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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.107 by root, Sun Jan 29 20:51:27 2006 UTC vs.
Revision 1.133 by ayin, Sat Jul 28 20:15:18 2007 UTC

…		…
17	=head1 FREQUENTLY ASKED QUESTIONS	17	=head1 FREQUENTLY ASKED QUESTIONS
18		18
19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of	19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20	frequently asked questions and answer to them and some common	20	frequently asked questions and answer to them and some common
21	problems. That document is also accessible on the World-Wide-Web at	21	problems. That document is also accessible on the World-Wide-Web at
22	L<http://cvs.schmorp.de/browse/checkout/rxvt-unicode/doc/rxvt.7.html>.	22	L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.
23		23
24	=head1 RXVT-UNICODE VS. RXVT	24	=head1 RXVT-UNICODE VS. RXVT
25		25
26	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode	26	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27	internally. That means it can store and display most scripts in the	27	internally. That means it can store and display most scripts in the
28	world. Being a terminal emulator, however, some things are very difficult,	28	world. Being a terminal emulator, however, some things are very difficult,
29	especially cursive scripts such as arabic, vertically written scripts	29	especially cursive scripts such as arabic, vertically written scripts
30	like mongolian or scripts requiring extremely complex combining rules,	30	like mongolian or scripts requiring extremely complex combining rules,
31	like tibetan or devenagari. Don't expect pretty output when using these	31	like tibetan or devenagari. Don't expect pretty output when using these
32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33	fine, though. A somewhat difficult case are left-to-right scripts, such	33	fine, though. A somewhat difficult case are right-to-left scripts, such
34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35	belong into the application, not the terminal emulator (too many things --	35	belong into the application, not the terminal emulator (too many things --
36	such as cursor-movement while editing -- break otherwise), but that might	36	such as cursor-movement while editing -- break otherwise), but that might
37	change.	37	change.
38		38
39	If you are looking for a terminal that supports more exotic scripts, let	39	If you are looking for a terminal that supports more exotic scripts, let
40	me recommend C<mlterm>, which is a very userfriendly, lean and clean	40	me recommend C<mlterm>, which is a very user friendly, lean and clean
41	terminal emulator. In fact, the reason rxvt-unicode was born was solely	41	terminal emulator. In fact, the reason rxvt-unicode was born was solely
42	because the author couldn't get C<mlterm> to use one font for latin1 and	42	because the author couldn't get C<mlterm> to use one font for latin1 and
43	another for japanese.	43	another for japanese.
44		44
45	Therefore another design rationale was the use of multiple fonts to	45	Therefore another design rationale was the use of multiple fonts to
46	display characters: The idea of a single unicode font which many other	46	display characters: The idea of a single unicode font which many other
47	programs force onto it's users never made sense to me: You should be able	47	programs force onto its users never made sense to me: You should be able
48	to choose any font for any script freely.	48	to choose any font for any script freely.
49		49
50	Apart from that, rxvt-unicode is also much better internationalised than	50	Apart from that, rxvt-unicode is also much better internationalised than
51	it's predecessor, supports things such as XFT and ISO 14755 that are handy	51	its predecessor, supports things such as XFT and ISO 14755 that are handy
52	in i18n-environments, is faster, and has a lot less bugs than the original	52	in i18n-environments, is faster, and has a lot bugs less than the original
53	rxvt. This all in addition to dozens of other small improvements.	53	rxvt. This all in addition to dozens of other small improvements.
54		54
55	It is still faithfully following the original rxvt idea of being lean	55	It is still faithfully following the original rxvt idea of being lean
56	and nice on resources: for example, you can still configure rxvt-unicode	56	and nice on resources: for example, you can still configure rxvt-unicode
57	without most of it's features to get a lean binary. It also comes with	57	without most of its features to get a lean binary. It also comes with
58	a client/daemon pair that lets you open any number of terminal windows	58	a client/daemon pair that lets you open any number of terminal windows
59	from within a single process, which makes startup time very fast and	59	from within a single process, which makes startup time very fast and
60	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and	60	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
61	@@RXVT_NAME@@c(1) (client).	61	@@RXVT_NAME@@c(1) (client).
62		62
63	It also makes technical information about escape sequences (which have	63	It also makes technical information about escape sequences (which have
64	been extended) easier accessible: see @@RXVT_NAME@@(7) for technical	64	been extended) more accessible: see @@RXVT_NAME@@(7) for technical
65	reference documentation (escape sequences etc.).	65	reference documentation (escape sequences etc.).
66		66
67	=head1 OPTIONS	67	=head1 OPTIONS
68		68
69	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed	69	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
…		…
95	respected). In the absence of this option, the display specified by the	95	respected). In the absence of this option, the display specified by the
96	B<DISPLAY> environment variable is used.	96	B<DISPLAY> environment variable is used.
97		97
98	=item B<-depth> I<bitdepth>	98	=item B<-depth> I<bitdepth>
99		99
100	Compile I<frills>: Attempt to find a visual with the given bit depth;	100	Compile I<xft>: Attempt to find a visual with the given bit depth;
101	resource B<depth>.	101	resource B<depth>.
102		102
103	=item B<-geometry> I<geom>	103	=item B<-geometry> I<geom>
104		104
105	Window geometry (B<-g> still respected); resource B<geometry>.	105	Window geometry (B<-g> still respected); resource B<geometry>.
…		…
108		108
109	Turn on/off simulated reverse video; resource B<reverseVideo>.	109	Turn on/off simulated reverse video; resource B<reverseVideo>.
110		110
111	=item B<-j>\|B<+j>	111	=item B<-j>\|B<+j>
112		112
113	Turn on/off jump scrolling; resource B<jumpScroll>.	113	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
		114
		115	=item B<-ss>\|B<+ss>
		116
		117	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
