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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.115 by root, Mon Jul 10 04:01:33 2006 UTC vs.
Revision 1.187 by sf-exg, Fri Oct 15 10:46:57 2010 UTC

…		…
12	emulator intended as an I<xterm>(1) replacement for users who do not	12	emulator intended as an I<xterm>(1) replacement for users who do not
13	require features such as Tektronix 4014 emulation and toolkit-style	13	require features such as Tektronix 4014 emulation and toolkit-style
14	configurability. As a result, B<rxvt-unicode> uses much less swap space --	14	configurability. As a result, B<rxvt-unicode> uses much less swap space --
15	a significant advantage on a machine serving many X sessions.	15	a significant advantage on a machine serving many X sessions.
16		16
		17	This document is also available on the World-Wide-Web at
		18	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
		19
17	=head1 FREQUENTLY ASKED QUESTIONS	20	=head1 FREQUENTLY ASKED QUESTIONS
18		21
19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of	22	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	23	frequently asked questions and answer to them and some common
21	problems. That document is also accessible on the World-Wide-Web at	24	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>.	25	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23		26
24	=head1 RXVT-UNICODE VS. RXVT	27	=head1 RXVT-UNICODE VS. RXVT
25		28
26	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode	29	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	30	internally. That means it can store and display most scripts in the
28	world. Being a terminal emulator, however, some things are very difficult,	31	world. Being a terminal emulator, however, some things are very difficult,
29	especially cursive scripts such as arabic, vertically written scripts	32	especially cursive scripts such as arabic, vertically written scripts
30	like mongolian or scripts requiring extremely complex combining rules,	33	like mongolian or scripts requiring extremely complex combining rules,
31	like tibetan or devenagari. Don't expect pretty output when using these	34	like tibetan or devanagari. Don't expect pretty output when using these
32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	35	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33	fine, though. A somewhat difficult case are right-to-left scripts, such	36	fine, though. A somewhat difficult case are right-to-left scripts, such
34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	37	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35	belong into the application, not the terminal emulator (too many things --	38	belong in the application, not the terminal emulator (too many things --
36	such as cursor-movement while editing -- break otherwise), but that might	39	such as cursor-movement while editing -- break otherwise), but that might
37	change.	40	change.
38		41
39	If you are looking for a terminal that supports more exotic scripts, let	42	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	43	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	44	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	45	because the author couldn't get C<mlterm> to use one font for latin1 and
43	another for japanese.	46	another for japanese.
44		47
45	Therefore another design rationale was the use of multiple fonts to	48	Therefore another design rationale was the use of multiple fonts to
…		…
47	programs force onto its users never made sense to me: You should be able	50	programs force onto its users never made sense to me: You should be able
48	to choose any font for any script freely.	51	to choose any font for any script freely.
49		52
50	Apart from that, rxvt-unicode is also much better internationalised than	53	Apart from that, rxvt-unicode is also much better internationalised than
51	its predecessor, supports things such as XFT and ISO 14755 that are handy	54	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	55	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.	56	rxvt. This all in addition to dozens of other small improvements.
54		57
55	It is still faithfully following the original rxvt idea of being lean	58	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	59	and nice on resources: for example, you can still configure rxvt-unicode
57	without most of its features to get a lean binary. It also comes with	60	without most of its features to get a lean binary. It also comes with
…		…
59	from within a single process, which makes startup time very fast and	62	from within a single process, which makes startup time very fast and
60	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and	63	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
61	@@RXVT_NAME@@c(1) (client).	64	@@RXVT_NAME@@c(1) (client).
62		65
63	It also makes technical information about escape sequences (which have	66	It also makes technical information about escape sequences (which have
64	been extended) easier accessible: see @@RXVT_NAME@@(7) for technical	67	been extended) more accessible: see @@RXVT_NAME@@(7) for technical
65	reference documentation (escape sequences etc.).	68	reference documentation (escape sequences etc.).
66		69
67	=head1 OPTIONS	70	=head1 OPTIONS
68		71
69	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed	72	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
…		…
89		92
90	Print out a message describing available options.	93	Print out a message describing available options.
91		94
92	=item B<-display> I<displayname>	95	=item B<-display> I<displayname>
93		96
94	Attempt to open a window on the named X display (B<-d> still	97	Attempt to open a window on the named X display (the older form B<-d>
95	respected). In the absence of this option, the display specified by the	98	is still respected. but deprecated). In the absence of this option, the
96	B<DISPLAY> environment variable is used.	99	display specified by the B<DISPLAY> environment variable is used.
97		100
98	=item B<-depth> I<bitdepth>	101	=item B<-depth> I<bitdepth>
99		102
100	Compile I<xft>: Attempt to find a visual with the given bit depth;	103	Compile I<xft>: Attempt to find a visual with the given bit depth;
101	resource B<depth>.	104	resource B<depth>.
102		105
		106	[Please note that many X servers (and libXft) are buggy with
		107	respect to C<-depth 32> and/or alpha channels, and will cause all sorts
		108	of graphical corruption. This is harmless, but we can't do anything about
		109	this, so watch out]
		110
103	=item B<-geometry> I<geom>	111	=item B<-geometry> I<geom>
104		112
105	Window geometry (B<-g> still respected); resource B<geometry>.	113	Window geometry (B<-g> still respected); resource B<geometry>.
106		114
107	=item B<-rv>\|B<+rv>	115	=item B<-rv>\|B<+rv>
108		116
109	Turn on/off simulated reverse video; resource B<reverseVideo>.	117	Turn on/off simulated reverse video; resource B<reverseVideo>.
110		118
111	=item B<-j>\|B<+j>	119	=item B<-j>\|B<+j>
112		120
113	Turn on/off jump scrolling; resource B<jumpScroll>.	121	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
114		122
115	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>	123	=item B<-ss>\|B<+ss>
116		124
117	Turn on/off inheriting parent window's pixmap. Alternative form is	125	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118	B<-tr>; resource B<inheritPixmap>.
119		126
120	I<Please note that transparency of any kind if completely unsupported by	127	=item B<-tr>\|B<+tr>
121	the author. Don't bug him with installation questions!>	128
		129	Turn on/off illusion of a transparent window background; resource B<transparent>.
		130
		131	B<-ip> is still accepted as an obsolete alias but will be removed in
		132	future versions.
122		133
123	=item B<-fade> I<number>	134	=item B<-fade> I<number>
124		135
125	Fade the text by the given percentage when focus is lost. Small values	136	Fade the text by the given percentage when focus is lost. Small values
126	fade a little only, 100 completely replaces all colours by the fade	137	fade a little only, 100 completely replaces all colours by the fade
…		…
132	is opaque black. resource B<fadeColor>.	143	is opaque black. resource B<fadeColor>.
133		144
134	=item B<-tint> I<colour>	145	=item B<-tint> I<colour>
135		146
136	Tint the transparent background pixmap with the given colour when	147	Tint the transparent background pixmap with the given colour when
137	transparency is enabled with B<-tr> or B<-ip>. This only works for	148	transparency is enabled with B<-tr>. This only works for
138	non-tiled backgrounds, currently. See also the B<-sh> option that can be	149	non-tiled backgrounds, currently. See also the B<-sh> option that can be
139	used to brighten or darken the image in addition to tinting it; resource	150	used to brighten or darken the image in addition to tinting it.
		151	Please note that certain tint colours can be applied on the server-side,
		152	thus yielding performance gain of two orders of magnitude. These colours are:
		153	blue, red, green, cyan, magenta, yellow, and those close to them. Also
		154	pure black and pure white colours essentially mean no tinting; resource
