[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.169 by root, Wed Nov 5 00:14:18 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>.
		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>.
141		192
142	=item B<-bg> I<colour>	193	=item B<-bg> I<colour>
143		194
144	Window background colour; resource B<background>.	195	Window background colour; resource B<background>.
145		196
146	=item B<-fg> I<colour>	197	=item B<-fg> I<colour>
147		198
148	Window foreground colour; resource B<foreground>.	199	Window foreground colour; resource B<foreground>.
149		200
150	=item B<-pixmap> I<file[;geom]>	201	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
151		202
152	Compile I<XPM>: Specify XPM file for the background and also optionally	203	Compile I<afterimage>: Specify image file for the background and also
153	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
154	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
155	command-line; resource B<backgroundPixmap>.	206	command-line; for more details see resource B<backgroundPixmap>.
156		207
157	=item B<-cr> I<colour>	208	=item B<-cr> I<colour>
158		209
159	The cursor colour; resource B<cursorColor>.	210	The cursor colour; resource B<cursorColor>.
160		211
…		…
172	resource B<borderColor>.	223	resource B<borderColor>.
173		224
174	=item B<-fn> I<fontlist>	225	=item B<-fn> I<fontlist>
175		226
176	Select the fonts to be used. This is a comma separated list of font names	227	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	228	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	229	first font defines the cell size for characters; other fonts might be
179	smaller, but not (in general) larger. A (hopefully) reasonable default	230	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.	231	font list is always appended to it. See resource B<font> for more details.
181		232
182	In short, to specify an X11 core font, just specify it's name or prefix it	233	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:>,	234	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184	e.g.:	235	e.g.:
185		236
186	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	237	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	238	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
205	italic> >> characters are to be printed. See resource B<boldItalicFont>	256	italic> >> characters are to be printed. See resource B<boldItalicFont>
206	for details.	257	for details.
207		258
208	=item B<-is>\|B<+is>	259	=item B<-is>\|B<+is>
209		260
210	Compile I<font-styles>: Bold/Italic font styles imply high intensity	261	Compile I<font-styles>: Bold/Blink font styles imply high intensity
211	foreground/background (default). See resource B<intensityStyles> for	262	foreground/background (default). See resource B<intensityStyles> for
212	details.	263	details.
213		264
214	=item B<-name> I<name>	265	=item B<-name> I<name>
215		266
…		…
233		284
234	=item B<-sb>\|B<+sb>	285	=item B<-sb>\|B<+sb>
235		286
236	Turn on/off scrollbar; resource B<scrollBar>.	287	Turn on/off scrollbar; resource B<scrollBar>.
237		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
238	=item B<-si>\|B<+si>	298	=item B<-si>\|B<+si>
239		299
240	Turn on/off scroll-to-bottom on TTY output inhibit; resource	300	Turn on/off scroll-to-bottom on TTY output inhibit; resource
241	B<scrollTtyOutput> has opposite effect.	301	B<scrollTtyOutput> has opposite effect.
242		302
…		…
248	=item B<-sw>\|B<+sw>	308	=item B<-sw>\|B<+sw>
249		309
250	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.
251	This only takes effect if B<-si> is also given; resource	311	This only takes effect if B<-si> is also given; resource
252	B<scrollWithBuffer>.	312	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		313
263	=item B<-ptab>\|B<+ptab>	314	=item B<-ptab>\|B<+ptab>
264		315
265	If enabled (default), "Horizontal Tab" characters are being stored as	316	If enabled (default), "Horizontal Tab" characters are being stored as
266	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
…		…
295		346
296	=item B<-bl>	347	=item B<-bl>
297		348
298	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	349	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	350	if honoured by the WM, the rxvt-unicode window will not have window
300	decorations; resource B<borderLess>.	351	decorations; resource B<borderLess>. If the window manager does not
		352	support MWM hints (e.g. kwin), enables override-redirect mode.
		353
		354	=item B<-override-redirect>
		355
		356	Compile I<frills>: Sets override-redirect on the window; resource
		357	B<override-redirect>.
301		358
302	=item B<-sbg>	359	=item B<-sbg>
303		360
304	Compile I<frills>: Disable the usage of the built-in block graphics/line	361	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	362	drawing characters and just rely on what the specified fonts provide. Use
…		…
308		365
309	=item B<-lsp> I<number>	366	=item B<-lsp> I<number>
310		367
311	Compile I<frills>: Lines (pixel height) to insert between each row of	368	Compile I<frills>: Lines (pixel height) to insert between each row of
312	the display. Useful to work around font rendering problems; resource	369	the display. Useful to work around font rendering problems; resource
313	B<linespace>.	370	B<lineSpace>.
314		371
315	=item B<-tn> I<termname>	372	=item B<-tn> I<termname>
316		373
317	This option specifies the name of the terminal type to be set in the	374	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	375	B<TERM> environment variable. This terminal type must exist in the
…		…
372	for more info.	429	for more info.
373		430
374	=item B<-tcw>	431	=item B<-tcw>
375		432
376	Change the meaning of triple-click selection with the left mouse	433	Change the meaning of triple-click selection with the left mouse
		434	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	435	in-use. Instead of selecting a full line it will extend the selection to
378	end of the logical line only. resource B<tripleclickwords>.	436	the end of the logical line only. resource B<tripleclickwords>.
379		437
380	=item B<-insecure>	438	=item B<-insecure>
381		439
382	Enable "insecure" mode, which currently enables most of the escape	440	Enable "insecure" mode, which currently enables most of the escape
383	sequences that echo strings. See the resource B<insecure> for more	441	sequences that echo strings. See the resource B<insecure> for more
…		…
404	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	462	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
405	will not immediately destroy its window when the program executed within	463	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	464	it exits. Instead, it will wait till it is being killed or closed by the
407	user; resource B<hold>.	465	user; resource B<hold>.
408		466
		467	=item B<-cd> I<path>
		468
		469	Sets the working directory for the shell (or the command specified via
		470	B<-e>). The I<path> must be an absolute path and it must exist for
		471	@@RXVT_NAME@@ to start; resource B<chdir>.
		472
		473	=item B<-xrm> I<string>
		474
		475	Works like the X Toolkit option of the same name, by adding the I<string>
		476	as if it were specified in a resource file. Resource values specified this
		477	way take precedence over all other resource specifications.
		478
		479	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		480	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		481	options can be specified as long-options on the commandline, so use
		482	of B<-xrm> is mostly limited to cases where you want to specify other
		483	resources (e.g. for input methods) or for compatibility with other
		484	programs.
		485
409	=item B<-keysym.>I<sym> I<string>	486	=item B<-keysym.>I<sym> I<string>
410		487
411	Remap a key symbol. See resource B<keysym>.	488	Remap a key symbol. See resource B<keysym>.
412		489
413	=item B<-embed> I<windowid>	490	=item B<-embed> I<windowid>
414		491
415	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,	492	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
416	which enables applications to easily embed a terminal.	493	which enables applications to easily embed a terminal.
417		494
418	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it	495	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	496	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	497	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.	500	The window will not be destroyed when @@RXVT_NAME@@ exits.
424		501
425	It might be useful to know that @@RXVT_NAME@@ will not close file	502	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	503	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	504	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	505	terminal. This works regardless of whether the C<-embed> option was used or
429	not.	506	not.
430		507
431	Here is a short Gtk2-perl snippet that illustrates how this option can be	508	Here is a short Gtk2-perl snippet that illustrates how this option can be
432	used (a longer example is in F<doc/embed>):	509	used (a longer example is in F<doc/embed>):
433		510
…		…
438	});	515	});
439		516
440	=item B<-pty-fd> I<file descriptor>	517	=item B<-pty-fd> I<file descriptor>
441		518
442	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	519	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	520	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	521	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
445	without having to run a program within it.	522	without having to run a program within it.
446		523
447	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	524	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	525	entries and will not tinker with pty/tty permissions - you have to do that
449	yourself if you want that.	526	yourself if you want that.
450		527
451	As an extremely special case, specifying C<-1> will completely suppress	528	As an extremely special case, specifying C<-1> will completely suppress
452	pty/tty operations.	529	pty/tty operations, which is probably only useful in conjunction with some
		530	perl extension that manages the terminal.
