Add recommendation to run applications within dvtm under abduco to README
[abduco.git] / abduco.1
blob4e85e04f68e3643fb5454f160f00802775deb7d0
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.
79 .SH OPTIONS
80 If no command line arguments are given all currently active sessions are
81 printed sorted by their respective creation date. Lines starting with an
82 asterik
83 .BR *
84 indicate that at least one client is connected.
85 A plus sign
86 .BR +
87 indicates that the command terminated while no client was connected, attach
88 to get its exit status.
89 .TP
90 .B \-v
91 Print version information to standard output and exit.
92 .TP
93 .B \-r
94 Readonly session, i.e. user input is ignored.
95 .TP
96 .BI \-e \ detachkey
97 Set the key to detach which by default is set to CTRL+\\ i.e. ^\\ to detachkey.
98 .TP
99 .BI \-f
100 Force creation of session when there is an already terminated session of the same name,
101 after showing its exit status.
103 .BI \-c
104 Create a new session and attach immediately to it.
106 .BI \-n
107 Create a new session but do not attach to it.
109 .BI \-A
110 Try to connect to an existing session, upon failure create said session and attach immediately to it.
112 .BI \-a
113 Attach to an existing session.
115 .BI \-l
116 Attach with the lowest priority, meaning this client will be the last to control the size.
117 .SH EXAMPLE
118 Start a new session (assuming
119 .BR dvtm(1)
120 is in
121 .BR $PATH )
122 with
125 .B abduco -c my-session
128 do some work, then detach by pressing
129 .B CTRL+\e
130 and later reattach with
133 .B abduco -a my-session
136 .SH AUTHOR
137 abduco is written by Marc AndrĂ© Tanner <mat at brain-dump.org>