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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.115 by root, Mon Jul 10 04:01:33 2006 UTC vs.
Revision 1.140 by sasha, Fri Oct 26 18:27:29 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 right-to-left 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
…		…
47	programs force onto its 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	its 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 its 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
…		…
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		114
115	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>	115	=item B<-ss>\|B<+ss>
116		116
117	Turn on/off inheriting parent window's pixmap. Alternative form is	117	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118	B<-tr>; resource B<inheritPixmap>.
119		118
120	I<Please note that transparency of any kind if completely unsupported by	119	=item B<-tr>\|B<+tr>
121	the author. Don't bug him with installation questions!>	120
		121	Turn on/off illusion of a transparent window background. Obsolete form of it is
		122	B<-ip> and it should not be used anymore; resource B<transparent>.
		123
		124	I<Please note that old resource name of B<inheritPixmap> is obsolete and should be
		125	changed to B<transparent>. Backwards compatibility support for B<inheritPixmap> will
		126	be phased out in future versions of rxvt!>
		127
		128	I<Please address all transparency related issues to Sasha Vasko at
		129	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
122		130
123	=item B<-fade> I<number>	131	=item B<-fade> I<number>
124		132
125	Fade the text by the given percentage when focus is lost. Small values	133	Fade the text by the given percentage when focus is lost. Small values
126	fade a little only, 100 completely replaces all colours by the fade	134	fade a little only, 100 completely replaces all colours by the fade
…		…
132	is opaque black. resource B<fadeColor>.	140	is opaque black. resource B<fadeColor>.
133		141
134	=item B<-tint> I<colour>	142	=item B<-tint> I<colour>
135		143
136	Tint the transparent background pixmap with the given colour when	144	Tint the transparent background pixmap with the given colour when
137	transparency is enabled with B<-tr> or B<-ip>. This only works for	145	transparency is enabled with B<-tr>. This only works for
138	non-tiled backgrounds, currently. See also the B<-sh> option that can be	146	non-tiled backgrounds, currently. See also the B<-sh> option that can be
139	used to brighten or darken the image in addition to tinting it; resource	147	used to brighten or darken the image in addition to tinting it.
		148	Please note that certain tint colours can be applied on the server-side,
		149	thus yielding performance gain of two orders of magnitude. These colours are:
		150	blue, red, green, cyan, magenta, yellow, and those close to them; resource
140	I<tintColor>. Example:	151	I<tintColor>. Example:
141		152
142	@@RXVT_NAME@@ -tr -tint blue -sh 40	153	@@RXVT_NAME@@ -tr -tint blue -sh 40
143		154
144	=item B<-sh>	155	=item B<-sh> I<number>
145		156
146	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	157	Darken (0 .. 100) or lighten (-1 .. -100) the transparent
147	background image in addition to tinting it (i.e. B<-tint> must be	158	background image in addition to (or instead of) tinting it;
148	specified, too, e.g. C<-tint white>).	159	resource I<shading>.
		160
		161	=item B<-blt> I<string>
		162
		163	Specify background blending type. If background pixmap is specified
		164	at the same time as transparency - such pixmap will be blended over
		165	transparency image, using method specified. Supported values are :
		166	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
		167	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
		168	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
		169	alpha-blending. Compile I<afterimage>; resource I<blendType>.
		170
		171	=item B<-blr> I<HxV>
		172
		173	Apply Gaussian Blur with the specified radii to the transparent
		174	background image. If single number is specified - both vertical and
		175	horizontal radii are considered to be the same. Setting one of the
		176	radii to 1 and another to a large number creates interesting effects
		177	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
		178	resource I<blurRadius>.
