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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.148 by ayin, Sat Nov 24 17:07:46 2007 UTC vs.
Revision 1.164 by root, Sun Jun 15 13:54:15 2008 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/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
…		…
30	like mongolian or scripts requiring extremely complex combining rules,	33	like mongolian or scripts requiring extremely complex combining rules,
31	like tibetan or devanagari. 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 user friendly, lean and clean	43	me recommend C<mlterm>, which is a very user friendly, lean and clean
…		…
89		92
90	Print out a message describing available options.	93	Print out a message describing available options.
91		94
92	=item B<-display> I<displayname>	95	=item B<-display> I<displayname>
93		96
94	Attempt to open a window on the named X display (B<-d> still	97	Attempt to open a window on the named X display (the older form B<-d>
95	respected). In the absence of this option, the display specified by the	98	is still respected. but deprecated). In the absence of this option, the
96	B<DISPLAY> environment variable is used.	99	display specified by the B<DISPLAY> environment variable is used.
97		100
98	=item B<-depth> I<bitdepth>	101	=item B<-depth> I<bitdepth>
99		102
100	Compile I<xft>: Attempt to find a visual with the given bit depth;	103	Compile I<xft>: Attempt to find a visual with the given bit depth;
101	resource B<depth>.	104	resource B<depth>.
		105
		106	[Please note that many X servers (and libXft) are buggy with
		107	respect to C<-depth 32> and/or alpha channels, and will cause all sorts
		108	of graphical corruption. This is harmless, but we can't do anything about
		109	this, so watch out]
102		110
103	=item B<-geometry> I<geom>	111	=item B<-geometry> I<geom>
104		112
105	Window geometry (B<-g> still respected); resource B<geometry>.	113	Window geometry (B<-g> still respected); resource B<geometry>.
106		114
…		…
242	italic> >> characters are to be printed. See resource B<boldItalicFont>	250	italic> >> characters are to be printed. See resource B<boldItalicFont>
243	for details.	251	for details.
244		252
245	=item B<-is>\|B<+is>	253	=item B<-is>\|B<+is>
246		254
247	Compile I<font-styles>: Bold/Italic font styles imply high intensity	255	Compile I<font-styles>: Bold/Blink font styles imply high intensity
248	foreground/background (default). See resource B<intensityStyles> for	256	foreground/background (default). See resource B<intensityStyles> for
249	details.	257	details.
250		258
251	=item B<-name> I<name>	259	=item B<-name> I<name>
252		260
…		…
270		278
271	=item B<-sb>\|B<+sb>	279	=item B<-sb>\|B<+sb>
272		280
273	Turn on/off scrollbar; resource B<scrollBar>.	281	Turn on/off scrollbar; resource B<scrollBar>.
274		282
		283	=item B<-sr>\|B<+sr>
		284
		285	Put scrollbar on right/left; resource B<scrollBar_right>.
		286
		287	=item B<-st>\|B<+st>
		288
		289	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		290	resource B<scrollBar_floating>.
		291
275	=item B<-si>\|B<+si>	292	=item B<-si>\|B<+si>
276		293
277	Turn on/off scroll-to-bottom on TTY output inhibit; resource	294	Turn on/off scroll-to-bottom on TTY output inhibit; resource
278	B<scrollTtyOutput> has opposite effect.	295	B<scrollTtyOutput> has opposite effect.
279		296
…		…
285	=item B<-sw>\|B<+sw>	302	=item B<-sw>\|B<+sw>
286		303
287	Turn on/off scrolling with the scrollback buffer as new lines appear.	304	Turn on/off scrolling with the scrollback buffer as new lines appear.
288	This only takes effect if B<-si> is also given; resource	305	This only takes effect if B<-si> is also given; resource
289	B<scrollWithBuffer>.	306	B<scrollWithBuffer>.
290
291	=item B<-sr>\|B<+sr>
292
293	Put scrollbar on right/left; resource B<scrollBar_right>.
294
295	=item B<-st>\|B<+st>
296
297	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
298	resource B<scrollBar_floating>.
299		307
300	=item B<-ptab>\|B<+ptab>	308	=item B<-ptab>\|B<+ptab>
301		309
302	If enabled (default), "Horizontal Tab" characters are being stored as	310	If enabled (default), "Horizontal Tab" characters are being stored as
303	actual wide characters in the screen buffer, which makes it possible to	311	actual wide characters in the screen buffer, which makes it possible to
…		…
415		423
416	=item B<-tcw>	424	=item B<-tcw>
417		425
418	Change the meaning of triple-click selection with the left mouse	426	Change the meaning of triple-click selection with the left mouse
419	button. Only effective when the original (non-perl) selection code is	427	button. Only effective when the original (non-perl) selection code is
420	in-use. Instead of selecting a full line it will extend the selection the	428	in-use. Instead of selecting a full line it will extend the selection to
421	end of the logical line only. resource B<tripleclickwords>.	429	the end of the logical line only. resource B<tripleclickwords>.
422		430
423	=item B<-insecure>	431	=item B<-insecure>
424		432
425	Enable "insecure" mode, which currently enables most of the escape	433	Enable "insecure" mode, which currently enables most of the escape
426	sequences that echo strings. See the resource B<insecure> for more	434	sequences that echo strings. See the resource B<insecure> for more
…		…
446		454
447	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	455	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
448	will not immediately destroy its window when the program executed within	456	will not immediately destroy its window when the program executed within
449	it exits. Instead, it will wait till it is being killed or closed by the	457	it exits. Instead, it will wait till it is being killed or closed by the
450	user; resource B<hold>.	458	user; resource B<hold>.
		459
		460	=item B<-cd> I<path>
		461
		462	Sets the working directory for the shell (or the command specified via
		463	B<-e>). The I<path> must be an absolute path and it must exist for
		464	@@RXVT_NAME@@ to start; resource B<chdir>.
