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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.66 by root, Thu Jun 30 14:02:17 2005 UTC vs.
Revision 1.131 by ayin, Sat Jun 9 09:05:38 2007 UTC

…		…
17	=head1 FREQUENTLY ASKED QUESTIONS	17	=head1 FREQUENTLY ASKED QUESTIONS
18		18
19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of	19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20	frequently asked questions and answer to them and some common	20	frequently asked questions and answer to them and some common
21	problems. That document is also accessible on the World-Wide-Web at	21	problems. That document is also accessible on the World-Wide-Web at
22	L<http://cvs.schmorp.de/browse/checkout/rxvt-unicode/doc/rxvt.7.html>.	22	L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.
23		23
24	=head1 RXVT-UNICODE VS. RXVT	24	=head1 RXVT-UNICODE VS. RXVT
25		25
26	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode	26	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27	internally. That means it can store and display most scripts in the	27	internally. That means it can store and display most scripts in the
28	world. Being a terminal emulator, however, some things are very difficult,	28	world. Being a terminal emulator, however, some things are very difficult,
29	especially cursive scripts such as arabic, vertically written scripts	29	especially cursive scripts such as arabic, vertically written scripts
30	like mongolian or scripts requiring extremely complex combining rules,	30	like mongolian or scripts requiring extremely complex combining rules,
31	like tibetan or devenagari. Don't expect pretty output when using these	31	like tibetan or devenagari. Don't expect pretty output when using these
32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33	fine, though. A somewhat difficult case are left-to-right scripts, such	33	fine, though. A somewhat difficult case are right-to-left scripts, such
34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35	belong into the application, not the terminal emulator (too many things --	35	belong into the application, not the terminal emulator (too many things --
36	such as cursor-movement while editing -- break otherwise), but that might	36	such as cursor-movement while editing -- break otherwise), but that might
37	change.	37	change.
38		38
39	If you are looking for a terminal that supports more exotic scripts, let	39	If you are looking for a terminal that supports more exotic scripts, let
40	me recommend C<mlterm>, which is a very userfriendly, lean and clean	40	me recommend C<mlterm>, which is a very user friendly, lean and clean
41	terminal emulator. In fact, the reason rxvt-unicode was born was solely	41	terminal emulator. In fact, the reason rxvt-unicode was born was solely
42	because the author couldn't get C<mlterm> to use one font for latin1 and	42	because the author couldn't get C<mlterm> to use one font for latin1 and
43	another for japanese.	43	another for japanese.
44		44
45	Therefore another design rationale was the use of multiple fonts to	45	Therefore another design rationale was the use of multiple fonts to
46	display characters: The idea of a single unicode font which many other	46	display characters: The idea of a single unicode font which many other
47	programs force onto it's users never made sense to me: You should be able	47	programs force onto its users never made sense to me: You should be able
48	to choose any font for any script freely.	48	to choose any font for any script freely.
49		49
50	Apart from that, rxvt-unicode is also much better internationalised than	50	Apart from that, rxvt-unicode is also much better internationalised than
51	it's predecessor, supports things such as XFT and ISO 14755 that are handy	51	its predecessor, supports things such as XFT and ISO 14755 that are handy
52	in i18n-environments, is faster, and has a lot less bugs than the original	52	in i18n-environments, is faster, and has a lot bugs less than the original
53	rxvt. This all in addition to dozens of other small improvements.	53	rxvt. This all in addition to dozens of other small improvements.
54		54
55	It is still faithfully following the original rxvt idea of being lean	55	It is still faithfully following the original rxvt idea of being lean
56	and nice on resources: for example, you can still configure rxvt-unicode	56	and nice on resources: for example, you can still configure rxvt-unicode
57	without most of it's features to get a lean binary. It also comes with	57	without most of its features to get a lean binary. It also comes with
58	a client/daemon pair that lets you open any number of terminal windows	58	a client/daemon pair that lets you open any number of terminal windows
59	from within a single process, which makes startup time very fast and	59	from within a single process, which makes startup time very fast and
60	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and	60	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
61	@@RXVT_NAME@@c(1) (client).	61	@@RXVT_NAME@@c(1) (client).
62		62
63	It also makes technical information about escape sequences (which have	63	It also makes technical information about escape sequences (which have
64	been extended) easier accessible: see @@RXVT_NAME@@(7) for technical	64	been extended) more accessible: see @@RXVT_NAME@@(7) for technical
65	reference documentation (escape sequences etc.).	65	reference documentation (escape sequences etc.).
66		66
67	=head1 OPTIONS	67	=head1 OPTIONS
68		68
69	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed	69	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
…		…
93		93
94	Attempt to open a window on the named X display (B<-d> still	94	Attempt to open a window on the named X display (B<-d> still
95	respected). In the absence of this option, the display specified by the	95	respected). In the absence of this option, the display specified by the
96	B<DISPLAY> environment variable is used.	96	B<DISPLAY> environment variable is used.
97		97
		98	=item B<-depth> I<bitdepth>
		99
		100	Compile I<xft>: Attempt to find a visual with the given bit depth;
		101	resource B<depth>.
		102
98	=item B<-geometry> I<geom>	103	=item B<-geometry> I<geom>
99		104
100	Window geometry (B<-g> still respected); resource B<geometry>.	105	Window geometry (B<-g> still respected); resource B<geometry>.
101		106
102	=item B<-rv>\|B<+rv>	107	=item B<-rv>\|B<+rv>
…		…
105		110
106	=item B<-j>\|B<+j>	111	=item B<-j>\|B<+j>
107		112
108	Turn on/off jump scrolling; resource B<jumpScroll>.	113	Turn on/off jump scrolling; resource B<jumpScroll>.
109		114
110	=item B<-ip>\|B<+ip>	115	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>
111		116
112	Turn on/off inheriting parent window's pixmap. Alternative form is	117	Turn on/off inheriting parent window's pixmap. Alternative form is
113	B<-tr>; resource B<inheritPixmap>.	118	B<-tr>; resource B<inheritPixmap>.
114		119
		120	I<Please note that transparency of any kind if completely unsupported by
		121	the author. Don't bug him with installation questions! Read the FAQ (man 7
		122	@@RXVT_NAME@@)!>
		123
115	=item B<-fade> I<number>	124	=item B<-fade> I<number>
116		125
117	Fade the text by the given percentage when focus is lost. resource B<fading>.	126	Fade the text by the given percentage when focus is lost. Small values
		127	fade a little only, 100 completely replaces all colours by the fade
		128	colour; resource B<fading>.
		129
		130	=item B<-fadecolor> I<colour>
		131
		132	Fade to this colour when fading is used (see B<-fade>). The default colour
		133	is opaque black. resource B<fadeColor>.