149		179
150	=item B<-bg> I<colour>	180	=item B<-bg> I<colour>
151		181
152	Window background colour; resource B<background>.	182	Window background colour; resource B<background>.
153		183
…		…
155		185
156	Window foreground colour; resource B<foreground>.	186	Window foreground colour; resource B<foreground>.
157		187
158	=item B<-pixmap> I<file[;geom]>	188	=item B<-pixmap> I<file[;geom]>
159		189
160	Compile I<XPM>: Specify XPM file for the background and also optionally	190	Compile I<afterimage>: Specify image file for the background and also
161	specify its scaling with a geometry string. Note you may need to	191	optionally specify its scaling with a geometry string. Note you may need to
162	add quotes to avoid special shell interpretation of the C<;> in the	192	add quotes to avoid special shell interpretation of the C<;> in the
163	command-line; resource B<backgroundPixmap>.	193	command-line; for more details see resource B<backgroundPixmap>.
164		194
165	=item B<-cr> I<colour>	195	=item B<-cr> I<colour>
166		196
167	The cursor colour; resource B<cursorColor>.	197	The cursor colour; resource B<cursorColor>.
168		198
…		…
321		351
322	=item B<-lsp> I<number>	352	=item B<-lsp> I<number>
323		353
324	Compile I<frills>: Lines (pixel height) to insert between each row of	354	Compile I<frills>: Lines (pixel height) to insert between each row of
325	the display. Useful to work around font rendering problems; resource	355	the display. Useful to work around font rendering problems; resource
326	B<linespace>.	356	B<lineSpace>.
327		357
328	=item B<-tn> I<termname>	358	=item B<-tn> I<termname>
329		359
330	This option specifies the name of the terminal type to be set in the	360	This option specifies the name of the terminal type to be set in the
331	B<TERM> environment variable. This terminal type must exist in the	361	B<TERM> environment variable. This terminal type must exist in the
…		…
385	for more info.	415	for more info.
386		416
387	=item B<-tcw>	417	=item B<-tcw>
388		418
389	Change the meaning of triple-click selection with the left mouse	419	Change the meaning of triple-click selection with the left mouse
		420	button. Only effective when the original (non-perl) selection code is
390	button. Instead of selecting a full line it will extend the selection the	421	in-use. Instead of selecting a full line it will extend the selection the
391	end of the logical line only. resource B<tripleclickwords>.	422	end of the logical line only. resource B<tripleclickwords>.
392		423
393	=item B<-insecure>	424	=item B<-insecure>
394		425
395	Enable "insecure" mode, which currently enables most of the escape	426	Enable "insecure" mode, which currently enables most of the escape
…		…
436	The window will not be destroyed when @@RXVT_NAME@@ exits.	467	The window will not be destroyed when @@RXVT_NAME@@ exits.
437		468
438	It might be useful to know that @@RXVT_NAME@@ will not close file	469	It might be useful to know that @@RXVT_NAME@@ will not close file
439	descriptors passed to it (except for stdin/out/err, of course), so you	470	descriptors passed to it (except for stdin/out/err, of course), so you
440	can use file descriptors to communicate with the programs within the	471	can use file descriptors to communicate with the programs within the
441	terminal. This works regardless of wether the C<-embed> option was used or	472	terminal. This works regardless of whether the C<-embed> option was used or
442	not.	473	not.
443		474
444	Here is a short Gtk2-perl snippet that illustrates how this option can be	475	Here is a short Gtk2-perl snippet that illustrates how this option can be
445	used (a longer example is in F<doc/embed>):	476	used (a longer example is in F<doc/embed>):
446		477
…		…
451	});	482	});
452		483
453	=item B<-pty-fd> I<file descriptor>	484	=item B<-pty-fd> I<file descriptor>
454		485
455	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	486	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
456	pair but instead use the given filehandle as the tty master. This is	487	pair but instead use the given file descriptor as the tty master. This is
457	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator	488	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
458	without having to run a program within it.	489	without having to run a program within it.
459		490
460	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	491	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
461	entries and will not tinker with pty/tty permissions - you have to do that	492	entries and will not tinker with pty/tty permissions - you have to do that
…		…
563	Use the specified colour to display underlined characters when the	594	Use the specified colour to display underlined characters when the
564	foreground colour is the default.	595	foreground colour is the default.
565		596
566	=item B<colorRV:> I<colour>	597	=item B<colorRV:> I<colour>
567		598
568	Use the specified colour as the background for reverse video	599	Use the specified colour as the background for reverse video characters
569	characters.	600	when OPTION_HC is disabled (--disable-frills).
570		601
571	=item B<underlineColor:> I<colour>	602	=item B<underlineColor:> I<colour>
572		603
573	If set, use the specified colour as the colour for the underline	604	If set, use the specified colour as the colour for the underline
574	itself. If unset, use the foreground colour.	605	itself. If unset, use the foreground colour.
…		…
590	option B<-rv>. B<False>: regular screen colours [default]; option	621	option B<-rv>. B<False>: regular screen colours [default]; option
591	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	622	B<+rv>. See note in B<COLORS AND GRAPHICS> section.
592		623
593	=item B<jumpScroll:> I<boolean>	624	=item B<jumpScroll:> I<boolean>
594		625
595	B<True>: specify that jump scrolling should be used. When scrolling	626	B<True>: specify that jump scrolling should be used. When receiving lots
596	quickly, fewer screen updates are performed [default]; option B<-j>.	627	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		628	has been read, resulting in fewer updates while still displaying every
		629	received line; option B<-j>.
		630
