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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.92 by root, Wed Jan 11 02:13:55 2006 UTC vs.
Revision 1.167 by root, Wed Oct 15 14:48:22 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
…		…
295		340
296	=item B<-bl>	341	=item B<-bl>
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>. If the window manager does not
		346	support MWM hints (e.g. kwin), enables override-redirect mode.
		347
		348	=item B<-override-redirect>
		349
		350	Compile I<frills>: Sets override-redirect on the window; resource
		351	B<override-redirect>.
301		352
302	=item B<-sbg>	353	=item B<-sbg>
303		354
304	Compile I<frills>: Disable the usage of the built-in block graphics/line	355	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	356	drawing characters and just rely on what the specified fonts provide. Use
…		…
308		359
309	=item B<-lsp> I<number>	360	=item B<-lsp> I<number>
310		361
311	Compile I<frills>: Lines (pixel height) to insert between each row of	362	Compile I<frills>: Lines (pixel height) to insert between each row of
312	the display. Useful to work around font rendering problems; resource	363	the display. Useful to work around font rendering problems; resource
313	B<linespace>.	364	B<lineSpace>.
314		365
315	=item B<-tn> I<termname>	366	=item B<-tn> I<termname>
316		367
317	This option specifies the name of the terminal type to be set in the	368	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	369	B<TERM> environment variable. This terminal type must exist in the
…		…
372	for more info.	423	for more info.
373		424
374	=item B<-tcw>	425	=item B<-tcw>
375		426
376	Change the meaning of triple-click selection with the left mouse	427	Change the meaning of triple-click selection with the left mouse
		428	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	429	in-use. Instead of selecting a full line it will extend the selection to
378	end of the logical line only. resource B<tripleclickwords>.	430	the end of the logical line only. resource B<tripleclickwords>.
379		431
380	=item B<-insecure>	432	=item B<-insecure>
381		433
382	Enable "insecure" mode, which currently enables most of the escape	434	Enable "insecure" mode, which currently enables most of the escape
383	sequences that echo strings. See the resource B<insecure> for more	435	sequences that echo strings. See the resource B<insecure> for more
…		…
404	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	456	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
405	will not immediately destroy its window when the program executed within	457	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	458	it exits. Instead, it will wait till it is being killed or closed by the
407	user; resource B<hold>.	459	user; resource B<hold>.
408		460
		461	=item B<-cd> I<path>
		462
		463	Sets the working directory for the shell (or the command specified via
		464	B<-e>). The I<path> must be an absolute path and it must exist for
		465	@@RXVT_NAME@@ to start; resource B<chdir>.
		466
		467	=item B<-xrm> I<string>
		468
		469	Works like the X Toolkit option of the same name, by adding the I<string>
		470	as if it were specified in a resource file. Resource values specified this
		471	way take precedence over all other resource specifications.
		472
		473	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		474	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		475	options can be specified as long-options on the commandline, so use
		476	of B<-xrm> is mostly limited to cases where you want to specify other
		477	resources (e.g. for input methods) or for compatibility with other
		478	programs.
		479
409	=item B<-keysym.>I<sym> I<string>	480	=item B<-keysym.>I<sym> I<string>
410		481
411	Remap a key symbol. See resource B<keysym>.	482	Remap a key symbol. See resource B<keysym>.
412		483
413	=item B<-embed> I<windowid>	484	=item B<-embed> I<windowid>
414		485
415	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,	486	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
416	which enables applications to easily embed a terminal.	487	which enables applications to easily embed a terminal.
417		488
418	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it	489	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	490	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	491	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.	494	The window will not be destroyed when @@RXVT_NAME@@ exits.
424		495
425	It might be useful to know that @@RXVT_NAME@@ will not close file	496	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	497	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	498	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	499	terminal. This works regardless of whether the C<-embed> option was used or
429	not.	500	not.
430		501
431	Here is a short Gtk2-perl snippet that illustrates how this option can be	502	Here is a short Gtk2-perl snippet that illustrates how this option can be
432	used (a longer example is in F<doc/embed>):	503	used (a longer example is in F<doc/embed>):
433		504
…		…
438	});	509	});
439		510
440	=item B<-pty-fd> I<file descriptor>	511	=item B<-pty-fd> I<file descriptor>
441		512
442	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	513	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	514	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	515	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
445	without having to run a program within it.	516	without having to run a program within it.
446		517
447	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	518	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	519	entries and will not tinker with pty/tty permissions - you have to do that
449	yourself if you want that.	520	yourself if you want that.
450		521
451	As an extremely special case, specifying C<-1> will completely suppress	522	As an extremely special case, specifying C<-1> will completely suppress
452	pty/tty operations.	523	pty/tty operations, which is probably only useful in conjunction with some
		524	perl extension that manages the terminal.