114		118
115	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>	119	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>
116		120
117	Turn on/off inheriting parent window's pixmap. Alternative form is	121	Turn on/off inheriting parent window's pixmap. Alternative form is
118	B<-tr>; resource B<inheritPixmap>.	122	B<-tr>; resource B<inheritPixmap>.
		123
		124	I<Please note that transparency of any kind if completely unsupported by
		125	the author. Don't bug him with installation questions! Read the FAQ (man 7
		126	@@RXVT_NAME@@)!>
119		127
120	=item B<-fade> I<number>	128	=item B<-fade> I<number>
121		129
122	Fade the text by the given percentage when focus is lost. Small values	130	Fade the text by the given percentage when focus is lost. Small values
123	fade a little only, 100 completely replaces all colours by the fade	131	fade a little only, 100 completely replaces all colours by the fade
124	colour; resource B<fading>.	132	colour; resource B<fading>.
125		133
126	=item B<-fadecolor> I<colour>	134	=item B<-fadecolor> I<colour>
127		135
128	Fade to this colour when fading is used (see B<-fade>). The default colour	136	Fade to this colour when fading is used (see B<-fade>). The default colour
129	is black. resource B<fadeColor>.	137	is opaque black. resource B<fadeColor>.
130		138
131	=item B<-tint> I<colour>	139	=item B<-tint> I<colour>
132		140
133	Tint the transparent background pixmap with the given colour when	141	Tint the transparent background pixmap with the given colour when
134	transparency is enabled with B<-tr> or B<-ip>. This only works for	142	transparency is enabled with B<-tr> or B<-ip>. This only works for
…		…
136	used to brighten or darken the image in addition to tinting it; resource	144	used to brighten or darken the image in addition to tinting it; resource
137	I<tintColor>. Example:	145	I<tintColor>. Example:
138		146
139	@@RXVT_NAME@@ -tr -tint blue -sh 40	147	@@RXVT_NAME@@ -tr -tint blue -sh 40
140		148
141	=item B<-sh>	149	=item B<-sh> I<number>
142		150
143	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	151	Darken (0 .. 100) or lighten (-1 .. -100) the transparent
144	background image in addition to tinting it (i.e. B<-tint> must be	152	background image in addition to (or instead of) tinting it;
145	specified, too, e.g. C<-tint white>).	153	resource I<shading>.
		154
		155	=item B<-blt> I<string>
		156
		157	Specify background blending type. If background pixmap is specified
		158	at the same time as transparency - such pixmap will be blended over
		159	transparency image, using method specified. Supported values are :
		160	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
		161	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
		162	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
		163	alpha-blending; resource I<blendType>.
		164
		165	=item B<-blr> I<number>
		166
		167	Apply Gaussian Blur with the specified radius to the transparent
		168	background image; resource I<blurRadius>.
