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

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.59 by root, Thu Feb 17 15:07:48 2005 UTC vs. Revision 1.192 by sf-exg, Sat Dec 18 12:20:18 2010 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.59 by root, Thu Feb 17 15:07:48 2005 UTC vs.
Revision 1.192 by sf-exg, Sat Dec 18 12:20:18 2010 UTC