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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.88 by root, Sun Jan 8 00:20:12 2006 UTC vs.
Revision 1.164 by root, Sun Jun 15 13:54:15 2008 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
46	display characters: The idea of a single unicode font which many other	49	display characters: The idea of a single unicode font which many other
47	programs force onto it's users never made sense to me: You should be able	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	it's 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 it's 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
58	a client/daemon pair that lets you open any number of terminal windows	61	a client/daemon pair that lets you open any number of terminal windows
59	from within a single process, which makes startup time very fast and	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.
		100
		101	=item B<-depth> I<bitdepth>
		102
		103	Compile I<xft>: Attempt to find a visual with the given bit depth;
		104	resource B<depth>.
		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]
97		110
98	=item B<-geometry> I<geom>	111	=item B<-geometry> I<geom>
99		112
100	Window geometry (B<-g> still respected); resource B<geometry>.	113	Window geometry (B<-g> still respected); resource B<geometry>.
101		114
…		…
103		116
104	Turn on/off simulated reverse video; resource B<reverseVideo>.	117	Turn on/off simulated reverse video; resource B<reverseVideo>.
105		118
106	=item B<-j>\|B<+j>	119	=item B<-j>\|B<+j>
107		120
108	Turn on/off jump scrolling; resource B<jumpScroll>.	121	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
109		122
110	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>	123	=item B<-ss>\|B<+ss>
111		124
112	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>.
113	B<-tr>; resource B<inheritPixmap>.	126
		127	=item B<-tr>\|B<+tr>
		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@@)!>
