docs: enter: false

Documents and examples for #53 #293 #735

Author: tony

CHANGES

@@ -6,6 +6,16 @@
 
 #### What's new
 
+- #747: Skip execution via `enter: false`
+
+  ```yaml
+  session_name: Should not execute
+  windows:
+  - panes:
+    - shell_command: echo "___$((1 + 3))___"
+      enter: false
+  ```
+
 - #701: `tmuxp freeze` now accepts `--quiet` and `--yes` along with the
   `--config-format` and filename (`--save-to`). This means you can do it all in
   one command:

docs/examples.md

@@ -328,6 +328,33 @@ This will add the `shell_command` to the bash history in the pane.
 
 ````
 
+## Skip command execution
+
+```{versionadded} 1.10.0b1
+`enter: false` option
+```
+
+Omit sending {kbd}`enter` to key commands. Equivalent to
+[`send_keys(enter=False)`](libtmux.Pane.send_keys).
+
+````{tab} YAML
+
+```{literalinclude} ../examples/skip-send.yaml
+:language: yaml
+
+```
+
+````
+
+````{tab} JSON
+
+```{literalinclude} ../examples/skip-send.json
+:language: json
+
+```
+
+````
+
 ## Window Index
 
 You can specify a window's index using the `window_index` property. Windows

examples/skip-send.json

@@ -0,0 +1,13 @@
+{
+  "session_name": "Should not execute",
+  "windows": [
+    {
+      "panes": [
+        {
+          "shell_command": "echo \"___$((1 + 3))___\"",
+          "enter": false
+        }
+      ]
+    }
+  ]
+}

examples/skip-send.yaml

@@ -0,0 +1,5 @@
+session_name: Should not execute
+windows:
+- panes:
+  - shell_command: echo "___$((1 + 3))___"
+    enter: false