[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.212 by sf-exg, Sun Jan 1 14:31:28 2012 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 pseudo-transparency by using the root pixmap as background; resource B<transparent>.
		130
		131	B<-ip> is still accepted as an obsolete alias but will be removed in
		132	future versions.
114		133
115	=item B<-fade> I<number>	134	=item B<-fade> I<number>
116		135
117	Fade the text by the given percentage when focus is lost. Small values	136	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	137	fade a little only, 100 completely replaces all colours by the fade
119	colour; resource B<fading>.	138	colour; resource B<fading>.
120		139
121	=item B<-fadecolor> I<colour>	140	=item B<-fadecolor> I<colour>
122		141
123	Fade to this colour when fading is used (see B<-fade>). The default colour	142	Fade to this colour when fading is used (see B<-fade>). The default colour
124	is black. resource B<fadeColor>.	143	is opaque black. resource B<fadeColor>.
125		144
126	=item B<-tint> I<colour>	145	=item B<-tint> I<colour>
127		146
128	Tint the transparent background pixmap with the given colour when	147	Tint the transparent background with the given colour;
129	transparency is enabled with B<-tr> or B<-ip>. This only works for	148	resource I<tintColor>.
130	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
132	I<tintColor>. Example:
133		149
134	@@RXVT_NAME@@ -tr -tint blue -sh 40	150	=item B<-sh> I<number>
135		151
136	=item B<-sh>
137
138	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	152	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
139	background image in addition to tinting it (i.e. B<-tint> must be	153	A value of 100 means no shading; resource I<shading>.
140	specified, too, e.g. C<-tint white>).	154
		155	=item B<-blt> I<string>
		156
		157	Specify background blending type. If background pixmap is specified
		158	at the same time as transparency - such pixmap will be blended over
		159	the transparent background, using the method specified. Supported values are:
		160	B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
		161	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
		162	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
		163	alpha-blending. Compile I<afterimage>; resource I<blendType>.
		164
		165	=item B<-blr> I<HxV>
		166
		167	Apply Gaussian Blur with the specified radii to the transparent
		168	background. If a single number is specified, the vertical and
		169	horizontal radii are considered to be the same. Setting one of the
		170	radii to 1 and the other to a large number creates interesting effects
		171	on some backgrounds. The maximum radius value is 128. An horizontal or
		172	vertical radius of 0 disables blurring;
		173	resource I<blurRadius>.
		174
		175	=item B<-icon> I<file>
		176
		177	Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
		178	is used by many window managers, taskbars and pagers to represent the
		179	application window; resource I<iconFile>.
141		180
142	=item B<-bg> I<colour>	181	=item B<-bg> I<colour>
143		182
144	Window background colour; resource B<background>.	183	Window background colour; resource B<background>.
145		184
146	=item B<-fg> I<colour>	185	=item B<-fg> I<colour>
147		186
148	Window foreground colour; resource B<foreground>.	187	Window foreground colour; resource B<foreground>.
149		188
150	=item B<-pixmap> I<file[;geom]>	189	=item B<-pixmap> I<file[;oplist]>
151		190
152	Compile I<XPM>: Specify XPM file for the background and also optionally	191	Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
153	specify its scaling with a geometry string. Note you may need to	192	optionally specify a list of operations to modify it. Note you may need to
154	add quotes to avoid special shell interpretation of the C<;> in the	193	add quotes to avoid special shell interpretation of the C<;> in the
155	command-line; resource B<backgroundPixmap>.	194	command-line; for more details see resource B<backgroundPixmap>.
156		195
157	=item B<-cr> I<colour>	196	=item B<-cr> I<colour>
158		197
159	The cursor colour; resource B<cursorColor>.	198	The cursor colour; resource B<cursorColor>.
160		199
…		…
177	that are checked in order when trying to find glyphs for characters. The	216	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	217	first font defines the cell size for characters; other fonts might be
179	smaller, but not (in general) larger. A (hopefully) reasonable default	218	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.	219	font list is always appended to it. See resource B<font> for more details.
181		220
182	In short, to specify an X11 core font, just specify it's name or prefix it	221	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:>,	222	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184	e.g.:	223	e.g.:
185		224
186	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	225	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	226	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
205	italic> >> characters are to be printed. See resource B<boldItalicFont>	244	italic> >> characters are to be printed. See resource B<boldItalicFont>
206	for details.	245	for details.
207		246
208	=item B<-is>\|B<+is>	247	=item B<-is>\|B<+is>
209		248
210	Compile I<font-styles>: Bold/Italic font styles imply high intensity	249	Compile I<font-styles>: Bold/Blink font styles imply high intensity
211	foreground/background (default). See resource B<intensityStyles> for	250	foreground/background (default). See resource B<intensityStyles> for
212	details.	251	details.
213		252
214	=item B<-name> I<name>	253	=item B<-name> I<name>
215		254
…		…
233		272
234	=item B<-sb>\|B<+sb>	273	=item B<-sb>\|B<+sb>
235		274
236	Turn on/off scrollbar; resource B<scrollBar>.	275	Turn on/off scrollbar; resource B<scrollBar>.
237		276
		277	=item B<-sr>\|B<+sr>
		278
		279	Put scrollbar on right/left; resource B<scrollBar_right>.
		280
		281	=item B<-st>\|B<+st>
		282
		283	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		284	resource B<scrollBar_floating>.
		285
238	=item B<-si>\|B<+si>	286	=item B<-si>\|B<+si>
239		287
240	Turn on/off scroll-to-bottom on TTY output inhibit; resource	288	Turn on/off scroll-to-bottom on TTY output inhibit; resource
241	B<scrollTtyOutput> has opposite effect.	289	B<scrollTtyOutput> has opposite effect.
242		290
…		…
248	=item B<-sw>\|B<+sw>	296	=item B<-sw>\|B<+sw>
249		297
250	Turn on/off scrolling with the scrollback buffer as new lines appear.	298	Turn on/off scrolling with the scrollback buffer as new lines appear.
251	This only takes effect if B<-si> is also given; resource	299	This only takes effect if B<-si> is also given; resource
252	B<scrollWithBuffer>.	300	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		301
263	=item B<-ptab>\|B<+ptab>	302	=item B<-ptab>\|B<+ptab>
264		303
265	If enabled (default), "Horizontal Tab" characters are being stored as	304	If enabled (default), "Horizontal Tab" characters are being stored as
266	actual wide characters in the screen buffer, which makes it possible to	305	actual wide characters in the screen buffer, which makes it possible to
…		…
270		309
271	=item B<-bc>\|B<+bc>	310	=item B<-bc>\|B<+bc>
272		311
273	Blink the cursor; resource B<cursorBlink>.	312	Blink the cursor; resource B<cursorBlink>.
274		313
		314	=item B<-uc>\|B<+uc>
		315
		316	Make the cursor underlined; resource B<cursorUnderline>.
		317
275	=item B<-iconic>	318	=item B<-iconic>
276		319
277	Start iconified, if the window manager supports that option.	320	Start iconified, if the window manager supports that option.
278	Alternative form is B<-ic>.	321	Alternative form is B<-ic>.
279		322
…		…
295		338
296	=item B<-bl>	339	=item B<-bl>
297		340
298	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	341	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	342	if honoured by the WM, the rxvt-unicode window will not have window
300	decorations; resource B<borderLess>.	343	decorations; resource B<borderLess>. If the window manager does not
		344	support MWM hints (e.g. kwin), enables override-redirect mode.
		345
		346	=item B<-override-redirect>
		347
		348	Compile I<frills>: Sets override-redirect on the window; resource
		349	B<override-redirect>.
301		350
302	=item B<-sbg>	351	=item B<-sbg>
303		352
304	Compile I<frills>: Disable the usage of the built-in block graphics/line	353	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	354	drawing characters and just rely on what the specified fonts provide. Use
…		…
308		357
309	=item B<-lsp> I<number>	358	=item B<-lsp> I<number>
310		359
311	Compile I<frills>: Lines (pixel height) to insert between each row of	360	Compile I<frills>: Lines (pixel height) to insert between each row of
312	the display. Useful to work around font rendering problems; resource	361	the display. Useful to work around font rendering problems; resource
313	B<linespace>.	362	B<lineSpace>.
		363
		364	=item B<-letsp> I<number>
		365
		366	Compile I<frills>: Amount to adjust the computed character width by
		367	to control overall letter spacing. Negative values will tighten up the
		368	letter spacing, positive values will space letters out more. Useful to
		369	work around odd font metrics; resource B<letterSpace>.
314		370
315	=item B<-tn> I<termname>	371	=item B<-tn> I<termname>
316		372
317	This option specifies the name of the terminal type to be set in the	373	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	374	B<TERM> environment variable. This terminal type must exist in the
…		…
372	for more info.	428	for more info.
373		429
374	=item B<-tcw>	430	=item B<-tcw>
375		431
376	Change the meaning of triple-click selection with the left mouse	432	Change the meaning of triple-click selection with the left mouse
		433	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	434	in-use. Instead of selecting a full line it will extend the selection to
378	end of the logical line only. resource B<tripleclickwords>.	435	the end of the logical line only. resource B<tripleclickwords>.
379		436
380	=item B<-insecure>	437	=item B<-insecure>
381		438
382	Enable "insecure" mode, which currently enables most of the escape	439	Enable "insecure" mode, which currently enables most of the escape
383	sequences that echo strings. See the resource B<insecure> for more	440	sequences that echo strings. See the resource B<insecure> for more
…		…
404	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	461	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
405	will not immediately destroy its window when the program executed within	462	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	463	it exits. Instead, it will wait till it is being killed or closed by the
407	user; resource B<hold>.	464	user; resource B<hold>.
408		465
		466	=item B<-cd> I<path>
		467
		468	Sets the working directory for the shell (or the command specified via
		469	B<-e>). The I<path> must be an absolute path and it must exist for
		470	@@RXVT_NAME@@ to start; resource B<chdir>.
		471
		472	=item B<-xrm> I<string>
		473
		474	Works like the X Toolkit option of the same name, by adding the I<string>
		475	as if it were specified in a resource file. Resource values specified this
		476	way take precedence over all other resource specifications.
		477
		478	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		479	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		480	options can be specified as long-options on the commandline, so use
		481	of B<-xrm> is mostly limited to cases where you want to specify other
		482	resources (e.g. for input methods) or for compatibility with other
		483	programs.
		484
409	=item B<-keysym.>I<sym> I<string>	485	=item B<-keysym.>I<sym> I<string>
410		486
411	Remap a key symbol. See resource B<keysym>.	487	Remap a key symbol. See resource B<keysym>.
412		488
413	=item B<-embed> I<windowid>	489	=item B<-embed> I<windowid>
414		490
415	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,	491	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
416	which enables applications to easily embed a terminal.	492	which enables applications to easily embed a terminal.
417		493
418	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it	494	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	495	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	496	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.	499	The window will not be destroyed when @@RXVT_NAME@@ exits.
424		500
425	It might be useful to know that @@RXVT_NAME@@ will not close file	501	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	502	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	503	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	504	terminal. This works regardless of whether the C<-embed> option was used or
429	not.	505	not.
430		506
431	Here is a short Gtk2-perl snippet that illustrates how this option can be	507	Here is a short Gtk2-perl snippet that illustrates how this option can be
432	used (a longer example is in F<doc/embed>):	508	used (a longer example is in F<doc/embed>):
433		509
…		…
438	});	514	});
439		515
440	=item B<-pty-fd> I<file descriptor>	516	=item B<-pty-fd> I<file descriptor>
441		517
442	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	518	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	519	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	520	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
445	without having to run a program within it.	521	without having to run a program within it.
446		522
447	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	523	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	524	entries and will not tinker with pty/tty permissions - you have to do that
449	yourself if you want that.	525	yourself if you want that.
450		526
451	As an extremely special case, specifying C<-1> will completely suppress	527	As an extremely special case, specifying C<-1> will completely suppress
452	pty/tty operations.	528	pty/tty operations, which is probably only useful in conjunction with some
		529	perl extension that manages the terminal.