140	I<tintColor>. Example:	155	I<tintColor>. Example:
141		156
142	@@RXVT_NAME@@ -tr -tint blue -sh 40	157	@@RXVT_NAME@@ -tr -tint blue -sh 40
143		158
144	=item B<-sh>	159	=item B<-sh> I<number>
145		160
146	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	161	Darken (0 .. 100) or lighten (100 .. 200) the transparent
147	background image in addition to tinting it (i.e. B<-tint> must be	162	background image in addition to (or instead of) tinting it;
148	specified, too, e.g. C<-tint white>).	163	resource I<shading>.
		164
		165	=item B<-blt> I<string>
		166
		167	Specify background blending type. If background pixmap is specified
		168	at the same time as transparency - such pixmap will be blended over
		169	transparency image, using method specified. Supported values are :
		170	B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
		171	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
		172	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
		173	alpha-blending. Compile I<afterimage>; resource I<blendType>.
		174
		175	=item B<-blr> I<HxV>
		176
		177	Apply Gaussian Blur with the specified radii to the transparent
		178	background image. If single number is specified - both vertical and
		179	horizontal radii are considered to be the same. Setting one of the
		180	radii to 1 and another to a large number creates interesting effects
		181	on some backgrounds. Maximum radius value is 128. Compile I<afterimage> or I<xft>;
		182	resource I<blurRadius>.
		183
		184	=item B<-icon> I<file>
		185
		186	Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
		187	is used by many window managers, taskbars and pagers to represent the
		188	application window; resource I<iconFile>.
149		189
150	=item B<-bg> I<colour>	190	=item B<-bg> I<colour>
151		191
152	Window background colour; resource B<background>.	192	Window background colour; resource B<background>.
153		193
154	=item B<-fg> I<colour>	194	=item B<-fg> I<colour>
155		195
156	Window foreground colour; resource B<foreground>.	196	Window foreground colour; resource B<foreground>.
157		197
158	=item B<-pixmap> I<file[;geom]>	198	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
159		199
160	Compile I<XPM>: Specify XPM file for the background and also optionally	200	Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
161	specify its scaling with a geometry string. Note you may need to	201	optionally specify its scaling with a geometry string. Note you may need to
162	add quotes to avoid special shell interpretation of the C<;> in the	202	add quotes to avoid special shell interpretation of the C<;> in the
163	command-line; resource B<backgroundPixmap>.	203	command-line; for more details see resource B<backgroundPixmap>.
164		204
165	=item B<-cr> I<colour>	205	=item B<-cr> I<colour>
166		206
167	The cursor colour; resource B<cursorColor>.	207	The cursor colour; resource B<cursorColor>.
168		208
…		…
213	italic> >> characters are to be printed. See resource B<boldItalicFont>	253	italic> >> characters are to be printed. See resource B<boldItalicFont>
214	for details.	254	for details.
215		255
216	=item B<-is>\|B<+is>	256	=item B<-is>\|B<+is>
217		257
218	Compile I<font-styles>: Bold/Italic font styles imply high intensity	258	Compile I<font-styles>: Bold/Blink font styles imply high intensity
219	foreground/background (default). See resource B<intensityStyles> for	259	foreground/background (default). See resource B<intensityStyles> for
220	details.	260	details.
221		261
222	=item B<-name> I<name>	262	=item B<-name> I<name>
223		263
…		…
241		281
242	=item B<-sb>\|B<+sb>	282	=item B<-sb>\|B<+sb>
243		283
244	Turn on/off scrollbar; resource B<scrollBar>.	284	Turn on/off scrollbar; resource B<scrollBar>.
245		285
		286	=item B<-sr>\|B<+sr>
		287
		288	Put scrollbar on right/left; resource B<scrollBar_right>.
		289
		290	=item B<-st>\|B<+st>
		291
		292	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		293	resource B<scrollBar_floating>.
		294
246	=item B<-si>\|B<+si>	295	=item B<-si>\|B<+si>
247		296
248	Turn on/off scroll-to-bottom on TTY output inhibit; resource	297	Turn on/off scroll-to-bottom on TTY output inhibit; resource
249	B<scrollTtyOutput> has opposite effect.	298	B<scrollTtyOutput> has opposite effect.
250		299
…		…
256	=item B<-sw>\|B<+sw>	305	=item B<-sw>\|B<+sw>
257		306
258	Turn on/off scrolling with the scrollback buffer as new lines appear.	307	Turn on/off scrolling with the scrollback buffer as new lines appear.
259	This only takes effect if B<-si> is also given; resource	308	This only takes effect if B<-si> is also given; resource
260	B<scrollWithBuffer>.	309	B<scrollWithBuffer>.
261
262	=item B<-sr>\|B<+sr>
263
264	Put scrollbar on right/left; resource B<scrollBar_right>.
265
266	=item B<-st>\|B<+st>
267
268	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
269	resource B<scrollBar_floating>.
270		310
271	=item B<-ptab>\|B<+ptab>	311	=item B<-ptab>\|B<+ptab>
272		312
273	If enabled (default), "Horizontal Tab" characters are being stored as	313	If enabled (default), "Horizontal Tab" characters are being stored as
274	actual wide characters in the screen buffer, which makes it possible to	314	actual wide characters in the screen buffer, which makes it possible to
…		…
278		318
279	=item B<-bc>\|B<+bc>	319	=item B<-bc>\|B<+bc>
280		320
281	Blink the cursor; resource B<cursorBlink>.	321	Blink the cursor; resource B<cursorBlink>.
282		322
		323	=item B<-uc>\|B<+uc>
		324
		325	Make the cursor underlined; resource B<cursorUnderline>.
		326
283	=item B<-iconic>	327	=item B<-iconic>
284		328
285	Start iconified, if the window manager supports that option.	329	Start iconified, if the window manager supports that option.
286	Alternative form is B<-ic>.	330	Alternative form is B<-ic>.
287		331
…		…
303		347
304	=item B<-bl>	348	=item B<-bl>
305		349
306	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	350	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
307	if honoured by the WM, the rxvt-unicode window will not have window	351	if honoured by the WM, the rxvt-unicode window will not have window
308	decorations; resource B<borderLess>.	352	decorations; resource B<borderLess>. If the window manager does not
		353	support MWM hints (e.g. kwin), enables override-redirect mode.