118		134
119	=item B<-tint> I<colour>	135	=item B<-tint> I<colour>
120		136
121	Tint the transparent background pixmap with the given colour when	137	Tint the transparent background pixmap with the given colour when
122	transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>	138	transparency is enabled with B<-tr> or B<-ip>. This only works for
123	option that can be used to brighten or darken the image in addition to	139	non-tiled backgrounds, currently. See also the B<-sh> option that can be
124	tinting it.	140	used to brighten or darken the image in addition to tinting it; resource
		141	I<tintColor>. Example:
125		142
126	=item B<-sh>	143	@@RXVT_NAME@@ -tr -tint blue -sh 40
127		144
		145	=item B<-sh> I<number>
		146
128	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	147	Darken (0 .. 100) or lighten (-1 .. -100) the transparent
129	background image in addition to tinting it (i.e. B<-tint> must be	148	background image in addition to (or instead of) tinting it;
130	specified, too, e.g. C<-tint white>).	149	resource I<shading>.
		150
		151	=item B<-blt> I<string>
		152
		153	Specify background blending type. If background pixmap is specified
		154	at the same time as transparency - such pixmap will be blended over
		155	transparency image, using method specified. Supported values are :
		156	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
		157	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
		158	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
		159	alpha-blending; resource I<blendType>.
		160
		161	=item B<-blr> I<number>
		162
		163	Apply Gaussian Blur with the specified radius to the transparent
		164	background image; resource I<blurRadius>.
131		165
132	=item B<-bg> I<colour>	166	=item B<-bg> I<colour>
133		167
134	Window background colour; resource B<background>.	168	Window background colour; resource B<background>.
135		169
…		…
137		171
138	Window foreground colour; resource B<foreground>.	172	Window foreground colour; resource B<foreground>.
139		173
140	=item B<-pixmap> I<file[;geom]>	174	=item B<-pixmap> I<file[;geom]>
141		175
142	Compile I<XPM>: Specify XPM file for the background and also optionally	176	Compile I<afterimage>: Specify image file for the background and also
143	specify its scaling with a geometry string. Note you may need to	177	optionally specify its scaling with a geometry string. Note you may need to
144	add quotes to avoid special shell interpretation of the C<;> in the	178	add quotes to avoid special shell interpretation of the C<;> in the
145	command-line; resource B<backgroundPixmap>.	179	command-line; for more details see resource B<backgroundPixmap>.
146		180
147	=item B<-cr> I<colour>	181	=item B<-cr> I<colour>
148		182
149	The cursor colour; resource B<cursorColor>.	183	The cursor colour; resource B<cursorColor>.
150		184
…		…
162	resource B<borderColor>.	196	resource B<borderColor>.
163		197
164	=item B<-fn> I<fontlist>	198	=item B<-fn> I<fontlist>
165		199
166	Select the fonts to be used. This is a comma separated list of font names	200	Select the fonts to be used. This is a comma separated list of font names
167	that are used in turn when trying to display Unicode characters. The	201	that are checked in order when trying to find glyphs for characters. The
168	first font defines the cell size for characters; other fonts might be	202	first font defines the cell size for characters; other fonts might be
169	smaller, but not (in general) larger. A (hopefully) reasonable default	203	smaller, but not (in general) larger. A (hopefully) reasonable default
170	font list is always appended to it. See resource B<font> for more details.	204	font list is always appended to it. See resource B<font> for more details.
171		205
172	In short, to specify an X11 core font, just specify it's name or prefix it	206	In short, to specify an X11 core font, just specify its name or prefix it
173	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,	207	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
174	e.g.:	208	e.g.:
175		209
176	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	210	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
177	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	211	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
179	See also the question "How does rxvt-unicode choose fonts?" in the FAQ	213	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
180	section of @@RXVT_NAME@@(7).	214	section of @@RXVT_NAME@@(7).
181		215
182	=item B<-fb> I<fontlist>	216	=item B<-fb> I<fontlist>
183		217
184	Compile font-styles: The bold font list to use when bold characters are to	218	Compile I<font-styles>: The bold font list to use when B<bold> characters
185	be printed. See resource B<boldFont> for details.	219	are to be printed. See resource B<boldFont> for details.
186		220
187	=item B<-fi> I<fontlist>	221	=item B<-fi> I<fontlist>
188		222
189	Compile font-styles: The italic font list to use when bold characters are to	223	Compile I<font-styles>: The italic font list to use when I<italic>
190	be printed. See resource B<italicFont> for details.	224	characters are to be printed. See resource B<italicFont> for details.
191		225
192	=item B<-fbi> I<fontlist>	226	=item B<-fbi> I<fontlist>
193		227
194	Compile font-styles: The bold italic font list to use when bold characters are to	228	Compile I<font-styles>: The bold italic font list to use when B<< I<bold
195	be printed. See resource B<boldItalicFont> for details.	229	italic> >> characters are to be printed. See resource B<boldItalicFont>
		230	for details.
		231
		232	=item B<-is>\|B<+is>
		233
		234	Compile I<font-styles>: Bold/Italic font styles imply high intensity
		235	foreground/background (default). See resource B<intensityStyles> for
		236	details.
196		237
197	=item B<-name> I<name>	238	=item B<-name> I<name>
198		239
199	Specify the application name under which resources are to be obtained,	240	Specify the application name under which resources are to be obtained,
200	rather than the default executable file name. Name should not contain	241	rather than the default executable file name. Name should not contain
…		…
279	=item B<-bl>	320	=item B<-bl>
280		321
281	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	322	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
282	if honoured by the WM, the rxvt-unicode window will not have window	323	if honoured by the WM, the rxvt-unicode window will not have window
283	decorations; resource B<borderLess>.	324	decorations; resource B<borderLess>.
		325
		326	=item B<-override-redirect>
		327
		328	Compile I<frills>: Sets override-redirect on the window; resource
		329	B<override-redirect>.
		330
		331	=item B<-sbg>
		332
		333	Compile I<frills>: Disable the usage of the built-in block graphics/line
		334	drawing characters and just rely on what the specified fonts provide. Use
		335	this if you have a good font and want to use its block graphic glyphs;
		336	resource B<skipBuiltinGlyphs>.