453		530
454	Here is a example in perl that illustrates how this option can be used (a	531	Here is a example in perl that illustrates how this option can be used (a
455	longer example is in F<doc/pty-fd>):	532	longer example is in F<doc/pty-fd>):
456		533
457	use IO::Pty;	534	use IO::Pty;
…		…
471	Comma-separated list of perl extension scripts to use (or not to use) in	548	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.	549	this terminal instance. See resource B<perl-ext> for details.
473		550
474	=back	551	=back
475		552
476	=head1 RESOURCES (available also as long-options)	553	=head1 RESOURCES
477		554
478	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	555	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
479	options) compiled into your version.	556	options) compiled into your version. All resources are also available as
		557	long-options.
480		558
481	You can set and change the resources using X11 tools like B<xrdb>. Many	559	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	560	distribution do also load settings from the B<~/.Xresources> file when X
483	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	561	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
484	with later settings overwriting earlier ones:	562	with later settings overwriting earlier ones:
485		563
486	1. system-wide app-defaults file, either locale-dependent OR global
487	2. app-defaults file in $XAPPLRESDIR	564	1. app-defaults file in $XAPPLRESDIR
		565	2. $HOME/.Xdefaults
488	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	566	3. RESOURCE_MANAGER property on root-window of screen 0
489	4. SCREEN_RESOURCES for the current screen	567	4. SCREEN_RESOURCES property on root-window of the current screen
490	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	568	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		569	6. resources specified via -xrm on the commandline
491		570
492	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	571	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	572	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	573	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	574	configured, while the class name B<URxvt> allows resources unique to
…		…
500	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl	579	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
501	extensions not documented here):	580	extensions not documented here):
502		581
503	=over 4	582	=over 4
504		583
		584	=item B<depth:> I<bitdepth>
		585
		586	Compile I<xft>: Attempt to find a visual with the given bit depth;
		587	option B<-depth>.
		588
		589	=item B<buffered:> I<boolean>
		590
		591	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		592	On some card/driver combination enabling it slightly decreases
		593	performance, on most it greatly helps it. The slowdown is small, so it
		594	should normally be enabled.
		595
