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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.116 by root, Mon Jul 10 04:03:09 2006 UTC vs.
Revision 1.154 by ayin, Fri Dec 14 09:06:36 2007 UTC

…		…
12	emulator intended as an I<xterm>(1) replacement for users who do not	12	emulator intended as an I<xterm>(1) replacement for users who do not
13	require features such as Tektronix 4014 emulation and toolkit-style	13	require features such as Tektronix 4014 emulation and toolkit-style
14	configurability. As a result, B<rxvt-unicode> uses much less swap space --	14	configurability. As a result, B<rxvt-unicode> uses much less swap space --
15	a significant advantage on a machine serving many X sessions.	15	a significant advantage on a machine serving many X sessions.
16		16
		17	This document is also available on the World-Wide-Web at
		18	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
		19
17	=head1 FREQUENTLY ASKED QUESTIONS	20	=head1 FREQUENTLY ASKED QUESTIONS
18		21
19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of	22	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	23	frequently asked questions and answer to them and some common
21	problems. That document is also accessible on the World-Wide-Web at	24	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>.	25	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23		26
24	=head1 RXVT-UNICODE VS. RXVT	27	=head1 RXVT-UNICODE VS. RXVT
25		28
26	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode	29	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	30	internally. That means it can store and display most scripts in the
28	world. Being a terminal emulator, however, some things are very difficult,	31	world. Being a terminal emulator, however, some things are very difficult,
29	especially cursive scripts such as arabic, vertically written scripts	32	especially cursive scripts such as arabic, vertically written scripts
30	like mongolian or scripts requiring extremely complex combining rules,	33	like mongolian or scripts requiring extremely complex combining rules,
31	like tibetan or devenagari. Don't expect pretty output when using these	34	like tibetan or devanagari. Don't expect pretty output when using these
32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	35	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33	fine, though. A somewhat difficult case are right-to-left scripts, such	36	fine, though. A somewhat difficult case are right-to-left scripts, such
34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	37	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35	belong into the application, not the terminal emulator (too many things --	38	belong in the application, not the terminal emulator (too many things --
36	such as cursor-movement while editing -- break otherwise), but that might	39	such as cursor-movement while editing -- break otherwise), but that might
37	change.	40	change.
38		41
39	If you are looking for a terminal that supports more exotic scripts, let	42	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	43	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	44	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	45	because the author couldn't get C<mlterm> to use one font for latin1 and
43	another for japanese.	46	another for japanese.
44		47
45	Therefore another design rationale was the use of multiple fonts to	48	Therefore another design rationale was the use of multiple fonts to
…		…
108		111
109	Turn on/off simulated reverse video; resource B<reverseVideo>.	112	Turn on/off simulated reverse video; resource B<reverseVideo>.
110		113
111	=item B<-j>\|B<+j>	114	=item B<-j>\|B<+j>
112		115
113	Turn on/off jump scrolling; resource B<jumpScroll>.	116	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
114		117
115	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>	118	=item B<-ss>\|B<+ss>
116		119
117	Turn on/off inheriting parent window's pixmap. Alternative form is	120	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118	B<-tr>; resource B<inheritPixmap>.
119		121
120	I<Please note that transparency of any kind if completely unsupported by	122	=item B<-tr>\|B<+tr>
121	the author. Don't bug him with installation questions!>	123
		124	Turn on/off illusion of a transparent window background; resource B<transparent>.
		125
		126	B<-ip> is still accepted as an obsolete alias but will be removed in
		127	future versions.
		128
		129	I<Please address all transparency related issues to Sasha Vasko at
		130	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
122		131
123	=item B<-fade> I<number>	132	=item B<-fade> I<number>
124		133
125	Fade the text by the given percentage when focus is lost. Small values	134	Fade the text by the given percentage when focus is lost. Small values
126	fade a little only, 100 completely replaces all colours by the fade	135	fade a little only, 100 completely replaces all colours by the fade
…		…
132	is opaque black. resource B<fadeColor>.	141	is opaque black. resource B<fadeColor>.
133		142
134	=item B<-tint> I<colour>	143	=item B<-tint> I<colour>
135		144
136	Tint the transparent background pixmap with the given colour when	145	Tint the transparent background pixmap with the given colour when
137	transparency is enabled with B<-tr> or B<-ip>. This only works for	146	transparency is enabled with B<-tr>. This only works for
138	non-tiled backgrounds, currently. See also the B<-sh> option that can be	147	non-tiled backgrounds, currently. See also the B<-sh> option that can be
139	used to brighten or darken the image in addition to tinting it; resource	148	used to brighten or darken the image in addition to tinting it.
		149	Please note that certain tint colours can be applied on the server-side,
		150	thus yielding performance gain of two orders of magnitude. These colours are:
		151	blue, red, green, cyan, magenta, yellow, and those close to them. Also
		152	pure black and pure white colors essentially mean no tinting; resource
