[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.186 by sf-exg, Wed Oct 13 23:36:00 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 illusion of a transparent window background; resource B<transparent>.
		130
		131	B<-ip> is still accepted as an obsolete alias but will be removed in
		132	future versions.
		133
		134	I<Please address all transparency related issues to Sasha Vasko at
		135	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
114		136
115	=item B<-fade> I<number>	137	=item B<-fade> I<number>
116		138
117	Fade the text by the given percentage when focus is lost. Small values	139	Fade the text by the given percentage when focus is lost. Small values
118	fade a little only, 100 completely replaces all colours by the fade	140	fade a little only, 100 completely replaces all colours by the fade
119	colour; resource B<fading>.	141	colour; resource B<fading>.
120		142
121	=item B<-fadecolor> I<colour>	143	=item B<-fadecolor> I<colour>
122		144
123	Fade to this colour when fading is used (see B<-fade>). The default colour	145	Fade to this colour when fading is used (see B<-fade>). The default colour
124	is black. resource B<fadeColor>.	146	is opaque black. resource B<fadeColor>.
125		147
126	=item B<-tint> I<colour>	148	=item B<-tint> I<colour>
127		149
128	Tint the transparent background pixmap with the given colour when	150	Tint the transparent background pixmap with the given colour when
129	transparency is enabled with B<-tr> or B<-ip>. This only works for	151	transparency is enabled with B<-tr>. This only works for
130	non-tiled backgrounds, currently. See also the B<-sh> option that can be	152	non-tiled backgrounds, currently. See also the B<-sh> option that can be
131	used to brighten or darken the image in addition to tinting it; resource	153	used to brighten or darken the image in addition to tinting it.
		154	Please note that certain tint colours can be applied on the server-side,
		155	thus yielding performance gain of two orders of magnitude. These colours are:
		156	blue, red, green, cyan, magenta, yellow, and those close to them. Also
		157	pure black and pure white colours essentially mean no tinting; resource
132	I<tintColor>. Example:	158	I<tintColor>. Example:
133		159
134	@@RXVT_NAME@@ -tr -tint blue -sh 40	160	@@RXVT_NAME@@ -tr -tint blue -sh 40
135		161
136	=item B<-sh>	162	=item B<-sh> I<number>
137		163
138	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	164	Darken (0 .. 100) or lighten (100 .. 200) the transparent
139	background image in addition to tinting it (i.e. B<-tint> must be	165	background image in addition to (or instead of) tinting it;
140	specified, too, e.g. C<-tint white>).	166	resource I<shading>.
		167
		168	=item B<-blt> I<string>
		169
		170	Specify background blending type. If background pixmap is specified
		171	at the same time as transparency - such pixmap will be blended over
		172	transparency image, using method specified. Supported values are :
		173	B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
		174	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
		175	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
		176	alpha-blending. Compile I<afterimage>; resource I<blendType>.
		177
		178	=item B<-blr> I<HxV>
		179
		180	Apply Gaussian Blur with the specified radii to the transparent
		181	background image. If single number is specified - both vertical and
		182	horizontal radii are considered to be the same. Setting one of the
		183	radii to 1 and another to a large number creates interesting effects
		184	on some backgrounds. Maximum radius value is 128. Compile I<afterimage> or I<xft>;
		185	resource I<blurRadius>.
		186
		187	=item B<-icon> I<file>
		188
		189	Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
		190	is used by many window managers, taskbars and pagers to represent the
		191	application window; resource I<iconFile>.
141		192
142	=item B<-bg> I<colour>	193	=item B<-bg> I<colour>
143		194
144	Window background colour; resource B<background>.	195	Window background colour; resource B<background>.
145		196
146	=item B<-fg> I<colour>	197	=item B<-fg> I<colour>
147		198
148	Window foreground colour; resource B<foreground>.	199	Window foreground colour; resource B<foreground>.
149		200
150	=item B<-pixmap> I<file[;geom]>	201	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
151		202
152	Compile I<XPM>: Specify XPM file for the background and also optionally	203	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	204	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	205	add quotes to avoid special shell interpretation of the C<;> in the
155	command-line; resource B<backgroundPixmap>.	206	command-line; for more details see resource B<backgroundPixmap>.
156		207
157	=item B<-cr> I<colour>	208	=item B<-cr> I<colour>
158		209
159	The cursor colour; resource B<cursorColor>.	210	The cursor colour; resource B<cursorColor>.
160		211
…		…
172	resource B<borderColor>.	223	resource B<borderColor>.
173		224
174	=item B<-fn> I<fontlist>	225	=item B<-fn> I<fontlist>
175		226
176	Select the fonts to be used. This is a comma separated list of font names	227	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	228	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	229	first font defines the cell size for characters; other fonts might be
179	smaller, but not (in general) larger. A (hopefully) reasonable default	230	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.	231	font list is always appended to it. See resource B<font> for more details.
181		232
182	In short, to specify an X11 core font, just specify it's name or prefix it	233	In short, to specify an X11 core font, just specify its name or prefix it
183	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,	234	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184	e.g.:	235	e.g.:
185		236
186	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	237	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	238	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
189	See also the question "How does rxvt-unicode choose fonts?" in the FAQ	240	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
190	section of @@RXVT_NAME@@(7).	241	section of @@RXVT_NAME@@(7).
191		242
192	=item B<-fb> I<fontlist>	243	=item B<-fb> I<fontlist>
193		244
194	Compile font-styles: The bold font list to use when bold characters are to	245	Compile I<font-styles>: The bold font list to use when B<bold> characters
195	be printed. See resource B<boldFont> for details.	246	are to be printed. See resource B<boldFont> for details.
196		247
197	=item B<-fi> I<fontlist>	248	=item B<-fi> I<fontlist>
198		249
199	Compile font-styles: The italic font list to use when bold characters are to	250	Compile I<font-styles>: The italic font list to use when I<italic>
200	be printed. See resource B<italicFont> for details.	251	characters are to be printed. See resource B<italicFont> for details.
201		252
202	=item B<-fbi> I<fontlist>	253	=item B<-fbi> I<fontlist>
203		254
204	Compile font-styles: The bold italic font list to use when bold characters are to	255	Compile I<font-styles>: The bold italic font list to use when B<< I<bold
205	be printed. See resource B<boldItalicFont> for details.	256	italic> >> characters are to be printed. See resource B<boldItalicFont>
		257	for details.
		258
		259	=item B<-is>\|B<+is>
		260
		261	Compile I<font-styles>: Bold/Blink font styles imply high intensity
		262	foreground/background (default). See resource B<intensityStyles> for
		263	details.
206		264
207	=item B<-name> I<name>	265	=item B<-name> I<name>
208		266
209	Specify the application name under which resources are to be obtained,	267	Specify the application name under which resources are to be obtained,
210	rather than the default executable file name. Name should not contain	268	rather than the default executable file name. Name should not contain
…		…
226		284
227	=item B<-sb>\|B<+sb>	285	=item B<-sb>\|B<+sb>
228		286
229	Turn on/off scrollbar; resource B<scrollBar>.	287	Turn on/off scrollbar; resource B<scrollBar>.
230		288
		289	=item B<-sr>\|B<+sr>
		290
		291	Put scrollbar on right/left; resource B<scrollBar_right>.
		292
		293	=item B<-st>\|B<+st>
		294
		295	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		296	resource B<scrollBar_floating>.
		297
231	=item B<-si>\|B<+si>	298	=item B<-si>\|B<+si>
232		299
233	Turn on/off scroll-to-bottom on TTY output inhibit; resource	300	Turn on/off scroll-to-bottom on TTY output inhibit; resource
234	B<scrollTtyOutput> has opposite effect.	301	B<scrollTtyOutput> has opposite effect.
235		302
…		…
241	=item B<-sw>\|B<+sw>	308	=item B<-sw>\|B<+sw>
242		309
243	Turn on/off scrolling with the scrollback buffer as new lines appear.	310	Turn on/off scrolling with the scrollback buffer as new lines appear.
244	This only takes effect if B<-si> is also given; resource	311	This only takes effect if B<-si> is also given; resource
245	B<scrollWithBuffer>.	312	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		313
256	=item B<-ptab>\|B<+ptab>	314	=item B<-ptab>\|B<+ptab>
257		315
258	If enabled (default), "Horizontal Tab" characters are being stored as	316	If enabled (default), "Horizontal Tab" characters are being stored as
259	actual wide characters in the screen buffer, which makes it possible to	317	actual wide characters in the screen buffer, which makes it possible to
…		…
263		321
264	=item B<-bc>\|B<+bc>	322	=item B<-bc>\|B<+bc>
265		323
266	Blink the cursor; resource B<cursorBlink>.	324	Blink the cursor; resource B<cursorBlink>.
267		325
		326	=item B<-uc>\|B<+uc>
		327
		328	Make the cursor underlined; resource B<cursorUnderline>.
		329
268	=item B<-iconic>	330	=item B<-iconic>
269		331
270	Start iconified, if the window manager supports that option.	332	Start iconified, if the window manager supports that option.
271	Alternative form is B<-ic>.	333	Alternative form is B<-ic>.
272		334
…		…
288		350
289	=item B<-bl>	351	=item B<-bl>
290		352
291	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	353	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	354	if honoured by the WM, the rxvt-unicode window will not have window
293	decorations; resource B<borderLess>.	355	decorations; resource B<borderLess>. If the window manager does not
		356	support MWM hints (e.g. kwin), enables override-redirect mode.
		357
		358	=item B<-override-redirect>
		359
		360	Compile I<frills>: Sets override-redirect on the window; resource
		361	B<override-redirect>.
		362
		363	=item B<-sbg>
		364
		365	Compile I<frills>: Disable the usage of the built-in block graphics/line
		366	drawing characters and just rely on what the specified fonts provide. Use
		367	this if you have a good font and want to use its block graphic glyphs;
		368	resource B<skipBuiltinGlyphs>.
294		369
295	=item B<-lsp> I<number>	370	=item B<-lsp> I<number>
296		371
297	Compile I<frills>: Lines (pixel height) to insert between each row of	372	Compile I<frills>: Lines (pixel height) to insert between each row of
298	the display. Useful to work around font rendering problems; resource	373	the display. Useful to work around font rendering problems; resource
299	B<linespace>.	374	B<lineSpace>.
		375
		376	=item B<-letsp> I<number>
		377
		378	Compile I<frills>: Amount to adjust the computed character width by
		379	to control overall letter spacing. Negative values will tighten up the
		380	letter spacing, positive values will space letters out more. Useful to
		381	work around odd font metrics; resource B<letterSpace>.
300		382
301	=item B<-tn> I<termname>	383	=item B<-tn> I<termname>
302		384
303	This option specifies the name of the terminal type to be set in the	385	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	386	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	395	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	396	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,	397	run the program specified by the B<SHELL> environment variable or,
316	failing that, I<sh(1)>.	398	failing that, I<sh(1)>.
317		399
		400	Please note that you must specify a program with arguments. If you want to
		401	run shell commands, you have to specify the shell, like this:
		402
		403	@@RXVT_NAME@@ -e sh -c "shell commands"
		404
318	=item B<-title> I<text>	405	=item B<-title> I<text>
319		406
320	Window title (B<-T> still respected); the default title is the basename	407	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	408	of the program specified after the B<-e> option, if any, otherwise the
322	application name; resource B<title>.	409	application name; resource B<title>.
…		…
353	for more info.	440	for more info.
354		441
355	=item B<-tcw>	442	=item B<-tcw>
356		443
357	Change the meaning of triple-click selection with the left mouse	444	Change the meaning of triple-click selection with the left mouse
		445	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	446	in-use. Instead of selecting a full line it will extend the selection to
359	end of the logical line only. resource B<tripleclickwords>.	447	the end of the logical line only. resource B<tripleclickwords>.
360		448
361	=item B<-insecure>	449	=item B<-insecure>
362		450
363	Enable "insecure" mode, which currently enables most of the escape	451	Enable "insecure" mode, which currently enables most of the escape
364	sequences that echo strings. See the resource B<insecure> for more	452	sequences that echo strings. See the resource B<insecure> for more
…		…
378	=item B<-ssr>\|B<+ssr>	466	=item B<-ssr>\|B<+ssr>
379		467
380	Turn on/off secondary screen scroll (default enabled); resource	468	Turn on/off secondary screen scroll (default enabled); resource
381	B<secondaryScroll>.	469	B<secondaryScroll>.
382		470
		471	=item B<-hold>\|B<+hold>
		472
		473	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		474	will not immediately destroy its window when the program executed within
		475	it exits. Instead, it will wait till it is being killed or closed by the
		476	user; resource B<hold>.
		477
		478	=item B<-cd> I<path>
		479
		480	Sets the working directory for the shell (or the command specified via
		481	B<-e>). The I<path> must be an absolute path and it must exist for
		482	@@RXVT_NAME@@ to start; resource B<chdir>.
		483
		484	=item B<-xrm> I<string>
		485
		486	Works like the X Toolkit option of the same name, by adding the I<string>
		487	as if it were specified in a resource file. Resource values specified this
		488	way take precedence over all other resource specifications.
		489
		490	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		491	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		492	options can be specified as long-options on the commandline, so use
		493	of B<-xrm> is mostly limited to cases where you want to specify other
		494	resources (e.g. for input methods) or for compatibility with other
		495	programs.
		496
383	=item B<-keysym.>I<sym> I<string>	497	=item B<-keysym.>I<sym> I<string>
384		498
385	Remap a key symbol. See resource B<keysym>.	499	Remap a key symbol. See resource B<keysym>.
386		500
387	=item B<-embed> I<windowid>	501	=item B<-embed> I<windowid>
388		502
389	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,	503	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
390	which enables applications to easily embed a terminal.	504	which enables applications to easily embed a terminal.
391		505
392	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it	506	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	507	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	508	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.	511	The window will not be destroyed when @@RXVT_NAME@@ exits.
398		512
399	It might be useful to know that @@RXVT_NAME@@ will not close file	513	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	514	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	515	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	516	terminal. This works regardless of whether the C<-embed> option was used or
403	not.	517	not.
404		518
405	Here is a short Gtk2-perl snippet that illustrates how this option can be	519	Here is a short Gtk2-perl snippet that illustrates how this option can be
406	used (a longer example is in F<doc/embed>):	520	used (a longer example is in F<doc/embed>):
407		521
…		…
409	$rxvt->signal_connect_after (realize => sub {	523	$rxvt->signal_connect_after (realize => sub {
410	my $xid = $_[0]->window->get_xid;	524	my $xid = $_[0]->window->get_xid;
411	system "@@RXVT_NAME@@ -embed $xid &";	525	system "@@RXVT_NAME@@ -embed $xid &";
412	});	526	});
413		527
414	=item B<-pty-fd> I<fileno>	528	=item B<-pty-fd> I<file descriptor>
415		529
416	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	530	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	531	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	532	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
419	without having to run a program within it.	533	without having to run a program within it.
420		534
421	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	535	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	536	entries and will not tinker with pty/tty permissions - you have to do that
423	yourself if you want that.	537	yourself if you want that.
		538
		539	As an extremely special case, specifying C<-1> will completely suppress
		540	pty/tty operations, which is probably only useful in conjunction with some
		541	perl extension that manages the terminal.
424		542
425	Here is a example in perl that illustrates how this option can be used (a	543	Here is a example in perl that illustrates how this option can be used (a
426	longer example is in F<doc/pty-fd>):	544	longer example is in F<doc/pty-fd>):
427		545
428	use IO::Pty;	546	use IO::Pty;
…		…
435		553
436	# now communicate with rxvt	554	# now communicate with rxvt
437	my $slave = $pty->slave;	555	my $slave = $pty->slave;
438	while (<$slave>) { print $slave "got <$_>\n" }	556	while (<$slave>) { print $slave "got <$_>\n" }
439		557
		558	=item B<-pe> I<string>
		559
		560	Comma-separated list of perl extension scripts to use (or not to use) in
		561	this terminal instance. See resource B<perl-ext> for details.
		562
440	=back	563	=back
441		564
442	=head1 RESOURCES (available also as long-options)	565	=head1 RESOURCES
443		566
444	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	567	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
445	options) compiled into your version.	568	options) compiled into your version. All resources are also available as
		569	long-options.
