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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.110 by root, Sun Jan 29 22:38:43 2006 UTC vs.
Revision 1.141 by sasha, Mon Oct 29 13:40:41 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		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. Also
		151	pure black and pure white colors essentialy mean no tinting; resource
140	I<tintColor>. Example:	152	I<tintColor>. Example:
141		153
142	@@RXVT_NAME@@ -tr -tint blue -sh 40	154	@@RXVT_NAME@@ -tr -tint blue -sh 40
143		155
144	=item B<-sh>	156	=item B<-sh> I<number>
145		157
146	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	158	Darken (0 .. 100) or lighten (100 .. 200) the transparent
147	background image in addition to tinting it (i.e. B<-tint> must be	159	background image in addition to (or instead of) tinting it;
148	specified, too, e.g. C<-tint white>).	160	resource I<shading>.
		161
		162	=item B<-blt> I<string>
		163
		164	Specify background blending type. If background pixmap is specified
		165	at the same time as transparency - such pixmap will be blended over
		166	transparency image, using method specified. Supported values are :
		167	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
		168	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
		169	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
		170	alpha-blending. Compile I<afterimage>; resource I<blendType>.
		171
		172	=item B<-blr> I<HxV>
		173
		174	Apply Gaussian Blur with the specified radii to the transparent
		175	background image. If single number is specified - both vertical and
		176	horizontal radii are considered to be the same. Setting one of the
		177	radii to 1 and another to a large number creates interesting effects
		178	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
		179	resource I<blurRadius>.
149		180
150	=item B<-bg> I<colour>	181	=item B<-bg> I<colour>
151		182
152	Window background colour; resource B<background>.	183	Window background colour; resource B<background>.
153		184
…		…
155		186
156	Window foreground colour; resource B<foreground>.	187	Window foreground colour; resource B<foreground>.
157		188
158	=item B<-pixmap> I<file[;geom]>	189	=item B<-pixmap> I<file[;geom]>
159		190
160	Compile I<XPM>: Specify XPM file for the background and also optionally	191	Compile I<afterimage>: Specify image file for the background and also
161	specify its scaling with a geometry string. Note you may need to	192	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	193	add quotes to avoid special shell interpretation of the C<;> in the
163	command-line; resource B<backgroundPixmap>.	194	command-line; for more details see resource B<backgroundPixmap>.
164		195
165	=item B<-cr> I<colour>	196	=item B<-cr> I<colour>
166		197
167	The cursor colour; resource B<cursorColor>.	198	The cursor colour; resource B<cursorColor>.
168		199
…		…
185	that are checked in order when trying to find glyphs for characters. The	216	that are checked in order when trying to find glyphs for characters. The
186	first font defines the cell size for characters; other fonts might be	217	first font defines the cell size for characters; other fonts might be
187	smaller, but not (in general) larger. A (hopefully) reasonable default	218	smaller, but not (in general) larger. A (hopefully) reasonable default
188	font list is always appended to it. See resource B<font> for more details.	219	font list is always appended to it. See resource B<font> for more details.
189		220
190	In short, to specify an X11 core font, just specify it's name or prefix it	221	In short, to specify an X11 core font, just specify its name or prefix it
191	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,	222	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
192	e.g.:	223	e.g.:
193		224
194	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	225	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
195	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	226	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
321		352
322	=item B<-lsp> I<number>	353	=item B<-lsp> I<number>
323		354
324	Compile I<frills>: Lines (pixel height) to insert between each row of	355	Compile I<frills>: Lines (pixel height) to insert between each row of
325	the display. Useful to work around font rendering problems; resource	356	the display. Useful to work around font rendering problems; resource
326	B<linespace>.	357	B<lineSpace>.
327		358
328	=item B<-tn> I<termname>	359	=item B<-tn> I<termname>
329		360
330	This option specifies the name of the terminal type to be set in the	361	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	362	B<TERM> environment variable. This terminal type must exist in the
…		…
385	for more info.	416	for more info.
386		417
387	=item B<-tcw>	418	=item B<-tcw>
388		419
389	Change the meaning of triple-click selection with the left mouse	420	Change the meaning of triple-click selection with the left mouse
		421	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	422	in-use. Instead of selecting a full line it will extend the selection the
