ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/rxvt-unicode/doc/rxvt.1.pod

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.1 by root, Thu Aug 12 20:42:12 2004 UTC vs.
Revision 1.230 by sf-exg, Mon Apr 28 16:00:34 2014 UTC

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

Diff Legend

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