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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.114 by root, Thu Jul 6 19:43:21 2006 UTC vs.
Revision 1.180 by root, Tue Jun 15 11:45:48 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 left-to-right 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.
		133
		134	I<Please address all transparency related issues to Sasha Vasko at
		135	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
122		136
123	=item B<-fade> I<number>	137	=item B<-fade> I<number>
124		138
125	Fade the text by the given percentage when focus is lost. Small values	139	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	140	fade a little only, 100 completely replaces all colours by the fade
…		…
132	is opaque black. resource B<fadeColor>.	146	is opaque black. resource B<fadeColor>.
133		147
134	=item B<-tint> I<colour>	148	=item B<-tint> I<colour>
135		149
136	Tint the transparent background pixmap with the given colour when	150	Tint the transparent background pixmap with the given colour when
137	transparency is enabled with B<-tr> or B<-ip>. This only works for	151	transparency is enabled with B<-tr>. This only works for
138	non-tiled backgrounds, currently. See also the B<-sh> option that can be	152	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	153	used to brighten or darken the image in addition to tinting it.
		154	Please note that certain tint colours can be applied on the server-side,
		155	thus yielding performance gain of two orders of magnitude. These colours are:
		156	blue, red, green, cyan, magenta, yellow, and those close to them. Also
		157	pure black and pure white colours essentially mean no tinting; resource
140	I<tintColor>. Example:	158	I<tintColor>. Example:
141		159
142	@@RXVT_NAME@@ -tr -tint blue -sh 40	160	@@RXVT_NAME@@ -tr -tint blue -sh 40
143		161
144	=item B<-sh>	162	=item B<-sh> I<number>
145		163
146	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	164	Darken (0 .. 100) or lighten (100 .. 200) the transparent
147	background image in addition to tinting it (i.e. B<-tint> must be	165	background image in addition to (or instead of) tinting it;
148	specified, too, e.g. C<-tint white>).	166	resource I<shading>.
		167
		168	=item B<-blt> I<string>
		169
		170	Specify background blending type. If background pixmap is specified
		171	at the same time as transparency - such pixmap will be blended over
		172	transparency image, using method specified. Supported values are :
		173	B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
		174	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
		175	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
		176	alpha-blending. Compile I<afterimage>; resource I<blendType>.
		177
		178	=item B<-blr> I<HxV>
		179
		180	Apply Gaussian Blur with the specified radii to the transparent
		181	background image. If single number is specified - both vertical and
		182	horizontal radii are considered to be the same. Setting one of the
		183	radii to 1 and another to a large number creates interesting effects
		184	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
		185	resource I<blurRadius>.
		186
		187	=item B<-icon> I<file>
		188
		189	Compile I<afterimage>: Use the specified image as application icon. This
		190	is used by many window managers, taskbars and pagers to represent the
		191	application window; resource I<iconFile>.
149		192
150	=item B<-bg> I<colour>	193	=item B<-bg> I<colour>
151		194
152	Window background colour; resource B<background>.	195	Window background colour; resource B<background>.
153		196
154	=item B<-fg> I<colour>	197	=item B<-fg> I<colour>
155		198
156	Window foreground colour; resource B<foreground>.	199	Window foreground colour; resource B<foreground>.
157		200
158	=item B<-pixmap> I<file[;geom]>	201	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
159		202
160	Compile I<XPM>: Specify XPM file for the background and also optionally	203	Compile I<afterimage>: Specify image file for the background and also
161	specify its scaling with a geometry string. Note you may need to	204	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	205	add quotes to avoid special shell interpretation of the C<;> in the
163	command-line; resource B<backgroundPixmap>.	206	command-line; for more details see resource B<backgroundPixmap>.
164		207
165	=item B<-cr> I<colour>	208	=item B<-cr> I<colour>
166		209
167	The cursor colour; resource B<cursorColor>.	210	The cursor colour; resource B<cursorColor>.
168		211
…		…
213	italic> >> characters are to be printed. See resource B<boldItalicFont>	256	italic> >> characters are to be printed. See resource B<boldItalicFont>
214	for details.	257	for details.
215		258
216	=item B<-is>\|B<+is>	259	=item B<-is>\|B<+is>
217		260
218	Compile I<font-styles>: Bold/Italic font styles imply high intensity	261	Compile I<font-styles>: Bold/Blink font styles imply high intensity
219	foreground/background (default). See resource B<intensityStyles> for	262	foreground/background (default). See resource B<intensityStyles> for
220	details.	263	details.
221		264
222	=item B<-name> I<name>	265	=item B<-name> I<name>
223		266
…		…
241		284
242	=item B<-sb>\|B<+sb>	285	=item B<-sb>\|B<+sb>
243		286
244	Turn on/off scrollbar; resource B<scrollBar>.	287	Turn on/off scrollbar; resource B<scrollBar>.
245		288
		289	=item B<-sr>\|B<+sr>
		290
		291	Put scrollbar on right/left; resource B<scrollBar_right>.
		292
		293	=item B<-st>\|B<+st>
		294
		295	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		296	resource B<scrollBar_floating>.
		297
