[ViewVC] Diff of: cvs/rxvt-unicode/doc/rxvt.1.pod

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.5 by root, Sat Aug 14 03:00:32 2004 UTC vs.
Revision 1.83 by root, Tue Jan 3 22:28:07 2006 UTC

…		…
11	B<rxvt-unicode>, version B<@@RXVT_VERSION@@>, is a colour vt102 terminal	11	B<rxvt-unicode>, version B<@@RXVT_VERSION@@>, is a colour vt102 terminal
12	emulator intended as an I<xterm>(1) replacement for users who do not	12	emulator intended as an I<xterm>(1) replacement for users who do not
13	require features such as Tektronix 4014 emulation and toolkit-style	13	require features such as Tektronix 4014 emulation and toolkit-style
14	configurability. As a result, B<rxvt-unicode> uses much less swap space --	14	configurability. As a result, B<rxvt-unicode> uses much less swap space --
15	a significant advantage on a machine serving many X sessions.	15	a significant advantage on a machine serving many X sessions.
		16
		17	=head1 FREQUENTLY ASKED QUESTIONS
		18
		19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
		20	frequently asked questions and answer to them and some common
		21	problems. That document is also accessible on the World-Wide-Web at
		22	L<http://cvs.schmorp.de/browse/checkout/rxvt-unicode/doc/rxvt.7.html>.
16		23
17	=head1 RXVT-UNICODE VS. RXVT	24	=head1 RXVT-UNICODE VS. RXVT
18		25
19	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode	26	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
20	internally. That means it can store and display most scripts in the	27	internally. That means it can store and display most scripts in the
…		…
24	like tibetan or devenagari. Don't expect pretty output when using these	31	like tibetan or devenagari. Don't expect pretty output when using these
25	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
26	fine, though. A somewhat difficult case are left-to-right scripts, such	33	fine, though. A somewhat difficult case are left-to-right scripts, such
27	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
28	belong into the application, not the terminal emulator (too many things --	35	belong into the application, not the terminal emulator (too many things --
29	such as cursor-movement -- break othwerwise).	36	such as cursor-movement while editing -- break otherwise), but that might
		37	change.
30		38
		39	If you are looking for a terminal that supports more exotic scripts, let
		40	me recommend C<mlterm>, which is a very userfriendly, lean and clean
		41	terminal emulator. In fact, the reason rxvt-unicode was born was solely
		42	because the author couldn't get C<mlterm> to use one font for latin1 and
		43	another for japanese.
		44
31	Another design rationale was the use of multiple fonts to display	45	Therefore another design rationale was the use of multiple fonts to
32	characters: The idea of a single unicode font which many other programs	46	display characters: The idea of a single unicode font which many other
33	force onto it's users never made sense to me: You should be able to choose	47	programs force onto it's users never made sense to me: You should be able
34	any font for any script.	48	to choose any font for any script freely.
35		49
36	Apart from that, rxvt-unicode is also much better internationalised than	50	Apart from that, rxvt-unicode is also much better internationalised than
37	it's predecessor, supports things such as XFT and ISO 14755 that are handy	51	it's predecessor, supports things such as XFT and ISO 14755 that are handy
38	in i18n-environments, is faster, and has a lot less bugs than the original	52	in i18n-environments, is faster, and has a lot less bugs than the original
39	rxvt. This all in addition to dozens of other small improvements.	53	rxvt. This all in addition to dozens of other small improvements.
…		…
46	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and	60	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
47	@@RXVT_NAME@@c(1) (client).	61	@@RXVT_NAME@@c(1) (client).
48		62
49	It also makes technical information about escape sequences (which have	63	It also makes technical information about escape sequences (which have
50	been extended) easier accessible: see @@RXVT_NAME@@(7) for technical	64	been extended) easier accessible: see @@RXVT_NAME@@(7) for technical
51	reference documentation (escape sequences etc.) and the FAQ section at the	65	reference documentation (escape sequences etc.).
52	end of this document.
53		66
54	=head1 OPTIONS	67	=head1 OPTIONS
55		68
56	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed	69	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
57	below. In keeping with the smaller-is-better philosophy, options may be	70	below. In keeping with the smaller-is-better philosophy, options may be
…		…
92		105
93	=item B<-j>\|B<+j>	106	=item B<-j>\|B<+j>
94		107
95	Turn on/off jump scrolling; resource B<jumpScroll>.	108	Turn on/off jump scrolling; resource B<jumpScroll>.
96		109
97	=item B<-ip>\|B<+ip>	110	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>
98		111
99	Turn on/off inheriting parent window's pixmap. Alternative form is	112	Turn on/off inheriting parent window's pixmap. Alternative form is
100	B<-tr>; resource B<inheritPixmap>.	113	B<-tr>; resource B<inheritPixmap>.
101		114
102	=item B<-fade> I<number>	115	=item B<-fade> I<number>
103		116
104	Fade the text by the given percentage when focus is lost.	117	Fade the text by the given percentage when focus is lost. Small values
		118	fade a little only, 100 completely replaces all colours by the fade
		119	colour; resource B<fading>.
		120
		121	=item B<-fadecolor> I<colour>
		122
		123	Fade to this colour when fading is used (see B<-fade>). The default colour
		124	is black. resource B<fadeColor>.
105		125
106	=item B<-tint> I<colour>	126	=item B<-tint> I<colour>
107		127
108	Tint the transparent background pixmap with the given colour when	128	Tint the transparent background pixmap with the given colour when
109	transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>	129	transparency is enabled with B<-tr> or B<-ip>. This only works for
110	option that can be used to brighten or darken the image in addition to	130	non-tiled backgrounds, currently. See also the B<-sh> option that can be
111	tinting it.	131	used to brighten or darken the image in addition to tinting it; resource
		132	I<tintColor>. Example:
		133
		134	@@RXVT_NAME@@ -tr -tint blue -sh 40
