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

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.43 by root, Sun Jan 16 19:22:16 2005 UTC vs. Revision 1.160 by root, Fri Jan 25 18:42:23 2008 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.43 by root, Sun Jan 16 19:22:16 2005 UTC vs.
Revision 1.160 by root, Fri Jan 25 18:42:23 2008 UTC