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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.109 by root, Sun Jan 29 22:27:04 2006 UTC vs.
Revision 1.137 by root, Sat Sep 1 09:38:50 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 devanagari. 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
…		…
108		108
109	Turn on/off simulated reverse video; resource B<reverseVideo>.	109	Turn on/off simulated reverse video; resource B<reverseVideo>.
110		110
111	=item B<-j>\|B<+j>	111	=item B<-j>\|B<+j>
112		112
113	Turn on/off jump scrolling; resource B<jumpScroll>.	113	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
		114
		115	=item B<-ss>\|B<+ss>
		116
		117	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
114		118
115	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>	119	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>
116		120
117	Turn on/off inheriting parent window's pixmap. Alternative form is	121	Turn on/off inheriting parent window's pixmap. Alternative form is
118	B<-tr>; resource B<inheritPixmap>.	122	B<-tr>; resource B<inheritPixmap>.
		123
		124	I<Please note that transparency of any kind if completely unsupported by
		125	the author. Don't bug him with installation questions! Read the FAQ (man 7
		126	@@RXVT_NAME@@)!>
119		127
120	=item B<-fade> I<number>	128	=item B<-fade> I<number>
121		129
122	Fade the text by the given percentage when focus is lost. Small values	130	Fade the text by the given percentage when focus is lost. Small values
123	fade a little only, 100 completely replaces all colours by the fade	131	fade a little only, 100 completely replaces all colours by the fade
124	colour; resource B<fading>.	132	colour; resource B<fading>.
125		133
126	=item B<-fadecolor> I<colour>	134	=item B<-fadecolor> I<colour>
127		135
128	Fade to this colour when fading is used (see B<-fade>). The default colour	136	Fade to this colour when fading is used (see B<-fade>). The default colour
129	is black. resource B<fadeColor>.	137	is opaque black. resource B<fadeColor>.
130		138
131	=item B<-tint> I<colour>	139	=item B<-tint> I<colour>
132		140
133	Tint the transparent background pixmap with the given colour when	141	Tint the transparent background pixmap with the given colour when
134	transparency is enabled with B<-tr> or B<-ip>. This only works for	142	transparency is enabled with B<-tr> or B<-ip>. This only works for
135	non-tiled backgrounds, currently. See also the B<-sh> option that can be	143	non-tiled backgrounds, currently. See also the B<-sh> option that can be
136	used to brighten or darken the image in addition to tinting it; resource	144	used to brighten or darken the image in addition to tinting it.
		145	Please note that certain tint colours can be applied on the server-side,
		146	thus yielding performance gain of two orders of magnitude. These colours are:
		147	blue, red, green, cyan, magenta, yellow, and those close to them; resource
137	I<tintColor>. Example:	148	I<tintColor>. Example:
138		149
139	@@RXVT_NAME@@ -tr -tint blue -sh 40	150	@@RXVT_NAME@@ -tr -tint blue -sh 40
140		151
141	=item B<-sh>	152	=item B<-sh> I<number>
142		153
143	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	154	Darken (0 .. 100) or lighten (-1 .. -100) the transparent
144	background image in addition to tinting it (i.e. B<-tint> must be	155	background image in addition to (or instead of) tinting it;
145	specified, too, e.g. C<-tint white>).	156	resource I<shading>.
		157
		158	=item B<-blt> I<string>
		159
		160	Specify background blending type. If background pixmap is specified
		161	at the same time as transparency - such pixmap will be blended over
		162	transparency image, using method specified. Supported values are :
		163	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
		164	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
		165	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
		166	alpha-blending; resource I<blendType>.
		167
		168	=item B<-blr> I<HxV>
		169
		170	Apply Gaussian Blur with the specified radii to the transparent
		171	background image. If single number is specified - both vertical and
		172	horizontal radii are considered to be the same. Setting one of the
		173	radii to 1 and another to a large number creates interesting effects
		174	on some backgrounds. Maximum radius value is 128; resource I<blurRadius>.
