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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.106 by root, Wed Jan 25 21:03:03 2006 UTC vs.
Revision 1.170 by root, Sat May 30 08:51:23 2009 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.
97		100
98	=item B<-depth> I<bitdepth>	101	=item B<-depth> I<bitdepth>
99		102
100	Compile I<frills>: Attempt to find a visual with the given bit depth;	103	Compile I<xft>: Attempt to find a visual with the given bit depth;
101	resource B<depth>.	104	resource B<depth>.
102		105
		106	[Please note that many X servers (and libXft) are buggy with
		107	respect to C<-depth 32> and/or alpha channels, and will cause all sorts
		108	of graphical corruption. This is harmless, but we can't do anything about
		109	this, so watch out]
		110
103	=item B<-geometry> I<geom>	111	=item B<-geometry> I<geom>
104		112
105	Window geometry (B<-g> still respected); resource B<geometry>.	113	Window geometry (B<-g> still respected); resource B<geometry>.
106		114
107	=item B<-rv>\|B<+rv>	115	=item B<-rv>\|B<+rv>
108		116
109	Turn on/off simulated reverse video; resource B<reverseVideo>.	117	Turn on/off simulated reverse video; resource B<reverseVideo>.
110		118
111	=item B<-j>\|B<+j>	119	=item B<-j>\|B<+j>
112		120
113	Turn on/off jump scrolling; resource B<jumpScroll>.	121	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
114		122
115	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>	123	=item B<-ss>\|B<+ss>
116		124
117	Turn on/off inheriting parent window's pixmap. Alternative form is	125	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118	B<-tr>; resource B<inheritPixmap>.	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@@)!>
119		136
120	=item B<-fade> I<number>	137	=item B<-fade> I<number>
121		138
122	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
123	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
124	colour; resource B<fading>.	141	colour; resource B<fading>.
125		142
126	=item B<-fadecolor> I<colour>	143	=item B<-fadecolor> I<colour>
127		144
128	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
129	is black. resource B<fadeColor>.	146	is opaque black. resource B<fadeColor>.
130		147
131	=item B<-tint> I<colour>	148	=item B<-tint> I<colour>
132		149
133	Tint the transparent background pixmap with the given colour when	150	Tint the transparent background pixmap with the given colour when
134	transparency is enabled with B<-tr> or B<-ip>. This only works for	151	transparency is enabled with B<-tr>. This only works for
135	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
136	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
137	I<tintColor>. Example:	158	I<tintColor>. Example:
138		159
139	@@RXVT_NAME@@ -tr -tint blue -sh 40	160	@@RXVT_NAME@@ -tr -tint blue -sh 40
140		161
141	=item B<-sh>	162	=item B<-sh> I<number>
142		163
143	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	164	Darken (0 .. 100) or lighten (100 .. 200) the transparent
144	background image in addition to tinting it (i.e. B<-tint> must be	165	background image in addition to (or instead of) tinting it;
145	specified, too, e.g. C<-tint white>).	166	resource I<shading>.
		167
		168	=item B<-blt> I<string>
		169
		170	Specify background blending type. If background pixmap is specified
		171	at the same time as transparency - such pixmap will be blended over
		172	transparency image, using method specified. Supported values are :
		173	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
		174	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
		175	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
		176	alpha-blending. Compile I<afterimage>; resource I<blendType>.
		177
		178	=item B<-blr> I<HxV>
		179
		180	Apply Gaussian Blur with the specified radii to the transparent
		181	background image. If single number is specified - both vertical and
		182	horizontal radii are considered to be the same. Setting one of the
		183	radii to 1 and another to a large number creates interesting effects
		184	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
		185	resource I<blurRadius>.
		186
		187	=item B<-icon> I<file>
		188
		189	Compile I<afterimage>: Use the specified image as application icon. This
		190	is used by many window managers, taskbars and pagers to represent the
		191	application window; resource I<iconFile>.
146		192
147	=item B<-bg> I<colour>	193	=item B<-bg> I<colour>
148		194
149	Window background colour; resource B<background>.	195	Window background colour; resource B<background>.
150		196
151	=item B<-fg> I<colour>	197	=item B<-fg> I<colour>
152		198
153	Window foreground colour; resource B<foreground>.	199	Window foreground colour; resource B<foreground>.
154		200
155	=item B<-pixmap> I<file[;geom]>	201	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
156		202
157	Compile I<XPM>: Specify XPM file for the background and also optionally	203	Compile I<afterimage>: Specify image file for the background and also
158	specify its scaling with a geometry string. Note you may need to	204	optionally specify its scaling with a geometry string. Note you may need to
159	add quotes to avoid special shell interpretation of the C<;> in the	205	add quotes to avoid special shell interpretation of the C<;> in the
160	command-line; resource B<backgroundPixmap>.	206	command-line; for more details see resource B<backgroundPixmap>.
161		207
162	=item B<-cr> I<colour>	208	=item B<-cr> I<colour>
163		209
164	The cursor colour; resource B<cursorColor>.	210	The cursor colour; resource B<cursorColor>.
165		211
…		…
182	that are checked in order when trying to find glyphs for characters. The	228	that are checked in order when trying to find glyphs for characters. The
183	first font defines the cell size for characters; other fonts might be	229	first font defines the cell size for characters; other fonts might be
184	smaller, but not (in general) larger. A (hopefully) reasonable default	230	smaller, but not (in general) larger. A (hopefully) reasonable default
185	font list is always appended to it. See resource B<font> for more details.	231	font list is always appended to it. See resource B<font> for more details.
186		232
187	In short, to specify an X11 core font, just specify it's name or prefix it	233	In short, to specify an X11 core font, just specify its name or prefix it
188	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,	234	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
189	e.g.:	235	e.g.:
190		236
191	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	237	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
192	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	238	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
210	italic> >> characters are to be printed. See resource B<boldItalicFont>	256	italic> >> characters are to be printed. See resource B<boldItalicFont>
211	for details.	257	for details.
212		258
213	=item B<-is>\|B<+is>	259	=item B<-is>\|B<+is>
214		260
215	Compile I<font-styles>: Bold/Italic font styles imply high intensity	261	Compile I<font-styles>: Bold/Blink font styles imply high intensity
216	foreground/background (default). See resource B<intensityStyles> for	262	foreground/background (default). See resource B<intensityStyles> for
217	details.	263	details.
218		264
219	=item B<-name> I<name>	265	=item B<-name> I<name>
220		266
…		…
238		284
239	=item B<-sb>\|B<+sb>	285	=item B<-sb>\|B<+sb>
240		286
241	Turn on/off scrollbar; resource B<scrollBar>.	287	Turn on/off scrollbar; resource B<scrollBar>.
242		288
		289	=item B<-sr>\|B<+sr>
		290
		291	Put scrollbar on right/left; resource B<scrollBar_right>.
		292
		293	=item B<-st>\|B<+st>
		294
		295	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		296	resource B<scrollBar_floating>.
		297