112		135
113	=item B<-sh>	136	=item B<-sh>
114		137
115	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	138	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
116	background image in addition to tinting it (i.e. B<-tint> must be	139	background image in addition to tinting it (i.e. B<-tint> must be
117	specified, too).	140	specified, too, e.g. C<-tint white>).
118		141
119	=item B<-bg> I<colour>	142	=item B<-bg> I<colour>
120		143
121	Window background colour; resource B<background>.	144	Window background colour; resource B<background>.
122		145
…		…
125	Window foreground colour; resource B<foreground>.	148	Window foreground colour; resource B<foreground>.
126		149
127	=item B<-pixmap> I<file[;geom]>	150	=item B<-pixmap> I<file[;geom]>
128		151
129	Compile I<XPM>: Specify XPM file for the background and also optionally	152	Compile I<XPM>: Specify XPM file for the background and also optionally
130	specify its scaling with a geometry string. Note you may need to add	153	specify its scaling with a geometry string. Note you may need to
131	quotes to avoid special shell interpretation of the `;' in the	154	add quotes to avoid special shell interpretation of the C<;> in the
132	command-line; resource B<backgroundPixmap>.	155	command-line; resource B<backgroundPixmap>.
133		156
134	=item B<-cr> I<colour>	157	=item B<-cr> I<colour>
135		158
136	The cursor colour; resource B<cursorColor>.	159	The cursor colour; resource B<cursorColor>.
…		…
143		166
144	The mouse pointer background colour; resource B<pointerColor2>.	167	The mouse pointer background colour; resource B<pointerColor2>.
145		168
146	=item B<-bd> I<colour>	169	=item B<-bd> I<colour>
147		170
148	The colour of the border between the xterm scrollbar and the text;	171	The colour of the border around the text area and between the scrollbar and the text;
149	resource B<borderColor>.	172	resource B<borderColor>.
150		173
151	=item B<-fn> I<fontname>	174	=item B<-fn> I<fontlist>
152		175
153	Select the fonts to be used. This is a comma seperated list of font	176	Select the fonts to be used. This is a comma separated list of font names
154	names that are used in turn when trying to display Unicode characters.	177	that are used in turn when trying to display Unicode characters. The
155	The first font defines the cell size for characters; other fonts might	178	first font defines the cell size for characters; other fonts might be
156	be smaller, but not larger. A reasonable default font list is always	179	smaller, but not (in general) larger. A (hopefully) reasonable default
157	appended to it. resource B<font>.	180	font list is always appended to it. See resource B<font> for more details.
		181
		182	In short, to specify an X11 core font, just specify it's name or prefix it
		183	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
		184	e.g.:
		185
		186	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
		187	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
158		188
159	See also the question "How does rxvt-unicode choose fonts?" in the FAQ	189	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
160	section.	190	section of @@RXVT_NAME@@(7).
161		191
		192	=item B<-fb> I<fontlist>
		193
		194	Compile font-styles: The bold font list to use when B<bold> characters are to
		195	be printed. See resource B<boldFont> for details.
		196
		197	=item B<-fi> I<fontlist>
		198
		199	Compile font-styles: The italic font list to use when I<italic> characters are to
		200	be printed. See resource B<italicFont> for details.
		201
		202	=item B<-fbi> I<fontlist>
		203
		204	Compile font-styles: The bold italic font list to use when B<< I<bold
		205	italic> >> characters are to be printed. See resource B<boldItalicFont>
		206	for details.
		207
162	=item B<-rb>\|B<+rb>	208	=item B<-is>\|B<+is>
163		209
164	Enable "real bold" support. When this option is on, bold text will be	210	Compile font-styles: Bold/Italic font styles imply high intensity
165	displayed using the first available bold font in the font list. Bold	211	foreground/background (default). See resource B<intensityStyles> for
166	fonts should thus be specified in the font list after their	212	details.
167	corresponding regular fonts. If no bold font can be found, a regular
168	font will be used. resource B<realBold>.
169		213
170	=item B<-name> I<name>	214	=item B<-name> I<name>
171		215
172	Specify the application name under which resources are to be obtained,	216	Specify the application name under which resources are to be obtained,
173	rather than the default executable file name. Name should not contain	217	rather than the default executable file name. Name should not contain
…		…
211		255
212	Put scrollbar on right/left; resource B<scrollBar_right>.	256	Put scrollbar on right/left; resource B<scrollBar_right>.
213		257
214	=item B<-st>\|B<+st>	258	=item B<-st>\|B<+st>
215		259
216	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	260	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
217	resource B<scrollBar_floating>.	261	resource B<scrollBar_floating>.
		262
		263	=item B<-ptab>\|B<+ptab>
		264
		265	If enabled (default), "Horizontal Tab" characters are being stored as
		266	actual wide characters in the screen buffer, which makes it possible to
		267	select and paste them. Since a horizontal tab is a cursor movement and
		268	not an actual glyph, this can sometimes be visually annoying as the cursor
		269	on a tab character is displayed as a wide cursor; resource B<pastableTabs>.
218		270
219	=item B<-bc>\|B<+bc>	271	=item B<-bc>\|B<+bc>
220		272
221	Blink the cursor; resource B<cursorBlink>.	273	Blink the cursor; resource B<cursorBlink>.
222		274
…		…
247	if honoured by the WM, the rxvt-unicode window will not have window	299	if honoured by the WM, the rxvt-unicode window will not have window
248	decorations; resource B<borderLess>.	300	decorations; resource B<borderLess>.
249		301
250	=item B<-lsp> I<number>	302	=item B<-lsp> I<number>
251		303
252	Compile I<linespace>: Lines (pixel height) to insert between each row	304	Compile I<frills>: Lines (pixel height) to insert between each row of
253	of the display; resource B<linespace>.	305	the display. Useful to work around font rendering problems; resource
		306	B<linespace>.
254		307
255	=item B<-tn> I<termname>	308	=item B<-tn> I<termname>
256		309
257	This option specifies the name of the terminal type to be set in the	310	This option specifies the name of the terminal type to be set in the
258	B<TERM> environment variable. This terminal type must exist in the	311	B<TERM> environment variable. This terminal type must exist in the
…		…
267	given on the command line. If this option is used, it must be the last	320	given on the command line. If this option is used, it must be the last
268	on the command-line. If there is no B<-e> option then the default is to	321	on the command-line. If there is no B<-e> option then the default is to
269	run the program specified by the B<SHELL> environment variable or,	322	run the program specified by the B<SHELL> environment variable or,
270	failing that, I<sh(1)>.	323	failing that, I<sh(1)>.
271		324
		325	Please note that you must specify a program with arguments. If you want to
		326	run shell commands, you have to specify the shell, like this:
		327
		328	@@RXVT_NAME@@ -e sh -c "shell commands"
		329
272	=item B<-title> I<text>	330	=item B<-title> I<text>
273		331
274	Window title (B<-T> still respected); the default title is the basename	332	Window title (B<-T> still respected); the default title is the basename
275	of the program specified after the B<-e> option, if any, otherwise the	333	of the program specified after the B<-e> option, if any, otherwise the
276	application name; resource B<title>.	334	application name; resource B<title>.
…		…
294		352
295	Compile I<XIM>: input method name. resource B<inputMethod>.	353	Compile I<XIM>: input method name. resource B<inputMethod>.
296		354
297	=item B<-imlocale> I<string>	355	=item B<-imlocale> I<string>
298		356
299	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	357	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
300	de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input	358	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
301	extension to be able to input japanese characters while staying in	359	input extension to be able to input japanese characters while staying in
302	another locale.	360	another locale. resource B<imLocale>.
		361
		362	=item B<-imfont> I<fontset>
		363
		364	Set the font set to use for the X Input Method, see resource B<imFont>
		365	for more info.
		366
		367	=item B<-tcw>
		368
		369	Change the meaning of triple-click selection with the left mouse
		370	button. Instead of selecting a full line it will extend the selection the
		371	end of the logical line only. resource B<tripleclickwords>.
303		372
304	=item B<-insecure>	373	=item B<-insecure>
305		374
306	Enable "insecure" mode, which currently enables most of the escape	375	Enable "insecure" mode, which currently enables most of the escape
307	sequences that echo strings. See the resource B<insecure> for more	376	sequences that echo strings. See the resource B<insecure> for more
…		…
321	=item B<-ssr>\|B<+ssr>	390	=item B<-ssr>\|B<+ssr>
322		391
323	Turn on/off secondary screen scroll (default enabled); resource	392	Turn on/off secondary screen scroll (default enabled); resource
324	B<secondaryScroll>.	393	B<secondaryScroll>.
325		394
		395	=item B<-hold>\|B<+hold>
		396
		397	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		398	will not immediately destroy its window when the program executed within
		399	it exits. Instead, it will wait till it is being killed or closed by the
		400	user; resource B<hold>.
		401
		402	=item B<-keysym.>I<sym> I<string>
		403
		404	Remap a key symbol. See resource B<keysym>.
		405
		406	=item B<-embed> I<windowid>
		407
		408	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
		409	which enables applications to easily embed a terminal.
		410
		411	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
		412	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
		413	quite a bit, so don't expect it to keep some specific state. It's best to
		414	create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
		415
		416	The window will not be destroyed when @@RXVT_NAME@@ exits.
		417
		418	It might be useful to know that @@RXVT_NAME@@ will not close file
		419	descriptors passed to it (except for stdin/out/err, of course), so you
		420	can use file descriptors to communicate with the programs within the
		421	terminal. This works regardless of wether the C<-embed> option was used or
		422	not.
		423
		424	Here is a short Gtk2-perl snippet that illustrates how this option can be
		425	used (a longer example is in F<doc/embed>):
		426
		427	my $rxvt = new Gtk2::Socket;
		428	$rxvt->signal_connect_after (realize => sub {
		429	my $xid = $_[0]->window->get_xid;
		430	system "@@RXVT_NAME@@ -embed $xid &";
		431	});
		432
		433	=item B<-pty-fd> I<fileno>
		434
		435	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
		436	pair but instead use the given filehandle as the tty master. This is
		437	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
		438	without having to run a program within it.
		439
		440	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
		441	entries and will not tinker with pty/tty permissions - you have to do that
		442	yourself if you want that.
		443
		444	Here is a example in perl that illustrates how this option can be used (a
		445	longer example is in F<doc/pty-fd>):
		446
		447	use IO::Pty;
		448	use Fcntl;
		449
		450	my $pty = new IO::Pty;
		451	fcntl $pty, F_SETFD, 0; # clear close-on-exec
		452	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		453	close $pty;
		454
		455	# now communicate with rxvt
		456	my $slave = $pty->slave;
		457	while (<$slave>) { print $slave "got <$_>\n" }
		458
326	=item B<-xrm> I<resourcestring>	459	=item B<-pe> I<string>
327		460
328	No effect on rxvt-unicode. Simply passes through an argument to be made	461	Colon-separated list of perl extension scripts to use in this terminal instance. See resource B<perl-ext>.
329	available in the instance's argument list. Appears in I<WM_COMMAND> in
330	some window managers.
331		462
332	=back	463	=back
333		464
334	=head1 RESOURCES (available also as long-options)	465	=head1 RESOURCES (available also as long-options)
335		466
…		…
338		469
339	There are two different methods that @@RXVT_NAME@@ can use to get the	470	There are two different methods that @@RXVT_NAME@@ can use to get the
340	Xresource data: using the X libraries (Xrm*-functions) or internal	471	Xresource data: using the X libraries (Xrm*-functions) or internal
341	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	472	Xresources reader (B<~/.Xdefaults>). For the first method (ie.
342	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	473	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the
343	resources using X11 tools like B<xset>. Many distribution do also load	474	resources using X11 tools like B<xrdb>. Many distribution do also load
344	settings from the B<~/.Xresources> file when X starts.	475	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
		476	will consult the following files/resources in order, with later settings
		477	overwriting earlier ones:
		478
		479	1. system-wide app-defaults file, either locale-dependent OR global
		480	2. app-defaults file in $XAPPLRESDIR
		481	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
		482	4. SCREEN_RESOURCES for the current screen
		483	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
345		484
346	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>	485	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
347	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults	486	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
348	set in XAPPLOADDIR/URxvt (compile-time defined: usually	487	set in XAPPLOADDIR/URxvt (compile-time defined: usually
349	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	488	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
…		…
382	high-intensity (bold = bright foreground, blink = bright background)	521	high-intensity (bold = bright foreground, blink = bright background)
383	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	522	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
384	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	523	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
385	names used are listed in the B<COLORS AND GRAPHICS> section.	524	names used are listed in the B<COLORS AND GRAPHICS> section.
386		525
		526	Colours higher than 15 cannot be set using resources (yet), but can be
		527	changed using an escape command (see @@RXVT_NAME@@(7)).
		528
		529	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
		530	88 colour support). Colours 80-87 are evenly spaces grey steps.
		531
387	=item B<colorBD:> I<colour>	532	=item B<colorBD:> I<colour>
388		533
		534	=item B<colorIT:> I<colour>
		535
389	Use the specified colour to display bold characters when the foreground	536	Use the specified colour to display bold or italic characters when the
390	colour is the default. This option will be ignored if B<realBold> is	537	foreground colour is the default. If font styles are not available
391	enabled.	538	(Compile I<styles>) and this option is unset, reverse video is used instead.
392		539
393	=item B<colorUL:> I<colour>	540	=item B<colorUL:> I<colour>
394		541
395	Use the specified colour to display underlined characters when the	542	Use the specified colour to display underlined characters when the
396	foreground colour is the default.	543	foreground colour is the default.
397		544
398	=item B<colorRV:> I<colour>	545	=item B<colorRV:> I<colour>
399		546
400	Use the specified colour as the background for reverse video	547	Use the specified colour as the background for reverse video
401	characters.	548	characters.
		549
		550	=item B<underlineColor:> I<colour>
		551
		552	If set, use the specified colour as the colour for the underline
		553	itself. If unset, use the foreground colour.
402		554
403	=item B<cursorColor:> I<colour>	555	=item B<cursorColor:> I<colour>
404		556
405	Use the specified colour for the cursor. The default is to use the	557	Use the specified colour for the cursor. The default is to use the
406	foreground colour; option B<-cr>.	558	foreground colour; option B<-cr>.
…		…
429	artificial transparency. B<False>: do not inherit the parent windows'	581	artificial transparency. B<False>: do not inherit the parent windows'
430	pixmap.	582	pixmap.
431		583
432	=item B<fading:> I<number>	584	=item B<fading:> I<number>
433		585
434	Fade the text by the given percentage when focus is lost.	586	Fade the text by the given percentage when focus is lost; option B<-fade>.
		587
		588	=item B<fadeColor:> I<colour>
		589
		590	Fade to this colour, when fading is used (see B<fading:>). The default
		591	colour is black; option B<-fadecolor>.
435		592
436	=item B<tintColor:> I<colour>	593	=item B<tintColor:> I<colour>
437		594
438	Tint the transparent background pixmap with the given colour.	595	Tint the transparent background pixmap with the given colour; option
		596	B<-tint>.
439		597
440	=item B<shading:> I<number>	598	=item B<shading:> I<number>
441		599
442	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	600	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
443	image in addition to tinting it.	601	image in addition to tinting it.
444		602
445	=item B<fading:> I<number>
446
447	Scale the tint colour by the given percentage.
448
449	=item B<scrollColor:> I<colour>	603	=item B<scrollColor:> I<colour>
450		604
451	Use the specified colour for the scrollbar [default #B2B2B2].	605	Use the specified colour for the scrollbar [default #B2B2B2].
452		606
453	=item B<troughColor:> I<colour>	607	=item B<troughColor:> I<colour>
454		608
455	Use the specified colour for the scrollbar's trough area [default	609	Use the specified colour for the scrollbar's trough area [default
456	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	610	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
		611
		612	=item B<borderColor:> I<colour>
		613
		614	The colour of the border around the text area and between the scrollbar
		615	and the text.
457		616
458	=item B<backgroundPixmap:> I<file[;geom]>	617	=item B<backgroundPixmap:> I<file[;geom]>
459		618
460	Use the specified XPM file (note the `.xpm' extension is optional) for	619	Use the specified XPM file (note the `.xpm' extension is optional) for
461	the background and also optionally specify its scaling with a geometry	620	the background and also optionally specify its scaling with a geometry
…		…
477		636
478	Specify the colon-delimited search path for finding files (XPM and	637	Specify the colon-delimited search path for finding files (XPM and
479	menus), in addition to the paths specified by the B<RXVTPATH> and	638	menus), in addition to the paths specified by the B<RXVTPATH> and
480	B<PATH> environment variables.	639	B<PATH> environment variables.
481		640
482	=item B<font:> I<fontname>	641	=item B<font:> I<fontlist>
483		642
484	Select the fonts to be used. This is a comma seperated list of font	643	Select the fonts to be used. This is a comma separated list of font
485	names that are used in turn when trying to display Unicode characters.	644	names that are used in turn when trying to display Unicode characters.
486	The first font defines the cell size for characters; other fonts might	645	The first font defines the cell size for characters; other fonts might
487	be smaller, but not larger. A reasonable default font list is always	646	be smaller, but not larger. A reasonable default font list is always
488	appended to it. option B<-fn>.	647	appended to it; option B<-fn>.
489		648
490	=item B<realBold:> I<boolean>	649	Each font can either be a standard X11 core font (XLFD) name, with
		650	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
