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.1 by root, Thu Aug 12 20:42:12 2004 UTC vs.
Revision 1.148 by ayin, Sat Nov 24 17:07:46 2007 UTC

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

Diff Legend

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