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

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.65 by root, Thu Jun 30 14:00:49 2005 UTC vs. Revision 1.180 by root, Tue Jun 15 11:45:48 2010 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.65 by root, Thu Jun 30 14:00:49 2005 UTC vs.
Revision 1.180 by root, Tue Jun 15 11:45:48 2010 UTC