453		531
454	Here is a example in perl that illustrates how this option can be used (a	532	Here is a example in perl that illustrates how this option can be used (a
455	longer example is in F<doc/pty-fd>):	533	longer example is in F<doc/pty-fd>):
456		534
457	use IO::Pty;	535	use IO::Pty;
…		…
471	Comma-separated list of perl extension scripts to use (or not to use) in	549	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.	550	this terminal instance. See resource B<perl-ext> for details.
473		551
474	=back	552	=back
475		553
476	=head1 RESOURCES (available also as long-options)	554	=head1 RESOURCES
477		555
478	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	556	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
479	options) compiled into your version.	557	options) compiled into your version. All resources are also available as
		558	long-options.
480		559
481	There are two different methods that @@RXVT_NAME@@ can use to get the	560	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	561	distribution do also load settings from the B<~/.Xresources> file when X
483	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	562	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	563	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		564
490	1. system-wide app-defaults file, either locale-dependent OR global	565	1. system-wide app-defaults file, either locale-dependent OR global
491	2. app-defaults file in $XAPPLRESDIR	566	2. app-defaults file in $XAPPLRESDIR
492	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	567	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
493	4. SCREEN_RESOURCES for the current screen	568	4. SCREEN_RESOURCES for the current screen
494	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	569	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		570	6. resources specified via -xrm on the commandline
495		571
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	572	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	573	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	574	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	575	configured, while the class name B<URxvt> allows resources unique to
505	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	576	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
506	shared between different B<@@RXVT_NAME@@> configurations. If no	577	configurations. If no resources are specified, suitable defaults will
507	resources are specified, suitable defaults will be used. Command-line	578	be used. Command-line arguments can be used to override resource
508	arguments can be used to override resource settings. The following	579	settings. The following resources are supported (you might want to
509	resources are allowed:	580	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		581	extensions not documented here):
510		582
511	=over 4	583	=over 4
		584
		585	=item B<depth:> I<bitdepth>
		586
		587	Compile I<xft>: Attempt to find a visual with the given bit depth;
		588	option B<-depth>.
		589
		590	=item B<buffered:> I<boolean>
		591
		592	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		593	On some card/driver combination enabling it slightly decreases
		594	performance, on most it greatly helps it. The slowdown is small, so it
		595	should normally be enabled.