453		525
454	Here is a example in perl that illustrates how this option can be used (a	526	Here is a example in perl that illustrates how this option can be used (a
455	longer example is in F<doc/pty-fd>):	527	longer example is in F<doc/pty-fd>):
456		528
457	use IO::Pty;	529	use IO::Pty;
…		…
471	Comma-separated list of perl extension scripts to use (or not to use) in	543	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.	544	this terminal instance. See resource B<perl-ext> for details.
473		545
474	=back	546	=back
475		547
476	=head1 RESOURCES (available also as long-options)	548	=head1 RESOURCES
477		549
478	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	550	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
479	options) compiled into your version.	551	options) compiled into your version. All resources are also available as
		552	long-options.
480		553
481	There are two different methods that @@RXVT_NAME@@ can use to get the	554	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	555	distribution do also load settings from the B<~/.Xresources> file when X
483	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	556	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	557	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		558
490	1. system-wide app-defaults file, either locale-dependent OR global	559	1. system-wide app-defaults file, either locale-dependent OR global
491	2. app-defaults file in $XAPPLRESDIR	560	2. app-defaults file in $XAPPLRESDIR
492	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	561	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
493	4. SCREEN_RESOURCES for the current screen	562	4. SCREEN_RESOURCES for the current screen
494	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	563	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		564	6. resources specified via -xrm on the commandline
495		565
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	566	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	567	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	568	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	569	configured, while the class name B<URxvt> allows resources unique to
505	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	570	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
506	shared between different B<@@RXVT_NAME@@> configurations. If no	571	configurations. If no resources are specified, suitable defaults will
507	resources are specified, suitable defaults will be used. Command-line	572	be used. Command-line arguments can be used to override resource
508	arguments can be used to override resource settings. The following	573	settings. The following resources are supported (you might want to
509	resources are allowed:	574	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		575	extensions not documented here):
510		576
511	=over 4	577	=over 4
		578
		579	=item B<depth:> I<bitdepth>
		580
		581	Compile I<xft>: Attempt to find a visual with the given bit depth;
		582	option B<-depth>.
		583
		584	=item B<buffered:> I<boolean>
		585
		586	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		587	On some card/driver combination enabling it slightly decreases
		588	performance, on most it greatly helps it. The slowdown is small, so it
		589	should normally be enabled.
512		590
513	=item B<geometry:> I<geom>	591	=item B<geometry:> I<geom>
514		592
515	Create the window with the specified X window geometry [default 80x24];	593	Create the window with the specified X window geometry [default 80x24];
516	option B<-geometry>.	594	option B<-geometry>.
…		…
553	Use the specified colour to display underlined characters when the	631	Use the specified colour to display underlined characters when the
554	foreground colour is the default.	632	foreground colour is the default.
555		633
556	=item B<colorRV:> I<colour>	634	=item B<colorRV:> I<colour>
557		635
558	Use the specified colour as the background for reverse video	636	Use the specified colour as the background for reverse video characters
559	characters.	637	when OPTION_HC is disabled (--disable-frills).
560		638
561	=item B<underlineColor:> I<colour>	639	=item B<underlineColor:> I<colour>
562		640
563	If set, use the specified colour as the colour for the underline	641	If set, use the specified colour as the colour for the underline
564	itself. If unset, use the foreground colour.	642	itself. If unset, use the foreground colour.
…		…
580	option B<-rv>. B<False>: regular screen colours [default]; option	658	option B<-rv>. B<False>: regular screen colours [default]; option
581	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	659	B<+rv>. See note in B<COLORS AND GRAPHICS> section.
582		660
583	=item B<jumpScroll:> I<boolean>	661	=item B<jumpScroll:> I<boolean>
584		662
585	B<True>: specify that jump scrolling should be used. When scrolling	663	B<True>: specify that jump scrolling should be used. When receiving lots
586	quickly, fewer screen updates are performed [default]; option B<-j>.	664	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		665	has been read, resulting in fewer updates while still displaying every
		666	received line; option B<-j>.
		667
587	B<False>: specify that smooth scrolling should be used; option B<+j>.	668	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		669	force a screen refresh on each new line it received; option B<+j>.
588		670
589	=item B<inheritPixmap:> I<boolean>	671	=item B<skipScroll:> I<boolean>
590		672
591	B<True>: make the background inherit the parent windows' pixmap, giving	673	B<True>: (the default) specify that skip scrolling should be used. When
592	artificial transparency. B<False>: do not inherit the parent windows'	674	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
593	pixmap.	675	(around 60 times per second), resulting in far fewer updates. This can
		676	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		677	option B<-ss>.
		678
		679	B<False>: specify that everything is to be displayed, even
		680	if the refresh is too fast for the human eye to read anything (or the
		681	monitor to display anything); option B<+ss>.
		682
		683	=item B<transparent:> I<boolean>
		684
		685	Turn on/off illusion of a transparent window background.
		686
		687	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
		688	future versions.
		689
		690	I<Please address all transparency related issues to Sasha Vasko at
		691	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