146		175
147	=item B<-bg> I<colour>	176	=item B<-bg> I<colour>
148		177
149	Window background colour; resource B<background>.	178	Window background colour; resource B<background>.
150		179
…		…
152		181
153	Window foreground colour; resource B<foreground>.	182	Window foreground colour; resource B<foreground>.
154		183
155	=item B<-pixmap> I<file[;geom]>	184	=item B<-pixmap> I<file[;geom]>
156		185
157	Compile I<XPM>: Specify XPM file for the background and also optionally	186	Compile I<afterimage>: Specify image file for the background and also
158	specify its scaling with a geometry string. Note you may need to	187	optionally specify its scaling with a geometry string. Note you may need to
159	add quotes to avoid special shell interpretation of the C<;> in the	188	add quotes to avoid special shell interpretation of the C<;> in the
160	command-line; resource B<backgroundPixmap>.	189	command-line; for more details see resource B<backgroundPixmap>.
161		190
162	=item B<-cr> I<colour>	191	=item B<-cr> I<colour>
163		192
164	The cursor colour; resource B<cursorColor>.	193	The cursor colour; resource B<cursorColor>.
165		194
…		…
182	that are checked in order when trying to find glyphs for characters. The	211	that are checked in order when trying to find glyphs for characters. The
183	first font defines the cell size for characters; other fonts might be	212	first font defines the cell size for characters; other fonts might be
184	smaller, but not (in general) larger. A (hopefully) reasonable default	213	smaller, but not (in general) larger. A (hopefully) reasonable default
185	font list is always appended to it. See resource B<font> for more details.	214	font list is always appended to it. See resource B<font> for more details.
186		215
187	In short, to specify an X11 core font, just specify it's name or prefix it	216	In short, to specify an X11 core font, just specify its name or prefix it
188	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,	217	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
189	e.g.:	218	e.g.:
190		219
191	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	220	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
192	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	221	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
318		347
319	=item B<-lsp> I<number>	348	=item B<-lsp> I<number>
320		349
321	Compile I<frills>: Lines (pixel height) to insert between each row of	350	Compile I<frills>: Lines (pixel height) to insert between each row of
322	the display. Useful to work around font rendering problems; resource	351	the display. Useful to work around font rendering problems; resource
323	B<linespace>.	352	B<lineSpace>.
324		353
325	=item B<-tn> I<termname>	354	=item B<-tn> I<termname>
326		355
327	This option specifies the name of the terminal type to be set in the	356	This option specifies the name of the terminal type to be set in the
328	B<TERM> environment variable. This terminal type must exist in the	357	B<TERM> environment variable. This terminal type must exist in the
…		…
382	for more info.	411	for more info.
383		412
384	=item B<-tcw>	413	=item B<-tcw>
385		414
386	Change the meaning of triple-click selection with the left mouse	415	Change the meaning of triple-click selection with the left mouse
		416	button. Only effective when the original (non-perl) selection code is