246	=item B<-si>\|B<+si>	298	=item B<-si>\|B<+si>
247		299
248	Turn on/off scroll-to-bottom on TTY output inhibit; resource	300	Turn on/off scroll-to-bottom on TTY output inhibit; resource
249	B<scrollTtyOutput> has opposite effect.	301	B<scrollTtyOutput> has opposite effect.
250		302
…		…
256	=item B<-sw>\|B<+sw>	308	=item B<-sw>\|B<+sw>
257		309
258	Turn on/off scrolling with the scrollback buffer as new lines appear.	310	Turn on/off scrolling with the scrollback buffer as new lines appear.
259	This only takes effect if B<-si> is also given; resource	311	This only takes effect if B<-si> is also given; resource
260	B<scrollWithBuffer>.	312	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		313
271	=item B<-ptab>\|B<+ptab>	314	=item B<-ptab>\|B<+ptab>
272		315
273	If enabled (default), "Horizontal Tab" characters are being stored as	316	If enabled (default), "Horizontal Tab" characters are being stored as
274	actual wide characters in the screen buffer, which makes it possible to	317	actual wide characters in the screen buffer, which makes it possible to
…		…
278		321
279	=item B<-bc>\|B<+bc>	322	=item B<-bc>\|B<+bc>
280		323
281	Blink the cursor; resource B<cursorBlink>.	324	Blink the cursor; resource B<cursorBlink>.
282		325
		326	=item B<-uc>\|B<+uc>
		327
		328	Make the cursor underlined; resource B<cursorUnderline>.
		329
283	=item B<-iconic>	330	=item B<-iconic>
284		331
285	Start iconified, if the window manager supports that option.	332	Start iconified, if the window manager supports that option.
286	Alternative form is B<-ic>.	333	Alternative form is B<-ic>.
287		334
…		…
303		350
304	=item B<-bl>	351	=item B<-bl>
305		352
306	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	353	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	354	if honoured by the WM, the rxvt-unicode window will not have window
308	decorations; resource B<borderLess>.	355	decorations; resource B<borderLess>. If the window manager does not
		356	support MWM hints (e.g. kwin), enables override-redirect mode.
309		357
310	=item B<-override-redirect>	358	=item B<-override-redirect>
311		359
312	Compile I<frills>: Sets override-redirect on the window; resource	360	Compile I<frills>: Sets override-redirect on the window; resource
313	B<override-redirect>.	361	B<override-redirect>.
…		…
321		369
322	=item B<-lsp> I<number>	370	=item B<-lsp> I<number>
323		371
324	Compile I<frills>: Lines (pixel height) to insert between each row of	372	Compile I<frills>: Lines (pixel height) to insert between each row of
325	the display. Useful to work around font rendering problems; resource	373	the display. Useful to work around font rendering problems; resource
326	B<linespace>.	374	B<lineSpace>.
		375
		376	=item B<-letsp> I<number>
		377
		378	Compile I<frills>: Amount to adjust the computed character width by
		379	to control overall letter spacing. Negative values will tighten up the
		380	letter spacing, positive values will space letters out more. Useful to
		381	work around odd font metrics; resource B<letterSpace>.
327		382
328	=item B<-tn> I<termname>	383	=item B<-tn> I<termname>
329		384
330	This option specifies the name of the terminal type to be set in the	385	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	386	B<TERM> environment variable. This terminal type must exist in the
…		…
385	for more info.	440	for more info.
386		441
387	=item B<-tcw>	442	=item B<-tcw>
388		443
389	Change the meaning of triple-click selection with the left mouse	444	Change the meaning of triple-click selection with the left mouse
		445	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	446	in-use. Instead of selecting a full line it will extend the selection to
391	end of the logical line only. resource B<tripleclickwords>.	447	the end of the logical line only. resource B<tripleclickwords>.
392		448
393	=item B<-insecure>	449	=item B<-insecure>
394		450
395	Enable "insecure" mode, which currently enables most of the escape	451	Enable "insecure" mode, which currently enables most of the escape
396	sequences that echo strings. See the resource B<insecure> for more	452	sequences that echo strings. See the resource B<insecure> for more
…		…
417	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	473	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
418	will not immediately destroy its window when the program executed within	474	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	475	it exits. Instead, it will wait till it is being killed or closed by the
420	user; resource B<hold>.	476	user; resource B<hold>.
421		477
		478	=item B<-cd> I<path>
		479
		480	Sets the working directory for the shell (or the command specified via
		481	B<-e>). The I<path> must be an absolute path and it must exist for
		482	@@RXVT_NAME@@ to start; resource B<chdir>.
		483
		484	=item B<-xrm> I<string>
		485
		486	Works like the X Toolkit option of the same name, by adding the I<string>
		487	as if it were specified in a resource file. Resource values specified this
		488	way take precedence over all other resource specifications.
		489
		490	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		491	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		492	options can be specified as long-options on the commandline, so use
		493	of B<-xrm> is mostly limited to cases where you want to specify other
		494	resources (e.g. for input methods) or for compatibility with other
		495	programs.
		496
