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.35 by root, Wed Dec 15 00:53:23 2004 UTC vs.
Revision 1.211 by sf-exg, Sat Dec 31 17:17:12 2011 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 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.
112		133
113	=item B<-fade> I<number>	134	=item B<-fade> I<number>
114		135
115	Fade the text by the given percentage when focus is lost.	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>.
116		144
117	=item B<-tint> I<colour>	145	=item B<-tint> I<colour>
118		146
119	Tint the transparent background pixmap with the given colour when	147	Tint the transparent background with the given colour;
120	transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>	148	resource I<tintColor>.
121	option that can be used to brighten or darken the image in addition to
122	tinting it.
123		149
124	=item B<-sh>	150	=item B<-sh> I<number>
125		151
126	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	152	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
127	background image in addition to tinting it (i.e. B<-tint> must be	153	A value of 100 means no shading; resource I<shading>.
128	specified, too).	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, the vertical and
		169	horizontal radii are considered to be the same. Setting one of the
		170	radii to 1 and the other to a large number creates interesting effects
		171	on some backgrounds. The 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>.
129		179
130	=item B<-bg> I<colour>	180	=item B<-bg> I<colour>
131		181
132	Window background colour; resource B<background>.	182	Window background colour; resource B<background>.
133		183
134	=item B<-fg> I<colour>	184	=item B<-fg> I<colour>
135		185
136	Window foreground colour; resource B<foreground>.	186	Window foreground colour; resource B<foreground>.
137		187
138	=item B<-pixmap> I<file[;geom]>	188	=item B<-pixmap> I<file[;oplist]>
139		189
140	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
141	specify its scaling with a geometry string. Note you may need to add	191	optionally specify a list of operations to modify it. Note you may need to
142	quotes to avoid special shell interpretation of the `;' in the	192	add quotes to avoid special shell interpretation of the C<;> in the
143	command-line; resource B<backgroundPixmap>.	193	command-line; for more details see resource B<backgroundPixmap>.
144		194
145	=item B<-cr> I<colour>	195	=item B<-cr> I<colour>
146		196
147	The cursor colour; resource B<cursorColor>.	197	The cursor colour; resource B<cursorColor>.
148		198
…		…
160	resource B<borderColor>.	210	resource B<borderColor>.
161		211
162	=item B<-fn> I<fontlist>	212	=item B<-fn> I<fontlist>
163		213
164	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
165	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
166	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
167	smaller, but not (in general) larger. A (hopefully) reasonable default	217	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.	218	font list is always appended to it. See resource B<font> for more details.
169		219
170	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
171	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:>,
172	e.g.:	222	e.g.:
173		223
174	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	224	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
175	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	225	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
177	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
178	section of @@RXVT_NAME@@(7).	228	section of @@RXVT_NAME@@(7).
179		229
180	=item B<-fb> I<fontlist>	230	=item B<-fb> I<fontlist>
181		231
182	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
183	be printed. See resource B<boldFont> for details.	233	are to be printed. See resource B<boldFont> for details.
184		234
185	=item B<-fi> I<fontlist>	235	=item B<-fi> I<fontlist>
186		236
187	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>
188	be printed. See resource B<italicFont> for details.	238	characters are to be printed. See resource B<italicFont> for details.
189		239
190	=item B<-fbi> I<fontlist>	240	=item B<-fbi> I<fontlist>
191		241
192	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
193	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.
194		251
195	=item B<-name> I<name>	252	=item B<-name> I<name>
196		253
197	Specify the application name under which resources are to be obtained,	254	Specify the application name under which resources are to be obtained,
198	rather than the default executable file name. Name should not contain	255	rather than the default executable file name. Name should not contain
…		…
214		271
215	=item B<-sb>|B<+sb>	272	=item B<-sb>|B<+sb>
216		273
217	Turn on/off scrollbar; resource B<scrollBar>.	274	Turn on/off scrollbar; resource B<scrollBar>.
218		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
219	=item B<-si>|B<+si>	285	=item B<-si>|B<+si>
220		286
221	Turn on/off scroll-to-bottom on TTY output inhibit; resource	287	Turn on/off scroll-to-bottom on TTY output inhibit; resource
222	B<scrollTtyOutput> has opposite effect.	288	B<scrollTtyOutput> has opposite effect.
223		289
…		…
229	=item B<-sw>|B<+sw>	295	=item B<-sw>|B<+sw>
230		296
231	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.
232	This only takes effect if B<-si> is also given; resource	298	This only takes effect if B<-si> is also given; resource
233	B<scrollWithBuffer>.	299	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		300
244	=item B<-ptab>|B<+ptab>	301	=item B<-ptab>|B<+ptab>
245		302
246	If enabled (default), "Horizontal Tab" characters are being stored as	303	If enabled (default), "Horizontal Tab" characters are being stored as
247	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
…		…
251		308
252	=item B<-bc>|B<+bc>	309	=item B<-bc>|B<+bc>
253		310
254	Blink the cursor; resource B<cursorBlink>.	311	Blink the cursor; resource B<cursorBlink>.
255		312
		313	=item B<-uc>|B<+uc>
		314
		315	Make the cursor underlined; resource B<cursorUnderline>.
		316
256	=item B<-iconic>	317	=item B<-iconic>
257		318
258	Start iconified, if the window manager supports that option.	319	Start iconified, if the window manager supports that option.
259	Alternative form is B<-ic>.	320	Alternative form is B<-ic>.
260		321
…		…
276		337
277	=item B<-bl>	338	=item B<-bl>
278		339
279	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.
280	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
281	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>.
282		356
283	=item B<-lsp> I<number>	357	=item B<-lsp> I<number>
284		358
285	Compile I<linespace>: Lines (pixel height) to insert between each row	359	Compile I<frills>: Lines (pixel height) to insert between each row of
286	of the display; resource B<linespace>.	360	the display. Useful to work around font rendering problems; resource
		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>.
287		369
288	=item B<-tn> I<termname>	370	=item B<-tn> I<termname>
289		371
290	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
291	B<TERM> environment variable. This terminal type must exist in the	373	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	382	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	383	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,	384	run the program specified by the B<SHELL> environment variable or,
303	failing that, I<sh(1)>.	385	failing that, I<sh(1)>.
304		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
305	=item B<-title> I<text>	392	=item B<-title> I<text>
306		393
307	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
308	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
309	application name; resource B<title>.	396	application name; resource B<title>.
…		…
327		414
328	Compile I<XIM>: input method name. resource B<inputMethod>.	415	Compile I<XIM>: input method name. resource B<inputMethod>.
329		416
330	=item B<-imlocale> I<string>	417	=item B<-imlocale> I<string>
331		418
332	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	419	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	420	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	421	input extension to be able to input japanese characters while staying in
335	another locale.	422	another locale. resource B<imLocale>.
		423
		424	=item B<-imfont> I<fontset>
		425
		426	Set the font set to use for the X Input Method, see resource B<imFont>
		427	for more info.
		428
		429	=item B<-tcw>
		430
		431	Change the meaning of triple-click selection with the left mouse
		432	button. Only effective when the original (non-perl) selection code is
		433	in-use. Instead of selecting a full line it will extend the selection to
		434	the end of the logical line only. resource B<tripleclickwords>.
336		435
337	=item B<-insecure>	436	=item B<-insecure>
338		437
339	Enable "insecure" mode, which currently enables most of the escape	438	Enable "insecure" mode, which currently enables most of the escape
340	sequences that echo strings. See the resource B<insecure> for more	439	sequences that echo strings. See the resource B<insecure> for more
…		…
354	=item B<-ssr>|B<+ssr>	453	=item B<-ssr>|B<+ssr>
355		454
356	Turn on/off secondary screen scroll (default enabled); resource	455	Turn on/off secondary screen scroll (default enabled); resource
357	B<secondaryScroll>.	456	B<secondaryScroll>.
358		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
359	=item B<-xrm> I<resourcestring>	471	=item B<-xrm> I<string>
360		472
361	No effect on rxvt-unicode. Simply passes through an argument to be made	473	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	474	as if it were specified in a resource file. Resource values specified this
363	some window managers.	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
		484	=item B<-keysym.>I<sym> I<string>
		485
		486	Remap a key symbol. See resource B<keysym>.
		487
		488	=item B<-embed> I<windowid>
		489
		490	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
		491	which enables applications to easily embed a terminal.
		492
		493	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
		494	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
		495	quite a bit, so don't expect it to keep some specific state. It's best to
		496	create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
		497
		498	The window will not be destroyed when @@RXVT_NAME@@ exits.
		499
		500	It might be useful to know that @@RXVT_NAME@@ will not close file
		501	descriptors passed to it (except for stdin/out/err, of course), so you
		502	can use file descriptors to communicate with the programs within the
		503	terminal. This works regardless of whether the C<-embed> option was used or
		504	not.
		505
		506	Here is a short Gtk2-perl snippet that illustrates how this option can be
		507	used (a longer example is in F<doc/embed>):
		508
		509	my $rxvt = new Gtk2::Socket;
		510	$rxvt->signal_connect_after (realize => sub {
		511	my $xid = $_[0]->window->get_xid;
		512	system "@@RXVT_NAME@@ -embed $xid &";
		513	});
		514
		515	=item B<-pty-fd> I<file descriptor>
		516
		517	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
		518	pair but instead use the given file descriptor as the tty master. This is
		519	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
		520	without having to run a program within it.
		521
		522	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
		523	entries and will not tinker with pty/tty permissions - you have to do that
		524	yourself if you want that.
		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
		530	Here is a example in perl that illustrates how this option can be used (a
		531	longer example is in F<doc/pty-fd>):
		532
		533	use IO::Pty;
		534	use Fcntl;
		535
		536	my $pty = new IO::Pty;
		537	fcntl $pty, F_SETFD, 0; # clear close-on-exec
		538	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		539	close $pty;
		540
		541	# now communicate with rxvt
		542	my $slave = $pty->slave;
		543	while (<$slave>) { print $slave "got <$_>\n" }
		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.
364		549
365	=back	550	=back
366		551
367	=head1 RESOURCES (available also as long-options)	552	=head1 RESOURCES
368		553
369	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	554	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
370	options) compiled into your version.	555	options) compiled into your version. All resources are also available as
		556	long-options.
371		557
372	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
373	Xresource data: using the X libraries (Xrm*-functions) or internal	559	distribution do also load settings from the B<~/.Xresources> file when X
374	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	560	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	561	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		562
379	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>	563	1. app-defaults file in $XAPPLRESDIR
380	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults	564	2. $HOME/.Xdefaults
381	set in XAPPLOADDIR/URxvt (compile-time defined: usually	565	3. RESOURCE_MANAGER property on root-window of screen 0
382	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	566	4. SCREEN_RESOURCES property on root-window of the current screen
383	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.	567	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		568	6. resources specified via -xrm on the commandline
		569
384	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	570	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	571	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	572	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	573	configured, while the class name B<URxvt> allows resources unique to
388	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	574	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
389	shared between different B<@@RXVT_NAME@@> configurations. If no	575	configurations. If no resources are specified, suitable defaults will
390	resources are specified, suitable defaults will be used. Command-line	576	be used. Command-line arguments can be used to override resource
391	arguments can be used to override resource settings. The following	577	settings. The following resources are supported (you might want to
392	resources are allowed:	578	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		579	extensions not documented here):
393		580
394	=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.
395		594
396	=item B<geometry:> I<geom>	595	=item B<geometry:> I<geom>
397		596
398	Create the window with the specified X window geometry [default 80x24];	597	Create the window with the specified X window geometry [default 80x24];
399	option B<-geometry>.	598	option B<-geometry>.
…		…
413	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
414	corresponds to low-intensity (normal) colours and 8-15 corresponds to	613	corresponds to low-intensity (normal) colours and 8-15 corresponds to
415	high-intensity (bold = bright foreground, blink = bright background)	614	high-intensity (bold = bright foreground, blink = bright background)
416	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,
417	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
418	names used are listed in the B<COLORS AND GRAPHICS> section.	617	names used are listed in the B<COLOURS AND GRAPHICS> section.
419		618
420	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
421	changed using an escape command (see @@RXVT_NAME@@(7)).	620	changed using an escape command (see @@RXVT_NAME@@(7)).
422		621
423	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
…		…
427		626
428	=item B<colorIT:> I<colour>	627	=item B<colorIT:> I<colour>
429		628
430	Use the specified colour to display bold or italic characters when the	629	Use the specified colour to display bold or italic characters when the
431	foreground colour is the default. If font styles are not available	630	foreground colour is the default. If font styles are not available
432	(Compile styles) and this option is unset, reverse video is used instead.	631	(Compile I<styles>) and this option is unset, reverse video is used instead.
433		632
434	=item B<colorUL:> I<colour>	633	=item B<colorUL:> I<colour>
435		634
436	Use the specified colour to display underlined characters when the	635	Use the specified colour to display underlined characters when the
437	foreground colour is the default.	636	foreground colour is the default.
438		637
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>	638	=item B<underlineColor:> I<colour>
445		639
446	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
447	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.
448		652
449	=item B<cursorColor:> I<colour>	653	=item B<cursorColor:> I<colour>
450		654
451	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
452	foreground colour; option B<-cr>.	656	foreground colour; option B<-cr>.
…		…
459		663
460	=item B<reverseVideo:> I<boolean>	664	=item B<reverseVideo:> I<boolean>
461		665
462	B<True>: simulate reverse video by foreground and background colours;	666	B<True>: simulate reverse video by foreground and background colours;
463	option B<-rv>. B<False>: regular screen colours [default]; option	667	option B<-rv>. B<False>: regular screen colours [default]; option
464	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	668	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
465		669
466	=item B<jumpScroll:> I<boolean>	670	=item B<jumpScroll:> I<boolean>
467		671
468	B<True>: specify that jump scrolling should be used. When scrolling	672	B<True>: specify that jump scrolling should be used. When receiving lots
469	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
470	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>.
471		679
472	=item B<inheritPixmap:> I<boolean>	680	=item B<skipScroll:> I<boolean>
473		681
474	B<True>: make the background inherit the parent windows' pixmap, giving	682	B<True>: (the default) specify that skip scrolling should be used. When
475	artificial transparency. B<False>: do not inherit the parent windows'	683	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
476	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.
477		698
478	=item B<fading:> I<number>	699	=item B<fading:> I<number>
479		700
480	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>.
481		707
482	=item B<tintColor:> I<colour>	708	=item B<tintColor:> I<colour>
483		709
484	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>.
485		715
486	=item B<shading:> I<number>	716	=item B<shading:> I<number>
487		717
488	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	718	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
489	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>.
490		733
491	=item B<scrollColor:> I<colour>	734	=item B<scrollColor:> I<colour>
492		735
493	Use the specified colour for the scrollbar [default #B2B2B2].	736	Use the specified colour for the scrollbar [default #B2B2B2].
494		737
495	=item B<troughColor:> I<colour>	738	=item B<troughColor:> I<colour>
496		739
497	Use the specified colour for the scrollbar's trough area [default	740	Use the specified colour for the scrollbar's trough area [default
498	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	741	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
499		742
500	=item B<borderColor:> I<colour>	743	=item B<borderColor:> I<colour>
501		744
502	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
503	and the text.	746	and the text.
504		747
505	=item B<backgroundPixmap:> I<file[;geom]>	748	=item B<backgroundPixmap:> I<file[;oplist]>
506		749
507	Use the specified XPM file (note the `.xpm' extension is optional) for	750	Use the specified image file for the background and also
508	the background and also optionally specify its scaling with a geometry	751	optionally specify a colon separated list of operations to modify it.
509	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	752	Supported operations are:
510	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
512	of 1 displays the image without any scaling. A scale of 2 to 9
513	specifies an integer number of images in that direction. No image will
514	be magnified beyond 10 times its original size. The maximum permitted
515	scale is 1000. [default 0x0+50+50]
516		753
517	=item B<menu:> I<file[;tag]>	754	=over 4
518		755
519	Read in the specified menu file (note the `.menu' extension is	756	=item B<WxH+X+Y>
520	optional) and also optionally specify a starting tag to find. See the	757
521	reference documentation for details on the syntax for the menuBar.	758	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
		759	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
		760	scale of 0 disables scaling. The maximum permitted scale is 1000.
		761
		762	=item B<op=tile>
		763
		764	enables tiling
		765
		766	=item B<op=keep-aspect>
		767
		768	maintain the image aspect ratio when scaling
		769
		770	=item B<op=root-align>
		771
		772	use the position of the terminal window relative to the root window as
		773	the image offset, simulating a root window background
		774
		775	=back
		776
		777	The default scale and position setting is C<100x100+50+50>.
		778	Alternatively, a predefined set of templates can be used to achieve
		779	the most common setups:
		780
		781	=over 4
		782
		783	=item B<style=tiled>
		784
		785	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		786
		787	=item B<style=aspect-stretched>
		788
		789	the image is scaled to fill the whole window maintaining the aspect
		790	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		791
		792	=item B<style=stretched>
		793
		794	the image is scaled to fill the whole window. Equivalent to 100x100
		795
		796	=item B<style=centered>
		797
		798	the image is centered with no scaling. Equivalent to 0x0+50+50
		799
		800	=item B<style=root-tiled>
		801
		802	the image is tiled with no scaling and using 'root' positioning.
		803	Equivalent to 0x0:op=tile:op=root-align
		804
		805	=back
		806
		807	If multiple templates are specified the last one wins. Note that a
		808	template overrides all the scale, position and operations settings.
		809
		810	If used in conjunction with B<-tr> option, the specified pixmap will be
		811	blended over the transparent background using alpha-blending. If I<afterimage>
		812	support has been compiled in it is possible to choose other blending
		813	types with B<-blt "type"> option.
522		814
523	=item B<path:> I<path>	815	=item B<path:> I<path>
524		816
525	Specify the colon-delimited search path for finding files (XPM and	817	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		818
529	=item B<font:> I<fontlist>	819	=item B<font:> I<fontlist>
530		820
531	Select the fonts to be used. This is a comma separated list of font	821	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.	822	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	823	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	824	smaller, but not (in general) larger. A (hopefully) reasonable default
535	appended to it. option B<-fn>.	825	font list is always appended to it; option B<-fn>.
536		826
537	Each font can either be a standard X11 core font (XLFD) name, with	827	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:>.	828	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
539		829
540	In addition, each font can be prefixed with additional hints and	830	In addition, each font can be prefixed with additional hints and
541	specifications enclosed in square brackets (C<[]>). The only available	831	specifications enclosed in square brackets (C<[]>). The only available
542	hint currently is C<codeset=codeset-name>, and this is only used for Xft	832	hint currently is C<codeset=codeset-name>, and this is only used for Xft
543	fonts.	833	fonts.
544		834
545	For example, this font resource	835	For example, this font resource
546		836
547	URxvt*font: 9x15bold,\	837	URxvt.font: 9x15bold,\
548	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	838	-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, \	839	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
550	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	840	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
551	xft:Code2000:antialias=false	841	xft:Code2000:antialias=false
552		842
…		…
555	it is named first) and thus defines the character cell grid to be 9 pixels	845	it is named first) and thus defines the character cell grid to be 9 pixels
556	wide and 15 pixels high.	846	wide and 15 pixels high.
557		847
558	The second font is just used to add additional unicode characters not in	848	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	849	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	850	the bold version of the font does contain fewer characters, so this is a
561	useful supplement.	851	useful supplement.
562		852
563	The third font is an Xft font with aliasing turned off, and the characters	853	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	854	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.	855	contains other characters, but we are not interested in them.
…		…
586	not possible, replacement fonts of the desired shape will be tried.	876	not possible, replacement fonts of the desired shape will be tried.
587		877
588	If set, but empty, then this specific style is disabled and the normal	878	If set, but empty, then this specific style is disabled and the normal
589	text font will being used for the given style.	879	text font will being used for the given style.
590		880
591	=item B<selectstyle:> I<mode>	881	=item B<intensityStyles:> I<boolean>
592		882
593	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	883	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	884	option B<-is>, the default), bold/blink font styles imply high
595	xterm style selection.	885	intensity foreground/background colours. Disabling this option (B<False>,
596		886	option B<+is>) disables this behaviour, the high intensity colours are not
597	=item B<scrollstyle:> I<mode>	887	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		888
602	=item B<title:> I<string>	889	=item B<title:> I<string>
603		890
604	Set window title string, the default title is the command-line	891	Set window title string, the default title is the command-line
605	specified after the B<-e> option, if any, otherwise the application	892	specified after the B<-e> option, if any, otherwise the application
…		…
614	=item B<mapAlert:> I<boolean>	901	=item B<mapAlert:> I<boolean>
615		902
616	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	903	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].	904	de-iconify (map) on receipt of a bell character [default].
618		905
		906	=item B<urgentOnBell:> I<boolean>
		907
		908	B<True>: set the urgency hint for the wm on receipt of a bell character.
		909	B<False>: do not set the urgency hint [default].
		910
		911	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		912
619	=item B<visualBell:> I<boolean>	913	=item B<visualBell:> I<boolean>
620		914
621	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	915	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
622	B<False>: no visual bell [default]; option B<+vb>.	916	B<False>: no visual bell [default]; option B<+vb>.
623		917
…		…
637		931
638	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	932	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	933	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.	934	B<Shift-Print> to include the scrollback as well.
641		935
		936	The string will be interpreted as if typed into the shell as-is.
		937
		938	Example:
		939
		940	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		941
		942	This creates a new file in your home directory with the screen contents
		943	every time you hit C<Print>.
		944
		945	=item B<scrollstyle:> I<mode>
		946
		947	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		948	the author's favourite.
		949
		950	=item B<thickness:> I<number>
		951
		952	Set the scrollbar width in pixels.
		953
642	=item B<scrollBar:> I<boolean>	954	=item B<scrollBar:> I<boolean>
643		955
644	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	956	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
645	disable the scrollbar; option B<+sb>.	957	disable the scrollbar; option B<+sb>.
646		958
…		…
665	B<False>: do not scroll to bottom when tty receives output; option	977	B<False>: do not scroll to bottom when tty receives output; option
666	B<+si>.	978	B<+si>.
667		979
668	=item B<scrollWithBuffer:> I<boolean>	980	=item B<scrollWithBuffer:> I<boolean>
669		981
670	B<True>: scroll with scrollback buffer when tty receives new lines (and	982	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
671	B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll	983	try to show the same lines) and B<scrollTtyOutput> is False; option
672	with scrollback buffer when tty recieves new lines; option B<-sw>.	984	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		985	new lines; option B<+sw>.
673		986
674	=item B<scrollTtyKeypress:> I<boolean>	987	=item B<scrollTtyKeypress:> I<boolean>
675		988
676	B<True>: scroll to bottom when a non-special key is pressed. Special keys	989	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	990	are those which are intercepted by rxvt-unicode for special handling and
…		…
696	=item B<borderLess:> I<boolean>	1009	=item B<borderLess:> I<boolean>
697		1010
698	Set MWM hints to request a borderless window, i.e. if honoured by the	1011	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>.	1012	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
700		1013
		1014	=item B<skipBuiltinGlyphs:> I<boolean>
		1015
		1016	Compile I<frills>: Disable the usage of the built-in block graphics/line
		1017	drawing characters and just rely on what the specified fonts provide. Use
		1018	this if you have a good font and want to use its block graphic glyphs;
		1019	option B<-sbg>.
		1020
701	=item B<termName:> I<termname>	1021	=item B<termName:> I<termname>
702		1022
703	Specifies the terminal type name to be set in the B<TERM> environment	1023	Specifies the terminal type name to be set in the B<TERM> environment
704	variable; option B<-tn>.	1024	variable; option B<-tn>.
705		1025
706	=item B<linespace:> I<number>	1026	=item B<lineSpace:> I<number>
707		1027
708	Specifies number of lines (pixel height) to insert between each row of	1028	Specifies number of lines (pixel height) to insert between each row of
709	the display [default 0]; option B<-lsp>.	1029	the display [default 0]; option B<-lsp>.
710		1030
711	=item B<meta8:> I<boolean>	1031	=item B<meta8:> I<boolean>
…		…
725		1045
726	=item B<cursorBlink:> I<boolean>	1046	=item B<cursorBlink:> I<boolean>
727		1047
728	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1048	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
729	option B<-bc>.	1049	option B<-bc>.
		1050
		1051	=item B<cursorUnderline:> I<boolean>
		1052
		1053	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1054	option B<-uc>.
730		1055
731	=item B<pointerBlank:> I<boolean>	1056	=item B<pointerBlank:> I<boolean>
732		1057
733	B<True>: blank the pointer when a key is pressed or after a set number	1058	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	1059	of seconds of inactivity. B<False>: the pointer is always visible
…		…
742		1067
743	Mouse pointer background colour.	1068	Mouse pointer background colour.
744		1069
745	=item B<pointerBlankDelay:> I<number>	1070	=item B<pointerBlankDelay:> I<number>
746		1071
747	Specifies number of seconds before blanking the pointer [default 2].	1072	Specifies number of seconds before blanking the pointer [default 2]. Use a
		1073	large number (e.g. C<987654321>) to effectively disable the timeout.
748		1074
749	=item B<backspacekey:> I<string>	1075	=item B<backspacekey:> I<string>
750		1076
751	The string to send when the backspace key is pressed. If set to B<DEC>	1077	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>	1078	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
753	(code 8) - which can be reversed with the appropriate DEC private mode	1079	(code 8) - which can be reversed with the appropriate DEC private mode
754	escape sequence.	1080	escape sequence.
755		1081
756	=item B<deletekey:> I<string>	1082	=item B<deletekey:> I<string>
757		1083
…		…
759	pressed. If unset it will send the sequence traditionally associated	1085	pressed. If unset it will send the sequence traditionally associated
760	with the B<Execute> key.	1086	with the B<Execute> key.
761		1087
762	=item B<cutchars:> I<string>	1088	=item B<cutchars:> I<string>
763		1089
764	The characters used as delimiters for double-click word selection. The	1090	The characters used as delimiters for double-click word selection
765	built-in default:	1091	(whitespace delimiting is added automatically if resource is given).
766		1092
		1093	When the perl selection extension is in use (the default if compiled
		1094	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		1095	characters will be created (if the resource exists, otherwise, no regex
		1096	will be created). In this mode, characters outside ISO-8859-1 can be used.
		1097
		1098	When the selection extension is not used, only ISO-8859-1 characters can
		1099	be used. If not specified, the built-in default is used:
		1100
767	B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>	1101	B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
768		1102
769	=item B<preeditType:> I<style>	1103	=item B<preeditType:> I<style>
770		1104
771	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1105	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
772		1106
…		…
774		1108
775	I<name> of inputMethod to use; option B<-im>.	1109	I<name> of inputMethod to use; option B<-im>.
776		1110
777	=item B<imLocale:> I<name>	1111	=item B<imLocale:> I<name>
778		1112
779	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	1113	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	1114	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	1115	input extension to be able to input japanese characters while staying in
782	another locale. option B<-imlocale>.	1116	another locale; option B<-imlocale>.
		1117
		1118	=item B<imFont:> I<fontset>
		1119
		1120	Specify the font-set used for XIM styles C<OverTheSpot> or
		1121	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
		1122	by commas), i.e. it's not in the same format as the other font lists used
		1123	in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
		1124	found, preferably one or two pixels differing in size to the base font.
		1125	option B<-imfont>.
		1126
		1127	=item B<tripleclickwords:> I<boolean>
		1128
		1129	Change the meaning of triple-click selection with the left mouse
		1130	button. Instead of selecting a full line it will extend the selection to
		1131	the end of the logical line only; option B<-tcw>.
783		1132
784	=item B<insecure:> I<boolean>	1133	=item B<insecure:> I<boolean>
785		1134
786	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	1135	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
787	echo arbitrary strings like the icon name or the locale. This could be	1136	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	1137	abused if somebody gets 8-bit-clean access to your display, whether
789	throuh a mail client displaying mail bodies unfiltered or though	1138	through a mail client displaying mail bodies unfiltered or through
790	write(1). Therefore, these sequences are disabled by default. (Note	1139	write(1) or any other means. Therefore, these sequences are disabled by
791	that other terminals, including xterm, have these sequences	1140	default. (Note that many other terminals, including xterm, have these
792	enabled by default). You can enable them by setting this boolean	1141	sequences enabled by default, which doesn't make it safer, though).
793	resource or specifying B<-insecure> as an option. At the moment, this	1142
794	enabled display-answer, locale, findfont, icon label and window title	1143	You can enable them by setting this boolean resource or specifying
795	requests as well as dynamic menubar dispatch.	1144	B<-insecure> as an option. At the moment, this enables display-answer,
		1145	locale, findfont, icon label and window title requests.
796		1146
797	=item B<modifier:> I<modifier>	1147	=item B<modifier:> I<modifier>
798		1148
799	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	1149	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	1150	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
804		1154
805	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	1155	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	1156	character is passed through. It may contain escape values as described
807	in the entry on B<keysym> following.	1157	in the entry on B<keysym> following.
808		1158
809	=item B<secondaryScreen:> I<bool>	1159	=item B<secondaryScreen:> I<boolean>
810		1160
811	Turn on/off secondary screen (default enabled).	1161	Turn on/off secondary screen (default enabled).
812		1162
813	=item B<secondaryScroll:> I<bool>	1163	=item B<secondaryScroll:> I<boolean>
814		1164
815	Turn on/off secondary screen scroll (default enabled). If the this	1165	Turn on/off secondary screen scroll (default enabled). If this
816	option is enabled, scrolls on the secondary screen will change the	1166	option is enabled, scrolls on the secondary screen will change the
817	scrollback buffer and switching to/from the secondary screen will	1167	scrollback buffer and, when secondaryScreen is off, switching
818	instead scroll the screen up.	1168	to/from the secondary screen will instead scroll the screen up.
		1169
		1170	=item B<hold>: I<boolean>
		1171
		1172	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		1173	will not immediately destroy its window when the program executed within
		1174	it exits. Instead, it will wait till it is being killed or closed by the
		1175	user.
		1176
		1177	=item B<chdir>: I<path>
		1178
		1179	Sets the working directory for the shell (or the command specified via
		1180	B<-e>). The I<path> must be an absolute path and it must exist for
		1181	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1182	directory will be used; option B<-cd>.
819		1183
820	=item B<keysym.>I<sym>: I<string>	1184	=item B<keysym.>I<sym>: I<string>
821		1185
822	Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may	1186	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	1187	intervening resource name B<keysym.> cannot be omitted.
828	omitted. This resource is only available when compiled with	1188
829	KEYSYM_RESOURCE.	1189	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
		1190	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
		1191	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
		1192	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
		1193	B<2>, B<3>, B<4>, B<5>.
		1194
		1195	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
		1196	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
		1197	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
		1198	current application keymap mode state.
		1199
		1200	The spellings of I<key> can be obtained by using B<xev>(1) command or
		1201	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
		1202	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
		1203	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
		1204	performed in an exact manner; however, the closest match is assured.
		1205
		1206	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
		1207	number), see RESOURCES in C<man 7 X> for further details.
		1208
		1209	You can define a range of keysyms in one shot by
		1210	loading the C<keysym-list> perl extension and providing a I<string>
		1211	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
		1212	should be a character not used by the strings.
		1213
		1214	Its usage can be demonstrated by an example:
		1215
		1216	URxvt.keysym.M-C-0x61: list|\033<|abc|>
		1217
		1218	The above line is equivalent to the following three lines:
		1219
		1220	URxvt.keysym.Meta-Control-0x61: \033<a>
		1221	URxvt.keysym.Meta-Control-0x62: \033<b>
		1222	URxvt.keysym.Meta-Control-0x63: \033<c>
		1223
		1224	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
		1225	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
		1226	example the following means "change the current locale to C<zh_CN.GBK>
		1227	when Control-Meta-c is being pressed":
		1228
		1229	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		1230
		1231	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1232	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1233	manpage. For example, the F<selection> extension (activated via
		1234	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1235
		1236	URxvt.keysym.M-C-c: perl:selection:rot13
		1237
		1238	Due the the large number of modifier combinations, a defined key mapping
		1239	will match if I<at least> the specified identifiers are being set, and
		1240	no other key mappings with those and more bits are being defined. That
		1241	means that defining a key map for C<a> will automatically provide
		1242	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		1243	mappings themselves.
		1244
		1245	Unfortunately, this will override built-in key mappings. For example
		1246	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		1247	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		1248	user-defined keymap using the C<builtin:> replacement:
		1249
		1250	URxvt.keysym.Insert: <my insert key sequence>
		1251	URxvt.keysym.S-Insert: builtin:
		1252
		1253	The first line defines a mapping for C<Insert> and I<any> combination
		1254	of modifiers. The second line re-establishes the default mapping for
		1255	C<Shift-Insert>.
		1256
		1257	The following example will map Control-Meta-1 and Control-Meta-2 to
		1258	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
		1259	font-switching at runtime:
		1260
		1261	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1262	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
		1263
		1264	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
		1265	info):
		1266
		1267	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1268	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1269
		1270	=item B<perl-ext-common>: I<string>
		1271
		1272	=item B<perl-ext>: I<string>
		1273
		1274	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1275	use in this terminal instance; option B<-pe>.
		1276
		1277	Extension names can be prefixed with a C<-> sign to prohibit using
		1278	them. This can be useful to selectively disable some extensions loaded
		1279	by default, or specified via the C<perl-ext-common> resource. For
		1280	example, C<default,-selection> will use all the default extension except
		1281	C<selection>.
		1282
		1283	Extension names can also be followed by an argument in angle brackets
		1284	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1285	searchable scrollback to Alt/Meta-s). Mentioning the same extension
		1286	multiple times with different arguments will pass multiple arguments to
		1287	the extension.
		1288
		1289	Each extension is looked up in the library directories, loaded if
		1290	necessary, and bound to the current terminal instance.
		1291
		1292	If both of these resources are the empty string, then the perl
		1293	interpreter will not be initialized. The idea behind two options is that
		1294	B<perl-ext-common> will be used for extensions that should be available to
		1295	all instances, while B<perl-ext> is used for specific instances.
		1296
		1297	=item B<perl-eval>: I<string>
		1298
		1299	Perl code to be evaluated when all extensions have been registered. See
		1300	the @@RXVT_NAME@@perl(3) manpage.
		1301
		1302	=item B<perl-lib>: I<path>
		1303
		1304	Colon-separated list of additional directories that hold extension
		1305	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
		1306	look in these directories, then in $HOME/.urxvt/ext and lastly in
		1307	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
		1308
		1309	See the @@RXVT_NAME@@perl(3) manpage.
		1310
		1311	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1312
		1313	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1314	details.
		1315
		1316	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1317
		1318	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1319	for details.
		1320
		1321	=item B<searchable-scrollback:> I<keysym>
		1322
		1323	Sets the hotkey that starts the incremental scrollback buffer search
		1324	(default: C<M-s>).
		1325
		1326	=item B<urlLauncher>: I<string>
		1327
		1328	Specifies the program to be started with a URL argument. Used by the
		1329	C<selection-popup> and C<matcher> perl extensions.
		1330
		1331	=item B<transient-for>: I<windowid>
		1332
		1333	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1334
		1335	=item B<override-redirect>: I<boolean>
		1336
		1337	Compile I<frills>: Sets override-redirect for the terminal window, making
		1338	it almost invisible to window managers; option B<-override-redirect>.
		1339
		1340	=item B<iso14755:> I<boolean>
		1341
		1342	Turn on/off ISO 14755 (default enabled).
		1343
		1344	=item B<iso14755_52:> I<boolean>
		1345
		1346	Turn on/off ISO 14755 5.2 mode (default enabled).
830		1347
831	=back	1348	=back
832		1349
833	=head1 THE SCROLLBAR	1350	=head1 THE SCROLLBAR
834		1351
…		…
848	the normal text selection/insertion, hold either the Shift or the Meta	1365	the normal text selection/insertion, hold either the Shift or the Meta
849	(Alt) key while performing the desired mouse action.	1366	(Alt) key while performing the desired mouse action.
850		1367
851	If mouse reporting mode is active, the normal scrollbar actions are	1368	If mouse reporting mode is active, the normal scrollbar actions are
852	disabled -- on the assumption that we are using a fullscreen	1369	disabled -- on the assumption that we are using a fullscreen
853	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	1370	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
854	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	1371	(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),	1372	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
856	respectively.	1373	respectively.
857		1374
858	=head1 TEXT SELECTION AND INSERTION	1375	=head1 THE SELECTION: SELECTING AND PASTING TEXT
859		1376
860	The behaviour of text selection and insertion mechanism is similar to	1377	The behaviour of text selection and insertion/pasting mechanism is similar
861	I<xterm>(1).	1378	to I<xterm>(1).
862		1379
863	=over 4	1380	=over 4
864		1381
865	=item B<Selection>:	1382	=item B<Selecting>:
866		1383
867	Left click at the beginning of the region, drag to the end of the	1384	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	1385	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	1386	to select a word; Left triple-click to select the entire logical line
870	line.	1387	(which can span multiple screen lines), unless modified by resource
		1388	B<tripleclickwords>.
871		1389
872	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1390	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	1391	(Compile: I<frills>) will create a rectangular selection instead of a
874	one.	1392	normal one. In this mode, every selected row becomes its own line in the
		1393	selection, and trailing whitespace is visually underlined and removed from
		1394	the selection.
875		1395
876	=item B<Insertion>:	1396	=item B<Pasting>:
877		1397
878	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1398	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	1399	window causes the value of the PRIMARY selection (or CLIPBOARD with the
880	inserted as if it had been typed on the keyboard.	1400	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1401
		1402	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1403	inserted too.
881		1404
882	=back	1405	=back
883		1406
884	=head1 CHANGING FONTS	1407	=head1 CHANGING FONTS
885		1408
886	Changing fonts (or font sizes, respectively) via the keypad is not yet	1409	Changing fonts (or font sizes, respectively) via the keypad is not yet
887	supported in rxvt-unicode. Bug me if you need this.	1410	supported in rxvt-unicode. Bug me if you need this.
888		1411
889	You can, however, switch fonts at runtime using escape sequences (and	1412	You can, however, switch fonts at runtime using escape sequences, e.g.:
890	therefore using the menubar), e.g.:
891		1413
892	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1414	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1415
		1416	You can use keyboard shortcuts, too:
		1417
		1418	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1419	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
893		1420
894	rxvt-unicode will automatically re-apply these fonts to the output so far.	1421	rxvt-unicode will automatically re-apply these fonts to the output so far.
895		1422
896	=head1 ISO 14755 SUPPORT	1423	=head1 ISO 14755 SUPPORT
897		1424
898	ISO 14755 is a standard for entering and viewing unicode characters	1425	ISO 14755 is a standard for entering and viewing unicode characters
899	and character codes using the keyboard. It consists of 4 parts. The	1426	and character codes using the keyboard. It consists of 4 parts. The
900	first part is available rxvt-unicode has been compiled with	1427	first part is available if rxvt-unicode has been compiled with
901	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1428	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
902	with C<--enable-iso14755>.	1429	with C<--enable-iso14755>.
903		1430
904	=over 4	1431	=over 4
905		1432
906	=item 5.1: Basic method	1433	=item * 5.1: Basic method
907		1434
908	This allows you to enter unicode characters using their hexcode.	1435	This allows you to enter unicode characters using their hexcode.
909		1436
910	Start by pressing and holding both C<Control> and C<Shift>, then enter	1437	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	1438	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	1445	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	1446	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>,	1447	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.	1448	followed by releasing the modifier keys.
922		1449
923	=item 5.2: Keyboard symbols entry method	1450	=item * 5.2: Keyboard symbols entry method
924		1451
925	This mode lets you input characters representing the keycap symbols of	1452	This mode lets you input characters representing the keycap symbols of
926	your keyboard, if representable in the current locale encoding.	1453	your keyboard, if representable in the current locale encoding.
927		1454
928	Start by pressing C<Control> and C<Shift> together, then releasing	1455	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	1456	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	1457	invoke its usual function but instead will insert the corresponding
931	keycap symbol. The symbol will only be entered when the key has been	1458	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	1459	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	1460	C<ISO Level 2 Switch>, although your intention might have been to enter a
934	reverse tab (Shift-Tab).	1461	reverse tab (Shift-Tab).
935		1462
936	=item 5.3: Screen-selection entry method	1463	=item * 5.3: Screen-selection entry method
937		1464
938	While this is implemented already (it's basically the selection	1465	While this is implemented already (it's basically the selection
939	mechanism), it could be extended by displaying a unicode character map.	1466	mechanism), it could be extended by displaying a unicode character map.
940		1467
941	=item 5.4: Feedback method for identifying displayed characters for later input	1468	=item * 5.4: Feedback method for identifying displayed characters for later input
942		1469
943	This method lets you display the unicode character code associated with	1470	This method lets you display the unicode character code associated with
944	characters already displayed.	1471	characters already displayed.
945		1472
946	You enter this mode by holding down C<Control> and C<Shift> together, then	1473	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	1485	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.	1486	both scenario A and B of ISO 14755, including part 5.2.
960		1487
961	=head1 LOGIN STAMP	1488	=head1 LOGIN STAMP
962		1489
963	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so	1490	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.	1491	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	1492	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
966	some systems.	1493	on some systems or setgid to root or to some other group on others.
967		1494
968	=head1 COLORS AND GRAPHICS	1495	=head1 COLOURS AND GRAPHICS
969		1496
970	In addition to the default foreground and background colours,	1497	In addition to the default foreground and background colours,
971	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1498	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
972	high-intensity bold/blink versions of the same). Here is a list of the	1499	high-intensity (potentially bold/blink) versions of the same, and 72 (or
973	colours with their B<rgb.txt> names.	1500	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1501	cube plus a 8 (24) colour greyscale ramp.
		1502
		1503	Here is a list of the ANSI colours with their names.
974		1504
975	=begin table	1505	=begin table
976		1506
977	B<color0> (black) = Black	1507	B<color0> (black) = Black
978	B<color1> (red) = Red3	1508	B<color1> (red) = Red3
…		…
998	It is also possible to specify the colour values of B<foreground>,	1528	It is also possible to specify the colour values of B<foreground>,
999	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1529	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	1530	a number 0-15, as a convenient shorthand to reference the colour name of
1001	color0-color15.	1531	color0-color15.
1002		1532
		1533	The following text gives values for the standard 88 colour mode (and
		1534	values for the 256 colour mode in parentheses).
		1535
		1536	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1537
		1538	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1539	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1540
		1541	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1542	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1543	the RGB cube.
		1544
		1545	Together, all those colours implement the 88 (256) colour xterm
		1546	colours. Only the first 16 can be changed using resources currently, the
		1547	rest can only be changed via command sequences ("escape codes").
		1548
		1549	Applications are advised to use terminfo or command sequences to discover
		1550	number and RGB values of all colours (yes, you can query this...).
		1551
1003	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1552	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1004	always swapping the foreground/background colours. This is in contrast to	1553	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	1554	I<xterm>(1) where the colours are only swapped if they have not otherwise
1006	been specified. For example,	1555	been specified. For example,
1007		1556
		1557	@@RXVT_NAME@@ -fg Black -bg White -rv
		1558
		1559	would yield White on Black, while on I<xterm>(1) it would yield Black on
		1560	White.
		1561
		1562	=head2 ALPHA CHANNEL SUPPORT
		1563
		1564	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1565	their act together, rxvt-unicode will do its own alpha channel management:
		1566
		1567	You can prefix any colour with an opaqueness percentage enclosed in
		1568	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1569	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1570	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1571	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1572	is the recommended format to specify transparency values, and works with
		1573	all ways to specify a colour.
		1574
		1575	For complete control, rxvt-unicode also supports
		1576	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1577	specifications, where the additional C<aaaa> component specifies opacity
		1578	(alpha) values. The minimum value of C<0000> is completely transparent,
		1579	while C<ffff> is completely opaque). The two example colours from
		1580	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1581	C<rgba:0000/ff00/0000/f332>.
		1582
		1583	You probably need to specify B<"-depth 32">, too, to force a visual with
		1584	alpha channels, and have the luck that your X-server uses ARGB pixel
		1585	layout, as X is far from just supporting ARGB visuals out of the box, and
		1586	rxvt-unicode just fudges around.
		1587
		1588	For example, the following selects an almost completely transparent black
		1589	background, and an almost opaque pink foreground:
		1590
		1591	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
		1592
		1593	When not using a background image, then the interpretation of the
		1594	alpha channel is up to your compositing manager (most interpret it as
		1595	transparency of course).
		1596
		1597	When using a background pixmap or pseudo-transparency, then the background
		1598	colour will always behave as if it were completely transparent (so the
		1599	background image shows instead), regardless of how it was specified, while
		1600	other colours will either be transparent as specified (the background
		1601	image will show through) on servers supporting the RENDER extension, or
		1602	fully opaque on servers not supporting the RENDER EXTENSION.
		1603
		1604	Please note that due to bugs in Xft, specifying alpha values might result
		1605	in garbage being displayed when the X-server does not support the RENDER
		1606	extension.
		1607
		1608	=head1 ENVIRONMENT
		1609
		1610	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
		1611
1008	=over 4	1612	=over 4
1009		1613
1010	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1614	=item B<TERM>
1011		1615
1012	would yield White on Black, while on I<xterm>(1) it would yield Black	1616	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1013	on White.	1617	resources or on the command line.
		1618
		1619	=item B<COLORTERM>
		1620
		1621	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
		1622	compiled with background image support, and optionally with the added
		1623	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1624	screen.
		1625
		1626	=item B<COLORFGBG>
		1627
		1628	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
		1629	the colour code used as default foreground/text colour (or the string
		1630	C<default> to indicate that the default-colour escape sequence is to be
		1631	used), C<bg> is the colour code used as default background colour (or the
		1632	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1633	was compiled with background image support. Libraries like C<ncurses>
		1634	and C<slang> can (and do) use this information to optimize screen output.
		1635
		1636	=item B<WINDOWID>
		1637
		1638	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
		1639	window, which usually has subwindows for the scrollbar, the terminal
		1640	window and so on).
		1641
		1642	=item B<TERMINFO>
		1643
		1644	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1645	C<--with-terminfo=PATH>.
		1646
		1647	=item B<DISPLAY>
		1648
		1649	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
		1650	display in its child processes if C<-display> isn't used to override. It
		1651	defaults to C<:0> if it doesn't exist.
		1652
		1653	=item B<SHELL>
		1654
		1655	The shell to be used for command execution, defaults to C</bin/sh>.
		1656
		1657	=item B<RXVT_SOCKET>
		1658
		1659	The unix domain socket path used by @@RXVT_NAME@@c(1) and
		1660	@@RXVT_NAME@@d(1).
		1661
		1662	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1663
		1664	=item B<HOME>
		1665
		1666	Used to locate the default directory for the unix domain socket for
		1667	daemon communications and to locate various resource files (such as
		1668	C<.Xdefaults>)
		1669
		1670	=item B<XAPPLRESDIR>
		1671
		1672	Directory where application-specific X resource files are located.
		1673
		1674	=item B<XENVIRONMENT>
		1675
		1676	If set and accessible, gives the name of a X resource file to be loaded by
		1677	@@RXVT_NAME@@.
1014		1678
1015	=back	1679	=back
1016		1680
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	1681	=head1 FILES
1027		1682
1028	=over 4	1683	=over 4
1029		1684
1030	=item B</etc/utmp>
1031
1032	System file for login records.
1033
1034	=item B</usr/lib/X11/rgb.txt>	1685	=item B</usr/lib/X11/rgb.txt>
1035		1686
1036	Color names.	1687	Colour names.
1037		1688
1038	=back	1689	=back
1039		1690
1040	=head1 SEE ALSO	1691	=head1 SEE ALSO
1041		1692
1042	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1693	@@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		1694
1052	=head1 CURRENT PROJECT COORDINATOR	1695	=head1 CURRENT PROJECT COORDINATOR
1053		1696
1054	=over 4	1697	=over 4
1055		1698
1056	=item Project Coordinator	1699	=item Project Coordinator
1057		1700
1058	@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@>	1701	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1059		1702
1060	=item Web page maintainter	1703	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1061
1062	@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1063
1064	L<@@RXVT_WEBPAGE@@>
1065		1704
1066	=back	1705	=back
1067		1706
1068	=head1 AUTHORS	1707	=head1 AUTHORS
1069		1708
…		…
1091		1730
1092	Project Coordinator (changes.txt 2.21a to 2.4.5)	1731	Project Coordinator (changes.txt 2.21a to 2.4.5)
1093		1732
1094	=item Geoff Wing L<< <gcw@pobox.com> >>	1733	=item Geoff Wing L<< <gcw@pobox.com> >>
1095		1734
1096	Rewrote screen display and text selection routines. Project Coordinator	1735	Rewrote screen display and text selection routines.
		1736
1097	(changes.txt 2.4.6 - rxvt-unicode)	1737	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1098		1738
1099	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>	1739	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1100		1740
1101	Forked rxvt-unicode, rewrote most of the display code and internal	1741	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1102	character handling to store text in unicode, improve xterm	1742	extension, random hacks, numerous bugfixes and extensions.
1103	compatibility and apply numerous other bugfixes and extensions.
1104		1743
1105	Project Coordinator (Changes 1.0 -)	1744	Project Coordinator (Changes 1.0 -)
1106		1745
		1746	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1747
		1748	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
		1749
1107	=back	1750	=back
1108		1751

Diff Legend

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