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.4 by root, Fri Aug 13 03:47:09 2004 UTC vs.
Revision 1.187 by sf-exg, Fri Oct 15 10:46:57 2010 UTC

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

Diff Legend

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