491		651
492	B<True>: Enable "real bold" support. When this option is on, bold text	652	In addition, each font can be prefixed with additional hints and
493	will be displayed using the first available bold font in the font list.	653	specifications enclosed in square brackets (C<[]>). The only available
494	Bold fonts should thus be specified in the font list after their	654	hint currently is C<codeset=codeset-name>, and this is only used for Xft
495	corresponding regular fonts. If no bold font can be found, a regular	655	fonts.
496	font will be used. option B<-rb>. B<False>: Display bold text in a	656
497	regular font, using the color specified with B<colorBD>; option B<+rb>.	657	For example, this font resource
		658
		659	URxvt*font: 9x15bold,\
		660	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
		661	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
		662	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
		663	xft:Code2000:antialias=false
		664
		665	specifies five fonts to be used. The first one is C<9x15bold> (actually
		666	the iso8859-1 version of the second font), which is the base font (because
		667	it is named first) and thus defines the character cell grid to be 9 pixels
		668	wide and 15 pixels high.
		669
		670	The second font is just used to add additional unicode characters not in
		671	the base font, likewise the third, which is unfortunately non-bold, but
		672	the bold version of the font does contain less characters, so this is a
		673	useful supplement.
		674
		675	The third font is an Xft font with aliasing turned off, and the characters
		676	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
		677	contains other characters, but we are not interested in them.
		678
		679	The last font is a useful catch-all font that supplies most of the
		680	remaining unicode characters.
		681
		682	=item B<boldFont:> I<fontlist>
		683
		684	=item B<italicFont:> I<fontlist>
		685
		686	=item B<boldItalicFont:> I<fontlist>
		687
		688	The font list to use for displaying B<bold>, I<italic> or B<< I<bold
		689	italic> >> characters, respectively.
		690
		691	If specified and non-empty, then the syntax is the same as for the
		692	B<font>-resource, and the given font list will be used as is, which makes
		693	it possible to substitute completely different font styles for bold and
		694	italic.
		695
		696	If unset (the default), a suitable font list will be synthesized by
		697	"morphing" the normal text font list into the desired shape. If that is
		698	not possible, replacement fonts of the desired shape will be tried.
		699
		700	If set, but empty, then this specific style is disabled and the normal
		701	text font will being used for the given style.
		702
		703	=item B<intensityStyles:> I<boolean>
		704
		705	When font styles are not enabled, or this option is enabled (B<True>,
		706	option B<-is>, the default), bold and italic font styles imply high
		707	intensity foreground/backround colours. Disabling this option (B<False>,
		708	option B<+is>) disables this behaviour, the high intensity colours are not
		709	reachable.
