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.55 by root, Mon Feb 14 10:44:50 2005 UTC vs.
Revision 1.225 by sf-exg, Wed Jun 5 07:58:17 2013 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	22	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20	frequently asked questions and answer to them and some common	23	frequently asked questions and answer to them and some common
21	problems. That document is also accessible on the World-Wide-Web at	24	problems. That document is also accessible on the World-Wide-Web at
22	L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.	25	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23		26
24	=head1 RXVT-UNICODE VS. RXVT	27	=head1 RXVT-UNICODE VS. RXVT
25		28
26	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
27	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
28	world. Being a terminal emulator, however, some things are very difficult,	31	world. Being a terminal emulator, however, some things are very difficult,
29	especially cursive scripts such as arabic, vertically written scripts	32	especially cursive scripts such as arabic, vertically written scripts
30	like mongolian or scripts requiring extremely complex combining rules,	33	like mongolian or scripts requiring extremely complex combining rules,
31	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
32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	35	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33	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
34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	37	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35	belong into the application, not the terminal emulator (too many things --	38	belong in the application, not the terminal emulator (too many things --
36	such as cursor-movement while editing -- break otherwise), but that might	39	such as cursor-movement while editing -- break otherwise), but that might
37	change.	40	change.
38		41
39	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
40	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
41	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
42	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
43	another for japanese.	46	another for japanese.
44		47
45	Therefore another design rationale was the use of multiple fonts to	48	Therefore another design rationale was the use of multiple fonts to
46	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
47	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
48	to choose any font for any script freely.	51	to choose any font for any script freely.
49		52
50	Apart from that, rxvt-unicode is also much better internationalised than	53	Apart from that, rxvt-unicode is also much better internationalised than
51	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
52	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
53	rxvt. This all in addition to dozens of other small improvements.	56	rxvt. This all in addition to dozens of other small improvements.
54		57
55	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
56	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
57	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
58	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
59	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
60	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and	63	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
61	@@RXVT_NAME@@c(1) (client).	64	@@RXVT_NAME@@c(1) (client).
62		65
63	It also makes technical information about escape sequences (which have	66	It also makes technical information about escape sequences (which have
64	been extended) easier accessible: see @@RXVT_NAME@@(7) for technical	67	been extended) more accessible: see @@RXVT_NAME@@(7) for technical
65	reference documentation (escape sequences etc.).	68	reference documentation (escape sequences etc.).
66		69
67	=head1 OPTIONS	70	=head1 OPTIONS
68		71
69	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
…		…
89		92
90	Print out a message describing available options.	93	Print out a message describing available options.
91		94
92	=item B<-display> I<displayname>	95	=item B<-display> I<displayname>
93		96
94	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>
95	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
96	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).
97		115
98	=item B<-geometry> I<geom>	116	=item B<-geometry> I<geom>
99		117
100	Window geometry (B<-g> still respected); resource B<geometry>.	118	Window geometry (B<-g> still respected); resource B<geometry>.
101		119
…		…
103		121
104	Turn on/off simulated reverse video; resource B<reverseVideo>.	122	Turn on/off simulated reverse video; resource B<reverseVideo>.
105		123
106	=item B<-j>|B<+j>	124	=item B<-j>|B<+j>
107		125
108	Turn on/off jump scrolling; resource B<jumpScroll>.	126	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
109		127
110	=item B<-ip>|B<+ip>	128	=item B<-ss>|B<+ss>
111		129
112	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>.
113	B<-tr>; resource B<inheritPixmap>.
114		131
115	=item B<-fade> I<number>	132	=item B<-fade> I<number>
116		133
117	Fade the text by the given percentage when focus is lost. resource B<fading>.	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>.
118		137
119	=item B<-tint> I<colour>	138	=item B<-fadecolor> I<colour>
120		139
121	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
122	transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>	141	is opaque black. resource B<fadeColor>.
123	option that can be used to brighten or darken the image in addition to
124	tinting it.
125		142
126	=item B<-sh>	143	=item B<-icon> I<file>
127		144
128	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	145	Compile I<pixbuf>: Use the specified image as application icon. This
129	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
130	specified, too, e.g. C<-tint white>).	147	application window; resource I<iconFile>.
131		148
132	=item B<-bg> I<colour>	149	=item B<-bg> I<colour>
133		150
134	Window background colour; resource B<background>.	151	Window background colour; resource B<background>.
135		152
136	=item B<-fg> I<colour>	153	=item B<-fg> I<colour>
137		154
138	Window foreground colour; resource B<foreground>.	155	Window foreground colour; resource B<foreground>.
139
140	=item B<-pixmap> I<file[;geom]>
141
142	Compile I<XPM>: Specify XPM file for the background and also optionally
143	specify its scaling with a geometry string. Note you may need to
144	add quotes to avoid special shell interpretation of the C<;> in the
145	command-line; resource B<backgroundPixmap>.
146		156
147	=item B<-cr> I<colour>	157	=item B<-cr> I<colour>
148		158
149	The cursor colour; resource B<cursorColor>.	159	The cursor colour; resource B<cursorColor>.
150		160
…		…
162	resource B<borderColor>.	172	resource B<borderColor>.
163		173
164	=item B<-fn> I<fontlist>	174	=item B<-fn> I<fontlist>
165		175
166	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
167	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
168	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
169	smaller, but not (in general) larger. A (hopefully) reasonable default	179	smaller, but not (in general) larger. A (hopefully) reasonable default
170	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.
171		181
172	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
173	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:>,
174	e.g.:	184	e.g.:
175		185
176	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	186	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
177	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	187	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
179	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
180	section of @@RXVT_NAME@@(7).	190	section of @@RXVT_NAME@@(7).
181		191
182	=item B<-fb> I<fontlist>	192	=item B<-fb> I<fontlist>
183		193
184	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
185	be printed. See resource B<boldFont> for details.	195	are to be printed. See resource B<boldFont> for details.
186		196
187	=item B<-fi> I<fontlist>	197	=item B<-fi> I<fontlist>
188		198
189	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>
190	be printed. See resource B<italicFont> for details.	200	characters are to be printed. See resource B<italicFont> for details.
191		201
192	=item B<-fbi> I<fontlist>	202	=item B<-fbi> I<fontlist>
193		203
194	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
195	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.
196		213
197	=item B<-name> I<name>	214	=item B<-name> I<name>
198		215
199	Specify the application name under which resources are to be obtained,	216	Specify the application name under which resources are to be obtained,
200	rather than the default executable file name. Name should not contain	217	rather than the default executable file name. Name should not contain
…		…
216		233
217	=item B<-sb>|B<+sb>	234	=item B<-sb>|B<+sb>
218		235
219	Turn on/off scrollbar; resource B<scrollBar>.	236	Turn on/off scrollbar; resource B<scrollBar>.
220		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
221	=item B<-si>|B<+si>	247	=item B<-si>|B<+si>
222		248
223	Turn on/off scroll-to-bottom on TTY output inhibit; resource	249	Turn on/off scroll-to-bottom on TTY output inhibit; resource
224	B<scrollTtyOutput> has opposite effect.	250	B<scrollTtyOutput> has opposite effect.
225		251
…		…
231	=item B<-sw>|B<+sw>	257	=item B<-sw>|B<+sw>
232		258
233	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.
234	This only takes effect if B<-si> is also given; resource	260	This only takes effect if B<-si> is also given; resource
235	B<scrollWithBuffer>.	261	B<scrollWithBuffer>.
236
237	=item B<-sr>|B<+sr>
238
239	Put scrollbar on right/left; resource B<scrollBar_right>.
240
241	=item B<-st>|B<+st>
242
243	Display normal (non XTerm/NeXT) scrollbar without/with a trough;
244	resource B<scrollBar_floating>.
245		262
246	=item B<-ptab>|B<+ptab>	263	=item B<-ptab>|B<+ptab>
247		264
248	If enabled (default), "Horizontal Tab" characters are being stored as	265	If enabled (default), "Horizontal Tab" characters are being stored as
249	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
…		…
253		270
254	=item B<-bc>|B<+bc>	271	=item B<-bc>|B<+bc>
255		272
256	Blink the cursor; resource B<cursorBlink>.	273	Blink the cursor; resource B<cursorBlink>.
257		274
		275	=item B<-uc>|B<+uc>
		276
		277	Make the cursor underlined; resource B<cursorUnderline>.
		278