446		570
447	There are two different methods that @@RXVT_NAME@@ can use to get the	571	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	572	distribution do also load settings from the B<~/.Xresources> file when X
449	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	573	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	574	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		575
456	1. system-wide app-defaults file, either locale-dependent OR global	576	1. system-wide app-defaults file, either locale-dependent OR global
457	2. app-defaults file in $XAPPLRESDIR	577	2. app-defaults file in $XAPPLRESDIR
458	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	578	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
459	4. SCREEN_RESOURCES for the current screen	579	4. SCREEN_RESOURCES for the current screen
460	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	580	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		581	6. resources specified via -xrm on the commandline
461		582
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	583	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	584	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	585	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	586	configured, while the class name B<URxvt> allows resources unique to
471	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	587	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
472	shared between different B<@@RXVT_NAME@@> configurations. If no	588	configurations. If no resources are specified, suitable defaults will
473	resources are specified, suitable defaults will be used. Command-line	589	be used. Command-line arguments can be used to override resource
474	arguments can be used to override resource settings. The following	590	settings. The following resources are supported (you might want to
475	resources are allowed:	591	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		592	extensions not documented here):
476		593
477	=over 4	594	=over 4
		595
		596	=item B<depth:> I<bitdepth>
		597
		598	Compile I<xft>: Attempt to find a visual with the given bit depth;
		599	option B<-depth>.
		600
		601	=item B<buffered:> I<boolean>
		602
		603	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		604	On some card/driver combination enabling it slightly decreases
		605	performance, on most it greatly helps it. The slowdown is small, so it
		606	should normally be enabled.