114		136
115	=item B<-fade> I<number>	137	=item B<-fade> I<number>
116		138
117	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
118	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
119	colour; resource B<fading>.	141	colour; resource B<fading>.
120		142
121	=item B<-fadecolor> I<colour>	143	=item B<-fadecolor> I<colour>
122		144
123	Fade to this colour when fading is used (see B<-fade>). The default colour	145	Fade to this colour when fading is used (see B<-fade>). The default colour
124	is black. resource B<fadeColor>.	146	is opaque black. resource B<fadeColor>.
125		147
126	=item B<-tint> I<colour>	148	=item B<-tint> I<colour>
127		149
128	Tint the transparent background pixmap with the given colour when	150	Tint the transparent background pixmap with the given colour when
129	transparency is enabled with B<-tr> or B<-ip>. This only works for	151	transparency is enabled with B<-tr>. This only works for
130	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
131	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 colors essentially mean no tinting; resource
132	I<tintColor>. Example:	158	I<tintColor>. Example:
133		159
134	@@RXVT_NAME@@ -tr -tint blue -sh 40	160	@@RXVT_NAME@@ -tr -tint blue -sh 40
135		161
136	=item B<-sh>	162	=item B<-sh> I<number>
137		163
138	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	164	Darken (0 .. 100) or lighten (100 .. 200) the transparent
139	background image in addition to tinting it (i.e. B<-tint> must be	165	background image in addition to (or instead of) tinting it;
140	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> - color 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>.
141		186
142	=item B<-bg> I<colour>	187	=item B<-bg> I<colour>
143		188
144	Window background colour; resource B<background>.	189	Window background colour; resource B<background>.
145		190
146	=item B<-fg> I<colour>	191	=item B<-fg> I<colour>
147		192
148	Window foreground colour; resource B<foreground>.	193	Window foreground colour; resource B<foreground>.
149		194
150	=item B<-pixmap> I<file[;geom]>	195	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
151		196
152	Compile I<XPM>: Specify XPM file for the background and also optionally	197	Compile I<afterimage>: Specify image file for the background and also
153	specify its scaling with a geometry string. Note you may need to	198	optionally specify its scaling with a geometry string. Note you may need to
154	add quotes to avoid special shell interpretation of the C<;> in the	199	add quotes to avoid special shell interpretation of the C<;> in the
155	command-line; resource B<backgroundPixmap>.	200	command-line; for more details see resource B<backgroundPixmap>.
156		201
157	=item B<-cr> I<colour>	202	=item B<-cr> I<colour>
158		203
159	The cursor colour; resource B<cursorColor>.	204	The cursor colour; resource B<cursorColor>.
160		205
…		…
172	resource B<borderColor>.	217	resource B<borderColor>.
173		218
174	=item B<-fn> I<fontlist>	219	=item B<-fn> I<fontlist>
175		220
176	Select the fonts to be used. This is a comma separated list of font names	221	Select the fonts to be used. This is a comma separated list of font names
177	that are used in turn when trying to display Unicode characters. The	222	that are checked in order when trying to find glyphs for characters. The
178	first font defines the cell size for characters; other fonts might be	223	first font defines the cell size for characters; other fonts might be
179	smaller, but not (in general) larger. A (hopefully) reasonable default	224	smaller, but not (in general) larger. A (hopefully) reasonable default
180	font list is always appended to it. See resource B<font> for more details.	225	font list is always appended to it. See resource B<font> for more details.
181		226
182	In short, to specify an X11 core font, just specify it's name or prefix it	227	In short, to specify an X11 core font, just specify its name or prefix it
183	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,	228	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184	e.g.:	229	e.g.:
185		230
186	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	231	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	232	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
205	italic> >> characters are to be printed. See resource B<boldItalicFont>	250	italic> >> characters are to be printed. See resource B<boldItalicFont>
206	for details.	251	for details.
207		252
208	=item B<-is>\|B<+is>	253	=item B<-is>\|B<+is>
209		254
210	Compile I<font-styles>: Bold/Italic font styles imply high intensity	255	Compile I<font-styles>: Bold/Blink font styles imply high intensity
211	foreground/background (default). See resource B<intensityStyles> for	256	foreground/background (default). See resource B<intensityStyles> for
212	details.	257	details.
213		258
214	=item B<-name> I<name>	259	=item B<-name> I<name>
215		260
…		…
233		278
234	=item B<-sb>\|B<+sb>	279	=item B<-sb>\|B<+sb>
235		280
236	Turn on/off scrollbar; resource B<scrollBar>.	281	Turn on/off scrollbar; resource B<scrollBar>.
237		282
		283	=item B<-sr>\|B<+sr>
		284
		285	Put scrollbar on right/left; resource B<scrollBar_right>.
		286
		287	=item B<-st>\|B<+st>
		288
		289	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		290	resource B<scrollBar_floating>.
		291
238	=item B<-si>\|B<+si>	292	=item B<-si>\|B<+si>
239		293
240	Turn on/off scroll-to-bottom on TTY output inhibit; resource	294	Turn on/off scroll-to-bottom on TTY output inhibit; resource
241	B<scrollTtyOutput> has opposite effect.	295	B<scrollTtyOutput> has opposite effect.
242		296
…		…
248	=item B<-sw>\|B<+sw>	302	=item B<-sw>\|B<+sw>
249		303
250	Turn on/off scrolling with the scrollback buffer as new lines appear.	304	Turn on/off scrolling with the scrollback buffer as new lines appear.
251	This only takes effect if B<-si> is also given; resource	305	This only takes effect if B<-si> is also given; resource
252	B<scrollWithBuffer>.	306	B<scrollWithBuffer>.
253
254	=item B<-sr>\|B<+sr>
255
256	Put scrollbar on right/left; resource B<scrollBar_right>.
257
258	=item B<-st>\|B<+st>
259
260	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
261	resource B<scrollBar_floating>.
262		307
263	=item B<-ptab>\|B<+ptab>	308	=item B<-ptab>\|B<+ptab>
264		309
265	If enabled (default), "Horizontal Tab" characters are being stored as	310	If enabled (default), "Horizontal Tab" characters are being stored as
266	actual wide characters in the screen buffer, which makes it possible to	311	actual wide characters in the screen buffer, which makes it possible to
…		…
297		342
298	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	343	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
299	if honoured by the WM, the rxvt-unicode window will not have window	344	if honoured by the WM, the rxvt-unicode window will not have window
300	decorations; resource B<borderLess>.	345	decorations; resource B<borderLess>.
301		346
		347	=item B<-override-redirect>
		348
		349	Compile I<frills>: Sets override-redirect on the window; resource
		350	B<override-redirect>.
		351
302	=item B<-sbg>	352	=item B<-sbg>
303		353
304	Compile I<frills>: Disable the usage of the built-in block graphics/line	354	Compile I<frills>: Disable the usage of the built-in block graphics/line
305	drawing characters and just rely on what the specified fonts provide. Use	355	drawing characters and just rely on what the specified fonts provide. Use
306	this if you have a good font and want to use its block graphic glyphs;	356	this if you have a good font and want to use its block graphic glyphs;
…		…
308		358
309	=item B<-lsp> I<number>	359	=item B<-lsp> I<number>
310		360
311	Compile I<frills>: Lines (pixel height) to insert between each row of	361	Compile I<frills>: Lines (pixel height) to insert between each row of
312	the display. Useful to work around font rendering problems; resource	362	the display. Useful to work around font rendering problems; resource
313	B<linespace>.	363	B<lineSpace>.
314		364
315	=item B<-tn> I<termname>	365	=item B<-tn> I<termname>
316		366
317	This option specifies the name of the terminal type to be set in the	367	This option specifies the name of the terminal type to be set in the
318	B<TERM> environment variable. This terminal type must exist in the	368	B<TERM> environment variable. This terminal type must exist in the
…		…
372	for more info.	422	for more info.
373		423
374	=item B<-tcw>	424	=item B<-tcw>
375		425
376	Change the meaning of triple-click selection with the left mouse	426	Change the meaning of triple-click selection with the left mouse
		427	button. Only effective when the original (non-perl) selection code is
377	button. Instead of selecting a full line it will extend the selection the	428	in-use. Instead of selecting a full line it will extend the selection to
378	end of the logical line only. resource B<tripleclickwords>.	429	the end of the logical line only. resource B<tripleclickwords>.
379		430
380	=item B<-insecure>	431	=item B<-insecure>
381		432
382	Enable "insecure" mode, which currently enables most of the escape	433	Enable "insecure" mode, which currently enables most of the escape
383	sequences that echo strings. See the resource B<insecure> for more	434	sequences that echo strings. See the resource B<insecure> for more
…		…
404	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	455	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
405	will not immediately destroy its window when the program executed within	456	will not immediately destroy its window when the program executed within
406	it exits. Instead, it will wait till it is being killed or closed by the	457	it exits. Instead, it will wait till it is being killed or closed by the
407	user; resource B<hold>.	458	user; resource B<hold>.
408		459
		460	=item B<-cd> I<path>
		461
		462	Sets the working directory for the shell (or the command specified via
		463	B<-e>). The I<path> must be an absolute path and it must exist for
		464	@@RXVT_NAME@@ to start; resource B<chdir>.
		465
		466	=item B<-xrm> I<string>
		467
		468	Works like the X Toolkit option of the same name, by adding the I<string>
		469	as if it were specified in a resource file. Resource values specified this
		470	way take precedence over all other resource specifications.
		471
		472	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		473	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		474	options can be specified as long-options on the commandline, so use
		475	of B<-xrm> is mostly limited to cases where you want to specify other
		476	resources (e.g. for input methods) or for compatibility with other
		477	programs.
		478
409	=item B<-keysym.>I<sym> I<string>	479	=item B<-keysym.>I<sym> I<string>
410		480
411	Remap a key symbol. See resource B<keysym>.	481	Remap a key symbol. See resource B<keysym>.
412		482
413	=item B<-embed> I<windowid>	483	=item B<-embed> I<windowid>
414		484
415	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,	485	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
416	which enables applications to easily embed a terminal.	486	which enables applications to easily embed a terminal.
417		487
418	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it	488	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
419	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it	489	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
420	quite a bit, so don't expect it to keep some specific state. It's best to	490	quite a bit, so don't expect it to keep some specific state. It's best to
…		…
423	The window will not be destroyed when @@RXVT_NAME@@ exits.	493	The window will not be destroyed when @@RXVT_NAME@@ exits.
424		494
425	It might be useful to know that @@RXVT_NAME@@ will not close file	495	It might be useful to know that @@RXVT_NAME@@ will not close file
426	descriptors passed to it (except for stdin/out/err, of course), so you	496	descriptors passed to it (except for stdin/out/err, of course), so you
427	can use file descriptors to communicate with the programs within the	497	can use file descriptors to communicate with the programs within the
428	terminal. This works regardless of wether the C<-embed> option was used or	498	terminal. This works regardless of whether the C<-embed> option was used or
429	not.	499	not.
430		500
431	Here is a short Gtk2-perl snippet that illustrates how this option can be	501	Here is a short Gtk2-perl snippet that illustrates how this option can be
432	used (a longer example is in F<doc/embed>):	502	used (a longer example is in F<doc/embed>):
433		503
…		…
438	});	508	});
439		509
440	=item B<-pty-fd> I<file descriptor>	510	=item B<-pty-fd> I<file descriptor>
441		511
442	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	512	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
443	pair but instead use the given filehandle as the tty master. This is	513	pair but instead use the given file descriptor as the tty master. This is
444	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator	514	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
445	without having to run a program within it.	515	without having to run a program within it.
446		516
447	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	517	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
448	entries and will not tinker with pty/tty permissions - you have to do that	518	entries and will not tinker with pty/tty permissions - you have to do that
449	yourself if you want that.	519	yourself if you want that.
450		520
451	As an extremely special case, specifying C<-1> will completely suppress	521	As an extremely special case, specifying C<-1> will completely suppress
452	pty/tty operations.	522	pty/tty operations, which is probably only useful in conjunction with some
		523	perl extension that manages the terminal.
