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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.83 by root, Tue Jan 3 22:28:07 2006 UTC vs.
Revision 1.129 by root, Mon May 28 20:34:56 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>
…		…
109		114
110	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>	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>.
		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@@)!>
114		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. Small values	126	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	127	fade a little only, 100 completely replaces all colours by the fade
119	colour; resource B<fading>.	128	colour; resource B<fading>.
120		129
121	=item B<-fadecolor> I<colour>	130	=item B<-fadecolor> I<colour>
122		131
123	Fade to this colour when fading is used (see B<-fade>). The default colour	132	Fade to this colour when fading is used (see B<-fade>). The default colour
124	is black. resource B<fadeColor>.	133	is opaque black. resource B<fadeColor>.
125		134
126	=item B<-tint> I<colour>	135	=item B<-tint> I<colour>
127		136
128	Tint the transparent background pixmap with the given colour when	137	Tint the transparent background pixmap with the given colour when
129	transparency is enabled with B<-tr> or B<-ip>. This only works for	138	transparency is enabled with B<-tr> or B<-ip>. This only works for
…		…
135		144
136	=item B<-sh>	145	=item B<-sh>
137		146
138	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	147	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
139	background image in addition to tinting it (i.e. B<-tint> must be	148	background image in addition to tinting it (i.e. B<-tint> must be
140	specified, too, e.g. C<-tint white>).	149	specified, too, e.g. C<-tint white>); resource I<shading>.
141		150
142	=item B<-bg> I<colour>	151	=item B<-bg> I<colour>
143		152
144	Window background colour; resource B<background>.	153	Window background colour; resource B<background>.
145		154
…		…
172	resource B<borderColor>.	181	resource B<borderColor>.
173		182
174	=item B<-fn> I<fontlist>	183	=item B<-fn> I<fontlist>
175		184
176	Select the fonts to be used. This is a comma separated list of font names	185	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	186	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	187	first font defines the cell size for characters; other fonts might be
179	smaller, but not (in general) larger. A (hopefully) reasonable default	188	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.	189	font list is always appended to it. See resource B<font> for more details.
181		190
182	In short, to specify an X11 core font, just specify it's name or prefix it	191	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:>,	192	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184	e.g.:	193	e.g.:
185		194
186	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	195	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	196	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
189	See also the question "How does rxvt-unicode choose fonts?" in the FAQ	198	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
190	section of @@RXVT_NAME@@(7).	199	section of @@RXVT_NAME@@(7).
191		200
192	=item B<-fb> I<fontlist>	201	=item B<-fb> I<fontlist>
193		202
194	Compile font-styles: The bold font list to use when B<bold> characters are to	203	Compile I<font-styles>: The bold font list to use when B<bold> characters
195	be printed. See resource B<boldFont> for details.	204	are to be printed. See resource B<boldFont> for details.
196		205
197	=item B<-fi> I<fontlist>	206	=item B<-fi> I<fontlist>
198		207
199	Compile font-styles: The italic font list to use when I<italic> characters are to	208	Compile I<font-styles>: The italic font list to use when I<italic>
200	be printed. See resource B<italicFont> for details.	209	characters are to be printed. See resource B<italicFont> for details.
201		210
202	=item B<-fbi> I<fontlist>	211	=item B<-fbi> I<fontlist>
203		212
204	Compile font-styles: The bold italic font list to use when B<< I<bold	213	Compile I<font-styles>: The bold italic font list to use when B<< I<bold
205	italic> >> characters are to be printed. See resource B<boldItalicFont>	214	italic> >> characters are to be printed. See resource B<boldItalicFont>
206	for details.	215	for details.
207		216
208	=item B<-is>\|B<+is>	217	=item B<-is>\|B<+is>
209		218
210	Compile font-styles: Bold/Italic font styles imply high intensity	219	Compile I<font-styles>: Bold/Italic font styles imply high intensity
211	foreground/background (default). See resource B<intensityStyles> for	220	foreground/background (default). See resource B<intensityStyles> for
212	details.	221	details.
213		222
214	=item B<-name> I<name>	223	=item B<-name> I<name>
215		224
…		…
296	=item B<-bl>	305	=item B<-bl>
297		306
298	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	307	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	308	if honoured by the WM, the rxvt-unicode window will not have window
300	decorations; resource B<borderLess>.	309	decorations; resource B<borderLess>.
		310
		311	=item B<-override-redirect>
		312
		313	Compile I<frills>: Sets override-redirect on the window; resource
		314	B<override-redirect>.
		315
		316	=item B<-sbg>
		317
		318	Compile I<frills>: Disable the usage of the built-in block graphics/line
		319	drawing characters and just rely on what the specified fonts provide. Use
		320	this if you have a good font and want to use its block graphic glyphs;
		321	resource B<skipBuiltinGlyphs>.