140	I<tintColor>. Example:	153	I<tintColor>. Example:
141		154
142	@@RXVT_NAME@@ -tr -tint blue -sh 40	155	@@RXVT_NAME@@ -tr -tint blue -sh 40
143		156
144	=item B<-sh>	157	=item B<-sh> I<number>
145		158
146	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	159	Darken (0 .. 100) or lighten (100 .. 200) the transparent
147	background image in addition to tinting it (i.e. B<-tint> must be	160	background image in addition to (or instead of) tinting it;
148	specified, too, e.g. C<-tint white>).	161	resource I<shading>.
		162
		163	=item B<-blt> I<string>
		164
		165	Specify background blending type. If background pixmap is specified
		166	at the same time as transparency - such pixmap will be blended over
		167	transparency image, using method specified. Supported values are :
		168	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
		169	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
		170	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
		171	alpha-blending. Compile I<afterimage>; resource I<blendType>.
		172
		173	=item B<-blr> I<HxV>
		174
		175	Apply Gaussian Blur with the specified radii to the transparent
		176	background image. If single number is specified - both vertical and
		177	horizontal radii are considered to be the same. Setting one of the
		178	radii to 1 and another to a large number creates interesting effects
		179	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
		180	resource I<blurRadius>.
149		181
150	=item B<-bg> I<colour>	182	=item B<-bg> I<colour>
151		183
152	Window background colour; resource B<background>.	184	Window background colour; resource B<background>.
153		185
154	=item B<-fg> I<colour>	186	=item B<-fg> I<colour>
155		187
156	Window foreground colour; resource B<foreground>.	188	Window foreground colour; resource B<foreground>.
157		189
158	=item B<-pixmap> I<file[;geom]>	190	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
159		191
160	Compile I<XPM>: Specify XPM file for the background and also optionally	192	Compile I<afterimage>: Specify image file for the background and also
161	specify its scaling with a geometry string. Note you may need to	193	optionally specify its scaling with a geometry string. Note you may need to
162	add quotes to avoid special shell interpretation of the C<;> in the	194	add quotes to avoid special shell interpretation of the C<;> in the
163	command-line; resource B<backgroundPixmap>.	195	command-line; for more details see resource B<backgroundPixmap>.
164		196
165	=item B<-cr> I<colour>	197	=item B<-cr> I<colour>
166		198
167	The cursor colour; resource B<cursorColor>.	199	The cursor colour; resource B<cursorColor>.
168		200
…		…
213	italic> >> characters are to be printed. See resource B<boldItalicFont>	245	italic> >> characters are to be printed. See resource B<boldItalicFont>
214	for details.	246	for details.
215		247
216	=item B<-is>\|B<+is>	248	=item B<-is>\|B<+is>
217		249
218	Compile I<font-styles>: Bold/Italic font styles imply high intensity	250	Compile I<font-styles>: Bold/Blink font styles imply high intensity
219	foreground/background (default). See resource B<intensityStyles> for	251	foreground/background (default). See resource B<intensityStyles> for
220	details.	252	details.
221		253
222	=item B<-name> I<name>	254	=item B<-name> I<name>
223		255
…		…
321		353
322	=item B<-lsp> I<number>	354	=item B<-lsp> I<number>
323		355
324	Compile I<frills>: Lines (pixel height) to insert between each row of	356	Compile I<frills>: Lines (pixel height) to insert between each row of
325	the display. Useful to work around font rendering problems; resource	357	the display. Useful to work around font rendering problems; resource
326	B<linespace>.	358	B<lineSpace>.
327		359
328	=item B<-tn> I<termname>	360	=item B<-tn> I<termname>
329		361
330	This option specifies the name of the terminal type to be set in the	362	This option specifies the name of the terminal type to be set in the
331	B<TERM> environment variable. This terminal type must exist in the	363	B<TERM> environment variable. This terminal type must exist in the
…		…
385	for more info.	417	for more info.
386		418
387	=item B<-tcw>	419	=item B<-tcw>
388		420
389	Change the meaning of triple-click selection with the left mouse	421	Change the meaning of triple-click selection with the left mouse
		422	button. Only effective when the original (non-perl) selection code is
