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.36 by root, Wed Dec 15 05:10:57 2004 UTC vs.
Revision 1.233 by sf-exg, Sat May 24 18:41:29 2014 UTC

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

Diff Legend

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