505	=item B<geometry:> I<geom>	596	=item B<geometry:> I<geom>
506		597
507	Create the window with the specified X window geometry [default 80x24];	598	Create the window with the specified X window geometry [default 80x24];
508	option B<-geometry>.	599	option B<-geometry>.
509		600
…		…
522	Use the specified colour for the colour value I<n>, where 0-7	613	Use the specified colour for the colour value I<n>, where 0-7
523	corresponds to low-intensity (normal) colours and 8-15 corresponds to	614	corresponds to low-intensity (normal) colours and 8-15 corresponds to
524	high-intensity (bold = bright foreground, blink = bright background)	615	high-intensity (bold = bright foreground, blink = bright background)
525	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	616	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
526	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	617	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
527	names used are listed in the B<COLORS AND GRAPHICS> section.	618	names used are listed in the B<COLOURS AND GRAPHICS> section.
528		619
529	Colours higher than 15 cannot be set using resources (yet), but can be	620	Colours higher than 15 cannot be set using resources (yet), but can be
530	changed using an escape command (see @@RXVT_NAME@@(7)).	621	changed using an escape command (see @@RXVT_NAME@@(7)).
531		622
532	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	623	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
543	=item B<colorUL:> I<colour>	634	=item B<colorUL:> I<colour>
544		635
545	Use the specified colour to display underlined characters when the	636	Use the specified colour to display underlined characters when the
546	foreground colour is the default.	637	foreground colour is the default.
547		638
548	=item B<colorRV:> I<colour>
549
550	Use the specified colour as the background for reverse video
551	characters.
552
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.
		643
		644	=item B<highlightColor:> I<colour>
		645
		646	If set, use the specified colour as the background for highlighted
		647	characters. If unset, use reverse video.
		648
		649	=item B<highlightTextColor:> I<colour>
		650
		651	If set and highlightColor is set, use the specified colour as the
		652	foreground for highlighted characters.
557		653
558	=item B<cursorColor:> I<colour>	654	=item B<cursorColor:> I<colour>
559		655
560	Use the specified colour for the cursor. The default is to use the	656	Use the specified colour for the cursor. The default is to use the
561	foreground colour; option B<-cr>.	657	foreground colour; option B<-cr>.
…		…
568		664
569	=item B<reverseVideo:> I<boolean>	665	=item B<reverseVideo:> I<boolean>
570		666
571	B<True>: simulate reverse video by foreground and background colours;	667	B<True>: simulate reverse video by foreground and background colours;
572	option B<-rv>. B<False>: regular screen colours [default]; option	668	option B<-rv>. B<False>: regular screen colours [default]; option
573	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	669	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
574		670
575	=item B<jumpScroll:> I<boolean>	671	=item B<jumpScroll:> I<boolean>
576		672
577	B<True>: specify that jump scrolling should be used. When scrolling	673	B<True>: specify that jump scrolling should be used. When receiving lots
578	quickly, fewer screen updates are performed [default]; option B<-j>.	674	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		675	has been read, resulting in fewer updates while still displaying every
		676	received line; option B<-j>.
		677
579	B<False>: specify that smooth scrolling should be used; option B<+j>.	678	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		679	force a screen refresh on each new line it received; option B<+j>.
580		680
581	=item B<inheritPixmap:> I<boolean>	681	=item B<skipScroll:> I<boolean>
582		682
583	B<True>: make the background inherit the parent windows' pixmap, giving	683	B<True>: (the default) specify that skip scrolling should be used. When
584	artificial transparency. B<False>: do not inherit the parent windows'	684	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
585	pixmap.	685	(around 60 times per second), resulting in far fewer updates. This can
		686	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		687	option B<-ss>.
		688
		689	B<False>: specify that everything is to be displayed, even
		690	if the refresh is too fast for the human eye to read anything (or the
		691	monitor to display anything); option B<+ss>.
		692
		693	=item B<transparent:> I<boolean>
		694
		695	Turn on/off pseudo-transparency by using the root pixmap as background.
		696
		697	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
		698	future versions.
586		699
587	=item B<fading:> I<number>	700	=item B<fading:> I<number>
588		701
589	Fade the text by the given percentage when focus is lost; option B<-fade>.	702	Fade the text by the given percentage when focus is lost; option B<-fade>.
590		703
…		…
593	Fade to this colour, when fading is used (see B<fading:>). The default	706	Fade to this colour, when fading is used (see B<fading:>). The default
594	colour is black; option B<-fadecolor>.	707	colour is black; option B<-fadecolor>.
595		708
596	=item B<tintColor:> I<colour>	709	=item B<tintColor:> I<colour>
597		710
598	Tint the transparent background pixmap with the given colour; option	711	Tint the transparent background with the given colour. If the RENDER
599	B<-tint>.	712	extension is not available only black, red, green, yellow, blue,
		713	magenta, cyan and white tints can be performed server-side. Note that
		714	a black tint yields a completely black image while a white tint yields
		715	the image unchanged; option B<-tint>.
