summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStefan Kreutz <mail@skreutz.com>2022-05-23 22:08:51 +0200
committerStefan Kreutz <mail@skreutz.com>2022-05-23 22:08:51 +0200
commit0d4b20e9226f60fdc0fc03d8b38a00d267d5b40e (patch)
treeb40ee66e50cb829700e7e982759f91aa9f6fab9d
parent1b8749280ddedb7fb34017ef5188e91467df0682 (diff)
downloadssh-tmux-0d4b20e9226f60fdc0fc03d8b38a00d267d5b40e.tar
Describe usage
-rw-r--r--README.md16
1 files changed, 15 insertions, 1 deletions
diff --git a/README.md b/README.md
index d3f1b36..0cd0938 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,20 @@ session on a specified host.
The intended purpose is to execute long-running interactive remote commands
with the ability to re-connect.
-## Install
+## Usage
+
+The following command logs into the OpenSSH host `example.com`, creates and
+attaches to a new Tmux session named `make`, and builds a project.
+
+ $ ssh-tmux -s make example.com "cd project && make && sudo make install"
+
+When you detach or disconnect, or simply want to watch from another client, you
+can re-connect and re-attach as follows:
+
+ $ ssh -t example.com tmux attach-session -t make
+
+See the manual page for more examples.
+
+## Installation
Run `make install` as root to install the `ssh-tmux` utility and man page.
Generated by cgit. See skreutz.com for my tech blog and contact information.