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

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.88 by root, Sun Jan 8 00:20:12 2006 UTC vs. Revision 1.191 by sf-exg, Thu Dec 9 14:19:39 2010 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.88 by root, Sun Jan 8 00:20:12 2006 UTC vs.
Revision 1.191 by sf-exg, Thu Dec 9 14:19:39 2010 UTC