146		169
147	=item B<-bg> I<colour>	170	=item B<-bg> I<colour>
148		171
149	Window background colour; resource B<background>.	172	Window background colour; resource B<background>.
150		173
…		…
152		175
153	Window foreground colour; resource B<foreground>.	176	Window foreground colour; resource B<foreground>.
154		177
155	=item B<-pixmap> I<file[;geom]>	178	=item B<-pixmap> I<file[;geom]>
156		179
157	Compile I<XPM>: Specify XPM file for the background and also optionally	180	Compile I<afterimage>: Specify image file for the background and also
158	specify its scaling with a geometry string. Note you may need to	181	optionally specify its scaling with a geometry string. Note you may need to
159	add quotes to avoid special shell interpretation of the C<;> in the	182	add quotes to avoid special shell interpretation of the C<;> in the
160	command-line; resource B<backgroundPixmap>.	183	command-line; for more details see resource B<backgroundPixmap>.
161		184
162	=item B<-cr> I<colour>	185	=item B<-cr> I<colour>
163		186
164	The cursor colour; resource B<cursorColor>.	187	The cursor colour; resource B<cursorColor>.
165		188
…		…
182	that are checked in order when trying to find glyphs for characters. The	205	that are checked in order when trying to find glyphs for characters. The
183	first font defines the cell size for characters; other fonts might be	206	first font defines the cell size for characters; other fonts might be
184	smaller, but not (in general) larger. A (hopefully) reasonable default	207	smaller, but not (in general) larger. A (hopefully) reasonable default
185	font list is always appended to it. See resource B<font> for more details.	208	font list is always appended to it. See resource B<font> for more details.
186		209
187	In short, to specify an X11 core font, just specify it's name or prefix it	210	In short, to specify an X11 core font, just specify its name or prefix it
188	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,	211	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
189	e.g.:	212	e.g.:
190		213
191	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	214	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
192	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	215	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
382	for more info.	405	for more info.
383		406
384	=item B<-tcw>	407	=item B<-tcw>
385		408
386	Change the meaning of triple-click selection with the left mouse	409	Change the meaning of triple-click selection with the left mouse
		410	button. Only effective when the original (non-perl) selection code is
387	button. Instead of selecting a full line it will extend the selection the	411	in-use. Instead of selecting a full line it will extend the selection the
388	end of the logical line only. resource B<tripleclickwords>.	412	end of the logical line only. resource B<tripleclickwords>.
389		413
390	=item B<-insecure>	414	=item B<-insecure>
391		415
392	Enable "insecure" mode, which currently enables most of the escape	416	Enable "insecure" mode, which currently enables most of the escape
…		…
420		444
421	Remap a key symbol. See resource B<keysym>.	445	Remap a key symbol. See resource B<keysym>.
422		446
423	=item B<-embed> I<windowid>	447	=item B<-embed> I<windowid>
424		448
425	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,	449	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
426	which enables applications to easily embed a terminal.	450	which enables applications to easily embed a terminal.
427		451
428	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it	452	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
429	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it	453	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
430	quite a bit, so don't expect it to keep some specific state. It's best to	454	quite a bit, so don't expect it to keep some specific state. It's best to
…		…
433	The window will not be destroyed when @@RXVT_NAME@@ exits.	457	The window will not be destroyed when @@RXVT_NAME@@ exits.
434		458
435	It might be useful to know that @@RXVT_NAME@@ will not close file	459	It might be useful to know that @@RXVT_NAME@@ will not close file
436	descriptors passed to it (except for stdin/out/err, of course), so you	460	descriptors passed to it (except for stdin/out/err, of course), so you
437	can use file descriptors to communicate with the programs within the	461	can use file descriptors to communicate with the programs within the
438	terminal. This works regardless of wether the C<-embed> option was used or	462	terminal. This works regardless of whether the C<-embed> option was used or
439	not.	463	not.
440		464
441	Here is a short Gtk2-perl snippet that illustrates how this option can be	465	Here is a short Gtk2-perl snippet that illustrates how this option can be
442	used (a longer example is in F<doc/embed>):	466	used (a longer example is in F<doc/embed>):
443		467
…		…
448	});	472	});
449		473
450	=item B<-pty-fd> I<file descriptor>	474	=item B<-pty-fd> I<file descriptor>
451		475
452	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	476	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
453	pair but instead use the given filehandle as the tty master. This is	477	pair but instead use the given file descriptor as the tty master. This is
454	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator	478	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
455	without having to run a program within it.	479	without having to run a program within it.
456		480
457	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	481	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
458	entries and will not tinker with pty/tty permissions - you have to do that	482	entries and will not tinker with pty/tty permissions - you have to do that
…		…
512		536
513	=over 4	537	=over 4
514		538
515	=item B<depth:> I<bitdepth>	539	=item B<depth:> I<bitdepth>
516		540
517	Compile I<frills>: Attempt to find a visual with the given bit depth;	541	Compile I<xft>: Attempt to find a visual with the given bit depth;
518	option B<-depth>.	542	option B<-depth>.
519		543
520	=item B<geometry:> I<geom>	544	=item B<geometry:> I<geom>
521		545
522	Create the window with the specified X window geometry [default 80x24];	546	Create the window with the specified X window geometry [default 80x24];
…		…
560	Use the specified colour to display underlined characters when the	584	Use the specified colour to display underlined characters when the
561	foreground colour is the default.	585	foreground colour is the default.
562		586
563	=item B<colorRV:> I<colour>	587	=item B<colorRV:> I<colour>
564		588
565	Use the specified colour as the background for reverse video	589	Use the specified colour as the background for reverse video characters
566	characters.	590	when OPTION_HC is disabled (--disable-frills).
567		591
568	=item B<underlineColor:> I<colour>	592	=item B<underlineColor:> I<colour>
569		593
570	If set, use the specified colour as the colour for the underline	594	If set, use the specified colour as the colour for the underline
571	itself. If unset, use the foreground colour.	595	itself. If unset, use the foreground colour.
…		…
587	option B<-rv>. B<False>: regular screen colours [default]; option	611	option B<-rv>. B<False>: regular screen colours [default]; option
588	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	612	B<+rv>. See note in B<COLORS AND GRAPHICS> section.
589		613
590	=item B<jumpScroll:> I<boolean>	614	=item B<jumpScroll:> I<boolean>
591		615
592	B<True>: specify that jump scrolling should be used. When scrolling	616	B<True>: specify that jump scrolling should be used. When receiving lots
593	quickly, fewer screen updates are performed [default]; option B<-j>.	617	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		618	has been read, resulting in fewer updates while still displaying every
		619	received line; option B<-j>.
		620
