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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.71 by root, Tue Oct 25 20:22:39 2005 UTC vs.
Revision 1.196 by root, Fri May 6 10:18:00 2011 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"
…		…
189	See also the question "How does rxvt-unicode choose fonts?" in the FAQ	227	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
190	section of @@RXVT_NAME@@(7).	228	section of @@RXVT_NAME@@(7).
191		229
192	=item B<-fb> I<fontlist>	230	=item B<-fb> I<fontlist>
193		231
194	Compile font-styles: The bold font list to use when bold characters are to	232	Compile I<font-styles>: The bold font list to use when B<bold> characters
195	be printed. See resource B<boldFont> for details.	233	are to be printed. See resource B<boldFont> for details.
196		234
197	=item B<-fi> I<fontlist>	235	=item B<-fi> I<fontlist>
198		236
199	Compile font-styles: The italic font list to use when bold characters are to	237	Compile I<font-styles>: The italic font list to use when I<italic>
200	be printed. See resource B<italicFont> for details.	238	characters are to be printed. See resource B<italicFont> for details.
201		239
202	=item B<-fbi> I<fontlist>	240	=item B<-fbi> I<fontlist>
203		241
204	Compile font-styles: The bold italic font list to use when bold characters are to	242	Compile I<font-styles>: The bold italic font list to use when B<< I<bold
205	be printed. See resource B<boldItalicFont> for details.	243	italic> >> characters are to be printed. See resource B<boldItalicFont>
		244	for details.
		245
		246	=item B<-is>\|B<+is>
		247
		248	Compile I<font-styles>: Bold/Blink font styles imply high intensity
		249	foreground/background (default). See resource B<intensityStyles> for
		250	details.
206		251
207	=item B<-name> I<name>	252	=item B<-name> I<name>
208		253
209	Specify the application name under which resources are to be obtained,	254	Specify the application name under which resources are to be obtained,
210	rather than the default executable file name. Name should not contain	255	rather than the default executable file name. Name should not contain
…		…
226		271
227	=item B<-sb>\|B<+sb>	272	=item B<-sb>\|B<+sb>
228		273
229	Turn on/off scrollbar; resource B<scrollBar>.	274	Turn on/off scrollbar; resource B<scrollBar>.
230		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
231	=item B<-si>\|B<+si>	285	=item B<-si>\|B<+si>
232		286
233	Turn on/off scroll-to-bottom on TTY output inhibit; resource	287	Turn on/off scroll-to-bottom on TTY output inhibit; resource
234	B<scrollTtyOutput> has opposite effect.	288	B<scrollTtyOutput> has opposite effect.
235		289
…		…
241	=item B<-sw>\|B<+sw>	295	=item B<-sw>\|B<+sw>
242		296
243	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.
244	This only takes effect if B<-si> is also given; resource	298	This only takes effect if B<-si> is also given; resource
245	B<scrollWithBuffer>.	299	B<scrollWithBuffer>.
246
247	=item B<-sr>\|B<+sr>
248
249	Put scrollbar on right/left; resource B<scrollBar_right>.
250
251	=item B<-st>\|B<+st>
252
253	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
254	resource B<scrollBar_floating>.
255		300
256	=item B<-ptab>\|B<+ptab>	301	=item B<-ptab>\|B<+ptab>
257		302
258	If enabled (default), "Horizontal Tab" characters are being stored as	303	If enabled (default), "Horizontal Tab" characters are being stored as
259	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
…		…
263		308
264	=item B<-bc>\|B<+bc>	309	=item B<-bc>\|B<+bc>
265		310
266	Blink the cursor; resource B<cursorBlink>.	311	Blink the cursor; resource B<cursorBlink>.
267		312
		313	=item B<-uc>\|B<+uc>
		314
		315	Make the cursor underlined; resource B<cursorUnderline>.
		316
268	=item B<-iconic>	317	=item B<-iconic>
269		318
270	Start iconified, if the window manager supports that option.	319	Start iconified, if the window manager supports that option.
271	Alternative form is B<-ic>.	320	Alternative form is B<-ic>.
272		321
…		…
288		337
289	=item B<-bl>	338	=item B<-bl>
290		339
291	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.
292	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
293	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>.
		349
		350	=item B<-sbg>
		351
		352	Compile I<frills>: Disable the usage of the built-in block graphics/line
		353	drawing characters and just rely on what the specified fonts provide. Use
		354	this if you have a good font and want to use its block graphic glyphs;
		355	resource B<skipBuiltinGlyphs>.
294		356
295	=item B<-lsp> I<number>	357	=item B<-lsp> I<number>
296		358
297	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
298	the display. Useful to work around font rendering problems; resource	360	the display. Useful to work around font rendering problems; resource
299	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>.
300		369
301	=item B<-tn> I<termname>	370	=item B<-tn> I<termname>
302		371
303	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
304	B<TERM> environment variable. This terminal type must exist in the	373	B<TERM> environment variable. This terminal type must exist in the
…		…
313	given on the command line. If this option is used, it must be the last	382	given on the command line. If this option is used, it must be the last
314	on the command-line. If there is no B<-e> option then the default is to	383	on the command-line. If there is no B<-e> option then the default is to
315	run the program specified by the B<SHELL> environment variable or,	384	run the program specified by the B<SHELL> environment variable or,
316	failing that, I<sh(1)>.	385	failing that, I<sh(1)>.
317		386
		387	Please note that you must specify a program with arguments. If you want to
		388	run shell commands, you have to specify the shell, like this:
		389
		390	@@RXVT_NAME@@ -e sh -c "shell commands"
		391