512		596
513	=item B<geometry:> I<geom>	597	=item B<geometry:> I<geom>
514		598
515	Create the window with the specified X window geometry [default 80x24];	599	Create the window with the specified X window geometry [default 80x24];
516	option B<-geometry>.	600	option B<-geometry>.
…		…
553	Use the specified colour to display underlined characters when the	637	Use the specified colour to display underlined characters when the
554	foreground colour is the default.	638	foreground colour is the default.
555		639
556	=item B<colorRV:> I<colour>	640	=item B<colorRV:> I<colour>
557		641
558	Use the specified colour as the background for reverse video	642	Use the specified colour as the background for reverse video characters
559	characters.	643	when OPTION_HC is disabled (--disable-frills).
560		644
561	=item B<underlineColor:> I<colour>	645	=item B<underlineColor:> I<colour>
562		646
563	If set, use the specified colour as the colour for the underline	647	If set, use the specified colour as the colour for the underline
564	itself. If unset, use the foreground colour.	648	itself. If unset, use the foreground colour.
…		…
580	option B<-rv>. B<False>: regular screen colours [default]; option	664	option B<-rv>. B<False>: regular screen colours [default]; option
581	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	665	B<+rv>. See note in B<COLORS AND GRAPHICS> section.
582		666
583	=item B<jumpScroll:> I<boolean>	667	=item B<jumpScroll:> I<boolean>
584		668
585	B<True>: specify that jump scrolling should be used. When scrolling	669	B<True>: specify that jump scrolling should be used. When receiving lots
586	quickly, fewer screen updates are performed [default]; option B<-j>.	670	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		671	has been read, resulting in fewer updates while still displaying every
		672	received line; option B<-j>.
		673
587	B<False>: specify that smooth scrolling should be used; option B<+j>.	674	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		675	force a screen refresh on each new line it received; option B<+j>.
588		676
589	=item B<inheritPixmap:> I<boolean>	677	=item B<skipScroll:> I<boolean>
590		678
591	B<True>: make the background inherit the parent windows' pixmap, giving	679	B<True>: (the default) specify that skip scrolling should be used. When
592	artificial transparency. B<False>: do not inherit the parent windows'	680	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
593	pixmap.	681	(around 60 times per second), resulting in far fewer updates. This can
		682	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		683	option B<-ss>.
		684
		685	B<False>: specify that everything is to be displayed, even
		686	if the refresh is too fast for the human eye to read anything (or the
		687	monitor to display anything); option B<+ss>.
		688
		689	=item B<transparent:> I<boolean>
		690
		691	Turn on/off illusion of a transparent window background.
		692
		693	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
		694	future versions.
		695
		696	I<Please address all transparency related issues to Sasha Vasko at
		697	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
594		698
595	=item B<fading:> I<number>	699	=item B<fading:> I<number>
596		700
597	Fade the text by the given percentage when focus is lost; option B<-fade>.	701	Fade the text by the given percentage when focus is lost; option B<-fade>.
598		702
…		…
606	Tint the transparent background pixmap with the given colour; option	710	Tint the transparent background pixmap with the given colour; option
607	B<-tint>.	711	B<-tint>.
608		712
609	=item B<shading:> I<number>	713	=item B<shading:> I<number>
610		714
611	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	715	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
612	image in addition to tinting it.	716	in addition to tinting it; option B<-sh>.
		717
		718	=item B<blendType:> I<string>
		719
		720	Specify background blending type; option B<-blt>.
		721
		722	=item B<blurRadius:> I<number>
		723
		724	Apply gaussian blur with the specified radius to the transparent
		725	background image; option B<-blr>.
		726
		727	=item B<iconFile:> I<file>
		728
		729	Set the application icon pixmap; option B<-icon>.