594	B<False>: specify that smooth scrolling should be used; option B<+j>.	621	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		622	force a screen refresh on each new line it received; option B<+j>.
		623
		624	=item B<skipScroll:> I<boolean>
		625
		626	B<True>: (the default) specify that skip scrolling should be used. When
		627	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
		628	(around 60 times per second), resulting in far fewer updates. This can
		629	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		630	option B<-ss>.
		631
		632	B<False>: specify that everything is to be displayed, even
		633	if the refresh is too fast for the human eye to read anything (or the
		634	monitor to display anything); option B<+ss>.
595		635
596	=item B<inheritPixmap:> I<boolean>	636	=item B<inheritPixmap:> I<boolean>
597		637
598	B<True>: make the background inherit the parent windows' pixmap, giving	638	B<True>: make the background inherit the parent windows' pixmap, giving
599	artificial transparency. B<False>: do not inherit the parent windows'	639	artificial transparency. B<False>: do not inherit the parent windows'
600	pixmap.	640	pixmap.
601		641
		642	I<Please note that transparency of any kind if completely unsupported by
		643	the author. Don't bug him with installation questions!>
		644
602	=item B<fading:> I<number>	645	=item B<fading:> I<number>
603		646
604	Fade the text by the given percentage when focus is lost; option B<-fade>.	647	Fade the text by the given percentage when focus is lost; option B<-fade>.
605		648
606	=item B<fadeColor:> I<colour>	649	=item B<fadeColor:> I<colour>
…		…
613	Tint the transparent background pixmap with the given colour; option	656	Tint the transparent background pixmap with the given colour; option
614	B<-tint>.	657	B<-tint>.
615		658
616	=item B<shading:> I<number>	659	=item B<shading:> I<number>
617		660
618	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	661	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
619	image in addition to tinting it.	662	in addition to tinting it; option B<-sh>.
		663
		664	=item B<blendType:> I<string>
		665
		666	Specify background blending type; option B<-blt>.
		667
		668	=item B<blurRadius:> I<number>
		669
		670	Apply Gaussian Blurr with the specified radius to the transparent
		671	background image; option B<-blr>.
