rxvt-unicode/doc/rxvtc.1.man.in

.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "@@RXVT_NAME@@ 1"
.TH @@RXVT_NAME@@ 1 "2013-10-29" "@@RXVT_VERSION@@" "RXVT-UNICODE"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
@@RXVT_NAME@@c \- control the @@RXVT_NAME@@d daemon
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fB@@RXVT_NAME@@c\fR [same options as for @@RXVT_NAME@@]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This manpage describes the \fB@@RXVT_NAME@@c\fR client program. It connects
to the \fB@@RXVT_NAME@@d\fR daemon and requests a new terminal window. It
takes the same arguments as the \fB@@RXVT_NAME@@\fR program. The environment
will also be respected. Currently, it always returns immediately after
contacting the daemon.
.SH "OPTIONS"
.IX Header "OPTIONS"
All options that are valid for \fB@@RXVT_NAME@@\fR are valid for
\&\fB@@RXVT_NAME@@c\fR, too. Please note that options are interpreted in the
context of the daemon process. However, as current working directory,
process environment and any file descriptor (e.g. for \f(CW\*(C`\-pty\-fd\*(C'\fR) are
preserved, this rarely makes a difference.
.SH "EXIT STATUS"
.IX Header "EXIT STATUS"
If everything went well, @@RXVT_NAME@@c returns with an exit status of \f(CW0\fR.
If contacting the daemon fails, it exits with the exit status \f(CW2\fR. In all other error
cases it returns with status \f(CW1\fR.
.PP
This can be used to implement auto-starting behaviour, by checking for an
exit status of \f(CW2\fR, running \f(CW\*(C`@@RXVT_NAME@@d \-f \-q\*(C'\fR and retrying the call
to @@RXVT_NAME@@c, like this:
.PP
.Vb 6
\&   #!/bin/sh
\&   @@RXVT_NAME@@c "$@"
\&   if [ $? \-eq 2 ]; then
\&      @@RXVT_NAME@@d \-q \-o \-f
\&      @@RXVT_NAME@@c "$@"
\&   fi
.Ve
.SH "ENVIRONMENT"
.IX Header "ENVIRONMENT"
All environment variables of the current process will be made available
to the new instance, and will be interpreted as if \fB@@RXVT_NAME@@\fR were
started directly.
.IP "\fB\s-1RXVT_SOCKET\s0\fR" 4
.IX Item "RXVT_SOCKET"
Both @@RXVT_NAME@@c and @@RXVT_NAME@@d use the environment variable
\&\fI\s-1RXVT_SOCKET\s0\fR to create a listening socket and to contact the
@@RXVT_NAME@@d, respectively. If the variable is missing,
\&\fI\f(CI$HOME\fI/.urxvt/urxvtd\-\fI<nodename>\fI\fR is used.  The variable must
specify the absolute path of the socket to create.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
@@RXVT_NAME@@(7), @@RXVT_NAME@@d(1)
Revision:	1.17
Committed:	Thu Jan 16 07:59:24 2014 UTC (10 years, 5 months ago) by root
Branch:	MAIN
Changes since 1.16:	+19 -10 lines
Log Message:	Robert Wittek
#	User	Rev	Content
1	root	1.17	.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
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	root	1.17	. ds C`
42			. ds C'
43	root	1.1	'br\}
44			.\"
45	root	1.10	.\" Escape single quotes in literal strings from groff's Unicode transform.
46			.ie \n(.g .ds Aq \(aq
47			.el .ds Aq '
48			.\"
49	root	1.1	.\" If the F register is turned on, we'll generate index entries on stderr for
50	root	1.10	.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51	root	1.1	.\" entries marked with X<> in POD. Of course, you'll have to process the
52			.\" output yourself in some meaningful fashion.
53	root	1.17	.\"
54			.\" Avoid warning from groff about undefined register 'F'.
55			.de IX
56	root	1.1	..
57	root	1.17	.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	root	1.10	..
64	root	1.17	. if !\nF==2 \{
65			. nr % 0
66			. nr F 2
67			. \}
68			. \}
69	root	1.10	.\}
70	root	1.17	.rr rF
71	root	1.1	.\"
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(.wu8/10-\(#H)'\'\h"\|\\n:u"
100			. ds ` \\k:\h'-(\\n(.wu8/10-\(#H)'\`\h'\|\\n:u'
101			. ds ^ \\k:\h'-(\\n(.wu10/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(.wu8/10-\(#H)'\z\(sl\h'\|\\n:u'
105			.\}
106			. \" troff and (daisy-wheel) nroff accents
107			.ds : \\k:\h'-(\\n(.wu8/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'u2/3)'\s-1o\s+1\*(#]
113			.ds Th \(#[\s+2I\s-2\h'-\w'I'u3/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(.wu9/10-\(#H)'\s-2\u~\d\s+2\h'\|\\n:u'
118			.if v .ds ^ \\k:\h'-(\\n(.wu10/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	root	1.4	.IX Title "@@RXVT_NAME@@ 1"
136	root	1.17	.TH @@RXVT_NAME@@ 1 "2013-10-29" "@@RXVT_VERSION@@" "RXVT-UNICODE"
137	root	1.10	.\" 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	root	1.1	.SH "NAME"
142			@@RXVT_NAME@@c \- control the @@RXVT_NAME@@d daemon
143			.SH "SYNOPSIS"
144			.IX Header "SYNOPSIS"
145			\&\fB@@RXVT_NAME@@c\fR [same options as for @@RXVT_NAME@@]
146			.SH "DESCRIPTION"
147			.IX Header "DESCRIPTION"
148			This manpage describes the \fB@@RXVT_NAME@@c\fR client program. It connects
149			to the \fB@@RXVT_NAME@@d\fR daemon and requests a new terminal window. It
150			takes the same arguments as the \fB@@RXVT_NAME@@\fR program. The environment
151			will also be respected. Currently, it always returns immediately after
152			contacting the daemon.
153			.SH "OPTIONS"
154			.IX Header "OPTIONS"
155			All options that are valid for \fB@@RXVT_NAME@@\fR are valid for
156	root	1.5	\&\fB@@RXVT_NAME@@c\fR, too. Please note that options are interpreted in the
157			context of the daemon process. However, as current working directory,
158	root	1.6	process environment and any file descriptor (e.g. for \f(CW\(C`\-pty\-fd\(C'\fR) are
159	root	1.5	preserved, this rarely makes a difference.
160	root	1.3	.SH "EXIT STATUS"
161			.IX Header "EXIT STATUS"
162			If everything went well, @@RXVT_NAME@@c returns with an exit status of \f(CW0\fR.
163			If contacting the daemon fails, it exits with the exit status \f(CW2\fR. In all other error
164			cases it returns with status \f(CW1\fR.
165			.PP
166			This can be used to implement auto-starting behaviour, by checking for an
167			exit status of \f(CW2\fR, running \f(CW\(C`@@RXVT_NAME@@d \-f \-q\(C'\fR and retrying the call
168	root	1.5	to @@RXVT_NAME@@c, like this:
169			.PP
170			.Vb 6
171			\& #!/bin/sh
172			\& @@RXVT_NAME@@c "$@"
173	root	1.10	\& if [ $? \-eq 2 ]; then
174			\& @@RXVT_NAME@@d \-q \-o \-f
175	root	1.5	\& @@RXVT_NAME@@c "$@"
176			\& fi
177			.Ve
178	root	1.1	.SH "ENVIRONMENT"
179			.IX Header "ENVIRONMENT"
180			All environment variables of the current process will be made available
181			to the new instance, and will be interpreted as if \fB@@RXVT_NAME@@\fR were
182			started directly.
183			.IP "\fB\s-1RXVT_SOCKET\s0\fR" 4
184			.IX Item "RXVT_SOCKET"
185			Both @@RXVT_NAME@@c and @@RXVT_NAME@@d use the environment variable
186	root	1.2	\&\fI\s-1RXVT_SOCKET\s0\fR to create a listening socket and to contact the
187			@@RXVT_NAME@@d, respectively. If the variable is missing,
188	root	1.13	\&\fI\f(CI$HOME\fI/.urxvt/urxvtd\-\fI<nodename>\fI\fR is used. The variable must
189	root	1.2	specify the absolute path of the socket to create.
190	root	1.1	.SH "SEE ALSO"
191			.IX Header "SEE ALSO"
192			@@RXVT_NAME@@(7), @@RXVT_NAME@@d(1)