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.5 by root, Sat Aug 14 03:00:32 2004 UTC vs.
Revision 1.166 by root, Fri Oct 10 13:23:56 2008 UTC

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

Diff Legend

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