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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.85 by root, Wed Jan 4 20:43:37 2006 UTC vs.
Revision 1.114 by root, Thu Jul 6 19:43:21 2006 UTC

…		…
42	because the author couldn't get C<mlterm> to use one font for latin1 and	42	because the author couldn't get C<mlterm> to use one font for latin1 and
43	another for japanese.	43	another for japanese.
44		44
45	Therefore another design rationale was the use of multiple fonts to	45	Therefore another design rationale was the use of multiple fonts to
46	display characters: The idea of a single unicode font which many other	46	display characters: The idea of a single unicode font which many other
47	programs force onto it's users never made sense to me: You should be able	47	programs force onto its users never made sense to me: You should be able
48	to choose any font for any script freely.	48	to choose any font for any script freely.
49		49
50	Apart from that, rxvt-unicode is also much better internationalised than	50	Apart from that, rxvt-unicode is also much better internationalised than
51	it's predecessor, supports things such as XFT and ISO 14755 that are handy	51	its predecessor, supports things such as XFT and ISO 14755 that are handy
52	in i18n-environments, is faster, and has a lot less bugs than the original	52	in i18n-environments, is faster, and has a lot less bugs than the original
53	rxvt. This all in addition to dozens of other small improvements.	53	rxvt. This all in addition to dozens of other small improvements.
54		54
55	It is still faithfully following the original rxvt idea of being lean	55	It is still faithfully following the original rxvt idea of being lean
56	and nice on resources: for example, you can still configure rxvt-unicode	56	and nice on resources: for example, you can still configure rxvt-unicode
57	without most of it's features to get a lean binary. It also comes with	57	without most of its features to get a lean binary. It also comes with
58	a client/daemon pair that lets you open any number of terminal windows	58	a client/daemon pair that lets you open any number of terminal windows
59	from within a single process, which makes startup time very fast and	59	from within a single process, which makes startup time very fast and
60	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and	60	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
61	@@RXVT_NAME@@c(1) (client).	61	@@RXVT_NAME@@c(1) (client).
62		62
…		…
93		93
94	Attempt to open a window on the named X display (B<-d> still	94	Attempt to open a window on the named X display (B<-d> still
95	respected). In the absence of this option, the display specified by the	95	respected). In the absence of this option, the display specified by the
96	B<DISPLAY> environment variable is used.	96	B<DISPLAY> environment variable is used.
97		97
		98	=item B<-depth> I<bitdepth>
		99
		100	Compile I<xft>: Attempt to find a visual with the given bit depth;
		101	resource B<depth>.
		102
98	=item B<-geometry> I<geom>	103	=item B<-geometry> I<geom>
99		104
100	Window geometry (B<-g> still respected); resource B<geometry>.	105	Window geometry (B<-g> still respected); resource B<geometry>.
101		106
102	=item B<-rv>\|B<+rv>	107	=item B<-rv>\|B<+rv>
…		…
109		114
110	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>	115	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>
111		116
112	Turn on/off inheriting parent window's pixmap. Alternative form is	117	Turn on/off inheriting parent window's pixmap. Alternative form is
113	B<-tr>; resource B<inheritPixmap>.	118	B<-tr>; resource B<inheritPixmap>.
		119
		120	I<Please note that transparency of any kind if completely unsupported by
		121	the author. Don't bug him with installation questions!>