391	end of the logical line only. resource B<tripleclickwords>.	423	end of the logical line only. resource B<tripleclickwords>.
392		424
393	=item B<-insecure>	425	=item B<-insecure>
394		426
395	Enable "insecure" mode, which currently enables most of the escape	427	Enable "insecure" mode, which currently enables most of the escape
…		…
423		455
424	Remap a key symbol. See resource B<keysym>.	456	Remap a key symbol. See resource B<keysym>.
425		457
426	=item B<-embed> I<windowid>	458	=item B<-embed> I<windowid>
427		459
428	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,	460	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
429	which enables applications to easily embed a terminal.	461	which enables applications to easily embed a terminal.
430		462
431	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it	463	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
432	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it	464	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
433	quite a bit, so don't expect it to keep some specific state. It's best to	465	quite a bit, so don't expect it to keep some specific state. It's best to
…		…
436	The window will not be destroyed when @@RXVT_NAME@@ exits.	468	The window will not be destroyed when @@RXVT_NAME@@ exits.
437		469
438	It might be useful to know that @@RXVT_NAME@@ will not close file	470	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	471	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	472	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	473	terminal. This works regardless of whether the C<-embed> option was used or
442	not.	474	not.
443		475
444	Here is a short Gtk2-perl snippet that illustrates how this option can be	476	Here is a short Gtk2-perl snippet that illustrates how this option can be
445	used (a longer example is in F<doc/embed>):	477	used (a longer example is in F<doc/embed>):
446		478
…		…
451	});	483	});
452		484
453	=item B<-pty-fd> I<file descriptor>	485	=item B<-pty-fd> I<file descriptor>
454		486
455	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	487	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	488	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	489	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
458	without having to run a program within it.	490	without having to run a program within it.
459		491
460	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	492	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	493	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	595	Use the specified colour to display underlined characters when the
564	foreground colour is the default.	596	foreground colour is the default.
565		597
566	=item B<colorRV:> I<colour>	598	=item B<colorRV:> I<colour>
567		599
568	Use the specified colour as the background for reverse video	600	Use the specified colour as the background for reverse video characters
569	characters.	601	when OPTION_HC is disabled (--disable-frills).
570		602
571	=item B<underlineColor:> I<colour>	603	=item B<underlineColor:> I<colour>
572		604
573	If set, use the specified colour as the colour for the underline	605	If set, use the specified colour as the colour for the underline
574	itself. If unset, use the foreground colour.	606	itself. If unset, use the foreground colour.
…		…
590	option B<-rv>. B<False>: regular screen colours [default]; option	622	option B<-rv>. B<False>: regular screen colours [default]; option
591	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	623	B<+rv>. See note in B<COLORS AND GRAPHICS> section.
592		624
593	=item B<jumpScroll:> I<boolean>	625	=item B<jumpScroll:> I<boolean>
594		626
595	B<True>: specify that jump scrolling should be used. When scrolling	627	B<True>: specify that jump scrolling should be used. When receiving lots
596	quickly, fewer screen updates are performed [default]; option B<-j>.	628	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		629	has been read, resulting in fewer updates while still displaying every
		630	received line; option B<-j>.
		631
597	B<False>: specify that smooth scrolling should be used; option B<+j>.	632	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		633	force a screen refresh on each new line it received; option B<+j>.
		634
		635	=item B<skipScroll:> I<boolean>
		636
		637	B<True>: (the default) specify that skip scrolling should be used. When
		638	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
		639	(around 60 times per second), resulting in far fewer updates. This can
		640	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		641	option B<-ss>.
		642
		643	B<False>: specify that everything is to be displayed, even
		644	if the refresh is too fast for the human eye to read anything (or the
		645	monitor to display anything); option B<+ss>.