613		730
614	=item B<scrollColor:> I<colour>	731	=item B<scrollColor:> I<colour>
615		732
616	Use the specified colour for the scrollbar [default #B2B2B2].	733	Use the specified colour for the scrollbar [default #B2B2B2].
617		734
…		…
623	=item B<borderColor:> I<colour>	740	=item B<borderColor:> I<colour>
624		741
625	The colour of the border around the text area and between the scrollbar	742	The colour of the border around the text area and between the scrollbar
626	and the text.	743	and the text.
627		744
628	=item B<backgroundPixmap:> I<file[;geom]>	745	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
629		746
630	Use the specified XPM file (note the `.xpm' extension is optional) for	747	Use the specified image file for the background and also
631	the background and also optionally specify its scaling with a geometry	748	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	749	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
633	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	750	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	751	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	752	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	753	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	754	beyond 10 times its original size. The maximum permitted scale is 1000.
638	scale is 1000. [default 0x0+50+50]	755	Additional operations can be specified after colon B<:op1:op2...>.
		756	Supported operations are:
639		757
640	=item B<menu:> I<file[;tag]>	758	tile force background image to be tiled and not scaled. Equivalent to 0x0
		759	propscale will scale image keeping proportions
		760	auto will scale image to match window size. Equivalent to 100x100
		761	hscale will scale image horizontally to the window size
		762	vscale will scale image vertically to the window size
		763	scale will scale image to match window size
		764	root will tile image as if it was a root window background, auto-adjusting
		765	whenever terminal window moves
641		766
642	Read in the specified menu file (note the `.menu' extension is	767	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	768	blended over transparency image using either alpha-blending, or any
644	reference documentation for details on the syntax for the menuBar.	769	other blending type, specified with B<-blt "type"> option.
645		770
646	=item B<path:> I<path>	771	=item B<path:> I<path>
647		772
648	Specify the colon-delimited search path for finding files (XPM and	773	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		774
652	=item B<font:> I<fontlist>	775	=item B<font:> I<fontlist>
653		776
654	Select the fonts to be used. This is a comma separated list of font	777	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.	778	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	779	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	780	smaller, but not (in general) larger. A (hopefully) reasonable default
658	appended to it; option B<-fn>.	781	font list is always appended to it; option B<-fn>.
659		782
660	Each font can either be a standard X11 core font (XLFD) name, with	783	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:>.	784	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
662		785
663	In addition, each font can be prefixed with additional hints and	786	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	788	hint currently is C<codeset=codeset-name>, and this is only used for Xft
666	fonts.	789	fonts.
667		790
668	For example, this font resource	791	For example, this font resource
669		792
670	URxvt*font: 9x15bold,\	793	URxvt.font: 9x15bold,\
671	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	794	-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, \	795	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
673	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	796	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
674	xft:Code2000:antialias=false	797	xft:Code2000:antialias=false
675		798
…		…
712	text font will being used for the given style.	835	text font will being used for the given style.
713		836
714	=item B<intensityStyles:> I<boolean>	837	=item B<intensityStyles:> I<boolean>
715		838
716	When font styles are not enabled, or this option is enabled (B<True>,	839	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	840	option B<-is>, the default), bold/blink font styles imply high
718	intensity foreground/backround colours. Disabling this option (B<False>,	841	intensity foreground/background colours. Disabling this option (B<False>,
719	option B<+is>) disables this behaviour, the high intensity colours are not	842	option B<+is>) disables this behaviour, the high intensity colours are not
720	reachable.	843	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		844
733	=item B<title:> I<string>	845	=item B<title:> I<string>
734		846
735	Set window title string, the default title is the command-line	847	Set window title string, the default title is the command-line
736	specified after the B<-e> option, if any, otherwise the application	848	specified after the B<-e> option, if any, otherwise the application
…		…
745	=item B<mapAlert:> I<boolean>	857	=item B<mapAlert:> I<boolean>
746		858
747	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	859	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].	860	de-iconify (map) on receipt of a bell character [default].
749		861
		862	=item B<urgentOnBell:> I<boolean>
		863
		864	B<True>: set the urgency hint for the wm on receipt of a bell character.
		865	B<False>: do not set the urgency hint [default].
		866
		867	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		868
750	=item B<visualBell:> I<boolean>	869	=item B<visualBell:> I<boolean>
751		870
752	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	871	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
753	B<False>: no visual bell [default]; option B<+vb>.	872	B<False>: no visual bell [default]; option B<+vb>.
754		873
…		…
772		891
773	The string will be interpreted as if typed into the shell as-is.	892	The string will be interpreted as if typed into the shell as-is.
774		893
775	Example:	894	Example:
776		895
777	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	896	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
778		897
779	This creates a new file in your home directory with the screen contents	898	This creates a new file in your home directory with the screen contents
780	everytime you hit C<Print>.	899	every time you hit C<Print>.
		900
		901	=item B<scrollstyle:> I<mode>
		902
		903	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		904	the author's favourite.
781		905
782	=item B<scrollBar:> I<boolean>	906	=item B<scrollBar:> I<boolean>
783		907
784	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	908	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
785	disable the scrollbar; option B<+sb>.	909	disable the scrollbar; option B<+sb>.
…		…
807		931
808	=item B<scrollWithBuffer:> I<boolean>	932	=item B<scrollWithBuffer:> I<boolean>
809		933
810	B<True>: scroll with scrollback buffer when tty receives new lines (and	934	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	935	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
812	with scrollback buffer when tty recieves new lines; option B<+sw>.	936	with scrollback buffer when tty receives new lines; option B<+sw>.
813		937
814	=item B<scrollTtyKeypress:> I<boolean>	938	=item B<scrollTtyKeypress:> I<boolean>
815		939
816	B<True>: scroll to bottom when a non-special key is pressed. Special keys	940	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	941	are those which are intercepted by rxvt-unicode for special handling and
…		…
848	=item B<termName:> I<termname>	972	=item B<termName:> I<termname>
849		973
850	Specifies the terminal type name to be set in the B<TERM> environment	974	Specifies the terminal type name to be set in the B<TERM> environment
851	variable; option B<-tn>.	975	variable; option B<-tn>.
852		976
853	=item B<linespace:> I<number>	977	=item B<lineSpace:> I<number>
854		978
855	Specifies number of lines (pixel height) to insert between each row of	979	Specifies number of lines (pixel height) to insert between each row of
856	the display [default 0]; option B<-lsp>.	980	the display [default 0]; option B<-lsp>.
857		981
858	=item B<meta8:> I<boolean>	982	=item B<meta8:> I<boolean>
…		…
907	pressed. If unset it will send the sequence traditionally associated	1031	pressed. If unset it will send the sequence traditionally associated
908	with the B<Execute> key.	1032	with the B<Execute> key.
909		1033
910	=item B<cutchars:> I<string>	1034	=item B<cutchars:> I<string>
911		1035
912	The characters used as delimiters for double-click word selection. The	1036	The characters used as delimiters for double-click word selection
913	built-in default:	1037	(whitespace delimiting is added automatically if resource is given).
914		1038
		1039	When the perl selection extension is in use (the default if compiled
		1040	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		1041	characters will be created (if the resource exists, otherwise, no regex
		1042	will be created). In this mode, characters outside ISO-8859-1 can be used.
		1043
		1044	When the selection extension is not used, only ISO-8859-1 characters can
		1045	be used. If not specified, the built-in default is used:
		1046
915	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1047	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
916		1048
917	=item B<preeditType:> I<style>	1049	=item B<preeditType:> I<style>
918		1050
919	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1051	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
920		1052
…		…
954	default. (Note that many other terminals, including xterm, have these	1086	default. (Note that many other terminals, including xterm, have these
955	sequences enabled by default, which doesn't make it safer, though).	1087	sequences enabled by default, which doesn't make it safer, though).
956		1088
957	You can enable them by setting this boolean resource or specifying	1089	You can enable them by setting this boolean resource or specifying
958	B<-insecure> as an option. At the moment, this enables display-answer,	1090	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	1091	locale, findfont, icon label and window title requests.
960	menubar dispatch.
961		1092
962	=item B<modifier:> I<modifier>	1093	=item B<modifier:> I<modifier>
963		1094
964	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	1095	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	1096	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
969		1100
970	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	1101	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	1102	character is passed through. It may contain escape values as described
972	in the entry on B<keysym> following.	1103	in the entry on B<keysym> following.
973		1104
974	=item B<secondaryScreen:> I<bool>	1105	=item B<secondaryScreen:> I<boolean>
975		1106
976	Turn on/off secondary screen (default enabled).	1107	Turn on/off secondary screen (default enabled).
977		1108
978	=item B<secondaryScroll:> I<bool>	1109	=item B<secondaryScroll:> I<boolean>
979		1110
980	Turn on/off secondary screen scroll (default enabled). If the this	1111	Turn on/off secondary screen scroll (default enabled). If this
981	option is enabled, scrolls on the secondary screen will change the	1112	option is enabled, scrolls on the secondary screen will change the
982	scrollback buffer and switching to/from the secondary screen will	1113	scrollback buffer and, when secondaryScreen is off, switching
983	instead scroll the screen up.	1114	to/from the secondary screen will instead scroll the screen up.
984		1115
985	=item B<hold>: I<bool>	1116	=item B<hold>: I<boolean>
986		1117
987	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1118	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
988	will not immediately destroy its window when the program executed within	1119	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	1120	it exits. Instead, it will wait till it is being killed or closed by the
990	user.	1121	user.
		1122
		1123	=item B<chdir>: I<path>
		1124
		1125	Sets the working directory for the shell (or the command specified via
		1126	B<-e>). The I<path> must be an absolute path and it must exist for
		1127	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1128	directory will be used; option B<-cd>.
991		1129
992	=item B<keysym.>I<sym>: I<string>	1130	=item B<keysym.>I<sym>: I<string>
993		1131
994	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1132	Compile I<frills>: Associate I<string> with keysym I<sym>. The
995	intervening resource name B<keysym.> cannot be omitted.	1133	intervening resource name B<keysym.> cannot be omitted.
…		…
1009	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1147	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	1148	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	1149	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.	1150	performed in an exact manner; however, the closest match is assured.
1013		1151
1014	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1152	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,	1153	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		1154
1025	You can define a range of keysyms in one shot by providing a I<string>	1155	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 `/'	1156	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1027	should be a character not used by the strings.	1157	should be a character not used by the strings.
1028		1158
1029	Its usage can be demonstrated by an example:	1159	Its usage can be demonstrated by an example:
1030		1160
1031	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1161	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
…		…
1088		1218
1089	Comma-separated list(s) of perl extension scripts (default: C<default>) to	1219	Comma-separated list(s) of perl extension scripts (default: C<default>) to
1090	use in this terminal instance; option B<-pe>.	1220	use in this terminal instance; option B<-pe>.
1091		1221
1092	Extension names can be prefixed with a C<-> sign to prohibit using	1222	Extension names can be prefixed with a C<-> sign to prohibit using
1093	it. This can be useful to selectively disable some extensions loaded	1223	them. This can be useful to selectively disable some extensions loaded
1094	by default, or specified via the C<perl-ext-common> resource. For	1224	by default, or specified via the C<perl-ext-common> resource. For
1095	example, C<default,-selection> will use all the default extension except	1225	example, C<default,-selection> will use all the default extension except
1096	C<selection>.	1226	C<selection>.
		1227
		1228	Extension names can also be followed by an argument in angle brackets
		1229	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1230	searchable scrollback to Alt/Meta-s). Mentioning the same extension
		1231	multiple times with different arguments will pass multiple arguments to
		1232	the extension.
1097		1233
1098	Each extension is looked up in the library directories, loaded if	1234	Each extension is looked up in the library directories, loaded if
1099	necessary, and bound to the current terminal instance.	1235	necessary, and bound to the current terminal instance.
1100		1236
1101	If both of these resources are the empty string, then the perl	1237	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	1239	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.	1240	all instances, while B<perl-ext> is used for specific instances.
1105		1241
1106	=item B<perl-eval>: I<string>	1242	=item B<perl-eval>: I<string>
1107		1243
1108	Perl code to be evaluated when all extensions have been registered. See the	1244	Perl code to be evaluated when all extensions have been registered. See
1109	@@RXVT_NAME@@perl(3) manpage.	1245	the @@RXVT_NAME@@perl(3) manpage.
1110		1246
1111	=item B<perl-lib>: I<path>	1247	=item B<perl-lib>: I<path>
1112		1248
1113	Colon-separated list of additional directories that hold extension	1249	Colon-separated list of additional directories that hold extension
1114	scripts. When looking for extensions specified by the C<perl> resource,	1250	scripts. When looking for extensions specified by the C<perl> resource,
1115	@@RXVT_NAME@@ will first look in these directories and then in	1251	@@RXVT_NAME@@ will first look in these directories and then in
1116	F<@@RXVT_LIBDIR@@/urxvt/perl/>.	1252	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1117		1253
1118	See the @@RXVT_NAME@@perl(3) manpage.	1254	See the @@RXVT_NAME@@perl(3) manpage.
		1255
		1256	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1257
		1258	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1259	details.
		1260
		1261	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1262
		1263	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1264	for details.
		1265
		1266	=item B<searchable-scrollback:> I<keysym>
		1267
		1268	Sets the hotkey that starts the incremental scrollback buffer search
		1269	(default: C<M-s>).
		1270
		1271	=item B<urlLauncher>: I<string>
		1272
		1273	Specifies the program to be started with a URL argument. Used by the
		1274	C<selection-popup> and C<matcher> perl extensions.
		1275
		1276	=item B<transient-for>: I<windowid>
		1277
		1278	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1279
		1280	=item B<override-redirect>: I<boolean>
		1281
		1282	Compile I<frills>: Sets override-redirect for the terminal window, making
		1283	it almost invisible to window managers; option B<-override-redirect>.
		1284
		1285	=item B<iso14755_52:> I<boolean>
		1286
		1287	Turn on/off ISO 14755 5.2 mode (default enabled).
1119		1288
1120	=back	1289	=back
1121		1290
1122	=head1 THE SCROLLBAR	1291	=head1 THE SCROLLBAR
1123		1292
…		…
1142	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1311	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1143	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1312	(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),	1313	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1145	respectively.	1314	respectively.
1146		1315
1147	=head1 TEXT SELECTION AND INSERTION	1316	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1148		1317
1149	The behaviour of text selection and insertion mechanism is similar to	1318	The behaviour of text selection and insertion/pasting mechanism is similar
1150	I<xterm>(1).	1319	to I<xterm>(1).
1151		1320
1152	=over 4	1321	=over 4
1153		1322
1154	=item B<Selection>:	1323	=item B<Selecting>:
1155		1324
1156	Left click at the beginning of the region, drag to the end of the region	1325	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	1326	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	1327	to select a word; Left triple-click to select the entire logical line
1159	(which can span multiple screen lines), unless modified by resource	1328	(which can span multiple screen lines), unless modified by resource
…		…
1163	(Compile: I<frills>) will create a rectangular selection instead of a	1332	(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	1333	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	1334	selection, and trailing whitespace is visually underlined and removed from
1166	the selection.	1335	the selection.
1167		1336
1168	=item B<Insertion>:	1337	=item B<Pasting>:
1169		1338
1170	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1339	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	1340	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1172	inserted as if it had been typed on the keyboard.	1341	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1342
		1343	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1344	inserted too.
1173		1345
1174	=back	1346	=back
1175		1347
1176	=head1 CHANGING FONTS	1348	=head1 CHANGING FONTS
1177		1349
1178	Changing fonts (or font sizes, respectively) via the keypad is not yet	1350	Changing fonts (or font sizes, respectively) via the keypad is not yet
1179	supported in rxvt-unicode. Bug me if you need this.	1351	supported in rxvt-unicode. Bug me if you need this.
1180		1352
1181	You can, however, switch fonts at runtime using escape sequences (and	1353	You can, however, switch fonts at runtime using escape sequences, e.g.:
1182	therefore using the menubar), e.g.:
1183		1354
1184	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"	1355	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1356
		1357	You can use keyboard shortcuts, too:
		1358
		1359	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1360	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1185		1361
1186	rxvt-unicode will automatically re-apply these fonts to the output so far.	1362	rxvt-unicode will automatically re-apply these fonts to the output so far.
1187		1363
1188	=head1 ISO 14755 SUPPORT	1364	=head1 ISO 14755 SUPPORT
1189		1365
1190	ISO 14755 is a standard for entering and viewing unicode characters	1366	ISO 14755 is a standard for entering and viewing unicode characters
1191	and character codes using the keyboard. It consists of 4 parts. The	1367	and character codes using the keyboard. It consists of 4 parts. The
1192	first part is available rxvt-unicode has been compiled with	1368	first part is available if rxvt-unicode has been compiled with
1193	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1369	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1194	with C<--enable-iso14755>.	1370	with C<--enable-iso14755>.
1195		1371
1196	=over 4	1372	=over 4
1197		1373
…		…
1217	This mode lets you input characters representing the keycap symbols of	1393	This mode lets you input characters representing the keycap symbols of
1218	your keyboard, if representable in the current locale encoding.	1394	your keyboard, if representable in the current locale encoding.
1219		1395
1220	Start by pressing C<Control> and C<Shift> together, then releasing	1396	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	1397	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	1398	invoke its usual function but instead will insert the corresponding
1223	keycap symbol. The symbol will only be entered when the key has been	1399	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	1400	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	1401	C<ISO Level 2 Switch>, although your intention might have been to enter a
1226	reverse tab (Shift-Tab).	1402	reverse tab (Shift-Tab).
1227		1403
…		…
1260	=head1 COLORS AND GRAPHICS	1436	=head1 COLORS AND GRAPHICS
1261		1437
1262	In addition to the default foreground and background colours,	1438	In addition to the default foreground and background colours,
1263	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1439	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	1440	high-intensity bold/blink versions of the same). Here is a list of the
1265	colours with their B<rgb.txt> names.	1441	colours with their names.
1266		1442
1267	=begin table	1443	=begin table
1268		1444
1269	B<color0> (black) = Black	1445	B<color0> (black) = Black
1270	B<color1> (red) = Red3	1446	B<color1> (red) = Red3
…		…
1290	It is also possible to specify the colour values of B<foreground>,	1466	It is also possible to specify the colour values of B<foreground>,
1291	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1467	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	1468	a number 0-15, as a convenient shorthand to reference the colour name of
1293	color0-color15.	1469	color0-color15.
1294		1470
		1471	In addition to the colours defined above, @@RXVT_NAME@@ offers an
		1472	additional 72 colours. The first 64 of those (with indices 16 to 79)
		1473	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
		1474	16>), followed by 8 additional shades of gray (with indices 80 to 87).
		1475
		1476	Together, all those colours implement the 88 colour xterm colours. Only
		1477	the first 16 can be changed using resources currently, the rest can only
		1478	be changed via command sequences ("escape codes").
		1479
1295	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1480	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1296	always swapping the foreground/background colours. This is in contrast to	1481	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	1482	I<xterm>(1) where the colours are only swapped if they have not otherwise
1298	been specified. For example,	1483	been specified. For example,
1299		1484
…		…
1304	would yield White on Black, while on I<xterm>(1) it would yield Black	1489	would yield White on Black, while on I<xterm>(1) it would yield Black
1305	on White.	1490	on White.
1306		1491
1307	=back	1492	=back
1308		1493
		1494	=head2 ALPHA CHANNEL SUPPORT
		1495
		1496	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1497	their act together, rxvt-unicode will do it's own alpha channel management:
		1498
		1499	You can prefix any color with an opaquenes percentage enclosed in
		1500	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1501	(0-100) that specifies the opacity of the color, where C<0> is completely
		1502	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1503	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1504	is the recommended format to specify transparency values, and works with
		1505	all ways to specify a colour.
		1506
		1507	For complete control, rxvt-unicode also supports
		1508	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1509	specifications, where the additional C<aaaa> component specifies opacity
		1510	(alpha) values. The minimum value of C<0000> is completely transparent,
		1511	while C<ffff> is completely opaque). The two example colours from
		1512	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1513	C<rgba:0000/ff00/0000/f332>.
		1514
		1515	You probably need to specify B<"-depth 32">, too, to force a visual with
		1516	alpha channels, and have the luck that your X-server uses ARGB pixel
		1517	layout, as X is far from just supporting ARGB visuals out of the box, and
		1518	rxvt-unicode just fudges around.
		1519
		1520	For example, the following selects an almost completely transparent black
		1521	background, and an almost opaque pink foreground:
		1522
		1523	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
		1524
		1525	When not using a background image, then the interpretation of the
		1526	alpha channel is up to your compositing manager (most interpret it as
		1527	transparency of course).
		1528
		1529	When using a background pixmap or pseudo-transparency, then the background
		1530	colour will always behave as if it were completely transparent (so the
		1531	background image shows instead), regardless of how it was specified, while
		1532	other colours will either be transparent as specified (the background
		1533	image will show through) on servers supporting the RENDER extension, or
		1534	fully opaque on servers not supporting the RENDER EXTENSION.
		1535
		1536	Please note that due to bugs in Xft, specifying alpha values might result
		1537	in garbage being displayed when the X-server does not support the RENDER
		1538	extension.
		1539
1309	=head1 ENVIRONMENT	1540	=head1 ENVIRONMENT
1310		1541
1311	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1542	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1312		1543
1313	=over 4	1544	=over 4
1314		1545
1315	=item B<TERM>	1546	=item B<TERM>
1316		1547
1317	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1548	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1318	resources or on the commandline.	1549	resources or on the command line.
1319		1550
1320	=item B<COLORTERM>	1551	=item B<COLORTERM>
1321		1552
1322	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1553	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1323	compiled with XPM support, and optionally with the added extension	1554	compiled with background image support, and optionally with the added
1324	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1555	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1556	screen.
1325		1557
1326	=item B<COLORFGBG>	1558	=item B<COLORFGBG>
1327		1559
1328	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1560	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	1561	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	1562	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	1563	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@@	1564	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	1565	was compiled with background image support. Libraries like C<ncurses>
1334	(and do) use this information to optimize screen output.	1566	and C<slang> can (and do) use this information to optimize screen output.
1335		1567
1336	=item B<WINDOWID>	1568	=item B<WINDOWID>
1337		1569
1338	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1570	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	1571	window, which usually has subwindows for the scrollbar, the terminal
…		…
1345	C<--with-terminfo=PATH>.	1577	C<--with-terminfo=PATH>.
1346		1578
1347	=item B<DISPLAY>	1579	=item B<DISPLAY>
1348		1580
1349	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1581	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1350	display in it's child processes.	1582	display in its child processes if C<-display> isn't used to override. It
		1583	defaults to C<:0> if it doesn't exist.
1351		1584
1352	=item B<SHELL>	1585	=item B<SHELL>
1353		1586
1354	The shell to be used for command execution, defaults to C</bin/sh>.	1587	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		1588
1365	=item B<RXVT_SOCKET>	1589	=item B<RXVT_SOCKET>
1366		1590
1367	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1591	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1368	@@RXVT_NAME@@d(1).	1592	@@RXVT_NAME@@d(1).
…		…
1406		1630
1407	=item Project Coordinator	1631	=item Project Coordinator
1408		1632
1409	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1633	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1410		1634
1411	L<http://software.schmorp.de/#rxvt-unicode>	1635	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1412		1636
1413	=back	1637	=back
1414		1638
1415	=head1 AUTHORS	1639	=head1 AUTHORS
1416		1640
…		…
1438		1662
1439	Project Coordinator (changes.txt 2.21a to 2.4.5)	1663	Project Coordinator (changes.txt 2.21a to 2.4.5)
1440		1664
1441	=item Geoff Wing L<< <gcw@pobox.com> >>	1665	=item Geoff Wing L<< <gcw@pobox.com> >>
1442		1666
1443	Rewrote screen display and text selection routines. Project Coordinator	1667	Rewrote screen display and text selection routines.
		1668
1444	(changes.txt 2.4.6 - rxvt-unicode)	1669	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1445		1670
1446	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1671	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1447		1672
1448	Forked rxvt-unicode, rewrote most of the display code and internal	1673	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1449	character handling to store text in unicode, improve xterm	1674	extension, random hacks, numerous bugfixes and extensions.
1450	compatibility and apply numerous other bugfixes and extensions.
1451		1675
1452	Project Coordinator (Changes 1.0 -)	1676	Project Coordinator (Changes 1.0 -)
1453		1677
		1678	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1679
		1680	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
		1681
1454	=back	1682	=back
1455		1683

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.169 by root, Wed Nov 5 00:14:18 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.169 by root, Wed Nov 5 00:14:18 2008 UTC