From d8ce3f820986988704973f5652905bf6bbea0afa Mon Sep 17 00:00:00 2001 From: mwtkrayer Date: Sat, 20 Mar 2021 14:31:20 +0100 Subject: [PATCH] Add 'README' --- README | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 README diff --git a/README b/README new file mode 100644 index 0000000..909b81c --- /dev/null +++ b/README @@ -0,0 +1,39 @@ +Usage: session mode [args] +Manage detachable shell sessions using [dtach](https://github.com/crigler/dtach). +Available modes: + attach | att | a attach to an existing session + new | | n create a new session + terminate | term | t terminate an existing session (SIGTERM) + kill | | k send SIGKILL to an existing session + list | ls | l list all available sessions + info | | i print information on a session + help | | h display this help message + +session attach [name] + Attach to specified session. If no session name is provided, an interactive + selection menu is provided. Use to detach. + +session new [name] + Create a new session. If no session name is provided, a generic name will + be generated. Use to detach. + +session terminate [name] + Terminate a specified session. If no session name is provided, all sessions + will be terminated upon confirmation. + +session kill [name] + Same as 'terminate' but SIGKILL is sent to the shell instead of SIGTERM. + +session list + List all available sessions. + +session info [name] + Print information on a specified session. If no session name is provided, + information on all sessions will be printed. The output contains the session + name, the timestamp of creation and the path of its socket. + +session help + Print this help message. + +session is configured using the file '/home/stumpf/.sessionrc', which, if +non-existent, can be initialized with 'session config generate'. \ No newline at end of file