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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.85 by root, Wed Jan 4 20:43:37 2006 UTC vs.
Revision 1.154 by ayin, Fri Dec 14 09:06:36 2007 UTC

…		…
12	emulator intended as an I<xterm>(1) replacement for users who do not	12	emulator intended as an I<xterm>(1) replacement for users who do not
13	require features such as Tektronix 4014 emulation and toolkit-style	13	require features such as Tektronix 4014 emulation and toolkit-style
14	configurability. As a result, B<rxvt-unicode> uses much less swap space --	14	configurability. As a result, B<rxvt-unicode> uses much less swap space --
15	a significant advantage on a machine serving many X sessions.	15	a significant advantage on a machine serving many X sessions.
16		16
		17	This document is also available on the World-Wide-Web at
		18	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
		19
17	=head1 FREQUENTLY ASKED QUESTIONS	20	=head1 FREQUENTLY ASKED QUESTIONS
18		21
19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of	22	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20	frequently asked questions and answer to them and some common	23	frequently asked questions and answer to them and some common
21	problems. That document is also accessible on the World-Wide-Web at	24	problems. That document is also accessible on the World-Wide-Web at
22	L<http://cvs.schmorp.de/browse/checkout/rxvt-unicode/doc/rxvt.7.html>.	25	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23		26
24	=head1 RXVT-UNICODE VS. RXVT	27	=head1 RXVT-UNICODE VS. RXVT
25		28
26	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode	29	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27	internally. That means it can store and display most scripts in the	30	internally. That means it can store and display most scripts in the
28	world. Being a terminal emulator, however, some things are very difficult,	31	world. Being a terminal emulator, however, some things are very difficult,
29	especially cursive scripts such as arabic, vertically written scripts	32	especially cursive scripts such as arabic, vertically written scripts
30	like mongolian or scripts requiring extremely complex combining rules,	33	like mongolian or scripts requiring extremely complex combining rules,
31	like tibetan or devenagari. Don't expect pretty output when using these	34	like tibetan or devanagari. Don't expect pretty output when using these
32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	35	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33	fine, though. A somewhat difficult case are left-to-right scripts, such	36	fine, though. A somewhat difficult case are right-to-left scripts, such
34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	37	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35	belong into the application, not the terminal emulator (too many things --	38	belong in the application, not the terminal emulator (too many things --
36	such as cursor-movement while editing -- break otherwise), but that might	39	such as cursor-movement while editing -- break otherwise), but that might
37	change.	40	change.
38		41
39	If you are looking for a terminal that supports more exotic scripts, let	42	If you are looking for a terminal that supports more exotic scripts, let
40	me recommend C<mlterm>, which is a very userfriendly, lean and clean	43	me recommend C<mlterm>, which is a very user friendly, lean and clean
41	terminal emulator. In fact, the reason rxvt-unicode was born was solely	44	terminal emulator. In fact, the reason rxvt-unicode was born was solely
42	because the author couldn't get C<mlterm> to use one font for latin1 and	45	because the author couldn't get C<mlterm> to use one font for latin1 and
43	another for japanese.	46	another for japanese.
44		47
45	Therefore another design rationale was the use of multiple fonts to	48	Therefore another design rationale was the use of multiple fonts to
46	display characters: The idea of a single unicode font which many other	49	display characters: The idea of a single unicode font which many other
47	programs force onto it's users never made sense to me: You should be able	50	programs force onto its users never made sense to me: You should be able
48	to choose any font for any script freely.	51	to choose any font for any script freely.
49		52
50	Apart from that, rxvt-unicode is also much better internationalised than	53	Apart from that, rxvt-unicode is also much better internationalised than
51	it's predecessor, supports things such as XFT and ISO 14755 that are handy	54	its predecessor, supports things such as XFT and ISO 14755 that are handy
52	in i18n-environments, is faster, and has a lot less bugs than the original	55	in i18n-environments, is faster, and has a lot bugs less than the original
53	rxvt. This all in addition to dozens of other small improvements.	56	rxvt. This all in addition to dozens of other small improvements.
54		57
55	It is still faithfully following the original rxvt idea of being lean	58	It is still faithfully following the original rxvt idea of being lean
56	and nice on resources: for example, you can still configure rxvt-unicode	59	and nice on resources: for example, you can still configure rxvt-unicode
57	without most of it's features to get a lean binary. It also comes with	60	without most of its features to get a lean binary. It also comes with
58	a client/daemon pair that lets you open any number of terminal windows	61	a client/daemon pair that lets you open any number of terminal windows
59	from within a single process, which makes startup time very fast and	62	from within a single process, which makes startup time very fast and
60	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and	63	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
61	@@RXVT_NAME@@c(1) (client).	64	@@RXVT_NAME@@c(1) (client).
62		65
63	It also makes technical information about escape sequences (which have	66	It also makes technical information about escape sequences (which have
64	been extended) easier accessible: see @@RXVT_NAME@@(7) for technical	67	been extended) more accessible: see @@RXVT_NAME@@(7) for technical
65	reference documentation (escape sequences etc.).	68	reference documentation (escape sequences etc.).
66		69
67	=head1 OPTIONS	70	=head1 OPTIONS
68		71
69	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed	72	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
…		…
93		96
94	Attempt to open a window on the named X display (B<-d> still	97	Attempt to open a window on the named X display (B<-d> still
95	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
96	B<DISPLAY> environment variable is used.	99	B<DISPLAY> environment variable is used.
97		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
98	=item B<-geometry> I<geom>	106	=item B<-geometry> I<geom>
99		107
100	Window geometry (B<-g> still respected); resource B<geometry>.	108	Window geometry (B<-g> still respected); resource B<geometry>.
101		109
102	=item B<-rv>\|B<+rv>	110	=item B<-rv>\|B<+rv>
103		111
104	Turn on/off simulated reverse video; resource B<reverseVideo>.	112	Turn on/off simulated reverse video; resource B<reverseVideo>.
105		113
106	=item B<-j>\|B<+j>	114	=item B<-j>\|B<+j>
107		115
108	Turn on/off jump scrolling; resource B<jumpScroll>.	116	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
109		117
110	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>	118	=item B<-ss>\|B<+ss>
111		119
112	Turn on/off inheriting parent window's pixmap. Alternative form is	120	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
113	B<-tr>; resource B<inheritPixmap>.	121
		122	=item B<-tr>\|B<+tr>
		123
		124	Turn on/off illusion of a transparent window background; resource B<transparent>.
		125
		126	B<-ip> is still accepted as an obsolete alias but will be removed in
		127	future versions.
		128
		129	I<Please address all transparency related issues to Sasha Vasko at
		130	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
114		131
115	=item B<-fade> I<number>	132	=item B<-fade> I<number>
116		133
117	Fade the text by the given percentage when focus is lost. Small values	134	Fade the text by the given percentage when focus is lost. Small values
118	fade a little only, 100 completely replaces all colours by the fade	135	fade a little only, 100 completely replaces all colours by the fade
119	colour; resource B<fading>.	136	colour; resource B<fading>.
120		137
121	=item B<-fadecolor> I<colour>	138	=item B<-fadecolor> I<colour>
122		139
123	Fade to this colour when fading is used (see B<-fade>). The default colour	140	Fade to this colour when fading is used (see B<-fade>). The default colour
124	is black. resource B<fadeColor>.	141	is opaque black. resource B<fadeColor>.
125		142
126	=item B<-tint> I<colour>	143	=item B<-tint> I<colour>
127		144
128	Tint the transparent background pixmap with the given colour when	145	Tint the transparent background pixmap with the given colour when
129	transparency is enabled with B<-tr> or B<-ip>. This only works for	146	transparency is enabled with B<-tr>. This only works for
130	non-tiled backgrounds, currently. See also the B<-sh> option that can be	147	non-tiled backgrounds, currently. See also the B<-sh> option that can be
131	used to brighten or darken the image in addition to tinting it; resource	148	used to brighten or darken the image in addition to tinting it.
		149	Please note that certain tint colours can be applied on the server-side,
		150	thus yielding performance gain of two orders of magnitude. These colours are:
		151	blue, red, green, cyan, magenta, yellow, and those close to them. Also
		152	pure black and pure white colors essentially mean no tinting; resource
132	I<tintColor>. Example:	153	I<tintColor>. Example:
133		154
134	@@RXVT_NAME@@ -tr -tint blue -sh 40	155	@@RXVT_NAME@@ -tr -tint blue -sh 40
135		156
136	=item B<-sh>	157	=item B<-sh> I<number>
137		158
138	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	159	Darken (0 .. 100) or lighten (100 .. 200) the transparent
139	background image in addition to tinting it (i.e. B<-tint> must be	160	background image in addition to (or instead of) tinting it;
140	specified, too, e.g. C<-tint white>).	161	resource I<shading>.
		162
		163	=item B<-blt> I<string>
		164
		165	Specify background blending type. If background pixmap is specified
		166	at the same time as transparency - such pixmap will be blended over
		167	transparency image, using method specified. Supported values are :
		168	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
		169	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
		170	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
		171	alpha-blending. Compile I<afterimage>; resource I<blendType>.
		172
		173	=item B<-blr> I<HxV>
		174
		175	Apply Gaussian Blur with the specified radii to the transparent
		176	background image. If single number is specified - both vertical and
		177	horizontal radii are considered to be the same. Setting one of the
		178	radii to 1 and another to a large number creates interesting effects
		179	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
		180	resource I<blurRadius>.
141		181
142	=item B<-bg> I<colour>	182	=item B<-bg> I<colour>
143		183
144	Window background colour; resource B<background>.	184	Window background colour; resource B<background>.
145		185
146	=item B<-fg> I<colour>	186	=item B<-fg> I<colour>
147		187
148	Window foreground colour; resource B<foreground>.	188	Window foreground colour; resource B<foreground>.
149		189
150	=item B<-pixmap> I<file[;geom]>	190	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
151		191
152	Compile I<XPM>: Specify XPM file for the background and also optionally	192	Compile I<afterimage>: Specify image file for the background and also
153	specify its scaling with a geometry string. Note you may need to	193	optionally specify its scaling with a geometry string. Note you may need to
154	add quotes to avoid special shell interpretation of the C<;> in the	194	add quotes to avoid special shell interpretation of the C<;> in the
155	command-line; resource B<backgroundPixmap>.	195	command-line; for more details see resource B<backgroundPixmap>.
156		196
157	=item B<-cr> I<colour>	197	=item B<-cr> I<colour>
158		198
159	The cursor colour; resource B<cursorColor>.	199	The cursor colour; resource B<cursorColor>.
160		200
…		…
172	resource B<borderColor>.	212	resource B<borderColor>.
173		213
174	=item B<-fn> I<fontlist>	214	=item B<-fn> I<fontlist>
175		215
176	Select the fonts to be used. This is a comma separated list of font names	216	Select the fonts to be used. This is a comma separated list of font names
177	that are used in turn when trying to display Unicode characters. The	217	that are checked in order when trying to find glyphs for characters. The
178	first font defines the cell size for characters; other fonts might be	218	first font defines the cell size for characters; other fonts might be
179	smaller, but not (in general) larger. A (hopefully) reasonable default	219	smaller, but not (in general) larger. A (hopefully) reasonable default
180	font list is always appended to it. See resource B<font> for more details.	220	font list is always appended to it. See resource B<font> for more details.
181		221
182	In short, to specify an X11 core font, just specify it's name or prefix it	222	In short, to specify an X11 core font, just specify its name or prefix it
183	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,	223	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184	e.g.:	224	e.g.:
185		225
186	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	226	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	227	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
205	italic> >> characters are to be printed. See resource B<boldItalicFont>	245	italic> >> characters are to be printed. See resource B<boldItalicFont>
206	for details.	246	for details.
207		247
208	=item B<-is>\|B<+is>	248	=item B<-is>\|B<+is>
209		249
210	Compile I<font-styles>: Bold/Italic font styles imply high intensity	250	Compile I<font-styles>: Bold/Blink font styles imply high intensity
211	foreground/background (default). See resource B<intensityStyles> for	251	foreground/background (default). See resource B<intensityStyles> for
212	details.	252	details.
213		253
214	=item B<-name> I<name>	254	=item B<-name> I<name>
215		255
…		…
297		337
298	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	338	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
299	if honoured by the WM, the rxvt-unicode window will not have window	339	if honoured by the WM, the rxvt-unicode window will not have window
300	decorations; resource B<borderLess>.	340	decorations; resource B<borderLess>.
301		341
		342	=item B<-override-redirect>
		343
		344	Compile I<frills>: Sets override-redirect on the window; resource
		345	B<override-redirect>.
		346
302	=item B<-sbg>	347	=item B<-sbg>
303		348
304	Compile I<frills>: Disable the usage of the built-in block graphics/line	349	Compile I<frills>: Disable the usage of the built-in block graphics/line
305	drawing characters and just rely on what the specified fonts provide. Use	350	drawing characters and just rely on what the specified fonts provide. Use
306	this if you have a good font and want to use its block graphic glyphs;	351	this if you have a good font and want to use its block graphic glyphs;
…		…
308		353
309	=item B<-lsp> I<number>	354	=item B<-lsp> I<number>
310		355
311	Compile I<frills>: Lines (pixel height) to insert between each row of	356	Compile I<frills>: Lines (pixel height) to insert between each row of
312	the display. Useful to work around font rendering problems; resource	357	the display. Useful to work around font rendering problems; resource
313	B<linespace>.	358	B<lineSpace>.
314		359
315	=item B<-tn> I<termname>	360	=item B<-tn> I<termname>
316		361
317	This option specifies the name of the terminal type to be set in the	362	This option specifies the name of the terminal type to be set in the
318	B<TERM> environment variable. This terminal type must exist in the	363	B<TERM> environment variable. This terminal type must exist in the
…		…
372	for more info.	417	for more info.
373		418
374	=item B<-tcw>	419	=item B<-tcw>
375		420
376	Change the meaning of triple-click selection with the left mouse	421	Change the meaning of triple-click selection with the left mouse
		422	button. Only effective when the original (non-perl) selection code is
377	button. Instead of selecting a full line it will extend the selection the	423	in-use. Instead of selecting a full line it will extend the selection to
378	end of the logical line only. resource B<tripleclickwords>.	424	the end of the logical line only. resource B<tripleclickwords>.
379		425
380	=item B<-insecure>	426	=item B<-insecure>
381		427
382	Enable "insecure" mode, which currently enables most of the escape	428	Enable "insecure" mode, which currently enables most of the escape
383	sequences that echo strings. See the resource B<insecure> for more	429	sequences that echo strings. See the resource B<insecure> for more
…		…
404	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	450	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
405	will not immediately destroy its window when the program executed within	451	will not immediately destroy its window when the program executed within
406	it exits. Instead, it will wait till it is being killed or closed by the	452	it exits. Instead, it will wait till it is being killed or closed by the
407	user; resource B<hold>.	453	user; resource B<hold>.
408		454
		455	=item B<-xrm> I<string>
		456
		457	Works like the X Toolkit option of the same name, by adding the I<string>
		458	as if it were specified in a resource file. Resource values specified this
		459	way take precedence over all other resource specifications.
		460
		461	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		462	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		463	options can be specified as long-options on the commandline, so use
		464	of B<-xrm> is mostly limited to cases where you want to specify other
		465	resources (e.g. for input methods) or for compatibility with other
		466	programs.
		467
409	=item B<-keysym.>I<sym> I<string>	468	=item B<-keysym.>I<sym> I<string>
410		469
411	Remap a key symbol. See resource B<keysym>.	470	Remap a key symbol. See resource B<keysym>.
412		471
413	=item B<-embed> I<windowid>	472	=item B<-embed> I<windowid>
414		473
415	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,	474	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
416	which enables applications to easily embed a terminal.	475	which enables applications to easily embed a terminal.
417		476
418	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it	477	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
419	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it	478	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
420	quite a bit, so don't expect it to keep some specific state. It's best to	479	quite a bit, so don't expect it to keep some specific state. It's best to
…		…
423	The window will not be destroyed when @@RXVT_NAME@@ exits.	482	The window will not be destroyed when @@RXVT_NAME@@ exits.
424		483
425	It might be useful to know that @@RXVT_NAME@@ will not close file	484	It might be useful to know that @@RXVT_NAME@@ will not close file
426	descriptors passed to it (except for stdin/out/err, of course), so you	485	descriptors passed to it (except for stdin/out/err, of course), so you
427	can use file descriptors to communicate with the programs within the	486	can use file descriptors to communicate with the programs within the
428	terminal. This works regardless of wether the C<-embed> option was used or	487	terminal. This works regardless of whether the C<-embed> option was used or
429	not.	488	not.
430		489
431	Here is a short Gtk2-perl snippet that illustrates how this option can be	490	Here is a short Gtk2-perl snippet that illustrates how this option can be
432	used (a longer example is in F<doc/embed>):	491	used (a longer example is in F<doc/embed>):
433		492
…		…
435	$rxvt->signal_connect_after (realize => sub {	494	$rxvt->signal_connect_after (realize => sub {
436	my $xid = $_[0]->window->get_xid;	495	my $xid = $_[0]->window->get_xid;
437	system "@@RXVT_NAME@@ -embed $xid &";	496	system "@@RXVT_NAME@@ -embed $xid &";
438	});	497	});
439		498
440	=item B<-pty-fd> I<fileno>	499	=item B<-pty-fd> I<file descriptor>
441		500
442	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	501	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
443	pair but instead use the given filehandle as the tty master. This is	502	pair but instead use the given file descriptor as the tty master. This is
444	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator	503	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
445	without having to run a program within it.	504	without having to run a program within it.
446		505
447	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	506	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
448	entries and will not tinker with pty/tty permissions - you have to do that	507	entries and will not tinker with pty/tty permissions - you have to do that
449	yourself if you want that.	508	yourself if you want that.
		509
		510	As an extremely special case, specifying C<-1> will completely suppress
		511	pty/tty operations, which is probably only useful in conjunction with some
		512	perl extension that manages the terminal.
450		513
451	Here is a example in perl that illustrates how this option can be used (a	514	Here is a example in perl that illustrates how this option can be used (a
452	longer example is in F<doc/pty-fd>):	515	longer example is in F<doc/pty-fd>):
453		516
454	use IO::Pty;	517	use IO::Pty;
…		…
463	my $slave = $pty->slave;	526	my $slave = $pty->slave;
464	while (<$slave>) { print $slave "got <$_>\n" }	527	while (<$slave>) { print $slave "got <$_>\n" }
465		528
466	=item B<-pe> I<string>	529	=item B<-pe> I<string>
467		530
468	Colon-separated list of perl extension scripts to use in this terminal	531	Comma-separated list of perl extension scripts to use (or not to use) in
469	instance. See resource B<perl-ext>.	532	this terminal instance. See resource B<perl-ext> for details.
470		533
471	=back	534	=back
472		535
473	=head1 RESOURCES (available also as long-options)	536	=head1 RESOURCES
474		537
475	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	538	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
476	options) compiled into your version.	539	options) compiled into your version. All resources are also available as
		540	long-options.