309		354
310	=item B<-override-redirect>	355	=item B<-override-redirect>
311		356
312	Compile I<frills>: Sets override-redirect on the window; resource	357	Compile I<frills>: Sets override-redirect on the window; resource
313	B<override-redirect>.	358	B<override-redirect>.
…		…
321		366
322	=item B<-lsp> I<number>	367	=item B<-lsp> I<number>
323		368
324	Compile I<frills>: Lines (pixel height) to insert between each row of	369	Compile I<frills>: Lines (pixel height) to insert between each row of
325	the display. Useful to work around font rendering problems; resource	370	the display. Useful to work around font rendering problems; resource
326	B<linespace>.	371	B<lineSpace>.
		372
		373	=item B<-letsp> I<number>
		374
		375	Compile I<frills>: Amount to adjust the computed character width by
		376	to control overall letter spacing. Negative values will tighten up the
		377	letter spacing, positive values will space letters out more. Useful to
		378	work around odd font metrics; resource B<letterSpace>.
327		379
328	=item B<-tn> I<termname>	380	=item B<-tn> I<termname>
329		381
330	This option specifies the name of the terminal type to be set in the	382	This option specifies the name of the terminal type to be set in the
331	B<TERM> environment variable. This terminal type must exist in the	383	B<TERM> environment variable. This terminal type must exist in the
…		…
385	for more info.	437	for more info.
386		438
387	=item B<-tcw>	439	=item B<-tcw>
388		440
389	Change the meaning of triple-click selection with the left mouse	441	Change the meaning of triple-click selection with the left mouse
		442	button. Only effective when the original (non-perl) selection code is
390	button. Instead of selecting a full line it will extend the selection the	443	in-use. Instead of selecting a full line it will extend the selection to
391	end of the logical line only. resource B<tripleclickwords>.	444	the end of the logical line only. resource B<tripleclickwords>.
392		445
393	=item B<-insecure>	446	=item B<-insecure>
394		447
395	Enable "insecure" mode, which currently enables most of the escape	448	Enable "insecure" mode, which currently enables most of the escape
396	sequences that echo strings. See the resource B<insecure> for more	449	sequences that echo strings. See the resource B<insecure> for more
…		…
417	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	470	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
418	will not immediately destroy its window when the program executed within	471	will not immediately destroy its window when the program executed within
419	it exits. Instead, it will wait till it is being killed or closed by the	472	it exits. Instead, it will wait till it is being killed or closed by the
420	user; resource B<hold>.	473	user; resource B<hold>.
421		474
		475	=item B<-cd> I<path>
		476
		477	Sets the working directory for the shell (or the command specified via
		478	B<-e>). The I<path> must be an absolute path and it must exist for
		479	@@RXVT_NAME@@ to start; resource B<chdir>.
		480
		481	=item B<-xrm> I<string>
		482
		483	Works like the X Toolkit option of the same name, by adding the I<string>
		484	as if it were specified in a resource file. Resource values specified this
		485	way take precedence over all other resource specifications.
		486
		487	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		488	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		489	options can be specified as long-options on the commandline, so use
		490	of B<-xrm> is mostly limited to cases where you want to specify other
		491	resources (e.g. for input methods) or for compatibility with other
		492	programs.
		493
422	=item B<-keysym.>I<sym> I<string>	494	=item B<-keysym.>I<sym> I<string>
423		495
424	Remap a key symbol. See resource B<keysym>.	496	Remap a key symbol. See resource B<keysym>.
425		497
426	=item B<-embed> I<windowid>	498	=item B<-embed> I<windowid>
…		…
436	The window will not be destroyed when @@RXVT_NAME@@ exits.	508	The window will not be destroyed when @@RXVT_NAME@@ exits.
437		509
438	It might be useful to know that @@RXVT_NAME@@ will not close file	510	It might be useful to know that @@RXVT_NAME@@ will not close file
439	descriptors passed to it (except for stdin/out/err, of course), so you	511	descriptors passed to it (except for stdin/out/err, of course), so you
440	can use file descriptors to communicate with the programs within the	512	can use file descriptors to communicate with the programs within the
441	terminal. This works regardless of wether the C<-embed> option was used or	513	terminal. This works regardless of whether the C<-embed> option was used or
442	not.	514	not.
443		515
444	Here is a short Gtk2-perl snippet that illustrates how this option can be	516	Here is a short Gtk2-perl snippet that illustrates how this option can be
445	used (a longer example is in F<doc/embed>):	517	used (a longer example is in F<doc/embed>):
446		518
…		…
451	});	523	});
452		524
453	=item B<-pty-fd> I<file descriptor>	525	=item B<-pty-fd> I<file descriptor>
454		526
455	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	527	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
456	pair but instead use the given filehandle as the tty master. This is	528	pair but instead use the given file descriptor as the tty master. This is
457	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator	529	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
458	without having to run a program within it.	530	without having to run a program within it.
459		531
460	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	532	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
461	entries and will not tinker with pty/tty permissions - you have to do that	533	entries and will not tinker with pty/tty permissions - you have to do that
462	yourself if you want that.	534	yourself if you want that.
463		535
464	As an extremely special case, specifying C<-1> will completely suppress	536	As an extremely special case, specifying C<-1> will completely suppress
465	pty/tty operations.	537	pty/tty operations, which is probably only useful in conjunction with some
		538	perl extension that manages the terminal.
466		539
467	Here is a example in perl that illustrates how this option can be used (a	540	Here is a example in perl that illustrates how this option can be used (a
468	longer example is in F<doc/pty-fd>):	541	longer example is in F<doc/pty-fd>):
469		542
470	use IO::Pty;	543	use IO::Pty;
…		…
484	Comma-separated list of perl extension scripts to use (or not to use) in	557	Comma-separated list of perl extension scripts to use (or not to use) in
485	this terminal instance. See resource B<perl-ext> for details.	558	this terminal instance. See resource B<perl-ext> for details.
486		559
487	=back	560	=back
488		561
489	=head1 RESOURCES (available also as long-options)	562	=head1 RESOURCES
490		563
491	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	564	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
492	options) compiled into your version.	565	options) compiled into your version. All resources are also available as
		566	long-options.
493		567
494	You can set and change the resources using X11 tools like B<xrdb>. Many	568	You can set and change the resources using X11 tools like B<xrdb>. Many
495	distribution do also load settings from the B<~/.Xresources> file when X	569	distribution do also load settings from the B<~/.Xresources> file when X
496	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	570	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
497	with later settings overwriting earlier ones:	571	with later settings overwriting earlier ones:
…		…
499	1. system-wide app-defaults file, either locale-dependent OR global	573	1. system-wide app-defaults file, either locale-dependent OR global
500	2. app-defaults file in $XAPPLRESDIR	574	2. app-defaults file in $XAPPLRESDIR
501	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	575	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
502	4. SCREEN_RESOURCES for the current screen	576	4. SCREEN_RESOURCES for the current screen
503	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	577	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		578	6. resources specified via -xrm on the commandline
504		579
505	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	580	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
506	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	581	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
507	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily	582	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
508	configured, while the class name B<URxvt> allows resources unique to	583	configured, while the class name B<URxvt> allows resources unique to
…		…
518	=item B<depth:> I<bitdepth>	593	=item B<depth:> I<bitdepth>
519		594
520	Compile I<xft>: Attempt to find a visual with the given bit depth;	595	Compile I<xft>: Attempt to find a visual with the given bit depth;
521	option B<-depth>.	596	option B<-depth>.
522		597
		598	=item B<buffered:> I<boolean>
		599
		600	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		601	On some card/driver combination enabling it slightly decreases
		602	performance, on most it greatly helps it. The slowdown is small, so it
		603	should normally be enabled.
		604