594		692
595	=item B<fading:> I<number>	693	=item B<fading:> I<number>
596		694
597	Fade the text by the given percentage when focus is lost; option B<-fade>.	695	Fade the text by the given percentage when focus is lost; option B<-fade>.
598		696
…		…
606	Tint the transparent background pixmap with the given colour; option	704	Tint the transparent background pixmap with the given colour; option
607	B<-tint>.	705	B<-tint>.
608		706
609	=item B<shading:> I<number>	707	=item B<shading:> I<number>
610		708
611	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	709	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
612	image in addition to tinting it.	710	in addition to tinting it; option B<-sh>.
		711
		712	=item B<blendType:> I<string>
		713
		714	Specify background blending type; option B<-blt>.
		715
		716	=item B<blurRadius:> I<number>
		717
		718	Apply Gaussian Blurr with the specified radius to the transparent
		719	background image; option B<-blr>.
613		720
614	=item B<scrollColor:> I<colour>	721	=item B<scrollColor:> I<colour>
615		722
616	Use the specified colour for the scrollbar [default #B2B2B2].	723	Use the specified colour for the scrollbar [default #B2B2B2].
617		724
…		…
623	=item B<borderColor:> I<colour>	730	=item B<borderColor:> I<colour>
624		731
625	The colour of the border around the text area and between the scrollbar	732	The colour of the border around the text area and between the scrollbar
626	and the text.	733	and the text.
627		734
628	=item B<backgroundPixmap:> I<file[;geom]>	735	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
629		736
630	Use the specified XPM file (note the `.xpm' extension is optional) for	737	Use the specified image file for the background and also
631	the background and also optionally specify its scaling with a geometry	738	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	739	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
633	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	740	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	741	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	742	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	743	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	744	beyond 10 times its original size. The maximum permitted scale is 1000.
638	scale is 1000. [default 0x0+50+50]	745	Additional operations can be specified after colon B<:op1:op2...>.
		746	Supported operations are:
639		747
640	=item B<menu:> I<file[;tag]>	748	tile force background image to be tiled and not scaled. Equivalent to 0x0
		749	propscale will scale image keeping proportions
		750	auto will scale image to match window size. Equivalent to 100x100
		751	hscale will scale image horizontally to the window size
		752	vscale will scale image vertically to the window size
		753	scale will scale image to match window size
		754	root will tile image as if it was a root window background, auto-adjusting
		755	whenever terminal window moves
641		756
642	Read in the specified menu file (note the `.menu' extension is	757	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	758	blended over transparency image using either alpha-blending, or any
644	reference documentation for details on the syntax for the menuBar.	759	other blending type, specified with B<-blt "type"> option.
645		760
646	=item B<path:> I<path>	761	=item B<path:> I<path>
647		762
648	Specify the colon-delimited search path for finding files (XPM and	763	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		764
652	=item B<font:> I<fontlist>	765	=item B<font:> I<fontlist>
653		766
654	Select the fonts to be used. This is a comma separated list of font	767	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.	768	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	769	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	770	smaller, but not (in general) larger. A (hopefully) reasonable default
658	appended to it; option B<-fn>.	771	font list is always appended to it; option B<-fn>.
659		772
660	Each font can either be a standard X11 core font (XLFD) name, with	773	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:>.	774	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
662		775
663	In addition, each font can be prefixed with additional hints and	776	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	778	hint currently is C<codeset=codeset-name>, and this is only used for Xft
666	fonts.	779	fonts.
667		780
668	For example, this font resource	781	For example, this font resource
669		782
670	URxvt*font: 9x15bold,\	783	URxvt.font: 9x15bold,\
671	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	784	-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, \	785	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
673	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	786	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
674	xft:Code2000:antialias=false	787	xft:Code2000:antialias=false
675		788
…		…
712	text font will being used for the given style.	825	text font will being used for the given style.
713		826
714	=item B<intensityStyles:> I<boolean>	827	=item B<intensityStyles:> I<boolean>
715		828
716	When font styles are not enabled, or this option is enabled (B<True>,	829	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	830	option B<-is>, the default), bold/blink font styles imply high
718	intensity foreground/backround colours. Disabling this option (B<False>,	831	intensity foreground/background colours. Disabling this option (B<False>,
719	option B<+is>) disables this behaviour, the high intensity colours are not	832	option B<+is>) disables this behaviour, the high intensity colours are not
720	reachable.	833	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		834
733	=item B<title:> I<string>	835	=item B<title:> I<string>
734		836
735	Set window title string, the default title is the command-line	837	Set window title string, the default title is the command-line
736	specified after the B<-e> option, if any, otherwise the application	838	specified after the B<-e> option, if any, otherwise the application
…		…
745	=item B<mapAlert:> I<boolean>	847	=item B<mapAlert:> I<boolean>
746		848
747	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	849	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].	850	de-iconify (map) on receipt of a bell character [default].
749		851
		852	=item B<urgentOnBell:> I<boolean>
		853
		854	B<True>: set the urgency hint for the wm on receipt of a bell character.
		855	B<False>: do not set the urgency hint [default].
		856
		857	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		858
750	=item B<visualBell:> I<boolean>	859	=item B<visualBell:> I<boolean>
751		860
752	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	861	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
753	B<False>: no visual bell [default]; option B<+vb>.	862	B<False>: no visual bell [default]; option B<+vb>.
754		863
…		…
772		881
773	The string will be interpreted as if typed into the shell as-is.	882	The string will be interpreted as if typed into the shell as-is.
774		883
775	Example:	884	Example:
776		885
777	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	886	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
778		887
779	This creates a new file in your home directory with the screen contents	888	This creates a new file in your home directory with the screen contents
780	everytime you hit C<Print>.	889	every time you hit C<Print>.
		890
		891	=item B<scrollstyle:> I<mode>
		892
		893	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		894	the author's favourite.
781		895
782	=item B<scrollBar:> I<boolean>	896	=item B<scrollBar:> I<boolean>
783		897
784	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	898	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
785	disable the scrollbar; option B<+sb>.	899	disable the scrollbar; option B<+sb>.
…		…
807		921
808	=item B<scrollWithBuffer:> I<boolean>	922	=item B<scrollWithBuffer:> I<boolean>
809		923
810	B<True>: scroll with scrollback buffer when tty receives new lines (and	924	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	925	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
812	with scrollback buffer when tty recieves new lines; option B<+sw>.	926	with scrollback buffer when tty receives new lines; option B<+sw>.
813		927
814	=item B<scrollTtyKeypress:> I<boolean>	928	=item B<scrollTtyKeypress:> I<boolean>
815		929
816	B<True>: scroll to bottom when a non-special key is pressed. Special keys	930	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	931	are those which are intercepted by rxvt-unicode for special handling and
…		…
848	=item B<termName:> I<termname>	962	=item B<termName:> I<termname>
849		963
850	Specifies the terminal type name to be set in the B<TERM> environment	964	Specifies the terminal type name to be set in the B<TERM> environment
851	variable; option B<-tn>.	965	variable; option B<-tn>.
852		966
853	=item B<linespace:> I<number>	967	=item B<lineSpace:> I<number>
854		968
855	Specifies number of lines (pixel height) to insert between each row of	969	Specifies number of lines (pixel height) to insert between each row of
856	the display [default 0]; option B<-lsp>.	970	the display [default 0]; option B<-lsp>.
857		971
858	=item B<meta8:> I<boolean>	972	=item B<meta8:> I<boolean>
…		…
907	pressed. If unset it will send the sequence traditionally associated	1021	pressed. If unset it will send the sequence traditionally associated
908	with the B<Execute> key.	1022	with the B<Execute> key.
909		1023
910	=item B<cutchars:> I<string>	1024	=item B<cutchars:> I<string>
911		1025
912	The characters used as delimiters for double-click word selection. The	1026	The characters used as delimiters for double-click word selection
913	built-in default:	1027	(whitespace delimiting is added automatically if resource is given).
914		1028
		1029	When the perl selection extension is in use (the default if compiled
		1030	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		1031	characters will be created (if the resource exists, otherwise, no regex
		1032	will be created). In this mode, characters outside ISO-8859-1 can be used.
		1033
		1034	When the selection extension is not used, only ISO-8859-1 characters can
		1035	be used. If not specified, the built-in default is used:
		1036
915	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1037	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
916		1038
917	=item B<preeditType:> I<style>	1039	=item B<preeditType:> I<style>
918		1040
919	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1041	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
920		1042
…		…
954	default. (Note that many other terminals, including xterm, have these	1076	default. (Note that many other terminals, including xterm, have these
955	sequences enabled by default, which doesn't make it safer, though).	1077	sequences enabled by default, which doesn't make it safer, though).
956		1078
957	You can enable them by setting this boolean resource or specifying	1079	You can enable them by setting this boolean resource or specifying
958	B<-insecure> as an option. At the moment, this enables display-answer,	1080	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	1081	locale, findfont, icon label and window title requests.
960	menubar dispatch.
961		1082
962	=item B<modifier:> I<modifier>	1083	=item B<modifier:> I<modifier>
963		1084
964	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	1085	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	1086	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
969		1090
970	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	1091	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	1092	character is passed through. It may contain escape values as described
972	in the entry on B<keysym> following.	1093	in the entry on B<keysym> following.
973		1094
974	=item B<secondaryScreen:> I<bool>	1095	=item B<secondaryScreen:> I<boolean>
975		1096
976	Turn on/off secondary screen (default enabled).	1097	Turn on/off secondary screen (default enabled).
977		1098
978	=item B<secondaryScroll:> I<bool>	1099	=item B<secondaryScroll:> I<boolean>
979		1100
980	Turn on/off secondary screen scroll (default enabled). If the this	1101	Turn on/off secondary screen scroll (default enabled). If this
981	option is enabled, scrolls on the secondary screen will change the	1102	option is enabled, scrolls on the secondary screen will change the
982	scrollback buffer and switching to/from the secondary screen will	1103	scrollback buffer and, when secondaryScreen is off, switching
983	instead scroll the screen up.	1104	to/from the secondary screen will instead scroll the screen up.
984		1105
985	=item B<hold>: I<bool>	1106	=item B<hold>: I<boolean>
986		1107
987	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1108	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
988	will not immediately destroy its window when the program executed within	1109	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	1110	it exits. Instead, it will wait till it is being killed or closed by the
990	user.	1111	user.
		1112
		1113	=item B<chdir>: I<path>
		1114
		1115	Sets the working directory for the shell (or the command specified via
		1116	B<-e>). The I<path> must be an absolute path and it must exist for
		1117	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1118	directory will be used; option B<-cd>.
991		1119
992	=item B<keysym.>I<sym>: I<string>	1120	=item B<keysym.>I<sym>: I<string>
993		1121
994	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1122	Compile I<frills>: Associate I<string> with keysym I<sym>. The
995	intervening resource name B<keysym.> cannot be omitted.	1123	intervening resource name B<keysym.> cannot be omitted.
…		…
1009	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1137	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	1138	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	1139	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.	1140	performed in an exact manner; however, the closest match is assured.
1013		1141
1014	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1142	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,	1143	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		1144
1025	You can define a range of keysyms in one shot by providing a I<string>	1145	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 `/'	1146	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1027	should be a character not used by the strings.	1147	should be a character not used by the strings.
1028		1148
1029	Its usage can be demonstrated by an example:	1149	Its usage can be demonstrated by an example:
1030		1150
1031	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1151	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
…		…
1095	example, C<default,-selection> will use all the default extension except	1215	example, C<default,-selection> will use all the default extension except
1096	C<selection>.	1216	C<selection>.
1097		1217
1098	Extension names can also be followed by an argument in angle brackets	1218	Extension names can also be followed by an argument in angle brackets
1099	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1219	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1100	searchable scorllback to Alt/Meta-s). Mentioning the same extension	1220	searchable scrollback to Alt/Meta-s). Mentioning the same extension
1101	multiple times with different arguments will pass multiple arguments to	1221	multiple times with different arguments will pass multiple arguments to
1102	the extension.	1222	the extension.
1103		1223
1104	Each extension is looked up in the library directories, loaded if	1224	Each extension is looked up in the library directories, loaded if
1105	necessary, and bound to the current terminal instance.	1225	necessary, and bound to the current terminal instance.
…		…
1110	all instances, while B<perl-ext> is used for specific instances.	1230	all instances, while B<perl-ext> is used for specific instances.
1111		1231
1112	=item B<perl-eval>: I<string>	1232	=item B<perl-eval>: I<string>
1113		1233
1114	Perl code to be evaluated when all extensions have been registered. See	1234	Perl code to be evaluated when all extensions have been registered. See
1115	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1235	the @@RXVT_NAME@@perl(3) manpage.
1116	will be ignored when running setuid/setgid.
1117		1236
1118	=item B<perl-lib>: I<path>	1237	=item B<perl-lib>: I<path>
1119		1238
1120	Colon-separated list of additional directories that hold extension	1239	Colon-separated list of additional directories that hold extension
1121	scripts. When looking for extensions specified by the C<perl> resource,	1240	scripts. When looking for extensions specified by the C<perl> resource,
1122	@@RXVT_NAME@@ will first look in these directories and then in	1241	@@RXVT_NAME@@ will first look in these directories and then in
1123	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1242	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1124	will be ignored when running setuid/setgid.
1125		1243
1126	See the @@RXVT_NAME@@perl(3) manpage.	1244	See the @@RXVT_NAME@@perl(3) manpage.
1127		1245
		1246	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1247
		1248	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1249	details.
		1250
		1251	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1252
		1253	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1254	for details.
		1255
		1256	=item B<searchable-scrollback:> I<keysym>
		1257
		1258	Sets the hotkey that starts the incremental scrollback buffer search
		1259	(default: C<M-s>).
		1260
1128	=item B<urlLauncher>: I<string>	1261	=item B<urlLauncher>: I<string>
1129		1262
1130	Specifies the program to be started with a URL argument. Used by the	1263	Specifies the program to be started with a URL argument. Used by the
1131	C<selection-popup> and C<mark-urls> perl extensions.	1264	C<selection-popup> and C<matcher> perl extensions.
1132		1265
1133	=item B<transient-for>: I<windowid>	1266	=item B<transient-for>: I<windowid>
1134		1267
1135	Sets the WM_TRANSIENT_FOR property to the given window iw.	1268	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1269
		1270	=item B<override-redirect>: I<boolean>
		1271
		1272	Compile I<frills>: Sets override-redirect for the terminal window, making
		1273	it almost invisible to window managers; option B<-override-redirect>.
		1274
		1275	=item B<iso14755_52:> I<boolean>
		1276
		1277	Turn on/off ISO 14755 5.2 mode (default enabled).
1136		1278
1137	=back	1279	=back
1138		1280
1139	=head1 THE SCROLLBAR	1281	=head1 THE SCROLLBAR
1140		1282
…		…
1159	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1301	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1160	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1302	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1161	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1303	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1162	respectively.	1304	respectively.
1163		1305
1164	=head1 TEXT SELECTION AND INSERTION	1306	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1165		1307
1166	The behaviour of text selection and insertion mechanism is similar to	1308	The behaviour of text selection and insertion/pasting mechanism is similar
1167	I<xterm>(1).	1309	to I<xterm>(1).
1168		1310
1169	=over 4	1311	=over 4
1170		1312
1171	=item B<Selection>:	1313	=item B<Selecting>:
1172		1314
1173	Left click at the beginning of the region, drag to the end of the region	1315	Left click at the beginning of the region, drag to the end of the region
1174	and release; Right click to extend the marked region; Left double-click	1316	and release; Right click to extend the marked region; Left double-click
1175	to select a word; Left triple-click to select the entire logical line	1317	to select a word; Left triple-click to select the entire logical line
1176	(which can span multiple screen lines), unless modified by resource	1318	(which can span multiple screen lines), unless modified by resource
…		…
1180	(Compile: I<frills>) will create a rectangular selection instead of a	1322	(Compile: I<frills>) will create a rectangular selection instead of a
1181	normal one. In this mode, every selected row becomes its own line in the	1323	normal one. In this mode, every selected row becomes its own line in the
1182	selection, and trailing whitespace is visually underlined and removed from	1324	selection, and trailing whitespace is visually underlined and removed from
1183	the selection.	1325	the selection.
1184		1326
1185	=item B<Insertion>:	1327	=item B<Pasting>:
1186		1328
1187	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1329	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1188	an B<@@RXVT_NAME@@> window causes the current text selection to be	1330	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1189	inserted as if it had been typed on the keyboard.	1331	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1332
		1333	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1334	inserted too.
1190		1335
1191	=back	1336	=back
1192		1337
1193	=head1 CHANGING FONTS	1338	=head1 CHANGING FONTS
1194		1339
1195	Changing fonts (or font sizes, respectively) via the keypad is not yet	1340	Changing fonts (or font sizes, respectively) via the keypad is not yet
1196	supported in rxvt-unicode. Bug me if you need this.	1341	supported in rxvt-unicode. Bug me if you need this.
1197		1342
1198	You can, however, switch fonts at runtime using escape sequences (and	1343	You can, however, switch fonts at runtime using escape sequences, e.g.:
1199	therefore using the menubar), e.g.:
1200		1344
1201	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"	1345	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1346
		1347	You can use keyboard shortcuts, too:
		1348
		1349	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1350	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1202		1351
1203	rxvt-unicode will automatically re-apply these fonts to the output so far.	1352	rxvt-unicode will automatically re-apply these fonts to the output so far.
1204		1353
1205	=head1 ISO 14755 SUPPORT	1354	=head1 ISO 14755 SUPPORT
1206		1355
1207	ISO 14755 is a standard for entering and viewing unicode characters	1356	ISO 14755 is a standard for entering and viewing unicode characters
1208	and character codes using the keyboard. It consists of 4 parts. The	1357	and character codes using the keyboard. It consists of 4 parts. The
1209	first part is available rxvt-unicode has been compiled with	1358	first part is available if rxvt-unicode has been compiled with
1210	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1359	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1211	with C<--enable-iso14755>.	1360	with C<--enable-iso14755>.
1212		1361
1213	=over 4	1362	=over 4
1214		1363
…		…
1234	This mode lets you input characters representing the keycap symbols of	1383	This mode lets you input characters representing the keycap symbols of
1235	your keyboard, if representable in the current locale encoding.	1384	your keyboard, if representable in the current locale encoding.
1236		1385
1237	Start by pressing C<Control> and C<Shift> together, then releasing	1386	Start by pressing C<Control> and C<Shift> together, then releasing
1238	them. The next special key (cursor keys, home etc.) you enter will not	1387	them. The next special key (cursor keys, home etc.) you enter will not
1239	invoke it's usual function but instead will insert the corresponding	1388	invoke its usual function but instead will insert the corresponding
1240	keycap symbol. The symbol will only be entered when the key has been	1389	keycap symbol. The symbol will only be entered when the key has been
1241	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1390	released, otherwise pressing e.g. C<Shift> would enter the symbol for
1242	C<ISO Level 2 Switch>, although your intention might have been to enter a	1391	C<ISO Level 2 Switch>, although your intention might have been to enter a
1243	reverse tab (Shift-Tab).	1392	reverse tab (Shift-Tab).
1244		1393
…		…
1277	=head1 COLORS AND GRAPHICS	1426	=head1 COLORS AND GRAPHICS
1278		1427
1279	In addition to the default foreground and background colours,	1428	In addition to the default foreground and background colours,
1280	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1429	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1281	high-intensity bold/blink versions of the same). Here is a list of the	1430	high-intensity bold/blink versions of the same). Here is a list of the
1282	colours with their B<rgb.txt> names.	1431	colours with their names.
1283		1432
1284	=begin table	1433	=begin table
1285		1434
1286	B<color0> (black) = Black	1435	B<color0> (black) = Black
1287	B<color1> (red) = Red3	1436	B<color1> (red) = Red3
…		…
1307	It is also possible to specify the colour values of B<foreground>,	1456	It is also possible to specify the colour values of B<foreground>,
1308	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1457	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1309	a number 0-15, as a convenient shorthand to reference the colour name of	1458	a number 0-15, as a convenient shorthand to reference the colour name of
1310	color0-color15.	1459	color0-color15.
1311		1460
		1461	In addition to the colours defined above, @@RXVT_NAME@@ offers an
		1462	additional 72 colours. The first 64 of those (with indices 16 to 79)
		1463	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
		1464	16>), followed by 8 additional shades of gray (with indices 80 to 87).
		1465
		1466	Together, all those colours implement the 88 colour xterm colours. Only
		1467	the first 16 can be changed using resources currently, the rest can only
		1468	be changed via command sequences ("escape codes").
		1469
1312	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1470	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1313	always swapping the foreground/background colours. This is in contrast to	1471	always swapping the foreground/background colours. This is in contrast to
1314	I<xterm>(1) where the colours are only swapped if they have not otherwise	1472	I<xterm>(1) where the colours are only swapped if they have not otherwise
1315	been specified. For example,	1473	been specified. For example,
1316		1474
…		…
1321	would yield White on Black, while on I<xterm>(1) it would yield Black	1479	would yield White on Black, while on I<xterm>(1) it would yield Black
1322	on White.	1480	on White.
1323		1481
1324	=back	1482	=back
1325		1483
		1484	=head2 ALPHA CHANNEL SUPPORT
		1485
		1486	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1487	their act together, rxvt-unicode will do it's own alpha channel management:
		1488
		1489	You can prefix any color with an opaquenes percentage enclosed in
		1490	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1491	(0-100) that specifies the opacity of the color, where C<0> is completely
		1492	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1493	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1494	is the recommended format to specify transparency values, and works with
		1495	all ways to specify a colour.
		1496
		1497	For complete control, rxvt-unicode also supports
		1498	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1499	specifications, where the additional C<aaaa> component specifies opacity
		1500	(alpha) values. The minimum value of C<0000> is completely transparent,
		1501	while C<ffff> is completely opaque). The two example colours from
		1502	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1503	C<rgba:0000/ff00/0000/f332>.
		1504
		1505	You probably need to specify B<"-depth 32">, too, to force a visual with
		1506	alpha channels, and have the luck that your X-server uses ARGB pixel
		1507	layout, as X is far from just supporting ARGB visuals out of the box, and
		1508	rxvt-unicode just fudges around.
		1509
		1510	For example, the following selects an almost completely transparent black
		1511	background, and an almost opaque pink foreground:
		1512
		1513	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
		1514
		1515	When not using a background image, then the interpretation of the
		1516	alpha channel is up to your compositing manager (most interpret it as
		1517	transparency of course).
		1518
		1519	When using a background pixmap or pseudo-transparency, then the background
		1520	colour will always behave as if it were completely transparent (so the
		1521	background image shows instead), regardless of how it was specified, while
		1522	other colours will either be transparent as specified (the background
		1523	image will show through) on servers supporting the RENDER extension, or
		1524	fully opaque on servers not supporting the RENDER EXTENSION.
		1525
		1526	Please note that due to bugs in Xft, specifying alpha values might result
		1527	in garbage being displayed when the X-server does not support the RENDER
		1528	extension.
		1529
1326	=head1 ENVIRONMENT	1530	=head1 ENVIRONMENT
1327		1531
1328	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1532	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1329		1533
1330	=over 4	1534	=over 4
1331		1535
1332	=item B<TERM>	1536	=item B<TERM>
1333		1537
1334	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1538	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1335	resources or on the commandline.	1539	resources or on the command line.
1336		1540
1337	=item B<COLORTERM>	1541	=item B<COLORTERM>
1338		1542
1339	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1543	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1340	compiled with XPM support, and optionally with the added extension	1544	compiled with background image support, and optionally with the added
1341	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1545	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1546	screen.
1342		1547
1343	=item B<COLORFGBG>	1548	=item B<COLORFGBG>
1344		1549
1345	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1550	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1346	the colour code used as default foreground/text colour (or the string	1551	the colour code used as default foreground/text colour (or the string
1347	C<default> to indicate that the default-colour escape sequence is to be	1552	C<default> to indicate that the default-colour escape sequence is to be
1348	used), C<bg> is the colour code used as default background colour (or the	1553	used), C<bg> is the colour code used as default background colour (or the
1349	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1554	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1350	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1555	was compiled with background image support. Libraries like C<ncurses>
1351	(and do) use this information to optimize screen output.	1556	and C<slang> can (and do) use this information to optimize screen output.
1352		1557
1353	=item B<WINDOWID>	1558	=item B<WINDOWID>
1354		1559
1355	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1560	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1356	window, which usually has subwindows for the scrollbar, the terminal	1561	window, which usually has subwindows for the scrollbar, the terminal
…		…
1362	C<--with-terminfo=PATH>.	1567	C<--with-terminfo=PATH>.
1363		1568
1364	=item B<DISPLAY>	1569	=item B<DISPLAY>
1365		1570
1366	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1571	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1367	display in it's child processes.	1572	display in its child processes if C<-display> isn't used to override. It
		1573	defaults to C<:0> if it doesn't exist.
1368		1574
1369	=item B<SHELL>	1575	=item B<SHELL>
1370		1576
1371	The shell to be used for command execution, defaults to C</bin/sh>.	1577	The shell to be used for command execution, defaults to C</bin/sh>.
1372
1373	=item B<RXVTPATH>
1374
1375	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1376	files.
1377
1378	=item B<PATH>
1379
1380	Used in the same way as C<RXVTPATH>.
1381		1578
1382	=item B<RXVT_SOCKET>	1579	=item B<RXVT_SOCKET>
1383		1580
1384	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1581	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1385	@@RXVT_NAME@@d(1).	1582	@@RXVT_NAME@@d(1).
…		…
1423		1620
1424	=item Project Coordinator	1621	=item Project Coordinator
1425		1622
1426	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1623	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1427		1624
1428	L<http://software.schmorp.de/#rxvt-unicode>	1625	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1429		1626
1430	=back	1627	=back
1431		1628
1432	=head1 AUTHORS	1629	=head1 AUTHORS
1433		1630
…		…
1455		1652
1456	Project Coordinator (changes.txt 2.21a to 2.4.5)	1653	Project Coordinator (changes.txt 2.21a to 2.4.5)
1457		1654
1458	=item Geoff Wing L<< <gcw@pobox.com> >>	1655	=item Geoff Wing L<< <gcw@pobox.com> >>
1459		1656
1460	Rewrote screen display and text selection routines. Project Coordinator	1657	Rewrote screen display and text selection routines.
		1658
1461	(changes.txt 2.4.6 - rxvt-unicode)	1659	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1462		1660
1463	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1661	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1464		1662
1465	Forked rxvt-unicode, rewrote most of the display code and internal	1663	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1466	character handling to store text in unicode, improve xterm	1664	extension, random hacks, numerous bugfixes and extensions.
1467	compatibility and apply numerous other bugfixes and extensions.
1468		1665
1469	Project Coordinator (Changes 1.0 -)	1666	Project Coordinator (Changes 1.0 -)
1470		1667
		1668	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1669
		1670	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
		1671
1471	=back	1672	=back
1472		1673

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.92 by root, Wed Jan 11 02:13:55 2006 UTC vs. Revision 1.167 by root, Wed Oct 15 14:48:22 2008 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.92 by root, Wed Jan 11 02:13:55 2006 UTC vs.
Revision 1.167 by root, Wed Oct 15 14:48:22 2008 UTC