477		541
478	There are two different methods that @@RXVT_NAME@@ can use to get the	542	You can set and change the resources using X11 tools like B<xrdb>. Many
479	Xresource data: using the X libraries (Xrm*-functions) or internal	543	distribution do also load settings from the B<~/.Xresources> file when X
480	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	544	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
481	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	545	with later settings overwriting earlier ones:
482	resources using X11 tools like B<xrdb>. Many distribution do also load
483	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
484	will consult the following files/resources in order, with later settings
485	overwriting earlier ones:
486		546
487	1. system-wide app-defaults file, either locale-dependent OR global	547	1. system-wide app-defaults file, either locale-dependent OR global
488	2. app-defaults file in $XAPPLRESDIR	548	2. app-defaults file in $XAPPLRESDIR
489	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	549	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
490	4. SCREEN_RESOURCES for the current screen	550	4. SCREEN_RESOURCES for the current screen
491	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	551	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		552	6. resources specified via -xrm on the commandline
492		553
493	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
494	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
495	set in XAPPLOADDIR/URxvt (compile-time defined: usually
496	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
497	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
498	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	554	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
499	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows	555	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
500	resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be	556	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
501	easily configured, while the class name B<URxvt> allows resources	557	configured, while the class name B<URxvt> allows resources unique to
502	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	558	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
503	shared between different B<@@RXVT_NAME@@> configurations. If no	559	configurations. If no resources are specified, suitable defaults will
504	resources are specified, suitable defaults will be used. Command-line	560	be used. Command-line arguments can be used to override resource
505	arguments can be used to override resource settings. The following	561	settings. The following resources are supported (you might want to
506	resources are allowed:	562	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		563	extensions not documented here):
507		564
508	=over 4	565	=over 4
		566
		567	=item B<depth:> I<bitdepth>
		568
		569	Compile I<xft>: Attempt to find a visual with the given bit depth;
		570	option B<-depth>.
509		571
510	=item B<geometry:> I<geom>	572	=item B<geometry:> I<geom>
511		573
512	Create the window with the specified X window geometry [default 80x24];	574	Create the window with the specified X window geometry [default 80x24];
513	option B<-geometry>.	575	option B<-geometry>.
…		…
550	Use the specified colour to display underlined characters when the	612	Use the specified colour to display underlined characters when the
551	foreground colour is the default.	613	foreground colour is the default.
552		614
553	=item B<colorRV:> I<colour>	615	=item B<colorRV:> I<colour>
554		616
555	Use the specified colour as the background for reverse video	617	Use the specified colour as the background for reverse video characters
556	characters.	618	when OPTION_HC is disabled (--disable-frills).
557		619
558	=item B<underlineColor:> I<colour>	620	=item B<underlineColor:> I<colour>
559		621
560	If set, use the specified colour as the colour for the underline	622	If set, use the specified colour as the colour for the underline
561	itself. If unset, use the foreground colour.	623	itself. If unset, use the foreground colour.
…		…
577	option B<-rv>. B<False>: regular screen colours [default]; option	639	option B<-rv>. B<False>: regular screen colours [default]; option
578	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	640	B<+rv>. See note in B<COLORS AND GRAPHICS> section.
579		641
580	=item B<jumpScroll:> I<boolean>	642	=item B<jumpScroll:> I<boolean>
581		643
582	B<True>: specify that jump scrolling should be used. When scrolling	644	B<True>: specify that jump scrolling should be used. When receiving lots
583	quickly, fewer screen updates are performed [default]; option B<-j>.	645	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		646	has been read, resulting in fewer updates while still displaying every
		647	received line; option B<-j>.
		648
584	B<False>: specify that smooth scrolling should be used; option B<+j>.	649	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		650	force a screen refresh on each new line it received; option B<+j>.
585		651
586	=item B<inheritPixmap:> I<boolean>	652	=item B<skipScroll:> I<boolean>
587		653
588	B<True>: make the background inherit the parent windows' pixmap, giving	654	B<True>: (the default) specify that skip scrolling should be used. When
589	artificial transparency. B<False>: do not inherit the parent windows'	655	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
590	pixmap.	656	(around 60 times per second), resulting in far fewer updates. This can
		657	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		658	option B<-ss>.
		659
		660	B<False>: specify that everything is to be displayed, even
		661	if the refresh is too fast for the human eye to read anything (or the
		662	monitor to display anything); option B<+ss>.
		663
		664	=item B<transparent:> I<boolean>
		665
		666	Turn on/off illusion of a transparent window background.
		667
		668	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
		669	future versions.
		670
		671	I<Please address all transparency related issues to Sasha Vasko at
		672	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
591		673
592	=item B<fading:> I<number>	674	=item B<fading:> I<number>
593		675
594	Fade the text by the given percentage when focus is lost; option B<-fade>.	676	Fade the text by the given percentage when focus is lost; option B<-fade>.
595		677
…		…
603	Tint the transparent background pixmap with the given colour; option	685	Tint the transparent background pixmap with the given colour; option
604	B<-tint>.	686	B<-tint>.
605		687
606	=item B<shading:> I<number>	688	=item B<shading:> I<number>
607		689
608	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	690	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
609	image in addition to tinting it.	691	in addition to tinting it; option B<-sh>.
		692
		693	=item B<blendType:> I<string>
		694
		695	Specify background blending type; option B<-blt>.
		696
		697	=item B<blurRadius:> I<number>
		698
		699	Apply Gaussian Blurr with the specified radius to the transparent
		700	background image; option B<-blr>.
610		701
611	=item B<scrollColor:> I<colour>	702	=item B<scrollColor:> I<colour>
612		703
613	Use the specified colour for the scrollbar [default #B2B2B2].	704	Use the specified colour for the scrollbar [default #B2B2B2].
614		705
…		…
620	=item B<borderColor:> I<colour>	711	=item B<borderColor:> I<colour>
621		712
622	The colour of the border around the text area and between the scrollbar	713	The colour of the border around the text area and between the scrollbar
623	and the text.	714	and the text.
624		715
625	=item B<backgroundPixmap:> I<file[;geom]>	716	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
626		717
627	Use the specified XPM file (note the `.xpm' extension is optional) for	718	Use the specified image file for the background and also
628	the background and also optionally specify its scaling with a geometry	719	optionally specify its scaling with a geometry string B<WxH+X+Y>,
629	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	720	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
630	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	721	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
631	centre (percent). A scale of 0 displays the image with tiling. A scale	722	centre (percent). A scale of 0 displays the image with tiling. A scale
632	of 1 displays the image without any scaling. A scale of 2 to 9	723	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
633	specifies an integer number of images in that direction. No image will	724	an integer number of images in that direction. No image will be magnified
634	be magnified beyond 10 times its original size. The maximum permitted	725	beyond 10 times its original size. The maximum permitted scale is 1000.
635	scale is 1000. [default 0x0+50+50]	726	Additional operations can be specified after colon B<:op1:op2...>.
		727	Supported operations are:
636		728
637	=item B<menu:> I<file[;tag]>	729	tile force background image to be tiled and not scaled. Equivalent to 0x0,
		730	propscale will scale image keeping proportions,
		731	auto will scale image to match window size. Equivalent to 100x100;
		732	hscale will scale image horizontally to the window size;
		733	vscale will scale image vertically to the window size;
		734	scale will scale image to match window size;
		735	root will tile image as if it was a root window background, auto-adjusting
		736	whenever terminal window moves.
638		737
639	Read in the specified menu file (note the `.menu' extension is	738	If used in conjunction with B<-tr> option, the specified pixmap will be
640	optional) and also optionally specify a starting tag to find. See the	739	blended over transparency image using either alpha-blending, or any
641	reference documentation for details on the syntax for the menuBar.	740	other blending type, specified with B<-blt "type"> option.
642		741
643	=item B<path:> I<path>	742	=item B<path:> I<path>
644		743
645	Specify the colon-delimited search path for finding files (XPM and	744	Specify the colon-delimited search path for finding background image files.
646	menus), in addition to the paths specified by the B<RXVTPATH> and
647	B<PATH> environment variables.
648		745
649	=item B<font:> I<fontlist>	746	=item B<font:> I<fontlist>
650		747
651	Select the fonts to be used. This is a comma separated list of font	748	Select the fonts to be used. This is a comma separated list of font names
652	names that are used in turn when trying to display Unicode characters.	749	that are checked in order when trying to find glyphs for characters. The
653	The first font defines the cell size for characters; other fonts might	750	first font defines the cell size for characters; other fonts might be
654	be smaller, but not larger. A reasonable default font list is always	751	smaller, but not (in general) larger. A (hopefully) reasonable default
655	appended to it; option B<-fn>.	752	font list is always appended to it; option B<-fn>.
656		753
657	Each font can either be a standard X11 core font (XLFD) name, with	754	Each font can either be a standard X11 core font (XLFD) name, with
658	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.	755	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
659		756
660	In addition, each font can be prefixed with additional hints and	757	In addition, each font can be prefixed with additional hints and
…		…
662	hint currently is C<codeset=codeset-name>, and this is only used for Xft	759	hint currently is C<codeset=codeset-name>, and this is only used for Xft
663	fonts.	760	fonts.
664		761
665	For example, this font resource	762	For example, this font resource
666		763
667	URxvt*font: 9x15bold,\	764	URxvt.font: 9x15bold,\
668	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	765	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
669	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \	766	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
670	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	767	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
671	xft:Code2000:antialias=false	768	xft:Code2000:antialias=false
672		769
…		…
709	text font will being used for the given style.	806	text font will being used for the given style.
710		807
711	=item B<intensityStyles:> I<boolean>	808	=item B<intensityStyles:> I<boolean>
712		809
713	When font styles are not enabled, or this option is enabled (B<True>,	810	When font styles are not enabled, or this option is enabled (B<True>,
714	option B<-is>, the default), bold and italic font styles imply high	811	option B<-is>, the default), bold/blink font styles imply high
715	intensity foreground/backround colours. Disabling this option (B<False>,	812	intensity foreground/background colours. Disabling this option (B<False>,
716	option B<+is>) disables this behaviour, the high intensity colours are not	813	option B<+is>) disables this behaviour, the high intensity colours are not
717	reachable.	814	reachable.
718		815
719	=item B<selectstyle:> I<mode>	816	=item B<selectstyle:> I<mode>
720		817
721	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	818	Set mouse selection style to B<old> which is 2.20, B<oldword> which
722	xterm style with 2.20 old word selection, or anything else which gives	819	is xterm style with 2.20 old word selection, or anything else which
723	xterm style selection.	820	gives xterm style selection. Only effective when the original (non-perl)
		821	selection code is in use.
724		822
725	=item B<scrollstyle:> I<mode>	823	=item B<scrollstyle:> I<mode>
726		824
727	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	825	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
728	the author's favourite.	826	the author's favourite.
…		…
742	=item B<mapAlert:> I<boolean>	840	=item B<mapAlert:> I<boolean>
743		841
744	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
745	de-iconify (map) on receipt of a bell character [default].	843	de-iconify (map) on receipt of a bell character [default].
746		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
747	=item B<visualBell:> I<boolean>	850	=item B<visualBell:> I<boolean>
748		851
749	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>.
750	B<False>: no visual bell [default]; option B<+vb>.	853	B<False>: no visual bell [default]; option B<+vb>.
751		854
…		…
769		872
770	The string will be interpreted as if typed into the shell as-is.	873	The string will be interpreted as if typed into the shell as-is.
771		874
772	Example:	875	Example:
773		876
774	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	877	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
775		878
776	This creates a new file in your home directory with the screen contents	879	This creates a new file in your home directory with the screen contents
777	everytime you hit C<Print>.	880	every time you hit C<Print>.
778		881
779	=item B<scrollBar:> I<boolean>	882	=item B<scrollBar:> I<boolean>
780		883
781	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	884	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
782	disable the scrollbar; option B<+sb>.	885	disable the scrollbar; option B<+sb>.
…		…
804		907
805	=item B<scrollWithBuffer:> I<boolean>	908	=item B<scrollWithBuffer:> I<boolean>
806		909
807	B<True>: scroll with scrollback buffer when tty receives new lines (and	910	B<True>: scroll with scrollback buffer when tty receives new lines (and
808	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	911	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
809	with scrollback buffer when tty recieves new lines; option B<+sw>.	912	with scrollback buffer when tty receives new lines; option B<+sw>.
810		913
811	=item B<scrollTtyKeypress:> I<boolean>	914	=item B<scrollTtyKeypress:> I<boolean>
812		915
813	B<True>: scroll to bottom when a non-special key is pressed. Special keys	916	B<True>: scroll to bottom when a non-special key is pressed. Special keys
814	are those which are intercepted by rxvt-unicode for special handling and	917	are those which are intercepted by rxvt-unicode for special handling and
…		…
845	=item B<termName:> I<termname>	948	=item B<termName:> I<termname>
846		949
847	Specifies the terminal type name to be set in the B<TERM> environment	950	Specifies the terminal type name to be set in the B<TERM> environment
848	variable; option B<-tn>.	951	variable; option B<-tn>.
849		952
850	=item B<linespace:> I<number>	953	=item B<lineSpace:> I<number>
851		954
852	Specifies number of lines (pixel height) to insert between each row of	955	Specifies number of lines (pixel height) to insert between each row of
853	the display [default 0]; option B<-lsp>.	956	the display [default 0]; option B<-lsp>.
854		957
855	=item B<meta8:> I<boolean>	958	=item B<meta8:> I<boolean>
…		…
904	pressed. If unset it will send the sequence traditionally associated	1007	pressed. If unset it will send the sequence traditionally associated
905	with the B<Execute> key.	1008	with the B<Execute> key.
906		1009
907	=item B<cutchars:> I<string>	1010	=item B<cutchars:> I<string>
908		1011
909	The characters used as delimiters for double-click word selection. The	1012	The characters used as delimiters for double-click word selection
910	built-in default:	1013	(whitespace delimiting is added automatically if resource is given).
911		1014
		1015	When the perl selection extension is in use (the default if compiled
		1016	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		1017	characters will be created (if the resource exists, otherwise, no regex
		1018	will be created). In this mode, characters outside ISO-8859-1 can be used.
		1019
		1020	When the selection extension is not used, only ISO-8859-1 characters can
		1021	be used. If not specified, the built-in default is used:
		1022
912	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1023	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
913		1024
914	=item B<preeditType:> I<style>	1025	=item B<preeditType:> I<style>
915		1026
916	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1027	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
917		1028
…		…
951	default. (Note that many other terminals, including xterm, have these	1062	default. (Note that many other terminals, including xterm, have these
952	sequences enabled by default, which doesn't make it safer, though).	1063	sequences enabled by default, which doesn't make it safer, though).
953		1064
954	You can enable them by setting this boolean resource or specifying	1065	You can enable them by setting this boolean resource or specifying
955	B<-insecure> as an option. At the moment, this enables display-answer,	1066	B<-insecure> as an option. At the moment, this enables display-answer,
956	locale, findfont, icon label and window title requests as well as dynamic	1067	locale, findfont, icon label and window title requests.
957	menubar dispatch.
958		1068
959	=item B<modifier:> I<modifier>	1069	=item B<modifier:> I<modifier>
960		1070
961	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	1071	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
962	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	1072	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
966		1076
967	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	1077	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
968	character is passed through. It may contain escape values as described	1078	character is passed through. It may contain escape values as described
969	in the entry on B<keysym> following.	1079	in the entry on B<keysym> following.
970		1080
971	=item B<secondaryScreen:> I<bool>	1081	=item B<secondaryScreen:> I<boolean>
972		1082
973	Turn on/off secondary screen (default enabled).	1083	Turn on/off secondary screen (default enabled).
974		1084
975	=item B<secondaryScroll:> I<bool>	1085	=item B<secondaryScroll:> I<boolean>
976		1086
977	Turn on/off secondary screen scroll (default enabled). If the this	1087	Turn on/off secondary screen scroll (default enabled). If this
978	option is enabled, scrolls on the secondary screen will change the	1088	option is enabled, scrolls on the secondary screen will change the
979	scrollback buffer and switching to/from the secondary screen will	1089	scrollback buffer and switching to/from the secondary screen will
980	instead scroll the screen up.	1090	instead scroll the screen up.
981		1091
982	=item B<hold>: I<bool>	1092	=item B<hold>: I<boolean>
983		1093
984	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1094	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
985	will not immediately destroy its window when the program executed within	1095	will not immediately destroy its window when the program executed within
986	it exits. Instead, it will wait till it is being killed or closed by the	1096	it exits. Instead, it will wait till it is being killed or closed by the
987	user.	1097	user.
…		…
1006	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1116	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1007	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1117	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1008	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1118	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1009	performed in an exact manner; however, the closest match is assured.	1119	performed in an exact manner; however, the closest match is assured.
1010		1120
1011	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1121	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1012	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1122	number), see RESOURCES in C<man 7 X> for futher details.
1013	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1014	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1015	can start or end with whitespace.
1016
1017	Please note that you need to double the C<\> when using
1018	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
1019	use C<\033> instead of C<\e> (and so on), which will work with both Xt and
1020	@@RXVT_NAME@@'s own processing).
1021		1123
1022	You can define a range of keysyms in one shot by providing a I<string>	1124	You can define a range of keysyms in one shot by providing a I<string>
1023	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1125	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1024	should be a character not used by the strings.	1126	should be a character not used by the strings.
1025		1127
1026	Its usage can be demonstrated by an example:	1128	Its usage can be demonstrated by an example:
1027		1129
1028	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1130	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
…		…
1081		1183
1082	=item B<perl-ext-common>: I<string>	1184	=item B<perl-ext-common>: I<string>
1083		1185
1084	=item B<perl-ext>: I<string>	1186	=item B<perl-ext>: I<string>
1085		1187
1086	Colon-separated list(s) of perl extension scripts to use in this terminal	1188	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1189	use in this terminal instance; option B<-pe>.
		1190
		1191	Extension names can be prefixed with a C<-> sign to prohibit using
		1192	them. This can be useful to selectively disable some extensions loaded
		1193	by default, or specified via the C<perl-ext-common> resource. For
		1194	example, C<default,-selection> will use all the default extension except
		1195	C<selection>.
		1196
		1197	Extension names can also be followed by an argument in angle brackets
		1198	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1199	searchable scrollback to Alt/Meta-s). Mentioning the same extension
		1200	multiple times with different arguments will pass multiple arguments to
		1201	the extension.
		1202
1087	instance. Each extension is looked up in the library directories, loaded	1203	Each extension is looked up in the library directories, loaded if
1088	if necessary, and bound to the current terminal instance. If this	1204	necessary, and bound to the current terminal instance.
1089	resource is empty or missing, then the perl interpreter will not be	1205
1090	initialized. The idea behind two options is that B<perl-ext-common> will	1206	If both of these resources are the empty string, then the perl
1091	be used for extensions that should be available to all instances, while	1207	interpreter will not be initialized. The idea behind two options is that
1092	B<perl-ext> is used for specific instances; option B<-pe>.	1208	B<perl-ext-common> will be used for extensions that should be available to
		1209	all instances, while B<perl-ext> is used for specific instances.
1093		1210
1094	=item B<perl-eval>: I<string>	1211	=item B<perl-eval>: I<string>
1095		1212
1096	Perl code to be evaluated when all extensions have been registered. See the	1213	Perl code to be evaluated when all extensions have been registered. See
1097	@@RXVT_NAME@@perl(3) manpage.	1214	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
		1215	will be ignored when running setuid/setgid.
1098		1216
1099	=item B<perl-lib>: I<path>	1217	=item B<perl-lib>: I<path>
1100		1218
1101	Colon-separated list of additional directories that hold extension	1219	Colon-separated list of additional directories that hold extension
1102	scripts. When looking for extensions specified by the C<perl> resource,	1220	scripts. When looking for extensions specified by the C<perl> resource,
1103	@@RXVT_NAME@@ will first look in these directories and then in	1221	@@RXVT_NAME@@ will first look in these directories and then in
1104	F<@@RXVT_LIBDIR@@/urxvt/perl/>.	1222	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
		1223	will be ignored when running setuid/setgid.
1105		1224
1106	See the @@RXVT_NAME@@perl(3) manpage.	1225	See the @@RXVT_NAME@@perl(3) manpage.
		1226
		1227	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1228
		1229	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1230	details.
		1231
		1232	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1233
		1234	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1235	for details.
		1236
		1237	=item B<searchable-scrollback:> I<keysym>
		1238
		1239	Sets the hotkey that starts the incremental scrollback buffer search
		1240	(default: C<M-s>).
		1241
		1242	=item B<urlLauncher>: I<string>
		1243
		1244	Specifies the program to be started with a URL argument. Used by the
		1245	C<selection-popup> and C<matcher> perl extensions.
		1246
		1247	=item B<transient-for>: I<windowid>
		1248
		1249	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1250
		1251	=item B<override-redirect>: I<boolean>
		1252
		1253	Compile I<frills>: Sets override-redirect for the terminal window, making
		1254	it almost invisible to window managers; option B<-override-redirect>.
		1255
		1256	=item B<iso14755_52:> I<boolean>
		1257
		1258	Turn on/off ISO 14755 5.2 mode (default enabled).
1107		1259
1108	=back	1260	=back
1109		1261
1110	=head1 THE SCROLLBAR	1262	=head1 THE SCROLLBAR
1111		1263
…		…
1130	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1282	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1131	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1283	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1132	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1284	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1133	respectively.	1285	respectively.
1134		1286
1135	=head1 TEXT SELECTION AND INSERTION	1287	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1136		1288
1137	The behaviour of text selection and insertion mechanism is similar to	1289	The behaviour of text selection and insertion/pasting mechanism is similar
1138	I<xterm>(1).	1290	to I<xterm>(1).
1139		1291
1140	=over 4	1292	=over 4
1141		1293
1142	=item B<Selection>:	1294	=item B<Selecting>:
1143		1295
1144	Left click at the beginning of the region, drag to the end of the region	1296	Left click at the beginning of the region, drag to the end of the region
1145	and release; Right click to extend the marked region; Left double-click	1297	and release; Right click to extend the marked region; Left double-click
1146	to select a word; Left triple-click to select the entire logical line	1298	to select a word; Left triple-click to select the entire logical line
1147	(which can span multiple screen lines), unless modified by resource	1299	(which can span multiple screen lines), unless modified by resource
…		…
1151	(Compile: I<frills>) will create a rectangular selection instead of a	1303	(Compile: I<frills>) will create a rectangular selection instead of a
1152	normal one. In this mode, every selected row becomes its own line in the	1304	normal one. In this mode, every selected row becomes its own line in the
1153	selection, and trailing whitespace is visually underlined and removed from	1305	selection, and trailing whitespace is visually underlined and removed from
1154	the selection.	1306	the selection.
1155		1307
1156	=item B<Insertion>:	1308	=item B<Pasting>:
1157		1309
1158	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1310	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1159	an B<@@RXVT_NAME@@> window causes the current text selection to be	1311	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1160	inserted as if it had been typed on the keyboard.	1312	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1313
		1314	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1315	inserted too.
1161		1316
1162	=back	1317	=back
1163		1318
1164	=head1 CHANGING FONTS	1319	=head1 CHANGING FONTS
1165		1320
1166	Changing fonts (or font sizes, respectively) via the keypad is not yet	1321	Changing fonts (or font sizes, respectively) via the keypad is not yet
1167	supported in rxvt-unicode. Bug me if you need this.	1322	supported in rxvt-unicode. Bug me if you need this.
1168		1323
1169	You can, however, switch fonts at runtime using escape sequences (and	1324	You can, however, switch fonts at runtime using escape sequences, e.g.:
1170	therefore using the menubar), e.g.:
1171		1325
1172	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"	1326	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1327
		1328	You can use keyboard shortcuts, too:
		1329
		1330	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1331	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1173		1332
1174	rxvt-unicode will automatically re-apply these fonts to the output so far.	1333	rxvt-unicode will automatically re-apply these fonts to the output so far.
1175		1334
1176	=head1 ISO 14755 SUPPORT	1335	=head1 ISO 14755 SUPPORT
1177		1336
1178	ISO 14755 is a standard for entering and viewing unicode characters	1337	ISO 14755 is a standard for entering and viewing unicode characters
1179	and character codes using the keyboard. It consists of 4 parts. The	1338	and character codes using the keyboard. It consists of 4 parts. The
1180	first part is available rxvt-unicode has been compiled with	1339	first part is available if rxvt-unicode has been compiled with
1181	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1340	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1182	with C<--enable-iso14755>.	1341	with C<--enable-iso14755>.
1183		1342
1184	=over 4	1343	=over 4
1185		1344
…		…
1205	This mode lets you input characters representing the keycap symbols of	1364	This mode lets you input characters representing the keycap symbols of
1206	your keyboard, if representable in the current locale encoding.	1365	your keyboard, if representable in the current locale encoding.
1207		1366
1208	Start by pressing C<Control> and C<Shift> together, then releasing	1367	Start by pressing C<Control> and C<Shift> together, then releasing
1209	them. The next special key (cursor keys, home etc.) you enter will not	1368	them. The next special key (cursor keys, home etc.) you enter will not
1210	invoke it's usual function but instead will insert the corresponding	1369	invoke its usual function but instead will insert the corresponding
1211	keycap symbol. The symbol will only be entered when the key has been	1370	keycap symbol. The symbol will only be entered when the key has been
1212	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1371	released, otherwise pressing e.g. C<Shift> would enter the symbol for
1213	C<ISO Level 2 Switch>, although your intention might have been to enter a	1372	C<ISO Level 2 Switch>, although your intention might have been to enter a
1214	reverse tab (Shift-Tab).	1373	reverse tab (Shift-Tab).
1215		1374
…		…
1248	=head1 COLORS AND GRAPHICS	1407	=head1 COLORS AND GRAPHICS
1249		1408
1250	In addition to the default foreground and background colours,	1409	In addition to the default foreground and background colours,
1251	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1410	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1252	high-intensity bold/blink versions of the same). Here is a list of the	1411	high-intensity bold/blink versions of the same). Here is a list of the
1253	colours with their B<rgb.txt> names.	1412	colours with their names.
1254		1413
1255	=begin table	1414	=begin table
1256		1415
1257	B<color0> (black) = Black	1416	B<color0> (black) = Black
1258	B<color1> (red) = Red3	1417	B<color1> (red) = Red3
…		…
1278	It is also possible to specify the colour values of B<foreground>,	1437	It is also possible to specify the colour values of B<foreground>,
1279	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1438	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1280	a number 0-15, as a convenient shorthand to reference the colour name of	1439	a number 0-15, as a convenient shorthand to reference the colour name of
1281	color0-color15.	1440	color0-color15.
1282		1441
		1442	In addition to the colours defined above, @@RXVT_NAME@@ offers an
		1443	additional 72 colours. The first 64 of those (with indices 16 to 79)
		1444	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
		1445	16>), followed by 8 additional shades of gray (with indices 80 to 87).
		1446
		1447	Together, all those colours implement the 88 colour xterm colours. Only
		1448	the first 16 can be changed using resources currently, the rest can only
		1449	be changed via command sequences ("escape codes").
		1450
1283	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1451	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1284	always swapping the foreground/background colours. This is in contrast to	1452	always swapping the foreground/background colours. This is in contrast to
1285	I<xterm>(1) where the colours are only swapped if they have not otherwise	1453	I<xterm>(1) where the colours are only swapped if they have not otherwise
1286	been specified. For example,	1454	been specified. For example,
1287		1455
…		…
1292	would yield White on Black, while on I<xterm>(1) it would yield Black	1460	would yield White on Black, while on I<xterm>(1) it would yield Black
1293	on White.	1461	on White.
1294		1462
1295	=back	1463	=back
1296		1464
		1465	=head2 ALPHA CHANNEL SUPPORT
		1466
		1467	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1468	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
		1469	(recommended, but B<MUST> have 4 digits/component) colour specifications,
		1470	in addition to the ones provided by X, where the additional A component
		1471	specifies opacity (alpha) values. The minimum value of C<0> is completely
		1472	transparent). You can also prefix any color with C<[percent]>, where
		1473	C<percent> is a decimal percentage (0-100) that specifies the opacity of
		1474	the color, where C<0> is completely transparent and C<100> is completelxy
		1475	opaque.
		1476
		1477	You probably need to specify B<"-depth 32">, too, and have the luck that
		1478	your X-server uses ARGB pixel layout, as X is far from just supporting
		1479	ARGB visuals out of the box, and rxvt-unicode just fudges around.
		1480
		1481	For example, the following selects an almost completely transparent red
		1482	background, and an almost opaque pink foreground:
		1483
		1484	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
		1485
		1486	I<Please note that transparency of any kind if completely unsupported by
		1487	the author. Don't bug him with installation questions!>
		1488
