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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.119 by root, Mon Aug 7 16:04:29 2006 UTC vs.
Revision 1.153 by root, Wed Dec 12 19:57:13 2007 UTC

…		…
12	emulator intended as an I<xterm>(1) replacement for users who do not	12	emulator intended as an I<xterm>(1) replacement for users who do not
13	require features such as Tektronix 4014 emulation and toolkit-style	13	require features such as Tektronix 4014 emulation and toolkit-style
14	configurability. As a result, B<rxvt-unicode> uses much less swap space --	14	configurability. As a result, B<rxvt-unicode> uses much less swap space --
15	a significant advantage on a machine serving many X sessions.	15	a significant advantage on a machine serving many X sessions.
16		16
		17	This document is also available on the World-Wide-Web at
		18	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
		19
17	=head1 FREQUENTLY ASKED QUESTIONS	20	=head1 FREQUENTLY ASKED QUESTIONS
18		21
19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of	22	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20	frequently asked questions and answer to them and some common	23	frequently asked questions and answer to them and some common
21	problems. That document is also accessible on the World-Wide-Web at	24	problems. That document is also accessible on the World-Wide-Web at
22	L<http://cvs.schmorp.de/browse/checkout/rxvt-unicode/doc/rxvt.7.html>.	25	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23		26
24	=head1 RXVT-UNICODE VS. RXVT	27	=head1 RXVT-UNICODE VS. RXVT
25		28
26	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode	29	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27	internally. That means it can store and display most scripts in the	30	internally. That means it can store and display most scripts in the
28	world. Being a terminal emulator, however, some things are very difficult,	31	world. Being a terminal emulator, however, some things are very difficult,
29	especially cursive scripts such as arabic, vertically written scripts	32	especially cursive scripts such as arabic, vertically written scripts
30	like mongolian or scripts requiring extremely complex combining rules,	33	like mongolian or scripts requiring extremely complex combining rules,
31	like tibetan or devenagari. Don't expect pretty output when using these	34	like tibetan or devanagari. Don't expect pretty output when using these
32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	35	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33	fine, though. A somewhat difficult case are right-to-left scripts, such	36	fine, though. A somewhat difficult case are right-to-left scripts, such
34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	37	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35	belong into the application, not the terminal emulator (too many things --	38	belong in the application, not the terminal emulator (too many things --
36	such as cursor-movement while editing -- break otherwise), but that might	39	such as cursor-movement while editing -- break otherwise), but that might
37	change.	40	change.
38		41
39	If you are looking for a terminal that supports more exotic scripts, let	42	If you are looking for a terminal that supports more exotic scripts, let
40	me recommend C<mlterm>, which is a very user friendly, lean and clean	43	me recommend C<mlterm>, which is a very user friendly, lean and clean
…		…
108		111
109	Turn on/off simulated reverse video; resource B<reverseVideo>.	112	Turn on/off simulated reverse video; resource B<reverseVideo>.
110		113
111	=item B<-j>\|B<+j>	114	=item B<-j>\|B<+j>
112		115
113	Turn on/off jump scrolling; resource B<jumpScroll>.	116	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
114		117
115	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>	118	=item B<-ss>\|B<+ss>
116		119
117	Turn on/off inheriting parent window's pixmap. Alternative form is	120	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118	B<-tr>; resource B<inheritPixmap>.
119		121
120	I<Please note that transparency of any kind if completely unsupported by	122	=item B<-tr>\|B<+tr>
121	the author. Don't bug him with installation questions! Read the FAQ (man 7	123
122	@@RXVT_NAME@@)!>	124	Turn on/off illusion of a transparent window background; resource B<transparent>.
		125
		126	B<-ip> is still accepted as an obsolete alias but will be removed in
		127	future versions.
		128
		129	I<Please address all transparency related issues to Sasha Vasko at
		130	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