422	=item B<-keysym.>I<sym> I<string>	497	=item B<-keysym.>I<sym> I<string>
423		498
424	Remap a key symbol. See resource B<keysym>.	499	Remap a key symbol. See resource B<keysym>.
425		500
426	=item B<-embed> I<windowid>	501	=item B<-embed> I<windowid>
…		…
436	The window will not be destroyed when @@RXVT_NAME@@ exits.	511	The window will not be destroyed when @@RXVT_NAME@@ exits.
437		512
438	It might be useful to know that @@RXVT_NAME@@ will not close file	513	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	514	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	515	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	516	terminal. This works regardless of whether the C<-embed> option was used or
442	not.	517	not.
443		518
444	Here is a short Gtk2-perl snippet that illustrates how this option can be	519	Here is a short Gtk2-perl snippet that illustrates how this option can be
445	used (a longer example is in F<doc/embed>):	520	used (a longer example is in F<doc/embed>):
446		521
…		…
451	});	526	});
452		527
453	=item B<-pty-fd> I<file descriptor>	528	=item B<-pty-fd> I<file descriptor>
454		529
455	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	530	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	531	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	532	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
458	without having to run a program within it.	533	without having to run a program within it.
459		534
460	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	535	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	536	entries and will not tinker with pty/tty permissions - you have to do that
462	yourself if you want that.	537	yourself if you want that.
463		538
464	As an extremely special case, specifying C<-1> will completely suppress	539	As an extremely special case, specifying C<-1> will completely suppress
465	pty/tty operations.	540	pty/tty operations, which is probably only useful in conjunction with some
		541	perl extension that manages the terminal.
466		542
467	Here is a example in perl that illustrates how this option can be used (a	543	Here is a example in perl that illustrates how this option can be used (a
468	longer example is in F<doc/pty-fd>):	544	longer example is in F<doc/pty-fd>):
469		545
470	use IO::Pty;	546	use IO::Pty;
…		…
484	Comma-separated list of perl extension scripts to use (or not to use) in	560	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.	561	this terminal instance. See resource B<perl-ext> for details.
486		562
487	=back	563	=back
488		564
489	=head1 RESOURCES (available also as long-options)	565	=head1 RESOURCES
490		566
491	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	567	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
492	options) compiled into your version.	568	options) compiled into your version. All resources are also available as
		569	long-options.
493		570
494	You can set and change the resources using X11 tools like B<xrdb>. Many	571	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	572	distribution do also load settings from the B<~/.Xresources> file when X
496	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	573	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
497	with later settings overwriting earlier ones:	574	with later settings overwriting earlier ones:
…		…
499	1. system-wide app-defaults file, either locale-dependent OR global	576	1. system-wide app-defaults file, either locale-dependent OR global
500	2. app-defaults file in $XAPPLRESDIR	577	2. app-defaults file in $XAPPLRESDIR
501	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	578	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
502	4. SCREEN_RESOURCES for the current screen	579	4. SCREEN_RESOURCES for the current screen
503	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	580	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		581	6. resources specified via -xrm on the commandline
504		582
505	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	583	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	584	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	585	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	586	configured, while the class name B<URxvt> allows resources unique to
…		…
518	=item B<depth:> I<bitdepth>	596	=item B<depth:> I<bitdepth>
519		597
520	Compile I<xft>: Attempt to find a visual with the given bit depth;	598	Compile I<xft>: Attempt to find a visual with the given bit depth;
521	option B<-depth>.	599	option B<-depth>.
522		600
		601	=item B<buffered:> I<boolean>
		602
		603	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		604	On some card/driver combination enabling it slightly decreases
		605	performance, on most it greatly helps it. The slowdown is small, so it
		606	should normally be enabled.
		607
523	=item B<geometry:> I<geom>	608	=item B<geometry:> I<geom>
524		609
525	Create the window with the specified X window geometry [default 80x24];	610	Create the window with the specified X window geometry [default 80x24];
526	option B<-geometry>.	611	option B<-geometry>.
527		612
…		…
540	Use the specified colour for the colour value I<n>, where 0-7	625	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	626	corresponds to low-intensity (normal) colours and 8-15 corresponds to
542	high-intensity (bold = bright foreground, blink = bright background)	627	high-intensity (bold = bright foreground, blink = bright background)
543	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	628	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	629	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.	630	names used are listed in the B<COLOURS AND GRAPHICS> section.
546		631
547	Colours higher than 15 cannot be set using resources (yet), but can be	632	Colours higher than 15 cannot be set using resources (yet), but can be
548	changed using an escape command (see @@RXVT_NAME@@(7)).	633	changed using an escape command (see @@RXVT_NAME@@(7)).
549		634
550	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	635	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
561	=item B<colorUL:> I<colour>	646	=item B<colorUL:> I<colour>
562		647
563	Use the specified colour to display underlined characters when the	648	Use the specified colour to display underlined characters when the
564	foreground colour is the default.	649	foreground colour is the default.
565		650
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>	651	=item B<underlineColor:> I<colour>
572		652
573	If set, use the specified colour as the colour for the underline	653	If set, use the specified colour as the colour for the underline
574	itself. If unset, use the foreground colour.	654	itself. If unset, use the foreground colour.
		655
		656	=item B<highlightColor:> I<colour>
		657
		658	If set, use the specified colour as the background for highlighted
		659	characters. If unset, use reverse video.
		660
		661	=item B<highlightTextColor:> I<colour>
		662
		663	If set and highlightColor is set, use the specified colour as the
		664	foreground for highlighted characters.
