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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.32 by root, Sat Oct 9 11:18:12 2004 UTC vs.
Revision 1.137 by root, Sat Sep 1 09:38:50 2007 UTC

…		…
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		16
17	=head1 FREQUENTLY ASKED QUESTIONS	17	=head1 FREQUENTLY ASKED QUESTIONS
18		18
19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of frequently	19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20	asked questions and answer to them and some common problems.	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/rxvt-unicode/doc/rxvt.7.html>.
21		23
22	=head1 RXVT-UNICODE VS. RXVT	24	=head1 RXVT-UNICODE VS. RXVT
23		25
24	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
25	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
26	world. Being a terminal emulator, however, some things are very difficult,	28	world. Being a terminal emulator, however, some things are very difficult,
27	especially cursive scripts such as arabic, vertically written scripts	29	especially cursive scripts such as arabic, vertically written scripts
28	like mongolian or scripts requiring extremely complex combining rules,	30	like mongolian or scripts requiring extremely complex combining rules,
29	like tibetan or devenagari. Don't expect pretty output when using these	31	like tibetan or devanagari. Don't expect pretty output when using these
30	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
31	fine, though. A somewhat difficult case are left-to-right scripts, such	33	fine, though. A somewhat difficult case are right-to-left scripts, such
32	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
33	belong into the application, not the terminal emulator (too many things --	35	belong into the application, not the terminal emulator (too many things --
34	such as cursor-movement while editing -- break otherwise), but that might	36	such as cursor-movement while editing -- break otherwise), but that might
35	change.	37	change.
36		38
37	If you are looking for a terminal that supports more exotic scripts, let	39	If you are looking for a terminal that supports more exotic scripts, let
38	me recommend C<mlterm>, which is a very userfriendly, lean and clean	40	me recommend C<mlterm>, which is a very user friendly, lean and clean
39	terminal emulator. In fact, the reason rxvt-unicode was born was solely	41	terminal emulator. In fact, the reason rxvt-unicode was born was solely
40	because the author couldn't get C<mlterm> to use one font for latin1 and	42	because the author couldn't get C<mlterm> to use one font for latin1 and
41	another for japanese.	43	another for japanese.
42		44
43	Therefore another design rationale was the use of multiple fonts to	45	Therefore another design rationale was the use of multiple fonts to
44	display characters: The idea of a single unicode font which many other	46	display characters: The idea of a single unicode font which many other
45	programs force onto it's users never made sense to me: You should be able	47	programs force onto its users never made sense to me: You should be able
46	to choose any font for any script freely.	48	to choose any font for any script freely.
47		49
48	Apart from that, rxvt-unicode is also much better internationalised than	50	Apart from that, rxvt-unicode is also much better internationalised than
49	it's predecessor, supports things such as XFT and ISO 14755 that are handy	51	its predecessor, supports things such as XFT and ISO 14755 that are handy
50	in i18n-environments, is faster, and has a lot less bugs than the original	52	in i18n-environments, is faster, and has a lot bugs less than the original
51	rxvt. This all in addition to dozens of other small improvements.	53	rxvt. This all in addition to dozens of other small improvements.
52		54
53	It is still faithfully following the original rxvt idea of being lean	55	It is still faithfully following the original rxvt idea of being lean
54	and nice on resources: for example, you can still configure rxvt-unicode	56	and nice on resources: for example, you can still configure rxvt-unicode
55	without most of it's features to get a lean binary. It also comes with	57	without most of its features to get a lean binary. It also comes with
56	a client/daemon pair that lets you open any number of terminal windows	58	a client/daemon pair that lets you open any number of terminal windows
57	from within a single process, which makes startup time very fast and	59	from within a single process, which makes startup time very fast and
58	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and	60	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
59	@@RXVT_NAME@@c(1) (client).	61	@@RXVT_NAME@@c(1) (client).
60		62
61	It also makes technical information about escape sequences (which have	63	It also makes technical information about escape sequences (which have
62	been extended) easier accessible: see @@RXVT_NAME@@(7) for technical	64	been extended) more accessible: see @@RXVT_NAME@@(7) for technical
63	reference documentation (escape sequences etc.).	65	reference documentation (escape sequences etc.).
64		66
65	=head1 OPTIONS	67	=head1 OPTIONS
66		68
67	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
…		…
91		93
92	Attempt to open a window on the named X display (B<-d> still	94	Attempt to open a window on the named X display (B<-d> still
93	respected). In the absence of this option, the display specified by the	95	respected). In the absence of this option, the display specified by the
94	B<DISPLAY> environment variable is used.	96	B<DISPLAY> environment variable is used.
95		97
		98	=item B<-depth> I<bitdepth>
		99
		100	Compile I<xft>: Attempt to find a visual with the given bit depth;
		101	resource B<depth>.
		102
96	=item B<-geometry> I<geom>	103	=item B<-geometry> I<geom>
97		104
98	Window geometry (B<-g> still respected); resource B<geometry>.	105	Window geometry (B<-g> still respected); resource B<geometry>.
99		106
100	=item B<-rv>\|B<+rv>	107	=item B<-rv>\|B<+rv>
101		108
102	Turn on/off simulated reverse video; resource B<reverseVideo>.	109	Turn on/off simulated reverse video; resource B<reverseVideo>.
103		110
104	=item B<-j>\|B<+j>	111	=item B<-j>\|B<+j>
105		112
106	Turn on/off jump scrolling; resource B<jumpScroll>.	113	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
107		114
108	=item B<-ip>\|B<+ip>	115	=item B<-ss>\|B<+ss>
		116
		117	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
		118
		119	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>
109		120
110	Turn on/off inheriting parent window's pixmap. Alternative form is	121	Turn on/off inheriting parent window's pixmap. Alternative form is
111	B<-tr>; resource B<inheritPixmap>.	122	B<-tr>; resource B<inheritPixmap>.
112		123
		124	I<Please note that transparency of any kind if completely unsupported by
		125	the author. Don't bug him with installation questions! Read the FAQ (man 7
		126	@@RXVT_NAME@@)!>
		127
113	=item B<-fade> I<number>	128	=item B<-fade> I<number>
114		129
115	Fade the text by the given percentage when focus is lost.	130	Fade the text by the given percentage when focus is lost. Small values
		131	fade a little only, 100 completely replaces all colours by the fade
		132	colour; resource B<fading>.
		133
		134	=item B<-fadecolor> I<colour>
		135
		136	Fade to this colour when fading is used (see B<-fade>). The default colour
		137	is opaque black. resource B<fadeColor>.
116		138
117	=item B<-tint> I<colour>	139	=item B<-tint> I<colour>
118		140
119	Tint the transparent background pixmap with the given colour when	141	Tint the transparent background pixmap with the given colour when
120	transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>	142	transparency is enabled with B<-tr> or B<-ip>. This only works for
		143	non-tiled backgrounds, currently. See also the B<-sh> option that can be
121	option that can be used to brighten or darken the image in addition to	144	used to brighten or darken the image in addition to tinting it.
122	tinting it.	145	Please note that certain tint colours can be applied on the server-side,
		146	thus yielding performance gain of two orders of magnitude. These colours are:
		147	blue, red, green, cyan, magenta, yellow, and those close to them; resource
		148	I<tintColor>. Example:
123		149
124	=item B<-sh>	150	@@RXVT_NAME@@ -tr -tint blue -sh 40
125		151
		152	=item B<-sh> I<number>
		153
126	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	154	Darken (0 .. 100) or lighten (-1 .. -100) the transparent
127	background image in addition to tinting it (i.e. B<-tint> must be	155	background image in addition to (or instead of) tinting it;
128	specified, too).	156	resource I<shading>.
		157
		158	=item B<-blt> I<string>
		159
		160	Specify background blending type. If background pixmap is specified
		161	at the same time as transparency - such pixmap will be blended over
		162	transparency image, using method specified. Supported values are :
		163	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
		164	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
		165	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
		166	alpha-blending; resource I<blendType>.
		167
		168	=item B<-blr> I<HxV>
		169
		170	Apply Gaussian Blur with the specified radii to the transparent
		171	background image. If single number is specified - both vertical and
		172	horizontal radii are considered to be the same. Setting one of the
		173	radii to 1 and another to a large number creates interesting effects
		174	on some backgrounds. Maximum radius value is 128; resource I<blurRadius>.