390	button. Instead of selecting a full line it will extend the selection the	423	in-use. Instead of selecting a full line it will extend the selection to
391	end of the logical line only. resource B<tripleclickwords>.	424	the end of the logical line only. resource B<tripleclickwords>.
392		425
393	=item B<-insecure>	426	=item B<-insecure>
394		427
395	Enable "insecure" mode, which currently enables most of the escape	428	Enable "insecure" mode, which currently enables most of the escape
396	sequences that echo strings. See the resource B<insecure> for more	429	sequences that echo strings. See the resource B<insecure> for more
…		…
417	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	450	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
418	will not immediately destroy its window when the program executed within	451	will not immediately destroy its window when the program executed within
419	it exits. Instead, it will wait till it is being killed or closed by the	452	it exits. Instead, it will wait till it is being killed or closed by the
420	user; resource B<hold>.	453	user; resource B<hold>.
421		454
		455	=item B<-xrm> I<string>
		456
		457	Works like the X Toolkit option of the same name, by adding the I<string>
		458	as if it were specified in a resource file. Resource values specified this
		459	way take precedence over all other resource specifications.
		460
		461	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		462	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		463	options can be specified as long-options on the commandline, so use
		464	of B<-xrm> is mostly limited to cases where you want to specify other
		465	resources (e.g. for input methods) or for compatibility with other
		466	programs.
		467
422	=item B<-keysym.>I<sym> I<string>	468	=item B<-keysym.>I<sym> I<string>
423		469
424	Remap a key symbol. See resource B<keysym>.	470	Remap a key symbol. See resource B<keysym>.
425		471
426	=item B<-embed> I<windowid>	472	=item B<-embed> I<windowid>
…		…
436	The window will not be destroyed when @@RXVT_NAME@@ exits.	482	The window will not be destroyed when @@RXVT_NAME@@ exits.
437		483
438	It might be useful to know that @@RXVT_NAME@@ will not close file	484	It might be useful to know that @@RXVT_NAME@@ will not close file
439	descriptors passed to it (except for stdin/out/err, of course), so you	485	descriptors passed to it (except for stdin/out/err, of course), so you
440	can use file descriptors to communicate with the programs within the	486	can use file descriptors to communicate with the programs within the
441	terminal. This works regardless of wether the C<-embed> option was used or	487	terminal. This works regardless of whether the C<-embed> option was used or
442	not.	488	not.
443		489
444	Here is a short Gtk2-perl snippet that illustrates how this option can be	490	Here is a short Gtk2-perl snippet that illustrates how this option can be
445	used (a longer example is in F<doc/embed>):	491	used (a longer example is in F<doc/embed>):
446		492
…		…
451	});	497	});
452		498
453	=item B<-pty-fd> I<file descriptor>	499	=item B<-pty-fd> I<file descriptor>
454		500
455	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	501	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
456	pair but instead use the given filehandle as the tty master. This is	502	pair but instead use the given file descriptor as the tty master. This is
457	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator	503	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
458	without having to run a program within it.	504	without having to run a program within it.
459		505
460	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	506	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
461	entries and will not tinker with pty/tty permissions - you have to do that	507	entries and will not tinker with pty/tty permissions - you have to do that
462	yourself if you want that.	508	yourself if you want that.
463		509
464	As an extremely special case, specifying C<-1> will completely suppress	510	As an extremely special case, specifying C<-1> will completely suppress
465	pty/tty operations.	511	pty/tty operations, which is probably only useful in conjunction with some
		512	perl extension that manages the terminal.
466		513
467	Here is a example in perl that illustrates how this option can be used (a	514	Here is a example in perl that illustrates how this option can be used (a
468	longer example is in F<doc/pty-fd>):	515	longer example is in F<doc/pty-fd>):
469		516
470	use IO::Pty;	517	use IO::Pty;
…		…
484	Comma-separated list of perl extension scripts to use (or not to use) in	531	Comma-separated list of perl extension scripts to use (or not to use) in
485	this terminal instance. See resource B<perl-ext> for details.	532	this terminal instance. See resource B<perl-ext> for details.
486		533
487	=back	534	=back
488		535
489	=head1 RESOURCES (available also as long-options)	536	=head1 RESOURCES
490		537
491	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	538	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
492	options) compiled into your version.	539	options) compiled into your version. All resources are also available as
		540	long-options.