597	B<False>: specify that smooth scrolling should be used; option B<+j>.	631	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		632	force a screen refresh on each new line it received; option B<+j>.
		633
		634	=item B<skipScroll:> I<boolean>
		635
		636	B<True>: (the default) specify that skip scrolling should be used. When
		637	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
		638	(around 60 times per second), resulting in far fewer updates. This can
		639	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		640	option B<-ss>.
		641
		642	B<False>: specify that everything is to be displayed, even
		643	if the refresh is too fast for the human eye to read anything (or the
		644	monitor to display anything); option B<+ss>.
598		645
599	=item B<inheritPixmap:> I<boolean>	646	=item B<inheritPixmap:> I<boolean>
600		647
601	B<True>: make the background inherit the parent windows' pixmap, giving	648	B<True>: make the background inherit the parent windows' pixmap, giving
602	artificial transparency. B<False>: do not inherit the parent windows'	649	artificial transparency. B<False>: do not inherit the parent windows'
…		…
619	Tint the transparent background pixmap with the given colour; option	666	Tint the transparent background pixmap with the given colour; option
620	B<-tint>.	667	B<-tint>.
621		668
622	=item B<shading:> I<number>	669	=item B<shading:> I<number>
623		670
624	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	671	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
625	image in addition to tinting it.	672	in addition to tinting it; option B<-sh>.
		673
		674	=item B<blendType:> I<string>
		675
		676	Specify background blending type; option B<-blt>.
		677
		678	=item B<blurRadius:> I<number>
		679
		680	Apply Gaussian Blurr with the specified radius to the transparent
		681	background image; option B<-blr>.
