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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.106 by root, Wed Jan 25 21:03:03 2006 UTC vs.
Revision 1.141 by sasha, Mon Oct 29 13:40:41 2007 UTC

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.106 by root, Wed Jan 25 21:03:03 2006 UTC vs. Revision 1.141 by sasha, Mon Oct 29 13:40:41 2007 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.106 by root, Wed Jan 25 21:03:03 2006 UTC vs.
Revision 1.141 by sasha, Mon Oct 29 13:40:41 2007 UTC