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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.60 by root, Thu Feb 17 15:13:47 2005 UTC vs.
Revision 1.127 by ayin, Wed May 2 23:06:32 2007 UTC

…		…
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	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	20	frequently asked questions and answer to them and some common
21	problems. That document is also accessible on the World-Wide-Web at	21	problems. That document is also accessible on the World-Wide-Web at
22	L<http://cvs.schmorp.de/browse/checkout/rxvt-unicode/doc/rxvt.7.html>.	22	L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.
23		23
24	=head1 RXVT-UNICODE VS. RXVT	24	=head1 RXVT-UNICODE VS. RXVT
25		25
26	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
27	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
28	world. Being a terminal emulator, however, some things are very difficult,	28	world. Being a terminal emulator, however, some things are very difficult,
29	especially cursive scripts such as arabic, vertically written scripts	29	especially cursive scripts such as arabic, vertically written scripts
30	like mongolian or scripts requiring extremely complex combining rules,	30	like mongolian or scripts requiring extremely complex combining rules,
31	like tibetan or devenagari. Don't expect pretty output when using these	31	like tibetan or devenagari. Don't expect pretty output when using these
32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33	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
34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35	belong into the application, not the terminal emulator (too many things --	35	belong into the application, not the terminal emulator (too many things --
36	such as cursor-movement while editing -- break otherwise), but that might	36	such as cursor-movement while editing -- break otherwise), but that might
37	change.	37	change.
38		38
39	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
40	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
41	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
42	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
43	another for japanese.	43	another for japanese.
44		44
45	Therefore another design rationale was the use of multiple fonts to	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	46	display characters: The idea of a single unicode font which many other
47	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
48	to choose any font for any script freely.	48	to choose any font for any script freely.
49		49
50	Apart from that, rxvt-unicode is also much better internationalised than	50	Apart from that, rxvt-unicode is also much better internationalised than
51	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
52	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
53	rxvt. This all in addition to dozens of other small improvements.	53	rxvt. This all in addition to dozens of other small improvements.
54		54
55	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
56	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
57	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
58	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
59	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
60	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and	60	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
61	@@RXVT_NAME@@c(1) (client).	61	@@RXVT_NAME@@c(1) (client).
62		62
63	It also makes technical information about escape sequences (which have	63	It also makes technical information about escape sequences (which have
64	been extended) easier accessible: see @@RXVT_NAME@@(7) for technical	64	been extended) more accessible: see @@RXVT_NAME@@(7) for technical
65	reference documentation (escape sequences etc.).	65	reference documentation (escape sequences etc.).
66		66
67	=head1 OPTIONS	67	=head1 OPTIONS
68		68
69	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
…		…
93		93
94	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
95	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
96	B<DISPLAY> environment variable is used.	96	B<DISPLAY> environment variable is used.
97		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
98	=item B<-geometry> I<geom>	103	=item B<-geometry> I<geom>
99		104
100	Window geometry (B<-g> still respected); resource B<geometry>.	105	Window geometry (B<-g> still respected); resource B<geometry>.
101		106
102	=item B<-rv>\|B<+rv>	107	=item B<-rv>\|B<+rv>
…		…
105		110
106	=item B<-j>\|B<+j>	111	=item B<-j>\|B<+j>
107		112
108	Turn on/off jump scrolling; resource B<jumpScroll>.	113	Turn on/off jump scrolling; resource B<jumpScroll>.
109		114
110	=item B<-ip>\|B<+ip>	115	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>
111		116
112	Turn on/off inheriting parent window's pixmap. Alternative form is	117	Turn on/off inheriting parent window's pixmap. Alternative form is
113	B<-tr>; resource B<inheritPixmap>.	118	B<-tr>; resource B<inheritPixmap>.
114		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
115	=item B<-fade> I<number>	124	=item B<-fade> I<number>
116		125
117	Fade the text by the given percentage when focus is lost. resource B<fading>.	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>.
118		134
119	=item B<-tint> I<colour>	135	=item B<-tint> I<colour>
120		136
121	Tint the transparent background pixmap with the given colour when	137	Tint the transparent background pixmap with the given colour when
122	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
123	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
124	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
125		144
126	=item B<-sh>	145	=item B<-sh>
127		146
128	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	147	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
129	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
130	specified, too, e.g. C<-tint white>).	149	specified, too, e.g. C<-tint white>); resource I<shading>.
131		150
132	=item B<-bg> I<colour>	151	=item B<-bg> I<colour>
133		152
134	Window background colour; resource B<background>.	153	Window background colour; resource B<background>.
135		154
…		…
162	resource B<borderColor>.	181	resource B<borderColor>.
163		182
164	=item B<-fn> I<fontlist>	183	=item B<-fn> I<fontlist>
165		184
166	Select the fonts to be used. This is a comma separated list of font names	185	Select the fonts to be used. This is a comma separated list of font names
167	that are used in turn when trying to display Unicode characters. The	186	that are checked in order when trying to find glyphs for characters. The
168	first font defines the cell size for characters; other fonts might be	187	first font defines the cell size for characters; other fonts might be
169	smaller, but not (in general) larger. A (hopefully) reasonable default	188	smaller, but not (in general) larger. A (hopefully) reasonable default
170	font list is always appended to it. See resource B<font> for more details.	189	font list is always appended to it. See resource B<font> for more details.
171		190
172	In short, to specify an X11 core font, just specify it's name or prefix it	191	In short, to specify an X11 core font, just specify its name or prefix it
173	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,	192	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
174	e.g.:	193	e.g.:
175		194
176	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	195	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
177	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	196	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
179	See also the question "How does rxvt-unicode choose fonts?" in the FAQ	198	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
180	section of @@RXVT_NAME@@(7).	199	section of @@RXVT_NAME@@(7).
181		200
182	=item B<-fb> I<fontlist>	201	=item B<-fb> I<fontlist>
183		202
184	Compile font-styles: The bold font list to use when bold characters are to	203	Compile I<font-styles>: The bold font list to use when B<bold> characters
185	be printed. See resource B<boldFont> for details.	204	are to be printed. See resource B<boldFont> for details.
186		205
187	=item B<-fi> I<fontlist>	206	=item B<-fi> I<fontlist>
188		207
189	Compile font-styles: The italic font list to use when bold characters are to	208	Compile I<font-styles>: The italic font list to use when I<italic>
190	be printed. See resource B<italicFont> for details.	209	characters are to be printed. See resource B<italicFont> for details.
191		210
192	=item B<-fbi> I<fontlist>	211	=item B<-fbi> I<fontlist>
193		212
194	Compile font-styles: The bold italic font list to use when bold characters are to	213	Compile I<font-styles>: The bold italic font list to use when B<< I<bold
195	be printed. See resource B<boldItalicFont> for details.	214	italic> >> characters are to be printed. See resource B<boldItalicFont>
		215	for details.
		216
		217	=item B<-is>\|B<+is>
		218
		219	Compile I<font-styles>: Bold/Italic font styles imply high intensity
		220	foreground/background (default). See resource B<intensityStyles> for
		221	details.