451		465
452	=item B<-xrm> I<string>	466	=item B<-xrm> I<string>
453		467
454	Works like the X Toolkit option of the same name, by adding the I<string>	468	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	469	as if it were specified in a resource file. Resource values specified this
…		…
503	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	517	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
504	entries and will not tinker with pty/tty permissions - you have to do that	518	entries and will not tinker with pty/tty permissions - you have to do that
505	yourself if you want that.	519	yourself if you want that.
506		520
507	As an extremely special case, specifying C<-1> will completely suppress	521	As an extremely special case, specifying C<-1> will completely suppress
508	pty/tty operations.	522	pty/tty operations, which is probably only useful in conjunction with some
		523	perl extension that manages the terminal.
509		524
510	Here is a example in perl that illustrates how this option can be used (a	525	Here is a example in perl that illustrates how this option can be used (a
511	longer example is in F<doc/pty-fd>):	526	longer example is in F<doc/pty-fd>):
512		527
513	use IO::Pty;	528	use IO::Pty;
…		…
527	Comma-separated list of perl extension scripts to use (or not to use) in	542	Comma-separated list of perl extension scripts to use (or not to use) in
528	this terminal instance. See resource B<perl-ext> for details.	543	this terminal instance. See resource B<perl-ext> for details.
529		544
530	=back	545	=back
531		546
532	=head1 RESOURCES (available also as long-options)	547	=head1 RESOURCES
533		548
534	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	549	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
535	options) compiled into your version.	550	options) compiled into your version. All resources are also available as
		551	long-options.
536		552
537	You can set and change the resources using X11 tools like B<xrdb>. Many	553	You can set and change the resources using X11 tools like B<xrdb>. Many
538	distribution do also load settings from the B<~/.Xresources> file when X	554	distribution do also load settings from the B<~/.Xresources> file when X
539	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	555	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
540	with later settings overwriting earlier ones:	556	with later settings overwriting earlier ones:
…		…
562	=item B<depth:> I<bitdepth>	578	=item B<depth:> I<bitdepth>
563		579
564	Compile I<xft>: Attempt to find a visual with the given bit depth;	580	Compile I<xft>: Attempt to find a visual with the given bit depth;
565	option B<-depth>.	581	option B<-depth>.
566		582
		583	=item B<buffered:> I<boolean>
		584
		585	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		586	On some card/driver combination enabling it slightly decreases
		587	performance, on most it greatly helps it. The slowdown is small, so it
		588	should normally be enabled.
		589
