Update test suite to account for ignored output
[abduco.git] / abduco.1
blobfa5a84f613879c041e2bfaff1d280b6e5832dde4
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 [ \-l ]
32 .RB \-A
33 .RB name
34 .RB command
35 .RI [ args \ ... "" ]
36 .br
37 .B abduco
38 .RB [ \-e
39 .IR detachkey ]
40 .RB [ \-r ]
41 .RB [ \-l ]
42 .RB \-a
43 .RB name
44 .br
45 .SH DESCRIPTION
46 .B abduco
47 provides a way to disconnect a given application from its controlling
48 terminal, thus it provides roughly the same session attach/detach support as
49 .BR screen(1) , " tmux(1)" " or" " dtach(1)".
51 If the
52 .BR command
53 to execute is not specified, the environment variable
54 .BR $ABDUCO_CMD
55 is examined, if it is not set
56 .BR dvtm(1)
57 is executed.
59 All session related information is stored in the following directories (first
60 to succeed is used):
61 .RS
62 .nf
63 .PP
64 .B $ABDUCO_SOCKET_DIR/abduco
65 .B $HOME/.abduco
66 .B $TMPDIR/abduco/$USER
67 .B /tmp/abduco/$USER
68 .fi
69 .RE
71 However if a given session name represents either a relative or absolute path
72 it is used unmodified.
74 If for some reason the
75 .BR unix(7)
76 domain socket representing a session is deleted, sending
77 .BR SIGUSR1
78 to the server process will recreate it.
80 If standard input does not refer to a terminal (or the
81 .B -p
82 option was given), its content is passed through to the underlying session.
83 .SH OPTIONS
84 If no command line arguments are given all currently active sessions are
85 printed sorted by their respective creation date. Lines starting with an
86 asterik
87 .BR *
88 indicate that at least one client is connected.
89 A plus sign
90 .BR +
91 indicates that the command terminated while no client was connected, attach
92 to get its exit status.
93 .TP
94 .B \-v
95 Print version information to standard output and exit.
96 .TP
97 .B \-r
98 Readonly session, i.e. user input is ignored.
99 .TP
100 .B \-e \fIdetachkey\fR
101 Set the key to detach which by default is set to CTRL+\\ i.e. ^\\ to detachkey.
103 .BI \-f
104 Force creation of session when there is an already terminated session of the same name,
105 after showing its exit status.
107 .BI \-c
108 Create a new session and attach immediately to it.
110 .BI \-n
111 Create a new session but do not attach to it.
113 .BI \-A
114 Try to connect to an existing session, upon failure create said session and attach immediately to it.
116 .BI \-a
117 Attach to an existing session.
119 .BI \-l
120 Attach with the lowest priority, meaning this client will be the last to control the size.
122 .BI \-q
123 Be quiet, do not print informative messages.
125 .BI \-p
126 Pass through content of standard input to the session. Implies the
127 .B \-q
129 .B \-l
130 options.
131 .SH EXAMPLE
132 Start a new session (assuming
133 .BR dvtm(1)
134 is in
135 .BR $PATH )
136 with
139 .B abduco -c my-session
142 do some work, then detach by pressing
143 .B CTRL+\e
144 and later reattach with
147 .B abduco -a my-session
150 .SH AUTHOR
151 abduco is written by Marc AndrĂ© Tanner <mat at brain-dump.org>