600		716
601	=item B<shading:> I<number>	717	=item B<shading:> I<number>
602		718
603	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	719	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
604	image in addition to tinting it.	720	A value of 100 means no shading; option B<-sh>.
		721
		722	=item B<blendType:> I<string>
		723
		724	Specify background blending type; option B<-blt>.
		725
		726	=item B<blurRadius:> I<number>
		727
		728	Apply gaussian blur with the specified radius to the transparent
		729	background; option B<-blr>.
		730
		731	=item B<iconFile:> I<file>
		732
		733	Set the application icon pixmap; option B<-icon>.
605		734
606	=item B<scrollColor:> I<colour>	735	=item B<scrollColor:> I<colour>
607		736
608	Use the specified colour for the scrollbar [default #B2B2B2].	737	Use the specified colour for the scrollbar [default #B2B2B2].
609		738
…		…
615	=item B<borderColor:> I<colour>	744	=item B<borderColor:> I<colour>
616		745
617	The colour of the border around the text area and between the scrollbar	746	The colour of the border around the text area and between the scrollbar
618	and the text.	747	and the text.
619		748
620	=item B<backgroundPixmap:> I<file[;geom]>	749	=item B<backgroundPixmap:> I<file[;oplist]>
621		750
622	Use the specified XPM file (note the `.xpm' extension is optional) for	751	Use the specified image file for the background and also
623	the background and also optionally specify its scaling with a geometry	752	optionally specify a colon separated list of operations to modify it.
624	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	753	Supported operations are:
625	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
627	of 1 displays the image without any scaling. A scale of 2 to 9
628	specifies an integer number of images in that direction. No image will
629	be magnified beyond 10 times its original size. The maximum permitted
630	scale is 1000. [default 0x0+50+50]
631		754
632	=item B<menu:> I<file[;tag]>	755	=over 4
633		756
634	Read in the specified menu file (note the `.menu' extension is	757	=item B<WxH+X+Y>
635	optional) and also optionally specify a starting tag to find. See the	758
636	reference documentation for details on the syntax for the menuBar.	759	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
		760	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
		761	scale of 0 disables scaling. The maximum permitted scale is 1000.
		762
		763	=item B<op=tile>
		764
		765	enables tiling
		766
		767	=item B<op=keep-aspect>
		768
		769	maintain the image aspect ratio when scaling
		770
		771	=item B<op=root-align>
		772
		773	use the position of the terminal window relative to the root window as
		774	the image offset, simulating a root window background
		775
		776	=back
		777
		778	The default scale and position setting is C<100x100+50+50>.
		779	Alternatively, a predefined set of templates can be used to achieve
		780	the most common setups:
		781
		782	=over 4
		783
		784	=item B<style=tiled>
		785
		786	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		787
		788	=item B<style=aspect-stretched>
		789
		790	the image is scaled to fill the whole window maintaining the aspect
		791	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		792
		793	=item B<style=stretched>
		794
		795	the image is scaled to fill the whole window. Equivalent to 100x100
		796
		797	=item B<style=centered>
		798
		799	the image is centered with no scaling. Equivalent to 0x0+50+50
		800
		801	=item B<style=root-tiled>
		802
		803	the image is tiled with no scaling and using 'root' positioning.
		804	Equivalent to 0x0:op=tile:op=root-align
		805
		806	=back
		807
		808	If multiple templates are specified the last one wins. Note that a
		809	template overrides all the scale, position and operations settings.
		810
		811	If used in conjunction with B<-tr> option, the specified pixmap will be
		812	blended over the transparent background using alpha-blending. If I<afterimage>
		813	support has been compiled in it is possible to choose other blending
		814	types with B<-blt "type"> option.
637		815
638	=item B<path:> I<path>	816	=item B<path:> I<path>
639		817
640	Specify the colon-delimited search path for finding files (XPM and	818	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		819
644	=item B<font:> I<fontlist>	820	=item B<font:> I<fontlist>
645		821
646	Select the fonts to be used. This is a comma separated list of font names	822	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	823	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	833	hint currently is C<codeset=codeset-name>, and this is only used for Xft
658	fonts.	834	fonts.
659		835
660	For example, this font resource	836	For example, this font resource
661		837
662	URxvt*font: 9x15bold,\	838	URxvt.font: 9x15bold,\
663	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	839	-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, \	840	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
665	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	841	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
666	xft:Code2000:antialias=false	842	xft:Code2000:antialias=false
667		843
…		…
670	it is named first) and thus defines the character cell grid to be 9 pixels	846	it is named first) and thus defines the character cell grid to be 9 pixels
671	wide and 15 pixels high.	847	wide and 15 pixels high.
672		848
673	The second font is just used to add additional unicode characters not in	849	The second font is just used to add additional unicode characters not in
674	the base font, likewise the third, which is unfortunately non-bold, but	850	the base font, likewise the third, which is unfortunately non-bold, but
675	the bold version of the font does contain less characters, so this is a	851	the bold version of the font does contain fewer characters, so this is a
676	useful supplement.	852	useful supplement.
677		853
678	The third font is an Xft font with aliasing turned off, and the characters	854	The third font is an Xft font with aliasing turned off, and the characters
679	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	855	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
680	contains other characters, but we are not interested in them.	856	contains other characters, but we are not interested in them.
…		…
704	text font will being used for the given style.	880	text font will being used for the given style.
705		881
706	=item B<intensityStyles:> I<boolean>	882	=item B<intensityStyles:> I<boolean>
707		883
708	When font styles are not enabled, or this option is enabled (B<True>,	884	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	885	option B<-is>, the default), bold/blink font styles imply high
710	intensity foreground/backround colours. Disabling this option (B<False>,	886	intensity foreground/background colours. Disabling this option (B<False>,
711	option B<+is>) disables this behaviour, the high intensity colours are not	887	option B<+is>) disables this behaviour, the high intensity colours are not
712	reachable.	888	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		889
725	=item B<title:> I<string>	890	=item B<title:> I<string>
726		891
727	Set window title string, the default title is the command-line	892	Set window title string, the default title is the command-line
728	specified after the B<-e> option, if any, otherwise the application	893	specified after the B<-e> option, if any, otherwise the application
…		…
737	=item B<mapAlert:> I<boolean>	902	=item B<mapAlert:> I<boolean>
738		903
739	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	904	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].	905	de-iconify (map) on receipt of a bell character [default].
741		906
		907	=item B<urgentOnBell:> I<boolean>
		908
		909	B<True>: set the urgency hint for the wm on receipt of a bell character.
		910	B<False>: do not set the urgency hint [default].
		911
		912	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		913
