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.2 by root, Thu Aug 12 21:30:14 2004 UTC vs.
Revision 1.186 by sf-exg, Wed Oct 13 23:36:00 2010 UTC

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

Diff Legend

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