196		222
197	=item B<-name> I<name>	223	=item B<-name> I<name>
198		224
199	Specify the application name under which resources are to be obtained,	225	Specify the application name under which resources are to be obtained,
200	rather than the default executable file name. Name should not contain	226	rather than the default executable file name. Name should not contain
…		…
238		264
239	Put scrollbar on right/left; resource B<scrollBar_right>.	265	Put scrollbar on right/left; resource B<scrollBar_right>.
240		266
241	=item B<-st>\|B<+st>	267	=item B<-st>\|B<+st>
242		268
243	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	269	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
244	resource B<scrollBar_floating>.	270	resource B<scrollBar_floating>.
245		271
246	=item B<-ptab>\|B<+ptab>	272	=item B<-ptab>\|B<+ptab>
247		273
248	If enabled (default), "Horizontal Tab" characters are being stored as	274	If enabled (default), "Horizontal Tab" characters are being stored as
…		…
279	=item B<-bl>	305	=item B<-bl>
280		306
281	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.
282	if honoured by the WM, the rxvt-unicode window will not have window	308	if honoured by the WM, the rxvt-unicode window will not have window
283	decorations; resource B<borderLess>.	309	decorations; resource B<borderLess>.
		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>.
284		322
285	=item B<-lsp> I<number>	323	=item B<-lsp> I<number>
286		324
287	Compile I<frills>: Lines (pixel height) to insert between each row of	325	Compile I<frills>: Lines (pixel height) to insert between each row of
288	the display. Useful to work around font rendering problems; resource	326	the display. Useful to work around font rendering problems; resource
…		…
303	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
304	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
305	run the program specified by the B<SHELL> environment variable or,	343	run the program specified by the B<SHELL> environment variable or,
306	failing that, I<sh(1)>.	344	failing that, I<sh(1)>.
307		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
308	=item B<-title> I<text>	351	=item B<-title> I<text>
309		352
310	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
311	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
312	application name; resource B<title>.	355	application name; resource B<title>.
…		…
368	=item B<-ssr>\|B<+ssr>	411	=item B<-ssr>\|B<+ssr>
369		412
370	Turn on/off secondary screen scroll (default enabled); resource	413	Turn on/off secondary screen scroll (default enabled); resource
371	B<secondaryScroll>.	414	B<secondaryScroll>.
372		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
373	=item B<-keysym.>I<sym> I<string>	423	=item B<-keysym.>I<sym> I<string>
374		424
375	Remap a key symbol. See resource B<keysym>.	425	Remap a key symbol. See resource B<keysym>.
376		426
377	=item B<-embed> I<windowid>	427	=item B<-embed> I<windowid>
378		428
379	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,	429	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
380	which enables applications to easily embed a terminal.	430	which enables applications to easily embed a terminal.
381		431
382	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it	432	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
383	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it	433	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
384	quite a bit, so don't expect it to keep some specific state. It's best to	434	quite a bit, so don't expect it to keep some specific state. It's best to
…		…
387	The window will not be destroyed when @@RXVT_NAME@@ exits.	437	The window will not be destroyed when @@RXVT_NAME@@ exits.
388		438
389	It might be useful to know that @@RXVT_NAME@@ will not close file	439	It might be useful to know that @@RXVT_NAME@@ will not close file
390	descriptors passed to it (except for stdin/out/err, of course), so you	440	descriptors passed to it (except for stdin/out/err, of course), so you
391	can use file descriptors to communicate with the programs within the	441	can use file descriptors to communicate with the programs within the
392	terminal. This works regardless of wether the C<-embed> option was used or	442	terminal. This works regardless of whether the C<-embed> option was used or
393	not.	443	not.
394		444
395	Here is a short Gtk2-perl snippet that illustrates how this option can be	445	Here is a short Gtk2-perl snippet that illustrates how this option can be
396	used (a longer example is in F<doc/embed>):	446	used (a longer example is in F<doc/embed>):
397		447
398	my $rxvt = new Gtk2::DrawingArea;	448	my $rxvt = new Gtk2::Socket;
399	$...->add ($rxvt); # important to add it somewhere first	449	$rxvt->signal_connect_after (realize => sub {
400	$rxvt->realize; # now it can be realized
401	my $xid = $rxvt->window->get_xid;	450	my $xid = $_[0]->window->get_xid;
402
403	system "@@RXVT_NAME@@ -embed $xid &";	451	system "@@RXVT_NAME@@ -embed $xid &";
		452	});
