ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvtd.1.man.in
Revision: 1.4
Committed: Mon Jul 17 19:20:29 2006 UTC (17 years, 11 months ago) by root
Branch: MAIN
CVS Tags: rel-7_8, rel-7_9
Changes since 1.3: +16 -6 lines
Log Message:
*** empty log message ***

File Contents

# User Rev Content
1 root 1.4 .\" Automatically generated by Pod::Man 2.09 (Pod::Simple 3.04)
2 root 1.1 .\"
3     .\" Standard preamble:
4     .\" ========================================================================
5     .de Sh \" Subsection heading
6     .br
7     .if t .Sp
8     .ne 5
9     .PP
10     \fB\\$1\fR
11     .PP
12     ..
13     .de Sp \" Vertical space (when we can't use .PP)
14     .if t .sp .5v
15     .if n .sp
16     ..
17     .de Vb \" Begin verbatim text
18     .ft CW
19     .nf
20     .ne \\$1
21     ..
22     .de Ve \" End verbatim text
23     .ft R
24     .fi
25     ..
26     .\" Set up some character translations and predefined strings. \*(-- will
27     .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28     .\" double quote, and \*(R" will give a right double quote. | will give a
29     .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30     .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31     .\" expand to `' in nroff, nothing in troff, for use with C<>.
32     .tr \(*W-|\(bv\*(Tr
33     .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34     .ie n \{\
35     . ds -- \(*W-
36     . ds PI pi
37     . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38     . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
39     . ds L" ""
40     . ds R" ""
41     . ds C` ""
42     . ds C' ""
43     'br\}
44     .el\{\
45     . ds -- \|\(em\|
46     . ds PI \(*p
47     . ds L" ``
48     . ds R" ''
49     'br\}
50     .\"
51     .\" If the F register is turned on, we'll generate index entries on stderr for
52     .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53     .\" entries marked with X<> in POD. Of course, you'll have to process the
54     .\" output yourself in some meaningful fashion.
55     .if \nF \{\
56     . de IX
57     . tm Index:\\$1\t\\n%\t"\\$2"
58     ..
59     . nr % 0
60     . rr F
61     .\}
62     .\"
63     .\" For nroff, turn off justification. Always turn off hyphenation; it makes
64     .\" way too many mistakes in technical documents.
65     .hy 0
66     .if n .na
67     .\"
68     .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69     .\" Fear. Run. Save yourself. No user-serviceable parts.
70     . \" fudge factors for nroff and troff
71     .if n \{\
72     . ds #H 0
73     . ds #V .8m
74     . ds #F .3m
75     . ds #[ \f1
76     . ds #] \fP
77     .\}
78     .if t \{\
79     . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80     . ds #V .6m
81     . ds #F 0
82     . ds #[ \&
83     . ds #] \&
84     .\}
85     . \" simple accents for nroff and troff
86     .if n \{\
87     . ds ' \&
88     . ds ` \&
89     . ds ^ \&
90     . ds , \&
91     . ds ~ ~
92     . ds /
93     .\}
94     .if t \{\
95     . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96     . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97     . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98     . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99     . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100     . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
101     .\}
102     . \" troff and (daisy-wheel) nroff accents
103     .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104     .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105     .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106     .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107     .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108     .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109     .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110     .ds ae a\h'-(\w'a'u*4/10)'e
111     .ds Ae A\h'-(\w'A'u*4/10)'E
112     . \" corrections for vroff
113     .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114     .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115     . \" for low resolution devices (crt and lpr)
116     .if \n(.H>23 .if \n(.V>19 \
117     \{\
118     . ds : e
119     . ds 8 ss
120     . ds o a
121     . ds d- d\h'-1'\(ga
122     . ds D- D\h'-1'\(hy
123     . ds th \o'bp'
124     . ds Th \o'LP'
125     . ds ae ae
126     . ds Ae AE
127     .\}
128     .rm #[ #] #H #V #F C
129     .\" ========================================================================
130     .\"
131 root 1.4 .IX Title "@@RXVT_NAME@@ 1"
132     .TH @@RXVT_NAME@@ 1 "2006-07-17" "7.8" "RXVT-UNICODE"
133 root 1.1 .SH "NAME"
134     @@RXVT_NAME@@d \- @@RXVT_NAME@@ terminal daemon
135     .SH "SYNOPSIS"
136     .IX Header "SYNOPSIS"
137     \&\fB@@RXVT_NAME@@d\fR [\-q|\-\-quiet] [\-o|\-\-opendisplay] [\-f|\-\-fork]
138     .SH "DESCRIPTION"
139     .IX Header "DESCRIPTION"
140     This manpage describes the @@RXVT_NAME@@d daemon, which is the same vt102
141     terminal emulator as @@RXVT_NAME@@, but runs as a daemon that can open
142     multiple terminal windows within the same process.
143     .PP
144     You can run it from your X startup scripts, for example, although it is
145     not dependent on a working \s-1DISPLAY\s0 and, in fact, can open windows on
146     multiple X displays on the same time.
147     .PP
148     Advantages of running a @@RXVT_NAME@@ daemon include faster creation time
149     for terminal windows and a lot of saved memory.
150     .PP
151     The disadvantage is a possible impact on stability \- if the
152     main program crashes, all processes in the terminal windows are
153     terminated. For example, as there is no way to cleanly react to abnormal
154     connection closes, \f(CW\*(C`xkill\*(C'\fR and server resets/restarts will kill the
155     \&\fB@@RXVT_NAME@@d\fR instance including all windows it has opened.
156     .SH "OPTIONS"
157     .IX Header "OPTIONS"
158     \&\fB@@RXVT_NAME@@d\fR currently understands a few options only. Bundling of
159     options is not yet supported.
160     .IP "\fB\-q\fR, \fB\-\-quiet\fR" 4
161     .IX Item "-q, --quiet"
162     Normally, \fB@@RXVT_NAME@@d\fR outputs the message \f(CW\*(C`rxvt\-unicode daemon
163     listening on <path>\*(C'\fR after binding to its control socket. This option
164 root 1.2 will suppress this message (errors and warnings will still be logged).
165 root 1.1 .IP "\fB\-o\fR, \fB\-\-opendisplay\fR" 4
166     .IX Item "-o, --opendisplay"
167     This forces \fB@@RXVT_NAME@@d\fR to open a connection to the current
168     \&\f(CW$DISPLAY\fR and keep it open.
169     .Sp
170     This is useful if you want to bind an instance of \fB@@RXVT_NAME@@d\fR to
171     the lifetime of a specific display/server. If the server does a reset,
172     \&\fB@@RXVT_NAME@@d\fR will be killed automatically.
173     .IP "\fB\-f\fR, \fB\-\-fork\fR" 4
174     .IX Item "-f, --fork"
175     This makes \fB@@RXVT_NAME@@d\fR fork after it has bound itself to its control
176     socket.
177     .SH "EXAMPLES"
178     .IX Header "EXAMPLES"
179     This is a useful invocation of \fB@@RXVT_NAME@@d\fR in a \fI.xsession\fR\-style
180     script:
181     .PP
182     .Vb 1
183 root 1.4 \& B<@@RXVT_NAME@@d> \-q \-f \-o
184 root 1.1 .Ve
185     .PP
186     This waits till the control socket is available, opens the current display
187     and forks into the background. When you log\-out, the server is reset and
188     \&\fB@@RXVT_NAME@@d\fR is killed.
189     .SH "ENVIRONMENT"
190     .IX Header "ENVIRONMENT"
191     .IP "\fB\s-1RXVT_SOCKET\s0\fR" 4
192     .IX Item "RXVT_SOCKET"
193 root 1.3 Both \fB@@RXVT_NAME@@c\fR and \fB@@RXVT_NAME@@d\fR use the environment
194     variable \fI\s-1RXVT_SOCKET\s0\fR to create a listening socket and to contact
195 root 1.1 the @@RXVT_NAME@@d, respectively. If the variable is missing,
196 root 1.4 \&\fI\f(CI$HOME\fI/.rxvt\-unicode\-\fI<nodename>\fI\fR is used. The variable must
197 root 1.3 specify the absolute path of the socket to create.
198 root 1.1 .IP "\fB\s-1DISPLAY\s0\fR" 4
199     .IX Item "DISPLAY"
200     Only used when the \f(CW\*(C`\-\-opendisplay\*(C'\fR option is specified. Must contain a
201     valid X display name.
202     .RS 4
203 root 1.4 .RE
204     .RS 4
205     .RE
206 root 1.1 .SH "SEE ALSO"
207     .IX Header "SEE ALSO"
208     @@RXVT_NAME@@(7), @@RXVT_NAME@@c(1)
209 root 1.4 .SH "POD ERRORS"
210     .IX Header "POD ERRORS"
211     Hey! \fBThe above document had some coding errors, which are explained below:\fR
212     .IP "Around line 87:" 4
213     .IX Item "Around line 87:"
214     You forgot a '=back' before '=head1'
215     .Sp
216     You forgot a '=back' before '=head1'