[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.140 by sasha, Fri Oct 26 18:27:29 2007 UTC

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

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.140 by sasha, Fri Oct 26 18:27:29 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.140 by sasha, Fri Oct 26 18:27:29 2007 UTC