742	=item B<visualBell:> I<boolean>	914	=item B<visualBell:> I<boolean>
743		915
744	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	916	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
745	B<False>: no visual bell [default]; option B<+vb>.	917	B<False>: no visual bell [default]; option B<+vb>.
746		918
…		…
764		936
765	The string will be interpreted as if typed into the shell as-is.	937	The string will be interpreted as if typed into the shell as-is.
766		938
767	Example:	939	Example:
768		940
769	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	941	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
770		942
771	This creates a new file in your home directory with the screen contents	943	This creates a new file in your home directory with the screen contents
772	everytime you hit C<Print>.	944	every time you hit C<Print>.
		945
		946	=item B<scrollstyle:> I<mode>
		947
		948	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		949	the author's favourite.
		950
		951	=item B<thickness:> I<number>
		952
		953	Set the scrollbar width in pixels.
773		954
774	=item B<scrollBar:> I<boolean>	955	=item B<scrollBar:> I<boolean>
775		956
776	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	957	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
777	disable the scrollbar; option B<+sb>.	958	disable the scrollbar; option B<+sb>.
…		…
797	B<False>: do not scroll to bottom when tty receives output; option	978	B<False>: do not scroll to bottom when tty receives output; option
798	B<+si>.	979	B<+si>.
799		980
800	=item B<scrollWithBuffer:> I<boolean>	981	=item B<scrollWithBuffer:> I<boolean>
801		982
802	B<True>: scroll with scrollback buffer when tty receives new lines (and	983	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
803	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	984	try to show the same lines) and B<scrollTtyOutput> is False; option
804	with scrollback buffer when tty recieves new lines; option B<+sw>.	985	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		986	new lines; option B<+sw>.
805		987
806	=item B<scrollTtyKeypress:> I<boolean>	988	=item B<scrollTtyKeypress:> I<boolean>
807		989
808	B<True>: scroll to bottom when a non-special key is pressed. Special keys	990	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	991	are those which are intercepted by rxvt-unicode for special handling and
…		…
840	=item B<termName:> I<termname>	1022	=item B<termName:> I<termname>
841		1023
842	Specifies the terminal type name to be set in the B<TERM> environment	1024	Specifies the terminal type name to be set in the B<TERM> environment
843	variable; option B<-tn>.	1025	variable; option B<-tn>.
844		1026
845	=item B<linespace:> I<number>	1027	=item B<lineSpace:> I<number>
846		1028
847	Specifies number of lines (pixel height) to insert between each row of	1029	Specifies number of lines (pixel height) to insert between each row of
848	the display [default 0]; option B<-lsp>.	1030	the display [default 0]; option B<-lsp>.
849		1031
850	=item B<meta8:> I<boolean>	1032	=item B<meta8:> I<boolean>
…		…
864		1046
865	=item B<cursorBlink:> I<boolean>	1047	=item B<cursorBlink:> I<boolean>
866		1048
867	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1049	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
868	option B<-bc>.	1050	option B<-bc>.
		1051
		1052	=item B<cursorUnderline:> I<boolean>
		1053
		1054	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1055	option B<-uc>.