567	=item B<geometry:> I<geom>	590	=item B<geometry:> I<geom>
568		591
569	Create the window with the specified X window geometry [default 80x24];	592	Create the window with the specified X window geometry [default 80x24];
570	option B<-geometry>.	593	option B<-geometry>.
571		594
…		…
719	an integer number of images in that direction. No image will be magnified	742	an integer number of images in that direction. No image will be magnified
720	beyond 10 times its original size. The maximum permitted scale is 1000.	743	beyond 10 times its original size. The maximum permitted scale is 1000.
721	Additional operations can be specified after colon B<:op1:op2...>.	744	Additional operations can be specified after colon B<:op1:op2...>.
722	Supported operations are:	745	Supported operations are:
723		746
724	tile force background image to be tiled and not scaled. Equivalent to 0x0,	747	tile force background image to be tiled and not scaled. Equivalent to 0x0
725	propscale will scale image keeping proportions,	748	propscale will scale image keeping proportions
726	auto will scale image to match window size. Equivalent to 100x100;	749	auto will scale image to match window size. Equivalent to 100x100
727	hscale will scale image horizontally to the window size;	750	hscale will scale image horizontally to the window size
728	vscale will scale image vertically to the window size;	751	vscale will scale image vertically to the window size
729	scale will scale image to match window size;	752	scale will scale image to match window size
730	root will tile image as if it was a root window background, auto-adjusting	753	root will tile image as if it was a root window background, auto-adjusting
731	whenever terminal window moves.	754	whenever terminal window moves
732		755
733	If used in conjunction with B<-tr> option, the specified pixmap will be	756	If used in conjunction with B<-tr> option, the specified pixmap will be
734	blended over transparency image using either alpha-blending, or any	757	blended over transparency image using either alpha-blending, or any
735	other blending type, specified with B<-blt "type"> option.	758	other blending type, specified with B<-blt "type"> option.
736		759
…		…
801	text font will being used for the given style.	824	text font will being used for the given style.
802		825
803	=item B<intensityStyles:> I<boolean>	826	=item B<intensityStyles:> I<boolean>
804		827
805	When font styles are not enabled, or this option is enabled (B<True>,	828	When font styles are not enabled, or this option is enabled (B<True>,
806	option B<-is>, the default), bold and italic font styles imply high	829	option B<-is>, the default), bold/blink font styles imply high
807	intensity foreground/background colours. Disabling this option (B<False>,	830	intensity foreground/background colours. Disabling this option (B<False>,
808	option B<+is>) disables this behaviour, the high intensity colours are not	831	option B<+is>) disables this behaviour, the high intensity colours are not
809	reachable.	832	reachable.
810		833
811	=item B<selectstyle:> I<mode>
812
813	Set mouse selection style to B<old> which is 2.20, B<oldword> which
814	is xterm style with 2.20 old word selection, or anything else which
815	gives xterm style selection. Only effective when the original (non-perl)
816	selection code is in use.
817
818	=item B<scrollstyle:> I<mode>
819
820	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
821	the author's favourite.
822
823	=item B<title:> I<string>	834	=item B<title:> I<string>
824		835
825	Set window title string, the default title is the command-line	836	Set window title string, the default title is the command-line
826	specified after the B<-e> option, if any, otherwise the application	837	specified after the B<-e> option, if any, otherwise the application
827	name; option B<-title>.	838	name; option B<-title>.
…		…
871		882
872	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	883	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
873		884
874	This creates a new file in your home directory with the screen contents	885	This creates a new file in your home directory with the screen contents
875	every time you hit C<Print>.	886	every time you hit C<Print>.
		887
		888	=item B<scrollstyle:> I<mode>
		889
		890	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		891	the author's favourite.
876		892
877	=item B<scrollBar:> I<boolean>	893	=item B<scrollBar:> I<boolean>
878		894
879	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	895	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
880	disable the scrollbar; option B<+sb>.	896	disable the scrollbar; option B<+sb>.
…		…
1079		1095
1080	=item B<secondaryScroll:> I<boolean>	1096	=item B<secondaryScroll:> I<boolean>
1081		1097
1082	Turn on/off secondary screen scroll (default enabled). If this	1098	Turn on/off secondary screen scroll (default enabled). If this
1083	option is enabled, scrolls on the secondary screen will change the	1099	option is enabled, scrolls on the secondary screen will change the
1084	scrollback buffer and switching to/from the secondary screen will	1100	scrollback buffer and, when secondaryScreen is off, switching
1085	instead scroll the screen up.	1101	to/from the secondary screen will instead scroll the screen up.
1086		1102
1087	=item B<hold>: I<boolean>	1103	=item B<hold>: I<boolean>
1088		1104
1089	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1105	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1090	will not immediately destroy its window when the program executed within	1106	will not immediately destroy its window when the program executed within
1091	it exits. Instead, it will wait till it is being killed or closed by the	1107	it exits. Instead, it will wait till it is being killed or closed by the
1092	user.	1108	user.
		1109
		1110	=item B<chdir>: I<path>
		1111
		1112	Sets the working directory for the shell (or the command specified via
		1113	B<-e>). The I<path> must be an absolute path and it must exist for
		1114	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1115	directory will be used; option B<-cd>.
