ViewVC Help

View File | Revision Log | Show Annotations | Download File

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.2 by root, Thu Aug 12 21:30:14 2004 UTC vs.
Revision 1.160 by root, Fri Jan 25 18:42:23 2008 UTC

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

Diff Legend

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