575		665
576	=item B<cursorColor:> I<colour>	666	=item B<cursorColor:> I<colour>
577		667
578	Use the specified colour for the cursor. The default is to use the	668	Use the specified colour for the cursor. The default is to use the
579	foreground colour; option B<-cr>.	669	foreground colour; option B<-cr>.
…		…
586		676
587	=item B<reverseVideo:> I<boolean>	677	=item B<reverseVideo:> I<boolean>
588		678
589	B<True>: simulate reverse video by foreground and background colours;	679	B<True>: simulate reverse video by foreground and background colours;
590	option B<-rv>. B<False>: regular screen colours [default]; option	680	option B<-rv>. B<False>: regular screen colours [default]; option
591	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	681	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
592		682
593	=item B<jumpScroll:> I<boolean>	683	=item B<jumpScroll:> I<boolean>
594		684
595	B<True>: specify that jump scrolling should be used. When scrolling	685	B<True>: specify that jump scrolling should be used. When receiving lots
596	quickly, fewer screen updates are performed [default]; option B<-j>.	686	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		687	has been read, resulting in fewer updates while still displaying every
		688	received line; option B<-j>.
		689
597	B<False>: specify that smooth scrolling should be used; option B<+j>.	690	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		691	force a screen refresh on each new line it received; option B<+j>.
598		692
599	=item B<inheritPixmap:> I<boolean>	693	=item B<skipScroll:> I<boolean>
600		694
601	B<True>: make the background inherit the parent windows' pixmap, giving	695	B<True>: (the default) specify that skip scrolling should be used. When
602	artificial transparency. B<False>: do not inherit the parent windows'	696	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
603	pixmap.	697	(around 60 times per second), resulting in far fewer updates. This can
		698	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		699	option B<-ss>.
604		700
605	I<Please note that transparency of any kind if completely unsupported by	701	B<False>: specify that everything is to be displayed, even
606	the author. Don't bug him with installation questions!>	702	if the refresh is too fast for the human eye to read anything (or the
		703	monitor to display anything); option B<+ss>.
		704
		705	=item B<transparent:> I<boolean>
		706
		707	Turn on/off illusion of a transparent window background.
		708
		709	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
		710	future versions.
		711
		712	I<Please address all transparency related issues to Sasha Vasko at
		713	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
607		714
608	=item B<fading:> I<number>	715	=item B<fading:> I<number>
609		716
610	Fade the text by the given percentage when focus is lost; option B<-fade>.	717	Fade the text by the given percentage when focus is lost; option B<-fade>.
611		718
…		…
619	Tint the transparent background pixmap with the given colour; option	726	Tint the transparent background pixmap with the given colour; option
620	B<-tint>.	727	B<-tint>.
621		728
622	=item B<shading:> I<number>	729	=item B<shading:> I<number>
623		730
624	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	731	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
625	image in addition to tinting it.	732	in addition to tinting it; option B<-sh>.
		733
		734	=item B<blendType:> I<string>
		735
		736	Specify background blending type; option B<-blt>.
		737
		738	=item B<blurRadius:> I<number>
		739
		740	Apply gaussian blur with the specified radius to the transparent
		741	background image; option B<-blr>.
		742
		743	=item B<iconFile:> I<file>
		744
		745	Set the application icon pixmap; option B<-icon>.