114		122
115	=item B<-fade> I<number>	123	=item B<-fade> I<number>
116		124
117	Fade the text by the given percentage when focus is lost. Small values	125	Fade the text by the given percentage when focus is lost. Small values
118	fade a little only, 100 completely replaces all colours by the fade	126	fade a little only, 100 completely replaces all colours by the fade
119	colour; resource B<fading>.	127	colour; resource B<fading>.
120		128
121	=item B<-fadecolor> I<colour>	129	=item B<-fadecolor> I<colour>
122		130
123	Fade to this colour when fading is used (see B<-fade>). The default colour	131	Fade to this colour when fading is used (see B<-fade>). The default colour
124	is black. resource B<fadeColor>.	132	is opaque black. resource B<fadeColor>.
125		133
126	=item B<-tint> I<colour>	134	=item B<-tint> I<colour>
127		135
128	Tint the transparent background pixmap with the given colour when	136	Tint the transparent background pixmap with the given colour when
129	transparency is enabled with B<-tr> or B<-ip>. This only works for	137	transparency is enabled with B<-tr> or B<-ip>. This only works for
…		…
172	resource B<borderColor>.	180	resource B<borderColor>.
173		181
174	=item B<-fn> I<fontlist>	182	=item B<-fn> I<fontlist>
175		183
176	Select the fonts to be used. This is a comma separated list of font names	184	Select the fonts to be used. This is a comma separated list of font names
177	that are used in turn when trying to display Unicode characters. The	185	that are checked in order when trying to find glyphs for characters. The
178	first font defines the cell size for characters; other fonts might be	186	first font defines the cell size for characters; other fonts might be
179	smaller, but not (in general) larger. A (hopefully) reasonable default	187	smaller, but not (in general) larger. A (hopefully) reasonable default
180	font list is always appended to it. See resource B<font> for more details.	188	font list is always appended to it. See resource B<font> for more details.
181		189
182	In short, to specify an X11 core font, just specify it's name or prefix it	190	In short, to specify an X11 core font, just specify its name or prefix it
183	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,	191	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184	e.g.:	192	e.g.:
185		193
186	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	194	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	195	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
296	=item B<-bl>	304	=item B<-bl>
297		305
298	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	306	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
299	if honoured by the WM, the rxvt-unicode window will not have window	307	if honoured by the WM, the rxvt-unicode window will not have window
300	decorations; resource B<borderLess>.	308	decorations; resource B<borderLess>.
		309
		310	=item B<-override-redirect>
		311
		312	Compile I<frills>: Sets override-redirect on the window; resource
		313	B<override-redirect>.
301		314
302	=item B<-sbg>	315	=item B<-sbg>
303		316
304	Compile I<frills>: Disable the usage of the built-in block graphics/line	317	Compile I<frills>: Disable the usage of the built-in block graphics/line
305	drawing characters and just rely on what the specified fonts provide. Use	318	drawing characters and just rely on what the specified fonts provide. Use
…		…
410		423
411	Remap a key symbol. See resource B<keysym>.	424	Remap a key symbol. See resource B<keysym>.
412		425
413	=item B<-embed> I<windowid>	426	=item B<-embed> I<windowid>
414		427
415	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,	428	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
416	which enables applications to easily embed a terminal.	429	which enables applications to easily embed a terminal.
417		430
418	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it	431	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
419	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it	432	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
420	quite a bit, so don't expect it to keep some specific state. It's best to	433	quite a bit, so don't expect it to keep some specific state. It's best to
…		…
435	$rxvt->signal_connect_after (realize => sub {	448	$rxvt->signal_connect_after (realize => sub {
436	my $xid = $_[0]->window->get_xid;	449	my $xid = $_[0]->window->get_xid;
437	system "@@RXVT_NAME@@ -embed $xid &";	450	system "@@RXVT_NAME@@ -embed $xid &";
438	});	451	});
439		452
440	=item B<-pty-fd> I<fileno>	453	=item B<-pty-fd> I<file descriptor>
441		454
442	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	455	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
443	pair but instead use the given filehandle as the tty master. This is	456	pair but instead use the given filehandle as the tty master. This is
444	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator	457	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
445	without having to run a program within it.	458	without having to run a program within it.
446		459
447	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	460	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
448	entries and will not tinker with pty/tty permissions - you have to do that	461	entries and will not tinker with pty/tty permissions - you have to do that
449	yourself if you want that.	462	yourself if you want that.
450		463
		464	As an extremely special case, specifying C<-1> will completely suppress
		465	pty/tty operations.
		466