869		1056
870	=item B<pointerBlank:> I<boolean>	1057	=item B<pointerBlank:> I<boolean>
871		1058
872	B<True>: blank the pointer when a key is pressed or after a set number	1059	B<True>: blank the pointer when a key is pressed or after a set number
873	of seconds of inactivity. B<False>: the pointer is always visible	1060	of seconds of inactivity. B<False>: the pointer is always visible
…		…
887	large number (e.g. C<987654321>) to effectively disable the timeout.	1074	large number (e.g. C<987654321>) to effectively disable the timeout.
888		1075
889	=item B<backspacekey:> I<string>	1076	=item B<backspacekey:> I<string>
890		1077
891	The string to send when the backspace key is pressed. If set to B<DEC>	1078	The string to send when the backspace key is pressed. If set to B<DEC>
892	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	1079	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
893	(code 8) - which can be reversed with the appropriate DEC private mode	1080	(code 8) - which can be reversed with the appropriate DEC private mode
894	escape sequence.	1081	escape sequence.
895		1082
896	=item B<deletekey:> I<string>	1083	=item B<deletekey:> I<string>
897		1084
…		…
899	pressed. If unset it will send the sequence traditionally associated	1086	pressed. If unset it will send the sequence traditionally associated
900	with the B<Execute> key.	1087	with the B<Execute> key.
901		1088
902	=item B<cutchars:> I<string>	1089	=item B<cutchars:> I<string>
903		1090
904	The characters used as delimiters for double-click word selection. The	1091	The characters used as delimiters for double-click word selection
905	built-in default:	1092	(whitespace delimiting is added automatically if resource is given).
906		1093
		1094	When the perl selection extension is in use (the default if compiled
		1095	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		1096	characters will be created (if the resource exists, otherwise, no regex
		1097	will be created). In this mode, characters outside ISO-8859-1 can be used.
		1098
		1099	When the selection extension is not used, only ISO-8859-1 characters can
		1100	be used. If not specified, the built-in default is used:
		1101
907	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1102	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
908		1103
909	=item B<preeditType:> I<style>	1104	=item B<preeditType:> I<style>
910		1105
911	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1106	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
912		1107
…		…
946	default. (Note that many other terminals, including xterm, have these	1141	default. (Note that many other terminals, including xterm, have these
947	sequences enabled by default, which doesn't make it safer, though).	1142	sequences enabled by default, which doesn't make it safer, though).
948		1143
949	You can enable them by setting this boolean resource or specifying	1144	You can enable them by setting this boolean resource or specifying
950	B<-insecure> as an option. At the moment, this enables display-answer,	1145	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	1146	locale, findfont, icon label and window title requests.
952	menubar dispatch.
953		1147
954	=item B<modifier:> I<modifier>	1148	=item B<modifier:> I<modifier>
955		1149
956	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	1150	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	1151	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
961		1155
962	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	1156	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	1157	character is passed through. It may contain escape values as described
964	in the entry on B<keysym> following.	1158	in the entry on B<keysym> following.
965		1159
966	=item B<secondaryScreen:> I<bool>	1160	=item B<secondaryScreen:> I<boolean>
967		1161
968	Turn on/off secondary screen (default enabled).	1162	Turn on/off secondary screen (default enabled).
969		1163
970	=item B<secondaryScroll:> I<bool>	1164	=item B<secondaryScroll:> I<boolean>
971		1165
972	Turn on/off secondary screen scroll (default enabled). If the this	1166	Turn on/off secondary screen scroll (default enabled). If this
973	option is enabled, scrolls on the secondary screen will change the	1167	option is enabled, scrolls on the secondary screen will change the
974	scrollback buffer and switching to/from the secondary screen will	1168	scrollback buffer and, when secondaryScreen is off, switching
975	instead scroll the screen up.	1169	to/from the secondary screen will instead scroll the screen up.
976		1170
977	=item B<hold>: I<bool>	1171	=item B<hold>: I<boolean>
978		1172
979	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1173	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
980	will not immediately destroy its window when the program executed within	1174	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	1175	it exits. Instead, it will wait till it is being killed or closed by the
982	user.	1176	user.
		1177
		1178	=item B<chdir>: I<path>
		1179
		1180	Sets the working directory for the shell (or the command specified via
		1181	B<-e>). The I<path> must be an absolute path and it must exist for
		1182	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1183	directory will be used; option B<-cd>.
983		1184
984	=item B<keysym.>I<sym>: I<string>	1185	=item B<keysym.>I<sym>: I<string>
985		1186
986	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1187	Compile I<frills>: Associate I<string> with keysym I<sym>. The
987	intervening resource name B<keysym.> cannot be omitted.	1188	intervening resource name B<keysym.> cannot be omitted.
…		…
1001	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1202	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	1203	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	1204	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.	1205	performed in an exact manner; however, the closest match is assured.
1005		1206
1006	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1207	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,	1208	number), see RESOURCES in C<man 7 X> for further 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		1209
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
1017	You can define a range of keysyms in one shot by providing a I<string>	1210	You can define a range of keysyms in one shot by
		1211	loading the C<keysym-list> perl extension and providing a I<string>
1018	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1212	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1019	should be a character not used by the strings.	1213	should be a character not used by the strings.
1020		1214
1021	Its usage can be demonstrated by an example:	1215	Its usage can be demonstrated by an example:
1022		1216
1023	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1217	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1024		1218
1025	The above line is equivalent to the following three lines:	1219	The above line is equivalent to the following three lines:
1026		1220
1027	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1221	URxvt.keysym.Meta-Control-0x61: \033<a>
1028	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1222	URxvt.keysym.Meta-Control-0x62: \033<b>
1029	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1223	URxvt.keysym.Meta-Control-0x63: \033<c>
1030		1224
1031	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1225	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1032	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1226	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1033	example the following means "change the current locale to C<zh_CN.GBK>	1227	example the following means "change the current locale to C<zh_CN.GBK>
1034	when Control-Meta-c is being pressed":	1228	when Control-Meta-c is being pressed":
1035		1229
1036	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1230	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1037		1231
1038	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1232	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1039	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1233	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1040	manpage. For example, the F<selection> extension (activated via	1234	manpage. For example, the F<selection> extension (activated via
1041	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1235	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1042		1236
1043	URxvt.keysym.M-C-c: perl:selection:rot13	1237	URxvt.keysym.M-C-c: perl:selection:rot13
1044		1238
1045	Due the the large number of modifier combinations, a defined key mapping	1239	Due the the large number of modifier combinations, a defined key mapping
1046	will match if at I<at least> the specified identifiers are being set, and	1240	will match if I<at least> the specified identifiers are being set, and
1047	no other key mappings with those and more bits are being defined. That	1241	no other key mappings with those and more bits are being defined. That
1048	means that defining a key map for C<a> will automatically provide	1242	means that defining a key map for C<a> will automatically provide
1049	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined	1243	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1050	mappings themselves.	1244	mappings themselves.
1051		1245
…		…
1087	example, C<default,-selection> will use all the default extension except	1281	example, C<default,-selection> will use all the default extension except
1088	C<selection>.	1282	C<selection>.
1089		1283
1090	Extension names can also be followed by an argument in angle brackets	1284	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	1285	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1092	searchable scorllback to Alt/Meta-s). Mentioning the same extension	1286	searchable scrollback to Alt/Meta-s). Mentioning the same extension
1093	multiple times with different arguments will pass multiple arguments to	1287	multiple times with different arguments will pass multiple arguments to
1094	the extension.	1288	the extension.
1095		1289
1096	Each extension is looked up in the library directories, loaded if	1290	Each extension is looked up in the library directories, loaded if
1097	necessary, and bound to the current terminal instance.	1291	necessary, and bound to the current terminal instance.
…		…
1102	all instances, while B<perl-ext> is used for specific instances.	1296	all instances, while B<perl-ext> is used for specific instances.
1103		1297
1104	=item B<perl-eval>: I<string>	1298	=item B<perl-eval>: I<string>
1105		1299
1106	Perl code to be evaluated when all extensions have been registered. See	1300	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	1301	the @@RXVT_NAME@@perl(3) manpage.
1108	will be ignored when running setuid/setgid.
1109		1302
1110	=item B<perl-lib>: I<path>	1303	=item B<perl-lib>: I<path>
1111		1304
1112	Colon-separated list of additional directories that hold extension	1305	Colon-separated list of additional directories that hold extension
1113	scripts. When looking for extensions specified by the C<perl> resource,	1306	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
1114	@@RXVT_NAME@@ will first look in these directories and then in	1307	look in these directories, then in $HOME/.urxvt/ext and lastly in
1115	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1308	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1116	will be ignored when running setuid/setgid.
1117		1309
1118	See the @@RXVT_NAME@@perl(3) manpage.	1310	See the @@RXVT_NAME@@perl(3) manpage.
1119		1311
1120	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1312	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1121		1313
…		…
1133	(default: C<M-s>).	1325	(default: C<M-s>).
1134		1326
1135	=item B<urlLauncher>: I<string>	1327	=item B<urlLauncher>: I<string>
1136		1328
1137	Specifies the program to be started with a URL argument. Used by the	1329	Specifies the program to be started with a URL argument. Used by the
1138	C<selection-popup> and C<mark-urls> perl extensions.	1330	C<selection-popup> and C<matcher> perl extensions.
1139		1331
1140	=item B<transient-for>: I<windowid>	1332	=item B<transient-for>: I<windowid>
1141		1333
1142	Sets the WM_TRANSIENT_FOR property to the given window iw.	1334	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1335
		1336	=item B<override-redirect>: I<boolean>
		1337
		1338	Compile I<frills>: Sets override-redirect for the terminal window, making
		1339	it almost invisible to window managers; option B<-override-redirect>.
		1340
		1341	=item B<iso14755:> I<boolean>
		1342
		1343	Turn on/off ISO 14755 (default enabled).
		1344
		1345	=item B<iso14755_52:> I<boolean>
		1346
		1347	Turn on/off ISO 14755 5.2 mode (default enabled).
1143		1348
1144	=back	1349	=back
1145		1350
1146	=head1 THE SCROLLBAR	1351	=head1 THE SCROLLBAR
1147		1352
…		…
1166	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1371	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1167	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1372	(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),	1373	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1169	respectively.	1374	respectively.
1170		1375
1171	=head1 TEXT SELECTION AND INSERTION	1376	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1172		1377
1173	The behaviour of text selection and insertion mechanism is similar to	1378	The behaviour of text selection and insertion/pasting mechanism is similar
1174	I<xterm>(1).	1379	to I<xterm>(1).
1175		1380
1176	=over 4	1381	=over 4
1177		1382
1178	=item B<Selection>:	1383	=item B<Selecting>:
1179		1384
1180	Left click at the beginning of the region, drag to the end of the region	1385	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	1386	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	1387	to select a word; Left triple-click to select the entire logical line
1183	(which can span multiple screen lines), unless modified by resource	1388	(which can span multiple screen lines), unless modified by resource
…		…
1187	(Compile: I<frills>) will create a rectangular selection instead of a	1392	(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	1393	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	1394	selection, and trailing whitespace is visually underlined and removed from
1190	the selection.	1395	the selection.
1191		1396
1192	=item B<Insertion>:	1397	=item B<Pasting>:
1193		1398
1194	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1399	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	1400	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1196	inserted as if it had been typed on the keyboard.	1401	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1402
		1403	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1404	inserted too.
1197		1405
1198	=back	1406	=back
1199		1407
1200	=head1 CHANGING FONTS	1408	=head1 CHANGING FONTS
1201		1409
1202	Changing fonts (or font sizes, respectively) via the keypad is not yet	1410	Changing fonts (or font sizes, respectively) via the keypad is not yet
1203	supported in rxvt-unicode. Bug me if you need this.	1411	supported in rxvt-unicode. Bug me if you need this.
1204		1412
1205	You can, however, switch fonts at runtime using escape sequences (and	1413	You can, however, switch fonts at runtime using escape sequences, e.g.:
1206	therefore using the menubar), e.g.:
1207		1414
1208	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"	1415	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1416
		1417	You can use keyboard shortcuts, too:
		1418
		1419	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1420	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1209		1421
1210	rxvt-unicode will automatically re-apply these fonts to the output so far.	1422	rxvt-unicode will automatically re-apply these fonts to the output so far.
1211		1423
1212	=head1 ISO 14755 SUPPORT	1424	=head1 ISO 14755 SUPPORT
1213		1425
1214	ISO 14755 is a standard for entering and viewing unicode characters	1426	ISO 14755 is a standard for entering and viewing unicode characters
1215	and character codes using the keyboard. It consists of 4 parts. The	1427	and character codes using the keyboard. It consists of 4 parts. The
1216	first part is available rxvt-unicode has been compiled with	1428	first part is available if rxvt-unicode has been compiled with
1217	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1429	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1218	with C<--enable-iso14755>.	1430	with C<--enable-iso14755>.
1219		1431
1220	=over 4	1432	=over 4
1221		1433
…		…
1241	This mode lets you input characters representing the keycap symbols of	1453	This mode lets you input characters representing the keycap symbols of
1242	your keyboard, if representable in the current locale encoding.	1454	your keyboard, if representable in the current locale encoding.
1243		1455
1244	Start by pressing C<Control> and C<Shift> together, then releasing	1456	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	1457	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	1458	invoke its usual function but instead will insert the corresponding
1247	keycap symbol. The symbol will only be entered when the key has been	1459	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	1460	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	1461	C<ISO Level 2 Switch>, although your intention might have been to enter a
1250	reverse tab (Shift-Tab).	1462	reverse tab (Shift-Tab).
1251		1463
…		…
1279	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1491	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1280	it can be seen via the I<who(1)> command, and can accept messages. To	1492	it can be seen via the I<who(1)> command, and can accept messages. To
1281	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1493	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1282	on some systems or setgid to root or to some other group on others.	1494	on some systems or setgid to root or to some other group on others.
1283		1495
1284	=head1 COLORS AND GRAPHICS	1496	=head1 COLOURS AND GRAPHICS
1285		1497
1286	In addition to the default foreground and background colours,	1498	In addition to the default foreground and background colours,
1287	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1499	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1288	high-intensity bold/blink versions of the same). Here is a list of the	1500	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1289	colours with their B<rgb.txt> names.	1501	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1502	cube plus a 8 (24) colour greyscale ramp.
		1503
		1504	Here is a list of the ANSI colours with their names.
1290		1505
1291	=begin table	1506	=begin table
1292		1507
1293	B<color0> (black) = Black	1508	B<color0> (black) = Black
1294	B<color1> (red) = Red3	1509	B<color1> (red) = Red3
…		…
1314	It is also possible to specify the colour values of B<foreground>,	1529	It is also possible to specify the colour values of B<foreground>,
1315	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1530	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	1531	a number 0-15, as a convenient shorthand to reference the colour name of
1317	color0-color15.	1532	color0-color15.
1318		1533
		1534	The following text gives values for the standard 88 colour mode (and
		1535	values for the 256 colour mode in parentheses).
		1536
		1537	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1538
		1539	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1540	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1541
		1542	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1543	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1544	the RGB cube.
		1545
		1546	Together, all those colours implement the 88 (256) colour xterm
		1547	colours. Only the first 16 can be changed using resources currently, the
		1548	rest can only be changed via command sequences ("escape codes").
		1549
		1550	Applications are advised to use terminfo or command sequences to discover
		1551	number and RGB values of all colours (yes, you can query this...).
		1552
1319	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1553	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1320	always swapping the foreground/background colours. This is in contrast to	1554	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	1555	I<xterm>(1) where the colours are only swapped if they have not otherwise
1322	been specified. For example,	1556	been specified. For example,
1323		1557
		1558	@@RXVT_NAME@@ -fg Black -bg White -rv
		1559
		1560	would yield White on Black, while on I<xterm>(1) it would yield Black on
		1561	White.
		1562
		1563	=head2 ALPHA CHANNEL SUPPORT
		1564
		1565	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1566	their act together, rxvt-unicode will do its own alpha channel management:
		1567
		1568	You can prefix any colour with an opaqueness percentage enclosed in
		1569	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1570	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1571	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1572	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1573	is the recommended format to specify transparency values, and works with
		1574	all ways to specify a colour.
		1575
		1576	For complete control, rxvt-unicode also supports
		1577	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1578	specifications, where the additional C<aaaa> component specifies opacity
		1579	(alpha) values. The minimum value of C<0000> is completely transparent,
		1580	while C<ffff> is completely opaque). The two example colours from
		1581	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1582	C<rgba:0000/ff00/0000/f332>.
		1583
		1584	You probably need to specify B<"-depth 32">, too, to force a visual with
		1585	alpha channels, and have the luck that your X-server uses ARGB pixel
		1586	layout, as X is far from just supporting ARGB visuals out of the box, and
		1587	rxvt-unicode just fudges around.
		1588
		1589	For example, the following selects an almost completely transparent black
		1590	background, and an almost opaque pink foreground:
		1591
		1592	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
		1593
		1594	When not using a background image, then the interpretation of the
		1595	alpha channel is up to your compositing manager (most interpret it as
		1596	transparency of course).
		1597
		1598	When using a background pixmap or pseudo-transparency, then the background
		1599	colour will always behave as if it were completely transparent (so the
		1600	background image shows instead), regardless of how it was specified, while
		1601	other colours will either be transparent as specified (the background
		1602	image will show through) on servers supporting the RENDER extension, or
		1603	fully opaque on servers not supporting the RENDER EXTENSION.
		1604
		1605	Please note that due to bugs in Xft, specifying alpha values might result
		1606	in garbage being displayed when the X-server does not support the RENDER
		1607	extension.
		1608
		1609	=head1 ENVIRONMENT
		1610
		1611	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
		1612