626		746
627	=item B<scrollColor:> I<colour>	747	=item B<scrollColor:> I<colour>
628		748
629	Use the specified colour for the scrollbar [default #B2B2B2].	749	Use the specified colour for the scrollbar [default #B2B2B2].
630		750
…		…
636	=item B<borderColor:> I<colour>	756	=item B<borderColor:> I<colour>
637		757
638	The colour of the border around the text area and between the scrollbar	758	The colour of the border around the text area and between the scrollbar
639	and the text.	759	and the text.
640		760
641	=item B<backgroundPixmap:> I<file[;geom]>	761	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
642		762
643	Use the specified XPM file (note the `.xpm' extension is optional) for	763	Use the specified image file for the background and also
644	the background and also optionally specify its scaling with a geometry	764	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	765	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
646	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	766	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	767	centre (percent). A scale of 0 displays the image with tiling. A scale
648	of 1 displays the image without any scaling. A scale of 2 to 9	768	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
649	specifies an integer number of images in that direction. No image will	769	an integer number of images in that direction. No image will be magnified
650	be magnified beyond 10 times its original size. The maximum permitted	770	beyond 10 times its original size. The maximum permitted scale is 1000.
651	scale is 1000. [default 0x0+50+50]	771	Additional operations can be specified after colon B<:op1:op2...>.
		772	Supported operations are:
		773
		774	tile force background image to be tiled and not scaled. Equivalent to 0x0
		775	propscale will scale image keeping proportions
		776	auto will scale image to match window size. Equivalent to 100x100
		777	hscale will scale image horizontally to the window size
		778	vscale will scale image vertically to the window size
		779	scale will scale image to match window size
		780	root will tile image as if it was a root window background, auto-adjusting
		781	whenever terminal window moves
		782
		783	If used in conjunction with B<-tr> option, the specified pixmap will be
		784	blended over transparency image using either alpha-blending, or any
		785	other blending type, specified with B<-blt "type"> option.
652		786
653	=item B<path:> I<path>	787	=item B<path:> I<path>
654		788
655	Specify the colon-delimited search path for finding XPM files.	789	Specify the colon-delimited search path for finding background image files.
656		790
657	=item B<font:> I<fontlist>	791	=item B<font:> I<fontlist>
658		792
659	Select the fonts to be used. This is a comma separated list of font names	793	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	794	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	817	it is named first) and thus defines the character cell grid to be 9 pixels
684	wide and 15 pixels high.	818	wide and 15 pixels high.
685		819
686	The second font is just used to add additional unicode characters not in	820	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	821	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	822	the bold version of the font does contain fewer characters, so this is a
689	useful supplement.	823	useful supplement.
690		824
691	The third font is an Xft font with aliasing turned off, and the characters	825	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	826	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.	827	contains other characters, but we are not interested in them.
…		…
717	text font will being used for the given style.	851	text font will being used for the given style.
718		852
719	=item B<intensityStyles:> I<boolean>	853	=item B<intensityStyles:> I<boolean>
720		854
721	When font styles are not enabled, or this option is enabled (B<True>,	855	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	856	option B<-is>, the default), bold/blink font styles imply high
723	intensity foreground/backround colours. Disabling this option (B<False>,	857	intensity foreground/background colours. Disabling this option (B<False>,
724	option B<+is>) disables this behaviour, the high intensity colours are not	858	option B<+is>) disables this behaviour, the high intensity colours are not
725	reachable.	859	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		860
738	=item B<title:> I<string>	861	=item B<title:> I<string>
739		862
740	Set window title string, the default title is the command-line	863	Set window title string, the default title is the command-line
741	specified after the B<-e> option, if any, otherwise the application	864	specified after the B<-e> option, if any, otherwise the application
…		…
750	=item B<mapAlert:> I<boolean>	873	=item B<mapAlert:> I<boolean>
751		874
752	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	875	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].	876	de-iconify (map) on receipt of a bell character [default].
754		877
		878	=item B<urgentOnBell:> I<boolean>
		879
		880	B<True>: set the urgency hint for the wm on receipt of a bell character.
		881	B<False>: do not set the urgency hint [default].
		882
		883	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		884
755	=item B<visualBell:> I<boolean>	885	=item B<visualBell:> I<boolean>
756		886
757	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	887	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
758	B<False>: no visual bell [default]; option B<+vb>.	888	B<False>: no visual bell [default]; option B<+vb>.
759		889
…		…
780	Example:	910	Example:
781		911
782	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	912	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
783		913
784	This creates a new file in your home directory with the screen contents	914	This creates a new file in your home directory with the screen contents
785	everytime you hit C<Print>.	915	every time you hit C<Print>.
		916
		917	=item B<scrollstyle:> I<mode>
		918
		919	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		920	the author's favourite.
786		921
787	=item B<scrollBar:> I<boolean>	922	=item B<scrollBar:> I<boolean>
788		923
789	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	924	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
790	disable the scrollbar; option B<+sb>.	925	disable the scrollbar; option B<+sb>.
…		…
812		947
813	=item B<scrollWithBuffer:> I<boolean>	948	=item B<scrollWithBuffer:> I<boolean>
814		949
815	B<True>: scroll with scrollback buffer when tty receives new lines (and	950	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	951	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
817	with scrollback buffer when tty recieves new lines; option B<+sw>.	952	with scrollback buffer when tty receives new lines; option B<+sw>.
818		953
819	=item B<scrollTtyKeypress:> I<boolean>	954	=item B<scrollTtyKeypress:> I<boolean>
820		955
821	B<True>: scroll to bottom when a non-special key is pressed. Special keys	956	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	957	are those which are intercepted by rxvt-unicode for special handling and
…		…
853	=item B<termName:> I<termname>	988	=item B<termName:> I<termname>
854		989
855	Specifies the terminal type name to be set in the B<TERM> environment	990	Specifies the terminal type name to be set in the B<TERM> environment
856	variable; option B<-tn>.	991	variable; option B<-tn>.
857		992
858	=item B<linespace:> I<number>	993	=item B<lineSpace:> I<number>
859		994
860	Specifies number of lines (pixel height) to insert between each row of	995	Specifies number of lines (pixel height) to insert between each row of
861	the display [default 0]; option B<-lsp>.	996	the display [default 0]; option B<-lsp>.
862		997
863	=item B<meta8:> I<boolean>	998	=item B<meta8:> I<boolean>
…		…
877		1012
878	=item B<cursorBlink:> I<boolean>	1013	=item B<cursorBlink:> I<boolean>
879		1014
880	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1015	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
881	option B<-bc>.	1016	option B<-bc>.
		1017
		1018	=item B<cursorUnderline:> I<boolean>
		1019
		1020	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1021	option B<-uc>.
882		1022
883	=item B<pointerBlank:> I<boolean>	1023	=item B<pointerBlank:> I<boolean>
884		1024
885	B<True>: blank the pointer when a key is pressed or after a set number	1025	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	1026	of seconds of inactivity. B<False>: the pointer is always visible
…		…
900	large number (e.g. C<987654321>) to effectively disable the timeout.	1040	large number (e.g. C<987654321>) to effectively disable the timeout.
901		1041
902	=item B<backspacekey:> I<string>	1042	=item B<backspacekey:> I<string>
903		1043
904	The string to send when the backspace key is pressed. If set to B<DEC>	1044	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>	1045	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	1046	(code 8) - which can be reversed with the appropriate DEC private mode
907	escape sequence.	1047	escape sequence.
908		1048
909	=item B<deletekey:> I<string>	1049	=item B<deletekey:> I<string>
910		1050
…		…
915	=item B<cutchars:> I<string>	1055	=item B<cutchars:> I<string>
916		1056
917	The characters used as delimiters for double-click word selection	1057	The characters used as delimiters for double-click word selection
918	(whitespace delimiting is added automatically if resource is given).	1058	(whitespace delimiting is added automatically if resource is given).
919		1059
920	When the selection extension is in use (the default if compiled in, see	1060	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	1061	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	1062	characters will be created (if the resource exists, otherwise, no regex
923	created). In this mode, characters outside ISO-8859-1 can be used.	1063	will be created). In this mode, characters outside ISO-8859-1 can be used.
924		1064
925	When the selection extension is not used, only ISO-8859-1 characters can	1065	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:	1066	be used. If not specified, the built-in default is used:
927		1067
928	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1068	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
929		1069
930	=item B<preeditType:> I<style>	1070	=item B<preeditType:> I<style>
931		1071
932	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1072	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
933		1073
…		…
987		1127
988	Turn on/off secondary screen (default enabled).	1128	Turn on/off secondary screen (default enabled).
989		1129
990	=item B<secondaryScroll:> I<boolean>	1130	=item B<secondaryScroll:> I<boolean>
991		1131
992	Turn on/off secondary screen scroll (default enabled). If the this	1132	Turn on/off secondary screen scroll (default enabled). If this
993	option is enabled, scrolls on the secondary screen will change the	1133	option is enabled, scrolls on the secondary screen will change the
994	scrollback buffer and switching to/from the secondary screen will	1134	scrollback buffer and, when secondaryScreen is off, switching
995	instead scroll the screen up.	1135	to/from the secondary screen will instead scroll the screen up.
996		1136
997	=item B<hold>: I<boolean>	1137	=item B<hold>: I<boolean>
998		1138
999	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1139	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1000	will not immediately destroy its window when the program executed within	1140	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	1141	it exits. Instead, it will wait till it is being killed or closed by the
1002	user.	1142	user.
		1143
		1144	=item B<chdir>: I<path>
		1145
		1146	Sets the working directory for the shell (or the command specified via
		1147	B<-e>). The I<path> must be an absolute path and it must exist for
		1148	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1149	directory will be used; option B<-cd>.
1003		1150
1004	=item B<keysym.>I<sym>: I<string>	1151	=item B<keysym.>I<sym>: I<string>
1005		1152
1006	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1153	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1007	intervening resource name B<keysym.> cannot be omitted.	1154	intervening resource name B<keysym.> cannot be omitted.
…		…
1021	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1168	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	1169	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	1170	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.	1171	performed in an exact manner; however, the closest match is assured.
1025		1172
1026	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1173	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,	1174	number), see RESOURCES in C<man 7 X> for futher 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		1175
1037	You can define a range of keysyms in one shot by providing a I<string>	1176	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 `/'	1177	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1039	should be a character not used by the strings.	1178	should be a character not used by the strings.
1040		1179
1041	Its usage can be demonstrated by an example:	1180	Its usage can be demonstrated by an example:
1042		1181
1043	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1182	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
…		…
1054	when Control-Meta-c is being pressed":	1193	when Control-Meta-c is being pressed":
1055		1194
1056	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1195	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1057		1196
1058	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1197	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)	1198	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	1199	manpage. For example, the F<selection> extension (activated via
1061	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1200	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1062		1201
1063	URxvt.keysym.M-C-c: perl:selection:rot13	1202	URxvt.keysym.M-C-c: perl:selection:rot13
1064		1203
…		…
1107	example, C<default,-selection> will use all the default extension except	1246	example, C<default,-selection> will use all the default extension except
1108	C<selection>.	1247	C<selection>.
1109		1248
1110	Extension names can also be followed by an argument in angle brackets	1249	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	1250	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1112	searchable scorllback to Alt/Meta-s). Mentioning the same extension	1251	searchable scrollback to Alt/Meta-s). Mentioning the same extension
1113	multiple times with different arguments will pass multiple arguments to	1252	multiple times with different arguments will pass multiple arguments to
1114	the extension.	1253	the extension.
1115		1254
1116	Each extension is looked up in the library directories, loaded if	1255	Each extension is looked up in the library directories, loaded if
1117	necessary, and bound to the current terminal instance.	1256	necessary, and bound to the current terminal instance.
…		…
1122	all instances, while B<perl-ext> is used for specific instances.	1261	all instances, while B<perl-ext> is used for specific instances.
1123		1262
1124	=item B<perl-eval>: I<string>	1263	=item B<perl-eval>: I<string>
1125		1264
1126	Perl code to be evaluated when all extensions have been registered. See	1265	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	1266	the @@RXVT_NAME@@perl(3) manpage.
1128	will be ignored when running setuid/setgid.
1129		1267
1130	=item B<perl-lib>: I<path>	1268	=item B<perl-lib>: I<path>
1131		1269
1132	Colon-separated list of additional directories that hold extension	1270	Colon-separated list of additional directories that hold extension
1133	scripts. When looking for extensions specified by the C<perl> resource,	1271	scripts. When looking for extensions specified by the C<perl> resource,
1134	@@RXVT_NAME@@ will first look in these directories and then in	1272	@@RXVT_NAME@@ will first look in these directories and then in
1135	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1273	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1136	will be ignored when running setuid/setgid.
1137		1274
1138	See the @@RXVT_NAME@@perl(3) manpage.	1275	See the @@RXVT_NAME@@perl(3) manpage.
1139		1276
1140	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1277	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1141		1278
…		…
1153	(default: C<M-s>).	1290	(default: C<M-s>).
1154		1291
1155	=item B<urlLauncher>: I<string>	1292	=item B<urlLauncher>: I<string>
1156		1293
1157	Specifies the program to be started with a URL argument. Used by the	1294	Specifies the program to be started with a URL argument. Used by the
1158	C<selection-popup> and C<mark-urls> perl extensions.	1295	C<selection-popup> and C<matcher> perl extensions.
1159		1296
1160	=item B<transient-for>: I<windowid>	1297	=item B<transient-for>: I<windowid>
1161		1298
1162	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.	1299	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1163		1300
1164	=item B<override-redirect>: I<boolean>	1301	=item B<override-redirect>: I<boolean>
1165		1302
1166	Compile I<frills>: Sets override-redirect for the terminal window, making	1303	Compile I<frills>: Sets override-redirect for the terminal window, making
1167	it almost invisible to window managers; option B<-override-redirect>.	1304	it almost invisible to window managers; option B<-override-redirect>.
		1305
		1306	=item B<iso14755:> I<boolean>
		1307
		1308	Turn on/off ISO 14755 (default enabled).
		1309
		1310	=item B<iso14755_52:> I<boolean>
		1311
		1312	Turn on/off ISO 14755 5.2 mode (default enabled).
