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