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

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

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.114 by root, Thu Jul 6 19:43:21 2006 UTC vs.
Revision 1.151 by root, Wed Dec 12 19:55:55 2007 UTC