ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvtc.1.man.in
Revision: 1.3
Committed: Thu Feb 2 00:24:14 2006 UTC (18 years, 5 months ago) by root
Branch: MAIN
CVS Tags: rel-7_7, rel-7_6
Changes since 1.2: +11 -2 lines
Log Message:
*** empty log message ***

File Contents

# User Rev Content
1 root 1.3 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
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     .IX Title "rxvt 1"
132 root 1.3 .TH rxvt 1 "2006-02-02" "7.5" "RXVT-UNICODE"
133 root 1.1 .SH "NAME"
134     @@RXVT_NAME@@c \- control the @@RXVT_NAME@@d daemon
135     .SH "SYNOPSIS"
136     .IX Header "SYNOPSIS"
137     \&\fB@@RXVT_NAME@@c\fR [same options as for @@RXVT_NAME@@]
138     .SH "DESCRIPTION"
139     .IX Header "DESCRIPTION"
140     This manpage describes the \fB@@RXVT_NAME@@c\fR client program. It connects
141     to the \fB@@RXVT_NAME@@d\fR daemon and requests a new terminal window. It
142     takes the same arguments as the \fB@@RXVT_NAME@@\fR program. The environment
143     will also be respected. Currently, it always returns immediately after
144     contacting the daemon.
145     .SH "OPTIONS"
146     .IX Header "OPTIONS"
147     All options that are valid for \fB@@RXVT_NAME@@\fR are valid for
148     \&\fB@@RXVT_NAME@@c\fR, too. Please note that all options are currently
149     interpreted in the context of the daemon process, which makes a difference
150     for options that specify a file descriptor (such as \fB\-pty\-fd\fR).
151 root 1.3 .SH "EXIT STATUS"
152     .IX Header "EXIT STATUS"
153     If everything went well, @@RXVT_NAME@@c returns with an exit status of \f(CW0\fR.
154     If contacting the daemon fails, it exits with the exit status \f(CW2\fR. In all other error
155     cases it returns with status \f(CW1\fR.
156     .PP
157     This can be used to implement auto-starting behaviour, by checking for an
158     exit status of \f(CW2\fR, running \f(CW\*(C`@@RXVT_NAME@@d \-f \-q\*(C'\fR and retrying the call
159     to @@RXVT_NAME@@c.
160 root 1.1 .SH "ENVIRONMENT"
161     .IX Header "ENVIRONMENT"
162     All environment variables of the current process will be made available
163     to the new instance, and will be interpreted as if \fB@@RXVT_NAME@@\fR were
164     started directly.
165     .IP "\fB\s-1RXVT_SOCKET\s0\fR" 4
166     .IX Item "RXVT_SOCKET"
167     Both @@RXVT_NAME@@c and @@RXVT_NAME@@d use the environment variable
168 root 1.2 \&\fI\s-1RXVT_SOCKET\s0\fR to create a listening socket and to contact the
169     @@RXVT_NAME@@d, respectively. If the variable is missing,
170     \&\fI$HOME/.rxvt\-unicode\-\fI<nodename>\fI\fR is used. The variable must
171     specify the absolute path of the socket to create.
172 root 1.1 .SH "SEE ALSO"
173     .IX Header "SEE ALSO"
174     @@RXVT_NAME@@(7), @@RXVT_NAME@@d(1)