[ViewVC] Diff of: cvs/rxvt-unicode/doc/rxvt.1.pod

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.75 by root, Tue Dec 27 01:50:00 2005 UTC vs. Revision 1.219 by root, Thu Jun 7 16:06:23 2012 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.75 by root, Tue Dec 27 01:50:00 2005 UTC vs.
Revision 1.219 by root, Thu Jun 7 16:06:23 2012 UTC