284		337
285	=item B<-lsp> I<number>	338	=item B<-lsp> I<number>
286		339
287	Compile I<frills>: Lines (pixel height) to insert between each row of	340	Compile I<frills>: Lines (pixel height) to insert between each row of
288	the display. Useful to work around font rendering problems; resource	341	the display. Useful to work around font rendering problems; resource
…		…
303	given on the command line. If this option is used, it must be the last	356	given on the command line. If this option is used, it must be the last
304	on the command-line. If there is no B<-e> option then the default is to	357	on the command-line. If there is no B<-e> option then the default is to
305	run the program specified by the B<SHELL> environment variable or,	358	run the program specified by the B<SHELL> environment variable or,
306	failing that, I<sh(1)>.	359	failing that, I<sh(1)>.
307		360
		361	Please note that you must specify a program with arguments. If you want to
		362	run shell commands, you have to specify the shell, like this:
		363
		364	@@RXVT_NAME@@ -e sh -c "shell commands"
		365
308	=item B<-title> I<text>	366	=item B<-title> I<text>
309		367
310	Window title (B<-T> still respected); the default title is the basename	368	Window title (B<-T> still respected); the default title is the basename
311	of the program specified after the B<-e> option, if any, otherwise the	369	of the program specified after the B<-e> option, if any, otherwise the
312	application name; resource B<title>.	370	application name; resource B<title>.
…		…
343	for more info.	401	for more info.
344		402
345	=item B<-tcw>	403	=item B<-tcw>
346		404
347	Change the meaning of triple-click selection with the left mouse	405	Change the meaning of triple-click selection with the left mouse
		406	button. Only effective when the original (non-perl) selection code is
348	button. Instead of selecting a full line it will extend the selection the	407	in-use. Instead of selecting a full line it will extend the selection the
349	end of the logical line only. resource B<tripleclickwords>.	408	end of the logical line only. resource B<tripleclickwords>.
350		409
351	=item B<-insecure>	410	=item B<-insecure>
352		411
353	Enable "insecure" mode, which currently enables most of the escape	412	Enable "insecure" mode, which currently enables most of the escape
…		…
368	=item B<-ssr>\|B<+ssr>	427	=item B<-ssr>\|B<+ssr>
369		428
370	Turn on/off secondary screen scroll (default enabled); resource	429	Turn on/off secondary screen scroll (default enabled); resource
371	B<secondaryScroll>.	430	B<secondaryScroll>.
372		431
		432	=item B<-hold>\|B<+hold>
		433
		434	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		435	will not immediately destroy its window when the program executed within
		436	it exits. Instead, it will wait till it is being killed or closed by the
		437	user; resource B<hold>.
		438
373	=item B<-keysym.>I<sym> I<string>	439	=item B<-keysym.>I<sym> I<string>
374		440
375	Remap a key symbol. See resource B<keysym>.	441	Remap a key symbol. See resource B<keysym>.
376		442
377	=item B<-embed> I<windowid>	443	=item B<-embed> I<windowid>
378		444
379	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,	445	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
380	which enables applications to easily embed a terminal.	446	which enables applications to easily embed a terminal.
381		447
382	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it	448	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
383	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it	449	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
384	quite a bit, so don't expect it to keep some specific state. It's best to	450	quite a bit, so don't expect it to keep some specific state. It's best to
…		…
387	The window will not be destroyed when @@RXVT_NAME@@ exits.	453	The window will not be destroyed when @@RXVT_NAME@@ exits.
388		454
389	It might be useful to know that @@RXVT_NAME@@ will not close file	455	It might be useful to know that @@RXVT_NAME@@ will not close file
390	descriptors passed to it (except for stdin/out/err, of course), so you	456	descriptors passed to it (except for stdin/out/err, of course), so you
391	can use file descriptors to communicate with the programs within the	457	can use file descriptors to communicate with the programs within the
392	terminal. This works regardless of wether the C<-embed> option was used or	458	terminal. This works regardless of whether the C<-embed> option was used or
393	not.	459	not.
394		460
395	Here is a short Gtk2-perl snippet that illustrates how this option can be	461	Here is a short Gtk2-perl snippet that illustrates how this option can be
396	used (a longer example is in F<doc/embed>):	462	used (a longer example is in F<doc/embed>):
397		463
…		…
399	$rxvt->signal_connect_after (realize => sub {	465	$rxvt->signal_connect_after (realize => sub {
400	my $xid = $_[0]->window->get_xid;	466	my $xid = $_[0]->window->get_xid;
401	system "@@RXVT_NAME@@ -embed $xid &";	467	system "@@RXVT_NAME@@ -embed $xid &";
402	});	468	});
403		469
404	=item B<-pty-fd> I<fileno>	470	=item B<-pty-fd> I<file descriptor>
405		471
406	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	472	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
407	pair but instead use the given filehandle as the tty master. This is	473	pair but instead use the given file descriptor as the tty master. This is
408	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator	474	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
409	without having to run a program within it.	475	without having to run a program within it.
410		476
411	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	477	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
412	entries and will not tinker with pty/tty permissions - you have to do that	478	entries and will not tinker with pty/tty permissions - you have to do that
413	yourself if you want that.	479	yourself if you want that.
		480
		481	As an extremely special case, specifying C<-1> will completely suppress
		482	pty/tty operations.
414		483
415	Here is a example in perl that illustrates how this option can be used (a	484	Here is a example in perl that illustrates how this option can be used (a
416	longer example is in F<doc/pty-fd>):	485	longer example is in F<doc/pty-fd>):
417		486
418	use IO::Pty;	487	use IO::Pty;
…		…
425		494
426	# now communicate with rxvt	495	# now communicate with rxvt
427	my $slave = $pty->slave;	496	my $slave = $pty->slave;
428	while (<$slave>) { print $slave "got <$_>\n" }	497	while (<$slave>) { print $slave "got <$_>\n" }
429		498
		499	=item B<-pe> I<string>
		500
		501	Comma-separated list of perl extension scripts to use (or not to use) in
		502	this terminal instance. See resource B<perl-ext> for details.
		503
