Add quick starting section to the README

This commit is contained in:
Marc André Tanner 2014-11-15 14:14:25 +01:00
parent 5ac6537927
commit 27744da967
1 changed files with 27 additions and 2 deletions

29
README
View File

@ -2,7 +2,32 @@ abduco
======
abduco provides the session management and attach/detach functionality
of screen(1) and tmux(1) together with dvtm(1) it is a nearly complete
replacement of the before mentioned tools.
of screen(1) and tmux(1) together with dvtm(1) it is a nearly complete,
but more lightweight, replacement of the before mentioned tools.
Quickstart
----------
Assuming dvtm is located somewhere in $PATH, the following creates a
new session named 'demo':
$ abduco -c demo
An arbitrary application can be started as follows:
$ abduco -c demo your-application
CTRL+\ detaches from the active session. All available sessions can be
displayed by running:
$ abduco
Active sessions (on host hostname)
Fri 2014-11-14 18:52:36 demo
The session can be restored with
$ abduco -a demo
Read the manual page for further information.
See http://www.brain-dump.org/projects/abduco for the latest version.