243	=item B<-si>\|B<+si>	298	=item B<-si>\|B<+si>
244		299
245	Turn on/off scroll-to-bottom on TTY output inhibit; resource	300	Turn on/off scroll-to-bottom on TTY output inhibit; resource
246	B<scrollTtyOutput> has opposite effect.	301	B<scrollTtyOutput> has opposite effect.
247		302
…		…
253	=item B<-sw>\|B<+sw>	308	=item B<-sw>\|B<+sw>
254		309
255	Turn on/off scrolling with the scrollback buffer as new lines appear.	310	Turn on/off scrolling with the scrollback buffer as new lines appear.
256	This only takes effect if B<-si> is also given; resource	311	This only takes effect if B<-si> is also given; resource
257	B<scrollWithBuffer>.	312	B<scrollWithBuffer>.
258
259	=item B<-sr>\|B<+sr>
260
261	Put scrollbar on right/left; resource B<scrollBar_right>.
262
263	=item B<-st>\|B<+st>
264
265	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
266	resource B<scrollBar_floating>.
267		313
268	=item B<-ptab>\|B<+ptab>	314	=item B<-ptab>\|B<+ptab>
269		315
270	If enabled (default), "Horizontal Tab" characters are being stored as	316	If enabled (default), "Horizontal Tab" characters are being stored as
271	actual wide characters in the screen buffer, which makes it possible to	317	actual wide characters in the screen buffer, which makes it possible to
…		…
300		346
301	=item B<-bl>	347	=item B<-bl>
302		348
303	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	349	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
304	if honoured by the WM, the rxvt-unicode window will not have window	350	if honoured by the WM, the rxvt-unicode window will not have window
305	decorations; resource B<borderLess>.	351	decorations; resource B<borderLess>. If the window manager does not
		352	support MWM hints (e.g. kwin), enables override-redirect mode.
306		353
307	=item B<-override-redirect>	354	=item B<-override-redirect>
308		355
309	Compile I<frills>: Sets override-redirect on the window; resource	356	Compile I<frills>: Sets override-redirect on the window; resource
310	B<override-redirect>.	357	B<override-redirect>.
…		…
318		365
319	=item B<-lsp> I<number>	366	=item B<-lsp> I<number>
320		367
321	Compile I<frills>: Lines (pixel height) to insert between each row of	368	Compile I<frills>: Lines (pixel height) to insert between each row of
322	the display. Useful to work around font rendering problems; resource	369	the display. Useful to work around font rendering problems; resource
323	B<linespace>.	370	B<lineSpace>.
		371
		372	=item B<-letsp> I<number>
		373
		374	Compile I<frills>: Amount to adjust the computed character width by
		375	to control overall letter spacing. Negative values will tighten up the
		376	letter spacing, positive values will space letters out more. Useful to
		377	work around odd font metrics; resource B<letterSpace>.
324		378
325	=item B<-tn> I<termname>	379	=item B<-tn> I<termname>
326		380
327	This option specifies the name of the terminal type to be set in the	381	This option specifies the name of the terminal type to be set in the
328	B<TERM> environment variable. This terminal type must exist in the	382	B<TERM> environment variable. This terminal type must exist in the
…		…
382	for more info.	436	for more info.
383		437
384	=item B<-tcw>	438	=item B<-tcw>
385		439
386	Change the meaning of triple-click selection with the left mouse	440	Change the meaning of triple-click selection with the left mouse
		441	button. Only effective when the original (non-perl) selection code is
387	button. Instead of selecting a full line it will extend the selection the	442	in-use. Instead of selecting a full line it will extend the selection to
388	end of the logical line only. resource B<tripleclickwords>.	443	the end of the logical line only. resource B<tripleclickwords>.
389		444
390	=item B<-insecure>	445	=item B<-insecure>
391		446
392	Enable "insecure" mode, which currently enables most of the escape	447	Enable "insecure" mode, which currently enables most of the escape
393	sequences that echo strings. See the resource B<insecure> for more	448	sequences that echo strings. See the resource B<insecure> for more
…		…
414	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	469	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
415	will not immediately destroy its window when the program executed within	470	will not immediately destroy its window when the program executed within
416	it exits. Instead, it will wait till it is being killed or closed by the	471	it exits. Instead, it will wait till it is being killed or closed by the
417	user; resource B<hold>.	472	user; resource B<hold>.
418		473
		474	=item B<-cd> I<path>
		475
		476	Sets the working directory for the shell (or the command specified via
		477	B<-e>). The I<path> must be an absolute path and it must exist for
		478	@@RXVT_NAME@@ to start; resource B<chdir>.
		479
		480	=item B<-xrm> I<string>
		481
		482	Works like the X Toolkit option of the same name, by adding the I<string>
		483	as if it were specified in a resource file. Resource values specified this
		484	way take precedence over all other resource specifications.
		485
		486	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		487	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		488	options can be specified as long-options on the commandline, so use
		489	of B<-xrm> is mostly limited to cases where you want to specify other
		490	resources (e.g. for input methods) or for compatibility with other
		491	programs.
		492