123		131
124	=item B<-fade> I<number>	132	=item B<-fade> I<number>
125		133
126	Fade the text by the given percentage when focus is lost. Small values	134	Fade the text by the given percentage when focus is lost. Small values
127	fade a little only, 100 completely replaces all colours by the fade	135	fade a little only, 100 completely replaces all colours by the fade
…		…
133	is opaque black. resource B<fadeColor>.	141	is opaque black. resource B<fadeColor>.
134		142
135	=item B<-tint> I<colour>	143	=item B<-tint> I<colour>
136		144
137	Tint the transparent background pixmap with the given colour when	145	Tint the transparent background pixmap with the given colour when
138	transparency is enabled with B<-tr> or B<-ip>. This only works for	146	transparency is enabled with B<-tr>. This only works for
139	non-tiled backgrounds, currently. See also the B<-sh> option that can be	147	non-tiled backgrounds, currently. See also the B<-sh> option that can be
140	used to brighten or darken the image in addition to tinting it; resource	148	used to brighten or darken the image in addition to tinting it.
		149	Please note that certain tint colours can be applied on the server-side,
		150	thus yielding performance gain of two orders of magnitude. These colours are:
		151	blue, red, green, cyan, magenta, yellow, and those close to them. Also
		152	pure black and pure white colors essentially mean no tinting; resource
141	I<tintColor>. Example:	153	I<tintColor>. Example:
142		154
143	@@RXVT_NAME@@ -tr -tint blue -sh 40	155	@@RXVT_NAME@@ -tr -tint blue -sh 40
144		156
145	=item B<-sh>	157	=item B<-sh> I<number>
146		158
147	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	159	Darken (0 .. 100) or lighten (100 .. 200) the transparent
148	background image in addition to tinting it (i.e. B<-tint> must be	160	background image in addition to (or instead of) tinting it;
149	specified, too, e.g. C<-tint white>).	161	resource I<shading>.
		162
		163	=item B<-blt> I<string>
		164
		165	Specify background blending type. If background pixmap is specified
		166	at the same time as transparency - such pixmap will be blended over
		167	transparency image, using method specified. Supported values are :
		168	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
		169	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
		170	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
		171	alpha-blending. Compile I<afterimage>; resource I<blendType>.
		172
		173	=item B<-blr> I<HxV>
		174
		175	Apply Gaussian Blur with the specified radii to the transparent
		176	background image. If single number is specified - both vertical and
		177	horizontal radii are considered to be the same. Setting one of the
		178	radii to 1 and another to a large number creates interesting effects
		179	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
		180	resource I<blurRadius>.
150		181
151	=item B<-bg> I<colour>	182	=item B<-bg> I<colour>
152		183
153	Window background colour; resource B<background>.	184	Window background colour; resource B<background>.
154		185
155	=item B<-fg> I<colour>	186	=item B<-fg> I<colour>
156		187
157	Window foreground colour; resource B<foreground>.	188	Window foreground colour; resource B<foreground>.
158		189
159	=item B<-pixmap> I<file[;geom]>	190	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
160		191
161	Compile I<XPM>: Specify XPM file for the background and also optionally	192	Compile I<afterimage>: Specify image file for the background and also
162	specify its scaling with a geometry string. Note you may need to	193	optionally specify its scaling with a geometry string. Note you may need to
163	add quotes to avoid special shell interpretation of the C<;> in the	194	add quotes to avoid special shell interpretation of the C<;> in the
164	command-line; resource B<backgroundPixmap>.	195	command-line; for more details see resource B<backgroundPixmap>.
165		196
166	=item B<-cr> I<colour>	197	=item B<-cr> I<colour>
167		198
168	The cursor colour; resource B<cursorColor>.	199	The cursor colour; resource B<cursorColor>.
169		200
…		…
322		353
323	=item B<-lsp> I<number>	354	=item B<-lsp> I<number>
324		355
325	Compile I<frills>: Lines (pixel height) to insert between each row of	356	Compile I<frills>: Lines (pixel height) to insert between each row of
326	the display. Useful to work around font rendering problems; resource	357	the display. Useful to work around font rendering problems; resource
327	B<linespace>.	358	B<lineSpace>.
328		359
329	=item B<-tn> I<termname>	360	=item B<-tn> I<termname>
330		361
331	This option specifies the name of the terminal type to be set in the	362	This option specifies the name of the terminal type to be set in the
332	B<TERM> environment variable. This terminal type must exist in the	363	B<TERM> environment variable. This terminal type must exist in the
…		…
386	for more info.	417	for more info.
387		418
388	=item B<-tcw>	419	=item B<-tcw>
389		420
390	Change the meaning of triple-click selection with the left mouse	421	Change the meaning of triple-click selection with the left mouse
		422	button. Only effective when the original (non-perl) selection code is