626		682
627	=item B<scrollColor:> I<colour>	683	=item B<scrollColor:> I<colour>
628		684
629	Use the specified colour for the scrollbar [default #B2B2B2].	685	Use the specified colour for the scrollbar [default #B2B2B2].
630		686
…		…
638	The colour of the border around the text area and between the scrollbar	694	The colour of the border around the text area and between the scrollbar
639	and the text.	695	and the text.
640		696
641	=item B<backgroundPixmap:> I<file[;geom]>	697	=item B<backgroundPixmap:> I<file[;geom]>
642		698
643	Use the specified XPM file (note the `.xpm' extension is optional) for	699	Use the specified image file for the background and also optionally
644	the background and also optionally specify its scaling with a geometry	700	specify its scaling with a geometry string B<WxH+X+Y>,
645	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	701	in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
646	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	702	and B<"X" / "Y"> locate the image centre (percent).
647	centre (percent). A scale of 0 displays the image with tiling. A scale	703	A scale of 0 displays the image with tiling. A scale of 1 displays the
648	of 1 displays the image without any scaling. A scale of 2 to 9	704	image without any scaling. A scale of 2 to 9 specifies an integer
649	specifies an integer number of images in that direction. No image will	705	number of images in that direction. No image will be magnified beyond
650	be magnified beyond 10 times its original size. The maximum permitted	706	10 times its original size. The maximum permitted scale is 1000.
651	scale is 1000. [default 0x0+50+50]	707	Special string of B<"auto"> used as a geometry will cause image to be
		708	automatically scaled to match window size.
		709	If used in conjunction with B<-tr> option - specified pixmap will be
		710	blended over transparency image using either alpha-blending, or any
		711	other blending type, specified with B<-blt "type"> option.
		712	[default 0x0+50+50]
652		713
653	=item B<path:> I<path>	714	=item B<path:> I<path>
654		715
655	Specify the colon-delimited search path for finding XPM files.	716	Specify the colon-delimited search path for finding background image files.
656		717
657	=item B<font:> I<fontlist>	718	=item B<font:> I<fontlist>
658		719
659	Select the fonts to be used. This is a comma separated list of font names	720	Select the fonts to be used. This is a comma separated list of font names
660	that are checked in order when trying to find glyphs for characters. The	721	that are checked in order when trying to find glyphs for characters. The
…		…
718		779
719	=item B<intensityStyles:> I<boolean>	780	=item B<intensityStyles:> I<boolean>
720		781
721	When font styles are not enabled, or this option is enabled (B<True>,	782	When font styles are not enabled, or this option is enabled (B<True>,
722	option B<-is>, the default), bold and italic font styles imply high	783	option B<-is>, the default), bold and italic font styles imply high
723	intensity foreground/backround colours. Disabling this option (B<False>,	784	intensity foreground/background colours. Disabling this option (B<False>,
724	option B<+is>) disables this behaviour, the high intensity colours are not	785	option B<+is>) disables this behaviour, the high intensity colours are not
725	reachable.	786	reachable.
726		787
727	=item B<selectstyle:> I<mode>	788	=item B<selectstyle:> I<mode>
728		789
729	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	790	Set mouse selection style to B<old> which is 2.20, B<oldword> which
730	xterm style with 2.20 old word selection, or anything else which gives	791	is xterm style with 2.20 old word selection, or anything else which
731	xterm style selection.	792	gives xterm style selection. Only effective when the original (non-perl)
		793	selection code is in use.
732		794
733	=item B<scrollstyle:> I<mode>	795	=item B<scrollstyle:> I<mode>
734		796
735	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	797	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
736	the author's favourite.	798	the author's favourite.
…		…
750	=item B<mapAlert:> I<boolean>	812	=item B<mapAlert:> I<boolean>
751		813
752	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	814	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
753	de-iconify (map) on receipt of a bell character [default].	815	de-iconify (map) on receipt of a bell character [default].
754		816
		817	=item B<urgentOnBell:> I<boolean>
		818
		819	B<True>: set the urgency hint for the wm on receipt of a bell character.
		820	B<False>: do not set the urgency hint [default].
		821
755	=item B<visualBell:> I<boolean>	822	=item B<visualBell:> I<boolean>
756		823
757	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	824	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
758	B<False>: no visual bell [default]; option B<+vb>.	825	B<False>: no visual bell [default]; option B<+vb>.
759		826
…		…
780	Example:	847	Example:
781		848
782	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	849	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
783		850
784	This creates a new file in your home directory with the screen contents	851	This creates a new file in your home directory with the screen contents
785	everytime you hit C<Print>.	852	every time you hit C<Print>.
786		853
787	=item B<scrollBar:> I<boolean>	854	=item B<scrollBar:> I<boolean>
788		855
789	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	856	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
790	disable the scrollbar; option B<+sb>.	857	disable the scrollbar; option B<+sb>.
…		…
812		879
813	=item B<scrollWithBuffer:> I<boolean>	880	=item B<scrollWithBuffer:> I<boolean>
814		881
815	B<True>: scroll with scrollback buffer when tty receives new lines (and	882	B<True>: scroll with scrollback buffer when tty receives new lines (and
816	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	883	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
817	with scrollback buffer when tty recieves new lines; option B<+sw>.	884	with scrollback buffer when tty receives new lines; option B<+sw>.
818		885
819	=item B<scrollTtyKeypress:> I<boolean>	886	=item B<scrollTtyKeypress:> I<boolean>
820		887
821	B<True>: scroll to bottom when a non-special key is pressed. Special keys	888	B<True>: scroll to bottom when a non-special key is pressed. Special keys
822	are those which are intercepted by rxvt-unicode for special handling and	889	are those which are intercepted by rxvt-unicode for special handling and
…		…
853	=item B<termName:> I<termname>	920	=item B<termName:> I<termname>
854		921
855	Specifies the terminal type name to be set in the B<TERM> environment	922	Specifies the terminal type name to be set in the B<TERM> environment
856	variable; option B<-tn>.	923	variable; option B<-tn>.
857		924
858	=item B<linespace:> I<number>	925	=item B<lineSpace:> I<number>
859		926
860	Specifies number of lines (pixel height) to insert between each row of	927	Specifies number of lines (pixel height) to insert between each row of
861	the display [default 0]; option B<-lsp>.	928	the display [default 0]; option B<-lsp>.
862		929
863	=item B<meta8:> I<boolean>	930	=item B<meta8:> I<boolean>
…		…
915	=item B<cutchars:> I<string>	982	=item B<cutchars:> I<string>
916		983
917	The characters used as delimiters for double-click word selection	984	The characters used as delimiters for double-click word selection
918	(whitespace delimiting is added automatically if resource is given).	985	(whitespace delimiting is added automatically if resource is given).
919		986
920	When the selection extension is in use (the default if compiled in, see	987	When the perl selection extension is in use (the default if compiled
921	the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters	988	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
922	will be created (if the resource exists, otherwise, no regex will be	989	characters will be created (if the resource exists, otherwise, no regex
923	created). In this mode, characters outside ISO-8859-1 can be used.	990	will be created). In this mode, characters outside ISO-8859-1 can be used.
924		991
925	When the selection extension is not used, only ISO-8859-1 characters can	992	When the selection extension is not used, only ISO-8859-1 characters can
926	be used. If not specified, the built-in default is used:	993	be used. If not specified, the built-in default is used:
927		994
928	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	995	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>
…		…
987		1054
988	Turn on/off secondary screen (default enabled).	1055	Turn on/off secondary screen (default enabled).
989		1056
990	=item B<secondaryScroll:> I<boolean>	1057	=item B<secondaryScroll:> I<boolean>
991		1058
992	Turn on/off secondary screen scroll (default enabled). If the this	1059	Turn on/off secondary screen scroll (default enabled). If this
993	option is enabled, scrolls on the secondary screen will change the	1060	option is enabled, scrolls on the secondary screen will change the
994	scrollback buffer and switching to/from the secondary screen will	1061	scrollback buffer and switching to/from the secondary screen will
995	instead scroll the screen up.	1062	instead scroll the screen up.
996		1063
997	=item B<hold>: I<boolean>	1064	=item B<hold>: I<boolean>
…		…
1021	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1088	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1022	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1089	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1023	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1090	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1024	performed in an exact manner; however, the closest match is assured.	1091	performed in an exact manner; however, the closest match is assured.
1025		1092
1026	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1093	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1027	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1094	number), see RESOURCES in C<man 7 X> for futher details.
1028	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1029	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1030	can start or end with whitespace.
1031
1032	Please note that you need to double the C<\> in resource files, as
1033	Xlib itself does its own de-escaping (you can use C<\033> instead of
1034	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1035	processing).
1036		1095
1037	You can define a range of keysyms in one shot by providing a I<string>	1096	You can define a range of keysyms in one shot by providing a I<string>
1038	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1097	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1039	should be a character not used by the strings.	1098	should be a character not used by the strings.
1040		1099
1041	Its usage can be demonstrated by an example:	1100	Its usage can be demonstrated by an example:
1042		1101
1043	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1102	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
…		…
1107	example, C<default,-selection> will use all the default extension except	1166	example, C<default,-selection> will use all the default extension except
1108	C<selection>.	1167	C<selection>.
1109		1168
1110	Extension names can also be followed by an argument in angle brackets	1169	Extension names can also be followed by an argument in angle brackets
1111	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1170	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1112	searchable scorllback to Alt/Meta-s). Mentioning the same extension	1171	searchable scrollback to Alt/Meta-s). Mentioning the same extension
1113	multiple times with different arguments will pass multiple arguments to	1172	multiple times with different arguments will pass multiple arguments to
1114	the extension.	1173	the extension.
1115		1174
1116	Each extension is looked up in the library directories, loaded if	1175	Each extension is looked up in the library directories, loaded if
1117	necessary, and bound to the current terminal instance.	1176	necessary, and bound to the current terminal instance.
…		…
1153	(default: C<M-s>).	1212	(default: C<M-s>).
1154		1213
1155	=item B<urlLauncher>: I<string>	1214	=item B<urlLauncher>: I<string>
1156		1215
1157	Specifies the program to be started with a URL argument. Used by the	1216	Specifies the program to be started with a URL argument. Used by the
1158	C<selection-popup> and C<mark-urls> perl extensions.	1217	C<selection-popup> and C<matcher> perl extensions.
1159		1218
1160	=item B<transient-for>: I<windowid>	1219	=item B<transient-for>: I<windowid>
1161		1220
1162	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.	1221	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1163		1222
1164	=item B<override-redirect>: I<boolean>	1223	=item B<override-redirect>: I<boolean>
1165		1224
1166	Compile I<frills>: Sets override-redirect for the terminal window, making	1225	Compile I<frills>: Sets override-redirect for the terminal window, making
1167	it almost invisible to window managers; option B<-override-redirect>.	1226	it almost invisible to window managers; option B<-override-redirect>.
		1227
		1228	=item B<iso14755_52:> I<boolean>
		1229
		1230	Turn on/off ISO 14755 5.2 mode (default enabled).
1168		1231
1169	=back	1232	=back
1170		1233
1171	=head1 THE SCROLLBAR	1234	=head1 THE SCROLLBAR
1172		1235
…		…
1191	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1254	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1192	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1255	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1193	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1256	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1194	respectively.	1257	respectively.
1195		1258
1196	=head1 TEXT SELECTION AND INSERTION	1259	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1197		1260
1198	The behaviour of text selection and insertion mechanism is similar to	1261	The behaviour of text selection and insertion/pasting mechanism is similar
1199	I<xterm>(1).	1262	to I<xterm>(1).
1200		1263
1201	=over 4	1264	=over 4
1202		1265
1203	=item B<Selection>:	1266	=item B<Selecting>:
1204		1267
1205	Left click at the beginning of the region, drag to the end of the region	1268	Left click at the beginning of the region, drag to the end of the region
1206	and release; Right click to extend the marked region; Left double-click	1269	and release; Right click to extend the marked region; Left double-click
1207	to select a word; Left triple-click to select the entire logical line	1270	to select a word; Left triple-click to select the entire logical line
1208	(which can span multiple screen lines), unless modified by resource	1271	(which can span multiple screen lines), unless modified by resource
…		…
1212	(Compile: I<frills>) will create a rectangular selection instead of a	1275	(Compile: I<frills>) will create a rectangular selection instead of a
1213	normal one. In this mode, every selected row becomes its own line in the	1276	normal one. In this mode, every selected row becomes its own line in the
1214	selection, and trailing whitespace is visually underlined and removed from	1277	selection, and trailing whitespace is visually underlined and removed from
1215	the selection.	1278	the selection.
1216		1279
1217	=item B<Insertion>:	1280	=item B<Pasting>:
1218		1281
1219	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>	1282	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1220	window causes the value of the PRIMARY selection (or CLIPBOARD with the	1283	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1221	Meta modifier) to be inserted as if it had been typed on the keyboard.	1284	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1222		1285
1223	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1286	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1224	inserted too.	1287	inserted too.
1225		1288
1226	=back	1289	=back
…		…
1243		1306
1244	=head1 ISO 14755 SUPPORT	1307	=head1 ISO 14755 SUPPORT
1245		1308
1246	ISO 14755 is a standard for entering and viewing unicode characters	1309	ISO 14755 is a standard for entering and viewing unicode characters
1247	and character codes using the keyboard. It consists of 4 parts. The	1310	and character codes using the keyboard. It consists of 4 parts. The
1248	first part is available rxvt-unicode has been compiled with	1311	first part is available if rxvt-unicode has been compiled with
1249	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1312	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1250	with C<--enable-iso14755>.	1313	with C<--enable-iso14755>.
1251		1314
1252	=over 4	1315	=over 4
1253		1316
…		…
1376	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1439	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1377	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1440	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1378	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1441	(recommended, but B<MUST> have 4 digits/component) colour specifications,
1379	in addition to the ones provided by X, where the additional A component	1442	in addition to the ones provided by X, where the additional A component
1380	specifies opacity (alpha) values. The minimum value of C<0> is completely	1443	specifies opacity (alpha) values. The minimum value of C<0> is completely
1381	transparent). You can also prefix any color with C<[a]>, where C<a> is on	1444	transparent). You can also prefix any color with C<[percent]>, where
1382	to four hex digits specifiying the opacity value.	1445	C<percent> is a decimal percentage (0-100) that specifies the opacity of
		1446	the color, where C<0> is completely transparent and C<100> is completelxy
		1447	opaque.
1383		1448
1384	You probably need to specify B<"-depth 32">, too, and have the luck that	1449	You probably need to specify B<"-depth 32">, too, and have the luck that
1385	your X-server uses ARGB pixel layout, as X is far from just supporting	1450	your X-server uses ARGB pixel layout, as X is far from just supporting
1386	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1451	ARGB visuals out of the box, and rxvt-unicode just fudges around.
1387		1452
1388	For example, the following selects an almost completely transparent red	1453	For example, the following selects an almost completely transparent red
1389	background, and an almost opaque pink foreground:	1454	background, and an almost opaque pink foreground:
1390		1455
1391	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"	1456	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1392		1457
1393	I<Please note that transparency of any kind if completely unsupported by	1458	I<Please note that transparency of any kind if completely unsupported by
1394	the author. Don't bug him with installation questions!>	1459	the author. Don't bug him with installation questions!>
1395		1460
1396	=head1 ENVIRONMENT	1461	=head1 ENVIRONMENT
…		…
1400	=over 4	1465	=over 4
1401		1466
1402	=item B<TERM>	1467	=item B<TERM>
1403		1468
1404	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1469	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1405	resources or on the commandline.	1470	resources or on the command line.
1406		1471
1407	=item B<COLORTERM>	1472	=item B<COLORTERM>
1408		1473
1409	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1474	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1410	compiled with XPM support, and optionally with the added extension	1475	compiled with background image support, and optionally with the added
1411	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1476	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1477	screen.
1412		1478
1413	=item B<COLORFGBG>	1479	=item B<COLORFGBG>
1414		1480
1415	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1481	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1416	the colour code used as default foreground/text colour (or the string	1482	the colour code used as default foreground/text colour (or the string
1417	C<default> to indicate that the default-colour escape sequence is to be	1483	C<default> to indicate that the default-colour escape sequence is to be
1418	used), C<bg> is the colour code used as default background colour (or the	1484	used), C<bg> is the colour code used as default background colour (or the
1419	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1485	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1420	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1486	was compiled with background image support. Libraries like C<ncurses>
1421	(and do) use this information to optimize screen output.	1487	and C<slang> can (and do) use this information to optimize screen output.
1422		1488
1423	=item B<WINDOWID>	1489	=item B<WINDOWID>
1424		1490
1425	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1491	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1426	window, which usually has subwindows for the scrollbar, the terminal	1492	window, which usually has subwindows for the scrollbar, the terminal

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.115 by root, Mon Jul 10 04:01:33 2006 UTC vs. Revision 1.140 by sasha, Fri Oct 26 18:27:29 2007 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.115 by root, Mon Jul 10 04:01:33 2006 UTC vs.
Revision 1.140 by sasha, Fri Oct 26 18:27:29 2007 UTC