498		710
499	=item B<selectstyle:> I<mode>	711	=item B<selectstyle:> I<mode>
500		712
501	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	713	Set mouse selection style to B<old> which is 2.20, B<oldword> which is
502	xterm style with 2.20 old word selection, or anything else which gives	714	xterm style with 2.20 old word selection, or anything else which gives
503	xterm style selection.	715	xterm style selection.
504		716
505	=item B<scrollstyle:> I<mode>	717	=item B<scrollstyle:> I<mode>
506		718
507	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	719	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
508	the author's favourite..	720	the author's favourite.
509		721
510	=item B<title:> I<string>	722	=item B<title:> I<string>
511		723
512	Set window title string, the default title is the command-line	724	Set window title string, the default title is the command-line
513	specified after the B<-e> option, if any, otherwise the application	725	specified after the B<-e> option, if any, otherwise the application
…		…
545		757
546	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	758	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
547	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or	759	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
548	B<Shift-Print> to include the scrollback as well.	760	B<Shift-Print> to include the scrollback as well.
549		761
		762	The string will be interpreted as if typed into the shell as-is.
		763
		764	Example:
		765
		766	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		767
		768	This creates a new file in your home directory with the screen contents
		769	everytime you hit C<Print>.
		770
550	=item B<scrollBar:> I<boolean>	771	=item B<scrollBar:> I<boolean>
551		772
552	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	773	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
553	disable the scrollbar; option B<+sb>.	774	disable the scrollbar; option B<+sb>.
554		775
…		…
573	B<False>: do not scroll to bottom when tty receives output; option	794	B<False>: do not scroll to bottom when tty receives output; option
574	B<+si>.	795	B<+si>.
575		796
576	=item B<scrollWithBuffer:> I<boolean>	797	=item B<scrollWithBuffer:> I<boolean>
577		798
578	B<True>: scroll with scrollback buffer when tty recieves new lines (and	799	B<True>: scroll with scrollback buffer when tty receives new lines (and
579	B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll	800	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
580	with scrollback buffer when tty recieves new lines; option B<-sw>.	801	with scrollback buffer when tty recieves new lines; option B<+sw>.
581		802
582	=item B<scrollTtyKeypress:> I<boolean>	803	=item B<scrollTtyKeypress:> I<boolean>
583		804
584	B<True>: scroll to bottom when a non-special key is pressed. Special keys	805	B<True>: scroll to bottom when a non-special key is pressed. Special keys
585	are those which are intercepted by rxvt-unicode for special handling and	806	are those which are intercepted by rxvt-unicode for special handling and
586	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to	807	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
587	bottom when a non-special key is pressed; option B<+sk>.	808	bottom when a non-special key is pressed; option B<+sk>.
588		809
589	=item B<smallfont_key:> I<keysym>
590
591	If enabled, use B<@@HOTKEY@@->I<keysym> to toggle to a smaller font
592	[default B<@@HOTKEY@@-@@SMALLFONT@@>]
593
594	=item B<bigfont_key:> I<keysym>
595
596	If enabled, use B<@@HOTKEY@@->I<keysym> to toggle to a bigger font
597	[default B<@@HOTKEY@@-@@BIGFONT@@>]
598
599	=item B<saveLines:> I<number>	810	=item B<saveLines:> I<number>
600		811
601	Save I<number> lines in the scrollback buffer [default 64]. This	812	Save I<number> lines in the scrollback buffer [default 64]. This
602	resource is limited on most machines to 65535; option B<-sl>.	813	resource is limited on most machines to 65535; option B<-sl>.
603		814
…		…
633		844
634	=item B<mouseWheelScrollPage:> I<boolean>	845	=item B<mouseWheelScrollPage:> I<boolean>
635		846
636	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel	847	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
637	scrolls five lines [default].	848	scrolls five lines [default].
		849
		850	=item B<pastableTabs:> I<boolean>
		851
		852	B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
		853	movement only; option C<-ptab>.
638		854
639	=item B<cursorBlink:> I<boolean>	855	=item B<cursorBlink:> I<boolean>
640		856
641	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	857	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
642	option B<-bc>.	858	option B<-bc>.
…		…
655		871
656	Mouse pointer background colour.	872	Mouse pointer background colour.
657		873
658	=item B<pointerBlankDelay:> I<number>	874	=item B<pointerBlankDelay:> I<number>
659		875
660	Specifies number of seconds before blanking the pointer [default 2].	876	Specifies number of seconds before blanking the pointer [default 2]. Use a
		877	large number (e.g. C<987654321>) to effectively disable the timeout.
661		878
662	=item B<backspacekey:> I<string>	879	=item B<backspacekey:> I<string>
663		880
664	The string to send when the backspace key is pressed. If set to B<DEC>	881	The string to send when the backspace key is pressed. If set to B<DEC>
665	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	882	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
…		…
687		904
688	I<name> of inputMethod to use; option B<-im>.	905	I<name> of inputMethod to use; option B<-im>.
689		906
690	=item B<imLocale:> I<name>	907	=item B<imLocale:> I<name>
691		908
692	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	909	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
693	de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input	910	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
694	extension to be able to input japanese characters while staying in	911	input extension to be able to input japanese characters while staying in
695	another locale. option B<-imlocale>.	912	another locale; option B<-imlocale>.
696		913
697	=item B<insecure>	914	=item B<imFont:> I<fontset>
		915
		916	Specify the font-set used for XIM styles C<OverTheSpot> or
		917	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
		918	by commas), i.e. it's not in the same format as the other font lists used
		919	in @@RXVT_NAME@@. The default will be set-up to chose any suitable found
		920	found, preferably one or two pixels differing in size to the base font.
		921	option B<-imfont>.
		922
		923	=item B<tripleclickwords:> I<boolean>
		924
		925	Change the meaning of triple-click selection with the left mouse
		926	button. Instead of selecting a full line it will extend the selection to
		927	the end of the logical line only; option B<-tcw>.
		928
		929	=item B<insecure:> I<boolean>
698		930
699	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	931	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
700	echo arbitrary strings like the icon name or the locale. This could be	932	echo arbitrary strings like the icon name or the locale. This could be
701	abused if somebody gets 8-bit-clean access to your display, wether	933	abused if somebody gets 8-bit-clean access to your display, whether
702	throuh a mail client displaying mail bodies unfiltered or though	934	through a mail client displaying mail bodies unfiltered or through
703	write(1). Therefore, these sequences are disabled by default. (Note	935	write(1) or any other means. Therefore, these sequences are disabled by
704	that other terminals, including xterm, have these sequences	936	default. (Note that many other terminals, including xterm, have these
705	enabled by default). You can enable them by setting this boolean	937	sequences enabled by default, which doesn't make it safer, though).
706	resource or specifying B<-insecure> as an option. At the moment, this	938
707	enabled display-answer, locale, findfont, icon label and window title	939	You can enable them by setting this boolean resource or specifying
708	requests as well as dynamic menubar dispatch.	940	B<-insecure> as an option. At the moment, this enables display-answer,
		941	locale, findfont, icon label and window title requests as well as dynamic
		942	menubar dispatch.
709		943
710	=item B<modifier:> I<modifier>	944	=item B<modifier:> I<modifier>
711		945
712	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	946	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
713	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	947	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
728	Turn on/off secondary screen scroll (default enabled). If the this	962	Turn on/off secondary screen scroll (default enabled). If the this
729	option is enabled, scrolls on the secondary screen will change the	963	option is enabled, scrolls on the secondary screen will change the
730	scrollback buffer and switching to/from the secondary screen will	964	scrollback buffer and switching to/from the secondary screen will
731	instead scroll the screen up.	965	instead scroll the screen up.
732		966
		967	=item B<hold>: I<bool>
		968
		969	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		970	will not immediately destroy its window when the program executed within
		971	it exits. Instead, it will wait till it is being killed or closed by the
		972	user.
		973
733	=item B<keysym.>I<sym>: I<string>	974	=item B<keysym.>I<sym>: I<string>
734		975
735	Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may	976	Compile I<frills>: Associate I<string> with keysym I<sym>. The
736	contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:	977	intervening resource name B<keysym.> cannot be omitted.
737	newline, \r: return, \t:	978
		979	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
		980	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
		981	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
		982	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
		983	B<2>, B<3>, B<4>, B<5>.
		984
		985	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
		986	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
		987	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
		988	current application keymap mode state.
		989
		990	The spellings of I<key> can be obtained by using B<xev>(1) command or
		991	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
		992	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
		993	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
		994	performed in an exact manner; however, the closest match is assured.
		995
		996	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
		997	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
738	tab, \000: octal number) or control characters (^?: delete, ^@: null,	998	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
739	^A ...) and may enclosed with double quotes so that it can start or end	999	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
740	with whitespace. The intervening resource name B<keysym.> cannot be	1000	can start or end with whitespace.
741	omitted. This resource is only available when compiled with	1001
742	KEYSYM_RESOURCE.	1002	Please note that you need to double the C<\> when using
		1003	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
		1004	use C<\033> instead of C<\e> (and so on), which will work with both Xt and
		1005	@@RXVT_NAME@@'s own processing).
		1006
		1007	You can define a range of keysyms in one shot by providing a I<string>
		1008	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
		1009	should be a character not used by the strings.
		1010
		1011	Its usage can be demonstrated by an example:
		1012
		1013	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
		1014
		1015	The above line is equivalent to the following three lines:
		1016
		1017	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
		1018	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
		1019	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
		1020
		1021	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
		1022	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
		1023	example the following means "change the current locale to C<zh_CN.GBK>
		1024	when Control-Meta-c is being pressed":
		1025
		1026	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		1027
		1028	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1029	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1030	manpage. For example, the F<selection> extension (activated via
		1031	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1032
		1033	URxvt.keysym.M-C-c: perl:selection:rot13
		1034
		1035	Due the the large number of modifier combinations, a defined key mapping
		1036	will match if at I<at least> the specified identifiers are being set, and
		1037	no other key mappings with those and more bits are being defined. That
		1038	means that defining a key map for C<a> will automatically provide
		1039	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		1040	mappings themselves.
		1041
		1042	Unfortunately, this will override built-in key mappings. For example
		1043	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		1044	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		1045	user-defined keymap using the C<builtin:> replacement:
		1046
		1047	URxvt.keysym.Insert: <my insert key sequence>
		1048	URxvt.keysym.S-Insert: builtin:
		1049
		1050	The first line defines a mapping for C<Insert> and I<any> combination
		1051	of modifiers. The second line re-establishes the default mapping for
		1052	C<Shift-Insert>.
		1053
		1054	The following example will map Control-Meta-1 and Control-Meta-2 to
		1055	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
		1056	font-switching at runtime:
		1057
		1058	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1059	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
		1060
		1061	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
		1062	info):
		1063
		1064	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1065	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1066
		1067	=item B<perl-ext>: I<string>
		1068
		1069	Colon-separated list of perl extension scripts to use in this terminal
		1070	instance. Each extension is looked up in the library directories, loaded
		1071	if necessary, and bound to the current terminal instance. If this resource
		1072	is empty or missing, then the perl interpreter will not be initialized;
		1073	option B<-pe>.
		1074
		1075	=item B<perl-eval>: I<string>
		1076
		1077	Perl code to be evaluated when all extensions have been registered. See the
		1078	@@RXVT_NAME@@perl(3) manpage.
		1079
		1080	=item B<perl-lib>: I<path>
		1081
		1082	Colon-separated list of additional directories that hold extension
		1083	scripts. When looking for extensions specified by the C<perl> resource,
		1084	@@RXVT_NAME@@ will first look in these directories and then in
		1085	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
		1086
		1087	See the @@RXVT_NAME@@perl(3) manpage.
743		1088
744	=back	1089	=back
745		1090
746	=head1 THE SCROLLBAR	1091	=head1 THE SCROLLBAR
747		1092
…		…
761	the normal text selection/insertion, hold either the Shift or the Meta	1106	the normal text selection/insertion, hold either the Shift or the Meta
762	(Alt) key while performing the desired mouse action.	1107	(Alt) key while performing the desired mouse action.
763		1108
764	If mouse reporting mode is active, the normal scrollbar actions are	1109	If mouse reporting mode is active, the normal scrollbar actions are
765	disabled -- on the assumption that we are using a fullscreen	1110	disabled -- on the assumption that we are using a fullscreen
766	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	1111	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
767	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	1112	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
768	up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down),	1113	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
769	respectively.	1114	respectively.
770		1115
771	=head1 TEXT SELECTION AND INSERTION	1116	=head1 TEXT SELECTION AND INSERTION
772		1117
773	The behaviour of text selection and insertion mechanism is similar to	1118	The behaviour of text selection and insertion mechanism is similar to
…		…
775		1120
776	=over 4	1121	=over 4
777		1122
778	=item B<Selection>:	1123	=item B<Selection>:
779		1124
780	Left click at the beginning of the region, drag to the end of the	1125	Left click at the beginning of the region, drag to the end of the region
781	region and release; Right click to extend the marked region; Left	1126	and release; Right click to extend the marked region; Left double-click
782	double-click to select a word; Left triple-click to select the entire	1127	to select a word; Left triple-click to select the entire logical line
783	line.	1128	(which can span multiple screen lines), unless modified by resource
		1129	B<tripleclickwords>.
		1130
		1131	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
		1132	(Compile: I<frills>) will create a rectangular selection instead of a
		1133	normal one. In this mode, every selected row becomes its own line in the
		1134	selection, and trailing whitespace is visually underlined and removed from
		1135	the selection.
