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

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.30 by root, Wed Sep 8 17:10:23 2004 UTC vs. Revision 1.161 by ayin, Sat Jan 26 14:24:42 2008 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.30 by root, Wed Sep 8 17:10:23 2004 UTC vs.
Revision 1.161 by ayin, Sat Jan 26 14:24:42 2008 UTC