523	=item B<geometry:> I<geom>	605	=item B<geometry:> I<geom>
524		606
525	Create the window with the specified X window geometry [default 80x24];	607	Create the window with the specified X window geometry [default 80x24];
526	option B<-geometry>.	608	option B<-geometry>.
527		609
…		…
540	Use the specified colour for the colour value I<n>, where 0-7	622	Use the specified colour for the colour value I<n>, where 0-7
541	corresponds to low-intensity (normal) colours and 8-15 corresponds to	623	corresponds to low-intensity (normal) colours and 8-15 corresponds to
542	high-intensity (bold = bright foreground, blink = bright background)	624	high-intensity (bold = bright foreground, blink = bright background)
543	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	625	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
544	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	626	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
545	names used are listed in the B<COLORS AND GRAPHICS> section.	627	names used are listed in the B<COLOURS AND GRAPHICS> section.
546		628
547	Colours higher than 15 cannot be set using resources (yet), but can be	629	Colours higher than 15 cannot be set using resources (yet), but can be
548	changed using an escape command (see @@RXVT_NAME@@(7)).	630	changed using an escape command (see @@RXVT_NAME@@(7)).
549		631
550	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	632	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
561	=item B<colorUL:> I<colour>	643	=item B<colorUL:> I<colour>
562		644
563	Use the specified colour to display underlined characters when the	645	Use the specified colour to display underlined characters when the
564	foreground colour is the default.	646	foreground colour is the default.
565		647
566	=item B<colorRV:> I<colour>
567
568	Use the specified colour as the background for reverse video
569	characters.
570
571	=item B<underlineColor:> I<colour>	648	=item B<underlineColor:> I<colour>
572		649
573	If set, use the specified colour as the colour for the underline	650	If set, use the specified colour as the colour for the underline
574	itself. If unset, use the foreground colour.	651	itself. If unset, use the foreground colour.
		652
		653	=item B<highlightColor:> I<colour>
		654
		655	If set, use the specified colour as the background for highlighted
		656	characters. If unset, use reverse video.
		657
		658	=item B<highlightTextColor:> I<colour>
		659
		660	If set and highlightColor is set, use the specified colour as the
		661	foreground for highlighted characters.
575		662
576	=item B<cursorColor:> I<colour>	663	=item B<cursorColor:> I<colour>
577		664
578	Use the specified colour for the cursor. The default is to use the	665	Use the specified colour for the cursor. The default is to use the
579	foreground colour; option B<-cr>.	666	foreground colour; option B<-cr>.
…		…
586		673
587	=item B<reverseVideo:> I<boolean>	674	=item B<reverseVideo:> I<boolean>
588		675
589	B<True>: simulate reverse video by foreground and background colours;	676	B<True>: simulate reverse video by foreground and background colours;
590	option B<-rv>. B<False>: regular screen colours [default]; option	677	option B<-rv>. B<False>: regular screen colours [default]; option
591	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	678	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
592		679
593	=item B<jumpScroll:> I<boolean>	680	=item B<jumpScroll:> I<boolean>
594		681
595	B<True>: specify that jump scrolling should be used. When scrolling	682	B<True>: specify that jump scrolling should be used. When receiving lots
596	quickly, fewer screen updates are performed [default]; option B<-j>.	683	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		684	has been read, resulting in fewer updates while still displaying every
		685	received line; option B<-j>.
		686
597	B<False>: specify that smooth scrolling should be used; option B<+j>.	687	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		688	force a screen refresh on each new line it received; option B<+j>.
598		689
599	=item B<inheritPixmap:> I<boolean>	690	=item B<skipScroll:> I<boolean>
600		691
601	B<True>: make the background inherit the parent windows' pixmap, giving	692	B<True>: (the default) specify that skip scrolling should be used. When
602	artificial transparency. B<False>: do not inherit the parent windows'	693	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
603	pixmap.	694	(around 60 times per second), resulting in far fewer updates. This can
		695	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		696	option B<-ss>.
604		697
605	I<Please note that transparency of any kind if completely unsupported by	698	B<False>: specify that everything is to be displayed, even
606	the author. Don't bug him with installation questions!>	699	if the refresh is too fast for the human eye to read anything (or the
		700	monitor to display anything); option B<+ss>.
		701
		702	=item B<transparent:> I<boolean>
		703
		704	Turn on/off illusion of a transparent window background.
		705
		706	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
		707	future versions.
607		708
608	=item B<fading:> I<number>	709	=item B<fading:> I<number>
609		710
610	Fade the text by the given percentage when focus is lost; option B<-fade>.	711	Fade the text by the given percentage when focus is lost; option B<-fade>.
611		712
…		…
619	Tint the transparent background pixmap with the given colour; option	720	Tint the transparent background pixmap with the given colour; option
620	B<-tint>.	721	B<-tint>.
621		722
622	=item B<shading:> I<number>	723	=item B<shading:> I<number>
623		724
624	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	725	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
625	image in addition to tinting it.	726	in addition to tinting it; option B<-sh>.
		727
		728	=item B<blendType:> I<string>
		729
		730	Specify background blending type; option B<-blt>.
		731
		732	=item B<blurRadius:> I<number>
		733
		734	Apply gaussian blur with the specified radius to the transparent
		735	background image; option B<-blr>.
		736
		737	=item B<iconFile:> I<file>
		738
		739	Set the application icon pixmap; option B<-icon>.