404		453
405	=item B<-pty-fd> I<fileno>	454	=item B<-pty-fd> I<file descriptor>
406		455
407	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	456	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
408	pair but instead use the given filehandle as the tty master. This is	457	pair but instead use the given file descriptor as the tty master. This is
409	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator	458	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
410	without having to run a program within it.	459	without having to run a program within it.
411		460
412	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	461	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
413	entries and will not tinker with pty/tty permissions - you have to do that	462	entries and will not tinker with pty/tty permissions - you have to do that
414	yourself if you want that.	463	yourself if you want that.
		464
		465	As an extremely special case, specifying C<-1> will completely suppress
		466	pty/tty operations.
415		467
416	Here is a example in perl that illustrates how this option can be used (a	468	Here is a example in perl that illustrates how this option can be used (a
417	longer example is in F<doc/pty-fd>):	469	longer example is in F<doc/pty-fd>):
418		470
419	use IO::Pty;	471	use IO::Pty;
…		…
426		478
427	# now communicate with rxvt	479	# now communicate with rxvt
428	my $slave = $pty->slave;	480	my $slave = $pty->slave;
429	while (<$slave>) { print $slave "got <$_>\n" }	481	while (<$slave>) { print $slave "got <$_>\n" }
430		482
		483	=item B<-pe> I<string>
		484
		485	Comma-separated list of perl extension scripts to use (or not to use) in
		486	this terminal instance. See resource B<perl-ext> for details.
		487
