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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.96 by root, Fri Jan 13 12:40:46 2006 UTC vs.
Revision 1.166 by root, Fri Oct 10 13:23:56 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
…		…
177	that are checked in order when trying to find glyphs for 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	You can set and change the resources using X11 tools like B<xrdb>. Many	554	You can set and change the resources using X11 tools like B<xrdb>. Many
482	distribution do also load settings from the B<~/.Xresources> file when X	555	distribution do also load settings from the B<~/.Xresources> file when X
483	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	556	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
484	with later settings overwriting earlier ones:	557	with later settings overwriting earlier ones:
…		…
486	1. system-wide app-defaults file, either locale-dependent OR global	559	1. system-wide app-defaults file, either locale-dependent OR global
487	2. app-defaults file in $XAPPLRESDIR	560	2. app-defaults file in $XAPPLRESDIR
488	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	561	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
489	4. SCREEN_RESOURCES for the current screen	562	4. SCREEN_RESOURCES for the current screen
490	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	563	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		564	6. resources specified via -xrm on the commandline
491		565
492	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	566	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
493	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	567	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
494	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily	568	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
495	configured, while the class name B<URxvt> allows resources unique to	569	configured, while the class name B<URxvt> allows resources unique to
…		…
500	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl	574	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
501	extensions not documented here):	575	extensions not documented here):
502		576
503	=over 4	577	=over 4
504		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.
		590