784		1136
785	=item B<Insertion>:	1137	=item B<Insertion>:
786		1138
787	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1139	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
788	an B<@@RXVT_NAME@@> window causes the current text selection to be	1140	an B<@@RXVT_NAME@@> window causes the current text selection to be
…		…
790		1142
791	=back	1143	=back
792		1144
793	=head1 CHANGING FONTS	1145	=head1 CHANGING FONTS
794		1146
795	You can change fonts on-the-fly, which is to say cycle through the	1147	Changing fonts (or font sizes, respectively) via the keypad is not yet
796	default font and others of various sizes, by using B<Shift-KP_Add> and	1148	supported in rxvt-unicode. Bug me if you need this.
797	B<Shift-KP_Subtract>. Or, alternatively (if enabled) with	1149
798	B<@@HOTKEY@@-@@BIGFONT@@> and B<@@HOTKEY@@-@@SMALLFONT@@>, where the	1150	You can, however, switch fonts at runtime using escape sequences (and
799	actual key can be selected using resources	1151	therefore using the menubar), e.g.:
800	B<smallfont_key>/B<bigfont_key>.	1152
		1153	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1154
		1155	rxvt-unicode will automatically re-apply these fonts to the output so far.
801		1156
802	=head1 ISO 14755 SUPPORT	1157	=head1 ISO 14755 SUPPORT
803		1158
804	Partial ISO 14755-support is implemented. that means that pressing	1159	ISO 14755 is a standard for entering and viewing unicode characters
		1160	and character codes using the keyboard. It consists of 4 parts. The
		1161	first part is available rxvt-unicode has been compiled with
		1162	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
		1163	with C<--enable-iso14755>.