419	=item B<-keysym.>I<sym> I<string>	493	=item B<-keysym.>I<sym> I<string>
420		494
421	Remap a key symbol. See resource B<keysym>.	495	Remap a key symbol. See resource B<keysym>.
422		496
423	=item B<-embed> I<windowid>	497	=item B<-embed> I<windowid>
424		498
425	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,	499	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
426	which enables applications to easily embed a terminal.	500	which enables applications to easily embed a terminal.
427		501
428	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it	502	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
429	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it	503	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
430	quite a bit, so don't expect it to keep some specific state. It's best to	504	quite a bit, so don't expect it to keep some specific state. It's best to
…		…
433	The window will not be destroyed when @@RXVT_NAME@@ exits.	507	The window will not be destroyed when @@RXVT_NAME@@ exits.
434		508
435	It might be useful to know that @@RXVT_NAME@@ will not close file	509	It might be useful to know that @@RXVT_NAME@@ will not close file
436	descriptors passed to it (except for stdin/out/err, of course), so you	510	descriptors passed to it (except for stdin/out/err, of course), so you
437	can use file descriptors to communicate with the programs within the	511	can use file descriptors to communicate with the programs within the
438	terminal. This works regardless of wether the C<-embed> option was used or	512	terminal. This works regardless of whether the C<-embed> option was used or
439	not.	513	not.
440		514
441	Here is a short Gtk2-perl snippet that illustrates how this option can be	515	Here is a short Gtk2-perl snippet that illustrates how this option can be
442	used (a longer example is in F<doc/embed>):	516	used (a longer example is in F<doc/embed>):
443		517
…		…
448	});	522	});
449		523
450	=item B<-pty-fd> I<file descriptor>	524	=item B<-pty-fd> I<file descriptor>
451		525
452	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	526	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
453	pair but instead use the given filehandle as the tty master. This is	527	pair but instead use the given file descriptor as the tty master. This is
454	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator	528	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
455	without having to run a program within it.	529	without having to run a program within it.
456		530
457	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	531	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
458	entries and will not tinker with pty/tty permissions - you have to do that	532	entries and will not tinker with pty/tty permissions - you have to do that
459	yourself if you want that.	533	yourself if you want that.
460		534
461	As an extremely special case, specifying C<-1> will completely suppress	535	As an extremely special case, specifying C<-1> will completely suppress
462	pty/tty operations.	536	pty/tty operations, which is probably only useful in conjunction with some
		537	perl extension that manages the terminal.
463		538
464	Here is a example in perl that illustrates how this option can be used (a	539	Here is a example in perl that illustrates how this option can be used (a
465	longer example is in F<doc/pty-fd>):	540	longer example is in F<doc/pty-fd>):
466		541
467	use IO::Pty;	542	use IO::Pty;
…		…
481	Comma-separated list of perl extension scripts to use (or not to use) in	556	Comma-separated list of perl extension scripts to use (or not to use) in
482	this terminal instance. See resource B<perl-ext> for details.	557	this terminal instance. See resource B<perl-ext> for details.
483		558
484	=back	559	=back
485		560
486	=head1 RESOURCES (available also as long-options)	561	=head1 RESOURCES
487		562
488	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	563	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
489	options) compiled into your version.	564	options) compiled into your version. All resources are also available as
		565	long-options.
490		566
491	You can set and change the resources using X11 tools like B<xrdb>. Many	567	You can set and change the resources using X11 tools like B<xrdb>. Many
492	distribution do also load settings from the B<~/.Xresources> file when X	568	distribution do also load settings from the B<~/.Xresources> file when X
493	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	569	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
494	with later settings overwriting earlier ones:	570	with later settings overwriting earlier ones:
…		…
496	1. system-wide app-defaults file, either locale-dependent OR global	572	1. system-wide app-defaults file, either locale-dependent OR global
497	2. app-defaults file in $XAPPLRESDIR	573	2. app-defaults file in $XAPPLRESDIR
498	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	574	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
499	4. SCREEN_RESOURCES for the current screen	575	4. SCREEN_RESOURCES for the current screen
500	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	576	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		577	6. resources specified via -xrm on the commandline
501		578
502	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	579	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
503	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	580	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
504	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily	581	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
505	configured, while the class name B<URxvt> allows resources unique to	582	configured, while the class name B<URxvt> allows resources unique to
…		…
512		589
513	=over 4	590	=over 4
514		591
515	=item B<depth:> I<bitdepth>	592	=item B<depth:> I<bitdepth>
516		593
517	Compile I<frills>: Attempt to find a visual with the given bit depth;	594	Compile I<xft>: Attempt to find a visual with the given bit depth;
518	option B<-depth>.	595	option B<-depth>.
		596
		597	=item B<buffered:> I<boolean>
		598
		599	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		600	On some card/driver combination enabling it slightly decreases
		601	performance, on most it greatly helps it. The slowdown is small, so it
		602	should normally be enabled.