598		646
599	=item B<inheritPixmap:> I<boolean>	647	=item B<inheritPixmap:> I<boolean>
600		648
601	B<True>: make the background inherit the parent windows' pixmap, giving	649	B<True>: make the background inherit the parent windows' pixmap, giving
602	artificial transparency. B<False>: do not inherit the parent windows'	650	artificial transparency. B<False>: do not inherit the parent windows'
…		…
619	Tint the transparent background pixmap with the given colour; option	667	Tint the transparent background pixmap with the given colour; option
620	B<-tint>.	668	B<-tint>.
621		669
622	=item B<shading:> I<number>	670	=item B<shading:> I<number>
623		671
624	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	672	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
625	image in addition to tinting it.	673	in addition to tinting it; option B<-sh>.
		674
		675	=item B<blendType:> I<string>
		676
		677	Specify background blending type; option B<-blt>.
		678
		679	=item B<blurRadius:> I<number>
		680
		681	Apply Gaussian Blurr with the specified radius to the transparent
		682	background image; option B<-blr>.
626		683
627	=item B<scrollColor:> I<colour>	684	=item B<scrollColor:> I<colour>
628		685
629	Use the specified colour for the scrollbar [default #B2B2B2].	686	Use the specified colour for the scrollbar [default #B2B2B2].
630		687
…		…
638	The colour of the border around the text area and between the scrollbar	695	The colour of the border around the text area and between the scrollbar
639	and the text.	696	and the text.
640		697
641	=item B<backgroundPixmap:> I<file[;geom]>	698	=item B<backgroundPixmap:> I<file[;geom]>
642		699
643	Use the specified XPM file (note the `.xpm' extension is optional) for	700	Use the specified image file for the background and also optionally
644	the background and also optionally specify its scaling with a geometry	701	specify its scaling with a geometry string B<WxH+X+Y>,
645	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	702	in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
646	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	703	and B<"X" / "Y"> locate the image centre (percent).
647	centre (percent). A scale of 0 displays the image with tiling. A scale	704	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	705	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	706	number of images in that direction. No image will be magnified beyond
650	be magnified beyond 10 times its original size. The maximum permitted	707	10 times its original size. The maximum permitted scale is 1000.
651	scale is 1000. [default 0x0+50+50]	708	Special string of B<"auto"> used as a geometry will cause image to be
		709	automatically scaled to match window size.
		710	If used in conjunction with B<-tr> option - specified pixmap will be
		711	blended over transparency image using either alpha-blending, or any
		712	other blending type, specified with B<-blt "type"> option.
		713	[default 0x0+50+50]
652		714
653	=item B<path:> I<path>	715	=item B<path:> I<path>
654		716
655	Specify the colon-delimited search path for finding XPM files.	717	Specify the colon-delimited search path for finding background image files.
656		718
657	=item B<font:> I<fontlist>	719	=item B<font:> I<fontlist>
658		720
659	Select the fonts to be used. This is a comma separated list of font names	721	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	722	that are checked in order when trying to find glyphs for characters. The
…		…
718		780
719	=item B<intensityStyles:> I<boolean>	781	=item B<intensityStyles:> I<boolean>
720		782
721	When font styles are not enabled, or this option is enabled (B<True>,	783	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	784	option B<-is>, the default), bold and italic font styles imply high
723	intensity foreground/backround colours. Disabling this option (B<False>,	785	intensity foreground/background colours. Disabling this option (B<False>,
724	option B<+is>) disables this behaviour, the high intensity colours are not	786	option B<+is>) disables this behaviour, the high intensity colours are not
725	reachable.	787	reachable.
726		788
727	=item B<selectstyle:> I<mode>	789	=item B<selectstyle:> I<mode>
728		790
729	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	791	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	792	is xterm style with 2.20 old word selection, or anything else which
731	xterm style selection.	793	gives xterm style selection. Only effective when the original (non-perl)
		794	selection code is in use.
732		795
733	=item B<scrollstyle:> I<mode>	796	=item B<scrollstyle:> I<mode>
734		797
735	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	798	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
736	the author's favourite.	799	the author's favourite.
…		…
750	=item B<mapAlert:> I<boolean>	813	=item B<mapAlert:> I<boolean>
751		814
752	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	815	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].	816	de-iconify (map) on receipt of a bell character [default].
754		817
		818	=item B<urgentOnBell:> I<boolean>
		819
		820	B<True>: set the urgency hint for the wm on receipt of a bell character.
		821	B<False>: do not set the urgency hint [default].
		822
755	=item B<visualBell:> I<boolean>	823	=item B<visualBell:> I<boolean>
756		824
757	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	825	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
758	B<False>: no visual bell [default]; option B<+vb>.	826	B<False>: no visual bell [default]; option B<+vb>.
759		827
…		…
780	Example:	848	Example:
781		849
782	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	850	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
783		851
784	This creates a new file in your home directory with the screen contents	852	This creates a new file in your home directory with the screen contents
785	everytime you hit C<Print>.	853	every time you hit C<Print>.
786		854
787	=item B<scrollBar:> I<boolean>	855	=item B<scrollBar:> I<boolean>
788		856
789	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	857	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
790	disable the scrollbar; option B<+sb>.	858	disable the scrollbar; option B<+sb>.
…		…
812		880
813	=item B<scrollWithBuffer:> I<boolean>	881	=item B<scrollWithBuffer:> I<boolean>
814		882
815	B<True>: scroll with scrollback buffer when tty receives new lines (and	883	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	884	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
817	with scrollback buffer when tty recieves new lines; option B<+sw>.	885	with scrollback buffer when tty receives new lines; option B<+sw>.
818		886
819	=item B<scrollTtyKeypress:> I<boolean>	887	=item B<scrollTtyKeypress:> I<boolean>
820		888
821	B<True>: scroll to bottom when a non-special key is pressed. Special keys	889	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	890	are those which are intercepted by rxvt-unicode for special handling and
…		…
853	=item B<termName:> I<termname>	921	=item B<termName:> I<termname>
854		922
855	Specifies the terminal type name to be set in the B<TERM> environment	923	Specifies the terminal type name to be set in the B<TERM> environment
856	variable; option B<-tn>.	924	variable; option B<-tn>.
857		925
858	=item B<linespace:> I<number>	926	=item B<lineSpace:> I<number>
859		927
860	Specifies number of lines (pixel height) to insert between each row of	928	Specifies number of lines (pixel height) to insert between each row of
861	the display [default 0]; option B<-lsp>.	929	the display [default 0]; option B<-lsp>.
862		930
863	=item B<meta8:> I<boolean>	931	=item B<meta8:> I<boolean>
…		…
915	=item B<cutchars:> I<string>	983	=item B<cutchars:> I<string>
916		984
917	The characters used as delimiters for double-click word selection	985	The characters used as delimiters for double-click word selection
918	(whitespace delimiting is added automatically if resource is given).	986	(whitespace delimiting is added automatically if resource is given).
919		987
920	When the selection extension is in use (the default if compiled in, see	988	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	989	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	990	characters will be created (if the resource exists, otherwise, no regex
923	created). In this mode, characters outside ISO-8859-1 can be used.	991	will be created). In this mode, characters outside ISO-8859-1 can be used.
924		992
925	When the selection extension is not used, only ISO-8859-1 characters can	993	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:	994	be used. If not specified, the built-in default is used:
927		995
928	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	996	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>
…		…
987		1055
988	Turn on/off secondary screen (default enabled).	1056	Turn on/off secondary screen (default enabled).
989		1057
990	=item B<secondaryScroll:> I<boolean>	1058	=item B<secondaryScroll:> I<boolean>
991		1059
992	Turn on/off secondary screen scroll (default enabled). If the this	1060	Turn on/off secondary screen scroll (default enabled). If this
993	option is enabled, scrolls on the secondary screen will change the	1061	option is enabled, scrolls on the secondary screen will change the
994	scrollback buffer and switching to/from the secondary screen will	1062	scrollback buffer and switching to/from the secondary screen will
995	instead scroll the screen up.	1063	instead scroll the screen up.
996		1064
997	=item B<hold>: I<boolean>	1065	=item B<hold>: I<boolean>
…		…
1021	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1089	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	1090	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	1091	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.	1092	performed in an exact manner; however, the closest match is assured.
1025		1093
1026	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1094	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,	1095	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 it's 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		1096
1037	You can define a range of keysyms in one shot by providing a I<string>	1097	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 `/'	1098	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1039	should be a character not used by the strings.	1099	should be a character not used by the strings.
1040		1100
1041	Its usage can be demonstrated by an example:	1101	Its usage can be demonstrated by an example:
1042		1102
1043	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1103	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
…		…
1107	example, C<default,-selection> will use all the default extension except	1167	example, C<default,-selection> will use all the default extension except
1108	C<selection>.	1168	C<selection>.
1109		1169
1110	Extension names can also be followed by an argument in angle brackets	1170	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	1171	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1112	searchable scorllback to Alt/Meta-s). Mentioning the same extension	1172	searchable scrollback to Alt/Meta-s). Mentioning the same extension
1113	multiple times with different arguments will pass multiple arguments to	1173	multiple times with different arguments will pass multiple arguments to
1114	the extension.	1174	the extension.
1115		1175
1116	Each extension is looked up in the library directories, loaded if	1176	Each extension is looked up in the library directories, loaded if
1117	necessary, and bound to the current terminal instance.	1177	necessary, and bound to the current terminal instance.
…		…
1153	(default: C<M-s>).	1213	(default: C<M-s>).
1154		1214
1155	=item B<urlLauncher>: I<string>	1215	=item B<urlLauncher>: I<string>
1156		1216
1157	Specifies the program to be started with a URL argument. Used by the	1217	Specifies the program to be started with a URL argument. Used by the
1158	C<selection-popup> and C<mark-urls> perl extensions.	1218	C<selection-popup> and C<matcher> perl extensions.
1159		1219
1160	=item B<transient-for>: I<windowid>	1220	=item B<transient-for>: I<windowid>
1161		1221
1162	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.	1222	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1163		1223
1164	=item B<override-redirect>: I<boolean>	1224	=item B<override-redirect>: I<boolean>
1165		1225
1166	Compile I<frills>: Sets override-redirect for the terminal window, making	1226	Compile I<frills>: Sets override-redirect for the terminal window, making
1167	it almost invisible to window managers; option B<-override-redirect>.	1227	it almost invisible to window managers; option B<-override-redirect>.
		1228
		1229	=item B<iso14755_52:> I<boolean>
		1230
		1231	Turn on/off ISO 14755 5.2 mode (default enabled).