1093		1116
1094	=item B<keysym.>I<sym>: I<string>	1117	=item B<keysym.>I<sym>: I<string>
1095		1118
1096	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1119	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1097	intervening resource name B<keysym.> cannot be omitted.	1120	intervening resource name B<keysym.> cannot be omitted.
…		…
1458	=back	1481	=back
1459		1482
1460	=head2 ALPHA CHANNEL SUPPORT	1483	=head2 ALPHA CHANNEL SUPPORT
1461		1484
1462	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1485	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1463	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1486	their act together, rxvt-unicode will do it's own alpha channel management:
1464	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1487
1465	in addition to the ones provided by X, where the additional A component	1488	You can prefix any color with an opaquenes percentage enclosed in
		1489	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1490	(0-100) that specifies the opacity of the color, where C<0> is completely
		1491	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1492	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1493	is the recommended format to specify transparency values, and works with
		1494	all ways to specify a colour.
		1495
		1496	For complete control, rxvt-unicode also supports
		1497	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1498	specifications, where the additional C<aaaa> component specifies opacity
1466	specifies opacity (alpha) values. The minimum value of C<0> is completely	1499	(alpha) values. The minimum value of C<0000> is completely transparent,
1467	transparent). You can also prefix any color with C<[percent]>, where	1500	while C<ffff> is completely opaque). The two example colours from
1468	C<percent> is a decimal percentage (0-100) that specifies the opacity of	1501	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1469	the color, where C<0> is completely transparent and C<100> is completelxy	1502	C<rgba:0000/ff00/0000/f332>.
1470	opaque.
1471		1503
1472	You probably need to specify B<"-depth 32">, too, and have the luck that	1504	You probably need to specify B<"-depth 32">, too, to force a visual with
1473	your X-server uses ARGB pixel layout, as X is far from just supporting	1505	alpha channels, and have the luck that your X-server uses ARGB pixel
1474	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1506	layout, as X is far from just supporting ARGB visuals out of the box, and
		1507	rxvt-unicode just fudges around.
1475		1508
1476	For example, the following selects an almost completely transparent red	1509	For example, the following selects an almost completely transparent black
1477	background, and an almost opaque pink foreground:	1510	background, and an almost opaque pink foreground:
1478		1511
1479	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1512	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1480		1513
1481	I<Please note that transparency of any kind if completely unsupported by	1514	When not using a background image, then the interpretation of the
1482	the author. Don't bug him with installation questions!>	1515	alpha channel is up to your compositing manager (most interpret it as
		1516	transparency of course).
		1517
		1518	When using a background pixmap or pseudo-transparency, then the background
		1519	colour will always behave as if it were completely transparent (so the
		1520	background image shows instead), regardless of how it was specified, while
		1521	other colours will either be transparent as specified (the background
		1522	image will show through) on servers supporting the RENDER extension, or
		1523	fully opaque on servers not supporting the RENDER EXTENSION.
		1524
		1525	Please note that due to bugs in Xft, specifying alpha values might result
		1526	in garbage being displayed when the X-server does not support the RENDER
		1527	extension.
1483		1528
1484	=head1 ENVIRONMENT	1529	=head1 ENVIRONMENT
1485		1530
1486	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1531	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1487		1532
…		…
1521	C<--with-terminfo=PATH>.	1566	C<--with-terminfo=PATH>.
1522		1567
1523	=item B<DISPLAY>	1568	=item B<DISPLAY>
1524		1569
1525	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1570	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1526	display in its child processes.	1571	display in its child processes if C<-display> isn't used to override. It
		1572	defaults to C<:0> if it doesn't exist.
1527		1573
1528	=item B<SHELL>	1574	=item B<SHELL>
1529		1575
1530	The shell to be used for command execution, defaults to C</bin/sh>.	1576	The shell to be used for command execution, defaults to C</bin/sh>.
1531		1577

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.148 by ayin, Sat Nov 24 17:07:46 2007 UTC vs. Revision 1.164 by root, Sun Jun 15 13:54:15 2008 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.148 by ayin, Sat Nov 24 17:07:46 2007 UTC vs.
Revision 1.164 by root, Sun Jun 15 13:54:15 2008 UTC