519		603
520	=item B<geometry:> I<geom>	604	=item B<geometry:> I<geom>
521		605
522	Create the window with the specified X window geometry [default 80x24];	606	Create the window with the specified X window geometry [default 80x24];
523	option B<-geometry>.	607	option B<-geometry>.
…		…
560	Use the specified colour to display underlined characters when the	644	Use the specified colour to display underlined characters when the
561	foreground colour is the default.	645	foreground colour is the default.
562		646
563	=item B<colorRV:> I<colour>	647	=item B<colorRV:> I<colour>
564		648
565	Use the specified colour as the background for reverse video	649	Use the specified colour as the background for reverse video characters
566	characters.	650	when OPTION_HC is disabled (--disable-frills).
567		651
568	=item B<underlineColor:> I<colour>	652	=item B<underlineColor:> I<colour>
569		653
570	If set, use the specified colour as the colour for the underline	654	If set, use the specified colour as the colour for the underline
571	itself. If unset, use the foreground colour.	655	itself. If unset, use the foreground colour.
…		…
587	option B<-rv>. B<False>: regular screen colours [default]; option	671	option B<-rv>. B<False>: regular screen colours [default]; option
588	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	672	B<+rv>. See note in B<COLORS AND GRAPHICS> section.
589		673
590	=item B<jumpScroll:> I<boolean>	674	=item B<jumpScroll:> I<boolean>
591		675
592	B<True>: specify that jump scrolling should be used. When scrolling	676	B<True>: specify that jump scrolling should be used. When receiving lots
593	quickly, fewer screen updates are performed [default]; option B<-j>.	677	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		678	has been read, resulting in fewer updates while still displaying every
		679	received line; option B<-j>.
		680
594	B<False>: specify that smooth scrolling should be used; option B<+j>.	681	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		682	force a screen refresh on each new line it received; option B<+j>.
595		683
596	=item B<inheritPixmap:> I<boolean>	684	=item B<skipScroll:> I<boolean>
597		685
598	B<True>: make the background inherit the parent windows' pixmap, giving	686	B<True>: (the default) specify that skip scrolling should be used. When
599	artificial transparency. B<False>: do not inherit the parent windows'	687	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
600	pixmap.	688	(around 60 times per second), resulting in far fewer updates. This can
		689	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		690	option B<-ss>.
		691
		692	B<False>: specify that everything is to be displayed, even
		693	if the refresh is too fast for the human eye to read anything (or the
		694	monitor to display anything); option B<+ss>.
		695
		696	=item B<transparent:> I<boolean>
		697
		698	Turn on/off illusion of a transparent window background.
		699
		700	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
		701	future versions.
		702
		703	I<Please address all transparency related issues to Sasha Vasko at
		704	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
601		705
602	=item B<fading:> I<number>	706	=item B<fading:> I<number>
603		707
604	Fade the text by the given percentage when focus is lost; option B<-fade>.	708	Fade the text by the given percentage when focus is lost; option B<-fade>.
605		709
…		…
613	Tint the transparent background pixmap with the given colour; option	717	Tint the transparent background pixmap with the given colour; option
614	B<-tint>.	718	B<-tint>.
615		719
616	=item B<shading:> I<number>	720	=item B<shading:> I<number>
617		721
618	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	722	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
619	image in addition to tinting it.	723	in addition to tinting it; option B<-sh>.
		724
		725	=item B<blendType:> I<string>
		726
		727	Specify background blending type; option B<-blt>.
		728
		729	=item B<blurRadius:> I<number>
		730
		731	Apply gaussian blur with the specified radius to the transparent
		732	background image; option B<-blr>.
		733
		734	=item B<iconFile:> I<file>
		735
		736	Set the application icon pixmap; option B<-icon>.
