Man page tweaks

This commit is contained in:
Marc André Tanner 2014-06-20 13:24:57 +02:00
parent ba2e6a4248
commit 0ca1a36cbc
1 changed files with 37 additions and 15 deletions

View File

@ -38,14 +38,14 @@ abduco
.SH DESCRIPTION .SH DESCRIPTION
.B abduco .B abduco
provides a way to disconnect a given application from its controlling provides a way to disconnect a given application from its controlling
terminal thus it provides roughly the same session attach/detach support as terminal, thus it provides roughly the same session attach/detach support as
.BR screen(1) , " tmux(1)" " or" " dtach(1)". .BR screen(1) , " tmux(1)" " or" " dtach(1)".
If the If the
.BR command .BR command
to execute is not specified, the environment variable to execute is not specified, the environment variable
.BR $ABDUCO_CMD .BR $ABDUCO_CMD
is checked, if it is not set is examined, if it is not set
.BR dvtm(1) .BR dvtm(1)
is executed. is executed.
@ -57,9 +57,8 @@ as a fallback and
.BR /tmp/.abduco .BR /tmp/.abduco
as a last resort. as a last resort.
However if a given session name starts either with a dot or a forward slash However if a given session name represents either a relative or absolute path
it is interpreted as a path name and used unmodified i.e. relatively to the it is used unmodified.
current working directory.
If for some reason the If for some reason the
.BR unix(7) .BR unix(7)
@ -72,12 +71,16 @@ printed sorted by their respective creation date. Lines starting with an
asterik asterik
.BR * .BR *
indicate that at least one client is connected. indicate that at least one client is connected.
A plus sign
.BR +
indicates that the cmd terminated while no client was connected, attach
to get its exit status.
.TP .TP
.B \-v .B \-v
Print version information to standard output and exit. Print version information to standard output and exit.
.TP .TP
.B \-r .B \-r
Readonly session, i.e. no user input is ignored. Readonly session, i.e. user input is ignored.
.TP .TP
.BI \-e \ detachkey .BI \-e \ detachkey
Set the key to detach which by default is set to CTRL+\\ i.e. ^\\ to detachkey. Set the key to detach which by default is set to CTRL+\\ i.e. ^\\ to detachkey.
@ -93,5 +96,24 @@ Try to connect to an existing session, upon failure create said session and atta
.TP .TP
.BI \-a .BI \-a
Attach to an existing session. Attach to an existing session.
.SH EXAMPLE
Start a new session (assuming
.BR dvtm(1)
is in
.BR $PATH )
with
.nf
.B abduco -c my-session
.fi
do some work, then detach by pressing
.B CTRL+\e
and later reattach with
.nf
.B abduco -a my-session
.fi
.SH AUTHOR .SH AUTHOR
abduco is written by Marc André Tanner <mat at brain-dump.org> abduco is written by Marc André Tanner <mat at brain-dump.org>