626		740
627	=item B<scrollColor:> I<colour>	741	=item B<scrollColor:> I<colour>
628		742
629	Use the specified colour for the scrollbar [default #B2B2B2].	743	Use the specified colour for the scrollbar [default #B2B2B2].
630		744
…		…
636	=item B<borderColor:> I<colour>	750	=item B<borderColor:> I<colour>
637		751
638	The colour of the border around the text area and between the scrollbar	752	The colour of the border around the text area and between the scrollbar
639	and the text.	753	and the text.
640		754
641	=item B<backgroundPixmap:> I<file[;geom]>	755	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
642		756
643	Use the specified XPM file (note the `.xpm' extension is optional) for	757	Use the specified image file for the background and also
644	the background and also optionally specify its scaling with a geometry	758	optionally specify its scaling with a geometry string B<WxH+X+Y>,
645	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	759	(default C<100x100+50+50>) in which B<"W" / "H"> specify the
646	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	760	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
647	centre (percent). A scale of 0 displays the image with tiling. A scale	761	centre (percent). A scale of 0 displays the image with tiling.
648	of 1 displays the image without any scaling. A scale of 2 to 9	762	The maximum permitted scale is 1000.
649	specifies an integer number of images in that direction. No image will	763	Additional operations can be specified after colon B<:op1:op2...>.
650	be magnified beyond 10 times its original size. The maximum permitted	764	Supported operations are:
651	scale is 1000. [default 0x0+50+50]	765
		766	tile force background image to be tiled and not scaled. Equivalent to 0x0
		767	propscale will scale image keeping proportions
		768	auto will scale image to match window size. Equivalent to 100x100
		769	hscale will scale image horizontally to the window size
		770	vscale will scale image vertically to the window size
		771	scale will scale image to match window size
		772	root will tile image as if it was a root window background, auto-adjusting
		773	whenever terminal window moves
		774
		775	If used in conjunction with B<-tr> option, the specified pixmap will be
		776	blended over transparency image using alpha-blending. If I<afterimage>
		777	support has been compiled in it is possible to choose other blending
		778	types with B<-blt "type"> option.
652		779
653	=item B<path:> I<path>	780	=item B<path:> I<path>
654		781
655	Specify the colon-delimited search path for finding XPM files.	782	Specify the colon-delimited search path for finding background image files.
656		783
657	=item B<font:> I<fontlist>	784	=item B<font:> I<fontlist>
658		785
659	Select the fonts to be used. This is a comma separated list of font names	786	Select the fonts to be used. This is a comma separated list of font names
660	that are checked in order when trying to find glyphs for characters. The	787	that are checked in order when trying to find glyphs for characters. The
…		…
683	it is named first) and thus defines the character cell grid to be 9 pixels	810	it is named first) and thus defines the character cell grid to be 9 pixels
684	wide and 15 pixels high.	811	wide and 15 pixels high.
685		812
686	The second font is just used to add additional unicode characters not in	813	The second font is just used to add additional unicode characters not in
687	the base font, likewise the third, which is unfortunately non-bold, but	814	the base font, likewise the third, which is unfortunately non-bold, but
688	the bold version of the font does contain less characters, so this is a	815	the bold version of the font does contain fewer characters, so this is a
689	useful supplement.	816	useful supplement.
690		817
691	The third font is an Xft font with aliasing turned off, and the characters	818	The third font is an Xft font with aliasing turned off, and the characters
692	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	819	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
693	contains other characters, but we are not interested in them.	820	contains other characters, but we are not interested in them.
…		…
717	text font will being used for the given style.	844	text font will being used for the given style.
718		845
719	=item B<intensityStyles:> I<boolean>	846	=item B<intensityStyles:> I<boolean>
720		847
721	When font styles are not enabled, or this option is enabled (B<True>,	848	When font styles are not enabled, or this option is enabled (B<True>,
722	option B<-is>, the default), bold and italic font styles imply high	849	option B<-is>, the default), bold/blink font styles imply high
723	intensity foreground/backround colours. Disabling this option (B<False>,	850	intensity foreground/background colours. Disabling this option (B<False>,
724	option B<+is>) disables this behaviour, the high intensity colours are not	851	option B<+is>) disables this behaviour, the high intensity colours are not
725	reachable.	852	reachable.
726
727	=item B<selectstyle:> I<mode>
728
729	Set mouse selection style to B<old> which is 2.20, B<oldword> which is
730	xterm style with 2.20 old word selection, or anything else which gives
731	xterm style selection.
732
733	=item B<scrollstyle:> I<mode>
734
735	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
736	the author's favourite.
737		853
738	=item B<title:> I<string>	854	=item B<title:> I<string>
739		855
740	Set window title string, the default title is the command-line	856	Set window title string, the default title is the command-line
741	specified after the B<-e> option, if any, otherwise the application	857	specified after the B<-e> option, if any, otherwise the application
…		…
750	=item B<mapAlert:> I<boolean>	866	=item B<mapAlert:> I<boolean>
751		867
752	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	868	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
753	de-iconify (map) on receipt of a bell character [default].	869	de-iconify (map) on receipt of a bell character [default].
754		870
		871	=item B<urgentOnBell:> I<boolean>
		872
		873	B<True>: set the urgency hint for the wm on receipt of a bell character.
		874	B<False>: do not set the urgency hint [default].
		875
		876	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		877
755	=item B<visualBell:> I<boolean>	878	=item B<visualBell:> I<boolean>
756		879
757	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	880	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
758	B<False>: no visual bell [default]; option B<+vb>.	881	B<False>: no visual bell [default]; option B<+vb>.
759		882
…		…
780	Example:	903	Example:
781		904
782	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	905	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
783		906
784	This creates a new file in your home directory with the screen contents	907	This creates a new file in your home directory with the screen contents
785	everytime you hit C<Print>.	908	every time you hit C<Print>.
		909
		910	=item B<scrollstyle:> I<mode>
		911
		912	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		913	the author's favourite.
786		914
787	=item B<scrollBar:> I<boolean>	915	=item B<scrollBar:> I<boolean>
788		916
789	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	917	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
790	disable the scrollbar; option B<+sb>.	918	disable the scrollbar; option B<+sb>.
…		…
812		940
813	=item B<scrollWithBuffer:> I<boolean>	941	=item B<scrollWithBuffer:> I<boolean>
814		942
815	B<True>: scroll with scrollback buffer when tty receives new lines (and	943	B<True>: scroll with scrollback buffer when tty receives new lines (and
816	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	944	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
817	with scrollback buffer when tty recieves new lines; option B<+sw>.	945	with scrollback buffer when tty receives new lines; option B<+sw>.
818		946
819	=item B<scrollTtyKeypress:> I<boolean>	947	=item B<scrollTtyKeypress:> I<boolean>
820		948
821	B<True>: scroll to bottom when a non-special key is pressed. Special keys	949	B<True>: scroll to bottom when a non-special key is pressed. Special keys
822	are those which are intercepted by rxvt-unicode for special handling and	950	are those which are intercepted by rxvt-unicode for special handling and
…		…
853	=item B<termName:> I<termname>	981	=item B<termName:> I<termname>
854		982
855	Specifies the terminal type name to be set in the B<TERM> environment	983	Specifies the terminal type name to be set in the B<TERM> environment
856	variable; option B<-tn>.	984	variable; option B<-tn>.
857		985
858	=item B<linespace:> I<number>	986	=item B<lineSpace:> I<number>
859		987
860	Specifies number of lines (pixel height) to insert between each row of	988	Specifies number of lines (pixel height) to insert between each row of
861	the display [default 0]; option B<-lsp>.	989	the display [default 0]; option B<-lsp>.
862		990
863	=item B<meta8:> I<boolean>	991	=item B<meta8:> I<boolean>
…		…
877		1005
878	=item B<cursorBlink:> I<boolean>	1006	=item B<cursorBlink:> I<boolean>
879		1007
880	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1008	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
881	option B<-bc>.	1009	option B<-bc>.
		1010
		1011	=item B<cursorUnderline:> I<boolean>
		1012
		1013	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1014	option B<-uc>.
882		1015
883	=item B<pointerBlank:> I<boolean>	1016	=item B<pointerBlank:> I<boolean>
884		1017
885	B<True>: blank the pointer when a key is pressed or after a set number	1018	B<True>: blank the pointer when a key is pressed or after a set number
886	of seconds of inactivity. B<False>: the pointer is always visible	1019	of seconds of inactivity. B<False>: the pointer is always visible
…		…
900	large number (e.g. C<987654321>) to effectively disable the timeout.	1033	large number (e.g. C<987654321>) to effectively disable the timeout.
901		1034
902	=item B<backspacekey:> I<string>	1035	=item B<backspacekey:> I<string>
903		1036
904	The string to send when the backspace key is pressed. If set to B<DEC>	1037	The string to send when the backspace key is pressed. If set to B<DEC>
905	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	1038	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
906	(code 8) - which can be reversed with the appropriate DEC private mode	1039	(code 8) - which can be reversed with the appropriate DEC private mode
907	escape sequence.	1040	escape sequence.
908		1041
909	=item B<deletekey:> I<string>	1042	=item B<deletekey:> I<string>
910		1043
…		…
915	=item B<cutchars:> I<string>	1048	=item B<cutchars:> I<string>
916		1049
917	The characters used as delimiters for double-click word selection	1050	The characters used as delimiters for double-click word selection
918	(whitespace delimiting is added automatically if resource is given).	1051	(whitespace delimiting is added automatically if resource is given).
919		1052
920	When the selection extension is in use (the default if compiled in, see	1053	When the perl selection extension is in use (the default if compiled
921	the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters	1054	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
922	will be created (if the resource exists, otherwise, no regex will be	1055	characters will be created (if the resource exists, otherwise, no regex
923	created). In this mode, characters outside ISO-8859-1 can be used.	1056	will be created). In this mode, characters outside ISO-8859-1 can be used.
924		1057
925	When the selection extension is not used, only ISO-8859-1 characters can	1058	When the selection extension is not used, only ISO-8859-1 characters can
926	be used. If not specified, the built-in default is used:	1059	be used. If not specified, the built-in default is used:
927		1060
928	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1061	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
929		1062
930	=item B<preeditType:> I<style>	1063	=item B<preeditType:> I<style>
931		1064
932	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1065	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
933		1066
…		…
987		1120
988	Turn on/off secondary screen (default enabled).	1121	Turn on/off secondary screen (default enabled).
989		1122
990	=item B<secondaryScroll:> I<boolean>	1123	=item B<secondaryScroll:> I<boolean>
991		1124
992	Turn on/off secondary screen scroll (default enabled). If the this	1125	Turn on/off secondary screen scroll (default enabled). If this
993	option is enabled, scrolls on the secondary screen will change the	1126	option is enabled, scrolls on the secondary screen will change the
994	scrollback buffer and switching to/from the secondary screen will	1127	scrollback buffer and, when secondaryScreen is off, switching
995	instead scroll the screen up.	1128	to/from the secondary screen will instead scroll the screen up.
996		1129
997	=item B<hold>: I<boolean>	1130	=item B<hold>: I<boolean>
998		1131
999	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1132	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1000	will not immediately destroy its window when the program executed within	1133	will not immediately destroy its window when the program executed within
1001	it exits. Instead, it will wait till it is being killed or closed by the	1134	it exits. Instead, it will wait till it is being killed or closed by the
1002	user.	1135	user.
		1136
		1137	=item B<chdir>: I<path>
		1138
		1139	Sets the working directory for the shell (or the command specified via
		1140	B<-e>). The I<path> must be an absolute path and it must exist for
		1141	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1142	directory will be used; option B<-cd>.
1003		1143
1004	=item B<keysym.>I<sym>: I<string>	1144	=item B<keysym.>I<sym>: I<string>
1005		1145
1006	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1146	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1007	intervening resource name B<keysym.> cannot be omitted.	1147	intervening resource name B<keysym.> cannot be omitted.
…		…
1021	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1161	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1022	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1162	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1023	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1163	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1024	performed in an exact manner; however, the closest match is assured.	1164	performed in an exact manner; however, the closest match is assured.
1025		1165
1026	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1166	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1027	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1167	number), see RESOURCES in C<man 7 X> for further details.
1028	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1029	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1030	can start or end with whitespace.
1031
1032	Please note that you need to double the C<\> in resource files, as
1033	Xlib itself does its own de-escaping (you can use C<\033> instead of
1034	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1035	processing).
1036		1168
1037	You can define a range of keysyms in one shot by providing a I<string>	1169	You can define a range of keysyms in one shot by providing a I<string>
1038	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1170	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1039	should be a character not used by the strings.	1171	should be a character not used by the strings.
1040		1172
1041	Its usage can be demonstrated by an example:	1173	Its usage can be demonstrated by an example:
1042		1174
1043	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1175	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
…		…
1054	when Control-Meta-c is being pressed":	1186	when Control-Meta-c is being pressed":
1055		1187
1056	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1188	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1057		1189
1058	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1190	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1059	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1191	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1060	manpage. For example, the F<selection> extension (activated via	1192	manpage. For example, the F<selection> extension (activated via
1061	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1193	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1062		1194
1063	URxvt.keysym.M-C-c: perl:selection:rot13	1195	URxvt.keysym.M-C-c: perl:selection:rot13
1064		1196
1065	Due the the large number of modifier combinations, a defined key mapping	1197	Due the the large number of modifier combinations, a defined key mapping
1066	will match if at I<at least> the specified identifiers are being set, and	1198	will match if I<at least> the specified identifiers are being set, and
1067	no other key mappings with those and more bits are being defined. That	1199	no other key mappings with those and more bits are being defined. That
1068	means that defining a key map for C<a> will automatically provide	1200	means that defining a key map for C<a> will automatically provide
1069	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined	1201	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1070	mappings themselves.	1202	mappings themselves.
1071		1203
…		…
1107	example, C<default,-selection> will use all the default extension except	1239	example, C<default,-selection> will use all the default extension except
1108	C<selection>.	1240	C<selection>.
1109		1241
1110	Extension names can also be followed by an argument in angle brackets	1242	Extension names can also be followed by an argument in angle brackets
1111	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1243	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1112	searchable scorllback to Alt/Meta-s). Mentioning the same extension	1244	searchable scrollback to Alt/Meta-s). Mentioning the same extension
1113	multiple times with different arguments will pass multiple arguments to	1245	multiple times with different arguments will pass multiple arguments to
1114	the extension.	1246	the extension.
1115		1247
1116	Each extension is looked up in the library directories, loaded if	1248	Each extension is looked up in the library directories, loaded if
1117	necessary, and bound to the current terminal instance.	1249	necessary, and bound to the current terminal instance.
…		…
1122	all instances, while B<perl-ext> is used for specific instances.	1254	all instances, while B<perl-ext> is used for specific instances.
1123		1255
1124	=item B<perl-eval>: I<string>	1256	=item B<perl-eval>: I<string>
1125		1257
1126	Perl code to be evaluated when all extensions have been registered. See	1258	Perl code to be evaluated when all extensions have been registered. See
1127	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1259	the @@RXVT_NAME@@perl(3) manpage.
1128	will be ignored when running setuid/setgid.
1129		1260
1130	=item B<perl-lib>: I<path>	1261	=item B<perl-lib>: I<path>
1131		1262
1132	Colon-separated list of additional directories that hold extension	1263	Colon-separated list of additional directories that hold extension
1133	scripts. When looking for extensions specified by the C<perl> resource,	1264	scripts. When looking for extensions specified by the C<perl> resource,
1134	@@RXVT_NAME@@ will first look in these directories and then in	1265	@@RXVT_NAME@@ will first look in these directories and then in
1135	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1266	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1136	will be ignored when running setuid/setgid.
1137		1267
1138	See the @@RXVT_NAME@@perl(3) manpage.	1268	See the @@RXVT_NAME@@perl(3) manpage.
1139		1269
1140	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1270	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1141		1271
…		…
1153	(default: C<M-s>).	1283	(default: C<M-s>).
1154		1284
1155	=item B<urlLauncher>: I<string>	1285	=item B<urlLauncher>: I<string>
1156		1286
1157	Specifies the program to be started with a URL argument. Used by the	1287	Specifies the program to be started with a URL argument. Used by the
1158	C<selection-popup> and C<mark-urls> perl extensions.	1288	C<selection-popup> and C<matcher> perl extensions.
1159		1289
1160	=item B<transient-for>: I<windowid>	1290	=item B<transient-for>: I<windowid>
1161		1291
1162	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.	1292	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1163		1293
1164	=item B<override-redirect>: I<boolean>	1294	=item B<override-redirect>: I<boolean>
1165		1295
1166	Compile I<frills>: Sets override-redirect for the terminal window, making	1296	Compile I<frills>: Sets override-redirect for the terminal window, making
1167	it almost invisible to window managers; option B<-override-redirect>.	1297	it almost invisible to window managers; option B<-override-redirect>.
		1298
		1299	=item B<iso14755:> I<boolean>
		1300
		1301	Turn on/off ISO 14755 (default enabled).
		1302
		1303	=item B<iso14755_52:> I<boolean>
		1304
		1305	Turn on/off ISO 14755 5.2 mode (default enabled).
1168		1306
1169	=back	1307	=back
1170		1308
1171	=head1 THE SCROLLBAR	1309	=head1 THE SCROLLBAR
1172		1310
…		…
1191	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1329	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1192	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1330	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1193	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1331	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1194	respectively.	1332	respectively.
1195		1333
1196	=head1 TEXT SELECTION AND INSERTION	1334	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1197		1335
1198	The behaviour of text selection and insertion mechanism is similar to	1336	The behaviour of text selection and insertion/pasting mechanism is similar
1199	I<xterm>(1).	1337	to I<xterm>(1).
1200		1338
1201	=over 4	1339	=over 4
1202		1340
1203	=item B<Selection>:	1341	=item B<Selecting>:
1204		1342
1205	Left click at the beginning of the region, drag to the end of the region	1343	Left click at the beginning of the region, drag to the end of the region
1206	and release; Right click to extend the marked region; Left double-click	1344	and release; Right click to extend the marked region; Left double-click
1207	to select a word; Left triple-click to select the entire logical line	1345	to select a word; Left triple-click to select the entire logical line
1208	(which can span multiple screen lines), unless modified by resource	1346	(which can span multiple screen lines), unless modified by resource
…		…
1212	(Compile: I<frills>) will create a rectangular selection instead of a	1350	(Compile: I<frills>) will create a rectangular selection instead of a
1213	normal one. In this mode, every selected row becomes its own line in the	1351	normal one. In this mode, every selected row becomes its own line in the
1214	selection, and trailing whitespace is visually underlined and removed from	1352	selection, and trailing whitespace is visually underlined and removed from
1215	the selection.	1353	the selection.
1216		1354
1217	=item B<Insertion>:	1355	=item B<Pasting>:
1218		1356
1219	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>	1357	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1220	window causes the value of the PRIMARY selection (or CLIPBOARD with the	1358	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1221	Meta modifier) to be inserted as if it had been typed on the keyboard.	1359	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1222		1360
1223	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1361	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1224	inserted too.	1362	inserted too.
1225		1363
1226	=back	1364	=back
…		…
1243		1381
1244	=head1 ISO 14755 SUPPORT	1382	=head1 ISO 14755 SUPPORT
1245		1383
1246	ISO 14755 is a standard for entering and viewing unicode characters	1384	ISO 14755 is a standard for entering and viewing unicode characters
1247	and character codes using the keyboard. It consists of 4 parts. The	1385	and character codes using the keyboard. It consists of 4 parts. The
1248	first part is available rxvt-unicode has been compiled with	1386	first part is available if rxvt-unicode has been compiled with
1249	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1387	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1250	with C<--enable-iso14755>.	1388	with C<--enable-iso14755>.
1251		1389
1252	=over 4	1390	=over 4
1253		1391
…		…
1311	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1449	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1312	it can be seen via the I<who(1)> command, and can accept messages. To	1450	it can be seen via the I<who(1)> command, and can accept messages. To
1313	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1451	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1314	on some systems or setgid to root or to some other group on others.	1452	on some systems or setgid to root or to some other group on others.
1315		1453
1316	=head1 COLORS AND GRAPHICS	1454	=head1 COLOURS AND GRAPHICS
1317		1455
1318	In addition to the default foreground and background colours,	1456	In addition to the default foreground and background colours,
1319	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1457	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1320	high-intensity bold/blink versions of the same). Here is a list of the	1458	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1321	colours with their names.	1459	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1460	cube plus a 8 (24) colour greyscale ramp.
		1461
		1462	Here is a list of the ANSI colours with their names.
1322		1463
1323	=begin table	1464	=begin table
1324		1465
1325	B<color0> (black) = Black	1466	B<color0> (black) = Black
1326	B<color1> (red) = Red3	1467	B<color1> (red) = Red3
…		…
1346	It is also possible to specify the colour values of B<foreground>,	1487	It is also possible to specify the colour values of B<foreground>,
1347	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1488	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1348	a number 0-15, as a convenient shorthand to reference the colour name of	1489	a number 0-15, as a convenient shorthand to reference the colour name of
1349	color0-color15.	1490	color0-color15.
1350		1491
1351	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1492	The following text gives values for the standard 88 colour mode (and
1352	additional 72 colours. The first 64 of those (with indices 16 to 79)	1493	values for the 256 colour mode in parentheses).
1353	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1354	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1355		1494
		1495	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1496
		1497	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1498	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1499
		1500	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1501	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1502	the RGB cube.
		1503
1356	Together, all those colours implement the 88 colour xterm colours. Only	1504	Together, all those colours implement the 88 (256) colour xterm
1357	the first 16 can be changed using resources currently, the rest can only	1505	colours. Only the first 16 can be changed using resources currently, the
1358	be changed via command sequences ("escape codes").	1506	rest can only be changed via command sequences ("escape codes").
		1507
		1508	Applications are advised to use terminfo or command sequences to discover
		1509	number and RGB values of all colours (yes, you can query this...).
1359		1510
1360	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1511	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1361	always swapping the foreground/background colours. This is in contrast to	1512	always swapping the foreground/background colours. This is in contrast to
1362	I<xterm>(1) where the colours are only swapped if they have not otherwise	1513	I<xterm>(1) where the colours are only swapped if they have not otherwise
1363	been specified. For example,	1514	been specified. For example,
1364		1515
		1516	@@RXVT_NAME@@ -fg Black -bg White -rv
		1517
		1518	would yield White on Black, while on I<xterm>(1) it would yield Black on
		1519	White.
		1520
		1521	=head2 ALPHA CHANNEL SUPPORT
		1522
		1523	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1524	their act together, rxvt-unicode will do it's own alpha channel management:
		1525
		1526	You can prefix any colour with an opaqueness percentage enclosed in
		1527	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1528	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1529	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1530	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1531	is the recommended format to specify transparency values, and works with
		1532	all ways to specify a colour.
		1533
		1534	For complete control, rxvt-unicode also supports
		1535	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1536	specifications, where the additional C<aaaa> component specifies opacity
		1537	(alpha) values. The minimum value of C<0000> is completely transparent,
		1538	while C<ffff> is completely opaque). The two example colours from
		1539	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1540	C<rgba:0000/ff00/0000/f332>.
		1541
		1542	You probably need to specify B<"-depth 32">, too, to force a visual with
		1543	alpha channels, and have the luck that your X-server uses ARGB pixel
		1544	layout, as X is far from just supporting ARGB visuals out of the box, and
		1545	rxvt-unicode just fudges around.
		1546
		1547	For example, the following selects an almost completely transparent black
		1548	background, and an almost opaque pink foreground:
		1549
		1550	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
		1551
		1552	When not using a background image, then the interpretation of the
		1553	alpha channel is up to your compositing manager (most interpret it as
		1554	transparency of course).
		1555
		1556	When using a background pixmap or pseudo-transparency, then the background
		1557	colour will always behave as if it were completely transparent (so the
		1558	background image shows instead), regardless of how it was specified, while
		1559	other colours will either be transparent as specified (the background
		1560	image will show through) on servers supporting the RENDER extension, or
		1561	fully opaque on servers not supporting the RENDER EXTENSION.
		1562
		1563	Please note that due to bugs in Xft, specifying alpha values might result
		1564	in garbage being displayed when the X-server does not support the RENDER
		1565	extension.
		1566
		1567	=head1 ENVIRONMENT
		1568
		1569	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
		1570
1365	=over 4	1571	=over 4
1366		1572
1367	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
1368
1369	would yield White on Black, while on I<xterm>(1) it would yield Black
1370	on White.
1371
1372	=back
1373
1374	=head2 ALPHA CHANNEL SUPPORT
1375
1376	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1377	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1378	(recommended, but B<MUST> have 4 digits/component) colour specifications,
1379	in addition to the ones provided by X, where the additional A component
1380	specifies opacity (alpha) values. The minimum value of C<0> is completely
1381	transparent). You can also prefix any color with C<[a]>, where C<a> is on
1382	to four hex digits specifiying the opacity value.
1383
1384	You probably need to specify B<"-depth 32">, too, and have the luck that
1385	your X-server uses ARGB pixel layout, as X is far from just supporting
1386	ARGB visuals out of the box, and rxvt-unicode just fudges around.
1387
1388	For example, the following selects an almost completely transparent red
1389	background, and an almost opaque pink foreground:
1390
1391	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"
1392
1393	I<Please note that transparency of any kind if completely unsupported by
1394	the author. Don't bug him with installation questions!>
1395
1396	=head1 ENVIRONMENT
1397
1398	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1399
1400	=over 4
1401
1402	=item B<TERM>	1573	=item B<TERM>
1403		1574
1404	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1575	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1405	resources or on the commandline.	1576	resources or on the command line.
1406		1577
1407	=item B<COLORTERM>	1578	=item B<COLORTERM>
1408		1579
1409	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1580	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1410	compiled with XPM support, and optionally with the added extension	1581	compiled with background image support, and optionally with the added
1411	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1582	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1583	screen.
1412		1584
1413	=item B<COLORFGBG>	1585	=item B<COLORFGBG>
1414		1586
1415	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1587	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1416	the colour code used as default foreground/text colour (or the string	1588	the colour code used as default foreground/text colour (or the string
1417	C<default> to indicate that the default-colour escape sequence is to be	1589	C<default> to indicate that the default-colour escape sequence is to be
1418	used), C<bg> is the colour code used as default background colour (or the	1590	used), C<bg> is the colour code used as default background colour (or the
1419	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1591	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1420	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1592	was compiled with background image support. Libraries like C<ncurses>
1421	(and do) use this information to optimize screen output.	1593	and C<slang> can (and do) use this information to optimize screen output.
1422		1594
1423	=item B<WINDOWID>	1595	=item B<WINDOWID>
1424		1596
1425	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1597	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1426	window, which usually has subwindows for the scrollbar, the terminal	1598	window, which usually has subwindows for the scrollbar, the terminal
…		…
1432	C<--with-terminfo=PATH>.	1604	C<--with-terminfo=PATH>.
1433		1605
1434	=item B<DISPLAY>	1606	=item B<DISPLAY>
1435		1607
1436	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1608	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1437	display in its child processes.	1609	display in its child processes if C<-display> isn't used to override. It
		1610	defaults to C<:0> if it doesn't exist.
1438		1611
1439	=item B<SHELL>	1612	=item B<SHELL>
1440		1613
1441	The shell to be used for command execution, defaults to C</bin/sh>.	1614	The shell to be used for command execution, defaults to C</bin/sh>.
1442		1615
…		…
1468		1641
1469	=over 4	1642	=over 4
1470		1643
1471	=item B</usr/lib/X11/rgb.txt>	1644	=item B</usr/lib/X11/rgb.txt>
1472		1645
1473	Color names.	1646	Colour names.
1474		1647
1475	=back	1648	=back
1476		1649
1477	=head1 SEE ALSO	1650	=head1 SEE ALSO
1478		1651
…		…
1517	Project Coordinator (changes.txt 2.21a to 2.4.5)	1690	Project Coordinator (changes.txt 2.21a to 2.4.5)
1518		1691
1519	=item Geoff Wing L<< <gcw@pobox.com> >>	1692	=item Geoff Wing L<< <gcw@pobox.com> >>
1520		1693
1521	Rewrote screen display and text selection routines.	1694	Rewrote screen display and text selection routines.
1522		1695
1523	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1696	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1524		1697
1525	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1698	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1526		1699
1527	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1700	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.115 by root, Mon Jul 10 04:01:33 2006 UTC vs. Revision 1.187 by sf-exg, Fri Oct 15 10:46:57 2010 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.115 by root, Mon Jul 10 04:01:33 2006 UTC vs.
Revision 1.187 by sf-exg, Fri Oct 15 10:46:57 2010 UTC