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