ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/rxvt-unicode/doc/rxvt.1.pod

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

Diff Legend

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