318	=item B<-title> I<text>	392	=item B<-title> I<text>
319		393
320	Window title (B<-T> still respected); the default title is the basename	394	Window title (B<-T> still respected); the default title is the basename
321	of the program specified after the B<-e> option, if any, otherwise the	395	of the program specified after the B<-e> option, if any, otherwise the
322	application name; resource B<title>.	396	application name; resource B<title>.
…		…
353	for more info.	427	for more info.
354		428
355	=item B<-tcw>	429	=item B<-tcw>
356		430
357	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
358	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
359	end of the logical line only. resource B<tripleclickwords>.	434	the end of the logical line only. resource B<tripleclickwords>.
360		435
361	=item B<-insecure>	436	=item B<-insecure>
362		437
363	Enable "insecure" mode, which currently enables most of the escape	438	Enable "insecure" mode, which currently enables most of the escape
364	sequences that echo strings. See the resource B<insecure> for more	439	sequences that echo strings. See the resource B<insecure> for more
…		…
378	=item B<-ssr>\|B<+ssr>	453	=item B<-ssr>\|B<+ssr>
379		454
380	Turn on/off secondary screen scroll (default enabled); resource	455	Turn on/off secondary screen scroll (default enabled); resource
381	B<secondaryScroll>.	456	B<secondaryScroll>.
382		457
		458	=item B<-hold>\|B<+hold>
		459
		460	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		461	will not immediately destroy its window when the program executed within
		462	it exits. Instead, it will wait till it is being killed or closed by the
		463	user; resource B<hold>.
		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
383	=item B<-keysym.>I<sym> I<string>	484	=item B<-keysym.>I<sym> I<string>
384		485
385	Remap a key symbol. See resource B<keysym>.	486	Remap a key symbol. See resource B<keysym>.
386		487
387	=item B<-embed> I<windowid>	488	=item B<-embed> I<windowid>
388		489
389	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,
390	which enables applications to easily embed a terminal.	491	which enables applications to easily embed a terminal.
391		492
392	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
393	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
394	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
…		…
397	The window will not be destroyed when @@RXVT_NAME@@ exits.	498	The window will not be destroyed when @@RXVT_NAME@@ exits.
398		499
399	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
400	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
401	can use file descriptors to communicate with the programs within the	502	can use file descriptors to communicate with the programs within the
402	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
403	not.	504	not.
404		505
405	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
406	used (a longer example is in F<doc/embed>):	507	used (a longer example is in F<doc/embed>):
407		508
…		…
409	$rxvt->signal_connect_after (realize => sub {	510	$rxvt->signal_connect_after (realize => sub {
410	my $xid = $_[0]->window->get_xid;	511	my $xid = $_[0]->window->get_xid;
411	system "@@RXVT_NAME@@ -embed $xid &";	512	system "@@RXVT_NAME@@ -embed $xid &";
412	});	513	});
413		514
414	=item B<-pty-fd> I<fileno>	515	=item B<-pty-fd> I<file descriptor>
415		516
416	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
417	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
418	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
419	without having to run a program within it.	520	without having to run a program within it.
420		521
421	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
422	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
423	yourself if you want that.	524	yourself if you want that.
		525
		526	As an extremely special case, specifying C<-1> will completely suppress
		527	pty/tty operations, which is probably only useful in conjunction with some
		528	perl extension that manages the terminal.
424		529
425	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
426	longer example is in F<doc/pty-fd>):	531	longer example is in F<doc/pty-fd>):
427		532
428	use IO::Pty;	533	use IO::Pty;
…		…
435		540
436	# now communicate with rxvt	541	# now communicate with rxvt
437	my $slave = $pty->slave;	542	my $slave = $pty->slave;
438	while (<$slave>) { print $slave "got <$_>\n" }	543	while (<$slave>) { print $slave "got <$_>\n" }
439		544
		545	=item B<-pe> I<string>
		546
		547	Comma-separated list of perl extension scripts to use (or not to use) in
		548	this terminal instance. See resource B<perl-ext> for details.
		549
440	=back	550	=back
441		551
442	=head1 RESOURCES (available also as long-options)	552	=head1 RESOURCES
443		553
444	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	554	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
445	options) compiled into your version.	555	options) compiled into your version. All resources are also available as
		556	long-options.
446		557
447	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
448	Xresource data: using the X libraries (Xrm*-functions) or internal	559	distribution do also load settings from the B<~/.Xresources> file when X
449	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	560	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
450	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	561	with later settings overwriting earlier ones:
451	resources using X11 tools like B<xrdb>. Many distribution do also load
452	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
453	will consult the following files/resources in order, with later settings
454	overwriting earlier ones:
455		562
456	1. system-wide app-defaults file, either locale-dependent OR global
457	2. app-defaults file in $XAPPLRESDIR	563	1. app-defaults file in $XAPPLRESDIR
		564	2. $HOME/.Xdefaults