505	=item B<geometry:> I<geom>	591	=item B<geometry:> I<geom>
506		592
507	Create the window with the specified X window geometry [default 80x24];	593	Create the window with the specified X window geometry [default 80x24];
508	option B<-geometry>.	594	option B<-geometry>.
509		595
…		…
545	Use the specified colour to display underlined characters when the	631	Use the specified colour to display underlined characters when the
546	foreground colour is the default.	632	foreground colour is the default.
547		633
548	=item B<colorRV:> I<colour>	634	=item B<colorRV:> I<colour>
549		635
550	Use the specified colour as the background for reverse video	636	Use the specified colour as the background for reverse video characters
551	characters.	637	when OPTION_HC is disabled (--disable-frills).
552		638
553	=item B<underlineColor:> I<colour>	639	=item B<underlineColor:> I<colour>
554		640
555	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
556	itself. If unset, use the foreground colour.	642	itself. If unset, use the foreground colour.
…		…
572	option B<-rv>. B<False>: regular screen colours [default]; option	658	option B<-rv>. B<False>: regular screen colours [default]; option
573	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	659	B<+rv>. See note in B<COLORS AND GRAPHICS> section.
574		660
575	=item B<jumpScroll:> I<boolean>	661	=item B<jumpScroll:> I<boolean>
576		662
577	B<True>: specify that jump scrolling should be used. When scrolling	663	B<True>: specify that jump scrolling should be used. When receiving lots
578	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
579	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>.
580		670
581	=item B<inheritPixmap:> I<boolean>	671	=item B<skipScroll:> I<boolean>
582		672
583	B<True>: make the background inherit the parent windows' pixmap, giving	673	B<True>: (the default) specify that skip scrolling should be used. When
584	artificial transparency. B<False>: do not inherit the parent windows'	674	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
585	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@@)!>
586		692
587	=item B<fading:> I<number>	693	=item B<fading:> I<number>
588		694
589	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>.
590		696
…		…
598	Tint the transparent background pixmap with the given colour; option	704	Tint the transparent background pixmap with the given colour; option
599	B<-tint>.	705	B<-tint>.
600		706
601	=item B<shading:> I<number>	707	=item B<shading:> I<number>
602		708
603	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	709	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
604	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>.
605		720
606	=item B<scrollColor:> I<colour>	721	=item B<scrollColor:> I<colour>
607		722
608	Use the specified colour for the scrollbar [default #B2B2B2].	723	Use the specified colour for the scrollbar [default #B2B2B2].
609		724
…		…
615	=item B<borderColor:> I<colour>	730	=item B<borderColor:> I<colour>
616		731
617	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
618	and the text.	733	and the text.
619		734
620	=item B<backgroundPixmap:> I<file[;geom]>	735	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
621		736
622	Use the specified XPM file (note the `.xpm' extension is optional) for	737	Use the specified image file for the background and also
623	the background and also optionally specify its scaling with a geometry	738	optionally specify its scaling with a geometry string B<WxH+X+Y>,
624	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
625	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	740	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
626	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
627	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
628	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
629	be magnified beyond 10 times its original size. The maximum permitted	744	beyond 10 times its original size. The maximum permitted scale is 1000.
630	scale is 1000. [default 0x0+50+50]	745	Additional operations can be specified after colon B<:op1:op2...>.
		746	Supported operations are:
631		747
632	=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
633		756
634	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
635	optional) and also optionally specify a starting tag to find. See the	758	blended over transparency image using either alpha-blending, or any
636	reference documentation for details on the syntax for the menuBar.	759	other blending type, specified with B<-blt "type"> option.
637		760
638	=item B<path:> I<path>	761	=item B<path:> I<path>
639		762
640	Specify the colon-delimited search path for finding files (XPM and	763	Specify the colon-delimited search path for finding background image files.
641	menus), in addition to the paths specified by the B<RXVTPATH> and
642	B<PATH> environment variables.
643		764
644	=item B<font:> I<fontlist>	765	=item B<font:> I<fontlist>
645		766
646	Select the fonts to be used. This is a comma separated list of font names	767	Select the fonts to be used. This is a comma separated list of font names
647	that are checked in order when trying to find glyphs for characters. The	768	that are checked in order when trying to find glyphs for characters. The
…		…
657	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
658	fonts.	779	fonts.
659		780
660	For example, this font resource	781	For example, this font resource
661		782
662	URxvt*font: 9x15bold,\	783	URxvt.font: 9x15bold,\
663	-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,\
664	-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, \
665	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	786	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
666	xft:Code2000:antialias=false	787	xft:Code2000:antialias=false
667		788
…		…
704	text font will being used for the given style.	825	text font will being used for the given style.
705		826
706	=item B<intensityStyles:> I<boolean>	827	=item B<intensityStyles:> I<boolean>
707		828
708	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>,
709	option B<-is>, the default), bold and italic font styles imply high	830	option B<-is>, the default), bold/blink font styles imply high
710	intensity foreground/backround colours. Disabling this option (B<False>,	831	intensity foreground/background colours. Disabling this option (B<False>,
711	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
712	reachable.	833	reachable.
713
714	=item B<selectstyle:> I<mode>
715
716	Set mouse selection style to B<old> which is 2.20, B<oldword> which is
717	xterm style with 2.20 old word selection, or anything else which gives
718	xterm style selection.
719
720	=item B<scrollstyle:> I<mode>
721
722	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
723	the author's favourite.
724		834
725	=item B<title:> I<string>	835	=item B<title:> I<string>
726		836
727	Set window title string, the default title is the command-line	837	Set window title string, the default title is the command-line
728	specified after the B<-e> option, if any, otherwise the application	838	specified after the B<-e> option, if any, otherwise the application
…		…
737	=item B<mapAlert:> I<boolean>	847	=item B<mapAlert:> I<boolean>
738		848
739	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
740	de-iconify (map) on receipt of a bell character [default].	850	de-iconify (map) on receipt of a bell character [default].
741		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
742	=item B<visualBell:> I<boolean>	857	=item B<visualBell:> I<boolean>
743		858
744	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	859	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
745	B<False>: no visual bell [default]; option B<+vb>.	860	B<False>: no visual bell [default]; option B<+vb>.
746		861
…		…
764		879
765	The string will be interpreted as if typed into the shell as-is.	880	The string will be interpreted as if typed into the shell as-is.
766		881
767	Example:	882	Example:
768		883
769	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	884	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
770		885
771	This creates a new file in your home directory with the screen contents	886	This creates a new file in your home directory with the screen contents
772	everytime you hit C<Print>.	887	every time you hit C<Print>.
		888
		889	=item B<scrollstyle:> I<mode>
		890
		891	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		892	the author's favourite.
773		893
774	=item B<scrollBar:> I<boolean>	894	=item B<scrollBar:> I<boolean>
775		895
776	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	896	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
777	disable the scrollbar; option B<+sb>.	897	disable the scrollbar; option B<+sb>.
…		…
799		919
800	=item B<scrollWithBuffer:> I<boolean>	920	=item B<scrollWithBuffer:> I<boolean>
801		921
802	B<True>: scroll with scrollback buffer when tty receives new lines (and	922	B<True>: scroll with scrollback buffer when tty receives new lines (and
803	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	923	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
804	with scrollback buffer when tty recieves new lines; option B<+sw>.	924	with scrollback buffer when tty receives new lines; option B<+sw>.
805		925
806	=item B<scrollTtyKeypress:> I<boolean>	926	=item B<scrollTtyKeypress:> I<boolean>
807		927
808	B<True>: scroll to bottom when a non-special key is pressed. Special keys	928	B<True>: scroll to bottom when a non-special key is pressed. Special keys
809	are those which are intercepted by rxvt-unicode for special handling and	929	are those which are intercepted by rxvt-unicode for special handling and
…		…
840	=item B<termName:> I<termname>	960	=item B<termName:> I<termname>
841		961
842	Specifies the terminal type name to be set in the B<TERM> environment	962	Specifies the terminal type name to be set in the B<TERM> environment
843	variable; option B<-tn>.	963	variable; option B<-tn>.
844		964
845	=item B<linespace:> I<number>	965	=item B<lineSpace:> I<number>
846		966
847	Specifies number of lines (pixel height) to insert between each row of	967	Specifies number of lines (pixel height) to insert between each row of
848	the display [default 0]; option B<-lsp>.	968	the display [default 0]; option B<-lsp>.
849		969
850	=item B<meta8:> I<boolean>	970	=item B<meta8:> I<boolean>
…		…
899	pressed. If unset it will send the sequence traditionally associated	1019	pressed. If unset it will send the sequence traditionally associated
900	with the B<Execute> key.	1020	with the B<Execute> key.
901		1021
902	=item B<cutchars:> I<string>	1022	=item B<cutchars:> I<string>
903		1023
904	The characters used as delimiters for double-click word selection. The	1024	The characters used as delimiters for double-click word selection
905	built-in default:	1025	(whitespace delimiting is added automatically if resource is given).
906		1026
		1027	When the perl selection extension is in use (the default if compiled
		1028	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		1029	characters will be created (if the resource exists, otherwise, no regex
		1030	will be created). In this mode, characters outside ISO-8859-1 can be used.
		1031
		1032	When the selection extension is not used, only ISO-8859-1 characters can
		1033	be used. If not specified, the built-in default is used:
		1034
907	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1035	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
908		1036
909	=item B<preeditType:> I<style>	1037	=item B<preeditType:> I<style>
910		1038
911	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1039	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
912		1040
…		…
946	default. (Note that many other terminals, including xterm, have these	1074	default. (Note that many other terminals, including xterm, have these
947	sequences enabled by default, which doesn't make it safer, though).	1075	sequences enabled by default, which doesn't make it safer, though).
948		1076
949	You can enable them by setting this boolean resource or specifying	1077	You can enable them by setting this boolean resource or specifying
950	B<-insecure> as an option. At the moment, this enables display-answer,	1078	B<-insecure> as an option. At the moment, this enables display-answer,
951	locale, findfont, icon label and window title requests as well as dynamic	1079	locale, findfont, icon label and window title requests.
952	menubar dispatch.
953		1080
954	=item B<modifier:> I<modifier>	1081	=item B<modifier:> I<modifier>
955		1082
956	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	1083	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
957	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	1084	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
961		1088
962	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	1089	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
963	character is passed through. It may contain escape values as described	1090	character is passed through. It may contain escape values as described
964	in the entry on B<keysym> following.	1091	in the entry on B<keysym> following.
965		1092
966	=item B<secondaryScreen:> I<bool>	1093	=item B<secondaryScreen:> I<boolean>
967		1094
968	Turn on/off secondary screen (default enabled).	1095	Turn on/off secondary screen (default enabled).
969		1096
970	=item B<secondaryScroll:> I<bool>	1097	=item B<secondaryScroll:> I<boolean>
971		1098
972	Turn on/off secondary screen scroll (default enabled). If the this	1099	Turn on/off secondary screen scroll (default enabled). If this
973	option is enabled, scrolls on the secondary screen will change the	1100	option is enabled, scrolls on the secondary screen will change the
974	scrollback buffer and switching to/from the secondary screen will	1101	scrollback buffer and, when secondaryScreen is off, switching
975	instead scroll the screen up.	1102	to/from the secondary screen will instead scroll the screen up.
976		1103
977	=item B<hold>: I<bool>	1104	=item B<hold>: I<boolean>
978		1105
979	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1106	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
980	will not immediately destroy its window when the program executed within	1107	will not immediately destroy its window when the program executed within
981	it exits. Instead, it will wait till it is being killed or closed by the	1108	it exits. Instead, it will wait till it is being killed or closed by the
982	user.	1109	user.
		1110
		1111	=item B<chdir>: I<path>
		1112
		1113	Sets the working directory for the shell (or the command specified via
		1114	B<-e>). The I<path> must be an absolute path and it must exist for
		1115	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1116	directory will be used; option B<-cd>.
983		1117
984	=item B<keysym.>I<sym>: I<string>	1118	=item B<keysym.>I<sym>: I<string>
985		1119
986	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1120	Compile I<frills>: Associate I<string> with keysym I<sym>. The
987	intervening resource name B<keysym.> cannot be omitted.	1121	intervening resource name B<keysym.> cannot be omitted.
…		…
1001	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1135	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1002	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1136	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1003	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1137	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1004	performed in an exact manner; however, the closest match is assured.	1138	performed in an exact manner; however, the closest match is assured.
1005		1139
1006	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1140	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1007	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1141	number), see RESOURCES in C<man 7 X> for futher details.
1008	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1009	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1010	can start or end with whitespace.
1011
1012	Please note that you need to double the C<\> in resource files, as
1013	Xlib itself does it's own de-escaping (you can use C<\033> instead of
1014	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1015	processing).
1016		1142
1017	You can define a range of keysyms in one shot by providing a I<string>	1143	You can define a range of keysyms in one shot by providing a I<string>
1018	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1144	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1019	should be a character not used by the strings.	1145	should be a character not used by the strings.
1020		1146
1021	Its usage can be demonstrated by an example:	1147	Its usage can be demonstrated by an example:
1022		1148
1023	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1149	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
…		…
1087	example, C<default,-selection> will use all the default extension except	1213	example, C<default,-selection> will use all the default extension except
1088	C<selection>.	1214	C<selection>.
1089		1215
1090	Extension names can also be followed by an argument in angle brackets	1216	Extension names can also be followed by an argument in angle brackets
1091	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1217	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1092	searchable scorllback to Alt/Meta-s). Mentioning the same extension	1218	searchable scrollback to Alt/Meta-s). Mentioning the same extension
1093	multiple times with different arguments will pass multiple arguments to	1219	multiple times with different arguments will pass multiple arguments to
1094	the extension.	1220	the extension.
1095		1221
1096	Each extension is looked up in the library directories, loaded if	1222	Each extension is looked up in the library directories, loaded if
1097	necessary, and bound to the current terminal instance.	1223	necessary, and bound to the current terminal instance.
…		…
1102	all instances, while B<perl-ext> is used for specific instances.	1228	all instances, while B<perl-ext> is used for specific instances.
1103		1229
1104	=item B<perl-eval>: I<string>	1230	=item B<perl-eval>: I<string>
1105		1231
1106	Perl code to be evaluated when all extensions have been registered. See	1232	Perl code to be evaluated when all extensions have been registered. See
1107	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1233	the @@RXVT_NAME@@perl(3) manpage.
1108	will be ignored when running setuid/setgid.
1109		1234
1110	=item B<perl-lib>: I<path>	1235	=item B<perl-lib>: I<path>
1111		1236
1112	Colon-separated list of additional directories that hold extension	1237	Colon-separated list of additional directories that hold extension
1113	scripts. When looking for extensions specified by the C<perl> resource,	1238	scripts. When looking for extensions specified by the C<perl> resource,
1114	@@RXVT_NAME@@ will first look in these directories and then in	1239	@@RXVT_NAME@@ will first look in these directories and then in
1115	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1240	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1116	will be ignored when running setuid/setgid.
1117		1241
1118	See the @@RXVT_NAME@@perl(3) manpage.	1242	See the @@RXVT_NAME@@perl(3) manpage.
1119		1243
1120	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1244	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1121		1245
…		…
1133	(default: C<M-s>).	1257	(default: C<M-s>).
1134		1258
1135	=item B<urlLauncher>: I<string>	1259	=item B<urlLauncher>: I<string>
1136		1260
1137	Specifies the program to be started with a URL argument. Used by the	1261	Specifies the program to be started with a URL argument. Used by the
1138	C<selection-popup> and C<mark-urls> perl extensions.	1262	C<selection-popup> and C<matcher> perl extensions.
1139		1263
1140	=item B<transient-for>: I<windowid>	1264	=item B<transient-for>: I<windowid>
1141		1265
1142	Sets the WM_TRANSIENT_FOR property to the given window iw.	1266	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1267
		1268	=item B<override-redirect>: I<boolean>
		1269
		1270	Compile I<frills>: Sets override-redirect for the terminal window, making
		1271	it almost invisible to window managers; option B<-override-redirect>.
		1272
		1273	=item B<iso14755_52:> I<boolean>
		1274
		1275	Turn on/off ISO 14755 5.2 mode (default enabled).
1143		1276
1144	=back	1277	=back
1145		1278
1146	=head1 THE SCROLLBAR	1279	=head1 THE SCROLLBAR
1147		1280
…		…
1166	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1299	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1167	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1300	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1168	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1301	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1169	respectively.	1302	respectively.
1170		1303
1171	=head1 TEXT SELECTION AND INSERTION	1304	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1172		1305
1173	The behaviour of text selection and insertion mechanism is similar to	1306	The behaviour of text selection and insertion/pasting mechanism is similar
1174	I<xterm>(1).	1307	to I<xterm>(1).
1175		1308
1176	=over 4	1309	=over 4
1177		1310
1178	=item B<Selection>:	1311	=item B<Selecting>:
1179		1312
1180	Left click at the beginning of the region, drag to the end of the region	1313	Left click at the beginning of the region, drag to the end of the region
1181	and release; Right click to extend the marked region; Left double-click	1314	and release; Right click to extend the marked region; Left double-click
1182	to select a word; Left triple-click to select the entire logical line	1315	to select a word; Left triple-click to select the entire logical line
1183	(which can span multiple screen lines), unless modified by resource	1316	(which can span multiple screen lines), unless modified by resource
…		…
1187	(Compile: I<frills>) will create a rectangular selection instead of a	1320	(Compile: I<frills>) will create a rectangular selection instead of a
1188	normal one. In this mode, every selected row becomes its own line in the	1321	normal one. In this mode, every selected row becomes its own line in the
1189	selection, and trailing whitespace is visually underlined and removed from	1322	selection, and trailing whitespace is visually underlined and removed from
1190	the selection.	1323	the selection.
1191		1324
1192	=item B<Insertion>:	1325	=item B<Pasting>:
1193		1326
1194	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1327	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1195	an B<@@RXVT_NAME@@> window causes the current text selection to be	1328	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1196	inserted as if it had been typed on the keyboard.	1329	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1330
		1331	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1332	inserted too.
1197		1333
1198	=back	1334	=back
1199		1335
1200	=head1 CHANGING FONTS	1336	=head1 CHANGING FONTS
1201		1337
1202	Changing fonts (or font sizes, respectively) via the keypad is not yet	1338	Changing fonts (or font sizes, respectively) via the keypad is not yet
1203	supported in rxvt-unicode. Bug me if you need this.	1339	supported in rxvt-unicode. Bug me if you need this.
1204		1340
1205	You can, however, switch fonts at runtime using escape sequences (and	1341	You can, however, switch fonts at runtime using escape sequences, e.g.:
1206	therefore using the menubar), e.g.:
1207		1342
1208	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"	1343	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1344
		1345	You can use keyboard shortcuts, too:
		1346
		1347	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1348	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1209		1349
1210	rxvt-unicode will automatically re-apply these fonts to the output so far.	1350	rxvt-unicode will automatically re-apply these fonts to the output so far.
1211		1351
1212	=head1 ISO 14755 SUPPORT	1352	=head1 ISO 14755 SUPPORT
1213		1353
1214	ISO 14755 is a standard for entering and viewing unicode characters	1354	ISO 14755 is a standard for entering and viewing unicode characters
1215	and character codes using the keyboard. It consists of 4 parts. The	1355	and character codes using the keyboard. It consists of 4 parts. The
1216	first part is available rxvt-unicode has been compiled with	1356	first part is available if rxvt-unicode has been compiled with
1217	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1357	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1218	with C<--enable-iso14755>.	1358	with C<--enable-iso14755>.
1219		1359
1220	=over 4	1360	=over 4
1221		1361
…		…
1241	This mode lets you input characters representing the keycap symbols of	1381	This mode lets you input characters representing the keycap symbols of
1242	your keyboard, if representable in the current locale encoding.	1382	your keyboard, if representable in the current locale encoding.
1243		1383
1244	Start by pressing C<Control> and C<Shift> together, then releasing	1384	Start by pressing C<Control> and C<Shift> together, then releasing
1245	them. The next special key (cursor keys, home etc.) you enter will not	1385	them. The next special key (cursor keys, home etc.) you enter will not
1246	invoke it's usual function but instead will insert the corresponding	1386	invoke its usual function but instead will insert the corresponding
1247	keycap symbol. The symbol will only be entered when the key has been	1387	keycap symbol. The symbol will only be entered when the key has been
1248	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1388	released, otherwise pressing e.g. C<Shift> would enter the symbol for
1249	C<ISO Level 2 Switch>, although your intention might have been to enter a	1389	C<ISO Level 2 Switch>, although your intention might have been to enter a
1250	reverse tab (Shift-Tab).	1390	reverse tab (Shift-Tab).
1251		1391
…		…
1284	=head1 COLORS AND GRAPHICS	1424	=head1 COLORS AND GRAPHICS
1285		1425
1286	In addition to the default foreground and background colours,	1426	In addition to the default foreground and background colours,
1287	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1427	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1288	high-intensity bold/blink versions of the same). Here is a list of the	1428	high-intensity bold/blink versions of the same). Here is a list of the
1289	colours with their B<rgb.txt> names.	1429	colours with their names.
1290		1430
1291	=begin table	1431	=begin table
1292		1432
1293	B<color0> (black) = Black	1433	B<color0> (black) = Black
1294	B<color1> (red) = Red3	1434	B<color1> (red) = Red3
…		…
1314	It is also possible to specify the colour values of B<foreground>,	1454	It is also possible to specify the colour values of B<foreground>,
1315	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1455	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1316	a number 0-15, as a convenient shorthand to reference the colour name of	1456	a number 0-15, as a convenient shorthand to reference the colour name of
1317	color0-color15.	1457	color0-color15.
1318		1458
		1459	In addition to the colours defined above, @@RXVT_NAME@@ offers an
		1460	additional 72 colours. The first 64 of those (with indices 16 to 79)
		1461	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
		1462	16>), followed by 8 additional shades of gray (with indices 80 to 87).
		1463
		1464	Together, all those colours implement the 88 colour xterm colours. Only
		1465	the first 16 can be changed using resources currently, the rest can only
		1466	be changed via command sequences ("escape codes").
		1467
1319	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1468	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1320	always swapping the foreground/background colours. This is in contrast to	1469	always swapping the foreground/background colours. This is in contrast to
1321	I<xterm>(1) where the colours are only swapped if they have not otherwise	1470	I<xterm>(1) where the colours are only swapped if they have not otherwise
1322	been specified. For example,	1471	been specified. For example,
1323		1472
…		…
1328	would yield White on Black, while on I<xterm>(1) it would yield Black	1477	would yield White on Black, while on I<xterm>(1) it would yield Black
1329	on White.	1478	on White.
1330		1479
1331	=back	1480	=back
1332		1481
		1482	=head2 ALPHA CHANNEL SUPPORT
		1483
		1484	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1485	their act together, rxvt-unicode will do it's own alpha channel management:
		1486
		1487	You can prefix any color with an opaquenes percentage enclosed in
		1488	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1489	(0-100) that specifies the opacity of the color, where C<0> is completely
		1490	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1491	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1492	is the recommended format to specify transparency values, and works with
		1493	all ways to specify a colour.
		1494
		1495	For complete control, rxvt-unicode also supports
		1496	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1497	specifications, where the additional C<aaaa> component specifies opacity
		1498	(alpha) values. The minimum value of C<0000> is completely transparent,
		1499	while C<ffff> is completely opaque). The two example colours from
		1500	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1501	C<rgba:0000/ff00/0000/f332>.
		1502
		1503	You probably need to specify B<"-depth 32">, too, to force a visual with
		1504	alpha channels, and have the luck that your X-server uses ARGB pixel
		1505	layout, as X is far from just supporting ARGB visuals out of the box, and
		1506	rxvt-unicode just fudges around.
		1507
		1508	For example, the following selects an almost completely transparent black
		1509	background, and an almost opaque pink foreground:
		1510
		1511	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
		1512
		1513	When not using a background image, then the interpretation of the
		1514	alpha channel is up to your compositing manager (most interpret it as
		1515	transparency of course).
		1516
		1517	When using a background pixmap or pseudo-transparency, then the background
		1518	colour will always behave as if it were completely transparent (so the
		1519	background image shows instead), regardless of how it was specified, while
		1520	other colours will either be transparent as specified (the background
		1521	image will show through) on servers supporting the RENDER extension, or
		1522	fully opaque on servers not supporting the RENDER EXTENSION.
		1523
		1524	Please note that due to bugs in Xft, specifying alpha values might result
		1525	in garbage being displayed when the X-server does not support the RENDER
		1526	extension.
		1527
1333	=head1 ENVIRONMENT	1528	=head1 ENVIRONMENT
1334		1529
1335	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1530	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1336		1531
1337	=over 4	1532	=over 4
1338		1533
1339	=item B<TERM>	1534	=item B<TERM>
1340		1535
1341	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1536	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1342	resources or on the commandline.	1537	resources or on the command line.
1343		1538
1344	=item B<COLORTERM>	1539	=item B<COLORTERM>
1345		1540
1346	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1541	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1347	compiled with XPM support, and optionally with the added extension	1542	compiled with background image support, and optionally with the added
1348	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1543	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1544	screen.
1349		1545
1350	=item B<COLORFGBG>	1546	=item B<COLORFGBG>
1351		1547
1352	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1548	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1353	the colour code used as default foreground/text colour (or the string	1549	the colour code used as default foreground/text colour (or the string
1354	C<default> to indicate that the default-colour escape sequence is to be	1550	C<default> to indicate that the default-colour escape sequence is to be
1355	used), C<bg> is the colour code used as default background colour (or the	1551	used), C<bg> is the colour code used as default background colour (or the
1356	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1552	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1357	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1553	was compiled with background image support. Libraries like C<ncurses>
1358	(and do) use this information to optimize screen output.	1554	and C<slang> can (and do) use this information to optimize screen output.
1359		1555
1360	=item B<WINDOWID>	1556	=item B<WINDOWID>
1361		1557
1362	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1558	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1363	window, which usually has subwindows for the scrollbar, the terminal	1559	window, which usually has subwindows for the scrollbar, the terminal
…		…
1369	C<--with-terminfo=PATH>.	1565	C<--with-terminfo=PATH>.
1370		1566
1371	=item B<DISPLAY>	1567	=item B<DISPLAY>
1372		1568
1373	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1569	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1374	display in it's child processes.	1570	display in its child processes if C<-display> isn't used to override. It
		1571	defaults to C<:0> if it doesn't exist.
1375		1572
1376	=item B<SHELL>	1573	=item B<SHELL>
1377		1574
1378	The shell to be used for command execution, defaults to C</bin/sh>.	1575	The shell to be used for command execution, defaults to C</bin/sh>.
1379
1380	=item B<RXVTPATH>
1381
1382	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1383	files.
1384
1385	=item B<PATH>
1386
1387	Used in the same way as C<RXVTPATH>.
1388		1576
1389	=item B<RXVT_SOCKET>	1577	=item B<RXVT_SOCKET>
1390		1578
1391	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1579	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1392	@@RXVT_NAME@@d(1).	1580	@@RXVT_NAME@@d(1).
…		…
1430		1618
1431	=item Project Coordinator	1619	=item Project Coordinator
1432		1620
1433	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1621	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1434		1622
1435	L<http://software.schmorp.de/#rxvt-unicode>	1623	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1436		1624
1437	=back	1625	=back
1438		1626
1439	=head1 AUTHORS	1627	=head1 AUTHORS
1440		1628
…		…
1462		1650
1463	Project Coordinator (changes.txt 2.21a to 2.4.5)	1651	Project Coordinator (changes.txt 2.21a to 2.4.5)
1464		1652
1465	=item Geoff Wing L<< <gcw@pobox.com> >>	1653	=item Geoff Wing L<< <gcw@pobox.com> >>
1466		1654
1467	Rewrote screen display and text selection routines. Project Coordinator	1655	Rewrote screen display and text selection routines.
		1656
1468	(changes.txt 2.4.6 - rxvt-unicode)	1657	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1469		1658
1470	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1659	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1471		1660
1472	Forked rxvt-unicode, rewrote most of the display code and internal	1661	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1473	character handling to store text in unicode, improve xterm	1662	extension, random hacks, numerous bugfixes and extensions.
1474	compatibility and apply numerous other bugfixes and extensions.
1475		1663
1476	Project Coordinator (Changes 1.0 -)	1664	Project Coordinator (Changes 1.0 -)
1477		1665
		1666	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1667
		1668	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
		1669
1478	=back	1670	=back
1479		1671

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.96 by root, Fri Jan 13 12:40:46 2006 UTC vs. Revision 1.166 by root, Fri Oct 10 13:23:56 2008 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.96 by root, Fri Jan 13 12:40:46 2006 UTC vs.
Revision 1.166 by root, Fri Oct 10 13:23:56 2008 UTC