1168		1313
1169	=back	1314	=back
1170		1315
1171	=head1 THE SCROLLBAR	1316	=head1 THE SCROLLBAR
1172		1317
…		…
1191	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1336	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1192	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1337	(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),	1338	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1194	respectively.	1339	respectively.
1195		1340
1196	=head1 TEXT SELECTION AND INSERTION	1341	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1197		1342
1198	The behaviour of text selection and insertion mechanism is similar to	1343	The behaviour of text selection and insertion/pasting mechanism is similar
1199	I<xterm>(1).	1344	to I<xterm>(1).
1200		1345
1201	=over 4	1346	=over 4
1202		1347
1203	=item B<Selection>:	1348	=item B<Selecting>:
1204		1349
1205	Left click at the beginning of the region, drag to the end of the region	1350	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	1351	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	1352	to select a word; Left triple-click to select the entire logical line
1208	(which can span multiple screen lines), unless modified by resource	1353	(which can span multiple screen lines), unless modified by resource
…		…
1212	(Compile: I<frills>) will create a rectangular selection instead of a	1357	(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	1358	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	1359	selection, and trailing whitespace is visually underlined and removed from
1215	the selection.	1360	the selection.
1216		1361
1217	=item B<Insertion>:	1362	=item B<Pasting>:
1218		1363
1219	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>	1364	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	1365	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.	1366	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1222		1367
1223	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1368	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1224	inserted too.	1369	inserted too.
1225		1370
1226	=back	1371	=back
…		…
1243		1388
1244	=head1 ISO 14755 SUPPORT	1389	=head1 ISO 14755 SUPPORT
1245		1390
1246	ISO 14755 is a standard for entering and viewing unicode characters	1391	ISO 14755 is a standard for entering and viewing unicode characters
1247	and character codes using the keyboard. It consists of 4 parts. The	1392	and character codes using the keyboard. It consists of 4 parts. The
1248	first part is available rxvt-unicode has been compiled with	1393	first part is available if rxvt-unicode has been compiled with
1249	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1394	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1250	with C<--enable-iso14755>.	1395	with C<--enable-iso14755>.
1251		1396
1252	=over 4	1397	=over 4
1253		1398
…		…
1311	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1456	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	1457	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	1458	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.	1459	on some systems or setgid to root or to some other group on others.
1315		1460
1316	=head1 COLORS AND GRAPHICS	1461	=head1 COLOURS AND GRAPHICS
1317		1462
1318	In addition to the default foreground and background colours,	1463	In addition to the default foreground and background colours,
1319	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1464	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	1465	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1321	colours with their names.	1466	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1467	cube plus a 8 (24) colour greyscale ramp.
		1468
		1469	Here is a list of the ANSI colours with their names.
1322		1470
1323	=begin table	1471	=begin table
1324		1472
1325	B<color0> (black) = Black	1473	B<color0> (black) = Black
1326	B<color1> (red) = Red3	1474	B<color1> (red) = Red3
…		…
1346	It is also possible to specify the colour values of B<foreground>,	1494	It is also possible to specify the colour values of B<foreground>,
1347	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1495	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	1496	a number 0-15, as a convenient shorthand to reference the colour name of
1349	color0-color15.	1497	color0-color15.
1350		1498
1351	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1499	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)	1500	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		1501
		1502	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1503
		1504	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1505	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1506
		1507	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1508	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1509	the RGB cube.
		1510