387	button. Instead of selecting a full line it will extend the selection the	417	in-use. Instead of selecting a full line it will extend the selection the
388	end of the logical line only. resource B<tripleclickwords>.	418	end of the logical line only. resource B<tripleclickwords>.
389		419
390	=item B<-insecure>	420	=item B<-insecure>
391		421
392	Enable "insecure" mode, which currently enables most of the escape	422	Enable "insecure" mode, which currently enables most of the escape
…		…
420		450
421	Remap a key symbol. See resource B<keysym>.	451	Remap a key symbol. See resource B<keysym>.
422		452
423	=item B<-embed> I<windowid>	453	=item B<-embed> I<windowid>
424		454
425	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,	455	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
426	which enables applications to easily embed a terminal.	456	which enables applications to easily embed a terminal.
427		457
428	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it	458	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
429	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it	459	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
430	quite a bit, so don't expect it to keep some specific state. It's best to	460	quite a bit, so don't expect it to keep some specific state. It's best to
…		…
433	The window will not be destroyed when @@RXVT_NAME@@ exits.	463	The window will not be destroyed when @@RXVT_NAME@@ exits.
434		464
435	It might be useful to know that @@RXVT_NAME@@ will not close file	465	It might be useful to know that @@RXVT_NAME@@ will not close file
436	descriptors passed to it (except for stdin/out/err, of course), so you	466	descriptors passed to it (except for stdin/out/err, of course), so you
437	can use file descriptors to communicate with the programs within the	467	can use file descriptors to communicate with the programs within the
438	terminal. This works regardless of wether the C<-embed> option was used or	468	terminal. This works regardless of whether the C<-embed> option was used or
439	not.	469	not.
440		470
441	Here is a short Gtk2-perl snippet that illustrates how this option can be	471	Here is a short Gtk2-perl snippet that illustrates how this option can be
442	used (a longer example is in F<doc/embed>):	472	used (a longer example is in F<doc/embed>):
443		473
…		…
448	});	478	});
449		479
450	=item B<-pty-fd> I<file descriptor>	480	=item B<-pty-fd> I<file descriptor>
451		481
452	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	482	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
453	pair but instead use the given filehandle as the tty master. This is	483	pair but instead use the given file descriptor as the tty master. This is
454	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator	484	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
455	without having to run a program within it.	485	without having to run a program within it.
456		486
457	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	487	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
458	entries and will not tinker with pty/tty permissions - you have to do that	488	entries and will not tinker with pty/tty permissions - you have to do that
…		…
560	Use the specified colour to display underlined characters when the	590	Use the specified colour to display underlined characters when the
561	foreground colour is the default.	591	foreground colour is the default.
562		592
563	=item B<colorRV:> I<colour>	593	=item B<colorRV:> I<colour>
564		594
565	Use the specified colour as the background for reverse video	595	Use the specified colour as the background for reverse video characters
566	characters.	596	when OPTION_HC is disabled (--disable-frills).
567		597
568	=item B<underlineColor:> I<colour>	598	=item B<underlineColor:> I<colour>
569		599
570	If set, use the specified colour as the colour for the underline	600	If set, use the specified colour as the colour for the underline
571	itself. If unset, use the foreground colour.	601	itself. If unset, use the foreground colour.
…		…
587	option B<-rv>. B<False>: regular screen colours [default]; option	617	option B<-rv>. B<False>: regular screen colours [default]; option
588	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	618	B<+rv>. See note in B<COLORS AND GRAPHICS> section.
589		619
590	=item B<jumpScroll:> I<boolean>	620	=item B<jumpScroll:> I<boolean>
591		621
592	B<True>: specify that jump scrolling should be used. When scrolling	622	B<True>: specify that jump scrolling should be used. When receiving lots
593	quickly, fewer screen updates are performed [default]; option B<-j>.	623	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		624	has been read, resulting in fewer updates while still displaying every
		625	received line; option B<-j>.
		626
594	B<False>: specify that smooth scrolling should be used; option B<+j>.	627	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		628	force a screen refresh on each new line it received; option B<+j>.
		629
		630	=item B<skipScroll:> I<boolean>
		631
		632	B<True>: (the default) specify that skip scrolling should be used. When
		633	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
		634	(around 60 times per second), resulting in far fewer updates. This can
		635	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		636	option B<-ss>.
		637
		638	B<False>: specify that everything is to be displayed, even
		639	if the refresh is too fast for the human eye to read anything (or the
		640	monitor to display anything); option B<+ss>.
595		641
596	=item B<inheritPixmap:> I<boolean>	642	=item B<inheritPixmap:> I<boolean>
597		643
598	B<True>: make the background inherit the parent windows' pixmap, giving	644	B<True>: make the background inherit the parent windows' pixmap, giving
599	artificial transparency. B<False>: do not inherit the parent windows'	645	artificial transparency. B<False>: do not inherit the parent windows'
600	pixmap.	646	pixmap.
601		647
		648	I<Please note that transparency of any kind if completely unsupported by
		649	the author. Don't bug him with installation questions!>
		650
