Set version to 0.3
[abduco.git] / abduco.1
blobe9a7448ea84d55d8270a9caf28ac9d91093a2fb3
1 .TH ABDUCO 1 abduco\-VERSION
2 .nh
3 .SH NAME
4 abduco - terminal session manager
5 .SH SYNOPSIS
6 .B abduco
7 .RB [ \-e
8 .IR detachkey ]
9 .RB \-c
10 .RB name
11 .RB command
12 .RI [ args \ ... "" ]
13 .br
14 .B abduco
15 .RB [ \-e
16 .IR detachkey ]
17 .RB \-C
18 .RB name
19 .RB command
20 .RI [ args \ ... "" ]
21 .br
22 .B abduco
23 .RB [ \-r ]
24 .RB [ \-e
25 .IR detachkey ]
26 .RB \-n
27 .RB name
28 .RB command
29 .RI [ args \ ... "" ]
30 .br
31 .B abduco
32 .RB [ \-e
33 .IR detachkey ]
34 .RB \-A
35 .RB name
36 .RB command
37 .RI [ args \ ... "" ]
38 .br
39 .B abduco
40 .RB [ \-r ]
41 .RB [ \-e
42 .IR detachkey ]
43 .RB \-a
44 .RB name
45 .br
46 .SH DESCRIPTION
47 .B abduco
48 provides a way to disconnect a given application from its controlling
49 terminal, thus it provides roughly the same session attach/detach support as
50 .BR screen(1) , " tmux(1)" " or" " dtach(1)".
52 If the
53 .BR command
54 to execute is not specified, the environment variable
55 .BR $ABDUCO_CMD
56 is examined, if it is not set
57 .BR dvtm(1)
58 is executed.
60 By default all session related information is stored in
61 .B $HOME/.abduco
62 with
63 .BR $TMPDIR/.abduco
64 as a fallback and
65 .BR /tmp/.abduco
66 as a last resort.
68 However if a given session name represents either a relative or absolute path
69 it is used unmodified.
71 If for some reason the
72 .BR unix(7)
73 domain socket representing a session is deleted, sending
74 .BR SIGUSR1
75 to the server process will recreate it.
76 .SH OPTIONS
77 If no command line arguments are given all currently active sessions are
78 printed sorted by their respective creation date. Lines starting with an
79 asterik
80 .BR *
81 indicate that at least one client is connected.
82 A plus sign
83 .BR +
84 indicates that the command terminated while no client was connected, attach
85 to get its exit status.
86 .TP
87 .B \-v
88 Print version information to standard output and exit.
89 .TP
90 .B \-r
91 Readonly session, i.e. user input is ignored.
92 .TP
93 .BI \-e \ detachkey
94 Set the key to detach which by default is set to CTRL+\\ i.e. ^\\ to detachkey.
95 .TP
96 .BI \-c
97 Create a new session and attach immediately to it.
98 .TP
99 .BI \-C
100 Show the exit status of an already terminated session, and create a new session under the same name.
101 If the session does not exist, it acts like
102 .BI \-c
104 .BI \-n
105 Create a new session but do not attach to it.
107 .BI \-A
108 Try to connect to an existing session, upon failure create said session and attach immediately to it.
110 .BI \-a
111 Attach to an existing session.
112 .SH EXAMPLE
113 Start a new session (assuming
114 .BR dvtm(1)
115 is in
116 .BR $PATH )
117 with
120 .B abduco -c my-session
123 do some work, then detach by pressing
124 .B CTRL+\e
125 and later reattach with
128 .B abduco -a my-session
131 .SH AUTHOR
132 abduco is written by Marc AndrĂ© Tanner <mat at brain-dump.org>