1356	Together, all those colours implement the 88 colour xterm colours. Only	1511	Together, all those colours implement the 88 (256) colour xterm
1357	the first 16 can be changed using resources currently, the rest can only	1512	colours. Only the first 16 can be changed using resources currently, the
1358	be changed via command sequences ("escape codes").	1513	rest can only be changed via command sequences ("escape codes").
		1514
		1515	Applications are advised to use terminfo or command sequences to discover
		1516	number and RGB values of all colours (yes, you can query this...).
1359		1517
1360	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1518	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1361	always swapping the foreground/background colours. This is in contrast to	1519	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	1520	I<xterm>(1) where the colours are only swapped if they have not otherwise
1363	been specified. For example,	1521	been specified. For example,
1364		1522
		1523	@@RXVT_NAME@@ -fg Black -bg White -rv
		1524
		1525	would yield White on Black, while on I<xterm>(1) it would yield Black on
		1526	White.
		1527
		1528	=head2 ALPHA CHANNEL SUPPORT
		1529
		1530	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1531	their act together, rxvt-unicode will do it's own alpha channel management:
		1532
		1533	You can prefix any colour with an opaquenes percentage enclosed in
		1534	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1535	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1536	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1537	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1538	is the recommended format to specify transparency values, and works with
		1539	all ways to specify a colour.
		1540
		1541	For complete control, rxvt-unicode also supports
		1542	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1543	specifications, where the additional C<aaaa> component specifies opacity
		1544	(alpha) values. The minimum value of C<0000> is completely transparent,
		1545	while C<ffff> is completely opaque). The two example colours from
		1546	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1547	C<rgba:0000/ff00/0000/f332>.
		1548
		1549	You probably need to specify B<"-depth 32">, too, to force a visual with
		1550	alpha channels, and have the luck that your X-server uses ARGB pixel
		1551	layout, as X is far from just supporting ARGB visuals out of the box, and
		1552	rxvt-unicode just fudges around.
		1553
		1554	For example, the following selects an almost completely transparent black
		1555	background, and an almost opaque pink foreground:
		1556
		1557	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
		1558
		1559	When not using a background image, then the interpretation of the
		1560	alpha channel is up to your compositing manager (most interpret it as
		1561	transparency of course).
		1562
		1563	When using a background pixmap or pseudo-transparency, then the background
		1564	colour will always behave as if it were completely transparent (so the
		1565	background image shows instead), regardless of how it was specified, while
		1566	other colours will either be transparent as specified (the background
		1567	image will show through) on servers supporting the RENDER extension, or
		1568	fully opaque on servers not supporting the RENDER EXTENSION.
		1569
		1570	Please note that due to bugs in Xft, specifying alpha values might result
		1571	in garbage being displayed when the X-server does not support the RENDER
		1572	extension.
		1573
		1574	=head1 ENVIRONMENT
		1575
		1576	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
		1577