458	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	565	3. RESOURCE_MANAGER property on root-window of screen 0
459	4. SCREEN_RESOURCES for the current screen	566	4. SCREEN_RESOURCES property on root-window of the current screen
460	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	567	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		568	6. resources specified via -xrm on the commandline
461		569
462	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
463	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
464	set in XAPPLOADDIR/URxvt (compile-time defined: usually
465	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
466	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
467	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	570	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
468	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
469	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
470	easily configured, while the class name B<URxvt> allows resources	573	configured, while the class name B<URxvt> allows resources unique to
471	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	574	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
472	shared between different B<@@RXVT_NAME@@> configurations. If no	575	configurations. If no resources are specified, suitable defaults will
473	resources are specified, suitable defaults will be used. Command-line	576	be used. Command-line arguments can be used to override resource
474	arguments can be used to override resource settings. The following	577	settings. The following resources are supported (you might want to
475	resources are allowed:	578	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		579	extensions not documented here):
476		580
477	=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.
478		594
479	=item B<geometry:> I<geom>	595	=item B<geometry:> I<geom>
480		596
481	Create the window with the specified X window geometry [default 80x24];	597	Create the window with the specified X window geometry [default 80x24];
482	option B<-geometry>.	598	option B<-geometry>.
…		…
496	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
497	corresponds to low-intensity (normal) colours and 8-15 corresponds to	613	corresponds to low-intensity (normal) colours and 8-15 corresponds to
498	high-intensity (bold = bright foreground, blink = bright background)	614	high-intensity (bold = bright foreground, blink = bright background)
499	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,
500	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
501	names used are listed in the B<COLORS AND GRAPHICS> section.	617	names used are listed in the B<COLOURS AND GRAPHICS> section.
502		618
503	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
504	changed using an escape command (see @@RXVT_NAME@@(7)).	620	changed using an escape command (see @@RXVT_NAME@@(7)).
505		621
506	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
…		…
517	=item B<colorUL:> I<colour>	633	=item B<colorUL:> I<colour>
518		634
519	Use the specified colour to display underlined characters when the	635	Use the specified colour to display underlined characters when the
520	foreground colour is the default.	636	foreground colour is the default.
521		637
522	=item B<colorRV:> I<colour>
523
524	Use the specified colour as the background for reverse video
525	characters.
526
527	=item B<underlineColor:> I<colour>	638	=item B<underlineColor:> I<colour>
528		639
529	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
530	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.
531		652
532	=item B<cursorColor:> I<colour>	653	=item B<cursorColor:> I<colour>
533		654
534	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
535	foreground colour; option B<-cr>.	656	foreground colour; option B<-cr>.
…		…
542		663
543	=item B<reverseVideo:> I<boolean>	664	=item B<reverseVideo:> I<boolean>
544		665
545	B<True>: simulate reverse video by foreground and background colours;	666	B<True>: simulate reverse video by foreground and background colours;
546	option B<-rv>. B<False>: regular screen colours [default]; option	667	option B<-rv>. B<False>: regular screen colours [default]; option
547	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	668	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
548		669
549	=item B<jumpScroll:> I<boolean>	670	=item B<jumpScroll:> I<boolean>
550		671
551	B<True>: specify that jump scrolling should be used. When scrolling	672	B<True>: specify that jump scrolling should be used. When receiving lots
552	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
553	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>.
554		679
555	=item B<inheritPixmap:> I<boolean>	680	=item B<skipScroll:> I<boolean>
556		681
557	B<True>: make the background inherit the parent windows' pixmap, giving	682	B<True>: (the default) specify that skip scrolling should be used. When
558	artificial transparency. B<False>: do not inherit the parent windows'	683	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
559	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.
560		698
561	=item B<fading:> I<number>	699	=item B<fading:> I<number>
562		700
563	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>.
564		702
…		…
567	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
568	colour is black; option B<-fadecolor>.	706	colour is black; option B<-fadecolor>.
569		707
570	=item B<tintColor:> I<colour>	708	=item B<tintColor:> I<colour>
571		709
572	Tint the transparent background pixmap with the given colour; option	710	Tint the transparent background with the given colour. If the RENDER
573	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>.
574		715
575	=item B<shading:> I<number>	716	=item B<shading:> I<number>
576		717
577	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	718	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
578	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>.
579		733
580	=item B<scrollColor:> I<colour>	734	=item B<scrollColor:> I<colour>
581		735
582	Use the specified colour for the scrollbar [default #B2B2B2].	736	Use the specified colour for the scrollbar [default #B2B2B2].
583		737
…		…
589	=item B<borderColor:> I<colour>	743	=item B<borderColor:> I<colour>
590		744
591	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
592	and the text.	746	and the text.
593		747
594	=item B<backgroundPixmap:> I<file[;geom]>	748	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
595		749
596	Use the specified XPM file (note the `.xpm' extension is optional) for	750	Use the specified image file for the background and also
597	the background and also optionally specify its scaling with a geometry	751	optionally specify its scaling with a geometry string B<WxH+X+Y>,
598	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
599	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	753	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
600	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.
601	of 1 displays the image without any scaling. A scale of 2 to 9	755	The maximum permitted scale is 1000.
602	specifies an integer number of images in that direction. No image will	756	Additional operations can be specified after colon B<:op1:op2...>.
603	be magnified beyond 10 times its original size. The maximum permitted	757	Supported operations are:
604	scale is 1000. [default 0x0+50+50]
605		758
606	=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
607		767
608	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
609	optional) and also optionally specify a starting tag to find. See the	769	blended over the transparent background using alpha-blending. If I<afterimage>
610	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.
611		772
612	=item B<path:> I<path>	773	=item B<path:> I<path>
613		774
614	Specify the colon-delimited search path for finding files (XPM and	775	Specify the colon-delimited search path for finding background image files.
615	menus), in addition to the paths specified by the B<RXVTPATH> and
616	B<PATH> environment variables.
617		776
618	=item B<font:> I<fontlist>	777	=item B<font:> I<fontlist>
619		778
620	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
621	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
622	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
623	be smaller, but not larger. A reasonable default font list is always	782	smaller, but not (in general) larger. A (hopefully) reasonable default
624	appended to it. option B<-fn>.	783	font list is always appended to it; option B<-fn>.
625		784
626	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
627	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:>.
628		787
629	In addition, each font can be prefixed with additional hints and	788	In addition, each font can be prefixed with additional hints and
…		…
631	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
632	fonts.	791	fonts.
633		792
634	For example, this font resource	793	For example, this font resource
635		794
636	URxvt*font: 9x15bold,\	795	URxvt.font: 9x15bold,\
637	-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,\
638	-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, \
639	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	798	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
640	xft:Code2000:antialias=false	799	xft:Code2000:antialias=false
641		800
…		…
644	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
645	wide and 15 pixels high.	804	wide and 15 pixels high.
646		805
647	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
648	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
649	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
650	useful supplement.	809	useful supplement.
651		810
652	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
653	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
654	contains other characters, but we are not interested in them.	813	contains other characters, but we are not interested in them.
…		…
675	not possible, replacement fonts of the desired shape will be tried.	834	not possible, replacement fonts of the desired shape will be tried.
676		835
677	If set, but empty, then this specific style is disabled and the normal	836	If set, but empty, then this specific style is disabled and the normal
678	text font will being used for the given style.	837	text font will being used for the given style.
679		838
680	=item B<selectstyle:> I<mode>	839	=item B<intensityStyles:> I<boolean>
681		840
682	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	841	When font styles are not enabled, or this option is enabled (B<True>,
683	xterm style with 2.20 old word selection, or anything else which gives	842	option B<-is>, the default), bold/blink font styles imply high
684	xterm style selection.	843	intensity foreground/background colours. Disabling this option (B<False>,
685		844	option B<+is>) disables this behaviour, the high intensity colours are not
686	=item B<scrollstyle:> I<mode>	845	reachable.
687
688	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
689	the author's favourite.
690		846
691	=item B<title:> I<string>	847	=item B<title:> I<string>
692		848
693	Set window title string, the default title is the command-line	849	Set window title string, the default title is the command-line
694	specified after the B<-e> option, if any, otherwise the application	850	specified after the B<-e> option, if any, otherwise the application
…		…
703	=item B<mapAlert:> I<boolean>	859	=item B<mapAlert:> I<boolean>
704		860
705	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
706	de-iconify (map) on receipt of a bell character [default].	862	de-iconify (map) on receipt of a bell character [default].
707		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
708	=item B<visualBell:> I<boolean>	871	=item B<visualBell:> I<boolean>
709		872
710	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>.
711	B<False>: no visual bell [default]; option B<+vb>.	874	B<False>: no visual bell [default]; option B<+vb>.
712		875
…		…
730		893
731	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.
732		895
733	Example:	896	Example:
734		897
735	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	898	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
736		899
737	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
738	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.
		907
		908	=item B<thickness:> I<number>
		909
		910	Set the scrollbar width in pixels.
739		911
740	=item B<scrollBar:> I<boolean>	912	=item B<scrollBar:> I<boolean>
741		913
742	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	914	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
743	disable the scrollbar; option B<+sb>.	915	disable the scrollbar; option B<+sb>.
…		…
763	B<False>: do not scroll to bottom when tty receives output; option	935	B<False>: do not scroll to bottom when tty receives output; option
764	B<+si>.	936	B<+si>.
765		937
766	=item B<scrollWithBuffer:> I<boolean>	938	=item B<scrollWithBuffer:> I<boolean>
767		939
768	B<True>: scroll with scrollback buffer when tty receives new lines (and	940	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
769	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	941	try to show the same lines) and B<scrollTtyOutput> is False; option
770	with scrollback buffer when tty recieves new lines; option B<+sw>.	942	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		943	new lines; option B<+sw>.
771		944
772	=item B<scrollTtyKeypress:> I<boolean>	945	=item B<scrollTtyKeypress:> I<boolean>
773		946
774	B<True>: scroll to bottom when a non-special key is pressed. Special keys	947	B<True>: scroll to bottom when a non-special key is pressed. Special keys
775	are those which are intercepted by rxvt-unicode for special handling and	948	are those which are intercepted by rxvt-unicode for special handling and
…		…
794	=item B<borderLess:> I<boolean>	967	=item B<borderLess:> I<boolean>
795		968
796	Set MWM hints to request a borderless window, i.e. if honoured by the	969	Set MWM hints to request a borderless window, i.e. if honoured by the
797	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.	970	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
798		971
		972	=item B<skipBuiltinGlyphs:> I<boolean>
		973
		974	Compile I<frills>: Disable the usage of the built-in block graphics/line
		975	drawing characters and just rely on what the specified fonts provide. Use
		976	this if you have a good font and want to use its block graphic glyphs;
		977	option B<-sbg>.
		978
799	=item B<termName:> I<termname>	979	=item B<termName:> I<termname>
800		980
801	Specifies the terminal type name to be set in the B<TERM> environment	981	Specifies the terminal type name to be set in the B<TERM> environment
802	variable; option B<-tn>.	982	variable; option B<-tn>.
803		983
804	=item B<linespace:> I<number>	984	=item B<lineSpace:> I<number>
805		985
806	Specifies number of lines (pixel height) to insert between each row of	986	Specifies number of lines (pixel height) to insert between each row of
807	the display [default 0]; option B<-lsp>.	987	the display [default 0]; option B<-lsp>.
808		988
809	=item B<meta8:> I<boolean>	989	=item B<meta8:> I<boolean>
…		…
823		1003
824	=item B<cursorBlink:> I<boolean>	1004	=item B<cursorBlink:> I<boolean>
825		1005
826	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1006	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
827	option B<-bc>.	1007	option B<-bc>.
		1008
		1009	=item B<cursorUnderline:> I<boolean>
		1010
		1011	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1012	option B<-uc>.
828		1013
829	=item B<pointerBlank:> I<boolean>	1014	=item B<pointerBlank:> I<boolean>
830		1015
831	B<True>: blank the pointer when a key is pressed or after a set number	1016	B<True>: blank the pointer when a key is pressed or after a set number
832	of seconds of inactivity. B<False>: the pointer is always visible	1017	of seconds of inactivity. B<False>: the pointer is always visible
…		…
846	large number (e.g. C<987654321>) to effectively disable the timeout.	1031	large number (e.g. C<987654321>) to effectively disable the timeout.
847		1032
848	=item B<backspacekey:> I<string>	1033	=item B<backspacekey:> I<string>
849		1034
850	The string to send when the backspace key is pressed. If set to B<DEC>	1035	The string to send when the backspace key is pressed. If set to B<DEC>
851	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	1036	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
852	(code 8) - which can be reversed with the appropriate DEC private mode	1037	(code 8) - which can be reversed with the appropriate DEC private mode
853	escape sequence.	1038	escape sequence.
854		1039
855	=item B<deletekey:> I<string>	1040	=item B<deletekey:> I<string>
856		1041
…		…
858	pressed. If unset it will send the sequence traditionally associated	1043	pressed. If unset it will send the sequence traditionally associated
859	with the B<Execute> key.	1044	with the B<Execute> key.
860		1045
861	=item B<cutchars:> I<string>	1046	=item B<cutchars:> I<string>
862		1047
863	The characters used as delimiters for double-click word selection. The	1048	The characters used as delimiters for double-click word selection
864	built-in default:	1049	(whitespace delimiting is added automatically if resource is given).
865		1050
		1051	When the perl selection extension is in use (the default if compiled
		1052	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		1053	characters will be created (if the resource exists, otherwise, no regex
		1054	will be created). In this mode, characters outside ISO-8859-1 can be used.
		1055
		1056	When the selection extension is not used, only ISO-8859-1 characters can
		1057	be used. If not specified, the built-in default is used:
		1058
866	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1059	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
867		1060
868	=item B<preeditType:> I<style>	1061	=item B<preeditType:> I<style>
869		1062
870	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1063	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
871		1064
…		…
876	=item B<imLocale:> I<name>	1069	=item B<imLocale:> I<name>
877		1070
878	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.	1071	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
879	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the	1072	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
880	input extension to be able to input japanese characters while staying in	1073	input extension to be able to input japanese characters while staying in
881	another locale. option B<-imlocale>.	1074	another locale; option B<-imlocale>.
882		1075
883	=item B<imFont:> I<fontset>	1076	=item B<imFont:> I<fontset>
884		1077
885	Specify the font-set used for XIM styles C<OverTheSpot> or	1078	Specify the font-set used for XIM styles C<OverTheSpot> or
886	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated	1079	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
…		…
891		1084
892	=item B<tripleclickwords:> I<boolean>	1085	=item B<tripleclickwords:> I<boolean>
893		1086
894	Change the meaning of triple-click selection with the left mouse	1087	Change the meaning of triple-click selection with the left mouse
895	button. Instead of selecting a full line it will extend the selection to	1088	button. Instead of selecting a full line it will extend the selection to
896	the end of the logical line only. option B<-tcw>.	1089	the end of the logical line only; option B<-tcw>.
897		1090
898	=item B<insecure:> I<boolean>	1091	=item B<insecure:> I<boolean>
899		1092
900	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	1093	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
901	echo arbitrary strings like the icon name or the locale. This could be	1094	echo arbitrary strings like the icon name or the locale. This could be
902	abused if somebody gets 8-bit-clean access to your display, whether	1095	abused if somebody gets 8-bit-clean access to your display, whether
903	throuh a mail client displaying mail bodies unfiltered or though	1096	through a mail client displaying mail bodies unfiltered or through
904	write(1). Therefore, these sequences are disabled by default. (Note	1097	write(1) or any other means. Therefore, these sequences are disabled by
905	that other terminals, including xterm, have these sequences	1098	default. (Note that many other terminals, including xterm, have these
906	enabled by default). You can enable them by setting this boolean	1099	sequences enabled by default, which doesn't make it safer, though).
907	resource or specifying B<-insecure> as an option. At the moment, this	1100
908	enabled display-answer, locale, findfont, icon label and window title	1101	You can enable them by setting this boolean resource or specifying
909	requests as well as dynamic menubar dispatch.	1102	B<-insecure> as an option. At the moment, this enables display-answer,
		1103	locale, findfont, icon label and window title requests.
910		1104
911	=item B<modifier:> I<modifier>	1105	=item B<modifier:> I<modifier>
912		1106
913	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	1107	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
914	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	1108	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
918		1112
919	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	1113	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
920	character is passed through. It may contain escape values as described	1114	character is passed through. It may contain escape values as described
921	in the entry on B<keysym> following.	1115	in the entry on B<keysym> following.
922		1116
923	=item B<secondaryScreen:> I<bool>	1117	=item B<secondaryScreen:> I<boolean>
924		1118
925	Turn on/off secondary screen (default enabled).	1119	Turn on/off secondary screen (default enabled).
926		1120
927	=item B<secondaryScroll:> I<bool>	1121	=item B<secondaryScroll:> I<boolean>
928		1122
929	Turn on/off secondary screen scroll (default enabled). If the this	1123	Turn on/off secondary screen scroll (default enabled). If this
930	option is enabled, scrolls on the secondary screen will change the	1124	option is enabled, scrolls on the secondary screen will change the
931	scrollback buffer and switching to/from the secondary screen will	1125	scrollback buffer and, when secondaryScreen is off, switching
932	instead scroll the screen up.	1126	to/from the secondary screen will instead scroll the screen up.
		1127
		1128	=item B<hold>: I<boolean>
		1129
		1130	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		1131	will not immediately destroy its window when the program executed within
		1132	it exits. Instead, it will wait till it is being killed or closed by the
		1133	user.
		1134
		1135	=item B<chdir>: I<path>
		1136
		1137	Sets the working directory for the shell (or the command specified via
		1138	B<-e>). The I<path> must be an absolute path and it must exist for
		1139	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1140	directory will be used; option B<-cd>.
933		1141
934	=item B<keysym.>I<sym>: I<string>	1142	=item B<keysym.>I<sym>: I<string>
935		1143
936	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1144	Compile I<frills>: Associate I<string> with keysym I<sym>. The
937	intervening resource name B<keysym.> cannot be omitted.	1145	intervening resource name B<keysym.> cannot be omitted.
…		…
951	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1159	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
952	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1160	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
953	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1161	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
954	performed in an exact manner; however, the closest match is assured.	1162	performed in an exact manner; however, the closest match is assured.
955		1163
956	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1164	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
957	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1165	number), see RESOURCES in C<man 7 X> for further details.
958	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
959	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
960	can start or end with whitespace.
961
962	Please note that you need to double the C<\> when using
963	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
964	use C<\033> instead of C<\e> (and so on), which will work with both Xt and
965	@@RXVT_NAME@@'s own processing).
966
967	You can define a range of keysyms in one shot by providing a I<string>
968	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
969	should be a character not used by the strings.
970
971	Its usage can be demonstrated by an example:
972
973	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
974
975	The above line is equivalent to the following three lines:
976
977	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
978	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
979	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
980		1166
981	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1167	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
982	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1168	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
983	example the following means "change the current locale to C<zh_CN.GBK>	1169	example the following means "change the current locale to C<zh_CN.GBK>
984	when Control-Meta-c is being pressed":	1170	when Control-Meta-c is being pressed":
985		1171
986	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1172	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
987		1173
		1174	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1175	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1176	manpage. For example, the F<selection> extension (activated via
		1177	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1178
		1179	URxvt.keysym.M-C-c: perl:selection:rot13
		1180
988	Due the the large number of modifier combinations, a defined key mapping	1181	Due the the large number of modifier combinations, a defined key mapping
989	will match if at I<at least> the specified identifiers are being set, and	1182	will match if I<at least> the specified identifiers are being set, and
990	no other key mappings with those and more bits are being defined. That	1183	no other key mappings with those and more bits are being defined. That
991	means that defining a key map for C<a> will automatically provide	1184	means that defining a key map for C<a> will automatically provide
992	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined	1185	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
993	mappings themselves.	1186	mappings themselves.
994		1187
…		…
1014	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1207	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1015	info):	1208	info):
1016		1209
1017	URxvt.keysym.M-C-3: command:\033[8;25;80t	1210	URxvt.keysym.M-C-3: command:\033[8;25;80t
1018	URxvt.keysym.M-C-4: command:\033[8;48;110t	1211	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1212
		1213	=item B<perl-ext-common>: I<string>
		1214
		1215	=item B<perl-ext>: I<string>
		1216
		1217	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1218	use in this terminal instance; option B<-pe>.
		1219
		1220	Extension names can be prefixed with a C<-> sign to prohibit using
		1221	them. This can be useful to selectively disable some extensions loaded
		1222	by default, or specified via the C<perl-ext-common> resource. For
		1223	example, C<default,-selection> will use all the default extension except
		1224	C<selection>.
		1225
		1226	Extension names can also be followed by an argument in angle brackets
		1227	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1228	searchable scrollback to Alt/Meta-s). Mentioning the same extension
		1229	multiple times with different arguments will pass multiple arguments to
		1230	the extension.
		1231
		1232	Each extension is looked up in the library directories, loaded if
		1233	necessary, and bound to the current terminal instance.
		1234
		1235	If both of these resources are the empty string, then the perl
		1236	interpreter will not be initialized. The idea behind two options is that
		1237	B<perl-ext-common> will be used for extensions that should be available to
		1238	all instances, while B<perl-ext> is used for specific instances.
		1239
		1240	=item B<perl-eval>: I<string>
		1241
		1242	Perl code to be evaluated when all extensions have been registered. See
		1243	the @@RXVT_NAME@@perl(3) manpage.
		1244
		1245	=item B<perl-lib>: I<path>
		1246
		1247	Colon-separated list of additional directories that hold extension
		1248	scripts. When looking for extensions specified by the C<perl> resource,
		1249	@@RXVT_NAME@@ will first look in these directories and then in
		1250	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
		1251
		1252	See the @@RXVT_NAME@@perl(3) manpage.
		1253
		1254	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1255
		1256	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1257	details.
		1258
		1259	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1260
		1261	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1262	for details.
		1263
		1264	=item B<searchable-scrollback:> I<keysym>
		1265
		1266	Sets the hotkey that starts the incremental scrollback buffer search
		1267	(default: C<M-s>).
		1268
		1269	=item B<urlLauncher>: I<string>
		1270
		1271	Specifies the program to be started with a URL argument. Used by the
		1272	C<selection-popup> and C<matcher> perl extensions.
		1273
		1274	=item B<transient-for>: I<windowid>
		1275
		1276	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1277
		1278	=item B<override-redirect>: I<boolean>
		1279
		1280	Compile I<frills>: Sets override-redirect for the terminal window, making
		1281	it almost invisible to window managers; option B<-override-redirect>.
		1282
		1283	=item B<iso14755:> I<boolean>
		1284
		1285	Turn on/off ISO 14755 (default enabled).
		1286
		1287	=item B<iso14755_52:> I<boolean>
		1288
		1289	Turn on/off ISO 14755 5.2 mode (default enabled).
1019		1290
1020	=back	1291	=back
1021		1292
1022	=head1 THE SCROLLBAR	1293	=head1 THE SCROLLBAR
1023		1294
…		…
1042	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1313	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1043	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1314	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1044	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1315	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1045	respectively.	1316	respectively.
1046		1317
1047	=head1 TEXT SELECTION AND INSERTION	1318	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1048		1319
1049	The behaviour of text selection and insertion mechanism is similar to	1320	The behaviour of text selection and insertion/pasting mechanism is similar
1050	I<xterm>(1).	1321	to I<xterm>(1).
1051		1322
1052	=over 4	1323	=over 4
1053		1324
1054	=item B<Selection>:	1325	=item B<Selecting>:
1055		1326
1056	Left click at the beginning of the region, drag to the end of the region	1327	Left click at the beginning of the region, drag to the end of the region
1057	and release; Right click to extend the marked region; Left double-click	1328	and release; Right click to extend the marked region; Left double-click
1058	to select a word; Left triple-click to select the entire logical line	1329	to select a word; Left triple-click to select the entire logical line
1059	(which can span multiple screen lines), unless modified by resource	1330	(which can span multiple screen lines), unless modified by resource
1060	B<tripleclickwords>.	1331	B<tripleclickwords>.
1061		1332
1062	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1333	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
1063	(Compile: I<frills>) will create a rectangular selection instead of a normal	1334	(Compile: I<frills>) will create a rectangular selection instead of a
1064	one.	1335	normal one. In this mode, every selected row becomes its own line in the
		1336	selection, and trailing whitespace is visually underlined and removed from
		1337	the selection.
1065		1338
1066	=item B<Insertion>:	1339	=item B<Pasting>:
1067		1340
1068	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1341	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1069	an B<@@RXVT_NAME@@> window causes the current text selection to be	1342	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1070	inserted as if it had been typed on the keyboard.	1343	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1344
		1345	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1346	inserted too.
1071		1347
1072	=back	1348	=back
1073		1349
1074	=head1 CHANGING FONTS	1350	=head1 CHANGING FONTS
1075		1351
1076	Changing fonts (or font sizes, respectively) via the keypad is not yet	1352	Changing fonts (or font sizes, respectively) via the keypad is not yet
1077	supported in rxvt-unicode. Bug me if you need this.	1353	supported in rxvt-unicode. Bug me if you need this.
1078		1354
1079	You can, however, switch fonts at runtime using escape sequences (and	1355	You can, however, switch fonts at runtime using escape sequences, e.g.:
1080	therefore using the menubar), e.g.:
1081		1356
1082	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1357	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1358
		1359	You can use keyboard shortcuts, too:
		1360
		1361	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1362	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1083		1363
1084	rxvt-unicode will automatically re-apply these fonts to the output so far.	1364	rxvt-unicode will automatically re-apply these fonts to the output so far.
1085		1365
1086	=head1 ISO 14755 SUPPORT	1366	=head1 ISO 14755 SUPPORT
1087		1367
1088	ISO 14755 is a standard for entering and viewing unicode characters	1368	ISO 14755 is a standard for entering and viewing unicode characters
1089	and character codes using the keyboard. It consists of 4 parts. The	1369	and character codes using the keyboard. It consists of 4 parts. The
1090	first part is available rxvt-unicode has been compiled with	1370	first part is available if rxvt-unicode has been compiled with
1091	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1371	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1092	with C<--enable-iso14755>.	1372	with C<--enable-iso14755>.
1093		1373
1094	=over 4	1374	=over 4
1095		1375
…		…
1115	This mode lets you input characters representing the keycap symbols of	1395	This mode lets you input characters representing the keycap symbols of
1116	your keyboard, if representable in the current locale encoding.	1396	your keyboard, if representable in the current locale encoding.
1117		1397
1118	Start by pressing C<Control> and C<Shift> together, then releasing	1398	Start by pressing C<Control> and C<Shift> together, then releasing
1119	them. The next special key (cursor keys, home etc.) you enter will not	1399	them. The next special key (cursor keys, home etc.) you enter will not
1120	invoke it's usual function but instead will insert the corresponding	1400	invoke its usual function but instead will insert the corresponding
1121	keycap symbol. The symbol will only be entered when the key has been	1401	keycap symbol. The symbol will only be entered when the key has been
1122	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1402	released, otherwise pressing e.g. C<Shift> would enter the symbol for
1123	C<ISO Level 2 Switch>, although your intention might have been to enter a	1403	C<ISO Level 2 Switch>, although your intention might have been to enter a
1124	reverse tab (Shift-Tab).	1404	reverse tab (Shift-Tab).
1125		1405
…		…
1153	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1433	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1154	it can be seen via the I<who(1)> command, and can accept messages. To	1434	it can be seen via the I<who(1)> command, and can accept messages. To
1155	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1435	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1156	on some systems or setgid to root or to some other group on others.	1436	on some systems or setgid to root or to some other group on others.
1157		1437
1158	=head1 COLORS AND GRAPHICS	1438	=head1 COLOURS AND GRAPHICS
1159		1439
1160	In addition to the default foreground and background colours,	1440	In addition to the default foreground and background colours,
1161	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1441	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1162	high-intensity bold/blink versions of the same). Here is a list of the	1442	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1163	colours with their B<rgb.txt> names.	1443	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1444	cube plus a 8 (24) colour greyscale ramp.
		1445
		1446	Here is a list of the ANSI colours with their names.
1164		1447
1165	=begin table	1448	=begin table
1166		1449
1167	B<color0> (black) = Black	1450	B<color0> (black) = Black
1168	B<color1> (red) = Red3	1451	B<color1> (red) = Red3
…		…
1188	It is also possible to specify the colour values of B<foreground>,	1471	It is also possible to specify the colour values of B<foreground>,
1189	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1472	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1190	a number 0-15, as a convenient shorthand to reference the colour name of	1473	a number 0-15, as a convenient shorthand to reference the colour name of
1191	color0-color15.	1474	color0-color15.
1192		1475
		1476	The following text gives values for the standard 88 colour mode (and
		1477	values for the 256 colour mode in parentheses).
		1478
		1479	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1480
		1481	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1482	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1483
		1484	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1485	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1486	the RGB cube.
		1487
		1488	Together, all those colours implement the 88 (256) colour xterm
		1489	colours. Only the first 16 can be changed using resources currently, the
		1490	rest can only be changed via command sequences ("escape codes").
		1491
		1492	Applications are advised to use terminfo or command sequences to discover
		1493	number and RGB values of all colours (yes, you can query this...).
		1494
1193	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1495	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1194	always swapping the foreground/background colours. This is in contrast to	1496	always swapping the foreground/background colours. This is in contrast to
1195	I<xterm>(1) where the colours are only swapped if they have not otherwise	1497	I<xterm>(1) where the colours are only swapped if they have not otherwise
1196	been specified. For example,	1498	been specified. For example,
1197		1499
		1500	@@RXVT_NAME@@ -fg Black -bg White -rv
		1501
		1502	would yield White on Black, while on I<xterm>(1) it would yield Black on
		1503	White.
		1504
		1505	=head2 ALPHA CHANNEL SUPPORT
		1506
		1507	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1508	their act together, rxvt-unicode will do it's own alpha channel management:
		1509
		1510	You can prefix any colour with an opaqueness percentage enclosed in
		1511	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1512	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1513	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1514	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1515	is the recommended format to specify transparency values, and works with
		1516	all ways to specify a colour.
		1517
		1518	For complete control, rxvt-unicode also supports
		1519	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1520	specifications, where the additional C<aaaa> component specifies opacity
		1521	(alpha) values. The minimum value of C<0000> is completely transparent,
		1522	while C<ffff> is completely opaque). The two example colours from
		1523	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1524	C<rgba:0000/ff00/0000/f332>.
		1525
		1526	You probably need to specify B<"-depth 32">, too, to force a visual with
		1527	alpha channels, and have the luck that your X-server uses ARGB pixel
		1528	layout, as X is far from just supporting ARGB visuals out of the box, and
		1529	rxvt-unicode just fudges around.
		1530
		1531	For example, the following selects an almost completely transparent black
		1532	background, and an almost opaque pink foreground:
		1533
		1534	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
		1535
		1536	When not using a background image, then the interpretation of the
		1537	alpha channel is up to your compositing manager (most interpret it as
		1538	transparency of course).
		1539
		1540	When using a background pixmap or pseudo-transparency, then the background
		1541	colour will always behave as if it were completely transparent (so the
		1542	background image shows instead), regardless of how it was specified, while
		1543	other colours will either be transparent as specified (the background
		1544	image will show through) on servers supporting the RENDER extension, or
		1545	fully opaque on servers not supporting the RENDER EXTENSION.
		1546
		1547	Please note that due to bugs in Xft, specifying alpha values might result
		1548	in garbage being displayed when the X-server does not support the RENDER
		1549	extension.
		1550
		1551	=head1 ENVIRONMENT
		1552
		1553	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
		1554
1198	=over 4	1555	=over 4
1199		1556
1200	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
1201
1202	would yield White on Black, while on I<xterm>(1) it would yield Black
1203	on White.
1204
1205	=back
1206
1207	=head1 ENVIRONMENT
1208
1209	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1210
1211	=over 4
1212
1213	=item B<TERM>	1557	=item B<TERM>
1214		1558
1215	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1559	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1216	resources or on the commandline.	1560	resources or on the command line.
1217		1561
1218	=item B<COLORTERM>	1562	=item B<COLORTERM>
1219		1563
1220	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1564	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1221	compiled with XPM support, and optionally with the added extension	1565	compiled with background image support, and optionally with the added
1222	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1566	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1567	screen.
1223		1568
1224	=item B<COLORFGBG>	1569	=item B<COLORFGBG>
1225		1570
1226	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1571	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1227	the colour code used as default foreground/text colour (or the string	1572	the colour code used as default foreground/text colour (or the string
1228	C<default> to indicate that the default-colour escape sequence is to be	1573	C<default> to indicate that the default-colour escape sequence is to be
1229	used), C<bg> is the colour code used as default background colour (or the	1574	used), C<bg> is the colour code used as default background colour (or the
1230	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1575	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1231	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1576	was compiled with background image support. Libraries like C<ncurses>
1232	(and do) use this information to optimize screen output.	1577	and C<slang> can (and do) use this information to optimize screen output.
1233		1578
1234	=item B<WINDOWID>	1579	=item B<WINDOWID>
1235		1580
1236	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1581	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1237	window, which usually has subwindows for the scrollbar, the terminal	1582	window, which usually has subwindows for the scrollbar, the terminal
…		…
1243	C<--with-terminfo=PATH>.	1588	C<--with-terminfo=PATH>.
1244		1589
1245	=item B<DISPLAY>	1590	=item B<DISPLAY>
1246		1591
1247	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1592	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1248	display in it's child processes.	1593	display in its child processes if C<-display> isn't used to override. It
		1594	defaults to C<:0> if it doesn't exist.
1249		1595
1250	=item B<SHELL>	1596	=item B<SHELL>
1251		1597
1252	The shell to be used for command execution, defaults to C</bin/sh>.	1598	The shell to be used for command execution, defaults to C</bin/sh>.
1253
1254	=item B<RXVTPATH>
1255
1256	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1257	files.
1258
1259	=item B<PATH>
1260
1261	Used in the same way as C<RXVTPATH>.
1262		1599
1263	=item B<RXVT_SOCKET>	1600	=item B<RXVT_SOCKET>
1264		1601
1265	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1602	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1266	@@RXVT_NAME@@d(1).	1603	@@RXVT_NAME@@d(1).
1267		1604
1268	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1605	Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>.
1269		1606
1270	=item B<HOME>	1607	=item B<HOME>
1271		1608
1272	Used to locate the default directory for the unix domain socket for	1609	Used to locate the default directory for the unix domain socket for
1273	daemon communications and to locate various resource files (such as	1610	daemon communications and to locate various resource files (such as
1274	C<.Xdefaults>)	1611	C<.Xdefaults>)
1275		1612
1276	=item B<XAPPLRESDIR>	1613	=item B<XAPPLRESDIR>
1277		1614
1278	Directory where various X resource files are being located.	1615	Directory where application-specific X resource files are located.
1279		1616
1280	=item B<XENVIRONMENT>	1617	=item B<XENVIRONMENT>
1281		1618
1282	If set and accessible, gives the name of a X resource file to be loaded by	1619	If set and accessible, gives the name of a X resource file to be loaded by
1283	@@RXVT_NAME@@.	1620	@@RXVT_NAME@@.
…		…
1288		1625
1289	=over 4	1626	=over 4
1290		1627
1291	=item B</usr/lib/X11/rgb.txt>	1628	=item B</usr/lib/X11/rgb.txt>
1292		1629
1293	Color names.	1630	Colour names.
1294		1631
1295	=back	1632	=back
1296		1633
1297	=head1 SEE ALSO	1634	=head1 SEE ALSO
1298		1635
…		…
1304		1641
1305	=item Project Coordinator	1642	=item Project Coordinator
1306		1643
1307	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1644	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1308		1645
1309	L<http://software.schmorp.de/#rxvt-unicode>	1646	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1310		1647
1311	=back	1648	=back
1312		1649
1313	=head1 AUTHORS	1650	=head1 AUTHORS
1314		1651
…		…
1336		1673
1337	Project Coordinator (changes.txt 2.21a to 2.4.5)	1674	Project Coordinator (changes.txt 2.21a to 2.4.5)
1338		1675
1339	=item Geoff Wing L<< <gcw@pobox.com> >>	1676	=item Geoff Wing L<< <gcw@pobox.com> >>
1340		1677
1341	Rewrote screen display and text selection routines. Project Coordinator	1678	Rewrote screen display and text selection routines.
		1679
1342	(changes.txt 2.4.6 - rxvt-unicode)	1680	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1343		1681
1344	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1682	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1345		1683
1346	Forked rxvt-unicode, rewrote most of the display code and internal	1684	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1347	character handling to store text in unicode, improve xterm	1685	extension, random hacks, numerous bugfixes and extensions.
1348	compatibility and apply numerous other bugfixes and extensions.
1349		1686
1350	Project Coordinator (Changes 1.0 -)	1687	Project Coordinator (Changes 1.0 -)
1351		1688
		1689	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1690
		1691	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
		1692
1352	=back	1693	=back
1353		1694

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.71 by root, Tue Oct 25 20:22:39 2005 UTC vs. Revision 1.196 by root, Fri May 6 10:18:00 2011 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.71 by root, Tue Oct 25 20:22:39 2005 UTC vs.
Revision 1.196 by root, Fri May 6 10:18:00 2011 UTC