301		322
302	=item B<-lsp> I<number>	323	=item B<-lsp> I<number>
303		324
304	Compile I<frills>: Lines (pixel height) to insert between each row of	325	Compile I<frills>: Lines (pixel height) to insert between each row of
305	the display. Useful to work around font rendering problems; resource	326	the display. Useful to work around font rendering problems; resource
…		…
365	for more info.	386	for more info.
366		387
367	=item B<-tcw>	388	=item B<-tcw>
368		389
369	Change the meaning of triple-click selection with the left mouse	390	Change the meaning of triple-click selection with the left mouse
		391	button. Only effective when the original (non-perl) selection code is
370	button. Instead of selecting a full line it will extend the selection the	392	in-use. Instead of selecting a full line it will extend the selection the
371	end of the logical line only. resource B<tripleclickwords>.	393	end of the logical line only. resource B<tripleclickwords>.
372		394
373	=item B<-insecure>	395	=item B<-insecure>
374		396
375	Enable "insecure" mode, which currently enables most of the escape	397	Enable "insecure" mode, which currently enables most of the escape
…		…
403		425
404	Remap a key symbol. See resource B<keysym>.	426	Remap a key symbol. See resource B<keysym>.
405		427
406	=item B<-embed> I<windowid>	428	=item B<-embed> I<windowid>
407		429
408	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,	430	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
409	which enables applications to easily embed a terminal.	431	which enables applications to easily embed a terminal.
410		432
411	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it	433	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
412	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it	434	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
413	quite a bit, so don't expect it to keep some specific state. It's best to	435	quite a bit, so don't expect it to keep some specific state. It's best to
…		…
416	The window will not be destroyed when @@RXVT_NAME@@ exits.	438	The window will not be destroyed when @@RXVT_NAME@@ exits.
417		439
418	It might be useful to know that @@RXVT_NAME@@ will not close file	440	It might be useful to know that @@RXVT_NAME@@ will not close file
419	descriptors passed to it (except for stdin/out/err, of course), so you	441	descriptors passed to it (except for stdin/out/err, of course), so you
420	can use file descriptors to communicate with the programs within the	442	can use file descriptors to communicate with the programs within the
421	terminal. This works regardless of wether the C<-embed> option was used or	443	terminal. This works regardless of whether the C<-embed> option was used or
422	not.	444	not.
423		445
424	Here is a short Gtk2-perl snippet that illustrates how this option can be	446	Here is a short Gtk2-perl snippet that illustrates how this option can be
425	used (a longer example is in F<doc/embed>):	447	used (a longer example is in F<doc/embed>):
426		448
…		…
428	$rxvt->signal_connect_after (realize => sub {	450	$rxvt->signal_connect_after (realize => sub {
429	my $xid = $_[0]->window->get_xid;	451	my $xid = $_[0]->window->get_xid;
430	system "@@RXVT_NAME@@ -embed $xid &";	452	system "@@RXVT_NAME@@ -embed $xid &";
431	});	453	});
432		454
433	=item B<-pty-fd> I<fileno>	455	=item B<-pty-fd> I<file descriptor>
434		456
435	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	457	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
436	pair but instead use the given filehandle as the tty master. This is	458	pair but instead use the given file descriptor as the tty master. This is
437	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator	459	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
438	without having to run a program within it.	460	without having to run a program within it.
439		461
440	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	462	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
441	entries and will not tinker with pty/tty permissions - you have to do that	463	entries and will not tinker with pty/tty permissions - you have to do that
442	yourself if you want that.	464	yourself if you want that.
		465
		466	As an extremely special case, specifying C<-1> will completely suppress
		467	pty/tty operations.
443		468
444	Here is a example in perl that illustrates how this option can be used (a	469	Here is a example in perl that illustrates how this option can be used (a
445	longer example is in F<doc/pty-fd>):	470	longer example is in F<doc/pty-fd>):
446		471
447	use IO::Pty;	472	use IO::Pty;
…		…
456	my $slave = $pty->slave;	481	my $slave = $pty->slave;
457	while (<$slave>) { print $slave "got <$_>\n" }	482	while (<$slave>) { print $slave "got <$_>\n" }
458		483
459	=item B<-pe> I<string>	484	=item B<-pe> I<string>
460		485
461	Colon-separated list of perl extension scripts to use in this terminal instance. See resource B<perl-ext>.	486	Comma-separated list of perl extension scripts to use (or not to use) in
		487	this terminal instance. See resource B<perl-ext> for details.