391	button. Instead of selecting a full line it will extend the selection the	423	in-use. Instead of selecting a full line it will extend the selection to
392	end of the logical line only. resource B<tripleclickwords>.	424	the end of the logical line only. resource B<tripleclickwords>.
393		425
394	=item B<-insecure>	426	=item B<-insecure>
395		427
396	Enable "insecure" mode, which currently enables most of the escape	428	Enable "insecure" mode, which currently enables most of the escape
397	sequences that echo strings. See the resource B<insecure> for more	429	sequences that echo strings. See the resource B<insecure> for more
…		…
417		449
418	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	450	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
419	will not immediately destroy its window when the program executed within	451	will not immediately destroy its window when the program executed within
420	it exits. Instead, it will wait till it is being killed or closed by the	452	it exits. Instead, it will wait till it is being killed or closed by the
421	user; resource B<hold>.	453	user; resource B<hold>.
		454
		455	=item B<-xrm> I<string>
		456
		457	Works like the X Toolkit option of the same name, by adding the I<string>
		458	as if it were specified in a resource file. Resource values specified this
		459	way take precedence over all other resource specifications.
		460
		461	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		462	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		463	options can be specified as long-options on the commandline, so use
		464	of B<-xrm> is mostly limited to cases where you want to specify other
		465	resources (e.g. for input methods) or for compatibility with other
		466	programs.
422		467
423	=item B<-keysym.>I<sym> I<string>	468	=item B<-keysym.>I<sym> I<string>
424		469
425	Remap a key symbol. See resource B<keysym>.	470	Remap a key symbol. See resource B<keysym>.
426		471
…		…
461	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	506	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
462	entries and will not tinker with pty/tty permissions - you have to do that	507	entries and will not tinker with pty/tty permissions - you have to do that
463	yourself if you want that.	508	yourself if you want that.
464		509
465	As an extremely special case, specifying C<-1> will completely suppress	510	As an extremely special case, specifying C<-1> will completely suppress
466	pty/tty operations.	511	pty/tty operations, which is probably only useful in conjunction with some
		512	perl extension that manages the terminal.
467		513
468	Here is a example in perl that illustrates how this option can be used (a	514	Here is a example in perl that illustrates how this option can be used (a
469	longer example is in F<doc/pty-fd>):	515	longer example is in F<doc/pty-fd>):
470		516
471	use IO::Pty;	517	use IO::Pty;
…		…
485	Comma-separated list of perl extension scripts to use (or not to use) in	531	Comma-separated list of perl extension scripts to use (or not to use) in
486	this terminal instance. See resource B<perl-ext> for details.	532	this terminal instance. See resource B<perl-ext> for details.
487		533
488	=back	534	=back
489		535
490	=head1 RESOURCES (available also as long-options)	536	=head1 RESOURCES
491		537
492	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	538	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
493	options) compiled into your version.	539	options) compiled into your version. All resources are also available as
		540	long-options.
