Added an example for the pane-shell configuration.

Author: jerri

docs/examples.rst

@@ -280,6 +280,23 @@ JSON
 .. literalinclude:: ../examples/window-index.json
     :language: json
 
+Shell per pane
+--------------
+
+Every pane can have its own shell or application started. This allows for usage of the ``remain-on-exit`` setting to be used properly, but also to have different shells on different panes.
+
+YAML
+~~~~
+
+.. literalinclude:: ../examples/pane-shell.yaml
+    :language: yaml
+
+JSON
+~~~~
+
+.. literalinclude:: ../examples/pane-shell.json
+    :language: json
+
 Set tmux options
 ----------------
 

examples/pane-shell.json

@@ -0,0 +1,40 @@
+{
+  "session_name": "Pane shell example",
+  "windows": [
+    {
+      "window_name": "first",
+      "window_shell": "/usr/bin/python2",
+      "layout": "even-vertical",
+      "suppress_history": false,
+      "options": {
+        "remain-on-exit": true
+      },
+      "panes": [
+        {
+          "shell": "/usr/bin/python3",
+          "shell_command": [
+            "print('This is python 3')"
+          ]
+        },
+        {
+          "shell": "/usr/bin/vim -u none",
+          "shell_command": [
+            "iAll panes have the `remain-on-exit` setting on.",
+            "When you exit out of the shell or application, the panes will remain.",
+            "Use tmux command `:kill-pane` to remove the pane.",
+            "Use tmux command `:respawn-pane` to restart the shell in the pane.",
+            "Use <Escape> and then `:q!` to get out of this vim window. :-)"
+          ]
+        },
+        {
+          "shell_command": [
+            "print('Hello World 2')"
+          ]
+        },
+        {
+          "shell": "/usr/bin/top"
+        }
+      ]
+    }
+  ]
+}

examples/pane-shell.yaml

@@ -0,0 +1,22 @@
+session_name: Pane shell example
+windows:
+  - window_name: first
+    window_shell: /usr/bin/python2
+    layout: even-vertical
+    suppress_history: false
+    options:
+      remain-on-exit: true
+    panes:
+      - shell: /usr/bin/python3
+        shell_command:
+          - print('This is python 3')
+      - shell: /usr/bin/vim -u none
+        shell_command:
+          - iAll panes have the `remain-on-exit` setting on.
+          - When you exit out of the shell or application, the panes will remain.
+          - Use tmux command `:kill-pane` to remove the pane.
+          - Use tmux command `:respawn-pane` to restart the shell in the pane.
+          - Use <Escape> and then `:q!` to get out of this vim window. :-)
+      - shell_command:
+          - print('Hello World 2')
+      - shell: /usr/bin/top