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

Diff Legend

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