ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvtc.1.man.in
Revision: 1.20
Committed: Wed Dec 31 14:12:44 2014 UTC (9 years, 6 months ago) by root
Branch: MAIN
Changes since 1.19: +10 -19 lines
Log Message:
name, alldocclean

File Contents

# User Rev Content
1 root 1.20 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
2 root 1.1 .\"
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 root 1.10 .\" 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 root 1.1 .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     'br\}
42     .\"
43 root 1.10 .\" Escape single quotes in literal strings from groff's Unicode transform.
44     .ie \n(.g .ds Aq \(aq
45     .el .ds Aq '
46     .\"
47 root 1.1 .\" If the F register is turned on, we'll generate index entries on stderr for
48 root 1.10 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49 root 1.1 .\" entries marked with X<> in POD. Of course, you'll have to process the
50     .\" output yourself in some meaningful fashion.
51 root 1.20 .ie \nF \{\
52     . de IX
53     . tm Index:\\$1\t\\n%\t"\\$2"
54 root 1.1 ..
55 root 1.20 . nr % 0
56     . rr F
57     .\}
58     .el \{\
59     . de IX
60 root 1.10 ..
61     .\}
62 root 1.1 .\"
63     .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64     .\" Fear. Run. Save yourself. No user-serviceable parts.
65     . \" fudge factors for nroff and troff
66     .if n \{\
67     . ds #H 0
68     . ds #V .8m
69     . ds #F .3m
70     . ds #[ \f1
71     . ds #] \fP
72     .\}
73     .if t \{\
74     . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75     . ds #V .6m
76     . ds #F 0
77     . ds #[ \&
78     . ds #] \&
79     .\}
80     . \" simple accents for nroff and troff
81     .if n \{\
82     . ds ' \&
83     . ds ` \&
84     . ds ^ \&
85     . ds , \&
86     . ds ~ ~
87     . ds /
88     .\}
89     .if t \{\
90     . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91     . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92     . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93     . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94     . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95     . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
96     .\}
97     . \" troff and (daisy-wheel) nroff accents
98     .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99     .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100     .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101     .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102     .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103     .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104     .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105     .ds ae a\h'-(\w'a'u*4/10)'e
106     .ds Ae A\h'-(\w'A'u*4/10)'E
107     . \" corrections for vroff
108     .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109     .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110     . \" for low resolution devices (crt and lpr)
111     .if \n(.H>23 .if \n(.V>19 \
112     \{\
113     . ds : e
114     . ds 8 ss
115     . ds o a
116     . ds d- d\h'-1'\(ga
117     . ds D- D\h'-1'\(hy
118     . ds th \o'bp'
119     . ds Th \o'LP'
120     . ds ae ae
121     . ds Ae AE
122     .\}
123     .rm #[ #] #H #V #F C
124     .\" ========================================================================
125     .\"
126 root 1.4 .IX Title "@@RXVT_NAME@@ 1"
127 root 1.20 .TH @@RXVT_NAME@@ 1 "2014-12-31" "@@RXVT_VERSION@@" "RXVT-UNICODE"
128 root 1.10 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
129     .\" way too many mistakes in technical documents.
130     .if n .ad l
131     .nh
132 root 1.1 .SH "NAME"
133     @@RXVT_NAME@@c \- control the @@RXVT_NAME@@d daemon
134     .SH "SYNOPSIS"
135     .IX Header "SYNOPSIS"
136     \&\fB@@RXVT_NAME@@c\fR [same options as for @@RXVT_NAME@@]
137     .SH "DESCRIPTION"
138     .IX Header "DESCRIPTION"
139     This manpage describes the \fB@@RXVT_NAME@@c\fR client program. It connects
140     to the \fB@@RXVT_NAME@@d\fR daemon and requests a new terminal window. It
141     takes the same arguments as the \fB@@RXVT_NAME@@\fR program. The environment
142     will also be respected. Currently, it always returns immediately after
143     contacting the daemon.
144     .SH "OPTIONS"
145     .IX Header "OPTIONS"
146 root 1.19 If the first option is \fB\-k\fR, \fB@@RXVT_NAME@@c\fR tries to kill the
147     daemon process and returns.
148     .PP
149 root 1.1 All options that are valid for \fB@@RXVT_NAME@@\fR are valid for
150 root 1.5 \&\fB@@RXVT_NAME@@c\fR, too. Please note that options are interpreted in the
151     context of the daemon process. However, as current working directory,
152 root 1.6 process environment and any file descriptor (e.g. for \f(CW\*(C`\-pty\-fd\*(C'\fR) are
153 root 1.5 preserved, this rarely makes a difference.
154 root 1.3 .SH "EXIT STATUS"
155     .IX Header "EXIT STATUS"
156     If everything went well, @@RXVT_NAME@@c returns with an exit status of \f(CW0\fR.
157     If contacting the daemon fails, it exits with the exit status \f(CW2\fR. In all other error
158     cases it returns with status \f(CW1\fR.
159     .PP
160     This can be used to implement auto-starting behaviour, by checking for an
161     exit status of \f(CW2\fR, running \f(CW\*(C`@@RXVT_NAME@@d \-f \-q\*(C'\fR and retrying the call
162 root 1.5 to @@RXVT_NAME@@c, like this:
163     .PP
164     .Vb 6
165     \& #!/bin/sh
166     \& @@RXVT_NAME@@c "$@"
167 root 1.10 \& if [ $? \-eq 2 ]; then
168     \& @@RXVT_NAME@@d \-q \-o \-f
169 root 1.5 \& @@RXVT_NAME@@c "$@"
170     \& fi
171     .Ve
172 root 1.1 .SH "ENVIRONMENT"
173     .IX Header "ENVIRONMENT"
174     All environment variables of the current process will be made available
175     to the new instance, and will be interpreted as if \fB@@RXVT_NAME@@\fR were
176     started directly.
177     .IP "\fB\s-1RXVT_SOCKET\s0\fR" 4
178     .IX Item "RXVT_SOCKET"
179     Both @@RXVT_NAME@@c and @@RXVT_NAME@@d use the environment variable
180 root 1.2 \&\fI\s-1RXVT_SOCKET\s0\fR to create a listening socket and to contact the
181     @@RXVT_NAME@@d, respectively. If the variable is missing,
182 root 1.13 \&\fI\f(CI$HOME\fI/.urxvt/urxvtd\-\fI<nodename>\fI\fR is used. The variable must
183 root 1.2 specify the absolute path of the socket to create.
184 root 1.1 .SH "SEE ALSO"
185     .IX Header "SEE ALSO"
186     @@RXVT_NAME@@(7), @@RXVT_NAME@@d(1)