129		175
130	=item B<-bg> I<colour>	176	=item B<-bg> I<colour>
131		177
132	Window background colour; resource B<background>.	178	Window background colour; resource B<background>.
133		179
…		…
135		181
136	Window foreground colour; resource B<foreground>.	182	Window foreground colour; resource B<foreground>.
137		183
138	=item B<-pixmap> I<file[;geom]>	184	=item B<-pixmap> I<file[;geom]>
139		185
140	Compile I<XPM>: Specify XPM file for the background and also optionally	186	Compile I<afterimage>: Specify image file for the background and also
141	specify its scaling with a geometry string. Note you may need to add	187	optionally specify its scaling with a geometry string. Note you may need to
142	quotes to avoid special shell interpretation of the `;' in the	188	add quotes to avoid special shell interpretation of the C<;> in the
143	command-line; resource B<backgroundPixmap>.	189	command-line; for more details see resource B<backgroundPixmap>.
144		190
145	=item B<-cr> I<colour>	191	=item B<-cr> I<colour>
146		192
147	The cursor colour; resource B<cursorColor>.	193	The cursor colour; resource B<cursorColor>.
148		194
…		…
160	resource B<borderColor>.	206	resource B<borderColor>.
161		207
162	=item B<-fn> I<fontlist>	208	=item B<-fn> I<fontlist>
163		209
164	Select the fonts to be used. This is a comma separated list of font names	210	Select the fonts to be used. This is a comma separated list of font names
165	that are used in turn when trying to display Unicode characters. The	211	that are checked in order when trying to find glyphs for characters. The
166	first font defines the cell size for characters; other fonts might be	212	first font defines the cell size for characters; other fonts might be
167	smaller, but not (in general) larger. A reasonable default font list is	213	smaller, but not (in general) larger. A (hopefully) reasonable default
168	always appended to it. See resource B<font> for details.	214	font list is always appended to it. See resource B<font> for more details.
		215
		216	In short, to specify an X11 core font, just specify its name or prefix it
		217	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
		218	e.g.:
		219
		220	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
		221	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
169		222
170	See also the question "How does rxvt-unicode choose fonts?" in the FAQ	223	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
171	section of @@RXVT_NAME@@(7).	224	section of @@RXVT_NAME@@(7).
172		225
173	=item B<-fb> I<fontlist>	226	=item B<-fb> I<fontlist>
174		227
175	Compile font-styles: The bold font list to use when bold characters are to	228	Compile I<font-styles>: The bold font list to use when B<bold> characters
176	be printed. See resource B<boldFont> for details.	229	are to be printed. See resource B<boldFont> for details.
177		230
178	=item B<-fi> I<fontlist>	231	=item B<-fi> I<fontlist>
179		232
180	Compile font-styles: The italic font list to use when bold characters are to	233	Compile I<font-styles>: The italic font list to use when I<italic>
181	be printed. See resource B<italicFont> for details.	234	characters are to be printed. See resource B<italicFont> for details.
182		235
183	=item B<-fbi> I<fontlist>	236	=item B<-fbi> I<fontlist>
184		237
185	Compile font-styles: The bold italic font list to use when bold characters are to	238	Compile I<font-styles>: The bold italic font list to use when B<< I<bold
186	be printed. See resource B<boldItalicFont> for details.	239	italic> >> characters are to be printed. See resource B<boldItalicFont>
		240	for details.
		241
		242	=item B<-is>\|B<+is>
		243
		244	Compile I<font-styles>: Bold/Italic font styles imply high intensity
		245	foreground/background (default). See resource B<intensityStyles> for
		246	details.
187		247
188	=item B<-name> I<name>	248	=item B<-name> I<name>
189		249
190	Specify the application name under which resources are to be obtained,	250	Specify the application name under which resources are to be obtained,
191	rather than the default executable file name. Name should not contain	251	rather than the default executable file name. Name should not contain
…		…
229		289
230	Put scrollbar on right/left; resource B<scrollBar_right>.	290	Put scrollbar on right/left; resource B<scrollBar_right>.
231		291
232	=item B<-st>\|B<+st>	292	=item B<-st>\|B<+st>
233		293
234	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	294	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
235	resource B<scrollBar_floating>.	295	resource B<scrollBar_floating>.
		296
		297	=item B<-ptab>\|B<+ptab>
		298
		299	If enabled (default), "Horizontal Tab" characters are being stored as
		300	actual wide characters in the screen buffer, which makes it possible to
		301	select and paste them. Since a horizontal tab is a cursor movement and
		302	not an actual glyph, this can sometimes be visually annoying as the cursor
		303	on a tab character is displayed as a wide cursor; resource B<pastableTabs>.
236		304
237	=item B<-bc>\|B<+bc>	305	=item B<-bc>\|B<+bc>
238		306
239	Blink the cursor; resource B<cursorBlink>.	307	Blink the cursor; resource B<cursorBlink>.
240		308
…		…
263		331
264	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	332	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
265	if honoured by the WM, the rxvt-unicode window will not have window	333	if honoured by the WM, the rxvt-unicode window will not have window
266	decorations; resource B<borderLess>.	334	decorations; resource B<borderLess>.
267		335
		336	=item B<-override-redirect>
		337
		338	Compile I<frills>: Sets override-redirect on the window; resource
		339	B<override-redirect>.
		340
		341	=item B<-sbg>
		342
		343	Compile I<frills>: Disable the usage of the built-in block graphics/line
		344	drawing characters and just rely on what the specified fonts provide. Use
		345	this if you have a good font and want to use its block graphic glyphs;
		346	resource B<skipBuiltinGlyphs>.
		347
268	=item B<-lsp> I<number>	348	=item B<-lsp> I<number>
269		349
270	Compile I<linespace>: Lines (pixel height) to insert between each row	350	Compile I<frills>: Lines (pixel height) to insert between each row of
271	of the display; resource B<linespace>.	351	the display. Useful to work around font rendering problems; resource
		352	B<lineSpace>.
272		353
273	=item B<-tn> I<termname>	354	=item B<-tn> I<termname>
274		355
275	This option specifies the name of the terminal type to be set in the	356	This option specifies the name of the terminal type to be set in the
276	B<TERM> environment variable. This terminal type must exist in the	357	B<TERM> environment variable. This terminal type must exist in the
…		…
285	given on the command line. If this option is used, it must be the last	366	given on the command line. If this option is used, it must be the last
286	on the command-line. If there is no B<-e> option then the default is to	367	on the command-line. If there is no B<-e> option then the default is to
287	run the program specified by the B<SHELL> environment variable or,	368	run the program specified by the B<SHELL> environment variable or,
288	failing that, I<sh(1)>.	369	failing that, I<sh(1)>.
289		370
		371	Please note that you must specify a program with arguments. If you want to
		372	run shell commands, you have to specify the shell, like this:
		373
		374	@@RXVT_NAME@@ -e sh -c "shell commands"
		375
290	=item B<-title> I<text>	376	=item B<-title> I<text>
291		377
292	Window title (B<-T> still respected); the default title is the basename	378	Window title (B<-T> still respected); the default title is the basename
293	of the program specified after the B<-e> option, if any, otherwise the	379	of the program specified after the B<-e> option, if any, otherwise the
294	application name; resource B<title>.	380	application name; resource B<title>.
…		…
312		398
313	Compile I<XIM>: input method name. resource B<inputMethod>.	399	Compile I<XIM>: input method name. resource B<inputMethod>.
314		400
315	=item B<-imlocale> I<string>	401	=item B<-imlocale> I<string>
316		402
317	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	403	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
318	de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input	404	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
319	extension to be able to input japanese characters while staying in	405	input extension to be able to input japanese characters while staying in
320	another locale.	406	another locale. resource B<imLocale>.
		407
		408	=item B<-imfont> I<fontset>
		409
		410	Set the font set to use for the X Input Method, see resource B<imFont>
		411	for more info.
		412
		413	=item B<-tcw>
		414
		415	Change the meaning of triple-click selection with the left mouse
		416	button. Only effective when the original (non-perl) selection code is
		417	in-use. Instead of selecting a full line it will extend the selection the
		418	end of the logical line only. resource B<tripleclickwords>.
321		419
322	=item B<-insecure>	420	=item B<-insecure>
323		421
324	Enable "insecure" mode, which currently enables most of the escape	422	Enable "insecure" mode, which currently enables most of the escape
325	sequences that echo strings. See the resource B<insecure> for more	423	sequences that echo strings. See the resource B<insecure> for more
…		…
339	=item B<-ssr>\|B<+ssr>	437	=item B<-ssr>\|B<+ssr>
340		438
341	Turn on/off secondary screen scroll (default enabled); resource	439	Turn on/off secondary screen scroll (default enabled); resource
342	B<secondaryScroll>.	440	B<secondaryScroll>.
343		441
		442	=item B<-hold>\|B<+hold>
		443
		444	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		445	will not immediately destroy its window when the program executed within
		446	it exits. Instead, it will wait till it is being killed or closed by the
		447	user; resource B<hold>.
		448
		449	=item B<-keysym.>I<sym> I<string>
		450
		451	Remap a key symbol. See resource B<keysym>.
		452
		453	=item B<-embed> I<windowid>
		454
		455	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
		456	which enables applications to easily embed a terminal.
		457
		458	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
		459	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
		460	quite a bit, so don't expect it to keep some specific state. It's best to
		461	create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
		462
		463	The window will not be destroyed when @@RXVT_NAME@@ exits.
		464
		465	It might be useful to know that @@RXVT_NAME@@ will not close file
		466	descriptors passed to it (except for stdin/out/err, of course), so you
		467	can use file descriptors to communicate with the programs within the
		468	terminal. This works regardless of whether the C<-embed> option was used or
		469	not.
		470
		471	Here is a short Gtk2-perl snippet that illustrates how this option can be
		472	used (a longer example is in F<doc/embed>):
		473
		474	my $rxvt = new Gtk2::Socket;
		475	$rxvt->signal_connect_after (realize => sub {
		476	my $xid = $_[0]->window->get_xid;
		477	system "@@RXVT_NAME@@ -embed $xid &";
		478	});
		479
		480	=item B<-pty-fd> I<file descriptor>
		481
		482	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
		483	pair but instead use the given file descriptor as the tty master. This is
		484	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
		485	without having to run a program within it.
		486
		487	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
		488	entries and will not tinker with pty/tty permissions - you have to do that
		489	yourself if you want that.
		490
		491	As an extremely special case, specifying C<-1> will completely suppress
		492	pty/tty operations.
		493
		494	Here is a example in perl that illustrates how this option can be used (a
		495	longer example is in F<doc/pty-fd>):
		496
		497	use IO::Pty;
		498	use Fcntl;
		499
		500	my $pty = new IO::Pty;
		501	fcntl $pty, F_SETFD, 0; # clear close-on-exec
		502	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		503	close $pty;
		504
		505	# now communicate with rxvt
		506	my $slave = $pty->slave;
		507	while (<$slave>) { print $slave "got <$_>\n" }
		508
344	=item B<-xrm> I<resourcestring>	509	=item B<-pe> I<string>
345		510
346	No effect on rxvt-unicode. Simply passes through an argument to be made	511	Comma-separated list of perl extension scripts to use (or not to use) in
347	available in the instance's argument list. Appears in I<WM_COMMAND> in	512	this terminal instance. See resource B<perl-ext> for details.
348	some window managers.
349		513
350	=back	514	=back
351		515
352	=head1 RESOURCES (available also as long-options)	516	=head1 RESOURCES (available also as long-options)
353		517
354	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	518	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
355	options) compiled into your version.	519	options) compiled into your version.
356		520
357	There are two different methods that @@RXVT_NAME@@ can use to get the	521	You can set and change the resources using X11 tools like B<xrdb>. Many
358	Xresource data: using the X libraries (Xrm*-functions) or internal	522	distribution do also load settings from the B<~/.Xresources> file when X
359	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	523	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
360	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	524	with later settings overwriting earlier ones:
361	resources using X11 tools like B<xset>. Many distribution do also load
362	settings from the B<~/.Xresources> file when X starts.
363		525
364	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>	526	1. system-wide app-defaults file, either locale-dependent OR global
365	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults	527	2. app-defaults file in $XAPPLRESDIR
366	set in XAPPLOADDIR/URxvt (compile-time defined: usually	528	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
367	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	529	4. SCREEN_RESOURCES for the current screen
368	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.	530	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		531
369	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	532	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
370	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows	533	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
371	resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be	534	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
372	easily configured, while the class name B<URxvt> allows resources	535	configured, while the class name B<URxvt> allows resources unique to
373	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	536	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
374	shared between different B<@@RXVT_NAME@@> configurations. If no	537	configurations. If no resources are specified, suitable defaults will
375	resources are specified, suitable defaults will be used. Command-line	538	be used. Command-line arguments can be used to override resource
376	arguments can be used to override resource settings. The following	539	settings. The following resources are supported (you might want to
377	resources are allowed:	540	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		541	extensions not documented here):
378		542
379	=over 4	543	=over 4
		544
		545	=item B<depth:> I<bitdepth>
		546
		547	Compile I<xft>: Attempt to find a visual with the given bit depth;
		548	option B<-depth>.
380		549
381	=item B<geometry:> I<geom>	550	=item B<geometry:> I<geom>
382		551
383	Create the window with the specified X window geometry [default 80x24];	552	Create the window with the specified X window geometry [default 80x24];
384	option B<-geometry>.	553	option B<-geometry>.
…		…
412		581
413	=item B<colorIT:> I<colour>	582	=item B<colorIT:> I<colour>
414		583
415	Use the specified colour to display bold or italic characters when the	584	Use the specified colour to display bold or italic characters when the
416	foreground colour is the default. If font styles are not available	585	foreground colour is the default. If font styles are not available
417	(Compile styles) and this option is unset, reverse video is used instead.	586	(Compile I<styles>) and this option is unset, reverse video is used instead.
418		587
419	=item B<colorUL:> I<colour>	588	=item B<colorUL:> I<colour>
420		589
421	Use the specified colour to display underlined characters when the	590	Use the specified colour to display underlined characters when the
422	foreground colour is the default.	591	foreground colour is the default.
423		592
424	=item B<colorRV:> I<colour>	593	=item B<colorRV:> I<colour>
425		594
426	Use the specified colour as the background for reverse video	595	Use the specified colour as the background for reverse video characters
427	characters.	596	when OPTION_HC is disabled (--disable-frills).
		597
		598	=item B<underlineColor:> I<colour>
		599
		600	If set, use the specified colour as the colour for the underline
		601	itself. If unset, use the foreground colour.
428		602
429	=item B<cursorColor:> I<colour>	603	=item B<cursorColor:> I<colour>
430		604
431	Use the specified colour for the cursor. The default is to use the	605	Use the specified colour for the cursor. The default is to use the
432	foreground colour; option B<-cr>.	606	foreground colour; option B<-cr>.
…		…
443	option B<-rv>. B<False>: regular screen colours [default]; option	617	option B<-rv>. B<False>: regular screen colours [default]; option
444	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	618	B<+rv>. See note in B<COLORS AND GRAPHICS> section.
445		619
446	=item B<jumpScroll:> I<boolean>	620	=item B<jumpScroll:> I<boolean>
447		621
448	B<True>: specify that jump scrolling should be used. When scrolling	622	B<True>: specify that jump scrolling should be used. When receiving lots
449	quickly, fewer screen updates are performed [default]; option B<-j>.	623	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		624	has been read, resulting in fewer updates while still displaying every
		625	received line; option B<-j>.
		626
450	B<False>: specify that smooth scrolling should be used; option B<+j>.	627	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		628	force a screen refresh on each new line it received; option B<+j>.
		629
		630	=item B<skipScroll:> I<boolean>
		631
		632	B<True>: (the default) specify that skip scrolling should be used. When
		633	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
		634	(around 60 times per second), resulting in far fewer updates. This can
		635	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		636	option B<-ss>.
		637
		638	B<False>: specify that everything is to be displayed, even
		639	if the refresh is too fast for the human eye to read anything (or the
		640	monitor to display anything); option B<+ss>.
451		641
452	=item B<inheritPixmap:> I<boolean>	642	=item B<inheritPixmap:> I<boolean>
453		643
454	B<True>: make the background inherit the parent windows' pixmap, giving	644	B<True>: make the background inherit the parent windows' pixmap, giving
455	artificial transparency. B<False>: do not inherit the parent windows'	645	artificial transparency. B<False>: do not inherit the parent windows'
456	pixmap.	646	pixmap.
457		647
		648	I<Please note that transparency of any kind if completely unsupported by
		649	the author. Don't bug him with installation questions!>
		650
458	=item B<fading:> I<number>	651	=item B<fading:> I<number>
459		652
460	Fade the text by the given percentage when focus is lost.	653	Fade the text by the given percentage when focus is lost; option B<-fade>.
		654
		655	=item B<fadeColor:> I<colour>
		656
		657	Fade to this colour, when fading is used (see B<fading:>). The default
		658	colour is black; option B<-fadecolor>.
461		659
462	=item B<tintColor:> I<colour>	660	=item B<tintColor:> I<colour>
463		661
464	Tint the transparent background pixmap with the given colour.	662	Tint the transparent background pixmap with the given colour; option
		663	B<-tint>.
465		664
466	=item B<shading:> I<number>	665	=item B<shading:> I<number>
467		666
468	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	667	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
469	image in addition to tinting it.	668	in addition to tinting it; option B<-sh>.
		669
		670	=item B<blendType:> I<string>
		671
		672	Specify background blending type; option B<-blt>.
		673
		674	=item B<blurRadius:> I<number>
		675
		676	Apply Gaussian Blurr with the specified radius to the transparent
		677	background image; option B<-blr>.
470		678
471	=item B<scrollColor:> I<colour>	679	=item B<scrollColor:> I<colour>
472		680
473	Use the specified colour for the scrollbar [default #B2B2B2].	681	Use the specified colour for the scrollbar [default #B2B2B2].
474		682
475	=item B<troughColor:> I<colour>	683	=item B<troughColor:> I<colour>
476		684
477	Use the specified colour for the scrollbar's trough area [default	685	Use the specified colour for the scrollbar's trough area [default
478	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	686	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
479		687
480	=item B<borderColor:> I<colour>	688	=item B<borderColor:> I<colour>
481		689
482	The colour of the border around the text area and between the scrollbar	690	The colour of the border around the text area and between the scrollbar
483	and the text.	691	and the text.
484		692
485	=item B<backgroundPixmap:> I<file[;geom]>	693	=item B<backgroundPixmap:> I<file[;geom]>
486		694
487	Use the specified XPM file (note the `.xpm' extension is optional) for	695	Use the specified image file for the background and also optionally
488	the background and also optionally specify its scaling with a geometry	696	specify its scaling with a geometry string B<WxH+X+Y>,
489	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	697	in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
490	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	698	and B<"X" / "Y"> locate the image centre (percent).
491	centre (percent). A scale of 0 displays the image with tiling. A scale	699	A scale of 0 displays the image with tiling. A scale of 1 displays the
492	of 1 displays the image without any scaling. A scale of 2 to 9	700	image without any scaling. A scale of 2 to 9 specifies an integer
493	specifies an integer number of images in that direction. No image will	701	number of images in that direction. No image will be magnified beyond
494	be magnified beyond 10 times its original size. The maximum permitted	702	10 times its original size. The maximum permitted scale is 1000.
495	scale is 1000. [default 0x0+50+50]	703	Special string of B<"auto"> used as a geometry will cause image to be
496		704	automatically scaled to match window size.
497	=item B<menu:> I<file[;tag]>	705	If used in conjunction with B<-tr> option - specified pixmap will be
498		706	blended over transparency image using either alpha-blending, or any
499	Read in the specified menu file (note the `.menu' extension is	707	other blending type, specified with B<-blt "type"> option.
500	optional) and also optionally specify a starting tag to find. See the	708	[default 0x0+50+50]
501	reference documentation for details on the syntax for the menuBar.
502		709
503	=item B<path:> I<path>	710	=item B<path:> I<path>
504		711
505	Specify the colon-delimited search path for finding files (XPM and	712	Specify the colon-delimited search path for finding XPM files.
506	menus), in addition to the paths specified by the B<RXVTPATH> and
507	B<PATH> environment variables.
508		713
509	=item B<font:> I<fontlist>	714	=item B<font:> I<fontlist>
510		715
511	Select the fonts to be used. This is a comma separated list of font	716	Select the fonts to be used. This is a comma separated list of font names
512	names that are used in turn when trying to display Unicode characters.	717	that are checked in order when trying to find glyphs for characters. The
513	The first font defines the cell size for characters; other fonts might	718	first font defines the cell size for characters; other fonts might be
514	be smaller, but not larger. A reasonable default font list is always	719	smaller, but not (in general) larger. A (hopefully) reasonable default
515	appended to it. option B<-fn>.	720	font list is always appended to it; option B<-fn>.
516		721
517	Each font can either be a standard X11 core font (XLFD) name, with	722	Each font can either be a standard X11 core font (XLFD) name, with
518	optional prefix C<x:> or a Xft font (Compile xft), prefixed with C<xft:>.	723	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
519		724
520	In addition, each font can be prefixed with additional hints and	725	In addition, each font can be prefixed with additional hints and
521	specifications enclosed in square brackets (C<[]>). The only available	726	specifications enclosed in square brackets (C<[]>). The only available
522	hint currently is C<codeset=codeset-name>, and this is only used for Xft	727	hint currently is C<codeset=codeset-name>, and this is only used for Xft
523	fonts.	728	fonts.
524		729
525	For example, this font resource	730	For example, this font resource
526		731
527	URxvt*font: 9x15bold,\	732	URxvt.font: 9x15bold,\
528	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	733	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
529	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \	734	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
530	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	735	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
531	xft:Code2000:antialias=false	736	xft:Code2000:antialias=false
532		737
533	specifies five fonts to be used. The first one is C<9x15bold> (actually	738	specifies five fonts to be used. The first one is C<9x15bold> (actually
534	the iso8859-1 version of the second font), which is the base font (because	739	the iso8859-1 version of the second font), which is the base font (because
535	it is named first) and thus defines the character cell grid to be 9 pixels	740	it is named first) and thus defines the character cell grid to be 9 pixels
536	wide and 15 pixels high.	741	wide and 15 pixels high.
537		742
538	the second font is just used to add additional unicode characters not in	743	The second font is just used to add additional unicode characters not in
539	the base font, likewise the third, which is unfortunately non-bold, but	744	the base font, likewise the third, which is unfortunately non-bold, but
540	the bold version of the font does contain less characters, so this is a	745	the bold version of the font does contain less characters, so this is a
541	useful supplement.	746	useful supplement.
542		747
543	The third font is an Xft font with aliasing turned off, and the characters	748	The third font is an Xft font with aliasing turned off, and the characters
…		…
566	not possible, replacement fonts of the desired shape will be tried.	771	not possible, replacement fonts of the desired shape will be tried.
567		772
568	If set, but empty, then this specific style is disabled and the normal	773	If set, but empty, then this specific style is disabled and the normal
569	text font will being used for the given style.	774	text font will being used for the given style.
570		775
		776	=item B<intensityStyles:> I<boolean>
		777
		778	When font styles are not enabled, or this option is enabled (B<True>,
		779	option B<-is>, the default), bold and italic font styles imply high
		780	intensity foreground/background colours. Disabling this option (B<False>,
		781	option B<+is>) disables this behaviour, the high intensity colours are not
		782	reachable.
		783
571	=item B<selectstyle:> I<mode>	784	=item B<selectstyle:> I<mode>
572		785
573	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	786	Set mouse selection style to B<old> which is 2.20, B<oldword> which
574	xterm style with 2.20 old word selection, or anything else which gives	787	is xterm style with 2.20 old word selection, or anything else which
575	xterm style selection.	788	gives xterm style selection. Only effective when the original (non-perl)
		789	selection code is in use.
576		790
577	=item B<scrollstyle:> I<mode>	791	=item B<scrollstyle:> I<mode>
578		792
579	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	793	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
580	the author's favourite..	794	the author's favourite.
581		795
582	=item B<title:> I<string>	796	=item B<title:> I<string>
583		797
584	Set window title string, the default title is the command-line	798	Set window title string, the default title is the command-line
585	specified after the B<-e> option, if any, otherwise the application	799	specified after the B<-e> option, if any, otherwise the application
…		…
594	=item B<mapAlert:> I<boolean>	808	=item B<mapAlert:> I<boolean>
595		809
596	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	810	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
597	de-iconify (map) on receipt of a bell character [default].	811	de-iconify (map) on receipt of a bell character [default].
598		812
		813	=item B<urgentOnBell:> I<boolean>
		814
		815	B<True>: set the urgency hint for the wm on receipt of a bell character.
		816	B<False>: do not set the urgency hint [default].
		817
599	=item B<visualBell:> I<boolean>	818	=item B<visualBell:> I<boolean>
600		819
601	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	820	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
602	B<False>: no visual bell [default]; option B<+vb>.	821	B<False>: no visual bell [default]; option B<+vb>.
603		822
…		…
617		836
618	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	837	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
619	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or	838	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
620	B<Shift-Print> to include the scrollback as well.	839	B<Shift-Print> to include the scrollback as well.
621		840
		841	The string will be interpreted as if typed into the shell as-is.
		842
		843	Example:
		844
		845	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		846
		847	This creates a new file in your home directory with the screen contents
		848	every time you hit C<Print>.
		849
622	=item B<scrollBar:> I<boolean>	850	=item B<scrollBar:> I<boolean>
623		851
624	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	852	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
625	disable the scrollbar; option B<+sb>.	853	disable the scrollbar; option B<+sb>.
626		854
…		…
646	B<+si>.	874	B<+si>.
647		875
648	=item B<scrollWithBuffer:> I<boolean>	876	=item B<scrollWithBuffer:> I<boolean>
649		877
650	B<True>: scroll with scrollback buffer when tty receives new lines (and	878	B<True>: scroll with scrollback buffer when tty receives new lines (and
651	B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll	879	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
652	with scrollback buffer when tty recieves new lines; option B<-sw>.	880	with scrollback buffer when tty receives new lines; option B<+sw>.
653		881
654	=item B<scrollTtyKeypress:> I<boolean>	882	=item B<scrollTtyKeypress:> I<boolean>
655		883
656	B<True>: scroll to bottom when a non-special key is pressed. Special keys	884	B<True>: scroll to bottom when a non-special key is pressed. Special keys
657	are those which are intercepted by rxvt-unicode for special handling and	885	are those which are intercepted by rxvt-unicode for special handling and
…		…
676	=item B<borderLess:> I<boolean>	904	=item B<borderLess:> I<boolean>
677		905
678	Set MWM hints to request a borderless window, i.e. if honoured by the	906	Set MWM hints to request a borderless window, i.e. if honoured by the
679	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.	907	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
680		908
		909	=item B<skipBuiltinGlyphs:> I<boolean>
		910
		911	Compile I<frills>: Disable the usage of the built-in block graphics/line
		912	drawing characters and just rely on what the specified fonts provide. Use
		913	this if you have a good font and want to use its block graphic glyphs;
		914	option B<-sbg>.
		915
681	=item B<termName:> I<termname>	916	=item B<termName:> I<termname>
682		917
683	Specifies the terminal type name to be set in the B<TERM> environment	918	Specifies the terminal type name to be set in the B<TERM> environment
684	variable; option B<-tn>.	919	variable; option B<-tn>.
685		920
686	=item B<linespace:> I<number>	921	=item B<lineSpace:> I<number>
687		922
688	Specifies number of lines (pixel height) to insert between each row of	923	Specifies number of lines (pixel height) to insert between each row of
689	the display [default 0]; option B<-lsp>.	924	the display [default 0]; option B<-lsp>.
690		925
691	=item B<meta8:> I<boolean>	926	=item B<meta8:> I<boolean>
…		…
695		930
696	=item B<mouseWheelScrollPage:> I<boolean>	931	=item B<mouseWheelScrollPage:> I<boolean>
697		932
698	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel	933	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
699	scrolls five lines [default].	934	scrolls five lines [default].
		935
		936	=item B<pastableTabs:> I<boolean>
		937
		938	B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
		939	movement only; option C<-ptab>.
700		940
701	=item B<cursorBlink:> I<boolean>	941	=item B<cursorBlink:> I<boolean>
702		942
703	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	943	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
704	option B<-bc>.	944	option B<-bc>.
…		…
717		957
718	Mouse pointer background colour.	958	Mouse pointer background colour.
719		959
720	=item B<pointerBlankDelay:> I<number>	960	=item B<pointerBlankDelay:> I<number>
721		961
722	Specifies number of seconds before blanking the pointer [default 2].	962	Specifies number of seconds before blanking the pointer [default 2]. Use a
		963	large number (e.g. C<987654321>) to effectively disable the timeout.
723		964
724	=item B<backspacekey:> I<string>	965	=item B<backspacekey:> I<string>
725		966
726	The string to send when the backspace key is pressed. If set to B<DEC>	967	The string to send when the backspace key is pressed. If set to B<DEC>
727	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	968	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
…		…
734	pressed. If unset it will send the sequence traditionally associated	975	pressed. If unset it will send the sequence traditionally associated
735	with the B<Execute> key.	976	with the B<Execute> key.
736		977
737	=item B<cutchars:> I<string>	978	=item B<cutchars:> I<string>
738		979
739	The characters used as delimiters for double-click word selection. The	980	The characters used as delimiters for double-click word selection
740	built-in default:	981	(whitespace delimiting is added automatically if resource is given).
		982
		983	When the perl selection extension is in use (the default if compiled
		984	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		985	characters will be created (if the resource exists, otherwise, no regex
		986	will be created). In this mode, characters outside ISO-8859-1 can be used.
		987
		988	When the selection extension is not used, only ISO-8859-1 characters can
		989	be used. If not specified, the built-in default is used:
741		990
742	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	991	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>
743		992
744	=item B<preeditType:> I<style>	993	=item B<preeditType:> I<style>
745		994
…		…
749		998
750	I<name> of inputMethod to use; option B<-im>.	999	I<name> of inputMethod to use; option B<-im>.
751		1000
752	=item B<imLocale:> I<name>	1001	=item B<imLocale:> I<name>
753		1002
754	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	1003	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
755	de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input	1004	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
756	extension to be able to input japanese characters while staying in	1005	input extension to be able to input japanese characters while staying in
757	another locale. option B<-imlocale>.	1006	another locale; option B<-imlocale>.
		1007
		1008	=item B<imFont:> I<fontset>
		1009
		1010	Specify the font-set used for XIM styles C<OverTheSpot> or
		1011	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
		1012	by commas), i.e. it's not in the same format as the other font lists used
		1013	in @@RXVT_NAME@@. The default will be set-up to chose any suitable found
		1014	found, preferably one or two pixels differing in size to the base font.
		1015	option B<-imfont>.
		1016
		1017	=item B<tripleclickwords:> I<boolean>
		1018
		1019	Change the meaning of triple-click selection with the left mouse
		1020	button. Instead of selecting a full line it will extend the selection to
		1021	the end of the logical line only; option B<-tcw>.
758		1022
759	=item B<insecure:> I<boolean>	1023	=item B<insecure:> I<boolean>
760		1024
761	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	1025	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
762	echo arbitrary strings like the icon name or the locale. This could be	1026	echo arbitrary strings like the icon name or the locale. This could be
763	abused if somebody gets 8-bit-clean access to your display, whether	1027	abused if somebody gets 8-bit-clean access to your display, whether
764	throuh a mail client displaying mail bodies unfiltered or though	1028	through a mail client displaying mail bodies unfiltered or through
765	write(1). Therefore, these sequences are disabled by default. (Note	1029	write(1) or any other means. Therefore, these sequences are disabled by
766	that other terminals, including xterm, have these sequences	1030	default. (Note that many other terminals, including xterm, have these
767	enabled by default). You can enable them by setting this boolean	1031	sequences enabled by default, which doesn't make it safer, though).
768	resource or specifying B<-insecure> as an option. At the moment, this	1032
769	enabled display-answer, locale, findfont, icon label and window title	1033	You can enable them by setting this boolean resource or specifying
770	requests as well as dynamic menubar dispatch.	1034	B<-insecure> as an option. At the moment, this enables display-answer,
		1035	locale, findfont, icon label and window title requests.
771		1036
772	=item B<modifier:> I<modifier>	1037	=item B<modifier:> I<modifier>
773		1038
774	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	1039	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
775	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	1040	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
779		1044
780	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	1045	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
781	character is passed through. It may contain escape values as described	1046	character is passed through. It may contain escape values as described
782	in the entry on B<keysym> following.	1047	in the entry on B<keysym> following.
783		1048
784	=item B<secondaryScreen:> I<bool>	1049	=item B<secondaryScreen:> I<boolean>
785		1050
786	Turn on/off secondary screen (default enabled).	1051	Turn on/off secondary screen (default enabled).
787		1052
788	=item B<secondaryScroll:> I<bool>	1053	=item B<secondaryScroll:> I<boolean>
789		1054
790	Turn on/off secondary screen scroll (default enabled). If the this	1055	Turn on/off secondary screen scroll (default enabled). If this
791	option is enabled, scrolls on the secondary screen will change the	1056	option is enabled, scrolls on the secondary screen will change the
792	scrollback buffer and switching to/from the secondary screen will	1057	scrollback buffer and switching to/from the secondary screen will
793	instead scroll the screen up.	1058	instead scroll the screen up.
794		1059
		1060	=item B<hold>: I<boolean>
		1061
		1062	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		1063	will not immediately destroy its window when the program executed within
		1064	it exits. Instead, it will wait till it is being killed or closed by the
		1065	user.
		1066
795	=item B<keysym.>I<sym>: I<string>	1067	=item B<keysym.>I<sym>: I<string>
796		1068
797	Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may	1069	Compile I<frills>: Associate I<string> with keysym I<sym>. The
798	contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:	1070	intervening resource name B<keysym.> cannot be omitted.
799	newline, \r: return, \t:	1071
		1072	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
		1073	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
		1074	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
		1075	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
		1076	B<2>, B<3>, B<4>, B<5>.
		1077
		1078	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
		1079	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
		1080	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
		1081	current application keymap mode state.
		1082
		1083	The spellings of I<key> can be obtained by using B<xev>(1) command or
		1084	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
		1085	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
		1086	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
		1087	performed in an exact manner; however, the closest match is assured.
		1088
		1089	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
		1090	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
800	tab, \000: octal number) or control characters (^?: delete, ^@: null,	1091	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
801	^A ...) and may enclosed with double quotes so that it can start or end	1092	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
802	with whitespace. The intervening resource name B<keysym.> cannot be	1093	can start or end with whitespace. B<This feature is deprecated and will
803	omitted. This resource is only available when compiled with	1094	be removed>.
804	KEYSYM_RESOURCE.	1095
		1096	Please note that you need to double the C<\> in resource files, as
		1097	Xlib itself does its own de-escaping (you can use C<\033> instead of
		1098	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
		1099	processing).
		1100
		1101	You can define a range of keysyms in one shot by providing a I<string>
		1102	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
		1103	should be a character not used by the strings.
		1104
		1105	Its usage can be demonstrated by an example:
		1106
		1107	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
		1108
		1109	The above line is equivalent to the following three lines:
		1110
		1111	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
		1112	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
		1113	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
		1114
		1115	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
		1116	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
		1117	example the following means "change the current locale to C<zh_CN.GBK>
		1118	when Control-Meta-c is being pressed":
		1119
		1120	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		1121
		1122	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1123	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1124	manpage. For example, the F<selection> extension (activated via
		1125	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1126
		1127	URxvt.keysym.M-C-c: perl:selection:rot13
		1128
		1129	Due the the large number of modifier combinations, a defined key mapping
		1130	will match if at I<at least> the specified identifiers are being set, and
		1131	no other key mappings with those and more bits are being defined. That
		1132	means that defining a key map for C<a> will automatically provide
		1133	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		1134	mappings themselves.
		1135
		1136	Unfortunately, this will override built-in key mappings. For example
		1137	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		1138	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		1139	user-defined keymap using the C<builtin:> replacement:
		1140
		1141	URxvt.keysym.Insert: <my insert key sequence>
		1142	URxvt.keysym.S-Insert: builtin:
		1143
		1144	The first line defines a mapping for C<Insert> and I<any> combination
		1145	of modifiers. The second line re-establishes the default mapping for
		1146	C<Shift-Insert>.
		1147
		1148	The following example will map Control-Meta-1 and Control-Meta-2 to
		1149	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
		1150	font-switching at runtime:
		1151
		1152	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1153	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
		1154
		1155	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
		1156	info):
		1157
		1158	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1159	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1160
		1161	=item B<perl-ext-common>: I<string>
		1162
		1163	=item B<perl-ext>: I<string>
		1164
		1165	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1166	use in this terminal instance; option B<-pe>.
		1167
		1168	Extension names can be prefixed with a C<-> sign to prohibit using
		1169	them. This can be useful to selectively disable some extensions loaded
		1170	by default, or specified via the C<perl-ext-common> resource. For
		1171	example, C<default,-selection> will use all the default extension except
		1172	C<selection>.
		1173
		1174	Extension names can also be followed by an argument in angle brackets
		1175	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1176	searchable scrollback to Alt/Meta-s). Mentioning the same extension
		1177	multiple times with different arguments will pass multiple arguments to
		1178	the extension.
		1179
		1180	Each extension is looked up in the library directories, loaded if
		1181	necessary, and bound to the current terminal instance.
		1182
		1183	If both of these resources are the empty string, then the perl
		1184	interpreter will not be initialized. The idea behind two options is that
		1185	B<perl-ext-common> will be used for extensions that should be available to
		1186	all instances, while B<perl-ext> is used for specific instances.
		1187
		1188	=item B<perl-eval>: I<string>
		1189
		1190	Perl code to be evaluated when all extensions have been registered. See
		1191	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
		1192	will be ignored when running setuid/setgid.
		1193
		1194	=item B<perl-lib>: I<path>
		1195
		1196	Colon-separated list of additional directories that hold extension
		1197	scripts. When looking for extensions specified by the C<perl> resource,
		1198	@@RXVT_NAME@@ will first look in these directories and then in
		1199	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
		1200	will be ignored when running setuid/setgid.
		1201
		1202	See the @@RXVT_NAME@@perl(3) manpage.
		1203
		1204	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1205
		1206	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1207	details.
		1208
		1209	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1210
		1211	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1212	for details.
		1213
		1214	=item B<searchable-scrollback:> I<keysym>
		1215
		1216	Sets the hotkey that starts the incremental scrollback buffer search
		1217	(default: C<M-s>).
		1218
		1219	=item B<urlLauncher>: I<string>
		1220
		1221	Specifies the program to be started with a URL argument. Used by the
		1222	C<selection-popup> and C<matcher> perl extensions.
		1223
		1224	=item B<transient-for>: I<windowid>
		1225
		1226	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1227
		1228	=item B<override-redirect>: I<boolean>
		1229
		1230	Compile I<frills>: Sets override-redirect for the terminal window, making
		1231	it almost invisible to window managers; option B<-override-redirect>.
		1232
		1233	=item B<iso14755_52:> I<boolean>
		1234
		1235	Turn on/off ISO 14755 5.2 mode (default enabled).
805		1236
806	=back	1237	=back
807		1238
808	=head1 THE SCROLLBAR	1239	=head1 THE SCROLLBAR
809		1240
…		…
823	the normal text selection/insertion, hold either the Shift or the Meta	1254	the normal text selection/insertion, hold either the Shift or the Meta
824	(Alt) key while performing the desired mouse action.	1255	(Alt) key while performing the desired mouse action.
825		1256
826	If mouse reporting mode is active, the normal scrollbar actions are	1257	If mouse reporting mode is active, the normal scrollbar actions are
827	disabled -- on the assumption that we are using a fullscreen	1258	disabled -- on the assumption that we are using a fullscreen
828	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	1259	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
829	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	1260	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
830	up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down),	1261	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
831	respectively.	1262	respectively.
832		1263
833	=head1 TEXT SELECTION AND INSERTION	1264	=head1 THE SELECTION: SELECTING AND PASTING TEXT
834		1265
835	The behaviour of text selection and insertion mechanism is similar to	1266	The behaviour of text selection and insertion/pasting mechanism is similar
836	I<xterm>(1).	1267	to I<xterm>(1).
837		1268
838	=over 4	1269	=over 4
839		1270
840	=item B<Selection>:	1271	=item B<Selecting>:
841		1272
842	Left click at the beginning of the region, drag to the end of the	1273	Left click at the beginning of the region, drag to the end of the region
843	region and release; Right click to extend the marked region; Left	1274	and release; Right click to extend the marked region; Left double-click
844	double-click to select a word; Left triple-click to select the entire	1275	to select a word; Left triple-click to select the entire logical line
845	line.	1276	(which can span multiple screen lines), unless modified by resource
		1277	B<tripleclickwords>.
846		1278
847	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1279	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
848	(Compile: frills) will create a rectangular selection instead of a normal	1280	(Compile: I<frills>) will create a rectangular selection instead of a
849	one.	1281	normal one. In this mode, every selected row becomes its own line in the
		1282	selection, and trailing whitespace is visually underlined and removed from
		1283	the selection.
850		1284
851	=item B<Insertion>:	1285	=item B<Pasting>:
852		1286
853	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1287	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
854	an B<@@RXVT_NAME@@> window causes the current text selection to be	1288	window causes the value of the PRIMARY selection (or CLIPBOARD with the
855	inserted as if it had been typed on the keyboard.	1289	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1290
		1291	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1292	inserted too.
856		1293
857	=back	1294	=back
858		1295
859	=head1 CHANGING FONTS	1296	=head1 CHANGING FONTS
860		1297
861	Changing fonts (or font sizes, respectively) via the keypad is not yet	1298	Changing fonts (or font sizes, respectively) via the keypad is not yet
862	supported in rxvt-unicode. Bug me if you need this.	1299	supported in rxvt-unicode. Bug me if you need this.
863		1300
864	You can, however, switch fonts at runtime using escape sequences (and	1301	You can, however, switch fonts at runtime using escape sequences, e.g.:
865	therefore using the menubar), e.g.:
866		1302
867	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1303	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1304
		1305	You can use keyboard shortcuts, too:
		1306
		1307	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1308	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
868		1309
869	rxvt-unicode will automatically re-apply these fonts to the output so far.	1310	rxvt-unicode will automatically re-apply these fonts to the output so far.
870		1311
871	=head1 ISO 14755 SUPPORT	1312	=head1 ISO 14755 SUPPORT
872		1313
873	ISO 14755 is a standard for entering and viewing unicode characters	1314	ISO 14755 is a standard for entering and viewing unicode characters
874	and character codes using the keyboard. It consists of 4 parts. The	1315	and character codes using the keyboard. It consists of 4 parts. The
875	first part is available rxvt-unicode has been compiled with	1316	first part is available if rxvt-unicode has been compiled with
876	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1317	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
877	with C<--enable-iso14755>.	1318	with C<--enable-iso14755>.
878		1319
879	=over 4	1320	=over 4
880		1321
881	=item 5.1: Basic method	1322	=item * 5.1: Basic method
882		1323
883	This allows you to enter unicode characters using their hexcode.	1324	This allows you to enter unicode characters using their hexcode.
884		1325
885	Start by pressing and holding both C<Control> and C<Shift>, then enter	1326	Start by pressing and holding both C<Control> and C<Shift>, then enter
886	hex-digits (between one and six). Releasing C<Control> and C<Shift> will	1327	hex-digits (between one and six). Releasing C<Control> and C<Shift> will
…		…
893	address, which you cannot type. Fortunately, the card has the e-mail	1334	address, which you cannot type. Fortunately, the card has the e-mail
894	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily	1335	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
895	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,	1336	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
896	followed by releasing the modifier keys.	1337	followed by releasing the modifier keys.
897		1338
898	=item 5.2: Keyboard symbols entry method	1339	=item * 5.2: Keyboard symbols entry method
899		1340
900	This mode lets you input characters representing the keycap symbols of	1341	This mode lets you input characters representing the keycap symbols of
901	your keyboard, if representable in the current locale encoding.	1342	your keyboard, if representable in the current locale encoding.
902		1343
903	Start by pressing C<Control> and C<Shift> together, then releasing	1344	Start by pressing C<Control> and C<Shift> together, then releasing
904	them. The next special key (cursor keys, home etc.) you enter will not	1345	them. The next special key (cursor keys, home etc.) you enter will not
905	invoke it's usual function but instead will insert the corresponding	1346	invoke its usual function but instead will insert the corresponding
906	keycap symbol. The symbol will only be entered when the key has been	1347	keycap symbol. The symbol will only be entered when the key has been
907	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1348	released, otherwise pressing e.g. C<Shift> would enter the symbol for
908	C<ISO Level 2 Switch>, although your intention might have been to enter a	1349	C<ISO Level 2 Switch>, although your intention might have been to enter a
909	reverse tab (Shift-Tab).	1350	reverse tab (Shift-Tab).
910		1351
911	=item 5.3: Screen-selection entry method	1352	=item * 5.3: Screen-selection entry method
912		1353
913	While this is implemented already (it's basically the selection	1354	While this is implemented already (it's basically the selection
914	mechanism), it could be extended by displaying a unicode character map.	1355	mechanism), it could be extended by displaying a unicode character map.
915		1356
916	=item 5.4: Feedback method for identifying displayed characters for later input	1357	=item * 5.4: Feedback method for identifying displayed characters for later input
917		1358
918	This method lets you display the unicode character code associated with	1359	This method lets you display the unicode character code associated with
919	characters already displayed.	1360	characters already displayed.
920		1361
921	You enter this mode by holding down C<Control> and C<Shift> together, then	1362	You enter this mode by holding down C<Control> and C<Shift> together, then
…		…
933	With respect to conformance, rxvt-unicode is supposed to be compliant to	1374	With respect to conformance, rxvt-unicode is supposed to be compliant to
934	both scenario A and B of ISO 14755, including part 5.2.	1375	both scenario A and B of ISO 14755, including part 5.2.
935		1376
936	=head1 LOGIN STAMP	1377	=head1 LOGIN STAMP
937		1378
938	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so	1379	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
939	that it can be seen via the I<who(1)> command, and can accept messages.	1380	it can be seen via the I<who(1)> command, and can accept messages. To
940	To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on	1381	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
941	some systems.	1382	on some systems or setgid to root or to some other group on others.
942		1383
943	=head1 COLORS AND GRAPHICS	1384	=head1 COLORS AND GRAPHICS
944		1385
945	In addition to the default foreground and background colours,	1386	In addition to the default foreground and background colours,
946	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1387	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
947	high-intensity bold/blink versions of the same). Here is a list of the	1388	high-intensity bold/blink versions of the same). Here is a list of the
948	colours with their B<rgb.txt> names.	1389	colours with their names.
949		1390
950	=begin table	1391	=begin table
951		1392
952	B<color0> (black) = Black	1393	B<color0> (black) = Black
953	B<color1> (red) = Red3	1394	B<color1> (red) = Red3
…		…
973	It is also possible to specify the colour values of B<foreground>,	1414	It is also possible to specify the colour values of B<foreground>,
974	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1415	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
975	a number 0-15, as a convenient shorthand to reference the colour name of	1416	a number 0-15, as a convenient shorthand to reference the colour name of
976	color0-color15.	1417	color0-color15.
977		1418
		1419	In addition to the colours defined above, @@RXVT_NAME@@ offers an
		1420	additional 72 colours. The first 64 of those (with indices 16 to 79)
		1421	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
		1422	16>), followed by 8 additional shades of gray (with indices 80 to 87).
		1423
		1424	Together, all those colours implement the 88 colour xterm colours. Only
		1425	the first 16 can be changed using resources currently, the rest can only
		1426	be changed via command sequences ("escape codes").
		1427
978	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1428	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
979	always swapping the foreground/background colours. This is in contrast to	1429	always swapping the foreground/background colours. This is in contrast to
980	I<xterm>(1) where the colours are only swapped if they have not otherwise	1430	I<xterm>(1) where the colours are only swapped if they have not otherwise
981	been specified. For example,	1431	been specified. For example,
982		1432
…		…
987	would yield White on Black, while on I<xterm>(1) it would yield Black	1437	would yield White on Black, while on I<xterm>(1) it would yield Black
988	on White.	1438	on White.
989		1439
990	=back	1440	=back
991		1441
		1442	=head2 ALPHA CHANNEL SUPPORT
		1443
		1444	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1445	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
		1446	(recommended, but B<MUST> have 4 digits/component) colour specifications,
		1447	in addition to the ones provided by X, where the additional A component
		1448	specifies opacity (alpha) values. The minimum value of C<0> is completely
		1449	transparent). You can also prefix any color with C<[percent]>, where
		1450	C<percent> is a decimal percentage (0-100) that specifies the opacity of
		1451	the color, where C<0> is completely transparent and C<100> is completelxy
		1452	opaque.
		1453
		1454	You probably need to specify B<"-depth 32">, too, and have the luck that
		1455	your X-server uses ARGB pixel layout, as X is far from just supporting
		1456	ARGB visuals out of the box, and rxvt-unicode just fudges around.
		1457
		1458	For example, the following selects an almost completely transparent red
		1459	background, and an almost opaque pink foreground:
		1460
		1461	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
		1462
		1463	I<Please note that transparency of any kind if completely unsupported by
		1464	the author. Don't bug him with installation questions!>
		1465
992	=head1 ENVIRONMENT	1466	=head1 ENVIRONMENT
993		1467
994	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>	1468	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
995	and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X	1469
996	window id number of the B<@@RXVT_NAME@@> window and it also uses and	1470	=over 4
997	sets the environment variable B<DISPLAY> to specify which display	1471
998	terminal to use. B<@@RXVT_NAME@@> uses the environment variables	1472	=item B<TERM>
999	B<RXVTPATH> and B<PATH> to find XPM files.	1473
		1474	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
		1475	resources or on the command line.
		1476
		1477	=item B<COLORTERM>
		1478
		1479	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
		1480	compiled with XPM support, and optionally with the added extension
		1481	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
		1482
		1483	=item B<COLORFGBG>
		1484
		1485	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
		1486	the colour code used as default foreground/text colour (or the string
		1487	C<default> to indicate that the default-colour escape sequence is to be
		1488	used), C<bg> is the colour code used as default background colour (or the
		1489	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1490	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
		1491	(and do) use this information to optimize screen output.
		1492
		1493	=item B<WINDOWID>
		1494
		1495	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
		1496	window, which usually has subwindows for the scrollbar, the terminal
		1497	window and so on).
		1498
		1499	=item B<TERMINFO>
		1500
		1501	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1502	C<--with-terminfo=PATH>.
		1503
		1504	=item B<DISPLAY>
		1505
		1506	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
		1507	display in its child processes.
		1508
		1509	=item B<SHELL>
		1510
		1511	The shell to be used for command execution, defaults to C</bin/sh>.
		1512
		1513	=item B<RXVT_SOCKET>
		1514
		1515	The unix domain socket path used by @@RXVT_NAME@@c(1) and
		1516	@@RXVT_NAME@@d(1).
		1517
		1518	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
		1519
		1520	=item B<HOME>
		1521
		1522	Used to locate the default directory for the unix domain socket for
		1523	daemon communications and to locate various resource files (such as
		1524	C<.Xdefaults>)
		1525
		1526	=item B<XAPPLRESDIR>
		1527
		1528	Directory where various X resource files are being located.
		1529
		1530	=item B<XENVIRONMENT>
		1531
		1532	If set and accessible, gives the name of a X resource file to be loaded by
		1533	@@RXVT_NAME@@.
		1534
		1535	=back
1000		1536
1001	=head1 FILES	1537	=head1 FILES
1002		1538
1003	=over 4	1539	=over 4
1004		1540
1005	=item B</etc/utmp>
1006
1007	System file for login records.
1008
1009	=item B</usr/lib/X11/rgb.txt>	1541	=item B</usr/lib/X11/rgb.txt>
1010		1542
1011	Color names.	1543	Color names.
1012		1544
1013	=back	1545	=back
1014		1546
1015	=head1 SEE ALSO	1547	=head1 SEE ALSO
1016		1548
1017	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1549	@@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)
1018
1019	=head1 BUGS
1020
1021	Check the BUGS file for an up-to-date list.
1022
1023	Cursor change support is not yet implemented.
1024
1025	Click-and-drag doesn't work with X11 mouse report overriding.
1026		1550
1027	=head1 CURRENT PROJECT COORDINATOR	1551	=head1 CURRENT PROJECT COORDINATOR
1028		1552
1029	=over 4	1553	=over 4
1030		1554
1031	=item Project Coordinator	1555	=item Project Coordinator
1032		1556
1033	@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@>	1557	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1034		1558
1035	=item Web page maintainter	1559	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1036
1037	@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1038
1039	L<@@RXVT_WEBPAGE@@>
1040		1560
1041	=back	1561	=back
1042		1562
1043	=head1 AUTHORS	1563	=head1 AUTHORS
1044		1564
…		…
1066		1586
1067	Project Coordinator (changes.txt 2.21a to 2.4.5)	1587	Project Coordinator (changes.txt 2.21a to 2.4.5)
1068		1588
1069	=item Geoff Wing L<< <gcw@pobox.com> >>	1589	=item Geoff Wing L<< <gcw@pobox.com> >>
1070		1590
1071	Rewrote screen display and text selection routines. Project Coordinator	1591	Rewrote screen display and text selection routines.
		1592
1072	(changes.txt 2.4.6 - rxvt-unicode)	1593	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1073		1594
1074	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>	1595	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1075		1596
1076	Forked rxvt-unicode, rewrote most of the display code and internal	1597	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1077	character handling to store text in unicode, improve xterm	1598	extension, random hacks, numerous bugfixes and extensions.
1078	compatibility and apply numerous other bugfixes and extensions.
1079		1599
1080	Project Coordinator (Changes 1.0 -)	1600	Project Coordinator (Changes 1.0 -)
1081		1601
		1602	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1603
		1604	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
		1605
1082	=back	1606	=back
1083		1607

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.32 by root, Sat Oct 9 11:18:12 2004 UTC vs. Revision 1.137 by root, Sat Sep 1 09:38:50 2007 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.32 by root, Sat Oct 9 11:18:12 2004 UTC vs.
Revision 1.137 by root, Sat Sep 1 09:38:50 2007 UTC