462		488
463	=back	489	=back
464		490
465	=head1 RESOURCES (available also as long-options)	491	=head1 RESOURCES (available also as long-options)
466		492
467	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	493	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
468	options) compiled into your version.	494	options) compiled into your version.
469		495
470	There are two different methods that @@RXVT_NAME@@ can use to get the	496	You can set and change the resources using X11 tools like B<xrdb>. Many
471	Xresource data: using the X libraries (Xrm*-functions) or internal	497	distribution do also load settings from the B<~/.Xresources> file when X
472	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	498	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
473	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	499	with later settings overwriting earlier ones:
474	resources using X11 tools like B<xrdb>. Many distribution do also load
475	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
476	will consult the following files/resources in order, with later settings
477	overwriting earlier ones:
478		500
479	1. system-wide app-defaults file, either locale-dependent OR global	501	1. system-wide app-defaults file, either locale-dependent OR global
480	2. app-defaults file in $XAPPLRESDIR	502	2. app-defaults file in $XAPPLRESDIR
481	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	503	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
482	4. SCREEN_RESOURCES for the current screen	504	4. SCREEN_RESOURCES for the current screen
483	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	505	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
484		506
485	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
486	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
487	set in XAPPLOADDIR/URxvt (compile-time defined: usually
488	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
489	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
490	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	507	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
491	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows	508	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
492	resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be	509	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
493	easily configured, while the class name B<URxvt> allows resources	510	configured, while the class name B<URxvt> allows resources unique to
494	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	511	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
495	shared between different B<@@RXVT_NAME@@> configurations. If no	512	configurations. If no resources are specified, suitable defaults will
496	resources are specified, suitable defaults will be used. Command-line	513	be used. Command-line arguments can be used to override resource
497	arguments can be used to override resource settings. The following	514	settings. The following resources are supported (you might want to
498	resources are allowed:	515	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		516	extensions not documented here):
499		517
500	=over 4	518	=over 4
		519
		520	=item B<depth:> I<bitdepth>
		521
		522	Compile I<xft>: Attempt to find a visual with the given bit depth;
		523	option B<-depth>.
501		524
502	=item B<geometry:> I<geom>	525	=item B<geometry:> I<geom>
503		526
504	Create the window with the specified X window geometry [default 80x24];	527	Create the window with the specified X window geometry [default 80x24];
505	option B<-geometry>.	528	option B<-geometry>.
…		…
542	Use the specified colour to display underlined characters when the	565	Use the specified colour to display underlined characters when the
543	foreground colour is the default.	566	foreground colour is the default.
544		567
545	=item B<colorRV:> I<colour>	568	=item B<colorRV:> I<colour>
546		569
547	Use the specified colour as the background for reverse video	570	Use the specified colour as the background for reverse video characters
548	characters.	571	when OPTION_HC is disabled (--disable-frills).
549		572
550	=item B<underlineColor:> I<colour>	573	=item B<underlineColor:> I<colour>
551		574
552	If set, use the specified colour as the colour for the underline	575	If set, use the specified colour as the colour for the underline
553	itself. If unset, use the foreground colour.	576	itself. If unset, use the foreground colour.
…		…
579		602
580	B<True>: make the background inherit the parent windows' pixmap, giving	603	B<True>: make the background inherit the parent windows' pixmap, giving
581	artificial transparency. B<False>: do not inherit the parent windows'	604	artificial transparency. B<False>: do not inherit the parent windows'
582	pixmap.	605	pixmap.
583		606
		607	I<Please note that transparency of any kind if completely unsupported by
		608	the author. Don't bug him with installation questions!>
		609
584	=item B<fading:> I<number>	610	=item B<fading:> I<number>
585		611
586	Fade the text by the given percentage when focus is lost; option B<-fade>.	612	Fade the text by the given percentage when focus is lost; option B<-fade>.
587		613
588	=item B<fadeColor:> I<colour>	614	=item B<fadeColor:> I<colour>
…		…
595	Tint the transparent background pixmap with the given colour; option	621	Tint the transparent background pixmap with the given colour; option
596	B<-tint>.	622	B<-tint>.
597		623
598	=item B<shading:> I<number>	624	=item B<shading:> I<number>
599		625
600	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	626	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
601	image in addition to tinting it.	627	in addition to tinting it; option B<-sh>.
602		628
603	=item B<scrollColor:> I<colour>	629	=item B<scrollColor:> I<colour>
604		630
605	Use the specified colour for the scrollbar [default #B2B2B2].	631	Use the specified colour for the scrollbar [default #B2B2B2].
606		632
…		…
624	of 1 displays the image without any scaling. A scale of 2 to 9	650	of 1 displays the image without any scaling. A scale of 2 to 9
625	specifies an integer number of images in that direction. No image will	651	specifies an integer number of images in that direction. No image will
626	be magnified beyond 10 times its original size. The maximum permitted	652	be magnified beyond 10 times its original size. The maximum permitted
627	scale is 1000. [default 0x0+50+50]	653	scale is 1000. [default 0x0+50+50]
628		654
629	=item B<menu:> I<file[;tag]>
630
631	Read in the specified menu file (note the `.menu' extension is
632	optional) and also optionally specify a starting tag to find. See the
633	reference documentation for details on the syntax for the menuBar.
634
635	=item B<path:> I<path>	655	=item B<path:> I<path>
636		656
637	Specify the colon-delimited search path for finding files (XPM and	657	Specify the colon-delimited search path for finding XPM files.
638	menus), in addition to the paths specified by the B<RXVTPATH> and
639	B<PATH> environment variables.
640		658
641	=item B<font:> I<fontlist>	659	=item B<font:> I<fontlist>
642		660
643	Select the fonts to be used. This is a comma separated list of font	661	Select the fonts to be used. This is a comma separated list of font names
644	names that are used in turn when trying to display Unicode characters.	662	that are checked in order when trying to find glyphs for characters. The
645	The first font defines the cell size for characters; other fonts might	663	first font defines the cell size for characters; other fonts might be
646	be smaller, but not larger. A reasonable default font list is always	664	smaller, but not (in general) larger. A (hopefully) reasonable default
647	appended to it; option B<-fn>.	665	font list is always appended to it; option B<-fn>.
648		666
649	Each font can either be a standard X11 core font (XLFD) name, with	667	Each font can either be a standard X11 core font (XLFD) name, with
650	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.	668	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
651		669
652	In addition, each font can be prefixed with additional hints and	670	In addition, each font can be prefixed with additional hints and
…		…
654	hint currently is C<codeset=codeset-name>, and this is only used for Xft	672	hint currently is C<codeset=codeset-name>, and this is only used for Xft
655	fonts.	673	fonts.
656		674
657	For example, this font resource	675	For example, this font resource
658		676
659	URxvt*font: 9x15bold,\	677	URxvt.font: 9x15bold,\
660	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	678	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
661	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \	679	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
662	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	680	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
663	xft:Code2000:antialias=false	681	xft:Code2000:antialias=false
664		682
…		…
702		720
703	=item B<intensityStyles:> I<boolean>	721	=item B<intensityStyles:> I<boolean>
704		722
705	When font styles are not enabled, or this option is enabled (B<True>,	723	When font styles are not enabled, or this option is enabled (B<True>,
706	option B<-is>, the default), bold and italic font styles imply high	724	option B<-is>, the default), bold and italic font styles imply high
707	intensity foreground/backround colours. Disabling this option (B<False>,	725	intensity foreground/background colours. Disabling this option (B<False>,
708	option B<+is>) disables this behaviour, the high intensity colours are not	726	option B<+is>) disables this behaviour, the high intensity colours are not
709	reachable.	727	reachable.
710		728
711	=item B<selectstyle:> I<mode>	729	=item B<selectstyle:> I<mode>
712		730
713	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	731	Set mouse selection style to B<old> which is 2.20, B<oldword> which
714	xterm style with 2.20 old word selection, or anything else which gives	732	is xterm style with 2.20 old word selection, or anything else which
715	xterm style selection.	733	gives xterm style selection. Only effective when the original (non-perl)
		734	selection code is in use.
716		735
717	=item B<scrollstyle:> I<mode>	736	=item B<scrollstyle:> I<mode>
718		737
719	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	738	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
720	the author's favourite.	739	the author's favourite.
…		…
734	=item B<mapAlert:> I<boolean>	753	=item B<mapAlert:> I<boolean>
735		754
736	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	755	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
737	de-iconify (map) on receipt of a bell character [default].	756	de-iconify (map) on receipt of a bell character [default].
738		757
		758	=item B<urgentOnBell:> I<boolean>
		759
		760	B<True>: set the urgency hint for the wm on receipt of a bell character.
		761	B<False>: do not set the urgency hint [default].
		762
739	=item B<visualBell:> I<boolean>	763	=item B<visualBell:> I<boolean>
740		764
741	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	765	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
742	B<False>: no visual bell [default]; option B<+vb>.	766	B<False>: no visual bell [default]; option B<+vb>.
743		767
…		…
761		785
762	The string will be interpreted as if typed into the shell as-is.	786	The string will be interpreted as if typed into the shell as-is.
763		787
764	Example:	788	Example:
765		789
766	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	790	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
767		791
768	This creates a new file in your home directory with the screen contents	792	This creates a new file in your home directory with the screen contents
769	everytime you hit C<Print>.	793	every time you hit C<Print>.
770		794
771	=item B<scrollBar:> I<boolean>	795	=item B<scrollBar:> I<boolean>
772		796
773	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	797	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
774	disable the scrollbar; option B<+sb>.	798	disable the scrollbar; option B<+sb>.
…		…
796		820
797	=item B<scrollWithBuffer:> I<boolean>	821	=item B<scrollWithBuffer:> I<boolean>
798		822
799	B<True>: scroll with scrollback buffer when tty receives new lines (and	823	B<True>: scroll with scrollback buffer when tty receives new lines (and
800	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	824	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
801	with scrollback buffer when tty recieves new lines; option B<+sw>.	825	with scrollback buffer when tty receives new lines; option B<+sw>.
802		826
803	=item B<scrollTtyKeypress:> I<boolean>	827	=item B<scrollTtyKeypress:> I<boolean>
804		828
805	B<True>: scroll to bottom when a non-special key is pressed. Special keys	829	B<True>: scroll to bottom when a non-special key is pressed. Special keys
806	are those which are intercepted by rxvt-unicode for special handling and	830	are those which are intercepted by rxvt-unicode for special handling and
…		…
825	=item B<borderLess:> I<boolean>	849	=item B<borderLess:> I<boolean>
826		850
827	Set MWM hints to request a borderless window, i.e. if honoured by the	851	Set MWM hints to request a borderless window, i.e. if honoured by the
828	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.	852	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
829		853
		854	=item B<skipBuiltinGlyphs:> I<boolean>
		855
		856	Compile I<frills>: Disable the usage of the built-in block graphics/line
		857	drawing characters and just rely on what the specified fonts provide. Use
		858	this if you have a good font and want to use its block graphic glyphs;
		859	option B<-sbg>.
		860
830	=item B<termName:> I<termname>	861	=item B<termName:> I<termname>
831		862
832	Specifies the terminal type name to be set in the B<TERM> environment	863	Specifies the terminal type name to be set in the B<TERM> environment
833	variable; option B<-tn>.	864	variable; option B<-tn>.
834		865
…		…
889	pressed. If unset it will send the sequence traditionally associated	920	pressed. If unset it will send the sequence traditionally associated
890	with the B<Execute> key.	921	with the B<Execute> key.
891		922
892	=item B<cutchars:> I<string>	923	=item B<cutchars:> I<string>
893		924
894	The characters used as delimiters for double-click word selection. The	925	The characters used as delimiters for double-click word selection
895	built-in default:	926	(whitespace delimiting is added automatically if resource is given).
		927
		928	When the perl selection extension is in use (the default if compiled
		929	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		930	characters will be created (if the resource exists, otherwise, no regex
		931	will be created). In this mode, characters outside ISO-8859-1 can be used.
		932
		933	When the selection extension is not used, only ISO-8859-1 characters can
		934	be used. If not specified, the built-in default is used:
896		935
897	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	936	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>
898		937
899	=item B<preeditType:> I<style>	938	=item B<preeditType:> I<style>
900		939
…		…
936	default. (Note that many other terminals, including xterm, have these	975	default. (Note that many other terminals, including xterm, have these
937	sequences enabled by default, which doesn't make it safer, though).	976	sequences enabled by default, which doesn't make it safer, though).
938		977
939	You can enable them by setting this boolean resource or specifying	978	You can enable them by setting this boolean resource or specifying
940	B<-insecure> as an option. At the moment, this enables display-answer,	979	B<-insecure> as an option. At the moment, this enables display-answer,
941	locale, findfont, icon label and window title requests as well as dynamic	980	locale, findfont, icon label and window title requests.
942	menubar dispatch.
943		981
944	=item B<modifier:> I<modifier>	982	=item B<modifier:> I<modifier>
945		983
946	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	984	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
947	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	985	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
951		989
952	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	990	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
953	character is passed through. It may contain escape values as described	991	character is passed through. It may contain escape values as described
954	in the entry on B<keysym> following.	992	in the entry on B<keysym> following.
955		993
956	=item B<secondaryScreen:> I<bool>	994	=item B<secondaryScreen:> I<boolean>
957		995
958	Turn on/off secondary screen (default enabled).	996	Turn on/off secondary screen (default enabled).
959		997
960	=item B<secondaryScroll:> I<bool>	998	=item B<secondaryScroll:> I<boolean>
961		999
962	Turn on/off secondary screen scroll (default enabled). If the this	1000	Turn on/off secondary screen scroll (default enabled). If this
963	option is enabled, scrolls on the secondary screen will change the	1001	option is enabled, scrolls on the secondary screen will change the
964	scrollback buffer and switching to/from the secondary screen will	1002	scrollback buffer and switching to/from the secondary screen will
965	instead scroll the screen up.	1003	instead scroll the screen up.
966		1004
967	=item B<hold>: I<bool>	1005	=item B<hold>: I<boolean>
968		1006
969	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1007	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
970	will not immediately destroy its window when the program executed within	1008	will not immediately destroy its window when the program executed within
971	it exits. Instead, it will wait till it is being killed or closed by the	1009	it exits. Instead, it will wait till it is being killed or closed by the
972	user.	1010	user.
…		…
995		1033
996	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1034	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
997	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1035	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
998	C<\000>: octal number) or verbatim control characters (C<^?>: delete,	1036	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
999	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it	1037	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1000	can start or end with whitespace.	1038	can start or end with whitespace. B<This feature is deprecated and will
		1039	be removed>.
1001		1040
1002	Please note that you need to double the C<\> when using	1041	Please note that you need to double the C<\> in resource files, as
1003	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can	1042	Xlib itself does its own de-escaping (you can use C<\033> instead of
1004	use C<\033> instead of C<\e> (and so on), which will work with both Xt and	1043	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1005	@@RXVT_NAME@@'s own processing).	1044	processing).
1006		1045
1007	You can define a range of keysyms in one shot by providing a I<string>	1046	You can define a range of keysyms in one shot by providing a I<string>
1008	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1047	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1009	should be a character not used by the strings.	1048	should be a character not used by the strings.
1010		1049
1011	Its usage can be demonstrated by an example:	1050	Its usage can be demonstrated by an example:
1012		1051
1013	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1052	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
…		…
1062	info):	1101	info):
1063		1102
1064	URxvt.keysym.M-C-3: command:\033[8;25;80t	1103	URxvt.keysym.M-C-3: command:\033[8;25;80t
1065	URxvt.keysym.M-C-4: command:\033[8;48;110t	1104	URxvt.keysym.M-C-4: command:\033[8;48;110t
1066		1105
		1106	=item B<perl-ext-common>: I<string>
		1107
1067	=item B<perl-ext>: I<string>	1108	=item B<perl-ext>: I<string>
1068		1109
1069	Colon-separated list of perl extension scripts to use in this terminal	1110	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1111	use in this terminal instance; option B<-pe>.
		1112
		1113	Extension names can be prefixed with a C<-> sign to prohibit using
		1114	them. This can be useful to selectively disable some extensions loaded
		1115	by default, or specified via the C<perl-ext-common> resource. For
		1116	example, C<default,-selection> will use all the default extension except
		1117	C<selection>.
		1118
		1119	Extension names can also be followed by an argument in angle brackets
		1120	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1121	searchable scrollback to Alt/Meta-s). Mentioning the same extension
		1122	multiple times with different arguments will pass multiple arguments to
		1123	the extension.
		1124
1070	instance. Each extension is looked up in the library directories, loaded	1125	Each extension is looked up in the library directories, loaded if
1071	if necessary, and bound to the current terminal instance. If this resource	1126	necessary, and bound to the current terminal instance.
1072	is empty or missing, then the perl interpreter will not be initialized;	1127
1073	option B<-pe>.	1128	If both of these resources are the empty string, then the perl
		1129	interpreter will not be initialized. The idea behind two options is that
		1130	B<perl-ext-common> will be used for extensions that should be available to
		1131	all instances, while B<perl-ext> is used for specific instances.
1074		1132
1075	=item B<perl-eval>: I<string>	1133	=item B<perl-eval>: I<string>
1076		1134
1077	Perl code to be evaluated when all extensions have been registered. See the	1135	Perl code to be evaluated when all extensions have been registered. See
1078	@@RXVT_NAME@@perl(3) manpage.	1136	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
		1137	will be ignored when running setuid/setgid.
1079		1138
1080	=item B<perl-lib>: I<path>	1139	=item B<perl-lib>: I<path>
1081		1140
1082	Colon-separated list of additional directories that hold extension	1141	Colon-separated list of additional directories that hold extension
1083	scripts. When looking for extensions specified by the C<perl> resource,	1142	scripts. When looking for extensions specified by the C<perl> resource,
1084	@@RXVT_NAME@@ will first look in these directories and then in	1143	@@RXVT_NAME@@ will first look in these directories and then in
1085	F<@@RXVT_LIBDIR@@/urxvt/perl/>.	1144	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
		1145	will be ignored when running setuid/setgid.
1086		1146
1087	See the @@RXVT_NAME@@perl(3) manpage.	1147	See the @@RXVT_NAME@@perl(3) manpage.
		1148
		1149	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1150
		1151	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1152	details.
		1153
		1154	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1155
		1156	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1157	for details.
		1158
		1159	=item B<searchable-scrollback:> I<keysym>
		1160
		1161	Sets the hotkey that starts the incremental scrollback buffer search
		1162	(default: C<M-s>).
		1163
		1164	=item B<urlLauncher>: I<string>
		1165
		1166	Specifies the program to be started with a URL argument. Used by the
		1167	C<selection-popup> and C<matcher> perl extensions.
		1168
		1169	=item B<transient-for>: I<windowid>
		1170
		1171	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1172
		1173	=item B<override-redirect>: I<boolean>
		1174
		1175	Compile I<frills>: Sets override-redirect for the terminal window, making
		1176	it almost invisible to window managers; option B<-override-redirect>.
1088		1177
1089	=back	1178	=back
1090		1179
1091	=head1 THE SCROLLBAR	1180	=head1 THE SCROLLBAR
1092		1181
…		…
1111	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1200	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1112	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1201	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1113	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1202	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1114	respectively.	1203	respectively.
1115		1204
1116	=head1 TEXT SELECTION AND INSERTION	1205	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1117		1206
1118	The behaviour of text selection and insertion mechanism is similar to	1207	The behaviour of text selection and insertion/pasting mechanism is similar
1119	I<xterm>(1).	1208	to I<xterm>(1).
1120		1209
1121	=over 4	1210	=over 4
1122		1211
1123	=item B<Selection>:	1212	=item B<Selecting>:
1124		1213
1125	Left click at the beginning of the region, drag to the end of the region	1214	Left click at the beginning of the region, drag to the end of the region
1126	and release; Right click to extend the marked region; Left double-click	1215	and release; Right click to extend the marked region; Left double-click
1127	to select a word; Left triple-click to select the entire logical line	1216	to select a word; Left triple-click to select the entire logical line
1128	(which can span multiple screen lines), unless modified by resource	1217	(which can span multiple screen lines), unless modified by resource
…		…
1132	(Compile: I<frills>) will create a rectangular selection instead of a	1221	(Compile: I<frills>) will create a rectangular selection instead of a
1133	normal one. In this mode, every selected row becomes its own line in the	1222	normal one. In this mode, every selected row becomes its own line in the
1134	selection, and trailing whitespace is visually underlined and removed from	1223	selection, and trailing whitespace is visually underlined and removed from
1135	the selection.	1224	the selection.
1136		1225
1137	=item B<Insertion>:	1226	=item B<Pasting>:
1138		1227
1139	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1228	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1140	an B<@@RXVT_NAME@@> window causes the current text selection to be	1229	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1141	inserted as if it had been typed on the keyboard.	1230	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1231
		1232	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1233	inserted too.
1142		1234
1143	=back	1235	=back
1144		1236
1145	=head1 CHANGING FONTS	1237	=head1 CHANGING FONTS
1146		1238
1147	Changing fonts (or font sizes, respectively) via the keypad is not yet	1239	Changing fonts (or font sizes, respectively) via the keypad is not yet
1148	supported in rxvt-unicode. Bug me if you need this.	1240	supported in rxvt-unicode. Bug me if you need this.
1149		1241
1150	You can, however, switch fonts at runtime using escape sequences (and	1242	You can, however, switch fonts at runtime using escape sequences, e.g.:
1151	therefore using the menubar), e.g.:
1152		1243
1153	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"	1244	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1245
		1246	You can use keyboard shortcuts, too:
		1247
		1248	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1249	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1154		1250
1155	rxvt-unicode will automatically re-apply these fonts to the output so far.	1251	rxvt-unicode will automatically re-apply these fonts to the output so far.
1156		1252
1157	=head1 ISO 14755 SUPPORT	1253	=head1 ISO 14755 SUPPORT
1158		1254
…		…
1186	This mode lets you input characters representing the keycap symbols of	1282	This mode lets you input characters representing the keycap symbols of
1187	your keyboard, if representable in the current locale encoding.	1283	your keyboard, if representable in the current locale encoding.
1188		1284
1189	Start by pressing C<Control> and C<Shift> together, then releasing	1285	Start by pressing C<Control> and C<Shift> together, then releasing
1190	them. The next special key (cursor keys, home etc.) you enter will not	1286	them. The next special key (cursor keys, home etc.) you enter will not
1191	invoke it's usual function but instead will insert the corresponding	1287	invoke its usual function but instead will insert the corresponding
1192	keycap symbol. The symbol will only be entered when the key has been	1288	keycap symbol. The symbol will only be entered when the key has been
1193	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1289	released, otherwise pressing e.g. C<Shift> would enter the symbol for
1194	C<ISO Level 2 Switch>, although your intention might have been to enter a	1290	C<ISO Level 2 Switch>, although your intention might have been to enter a
1195	reverse tab (Shift-Tab).	1291	reverse tab (Shift-Tab).
1196		1292
…		…
1229	=head1 COLORS AND GRAPHICS	1325	=head1 COLORS AND GRAPHICS
1230		1326
1231	In addition to the default foreground and background colours,	1327	In addition to the default foreground and background colours,
1232	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1328	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1233	high-intensity bold/blink versions of the same). Here is a list of the	1329	high-intensity bold/blink versions of the same). Here is a list of the
1234	colours with their B<rgb.txt> names.	1330	colours with their names.
1235		1331
1236	=begin table	1332	=begin table
1237		1333
1238	B<color0> (black) = Black	1334	B<color0> (black) = Black
1239	B<color1> (red) = Red3	1335	B<color1> (red) = Red3
…		…
1259	It is also possible to specify the colour values of B<foreground>,	1355	It is also possible to specify the colour values of B<foreground>,
1260	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1356	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1261	a number 0-15, as a convenient shorthand to reference the colour name of	1357	a number 0-15, as a convenient shorthand to reference the colour name of
1262	color0-color15.	1358	color0-color15.
1263		1359
		1360	In addition to the colours defined above, @@RXVT_NAME@@ offers an
		1361	additional 72 colours. The first 64 of those (with indices 16 to 79)
		1362	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
		1363	16>), followed by 8 additional shades of gray (with indices 80 to 87).
		1364
		1365	Together, all those colours implement the 88 colour xterm colours. Only
		1366	the first 16 can be changed using resources currently, the rest can only
		1367	be changed via command sequences ("escape codes").
		1368
1264	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1369	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1265	always swapping the foreground/background colours. This is in contrast to	1370	always swapping the foreground/background colours. This is in contrast to
1266	I<xterm>(1) where the colours are only swapped if they have not otherwise	1371	I<xterm>(1) where the colours are only swapped if they have not otherwise
1267	been specified. For example,	1372	been specified. For example,
1268		1373
…		…
1273	would yield White on Black, while on I<xterm>(1) it would yield Black	1378	would yield White on Black, while on I<xterm>(1) it would yield Black
1274	on White.	1379	on White.
1275		1380
1276	=back	1381	=back
1277		1382
		1383	=head2 ALPHA CHANNEL SUPPORT
		1384
		1385	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1386	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
		1387	(recommended, but B<MUST> have 4 digits/component) colour specifications,
		1388	in addition to the ones provided by X, where the additional A component
		1389	specifies opacity (alpha) values. The minimum value of C<0> is completely
		1390	transparent). You can also prefix any color with C<[percent]>, where
		1391	C<percent> is a decimal percentage (0-100) that specifies the opacity of
		1392	the color, where C<0> is completely transparent and C<100> is completelxy
		1393	opaque.
		1394
		1395	You probably need to specify B<"-depth 32">, too, and have the luck that
		1396	your X-server uses ARGB pixel layout, as X is far from just supporting
		1397	ARGB visuals out of the box, and rxvt-unicode just fudges around.
		1398
		1399	For example, the following selects an almost completely transparent red
		1400	background, and an almost opaque pink foreground:
		1401
		1402	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
		1403
		1404	I<Please note that transparency of any kind if completely unsupported by
		1405	the author. Don't bug him with installation questions!>
		1406
1278	=head1 ENVIRONMENT	1407	=head1 ENVIRONMENT
1279		1408
1280	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1409	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1281		1410
1282	=over 4	1411	=over 4
1283		1412
1284	=item B<TERM>	1413	=item B<TERM>
1285		1414
1286	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1415	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1287	resources or on the commandline.	1416	resources or on the command line.
1288		1417
1289	=item B<COLORTERM>	1418	=item B<COLORTERM>
1290		1419
1291	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1420	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1292	compiled with XPM support, and optionally with the added extension	1421	compiled with XPM support, and optionally with the added extension
1293	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1422	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1294		1423
1295	=item B<COLORFGBG>	1424	=item B<COLORFGBG>
1296		1425
…		…
1314	C<--with-terminfo=PATH>.	1443	C<--with-terminfo=PATH>.
1315		1444
1316	=item B<DISPLAY>	1445	=item B<DISPLAY>
1317		1446
1318	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1447	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1319	display in it's child processes.	1448	display in its child processes.
1320		1449
1321	=item B<SHELL>	1450	=item B<SHELL>
1322		1451
1323	The shell to be used for command execution, defaults to C</bin/sh>.	1452	The shell to be used for command execution, defaults to C</bin/sh>.
1324
1325	=item B<RXVTPATH>
1326
1327	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1328	files.
1329
1330	=item B<PATH>
1331
1332	Used in the same way as C<RXVTPATH>.
1333		1453
1334	=item B<RXVT_SOCKET>	1454	=item B<RXVT_SOCKET>
1335		1455
1336	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1456	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1337	@@RXVT_NAME@@d(1).	1457	@@RXVT_NAME@@d(1).
…		…
1375		1495
1376	=item Project Coordinator	1496	=item Project Coordinator
1377		1497
1378	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1498	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1379		1499
1380	L<http://software.schmorp.de/#rxvt-unicode>	1500	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1381		1501
1382	=back	1502	=back
1383		1503
1384	=head1 AUTHORS	1504	=head1 AUTHORS
1385		1505
…		…
1407		1527
1408	Project Coordinator (changes.txt 2.21a to 2.4.5)	1528	Project Coordinator (changes.txt 2.21a to 2.4.5)
1409		1529
1410	=item Geoff Wing L<< <gcw@pobox.com> >>	1530	=item Geoff Wing L<< <gcw@pobox.com> >>
1411		1531
1412	Rewrote screen display and text selection routines. Project Coordinator	1532	Rewrote screen display and text selection routines.
		1533
1413	(changes.txt 2.4.6 - rxvt-unicode)	1534	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1414		1535
1415	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1536	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1416		1537
1417	Forked rxvt-unicode, rewrote most of the display code and internal	1538	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1418	character handling to store text in unicode, improve xterm	1539	extension, random hacks, numerous bugfixes and extensions.
1419	compatibility and apply numerous other bugfixes and extensions.
1420		1540
1421	Project Coordinator (Changes 1.0 -)	1541	Project Coordinator (Changes 1.0 -)
1422		1542
		1543	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1544
		1545	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
		1546
1423	=back	1547	=back
1424		1548

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.83 by root, Tue Jan 3 22:28:07 2006 UTC vs. Revision 1.129 by root, Mon May 28 20:34:56 2007 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.83 by root, Tue Jan 3 22:28:07 2006 UTC vs.
Revision 1.129 by root, Mon May 28 20:34:56 2007 UTC