494		541
495	You can set and change the resources using X11 tools like B<xrdb>. Many	542	You can set and change the resources using X11 tools like B<xrdb>. Many
496	distribution do also load settings from the B<~/.Xresources> file when X	543	distribution do also load settings from the B<~/.Xresources> file when X
497	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	544	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
498	with later settings overwriting earlier ones:	545	with later settings overwriting earlier ones:
…		…
500	1. system-wide app-defaults file, either locale-dependent OR global	547	1. system-wide app-defaults file, either locale-dependent OR global
501	2. app-defaults file in $XAPPLRESDIR	548	2. app-defaults file in $XAPPLRESDIR
502	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	549	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
503	4. SCREEN_RESOURCES for the current screen	550	4. SCREEN_RESOURCES for the current screen
504	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	551	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		552	6. resources specified via -xrm on the commandline
505		553
506	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	554	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
507	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	555	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
508	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily	556	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
509	configured, while the class name B<URxvt> allows resources unique to	557	configured, while the class name B<URxvt> allows resources unique to
…		…
564	Use the specified colour to display underlined characters when the	612	Use the specified colour to display underlined characters when the
565	foreground colour is the default.	613	foreground colour is the default.
566		614
567	=item B<colorRV:> I<colour>	615	=item B<colorRV:> I<colour>
568		616
569	Use the specified colour as the background for reverse video	617	Use the specified colour as the background for reverse video characters
570	characters.	618	when OPTION_HC is disabled (--disable-frills).
571		619
572	=item B<underlineColor:> I<colour>	620	=item B<underlineColor:> I<colour>
573		621
574	If set, use the specified colour as the colour for the underline	622	If set, use the specified colour as the colour for the underline
575	itself. If unset, use the foreground colour.	623	itself. If unset, use the foreground colour.
…		…
591	option B<-rv>. B<False>: regular screen colours [default]; option	639	option B<-rv>. B<False>: regular screen colours [default]; option
592	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	640	B<+rv>. See note in B<COLORS AND GRAPHICS> section.
593		641
594	=item B<jumpScroll:> I<boolean>	642	=item B<jumpScroll:> I<boolean>
595		643
596	B<True>: specify that jump scrolling should be used. When scrolling	644	B<True>: specify that jump scrolling should be used. When receiving lots
597	quickly, fewer screen updates are performed [default]; option B<-j>.	645	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		646	has been read, resulting in fewer updates while still displaying every
		647	received line; option B<-j>.
		648
598	B<False>: specify that smooth scrolling should be used; option B<+j>.	649	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		650	force a screen refresh on each new line it received; option B<+j>.
599		651
600	=item B<inheritPixmap:> I<boolean>	652	=item B<skipScroll:> I<boolean>
601		653
602	B<True>: make the background inherit the parent windows' pixmap, giving	654	B<True>: (the default) specify that skip scrolling should be used. When
603	artificial transparency. B<False>: do not inherit the parent windows'	655	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
604	pixmap.	656	(around 60 times per second), resulting in far fewer updates. This can
		657	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		658	option B<-ss>.
605		659
606	I<Please note that transparency of any kind if completely unsupported by	660	B<False>: specify that everything is to be displayed, even
607	the author. Don't bug him with installation questions!>	661	if the refresh is too fast for the human eye to read anything (or the
		662	monitor to display anything); option B<+ss>.
		663
		664	=item B<transparent:> I<boolean>
		665
		666	Turn on/off illusion of a transparent window background.
		667
		668	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
		669	future versions.
		670
		671	I<Please address all transparency related issues to Sasha Vasko at
		672	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
608		673
609	=item B<fading:> I<number>	674	=item B<fading:> I<number>
610		675
611	Fade the text by the given percentage when focus is lost; option B<-fade>.	676	Fade the text by the given percentage when focus is lost; option B<-fade>.
612		677
…		…
620	Tint the transparent background pixmap with the given colour; option	685	Tint the transparent background pixmap with the given colour; option
621	B<-tint>.	686	B<-tint>.
622		687
623	=item B<shading:> I<number>	688	=item B<shading:> I<number>
624		689
625	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	690	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
626	image in addition to tinting it.	691	in addition to tinting it; option B<-sh>.
		692
		693	=item B<blendType:> I<string>
		694
		695	Specify background blending type; option B<-blt>.
		696
		697	=item B<blurRadius:> I<number>
		698
		699	Apply Gaussian Blurr with the specified radius to the transparent
		700	background image; option B<-blr>.
