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.1 by root, Thu Aug 12 20:42:12 2004 UTC vs.
Revision 1.194 by sf-exg, Wed Mar 9 13:24:30 2011 UTC

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

Diff Legend

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