620		737
621	=item B<scrollColor:> I<colour>	738	=item B<scrollColor:> I<colour>
622		739
623	Use the specified colour for the scrollbar [default #B2B2B2].	740	Use the specified colour for the scrollbar [default #B2B2B2].
624		741
…		…
630	=item B<borderColor:> I<colour>	747	=item B<borderColor:> I<colour>
631		748
632	The colour of the border around the text area and between the scrollbar	749	The colour of the border around the text area and between the scrollbar
633	and the text.	750	and the text.
634		751
635	=item B<backgroundPixmap:> I<file[;geom]>	752	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
636		753
637	Use the specified XPM file (note the `.xpm' extension is optional) for	754	Use the specified image file for the background and also
638	the background and also optionally specify its scaling with a geometry	755	optionally specify its scaling with a geometry string B<WxH+X+Y>,
639	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	756	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
640	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	757	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
641	centre (percent). A scale of 0 displays the image with tiling. A scale	758	centre (percent). A scale of 0 displays the image with tiling. A scale
642	of 1 displays the image without any scaling. A scale of 2 to 9	759	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
643	specifies an integer number of images in that direction. No image will	760	an integer number of images in that direction. No image will be magnified
644	be magnified beyond 10 times its original size. The maximum permitted	761	beyond 10 times its original size. The maximum permitted scale is 1000.
645	scale is 1000. [default 0x0+50+50]	762	Additional operations can be specified after colon B<:op1:op2...>.
		763	Supported operations are:
		764
		765	tile force background image to be tiled and not scaled. Equivalent to 0x0
		766	propscale will scale image keeping proportions
		767	auto will scale image to match window size. Equivalent to 100x100
		768	hscale will scale image horizontally to the window size
		769	vscale will scale image vertically to the window size
		770	scale will scale image to match window size
		771	root will tile image as if it was a root window background, auto-adjusting
		772	whenever terminal window moves
		773
		774	If used in conjunction with B<-tr> option, the specified pixmap will be
		775	blended over transparency image using either alpha-blending, or any
		776	other blending type, specified with B<-blt "type"> option.
646		777
647	=item B<path:> I<path>	778	=item B<path:> I<path>
648		779
649	Specify the colon-delimited search path for finding XPM files.	780	Specify the colon-delimited search path for finding background image files.
650		781
651	=item B<font:> I<fontlist>	782	=item B<font:> I<fontlist>
652		783
653	Select the fonts to be used. This is a comma separated list of font names	784	Select the fonts to be used. This is a comma separated list of font names
654	that are checked in order when trying to find glyphs for characters. The	785	that are checked in order when trying to find glyphs for characters. The
…		…
711	text font will being used for the given style.	842	text font will being used for the given style.
712		843
713	=item B<intensityStyles:> I<boolean>	844	=item B<intensityStyles:> I<boolean>
714		845
715	When font styles are not enabled, or this option is enabled (B<True>,	846	When font styles are not enabled, or this option is enabled (B<True>,
716	option B<-is>, the default), bold and italic font styles imply high	847	option B<-is>, the default), bold/blink font styles imply high
717	intensity foreground/backround colours. Disabling this option (B<False>,	848	intensity foreground/background colours. Disabling this option (B<False>,
718	option B<+is>) disables this behaviour, the high intensity colours are not	849	option B<+is>) disables this behaviour, the high intensity colours are not
719	reachable.	850	reachable.
720
721	=item B<selectstyle:> I<mode>
722
723	Set mouse selection style to B<old> which is 2.20, B<oldword> which is
724	xterm style with 2.20 old word selection, or anything else which gives
725	xterm style selection.
726
727	=item B<scrollstyle:> I<mode>
728
729	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
730	the author's favourite.
731		851
732	=item B<title:> I<string>	852	=item B<title:> I<string>
733		853
734	Set window title string, the default title is the command-line	854	Set window title string, the default title is the command-line
735	specified after the B<-e> option, if any, otherwise the application	855	specified after the B<-e> option, if any, otherwise the application
…		…
744	=item B<mapAlert:> I<boolean>	864	=item B<mapAlert:> I<boolean>
745		865
746	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	866	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
747	de-iconify (map) on receipt of a bell character [default].	867	de-iconify (map) on receipt of a bell character [default].
748		868
		869	=item B<urgentOnBell:> I<boolean>
		870
		871	B<True>: set the urgency hint for the wm on receipt of a bell character.
		872	B<False>: do not set the urgency hint [default].
		873
		874	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		875
749	=item B<visualBell:> I<boolean>	876	=item B<visualBell:> I<boolean>
750		877
751	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	878	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
752	B<False>: no visual bell [default]; option B<+vb>.	879	B<False>: no visual bell [default]; option B<+vb>.
753		880
…		…
774	Example:	901	Example:
775		902
776	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	903	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
777		904
778	This creates a new file in your home directory with the screen contents	905	This creates a new file in your home directory with the screen contents
779	everytime you hit C<Print>.	906	every time you hit C<Print>.
		907
		908	=item B<scrollstyle:> I<mode>
		909
		910	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		911	the author's favourite.
780		912
781	=item B<scrollBar:> I<boolean>	913	=item B<scrollBar:> I<boolean>
782		914
783	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	915	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
784	disable the scrollbar; option B<+sb>.	916	disable the scrollbar; option B<+sb>.
…		…
806		938
807	=item B<scrollWithBuffer:> I<boolean>	939	=item B<scrollWithBuffer:> I<boolean>
808		940
809	B<True>: scroll with scrollback buffer when tty receives new lines (and	941	B<True>: scroll with scrollback buffer when tty receives new lines (and
810	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	942	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
811	with scrollback buffer when tty recieves new lines; option B<+sw>.	943	with scrollback buffer when tty receives new lines; option B<+sw>.
812		944
813	=item B<scrollTtyKeypress:> I<boolean>	945	=item B<scrollTtyKeypress:> I<boolean>
814		946
815	B<True>: scroll to bottom when a non-special key is pressed. Special keys	947	B<True>: scroll to bottom when a non-special key is pressed. Special keys
816	are those which are intercepted by rxvt-unicode for special handling and	948	are those which are intercepted by rxvt-unicode for special handling and
…		…
847	=item B<termName:> I<termname>	979	=item B<termName:> I<termname>
848		980
849	Specifies the terminal type name to be set in the B<TERM> environment	981	Specifies the terminal type name to be set in the B<TERM> environment
850	variable; option B<-tn>.	982	variable; option B<-tn>.
851		983
852	=item B<linespace:> I<number>	984	=item B<lineSpace:> I<number>
853		985
854	Specifies number of lines (pixel height) to insert between each row of	986	Specifies number of lines (pixel height) to insert between each row of
855	the display [default 0]; option B<-lsp>.	987	the display [default 0]; option B<-lsp>.
856		988
857	=item B<meta8:> I<boolean>	989	=item B<meta8:> I<boolean>
…		…
909	=item B<cutchars:> I<string>	1041	=item B<cutchars:> I<string>
910		1042
911	The characters used as delimiters for double-click word selection	1043	The characters used as delimiters for double-click word selection
912	(whitespace delimiting is added automatically if resource is given).	1044	(whitespace delimiting is added automatically if resource is given).
913		1045
914	When the selection extension is in use (the default if compiled in, see	1046	When the perl selection extension is in use (the default if compiled
915	the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters	1047	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
916	will be created (if the resource exists, otherwise, no regex will be	1048	characters will be created (if the resource exists, otherwise, no regex
917	created). In this mode, characters outside ISO-8859-1 can be used.	1049	will be created). In this mode, characters outside ISO-8859-1 can be used.
918		1050
919	When the selection extension is not used, only ISO-8859-1 characters can	1051	When the selection extension is not used, only ISO-8859-1 characters can
920	be used. If not specified, the built-in default is used:	1052	be used. If not specified, the built-in default is used:
921		1053
922	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1054	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
923		1055
924	=item B<preeditType:> I<style>	1056	=item B<preeditType:> I<style>
925		1057
926	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1058	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
927		1059
…		…
981		1113
982	Turn on/off secondary screen (default enabled).	1114	Turn on/off secondary screen (default enabled).
983		1115
984	=item B<secondaryScroll:> I<boolean>	1116	=item B<secondaryScroll:> I<boolean>
985		1117
986	Turn on/off secondary screen scroll (default enabled). If the this	1118	Turn on/off secondary screen scroll (default enabled). If this
987	option is enabled, scrolls on the secondary screen will change the	1119	option is enabled, scrolls on the secondary screen will change the
988	scrollback buffer and switching to/from the secondary screen will	1120	scrollback buffer and, when secondaryScreen is off, switching
989	instead scroll the screen up.	1121	to/from the secondary screen will instead scroll the screen up.
990		1122
991	=item B<hold>: I<boolean>	1123	=item B<hold>: I<boolean>
992		1124
993	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1125	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
994	will not immediately destroy its window when the program executed within	1126	will not immediately destroy its window when the program executed within
995	it exits. Instead, it will wait till it is being killed or closed by the	1127	it exits. Instead, it will wait till it is being killed or closed by the
996	user.	1128	user.
		1129
		1130	=item B<chdir>: I<path>
		1131
		1132	Sets the working directory for the shell (or the command specified via
		1133	B<-e>). The I<path> must be an absolute path and it must exist for
		1134	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1135	directory will be used; option B<-cd>.
997		1136
998	=item B<keysym.>I<sym>: I<string>	1137	=item B<keysym.>I<sym>: I<string>
999		1138
1000	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1139	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1001	intervening resource name B<keysym.> cannot be omitted.	1140	intervening resource name B<keysym.> cannot be omitted.
…		…
1015	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1154	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1016	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1155	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1017	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1156	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1018	performed in an exact manner; however, the closest match is assured.	1157	performed in an exact manner; however, the closest match is assured.
1019		1158
1020	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1159	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1021	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1160	number), see RESOURCES in C<man 7 X> for futher details.
1022	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1023	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1024	can start or end with whitespace.
1025
1026	Please note that you need to double the C<\> in resource files, as
1027	Xlib itself does it's own de-escaping (you can use C<\033> instead of
1028	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1029	processing).
1030		1161
1031	You can define a range of keysyms in one shot by providing a I<string>	1162	You can define a range of keysyms in one shot by providing a I<string>
1032	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1163	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1033	should be a character not used by the strings.	1164	should be a character not used by the strings.
1034		1165
1035	Its usage can be demonstrated by an example:	1166	Its usage can be demonstrated by an example:
1036		1167
1037	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1168	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
…		…
1101	example, C<default,-selection> will use all the default extension except	1232	example, C<default,-selection> will use all the default extension except
1102	C<selection>.	1233	C<selection>.
1103		1234
1104	Extension names can also be followed by an argument in angle brackets	1235	Extension names can also be followed by an argument in angle brackets
1105	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1236	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1106	searchable scorllback to Alt/Meta-s). Mentioning the same extension	1237	searchable scrollback to Alt/Meta-s). Mentioning the same extension
1107	multiple times with different arguments will pass multiple arguments to	1238	multiple times with different arguments will pass multiple arguments to
1108	the extension.	1239	the extension.
1109		1240
1110	Each extension is looked up in the library directories, loaded if	1241	Each extension is looked up in the library directories, loaded if
1111	necessary, and bound to the current terminal instance.	1242	necessary, and bound to the current terminal instance.
…		…
1116	all instances, while B<perl-ext> is used for specific instances.	1247	all instances, while B<perl-ext> is used for specific instances.
1117		1248
1118	=item B<perl-eval>: I<string>	1249	=item B<perl-eval>: I<string>
1119		1250
1120	Perl code to be evaluated when all extensions have been registered. See	1251	Perl code to be evaluated when all extensions have been registered. See
1121	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1252	the @@RXVT_NAME@@perl(3) manpage.
1122	will be ignored when running setuid/setgid.
1123		1253
1124	=item B<perl-lib>: I<path>	1254	=item B<perl-lib>: I<path>
1125		1255
1126	Colon-separated list of additional directories that hold extension	1256	Colon-separated list of additional directories that hold extension
1127	scripts. When looking for extensions specified by the C<perl> resource,	1257	scripts. When looking for extensions specified by the C<perl> resource,
1128	@@RXVT_NAME@@ will first look in these directories and then in	1258	@@RXVT_NAME@@ will first look in these directories and then in
1129	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1259	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1130	will be ignored when running setuid/setgid.
1131		1260
1132	See the @@RXVT_NAME@@perl(3) manpage.	1261	See the @@RXVT_NAME@@perl(3) manpage.
1133		1262
1134	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1263	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1135		1264
…		…
1147	(default: C<M-s>).	1276	(default: C<M-s>).
1148		1277
1149	=item B<urlLauncher>: I<string>	1278	=item B<urlLauncher>: I<string>
1150		1279
1151	Specifies the program to be started with a URL argument. Used by the	1280	Specifies the program to be started with a URL argument. Used by the
1152	C<selection-popup> and C<mark-urls> perl extensions.	1281	C<selection-popup> and C<matcher> perl extensions.
1153		1282
1154	=item B<transient-for>: I<windowid>	1283	=item B<transient-for>: I<windowid>
1155		1284
1156	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.	1285	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1157		1286
1158	=item B<override-redirect>: I<boolean>	1287	=item B<override-redirect>: I<boolean>
1159		1288
1160	Compile I<frills>: Sets override-redirect for the terminal window, making	1289	Compile I<frills>: Sets override-redirect for the terminal window, making
1161	it almost invisible to window managers; option B<-override-redirect>.	1290	it almost invisible to window managers; option B<-override-redirect>.
		1291
		1292	=item B<iso14755_52:> I<boolean>
		1293
		1294	Turn on/off ISO 14755 5.2 mode (default enabled).
1162		1295
1163	=back	1296	=back
1164		1297
1165	=head1 THE SCROLLBAR	1298	=head1 THE SCROLLBAR
1166		1299
…		…
1185	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1318	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1186	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1319	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1187	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1320	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1188	respectively.	1321	respectively.
1189		1322
1190	=head1 TEXT SELECTION AND INSERTION	1323	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1191		1324
1192	The behaviour of text selection and insertion mechanism is similar to	1325	The behaviour of text selection and insertion/pasting mechanism is similar
1193	I<xterm>(1).	1326	to I<xterm>(1).
1194		1327
1195	=over 4	1328	=over 4
1196		1329
1197	=item B<Selection>:	1330	=item B<Selecting>:
1198		1331
1199	Left click at the beginning of the region, drag to the end of the region	1332	Left click at the beginning of the region, drag to the end of the region
1200	and release; Right click to extend the marked region; Left double-click	1333	and release; Right click to extend the marked region; Left double-click
1201	to select a word; Left triple-click to select the entire logical line	1334	to select a word; Left triple-click to select the entire logical line
1202	(which can span multiple screen lines), unless modified by resource	1335	(which can span multiple screen lines), unless modified by resource
…		…
1206	(Compile: I<frills>) will create a rectangular selection instead of a	1339	(Compile: I<frills>) will create a rectangular selection instead of a
1207	normal one. In this mode, every selected row becomes its own line in the	1340	normal one. In this mode, every selected row becomes its own line in the
1208	selection, and trailing whitespace is visually underlined and removed from	1341	selection, and trailing whitespace is visually underlined and removed from
1209	the selection.	1342	the selection.
1210		1343
1211	=item B<Insertion>:	1344	=item B<Pasting>:
1212		1345
1213	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>	1346	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1214	window causes the value of the PRIMARY selection (or CLIPBOARD with the	1347	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1215	Meta modifier) to be inserted as if it had been typed on the keyboard.	1348	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1216		1349
1217	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1350	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1218	inserted too.	1351	inserted too.
1219		1352
1220	=back	1353	=back
…		…
1237		1370
1238	=head1 ISO 14755 SUPPORT	1371	=head1 ISO 14755 SUPPORT
1239		1372
1240	ISO 14755 is a standard for entering and viewing unicode characters	1373	ISO 14755 is a standard for entering and viewing unicode characters
1241	and character codes using the keyboard. It consists of 4 parts. The	1374	and character codes using the keyboard. It consists of 4 parts. The
1242	first part is available rxvt-unicode has been compiled with	1375	first part is available if rxvt-unicode has been compiled with
1243	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1376	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1244	with C<--enable-iso14755>.	1377	with C<--enable-iso14755>.
1245		1378
1246	=over 4	1379	=over 4
1247		1380
…		…
1267	This mode lets you input characters representing the keycap symbols of	1400	This mode lets you input characters representing the keycap symbols of
1268	your keyboard, if representable in the current locale encoding.	1401	your keyboard, if representable in the current locale encoding.
1269		1402
1270	Start by pressing C<Control> and C<Shift> together, then releasing	1403	Start by pressing C<Control> and C<Shift> together, then releasing
1271	them. The next special key (cursor keys, home etc.) you enter will not	1404	them. The next special key (cursor keys, home etc.) you enter will not
1272	invoke it's usual function but instead will insert the corresponding	1405	invoke its usual function but instead will insert the corresponding
1273	keycap symbol. The symbol will only be entered when the key has been	1406	keycap symbol. The symbol will only be entered when the key has been
1274	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1407	released, otherwise pressing e.g. C<Shift> would enter the symbol for
1275	C<ISO Level 2 Switch>, although your intention might have been to enter a	1408	C<ISO Level 2 Switch>, although your intention might have been to enter a
1276	reverse tab (Shift-Tab).	1409	reverse tab (Shift-Tab).
1277		1410
…		…
1310	=head1 COLORS AND GRAPHICS	1443	=head1 COLORS AND GRAPHICS
1311		1444
1312	In addition to the default foreground and background colours,	1445	In addition to the default foreground and background colours,
1313	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1446	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1314	high-intensity bold/blink versions of the same). Here is a list of the	1447	high-intensity bold/blink versions of the same). Here is a list of the
1315	colours with their B<rgb.txt> names.	1448	colours with their names.
1316		1449
1317	=begin table	1450	=begin table
1318		1451
1319	B<color0> (black) = Black	1452	B<color0> (black) = Black
1320	B<color1> (red) = Red3	1453	B<color1> (red) = Red3
…		…
1340	It is also possible to specify the colour values of B<foreground>,	1473	It is also possible to specify the colour values of B<foreground>,
1341	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1474	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1342	a number 0-15, as a convenient shorthand to reference the colour name of	1475	a number 0-15, as a convenient shorthand to reference the colour name of
1343	color0-color15.	1476	color0-color15.
1344		1477
		1478	In addition to the colours defined above, @@RXVT_NAME@@ offers an
		1479	additional 72 colours. The first 64 of those (with indices 16 to 79)
		1480	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
		1481	16>), followed by 8 additional shades of gray (with indices 80 to 87).
		1482
		1483	Together, all those colours implement the 88 colour xterm colours. Only
		1484	the first 16 can be changed using resources currently, the rest can only
		1485	be changed via command sequences ("escape codes").
		1486
1345	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1487	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1346	always swapping the foreground/background colours. This is in contrast to	1488	always swapping the foreground/background colours. This is in contrast to
1347	I<xterm>(1) where the colours are only swapped if they have not otherwise	1489	I<xterm>(1) where the colours are only swapped if they have not otherwise
1348	been specified. For example,	1490	been specified. For example,
1349		1491
…		…
1354	would yield White on Black, while on I<xterm>(1) it would yield Black	1496	would yield White on Black, while on I<xterm>(1) it would yield Black
1355	on White.	1497	on White.
1356		1498
1357	=back	1499	=back
1358		1500
		1501	=head2 ALPHA CHANNEL SUPPORT
		1502
		1503	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1504	their act together, rxvt-unicode will do it's own alpha channel management:
		1505
		1506	You can prefix any color with an opaquenes percentage enclosed in
		1507	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1508	(0-100) that specifies the opacity of the color, where C<0> is completely
		1509	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1510	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1511	is the recommended format to specify transparency values, and works with
		1512	all ways to specify a colour.
		1513
		1514	For complete control, rxvt-unicode also supports
		1515	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1516	specifications, where the additional C<aaaa> component specifies opacity
		1517	(alpha) values. The minimum value of C<0000> is completely transparent,
		1518	while C<ffff> is completely opaque). The two example colours from
		1519	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1520	C<rgba:0000/ff00/0000/f332>.
		1521
		1522	You probably need to specify B<"-depth 32">, too, to force a visual with
		1523	alpha channels, and have the luck that your X-server uses ARGB pixel
		1524	layout, as X is far from just supporting ARGB visuals out of the box, and
		1525	rxvt-unicode just fudges around.
		1526
		1527	For example, the following selects an almost completely transparent black
		1528	background, and an almost opaque pink foreground:
		1529
		1530	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
		1531
		1532	When not using a background image, then the interpretation of the
		1533	alpha channel is up to your compositing manager (most interpret it as
		1534	transparency of course).
		1535
		1536	When using a background pixmap or pseudo-transparency, then the background
		1537	colour will always behave as if it were completely transparent (so the
		1538	background image shows instead), regardless of how it was specified, while
		1539	other colours will either be transparent as specified (the background
		1540	image will show through) on servers supporting the RENDER extension, or
		1541	fully opaque on servers not supporting the RENDER EXTENSION.
		1542
		1543	Please note that due to bugs in Xft, specifying alpha values might result
		1544	in garbage being displayed when the X-server does not support the RENDER
		1545	extension.
		1546
1359	=head1 ENVIRONMENT	1547	=head1 ENVIRONMENT
1360		1548
1361	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1549	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1362		1550
1363	=over 4	1551	=over 4
1364		1552
1365	=item B<TERM>	1553	=item B<TERM>
1366		1554
1367	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1555	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1368	resources or on the commandline.	1556	resources or on the command line.
1369		1557
1370	=item B<COLORTERM>	1558	=item B<COLORTERM>
1371		1559
1372	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1560	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1373	compiled with XPM support, and optionally with the added extension	1561	compiled with background image support, and optionally with the added
1374	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1562	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1563	screen.
1375		1564
1376	=item B<COLORFGBG>	1565	=item B<COLORFGBG>
1377		1566
1378	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1567	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1379	the colour code used as default foreground/text colour (or the string	1568	the colour code used as default foreground/text colour (or the string
1380	C<default> to indicate that the default-colour escape sequence is to be	1569	C<default> to indicate that the default-colour escape sequence is to be
1381	used), C<bg> is the colour code used as default background colour (or the	1570	used), C<bg> is the colour code used as default background colour (or the
1382	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1571	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1383	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1572	was compiled with background image support. Libraries like C<ncurses>
1384	(and do) use this information to optimize screen output.	1573	and C<slang> can (and do) use this information to optimize screen output.
1385		1574
1386	=item B<WINDOWID>	1575	=item B<WINDOWID>
1387		1576
1388	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1577	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1389	window, which usually has subwindows for the scrollbar, the terminal	1578	window, which usually has subwindows for the scrollbar, the terminal
…		…
1395	C<--with-terminfo=PATH>.	1584	C<--with-terminfo=PATH>.
1396		1585
1397	=item B<DISPLAY>	1586	=item B<DISPLAY>
1398		1587
1399	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1588	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1400	display in it's child processes.	1589	display in its child processes if C<-display> isn't used to override. It
		1590	defaults to C<:0> if it doesn't exist.
1401		1591
1402	=item B<SHELL>	1592	=item B<SHELL>
1403		1593
1404	The shell to be used for command execution, defaults to C</bin/sh>.	1594	The shell to be used for command execution, defaults to C</bin/sh>.
1405		1595
…		…
1447		1637
1448	=item Project Coordinator	1638	=item Project Coordinator
1449		1639
1450	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1640	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1451		1641
1452	L<http://software.schmorp.de/#rxvt-unicode>	1642	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1453		1643
1454	=back	1644	=back
1455		1645
1456	=head1 AUTHORS	1646	=head1 AUTHORS
1457		1647
…		…
1480	Project Coordinator (changes.txt 2.21a to 2.4.5)	1670	Project Coordinator (changes.txt 2.21a to 2.4.5)
1481		1671
1482	=item Geoff Wing L<< <gcw@pobox.com> >>	1672	=item Geoff Wing L<< <gcw@pobox.com> >>
1483		1673
1484	Rewrote screen display and text selection routines.	1674	Rewrote screen display and text selection routines.
1485		1675
1486	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1676	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1487		1677
1488	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1678	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1489		1679
1490	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1680	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.106 by root, Wed Jan 25 21:03:03 2006 UTC vs. Revision 1.170 by root, Sat May 30 08:51:23 2009 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.106 by root, Wed Jan 25 21:03:03 2006 UTC vs.
Revision 1.170 by root, Sat May 30 08:51:23 2009 UTC