1324	=over 4	1613	=over 4
1325		1614
1326	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
1327
1328	would yield White on Black, while on I<xterm>(1) it would yield Black
1329	on White.
1330
1331	=back
1332
1333	=head1 ENVIRONMENT
1334
1335	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1336
1337	=over 4
1338
1339	=item B<TERM>	1615	=item B<TERM>
1340		1616
1341	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1617	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1342	resources or on the commandline.	1618	resources or on the command line.
1343		1619
1344	=item B<COLORTERM>	1620	=item B<COLORTERM>
1345		1621
1346	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1622	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1347	compiled with XPM support, and optionally with the added extension	1623	compiled with background image support, and optionally with the added
1348	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1624	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1625	screen.
1349		1626
1350	=item B<COLORFGBG>	1627	=item B<COLORFGBG>
1351		1628
1352	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1629	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	1630	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	1631	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	1632	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@@	1633	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	1634	was compiled with background image support. Libraries like C<ncurses>
1358	(and do) use this information to optimize screen output.	1635	and C<slang> can (and do) use this information to optimize screen output.
1359		1636
1360	=item B<WINDOWID>	1637	=item B<WINDOWID>
1361		1638
1362	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1639	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	1640	window, which usually has subwindows for the scrollbar, the terminal
…		…
1369	C<--with-terminfo=PATH>.	1646	C<--with-terminfo=PATH>.
1370		1647
1371	=item B<DISPLAY>	1648	=item B<DISPLAY>
1372		1649
1373	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1650	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1374	display in it's child processes.	1651	display in its child processes if C<-display> isn't used to override. It
		1652	defaults to C<:0> if it doesn't exist.