1297	=head1 ENVIRONMENT	1489	=head1 ENVIRONMENT
1298		1490
1299	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1491	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1300		1492
1301	=over 4	1493	=over 4
1302		1494
1303	=item B<TERM>	1495	=item B<TERM>
1304		1496
1305	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1497	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1306	resources or on the commandline.	1498	resources or on the command line.
1307		1499
1308	=item B<COLORTERM>	1500	=item B<COLORTERM>
1309		1501
1310	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1502	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1311	compiled with XPM support, and optionally with the added extension	1503	compiled with background image support, and optionally with the added
1312	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1504	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1505	screen.
1313		1506
1314	=item B<COLORFGBG>	1507	=item B<COLORFGBG>
1315		1508
1316	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1509	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1317	the colour code used as default foreground/text colour (or the string	1510	the colour code used as default foreground/text colour (or the string
1318	C<default> to indicate that the default-colour escape sequence is to be	1511	C<default> to indicate that the default-colour escape sequence is to be
1319	used), C<bg> is the colour code used as default background colour (or the	1512	used), C<bg> is the colour code used as default background colour (or the
1320	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1513	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1321	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1514	was compiled with background image support. Libraries like C<ncurses>
1322	(and do) use this information to optimize screen output.	1515	and C<slang> can (and do) use this information to optimize screen output.
1323		1516
1324	=item B<WINDOWID>	1517	=item B<WINDOWID>
1325		1518
1326	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1519	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1327	window, which usually has subwindows for the scrollbar, the terminal	1520	window, which usually has subwindows for the scrollbar, the terminal
…		…
1333	C<--with-terminfo=PATH>.	1526	C<--with-terminfo=PATH>.
1334		1527
1335	=item B<DISPLAY>	1528	=item B<DISPLAY>
1336		1529
1337	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1530	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1338	display in it's child processes.	1531	display in its child processes.
1339		1532
1340	=item B<SHELL>	1533	=item B<SHELL>
1341		1534
1342	The shell to be used for command execution, defaults to C</bin/sh>.	1535	The shell to be used for command execution, defaults to C</bin/sh>.
1343
1344	=item B<RXVTPATH>
1345
1346	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1347	files.
1348
1349	=item B<PATH>
1350
1351	Used in the same way as C<RXVTPATH>.
1352		1536
1353	=item B<RXVT_SOCKET>	1537	=item B<RXVT_SOCKET>
1354		1538
1355	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1539	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1356	@@RXVT_NAME@@d(1).	1540	@@RXVT_NAME@@d(1).
…		…
1394		1578
1395	=item Project Coordinator	1579	=item Project Coordinator
1396		1580
1397	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1581	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1398		1582
1399	L<http://software.schmorp.de/#rxvt-unicode>	1583	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1400		1584
1401	=back	1585	=back
1402		1586
1403	=head1 AUTHORS	1587	=head1 AUTHORS
1404		1588
…		…
1426		1610
1427	Project Coordinator (changes.txt 2.21a to 2.4.5)	1611	Project Coordinator (changes.txt 2.21a to 2.4.5)
1428		1612
1429	=item Geoff Wing L<< <gcw@pobox.com> >>	1613	=item Geoff Wing L<< <gcw@pobox.com> >>
1430		1614
1431	Rewrote screen display and text selection routines. Project Coordinator	1615	Rewrote screen display and text selection routines.
		1616
1432	(changes.txt 2.4.6 - rxvt-unicode)	1617	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1433		1618
1434	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1619	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1435		1620
1436	Forked rxvt-unicode, rewrote most of the display code and internal	1621	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1437	character handling to store text in unicode, improve xterm	1622	extension, random hacks, numerous bugfixes and extensions.
1438	compatibility and apply numerous other bugfixes and extensions.
1439		1623
1440	Project Coordinator (Changes 1.0 -)	1624	Project Coordinator (Changes 1.0 -)
1441		1625
		1626	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1627
		1628	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
		1629
1442	=back	1630	=back
1443		1631

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.85 by root, Wed Jan 4 20:43:37 2006 UTC vs. Revision 1.154 by ayin, Fri Dec 14 09:06:36 2007 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.85 by root, Wed Jan 4 20:43:37 2006 UTC vs.
Revision 1.154 by ayin, Fri Dec 14 09:06:36 2007 UTC