258	=item B<-iconic>	279	=item B<-iconic>
259		280
260	Start iconified, if the window manager supports that option.	281	Start iconified, if the window manager supports that option.
261	Alternative form is B<-ic>.	282	Alternative form is B<-ic>.
262		283
…		…
278		299
279	=item B<-bl>	300	=item B<-bl>
280		301
281	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.
282	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
283	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>.
284		318
285	=item B<-lsp> I<number>	319	=item B<-lsp> I<number>
286		320
287	Compile I<frills>: Lines (pixel height) to insert between each row of	321	Compile I<frills>: Lines (pixel height) to insert between each row of
288	the display. Useful to work around font rendering problems; resource	322	the display. Useful to work around font rendering problems; resource
289	B<linespace>.	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>.
290		331
291	=item B<-tn> I<termname>	332	=item B<-tn> I<termname>
292		333
293	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
294	B<TERM> environment variable. This terminal type must exist in the	335	B<TERM> environment variable. This terminal type must exist in the
…		…
303	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
304	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
305	run the program specified by the B<SHELL> environment variable or,	346	run the program specified by the B<SHELL> environment variable or,
306	failing that, I<sh(1)>.	347	failing that, I<sh(1)>.
307		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
308	=item B<-title> I<text>	354	=item B<-title> I<text>
309		355
310	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
311	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
312	application name; resource B<title>.	358	application name; resource B<title>.
…		…
343	for more info.	389	for more info.
344		390
345	=item B<-tcw>	391	=item B<-tcw>
346		392
347	Change the meaning of triple-click selection with the left mouse	393	Change the meaning of triple-click selection with the left mouse
		394	button. Only effective when the original (non-perl) selection code is
348	button. Instead of selecting a full line it will extend the selection the	395	in-use. Instead of selecting a full line it will extend the selection to
349	end of the logical line only. resource B<tripleclickwords>.	396	the end of the logical line only. resource B<tripleclickwords>.
350		397
351	=item B<-insecure>	398	=item B<-insecure>
352		399
353	Enable "insecure" mode, which currently enables most of the escape	400	Enable "insecure" mode, which currently enables most of the escape
354	sequences that echo strings. See the resource B<insecure> for more	401	sequences that echo strings. See the resource B<insecure> for more
…		…
368	=item B<-ssr>|B<+ssr>	415	=item B<-ssr>|B<+ssr>
369		416
370	Turn on/off secondary screen scroll (default enabled); resource	417	Turn on/off secondary screen scroll (default enabled); resource
371	B<secondaryScroll>.	418	B<secondaryScroll>.
372		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
		433	=item B<-xrm> I<string>
		434
		435	Works like the X Toolkit option of the same name, by adding the I<string>
		436	as if it were specified in a resource file. Resource values specified this
		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
373	=item B<-keysym.>I<sym>: I<string>	446	=item B<-keysym.>I<sym> I<string>
374		447
375	Remap a key symbol. See resource B<keysym>.	448	Remap a key symbol. See resource B<keysym>.
376		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
377	=item B<-xrm> I<resourcestring>	507	=item B<-pe> I<string>
378		508
379	No effect on rxvt-unicode. Simply passes through an argument to be made	509	Comma-separated list of perl extension scripts to use (or not to use) in
380	available in the instance's argument list. Appears in I<WM_COMMAND> in	510	this terminal instance. See resource B<perl-ext> for details.
381	some window managers.
382		511
383	=back	512	=back
384		513
385	=head1 RESOURCES (available also as long-options)	514	=head1 RESOURCES
386		515
387	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	516	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
388	options) compiled into your version.	517	options) compiled into your version. All resources are also available as
		518	long-options.
389		519
390	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
391	Xresource data: using the X libraries (Xrm*-functions) or internal	521	distribution do also load settings from the B<~/.Xresources> file when X
392	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	522	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
393	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	523	with later settings overwriting earlier ones:
394	resources using X11 tools like B<xrdb>. Many distribution do also load
395	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
396	will consult the following files/resources in order, with later settings
397	overwriting earlier ones:
398		524
399	1. system-wide app-defaults file, either locale-dependent OR global
400	2. app-defaults file in $XAPPLRESDIR	525	1. app-defaults file in $XAPPLRESDIR
		526	2. $HOME/.Xdefaults