1375		1653
1376	=item B<SHELL>	1654	=item B<SHELL>
1377		1655
1378	The shell to be used for command execution, defaults to C</bin/sh>.	1656	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		1657
1389	=item B<RXVT_SOCKET>	1658	=item B<RXVT_SOCKET>
1390		1659
1391	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1660	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1392	@@RXVT_NAME@@d(1).	1661	@@RXVT_NAME@@d(1).
1393		1662
1394	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1663	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1395		1664
1396	=item B<HOME>	1665	=item B<HOME>
1397		1666
1398	Used to locate the default directory for the unix domain socket for	1667	Used to locate the default directory for the unix domain socket for
1399	daemon communications and to locate various resource files (such as	1668	daemon communications and to locate various resource files (such as
1400	C<.Xdefaults>)	1669	C<.Xdefaults>)
1401		1670
1402	=item B<XAPPLRESDIR>	1671	=item B<XAPPLRESDIR>
1403		1672
1404	Directory where various X resource files are being located.	1673	Directory where application-specific X resource files are located.
1405		1674
1406	=item B<XENVIRONMENT>	1675	=item B<XENVIRONMENT>
1407		1676
1408	If set and accessible, gives the name of a X resource file to be loaded by	1677	If set and accessible, gives the name of a X resource file to be loaded by
1409	@@RXVT_NAME@@.	1678	@@RXVT_NAME@@.
…		…
1414		1683
1415	=over 4	1684	=over 4
1416		1685
1417	=item B</usr/lib/X11/rgb.txt>	1686	=item B</usr/lib/X11/rgb.txt>
1418		1687
1419	Color names.	1688	Colour names.
1420		1689
1421	=back	1690	=back
1422		1691
1423	=head1 SEE ALSO	1692	=head1 SEE ALSO
1424		1693
…		…
1430		1699
1431	=item Project Coordinator	1700	=item Project Coordinator
1432		1701
1433	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1702	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1434		1703
1435	L<http://software.schmorp.de/#rxvt-unicode>	1704	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1436		1705
1437	=back	1706	=back
1438		1707
1439	=head1 AUTHORS	1708	=head1 AUTHORS
1440		1709
…		…
1462		1731
1463	Project Coordinator (changes.txt 2.21a to 2.4.5)	1732	Project Coordinator (changes.txt 2.21a to 2.4.5)
1464		1733
1465	=item Geoff Wing L<< <gcw@pobox.com> >>	1734	=item Geoff Wing L<< <gcw@pobox.com> >>
1466		1735
1467	Rewrote screen display and text selection routines. Project Coordinator	1736	Rewrote screen display and text selection routines.
		1737
1468	(changes.txt 2.4.6 - rxvt-unicode)	1738	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1469		1739
1470	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1740	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1471		1741
1472	Forked rxvt-unicode, rewrote most of the display code and internal	1742	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1473	character handling to store text in unicode, improve xterm	1743	extension, random hacks, numerous bugfixes and extensions.
1474	compatibility and apply numerous other bugfixes and extensions.
1475		1744
1476	Project Coordinator (Changes 1.0 -)	1745	Project Coordinator (Changes 1.0 -)
1477		1746
		1747	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1748
		1749	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
		1750
1478	=back	1751	=back
1479		1752

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.212 by sf-exg, Sun Jan 1 14:31:28 2012 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.212 by sf-exg, Sun Jan 1 14:31:28 2012 UTC