ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.man.in
Revision: 1.29
Committed: Tue Dec 27 12:24:09 2005 UTC (18 years, 6 months ago) by root
Branch: MAIN
CVS Tags: rel-6_1
Changes since 1.28: +5 -3 lines
Log Message:
*** empty log message ***

File Contents

# User Rev Content
1 root 1.28 .\" 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 root 1.12 . ds C` ""
42     . ds C' ""
43 root 1.1 '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.29 .TH rxvt 1 "2005-12-27" "6.1" "RXVT-UNICODE"
133 root 1.1 .SH "NAME"
134     rxvt\-unicode (ouR XVT, unicode) \- (a VT102 emulator for the X window system)
135     .SH "SYNOPSIS"
136     .IX Header "SYNOPSIS"
137     \&\fB@@RXVT_NAME@@\fR [options] [\-e command [ args ]]
138     .SH "DESCRIPTION"
139     .IX Header "DESCRIPTION"
140     \&\fBrxvt-unicode\fR, version \fB@@RXVT_VERSION@@\fR, is a colour vt102 terminal
141     emulator intended as an \fIxterm\fR(1) replacement for users who do not
142     require features such as Tektronix 4014 emulation and toolkit-style
143     configurability. As a result, \fBrxvt-unicode\fR uses much less swap space \*(--
144     a significant advantage on a machine serving many X sessions.
145     .SH "FREQUENTLY ASKED QUESTIONS"
146     .IX Header "FREQUENTLY ASKED QUESTIONS"
147 root 1.12 See @@RXVT_NAME@@(7) (try \f(CW\*(C`man 7 @@RXVT_NAME@@\*(C'\fR) for a list of
148     frequently asked questions and answer to them and some common
149     problems. That document is also accessible on the World-Wide-Web at
150     <http://cvs.schmorp.de/browse/*checkout*/rxvt\-unicode/doc/rxvt.7.html>.
151 root 1.1 .SH "RXVT-UNICODE VS. RXVT"
152     .IX Header "RXVT-UNICODE VS. RXVT"
153     Unlike the original rxvt, \fBrxvt-unicode\fR stores all text in Unicode
154     internally. That means it can store and display most scripts in the
155     world. Being a terminal emulator, however, some things are very difficult,
156     especially cursive scripts such as arabic, vertically written scripts
157     like mongolian or scripts requiring extremely complex combining rules,
158     like tibetan or devenagari. Don't expect pretty output when using these
159     scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
160     fine, though. A somewhat difficult case are left-to-right scripts, such
161     as hebrew: \fBrxvt-unicode\fR adopts the view that bidirectional algorithms
162     belong into the application, not the terminal emulator (too many things \*(--
163     such as cursor-movement while editing \*(-- break otherwise), but that might
164     change.
165     .PP
166     If you are looking for a terminal that supports more exotic scripts, let
167     me recommend \f(CW\*(C`mlterm\*(C'\fR, which is a very userfriendly, lean and clean
168     terminal emulator. In fact, the reason rxvt-unicode was born was solely
169     because the author couldn't get \f(CW\*(C`mlterm\*(C'\fR to use one font for latin1 and
170     another for japanese.
171     .PP
172     Therefore another design rationale was the use of multiple fonts to
173     display characters: The idea of a single unicode font which many other
174     programs force onto it's users never made sense to me: You should be able
175     to choose any font for any script freely.
176     .PP
177     Apart from that, rxvt-unicode is also much better internationalised than
178     it's predecessor, supports things such as \s-1XFT\s0 and \s-1ISO\s0 14755 that are handy
179     in i18n\-environments, is faster, and has a lot less bugs than the original
180     rxvt. This all in addition to dozens of other small improvements.
181     .PP
182     It is still faithfully following the original rxvt idea of being lean
183     and nice on resources: for example, you can still configure rxvt-unicode
184     without most of it's features to get a lean binary. It also comes with
185     a client/daemon pair that lets you open any number of terminal windows
186     from within a single process, which makes startup time very fast and
187     drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
188     @@RXVT_NAME@@c(1) (client).
189     .PP
190     It also makes technical information about escape sequences (which have
191     been extended) easier accessible: see @@RXVT_NAME@@(7) for technical
192     reference documentation (escape sequences etc.).
193     .SH "OPTIONS"
194     .IX Header "OPTIONS"
195     The \fB@@RXVT_NAME@@\fR options (mostly a subset of \fIxterm\fR's) are listed
196     below. In keeping with the smaller-is-better philosophy, options may be
197     eliminated or default values chosen at compile\-time, so options and
198     defaults listed may not accurately reflect the version installed on
199     your system. `@@RXVT_NAME@@ \-h' gives a list of major compile-time options on
200     the \fIOptions\fR line. Option descriptions may be prefixed with which
201     compile option each is dependent upon. e.g. `Compile \fI\s-1XIM\s0\fR:' requires
202     \&\fI\s-1XIM\s0\fR on the \fIOptions\fR line. Note: `@@RXVT_NAME@@ \-help' gives a list of all
203     command-line options compiled into your version.
204     .PP
205     Note that \fB@@RXVT_NAME@@\fR permits the resource name to be used as a
206     long-option (\-\-/++ option) so the potential command-line options are
207     far greater than those listed. For example: `@@RXVT_NAME@@ \-\-loginShell \-\-color1
208     Orange'.
209     .PP
210     The following options are available:
211     .IP "\fB\-help\fR, \fB\-\-help\fR" 4
212     .IX Item "-help, --help"
213     Print out a message describing available options.
214     .IP "\fB\-display\fR \fIdisplayname\fR" 4
215     .IX Item "-display displayname"
216     Attempt to open a window on the named X display (\fB\-d\fR still
217     respected). In the absence of this option, the display specified by the
218     \&\fB\s-1DISPLAY\s0\fR environment variable is used.
219     .IP "\fB\-geometry\fR \fIgeom\fR" 4
220     .IX Item "-geometry geom"
221     Window geometry (\fB\-g\fR still respected); resource \fBgeometry\fR.
222     .IP "\fB\-rv\fR|\fB+rv\fR" 4
223     .IX Item "-rv|+rv"
224     Turn on/off simulated reverse video; resource \fBreverseVideo\fR.
225     .IP "\fB\-j\fR|\fB+j\fR" 4
226     .IX Item "-j|+j"
227     Turn on/off jump scrolling; resource \fBjumpScroll\fR.
228 root 1.25 .IP "\fB\-ip\fR|\fB+ip\fR | \fB\-tr\fR|\fB+tr\fR" 4
229     .IX Item "-ip|+ip | -tr|+tr"
230 root 1.1 Turn on/off inheriting parent window's pixmap. Alternative form is
231     \&\fB\-tr\fR; resource \fBinheritPixmap\fR.
232     .IP "\fB\-fade\fR \fInumber\fR" 4
233     .IX Item "-fade number"
234 root 1.25 Fade the text by the given percentage when focus is lost. Small values
235     fade a little only, 100 completely replaces all colours by the fade
236     colour; resource \fBfading\fR.
237     .IP "\fB\-fadecolor\fR \fIcolour\fR" 4
238     .IX Item "-fadecolor colour"
239     Fade to this colour when fading is used (see \fB\-fade\fR). The default colour
240     is black. resource \fBfadeColor\fR.
241 root 1.1 .IP "\fB\-tint\fR \fIcolour\fR" 4
242     .IX Item "-tint colour"
243     Tint the transparent background pixmap with the given colour when
244 root 1.25 transparency is enabled with \fB\-tr\fR or \fB\-ip\fR. This only works for
245     non-tiled backgrounds, currently. See also the \fB\-sh\fR option that can be
246     used to brighten or darken the image in addition to tinting it; resource
247     \&\fItintColor\fR. Example:
248     .Sp
249     .Vb 1
250     \& @@RXVT_NAME@@ -tr -tint blue -sh 40
251     .Ve
252 root 1.1 .IP "\fB\-sh\fR" 4
253     .IX Item "-sh"
254     \&\fInumber\fR Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent
255     background image in addition to tinting it (i.e. \fB\-tint\fR must be
256     specified, too, e.g. \f(CW\*(C`\-tint white\*(C'\fR).
257     .IP "\fB\-bg\fR \fIcolour\fR" 4
258     .IX Item "-bg colour"
259     Window background colour; resource \fBbackground\fR.
260     .IP "\fB\-fg\fR \fIcolour\fR" 4
261     .IX Item "-fg colour"
262     Window foreground colour; resource \fBforeground\fR.
263     .IP "\fB\-pixmap\fR \fIfile[;geom]\fR" 4
264     .IX Item "-pixmap file[;geom]"
265     Compile \fI\s-1XPM\s0\fR: Specify \s-1XPM\s0 file for the background and also optionally
266 root 1.3 specify its scaling with a geometry string. Note you may need to
267     add quotes to avoid special shell interpretation of the \f(CW\*(C`;\*(C'\fR in the
268 root 1.1 command\-line; resource \fBbackgroundPixmap\fR.
269     .IP "\fB\-cr\fR \fIcolour\fR" 4
270     .IX Item "-cr colour"
271     The cursor colour; resource \fBcursorColor\fR.
272     .IP "\fB\-pr\fR \fIcolour\fR" 4
273     .IX Item "-pr colour"
274     The mouse pointer foreground colour; resource \fBpointerColor\fR.
275     .IP "\fB\-pr2\fR \fIcolour\fR" 4
276     .IX Item "-pr2 colour"
277     The mouse pointer background colour; resource \fBpointerColor2\fR.
278     .IP "\fB\-bd\fR \fIcolour\fR" 4
279     .IX Item "-bd colour"
280     The colour of the border around the text area and between the scrollbar and the text;
281     resource \fBborderColor\fR.
282     .IP "\fB\-fn\fR \fIfontlist\fR" 4
283     .IX Item "-fn fontlist"
284     Select the fonts to be used. This is a comma separated list of font names
285     that are used in turn when trying to display Unicode characters. The
286     first font defines the cell size for characters; other fonts might be
287     smaller, but not (in general) larger. A (hopefully) reasonable default
288     font list is always appended to it. See resource \fBfont\fR for more details.
289     .Sp
290     In short, to specify an X11 core font, just specify it's name or prefix it
291     with \f(CW\*(C`x:\*(C'\fR. To specify an XFT\-font, you need to prefix it with \f(CW\*(C`xft:\*(C'\fR,
292     e.g.:
293     .Sp
294     .Vb 2
295     \& @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
296     \& @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
297     .Ve
298     .Sp
299     See also the question \*(L"How does rxvt-unicode choose fonts?\*(R" in the \s-1FAQ\s0
300     section of @@RXVT_NAME@@(7).
301     .IP "\fB\-fb\fR \fIfontlist\fR" 4
302     .IX Item "-fb fontlist"
303     Compile font\-styles: The bold font list to use when bold characters are to
304     be printed. See resource \fBboldFont\fR for details.
305     .IP "\fB\-fi\fR \fIfontlist\fR" 4
306     .IX Item "-fi fontlist"
307     Compile font\-styles: The italic font list to use when bold characters are to
308     be printed. See resource \fBitalicFont\fR for details.
309     .IP "\fB\-fbi\fR \fIfontlist\fR" 4
310     .IX Item "-fbi fontlist"
311     Compile font\-styles: The bold italic font list to use when bold characters are to
312     be printed. See resource \fBboldItalicFont\fR for details.
313     .IP "\fB\-name\fR \fIname\fR" 4
314     .IX Item "-name name"
315     Specify the application name under which resources are to be obtained,
316     rather than the default executable file name. Name should not contain
317     `.' or `*' characters. Also sets the icon and title name.
318     .IP "\fB\-ls\fR|\fB+ls\fR" 4
319     .IX Item "-ls|+ls"
320     Start as a login\-shell/sub\-shell; resource \fBloginShell\fR.
321     .IP "\fB\-ut\fR|\fB+ut\fR" 4
322     .IX Item "-ut|+ut"
323     Compile \fIutmp\fR: Inhibit/enable writing a utmp entry; resource
324     \&\fButmpInhibit\fR.
325     .IP "\fB\-vb\fR|\fB+vb\fR" 4
326     .IX Item "-vb|+vb"
327     Turn on/off visual bell on receipt of a bell character; resource
328     \&\fBvisualBell\fR.
329     .IP "\fB\-sb\fR|\fB+sb\fR" 4
330     .IX Item "-sb|+sb"
331     Turn on/off scrollbar; resource \fBscrollBar\fR.
332     .IP "\fB\-si\fR|\fB+si\fR" 4
333     .IX Item "-si|+si"
334     Turn on/off scroll-to-bottom on \s-1TTY\s0 output inhibit; resource
335     \&\fBscrollTtyOutput\fR has opposite effect.
336     .IP "\fB\-sk\fR|\fB+sk\fR" 4
337     .IX Item "-sk|+sk"
338     Turn on/off scroll-to-bottom on keypress; resource
339     \&\fBscrollTtyKeypress\fR.
340     .IP "\fB\-sw\fR|\fB+sw\fR" 4
341     .IX Item "-sw|+sw"
342     Turn on/off scrolling with the scrollback buffer as new lines appear.
343     This only takes effect if \fB\-si\fR is also given; resource
344     \&\fBscrollWithBuffer\fR.
345     .IP "\fB\-sr\fR|\fB+sr\fR" 4
346     .IX Item "-sr|+sr"
347     Put scrollbar on right/left; resource \fBscrollBar_right\fR.
348     .IP "\fB\-st\fR|\fB+st\fR" 4
349     .IX Item "-st|+st"
350 root 1.23 Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
351 root 1.1 resource \fBscrollBar_floating\fR.
352     .IP "\fB\-ptab\fR|\fB+ptab\fR" 4
353     .IX Item "-ptab|+ptab"
354     If enabled (default), \*(L"Horizontal Tab\*(R" characters are being stored as
355     actual wide characters in the screen buffer, which makes it possible to
356     select and paste them. Since a horizontal tab is a cursor movement and
357     not an actual glyph, this can sometimes be visually annoying as the cursor
358     on a tab character is displayed as a wide cursor; resource \fBpastableTabs\fR.
359     .IP "\fB\-bc\fR|\fB+bc\fR" 4
360     .IX Item "-bc|+bc"
361     Blink the cursor; resource \fBcursorBlink\fR.
362     .IP "\fB\-iconic\fR" 4
363     .IX Item "-iconic"
364     Start iconified, if the window manager supports that option.
365     Alternative form is \fB\-ic\fR.
366     .IP "\fB\-sl\fR \fInumber\fR" 4
367     .IX Item "-sl number"
368     Save \fInumber\fR lines in the scrollback buffer. See resource entry for
369     limits; resource \fBsaveLines\fR.
370     .IP "\fB\-b\fR \fInumber\fR" 4
371     .IX Item "-b number"
372     Compile \fIfrills\fR: Internal border of \fInumber\fR pixels. See resource
373     entry for limits; resource \fBinternalBorder\fR.
374     .IP "\fB\-w\fR \fInumber\fR" 4
375     .IX Item "-w number"
376     Compile \fIfrills\fR: External border of \fInumber\fR pixels. Also, \fB\-bw\fR
377     and \fB\-borderwidth\fR. See resource entry for limits; resource
378     \&\fBexternalBorder\fR.
379     .IP "\fB\-bl\fR" 4
380     .IX Item "-bl"
381     Compile \fIfrills\fR: Set \s-1MWM\s0 hints to request a borderless window, i.e.
382     if honoured by the \s-1WM\s0, the rxvt-unicode window will not have window
383     decorations; resource \fBborderLess\fR.
384     .IP "\fB\-lsp\fR \fInumber\fR" 4
385     .IX Item "-lsp number"
386     Compile \fIfrills\fR: Lines (pixel height) to insert between each row of
387     the display. Useful to work around font rendering problems; resource
388     \&\fBlinespace\fR.
389     .IP "\fB\-tn\fR \fItermname\fR" 4
390     .IX Item "-tn termname"
391     This option specifies the name of the terminal type to be set in the
392     \&\fB\s-1TERM\s0\fR environment variable. This terminal type must exist in the
393     \&\fI\fItermcap\fI\|(5)\fR database and should have \fIli#\fR and \fIco#\fR entries;
394     resource \fBtermName\fR.
395     .IP "\fB\-e\fR \fIcommand [arguments]\fR" 4
396     .IX Item "-e command [arguments]"
397     Run the command with its command-line arguments in the \fB@@RXVT_NAME@@\fR
398     window; also sets the window title and icon name to be the basename of
399     the program being executed if neither \fI\-title\fR (\fI\-T\fR) nor \fI\-n\fR are
400     given on the command line. If this option is used, it must be the last
401     on the command\-line. If there is no \fB\-e\fR option then the default is to
402     run the program specified by the \fB\s-1SHELL\s0\fR environment variable or,
403     failing that, \fI\fIsh\fI\|(1)\fR.
404 root 1.28 .Sp
405     Please note that you must specify a program with arguments. If you want to
406     run shell commands, you have to specify the shell, like this:
407     .Sp
408     .Vb 1
409     \& @@RXVT_NAME@@ -e sh -c "shell commands"
410     .Ve
411 root 1.1 .IP "\fB\-title\fR \fItext\fR" 4
412     .IX Item "-title text"
413     Window title (\fB\-T\fR still respected); the default title is the basename
414     of the program specified after the \fB\-e\fR option, if any, otherwise the
415     application name; resource \fBtitle\fR.
416     .IP "\fB\-n\fR \fItext\fR" 4
417     .IX Item "-n text"
418     Icon name; the default name is the basename of the program specified
419     after the \fB\-e\fR option, if any, otherwise the application name;
420     resource \fBiconName\fR.
421     .IP "\fB\-C\fR" 4
422     .IX Item "-C"
423     Capture system console messages.
424     .IP "\fB\-pt\fR \fIstyle\fR" 4
425     .IX Item "-pt style"
426     Compile \fI\s-1XIM\s0\fR: input style for input method; \fBOverTheSpot\fR,
427     \&\fBOffTheSpot\fR, \fBRoot\fR; resource \fBpreeditType\fR.
428     .IP "\fB\-im\fR \fItext\fR" 4
429     .IX Item "-im text"
430     Compile \fI\s-1XIM\s0\fR: input method name. resource \fBinputMethod\fR.
431     .IP "\fB\-imlocale\fR \fIstring\fR" 4
432     .IX Item "-imlocale string"
433 root 1.7 The locale to use for opening the \s-1IM\s0. You can use an \f(CW\*(C`LC_CTYPE\*(C'\fR of e.g.
434     \&\f(CW\*(C`de_DE.UTF\-8\*(C'\fR for normal text processing but \f(CW\*(C`ja_JP.EUC\-JP\*(C'\fR for the
435     input extension to be able to input japanese characters while staying in
436     another locale. resource \fBimLocale\fR.
437     .IP "\fB\-imfont\fR \fIfontset\fR" 4
438     .IX Item "-imfont fontset"
439     Set the font set to use for the X Input Method, see resource \fBimFont\fR
440     for more info.
441     .IP "\fB\-tcw\fR" 4
442     .IX Item "-tcw"
443     Change the meaning of triple-click selection with the left mouse
444     button. Instead of selecting a full line it will extend the selection the
445     end of the logical line only. resource \fBtripleclickwords\fR.
446 root 1.1 .IP "\fB\-insecure\fR" 4
447     .IX Item "-insecure"
448     Enable \*(L"insecure\*(R" mode, which currently enables most of the escape
449     sequences that echo strings. See the resource \fBinsecure\fR for more
450     info.
451     .IP "\fB\-mod\fR \fImodifier\fR" 4
452     .IX Item "-mod modifier"
453     Override detection of Meta modifier with specified key: \fBalt\fR,
454     \&\fBmeta\fR, \fBhyper\fR, \fBsuper\fR, \fBmod1\fR, \fBmod2\fR, \fBmod3\fR, \fBmod4\fR,
455     \&\fBmod5\fR; resource \fImodifier\fR.
456     .IP "\fB\-ssc\fR|\fB+ssc\fR" 4
457     .IX Item "-ssc|+ssc"
458     Turn on/off secondary screen (default enabled); resource
459     \&\fBsecondaryScreen\fR.
460     .IP "\fB\-ssr\fR|\fB+ssr\fR" 4
461     .IX Item "-ssr|+ssr"
462     Turn on/off secondary screen scroll (default enabled); resource
463     \&\fBsecondaryScroll\fR.
464 root 1.28 .IP "\fB\-hold\fR|\fB+hold\fR" 4
465     .IX Item "-hold|+hold"
466     Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
467     will not immediately destroy its window when the program executed within
468     it exits. Instead, it will wait till it is being killed or closed by the
469     user; resource \fBhold\fR.
470 root 1.18 .IP "\fB\-keysym.\fR\fIsym\fR \fIstring\fR" 4
471     .IX Item "-keysym.sym string"
472 root 1.12 Remap a key symbol. See resource \fBkeysym\fR.
473 root 1.18 .IP "\fB\-embed\fR \fIwindowid\fR" 4
474     .IX Item "-embed windowid"
475 root 1.15 Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
476     which enables applications to easily embed a terminal.
477     .Sp
478     Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
479     shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
480     quite a bit, so don't expect it to keep some specific state. It's best to
481     create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
482     .Sp
483 root 1.16 The window will not be destroyed when @@RXVT_NAME@@ exits.
484     .Sp
485 root 1.15 It might be useful to know that @@RXVT_NAME@@ will not close file
486     descriptors passed to it (except for stdin/out/err, of course), so you
487     can use file descriptors to communicate with the programs within the
488     terminal. This works regardless of wether the \f(CW\*(C`\-embed\*(C'\fR option was used or
489     not.
490 root 1.18 .Sp
491     Here is a short Gtk2\-perl snippet that illustrates how this option can be
492     used (a longer example is in \fIdoc/embed\fR):
493     .Sp
494 root 1.20 .Vb 5
495     \& my $rxvt = new Gtk2::Socket;
496     \& $rxvt->signal_connect_after (realize => sub {
497     \& my $xid = $_[0]->window->get_xid;
498     \& system "@@RXVT_NAME@@ -embed $xid &";
499     \& });
500 root 1.18 .Ve
501     .IP "\fB\-pty\-fd\fR \fIfileno\fR" 4
502     .IX Item "-pty-fd fileno"
503     Tells @@RXVT_NAME@@ \s-1NOT\s0 to execute any commands or create a new pty/tty
504     pair but instead use the given filehandle as the tty master. This is
505     useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
506     without having to run a program within it.
507     .Sp
508     If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
509     entries and will not tinker with pty/tty permissions \- you have to do that
510     yourself if you want that.
511     .Sp
512     Here is a example in perl that illustrates how this option can be used (a
513     longer example is in \fIdoc/pty\-fd\fR):
514     .Sp
515     .Vb 2
516     \& use IO::Pty;
517     \& use Fcntl;
518     .Ve
519     .Sp
520 root 1.19 .Vb 4
521 root 1.18 \& my $pty = new IO::Pty;
522     \& fcntl $pty, F_SETFD, 0; # clear close-on-exec
523     \& system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
524 root 1.19 \& close $pty;
525 root 1.18 .Ve
526     .Sp
527     .Vb 3
528     \& # now communicate with rxvt
529     \& my $slave = $pty->slave;
530     \& while (<$slave>) { print $slave "got <$_>\en" }
531     .Ve
532 root 1.1 .SH "RESOURCES (available also as long\-options)"
533     .IX Header "RESOURCES (available also as long-options)"
534     Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long
535     options) compiled into your version.
536     .PP
537     There are two different methods that @@RXVT_NAME@@ can use to get the
538     Xresource data: using the X libraries (Xrm*\-functions) or internal
539     Xresources reader (\fB~/.Xdefaults\fR). For the first method (ie.
540     \&\fB@@RXVT_NAME@@ \-h\fR lists \fBXGetDefaults\fR), you can set and change the
541 root 1.12 resources using X11 tools like \fBxrdb\fR. Many distribution do also load
542     settings from the \fB~/.Xresources\fR file when X starts. @@RXVT_NAME@@
543     will consult the following files/resources in order, with later settings
544     overwriting earlier ones:
545     .PP
546     .Vb 5
547     \& 1. system-wide app-defaults file, either locale-dependent OR global
548     \& 2. app-defaults file in $XAPPLRESDIR
549     \& 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
550     \& 4. SCREEN_RESOURCES for the current screen
551     \& 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
552     .Ve
553 root 1.1 .PP
554     If compiled with internal Xresources support (i.e. \fB@@RXVT_NAME@@ \-h\fR
555     lists \fB.Xdefaults\fR) then \fB@@RXVT_NAME@@\fR accepts application defaults
556     set in XAPPLOADDIR/URxvt (compile\-time defined: usually
557     \&\fB/usr/lib/X11/app\-defaults/URxvt\fR) and resources set in
558     \&\fB~/.Xdefaults\fR, or \fB~/.Xresources\fR if \fB~/.Xdefaults\fR does not exist.
559     Note that when reading X resources, \fB@@RXVT_NAME@@\fR recognizes two
560     class names: \fBXTerm\fR and \fBURxvt\fR. The class name \fBRxvt\fR allows
561     resources common to both \fB@@RXVT_NAME@@\fR and the original \fIrxvt\fR to be
562     easily configured, while the class name \fBURxvt\fR allows resources
563     unique to \fB@@RXVT_NAME@@\fR, notably colours and key\-handling, to be
564     shared between different \fB@@RXVT_NAME@@\fR configurations. If no
565     resources are specified, suitable defaults will be used. Command-line
566     arguments can be used to override resource settings. The following
567     resources are allowed:
568     .IP "\fBgeometry:\fR \fIgeom\fR" 4
569     .IX Item "geometry: geom"
570     Create the window with the specified X window geometry [default 80x24];
571     option \fB\-geometry\fR.
572     .IP "\fBbackground:\fR \fIcolour\fR" 4
573     .IX Item "background: colour"
574     Use the specified colour as the window's background colour [default
575     White]; option \fB\-bg\fR.
576     .IP "\fBforeground:\fR \fIcolour\fR" 4
577     .IX Item "foreground: colour"
578     Use the specified colour as the window's foreground colour [default
579     Black]; option \fB\-fg\fR.
580     .IP "\fBcolor\fR\fIn\fR\fB:\fR \fIcolour\fR" 4
581     .IX Item "colorn: colour"
582     Use the specified colour for the colour value \fIn\fR, where 0\-7
583     corresponds to low-intensity (normal) colours and 8\-15 corresponds to
584     high-intensity (bold = bright foreground, blink = bright background)
585     colours. The canonical names are as follows: 0=black, 1=red, 2=green,
586     3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
587     names used are listed in the \fB\s-1COLORS\s0 \s-1AND\s0 \s-1GRAPHICS\s0\fR section.
588     .Sp
589     Colours higher than 15 cannot be set using resources (yet), but can be
590     changed using an escape command (see @@RXVT_NAME@@(7)).
591     .Sp
592     Colours 16\-79 form a standard 4x4x4 colour cube (the same as xterm with
593     88 colour support). Colours 80\-87 are evenly spaces grey steps.
594     .IP "\fBcolorBD:\fR \fIcolour\fR" 4
595     .IX Item "colorBD: colour"
596     .PD 0
597     .IP "\fBcolorIT:\fR \fIcolour\fR" 4
598     .IX Item "colorIT: colour"
599     .PD
600     Use the specified colour to display bold or italic characters when the
601     foreground colour is the default. If font styles are not available
602 root 1.3 (Compile \fIstyles\fR) and this option is unset, reverse video is used instead.
603 root 1.1 .IP "\fBcolorUL:\fR \fIcolour\fR" 4
604     .IX Item "colorUL: colour"
605     Use the specified colour to display underlined characters when the
606     foreground colour is the default.
607     .IP "\fBcolorRV:\fR \fIcolour\fR" 4
608     .IX Item "colorRV: colour"
609     Use the specified colour as the background for reverse video
610     characters.
611     .IP "\fBunderlineColor:\fR \fIcolour\fR" 4
612     .IX Item "underlineColor: colour"
613     If set, use the specified colour as the colour for the underline
614     itself. If unset, use the foreground colour.
615     .IP "\fBcursorColor:\fR \fIcolour\fR" 4
616     .IX Item "cursorColor: colour"
617     Use the specified colour for the cursor. The default is to use the
618     foreground colour; option \fB\-cr\fR.
619     .IP "\fBcursorColor2:\fR \fIcolour\fR" 4
620     .IX Item "cursorColor2: colour"
621     Use the specified colour for the colour of the cursor text. For this to
622     take effect, \fBcursorColor\fR must also be specified. The default is to
623     use the background colour.
624     .IP "\fBreverseVideo:\fR \fIboolean\fR" 4
625     .IX Item "reverseVideo: boolean"
626     \&\fBTrue\fR: simulate reverse video by foreground and background colours;
627     option \fB\-rv\fR. \fBFalse\fR: regular screen colours [default]; option
628     \&\fB+rv\fR. See note in \fB\s-1COLORS\s0 \s-1AND\s0 \s-1GRAPHICS\s0\fR section.
629     .IP "\fBjumpScroll:\fR \fIboolean\fR" 4
630     .IX Item "jumpScroll: boolean"
631     \&\fBTrue\fR: specify that jump scrolling should be used. When scrolling
632     quickly, fewer screen updates are performed [default]; option \fB\-j\fR.
633     \&\fBFalse\fR: specify that smooth scrolling should be used; option \fB+j\fR.
634     .IP "\fBinheritPixmap:\fR \fIboolean\fR" 4
635     .IX Item "inheritPixmap: boolean"
636     \&\fBTrue\fR: make the background inherit the parent windows' pixmap, giving
637     artificial transparency. \fBFalse\fR: do not inherit the parent windows'
638     pixmap.
639     .IP "\fBfading:\fR \fInumber\fR" 4
640     .IX Item "fading: number"
641 root 1.25 Fade the text by the given percentage when focus is lost; option \fB\-fade\fR.
642     .IP "\fBfadeColor:\fR \fIcolour\fR" 4
643     .IX Item "fadeColor: colour"
644     Fade to this colour, when fading is used (see \fBfading:\fR). The default
645     colour is black; option \fB\-fadecolor\fR.
646 root 1.1 .IP "\fBtintColor:\fR \fIcolour\fR" 4
647     .IX Item "tintColor: colour"
648 root 1.25 Tint the transparent background pixmap with the given colour; option
649     \&\fB\-tint\fR.
650 root 1.1 .IP "\fBshading:\fR \fInumber\fR" 4
651     .IX Item "shading: number"
652     Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent background
653     image in addition to tinting it.
654     .IP "\fBscrollColor:\fR \fIcolour\fR" 4
655     .IX Item "scrollColor: colour"
656     Use the specified colour for the scrollbar [default #B2B2B2].
657     .IP "\fBtroughColor:\fR \fIcolour\fR" 4
658     .IX Item "troughColor: colour"
659     Use the specified colour for the scrollbar's trough area [default
660 root 1.23 #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
661 root 1.1 .IP "\fBborderColor:\fR \fIcolour\fR" 4
662     .IX Item "borderColor: colour"
663     The colour of the border around the text area and between the scrollbar
664     and the text.
665     .IP "\fBbackgroundPixmap:\fR \fIfile[;geom]\fR" 4
666     .IX Item "backgroundPixmap: file[;geom]"
667     Use the specified \s-1XPM\s0 file (note the `.xpm' extension is optional) for
668     the background and also optionally specify its scaling with a geometry
669     string \fBWxH+X+Y\fR, in which \fB\*(L"W\*(R" / \*(L"H\*(R"\fR specify the
670     horizontal/vertical scale (percent) and \fB\*(L"X\*(R" / \*(L"Y\*(R"\fR locate the image
671     centre (percent). A scale of 0 displays the image with tiling. A scale
672     of 1 displays the image without any scaling. A scale of 2 to 9
673     specifies an integer number of images in that direction. No image will
674     be magnified beyond 10 times its original size. The maximum permitted
675     scale is 1000. [default 0x0+50+50]
676     .IP "\fBmenu:\fR \fIfile[;tag]\fR" 4
677     .IX Item "menu: file[;tag]"
678     Read in the specified menu file (note the `.menu' extension is
679     optional) and also optionally specify a starting tag to find. See the
680     reference documentation for details on the syntax for the menuBar.
681     .IP "\fBpath:\fR \fIpath\fR" 4
682     .IX Item "path: path"
683     Specify the colon-delimited search path for finding files (\s-1XPM\s0 and
684     menus), in addition to the paths specified by the \fB\s-1RXVTPATH\s0\fR and
685     \&\fB\s-1PATH\s0\fR environment variables.
686     .IP "\fBfont:\fR \fIfontlist\fR" 4
687     .IX Item "font: fontlist"
688     Select the fonts to be used. This is a comma separated list of font
689     names that are used in turn when trying to display Unicode characters.
690     The first font defines the cell size for characters; other fonts might
691     be smaller, but not larger. A reasonable default font list is always
692     appended to it. option \fB\-fn\fR.
693     .Sp
694     Each font can either be a standard X11 core font (\s-1XLFD\s0) name, with
695 root 1.3 optional prefix \f(CW\*(C`x:\*(C'\fR or a Xft font (Compile \fIxft\fR), prefixed with \f(CW\*(C`xft:\*(C'\fR.
696 root 1.1 .Sp
697     In addition, each font can be prefixed with additional hints and
698     specifications enclosed in square brackets (\f(CW\*(C`[]\*(C'\fR). The only available
699     hint currently is \f(CW\*(C`codeset=codeset\-name\*(C'\fR, and this is only used for Xft
700     fonts.
701     .Sp
702     For example, this font resource
703     .Sp
704     .Vb 5
705     \& URxvt*font: 9x15bold,\e
706     \& -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\e
707     \& -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \e
708     \& [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \e
709     \& xft:Code2000:antialias=false
710     .Ve
711     .Sp
712     specifies five fonts to be used. The first one is \f(CW\*(C`9x15bold\*(C'\fR (actually
713     the iso8859\-1 version of the second font), which is the base font (because
714     it is named first) and thus defines the character cell grid to be 9 pixels
715     wide and 15 pixels high.
716     .Sp
717     The second font is just used to add additional unicode characters not in
718     the base font, likewise the third, which is unfortunately non\-bold, but
719     the bold version of the font does contain less characters, so this is a
720     useful supplement.
721     .Sp
722     The third font is an Xft font with aliasing turned off, and the characters
723     are limited to the \fB\s-1JIS\s0 0208\fR codeset (i.e. japanese kanji). The font
724     contains other characters, but we are not interested in them.
725     .Sp
726     The last font is a useful catch-all font that supplies most of the
727     remaining unicode characters.
728     .IP "\fBboldFont:\fR \fIfontlist\fR" 4
729     .IX Item "boldFont: fontlist"
730     .PD 0
731     .IP "\fBitalicFont:\fR \fIfontlist\fR" 4
732     .IX Item "italicFont: fontlist"
733     .IP "\fBboldItalicFont:\fR \fIfontlist\fR" 4
734     .IX Item "boldItalicFont: fontlist"
735     .PD
736     The font list to use for displaying \fBbold\fR, \fIitalic\fR or \fB\f(BIbold
737     italic\fB\fR characters, respectively.
738     .Sp
739     If specified and non\-empty, then the syntax is the same as for the
740     \&\fBfont\fR\-resource, and the given font list will be used as is, which makes
741     it possible to substitute completely different font styles for bold and
742     italic.
743     .Sp
744     If unset (the default), a suitable font list will be synthesized by
745     \&\*(L"morphing\*(R" the normal text font list into the desired shape. If that is
746     not possible, replacement fonts of the desired shape will be tried.
747     .Sp
748     If set, but empty, then this specific style is disabled and the normal
749     text font will being used for the given style.
750     .IP "\fBselectstyle:\fR \fImode\fR" 4
751     .IX Item "selectstyle: mode"
752     Set mouse selection style to \fBold\fR which is 2.20, \fBoldword\fR which is
753     xterm style with 2.20 old word selection, or anything else which gives
754     xterm style selection.
755     .IP "\fBscrollstyle:\fR \fImode\fR" 4
756     .IX Item "scrollstyle: mode"
757     Set scrollbar style to \fBrxvt\fR, \fBplain\fR, \fBnext\fR or \fBxterm\fR. \fBplain\fR is
758 root 1.23 the author's favourite.
759 root 1.1 .IP "\fBtitle:\fR \fIstring\fR" 4
760     .IX Item "title: string"
761     Set window title string, the default title is the command-line
762     specified after the \fB\-e\fR option, if any, otherwise the application
763     name; option \fB\-title\fR.
764     .IP "\fBiconName:\fR \fIstring\fR" 4
765     .IX Item "iconName: string"
766     Set the name used to label the window's icon or displayed in an icon
767     manager window, it also sets the window's title unless it is explicitly
768     set; option \fB\-n\fR.
769     .IP "\fBmapAlert:\fR \fIboolean\fR" 4
770     .IX Item "mapAlert: boolean"
771     \&\fBTrue\fR: de-iconify (map) on receipt of a bell character. \fBFalse\fR: no
772     de-iconify (map) on receipt of a bell character [default].
773     .IP "\fBvisualBell:\fR \fIboolean\fR" 4
774     .IX Item "visualBell: boolean"
775     \&\fBTrue\fR: use visual bell on receipt of a bell character; option \fB\-vb\fR.
776     \&\fBFalse\fR: no visual bell [default]; option \fB+vb\fR.
777     .IP "\fBloginShell:\fR \fIboolean\fR" 4
778     .IX Item "loginShell: boolean"
779     \&\fBTrue\fR: start as a login shell by prepending a `\-' to \fBargv[0]\fR of
780     the shell; option \fB\-ls\fR. \fBFalse\fR: start as a normal sub-shell
781     [default]; option \fB+ls\fR.
782     .IP "\fButmpInhibit:\fR \fIboolean\fR" 4
783     .IX Item "utmpInhibit: boolean"
784     \&\fBTrue\fR: inhibit writing record into the system log file \fButmp\fR;
785     option \fB\-ut\fR. \fBFalse\fR: write record into the system log file \fButmp\fR
786     [default]; option \fB+ut\fR.
787     .IP "\fBprint\-pipe:\fR \fIstring\fR" 4
788     .IX Item "print-pipe: string"
789     Specify a command pipe for vt100 printer [default \fI\fIlpr\fI\|(1)\fR]. Use
790     \&\fBPrint\fR to initiate a screen dump to the printer and \fBCtrl-Print\fR or
791     \&\fBShift-Print\fR to include the scrollback as well.
792 root 1.24 .Sp
793     The string will be interpreted as if typed into the shell as\-is.
794     .Sp
795     Example:
796     .Sp
797     .Vb 1
798     \& URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
799     .Ve
800     .Sp
801     This creates a new file in your home directory with the screen contents
802     everytime you hit \f(CW\*(C`Print\*(C'\fR.
803 root 1.1 .IP "\fBscrollBar:\fR \fIboolean\fR" 4
804     .IX Item "scrollBar: boolean"
805     \&\fBTrue\fR: enable the scrollbar [default]; option \fB\-sb\fR. \fBFalse\fR:
806     disable the scrollbar; option \fB+sb\fR.
807     .IP "\fBscrollBar_right:\fR \fIboolean\fR" 4
808     .IX Item "scrollBar_right: boolean"
809     \&\fBTrue\fR: place the scrollbar on the right of the window; option \fB\-sr\fR.
810     \&\fBFalse\fR: place the scrollbar on the left of the window; option \fB+sr\fR.
811     .IP "\fBscrollBar_floating:\fR \fIboolean\fR" 4
812     .IX Item "scrollBar_floating: boolean"
813     \&\fBTrue\fR: display an rxvt scrollbar without a trough; option \fB\-st\fR.
814     \&\fBFalse\fR: display an rxvt scrollbar with a trough; option \fB+st\fR.
815     .IP "\fBscrollBar_align:\fR \fImode\fR" 4
816     .IX Item "scrollBar_align: mode"
817     Align the \fBtop\fR, \fBbottom\fR or \fBcentre\fR [default] of the scrollbar
818     thumb with the pointer on middle button press/drag.
819     .IP "\fBscrollTtyOutput:\fR \fIboolean\fR" 4
820     .IX Item "scrollTtyOutput: boolean"
821     \&\fBTrue\fR: scroll to bottom when tty receives output; option \fB\-si\fR.
822     \&\fBFalse\fR: do not scroll to bottom when tty receives output; option
823     \&\fB+si\fR.
824     .IP "\fBscrollWithBuffer:\fR \fIboolean\fR" 4
825     .IX Item "scrollWithBuffer: boolean"
826     \&\fBTrue\fR: scroll with scrollback buffer when tty receives new lines (and
827 root 1.17 \&\fBscrollTtyOutput\fR is False); option \fB\-sw\fR. \fBFalse\fR: do not scroll
828     with scrollback buffer when tty recieves new lines; option \fB+sw\fR.
829 root 1.1 .IP "\fBscrollTtyKeypress:\fR \fIboolean\fR" 4
830     .IX Item "scrollTtyKeypress: boolean"
831     \&\fBTrue\fR: scroll to bottom when a non-special key is pressed. Special keys
832     are those which are intercepted by rxvt-unicode for special handling and
833     are not passed onto the shell; option \fB\-sk\fR. \fBFalse\fR: do not scroll to
834     bottom when a non-special key is pressed; option \fB+sk\fR.
835     .IP "\fBsaveLines:\fR \fInumber\fR" 4
836     .IX Item "saveLines: number"
837     Save \fInumber\fR lines in the scrollback buffer [default 64]. This
838     resource is limited on most machines to 65535; option \fB\-sl\fR.
839     .IP "\fBinternalBorder:\fR \fInumber\fR" 4
840     .IX Item "internalBorder: number"
841     Internal border of \fInumber\fR pixels. This resource is limited to 100;
842     option \fB\-b\fR.
843     .IP "\fBexternalBorder:\fR \fInumber\fR" 4
844     .IX Item "externalBorder: number"
845     External border of \fInumber\fR pixels. This resource is limited to 100;
846     option \fB\-w\fR, \fB\-bw\fR, \fB\-borderwidth\fR.
847     .IP "\fBborderLess:\fR \fIboolean\fR" 4
848     .IX Item "borderLess: boolean"
849     Set \s-1MWM\s0 hints to request a borderless window, i.e. if honoured by the
850     \&\s-1WM\s0, the rxvt-unicode window will not have window decorations; option \fB\-bl\fR.
851     .IP "\fBtermName:\fR \fItermname\fR" 4
852     .IX Item "termName: termname"
853     Specifies the terminal type name to be set in the \fB\s-1TERM\s0\fR environment
854     variable; option \fB\-tn\fR.
855     .IP "\fBlinespace:\fR \fInumber\fR" 4
856     .IX Item "linespace: number"
857     Specifies number of lines (pixel height) to insert between each row of
858     the display [default 0]; option \fB\-lsp\fR.
859     .IP "\fBmeta8:\fR \fIboolean\fR" 4
860     .IX Item "meta8: boolean"
861     \&\fBTrue\fR: handle Meta (Alt) + keypress to set the 8th bit. \fBFalse\fR:
862     handle Meta (Alt) + keypress as an escape prefix [default].
863     .IP "\fBmouseWheelScrollPage:\fR \fIboolean\fR" 4
864     .IX Item "mouseWheelScrollPage: boolean"
865     \&\fBTrue\fR: the mouse wheel scrolls a page full. \fBFalse\fR: the mouse wheel
866     scrolls five lines [default].
867     .IP "\fBpastableTabs:\fR \fIboolean\fR" 4
868     .IX Item "pastableTabs: boolean"
869     \&\fBTrue\fR: store tabs as wide characters. \fBFalse\fR: interpret tabs as cursor
870     movement only; option \f(CW\*(C`\-ptab\*(C'\fR.
871     .IP "\fBcursorBlink:\fR \fIboolean\fR" 4
872     .IX Item "cursorBlink: boolean"
873     \&\fBTrue\fR: blink the cursor. \fBFalse\fR: do not blink the cursor [default];
874     option \fB\-bc\fR.
875     .IP "\fBpointerBlank:\fR \fIboolean\fR" 4
876     .IX Item "pointerBlank: boolean"
877     \&\fBTrue\fR: blank the pointer when a key is pressed or after a set number
878     of seconds of inactivity. \fBFalse\fR: the pointer is always visible
879     [default].
880     .IP "\fBpointerColor:\fR \fIcolour\fR" 4
881     .IX Item "pointerColor: colour"
882     Mouse pointer foreground colour.
883     .IP "\fBpointerColor2:\fR \fIcolour\fR" 4
884     .IX Item "pointerColor2: colour"
885     Mouse pointer background colour.
886     .IP "\fBpointerBlankDelay:\fR \fInumber\fR" 4
887     .IX Item "pointerBlankDelay: number"
888 root 1.21 Specifies number of seconds before blanking the pointer [default 2]. Use a
889     large number (e.g. \f(CW987654321\fR) to effectively disable the timeout.
890 root 1.1 .IP "\fBbackspacekey:\fR \fIstring\fR" 4
891     .IX Item "backspacekey: string"
892     The string to send when the backspace key is pressed. If set to \fB\s-1DEC\s0\fR
893     or unset it will send \fBDelete\fR (code 127) or, if shifted, \fBBackspace\fR
894     (code 8) \- which can be reversed with the appropriate \s-1DEC\s0 private mode
895     escape sequence.
896     .IP "\fBdeletekey:\fR \fIstring\fR" 4
897     .IX Item "deletekey: string"
898     The string to send when the delete key (not the keypad delete key) is
899     pressed. If unset it will send the sequence traditionally associated
900     with the \fBExecute\fR key.
901     .IP "\fBcutchars:\fR \fIstring\fR" 4
902     .IX Item "cutchars: string"
903     The characters used as delimiters for double-click word selection. The
904     built-in default:
905     .Sp
906     \&\fB\s-1BACKSLASH\s0 `"'&()*,;<=>?@[]{|}\fR
907     .IP "\fBpreeditType:\fR \fIstyle\fR" 4
908     .IX Item "preeditType: style"
909     \&\fBOverTheSpot\fR, \fBOffTheSpot\fR, \fBRoot\fR; option \fB\-pt\fR.
910     .IP "\fBinputMethod:\fR \fIname\fR" 4
911     .IX Item "inputMethod: name"
912     \&\fIname\fR of inputMethod to use; option \fB\-im\fR.
913     .IP "\fBimLocale:\fR \fIname\fR" 4
914     .IX Item "imLocale: name"
915 root 1.7 The locale to use for opening the \s-1IM\s0. You can use an \f(CW\*(C`LC_CTYPE\*(C'\fR of e.g.
916     \&\f(CW\*(C`de_DE.UTF\-8\*(C'\fR for normal text processing but \f(CW\*(C`ja_JP.EUC\-JP\*(C'\fR for the
917     input extension to be able to input japanese characters while staying in
918 root 1.1 another locale. option \fB\-imlocale\fR.
919 root 1.7 .IP "\fBimFont:\fR \fIfontset\fR" 4
920     .IX Item "imFont: fontset"
921     Specify the font-set used for \s-1XIM\s0 styles \f(CW\*(C`OverTheSpot\*(C'\fR or
922     \&\f(CW\*(C`OffTheSpot\*(C'\fR. It must be a standard X font set (\s-1XLFD\s0 patterns separated
923     by commas), i.e. it's not in the same format as the other font lists used
924     in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
925     found, preferably one or two pixels differing in size to the base font.
926     option \fB\-imfont\fR.
927     .IP "\fBtripleclickwords:\fR \fIboolean\fR" 4
928     .IX Item "tripleclickwords: boolean"
929     Change the meaning of triple-click selection with the left mouse
930     button. Instead of selecting a full line it will extend the selection to
931     the end of the logical line only. option \fB\-tcw\fR.
932 root 1.1 .IP "\fBinsecure:\fR \fIboolean\fR" 4
933     .IX Item "insecure: boolean"
934     Enables \*(L"insecure\*(R" mode. Rxvt-unicode offers some escape sequences that
935     echo arbitrary strings like the icon name or the locale. This could be
936     abused if somebody gets 8\-bit\-clean access to your display, whether
937 root 1.27 through a mail client displaying mail bodies unfiltered or through
938     \&\fIwrite\fR\|(1) or any other means. Therefore, these sequences are disabled by
939     default. (Note that many other terminals, including xterm, have these
940     sequences enabled by default, which doesn't make it safer, though).
941     .Sp
942     You can enable them by setting this boolean resource or specifying
943     \&\fB\-insecure\fR as an option. At the moment, this enables display\-answer,
944     locale, findfont, icon label and window title requests as well as dynamic
945     menubar dispatch.
946 root 1.1 .IP "\fBmodifier:\fR \fImodifier\fR" 4
947     .IX Item "modifier: modifier"
948     Set the key to be interpreted as the Meta key to: \fBalt\fR, \fBmeta\fR,
949     \&\fBhyper\fR, \fBsuper\fR, \fBmod1\fR, \fBmod2\fR, \fBmod3\fR, \fBmod4\fR, \fBmod5\fR; option
950     \&\fB\-mod\fR.
951     .IP "\fBanswerbackString:\fR \fIstring\fR" 4
952     .IX Item "answerbackString: string"
953     Specify the reply rxvt-unicode sends to the shell when an \s-1ENQ\s0 (control\-E)
954     character is passed through. It may contain escape values as described
955     in the entry on \fBkeysym\fR following.
956     .IP "\fBsecondaryScreen:\fR \fIbool\fR" 4
957     .IX Item "secondaryScreen: bool"
958     Turn on/off secondary screen (default enabled).
959     .IP "\fBsecondaryScroll:\fR \fIbool\fR" 4
960     .IX Item "secondaryScroll: bool"
961     Turn on/off secondary screen scroll (default enabled). If the this
962     option is enabled, scrolls on the secondary screen will change the
963     scrollback buffer and switching to/from the secondary screen will
964     instead scroll the screen up.
965 root 1.28 .IP "\fBhold\fR: \fIbool\fR" 4
966     .IX Item "hold: bool"
967     Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
968     will not immediately destroy its window when the program executed within
969     it exits. Instead, it will wait till it is being killed or closed by the
970     user.
971 root 1.1 .IP "\fBkeysym.\fR\fIsym\fR: \fIstring\fR" 4
972     .IX Item "keysym.sym: string"
973 root 1.3 Compile \fIfrills\fR: Associate \fIstring\fR with keysym \fIsym\fR. The
974     intervening resource name \fBkeysym.\fR cannot be omitted.
975     .Sp
976     The format of \fIsym\fR is "\fI(modifiers\-)key\fR", where \fImodifiers\fR can be
977     any combination of \fBISOLevel3\fR, \fBAppKeypad\fR, \fBControl\fR, \fBNumLock\fR,
978     \&\fBShift\fR, \fBMeta\fR, \fBLock\fR, \fBMod1\fR, \fBMod2\fR, \fBMod3\fR, \fBMod4\fR, \fBMod5\fR,
979     and the abbreviated \fBI\fR, \fBK\fR, \fBC\fR, \fBN\fR, \fBS\fR, \fBM\fR, \fBA\fR, \fBL\fR, \fB1\fR,
980     \&\fB2\fR, \fB3\fR, \fB4\fR, \fB5\fR.
981     .Sp
982     The \fBNumLock\fR, \fBMeta\fR and \fBISOLevel3\fR modifiers are usually aliased to
983     whatever modifier the NumLock key, Meta/Alt keys or \s-1ISO\s0 Level3 Shift/AltGr
984 root 1.7 keys are being mapped. \fBAppKeypad\fR is a synthetic modifier mapped to the
985 root 1.3 current application keymap mode state.
986     .Sp
987     The spellings of \fIkey\fR can be obtained by using \fBxev\fR(1) command or
988     searching keysym macros from \fB/usr/X11R6/include/X11/keysymdef.h\fR and
989     omitting the prefix \fB\s-1XK_\s0\fR. Alternatively you can specify \fIkey\fR by its hex
990     keysym value (\fB0x0000 \- 0xFFFF\fR). Note that the lookup of \fIsym\fRs is not
991     performed in an exact manner; however, the closest match is assured.
992     .Sp
993     \&\fIstring\fR may contain escape values (\f(CW\*(C`\ea\*(C'\fR: bell, \f(CW\*(C`\eb\*(C'\fR: backspace,
994     \&\f(CW\*(C`\ee\*(C'\fR, \f(CW\*(C`\eE\*(C'\fR: escape, \f(CW\*(C`\en\*(C'\fR: newline, \f(CW\*(C`\er\*(C'\fR: carriage return, \f(CW\*(C`\et\*(C'\fR: tab,
995     \&\f(CW\*(C`\e000\*(C'\fR: octal number) or verbatim control characters (\f(CW\*(C`^?\*(C'\fR: delete,
996     \&\f(CW\*(C`^@\*(C'\fR: null, \f(CW\*(C`^A\*(C'\fR ...) and may be enclosed with double quotes so that it
997     can start or end with whitespace.
998 root 1.2 .Sp
999 root 1.12 Please note that you need to double the \f(CW\*(C`\e\*(C'\fR when using
1000     \&\f(CW\*(C`\-\-enable\-xgetdefault\*(C'\fR, as X itself does it's own de-escaping (you can
1001     use \f(CW\*(C`\e033\*(C'\fR instead of \f(CW\*(C`\ee\*(C'\fR (and so on), which will work with both Xt and
1002     @@RXVT_NAME@@'s own processing).
1003     .Sp
1004 root 1.2 You can define a range of keysyms in one shot by providing a \fIstring\fR
1005 root 1.3 with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimeter `/'
1006     should be a character not used by the strings.
1007 root 1.2 .Sp
1008     Its usage can be demonstrated by an example:
1009 root 1.3 .Sp
1010     .Vb 1
1011 root 1.12 \& URxvt.keysym.M-C-0x61: list|\e033<M-C-|abc|>
1012 root 1.3 .Ve
1013 root 1.2 .Sp
1014     The above line is equivalent to the following three lines:
1015 root 1.3 .Sp
1016     .Vb 3
1017 root 1.12 \& URxvt.keysym.Meta-Control-0x61: \e033<M-C-a>
1018     \& URxvt.keysym.Meta-Control-0x62: \e033<M-C-b>
1019     \& URxvt.keysym.Meta-Control-0x63: \e033<M-C-c>
1020 root 1.3 .Ve
1021     .Sp
1022 root 1.12 If \fIstring\fR takes the form of \f(CW\*(C`command:STRING\*(C'\fR, the specified \fB\s-1STRING\s0\fR
1023 root 1.7 is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1024     example the following means "change the current locale to \f(CW\*(C`zh_CN.GBK\*(C'\fR
1025     when Control-Meta-c is being pressed":
1026     .Sp
1027     .Vb 1
1028 root 1.12 \& URxvt.keysym.M-C-c: command:\e033]701;zh_CN.GBK\e007
1029 root 1.7 .Ve
1030     .Sp
1031 root 1.22 Due the the large number of modifier combinations, a defined key mapping
1032     will match if at \fIat least\fR the specified identifiers are being set, and
1033     no other key mappings with those and more bits are being defined. That
1034     means that defining a key map for \f(CW\*(C`a\*(C'\fR will automatically provide
1035     definitions for \f(CW\*(C`Meta\-a\*(C'\fR, \f(CW\*(C`Shift\-a\*(C'\fR and so on, unless some of those are defined
1036     mappings themselves.
1037     .Sp
1038     Unfortunately, this will override built-in key mappings. For example
1039     if you overwrite the \f(CW\*(C`Insert\*(C'\fR key you will disable @@RXVT_NAME@@'s
1040     \&\f(CW\*(C`Shift\-Insert\*(C'\fR mapping. To re-enable that, you can poke \*(L"holes\*(R" into the
1041     user-defined keymap using the \f(CW\*(C`builtin:\*(C'\fR replacement:
1042     .Sp
1043     .Vb 2
1044     \& URxvt.keysym.Insert: <my insert key sequence>
1045     \& URxvt.keysym.S-Insert: builtin:
1046     .Ve
1047     .Sp
1048     The first line defines a mapping for \f(CW\*(C`Insert\*(C'\fR and \fIany\fR combination
1049     of modifiers. The second line re-establishes the default mapping for
1050     \&\f(CW\*(C`Shift\-Insert\*(C'\fR.
1051     .Sp
1052 root 1.7 The following example will map Control\-Meta\-1 and Control\-Meta\-2 to
1053 root 1.12 the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you can have some limited
1054 root 1.7 font-switching at runtime:
1055     .Sp
1056     .Vb 2
1057 root 1.12 \& URxvt.keysym.M-C-1: command:\e033]50;suxuseuro\e007
1058     \& URxvt.keysym.M-C-2: command:\e033]50;9x15bold\e007
1059 root 1.7 .Ve
1060     .Sp
1061 root 1.12 Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1062     info):
1063     .Sp
1064     .Vb 2
1065     \& URxvt.keysym.M-C-3: command:\e033[8;25;80t
1066     \& URxvt.keysym.M-C-4: command:\e033[8;48;110t
1067     .Ve
1068 root 1.1 .SH "THE SCROLLBAR"
1069     .IX Header "THE SCROLLBAR"
1070     Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window
1071     (resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar
1072     or by keystrokes. The normal \fB@@RXVT_NAME@@\fR scrollbar has arrows and
1073     its behaviour is fairly intuitive. The \fBxterm-scrollbar\fR is without
1074     arrows and its behaviour mimics that of \fIxterm\fR
1075     .PP
1076     Scroll down with \fBButton1\fR (\fBxterm-scrollbar\fR) or \fBShift-Next\fR.
1077     Scroll up with \fBButton3\fR (\fBxterm-scrollbar\fR) or \fBShift-Prior\fR.
1078     Continuous scroll with \fBButton2\fR.
1079     .SH "MOUSE REPORTING"
1080     .IX Header "MOUSE REPORTING"
1081     To temporarily override mouse reporting, for either the scrollbar or
1082     the normal text selection/insertion, hold either the Shift or the Meta
1083     (Alt) key while performing the desired mouse action.
1084     .PP
1085     If mouse reporting mode is active, the normal scrollbar actions are
1086     disabled \*(-- on the assumption that we are using a fullscreen
1087 root 1.12 application. Instead, pressing Button1 and Button3 sends \fB\s-1ESC\s0 [ 6 ~\fR
1088     (Next) and \fB\s-1ESC\s0 [ 5 ~\fR (Prior), respectively. Similarly, clicking on the
1089     up and down arrows sends \fB\s-1ESC\s0 [ A\fR (Up) and \fB\s-1ESC\s0 [ B\fR (Down),
1090 root 1.1 respectively.
1091     .SH "TEXT SELECTION AND INSERTION"
1092     .IX Header "TEXT SELECTION AND INSERTION"
1093     The behaviour of text selection and insertion mechanism is similar to
1094     \&\fIxterm\fR(1).
1095     .IP "\fBSelection\fR:" 4
1096     .IX Item "Selection:"
1097 root 1.7 Left click at the beginning of the region, drag to the end of the region
1098     and release; Right click to extend the marked region; Left double-click
1099     to select a word; Left triple-click to select the entire logical line
1100     (which can span multiple screen lines), unless modified by resource
1101     \&\fBtripleclickwords\fR.
1102 root 1.1 .Sp
1103     Starting a selection while pressing the \fBMeta\fR key (or \fBMeta+Ctrl\fR keys)
1104 root 1.29 (Compile: \fIfrills\fR) will create a rectangular selection instead of a
1105     normal one. In this mode, every selected row becomes its own line in the
1106     selection, and trailing whitespace is visually underlined and removed from
1107     the selection.
1108 root 1.1 .IP "\fBInsertion\fR:" 4
1109     .IX Item "Insertion:"
1110     Pressing and releasing the Middle mouse button (or \fBShift-Insert\fR) in
1111     an \fB@@RXVT_NAME@@\fR window causes the current text selection to be
1112     inserted as if it had been typed on the keyboard.
1113     .SH "CHANGING FONTS"
1114     .IX Header "CHANGING FONTS"
1115     Changing fonts (or font sizes, respectively) via the keypad is not yet
1116     supported in rxvt\-unicode. Bug me if you need this.
1117     .PP
1118     You can, however, switch fonts at runtime using escape sequences (and
1119     therefore using the menubar), e.g.:
1120     .PP
1121     .Vb 1
1122 root 1.27 \& printf '\ee]710;%s\e007' "9x15bold,xft:Kochi Gothic"
1123 root 1.1 .Ve
1124     .PP
1125     rxvt-unicode will automatically re-apply these fonts to the output so far.
1126     .SH "ISO 14755 SUPPORT"
1127     .IX Header "ISO 14755 SUPPORT"
1128     \&\s-1ISO\s0 14755 is a standard for entering and viewing unicode characters
1129     and character codes using the keyboard. It consists of 4 parts. The
1130     first part is available rxvt-unicode has been compiled with
1131     \&\f(CW\*(C`\-\-enable\-frills\*(C'\fR, the rest is available when rxvt-unicode was compiled
1132     with \f(CW\*(C`\-\-enable\-iso14755\*(C'\fR.
1133 root 1.7 .IP "* 5.1: Basic method" 4
1134 root 1.1 .IX Item "5.1: Basic method"
1135     This allows you to enter unicode characters using their hexcode.
1136     .Sp
1137     Start by pressing and holding both \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR, then enter
1138     hex-digits (between one and six). Releasing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR will
1139     commit the character as if it were typed directly. While holding down
1140     \&\f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR you can also enter multiple characters by pressing
1141     \&\f(CW\*(C`Space\*(C'\fR, which will commit the current character and lets you start a new
1142     one.
1143     .Sp
1144     As an example of use, imagine a business card with a japanese e\-mail
1145     address, which you cannot type. Fortunately, the card has the e\-mail
1146     address printed as hexcodes, e.g. \f(CW\*(C`671d 65e5\*(C'\fR. You can enter this easily
1147     by pressing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR, followed by \f(CW\*(C`6\-7\-1\-D\-SPACE\-6\-5\-E\-5\*(C'\fR,
1148     followed by releasing the modifier keys.
1149 root 1.7 .IP "* 5.2: Keyboard symbols entry method" 4
1150 root 1.1 .IX Item "5.2: Keyboard symbols entry method"
1151     This mode lets you input characters representing the keycap symbols of
1152     your keyboard, if representable in the current locale encoding.
1153     .Sp
1154     Start by pressing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then releasing
1155     them. The next special key (cursor keys, home etc.) you enter will not
1156     invoke it's usual function but instead will insert the corresponding
1157     keycap symbol. The symbol will only be entered when the key has been
1158     released, otherwise pressing e.g. \f(CW\*(C`Shift\*(C'\fR would enter the symbol for
1159     \&\f(CW\*(C`ISO Level 2 Switch\*(C'\fR, although your intention might have been to enter a
1160     reverse tab (Shift\-Tab).
1161 root 1.7 .IP "* 5.3: Screen-selection entry method" 4
1162 root 1.1 .IX Item "5.3: Screen-selection entry method"
1163     While this is implemented already (it's basically the selection
1164     mechanism), it could be extended by displaying a unicode character map.
1165 root 1.7 .IP "* 5.4: Feedback method for identifying displayed characters for later input" 4
1166 root 1.1 .IX Item "5.4: Feedback method for identifying displayed characters for later input"
1167     This method lets you display the unicode character code associated with
1168     characters already displayed.
1169     .Sp
1170     You enter this mode by holding down \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then
1171     pressing and holding the left mouse button and moving around. The unicode
1172     hex code(s) (it might be a combining character) of the character under the
1173     pointer is displayed until you release \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR.
1174     .Sp
1175     In addition to the hex codes it will display the font used to draw this
1176     character \- due to implementation reasons, characters combined with
1177     combining characters, line drawing characters and unknown characters will
1178     always be drawn using the built-in support font.
1179     .PP
1180     With respect to conformance, rxvt-unicode is supposed to be compliant to
1181     both scenario A and B of \s-1ISO\s0 14755, including part 5.2.
1182     .SH "LOGIN STAMP"
1183     .IX Header "LOGIN STAMP"
1184 root 1.7 \&\fB@@RXVT_NAME@@\fR tries to write an entry into the \fIutmp\fR(5) file so that
1185     it can be seen via the \fI\fIwho\fI\|(1)\fR command, and can accept messages. To
1186     allow this feature, \fB@@RXVT_NAME@@\fR may need to be installed setuid root
1187     on some systems or setgid to root or to some other group on others.
1188 root 1.1 .SH "COLORS AND GRAPHICS"
1189     .IX Header "COLORS AND GRAPHICS"
1190     In addition to the default foreground and background colours,
1191     \&\fB@@RXVT_NAME@@\fR can display up to 16 colours (8 \s-1ANSI\s0 colours plus
1192     high-intensity bold/blink versions of the same). Here is a list of the
1193     colours with their \fBrgb.txt\fR names.
1194     .TS
1195     l l l .
1196     color0 (black) = Black
1197     color1 (red) = Red3
1198     color2 (green) = Green3
1199     color3 (yellow) = Yellow3
1200     color4 (blue) = Blue3
1201     color5 (magenta) = Magenta3
1202     color6 (cyan) = Cyan3
1203     color7 (white) = AntiqueWhite
1204     color8 (bright black) = Grey25
1205     color9 (bright red) = Red
1206     color10 (bright green) = Green
1207     color11 (bright yellow) = Yellow
1208     color12 (bright blue) = Blue
1209     color13 (bright magenta) = Magenta
1210     color14 (bright cyan) = Cyan
1211     color15 (bright white) = White
1212     foreground = Black
1213     background = White
1214     .TE
1215    
1216     .PP
1217     It is also possible to specify the colour values of \fBforeground\fR,
1218     \&\fBbackground\fR, \fBcursorColor\fR, \fBcursorColor2\fR, \fBcolorBD\fR, \fBcolorUL\fR as
1219     a number 0\-15, as a convenient shorthand to reference the colour name of
1220     color0\-color15.
1221     .PP
1222     Note that \fB\-rv\fR (\fB\*(L"reverseVideo: True\*(R"\fR) simulates reverse video by
1223     always swapping the foreground/background colours. This is in contrast to
1224     \&\fIxterm\fR(1) where the colours are only swapped if they have not otherwise
1225     been specified. For example,
1226     .IP "\fB@@RXVT_NAME@@ \-fg Black \-bg White \-rv\fR" 4
1227     .IX Item "@@RXVT_NAME@@ -fg Black -bg White -rv"
1228     would yield White on Black, while on \fIxterm\fR(1) it would yield Black
1229     on White.
1230     .SH "ENVIRONMENT"
1231     .IX Header "ENVIRONMENT"
1232 root 1.12 \&\fB@@RXVT_NAME@@\fR sets and/or uses the following environment variables:
1233     .IP "\fB\s-1TERM\s0\fR" 4
1234     .IX Item "TERM"
1235     Normally set to \f(CW\*(C`rxvt\-unicode\*(C'\fR, unless overwritten at configure time, via
1236     resources or on the commandline.
1237     .IP "\fB\s-1COLORTERM\s0\fR" 4
1238     .IX Item "COLORTERM"
1239     Either \f(CW\*(C`rxvt\*(C'\fR, \f(CW\*(C`rxvt\-xpm\*(C'\fR, depending on wether @@RXVT_NAME@@ was
1240     compiled with \s-1XPM\s0 support, and optionally with the added extension
1241     \&\f(CW\*(C`\-mono\*(C'\fR to indicate that rxvt-unicode runs on a monochrome screen.
1242     .IP "\fB\s-1COLORFGBG\s0\fR" 4
1243     .IX Item "COLORFGBG"
1244     Set to a string of the form \f(CW\*(C`fg;bg\*(C'\fR or \f(CW\*(C`fg;xpm;bg\*(C'\fR, where \f(CW\*(C`fg\*(C'\fR is
1245     the colour code used as default foreground/text colour (or the string
1246     \&\f(CW\*(C`default\*(C'\fR to indicate that the default-colour escape sequence is to be
1247     used), \f(CW\*(C`bg\*(C'\fR is the colour code used as default background colour (or the
1248     string \f(CW\*(C`default\*(C'\fR), and \f(CW\*(C`xpm\*(C'\fR is the string \f(CW\*(C`default\*(C'\fR if @@RXVT_NAME@@
1249 root 1.13 was compiled with \s-1XPM\s0 support. Libraries like \f(CW\*(C`ncurses\*(C'\fR and \f(CW\*(C`slang\*(C'\fR can
1250     (and do) use this information to optimize screen output.
1251 root 1.12 .IP "\fB\s-1WINDOWID\s0\fR" 4
1252     .IX Item "WINDOWID"
1253     Set to the (decimal) X Window \s-1ID\s0 of the @@RXVT_NAME@@ window (the toplevel
1254     window, which usually has subwindows for the scrollbar, the terminal
1255     window and so on).
1256     .IP "\fB\s-1TERMINFO\s0\fR" 4
1257     .IX Item "TERMINFO"
1258     Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1259     \&\f(CW\*(C`\-\-with\-terminfo=PATH\*(C'\fR.
1260     .IP "\fB\s-1DISPLAY\s0\fR" 4
1261     .IX Item "DISPLAY"
1262     Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1263     display in it's child processes.
1264     .IP "\fB\s-1SHELL\s0\fR" 4
1265     .IX Item "SHELL"
1266     The shell to be used for command execution, defaults to \f(CW\*(C`/bin/sh\*(C'\fR.
1267     .IP "\fB\s-1RXVTPATH\s0\fR" 4
1268     .IX Item "RXVTPATH"
1269     The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1270     files.
1271     .IP "\fB\s-1PATH\s0\fR" 4
1272     .IX Item "PATH"
1273     Used in the same way as \f(CW\*(C`RXVTPATH\*(C'\fR.
1274     .IP "\fB\s-1RXVT_SOCKET\s0\fR" 4
1275     .IX Item "RXVT_SOCKET"
1276     The unix domain socket path used by @@RXVT_NAME@@c(1) and
1277     @@RXVT_NAME@@d(1).
1278     .Sp
1279 root 1.24 Default \fI$HOME/.rxvt\-unicode\-\fI<nodename\fI\fR.
1280 root 1.12 .IP "\fB\s-1HOME\s0\fR" 4
1281     .IX Item "HOME"
1282     Used to locate the default directory for the unix domain socket for
1283     daemon communications and to locate various resource files (such as
1284     \&\f(CW\*(C`.Xdefaults\*(C'\fR)
1285     .IP "\fB\s-1XAPPLRESDIR\s0\fR" 4
1286     .IX Item "XAPPLRESDIR"
1287     Directory where various X resource files are being located.
1288     .IP "\fB\s-1XENVIRONMENT\s0\fR" 4
1289     .IX Item "XENVIRONMENT"
1290     If set and accessible, gives the name of a X resource file to be loaded by
1291     @@RXVT_NAME@@.
1292 root 1.1 .SH "FILES"
1293     .IX Header "FILES"
1294     .IP "\fB/usr/lib/X11/rgb.txt\fR" 4
1295     .IX Item "/usr/lib/X11/rgb.txt"
1296     Color names.
1297     .SH "SEE ALSO"
1298     .IX Header "SEE ALSO"
1299 root 1.24 @@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), \fIxterm\fR\|(1), \fIsh\fR\|(1), \fIresize\fR\|(1), X(1), \fIpty\fR\|(4), \fItty\fR\|(4), \fIutmp\fR\|(5)
1300 root 1.1 .SH "CURRENT PROJECT COORDINATOR"
1301     .IX Header "CURRENT PROJECT COORDINATOR"
1302     .IP "Project Coordinator" 4
1303     .IX Item "Project Coordinator"
1304 root 1.14 Marc A. Lehmann <rxvt\-unicode@schmorp.de>
1305 root 1.1 .Sp
1306 root 1.14 <http://software.schmorp.de/#rxvt\-unicode>
1307 root 1.1 .SH "AUTHORS"
1308     .IX Header "AUTHORS"
1309     .IP "John Bovey" 4
1310     .IX Item "John Bovey"
1311     University of Kent, 1992, wrote the original Xvt.
1312     .IP "Rob Nation <nation@rocket.sanders.lockheed.com>" 4
1313     .IX Item "Rob Nation <nation@rocket.sanders.lockheed.com>"
1314     very heavily modified Xvt and came up with Rxvt
1315     .IP "Angelo Haritsis <ah@doc.ic.ac.uk>" 4
1316     .IX Item "Angelo Haritsis <ah@doc.ic.ac.uk>"
1317     wrote the Greek Keyboard Input (no longer in code)
1318     .IP "mj olesen <olesen@me.QueensU.CA>" 4
1319     .IX Item "mj olesen <olesen@me.QueensU.CA>"
1320     Wrote the menu system.
1321     .Sp
1322     Project Coordinator (changes.txt 2.11 to 2.21)
1323     .IP "Oezguer Kesim <kesim@math.fu\-berlin.de>" 4
1324     .IX Item "Oezguer Kesim <kesim@math.fu-berlin.de>"
1325     Project Coordinator (changes.txt 2.21a to 2.4.5)
1326     .IP "Geoff Wing <gcw@pobox.com>" 4
1327     .IX Item "Geoff Wing <gcw@pobox.com>"
1328     Rewrote screen display and text selection routines. Project Coordinator
1329     (changes.txt 2.4.6 \- rxvt\-unicode)
1330 root 1.14 .IP "Marc Alexander Lehmann <rxvt\-unicode@schmorp.de>" 4
1331     .IX Item "Marc Alexander Lehmann <rxvt-unicode@schmorp.de>"
1332 root 1.1 Forked rxvt\-unicode, rewrote most of the display code and internal
1333     character handling to store text in unicode, improve xterm
1334     compatibility and apply numerous other bugfixes and extensions.
1335     .Sp
1336     Project Coordinator (Changes 1.0 \-)