451	Here is a example in perl that illustrates how this option can be used (a	467	Here is a example in perl that illustrates how this option can be used (a
452	longer example is in F<doc/pty-fd>):	468	longer example is in F<doc/pty-fd>):
453		469
454	use IO::Pty;	470	use IO::Pty;
455	use Fcntl;	471	use Fcntl;
…		…
463	my $slave = $pty->slave;	479	my $slave = $pty->slave;
464	while (<$slave>) { print $slave "got <$_>\n" }	480	while (<$slave>) { print $slave "got <$_>\n" }
465		481
466	=item B<-pe> I<string>	482	=item B<-pe> I<string>
467		483
468	Colon-separated list of perl extension scripts to use in this terminal	484	Comma-separated list of perl extension scripts to use (or not to use) in
469	instance. See resource B<perl-ext>.	485	this terminal instance. See resource B<perl-ext> for details.
470		486
471	=back	487	=back
472		488
473	=head1 RESOURCES (available also as long-options)	489	=head1 RESOURCES (available also as long-options)
474		490
475	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	491	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
476	options) compiled into your version.	492	options) compiled into your version.
477		493
478	There are two different methods that @@RXVT_NAME@@ can use to get the	494	You can set and change the resources using X11 tools like B<xrdb>. Many
479	Xresource data: using the X libraries (Xrm*-functions) or internal	495	distribution do also load settings from the B<~/.Xresources> file when X
480	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	496	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
481	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	497	with later settings overwriting earlier ones:
482	resources using X11 tools like B<xrdb>. Many distribution do also load
483	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
484	will consult the following files/resources in order, with later settings
485	overwriting earlier ones:
486		498
487	1. system-wide app-defaults file, either locale-dependent OR global	499	1. system-wide app-defaults file, either locale-dependent OR global
488	2. app-defaults file in $XAPPLRESDIR	500	2. app-defaults file in $XAPPLRESDIR
489	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	501	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
490	4. SCREEN_RESOURCES for the current screen	502	4. SCREEN_RESOURCES for the current screen
491	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	503	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
492		504
493	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
494	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
495	set in XAPPLOADDIR/URxvt (compile-time defined: usually
496	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
497	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
498	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	505	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
499	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows	506	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
500	resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be	507	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
501	easily configured, while the class name B<URxvt> allows resources	508	configured, while the class name B<URxvt> allows resources unique to
502	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	509	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
503	shared between different B<@@RXVT_NAME@@> configurations. If no	510	configurations. If no resources are specified, suitable defaults will
504	resources are specified, suitable defaults will be used. Command-line	511	be used. Command-line arguments can be used to override resource
505	arguments can be used to override resource settings. The following	512	settings. The following resources are supported (you might want to
506	resources are allowed:	513	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		514	extensions not documented here):
507		515
508	=over 4	516	=over 4
		517
		518	=item B<depth:> I<bitdepth>
		519
		520	Compile I<xft>: Attempt to find a visual with the given bit depth;
		521	option B<-depth>.
509		522
510	=item B<geometry:> I<geom>	523	=item B<geometry:> I<geom>
511		524
512	Create the window with the specified X window geometry [default 80x24];	525	Create the window with the specified X window geometry [default 80x24];
513	option B<-geometry>.	526	option B<-geometry>.
…		…
586	=item B<inheritPixmap:> I<boolean>	599	=item B<inheritPixmap:> I<boolean>
587		600
588	B<True>: make the background inherit the parent windows' pixmap, giving	601	B<True>: make the background inherit the parent windows' pixmap, giving
589	artificial transparency. B<False>: do not inherit the parent windows'	602	artificial transparency. B<False>: do not inherit the parent windows'
590	pixmap.	603	pixmap.
		604
		605	I<Please note that transparency of any kind if completely unsupported by
		606	the author. Don't bug him with installation questions!>
591		607
592	=item B<fading:> I<number>	608	=item B<fading:> I<number>
593		609
594	Fade the text by the given percentage when focus is lost; option B<-fade>.	610	Fade the text by the given percentage when focus is lost; option B<-fade>.
595		611
…		…
632	of 1 displays the image without any scaling. A scale of 2 to 9	648	of 1 displays the image without any scaling. A scale of 2 to 9
633	specifies an integer number of images in that direction. No image will	649	specifies an integer number of images in that direction. No image will
634	be magnified beyond 10 times its original size. The maximum permitted	650	be magnified beyond 10 times its original size. The maximum permitted
635	scale is 1000. [default 0x0+50+50]	651	scale is 1000. [default 0x0+50+50]
636		652
637	=item B<menu:> I<file[;tag]>
638
639	Read in the specified menu file (note the `.menu' extension is
640	optional) and also optionally specify a starting tag to find. See the
641	reference documentation for details on the syntax for the menuBar.
642
643	=item B<path:> I<path>	653	=item B<path:> I<path>
644		654
645	Specify the colon-delimited search path for finding files (XPM and	655	Specify the colon-delimited search path for finding XPM files.
646	menus), in addition to the paths specified by the B<RXVTPATH> and
647	B<PATH> environment variables.
648		656
649	=item B<font:> I<fontlist>	657	=item B<font:> I<fontlist>
650		658
651	Select the fonts to be used. This is a comma separated list of font	659	Select the fonts to be used. This is a comma separated list of font names
652	names that are used in turn when trying to display Unicode characters.	660	that are checked in order when trying to find glyphs for characters. The
653	The first font defines the cell size for characters; other fonts might	661	first font defines the cell size for characters; other fonts might be
654	be smaller, but not larger. A reasonable default font list is always	662	smaller, but not (in general) larger. A (hopefully) reasonable default
655	appended to it; option B<-fn>.	663	font list is always appended to it; option B<-fn>.
656		664
657	Each font can either be a standard X11 core font (XLFD) name, with	665	Each font can either be a standard X11 core font (XLFD) name, with
658	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.	666	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
659		667
660	In addition, each font can be prefixed with additional hints and	668	In addition, each font can be prefixed with additional hints and
…		…
662	hint currently is C<codeset=codeset-name>, and this is only used for Xft	670	hint currently is C<codeset=codeset-name>, and this is only used for Xft
663	fonts.	671	fonts.
664		672
665	For example, this font resource	673	For example, this font resource
666		674
667	URxvt*font: 9x15bold,\	675	URxvt.font: 9x15bold,\
668	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	676	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
669	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \	677	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
670	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	678	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
671	xft:Code2000:antialias=false	679	xft:Code2000:antialias=false
672		680
…		…
769		777
770	The string will be interpreted as if typed into the shell as-is.	778	The string will be interpreted as if typed into the shell as-is.
771		779
772	Example:	780	Example:
773		781
774	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	782	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
775		783
776	This creates a new file in your home directory with the screen contents	784	This creates a new file in your home directory with the screen contents
777	everytime you hit C<Print>.	785	everytime you hit C<Print>.
778		786
779	=item B<scrollBar:> I<boolean>	787	=item B<scrollBar:> I<boolean>
…		…
904	pressed. If unset it will send the sequence traditionally associated	912	pressed. If unset it will send the sequence traditionally associated
905	with the B<Execute> key.	913	with the B<Execute> key.
906		914
907	=item B<cutchars:> I<string>	915	=item B<cutchars:> I<string>
908		916
909	The characters used as delimiters for double-click word selection. The	917	The characters used as delimiters for double-click word selection
910	built-in default:	918	(whitespace delimiting is added automatically if resource is given).
		919
		920	When the selection extension is in use (the default if compiled in, see
		921	the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters
		922	will be created (if the resource exists, otherwise, no regex will be
		923	created). In this mode, characters outside ISO-8859-1 can be used.
		924
		925	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:
911		927
912	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	928	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>
913		929
914	=item B<preeditType:> I<style>	930	=item B<preeditType:> I<style>
915		931
…		…
951	default. (Note that many other terminals, including xterm, have these	967	default. (Note that many other terminals, including xterm, have these
952	sequences enabled by default, which doesn't make it safer, though).	968	sequences enabled by default, which doesn't make it safer, though).
953		969
954	You can enable them by setting this boolean resource or specifying	970	You can enable them by setting this boolean resource or specifying
955	B<-insecure> as an option. At the moment, this enables display-answer,	971	B<-insecure> as an option. At the moment, this enables display-answer,
956	locale, findfont, icon label and window title requests as well as dynamic	972	locale, findfont, icon label and window title requests.
957	menubar dispatch.
958		973
959	=item B<modifier:> I<modifier>	974	=item B<modifier:> I<modifier>
960		975
961	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	976	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
962	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	977	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
966		981
967	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	982	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
968	character is passed through. It may contain escape values as described	983	character is passed through. It may contain escape values as described
969	in the entry on B<keysym> following.	984	in the entry on B<keysym> following.
970		985
971	=item B<secondaryScreen:> I<bool>	986	=item B<secondaryScreen:> I<boolean>
972		987
973	Turn on/off secondary screen (default enabled).	988	Turn on/off secondary screen (default enabled).
974		989
975	=item B<secondaryScroll:> I<bool>	990	=item B<secondaryScroll:> I<boolean>
976		991
977	Turn on/off secondary screen scroll (default enabled). If the this	992	Turn on/off secondary screen scroll (default enabled). If the this
978	option is enabled, scrolls on the secondary screen will change the	993	option is enabled, scrolls on the secondary screen will change the
979	scrollback buffer and switching to/from the secondary screen will	994	scrollback buffer and switching to/from the secondary screen will
980	instead scroll the screen up.	995	instead scroll the screen up.
981		996
982	=item B<hold>: I<bool>	997	=item B<hold>: I<boolean>
983		998
984	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	999	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
985	will not immediately destroy its window when the program executed within	1000	will not immediately destroy its window when the program executed within
986	it exits. Instead, it will wait till it is being killed or closed by the	1001	it exits. Instead, it will wait till it is being killed or closed by the
987	user.	1002	user.
…		…
1012	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1027	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
1013	C<\000>: octal number) or verbatim control characters (C<^?>: delete,	1028	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1014	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it	1029	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1015	can start or end with whitespace.	1030	can start or end with whitespace.
1016		1031
1017	Please note that you need to double the C<\> when using	1032	Please note that you need to double the C<\> in resource files, as
1018	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can	1033	Xlib itself does its own de-escaping (you can use C<\033> instead of
1019	use C<\033> instead of C<\e> (and so on), which will work with both Xt and	1034	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1020	@@RXVT_NAME@@'s own processing).	1035	processing).
1021		1036
1022	You can define a range of keysyms in one shot by providing a I<string>	1037	You can define a range of keysyms in one shot by providing a I<string>
1023	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1038	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
1024	should be a character not used by the strings.	1039	should be a character not used by the strings.
1025		1040
…		…
1081		1096
1082	=item B<perl-ext-common>: I<string>	1097	=item B<perl-ext-common>: I<string>
1083		1098
1084	=item B<perl-ext>: I<string>	1099	=item B<perl-ext>: I<string>
1085		1100
1086	Colon-separated list(s) of perl extension scripts to use in this terminal	1101	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1102	use in this terminal instance; option B<-pe>.
		1103
		1104	Extension names can be prefixed with a C<-> sign to prohibit using
		1105	them. This can be useful to selectively disable some extensions loaded
		1106	by default, or specified via the C<perl-ext-common> resource. For
		1107	example, C<default,-selection> will use all the default extension except
		1108	C<selection>.
		1109
		1110	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
		1112	searchable scorllback to Alt/Meta-s). Mentioning the same extension
		1113	multiple times with different arguments will pass multiple arguments to
		1114	the extension.
		1115
1087	instance. Each extension is looked up in the library directories, loaded	1116	Each extension is looked up in the library directories, loaded if
1088	if necessary, and bound to the current terminal instance. If this	1117	necessary, and bound to the current terminal instance.
1089	resource is empty or missing, then the perl interpreter will not be	1118
1090	initialized. The idea behind two options is that B<perl-ext-common> will	1119	If both of these resources are the empty string, then the perl
1091	be used for extensions that should be available to all instances, while	1120	interpreter will not be initialized. The idea behind two options is that
1092	B<perl-ext> is used for specific instances; option B<-pe>.	1121	B<perl-ext-common> will be used for extensions that should be available to
		1122	all instances, while B<perl-ext> is used for specific instances.
1093		1123
1094	=item B<perl-eval>: I<string>	1124	=item B<perl-eval>: I<string>
1095		1125
1096	Perl code to be evaluated when all extensions have been registered. See the	1126	Perl code to be evaluated when all extensions have been registered. See
1097	@@RXVT_NAME@@perl(3) manpage.	1127	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
		1128	will be ignored when running setuid/setgid.
1098		1129
1099	=item B<perl-lib>: I<path>	1130	=item B<perl-lib>: I<path>
1100		1131
1101	Colon-separated list of additional directories that hold extension	1132	Colon-separated list of additional directories that hold extension
1102	scripts. When looking for extensions specified by the C<perl> resource,	1133	scripts. When looking for extensions specified by the C<perl> resource,
1103	@@RXVT_NAME@@ will first look in these directories and then in	1134	@@RXVT_NAME@@ will first look in these directories and then in
1104	F<@@RXVT_LIBDIR@@/urxvt/perl/>.	1135	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
		1136	will be ignored when running setuid/setgid.
1105		1137
1106	See the @@RXVT_NAME@@perl(3) manpage.	1138	See the @@RXVT_NAME@@perl(3) manpage.
		1139
		1140	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1141
		1142	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1143	details.
		1144
		1145	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1146
		1147	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1148	for details.
		1149
		1150	=item B<searchable-scrollback:> I<keysym>
		1151
		1152	Sets the hotkey that starts the incremental scrollback buffer search
		1153	(default: C<M-s>).
		1154
		1155	=item B<urlLauncher>: I<string>
		1156
		1157	Specifies the program to be started with a URL argument. Used by the
		1158	C<selection-popup> and C<mark-urls> perl extensions.
		1159
		1160	=item B<transient-for>: I<windowid>
		1161
		1162	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1163
		1164	=item B<override-redirect>: I<boolean>
		1165
		1166	Compile I<frills>: Sets override-redirect for the terminal window, making
		1167	it almost invisible to window managers; option B<-override-redirect>.
1107		1168
1108	=back	1169	=back
1109		1170
1110	=head1 THE SCROLLBAR	1171	=head1 THE SCROLLBAR
1111		1172
…		…
1153	selection, and trailing whitespace is visually underlined and removed from	1214	selection, and trailing whitespace is visually underlined and removed from
1154	the selection.	1215	the selection.
1155		1216
1156	=item B<Insertion>:	1217	=item B<Insertion>:
1157		1218
1158	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1219	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1159	an B<@@RXVT_NAME@@> window causes the current text selection to be	1220	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1160	inserted as if it had been typed on the keyboard.	1221	Meta modifier) to be inserted as if it had been typed on the keyboard.
		1222
		1223	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1224	inserted too.
1161		1225
1162	=back	1226	=back
1163		1227
1164	=head1 CHANGING FONTS	1228	=head1 CHANGING FONTS
1165		1229
1166	Changing fonts (or font sizes, respectively) via the keypad is not yet	1230	Changing fonts (or font sizes, respectively) via the keypad is not yet
1167	supported in rxvt-unicode. Bug me if you need this.	1231	supported in rxvt-unicode. Bug me if you need this.
1168		1232
1169	You can, however, switch fonts at runtime using escape sequences (and	1233	You can, however, switch fonts at runtime using escape sequences, e.g.:
1170	therefore using the menubar), e.g.:
1171		1234
1172	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"	1235	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1236
		1237	You can use keyboard shortcuts, too:
		1238
		1239	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1240	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1173		1241
1174	rxvt-unicode will automatically re-apply these fonts to the output so far.	1242	rxvt-unicode will automatically re-apply these fonts to the output so far.
1175		1243
1176	=head1 ISO 14755 SUPPORT	1244	=head1 ISO 14755 SUPPORT
1177		1245
…		…
1205	This mode lets you input characters representing the keycap symbols of	1273	This mode lets you input characters representing the keycap symbols of
1206	your keyboard, if representable in the current locale encoding.	1274	your keyboard, if representable in the current locale encoding.
1207		1275
1208	Start by pressing C<Control> and C<Shift> together, then releasing	1276	Start by pressing C<Control> and C<Shift> together, then releasing
1209	them. The next special key (cursor keys, home etc.) you enter will not	1277	them. The next special key (cursor keys, home etc.) you enter will not
1210	invoke it's usual function but instead will insert the corresponding	1278	invoke its usual function but instead will insert the corresponding
1211	keycap symbol. The symbol will only be entered when the key has been	1279	keycap symbol. The symbol will only be entered when the key has been
1212	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1280	released, otherwise pressing e.g. C<Shift> would enter the symbol for
1213	C<ISO Level 2 Switch>, although your intention might have been to enter a	1281	C<ISO Level 2 Switch>, although your intention might have been to enter a
1214	reverse tab (Shift-Tab).	1282	reverse tab (Shift-Tab).
1215		1283
…		…
1248	=head1 COLORS AND GRAPHICS	1316	=head1 COLORS AND GRAPHICS
1249		1317
1250	In addition to the default foreground and background colours,	1318	In addition to the default foreground and background colours,
1251	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1319	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1252	high-intensity bold/blink versions of the same). Here is a list of the	1320	high-intensity bold/blink versions of the same). Here is a list of the
1253	colours with their B<rgb.txt> names.	1321	colours with their names.
1254		1322
1255	=begin table	1323	=begin table
1256		1324
1257	B<color0> (black) = Black	1325	B<color0> (black) = Black
1258	B<color1> (red) = Red3	1326	B<color1> (red) = Red3
…		…
1278	It is also possible to specify the colour values of B<foreground>,	1346	It is also possible to specify the colour values of B<foreground>,
1279	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1347	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1280	a number 0-15, as a convenient shorthand to reference the colour name of	1348	a number 0-15, as a convenient shorthand to reference the colour name of
1281	color0-color15.	1349	color0-color15.
1282		1350
		1351	In addition to the colours defined above, @@RXVT_NAME@@ offers an
		1352	additional 72 colours. The first 64 of those (with indices 16 to 79)
		1353	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
		1354	16>), followed by 8 additional shades of gray (with indices 80 to 87).
		1355
		1356	Together, all those colours implement the 88 colour xterm colours. Only
		1357	the first 16 can be changed using resources currently, the rest can only
		1358	be changed via command sequences ("escape codes").
		1359
1283	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1360	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1284	always swapping the foreground/background colours. This is in contrast to	1361	always swapping the foreground/background colours. This is in contrast to
1285	I<xterm>(1) where the colours are only swapped if they have not otherwise	1362	I<xterm>(1) where the colours are only swapped if they have not otherwise
1286	been specified. For example,	1363	been specified. For example,
1287		1364
…		…
1291		1368
1292	would yield White on Black, while on I<xterm>(1) it would yield Black	1369	would yield White on Black, while on I<xterm>(1) it would yield Black
1293	on White.	1370	on White.
1294		1371
1295	=back	1372	=back
		1373
		1374	=head2 ALPHA CHANNEL SUPPORT
		1375
		1376	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>
		1378	(recommended, but B<MUST> have 4 digits/component) colour specifications,
		1379	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
		1381	transparent). You can also prefix any color with C<[a]>, where C<a> is on
		1382	to four hex digits specifiying the opacity value.
		1383
		1384	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
		1386	ARGB visuals out of the box, and rxvt-unicode just fudges around.
		1387
		1388	For example, the following selects an almost completely transparent red
		1389	background, and an almost opaque pink foreground:
		1390
		1391	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"
		1392
		1393	I<Please note that transparency of any kind if completely unsupported by
		1394	the author. Don't bug him with installation questions!>
1296		1395
1297	=head1 ENVIRONMENT	1396	=head1 ENVIRONMENT
1298		1397
1299	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1398	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1300		1399
…		…
1333	C<--with-terminfo=PATH>.	1432	C<--with-terminfo=PATH>.
1334		1433
1335	=item B<DISPLAY>	1434	=item B<DISPLAY>
1336		1435
1337	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1436	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1338	display in it's child processes.	1437	display in its child processes.
1339		1438
1340	=item B<SHELL>	1439	=item B<SHELL>
1341		1440
1342	The shell to be used for command execution, defaults to C</bin/sh>.	1441	The shell to be used for command execution, defaults to C</bin/sh>.
1343
1344	=item B<RXVTPATH>
1345
1346	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1347	files.
1348
1349	=item B<PATH>
1350
1351	Used in the same way as C<RXVTPATH>.
1352		1442
1353	=item B<RXVT_SOCKET>	1443	=item B<RXVT_SOCKET>
1354		1444
1355	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1445	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1356	@@RXVT_NAME@@d(1).	1446	@@RXVT_NAME@@d(1).
…		…
1394		1484
1395	=item Project Coordinator	1485	=item Project Coordinator
1396		1486
1397	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1487	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1398		1488
1399	L<http://software.schmorp.de/#rxvt-unicode>	1489	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1400		1490
1401	=back	1491	=back
1402		1492
1403	=head1 AUTHORS	1493	=head1 AUTHORS
1404		1494
…		…
1426		1516
1427	Project Coordinator (changes.txt 2.21a to 2.4.5)	1517	Project Coordinator (changes.txt 2.21a to 2.4.5)
1428		1518
1429	=item Geoff Wing L<< <gcw@pobox.com> >>	1519	=item Geoff Wing L<< <gcw@pobox.com> >>
1430		1520
1431	Rewrote screen display and text selection routines. Project Coordinator	1521	Rewrote screen display and text selection routines.
		1522
1432	(changes.txt 2.4.6 - rxvt-unicode)	1523	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1433		1524
1434	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1525	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1435		1526
1436	Forked rxvt-unicode, rewrote most of the display code and internal	1527	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1437	character handling to store text in unicode, improve xterm	1528	extension, random hacks, numerous bugfixes and extensions.
1438	compatibility and apply numerous other bugfixes and extensions.
1439		1529
1440	Project Coordinator (Changes 1.0 -)	1530	Project Coordinator (Changes 1.0 -)
1441		1531
		1532	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1533
		1534	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
		1535
1442	=back	1536	=back
1443		1537

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.85 by root, Wed Jan 4 20:43:37 2006 UTC vs. Revision 1.114 by root, Thu Jul 6 19:43:21 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.85 by root, Wed Jan 4 20:43:37 2006 UTC vs.
Revision 1.114 by root, Thu Jul 6 19:43:21 2006 UTC