805		1164
806	Section 5.1: Control and Shift together enters unicode input	1165	=over 4
807	mode. Entering hex digits composes a Unicode character, pressing space or
808	releasing the modifiers commits the keycode and every other key cancels
809	the current input character.
810		1166
811	Section 5.2: Pressing and immediately releasing Control and Shift together	1167	=item * 5.1: Basic method
812	enters keycap entry mode for the next key: pressing a function key (tab,	1168
813	return etc..) will enter the unicode character corresponding to the given	1169	This allows you to enter unicode characters using their hexcode.
814	key.	1170
		1171	Start by pressing and holding both C<Control> and C<Shift>, then enter
		1172	hex-digits (between one and six). Releasing C<Control> and C<Shift> will
		1173	commit the character as if it were typed directly. While holding down
		1174	C<Control> and C<Shift> you can also enter multiple characters by pressing
		1175	C<Space>, which will commit the current character and lets you start a new
		1176	one.
		1177
		1178	As an example of use, imagine a business card with a japanese e-mail
		1179	address, which you cannot type. Fortunately, the card has the e-mail
		1180	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
		1181	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
		1182	followed by releasing the modifier keys.
		1183
		1184	=item * 5.2: Keyboard symbols entry method
		1185
		1186	This mode lets you input characters representing the keycap symbols of
		1187	your keyboard, if representable in the current locale encoding.
		1188
		1189	Start by pressing C<Control> and C<Shift> together, then releasing
		1190	them. The next special key (cursor keys, home etc.) you enter will not
		1191	invoke it's usual function but instead will insert the corresponding
		1192	keycap symbol. The symbol will only be entered when the key has been
		1193	released, otherwise pressing e.g. C<Shift> would enter the symbol for
		1194	C<ISO Level 2 Switch>, although your intention might have been to enter a
		1195	reverse tab (Shift-Tab).
		1196
		1197	=item * 5.3: Screen-selection entry method
		1198
		1199	While this is implemented already (it's basically the selection
		1200	mechanism), it could be extended by displaying a unicode character map.
		1201
		1202	=item * 5.4: Feedback method for identifying displayed characters for later input
		1203
		1204	This method lets you display the unicode character code associated with
		1205	characters already displayed.
		1206
		1207	You enter this mode by holding down C<Control> and C<Shift> together, then
		1208	pressing and holding the left mouse button and moving around. The unicode
		1209	hex code(s) (it might be a combining character) of the character under the
		1210	pointer is displayed until you release C<Control> and C<Shift>.
		1211
		1212	In addition to the hex codes it will display the font used to draw this
		1213	character - due to implementation reasons, characters combined with
		1214	combining characters, line drawing characters and unknown characters will
		1215	always be drawn using the built-in support font.
		1216
		1217	=back
		1218
		1219	With respect to conformance, rxvt-unicode is supposed to be compliant to
		1220	both scenario A and B of ISO 14755, including part 5.2.
815		1221
816	=head1 LOGIN STAMP	1222	=head1 LOGIN STAMP
817		1223
818	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so	1224	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
819	that it can be seen via the I<who(1)> command, and can accept messages.	1225	it can be seen via the I<who(1)> command, and can accept messages. To
820	To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on	1226	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
821	some systems.	1227	on some systems or setgid to root or to some other group on others.
822		1228
823	=head1 COLORS AND GRAPHICS	1229	=head1 COLORS AND GRAPHICS
824		1230
825	In addition to the default foreground and background colours,	1231	In addition to the default foreground and background colours,
826	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1232	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
…		…
867	would yield White on Black, while on I<xterm>(1) it would yield Black	1273	would yield White on Black, while on I<xterm>(1) it would yield Black
868	on White.	1274	on White.
869		1275
870	=back	1276	=back
871		1277
872	=head1 FREQUENTLY ASKED QUESTIONS (FAQ)	1278	=head1 ENVIRONMENT
		1279
		1280	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
