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

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.56 by root, Mon Feb 14 18:47:54 2005 UTC vs. Revision 1.187 by sf-exg, Fri Oct 15 10:46:57 2010 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.56 by root, Mon Feb 14 18:47:54 2005 UTC vs.
Revision 1.187 by sf-exg, Fri Oct 15 10:46:57 2010 UTC