627		701
628	=item B<scrollColor:> I<colour>	702	=item B<scrollColor:> I<colour>
629		703
630	Use the specified colour for the scrollbar [default #B2B2B2].	704	Use the specified colour for the scrollbar [default #B2B2B2].
631		705
…		…
637	=item B<borderColor:> I<colour>	711	=item B<borderColor:> I<colour>
638		712
639	The colour of the border around the text area and between the scrollbar	713	The colour of the border around the text area and between the scrollbar
640	and the text.	714	and the text.
641		715
642	=item B<backgroundPixmap:> I<file[;geom]>	716	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
643		717
644	Use the specified XPM file (note the `.xpm' extension is optional) for	718	Use the specified image file for the background and also
645	the background and also optionally specify its scaling with a geometry	719	optionally specify its scaling with a geometry string B<WxH+X+Y>,
646	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	720	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
647	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	721	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
648	centre (percent). A scale of 0 displays the image with tiling. A scale	722	centre (percent). A scale of 0 displays the image with tiling. A scale
649	of 1 displays the image without any scaling. A scale of 2 to 9	723	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
650	specifies an integer number of images in that direction. No image will	724	an integer number of images in that direction. No image will be magnified
651	be magnified beyond 10 times its original size. The maximum permitted	725	beyond 10 times its original size. The maximum permitted scale is 1000.
652	scale is 1000. [default 0x0+50+50]	726	Additional operations can be specified after colon B<:op1:op2...>.
		727	Supported operations are:
		728
		729	tile force background image to be tiled and not scaled. Equivalent to 0x0,
		730	propscale will scale image keeping proportions,
		731	auto will scale image to match window size. Equivalent to 100x100;
		732	hscale will scale image horizontally to the window size;
		733	vscale will scale image vertically to the window size;
		734	scale will scale image to match window size;
		735	root will tile image as if it was a root window background, auto-adjusting
		736	whenever terminal window moves.
		737
		738	If used in conjunction with B<-tr> option, the specified pixmap will be
		739	blended over transparency image using either alpha-blending, or any
		740	other blending type, specified with B<-blt "type"> option.
653		741
654	=item B<path:> I<path>	742	=item B<path:> I<path>
655		743
656	Specify the colon-delimited search path for finding XPM files.	744	Specify the colon-delimited search path for finding background image files.
657		745
658	=item B<font:> I<fontlist>	746	=item B<font:> I<fontlist>
659		747
660	Select the fonts to be used. This is a comma separated list of font names	748	Select the fonts to be used. This is a comma separated list of font names
661	that are checked in order when trying to find glyphs for characters. The	749	that are checked in order when trying to find glyphs for characters. The
…		…
725	option B<+is>) disables this behaviour, the high intensity colours are not	813	option B<+is>) disables this behaviour, the high intensity colours are not
726	reachable.	814	reachable.
727		815
728	=item B<selectstyle:> I<mode>	816	=item B<selectstyle:> I<mode>
729		817
730	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	818	Set mouse selection style to B<old> which is 2.20, B<oldword> which
731	xterm style with 2.20 old word selection, or anything else which gives	819	is xterm style with 2.20 old word selection, or anything else which
732	xterm style selection.	820	gives xterm style selection. Only effective when the original (non-perl)
		821	selection code is in use.
733		822
734	=item B<scrollstyle:> I<mode>	823	=item B<scrollstyle:> I<mode>
735		824
736	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	825	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
737	the author's favourite.	826	the author's favourite.
…		…
750		839
751	=item B<mapAlert:> I<boolean>	840	=item B<mapAlert:> I<boolean>
752		841
753	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	842	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
754	de-iconify (map) on receipt of a bell character [default].	843	de-iconify (map) on receipt of a bell character [default].
		844
		845	=item B<urgentOnBell:> I<boolean>
		846
		847	B<True>: set the urgency hint for the wm on receipt of a bell character.
		848	B<False>: do not set the urgency hint [default].
755		849
756	=item B<visualBell:> I<boolean>	850	=item B<visualBell:> I<boolean>
757		851
758	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	852	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
759	B<False>: no visual bell [default]; option B<+vb>.	853	B<False>: no visual bell [default]; option B<+vb>.
…		…
854	=item B<termName:> I<termname>	948	=item B<termName:> I<termname>
855		949
856	Specifies the terminal type name to be set in the B<TERM> environment	950	Specifies the terminal type name to be set in the B<TERM> environment
857	variable; option B<-tn>.	951	variable; option B<-tn>.
858		952
859	=item B<linespace:> I<number>	953	=item B<lineSpace:> I<number>
860		954
861	Specifies number of lines (pixel height) to insert between each row of	955	Specifies number of lines (pixel height) to insert between each row of
862	the display [default 0]; option B<-lsp>.	956	the display [default 0]; option B<-lsp>.
863		957
864	=item B<meta8:> I<boolean>	958	=item B<meta8:> I<boolean>
…		…
916	=item B<cutchars:> I<string>	1010	=item B<cutchars:> I<string>
917		1011
918	The characters used as delimiters for double-click word selection	1012	The characters used as delimiters for double-click word selection
919	(whitespace delimiting is added automatically if resource is given).	1013	(whitespace delimiting is added automatically if resource is given).
920		1014
921	When the selection extension is in use (the default if compiled in, see	1015	When the perl selection extension is in use (the default if compiled
922	the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters	1016	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
923	will be created (if the resource exists, otherwise, no regex will be	1017	characters will be created (if the resource exists, otherwise, no regex
924	created). In this mode, characters outside ISO-8859-1 can be used.	1018	will be created). In this mode, characters outside ISO-8859-1 can be used.
925		1019
926	When the selection extension is not used, only ISO-8859-1 characters can	1020	When the selection extension is not used, only ISO-8859-1 characters can
927	be used. If not specified, the built-in default is used:	1021	be used. If not specified, the built-in default is used:
928		1022
929	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1023	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
930		1024
931	=item B<preeditType:> I<style>	1025	=item B<preeditType:> I<style>
932		1026
933	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1027	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
934		1028
…		…
988		1082
989	Turn on/off secondary screen (default enabled).	1083	Turn on/off secondary screen (default enabled).
990		1084
991	=item B<secondaryScroll:> I<boolean>	1085	=item B<secondaryScroll:> I<boolean>
992		1086
993	Turn on/off secondary screen scroll (default enabled). If the this	1087	Turn on/off secondary screen scroll (default enabled). If this
994	option is enabled, scrolls on the secondary screen will change the	1088	option is enabled, scrolls on the secondary screen will change the
995	scrollback buffer and switching to/from the secondary screen will	1089	scrollback buffer and switching to/from the secondary screen will
996	instead scroll the screen up.	1090	instead scroll the screen up.
997		1091
998	=item B<hold>: I<boolean>	1092	=item B<hold>: I<boolean>
…		…
1022	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1116	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1023	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1117	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1024	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1118	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1025	performed in an exact manner; however, the closest match is assured.	1119	performed in an exact manner; however, the closest match is assured.
1026		1120
1027	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1121	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1028	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1122	number), see RESOURCES in C<man 7 X> for futher details.
1029	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1030	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1031	can start or end with whitespace.
1032
1033	Please note that you need to double the C<\> in resource files, as
1034	Xlib itself does its own de-escaping (you can use C<\033> instead of
1035	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1036	processing).
1037		1123
1038	You can define a range of keysyms in one shot by providing a I<string>	1124	You can define a range of keysyms in one shot by providing a I<string>
1039	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1125	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1040	should be a character not used by the strings.	1126	should be a character not used by the strings.
1041		1127
…		…
1154	(default: C<M-s>).	1240	(default: C<M-s>).
1155		1241
1156	=item B<urlLauncher>: I<string>	1242	=item B<urlLauncher>: I<string>
1157		1243
1158	Specifies the program to be started with a URL argument. Used by the	1244	Specifies the program to be started with a URL argument. Used by the
1159	C<selection-popup> and C<mark-urls> perl extensions.	1245	C<selection-popup> and C<matcher> perl extensions.
1160		1246
1161	=item B<transient-for>: I<windowid>	1247	=item B<transient-for>: I<windowid>
1162		1248
1163	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.	1249	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1164		1250
1165	=item B<override-redirect>: I<boolean>	1251	=item B<override-redirect>: I<boolean>
1166		1252
1167	Compile I<frills>: Sets override-redirect for the terminal window, making	1253	Compile I<frills>: Sets override-redirect for the terminal window, making
1168	it almost invisible to window managers; option B<-override-redirect>.	1254	it almost invisible to window managers; option B<-override-redirect>.
		1255
		1256	=item B<iso14755_52:> I<boolean>
		1257
		1258	Turn on/off ISO 14755 5.2 mode (default enabled).
1169		1259
1170	=back	1260	=back
1171		1261
1172	=head1 THE SCROLLBAR	1262	=head1 THE SCROLLBAR
1173		1263
…		…
1192	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1282	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1193	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1283	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1194	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1284	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1195	respectively.	1285	respectively.
1196		1286
1197	=head1 TEXT SELECTION AND INSERTION	1287	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1198		1288
1199	The behaviour of text selection and insertion mechanism is similar to	1289	The behaviour of text selection and insertion/pasting mechanism is similar
1200	I<xterm>(1).	1290	to I<xterm>(1).
1201		1291
1202	=over 4	1292	=over 4
1203		1293
1204	=item B<Selection>:	1294	=item B<Selecting>:
1205		1295
1206	Left click at the beginning of the region, drag to the end of the region	1296	Left click at the beginning of the region, drag to the end of the region
1207	and release; Right click to extend the marked region; Left double-click	1297	and release; Right click to extend the marked region; Left double-click
1208	to select a word; Left triple-click to select the entire logical line	1298	to select a word; Left triple-click to select the entire logical line
1209	(which can span multiple screen lines), unless modified by resource	1299	(which can span multiple screen lines), unless modified by resource
…		…
1213	(Compile: I<frills>) will create a rectangular selection instead of a	1303	(Compile: I<frills>) will create a rectangular selection instead of a
1214	normal one. In this mode, every selected row becomes its own line in the	1304	normal one. In this mode, every selected row becomes its own line in the
1215	selection, and trailing whitespace is visually underlined and removed from	1305	selection, and trailing whitespace is visually underlined and removed from
1216	the selection.	1306	the selection.
1217		1307
1218	=item B<Insertion>:	1308	=item B<Pasting>:
1219		1309
1220	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>	1310	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1221	window causes the value of the PRIMARY selection (or CLIPBOARD with the	1311	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1222	Meta modifier) to be inserted as if it had been typed on the keyboard.	1312	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1223		1313
1224	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1314	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1225	inserted too.	1315	inserted too.
1226		1316
1227	=back	1317	=back
…		…
1244		1334
1245	=head1 ISO 14755 SUPPORT	1335	=head1 ISO 14755 SUPPORT
1246		1336
1247	ISO 14755 is a standard for entering and viewing unicode characters	1337	ISO 14755 is a standard for entering and viewing unicode characters
1248	and character codes using the keyboard. It consists of 4 parts. The	1338	and character codes using the keyboard. It consists of 4 parts. The
1249	first part is available rxvt-unicode has been compiled with	1339	first part is available if rxvt-unicode has been compiled with
1250	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1340	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1251	with C<--enable-iso14755>.	1341	with C<--enable-iso14755>.
1252		1342
1253	=over 4	1343	=over 4
1254		1344
…		…
1377	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1467	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1378	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1468	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1379	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1469	(recommended, but B<MUST> have 4 digits/component) colour specifications,
1380	in addition to the ones provided by X, where the additional A component	1470	in addition to the ones provided by X, where the additional A component
1381	specifies opacity (alpha) values. The minimum value of C<0> is completely	1471	specifies opacity (alpha) values. The minimum value of C<0> is completely
1382	transparent). You can also prefix any color with C<[a]>, where C<a> is on	1472	transparent). You can also prefix any color with C<[percent]>, where
1383	to four hex digits specifiying the opacity value.	1473	C<percent> is a decimal percentage (0-100) that specifies the opacity of
		1474	the color, where C<0> is completely transparent and C<100> is completelxy
		1475	opaque.
1384		1476
1385	You probably need to specify B<"-depth 32">, too, and have the luck that	1477	You probably need to specify B<"-depth 32">, too, and have the luck that
1386	your X-server uses ARGB pixel layout, as X is far from just supporting	1478	your X-server uses ARGB pixel layout, as X is far from just supporting
1387	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1479	ARGB visuals out of the box, and rxvt-unicode just fudges around.
1388		1480
1389	For example, the following selects an almost completely transparent red	1481	For example, the following selects an almost completely transparent red
1390	background, and an almost opaque pink foreground:	1482	background, and an almost opaque pink foreground:
1391		1483
1392	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"	1484	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1393		1485
1394	I<Please note that transparency of any kind if completely unsupported by	1486	I<Please note that transparency of any kind if completely unsupported by
1395	the author. Don't bug him with installation questions!>	1487	the author. Don't bug him with installation questions!>
1396		1488
1397	=head1 ENVIRONMENT	1489	=head1 ENVIRONMENT
…		…
1406	resources or on the command line.	1498	resources or on the command line.
1407		1499
1408	=item B<COLORTERM>	1500	=item B<COLORTERM>
1409		1501
1410	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was	1502	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1411	compiled with XPM support, and optionally with the added extension	1503	compiled with background image support, and optionally with the added
1412	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1504	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1505	screen.
1413		1506
1414	=item B<COLORFGBG>	1507	=item B<COLORFGBG>
1415		1508
1416	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1509	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1417	the colour code used as default foreground/text colour (or the string	1510	the colour code used as default foreground/text colour (or the string
1418	C<default> to indicate that the default-colour escape sequence is to be	1511	C<default> to indicate that the default-colour escape sequence is to be
1419	used), C<bg> is the colour code used as default background colour (or the	1512	used), C<bg> is the colour code used as default background colour (or the
1420	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1513	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1421	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1514	was compiled with background image support. Libraries like C<ncurses>
1422	(and do) use this information to optimize screen output.	1515	and C<slang> can (and do) use this information to optimize screen output.
1423		1516
1424	=item B<WINDOWID>	1517	=item B<WINDOWID>
1425		1518
1426	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1519	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1427	window, which usually has subwindows for the scrollbar, the terminal	1520	window, which usually has subwindows for the scrollbar, the terminal
…		…
1518	Project Coordinator (changes.txt 2.21a to 2.4.5)	1611	Project Coordinator (changes.txt 2.21a to 2.4.5)
1519		1612
1520	=item Geoff Wing L<< <gcw@pobox.com> >>	1613	=item Geoff Wing L<< <gcw@pobox.com> >>
1521		1614
1522	Rewrote screen display and text selection routines.	1615	Rewrote screen display and text selection routines.
1523		1616
1524	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1617	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1525		1618
1526	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1619	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1527		1620
1528	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1621	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.119 by root, Mon Aug 7 16:04:29 2006 UTC vs. Revision 1.153 by root, Wed Dec 12 19:57:13 2007 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.119 by root, Mon Aug 7 16:04:29 2006 UTC vs.
Revision 1.153 by root, Wed Dec 12 19:57:13 2007 UTC