873		1281
874	=over 4	1282	=over 4
875		1283
876	=item How do I know which rxvt-unicode version I'm using?	1284	=item B<TERM>
877		1285
878	The version number is displayed with the usage (-h). For rxvt-unicode	1286	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
879	version 2.14 and later, the escape sequence C<ESC[8n> sets the window	1287	resources or on the commandline.
880	title to the version number.
881		1288
882	=item Why do the characters look ugly?	1289	=item B<COLORTERM>
883		1290
884	=item How does rxvt-unicode choose fonts?	1291	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
		1292	compiled with XPM support, and optionally with the added extension
		1293	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
885		1294
886	Most fonts do not contain the full range of Unicode, which is	1295	=item B<COLORFGBG>
887	fine. Chances are that the font you (or the admin/package maintainer of
888	your system/os) have specified does not cover all the characters you want
889	to display.
890		1296
891	B<rxvt-unicode> makes a best-effort try at finding a replacement	1297	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
892	font. Often the result is fine, but sometimes the chosen font looks	1298	the colour code used as default foreground/text colour (or the string
893	bad. In that case, select a font of your taste and add it to the font	1299	C<default> to indicate that the default-colour escape sequence is to be
894	list, e.g.:	1300	used), C<bg> is the colour code used as default background colour (or the
		1301	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1302	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
		1303	(and do) use this information to optimize screen output.
895		1304
896	@@RXVT_NAME@@ -fn basefont,font2,font3...	1305	=item B<WINDOWID>
897		1306
898	When rxvt-unicode sees a character, it will first look at the base	1307	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
899	font. If the base font does not contain the character, it will go to the	1308	window, which usually has subwindows for the scrollbar, the terminal
900	next font, and so on.	1309	window and so on).
901		1310
902	The only limitation is that all the fonts must not be larger than the base	1311	=item B<TERMINFO>
903	font, as the base font defines the principial cell size, which must be the
904	same due to the way terminals work.
905		1312
906	=item Why do some chinese characters look so different than others?	1313	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1314	C<--with-terminfo=PATH>.
907		1315
908	This is because there is a difference between script and language --	1316	=item B<DISPLAY>
909	rxvt-unicode does not know which language the text that is output
910	is, as it only knows the unicode character codes. If rxvt-unicode
911	first sees a japanese character, it might choose a japanese font for
912	it. Subseqzuent japanese characters will take that font. Now, many chinese
913	characters aren't represented in japanese fonts, so when the first
914	non-japanese character comes up, rxvt-unicode will look for a chinese font
915	-- unfortunately at this point, it will still use the japanese font for
916	japanese characters that are also chinese.
917		1317
918	The workaround is easy: just tag a chinese font at the end of your font	1318	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
919	list (see the previous question). The key is to view the font list as	1319	display in it's child processes.
920	a preference list: If you expect more japanese, list a japanese font
921	first. If you expect more chinese, put a chinese font first.
922		1320
923	In the future it might be possible to switch preferences at runtime (the	1321	=item B<SHELL>
924	internal data structure has no problem with using different fonts for
925	the same character at the same time, but no interface for this has been
926	designed yet).
927		1322
928	=item Mouse cut/paste suddenly no longer works.	1323	The shell to be used for command execution, defaults to C</bin/sh>.
929		1324
930	Make sure that mouse reporting is actually turned off since killing	1325	=item B<RXVTPATH>
931	some editors prematurely may leave the mouse in mouse report mode. I've
932	heard that tcsh may use mouse reporting unless it otherwise specified. A
933	quick check is to see if cut/paste works when the Alt or Shift keys are
934	depressed. See @@RXVT_NAME@@(7)
935		1326
936	=item What's with this bold/blink stuff?	1327	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
		1328	files.
937		1329
938	If no bold colour is set via C<colorBD:>, bold will invert text using the	1330	=item B<PATH>
939	standard foreground colour.
940		1331
941	For the standard background colour, blinking will actually make the	1332	Used in the same way as C<RXVTPATH>.
942	text blink when compiled with C<--enable-blinking>. with standard
943	colours. Without C<--enable-blinking>, the blink attribute will be
944	ignored.
945		1333
946	On ANSI colours, bold/blink attributes are used to set high-intensity	1334	=item B<RXVT_SOCKET>
947	foreground/background colors.
948		1335
949	color0-7 are the low-intensity colors.	1336	The unix domain socket path used by @@RXVT_NAME@@c(1) and
		1337	@@RXVT_NAME@@d(1).
950		1338
951	color8-15 are the corresponding high-intensity colors.	1339	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
952		1340
953	=item I don't like the screen colors. How do I change them?	1341	=item B<HOME>
954		1342
955	You can change the screen colors at run-time using F<~/.Xdefaults>	1343	Used to locate the default directory for the unix domain socket for
956	resources (or as long-options).	1344	daemon communications and to locate various resource files (such as
		1345	C<.Xdefaults>)
957		1346
958	Here are values that are supposed to resemble a VGA screen,	1347	=item B<XAPPLRESDIR>
959	including the murky brown that passes for low-intensity yellow:
960		1348
961	Rxvt*color0: #000000	1349	Directory where various X resource files are being located.
962	Rxvt*color1: #A80000
963	Rxvt*color2: #00A800
964	Rxvt*color3: #A8A800
965	Rxvt*color4: #0000A8
966	Rxvt*color5: #A800A8
967	Rxvt*color6: #00A8A8
968	Rxvt*color7: #A8A8A8
969
970	Rxvt*color8: #000054
971	Rxvt*color9: #FF0054
972	Rxvt*color10: #00FF54
973	Rxvt*color11: #FFFF54
974	Rxvt*color12: #0000FF
975	Rxvt*color13: #FF00FF
976	Rxvt*color14: #00FFFF
977	Rxvt*color15: #FFFFFF
978		1350
979	=item What's with the strange Backspace/Delete key behaviour?	1351	=item B<XENVIRONMENT>
980		1352
981	Assuming that the physical Backspace key corresponds to the	1353	If set and accessible, gives the name of a X resource file to be loaded by
982	BackSpace keysym (not likely for Linux ... see the following
983	question) there are two standard values that can be used for
984	Backspace: C<^H> and C<^?>.
985
986	Historically, either value is correct, but rxvt-unicode adopts the debian
987	policy of using C<^?> when unsure, because it's the one only only correct
988	choice :).
989
990	Rxvt-unicode tries to inherit the current stty settings and uses the value
991	of `erase' to guess the value for backspace. If rxvt-unicode wasn't
992	started from a terminal (say, from a menu or by remote shell), then the
993	system value of `erase', which corresponds to CERASE in <termios.h>, will
994	be used (which may not be the same as your stty setting).
995
996	For starting a new rxvt-unicode:
997
998	# use Backspace = ^H
999	$ stty erase ^H
1000	$ @@RXVT_NAME@@	1354	@@RXVT_NAME@@.
1001
1002	# use Backspace = ^?
1003	$ stty erase ^?
1004	$ @@RXVT_NAME@@
1005
1006	Toggle with "ESC[36h" / "ESC[36l" as documented in @@RXVT_NAME@@(7).
1007
1008	For an existing rxvt-unicode:
1009
1010	# use Backspace = ^H
1011	$ stty erase ^H
1012	$ echo -n "^[[36h"
1013
1014	# use Backspace = ^?
1015	$ stty erase ^?
1016	$ echo -n "^[[36l"
1017
1018	This helps satisfy some of the Backspace discrepancies that occur, but
1019	if you use Backspace = C<^H>, make sure that the termcap/terminfo value
1020	properly reflects that.
1021
1022	The Delete key is a another casualty of the ill-defined Backspace problem.
1023	To avoid confusion between the Backspace and Delete keys, the Delete
1024	key has been assigned an escape sequence to match the vt100 for Execute
1025	(ESC[3~) and is in the supplied termcap/terminfo.
1026
1027	Some other Backspace problems:
1028
1029	some editors use termcap/terminfo,
1030	some editors (vim I'm told) expect Backspace = ^H,
1031	GNU Emacs (and Emacs-like editors) use ^H for help.
1032
1033	Perhaps someday this will all be resolved in a consistent manner.
1034
1035	=item I don't like the key-bindings. How do I change them?
1036
1037	There are some compile-time selections available via configure. Unless
1038	you have run "configure" with the C<--disable-resources> option you can
1039	use the `keysym' resource to alter the keystrings associated with keysym
1040	0xFF00 - 0xFFFF (function, cursor keys, etc).
1041
1042	Here's an example for a tn3270 session started using `@@RXVT_NAME@@ -name tn3270'
1043
1044	!# ----- special uses ------:
1045	! tn3270 login, remap function and arrow keys.
1046	tn3270font: clean-bold----15-*
1047
1048	! keysym - used by rxvt only
1049	! Delete - ^D
1050	tn3270*keysym.0xFFFF: \004
1051
1052	! Home - ^A
1053	tn3270*keysym.0xFF50: \001
1054	! Left - ^B
1055	tn3270*keysym.0xFF51: \002
1056	! Up - ^P
1057	tn3270*keysym.0xFF52: \020
1058	! Right - ^F
1059	tn3270*keysym.0xFF53: \006
1060	! Down - ^N
1061	tn3270*keysym.0xFF54: \016
1062	! End - ^E
1063	tn3270*keysym.0xFF57: \005
1064
1065	! F1 - F12
1066	tn3270*keysym.0xFFBE: \e1
1067	tn3270*keysym.0xFFBF: \e2
1068	tn3270*keysym.0xFFC0: \e3
1069	tn3270*keysym.0xFFC1: \e4
1070	tn3270*keysym.0xFFC2: \e5
1071	tn3270*keysym.0xFFC3: \e6
1072	tn3270*keysym.0xFFC4: \e7
1073	tn3270*keysym.0xFFC5: \e8
1074	tn3270*keysym.0xFFC6: \e9
1075	tn3270*keysym.0xFFC7: \e0
1076	tn3270*keysym.0xFFC8: \e-
1077	tn3270*keysym.0xFFC9: \e=
1078
1079	! map Prior/Next to F7/F8
1080	tn3270*keysym.0xFF55: \e7
1081	tn3270*keysym.0xFF56: \e8
1082
1083	=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
1084	How do I make use of them? For example, the Sun Keyboard type 4
1085	has the following mappings that rxvt-unicode doesn't recognize.
1086
1087	KP_Insert == Insert
1088	F22 == Print
1089	F27 == Home
1090	F29 == Prior
1091	F33 == End
1092	F35 == Next
1093
1094	Rather than have rxvt-unicode try to accomodate all the various possible keyboard
1095	mappings, it is better to use `xmodmap' to remap the keys as required for
1096	your particular machine.
1097
1098	=item How do I distinguish if I'm running rxvt-unicode or a regular xterm?
1099	I need this to decide about setting colors etc.
1100
1101	rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
1102	check and see if that is set. Note that several programs, JED, slrn,
1103	Midnight Commander automatically check this variable to decide whether or
1104	not to use color.
1105
1106	=item How do I set the correct, full IP address for the DISPLAY variable?
1107
1108	If you've compiled rxvt-unicode with DISPLAY_IS_IP and ahve enabled
1109	insecure mode then it is possible to use the following shell script
1110	snippets to correctly set the display. If your version of rxvt-unicode
1111	wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
1112	the COLORTERM variable can be used to distinguish rxvt-unicode from a
1113	regular xterm.
1114
1115	Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
1116	snippets:
1117
1118	# Bourne/Korn/POSIX family of shells:
1119	[ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
1120	if [ ${TERM:-foo} = xterm ]; then
1121	stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
1122	echo -n '^[Z'
1123	read term_id
1124	stty icanon echo
1125	if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
1126	echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
1127	read DISPLAY # set it in our local shell
1128	fi
1129	fi
1130
1131	=item How do I compile the manual pages for myself?
1132
1133	You need to have a recent version of perl installed as F</usr/bin/perl>,
1134	one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
1135	the doc subdirectory and enter C<make alldoc>.
1136		1355
1137	=back	1356	=back
1138		1357
1139	=head1 ENVIRONMENT
1140
1141	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>
1142	and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X
1143	window id number of the B<@@RXVT_NAME@@> window and it also uses and
1144	sets the environment variable B<DISPLAY> to specify which display
1145	terminal to use. B<@@RXVT_NAME@@> uses the environment variables
1146	B<RXVTPATH> and B<PATH> to find XPM files.
1147
1148	=head1 FILES	1358	=head1 FILES
1149		1359
1150	=over 4	1360	=over 4
1151		1361
1152	=item B</etc/utmp>
1153
1154	System file for login records.
1155
1156	=item B</usr/lib/X11/rgb.txt>	1362	=item B</usr/lib/X11/rgb.txt>
1157		1363
1158	Color names.	1364	Color names.
1159		1365
1160	=back	1366	=back
1161		1367
1162	=head1 SEE ALSO	1368	=head1 SEE ALSO
1163		1369
1164	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1370	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1165
1166	=head1 BUGS
1167
1168	Check the BUGS file for an up-to-date list.
1169
1170	Cursor change support is not yet implemented.
1171
1172	Click-and-drag doesn't work with X11 mouse report overriding.
1173		1371
1174	=head1 CURRENT PROJECT COORDINATOR	1372	=head1 CURRENT PROJECT COORDINATOR
1175		1373
1176	=over 4	1374	=over 4
1177		1375
1178	=item Project Coordinator	1376	=item Project Coordinator
1179		1377
1180	@@RXVTMAINT@@ L<@@RXVT_MAINTEMAIL@@>	1378	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1181		1379
1182	=item Web page maintainter	1380	L<http://software.schmorp.de/#rxvt-unicode>
1183
1184	@@RXVTWEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1185
1186	L<@@RXVT_WEBPAGE@@>
1187		1381
1188	=back	1382	=back
1189		1383
1190	=head1 AUTHORS	1384	=head1 AUTHORS
1191		1385
…		…
1216	=item Geoff Wing L<< <gcw@pobox.com> >>	1410	=item Geoff Wing L<< <gcw@pobox.com> >>
1217		1411
1218	Rewrote screen display and text selection routines. Project Coordinator	1412	Rewrote screen display and text selection routines. Project Coordinator
1219	(changes.txt 2.4.6 - rxvt-unicode)	1413	(changes.txt 2.4.6 - rxvt-unicode)
1220		1414
1221	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>	1415	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1222		1416
1223	Forked rxvt-unicode, rewrote most of the display code and internal	1417	Forked rxvt-unicode, rewrote most of the display code and internal
1224	character handling to store text in unicode, improve xterm	1418	character handling to store text in unicode, improve xterm
1225	compatibility and apply numerous other bugfixes and extensions.	1419	compatibility and apply numerous other bugfixes and extensions.
1226		1420

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.5 by root, Sat Aug 14 03:00:32 2004 UTC vs. Revision 1.83 by root, Tue Jan 3 22:28:07 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.5 by root, Sat Aug 14 03:00:32 2004 UTC vs.
Revision 1.83 by root, Tue Jan 3 22:28:07 2006 UTC