ViewVC Help

View File | Revision Log | Show Annotations | Download File

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.2 by root, Thu Aug 12 21:30:14 2004 UTC vs.
Revision 1.239 by sf-exg, Sun Oct 12 20:51:51 2014 UTC

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

Diff Legend

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