From 0d4b20e9226f60fdc0fc03d8b38a00d267d5b40e Mon Sep 17 00:00:00 2001 From: Stefan Kreutz Date: Mon, 23 May 2022 22:08:51 +0200 Subject: Describe usage --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) 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. -- cgit v1.2.3