493		541
494	You can set and change the resources using X11 tools like B<xrdb>. Many	542	You can set and change the resources using X11 tools like B<xrdb>. Many
495	distribution do also load settings from the B<~/.Xresources> file when X	543	distribution do also load settings from the B<~/.Xresources> file when X
496	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	544	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
497	with later settings overwriting earlier ones:	545	with later settings overwriting earlier ones:
…		…
499	1. system-wide app-defaults file, either locale-dependent OR global	547	1. system-wide app-defaults file, either locale-dependent OR global
500	2. app-defaults file in $XAPPLRESDIR	548	2. app-defaults file in $XAPPLRESDIR
501	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	549	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
502	4. SCREEN_RESOURCES for the current screen	550	4. SCREEN_RESOURCES for the current screen
503	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	551	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		552	6. resources specified via -xrm on the commandline
504		553
505	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	554	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
506	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	555	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
507	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily	556	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
508	configured, while the class name B<URxvt> allows resources unique to	557	configured, while the class name B<URxvt> allows resources unique to
…		…
563	Use the specified colour to display underlined characters when the	612	Use the specified colour to display underlined characters when the
564	foreground colour is the default.	613	foreground colour is the default.
565		614
566	=item B<colorRV:> I<colour>	615	=item B<colorRV:> I<colour>
567		616
568	Use the specified colour as the background for reverse video	617	Use the specified colour as the background for reverse video characters
569	characters.	618	when OPTION_HC is disabled (--disable-frills).
570		619
571	=item B<underlineColor:> I<colour>	620	=item B<underlineColor:> I<colour>
572		621
573	If set, use the specified colour as the colour for the underline	622	If set, use the specified colour as the colour for the underline
574	itself. If unset, use the foreground colour.	623	itself. If unset, use the foreground colour.
…		…
590	option B<-rv>. B<False>: regular screen colours [default]; option	639	option B<-rv>. B<False>: regular screen colours [default]; option
591	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	640	B<+rv>. See note in B<COLORS AND GRAPHICS> section.
592		641
593	=item B<jumpScroll:> I<boolean>	642	=item B<jumpScroll:> I<boolean>
594		643
595	B<True>: specify that jump scrolling should be used. When scrolling	644	B<True>: specify that jump scrolling should be used. When receiving lots
596	quickly, fewer screen updates are performed [default]; option B<-j>.	645	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		646	has been read, resulting in fewer updates while still displaying every
		647	received line; option B<-j>.
		648
597	B<False>: specify that smooth scrolling should be used; option B<+j>.	649	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		650	force a screen refresh on each new line it received; option B<+j>.
598		651
599	=item B<inheritPixmap:> I<boolean>	652	=item B<skipScroll:> I<boolean>
600		653
601	B<True>: make the background inherit the parent windows' pixmap, giving	654	B<True>: (the default) specify that skip scrolling should be used. When
602	artificial transparency. B<False>: do not inherit the parent windows'	655	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
603	pixmap.	656	(around 60 times per second), resulting in far fewer updates. This can
		657	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		658	option B<-ss>.
604		659
605	I<Please note that transparency of any kind if completely unsupported by	660	B<False>: specify that everything is to be displayed, even
606	the author. Don't bug him with installation questions!>	661	if the refresh is too fast for the human eye to read anything (or the
		662	monitor to display anything); option B<+ss>.
		663
		664	=item B<transparent:> I<boolean>
		665
		666	Turn on/off illusion of a transparent window background.
		667
		668	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
		669	future versions.
		670
		671	I<Please address all transparency related issues to Sasha Vasko at
		672	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
607		673
608	=item B<fading:> I<number>	674	=item B<fading:> I<number>
609		675
610	Fade the text by the given percentage when focus is lost; option B<-fade>.	676	Fade the text by the given percentage when focus is lost; option B<-fade>.
611		677
…		…
619	Tint the transparent background pixmap with the given colour; option	685	Tint the transparent background pixmap with the given colour; option
620	B<-tint>.	686	B<-tint>.
621		687
622	=item B<shading:> I<number>	688	=item B<shading:> I<number>
623		689
624	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	690	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
625	image in addition to tinting it.	691	in addition to tinting it; option B<-sh>.
		692
		693	=item B<blendType:> I<string>
		694
		695	Specify background blending type; option B<-blt>.
		696
		697	=item B<blurRadius:> I<number>
		698
		699	Apply Gaussian Blurr with the specified radius to the transparent
		700	background image; option B<-blr>.
