ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvtd.1.man.in
Revision: 1.26
Committed: Fri May 14 13:52:31 2021 UTC (3 years, 1 month ago) by root
Branch: MAIN
CVS Tags: rxvt-unicode-rel-9_26, rxvt-unicode-rel-9_25
Changes since 1.25: +1 -1 lines
Log Message:
9.25

File Contents

# Content
1 .\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings. \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 . ds -- \(*W-
28 . ds PI pi
29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
31 . ds L" ""
32 . ds R" ""
33 . ds C` ""
34 . ds C' ""
35 'br\}
36 .el\{\
37 . ds -- \|\(em\|
38 . ds PI \(*p
39 . ds L" ``
40 . ds R" ''
41 . ds C`
42 . ds C'
43 'br\}
44 .\"
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
46 .ie \n(.g .ds Aq \(aq
47 .el .ds Aq '
48 .\"
49 .\" If the F register is >0, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD. Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
53 .\"
54 .\" Avoid warning from groff about undefined register 'F'.
55 .de IX
56 ..
57 .nr rF 0
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{\
60 . if \nF \{\
61 . de IX
62 . tm Index:\\$1\t\\n%\t"\\$2"
63 ..
64 . if !\nF==2 \{\
65 . nr % 0
66 . nr F 2
67 . \}
68 . \}
69 .\}
70 .rr rF
71 .\"
72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73 .\" Fear. Run. Save yourself. No user-serviceable parts.
74 . \" fudge factors for nroff and troff
75 .if n \{\
76 . ds #H 0
77 . ds #V .8m
78 . ds #F .3m
79 . ds #[ \f1
80 . ds #] \fP
81 .\}
82 .if t \{\
83 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
84 . ds #V .6m
85 . ds #F 0
86 . ds #[ \&
87 . ds #] \&
88 .\}
89 . \" simple accents for nroff and troff
90 .if n \{\
91 . ds ' \&
92 . ds ` \&
93 . ds ^ \&
94 . ds , \&
95 . ds ~ ~
96 . ds /
97 .\}
98 .if t \{\
99 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
100 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
101 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
102 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
103 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
104 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
105 .\}
106 . \" troff and (daisy-wheel) nroff accents
107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
114 .ds ae a\h'-(\w'a'u*4/10)'e
115 .ds Ae A\h'-(\w'A'u*4/10)'E
116 . \" corrections for vroff
117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
119 . \" for low resolution devices (crt and lpr)
120 .if \n(.H>23 .if \n(.V>19 \
121 \{\
122 . ds : e
123 . ds 8 ss
124 . ds o a
125 . ds d- d\h'-1'\(ga
126 . ds D- D\h'-1'\(hy
127 . ds th \o'bp'
128 . ds Th \o'LP'
129 . ds ae ae
130 . ds Ae AE
131 .\}
132 .rm #[ #] #H #V #F C
133 .\" ========================================================================
134 .\"
135 .IX Title "@@RXVT_NAME@@ 1"
136 .TH @@RXVT_NAME@@ 1 "2021-05-14" "@@RXVT_VERSION@@" "RXVT-UNICODE"
137 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
139 .if n .ad l
140 .nh
141 .SH "NAME"
142 @@RXVT_NAME@@d \- @@RXVT_NAME@@ terminal daemon
143 .SH "SYNOPSIS"
144 .IX Header "SYNOPSIS"
145 \&\fB@@RXVT_NAME@@d\fR [\-q|\-\-quiet] [\-o|\-\-opendisplay] [\-f|\-\-fork] [\-m|\-\-mlock] [\-e|\-\-eval \fIperlstring\fR]
146 .PP
147 \&\fB@@RXVT_NAME@@d\fR \-q \-o \-f # for .xsession use
148 .SH "DESCRIPTION"
149 .IX Header "DESCRIPTION"
150 This manpage describes the @@RXVT_NAME@@d daemon, which is the same vt102
151 terminal emulator as @@RXVT_NAME@@, but runs as a daemon that can open
152 multiple terminal windows within the same process.
153 .PP
154 You can run it from your X startup scripts, for example, although it is
155 not dependent on a working \s-1DISPLAY\s0 and, in fact, can open windows on
156 multiple X displays on the same time.
157 .PP
158 Advantages of running a @@RXVT_NAME@@ daemon include faster creation time
159 for terminal windows and a lot of saved memory.
160 .PP
161 The disadvantage is a possible impact on stability \- if the
162 main program crashes, all processes in the terminal windows are
163 terminated. For example, as there is no way to cleanly react to abnormal
164 connection closes, \f(CW\*(C`xkill\*(C'\fR and server resets/restarts will kill the
165 \&\fB@@RXVT_NAME@@d\fR instance including all windows it has opened.
166 .SH "OPTIONS"
167 .IX Header "OPTIONS"
168 \&\fB@@RXVT_NAME@@d\fR currently understands a few options only. Bundling of
169 options is not yet supported.
170 .IP "\fB\-q\fR, \fB\-\-quiet\fR" 4
171 .IX Item "-q, --quiet"
172 Normally, \fB@@RXVT_NAME@@d\fR outputs the message \f(CW\*(C`rxvt\-unicode daemon
173 listening on <path>\*(C'\fR after binding to its control socket. This option
174 will suppress this message (errors and warnings will still be logged).
175 .IP "\fB\-o\fR, \fB\-\-opendisplay\fR" 4
176 .IX Item "-o, --opendisplay"
177 This forces \fB@@RXVT_NAME@@d\fR to open a connection to the current
178 \&\f(CW$DISPLAY\fR and keep it open.
179 .Sp
180 This is useful if you want to bind an instance of \fB@@RXVT_NAME@@d\fR to
181 the lifetime of a specific display/server. If the server does a reset,
182 \&\fB@@RXVT_NAME@@d\fR will be killed automatically.
183 .IP "\fB\-f\fR, \fB\-\-fork\fR" 4
184 .IX Item "-f, --fork"
185 This makes \fB@@RXVT_NAME@@d\fR fork after it has bound itself to its control
186 socket.
187 .IP "\fB\-m\fR, \fB\-\-mlock\fR" 4
188 .IX Item "-m, --mlock"
189 This makes \fB@@RXVT_NAME@@d\fR call \fBmlockall\fR\|(2) on itself. This locks
190 \&\fB@@RXVT_NAME@@d\fR in \s-1RAM\s0 and prevents it from being swapped out to disk,
191 at the cost of consuming a lot more memory on most operating systems.
192 .Sp
193 Note: In order to use this feature, your system administrator must have set
194 your user's \s-1RLIMIT_MEMLOCK\s0 to a size greater than or equal to the size of the
195 \&\fB@@RXVT_NAME@@d\fR binary (or to unlimited). See \fI/etc/security/limits.conf\fR.
196 .Sp
197 Note 2: There is a known bug in glibc (possibly fixed in 2.8 and later
198 versions) where calloc returns non-zeroed memory when mlockall is in
199 effect. If you experience crashes or other odd behaviour while using
200 \&\-\-mlock, try it without it.
201 .IP "\fB\-e\fR, \fB\-\-eval\fR \fIperlstring\fR" 4
202 .IX Item "-e, --eval perlstring"
203 Evaluate the given perl code after basic initialisation (requires perl
204 support to be enabled when compiling \fB@@RXVT_NAME@@d\fR).
205 .Sp
206 This can be used for example to configure the internal perl interpreter,
207 which is shared between all terminal instances, or create additional
208 listening sockets for additional protocols.
209 .Sp
210 The code is currently executed \fIbefore\fR creating the normal listening
211 sockets: this might change in future versions.
212 .SH "EXAMPLES"
213 .IX Header "EXAMPLES"
214 This is a useful invocation of \fB@@RXVT_NAME@@d\fR in a \fI.xsession\fR\-style
215 script:
216 .PP
217 .Vb 1
218 \& @@RXVT_NAME@@d \-q \-f \-o
219 .Ve
220 .PP
221 This waits till the control socket is available, opens the current display
222 and forks into the background. When you log-out, the server is reset and
223 \&\fB@@RXVT_NAME@@d\fR is killed.
224 .SH "ENVIRONMENT"
225 .IX Header "ENVIRONMENT"
226 .IP "\fB\s-1RXVT_SOCKET\s0\fR" 4
227 .IX Item "RXVT_SOCKET"
228 Both \fB@@RXVT_NAME@@c\fR and \fB@@RXVT_NAME@@d\fR use the environment
229 variable \fI\s-1RXVT_SOCKET\s0\fR to create a listening socket and to contact
230 the @@RXVT_NAME@@d, respectively. If the variable is missing then
231 \&\fI\f(CI$HOME\fI/.urxvt/urxvtd\-\fI<nodename>\fI\fR is used.
232 .IP "\fB\s-1LISTEN_PID\s0\fR, \fB\s-1LISTEN_FDS\s0\fR, \fB\s-1LISTEN_FDNAMES\s0\fR" 4
233 .IX Item "LISTEN_PID, LISTEN_FDS, LISTEN_FDNAMES"
234 if these environment variables are set, @@RXVT_NAME@@d checks for a file
235 descriptor passed by the service manager via systemd native interface. If
236 one is provided, @@RXVT_NAME@@d uses it as its listening socket instead of
237 creating one as specified above.
238 .IP "\fB\s-1DISPLAY\s0\fR" 4
239 .IX Item "DISPLAY"
240 Only used when the \f(CW\*(C`\-\-opendisplay\*(C'\fR option is specified. Must contain a
241 valid X display name.
242 .SH "SEE ALSO"
243 .IX Header "SEE ALSO"
244 @@RXVT_NAME@@(7), @@RXVT_NAME@@c(1)