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.220 by root, Fri Sep 21 23:31:43 2012 UTC

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

Diff Legend

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