478		607
479	=item B<geometry:> I<geom>	608	=item B<geometry:> I<geom>
480		609
481	Create the window with the specified X window geometry [default 80x24];	610	Create the window with the specified X window geometry [default 80x24];
482	option B<-geometry>.	611	option B<-geometry>.
…		…
496	Use the specified colour for the colour value I<n>, where 0-7	625	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	626	corresponds to low-intensity (normal) colours and 8-15 corresponds to
498	high-intensity (bold = bright foreground, blink = bright background)	627	high-intensity (bold = bright foreground, blink = bright background)
499	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	628	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	629	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.	630	names used are listed in the B<COLOURS AND GRAPHICS> section.
502		631
503	Colours higher than 15 cannot be set using resources (yet), but can be	632	Colours higher than 15 cannot be set using resources (yet), but can be
504	changed using an escape command (see @@RXVT_NAME@@(7)).	633	changed using an escape command (see @@RXVT_NAME@@(7)).
505		634
506	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	635	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
517	=item B<colorUL:> I<colour>	646	=item B<colorUL:> I<colour>
518		647
519	Use the specified colour to display underlined characters when the	648	Use the specified colour to display underlined characters when the
520	foreground colour is the default.	649	foreground colour is the default.
521		650
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>	651	=item B<underlineColor:> I<colour>
528		652
529	If set, use the specified colour as the colour for the underline	653	If set, use the specified colour as the colour for the underline
530	itself. If unset, use the foreground colour.	654	itself. If unset, use the foreground colour.
		655
		656	=item B<highlightColor:> I<colour>
		657
		658	If set, use the specified colour as the background for highlighted
		659	characters. If unset, use reverse video.
		660
		661	=item B<highlightTextColor:> I<colour>
		662
		663	If set and highlightColor is set, use the specified colour as the
		664	foreground for highlighted characters.
