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

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.30 by root, Wed Sep 8 17:10:23 2004 UTC vs. Revision 1.147 by root, Fri Nov 23 11:18:04 2007 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.30 by root, Wed Sep 8 17:10:23 2004 UTC vs.
Revision 1.147 by root, Fri Nov 23 11:18:04 2007 UTC