626		701
627	=item B<scrollColor:> I<colour>	702	=item B<scrollColor:> I<colour>
628		703
629	Use the specified colour for the scrollbar [default #B2B2B2].	704	Use the specified colour for the scrollbar [default #B2B2B2].
630		705
…		…
636	=item B<borderColor:> I<colour>	711	=item B<borderColor:> I<colour>
637		712
638	The colour of the border around the text area and between the scrollbar	713	The colour of the border around the text area and between the scrollbar
639	and the text.	714	and the text.
640		715
641	=item B<backgroundPixmap:> I<file[;geom]>	716	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
642		717
643	Use the specified XPM file (note the `.xpm' extension is optional) for	718	Use the specified image file for the background and also
644	the background and also optionally specify its scaling with a geometry	719	optionally specify its scaling with a geometry string B<WxH+X+Y>,
645	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	720	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
646	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	721	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
647	centre (percent). A scale of 0 displays the image with tiling. A scale	722	centre (percent). A scale of 0 displays the image with tiling. A scale
648	of 1 displays the image without any scaling. A scale of 2 to 9	723	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
649	specifies an integer number of images in that direction. No image will	724	an integer number of images in that direction. No image will be magnified
650	be magnified beyond 10 times its original size. The maximum permitted	725	beyond 10 times its original size. The maximum permitted scale is 1000.
651	scale is 1000. [default 0x0+50+50]	726	Additional operations can be specified after colon B<:op1:op2...>.
		727	Supported operations are:
		728
		729	tile force background image to be tiled and not scaled. Equivalent to 0x0,
		730	propscale will scale image keeping proportions,
		731	auto will scale image to match window size. Equivalent to 100x100;
		732	hscale will scale image horizontally to the window size;
		733	vscale will scale image vertically to the window size;
		734	scale will scale image to match window size;
		735	root will tile image as if it was a root window background, auto-adjusting
		736	whenever terminal window moves.
		737
		738	If used in conjunction with B<-tr> option, the specified pixmap will be
		739	blended over transparency image using either alpha-blending, or any
		740	other blending type, specified with B<-blt "type"> option.
652		741
653	=item B<path:> I<path>	742	=item B<path:> I<path>
654		743
655	Specify the colon-delimited search path for finding XPM files.	744	Specify the colon-delimited search path for finding background image files.
656		745
657	=item B<font:> I<fontlist>	746	=item B<font:> I<fontlist>
658		747
659	Select the fonts to be used. This is a comma separated list of font names	748	Select the fonts to be used. This is a comma separated list of font names
660	that are checked in order when trying to find glyphs for characters. The	749	that are checked in order when trying to find glyphs for characters. The
…		…
717	text font will being used for the given style.	806	text font will being used for the given style.
718		807
719	=item B<intensityStyles:> I<boolean>	808	=item B<intensityStyles:> I<boolean>
720		809
721	When font styles are not enabled, or this option is enabled (B<True>,	810	When font styles are not enabled, or this option is enabled (B<True>,
722	option B<-is>, the default), bold and italic font styles imply high	811	option B<-is>, the default), bold/blink font styles imply high
723	intensity foreground/backround colours. Disabling this option (B<False>,	812	intensity foreground/background colours. Disabling this option (B<False>,
724	option B<+is>) disables this behaviour, the high intensity colours are not	813	option B<+is>) disables this behaviour, the high intensity colours are not
725	reachable.	814	reachable.
726		815
727	=item B<selectstyle:> I<mode>	816	=item B<selectstyle:> I<mode>
728		817
729	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	818	Set mouse selection style to B<old> which is 2.20, B<oldword> which
730	xterm style with 2.20 old word selection, or anything else which gives	819	is xterm style with 2.20 old word selection, or anything else which
731	xterm style selection.	820	gives xterm style selection. Only effective when the original (non-perl)
		821	selection code is in use.
732		822
733	=item B<scrollstyle:> I<mode>	823	=item B<scrollstyle:> I<mode>
734		824
735	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	825	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
736	the author's favourite.	826	the author's favourite.
…		…
750	=item B<mapAlert:> I<boolean>	840	=item B<mapAlert:> I<boolean>
751		841
752	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	842	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
753	de-iconify (map) on receipt of a bell character [default].	843	de-iconify (map) on receipt of a bell character [default].
754		844
		845	=item B<urgentOnBell:> I<boolean>
		846
		847	B<True>: set the urgency hint for the wm on receipt of a bell character.
		848	B<False>: do not set the urgency hint [default].
		849
755	=item B<visualBell:> I<boolean>	850	=item B<visualBell:> I<boolean>
756		851
757	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	852	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
758	B<False>: no visual bell [default]; option B<+vb>.	853	B<False>: no visual bell [default]; option B<+vb>.
759		854
…		…
780	Example:	875	Example:
781		876
782	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	877	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
783		878
784	This creates a new file in your home directory with the screen contents	879	This creates a new file in your home directory with the screen contents
785	everytime you hit C<Print>.	880	every time you hit C<Print>.
786		881
787	=item B<scrollBar:> I<boolean>	882	=item B<scrollBar:> I<boolean>
788		883
789	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	884	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
790	disable the scrollbar; option B<+sb>.	885	disable the scrollbar; option B<+sb>.
…		…
812		907
813	=item B<scrollWithBuffer:> I<boolean>	908	=item B<scrollWithBuffer:> I<boolean>
814		909
815	B<True>: scroll with scrollback buffer when tty receives new lines (and	910	B<True>: scroll with scrollback buffer when tty receives new lines (and
816	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	911	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
817	with scrollback buffer when tty recieves new lines; option B<+sw>.	912	with scrollback buffer when tty receives new lines; option B<+sw>.
818		913
819	=item B<scrollTtyKeypress:> I<boolean>	914	=item B<scrollTtyKeypress:> I<boolean>
820		915
821	B<True>: scroll to bottom when a non-special key is pressed. Special keys	916	B<True>: scroll to bottom when a non-special key is pressed. Special keys
822	are those which are intercepted by rxvt-unicode for special handling and	917	are those which are intercepted by rxvt-unicode for special handling and
…		…
853	=item B<termName:> I<termname>	948	=item B<termName:> I<termname>
854		949
855	Specifies the terminal type name to be set in the B<TERM> environment	950	Specifies the terminal type name to be set in the B<TERM> environment
856	variable; option B<-tn>.	951	variable; option B<-tn>.
857		952
858	=item B<linespace:> I<number>	953	=item B<lineSpace:> I<number>
859		954
860	Specifies number of lines (pixel height) to insert between each row of	955	Specifies number of lines (pixel height) to insert between each row of
861	the display [default 0]; option B<-lsp>.	956	the display [default 0]; option B<-lsp>.
862		957
863	=item B<meta8:> I<boolean>	958	=item B<meta8:> I<boolean>
…		…
915	=item B<cutchars:> I<string>	1010	=item B<cutchars:> I<string>
916		1011
917	The characters used as delimiters for double-click word selection	1012	The characters used as delimiters for double-click word selection
918	(whitespace delimiting is added automatically if resource is given).	1013	(whitespace delimiting is added automatically if resource is given).
919		1014
920	When the selection extension is in use (the default if compiled in, see	1015	When the perl selection extension is in use (the default if compiled
921	the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters	1016	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
922	will be created (if the resource exists, otherwise, no regex will be	1017	characters will be created (if the resource exists, otherwise, no regex
923	created). In this mode, characters outside ISO-8859-1 can be used.	1018	will be created). In this mode, characters outside ISO-8859-1 can be used.
924		1019
925	When the selection extension is not used, only ISO-8859-1 characters can	1020	When the selection extension is not used, only ISO-8859-1 characters can
926	be used. If not specified, the built-in default is used:	1021	be used. If not specified, the built-in default is used:
927		1022
928	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1023	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
929		1024
930	=item B<preeditType:> I<style>	1025	=item B<preeditType:> I<style>
931		1026
932	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1027	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
933		1028
…		…
987		1082
988	Turn on/off secondary screen (default enabled).	1083	Turn on/off secondary screen (default enabled).
989		1084
990	=item B<secondaryScroll:> I<boolean>	1085	=item B<secondaryScroll:> I<boolean>
991		1086
992	Turn on/off secondary screen scroll (default enabled). If the this	1087	Turn on/off secondary screen scroll (default enabled). If this
993	option is enabled, scrolls on the secondary screen will change the	1088	option is enabled, scrolls on the secondary screen will change the
994	scrollback buffer and switching to/from the secondary screen will	1089	scrollback buffer and switching to/from the secondary screen will
995	instead scroll the screen up.	1090	instead scroll the screen up.
996		1091
997	=item B<hold>: I<boolean>	1092	=item B<hold>: I<boolean>
…		…
1021	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1116	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1022	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1117	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1023	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1118	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1024	performed in an exact manner; however, the closest match is assured.	1119	performed in an exact manner; however, the closest match is assured.
1025		1120
1026	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1121	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1027	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1122	number), see RESOURCES in C<man 7 X> for futher details.
1028	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1029	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1030	can start or end with whitespace.
1031
1032	Please note that you need to double the C<\> in resource files, as
1033	Xlib itself does its own de-escaping (you can use C<\033> instead of
1034	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1035	processing).
1036		1123
1037	You can define a range of keysyms in one shot by providing a I<string>	1124	You can define a range of keysyms in one shot by providing a I<string>
1038	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1125	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1039	should be a character not used by the strings.	1126	should be a character not used by the strings.
1040		1127
1041	Its usage can be demonstrated by an example:	1128	Its usage can be demonstrated by an example:
1042		1129
1043	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1130	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
…		…
1107	example, C<default,-selection> will use all the default extension except	1194	example, C<default,-selection> will use all the default extension except
1108	C<selection>.	1195	C<selection>.
1109		1196
1110	Extension names can also be followed by an argument in angle brackets	1197	Extension names can also be followed by an argument in angle brackets
1111	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1198	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1112	searchable scorllback to Alt/Meta-s). Mentioning the same extension	1199	searchable scrollback to Alt/Meta-s). Mentioning the same extension
1113	multiple times with different arguments will pass multiple arguments to	1200	multiple times with different arguments will pass multiple arguments to
1114	the extension.	1201	the extension.
1115		1202
1116	Each extension is looked up in the library directories, loaded if	1203	Each extension is looked up in the library directories, loaded if
1117	necessary, and bound to the current terminal instance.	1204	necessary, and bound to the current terminal instance.
…		…
1153	(default: C<M-s>).	1240	(default: C<M-s>).
1154		1241
1155	=item B<urlLauncher>: I<string>	1242	=item B<urlLauncher>: I<string>
1156		1243
1157	Specifies the program to be started with a URL argument. Used by the	1244	Specifies the program to be started with a URL argument. Used by the
1158	C<selection-popup> and C<mark-urls> perl extensions.	1245	C<selection-popup> and C<matcher> perl extensions.
1159		1246
1160	=item B<transient-for>: I<windowid>	1247	=item B<transient-for>: I<windowid>
1161		1248
1162	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.	1249	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1163		1250
1164	=item B<override-redirect>: I<boolean>	1251	=item B<override-redirect>: I<boolean>
1165		1252
1166	Compile I<frills>: Sets override-redirect for the terminal window, making	1253	Compile I<frills>: Sets override-redirect for the terminal window, making
1167	it almost invisible to window managers; option B<-override-redirect>.	1254	it almost invisible to window managers; option B<-override-redirect>.
		1255
		1256	=item B<iso14755_52:> I<boolean>
		1257
		1258	Turn on/off ISO 14755 5.2 mode (default enabled).
1168		1259
1169	=back	1260	=back
1170		1261
1171	=head1 THE SCROLLBAR	1262	=head1 THE SCROLLBAR
1172		1263
…		…
1191	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1282	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1192	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1283	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1193	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1284	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1194	respectively.	1285	respectively.
1195		1286
1196	=head1 TEXT SELECTION AND INSERTION	1287	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1197		1288
1198	The behaviour of text selection and insertion mechanism is similar to	1289	The behaviour of text selection and insertion/pasting mechanism is similar
1199	I<xterm>(1).	1290	to I<xterm>(1).
1200		1291
1201	=over 4	1292	=over 4
1202		1293
1203	=item B<Selection>:	1294	=item B<Selecting>:
1204		1295
1205	Left click at the beginning of the region, drag to the end of the region	1296	Left click at the beginning of the region, drag to the end of the region
1206	and release; Right click to extend the marked region; Left double-click	1297	and release; Right click to extend the marked region; Left double-click
1207	to select a word; Left triple-click to select the entire logical line	1298	to select a word; Left triple-click to select the entire logical line
1208	(which can span multiple screen lines), unless modified by resource	1299	(which can span multiple screen lines), unless modified by resource
…		…
1212	(Compile: I<frills>) will create a rectangular selection instead of a	1303	(Compile: I<frills>) will create a rectangular selection instead of a
1213	normal one. In this mode, every selected row becomes its own line in the	1304	normal one. In this mode, every selected row becomes its own line in the
1214	selection, and trailing whitespace is visually underlined and removed from	1305	selection, and trailing whitespace is visually underlined and removed from
1215	the selection.	1306	the selection.
1216		1307
1217	=item B<Insertion>:	1308	=item B<Pasting>:
1218		1309
1219	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>	1310	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1220	window causes the value of the PRIMARY selection (or CLIPBOARD with the	1311	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1221	Meta modifier) to be inserted as if it had been typed on the keyboard.	1312	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1222		1313
1223	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1314	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1224	inserted too.	1315	inserted too.
1225		1316
1226	=back	1317	=back
…		…
1243		1334
1244	=head1 ISO 14755 SUPPORT	1335	=head1 ISO 14755 SUPPORT
1245		1336
1246	ISO 14755 is a standard for entering and viewing unicode characters	1337	ISO 14755 is a standard for entering and viewing unicode characters
1247	and character codes using the keyboard. It consists of 4 parts. The	1338	and character codes using the keyboard. It consists of 4 parts. The
1248	first part is available rxvt-unicode has been compiled with	1339	first part is available if rxvt-unicode has been compiled with
1249	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1340	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1250	with C<--enable-iso14755>.	1341	with C<--enable-iso14755>.
1251		1342
1252	=over 4	1343	=over 4
1253		1344
…		…
1376	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1467	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1377	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1468	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1378	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1469	(recommended, but B<MUST> have 4 digits/component) colour specifications,
1379	in addition to the ones provided by X, where the additional A component	1470	in addition to the ones provided by X, where the additional A component
1380	specifies opacity (alpha) values. The minimum value of C<0> is completely	1471	specifies opacity (alpha) values. The minimum value of C<0> is completely
1381	transparent). You can also prefix any color with C<[a]>, where C<a> is on	1472	transparent). You can also prefix any color with C<[percent]>, where
1382	to four hex digits specifiying the opacity value.	1473	C<percent> is a decimal percentage (0-100) that specifies the opacity of
		1474	the color, where C<0> is completely transparent and C<100> is completelxy
		1475	opaque.
1383		1476
1384	You probably need to specify B<"-depth 32">, too, and have the luck that	1477	You probably need to specify B<"-depth 32">, too, and have the luck that
1385	your X-server uses ARGB pixel layout, as X is far from just supporting	1478	your X-server uses ARGB pixel layout, as X is far from just supporting
1386	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1479	ARGB visuals out of the box, and rxvt-unicode just fudges around.
1387		1480
1388	For example, the following selects an almost completely transparent red	1481	For example, the following selects an almost completely transparent red
1389	background, and an almost opaque pink foreground:	1482	background, and an almost opaque pink foreground:
1390		1483
1391	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"	1484	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1392		1485
1393	I<Please note that transparency of any kind if completely unsupported by	1486	I<Please note that transparency of any kind if completely unsupported by
1394	the author. Don't bug him with installation questions!>	1487	the author. Don't bug him with installation questions!>
1395		1488
1396	=head1 ENVIRONMENT	1489	=head1 ENVIRONMENT
…		…
1400	=over 4	1493	=over 4
1401		1494
1402	=item B<TERM>	1495	=item B<TERM>
1403		1496
1404	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1497	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1405	resources or on the commandline.	1498	resources or on the command line.
1406		1499
1407	=item B<COLORTERM>	1500	=item B<COLORTERM>
1408		1501
1409	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1502	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1410	compiled with XPM support, and optionally with the added extension	1503	compiled with background image support, and optionally with the added
1411	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1504	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1505	screen.
1412		1506
1413	=item B<COLORFGBG>	1507	=item B<COLORFGBG>
1414		1508
1415	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1509	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1416	the colour code used as default foreground/text colour (or the string	1510	the colour code used as default foreground/text colour (or the string
1417	C<default> to indicate that the default-colour escape sequence is to be	1511	C<default> to indicate that the default-colour escape sequence is to be
1418	used), C<bg> is the colour code used as default background colour (or the	1512	used), C<bg> is the colour code used as default background colour (or the
1419	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1513	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1420	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1514	was compiled with background image support. Libraries like C<ncurses>
1421	(and do) use this information to optimize screen output.	1515	and C<slang> can (and do) use this information to optimize screen output.
1422		1516
1423	=item B<WINDOWID>	1517	=item B<WINDOWID>
1424		1518
1425	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1519	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1426	window, which usually has subwindows for the scrollbar, the terminal	1520	window, which usually has subwindows for the scrollbar, the terminal
…		…
1517	Project Coordinator (changes.txt 2.21a to 2.4.5)	1611	Project Coordinator (changes.txt 2.21a to 2.4.5)
1518		1612
1519	=item Geoff Wing L<< <gcw@pobox.com> >>	1613	=item Geoff Wing L<< <gcw@pobox.com> >>
1520		1614
1521	Rewrote screen display and text selection routines.	1615	Rewrote screen display and text selection routines.
1522		1616
1523	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1617	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1524		1618
1525	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1619	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1526		1620
1527	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1621	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.116 by root, Mon Jul 10 04:03:09 2006 UTC vs. Revision 1.154 by ayin, Fri Dec 14 09:06:36 2007 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.116 by root, Mon Jul 10 04:03:09 2006 UTC vs.
Revision 1.154 by ayin, Fri Dec 14 09:06:36 2007 UTC