401	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	527	3. RESOURCE_MANAGER property on root-window of screen 0
402	4. SCREEN_RESOURCES for the current screen	528	4. SCREEN_RESOURCES property on root-window of the current screen
403	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	529	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		530	6. resources specified via -xrm on the commandline
404		531
405	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
406	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
407	set in XAPPLOADDIR/URxvt (compile-time defined: usually
408	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
409	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
410	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	532	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
411	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
412	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
413	easily configured, while the class name B<URxvt> allows resources	535	configured, while the class name B<URxvt> allows resources unique to
414	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	536	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
415	shared between different B<@@RXVT_NAME@@> configurations. If no	537	configurations. If no resources are specified, suitable defaults will
416	resources are specified, suitable defaults will be used. Command-line	538	be used. Command-line arguments can be used to override resource
417	arguments can be used to override resource settings. The following	539	settings. The following resources are supported (you might want to
418	resources are allowed:	540	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		541	extensions not documented here):
419		542
420	=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.
421		556
422	=item B<geometry:> I<geom>	557	=item B<geometry:> I<geom>
423		558
424	Create the window with the specified X window geometry [default 80x24];	559	Create the window with the specified X window geometry [default 80x24];
425	option B<-geometry>.	560	option B<-geometry>.
…		…
439	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
440	corresponds to low-intensity (normal) colours and 8-15 corresponds to	575	corresponds to low-intensity (normal) colours and 8-15 corresponds to
441	high-intensity (bold = bright foreground, blink = bright background)	576	high-intensity (bold = bright foreground, blink = bright background)
442	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,
443	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
444	names used are listed in the B<COLORS AND GRAPHICS> section.	579	names used are listed in the B<COLOURS AND GRAPHICS> section.
445		580
446	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
447	changed using an escape command (see @@RXVT_NAME@@(7)).	582	changed using an escape command (see @@RXVT_NAME@@(7)).
448		583
449	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
…		…
460	=item B<colorUL:> I<colour>	595	=item B<colorUL:> I<colour>
461		596
462	Use the specified colour to display underlined characters when the	597	Use the specified colour to display underlined characters when the
463	foreground colour is the default.	598	foreground colour is the default.
464		599
465	=item B<colorRV:> I<colour>
466
467	Use the specified colour as the background for reverse video
468	characters.
469
470	=item B<underlineColor:> I<colour>	600	=item B<underlineColor:> I<colour>
471		601
472	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
473	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.
474		614
475	=item B<cursorColor:> I<colour>	615	=item B<cursorColor:> I<colour>
476		616
477	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
478	foreground colour; option B<-cr>.	618	foreground colour; option B<-cr>.
…		…
485		625
486	=item B<reverseVideo:> I<boolean>	626	=item B<reverseVideo:> I<boolean>
487		627
488	B<True>: simulate reverse video by foreground and background colours;	628	B<True>: simulate reverse video by foreground and background colours;
489	option B<-rv>. B<False>: regular screen colours [default]; option	629	option B<-rv>. B<False>: regular screen colours [default]; option
490	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	630	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
491		631
492	=item B<jumpScroll:> I<boolean>	632	=item B<jumpScroll:> I<boolean>
493		633
494	B<True>: specify that jump scrolling should be used. When scrolling	634	B<True>: specify that jump scrolling should be used. When receiving lots
495	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
496	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>.
497		641
498	=item B<inheritPixmap:> I<boolean>	642	=item B<skipScroll:> I<boolean>
499		643
500	B<True>: make the background inherit the parent windows' pixmap, giving	644	B<True>: (the default) specify that skip scrolling should be used. When
501	artificial transparency. B<False>: do not inherit the parent windows'	645	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
502	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>.
503		653
504	=item B<fading:> I<number>	654	=item B<fading:> I<number>
505		655
506	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>.
507		657
508	=item B<tintColor:> I<colour>	658	=item B<fadeColor:> I<colour>
509		659
510	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>.
511		662
512	=item B<shading:> I<number>	663	=item B<iconFile:> I<file>
513		664
514	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	665	Set the application icon pixmap; option B<-icon>.
515	image in addition to tinting it.
516		666
517	=item B<scrollColor:> I<colour>	667	=item B<scrollColor:> I<colour>
518		668
519	Use the specified colour for the scrollbar [default #B2B2B2].	669	Use the specified colour for the scrollbar [default #B2B2B2].
520		670
521	=item B<troughColor:> I<colour>	671	=item B<troughColor:> I<colour>
522		672
523	Use the specified colour for the scrollbar's trough area [default	673	Use the specified colour for the scrollbar's trough area [default
524	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	674	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
525		675
526	=item B<borderColor:> I<colour>	676	=item B<borderColor:> I<colour>
527		677
528	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
529	and the text.	679	and the text.
530		680
531	=item B<backgroundPixmap:> I<file[;geom]>
532
533	Use the specified XPM file (note the `.xpm' extension is optional) for
534	the background and also optionally specify its scaling with a geometry
535	string B<WxH+X+Y>, in which B<"W" / "H"> specify the
536	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image
537	centre (percent). A scale of 0 displays the image with tiling. A scale
538	of 1 displays the image without any scaling. A scale of 2 to 9
539	specifies an integer number of images in that direction. No image will
540	be magnified beyond 10 times its original size. The maximum permitted
541	scale is 1000. [default 0x0+50+50]
542
543	=item B<menu:> I<file[;tag]>
544
545	Read in the specified menu file (note the `.menu' extension is
546	optional) and also optionally specify a starting tag to find. See the
547	reference documentation for details on the syntax for the menuBar.
548
549	=item B<path:> I<path>
550
551	Specify the colon-delimited search path for finding files (XPM and
552	menus), in addition to the paths specified by the B<RXVTPATH> and
553	B<PATH> environment variables.
554
555	=item B<font:> I<fontlist>	681	=item B<font:> I<fontlist>
556		682
557	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
558	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
559	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
560	be smaller, but not larger. A reasonable default font list is always	686	smaller, but not (in general) larger. A (hopefully) reasonable default
561	appended to it. option B<-fn>.	687	font list is always appended to it; option B<-fn>.
562		688
563	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
564	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.	690	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
565		691
566	In addition, each font can be prefixed with additional hints and	692	In addition, each font can be prefixed with additional hints and
…		…
568	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
569	fonts.	695	fonts.
570		696
571	For example, this font resource	697	For example, this font resource
572		698
573	URxvt*font: 9x15bold,\	699	URxvt.font: 9x15bold,\
574	-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,\
575	-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, \
576	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	702	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
577	xft:Code2000:antialias=false	703	xft:Code2000:antialias=false
578		704
…		…
581	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
582	wide and 15 pixels high.	708	wide and 15 pixels high.
583		709
584	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
585	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
586	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
587	useful supplement.	713	useful supplement.
588		714
589	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
590	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
591	contains other characters, but we are not interested in them.	717	contains other characters, but we are not interested in them.
…		…
612	not possible, replacement fonts of the desired shape will be tried.	738	not possible, replacement fonts of the desired shape will be tried.
613		739
614	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
615	text font will being used for the given style.	741	text font will being used for the given style.
616		742
617	=item B<selectstyle:> I<mode>	743	=item B<intensityStyles:> I<boolean>
618		744
619	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>,
620	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
621	xterm style selection.	747	intensity foreground/background colours. Disabling this option (B<False>,
622		748	option B<+is>) disables this behaviour, the high intensity colours are not
623	=item B<scrollstyle:> I<mode>	749	reachable.
624
625	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
626	the author's favourite..
627		750
628	=item B<title:> I<string>	751	=item B<title:> I<string>
629		752
630	Set window title string, the default title is the command-line	753	Set window title string, the default title is the command-line
631	specified after the B<-e> option, if any, otherwise the application	754	specified after the B<-e> option, if any, otherwise the application
…		…
640	=item B<mapAlert:> I<boolean>	763	=item B<mapAlert:> I<boolean>
641		764
642	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
643	de-iconify (map) on receipt of a bell character [default].	766	de-iconify (map) on receipt of a bell character [default].
644		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
645	=item B<visualBell:> I<boolean>	775	=item B<visualBell:> I<boolean>
646		776
647	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>.
648	B<False>: no visual bell [default]; option B<+vb>.	778	B<False>: no visual bell [default]; option B<+vb>.
649		779
…		…
663		793
664	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
665	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
666	B<Shift-Print> to include the scrollback as well.	796	B<Shift-Print> to include the scrollback as well.
667		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
668	=item B<scrollBar:> I<boolean>	816	=item B<scrollBar:> I<boolean>
669		817
670	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	818	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
671	disable the scrollbar; option B<+sb>.	819	disable the scrollbar; option B<+sb>.
672		820
…		…
691	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
692	B<+si>.	840	B<+si>.
693		841
694	=item B<scrollWithBuffer:> I<boolean>	842	=item B<scrollWithBuffer:> I<boolean>
695		843
696	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.
697	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
698	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>.
699		848
700	=item B<scrollTtyKeypress:> I<boolean>	849	=item B<scrollTtyKeypress:> I<boolean>
701		850
702	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
703	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
…		…
722	=item B<borderLess:> I<boolean>	871	=item B<borderLess:> I<boolean>
723		872
724	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
725	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>.
726		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
727	=item B<termName:> I<termname>	883	=item B<termName:> I<termname>
728		884
729	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
730	variable; option B<-tn>.	886	variable; option B<-tn>.
731		887
732	=item B<linespace:> I<number>	888	=item B<lineSpace:> I<number>
733		889
734	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
735	the display [default 0]; option B<-lsp>.	891	the display [default 0]; option B<-lsp>.
736		892
737	=item B<meta8:> I<boolean>	893	=item B<meta8:> I<boolean>
…		…
751		907
752	=item B<cursorBlink:> I<boolean>	908	=item B<cursorBlink:> I<boolean>
753		909
754	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];
755	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>.
756		917
757	=item B<pointerBlank:> I<boolean>	918	=item B<pointerBlank:> I<boolean>
758		919
759	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
760	of seconds of inactivity. B<False>: the pointer is always visible	921	of seconds of inactivity. B<False>: the pointer is always visible
…		…
768		929
769	Mouse pointer background colour.	930	Mouse pointer background colour.
770		931
771	=item B<pointerBlankDelay:> I<number>	932	=item B<pointerBlankDelay:> I<number>
772		933
773	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.
774		936
775	=item B<backspacekey:> I<string>	937	=item B<backspacekey:> I<string>
776		938
777	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>
778	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>
779	(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
780	escape sequence.	942	escape sequence.
781		943
782	=item B<deletekey:> I<string>	944	=item B<deletekey:> I<string>
783		945
…		…
785	pressed. If unset it will send the sequence traditionally associated	947	pressed. If unset it will send the sequence traditionally associated
786	with the B<Execute> key.	948	with the B<Execute> key.
787		949
788	=item B<cutchars:> I<string>	950	=item B<cutchars:> I<string>
789		951
790	The characters used as delimiters for double-click word selection. The	952	The characters used as delimiters for double-click word selection
791	built-in default:	953	(whitespace delimiting is added automatically if resource is given).
792		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
793	B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>	963	B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
794		964
795	=item B<preeditType:> I<style>	965	=item B<preeditType:> I<style>
796		966
797	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	967	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
798		968
…		…
803	=item B<imLocale:> I<name>	973	=item B<imLocale:> I<name>
804		974
805	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.	975	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
806	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the	976	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
807	input extension to be able to input japanese characters while staying in	977	input extension to be able to input japanese characters while staying in
808	another locale. option B<-imlocale>.	978	another locale; option B<-imlocale>.
809		979
810	=item B<imFont:> I<fontset>	980	=item B<imFont:> I<fontset>
811		981
812	Specify the font-set used for XIM styles C<OverTheSpot> or	982	Specify the font-set used for XIM styles C<OverTheSpot> or
813	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated	983	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
…		…
818		988
819	=item B<tripleclickwords:> I<boolean>	989	=item B<tripleclickwords:> I<boolean>
820		990
821	Change the meaning of triple-click selection with the left mouse	991	Change the meaning of triple-click selection with the left mouse
822	button. Instead of selecting a full line it will extend the selection to	992	button. Instead of selecting a full line it will extend the selection to
823	the end of the logical line only. option B<-tcw>.	993	the end of the logical line only; option B<-tcw>.
824		994
825	=item B<insecure:> I<boolean>	995	=item B<insecure:> I<boolean>
826		996
827	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	997	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
828	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
829	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
830	throuh a mail client displaying mail bodies unfiltered or though	1000	through a mail client displaying mail bodies unfiltered or through
831	write(1). Therefore, these sequences are disabled by default. (Note	1001	write(1) or any other means. Therefore, these sequences are disabled by
832	that other terminals, including xterm, have these sequences	1002	default. (Note that many other terminals, including xterm, have these
833	enabled by default). You can enable them by setting this boolean	1003	sequences enabled by default, which doesn't make it safer, though).
834	resource or specifying B<-insecure> as an option. At the moment, this	1004
835	enabled display-answer, locale, findfont, icon label and window title	1005	You can enable them by setting this boolean resource or specifying
836	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.
837		1008
838	=item B<modifier:> I<modifier>	1009	=item B<modifier:> I<modifier>
839		1010
840	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>,
841	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
…		…
845		1016
846	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)
847	character is passed through. It may contain escape values as described	1018	character is passed through. It may contain escape values as described
848	in the entry on B<keysym> following.	1019	in the entry on B<keysym> following.
849		1020
850	=item B<secondaryScreen:> I<bool>	1021	=item B<secondaryScreen:> I<boolean>
851		1022
852	Turn on/off secondary screen (default enabled).	1023	Turn on/off secondary screen (default enabled).
853		1024
854	=item B<secondaryScroll:> I<bool>	1025	=item B<secondaryScroll:> I<boolean>
855		1026
856	Turn on/off secondary screen scroll (default enabled). If the this	1027	Turn on/off secondary screen scroll (default enabled). If this
857	option is enabled, scrolls on the secondary screen will change the	1028	option is enabled, scrolls on the secondary screen will change the
858	scrollback buffer and switching to/from the secondary screen will	1029	scrollback buffer and, when secondaryScreen is off, switching
859	instead scroll the screen up.	1030	to/from the secondary screen will instead scroll the screen up.
		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>.
860		1045
861	=item B<keysym.>I<sym>: I<string>	1046	=item B<keysym.>I<sym>: I<string>
862		1047
863	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1048	Compile I<frills>: Associate I<string> with keysym I<sym>. The
864	intervening resource name B<keysym.> cannot be omitted.	1049	intervening resource name B<keysym.> cannot be omitted.
…		…
878	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1063	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
879	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1064	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
880	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1065	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
881	performed in an exact manner; however, the closest match is assured.	1066	performed in an exact manner; however, the closest match is assured.
882		1067
883	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1068	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
884	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1069	number), see RESOURCES in C<man 7 X> for further details.
885	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
886	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
887	can start or end with whitespace.
888		1070
889	Please note that you need to double the C<\> when using
890	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
891	use C<\033> instead of C<\e> (and so on), which will work with both Xt and
892	@@RXVT_NAME@@'s own processing).
893
894	You can define a range of keysyms in one shot by providing a I<string>	1071	You can define a range of keysyms in one shot by
		1072	loading the C<keysym-list> perl extension and providing a I<string>
895	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1073	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
896	should be a character not used by the strings.	1074	should be a character not used by the strings.
897		1075
898	Its usage can be demonstrated by an example:	1076	Its usage can be demonstrated by an example:
899		1077
900	URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>	1078	URxvt.keysym.M-C-0x61: list|\033<|abc|>
901		1079
902	The above line is equivalent to the following three lines:	1080	The above line is equivalent to the following three lines:
903		1081
904	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1082	URxvt.keysym.Meta-Control-0x61: \033<a>
905	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1083	URxvt.keysym.Meta-Control-0x62: \033<b>
906	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1084	URxvt.keysym.Meta-Control-0x63: \033<c>
907		1085
908	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1086	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
909	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1087	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
910	example the following means "change the current locale to C<zh_CN.GBK>	1088	example the following means "change the current locale to C<zh_CN.GBK>
911	when Control-Meta-c is being pressed":	1089	when Control-Meta-c is being pressed":
912		1090
913	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1091	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
914		1092
		1093	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1094	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1095	manpage. For example, the F<selection> extension (activated via
		1096	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1097
		1098	URxvt.keysym.M-C-c: perl:selection:rot13
		1099
		1100	Due the the large number of modifier combinations, a defined key mapping
		1101	will match if I<at least> the specified identifiers are being set, and
		1102	no other key mappings with those and more bits are being defined. That
		1103	means that defining a key map for C<a> will automatically provide
		1104	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		1105	mappings themselves.
		1106
		1107	Unfortunately, this will override built-in key mappings. For example
		1108	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		1109	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		1110	user-defined keymap using the C<builtin:> replacement:
		1111
		1112	URxvt.keysym.Insert: <my insert key sequence>
		1113	URxvt.keysym.S-Insert: builtin:
		1114
		1115	The first line defines a mapping for C<Insert> and I<any> combination
		1116	of modifiers. The second line re-establishes the default mapping for
		1117	C<Shift-Insert>.
		1118
915	The following example will map Control-Meta-1 and Control-Meta-2 to	1119	The following example will map Control-Meta-1 and Control-Meta-2 to
916	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited	1120	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
917	font-switching at runtime:	1121	font-switching at runtime:
918		1122
919	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1123	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
…		…
922	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1126	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
923	info):	1127	info):
924		1128
925	URxvt.keysym.M-C-3: command:\033[8;25;80t	1129	URxvt.keysym.M-C-3: command:\033[8;25;80t
926	URxvt.keysym.M-C-4: command:\033[8;48;110t	1130	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1131
		1132	=item B<perl-ext-common>: I<string>
		1133
		1134	=item B<perl-ext>: I<string>
		1135
		1136	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1137	use in this terminal instance; option B<-pe>.
		1138
		1139	Extension names can be prefixed with a C<-> sign to prohibit using
		1140	them. This can be useful to selectively disable some extensions loaded
		1141	by default, or specified via the C<perl-ext-common> resource. For
		1142	example, C<default,-selection> will use all the default extension except
		1143	C<selection>.
		1144
		1145	Extension names can also be followed by an argument in angle brackets
		1146	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1147	searchable scrollback to Alt/Meta-s). Mentioning the same extension
		1148	multiple times with different arguments will pass multiple arguments to
		1149	the extension.
		1150
		1151	Each extension is looked up in the library directories, loaded if
		1152	necessary, and bound to the current terminal instance.
		1153
		1154	If both of these resources are the empty string, then the perl
		1155	interpreter will not be initialized. The idea behind two options is that
		1156	B<perl-ext-common> will be used for extensions that should be available to
		1157	all instances, while B<perl-ext> is used for specific instances.
		1158
		1159	=item B<perl-eval>: I<string>
		1160
		1161	Perl code to be evaluated when all extensions have been registered. See
		1162	the @@RXVT_NAME@@perl(3) manpage.
		1163
		1164	=item B<perl-lib>: I<path>
		1165
		1166	Colon-separated list of additional directories that hold extension
		1167	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
		1168	in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
		1169	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
		1170
		1171	See the @@RXVT_NAME@@perl(3) manpage.
		1172
		1173	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1174
		1175	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1176	details.
		1177
		1178	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1179
		1180	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1181	for details.
		1182
		1183	=item B<searchable-scrollback:> I<keysym>
		1184
		1185	Sets the hotkey that starts the incremental scrollback buffer search
		1186	(default: C<M-s>).
		1187
		1188	=item B<url-launcher>: I<string>
		1189
		1190	Specifies the program to be started with a URL argument. Used by the
		1191	C<selection-popup> and C<matcher> perl extensions.
		1192
		1193	=item B<transient-for>: I<windowid>
		1194
		1195	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1196
		1197	=item B<override-redirect>: I<boolean>
		1198
		1199	Compile I<frills>: Sets override-redirect for the terminal window, making
		1200	it almost invisible to window managers; option B<-override-redirect>.
		1201
		1202	=item B<iso14755:> I<boolean>
		1203
		1204	Turn on/off ISO 14755 (default enabled).
		1205
		1206	=item B<iso14755_52:> I<boolean>
		1207
		1208	Turn on/off ISO 14755 5.2 mode (default enabled).
		1209
		1210	=back
		1211
		1212	=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
		1213
		1214	=over 4
		1215
		1216	=item B<-pixmap> I<file[;oplist]>
		1217
		1218	=item B<backgroundPixmap:> I<file[;oplist]>
		1219
		1220	Compile I<pixbuf>: Use the specified image file as the window's
		1221	background and also optionally specify a colon separated list of
		1222	operations to modify it. Note that you may need to quote the C<;>
		1223	character when using the command line option, as C<;> is usually a
		1224	metacharacter in shells. Supported operations are:
		1225
		1226	=over 4
		1227
		1228	=item B<WxH+X+Y>
		1229
		1230	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
		1231	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
		1232	scale of 0 disables scaling.
		1233
		1234	=item B<op=tile>
		1235
		1236	enables tiling
		1237
		1238	=item B<op=keep-aspect>
		1239
		1240	maintain the image aspect ratio when scaling
		1241
		1242	=item B<op=root-align>
		1243
		1244	use the position of the terminal window relative to the root window as
		1245	the image offset, simulating a root window background
		1246
		1247	=back
		1248
		1249	The default scale and position setting is C<100x100+50+50>.
		1250	Alternatively, a predefined set of templates can be used to achieve
		1251	the most common setups:
		1252
		1253	=over 4
		1254
		1255	=item B<style=tiled>
		1256
		1257	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		1258
		1259	=item B<style=aspect-stretched>
		1260
		1261	the image is scaled to fill the whole window maintaining the aspect
		1262	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		1263
		1264	=item B<style=stretched>
		1265
		1266	the image is scaled to fill the whole window. Equivalent to 100x100
		1267
		1268	=item B<style=centered>
		1269
		1270	the image is centered with no scaling. Equivalent to 0x0+50+50
		1271
		1272	=item B<style=root-tiled>
		1273
		1274	the image is tiled with no scaling and using 'root' positioning.
		1275	Equivalent to 0x0:op=tile:op=root-align
		1276
		1277	=back
		1278
		1279	If multiple templates are specified the last one wins. Note that a
		1280	template overrides all the scale, position and operations settings.
		1281
		1282	If used in conjunction with pseudo-transparency, the specified pixmap
		1283	will be blended over the transparent background using alpha-blending.
		1284
		1285	=item B<-tr>|B<+tr>
		1286
		1287	=item B<transparent:> I<boolean>
		1288
		1289	Turn on/off pseudo-transparency by using the root pixmap as background.
		1290
		1291	B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
		1292	will be removed in future versions.
		1293
		1294	=item B<-tint> I<colour>
		1295
		1296	=item B<tintColor:> I<colour>
		1297
		1298	Tint the transparent background with the given colour. Note that a
		1299	black tint yields a completely black image while a white tint yields
		1300	the image unchanged.
		1301
		1302	=item B<-sh> I<number>
		1303
		1304	=item B<shading:> I<number>
		1305
		1306	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
		1307	A value of 100 means no shading.
		1308
		1309	=item B<-blr> I<HxV>
		1310
		1311	=item B<blurRadius:> I<HxV>
		1312
		1313	Apply gaussian blur with the specified radius to the transparent
		1314	background. If a single number is specified, the vertical and
		1315	horizontal radii are considered to be the same. Setting one of the
		1316	radii to 1 and the other to a large number creates interesting effects
		1317	on some backgrounds. The maximum radius value is 128. An horizontal or
		1318	vertical radius of 0 disables blurring.
		1319
		1320	=item B<path:> I<path>
		1321
		1322	Specify the colon-delimited search path for finding background image files.
927		1323
928	=back	1324	=back
929		1325
930	=head1 THE SCROLLBAR	1326	=head1 THE SCROLLBAR
931		1327
…		…
950	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1346	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
951	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1347	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
952	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1348	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
953	respectively.	1349	respectively.
954		1350
955	=head1 TEXT SELECTION AND INSERTION	1351	=head1 THE SELECTION: SELECTING AND PASTING TEXT
956		1352
957	The behaviour of text selection and insertion mechanism is similar to	1353	The behaviour of text selection and insertion/pasting mechanism is similar
958	I<xterm>(1).	1354	to I<xterm>(1).
959		1355
960	=over 4	1356	=over 4
961		1357
962	=item B<Selection>:	1358	=item B<Selecting>:
963		1359
964	Left click at the beginning of the region, drag to the end of the region	1360	Left click at the beginning of the region, drag to the end of the region
965	and release; Right click to extend the marked region; Left double-click	1361	and release; Right click to extend the marked region; Left double-click
966	to select a word; Left triple-click to select the entire logical line	1362	to select a word; Left triple-click to select the entire logical line
967	(which can span multiple screen lines), unless modified by resource	1363	(which can span multiple screen lines), unless modified by resource
968	B<tripleclickwords>.	1364	B<tripleclickwords>.
969		1365
970	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1366	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
971	(Compile: I<frills>) will create a rectangular selection instead of a normal	1367	(Compile: I<frills>) will create a rectangular selection instead of a
972	one.	1368	normal one. In this mode, every selected row becomes its own line in the
		1369	selection, and trailing whitespace is visually underlined and removed from
		1370	the selection.
973		1371
974	=item B<Insertion>:	1372	=item B<Pasting>:
975		1373
976	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1374	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
977	an B<@@RXVT_NAME@@> window causes the current text selection to be	1375	window causes the value of the PRIMARY selection (or CLIPBOARD with the
978	inserted as if it had been typed on the keyboard.	1376	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1377
		1378	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1379	inserted too.
979		1380
980	=back	1381	=back
981		1382
982	=head1 CHANGING FONTS	1383	=head1 CHANGING FONTS
983		1384
984	Changing fonts (or font sizes, respectively) via the keypad is not yet	1385	Changing fonts (or font sizes, respectively) via the keypad is not yet
985	supported in rxvt-unicode. Bug me if you need this.	1386	supported in rxvt-unicode. Bug me if you need this.
986		1387
987	You can, however, switch fonts at runtime using escape sequences (and	1388	You can, however, switch fonts at runtime using escape sequences, e.g.:
988	therefore using the menubar), e.g.:
989		1389
990	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1390	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1391
		1392	You can use keyboard shortcuts, too:
		1393
		1394	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1395	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
991		1396
992	rxvt-unicode will automatically re-apply these fonts to the output so far.	1397	rxvt-unicode will automatically re-apply these fonts to the output so far.
993		1398
994	=head1 ISO 14755 SUPPORT	1399	=head1 ISO 14755 SUPPORT
995		1400
996	ISO 14755 is a standard for entering and viewing unicode characters	1401	ISO 14755 is a standard for entering and viewing unicode characters
997	and character codes using the keyboard. It consists of 4 parts. The	1402	and character codes using the keyboard. It consists of 4 parts. The
998	first part is available rxvt-unicode has been compiled with	1403	first part is available if rxvt-unicode has been compiled with
999	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1404	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1000	with C<--enable-iso14755>.	1405	with C<--enable-iso14755>.
1001		1406
1002	=over 4	1407	=over 4
1003		1408
…		…
1023	This mode lets you input characters representing the keycap symbols of	1428	This mode lets you input characters representing the keycap symbols of
1024	your keyboard, if representable in the current locale encoding.	1429	your keyboard, if representable in the current locale encoding.
1025		1430
1026	Start by pressing C<Control> and C<Shift> together, then releasing	1431	Start by pressing C<Control> and C<Shift> together, then releasing
1027	them. The next special key (cursor keys, home etc.) you enter will not	1432	them. The next special key (cursor keys, home etc.) you enter will not
1028	invoke it's usual function but instead will insert the corresponding	1433	invoke its usual function but instead will insert the corresponding
1029	keycap symbol. The symbol will only be entered when the key has been	1434	keycap symbol. The symbol will only be entered when the key has been
1030	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1435	released, otherwise pressing e.g. C<Shift> would enter the symbol for
1031	C<ISO Level 2 Switch>, although your intention might have been to enter a	1436	C<ISO Level 2 Switch>, although your intention might have been to enter a
1032	reverse tab (Shift-Tab).	1437	reverse tab (Shift-Tab).
1033		1438
…		…
1061	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1466	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1062	it can be seen via the I<who(1)> command, and can accept messages. To	1467	it can be seen via the I<who(1)> command, and can accept messages. To
1063	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1468	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1064	on some systems or setgid to root or to some other group on others.	1469	on some systems or setgid to root or to some other group on others.
1065		1470
1066	=head1 COLORS AND GRAPHICS	1471	=head1 COLOURS AND GRAPHICS
1067		1472
1068	In addition to the default foreground and background colours,	1473	In addition to the default foreground and background colours,
1069	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1474	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1070	high-intensity bold/blink versions of the same). Here is a list of the	1475	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1071	colours with their B<rgb.txt> names.	1476	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1477	cube plus a 8 (24) colour greyscale ramp.
		1478
		1479	Here is a list of the ANSI colours with their names.
1072		1480
1073	=begin table	1481	=begin table
1074		1482
1075	B<color0> (black) = Black	1483	B<color0> (black) = Black
1076	B<color1> (red) = Red3	1484	B<color1> (red) = Red3
…		…
1096	It is also possible to specify the colour values of B<foreground>,	1504	It is also possible to specify the colour values of B<foreground>,
1097	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1505	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1098	a number 0-15, as a convenient shorthand to reference the colour name of	1506	a number 0-15, as a convenient shorthand to reference the colour name of
1099	color0-color15.	1507	color0-color15.
1100		1508
		1509	The following text gives values for the standard 88 colour mode (and
		1510	values for the 256 colour mode in parentheses).
		1511
		1512	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1513
		1514	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1515	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1516
		1517	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1518	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1519	the RGB cube.
		1520
		1521	Together, all those colours implement the 88 (256) colour xterm
		1522	colours. Only the first 16 can be changed using resources currently, the
		1523	rest can only be changed via command sequences ("escape codes").
		1524
		1525	Applications are advised to use terminfo or command sequences to discover
		1526	number and RGB values of all colours (yes, you can query this...).
		1527
1101	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1528	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1102	always swapping the foreground/background colours. This is in contrast to	1529	always swapping the foreground/background colours. This is in contrast to
1103	I<xterm>(1) where the colours are only swapped if they have not otherwise	1530	I<xterm>(1) where the colours are only swapped if they have not otherwise
1104	been specified. For example,	1531	been specified. For example,
1105		1532
		1533	@@RXVT_NAME@@ -fg Black -bg White -rv
		1534
		1535	would yield White on Black, while on I<xterm>(1) it would yield Black on
		1536	White.
		1537
		1538	=head2 ALPHA CHANNEL SUPPORT
		1539
		1540	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1541	their act together, rxvt-unicode will do its own alpha channel management:
		1542
		1543	You can prefix any colour with an opaqueness percentage enclosed in
		1544	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1545	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1546	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1547	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1548	is the recommended format to specify transparency values, and works with
		1549	all ways to specify a colour.
		1550
		1551	For complete control, rxvt-unicode also supports
		1552	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1553	specifications, where the additional C<aaaa> component specifies opacity
		1554	(alpha) values. The minimum value of C<0000> is completely transparent,
		1555	while C<ffff> is completely opaque). The two example colours from
		1556	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1557	C<rgba:0000/ff00/0000/f332>.
		1558
		1559	You probably need to specify B<"-depth 32">, too, to force a visual with
		1560	alpha channels, and have the luck that your X-server uses ARGB pixel
		1561	layout, as X is far from just supporting ARGB visuals out of the box, and
		1562	rxvt-unicode just fudges around.
		1563
		1564	For example, the following selects an almost completely transparent black
		1565	background, and an almost opaque pink foreground:
		1566
		1567	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
		1568
		1569	When not using a background image, then the interpretation of the
		1570	alpha channel is up to your compositing manager (most interpret it as
		1571	transparency of course).
		1572
		1573	When using a background pixmap or pseudo-transparency, then the background
		1574	colour will always behave as if it were completely transparent (so the
		1575	background image shows instead), regardless of how it was specified, while
		1576	other colours will either be transparent as specified (the background
		1577	image will show through) on servers supporting the RENDER extension, or
		1578	fully opaque on servers not supporting the RENDER EXTENSION.
		1579
		1580	Please note that due to bugs in Xft, specifying alpha values might result
		1581	in garbage being displayed when the X-server does not support the RENDER
		1582	extension.
		1583
		1584	=head1 ENVIRONMENT
		1585
		1586	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
		1587
1106	=over 4	1588	=over 4
1107		1589
1108	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
1109
1110	would yield White on Black, while on I<xterm>(1) it would yield Black
1111	on White.
1112
1113	=back
1114
1115	=head1 ENVIRONMENT
1116
1117	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1118
1119	=over 4
1120
1121	=item B<TERM>	1590	=item B<TERM>
1122		1591
1123	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1592	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1124	resources or on the commandline.	1593	resources or on the command line.
1125		1594
1126	=item B<COLORTERM>	1595	=item B<COLORTERM>
1127		1596
1128	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1597	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1129	compiled with XPM support, and optionally with the added extension	1598	compiled with background image support, and optionally with the added
1130	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1599	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1600	screen.
1131		1601
1132	=item B<COLORFGBG>	1602	=item B<COLORFGBG>
1133		1603
1134	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1604	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1135	the colour code used as default foreground/text colour (or the string	1605	the colour code used as default foreground/text colour (or the string
1136	C<default> to indicate that the default-colour escape sequence is to be	1606	C<default> to indicate that the default-colour escape sequence is to be
1137	used), C<bg> is the colour code used as default background colour (or the	1607	used), C<bg> is the colour code used as default background colour (or the
1138	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1608	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1139	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1609	was compiled with background image support. Libraries like C<ncurses>
1140	(and do) use this information to optimize screen output.	1610	and C<slang> can (and do) use this information to optimize screen output.
1141		1611
1142	=item B<WINDOWID>	1612	=item B<WINDOWID>
1143		1613
1144	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1614	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1145	window, which usually has subwindows for the scrollbar, the terminal	1615	window, which usually has subwindows for the scrollbar, the terminal
…		…
1151	C<--with-terminfo=PATH>.	1621	C<--with-terminfo=PATH>.
1152		1622
1153	=item B<DISPLAY>	1623	=item B<DISPLAY>
1154		1624
1155	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1625	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1156	display in it's child processes.	1626	display in its child processes if C<-display> isn't used to override. It
		1627	defaults to C<:0> if it doesn't exist.
1157		1628
1158	=item B<SHELL>	1629	=item B<SHELL>
1159		1630
1160	The shell to be used for command execution, defaults to C</bin/sh>.	1631	The shell to be used for command execution, defaults to C</bin/sh>.
1161		1632
1162	=item B<RXVTPATH>
1163
1164	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1165	files.
1166
1167	=item B<PATH>
1168
1169	Used in the same way as C<RXVTPATH>.
1170
1171	=item B<RXVT_SOCKET>	1633	=item B<RXVT_SOCKET> [I<sic>]
1172		1634
1173	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1635	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1174	@@RXVT_NAME@@d(1).	1636	@@RXVT_NAME@@d(1).
1175		1637
1176	Default C<< $HOME/.rxvt-unicode-<nodename >>.	1638	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1639
		1640	=item B<URXVT_PERL_LIB>
		1641
		1642	Additional F<:>-separated library search path for perl extensions. Will be
		1643	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1644	directory.
		1645
		1646	=item B<URXVT_PERL_VERBOSITY>
		1647
		1648	See L<@@RXVT_NAME@@perl>(3).
1177		1649
1178	=item B<HOME>	1650	=item B<HOME>
1179		1651
1180	Used to locate the default directory for the unix domain socket for	1652	Used to locate the default directory for the unix domain socket for
1181	daemon communications and to locate various resource files (such as	1653	daemon communications and to locate various resource files (such as
1182	C<.Xdefaults>)	1654	C<.Xdefaults>)
1183		1655
1184	=item B<XAPPLRESDIR>	1656	=item B<XAPPLRESDIR>
1185		1657
1186	Directory where various X resource files are being located.	1658	Directory where application-specific X resource files are located.
1187		1659
1188	=item B<XENVIRONMENT>	1660	=item B<XENVIRONMENT>
1189		1661
1190	If set and accessible, gives the name of a X resource file to be loaded by	1662	If set and accessible, gives the name of a X resource file to be loaded by
1191	@@RXVT_NAME@@.	1663	@@RXVT_NAME@@.
…		…
1196		1668
1197	=over 4	1669	=over 4
1198		1670
1199	=item B</usr/lib/X11/rgb.txt>	1671	=item B</usr/lib/X11/rgb.txt>
1200		1672
1201	Color names.	1673	Colour names.
1202		1674
1203	=back	1675	=back
1204		1676
1205	=head1 SEE ALSO	1677	=head1 SEE ALSO
1206		1678
		1679	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1207	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1680	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1208
1209	=head1 BUGS
1210
1211	Check the BUGS file for an up-to-date list.
1212
1213	Cursor change support is not yet implemented.
1214
1215	Click-and-drag doesn't work with X11 mouse report overriding.
1216		1681
1217	=head1 CURRENT PROJECT COORDINATOR	1682	=head1 CURRENT PROJECT COORDINATOR
1218		1683
1219	=over 4	1684	=over 4
1220		1685
1221	=item Project Coordinator	1686	=item Project Coordinator
1222		1687
1223	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1688	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1224		1689
1225	L<http://software.schmorp.de/#rxvt-unicode>	1690	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1226		1691
1227	=back	1692	=back
1228		1693
1229	=head1 AUTHORS	1694	=head1 AUTHORS
1230		1695
…		…
1232		1697
1233	=item John Bovey	1698	=item John Bovey
1234		1699
1235	University of Kent, 1992, wrote the original Xvt.	1700	University of Kent, 1992, wrote the original Xvt.
1236		1701
1237	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>	1702	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1238		1703
1239	very heavily modified Xvt and came up with Rxvt	1704	very heavily modified Xvt and came up with Rxvt
1240		1705
1241	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>	1706	=item Angelo Haritsis <ah@doc.ic.ac.uk>
1242		1707
1243	wrote the Greek Keyboard Input (no longer in code)	1708	wrote the Greek Keyboard Input (no longer in code)
1244		1709
1245	=item mj olesen L<< <olesen@me.QueensU.CA> >>	1710	=item mj olesen <olesen@me.QueensU.CA>
1246		1711
1247	Wrote the menu system.	1712	Wrote the menu system.
1248		1713
1249	Project Coordinator (changes.txt 2.11 to 2.21)	1714	Project Coordinator (changes.txt 2.11 to 2.21)
1250		1715
1251	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>	1716	=item Oezguer Kesim <kesim@math.fu-berlin.de>
1252		1717
1253	Project Coordinator (changes.txt 2.21a to 2.4.5)	1718	Project Coordinator (changes.txt 2.21a to 2.4.5)
1254		1719
1255	=item Geoff Wing L<< <gcw@pobox.com> >>	1720	=item Geoff Wing <gcw@pobox.com>
1256		1721
1257	Rewrote screen display and text selection routines. Project Coordinator	1722	Rewrote screen display and text selection routines.
		1723
1258	(changes.txt 2.4.6 - rxvt-unicode)	1724	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1259		1725
1260	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1726	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1261		1727
1262	Forked rxvt-unicode, rewrote most of the display code and internal	1728	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1263	character handling to store text in unicode, improve xterm	1729	extension, random hacks, numerous bugfixes and extensions.
1264	compatibility and apply numerous other bugfixes and extensions.
1265		1730
1266	Project Coordinator (Changes 1.0 -)	1731	Project Coordinator (Changes 1.0 -)
1267		1732
		1733	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
		1734
		1735	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
		1736
1268	=back	1737	=back
1269		1738

Diff Legend

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