1365	=over 4	1578	=over 4
1366		1579
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>	1580	=item B<TERM>
1403		1581
1404	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1582	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1405	resources or on the commandline.	1583	resources or on the command line.
1406		1584
1407	=item B<COLORTERM>	1585	=item B<COLORTERM>
1408		1586
1409	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1587	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1410	compiled with XPM support, and optionally with the added extension	1588	compiled with background image support, and optionally with the added
1411	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1589	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1590	screen.
1412		1591
1413	=item B<COLORFGBG>	1592	=item B<COLORFGBG>
1414		1593
1415	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1594	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	1595	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	1596	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	1597	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@@	1598	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	1599	was compiled with background image support. Libraries like C<ncurses>
1421	(and do) use this information to optimize screen output.	1600	and C<slang> can (and do) use this information to optimize screen output.
1422		1601
1423	=item B<WINDOWID>	1602	=item B<WINDOWID>
1424		1603
1425	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1604	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	1605	window, which usually has subwindows for the scrollbar, the terminal
…		…
1432	C<--with-terminfo=PATH>.	1611	C<--with-terminfo=PATH>.
1433		1612
1434	=item B<DISPLAY>	1613	=item B<DISPLAY>
1435		1614
1436	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1615	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1437	display in its child processes.	1616	display in its child processes if C<-display> isn't used to override. It
		1617	defaults to C<:0> if it doesn't exist.
1438		1618
1439	=item B<SHELL>	1619	=item B<SHELL>
1440		1620
1441	The shell to be used for command execution, defaults to C</bin/sh>.	1621	The shell to be used for command execution, defaults to C</bin/sh>.
1442		1622
…		…
1468		1648
1469	=over 4	1649	=over 4
1470		1650
1471	=item B</usr/lib/X11/rgb.txt>	1651	=item B</usr/lib/X11/rgb.txt>
1472		1652
1473	Color names.	1653	Colour names.
1474		1654
1475	=back	1655	=back
1476		1656
1477	=head1 SEE ALSO	1657	=head1 SEE ALSO
1478		1658
…		…
1517	Project Coordinator (changes.txt 2.21a to 2.4.5)	1697	Project Coordinator (changes.txt 2.21a to 2.4.5)
1518		1698
1519	=item Geoff Wing L<< <gcw@pobox.com> >>	1699	=item Geoff Wing L<< <gcw@pobox.com> >>
1520		1700
1521	Rewrote screen display and text selection routines.	1701	Rewrote screen display and text selection routines.
1522		1702
1523	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1703	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1524		1704
1525	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1705	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1526		1706
1527	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1707	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.114 by root, Thu Jul 6 19:43:21 2006 UTC vs. Revision 1.180 by root, Tue Jun 15 11:45:48 2010 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.114 by root, Thu Jul 6 19:43:21 2006 UTC vs.
Revision 1.180 by root, Tue Jun 15 11:45:48 2010 UTC