docs(sleep): Sleep command

tmux-python · tony · Mar 12, 2022 · Mar 12, 2022 · Mar 13, 2022 · Mar 13, 2022
commit 93b4ff11f5e34da8bfe7171debd4b21e97296895
diff --git a/docs/examples.md b/docs/examples.md
@@ -356,6 +356,33 @@ Omit sending {kbd}`enter` to key commands. Equivalent to
 
 ````
 
+## Pause / delay command execution
+
+```{versionadded} 1.10.0bX
+`sleep: [seconds]` option
+```
+
+Omit sending {kbd}`enter` to key commands. Equivalent to
+[`time.sleep()`](time.sleep) before [`send_keys(enter=False)`](libtmux.Pane.send_keys).
+
+````{tab} YAML
+
+```{literalinclude} ../examples/sleep.yaml
+:language: yaml
+
+```
+
+````
+
+````{tab} JSON
+
+```{literalinclude} ../examples/sleep.json
+:language: json
+
+```
+
+````
+
 ## Window Index
 
 You can specify a window's index using the `window_index` property. Windows

diff --git a/examples/sleep.json b/examples/sleep.json
@@ -0,0 +1,13 @@
+{
+  "session_name": "Should sleep 3 seconds before sending pane commands",
+  "windows": [
+    {
+      "panes": [
+        {
+          "shell_command": "echo \"___$((1 + 3))___\"",
+          "sleep": 3
+        }
+      ]
+    }
+  ]
+}
diff --git a/examples/sleep.yaml b/examples/sleep.yaml
@@ -0,0 +1,5 @@
+session_name: Should sleep 3 seconds before sending pane commands
+windows:
+- panes:
+  - shell_command: echo "___$((1 + 3))___"
+    sleep: 3