531		665
532	=item B<cursorColor:> I<colour>	666	=item B<cursorColor:> I<colour>
533		667
534	Use the specified colour for the cursor. The default is to use the	668	Use the specified colour for the cursor. The default is to use the
535	foreground colour; option B<-cr>.	669	foreground colour; option B<-cr>.
…		…
542		676
543	=item B<reverseVideo:> I<boolean>	677	=item B<reverseVideo:> I<boolean>
544		678
545	B<True>: simulate reverse video by foreground and background colours;	679	B<True>: simulate reverse video by foreground and background colours;
546	option B<-rv>. B<False>: regular screen colours [default]; option	680	option B<-rv>. B<False>: regular screen colours [default]; option
547	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	681	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
548		682
549	=item B<jumpScroll:> I<boolean>	683	=item B<jumpScroll:> I<boolean>
550		684
551	B<True>: specify that jump scrolling should be used. When scrolling	685	B<True>: specify that jump scrolling should be used. When receiving lots
552	quickly, fewer screen updates are performed [default]; option B<-j>.	686	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		687	has been read, resulting in fewer updates while still displaying every
		688	received line; option B<-j>.
		689
553	B<False>: specify that smooth scrolling should be used; option B<+j>.	690	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		691	force a screen refresh on each new line it received; option B<+j>.
554		692
555	=item B<inheritPixmap:> I<boolean>	693	=item B<skipScroll:> I<boolean>
556		694
557	B<True>: make the background inherit the parent windows' pixmap, giving	695	B<True>: (the default) specify that skip scrolling should be used. When
558	artificial transparency. B<False>: do not inherit the parent windows'	696	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
559	pixmap.	697	(around 60 times per second), resulting in far fewer updates. This can
		698	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		699	option B<-ss>.
		700
		701	B<False>: specify that everything is to be displayed, even
		702	if the refresh is too fast for the human eye to read anything (or the
		703	monitor to display anything); option B<+ss>.
		704
		705	=item B<transparent:> I<boolean>
		706
		707	Turn on/off illusion of a transparent window background.
		708
		709	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
		710	future versions.
		711
		712	I<Please address all transparency related issues to Sasha Vasko at
		713	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
560		714
561	=item B<fading:> I<number>	715	=item B<fading:> I<number>
562		716
563	Fade the text by the given percentage when focus is lost; option B<-fade>.	717	Fade the text by the given percentage when focus is lost; option B<-fade>.
564		718
…		…
572	Tint the transparent background pixmap with the given colour; option	726	Tint the transparent background pixmap with the given colour; option
573	B<-tint>.	727	B<-tint>.
574		728
575	=item B<shading:> I<number>	729	=item B<shading:> I<number>
576		730
577	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	731	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
578	image in addition to tinting it.	732	in addition to tinting it; option B<-sh>.
		733
		734	=item B<blendType:> I<string>
		735
		736	Specify background blending type; option B<-blt>.
		737
		738	=item B<blurRadius:> I<number>
		739
		740	Apply gaussian blur with the specified radius to the transparent
		741	background image; option B<-blr>.
		742
		743	=item B<iconFile:> I<file>
		744
		745	Set the application icon pixmap; option B<-icon>.
579		746
580	=item B<scrollColor:> I<colour>	747	=item B<scrollColor:> I<colour>
581		748
582	Use the specified colour for the scrollbar [default #B2B2B2].	749	Use the specified colour for the scrollbar [default #B2B2B2].
583		750
…		…
589	=item B<borderColor:> I<colour>	756	=item B<borderColor:> I<colour>
590		757
591	The colour of the border around the text area and between the scrollbar	758	The colour of the border around the text area and between the scrollbar
592	and the text.	759	and the text.
593		760
594	=item B<backgroundPixmap:> I<file[;geom]>	761	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
595		762
596	Use the specified XPM file (note the `.xpm' extension is optional) for	763	Use the specified image file for the background and also
597	the background and also optionally specify its scaling with a geometry	764	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	765	(default C<100x100+50+50>) in which B<"W" / "H"> specify the
599	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	766	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	767	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	768	The maximum permitted scale is 1000.
602	specifies an integer number of images in that direction. No image will	769	Additional operations can be specified after colon B<:op1:op2...>.
603	be magnified beyond 10 times its original size. The maximum permitted	770	Supported operations are:
604	scale is 1000. [default 0x0+50+50]
605		771
606	=item B<menu:> I<file[;tag]>	772	tile force background image to be tiled and not scaled. Equivalent to 0x0
		773	propscale will scale image keeping proportions
		774	auto will scale image to match window size. Equivalent to 100x100
		775	hscale will scale image horizontally to the window size
		776	vscale will scale image vertically to the window size
		777	scale will scale image to match window size
		778	root will tile image as if it was a root window background, auto-adjusting
		779	whenever terminal window moves
607		780
608	Read in the specified menu file (note the `.menu' extension is	781	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	782	blended over transparency image using alpha-blending. If I<afterimage>
610	reference documentation for details on the syntax for the menuBar.	783	support has been compiled in it is possible to choose other blending
		784	types with B<-blt "type"> option.
611		785
612	=item B<path:> I<path>	786	=item B<path:> I<path>
613		787
614	Specify the colon-delimited search path for finding files (XPM and	788	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		789
618	=item B<font:> I<fontlist>	790	=item B<font:> I<fontlist>
619		791
620	Select the fonts to be used. This is a comma separated list of font	792	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.	793	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	794	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	795	smaller, but not (in general) larger. A (hopefully) reasonable default
624	appended to it. option B<-fn>.	796	font list is always appended to it; option B<-fn>.
625		797
626	Each font can either be a standard X11 core font (XLFD) name, with	798	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:>.	799	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
628		800
629	In addition, each font can be prefixed with additional hints and	801	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	803	hint currently is C<codeset=codeset-name>, and this is only used for Xft
632	fonts.	804	fonts.
633		805
634	For example, this font resource	806	For example, this font resource
635		807
636	URxvt*font: 9x15bold,\	808	URxvt.font: 9x15bold,\
637	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	809	-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, \	810	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
639	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	811	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
640	xft:Code2000:antialias=false	812	xft:Code2000:antialias=false
641		813
…		…
644	it is named first) and thus defines the character cell grid to be 9 pixels	816	it is named first) and thus defines the character cell grid to be 9 pixels
645	wide and 15 pixels high.	817	wide and 15 pixels high.
646		818
647	The second font is just used to add additional unicode characters not in	819	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	820	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	821	the bold version of the font does contain fewer characters, so this is a
650	useful supplement.	822	useful supplement.
651		823
652	The third font is an Xft font with aliasing turned off, and the characters	824	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	825	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.	826	contains other characters, but we are not interested in them.
…		…
675	not possible, replacement fonts of the desired shape will be tried.	847	not possible, replacement fonts of the desired shape will be tried.
676		848
677	If set, but empty, then this specific style is disabled and the normal	849	If set, but empty, then this specific style is disabled and the normal
678	text font will being used for the given style.	850	text font will being used for the given style.
679		851
680	=item B<selectstyle:> I<mode>	852	=item B<intensityStyles:> I<boolean>
681		853
682	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	854	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	855	option B<-is>, the default), bold/blink font styles imply high
684	xterm style selection.	856	intensity foreground/background colours. Disabling this option (B<False>,
685		857	option B<+is>) disables this behaviour, the high intensity colours are not
686	=item B<scrollstyle:> I<mode>	858	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		859
691	=item B<title:> I<string>	860	=item B<title:> I<string>
692		861
693	Set window title string, the default title is the command-line	862	Set window title string, the default title is the command-line
694	specified after the B<-e> option, if any, otherwise the application	863	specified after the B<-e> option, if any, otherwise the application
…		…
703	=item B<mapAlert:> I<boolean>	872	=item B<mapAlert:> I<boolean>
704		873
705	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	874	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].	875	de-iconify (map) on receipt of a bell character [default].
707		876
		877	=item B<urgentOnBell:> I<boolean>
		878
		879	B<True>: set the urgency hint for the wm on receipt of a bell character.
		880	B<False>: do not set the urgency hint [default].
		881
		882	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		883