453		524
454	Here is a example in perl that illustrates how this option can be used (a	525	Here is a example in perl that illustrates how this option can be used (a
455	longer example is in F<doc/pty-fd>):	526	longer example is in F<doc/pty-fd>):
456		527
457	use IO::Pty;	528	use IO::Pty;
…		…
471	Comma-separated list of perl extension scripts to use (or not to use) in	542	Comma-separated list of perl extension scripts to use (or not to use) in
472	this terminal instance. See resource B<perl-ext> for details.	543	this terminal instance. See resource B<perl-ext> for details.
473		544
474	=back	545	=back
475		546
476	=head1 RESOURCES (available also as long-options)	547	=head1 RESOURCES
477		548
478	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	549	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
479	options) compiled into your version.	550	options) compiled into your version. All resources are also available as
		551	long-options.
480		552
481	There are two different methods that @@RXVT_NAME@@ can use to get the	553	You can set and change the resources using X11 tools like B<xrdb>. Many
482	Xresource data: using the X libraries (Xrm*-functions) or internal	554	distribution do also load settings from the B<~/.Xresources> file when X
483	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	555	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
484	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	556	with later settings overwriting earlier ones:
485	resources using X11 tools like B<xrdb>. Many distribution do also load
486	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
487	will consult the following files/resources in order, with later settings
488	overwriting earlier ones:
489		557
490	1. system-wide app-defaults file, either locale-dependent OR global	558	1. system-wide app-defaults file, either locale-dependent OR global
491	2. app-defaults file in $XAPPLRESDIR	559	2. app-defaults file in $XAPPLRESDIR
492	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	560	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
493	4. SCREEN_RESOURCES for the current screen	561	4. SCREEN_RESOURCES for the current screen
494	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	562	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		563	6. resources specified via -xrm on the commandline
495		564
496	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
497	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
498	set in XAPPLOADDIR/URxvt (compile-time defined: usually
499	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
500	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
501	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	565	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
502	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows	566	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
503	resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be	567	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
504	easily configured, while the class name B<URxvt> allows resources	568	configured, while the class name B<URxvt> allows resources unique to
505	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	569	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
506	shared between different B<@@RXVT_NAME@@> configurations. If no	570	configurations. If no resources are specified, suitable defaults will
507	resources are specified, suitable defaults will be used. Command-line	571	be used. Command-line arguments can be used to override resource
508	arguments can be used to override resource settings. The following	572	settings. The following resources are supported (you might want to
509	resources are allowed:	573	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		574	extensions not documented here):
510		575
511	=over 4	576	=over 4
		577
		578	=item B<depth:> I<bitdepth>
		579
		580	Compile I<xft>: Attempt to find a visual with the given bit depth;
		581	option B<-depth>.
		582
		583	=item B<buffered:> I<boolean>
		584
		585	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		586	On some card/driver combination enabling it slightly decreases
		587	performance, on most it greatly helps it. The slowdown is small, so it
		588	should normally be enabled.
512		589
513	=item B<geometry:> I<geom>	590	=item B<geometry:> I<geom>
514		591
515	Create the window with the specified X window geometry [default 80x24];	592	Create the window with the specified X window geometry [default 80x24];
516	option B<-geometry>.	593	option B<-geometry>.
…		…
553	Use the specified colour to display underlined characters when the	630	Use the specified colour to display underlined characters when the
554	foreground colour is the default.	631	foreground colour is the default.
555		632
556	=item B<colorRV:> I<colour>	633	=item B<colorRV:> I<colour>
557		634
558	Use the specified colour as the background for reverse video	635	Use the specified colour as the background for reverse video characters
559	characters.	636	when OPTION_HC is disabled (--disable-frills).
560		637
561	=item B<underlineColor:> I<colour>	638	=item B<underlineColor:> I<colour>
562		639
563	If set, use the specified colour as the colour for the underline	640	If set, use the specified colour as the colour for the underline
564	itself. If unset, use the foreground colour.	641	itself. If unset, use the foreground colour.
…		…
580	option B<-rv>. B<False>: regular screen colours [default]; option	657	option B<-rv>. B<False>: regular screen colours [default]; option
581	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	658	B<+rv>. See note in B<COLORS AND GRAPHICS> section.
582		659
583	=item B<jumpScroll:> I<boolean>	660	=item B<jumpScroll:> I<boolean>
584		661
585	B<True>: specify that jump scrolling should be used. When scrolling	662	B<True>: specify that jump scrolling should be used. When receiving lots
586	quickly, fewer screen updates are performed [default]; option B<-j>.	663	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		664	has been read, resulting in fewer updates while still displaying every
		665	received line; option B<-j>.
		666
587	B<False>: specify that smooth scrolling should be used; option B<+j>.	667	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		668	force a screen refresh on each new line it received; option B<+j>.
588		669
589	=item B<inheritPixmap:> I<boolean>	670	=item B<skipScroll:> I<boolean>
590		671
591	B<True>: make the background inherit the parent windows' pixmap, giving	672	B<True>: (the default) specify that skip scrolling should be used. When
592	artificial transparency. B<False>: do not inherit the parent windows'	673	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
593	pixmap.	674	(around 60 times per second), resulting in far fewer updates. This can
		675	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		676	option B<-ss>.
		677
		678	B<False>: specify that everything is to be displayed, even
		679	if the refresh is too fast for the human eye to read anything (or the
		680	monitor to display anything); option B<+ss>.
		681
		682	=item B<transparent:> I<boolean>
		683
		684	Turn on/off illusion of a transparent window background.
		685
		686	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
		687	future versions.
		688
		689	I<Please address all transparency related issues to Sasha Vasko at
		690	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
594		691
595	=item B<fading:> I<number>	692	=item B<fading:> I<number>
596		693
597	Fade the text by the given percentage when focus is lost; option B<-fade>.	694	Fade the text by the given percentage when focus is lost; option B<-fade>.
598		695
…		…
606	Tint the transparent background pixmap with the given colour; option	703	Tint the transparent background pixmap with the given colour; option
607	B<-tint>.	704	B<-tint>.
608		705
609	=item B<shading:> I<number>	706	=item B<shading:> I<number>
610		707
611	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	708	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
612	image in addition to tinting it.	709	in addition to tinting it; option B<-sh>.
		710
		711	=item B<blendType:> I<string>
		712
		713	Specify background blending type; option B<-blt>.
		714
		715	=item B<blurRadius:> I<number>
		716
		717	Apply Gaussian Blurr with the specified radius to the transparent
		718	background image; option B<-blr>.
613		719
614	=item B<scrollColor:> I<colour>	720	=item B<scrollColor:> I<colour>
615		721
616	Use the specified colour for the scrollbar [default #B2B2B2].	722	Use the specified colour for the scrollbar [default #B2B2B2].
617		723
…		…
623	=item B<borderColor:> I<colour>	729	=item B<borderColor:> I<colour>
624		730
625	The colour of the border around the text area and between the scrollbar	731	The colour of the border around the text area and between the scrollbar
626	and the text.	732	and the text.
627		733
628	=item B<backgroundPixmap:> I<file[;geom]>	734	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
629		735
630	Use the specified XPM file (note the `.xpm' extension is optional) for	736	Use the specified image file for the background and also
631	the background and also optionally specify its scaling with a geometry	737	optionally specify its scaling with a geometry string B<WxH+X+Y>,
632	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	738	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
633	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	739	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
634	centre (percent). A scale of 0 displays the image with tiling. A scale	740	centre (percent). A scale of 0 displays the image with tiling. A scale
635	of 1 displays the image without any scaling. A scale of 2 to 9	741	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
636	specifies an integer number of images in that direction. No image will	742	an integer number of images in that direction. No image will be magnified
637	be magnified beyond 10 times its original size. The maximum permitted	743	beyond 10 times its original size. The maximum permitted scale is 1000.
638	scale is 1000. [default 0x0+50+50]	744	Additional operations can be specified after colon B<:op1:op2...>.
		745	Supported operations are:
639		746
640	=item B<menu:> I<file[;tag]>	747	tile force background image to be tiled and not scaled. Equivalent to 0x0
		748	propscale will scale image keeping proportions
		749	auto will scale image to match window size. Equivalent to 100x100
		750	hscale will scale image horizontally to the window size
		751	vscale will scale image vertically to the window size
		752	scale will scale image to match window size
		753	root will tile image as if it was a root window background, auto-adjusting
		754	whenever terminal window moves
641		755
642	Read in the specified menu file (note the `.menu' extension is	756	If used in conjunction with B<-tr> option, the specified pixmap will be
643	optional) and also optionally specify a starting tag to find. See the	757	blended over transparency image using either alpha-blending, or any
644	reference documentation for details on the syntax for the menuBar.	758	other blending type, specified with B<-blt "type"> option.
645		759
646	=item B<path:> I<path>	760	=item B<path:> I<path>
647		761
648	Specify the colon-delimited search path for finding files (XPM and	762	Specify the colon-delimited search path for finding background image files.
649	menus), in addition to the paths specified by the B<RXVTPATH> and
650	B<PATH> environment variables.
651		763
652	=item B<font:> I<fontlist>	764	=item B<font:> I<fontlist>
653		765
654	Select the fonts to be used. This is a comma separated list of font	766	Select the fonts to be used. This is a comma separated list of font names
655	names that are used in turn when trying to display Unicode characters.	767	that are checked in order when trying to find glyphs for characters. The
656	The first font defines the cell size for characters; other fonts might	768	first font defines the cell size for characters; other fonts might be
657	be smaller, but not larger. A reasonable default font list is always	769	smaller, but not (in general) larger. A (hopefully) reasonable default
658	appended to it; option B<-fn>.	770	font list is always appended to it; option B<-fn>.
659		771
660	Each font can either be a standard X11 core font (XLFD) name, with	772	Each font can either be a standard X11 core font (XLFD) name, with
661	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.	773	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
662		774
663	In addition, each font can be prefixed with additional hints and	775	In addition, each font can be prefixed with additional hints and
…		…
665	hint currently is C<codeset=codeset-name>, and this is only used for Xft	777	hint currently is C<codeset=codeset-name>, and this is only used for Xft
666	fonts.	778	fonts.
667		779
668	For example, this font resource	780	For example, this font resource
669		781
670	URxvt*font: 9x15bold,\	782	URxvt.font: 9x15bold,\
671	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	783	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
672	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \	784	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
673	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	785	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
674	xft:Code2000:antialias=false	786	xft:Code2000:antialias=false
675		787
…		…
712	text font will being used for the given style.	824	text font will being used for the given style.
713		825
714	=item B<intensityStyles:> I<boolean>	826	=item B<intensityStyles:> I<boolean>
715		827
716	When font styles are not enabled, or this option is enabled (B<True>,	828	When font styles are not enabled, or this option is enabled (B<True>,
717	option B<-is>, the default), bold and italic font styles imply high	829	option B<-is>, the default), bold/blink font styles imply high
718	intensity foreground/backround colours. Disabling this option (B<False>,	830	intensity foreground/background colours. Disabling this option (B<False>,
719	option B<+is>) disables this behaviour, the high intensity colours are not	831	option B<+is>) disables this behaviour, the high intensity colours are not
720	reachable.	832	reachable.
721
722	=item B<selectstyle:> I<mode>
723
724	Set mouse selection style to B<old> which is 2.20, B<oldword> which is
725	xterm style with 2.20 old word selection, or anything else which gives
726	xterm style selection.
727
728	=item B<scrollstyle:> I<mode>
729
730	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
731	the author's favourite.
732		833
733	=item B<title:> I<string>	834	=item B<title:> I<string>
734		835
735	Set window title string, the default title is the command-line	836	Set window title string, the default title is the command-line
736	specified after the B<-e> option, if any, otherwise the application	837	specified after the B<-e> option, if any, otherwise the application
…		…
745	=item B<mapAlert:> I<boolean>	846	=item B<mapAlert:> I<boolean>
746		847
747	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	848	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
748	de-iconify (map) on receipt of a bell character [default].	849	de-iconify (map) on receipt of a bell character [default].
749		850
		851	=item B<urgentOnBell:> I<boolean>
		852
		853	B<True>: set the urgency hint for the wm on receipt of a bell character.
		854	B<False>: do not set the urgency hint [default].
		855
750	=item B<visualBell:> I<boolean>	856	=item B<visualBell:> I<boolean>
751		857
752	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	858	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
753	B<False>: no visual bell [default]; option B<+vb>.	859	B<False>: no visual bell [default]; option B<+vb>.
754		860
…		…
772		878
773	The string will be interpreted as if typed into the shell as-is.	879	The string will be interpreted as if typed into the shell as-is.
774		880
775	Example:	881	Example:
776		882
777	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	883	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
778		884
779	This creates a new file in your home directory with the screen contents	885	This creates a new file in your home directory with the screen contents
780	everytime you hit C<Print>.	886	every time you hit C<Print>.
		887
		888	=item B<scrollstyle:> I<mode>
		889
		890	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		891	the author's favourite.
781		892
782	=item B<scrollBar:> I<boolean>	893	=item B<scrollBar:> I<boolean>
783		894
784	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	895	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
785	disable the scrollbar; option B<+sb>.	896	disable the scrollbar; option B<+sb>.
…		…
807		918
808	=item B<scrollWithBuffer:> I<boolean>	919	=item B<scrollWithBuffer:> I<boolean>
809		920
810	B<True>: scroll with scrollback buffer when tty receives new lines (and	921	B<True>: scroll with scrollback buffer when tty receives new lines (and
811	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	922	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
812	with scrollback buffer when tty recieves new lines; option B<+sw>.	923	with scrollback buffer when tty receives new lines; option B<+sw>.
813		924
814	=item B<scrollTtyKeypress:> I<boolean>	925	=item B<scrollTtyKeypress:> I<boolean>
815		926
816	B<True>: scroll to bottom when a non-special key is pressed. Special keys	927	B<True>: scroll to bottom when a non-special key is pressed. Special keys
817	are those which are intercepted by rxvt-unicode for special handling and	928	are those which are intercepted by rxvt-unicode for special handling and
…		…
848	=item B<termName:> I<termname>	959	=item B<termName:> I<termname>
849		960
850	Specifies the terminal type name to be set in the B<TERM> environment	961	Specifies the terminal type name to be set in the B<TERM> environment
851	variable; option B<-tn>.	962	variable; option B<-tn>.
852		963
853	=item B<linespace:> I<number>	964	=item B<lineSpace:> I<number>
854		965
855	Specifies number of lines (pixel height) to insert between each row of	966	Specifies number of lines (pixel height) to insert between each row of
856	the display [default 0]; option B<-lsp>.	967	the display [default 0]; option B<-lsp>.
857		968
858	=item B<meta8:> I<boolean>	969	=item B<meta8:> I<boolean>
…		…
907	pressed. If unset it will send the sequence traditionally associated	1018	pressed. If unset it will send the sequence traditionally associated
908	with the B<Execute> key.	1019	with the B<Execute> key.
909		1020
910	=item B<cutchars:> I<string>	1021	=item B<cutchars:> I<string>
911		1022
912	The characters used as delimiters for double-click word selection. The	1023	The characters used as delimiters for double-click word selection
913	built-in default:	1024	(whitespace delimiting is added automatically if resource is given).
914		1025
		1026	When the perl selection extension is in use (the default if compiled
		1027	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		1028	characters will be created (if the resource exists, otherwise, no regex
		1029	will be created). In this mode, characters outside ISO-8859-1 can be used.
		1030
		1031	When the selection extension is not used, only ISO-8859-1 characters can
		1032	be used. If not specified, the built-in default is used:
		1033
915	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1034	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
916		1035
917	=item B<preeditType:> I<style>	1036	=item B<preeditType:> I<style>
918		1037
919	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1038	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
920		1039
…		…
954	default. (Note that many other terminals, including xterm, have these	1073	default. (Note that many other terminals, including xterm, have these
955	sequences enabled by default, which doesn't make it safer, though).	1074	sequences enabled by default, which doesn't make it safer, though).
956		1075
957	You can enable them by setting this boolean resource or specifying	1076	You can enable them by setting this boolean resource or specifying
958	B<-insecure> as an option. At the moment, this enables display-answer,	1077	B<-insecure> as an option. At the moment, this enables display-answer,
959	locale, findfont, icon label and window title requests as well as dynamic	1078	locale, findfont, icon label and window title requests.
960	menubar dispatch.
961		1079
962	=item B<modifier:> I<modifier>	1080	=item B<modifier:> I<modifier>
963		1081
964	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	1082	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
965	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	1083	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
969		1087
970	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	1088	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
971	character is passed through. It may contain escape values as described	1089	character is passed through. It may contain escape values as described
972	in the entry on B<keysym> following.	1090	in the entry on B<keysym> following.
973		1091
974	=item B<secondaryScreen:> I<bool>	1092	=item B<secondaryScreen:> I<boolean>
975		1093
976	Turn on/off secondary screen (default enabled).	1094	Turn on/off secondary screen (default enabled).
977		1095
978	=item B<secondaryScroll:> I<bool>	1096	=item B<secondaryScroll:> I<boolean>
979		1097
980	Turn on/off secondary screen scroll (default enabled). If the this	1098	Turn on/off secondary screen scroll (default enabled). If this
981	option is enabled, scrolls on the secondary screen will change the	1099	option is enabled, scrolls on the secondary screen will change the
982	scrollback buffer and switching to/from the secondary screen will	1100	scrollback buffer and, when secondaryScreen is off, switching
983	instead scroll the screen up.	1101	to/from the secondary screen will instead scroll the screen up.
984		1102
985	=item B<hold>: I<bool>	1103	=item B<hold>: I<boolean>
986		1104
987	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1105	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
988	will not immediately destroy its window when the program executed within	1106	will not immediately destroy its window when the program executed within
989	it exits. Instead, it will wait till it is being killed or closed by the	1107	it exits. Instead, it will wait till it is being killed or closed by the
990	user.	1108	user.
		1109
		1110	=item B<chdir>: I<path>
		1111
		1112	Sets the working directory for the shell (or the command specified via
		1113	B<-e>). The I<path> must be an absolute path and it must exist for
		1114	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1115	directory will be used; option B<-cd>.
991		1116
992	=item B<keysym.>I<sym>: I<string>	1117	=item B<keysym.>I<sym>: I<string>
993		1118
994	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1119	Compile I<frills>: Associate I<string> with keysym I<sym>. The
995	intervening resource name B<keysym.> cannot be omitted.	1120	intervening resource name B<keysym.> cannot be omitted.
…		…
1009	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1134	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1010	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1135	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1011	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1136	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1012	performed in an exact manner; however, the closest match is assured.	1137	performed in an exact manner; however, the closest match is assured.
1013		1138
1014	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1139	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1015	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1140	number), see RESOURCES in C<man 7 X> for futher details.
1016	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1017	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1018	can start or end with whitespace.
1019
1020	Please note that you need to double the C<\> when using
1021	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
1022	use C<\033> instead of C<\e> (and so on), which will work with both Xt and
1023	@@RXVT_NAME@@'s own processing).
1024		1141
1025	You can define a range of keysyms in one shot by providing a I<string>	1142	You can define a range of keysyms in one shot by providing a I<string>
1026	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1143	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1027	should be a character not used by the strings.	1144	should be a character not used by the strings.
1028		1145
1029	Its usage can be demonstrated by an example:	1146	Its usage can be demonstrated by an example:
1030		1147
1031	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1148	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
…		…
1088		1205
1089	Comma-separated list(s) of perl extension scripts (default: C<default>) to	1206	Comma-separated list(s) of perl extension scripts (default: C<default>) to
1090	use in this terminal instance; option B<-pe>.	1207	use in this terminal instance; option B<-pe>.
1091		1208
1092	Extension names can be prefixed with a C<-> sign to prohibit using	1209	Extension names can be prefixed with a C<-> sign to prohibit using
1093	it. This can be useful to selectively disable some extensions loaded	1210	them. This can be useful to selectively disable some extensions loaded
1094	by default, or specified via the C<perl-ext-common> resource. For	1211	by default, or specified via the C<perl-ext-common> resource. For
1095	example, C<default,-selection> will use all the default extension except	1212	example, C<default,-selection> will use all the default extension except
1096	C<selection>.	1213	C<selection>.
		1214
		1215	Extension names can also be followed by an argument in angle brackets
		1216	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1217	searchable scrollback to Alt/Meta-s). Mentioning the same extension
		1218	multiple times with different arguments will pass multiple arguments to
		1219	the extension.
1097		1220
1098	Each extension is looked up in the library directories, loaded if	1221	Each extension is looked up in the library directories, loaded if
1099	necessary, and bound to the current terminal instance.	1222	necessary, and bound to the current terminal instance.
1100		1223
1101	If both of these resources are the empty string, then the perl	1224	If both of these resources are the empty string, then the perl
…		…
1103	B<perl-ext-common> will be used for extensions that should be available to	1226	B<perl-ext-common> will be used for extensions that should be available to
1104	all instances, while B<perl-ext> is used for specific instances.	1227	all instances, while B<perl-ext> is used for specific instances.
1105		1228
1106	=item B<perl-eval>: I<string>	1229	=item B<perl-eval>: I<string>
1107		1230
1108	Perl code to be evaluated when all extensions have been registered. See the	1231	Perl code to be evaluated when all extensions have been registered. See
1109	@@RXVT_NAME@@perl(3) manpage.	1232	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
		1233	will be ignored when running setuid/setgid.
1110		1234
1111	=item B<perl-lib>: I<path>	1235	=item B<perl-lib>: I<path>
1112		1236
1113	Colon-separated list of additional directories that hold extension	1237	Colon-separated list of additional directories that hold extension
1114	scripts. When looking for extensions specified by the C<perl> resource,	1238	scripts. When looking for extensions specified by the C<perl> resource,
1115	@@RXVT_NAME@@ will first look in these directories and then in	1239	@@RXVT_NAME@@ will first look in these directories and then in
1116	F<@@RXVT_LIBDIR@@/urxvt/perl/>.	1240	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
		1241	will be ignored when running setuid/setgid.
1117		1242
1118	See the @@RXVT_NAME@@perl(3) manpage.	1243	See the @@RXVT_NAME@@perl(3) manpage.
		1244
		1245	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1246
		1247	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1248	details.
		1249
		1250	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1251
		1252	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1253	for details.
		1254
		1255	=item B<searchable-scrollback:> I<keysym>
		1256
		1257	Sets the hotkey that starts the incremental scrollback buffer search
		1258	(default: C<M-s>).
		1259
		1260	=item B<urlLauncher>: I<string>
		1261
		1262	Specifies the program to be started with a URL argument. Used by the
		1263	C<selection-popup> and C<matcher> perl extensions.
		1264
		1265	=item B<transient-for>: I<windowid>
		1266
		1267	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1268
		1269	=item B<override-redirect>: I<boolean>
		1270
		1271	Compile I<frills>: Sets override-redirect for the terminal window, making
		1272	it almost invisible to window managers; option B<-override-redirect>.
		1273
		1274	=item B<iso14755_52:> I<boolean>
		1275
		1276	Turn on/off ISO 14755 5.2 mode (default enabled).
1119		1277
1120	=back	1278	=back
1121		1279
1122	=head1 THE SCROLLBAR	1280	=head1 THE SCROLLBAR
1123		1281
…		…
1142	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1300	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1143	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1301	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1144	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1302	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1145	respectively.	1303	respectively.
1146		1304
1147	=head1 TEXT SELECTION AND INSERTION	1305	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1148		1306
1149	The behaviour of text selection and insertion mechanism is similar to	1307	The behaviour of text selection and insertion/pasting mechanism is similar
1150	I<xterm>(1).	1308	to I<xterm>(1).
1151		1309
1152	=over 4	1310	=over 4
1153		1311
1154	=item B<Selection>:	1312	=item B<Selecting>:
1155		1313
1156	Left click at the beginning of the region, drag to the end of the region	1314	Left click at the beginning of the region, drag to the end of the region
1157	and release; Right click to extend the marked region; Left double-click	1315	and release; Right click to extend the marked region; Left double-click
1158	to select a word; Left triple-click to select the entire logical line	1316	to select a word; Left triple-click to select the entire logical line
1159	(which can span multiple screen lines), unless modified by resource	1317	(which can span multiple screen lines), unless modified by resource
…		…
1163	(Compile: I<frills>) will create a rectangular selection instead of a	1321	(Compile: I<frills>) will create a rectangular selection instead of a
1164	normal one. In this mode, every selected row becomes its own line in the	1322	normal one. In this mode, every selected row becomes its own line in the
1165	selection, and trailing whitespace is visually underlined and removed from	1323	selection, and trailing whitespace is visually underlined and removed from
1166	the selection.	1324	the selection.
1167		1325
1168	=item B<Insertion>:	1326	=item B<Pasting>:
1169		1327
1170	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1328	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1171	an B<@@RXVT_NAME@@> window causes the current text selection to be	1329	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1172	inserted as if it had been typed on the keyboard.	1330	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1331
		1332	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1333	inserted too.
1173		1334
1174	=back	1335	=back
1175		1336
1176	=head1 CHANGING FONTS	1337	=head1 CHANGING FONTS
1177		1338
1178	Changing fonts (or font sizes, respectively) via the keypad is not yet	1339	Changing fonts (or font sizes, respectively) via the keypad is not yet
1179	supported in rxvt-unicode. Bug me if you need this.	1340	supported in rxvt-unicode. Bug me if you need this.
1180		1341
1181	You can, however, switch fonts at runtime using escape sequences (and	1342	You can, however, switch fonts at runtime using escape sequences, e.g.:
1182	therefore using the menubar), e.g.:
1183		1343
1184	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"	1344	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1345
		1346	You can use keyboard shortcuts, too:
		1347
		1348	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1349	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1185		1350
1186	rxvt-unicode will automatically re-apply these fonts to the output so far.	1351	rxvt-unicode will automatically re-apply these fonts to the output so far.
1187		1352
1188	=head1 ISO 14755 SUPPORT	1353	=head1 ISO 14755 SUPPORT
1189		1354
1190	ISO 14755 is a standard for entering and viewing unicode characters	1355	ISO 14755 is a standard for entering and viewing unicode characters
1191	and character codes using the keyboard. It consists of 4 parts. The	1356	and character codes using the keyboard. It consists of 4 parts. The
1192	first part is available rxvt-unicode has been compiled with	1357	first part is available if rxvt-unicode has been compiled with
1193	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1358	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1194	with C<--enable-iso14755>.	1359	with C<--enable-iso14755>.
1195		1360
1196	=over 4	1361	=over 4
1197		1362
…		…
1217	This mode lets you input characters representing the keycap symbols of	1382	This mode lets you input characters representing the keycap symbols of
1218	your keyboard, if representable in the current locale encoding.	1383	your keyboard, if representable in the current locale encoding.
1219		1384
1220	Start by pressing C<Control> and C<Shift> together, then releasing	1385	Start by pressing C<Control> and C<Shift> together, then releasing
1221	them. The next special key (cursor keys, home etc.) you enter will not	1386	them. The next special key (cursor keys, home etc.) you enter will not
1222	invoke it's usual function but instead will insert the corresponding	1387	invoke its usual function but instead will insert the corresponding
1223	keycap symbol. The symbol will only be entered when the key has been	1388	keycap symbol. The symbol will only be entered when the key has been
1224	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1389	released, otherwise pressing e.g. C<Shift> would enter the symbol for
1225	C<ISO Level 2 Switch>, although your intention might have been to enter a	1390	C<ISO Level 2 Switch>, although your intention might have been to enter a
1226	reverse tab (Shift-Tab).	1391	reverse tab (Shift-Tab).
1227		1392
…		…
1260	=head1 COLORS AND GRAPHICS	1425	=head1 COLORS AND GRAPHICS
1261		1426
1262	In addition to the default foreground and background colours,	1427	In addition to the default foreground and background colours,
1263	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1428	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1264	high-intensity bold/blink versions of the same). Here is a list of the	1429	high-intensity bold/blink versions of the same). Here is a list of the
1265	colours with their B<rgb.txt> names.	1430	colours with their names.
1266		1431
1267	=begin table	1432	=begin table
1268		1433
1269	B<color0> (black) = Black	1434	B<color0> (black) = Black
1270	B<color1> (red) = Red3	1435	B<color1> (red) = Red3
…		…
1290	It is also possible to specify the colour values of B<foreground>,	1455	It is also possible to specify the colour values of B<foreground>,
1291	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1456	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1292	a number 0-15, as a convenient shorthand to reference the colour name of	1457	a number 0-15, as a convenient shorthand to reference the colour name of
1293	color0-color15.	1458	color0-color15.
1294		1459
		1460	In addition to the colours defined above, @@RXVT_NAME@@ offers an
		1461	additional 72 colours. The first 64 of those (with indices 16 to 79)
		1462	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
		1463	16>), followed by 8 additional shades of gray (with indices 80 to 87).
		1464
		1465	Together, all those colours implement the 88 colour xterm colours. Only
		1466	the first 16 can be changed using resources currently, the rest can only
		1467	be changed via command sequences ("escape codes").
		1468
1295	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1469	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1296	always swapping the foreground/background colours. This is in contrast to	1470	always swapping the foreground/background colours. This is in contrast to
1297	I<xterm>(1) where the colours are only swapped if they have not otherwise	1471	I<xterm>(1) where the colours are only swapped if they have not otherwise
1298	been specified. For example,	1472	been specified. For example,
1299		1473
…		…
1304	would yield White on Black, while on I<xterm>(1) it would yield Black	1478	would yield White on Black, while on I<xterm>(1) it would yield Black
1305	on White.	1479	on White.
1306		1480
1307	=back	1481	=back
1308		1482
		1483	=head2 ALPHA CHANNEL SUPPORT
		1484
		1485	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1486	their act together, rxvt-unicode will do it's own alpha channel management:
		1487
		1488	You can prefix any color with an opaquenes percentage enclosed in
		1489	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1490	(0-100) that specifies the opacity of the color, where C<0> is completely
		1491	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1492	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1493	is the recommended format to specify transparency values, and works with
		1494	all ways to specify a colour.
		1495
		1496	For complete control, rxvt-unicode also supports
		1497	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1498	specifications, where the additional C<aaaa> component specifies opacity
		1499	(alpha) values. The minimum value of C<0000> is completely transparent,
		1500	while C<ffff> is completely opaque). The two example colours from
		1501	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1502	C<rgba:0000/ff00/0000/f332>.
		1503
		1504	You probably need to specify B<"-depth 32">, too, to force a visual with
		1505	alpha channels, and have the luck that your X-server uses ARGB pixel
		1506	layout, as X is far from just supporting ARGB visuals out of the box, and
		1507	rxvt-unicode just fudges around.
		1508
		1509	For example, the following selects an almost completely transparent black
		1510	background, and an almost opaque pink foreground:
		1511
		1512	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
		1513
		1514	When not using a background image, then the interpretation of the
		1515	alpha channel is up to your compositing manager (most interpret it as
		1516	transparency of course).
		1517
		1518	When using a background pixmap or pseudo-transparency, then the background
		1519	colour will always behave as if it were completely transparent (so the
		1520	background image shows instead), regardless of how it was specified, while
		1521	other colours will either be transparent as specified (the background
		1522	image will show through) on servers supporting the RENDER extension, or
		1523	fully opaque on servers not supporting the RENDER EXTENSION.
		1524
		1525	Please note that due to bugs in Xft, specifying alpha values might result
		1526	in garbage being displayed when the X-server does not support the RENDER
		1527	extension.
		1528
