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

Diff Legend

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