1168		1232
1169	=back	1233	=back
1170		1234
1171	=head1 THE SCROLLBAR	1235	=head1 THE SCROLLBAR
1172		1236
…		…
1191	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1255	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1192	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1256	(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),	1257	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1194	respectively.	1258	respectively.
1195		1259
1196	=head1 TEXT SELECTION AND INSERTION	1260	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1197		1261
1198	The behaviour of text selection and insertion mechanism is similar to	1262	The behaviour of text selection and insertion/pasting mechanism is similar
1199	I<xterm>(1).	1263	to I<xterm>(1).
1200		1264
1201	=over 4	1265	=over 4
1202		1266
1203	=item B<Selection>:	1267	=item B<Selecting>:
1204		1268
1205	Left click at the beginning of the region, drag to the end of the region	1269	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	1270	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	1271	to select a word; Left triple-click to select the entire logical line
1208	(which can span multiple screen lines), unless modified by resource	1272	(which can span multiple screen lines), unless modified by resource
…		…
1212	(Compile: I<frills>) will create a rectangular selection instead of a	1276	(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	1277	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	1278	selection, and trailing whitespace is visually underlined and removed from
1215	the selection.	1279	the selection.
1216		1280
1217	=item B<Insertion>:	1281	=item B<Pasting>:
1218		1282
1219	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>	1283	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	1284	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.	1285	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1222		1286
1223	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1287	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1224	inserted too.	1288	inserted too.
1225		1289
1226	=back	1290	=back
…		…
1243		1307
1244	=head1 ISO 14755 SUPPORT	1308	=head1 ISO 14755 SUPPORT
1245		1309
1246	ISO 14755 is a standard for entering and viewing unicode characters	1310	ISO 14755 is a standard for entering and viewing unicode characters
1247	and character codes using the keyboard. It consists of 4 parts. The	1311	and character codes using the keyboard. It consists of 4 parts. The
1248	first part is available rxvt-unicode has been compiled with	1312	first part is available if rxvt-unicode has been compiled with
1249	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1313	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1250	with C<--enable-iso14755>.	1314	with C<--enable-iso14755>.
1251		1315
1252	=over 4	1316	=over 4
1253		1317
…		…
1273	This mode lets you input characters representing the keycap symbols of	1337	This mode lets you input characters representing the keycap symbols of
1274	your keyboard, if representable in the current locale encoding.	1338	your keyboard, if representable in the current locale encoding.
1275		1339
1276	Start by pressing C<Control> and C<Shift> together, then releasing	1340	Start by pressing C<Control> and C<Shift> together, then releasing
1277	them. The next special key (cursor keys, home etc.) you enter will not	1341	them. The next special key (cursor keys, home etc.) you enter will not
1278	invoke it's usual function but instead will insert the corresponding	1342	invoke its usual function but instead will insert the corresponding
1279	keycap symbol. The symbol will only be entered when the key has been	1343	keycap symbol. The symbol will only be entered when the key has been
1280	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1344	released, otherwise pressing e.g. C<Shift> would enter the symbol for
1281	C<ISO Level 2 Switch>, although your intention might have been to enter a	1345	C<ISO Level 2 Switch>, although your intention might have been to enter a
1282	reverse tab (Shift-Tab).	1346	reverse tab (Shift-Tab).
1283		1347
…		…
1346	It is also possible to specify the colour values of B<foreground>,	1410	It is also possible to specify the colour values of B<foreground>,
1347	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1411	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1348	a number 0-15, as a convenient shorthand to reference the colour name of	1412	a number 0-15, as a convenient shorthand to reference the colour name of
1349	color0-color15.	1413	color0-color15.
1350		1414
1351	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1415	In addition to the colours defined above, @@RXVT_NAME@@ offers an
1352	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1416	additional 72 colours. The first 64 of those (with indices 16 to 79)
1353	(recommended, but B<MUST> have 4 digits/component), C<#ARGB>, C<#AARRGGBB>	1417	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1354	and C<#AAAARRRRGGGGBBBB> colour specifications, in addition to the ones	1418	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1355	provided by X, where the additional A component specifies alpha (opacity)
1356	values (0 is completely transparent and the maximum is opaque). You
1357	probably need to specify B<"-depth 32">, too, and have the luck that your
1358	X-server uses ARGB pixel layout, as X is far from just supporting ARGB
1359	visuals out of the box, and rxvt-unicode just fudges around.
1360		1419
1361	I<Please note that transparency of any kind if completely unsupported by	1420	Together, all those colours implement the 88 colour xterm colours. Only
1362	the author. Don't bug him with installation questions!>	1421	the first 16 can be changed using resources currently, the rest can only
		1422	be changed via command sequences ("escape codes").
1363		1423
1364	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1424	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1365	always swapping the foreground/background colours. This is in contrast to	1425	always swapping the foreground/background colours. This is in contrast to
1366	I<xterm>(1) where the colours are only swapped if they have not otherwise	1426	I<xterm>(1) where the colours are only swapped if they have not otherwise
1367	been specified. For example,	1427	been specified. For example,
…		…
1373	would yield White on Black, while on I<xterm>(1) it would yield Black	1433	would yield White on Black, while on I<xterm>(1) it would yield Black
1374	on White.	1434	on White.
1375		1435
1376	=back	1436	=back
1377		1437
		1438	=head2 ALPHA CHANNEL SUPPORT
		1439
		1440	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1441	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
		1442	(recommended, but B<MUST> have 4 digits/component) colour specifications,
		1443	in addition to the ones provided by X, where the additional A component
		1444	specifies opacity (alpha) values. The minimum value of C<0> is completely
		1445	transparent). You can also prefix any color with C<[percent]>, where
		1446	C<percent> is a decimal percentage (0-100) that specifies the opacity of
		1447	the color, where C<0> is completely transparent and C<100> is completelxy
		1448	opaque.
		1449
		1450	You probably need to specify B<"-depth 32">, too, and have the luck that
		1451	your X-server uses ARGB pixel layout, as X is far from just supporting
		1452	ARGB visuals out of the box, and rxvt-unicode just fudges around.
		1453
		1454	For example, the following selects an almost completely transparent red
		1455	background, and an almost opaque pink foreground:
		1456
		1457	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
		1458
		1459	I<Please note that transparency of any kind if completely unsupported by
		1460	the author. Don't bug him with installation questions!>
		1461