1309	=head1 ENVIRONMENT	1529	=head1 ENVIRONMENT
1310		1530
1311	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1531	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1312		1532
1313	=over 4	1533	=over 4
1314		1534
1315	=item B<TERM>	1535	=item B<TERM>
1316		1536
1317	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1537	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1318	resources or on the commandline.	1538	resources or on the command line.
1319		1539
1320	=item B<COLORTERM>	1540	=item B<COLORTERM>
1321		1541
1322	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1542	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1323	compiled with XPM support, and optionally with the added extension	1543	compiled with background image support, and optionally with the added
1324	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1544	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1545	screen.
1325		1546
1326	=item B<COLORFGBG>	1547	=item B<COLORFGBG>
1327		1548
1328	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1549	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1329	the colour code used as default foreground/text colour (or the string	1550	the colour code used as default foreground/text colour (or the string
1330	C<default> to indicate that the default-colour escape sequence is to be	1551	C<default> to indicate that the default-colour escape sequence is to be
1331	used), C<bg> is the colour code used as default background colour (or the	1552	used), C<bg> is the colour code used as default background colour (or the
1332	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1553	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1333	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1554	was compiled with background image support. Libraries like C<ncurses>
1334	(and do) use this information to optimize screen output.	1555	and C<slang> can (and do) use this information to optimize screen output.
1335		1556
1336	=item B<WINDOWID>	1557	=item B<WINDOWID>
1337		1558
1338	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1559	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1339	window, which usually has subwindows for the scrollbar, the terminal	1560	window, which usually has subwindows for the scrollbar, the terminal
…		…
1345	C<--with-terminfo=PATH>.	1566	C<--with-terminfo=PATH>.
1346		1567
1347	=item B<DISPLAY>	1568	=item B<DISPLAY>
1348		1569
1349	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1570	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1350	display in it's child processes.	1571	display in its child processes if C<-display> isn't used to override. It
		1572	defaults to C<:0> if it doesn't exist.
1351		1573
1352	=item B<SHELL>	1574	=item B<SHELL>
1353		1575
1354	The shell to be used for command execution, defaults to C</bin/sh>.	1576	The shell to be used for command execution, defaults to C</bin/sh>.
1355
1356	=item B<RXVTPATH>
1357
1358	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1359	files.
1360
1361	=item B<PATH>
1362
1363	Used in the same way as C<RXVTPATH>.
1364		1577
1365	=item B<RXVT_SOCKET>	1578	=item B<RXVT_SOCKET>
1366		1579
1367	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1580	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1368	@@RXVT_NAME@@d(1).	1581	@@RXVT_NAME@@d(1).
…		…
1406		1619
1407	=item Project Coordinator	1620	=item Project Coordinator
1408		1621
1409	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1622	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1410		1623
1411	L<http://software.schmorp.de/#rxvt-unicode>	1624	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1412		1625
1413	=back	1626	=back
1414		1627
1415	=head1 AUTHORS	1628	=head1 AUTHORS
1416		1629
…		…
1438		1651
1439	Project Coordinator (changes.txt 2.21a to 2.4.5)	1652	Project Coordinator (changes.txt 2.21a to 2.4.5)
1440		1653
1441	=item Geoff Wing L<< <gcw@pobox.com> >>	1654	=item Geoff Wing L<< <gcw@pobox.com> >>
1442		1655
1443	Rewrote screen display and text selection routines. Project Coordinator	1656	Rewrote screen display and text selection routines.
		1657
1444	(changes.txt 2.4.6 - rxvt-unicode)	1658	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1445		1659
1446	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1660	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1447		1661
1448	Forked rxvt-unicode, rewrote most of the display code and internal	1662	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1449	character handling to store text in unicode, improve xterm	1663	extension, random hacks, numerous bugfixes and extensions.
1450	compatibility and apply numerous other bugfixes and extensions.
1451		1664
1452	Project Coordinator (Changes 1.0 -)	1665	Project Coordinator (Changes 1.0 -)
1453		1666
		1667	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1668
		1669	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
		1670
1454	=back	1671	=back
1455		1672

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.88 by root, Sun Jan 8 00:20:12 2006 UTC vs. Revision 1.164 by root, Sun Jun 15 13:54:15 2008 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.88 by root, Sun Jan 8 00:20:12 2006 UTC vs.
Revision 1.164 by root, Sun Jun 15 13:54:15 2008 UTC