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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.1 by root, Thu Aug 12 20:42:12 2004 UTC vs.
Revision 1.127 by ayin, Wed May 2 23:06:32 2007 UTC

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.1 by root, Thu Aug 12 20:42:12 2004 UTC vs. Revision 1.127 by ayin, Wed May 2 23:06:32 2007 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.1 by root, Thu Aug 12 20:42:12 2004 UTC vs.
Revision 1.127 by ayin, Wed May 2 23:06:32 2007 UTC