430	=back	504	=back
431		505
432	=head1 RESOURCES (available also as long-options)	506	=head1 RESOURCES (available also as long-options)
433		507
434	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	508	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
435	options) compiled into your version.	509	options) compiled into your version.
436		510
437	There are two different methods that @@RXVT_NAME@@ can use to get the	511	You can set and change the resources using X11 tools like B<xrdb>. Many
438	Xresource data: using the X libraries (Xrm*-functions) or internal	512	distribution do also load settings from the B<~/.Xresources> file when X
439	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	513	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
440	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	514	with later settings overwriting earlier ones:
441	resources using X11 tools like B<xrdb>. Many distribution do also load
442	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
443	will consult the following files/resources in order, with later settings
444	overwriting earlier ones:
445		515
446	1. system-wide app-defaults file, either locale-dependent OR global	516	1. system-wide app-defaults file, either locale-dependent OR global
447	2. app-defaults file in $XAPPLRESDIR	517	2. app-defaults file in $XAPPLRESDIR
448	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	518	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
449	4. SCREEN_RESOURCES for the current screen	519	4. SCREEN_RESOURCES for the current screen
450	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	520	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
451		521
452	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
453	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
454	set in XAPPLOADDIR/URxvt (compile-time defined: usually
455	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
456	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
457	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	522	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
458	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows	523	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
459	resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be	524	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
460	easily configured, while the class name B<URxvt> allows resources	525	configured, while the class name B<URxvt> allows resources unique to
461	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	526	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
462	shared between different B<@@RXVT_NAME@@> configurations. If no	527	configurations. If no resources are specified, suitable defaults will
463	resources are specified, suitable defaults will be used. Command-line	528	be used. Command-line arguments can be used to override resource
464	arguments can be used to override resource settings. The following	529	settings. The following resources are supported (you might want to
465	resources are allowed:	530	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		531	extensions not documented here):
466		532
467	=over 4	533	=over 4
		534
		535	=item B<depth:> I<bitdepth>
		536
		537	Compile I<xft>: Attempt to find a visual with the given bit depth;
		538	option B<-depth>.
468		539
469	=item B<geometry:> I<geom>	540	=item B<geometry:> I<geom>
470		541
471	Create the window with the specified X window geometry [default 80x24];	542	Create the window with the specified X window geometry [default 80x24];
472	option B<-geometry>.	543	option B<-geometry>.
…		…
509	Use the specified colour to display underlined characters when the	580	Use the specified colour to display underlined characters when the
510	foreground colour is the default.	581	foreground colour is the default.
511		582
512	=item B<colorRV:> I<colour>	583	=item B<colorRV:> I<colour>
513		584
514	Use the specified colour as the background for reverse video	585	Use the specified colour as the background for reverse video characters
515	characters.	586	when OPTION_HC is disabled (--disable-frills).
516		587
517	=item B<underlineColor:> I<colour>	588	=item B<underlineColor:> I<colour>
518		589
519	If set, use the specified colour as the colour for the underline	590	If set, use the specified colour as the colour for the underline
520	itself. If unset, use the foreground colour.	591	itself. If unset, use the foreground colour.
…		…
546		617
547	B<True>: make the background inherit the parent windows' pixmap, giving	618	B<True>: make the background inherit the parent windows' pixmap, giving
548	artificial transparency. B<False>: do not inherit the parent windows'	619	artificial transparency. B<False>: do not inherit the parent windows'
549	pixmap.	620	pixmap.
550		621
		622	I<Please note that transparency of any kind if completely unsupported by
		623	the author. Don't bug him with installation questions!>
		624
551	=item B<fading:> I<number>	625	=item B<fading:> I<number>
552		626
553	Fade the text by the given percentage when focus is lost.	627	Fade the text by the given percentage when focus is lost; option B<-fade>.
		628
		629	=item B<fadeColor:> I<colour>
		630
		631	Fade to this colour, when fading is used (see B<fading:>). The default
		632	colour is black; option B<-fadecolor>.
554		633
555	=item B<tintColor:> I<colour>	634	=item B<tintColor:> I<colour>
556		635
557	Tint the transparent background pixmap with the given colour.	636	Tint the transparent background pixmap with the given colour; option
		637	B<-tint>.
558		638
559	=item B<shading:> I<number>	639	=item B<shading:> I<number>
560		640
561	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	641	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
562	image in addition to tinting it.	642	in addition to tinting it; option B<-sh>.
		643
		644	=item B<blendType:> I<string>
		645
		646	Specify background blending type; option B<-blt>.
		647
		648	=item B<blurRadius:> I<number>
		649
		650	Apply Gaussian Blurr with the specified radius to the transparent
		651	background image; option B<-blr>.
563		652
564	=item B<scrollColor:> I<colour>	653	=item B<scrollColor:> I<colour>
565		654
566	Use the specified colour for the scrollbar [default #B2B2B2].	655	Use the specified colour for the scrollbar [default #B2B2B2].
567		656
…		…
575	The colour of the border around the text area and between the scrollbar	664	The colour of the border around the text area and between the scrollbar
576	and the text.	665	and the text.
577		666
578	=item B<backgroundPixmap:> I<file[;geom]>	667	=item B<backgroundPixmap:> I<file[;geom]>
579		668
580	Use the specified XPM file (note the `.xpm' extension is optional) for	669	Use the specified image file for the background and also optionally
581	the background and also optionally specify its scaling with a geometry	670	specify its scaling with a geometry string B<WxH+X+Y>,
582	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	671	in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
583	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	672	and B<"X" / "Y"> locate the image centre (percent).
584	centre (percent). A scale of 0 displays the image with tiling. A scale	673	A scale of 0 displays the image with tiling. A scale of 1 displays the
585	of 1 displays the image without any scaling. A scale of 2 to 9	674	image without any scaling. A scale of 2 to 9 specifies an integer
586	specifies an integer number of images in that direction. No image will	675	number of images in that direction. No image will be magnified beyond
587	be magnified beyond 10 times its original size. The maximum permitted	676	10 times its original size. The maximum permitted scale is 1000.
588	scale is 1000. [default 0x0+50+50]	677	Special string of B<"auto"> used as a geometry will cause image to be
589		678	automatically scaled to match window size.
590	=item B<menu:> I<file[;tag]>	679	If used in conjunction with B<-tr> option - specified pixmap will be
591		680	blended over transparency image using either alpha-blending, or any
592	Read in the specified menu file (note the `.menu' extension is	681	other blending type, specified with B<-blt "type"> option.
593	optional) and also optionally specify a starting tag to find. See the	682	[default 0x0+50+50]
594	reference documentation for details on the syntax for the menuBar.
595		683
596	=item B<path:> I<path>	684	=item B<path:> I<path>
597		685
598	Specify the colon-delimited search path for finding files (XPM and	686	Specify the colon-delimited search path for finding XPM files.
599	menus), in addition to the paths specified by the B<RXVTPATH> and
600	B<PATH> environment variables.
601		687
602	=item B<font:> I<fontlist>	688	=item B<font:> I<fontlist>
603		689
604	Select the fonts to be used. This is a comma separated list of font	690	Select the fonts to be used. This is a comma separated list of font names
605	names that are used in turn when trying to display Unicode characters.	691	that are checked in order when trying to find glyphs for characters. The
606	The first font defines the cell size for characters; other fonts might	692	first font defines the cell size for characters; other fonts might be
607	be smaller, but not larger. A reasonable default font list is always	693	smaller, but not (in general) larger. A (hopefully) reasonable default
608	appended to it. option B<-fn>.	694	font list is always appended to it; option B<-fn>.
609		695
610	Each font can either be a standard X11 core font (XLFD) name, with	696	Each font can either be a standard X11 core font (XLFD) name, with
611	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.	697	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
612		698
613	In addition, each font can be prefixed with additional hints and	699	In addition, each font can be prefixed with additional hints and
…		…
615	hint currently is C<codeset=codeset-name>, and this is only used for Xft	701	hint currently is C<codeset=codeset-name>, and this is only used for Xft
616	fonts.	702	fonts.
617		703
618	For example, this font resource	704	For example, this font resource
619		705
620	URxvt*font: 9x15bold,\	706	URxvt.font: 9x15bold,\
621	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	707	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
622	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \	708	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
623	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	709	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
624	xft:Code2000:antialias=false	710	xft:Code2000:antialias=false
625		711
…		…
659	not possible, replacement fonts of the desired shape will be tried.	745	not possible, replacement fonts of the desired shape will be tried.
660		746
661	If set, but empty, then this specific style is disabled and the normal	747	If set, but empty, then this specific style is disabled and the normal
662	text font will being used for the given style.	748	text font will being used for the given style.
663		749
		750	=item B<intensityStyles:> I<boolean>
		751
		752	When font styles are not enabled, or this option is enabled (B<True>,
		753	option B<-is>, the default), bold and italic font styles imply high
		754	intensity foreground/background colours. Disabling this option (B<False>,
		755	option B<+is>) disables this behaviour, the high intensity colours are not
		756	reachable.
		757
664	=item B<selectstyle:> I<mode>	758	=item B<selectstyle:> I<mode>
665		759
666	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	760	Set mouse selection style to B<old> which is 2.20, B<oldword> which
667	xterm style with 2.20 old word selection, or anything else which gives	761	is xterm style with 2.20 old word selection, or anything else which
668	xterm style selection.	762	gives xterm style selection. Only effective when the original (non-perl)
		763	selection code is in use.
669		764
670	=item B<scrollstyle:> I<mode>	765	=item B<scrollstyle:> I<mode>
671		766
672	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	767	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
673	the author's favourite.	768	the author's favourite.
…		…
687	=item B<mapAlert:> I<boolean>	782	=item B<mapAlert:> I<boolean>
688		783
689	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	784	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
690	de-iconify (map) on receipt of a bell character [default].	785	de-iconify (map) on receipt of a bell character [default].
691		786
		787	=item B<urgentOnBell:> I<boolean>
		788
		789	B<True>: set the urgency hint for the wm on receipt of a bell character.
		790	B<False>: do not set the urgency hint [default].
		791
692	=item B<visualBell:> I<boolean>	792	=item B<visualBell:> I<boolean>
693		793
694	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	794	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
695	B<False>: no visual bell [default]; option B<+vb>.	795	B<False>: no visual bell [default]; option B<+vb>.
696		796
…		…
714		814
715	The string will be interpreted as if typed into the shell as-is.	815	The string will be interpreted as if typed into the shell as-is.
716		816
717	Example:	817	Example:
718		818
719	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	819	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
720		820
721	This creates a new file in your home directory with the screen contents	821	This creates a new file in your home directory with the screen contents
722	everytime you hit C<Print>.	822	every time you hit C<Print>.
723		823
724	=item B<scrollBar:> I<boolean>	824	=item B<scrollBar:> I<boolean>
725		825
726	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	826	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
727	disable the scrollbar; option B<+sb>.	827	disable the scrollbar; option B<+sb>.
…		…
749		849
750	=item B<scrollWithBuffer:> I<boolean>	850	=item B<scrollWithBuffer:> I<boolean>
751		851
752	B<True>: scroll with scrollback buffer when tty receives new lines (and	852	B<True>: scroll with scrollback buffer when tty receives new lines (and
753	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	853	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
754	with scrollback buffer when tty recieves new lines; option B<+sw>.	854	with scrollback buffer when tty receives new lines; option B<+sw>.
755		855
756	=item B<scrollTtyKeypress:> I<boolean>	856	=item B<scrollTtyKeypress:> I<boolean>
757		857
758	B<True>: scroll to bottom when a non-special key is pressed. Special keys	858	B<True>: scroll to bottom when a non-special key is pressed. Special keys
759	are those which are intercepted by rxvt-unicode for special handling and	859	are those which are intercepted by rxvt-unicode for special handling and
…		…
778	=item B<borderLess:> I<boolean>	878	=item B<borderLess:> I<boolean>
779		879
780	Set MWM hints to request a borderless window, i.e. if honoured by the	880	Set MWM hints to request a borderless window, i.e. if honoured by the
781	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.	881	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
782		882
		883	=item B<skipBuiltinGlyphs:> I<boolean>
		884
		885	Compile I<frills>: Disable the usage of the built-in block graphics/line
		886	drawing characters and just rely on what the specified fonts provide. Use
		887	this if you have a good font and want to use its block graphic glyphs;
		888	option B<-sbg>.
		889
783	=item B<termName:> I<termname>	890	=item B<termName:> I<termname>
784		891
785	Specifies the terminal type name to be set in the B<TERM> environment	892	Specifies the terminal type name to be set in the B<TERM> environment
786	variable; option B<-tn>.	893	variable; option B<-tn>.
787		894
…		…
842	pressed. If unset it will send the sequence traditionally associated	949	pressed. If unset it will send the sequence traditionally associated
843	with the B<Execute> key.	950	with the B<Execute> key.
844		951
845	=item B<cutchars:> I<string>	952	=item B<cutchars:> I<string>
846		953
847	The characters used as delimiters for double-click word selection. The	954	The characters used as delimiters for double-click word selection
848	built-in default:	955	(whitespace delimiting is added automatically if resource is given).
		956
		957	When the perl selection extension is in use (the default if compiled
		958	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		959	characters will be created (if the resource exists, otherwise, no regex
		960	will be created). In this mode, characters outside ISO-8859-1 can be used.
		961
		962	When the selection extension is not used, only ISO-8859-1 characters can
		963	be used. If not specified, the built-in default is used:
849		964
850	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	965	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>
851		966
852	=item B<preeditType:> I<style>	967	=item B<preeditType:> I<style>
853		968
…		…
860	=item B<imLocale:> I<name>	975	=item B<imLocale:> I<name>
861		976
862	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.	977	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
863	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the	978	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
864	input extension to be able to input japanese characters while staying in	979	input extension to be able to input japanese characters while staying in
865	another locale. option B<-imlocale>.	980	another locale; option B<-imlocale>.
866		981
867	=item B<imFont:> I<fontset>	982	=item B<imFont:> I<fontset>
868		983
869	Specify the font-set used for XIM styles C<OverTheSpot> or	984	Specify the font-set used for XIM styles C<OverTheSpot> or
870	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated	985	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
…		…
875		990
876	=item B<tripleclickwords:> I<boolean>	991	=item B<tripleclickwords:> I<boolean>
877		992
878	Change the meaning of triple-click selection with the left mouse	993	Change the meaning of triple-click selection with the left mouse
879	button. Instead of selecting a full line it will extend the selection to	994	button. Instead of selecting a full line it will extend the selection to
880	the end of the logical line only. option B<-tcw>.	995	the end of the logical line only; option B<-tcw>.
881		996
882	=item B<insecure:> I<boolean>	997	=item B<insecure:> I<boolean>
883		998
884	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	999	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
885	echo arbitrary strings like the icon name or the locale. This could be	1000	echo arbitrary strings like the icon name or the locale. This could be
886	abused if somebody gets 8-bit-clean access to your display, whether	1001	abused if somebody gets 8-bit-clean access to your display, whether
887	throuh a mail client displaying mail bodies unfiltered or though	1002	through a mail client displaying mail bodies unfiltered or through
888	write(1). Therefore, these sequences are disabled by default. (Note	1003	write(1) or any other means. Therefore, these sequences are disabled by
889	that other terminals, including xterm, have these sequences	1004	default. (Note that many other terminals, including xterm, have these
890	enabled by default). You can enable them by setting this boolean	1005	sequences enabled by default, which doesn't make it safer, though).
891	resource or specifying B<-insecure> as an option. At the moment, this	1006
892	enabled display-answer, locale, findfont, icon label and window title	1007	You can enable them by setting this boolean resource or specifying
893	requests as well as dynamic menubar dispatch.	1008	B<-insecure> as an option. At the moment, this enables display-answer,
		1009	locale, findfont, icon label and window title requests.
894		1010
895	=item B<modifier:> I<modifier>	1011	=item B<modifier:> I<modifier>
896		1012
897	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	1013	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
898	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	1014	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
902		1018
903	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	1019	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
904	character is passed through. It may contain escape values as described	1020	character is passed through. It may contain escape values as described
905	in the entry on B<keysym> following.	1021	in the entry on B<keysym> following.
906		1022
907	=item B<secondaryScreen:> I<bool>	1023	=item B<secondaryScreen:> I<boolean>
908		1024
909	Turn on/off secondary screen (default enabled).	1025	Turn on/off secondary screen (default enabled).
910		1026
911	=item B<secondaryScroll:> I<bool>	1027	=item B<secondaryScroll:> I<boolean>
912		1028
913	Turn on/off secondary screen scroll (default enabled). If the this	1029	Turn on/off secondary screen scroll (default enabled). If this
914	option is enabled, scrolls on the secondary screen will change the	1030	option is enabled, scrolls on the secondary screen will change the
915	scrollback buffer and switching to/from the secondary screen will	1031	scrollback buffer and switching to/from the secondary screen will
916	instead scroll the screen up.	1032	instead scroll the screen up.
		1033
		1034	=item B<hold>: I<boolean>
		1035
		1036	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		1037	will not immediately destroy its window when the program executed within
		1038	it exits. Instead, it will wait till it is being killed or closed by the
		1039	user.
917		1040
918	=item B<keysym.>I<sym>: I<string>	1041	=item B<keysym.>I<sym>: I<string>
919		1042
920	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1043	Compile I<frills>: Associate I<string> with keysym I<sym>. The
921	intervening resource name B<keysym.> cannot be omitted.	1044	intervening resource name B<keysym.> cannot be omitted.
…		…
939		1062
940	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1063	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
941	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1064	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
942	C<\000>: octal number) or verbatim control characters (C<^?>: delete,	1065	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
943	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it	1066	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
944	can start or end with whitespace.	1067	can start or end with whitespace. B<This feature is deprecated and will
		1068	be removed>.
945		1069
946	Please note that you need to double the C<\> when using	1070	Please note that you need to double the C<\> in resource files, as
947	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can	1071	Xlib itself does its own de-escaping (you can use C<\033> instead of
948	use C<\033> instead of C<\e> (and so on), which will work with both Xt and	1072	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
949	@@RXVT_NAME@@'s own processing).	1073	processing).
950		1074
951	You can define a range of keysyms in one shot by providing a I<string>	1075	You can define a range of keysyms in one shot by providing a I<string>
952	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1076	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
953	should be a character not used by the strings.	1077	should be a character not used by the strings.
954		1078
955	Its usage can be demonstrated by an example:	1079	Its usage can be demonstrated by an example:
956		1080
957	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1081	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
…		…
966	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1090	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
967	example the following means "change the current locale to C<zh_CN.GBK>	1091	example the following means "change the current locale to C<zh_CN.GBK>
968	when Control-Meta-c is being pressed":	1092	when Control-Meta-c is being pressed":
969		1093
970	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1094	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		1095
		1096	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1097	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1098	manpage. For example, the F<selection> extension (activated via
		1099	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1100
		1101	URxvt.keysym.M-C-c: perl:selection:rot13
971		1102
972	Due the the large number of modifier combinations, a defined key mapping	1103	Due the the large number of modifier combinations, a defined key mapping
973	will match if at I<at least> the specified identifiers are being set, and	1104	will match if at I<at least> the specified identifiers are being set, and
974	no other key mappings with those and more bits are being defined. That	1105	no other key mappings with those and more bits are being defined. That
975	means that defining a key map for C<a> will automatically provide	1106	means that defining a key map for C<a> will automatically provide
…		…
999	info):	1130	info):
1000		1131
1001	URxvt.keysym.M-C-3: command:\033[8;25;80t	1132	URxvt.keysym.M-C-3: command:\033[8;25;80t
1002	URxvt.keysym.M-C-4: command:\033[8;48;110t	1133	URxvt.keysym.M-C-4: command:\033[8;48;110t
1003		1134
		1135	=item B<perl-ext-common>: I<string>
		1136
		1137	=item B<perl-ext>: I<string>
		1138
		1139	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1140	use in this terminal instance; option B<-pe>.
		1141
		1142	Extension names can be prefixed with a C<-> sign to prohibit using
		1143	them. This can be useful to selectively disable some extensions loaded
		1144	by default, or specified via the C<perl-ext-common> resource. For
		1145	example, C<default,-selection> will use all the default extension except
		1146	C<selection>.
		1147
		1148	Extension names can also be followed by an argument in angle brackets
		1149	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1150	searchable scrollback to Alt/Meta-s). Mentioning the same extension
		1151	multiple times with different arguments will pass multiple arguments to
		1152	the extension.
		1153
		1154	Each extension is looked up in the library directories, loaded if
		1155	necessary, and bound to the current terminal instance.
		1156
		1157	If both of these resources are the empty string, then the perl
		1158	interpreter will not be initialized. The idea behind two options is that
		1159	B<perl-ext-common> will be used for extensions that should be available to
		1160	all instances, while B<perl-ext> is used for specific instances.
		1161
		1162	=item B<perl-eval>: I<string>
		1163
		1164	Perl code to be evaluated when all extensions have been registered. See
		1165	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
		1166	will be ignored when running setuid/setgid.
		1167
		1168	=item B<perl-lib>: I<path>
		1169
		1170	Colon-separated list of additional directories that hold extension
		1171	scripts. When looking for extensions specified by the C<perl> resource,
		1172	@@RXVT_NAME@@ will first look in these directories and then in
		1173	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
		1174	will be ignored when running setuid/setgid.
		1175
		1176	See the @@RXVT_NAME@@perl(3) manpage.
		1177
		1178	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1179
		1180	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1181	details.
		1182
		1183	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1184
		1185	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1186	for details.
		1187
		1188	=item B<searchable-scrollback:> I<keysym>
		1189
		1190	Sets the hotkey that starts the incremental scrollback buffer search
		1191	(default: C<M-s>).
		1192
		1193	=item B<urlLauncher>: I<string>
		1194
		1195	Specifies the program to be started with a URL argument. Used by the
		1196	C<selection-popup> and C<matcher> perl extensions.
		1197
		1198	=item B<transient-for>: I<windowid>
		1199
		1200	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1201
		1202	=item B<override-redirect>: I<boolean>
		1203
		1204	Compile I<frills>: Sets override-redirect for the terminal window, making
		1205	it almost invisible to window managers; option B<-override-redirect>.
		1206
		1207	=item B<iso14755_52:> I<boolean>
		1208
		1209	Turn on/off ISO 14755 5.2 mode (default enabled).
		1210
1004	=back	1211	=back
1005		1212
1006	=head1 THE SCROLLBAR	1213	=head1 THE SCROLLBAR
1007		1214
1008	Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window	1215	Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
…		…
1026	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1233	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1027	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1234	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1028	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1235	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1029	respectively.	1236	respectively.
1030		1237
1031	=head1 TEXT SELECTION AND INSERTION	1238	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1032		1239
1033	The behaviour of text selection and insertion mechanism is similar to	1240	The behaviour of text selection and insertion/pasting mechanism is similar
1034	I<xterm>(1).	1241	to I<xterm>(1).
1035		1242
1036	=over 4	1243	=over 4
1037		1244
1038	=item B<Selection>:	1245	=item B<Selecting>:
1039		1246
1040	Left click at the beginning of the region, drag to the end of the region	1247	Left click at the beginning of the region, drag to the end of the region
1041	and release; Right click to extend the marked region; Left double-click	1248	and release; Right click to extend the marked region; Left double-click
1042	to select a word; Left triple-click to select the entire logical line	1249	to select a word; Left triple-click to select the entire logical line
1043	(which can span multiple screen lines), unless modified by resource	1250	(which can span multiple screen lines), unless modified by resource
1044	B<tripleclickwords>.	1251	B<tripleclickwords>.
1045		1252
1046	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1253	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
1047	(Compile: I<frills>) will create a rectangular selection instead of a normal	1254	(Compile: I<frills>) will create a rectangular selection instead of a
1048	one.	1255	normal one. In this mode, every selected row becomes its own line in the
		1256	selection, and trailing whitespace is visually underlined and removed from
		1257	the selection.
1049		1258
1050	=item B<Insertion>:	1259	=item B<Pasting>:
1051		1260
1052	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1261	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1053	an B<@@RXVT_NAME@@> window causes the current text selection to be	1262	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1054	inserted as if it had been typed on the keyboard.	1263	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1264
		1265	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1266	inserted too.
1055		1267
1056	=back	1268	=back
1057		1269
1058	=head1 CHANGING FONTS	1270	=head1 CHANGING FONTS
1059		1271
1060	Changing fonts (or font sizes, respectively) via the keypad is not yet	1272	Changing fonts (or font sizes, respectively) via the keypad is not yet
1061	supported in rxvt-unicode. Bug me if you need this.	1273	supported in rxvt-unicode. Bug me if you need this.
1062		1274
1063	You can, however, switch fonts at runtime using escape sequences (and	1275	You can, however, switch fonts at runtime using escape sequences, e.g.:
1064	therefore using the menubar), e.g.:
1065		1276
1066	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1277	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1278
		1279	You can use keyboard shortcuts, too:
		1280
		1281	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1282	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1067		1283
1068	rxvt-unicode will automatically re-apply these fonts to the output so far.	1284	rxvt-unicode will automatically re-apply these fonts to the output so far.
1069		1285
1070	=head1 ISO 14755 SUPPORT	1286	=head1 ISO 14755 SUPPORT
1071		1287
…		…
1099	This mode lets you input characters representing the keycap symbols of	1315	This mode lets you input characters representing the keycap symbols of
1100	your keyboard, if representable in the current locale encoding.	1316	your keyboard, if representable in the current locale encoding.
1101		1317
1102	Start by pressing C<Control> and C<Shift> together, then releasing	1318	Start by pressing C<Control> and C<Shift> together, then releasing
1103	them. The next special key (cursor keys, home etc.) you enter will not	1319	them. The next special key (cursor keys, home etc.) you enter will not
1104	invoke it's usual function but instead will insert the corresponding	1320	invoke its usual function but instead will insert the corresponding
1105	keycap symbol. The symbol will only be entered when the key has been	1321	keycap symbol. The symbol will only be entered when the key has been
1106	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1322	released, otherwise pressing e.g. C<Shift> would enter the symbol for
1107	C<ISO Level 2 Switch>, although your intention might have been to enter a	1323	C<ISO Level 2 Switch>, although your intention might have been to enter a
1108	reverse tab (Shift-Tab).	1324	reverse tab (Shift-Tab).
1109		1325
…		…
1142	=head1 COLORS AND GRAPHICS	1358	=head1 COLORS AND GRAPHICS
1143		1359
1144	In addition to the default foreground and background colours,	1360	In addition to the default foreground and background colours,
1145	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1361	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1146	high-intensity bold/blink versions of the same). Here is a list of the	1362	high-intensity bold/blink versions of the same). Here is a list of the
1147	colours with their B<rgb.txt> names.	1363	colours with their names.
1148		1364
1149	=begin table	1365	=begin table
1150		1366
1151	B<color0> (black) = Black	1367	B<color0> (black) = Black
1152	B<color1> (red) = Red3	1368	B<color1> (red) = Red3
…		…
1172	It is also possible to specify the colour values of B<foreground>,	1388	It is also possible to specify the colour values of B<foreground>,
1173	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1389	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1174	a number 0-15, as a convenient shorthand to reference the colour name of	1390	a number 0-15, as a convenient shorthand to reference the colour name of
1175	color0-color15.	1391	color0-color15.
1176		1392
		1393	In addition to the colours defined above, @@RXVT_NAME@@ offers an
		1394	additional 72 colours. The first 64 of those (with indices 16 to 79)
		1395	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
		1396	16>), followed by 8 additional shades of gray (with indices 80 to 87).
		1397
		1398	Together, all those colours implement the 88 colour xterm colours. Only
		1399	the first 16 can be changed using resources currently, the rest can only
		1400	be changed via command sequences ("escape codes").
		1401
1177	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1402	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1178	always swapping the foreground/background colours. This is in contrast to	1403	always swapping the foreground/background colours. This is in contrast to
1179	I<xterm>(1) where the colours are only swapped if they have not otherwise	1404	I<xterm>(1) where the colours are only swapped if they have not otherwise
1180	been specified. For example,	1405	been specified. For example,
1181		1406
…		…
1186	would yield White on Black, while on I<xterm>(1) it would yield Black	1411	would yield White on Black, while on I<xterm>(1) it would yield Black
1187	on White.	1412	on White.
1188		1413
1189	=back	1414	=back
1190		1415
		1416	=head2 ALPHA CHANNEL SUPPORT
		1417
		1418	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1419	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
		1420	(recommended, but B<MUST> have 4 digits/component) colour specifications,
		1421	in addition to the ones provided by X, where the additional A component
		1422	specifies opacity (alpha) values. The minimum value of C<0> is completely
		1423	transparent). You can also prefix any color with C<[percent]>, where
		1424	C<percent> is a decimal percentage (0-100) that specifies the opacity of
		1425	the color, where C<0> is completely transparent and C<100> is completelxy
		1426	opaque.
		1427
		1428	You probably need to specify B<"-depth 32">, too, and have the luck that
		1429	your X-server uses ARGB pixel layout, as X is far from just supporting
		1430	ARGB visuals out of the box, and rxvt-unicode just fudges around.
		1431
		1432	For example, the following selects an almost completely transparent red
		1433	background, and an almost opaque pink foreground:
		1434
		1435	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
		1436
		1437	I<Please note that transparency of any kind if completely unsupported by
		1438	the author. Don't bug him with installation questions!>
		1439
1191	=head1 ENVIRONMENT	1440	=head1 ENVIRONMENT
1192		1441
1193	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1442	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1194		1443
1195	=over 4	1444	=over 4
1196		1445
1197	=item B<TERM>	1446	=item B<TERM>
1198		1447
1199	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1448	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1200	resources or on the commandline.	1449	resources or on the command line.
1201		1450
1202	=item B<COLORTERM>	1451	=item B<COLORTERM>
1203		1452
1204	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1453	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1205	compiled with XPM support, and optionally with the added extension	1454	compiled with XPM support, and optionally with the added extension
1206	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1455	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1207		1456
1208	=item B<COLORFGBG>	1457	=item B<COLORFGBG>
1209		1458
…		…
1227	C<--with-terminfo=PATH>.	1476	C<--with-terminfo=PATH>.
1228		1477
1229	=item B<DISPLAY>	1478	=item B<DISPLAY>
1230		1479
1231	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1480	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1232	display in it's child processes.	1481	display in its child processes.
1233		1482
1234	=item B<SHELL>	1483	=item B<SHELL>
1235		1484
1236	The shell to be used for command execution, defaults to C</bin/sh>.	1485	The shell to be used for command execution, defaults to C</bin/sh>.
1237
1238	=item B<RXVTPATH>
1239
1240	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1241	files.
1242
1243	=item B<PATH>
1244
1245	Used in the same way as C<RXVTPATH>.
1246		1486
1247	=item B<RXVT_SOCKET>	1487	=item B<RXVT_SOCKET>
1248		1488
1249	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1489	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1250	@@RXVT_NAME@@d(1).	1490	@@RXVT_NAME@@d(1).
1251		1491
1252	Default C<< $HOME/.rxvt-unicode-<nodename >>.	1492	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1253		1493
1254	=item B<HOME>	1494	=item B<HOME>
1255		1495
1256	Used to locate the default directory for the unix domain socket for	1496	Used to locate the default directory for the unix domain socket for
1257	daemon communications and to locate various resource files (such as	1497	daemon communications and to locate various resource files (such as
…		…
1278		1518
1279	=back	1519	=back
1280		1520
1281	=head1 SEE ALSO	1521	=head1 SEE ALSO
1282		1522
1283	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1523	@@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)
1284
1285	=head1 BUGS
1286
1287	Check the BUGS file for an up-to-date list.
1288
1289	Cursor change support is not yet implemented.
1290
1291	Click-and-drag doesn't work with X11 mouse report overriding.
1292		1524
1293	=head1 CURRENT PROJECT COORDINATOR	1525	=head1 CURRENT PROJECT COORDINATOR
1294		1526
1295	=over 4	1527	=over 4
1296		1528
1297	=item Project Coordinator	1529	=item Project Coordinator
1298		1530
1299	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1531	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1300		1532
1301	L<http://software.schmorp.de/#rxvt-unicode>	1533	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1302		1534
1303	=back	1535	=back
1304		1536
1305	=head1 AUTHORS	1537	=head1 AUTHORS
1306		1538
…		…
1328		1560
1329	Project Coordinator (changes.txt 2.21a to 2.4.5)	1561	Project Coordinator (changes.txt 2.21a to 2.4.5)
1330		1562
1331	=item Geoff Wing L<< <gcw@pobox.com> >>	1563	=item Geoff Wing L<< <gcw@pobox.com> >>
1332		1564
1333	Rewrote screen display and text selection routines. Project Coordinator	1565	Rewrote screen display and text selection routines.
		1566
1334	(changes.txt 2.4.6 - rxvt-unicode)	1567	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1335		1568
1336	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1569	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1337		1570
1338	Forked rxvt-unicode, rewrote most of the display code and internal	1571	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1339	character handling to store text in unicode, improve xterm	1572	extension, random hacks, numerous bugfixes and extensions.
1340	compatibility and apply numerous other bugfixes and extensions.
1341		1573
1342	Project Coordinator (Changes 1.0 -)	1574	Project Coordinator (Changes 1.0 -)
1343		1575
		1576	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1577
		1578	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
		1579
1344	=back	1580	=back
1345		1581

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.66 by root, Thu Jun 30 14:02:17 2005 UTC vs. Revision 1.131 by ayin, Sat Jun 9 09:05:38 2007 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.66 by root, Thu Jun 30 14:02:17 2005 UTC vs.
Revision 1.131 by ayin, Sat Jun 9 09:05:38 2007 UTC