602	=item B<fading:> I<number>	651	=item B<fading:> I<number>
603		652
604	Fade the text by the given percentage when focus is lost; option B<-fade>.	653	Fade the text by the given percentage when focus is lost; option B<-fade>.
605		654
606	=item B<fadeColor:> I<colour>	655	=item B<fadeColor:> I<colour>
…		…
613	Tint the transparent background pixmap with the given colour; option	662	Tint the transparent background pixmap with the given colour; option
614	B<-tint>.	663	B<-tint>.
615		664
616	=item B<shading:> I<number>	665	=item B<shading:> I<number>
617		666
618	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	667	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
619	image in addition to tinting it.	668	in addition to tinting it; option B<-sh>.
		669
		670	=item B<blendType:> I<string>
		671
		672	Specify background blending type; option B<-blt>.
		673
		674	=item B<blurRadius:> I<number>
		675
		676	Apply Gaussian Blurr with the specified radius to the transparent
		677	background image; option B<-blr>.
620		678
621	=item B<scrollColor:> I<colour>	679	=item B<scrollColor:> I<colour>
622		680
623	Use the specified colour for the scrollbar [default #B2B2B2].	681	Use the specified colour for the scrollbar [default #B2B2B2].
624		682
…		…
632	The colour of the border around the text area and between the scrollbar	690	The colour of the border around the text area and between the scrollbar
633	and the text.	691	and the text.
634		692
635	=item B<backgroundPixmap:> I<file[;geom]>	693	=item B<backgroundPixmap:> I<file[;geom]>
636		694
637	Use the specified XPM file (note the `.xpm' extension is optional) for	695	Use the specified image file for the background and also optionally
638	the background and also optionally specify its scaling with a geometry	696	specify its scaling with a geometry string B<WxH+X+Y>,
639	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	697	in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
640	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	698	and B<"X" / "Y"> locate the image centre (percent).
641	centre (percent). A scale of 0 displays the image with tiling. A scale	699	A scale of 0 displays the image with tiling. A scale of 1 displays the
642	of 1 displays the image without any scaling. A scale of 2 to 9	700	image without any scaling. A scale of 2 to 9 specifies an integer
643	specifies an integer number of images in that direction. No image will	701	number of images in that direction. No image will be magnified beyond
644	be magnified beyond 10 times its original size. The maximum permitted	702	10 times its original size. The maximum permitted scale is 1000.
645	scale is 1000. [default 0x0+50+50]	703	Special string of B<"auto"> used as a geometry will cause image to be
		704	automatically scaled to match window size.
		705	If used in conjunction with B<-tr> option - specified pixmap will be
		706	blended over transparency image using either alpha-blending, or any
		707	other blending type, specified with B<-blt "type"> option.
		708	[default 0x0+50+50]
646		709
647	=item B<path:> I<path>	710	=item B<path:> I<path>
648		711
649	Specify the colon-delimited search path for finding XPM files.	712	Specify the colon-delimited search path for finding XPM files.
650		713
…		…
712		775
713	=item B<intensityStyles:> I<boolean>	776	=item B<intensityStyles:> I<boolean>
714		777
715	When font styles are not enabled, or this option is enabled (B<True>,	778	When font styles are not enabled, or this option is enabled (B<True>,
716	option B<-is>, the default), bold and italic font styles imply high	779	option B<-is>, the default), bold and italic font styles imply high
717	intensity foreground/backround colours. Disabling this option (B<False>,	780	intensity foreground/background colours. Disabling this option (B<False>,
718	option B<+is>) disables this behaviour, the high intensity colours are not	781	option B<+is>) disables this behaviour, the high intensity colours are not
719	reachable.	782	reachable.
720		783
721	=item B<selectstyle:> I<mode>	784	=item B<selectstyle:> I<mode>
722		785
723	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	786	Set mouse selection style to B<old> which is 2.20, B<oldword> which
724	xterm style with 2.20 old word selection, or anything else which gives	787	is xterm style with 2.20 old word selection, or anything else which
725	xterm style selection.	788	gives xterm style selection. Only effective when the original (non-perl)
		789	selection code is in use.
726		790
727	=item B<scrollstyle:> I<mode>	791	=item B<scrollstyle:> I<mode>
728		792
729	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	793	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
730	the author's favourite.	794	the author's favourite.
…		…
744	=item B<mapAlert:> I<boolean>	808	=item B<mapAlert:> I<boolean>
745		809
746	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	810	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
747	de-iconify (map) on receipt of a bell character [default].	811	de-iconify (map) on receipt of a bell character [default].
748		812
		813	=item B<urgentOnBell:> I<boolean>
		814
		815	B<True>: set the urgency hint for the wm on receipt of a bell character.
		816	B<False>: do not set the urgency hint [default].
		817
749	=item B<visualBell:> I<boolean>	818	=item B<visualBell:> I<boolean>
750		819
751	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	820	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
752	B<False>: no visual bell [default]; option B<+vb>.	821	B<False>: no visual bell [default]; option B<+vb>.
753		822
…		…
774	Example:	843	Example:
775		844
776	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	845	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
777		846
778	This creates a new file in your home directory with the screen contents	847	This creates a new file in your home directory with the screen contents
779	everytime you hit C<Print>.	848	every time you hit C<Print>.
780		849
781	=item B<scrollBar:> I<boolean>	850	=item B<scrollBar:> I<boolean>
782		851
783	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	852	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
784	disable the scrollbar; option B<+sb>.	853	disable the scrollbar; option B<+sb>.
…		…
806		875
807	=item B<scrollWithBuffer:> I<boolean>	876	=item B<scrollWithBuffer:> I<boolean>
808		877
809	B<True>: scroll with scrollback buffer when tty receives new lines (and	878	B<True>: scroll with scrollback buffer when tty receives new lines (and
810	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	879	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
811	with scrollback buffer when tty recieves new lines; option B<+sw>.	880	with scrollback buffer when tty receives new lines; option B<+sw>.
812		881
813	=item B<scrollTtyKeypress:> I<boolean>	882	=item B<scrollTtyKeypress:> I<boolean>
814		883
815	B<True>: scroll to bottom when a non-special key is pressed. Special keys	884	B<True>: scroll to bottom when a non-special key is pressed. Special keys
816	are those which are intercepted by rxvt-unicode for special handling and	885	are those which are intercepted by rxvt-unicode for special handling and
…		…
847	=item B<termName:> I<termname>	916	=item B<termName:> I<termname>
848		917
849	Specifies the terminal type name to be set in the B<TERM> environment	918	Specifies the terminal type name to be set in the B<TERM> environment
850	variable; option B<-tn>.	919	variable; option B<-tn>.
851		920
852	=item B<linespace:> I<number>	921	=item B<lineSpace:> I<number>
853		922
854	Specifies number of lines (pixel height) to insert between each row of	923	Specifies number of lines (pixel height) to insert between each row of
855	the display [default 0]; option B<-lsp>.	924	the display [default 0]; option B<-lsp>.
856		925
857	=item B<meta8:> I<boolean>	926	=item B<meta8:> I<boolean>
…		…
909	=item B<cutchars:> I<string>	978	=item B<cutchars:> I<string>
910		979
911	The characters used as delimiters for double-click word selection	980	The characters used as delimiters for double-click word selection
912	(whitespace delimiting is added automatically if resource is given).	981	(whitespace delimiting is added automatically if resource is given).
913		982
914	When the selection extension is in use (the default if compiled in, see	983	When the perl selection extension is in use (the default if compiled
915	the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters	984	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
916	will be created (if the resource exists, otherwise, no regex will be	985	characters will be created (if the resource exists, otherwise, no regex
917	created). In this mode, characters outside ISO-8859-1 can be used.	986	will be created). In this mode, characters outside ISO-8859-1 can be used.
918		987
919	When the selection extension is not used, only ISO-8859-1 characters can	988	When the selection extension is not used, only ISO-8859-1 characters can
920	be used. If not specified, the built-in default is used:	989	be used. If not specified, the built-in default is used:
921		990
922	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	991	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>
…		…
981		1050
982	Turn on/off secondary screen (default enabled).	1051	Turn on/off secondary screen (default enabled).
983		1052
984	=item B<secondaryScroll:> I<boolean>	1053	=item B<secondaryScroll:> I<boolean>
985		1054
986	Turn on/off secondary screen scroll (default enabled). If the this	1055	Turn on/off secondary screen scroll (default enabled). If this
987	option is enabled, scrolls on the secondary screen will change the	1056	option is enabled, scrolls on the secondary screen will change the
988	scrollback buffer and switching to/from the secondary screen will	1057	scrollback buffer and switching to/from the secondary screen will
989	instead scroll the screen up.	1058	instead scroll the screen up.
990		1059
991	=item B<hold>: I<boolean>	1060	=item B<hold>: I<boolean>
…		…
1019		1088
1020	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1089	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
1021	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1090	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
1022	C<\000>: octal number) or verbatim control characters (C<^?>: delete,	1091	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1023	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it	1092	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1024	can start or end with whitespace.	1093	can start or end with whitespace. B<This feature is deprecated and will
		1094	be removed>.
1025		1095
1026	Please note that you need to double the C<\> in resource files, as	1096	Please note that you need to double the C<\> in resource files, as
1027	Xlib itself does it's own de-escaping (you can use C<\033> instead of	1097	Xlib itself does its own de-escaping (you can use C<\033> instead of
1028	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own	1098	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1029	processing).	1099	processing).
1030		1100
1031	You can define a range of keysyms in one shot by providing a I<string>	1101	You can define a range of keysyms in one shot by providing a I<string>
1032	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1102	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1033	should be a character not used by the strings.	1103	should be a character not used by the strings.
1034		1104
1035	Its usage can be demonstrated by an example:	1105	Its usage can be demonstrated by an example:
1036		1106
1037	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1107	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
…		…
1101	example, C<default,-selection> will use all the default extension except	1171	example, C<default,-selection> will use all the default extension except
1102	C<selection>.	1172	C<selection>.
1103		1173
1104	Extension names can also be followed by an argument in angle brackets	1174	Extension names can also be followed by an argument in angle brackets
1105	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1175	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1106	searchable scorllback to Alt/Meta-s). Mentioning the same extension	1176	searchable scrollback to Alt/Meta-s). Mentioning the same extension
1107	multiple times with different arguments will pass multiple arguments to	1177	multiple times with different arguments will pass multiple arguments to
1108	the extension.	1178	the extension.
1109		1179
1110	Each extension is looked up in the library directories, loaded if	1180	Each extension is looked up in the library directories, loaded if
1111	necessary, and bound to the current terminal instance.	1181	necessary, and bound to the current terminal instance.
…		…
1147	(default: C<M-s>).	1217	(default: C<M-s>).
1148		1218
1149	=item B<urlLauncher>: I<string>	1219	=item B<urlLauncher>: I<string>
1150		1220
1151	Specifies the program to be started with a URL argument. Used by the	1221	Specifies the program to be started with a URL argument. Used by the
1152	C<selection-popup> and C<mark-urls> perl extensions.	1222	C<selection-popup> and C<matcher> perl extensions.
1153		1223
1154	=item B<transient-for>: I<windowid>	1224	=item B<transient-for>: I<windowid>
1155		1225
1156	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.	1226	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1157		1227
1158	=item B<override-redirect>: I<boolean>	1228	=item B<override-redirect>: I<boolean>
1159		1229
1160	Compile I<frills>: Sets override-redirect for the terminal window, making	1230	Compile I<frills>: Sets override-redirect for the terminal window, making
1161	it almost invisible to window managers; option B<-override-redirect>.	1231	it almost invisible to window managers; option B<-override-redirect>.
		1232
		1233	=item B<iso14755_52:> I<boolean>
		1234
		1235	Turn on/off ISO 14755 5.2 mode (default enabled).
1162		1236
1163	=back	1237	=back
1164		1238
1165	=head1 THE SCROLLBAR	1239	=head1 THE SCROLLBAR
1166		1240
…		…
1185	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1259	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1186	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1260	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1187	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1261	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1188	respectively.	1262	respectively.
1189		1263
1190	=head1 TEXT SELECTION AND INSERTION	1264	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1191		1265
1192	The behaviour of text selection and insertion mechanism is similar to	1266	The behaviour of text selection and insertion/pasting mechanism is similar
1193	I<xterm>(1).	1267	to I<xterm>(1).
1194		1268
1195	=over 4	1269	=over 4
1196		1270
1197	=item B<Selection>:	1271	=item B<Selecting>:
1198		1272
1199	Left click at the beginning of the region, drag to the end of the region	1273	Left click at the beginning of the region, drag to the end of the region
1200	and release; Right click to extend the marked region; Left double-click	1274	and release; Right click to extend the marked region; Left double-click
1201	to select a word; Left triple-click to select the entire logical line	1275	to select a word; Left triple-click to select the entire logical line
1202	(which can span multiple screen lines), unless modified by resource	1276	(which can span multiple screen lines), unless modified by resource
…		…
1206	(Compile: I<frills>) will create a rectangular selection instead of a	1280	(Compile: I<frills>) will create a rectangular selection instead of a
1207	normal one. In this mode, every selected row becomes its own line in the	1281	normal one. In this mode, every selected row becomes its own line in the
1208	selection, and trailing whitespace is visually underlined and removed from	1282	selection, and trailing whitespace is visually underlined and removed from
1209	the selection.	1283	the selection.
1210		1284
1211	=item B<Insertion>:	1285	=item B<Pasting>:
1212		1286
1213	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>	1287	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1214	window causes the value of the PRIMARY selection (or CLIPBOARD with the	1288	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1215	Meta modifier) to be inserted as if it had been typed on the keyboard.	1289	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1216		1290
1217	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1291	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1218	inserted too.	1292	inserted too.
1219		1293
1220	=back	1294	=back
…		…
1237		1311
1238	=head1 ISO 14755 SUPPORT	1312	=head1 ISO 14755 SUPPORT
1239		1313
1240	ISO 14755 is a standard for entering and viewing unicode characters	1314	ISO 14755 is a standard for entering and viewing unicode characters
1241	and character codes using the keyboard. It consists of 4 parts. The	1315	and character codes using the keyboard. It consists of 4 parts. The
1242	first part is available rxvt-unicode has been compiled with	1316	first part is available if rxvt-unicode has been compiled with
1243	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1317	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1244	with C<--enable-iso14755>.	1318	with C<--enable-iso14755>.
1245		1319
1246	=over 4	1320	=over 4
1247		1321
…		…
1267	This mode lets you input characters representing the keycap symbols of	1341	This mode lets you input characters representing the keycap symbols of
1268	your keyboard, if representable in the current locale encoding.	1342	your keyboard, if representable in the current locale encoding.
1269		1343
1270	Start by pressing C<Control> and C<Shift> together, then releasing	1344	Start by pressing C<Control> and C<Shift> together, then releasing
1271	them. The next special key (cursor keys, home etc.) you enter will not	1345	them. The next special key (cursor keys, home etc.) you enter will not
1272	invoke it's usual function but instead will insert the corresponding	1346	invoke its usual function but instead will insert the corresponding
1273	keycap symbol. The symbol will only be entered when the key has been	1347	keycap symbol. The symbol will only be entered when the key has been
1274	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1348	released, otherwise pressing e.g. C<Shift> would enter the symbol for
1275	C<ISO Level 2 Switch>, although your intention might have been to enter a	1349	C<ISO Level 2 Switch>, although your intention might have been to enter a
1276	reverse tab (Shift-Tab).	1350	reverse tab (Shift-Tab).
1277		1351
…		…
1340	It is also possible to specify the colour values of B<foreground>,	1414	It is also possible to specify the colour values of B<foreground>,
1341	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1415	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1342	a number 0-15, as a convenient shorthand to reference the colour name of	1416	a number 0-15, as a convenient shorthand to reference the colour name of
1343	color0-color15.	1417	color0-color15.
1344		1418
1345	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1419	In addition to the colours defined above, @@RXVT_NAME@@ offers an
1346	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1420	additional 72 colours. The first 64 of those (with indices 16 to 79)
1347	(recommended, but B<MUST> have 4 digits/component), C<#ARGB>, C<#AARRGGBB>	1421	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1348	and C<#AAAARRRRGGGGBBBB> colour specifications, in addition to the ones	1422	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1349	provided by X, where the additional A component specifies alpha (opacity)	1423
1350	values (0 is completely transparent and the maximum is opaque). You	1424	Together, all those colours implement the 88 colour xterm colours. Only
1351	probably need to specify B<"-depth 32">, too, and have the luck that your	1425	the first 16 can be changed using resources currently, the rest can only
1352	X-server uses ARGB pixel layout, as X is far from just supporting ARGB	1426	be changed via command sequences ("escape codes").
1353	visuals out of the box, and rxvt-unicode just fudges around.
1354		1427
1355	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1428	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1356	always swapping the foreground/background colours. This is in contrast to	1429	always swapping the foreground/background colours. This is in contrast to
1357	I<xterm>(1) where the colours are only swapped if they have not otherwise	1430	I<xterm>(1) where the colours are only swapped if they have not otherwise
1358	been specified. For example,	1431	been specified. For example,
…		…
1364	would yield White on Black, while on I<xterm>(1) it would yield Black	1437	would yield White on Black, while on I<xterm>(1) it would yield Black
1365	on White.	1438	on White.
1366		1439
1367	=back	1440	=back
1368		1441
		1442	=head2 ALPHA CHANNEL SUPPORT
		1443
		1444	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1445	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
		1446	(recommended, but B<MUST> have 4 digits/component) colour specifications,
		1447	in addition to the ones provided by X, where the additional A component
		1448	specifies opacity (alpha) values. The minimum value of C<0> is completely
		1449	transparent). You can also prefix any color with C<[percent]>, where
		1450	C<percent> is a decimal percentage (0-100) that specifies the opacity of
		1451	the color, where C<0> is completely transparent and C<100> is completelxy
		1452	opaque.
		1453
		1454	You probably need to specify B<"-depth 32">, too, and have the luck that
		1455	your X-server uses ARGB pixel layout, as X is far from just supporting
		1456	ARGB visuals out of the box, and rxvt-unicode just fudges around.
		1457
		1458	For example, the following selects an almost completely transparent red
		1459	background, and an almost opaque pink foreground:
		1460
		1461	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
		1462
		1463	I<Please note that transparency of any kind if completely unsupported by
		1464	the author. Don't bug him with installation questions!>
		1465
1369	=head1 ENVIRONMENT	1466	=head1 ENVIRONMENT
1370		1467
1371	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1468	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1372		1469
1373	=over 4	1470	=over 4
1374		1471
1375	=item B<TERM>	1472	=item B<TERM>
1376		1473
1377	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1474	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1378	resources or on the commandline.	1475	resources or on the command line.
1379		1476
1380	=item B<COLORTERM>	1477	=item B<COLORTERM>
1381		1478
1382	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1479	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1383	compiled with XPM support, and optionally with the added extension	1480	compiled with XPM support, and optionally with the added extension
1384	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1481	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1385		1482
1386	=item B<COLORFGBG>	1483	=item B<COLORFGBG>
1387		1484
…		…
1405	C<--with-terminfo=PATH>.	1502	C<--with-terminfo=PATH>.
1406		1503
1407	=item B<DISPLAY>	1504	=item B<DISPLAY>
1408		1505
1409	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1506	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1410	display in it's child processes.	1507	display in its child processes.
1411		1508
1412	=item B<SHELL>	1509	=item B<SHELL>
1413		1510
1414	The shell to be used for command execution, defaults to C</bin/sh>.	1511	The shell to be used for command execution, defaults to C</bin/sh>.
1415		1512
…		…
1457		1554
1458	=item Project Coordinator	1555	=item Project Coordinator
1459		1556
1460	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1557	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1461		1558
1462	L<http://software.schmorp.de/#rxvt-unicode>	1559	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1463		1560
1464	=back	1561	=back
1465		1562
1466	=head1 AUTHORS	1563	=head1 AUTHORS
1467		1564

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.109 by root, Sun Jan 29 22:27:04 2006 UTC vs. Revision 1.137 by root, Sat Sep 1 09:38:50 2007 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.109 by root, Sun Jan 29 22:27:04 2006 UTC vs.
Revision 1.137 by root, Sat Sep 1 09:38:50 2007 UTC