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.69 by root, Tue Oct 25 19:04:45 2005 UTC vs.
Revision 1.212 by sf-exg, Sun Jan 1 14:31:28 2012 UTC

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

Diff Legend

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