1378	=head1 ENVIRONMENT	1462	=head1 ENVIRONMENT
1379		1463
1380	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1464	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1381		1465
1382	=over 4	1466	=over 4
1383		1467
1384	=item B<TERM>	1468	=item B<TERM>
1385		1469
1386	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1470	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1387	resources or on the commandline.	1471	resources or on the command line.
1388		1472
1389	=item B<COLORTERM>	1473	=item B<COLORTERM>
1390		1474
1391	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1475	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1392	compiled with XPM support, and optionally with the added extension	1476	compiled with background image support, and optionally with the added
1393	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1477	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1478	screen.
1394		1479
1395	=item B<COLORFGBG>	1480	=item B<COLORFGBG>
1396		1481
1397	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1482	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1398	the colour code used as default foreground/text colour (or the string	1483	the colour code used as default foreground/text colour (or the string
1399	C<default> to indicate that the default-colour escape sequence is to be	1484	C<default> to indicate that the default-colour escape sequence is to be
1400	used), C<bg> is the colour code used as default background colour (or the	1485	used), C<bg> is the colour code used as default background colour (or the
1401	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1486	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1402	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1487	was compiled with background image support. Libraries like C<ncurses>
1403	(and do) use this information to optimize screen output.	1488	and C<slang> can (and do) use this information to optimize screen output.
1404		1489
1405	=item B<WINDOWID>	1490	=item B<WINDOWID>
1406		1491
1407	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1492	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1408	window, which usually has subwindows for the scrollbar, the terminal	1493	window, which usually has subwindows for the scrollbar, the terminal
…		…
1414	C<--with-terminfo=PATH>.	1499	C<--with-terminfo=PATH>.
1415		1500
1416	=item B<DISPLAY>	1501	=item B<DISPLAY>
1417		1502
1418	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1503	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1419	display in it's child processes.	1504	display in its child processes.
1420		1505
1421	=item B<SHELL>	1506	=item B<SHELL>
1422		1507
1423	The shell to be used for command execution, defaults to C</bin/sh>.	1508	The shell to be used for command execution, defaults to C</bin/sh>.
1424		1509
…		…
1466		1551
1467	=item Project Coordinator	1552	=item Project Coordinator
1468		1553
1469	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1554	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1470		1555
1471	L<http://software.schmorp.de/#rxvt-unicode>	1556	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1472		1557
1473	=back	1558	=back
1474		1559
1475	=head1 AUTHORS	1560	=head1 AUTHORS
1476		1561

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.110 by root, Sun Jan 29 22:38:43 2006 UTC vs. Revision 1.141 by sasha, Mon Oct 29 13:40:41 2007 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.110 by root, Sun Jan 29 22:38:43 2006 UTC vs.
Revision 1.141 by sasha, Mon Oct 29 13:40:41 2007 UTC