708	=item B<visualBell:> I<boolean>	884	=item B<visualBell:> I<boolean>
709		885
710	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	886	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
711	B<False>: no visual bell [default]; option B<+vb>.	887	B<False>: no visual bell [default]; option B<+vb>.
712		888
…		…
730		906
731	The string will be interpreted as if typed into the shell as-is.	907	The string will be interpreted as if typed into the shell as-is.
732		908
733	Example:	909	Example:
734		910
735	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	911	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
736		912
737	This creates a new file in your home directory with the screen contents	913	This creates a new file in your home directory with the screen contents
738	everytime you hit C<Print>.	914	every time you hit C<Print>.
		915
		916	=item B<scrollstyle:> I<mode>
		917
		918	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		919	the author's favourite.
739		920
740	=item B<scrollBar:> I<boolean>	921	=item B<scrollBar:> I<boolean>
741		922
742	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	923	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
743	disable the scrollbar; option B<+sb>.	924	disable the scrollbar; option B<+sb>.
…		…
765		946
766	=item B<scrollWithBuffer:> I<boolean>	947	=item B<scrollWithBuffer:> I<boolean>
767		948
768	B<True>: scroll with scrollback buffer when tty receives new lines (and	949	B<True>: scroll with scrollback buffer when tty receives new lines (and
769	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	950	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
770	with scrollback buffer when tty recieves new lines; option B<+sw>.	951	with scrollback buffer when tty receives new lines; option B<+sw>.
771		952
772	=item B<scrollTtyKeypress:> I<boolean>	953	=item B<scrollTtyKeypress:> I<boolean>
773		954
774	B<True>: scroll to bottom when a non-special key is pressed. Special keys	955	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	956	are those which are intercepted by rxvt-unicode for special handling and
…		…
794	=item B<borderLess:> I<boolean>	975	=item B<borderLess:> I<boolean>
795		976
796	Set MWM hints to request a borderless window, i.e. if honoured by the	977	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>.	978	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
798		979
		980	=item B<skipBuiltinGlyphs:> I<boolean>
		981
		982	Compile I<frills>: Disable the usage of the built-in block graphics/line
		983	drawing characters and just rely on what the specified fonts provide. Use
		984	this if you have a good font and want to use its block graphic glyphs;
		985	option B<-sbg>.
		986
799	=item B<termName:> I<termname>	987	=item B<termName:> I<termname>
800		988
801	Specifies the terminal type name to be set in the B<TERM> environment	989	Specifies the terminal type name to be set in the B<TERM> environment
802	variable; option B<-tn>.	990	variable; option B<-tn>.
803		991
804	=item B<linespace:> I<number>	992	=item B<lineSpace:> I<number>
805		993
806	Specifies number of lines (pixel height) to insert between each row of	994	Specifies number of lines (pixel height) to insert between each row of
807	the display [default 0]; option B<-lsp>.	995	the display [default 0]; option B<-lsp>.
808		996
809	=item B<meta8:> I<boolean>	997	=item B<meta8:> I<boolean>
…		…
823		1011
824	=item B<cursorBlink:> I<boolean>	1012	=item B<cursorBlink:> I<boolean>
825		1013
826	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1014	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
827	option B<-bc>.	1015	option B<-bc>.
		1016
		1017	=item B<cursorUnderline:> I<boolean>
		1018
		1019	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1020	option B<-uc>.
828		1021
829	=item B<pointerBlank:> I<boolean>	1022	=item B<pointerBlank:> I<boolean>
830		1023
831	B<True>: blank the pointer when a key is pressed or after a set number	1024	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	1025	of seconds of inactivity. B<False>: the pointer is always visible
…		…
846	large number (e.g. C<987654321>) to effectively disable the timeout.	1039	large number (e.g. C<987654321>) to effectively disable the timeout.
847		1040
848	=item B<backspacekey:> I<string>	1041	=item B<backspacekey:> I<string>
849		1042
850	The string to send when the backspace key is pressed. If set to B<DEC>	1043	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>	1044	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	1045	(code 8) - which can be reversed with the appropriate DEC private mode
853	escape sequence.	1046	escape sequence.
854		1047
855	=item B<deletekey:> I<string>	1048	=item B<deletekey:> I<string>
856		1049
…		…
858	pressed. If unset it will send the sequence traditionally associated	1051	pressed. If unset it will send the sequence traditionally associated
859	with the B<Execute> key.	1052	with the B<Execute> key.
860		1053
861	=item B<cutchars:> I<string>	1054	=item B<cutchars:> I<string>
862		1055
863	The characters used as delimiters for double-click word selection. The	1056	The characters used as delimiters for double-click word selection
864	built-in default:	1057	(whitespace delimiting is added automatically if resource is given).
865		1058
		1059	When the perl selection extension is in use (the default if compiled
		1060	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		1061	characters will be created (if the resource exists, otherwise, no regex
		1062	will be created). In this mode, characters outside ISO-8859-1 can be used.
		1063
		1064	When the selection extension is not used, only ISO-8859-1 characters can
		1065	be used. If not specified, the built-in default is used:
		1066
866	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1067	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
867		1068
868	=item B<preeditType:> I<style>	1069	=item B<preeditType:> I<style>
869		1070
870	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1071	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
871		1072
…		…
876	=item B<imLocale:> I<name>	1077	=item B<imLocale:> I<name>
877		1078
878	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.	1079	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	1080	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	1081	input extension to be able to input japanese characters while staying in
881	another locale. option B<-imlocale>.	1082	another locale; option B<-imlocale>.
882		1083
883	=item B<imFont:> I<fontset>	1084	=item B<imFont:> I<fontset>
884		1085
885	Specify the font-set used for XIM styles C<OverTheSpot> or	1086	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	1087	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
…		…
891		1092
892	=item B<tripleclickwords:> I<boolean>	1093	=item B<tripleclickwords:> I<boolean>
893		1094
894	Change the meaning of triple-click selection with the left mouse	1095	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	1096	button. Instead of selecting a full line it will extend the selection to
896	the end of the logical line only. option B<-tcw>.	1097	the end of the logical line only; option B<-tcw>.
897		1098
898	=item B<insecure:> I<boolean>	1099	=item B<insecure:> I<boolean>
899		1100
900	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	1101	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
901	echo arbitrary strings like the icon name or the locale. This could be	1102	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	1103	abused if somebody gets 8-bit-clean access to your display, whether
903	throuh a mail client displaying mail bodies unfiltered or though	1104	through a mail client displaying mail bodies unfiltered or through
904	write(1). Therefore, these sequences are disabled by default. (Note	1105	write(1) or any other means. Therefore, these sequences are disabled by
905	that other terminals, including xterm, have these sequences	1106	default. (Note that many other terminals, including xterm, have these
906	enabled by default). You can enable them by setting this boolean	1107	sequences enabled by default, which doesn't make it safer, though).
907	resource or specifying B<-insecure> as an option. At the moment, this	1108
908	enabled display-answer, locale, findfont, icon label and window title	1109	You can enable them by setting this boolean resource or specifying
909	requests as well as dynamic menubar dispatch.	1110	B<-insecure> as an option. At the moment, this enables display-answer,
		1111	locale, findfont, icon label and window title requests.
910		1112
911	=item B<modifier:> I<modifier>	1113	=item B<modifier:> I<modifier>
912		1114
913	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	1115	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	1116	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
918		1120
919	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	1121	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	1122	character is passed through. It may contain escape values as described
921	in the entry on B<keysym> following.	1123	in the entry on B<keysym> following.
922		1124
923	=item B<secondaryScreen:> I<bool>	1125	=item B<secondaryScreen:> I<boolean>
924		1126
925	Turn on/off secondary screen (default enabled).	1127	Turn on/off secondary screen (default enabled).
926		1128
927	=item B<secondaryScroll:> I<bool>	1129	=item B<secondaryScroll:> I<boolean>
928		1130
929	Turn on/off secondary screen scroll (default enabled). If the this	1131	Turn on/off secondary screen scroll (default enabled). If this
930	option is enabled, scrolls on the secondary screen will change the	1132	option is enabled, scrolls on the secondary screen will change the
931	scrollback buffer and switching to/from the secondary screen will	1133	scrollback buffer and, when secondaryScreen is off, switching
932	instead scroll the screen up.	1134	to/from the secondary screen will instead scroll the screen up.
		1135
		1136	=item B<hold>: I<boolean>
		1137
		1138	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		1139	will not immediately destroy its window when the program executed within
		1140	it exits. Instead, it will wait till it is being killed or closed by the
		1141	user.
		1142
		1143	=item B<chdir>: I<path>
		1144
		1145	Sets the working directory for the shell (or the command specified via
		1146	B<-e>). The I<path> must be an absolute path and it must exist for
		1147	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1148	directory will be used; option B<-cd>.
933		1149
934	=item B<keysym.>I<sym>: I<string>	1150	=item B<keysym.>I<sym>: I<string>
935		1151
936	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1152	Compile I<frills>: Associate I<string> with keysym I<sym>. The
937	intervening resource name B<keysym.> cannot be omitted.	1153	intervening resource name B<keysym.> cannot be omitted.
…		…
951	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1167	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	1168	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	1169	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.	1170	performed in an exact manner; however, the closest match is assured.
955		1171
956	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1172	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,	1173	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		1174
967	You can define a range of keysyms in one shot by providing a I<string>	1175	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 `/'	1176	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
969	should be a character not used by the strings.	1177	should be a character not used by the strings.
970		1178
971	Its usage can be demonstrated by an example:	1179	Its usage can be demonstrated by an example:
972		1180
973	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1181	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
…		…
983	example the following means "change the current locale to C<zh_CN.GBK>	1191	example the following means "change the current locale to C<zh_CN.GBK>
984	when Control-Meta-c is being pressed":	1192	when Control-Meta-c is being pressed":
985		1193
986	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1194	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
987		1195
		1196	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1197	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1198	manpage. For example, the F<selection> extension (activated via
		1199	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1200
		1201	URxvt.keysym.M-C-c: perl:selection:rot13
		1202
988	Due the the large number of modifier combinations, a defined key mapping	1203	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	1204	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	1205	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	1206	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	1207	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
993	mappings themselves.	1208	mappings themselves.
994		1209
…		…
1014	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1229	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1015	info):	1230	info):
1016		1231
1017	URxvt.keysym.M-C-3: command:\033[8;25;80t	1232	URxvt.keysym.M-C-3: command:\033[8;25;80t
1018	URxvt.keysym.M-C-4: command:\033[8;48;110t	1233	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1234
		1235	=item B<perl-ext-common>: I<string>
		1236
		1237	=item B<perl-ext>: I<string>
		1238
		1239	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1240	use in this terminal instance; option B<-pe>.
		1241
		1242	Extension names can be prefixed with a C<-> sign to prohibit using
		1243	them. This can be useful to selectively disable some extensions loaded
		1244	by default, or specified via the C<perl-ext-common> resource. For
		1245	example, C<default,-selection> will use all the default extension except
		1246	C<selection>.
		1247
		1248	Extension names can also be followed by an argument in angle brackets
		1249	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1250	searchable scrollback to Alt/Meta-s). Mentioning the same extension
		1251	multiple times with different arguments will pass multiple arguments to
		1252	the extension.
		1253
		1254	Each extension is looked up in the library directories, loaded if
		1255	necessary, and bound to the current terminal instance.
		1256
		1257	If both of these resources are the empty string, then the perl
		1258	interpreter will not be initialized. The idea behind two options is that
		1259	B<perl-ext-common> will be used for extensions that should be available to
		1260	all instances, while B<perl-ext> is used for specific instances.
		1261
		1262	=item B<perl-eval>: I<string>
		1263
		1264	Perl code to be evaluated when all extensions have been registered. See
		1265	the @@RXVT_NAME@@perl(3) manpage.
		1266
		1267	=item B<perl-lib>: I<path>
		1268
		1269	Colon-separated list of additional directories that hold extension
		1270	scripts. When looking for extensions specified by the C<perl> resource,
		1271	@@RXVT_NAME@@ will first look in these directories and then in
		1272	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
		1273
		1274	See the @@RXVT_NAME@@perl(3) manpage.
		1275
		1276	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1277
		1278	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1279	details.
		1280
		1281	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1282
		1283	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1284	for details.
		1285
		1286	=item B<searchable-scrollback:> I<keysym>
		1287
		1288	Sets the hotkey that starts the incremental scrollback buffer search
		1289	(default: C<M-s>).
		1290
		1291	=item B<urlLauncher>: I<string>
		1292
		1293	Specifies the program to be started with a URL argument. Used by the
		1294	C<selection-popup> and C<matcher> perl extensions.
		1295
		1296	=item B<transient-for>: I<windowid>
		1297
		1298	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1299
		1300	=item B<override-redirect>: I<boolean>
		1301
		1302	Compile I<frills>: Sets override-redirect for the terminal window, making
		1303	it almost invisible to window managers; option B<-override-redirect>.
		1304
		1305	=item B<iso14755:> I<boolean>
		1306
		1307	Turn on/off ISO 14755 (default enabled).
		1308
		1309	=item B<iso14755_52:> I<boolean>
		1310
		1311	Turn on/off ISO 14755 5.2 mode (default enabled).
1019		1312
1020	=back	1313	=back
1021		1314
1022	=head1 THE SCROLLBAR	1315	=head1 THE SCROLLBAR
1023		1316
…		…
1042	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1335	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1043	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1336	(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),	1337	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1045	respectively.	1338	respectively.
1046		1339
1047	=head1 TEXT SELECTION AND INSERTION	1340	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1048		1341
1049	The behaviour of text selection and insertion mechanism is similar to	1342	The behaviour of text selection and insertion/pasting mechanism is similar
1050	I<xterm>(1).	1343	to I<xterm>(1).
1051		1344
1052	=over 4	1345	=over 4
1053		1346
1054	=item B<Selection>:	1347	=item B<Selecting>:
1055		1348
1056	Left click at the beginning of the region, drag to the end of the region	1349	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	1350	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	1351	to select a word; Left triple-click to select the entire logical line
1059	(which can span multiple screen lines), unless modified by resource	1352	(which can span multiple screen lines), unless modified by resource
1060	B<tripleclickwords>.	1353	B<tripleclickwords>.
1061		1354
1062	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1355	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	1356	(Compile: I<frills>) will create a rectangular selection instead of a
1064	one.	1357	normal one. In this mode, every selected row becomes its own line in the
		1358	selection, and trailing whitespace is visually underlined and removed from
		1359	the selection.
1065		1360
1066	=item B<Insertion>:	1361	=item B<Pasting>:
1067		1362
1068	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1363	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	1364	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1070	inserted as if it had been typed on the keyboard.	1365	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1366
		1367	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1368	inserted too.
1071		1369
1072	=back	1370	=back
1073		1371
1074	=head1 CHANGING FONTS	1372	=head1 CHANGING FONTS
1075		1373
1076	Changing fonts (or font sizes, respectively) via the keypad is not yet	1374	Changing fonts (or font sizes, respectively) via the keypad is not yet
1077	supported in rxvt-unicode. Bug me if you need this.	1375	supported in rxvt-unicode. Bug me if you need this.
1078		1376
1079	You can, however, switch fonts at runtime using escape sequences (and	1377	You can, however, switch fonts at runtime using escape sequences, e.g.:
1080	therefore using the menubar), e.g.:
1081		1378
1082	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1379	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1380
		1381	You can use keyboard shortcuts, too:
		1382
		1383	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1384	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1083		1385
1084	rxvt-unicode will automatically re-apply these fonts to the output so far.	1386	rxvt-unicode will automatically re-apply these fonts to the output so far.
1085		1387
1086	=head1 ISO 14755 SUPPORT	1388	=head1 ISO 14755 SUPPORT
1087		1389
1088	ISO 14755 is a standard for entering and viewing unicode characters	1390	ISO 14755 is a standard for entering and viewing unicode characters
1089	and character codes using the keyboard. It consists of 4 parts. The	1391	and character codes using the keyboard. It consists of 4 parts. The
1090	first part is available rxvt-unicode has been compiled with	1392	first part is available if rxvt-unicode has been compiled with
1091	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1393	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1092	with C<--enable-iso14755>.	1394	with C<--enable-iso14755>.
1093		1395
1094	=over 4	1396	=over 4
1095		1397
…		…
1115	This mode lets you input characters representing the keycap symbols of	1417	This mode lets you input characters representing the keycap symbols of
1116	your keyboard, if representable in the current locale encoding.	1418	your keyboard, if representable in the current locale encoding.
1117		1419
1118	Start by pressing C<Control> and C<Shift> together, then releasing	1420	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	1421	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	1422	invoke its usual function but instead will insert the corresponding
1121	keycap symbol. The symbol will only be entered when the key has been	1423	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	1424	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	1425	C<ISO Level 2 Switch>, although your intention might have been to enter a
1124	reverse tab (Shift-Tab).	1426	reverse tab (Shift-Tab).
1125		1427
…		…
1153	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1455	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	1456	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	1457	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.	1458	on some systems or setgid to root or to some other group on others.
1157		1459
1158	=head1 COLORS AND GRAPHICS	1460	=head1 COLOURS AND GRAPHICS
1159		1461
1160	In addition to the default foreground and background colours,	1462	In addition to the default foreground and background colours,
1161	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1463	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	1464	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1163	colours with their B<rgb.txt> names.	1465	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1466	cube plus a 8 (24) colour greyscale ramp.
		1467
		1468	Here is a list of the ANSI colours with their names.
1164		1469
1165	=begin table	1470	=begin table
1166		1471
1167	B<color0> (black) = Black	1472	B<color0> (black) = Black
1168	B<color1> (red) = Red3	1473	B<color1> (red) = Red3
…		…
1188	It is also possible to specify the colour values of B<foreground>,	1493	It is also possible to specify the colour values of B<foreground>,
1189	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1494	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	1495	a number 0-15, as a convenient shorthand to reference the colour name of
1191	color0-color15.	1496	color0-color15.
1192		1497
		1498	The following text gives values for the standard 88 colour mode (and
		1499	values for the 256 colour mode in parentheses).
		1500
		1501	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1502
		1503	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1504	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1505
		1506	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1507	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1508	the RGB cube.
		1509
		1510	Together, all those colours implement the 88 (256) colour xterm
		1511	colours. Only the first 16 can be changed using resources currently, the
		1512	rest can only be changed via command sequences ("escape codes").
		1513
		1514	Applications are advised to use terminfo or command sequences to discover
		1515	number and RGB values of all colours (yes, you can query this...).
		1516
1193	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1517	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1194	always swapping the foreground/background colours. This is in contrast to	1518	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	1519	I<xterm>(1) where the colours are only swapped if they have not otherwise
1196	been specified. For example,	1520	been specified. For example,
1197		1521
		1522	@@RXVT_NAME@@ -fg Black -bg White -rv
		1523
		1524	would yield White on Black, while on I<xterm>(1) it would yield Black on
		1525	White.
		1526
		1527	=head2 ALPHA CHANNEL SUPPORT
		1528
		1529	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1530	their act together, rxvt-unicode will do it's own alpha channel management:
		1531
		1532	You can prefix any colour with an opaqueness percentage enclosed in
		1533	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1534	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1535	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1536	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1537	is the recommended format to specify transparency values, and works with
		1538	all ways to specify a colour.
		1539
		1540	For complete control, rxvt-unicode also supports
		1541	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1542	specifications, where the additional C<aaaa> component specifies opacity
		1543	(alpha) values. The minimum value of C<0000> is completely transparent,
		1544	while C<ffff> is completely opaque). The two example colours from
		1545	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1546	C<rgba:0000/ff00/0000/f332>.
		1547
		1548	You probably need to specify B<"-depth 32">, too, to force a visual with
		1549	alpha channels, and have the luck that your X-server uses ARGB pixel
		1550	layout, as X is far from just supporting ARGB visuals out of the box, and
		1551	rxvt-unicode just fudges around.
		1552
		1553	For example, the following selects an almost completely transparent black
		1554	background, and an almost opaque pink foreground:
		1555
		1556	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
		1557
		1558	When not using a background image, then the interpretation of the
		1559	alpha channel is up to your compositing manager (most interpret it as
		1560	transparency of course).
		1561
		1562	When using a background pixmap or pseudo-transparency, then the background
		1563	colour will always behave as if it were completely transparent (so the
		1564	background image shows instead), regardless of how it was specified, while
		1565	other colours will either be transparent as specified (the background
		1566	image will show through) on servers supporting the RENDER extension, or
		1567	fully opaque on servers not supporting the RENDER EXTENSION.
		1568
		1569	Please note that due to bugs in Xft, specifying alpha values might result
		1570	in garbage being displayed when the X-server does not support the RENDER
		1571	extension.
		1572
		1573	=head1 ENVIRONMENT
		1574
		1575	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
		1576
1198	=over 4	1577	=over 4
1199		1578
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>	1579	=item B<TERM>
1214		1580
1215	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1581	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1216	resources or on the commandline.	1582	resources or on the command line.
1217		1583
1218	=item B<COLORTERM>	1584	=item B<COLORTERM>
1219		1585
1220	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1586	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1221	compiled with XPM support, and optionally with the added extension	1587	compiled with background image support, and optionally with the added
1222	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1588	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1589	screen.
1223		1590
1224	=item B<COLORFGBG>	1591	=item B<COLORFGBG>
1225		1592
1226	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1593	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	1594	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	1595	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	1596	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@@	1597	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	1598	was compiled with background image support. Libraries like C<ncurses>
1232	(and do) use this information to optimize screen output.	1599	and C<slang> can (and do) use this information to optimize screen output.
1233		1600
1234	=item B<WINDOWID>	1601	=item B<WINDOWID>
1235		1602
1236	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1603	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	1604	window, which usually has subwindows for the scrollbar, the terminal
…		…
1243	C<--with-terminfo=PATH>.	1610	C<--with-terminfo=PATH>.
1244		1611
1245	=item B<DISPLAY>	1612	=item B<DISPLAY>
1246		1613
1247	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1614	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1248	display in it's child processes.	1615	display in its child processes if C<-display> isn't used to override. It
		1616	defaults to C<:0> if it doesn't exist.
1249		1617
1250	=item B<SHELL>	1618	=item B<SHELL>
1251		1619
1252	The shell to be used for command execution, defaults to C</bin/sh>.	1620	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		1621
1263	=item B<RXVT_SOCKET>	1622	=item B<RXVT_SOCKET>
1264		1623
1265	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1624	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1266	@@RXVT_NAME@@d(1).	1625	@@RXVT_NAME@@d(1).
…		…
1288		1647
1289	=over 4	1648	=over 4
1290		1649
1291	=item B</usr/lib/X11/rgb.txt>	1650	=item B</usr/lib/X11/rgb.txt>
1292		1651
1293	Color names.	1652	Colour names.
1294		1653
1295	=back	1654	=back
1296		1655
1297	=head1 SEE ALSO	1656	=head1 SEE ALSO
1298		1657
…		…
1304		1663
1305	=item Project Coordinator	1664	=item Project Coordinator
1306		1665
1307	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1666	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1308		1667
1309	L<http://software.schmorp.de/#rxvt-unicode>	1668	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1310		1669
1311	=back	1670	=back
1312		1671
1313	=head1 AUTHORS	1672	=head1 AUTHORS
1314		1673
…		…
1336		1695
1337	Project Coordinator (changes.txt 2.21a to 2.4.5)	1696	Project Coordinator (changes.txt 2.21a to 2.4.5)
1338		1697
1339	=item Geoff Wing L<< <gcw@pobox.com> >>	1698	=item Geoff Wing L<< <gcw@pobox.com> >>
1340		1699
1341	Rewrote screen display and text selection routines. Project Coordinator	1700	Rewrote screen display and text selection routines.
		1701
1342	(changes.txt 2.4.6 - rxvt-unicode)	1702	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1343		1703
1344	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1704	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1345		1705
1346	Forked rxvt-unicode, rewrote most of the display code and internal	1706	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1347	character handling to store text in unicode, improve xterm	1707	extension, random hacks, numerous bugfixes and extensions.
1348	compatibility and apply numerous other bugfixes and extensions.
1349		1708
1350	Project Coordinator (Changes 1.0 -)	1709	Project Coordinator (Changes 1.0 -)
1351		1710
		1711	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1712
		1713	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
		1714
1352	=back	1715	=back
1353		1716

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.186 by sf-exg, Wed Oct 13 23:36:00 2010 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.186 by sf-exg, Wed Oct 13 23:36:00 2010 UTC