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

Diff Legend

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