431	=back	488	=back
432		489
433	=head1 RESOURCES (available also as long-options)	490	=head1 RESOURCES (available also as long-options)
434		491
435	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	492	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
436	options) compiled into your version.	493	options) compiled into your version.
437		494
438	There are two different methods that @@RXVT_NAME@@ can use to get the	495	You can set and change the resources using X11 tools like B<xrdb>. Many
439	Xresource data: using the X libraries (Xrm*-functions) or internal	496	distribution do also load settings from the B<~/.Xresources> file when X
440	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	497	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
441	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	498	with later settings overwriting earlier ones:
442	resources using X11 tools like B<xrdb>. Many distribution do also load
443	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
444	will consult the following files/resources in order, with later settings
445	overwriting earlier ones:
446		499
447	1. system-wide app-defaults file, either locale-dependent OR global	500	1. system-wide app-defaults file, either locale-dependent OR global
448	2. app-defaults file in $XAPPLRESDIR	501	2. app-defaults file in $XAPPLRESDIR
449	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	502	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
450	4. SCREEN_RESOURCES for the current screen	503	4. SCREEN_RESOURCES for the current screen
451	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	504	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
452		505
453	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
454	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
455	set in XAPPLOADDIR/URxvt (compile-time defined: usually
456	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
457	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
458	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	506	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
459	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
460	resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be	508	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
461	easily configured, while the class name B<URxvt> allows resources	509	configured, while the class name B<URxvt> allows resources unique to
462	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	510	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
463	shared between different B<@@RXVT_NAME@@> configurations. If no	511	configurations. If no resources are specified, suitable defaults will
464	resources are specified, suitable defaults will be used. Command-line	512	be used. Command-line arguments can be used to override resource
465	arguments can be used to override resource settings. The following	513	settings. The following resources are supported (you might want to
466	resources are allowed:	514	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		515	extensions not documented here):
467		516
468	=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>.
469		523
470	=item B<geometry:> I<geom>	524	=item B<geometry:> I<geom>
471		525
472	Create the window with the specified X window geometry [default 80x24];	526	Create the window with the specified X window geometry [default 80x24];
473	option B<-geometry>.	527	option B<-geometry>.
…		…
510	Use the specified colour to display underlined characters when the	564	Use the specified colour to display underlined characters when the
511	foreground colour is the default.	565	foreground colour is the default.
512		566
513	=item B<colorRV:> I<colour>	567	=item B<colorRV:> I<colour>
514		568
515	Use the specified colour as the background for reverse video	569	Use the specified colour as the background for reverse video characters
516	characters.	570	when OPTION_HC is disabled (--disable-frills).
517		571
518	=item B<underlineColor:> I<colour>	572	=item B<underlineColor:> I<colour>
519		573
520	If set, use the specified colour as the colour for the underline	574	If set, use the specified colour as the colour for the underline
521	itself. If unset, use the foreground colour.	575	itself. If unset, use the foreground colour.
…		…
547		601
548	B<True>: make the background inherit the parent windows' pixmap, giving	602	B<True>: make the background inherit the parent windows' pixmap, giving
549	artificial transparency. B<False>: do not inherit the parent windows'	603	artificial transparency. B<False>: do not inherit the parent windows'
550	pixmap.	604	pixmap.
551		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
552	=item B<fading:> I<number>	609	=item B<fading:> I<number>
553		610
554	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>.
555		617
556	=item B<tintColor:> I<colour>	618	=item B<tintColor:> I<colour>
557		619
558	Tint the transparent background pixmap with the given colour.	620	Tint the transparent background pixmap with the given colour; option
		621	B<-tint>.
559		622
560	=item B<shading:> I<number>	623	=item B<shading:> I<number>
561		624
562	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	625	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
563	image in addition to tinting it.	626	in addition to tinting it; option B<-sh>.
564		627
565	=item B<scrollColor:> I<colour>	628	=item B<scrollColor:> I<colour>
566		629
567	Use the specified colour for the scrollbar [default #B2B2B2].	630	Use the specified colour for the scrollbar [default #B2B2B2].
568		631
569	=item B<troughColor:> I<colour>	632	=item B<troughColor:> I<colour>
570		633
571	Use the specified colour for the scrollbar's trough area [default	634	Use the specified colour for the scrollbar's trough area [default
572	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	635	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
573		636
574	=item B<borderColor:> I<colour>	637	=item B<borderColor:> I<colour>
575		638
576	The colour of the border around the text area and between the scrollbar	639	The colour of the border around the text area and between the scrollbar
577	and the text.	640	and the text.
…		…
586	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
587	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
588	be magnified beyond 10 times its original size. The maximum permitted	651	be magnified beyond 10 times its original size. The maximum permitted
589	scale is 1000. [default 0x0+50+50]	652	scale is 1000. [default 0x0+50+50]
590		653
591	=item B<menu:> I<file[;tag]>
592
593	Read in the specified menu file (note the `.menu' extension is
594	optional) and also optionally specify a starting tag to find. See the
595	reference documentation for details on the syntax for the menuBar.
596
597	=item B<path:> I<path>	654	=item B<path:> I<path>
598		655
599	Specify the colon-delimited search path for finding files (XPM and	656	Specify the colon-delimited search path for finding XPM files.
600	menus), in addition to the paths specified by the B<RXVTPATH> and
601	B<PATH> environment variables.
602		657
603	=item B<font:> I<fontlist>	658	=item B<font:> I<fontlist>
604		659
605	Select the fonts to be used. This is a comma separated list of font	660	Select the fonts to be used. This is a comma separated list of font names
606	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
607	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
608	be smaller, but not larger. A reasonable default font list is always	663	smaller, but not (in general) larger. A (hopefully) reasonable default
609	appended to it. option B<-fn>.	664	font list is always appended to it; option B<-fn>.
610		665
611	Each font can either be a standard X11 core font (XLFD) name, with	666	Each font can either be a standard X11 core font (XLFD) name, with
612	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.	667	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
613		668
614	In addition, each font can be prefixed with additional hints and	669	In addition, each font can be prefixed with additional hints and
…		…
616	hint currently is C<codeset=codeset-name>, and this is only used for Xft	671	hint currently is C<codeset=codeset-name>, and this is only used for Xft
617	fonts.	672	fonts.
618		673
619	For example, this font resource	674	For example, this font resource
620		675
621	URxvt*font: 9x15bold,\	676	URxvt.font: 9x15bold,\
622	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	677	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
623	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \	678	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
624	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	679	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
625	xft:Code2000:antialias=false	680	xft:Code2000:antialias=false
626		681
…		…
660	not possible, replacement fonts of the desired shape will be tried.	715	not possible, replacement fonts of the desired shape will be tried.
661		716
662	If set, but empty, then this specific style is disabled and the normal	717	If set, but empty, then this specific style is disabled and the normal
663	text font will being used for the given style.	718	text font will being used for the given style.
664		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.
		727
665	=item B<selectstyle:> I<mode>	728	=item B<selectstyle:> I<mode>
666		729
667	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
668	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
669	xterm style selection.	732	xterm style selection.
670		733
671	=item B<scrollstyle:> I<mode>	734	=item B<scrollstyle:> I<mode>
672		735
673	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	736	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
674	the author's favourite..	737	the author's favourite.
675		738
676	=item B<title:> I<string>	739	=item B<title:> I<string>
677		740
678	Set window title string, the default title is the command-line	741	Set window title string, the default title is the command-line
679	specified after the B<-e> option, if any, otherwise the application	742	specified after the B<-e> option, if any, otherwise the application
…		…
688	=item B<mapAlert:> I<boolean>	751	=item B<mapAlert:> I<boolean>
689		752
690	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
691	de-iconify (map) on receipt of a bell character [default].	754	de-iconify (map) on receipt of a bell character [default].
692		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
693	=item B<visualBell:> I<boolean>	761	=item B<visualBell:> I<boolean>
694		762
695	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>.
696	B<False>: no visual bell [default]; option B<+vb>.	764	B<False>: no visual bell [default]; option B<+vb>.
697		765
…		…
711		779
712	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
713	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
714	B<Shift-Print> to include the scrollback as well.	782	B<Shift-Print> to include the scrollback as well.
715		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
716	=item B<scrollBar:> I<boolean>	793	=item B<scrollBar:> I<boolean>
717		794
718	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	795	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
719	disable the scrollbar; option B<+sb>.	796	disable the scrollbar; option B<+sb>.
720		797
…		…
741		818
742	=item B<scrollWithBuffer:> I<boolean>	819	=item B<scrollWithBuffer:> I<boolean>
743		820
744	B<True>: scroll with scrollback buffer when tty receives new lines (and	821	B<True>: scroll with scrollback buffer when tty receives new lines (and
745	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
746	with scrollback buffer when tty recieves new lines; option B<+sw>.	823	with scrollback buffer when tty receives new lines; option B<+sw>.
747		824
748	=item B<scrollTtyKeypress:> I<boolean>	825	=item B<scrollTtyKeypress:> I<boolean>
749		826
750	B<True>: scroll to bottom when a non-special key is pressed. Special keys	827	B<True>: scroll to bottom when a non-special key is pressed. Special keys
751	are those which are intercepted by rxvt-unicode for special handling and	828	are those which are intercepted by rxvt-unicode for special handling and
…		…
770	=item B<borderLess:> I<boolean>	847	=item B<borderLess:> I<boolean>
771		848
772	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
773	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.	850	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
774		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>.
		858
775	=item B<termName:> I<termname>	859	=item B<termName:> I<termname>
776		860
777	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
778	variable; option B<-tn>.	862	variable; option B<-tn>.
779		863
…		…
816		900
817	Mouse pointer background colour.	901	Mouse pointer background colour.
818		902
819	=item B<pointerBlankDelay:> I<number>	903	=item B<pointerBlankDelay:> I<number>
820		904
821	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.
822		907
823	=item B<backspacekey:> I<string>	908	=item B<backspacekey:> I<string>
824		909
825	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>
826	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>
…		…
833	pressed. If unset it will send the sequence traditionally associated	918	pressed. If unset it will send the sequence traditionally associated
834	with the B<Execute> key.	919	with the B<Execute> key.
835		920
836	=item B<cutchars:> I<string>	921	=item B<cutchars:> I<string>
837		922
838	The characters used as delimiters for double-click word selection. The	923	The characters used as delimiters for double-click word selection
839	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:
840		933
841	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	934	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>
842		935
843	=item B<preeditType:> I<style>	936	=item B<preeditType:> I<style>
844		937
…		…
851	=item B<imLocale:> I<name>	944	=item B<imLocale:> I<name>
852		945
853	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.	946	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
854	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the	947	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
855	input extension to be able to input japanese characters while staying in	948	input extension to be able to input japanese characters while staying in
856	another locale. option B<-imlocale>.	949	another locale; option B<-imlocale>.
857		950
858	=item B<imFont:> I<fontset>	951	=item B<imFont:> I<fontset>
859		952
860	Specify the font-set used for XIM styles C<OverTheSpot> or	953	Specify the font-set used for XIM styles C<OverTheSpot> or
861	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated	954	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
…		…
866		959
867	=item B<tripleclickwords:> I<boolean>	960	=item B<tripleclickwords:> I<boolean>
868		961
869	Change the meaning of triple-click selection with the left mouse	962	Change the meaning of triple-click selection with the left mouse
870	button. Instead of selecting a full line it will extend the selection to	963	button. Instead of selecting a full line it will extend the selection to
871	the end of the logical line only. option B<-tcw>.	964	the end of the logical line only; option B<-tcw>.
872		965
873	=item B<insecure:> I<boolean>	966	=item B<insecure:> I<boolean>
874		967
875	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	968	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
876	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
877	abused if somebody gets 8-bit-clean access to your display, whether	970	abused if somebody gets 8-bit-clean access to your display, whether
878	throuh a mail client displaying mail bodies unfiltered or though	971	through a mail client displaying mail bodies unfiltered or through
879	write(1). Therefore, these sequences are disabled by default. (Note	972	write(1) or any other means. Therefore, these sequences are disabled by
880	that other terminals, including xterm, have these sequences	973	default. (Note that many other terminals, including xterm, have these
881	enabled by default). You can enable them by setting this boolean	974	sequences enabled by default, which doesn't make it safer, though).
882	resource or specifying B<-insecure> as an option. At the moment, this	975
883	enabled display-answer, locale, findfont, icon label and window title	976	You can enable them by setting this boolean resource or specifying
884	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.
885		979
886	=item B<modifier:> I<modifier>	980	=item B<modifier:> I<modifier>
887		981
888	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>,
889	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
…		…
893		987
894	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	988	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
895	character is passed through. It may contain escape values as described	989	character is passed through. It may contain escape values as described
896	in the entry on B<keysym> following.	990	in the entry on B<keysym> following.
897		991
898	=item B<secondaryScreen:> I<bool>	992	=item B<secondaryScreen:> I<boolean>
899		993
900	Turn on/off secondary screen (default enabled).	994	Turn on/off secondary screen (default enabled).
901		995
902	=item B<secondaryScroll:> I<bool>	996	=item B<secondaryScroll:> I<boolean>
903		997
904	Turn on/off secondary screen scroll (default enabled). If the this	998	Turn on/off secondary screen scroll (default enabled). If this
905	option is enabled, scrolls on the secondary screen will change the	999	option is enabled, scrolls on the secondary screen will change the
906	scrollback buffer and switching to/from the secondary screen will	1000	scrollback buffer and switching to/from the secondary screen will
907	instead scroll the screen up.	1001	instead scroll the screen up.
		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.
908		1009
909	=item B<keysym.>I<sym>: I<string>	1010	=item B<keysym.>I<sym>: I<string>
910		1011
911	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1012	Compile I<frills>: Associate I<string> with keysym I<sym>. The
912	intervening resource name B<keysym.> cannot be omitted.	1013	intervening resource name B<keysym.> cannot be omitted.
…		…
930		1031
931	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1032	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
932	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1033	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
933	C<\000>: octal number) or verbatim control characters (C<^?>: delete,	1034	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
934	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it	1035	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
935	can start or end with whitespace.	1036	can start or end with whitespace. B<This feature is deprecated and will
		1037	be removed>.
936		1038
937	Please note that you need to double the C<\> when using	1039	Please note that you need to double the C<\> in resource files, as
938	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can	1040	Xlib itself does its own de-escaping (you can use C<\033> instead of
939	use C<\033> instead of C<\e> (and so on), which will work with both Xt and	1041	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
940	@@RXVT_NAME@@'s own processing).	1042	processing).
941		1043
942	You can define a range of keysyms in one shot by providing a I<string>	1044	You can define a range of keysyms in one shot by providing a I<string>
943	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1045	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
944	should be a character not used by the strings.	1046	should be a character not used by the strings.
945		1047
946	Its usage can be demonstrated by an example:	1048	Its usage can be demonstrated by an example:
947		1049
948	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1050	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
…		…
958	example the following means "change the current locale to C<zh_CN.GBK>	1060	example the following means "change the current locale to C<zh_CN.GBK>
959	when Control-Meta-c is being pressed":	1061	when Control-Meta-c is being pressed":
960		1062
961	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1063	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
962		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
963	The following example will map Control-Meta-1 and Control-Meta-2 to	1091	The following example will map Control-Meta-1 and Control-Meta-2 to
964	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited	1092	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
965	font-switching at runtime:	1093	font-switching at runtime:
966		1094
967	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1095	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
…		…
970	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1098	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
971	info):	1099	info):
972		1100
973	URxvt.keysym.M-C-3: command:\033[8;25;80t	1101	URxvt.keysym.M-C-3: command:\033[8;25;80t
974	URxvt.keysym.M-C-4: command:\033[8;48;110t	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>.
975		1175
976	=back	1176	=back
977		1177
978	=head1 THE SCROLLBAR	1178	=head1 THE SCROLLBAR
979		1179
…		…
1014	to select a word; Left triple-click to select the entire logical line	1214	to select a word; Left triple-click to select the entire logical line
1015	(which can span multiple screen lines), unless modified by resource	1215	(which can span multiple screen lines), unless modified by resource
1016	B<tripleclickwords>.	1216	B<tripleclickwords>.
1017		1217
1018	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1218	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
1019	(Compile: I<frills>) will create a rectangular selection instead of a normal	1219	(Compile: I<frills>) will create a rectangular selection instead of a
1020	one.	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.
1021		1223
1022	=item B<Insertion>:	1224	=item B<Insertion>:
1023		1225
1024	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@@>
1025	an B<@@RXVT_NAME@@> window causes the current text selection to be	1227	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1026	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.
1027		1232
1028	=back	1233	=back
1029		1234
1030	=head1 CHANGING FONTS	1235	=head1 CHANGING FONTS
1031		1236
1032	Changing fonts (or font sizes, respectively) via the keypad is not yet	1237	Changing fonts (or font sizes, respectively) via the keypad is not yet
1033	supported in rxvt-unicode. Bug me if you need this.	1238	supported in rxvt-unicode. Bug me if you need this.
1034		1239
1035	You can, however, switch fonts at runtime using escape sequences (and	1240	You can, however, switch fonts at runtime using escape sequences, e.g.:
1036	therefore using the menubar), e.g.:
1037		1241
1038	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	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
1039		1248
1040	rxvt-unicode will automatically re-apply these fonts to the output so far.	1249	rxvt-unicode will automatically re-apply these fonts to the output so far.
1041		1250
1042	=head1 ISO 14755 SUPPORT	1251	=head1 ISO 14755 SUPPORT
1043		1252
…		…
1071	This mode lets you input characters representing the keycap symbols of	1280	This mode lets you input characters representing the keycap symbols of
1072	your keyboard, if representable in the current locale encoding.	1281	your keyboard, if representable in the current locale encoding.
1073		1282
1074	Start by pressing C<Control> and C<Shift> together, then releasing	1283	Start by pressing C<Control> and C<Shift> together, then releasing
1075	them. The next special key (cursor keys, home etc.) you enter will not	1284	them. The next special key (cursor keys, home etc.) you enter will not
1076	invoke it's usual function but instead will insert the corresponding	1285	invoke its usual function but instead will insert the corresponding
1077	keycap symbol. The symbol will only be entered when the key has been	1286	keycap symbol. The symbol will only be entered when the key has been
1078	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1287	released, otherwise pressing e.g. C<Shift> would enter the symbol for
1079	C<ISO Level 2 Switch>, although your intention might have been to enter a	1288	C<ISO Level 2 Switch>, although your intention might have been to enter a
1080	reverse tab (Shift-Tab).	1289	reverse tab (Shift-Tab).
1081		1290
…		…
1114	=head1 COLORS AND GRAPHICS	1323	=head1 COLORS AND GRAPHICS
1115		1324
1116	In addition to the default foreground and background colours,	1325	In addition to the default foreground and background colours,
1117	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1326	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1118	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
1119	colours with their B<rgb.txt> names.	1328	colours with their names.
1120		1329
1121	=begin table	1330	=begin table
1122		1331
1123	B<color0> (black) = Black	1332	B<color0> (black) = Black
1124	B<color1> (red) = Red3	1333	B<color1> (red) = Red3
…		…
1144	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>,
1145	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1354	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1146	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
1147	color0-color15.	1356	color0-color15.
1148		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
1149	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1367	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1150	always swapping the foreground/background colours. This is in contrast to	1368	always swapping the foreground/background colours. This is in contrast to
1151	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
1152	been specified. For example,	1370	been specified. For example,
1153		1371
…		…
1158	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
1159	on White.	1377	on White.
1160		1378
1161	=back	1379	=back
1162		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
1163	=head1 ENVIRONMENT	1405	=head1 ENVIRONMENT
1164		1406
1165	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1407	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1166		1408
1167	=over 4	1409	=over 4
1168		1410
1169	=item B<TERM>	1411	=item B<TERM>
1170		1412
1171	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1413	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1172	resources or on the commandline.	1414	resources or on the command line.
1173		1415
1174	=item B<COLORTERM>	1416	=item B<COLORTERM>
1175		1417
1176	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1418	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1177	compiled with XPM support, and optionally with the added extension	1419	compiled with XPM support, and optionally with the added extension
1178	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1420	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1179		1421
1180	=item B<COLORFGBG>	1422	=item B<COLORFGBG>
1181		1423
…		…
1199	C<--with-terminfo=PATH>.	1441	C<--with-terminfo=PATH>.
1200		1442
1201	=item B<DISPLAY>	1443	=item B<DISPLAY>
1202		1444
1203	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1445	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1204	display in it's child processes.	1446	display in its child processes.
1205		1447
1206	=item B<SHELL>	1448	=item B<SHELL>
1207		1449
1208	The shell to be used for command execution, defaults to C</bin/sh>.	1450	The shell to be used for command execution, defaults to C</bin/sh>.
1209
1210	=item B<RXVTPATH>
1211
1212	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1213	files.
1214
1215	=item B<PATH>
1216
1217	Used in the same way as C<RXVTPATH>.
1218		1451
1219	=item B<RXVT_SOCKET>	1452	=item B<RXVT_SOCKET>
1220		1453
1221	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1454	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1222	@@RXVT_NAME@@d(1).	1455	@@RXVT_NAME@@d(1).
1223		1456
1224	Default C<< $HOME/.rxvt-unicode-<nodename >>.	1457	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1225		1458
1226	=item B<HOME>	1459	=item B<HOME>
1227		1460
1228	Used to locate the default directory for the unix domain socket for	1461	Used to locate the default directory for the unix domain socket for
1229	daemon communications and to locate various resource files (such as	1462	daemon communications and to locate various resource files (such as
…		…
1250		1483
1251	=back	1484	=back
1252		1485
1253	=head1 SEE ALSO	1486	=head1 SEE ALSO
1254		1487
1255	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), 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)
1256
1257	=head1 BUGS
1258
1259	Check the BUGS file for an up-to-date list.
1260
1261	Cursor change support is not yet implemented.
1262
1263	Click-and-drag doesn't work with X11 mouse report overriding.
1264		1489
1265	=head1 CURRENT PROJECT COORDINATOR	1490	=head1 CURRENT PROJECT COORDINATOR
1266		1491
1267	=over 4	1492	=over 4
1268		1493
1269	=item Project Coordinator	1494	=item Project Coordinator
1270		1495
1271	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1496	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1272		1497
1273	L<http://software.schmorp.de/#rxvt-unicode>	1498	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1274		1499
1275	=back	1500	=back
1276		1501
1277	=head1 AUTHORS	1502	=head1 AUTHORS
1278		1503
…		…
1300		1525
1301	Project Coordinator (changes.txt 2.21a to 2.4.5)	1526	Project Coordinator (changes.txt 2.21a to 2.4.5)
1302		1527
1303	=item Geoff Wing L<< <gcw@pobox.com> >>	1528	=item Geoff Wing L<< <gcw@pobox.com> >>
1304		1529
1305	Rewrote screen display and text selection routines. Project Coordinator	1530	Rewrote screen display and text selection routines.
		1531
1306	(changes.txt 2.4.6 - rxvt-unicode)	1532	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1307		1533
1308	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1534	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1309		1535
1310	Forked rxvt-unicode, rewrote most of the display code and internal	1536	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1311	character handling to store text in unicode, improve xterm	1537	extension, random hacks, numerous bugfixes and extensions.
1312	compatibility and apply numerous other bugfixes and extensions.
1313		1538
1314	Project Coordinator (Changes 1.0 -)	1539	Project Coordinator (Changes 1.0 -)
1315		1540
		1541	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1542
		1543	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
		1544
1316	=back	1545	=back
1317		1546

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.60 by root, Thu Feb 17 15:13:47 2005 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.60 by root, Thu Feb 17 15:13:47 2005 UTC vs.
Revision 1.127 by ayin, Wed May 2 23:06:32 2007 UTC