620		672
621	=item B<scrollColor:> I<colour>	673	=item B<scrollColor:> I<colour>
622		674
623	Use the specified colour for the scrollbar [default #B2B2B2].	675	Use the specified colour for the scrollbar [default #B2B2B2].
624		676
…		…
632	The colour of the border around the text area and between the scrollbar	684	The colour of the border around the text area and between the scrollbar
633	and the text.	685	and the text.
634		686
635	=item B<backgroundPixmap:> I<file[;geom]>	687	=item B<backgroundPixmap:> I<file[;geom]>
636		688
637	Use the specified XPM file (note the `.xpm' extension is optional) for	689	Use the specified image file for the background and also optionally
638	the background and also optionally specify its scaling with a geometry	690	specify its scaling with a geometry string B<WxH+X+Y>,
639	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	691	in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
640	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	692	and B<"X" / "Y"> locate the image centre (percent).
641	centre (percent). A scale of 0 displays the image with tiling. A scale	693	A scale of 0 displays the image with tiling. A scale of 1 displays the
642	of 1 displays the image without any scaling. A scale of 2 to 9	694	image without any scaling. A scale of 2 to 9 specifies an integer
643	specifies an integer number of images in that direction. No image will	695	number of images in that direction. No image will be magnified beyond
644	be magnified beyond 10 times its original size. The maximum permitted	696	10 times its original size. The maximum permitted scale is 1000.
645	scale is 1000. [default 0x0+50+50]	697	Special string of B<"auto"> used as a geometry will cause image to be
		698	automatically scaled to match window size.
		699	If used in conjunction with B<-tr> option - specified pixmap will be
		700	blended over transparency image using either alpha-blending, or any
		701	other blending type, specified with B<-blt "type"> option.
		702	[default 0x0+50+50]
646		703
647	=item B<path:> I<path>	704	=item B<path:> I<path>
648		705
649	Specify the colon-delimited search path for finding XPM files.	706	Specify the colon-delimited search path for finding XPM files.
650		707
…		…
712		769
713	=item B<intensityStyles:> I<boolean>	770	=item B<intensityStyles:> I<boolean>
714		771
715	When font styles are not enabled, or this option is enabled (B<True>,	772	When font styles are not enabled, or this option is enabled (B<True>,
716	option B<-is>, the default), bold and italic font styles imply high	773	option B<-is>, the default), bold and italic font styles imply high
717	intensity foreground/backround colours. Disabling this option (B<False>,	774	intensity foreground/background colours. Disabling this option (B<False>,
718	option B<+is>) disables this behaviour, the high intensity colours are not	775	option B<+is>) disables this behaviour, the high intensity colours are not
719	reachable.	776	reachable.
720		777
721	=item B<selectstyle:> I<mode>	778	=item B<selectstyle:> I<mode>
722		779
723	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	780	Set mouse selection style to B<old> which is 2.20, B<oldword> which
724	xterm style with 2.20 old word selection, or anything else which gives	781	is xterm style with 2.20 old word selection, or anything else which
725	xterm style selection.	782	gives xterm style selection. Only effective when the original (non-perl)
		783	selection code is in use.
726		784
727	=item B<scrollstyle:> I<mode>	785	=item B<scrollstyle:> I<mode>
728		786
729	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	787	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
730	the author's favourite.	788	the author's favourite.
…		…
744	=item B<mapAlert:> I<boolean>	802	=item B<mapAlert:> I<boolean>
745		803
746	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	804	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
747	de-iconify (map) on receipt of a bell character [default].	805	de-iconify (map) on receipt of a bell character [default].
748		806
		807	=item B<urgentOnBell:> I<boolean>
		808
		809	B<True>: set the urgency hint for the wm on receipt of a bell character.
		810	B<False>: do not set the urgency hint [default].
		811
749	=item B<visualBell:> I<boolean>	812	=item B<visualBell:> I<boolean>
750		813
751	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	814	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
752	B<False>: no visual bell [default]; option B<+vb>.	815	B<False>: no visual bell [default]; option B<+vb>.
753		816
…		…
774	Example:	837	Example:
775		838
776	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	839	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
777		840
778	This creates a new file in your home directory with the screen contents	841	This creates a new file in your home directory with the screen contents
779	everytime you hit C<Print>.	842	every time you hit C<Print>.
780		843
781	=item B<scrollBar:> I<boolean>	844	=item B<scrollBar:> I<boolean>
782		845
783	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	846	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
784	disable the scrollbar; option B<+sb>.	847	disable the scrollbar; option B<+sb>.
…		…
806		869
807	=item B<scrollWithBuffer:> I<boolean>	870	=item B<scrollWithBuffer:> I<boolean>
808		871
809	B<True>: scroll with scrollback buffer when tty receives new lines (and	872	B<True>: scroll with scrollback buffer when tty receives new lines (and
810	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	873	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
811	with scrollback buffer when tty recieves new lines; option B<+sw>.	874	with scrollback buffer when tty receives new lines; option B<+sw>.
812		875
813	=item B<scrollTtyKeypress:> I<boolean>	876	=item B<scrollTtyKeypress:> I<boolean>
814		877
815	B<True>: scroll to bottom when a non-special key is pressed. Special keys	878	B<True>: scroll to bottom when a non-special key is pressed. Special keys
816	are those which are intercepted by rxvt-unicode for special handling and	879	are those which are intercepted by rxvt-unicode for special handling and
…		…
909	=item B<cutchars:> I<string>	972	=item B<cutchars:> I<string>
910		973
911	The characters used as delimiters for double-click word selection	974	The characters used as delimiters for double-click word selection
912	(whitespace delimiting is added automatically if resource is given).	975	(whitespace delimiting is added automatically if resource is given).
913		976
914	When the selection extension is in use (the default if compiled in, see	977	When the perl selection extension is in use (the default if compiled
915	the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters	978	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
916	will be created (if the resource exists, otherwise, no regex will be	979	characters will be created (if the resource exists, otherwise, no regex
917	created). In this mode, characters outside ISO-8859-1 can be used.	980	will be created). In this mode, characters outside ISO-8859-1 can be used.
918		981
919	When the selection extension is not used, only ISO-8859-1 characters can	982	When the selection extension is not used, only ISO-8859-1 characters can
920	be used. If not specified, the built-in default is used:	983	be used. If not specified, the built-in default is used:
921		984
922	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	985	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>
…		…
981		1044
982	Turn on/off secondary screen (default enabled).	1045	Turn on/off secondary screen (default enabled).
983		1046
984	=item B<secondaryScroll:> I<boolean>	1047	=item B<secondaryScroll:> I<boolean>
985		1048
986	Turn on/off secondary screen scroll (default enabled). If the this	1049	Turn on/off secondary screen scroll (default enabled). If this
987	option is enabled, scrolls on the secondary screen will change the	1050	option is enabled, scrolls on the secondary screen will change the
988	scrollback buffer and switching to/from the secondary screen will	1051	scrollback buffer and switching to/from the secondary screen will
989	instead scroll the screen up.	1052	instead scroll the screen up.
990		1053
991	=item B<hold>: I<boolean>	1054	=item B<hold>: I<boolean>
…		…
1019		1082
1020	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1083	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
1021	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1084	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
1022	C<\000>: octal number) or verbatim control characters (C<^?>: delete,	1085	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1023	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it	1086	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1024	can start or end with whitespace.	1087	can start or end with whitespace. B<This feature is deprecated and will
		1088	be removed>.
1025		1089
1026	Please note that you need to double the C<\> in resource files, as	1090	Please note that you need to double the C<\> in resource files, as
1027	Xlib itself does it's own de-escaping (you can use C<\033> instead of	1091	Xlib itself does its own de-escaping (you can use C<\033> instead of
1028	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own	1092	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1029	processing).	1093	processing).
1030		1094
1031	You can define a range of keysyms in one shot by providing a I<string>	1095	You can define a range of keysyms in one shot by providing a I<string>
1032	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1096	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1033	should be a character not used by the strings.	1097	should be a character not used by the strings.
1034		1098
1035	Its usage can be demonstrated by an example:	1099	Its usage can be demonstrated by an example:
1036		1100
1037	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1101	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
…		…
1101	example, C<default,-selection> will use all the default extension except	1165	example, C<default,-selection> will use all the default extension except
1102	C<selection>.	1166	C<selection>.
1103		1167
1104	Extension names can also be followed by an argument in angle brackets	1168	Extension names can also be followed by an argument in angle brackets
1105	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1169	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1106	searchable scorllback to Alt/Meta-s). Mentioning the same extension	1170	searchable scrollback to Alt/Meta-s). Mentioning the same extension
1107	multiple times with different arguments will pass multiple arguments to	1171	multiple times with different arguments will pass multiple arguments to
1108	the extension.	1172	the extension.
1109		1173
1110	Each extension is looked up in the library directories, loaded if	1174	Each extension is looked up in the library directories, loaded if
1111	necessary, and bound to the current terminal instance.	1175	necessary, and bound to the current terminal instance.
…		…
1147	(default: C<M-s>).	1211	(default: C<M-s>).
1148		1212
1149	=item B<urlLauncher>: I<string>	1213	=item B<urlLauncher>: I<string>
1150		1214
1151	Specifies the program to be started with a URL argument. Used by the	1215	Specifies the program to be started with a URL argument. Used by the
1152	C<selection-popup> and C<mark-urls> perl extensions.	1216	C<selection-popup> and C<matcher> perl extensions.
1153		1217
1154	=item B<transient-for>: I<windowid>	1218	=item B<transient-for>: I<windowid>
1155		1219
1156	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.	1220	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1157		1221
1158	=item B<override-redirect>: I<boolean>	1222	=item B<override-redirect>: I<boolean>
1159		1223
1160	Compile I<frills>: Sets override-redirect for the terminal window, making	1224	Compile I<frills>: Sets override-redirect for the terminal window, making
1161	it almost invisible to window managers; option B<-override-redirect>.	1225	it almost invisible to window managers; option B<-override-redirect>.
		1226
		1227	=item B<iso14755_52:> I<boolean>
		1228
		1229	Turn on/off ISO 14755 5.2 mode (default enabled).
1162		1230
1163	=back	1231	=back
1164		1232
1165	=head1 THE SCROLLBAR	1233	=head1 THE SCROLLBAR
1166		1234
…		…
1185	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1253	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1186	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1254	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1187	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1255	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1188	respectively.	1256	respectively.
1189		1257
1190	=head1 TEXT SELECTION AND INSERTION	1258	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1191		1259
1192	The behaviour of text selection and insertion mechanism is similar to	1260	The behaviour of text selection and insertion/pasting mechanism is similar
1193	I<xterm>(1).	1261	to I<xterm>(1).
1194		1262
1195	=over 4	1263	=over 4
1196		1264
1197	=item B<Selection>:	1265	=item B<Selecting>:
1198		1266
1199	Left click at the beginning of the region, drag to the end of the region	1267	Left click at the beginning of the region, drag to the end of the region
1200	and release; Right click to extend the marked region; Left double-click	1268	and release; Right click to extend the marked region; Left double-click
1201	to select a word; Left triple-click to select the entire logical line	1269	to select a word; Left triple-click to select the entire logical line
1202	(which can span multiple screen lines), unless modified by resource	1270	(which can span multiple screen lines), unless modified by resource
…		…
1206	(Compile: I<frills>) will create a rectangular selection instead of a	1274	(Compile: I<frills>) will create a rectangular selection instead of a
1207	normal one. In this mode, every selected row becomes its own line in the	1275	normal one. In this mode, every selected row becomes its own line in the
1208	selection, and trailing whitespace is visually underlined and removed from	1276	selection, and trailing whitespace is visually underlined and removed from
1209	the selection.	1277	the selection.
1210		1278
1211	=item B<Insertion>:	1279	=item B<Pasting>:
1212		1280
1213	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>	1281	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1214	window causes the value of the PRIMARY selection (or CLIPBOARD with the	1282	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1215	Meta modifier) to be inserted as if it had been typed on the keyboard.	1283	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1216		1284
1217	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1285	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1218	inserted too.	1286	inserted too.
1219		1287
1220	=back	1288	=back
…		…
1237		1305
1238	=head1 ISO 14755 SUPPORT	1306	=head1 ISO 14755 SUPPORT
1239		1307
1240	ISO 14755 is a standard for entering and viewing unicode characters	1308	ISO 14755 is a standard for entering and viewing unicode characters
1241	and character codes using the keyboard. It consists of 4 parts. The	1309	and character codes using the keyboard. It consists of 4 parts. The
1242	first part is available rxvt-unicode has been compiled with	1310	first part is available if rxvt-unicode has been compiled with
1243	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1311	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1244	with C<--enable-iso14755>.	1312	with C<--enable-iso14755>.
1245		1313
1246	=over 4	1314	=over 4
1247		1315
…		…
1267	This mode lets you input characters representing the keycap symbols of	1335	This mode lets you input characters representing the keycap symbols of
1268	your keyboard, if representable in the current locale encoding.	1336	your keyboard, if representable in the current locale encoding.
1269		1337
1270	Start by pressing C<Control> and C<Shift> together, then releasing	1338	Start by pressing C<Control> and C<Shift> together, then releasing
1271	them. The next special key (cursor keys, home etc.) you enter will not	1339	them. The next special key (cursor keys, home etc.) you enter will not
1272	invoke it's usual function but instead will insert the corresponding	1340	invoke its usual function but instead will insert the corresponding
1273	keycap symbol. The symbol will only be entered when the key has been	1341	keycap symbol. The symbol will only be entered when the key has been
1274	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1342	released, otherwise pressing e.g. C<Shift> would enter the symbol for
1275	C<ISO Level 2 Switch>, although your intention might have been to enter a	1343	C<ISO Level 2 Switch>, although your intention might have been to enter a
1276	reverse tab (Shift-Tab).	1344	reverse tab (Shift-Tab).
1277		1345
…		…
1340	It is also possible to specify the colour values of B<foreground>,	1408	It is also possible to specify the colour values of B<foreground>,
1341	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1409	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1342	a number 0-15, as a convenient shorthand to reference the colour name of	1410	a number 0-15, as a convenient shorthand to reference the colour name of
1343	color0-color15.	1411	color0-color15.
1344		1412
1345	If Xft support has been compiled in and as long as Xft/Xrender don't get	1413	In addition to the colours defined above, @@RXVT_NAME@@ offers an
1346	their act together, rxvt-unicode will support C<#ARGB>, C<#AARRGGBB>	1414	additional 72 colours. The first 64 of those (with indices 16 to 79)
1347	and C<#AAAARRRRGGGGBBBB> colour specifications, in addition to the ones	1415	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1348	provided by X, where the additional A component specifies alpha (opacity)	1416	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1349	values (0 is completely transparent and the maximum is opaque). You	1417
1350	probably need to specify B<"-depth 32">, too, as X is far from just	1418	Together, all those colours implement the 88 colour xterm colours. Only
1351	supporting ARGB visuals out of the box.	1419	the first 16 can be changed using resources currently, the rest can only
		1420	be changed via command sequences ("escape codes").
1352		1421
1353	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1422	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1354	always swapping the foreground/background colours. This is in contrast to	1423	always swapping the foreground/background colours. This is in contrast to
1355	I<xterm>(1) where the colours are only swapped if they have not otherwise	1424	I<xterm>(1) where the colours are only swapped if they have not otherwise
1356	been specified. For example,	1425	been specified. For example,
…		…
1362	would yield White on Black, while on I<xterm>(1) it would yield Black	1431	would yield White on Black, while on I<xterm>(1) it would yield Black
1363	on White.	1432	on White.
1364		1433
1365	=back	1434	=back
1366		1435
		1436	=head2 ALPHA CHANNEL SUPPORT
		1437
		1438	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1439	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
		1440	(recommended, but B<MUST> have 4 digits/component) colour specifications,
		1441	in addition to the ones provided by X, where the additional A component
		1442	specifies opacity (alpha) values. The minimum value of C<0> is completely
		1443	transparent). You can also prefix any color with C<[percent]>, where
		1444	C<percent> is a decimal percentage (0-100) that specifies the opacity of
		1445	the color, where C<0> is completely transparent and C<100> is completelxy
		1446	opaque.
		1447
		1448	You probably need to specify B<"-depth 32">, too, and have the luck that
		1449	your X-server uses ARGB pixel layout, as X is far from just supporting
		1450	ARGB visuals out of the box, and rxvt-unicode just fudges around.
		1451
		1452	For example, the following selects an almost completely transparent red
		1453	background, and an almost opaque pink foreground:
		1454
		1455	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
		1456
		1457	I<Please note that transparency of any kind if completely unsupported by
		1458	the author. Don't bug him with installation questions!>
		1459
1367	=head1 ENVIRONMENT	1460	=head1 ENVIRONMENT
1368		1461
1369	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1462	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1370		1463
1371	=over 4	1464	=over 4
1372		1465
1373	=item B<TERM>	1466	=item B<TERM>
1374		1467
1375	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1468	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1376	resources or on the commandline.	1469	resources or on the command line.
1377		1470
1378	=item B<COLORTERM>	1471	=item B<COLORTERM>
1379		1472
1380	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1473	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1381	compiled with XPM support, and optionally with the added extension	1474	compiled with XPM support, and optionally with the added extension
1382	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1475	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1383		1476
1384	=item B<COLORFGBG>	1477	=item B<COLORFGBG>
1385		1478
…		…
1403	C<--with-terminfo=PATH>.	1496	C<--with-terminfo=PATH>.
1404		1497
1405	=item B<DISPLAY>	1498	=item B<DISPLAY>
1406		1499
1407	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1500	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1408	display in it's child processes.	1501	display in its child processes.
1409		1502
1410	=item B<SHELL>	1503	=item B<SHELL>
1411		1504
1412	The shell to be used for command execution, defaults to C</bin/sh>.	1505	The shell to be used for command execution, defaults to C</bin/sh>.
1413		1506
…		…
1455		1548
1456	=item Project Coordinator	1549	=item Project Coordinator
1457		1550
1458	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1551	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1459		1552
1460	L<http://software.schmorp.de/#rxvt-unicode>	1553	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1461		1554
1462	=back	1555	=back
1463		1556
1464	=head1 AUTHORS	1557	=head1 AUTHORS
1465		1558

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.107 by root, Sun Jan 29 20:51:27 2006 UTC vs. Revision 1.133 by ayin, Sat Jul 28 20:15:18 2007 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.107 by root, Sun Jan 29 20:51:27 2006 UTC vs.
Revision 1.133 by ayin, Sat Jul 28 20:15:18 2007 UTC