[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.98 by root, Mon Jan 16 15:12:48 2006 UTC

…		…
172	resource B<borderColor>.	172	resource B<borderColor>.
173		173
174	=item B<-fn> I<fontlist>	174	=item B<-fn> I<fontlist>
175		175
176	Select the fonts to be used. This is a comma separated list of font names	176	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	177	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	178	first font defines the cell size for characters; other fonts might be
179	smaller, but not (in general) larger. A (hopefully) reasonable default	179	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.	180	font list is always appended to it. See resource B<font> for more details.
181		181
182	In short, to specify an X11 core font, just specify it's name or prefix it	182	In short, to specify an X11 core font, just specify it's name or prefix it
…		…
435	$rxvt->signal_connect_after (realize => sub {	435	$rxvt->signal_connect_after (realize => sub {
436	my $xid = $_[0]->window->get_xid;	436	my $xid = $_[0]->window->get_xid;
437	system "@@RXVT_NAME@@ -embed $xid &";	437	system "@@RXVT_NAME@@ -embed $xid &";
438	});	438	});
439		439
440	=item B<-pty-fd> I<fileno>	440	=item B<-pty-fd> I<file descriptor>
441		441
442	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	442	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	443	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	444	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
445	without having to run a program within it.	445	without having to run a program within it.
446		446
447	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	447	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	448	entries and will not tinker with pty/tty permissions - you have to do that
449	yourself if you want that.	449	yourself if you want that.
450		450
		451	As an extremely special case, specifying C<-1> will completely suppress
		452	pty/tty operations.
		453
451	Here is a example in perl that illustrates how this option can be used (a	454	Here is a example in perl that illustrates how this option can be used (a
452	longer example is in F<doc/pty-fd>):	455	longer example is in F<doc/pty-fd>):
453		456
454	use IO::Pty;	457	use IO::Pty;
455	use Fcntl;	458	use Fcntl;
…		…
463	my $slave = $pty->slave;	466	my $slave = $pty->slave;
464	while (<$slave>) { print $slave "got <$_>\n" }	467	while (<$slave>) { print $slave "got <$_>\n" }
465		468
466	=item B<-pe> I<string>	469	=item B<-pe> I<string>
467		470
468	Colon-separated list of perl extension scripts to use in this terminal	471	Comma-separated list of perl extension scripts to use (or not to use) in
469	instance. See resource B<perl-ext>.	472	this terminal instance. See resource B<perl-ext> for details.
470		473
471	=back	474	=back
472		475
473	=head1 RESOURCES (available also as long-options)	476	=head1 RESOURCES (available also as long-options)
474		477
475	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	478	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
476	options) compiled into your version.	479	options) compiled into your version.
477		480
478	There are two different methods that @@RXVT_NAME@@ can use to get the	481	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	482	distribution do also load settings from the B<~/.Xresources> file when X
480	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	483	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	484	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		485
487	1. system-wide app-defaults file, either locale-dependent OR global	486	1. system-wide app-defaults file, either locale-dependent OR global
488	2. app-defaults file in $XAPPLRESDIR	487	2. app-defaults file in $XAPPLRESDIR
489	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	488	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
490	4. SCREEN_RESOURCES for the current screen	489	4. SCREEN_RESOURCES for the current screen
491	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	490	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
492		491
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	492	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	493	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	494	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	495	configured, while the class name B<URxvt> allows resources unique to
502	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	496	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
503	shared between different B<@@RXVT_NAME@@> configurations. If no	497	configurations. If no resources are specified, suitable defaults will
504	resources are specified, suitable defaults will be used. Command-line	498	be used. Command-line arguments can be used to override resource
505	arguments can be used to override resource settings. The following	499	settings. The following resources are supported (you might want to
506	resources are allowed:	500	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		501	extensions not documented here):
507		502
508	=over 4	503	=over 4
509		504
510	=item B<geometry:> I<geom>	505	=item B<geometry:> I<geom>
511		506
…		…
632	of 1 displays the image without any scaling. A scale of 2 to 9	627	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	628	specifies an integer number of images in that direction. No image will
634	be magnified beyond 10 times its original size. The maximum permitted	629	be magnified beyond 10 times its original size. The maximum permitted
635	scale is 1000. [default 0x0+50+50]	630	scale is 1000. [default 0x0+50+50]
636		631
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>	632	=item B<path:> I<path>
644		633
645	Specify the colon-delimited search path for finding files (XPM and	634	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		635
649	=item B<font:> I<fontlist>	636	=item B<font:> I<fontlist>
650		637
651	Select the fonts to be used. This is a comma separated list of font	638	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.	639	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	640	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	641	smaller, but not (in general) larger. A (hopefully) reasonable default
655	appended to it; option B<-fn>.	642	font list is always appended to it; option B<-fn>.
656		643
657	Each font can either be a standard X11 core font (XLFD) name, with	644	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:>.	645	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
659		646
660	In addition, each font can be prefixed with additional hints and	647	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	649	hint currently is C<codeset=codeset-name>, and this is only used for Xft
663	fonts.	650	fonts.
664		651
665	For example, this font resource	652	For example, this font resource
666		653
667	URxvt*font: 9x15bold,\	654	URxvt.font: 9x15bold,\
668	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	655	-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, \	656	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
670	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	657	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
671	xft:Code2000:antialias=false	658	xft:Code2000:antialias=false
672		659
…		…
769		756
770	The string will be interpreted as if typed into the shell as-is.	757	The string will be interpreted as if typed into the shell as-is.
771		758
772	Example:	759	Example:
773		760
774	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	761	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
775		762
776	This creates a new file in your home directory with the screen contents	763	This creates a new file in your home directory with the screen contents
777	everytime you hit C<Print>.	764	everytime you hit C<Print>.
778		765
779	=item B<scrollBar:> I<boolean>	766	=item B<scrollBar:> I<boolean>
…		…
951	default. (Note that many other terminals, including xterm, have these	938	default. (Note that many other terminals, including xterm, have these
952	sequences enabled by default, which doesn't make it safer, though).	939	sequences enabled by default, which doesn't make it safer, though).
953		940
954	You can enable them by setting this boolean resource or specifying	941	You can enable them by setting this boolean resource or specifying
955	B<-insecure> as an option. At the moment, this enables display-answer,	942	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	943	locale, findfont, icon label and window title requests.
957	menubar dispatch.
958		944
959	=item B<modifier:> I<modifier>	945	=item B<modifier:> I<modifier>
960		946
961	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	947	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	948	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
1012	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	998	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,	999	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	1000	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1015	can start or end with whitespace.	1001	can start or end with whitespace.
1016		1002
1017	Please note that you need to double the C<\> when using	1003	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	1004	Xlib itself does it's 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	1005	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1020	@@RXVT_NAME@@'s own processing).	1006	processing).
1021		1007
1022	You can define a range of keysyms in one shot by providing a I<string>	1008	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 `/'	1009	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
1024	should be a character not used by the strings.	1010	should be a character not used by the strings.
1025		1011
…		…
1081		1067
1082	=item B<perl-ext-common>: I<string>	1068	=item B<perl-ext-common>: I<string>
1083		1069
1084	=item B<perl-ext>: I<string>	1070	=item B<perl-ext>: I<string>
1085		1071
1086	Colon-separated list(s) of perl extension scripts to use in this terminal	1072	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1073	use in this terminal instance; option B<-pe>.
		1074
		1075	Extension names can be prefixed with a C<-> sign to prohibit using
		1076	them. This can be useful to selectively disable some extensions loaded
		1077	by default, or specified via the C<perl-ext-common> resource. For
		1078	example, C<default,-selection> will use all the default extension except
		1079	C<selection>.
		1080
		1081	Extension names can also be followed by an argument in angle brackets
		1082	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1083	searchable scorllback to Alt/Meta-s). Mentioning the same extension
		1084	multiple times with different arguments will pass multiple arguments to
		1085	the extension.
		1086
1087	instance. Each extension is looked up in the library directories, loaded	1087	Each extension is looked up in the library directories, loaded if
1088	if necessary, and bound to the current terminal instance. If this	1088	necessary, and bound to the current terminal instance.
1089	resource is empty or missing, then the perl interpreter will not be	1089
1090	initialized. The idea behind two options is that B<perl-ext-common> will	1090	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	1091	interpreter will not be initialized. The idea behind two options is that
1092	B<perl-ext> is used for specific instances; option B<-pe>.	1092	B<perl-ext-common> will be used for extensions that should be available to
		1093	all instances, while B<perl-ext> is used for specific instances.
1093		1094
1094	=item B<perl-eval>: I<string>	1095	=item B<perl-eval>: I<string>
1095		1096
1096	Perl code to be evaluated when all extensions have been registered. See the	1097	Perl code to be evaluated when all extensions have been registered. See
1097	@@RXVT_NAME@@perl(3) manpage.	1098	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
		1099	will be ignored when running setuid/setgid.
1098		1100
1099	=item B<perl-lib>: I<path>	1101	=item B<perl-lib>: I<path>
1100		1102
1101	Colon-separated list of additional directories that hold extension	1103	Colon-separated list of additional directories that hold extension
1102	scripts. When looking for extensions specified by the C<perl> resource,	1104	scripts. When looking for extensions specified by the C<perl> resource,
1103	@@RXVT_NAME@@ will first look in these directories and then in	1105	@@RXVT_NAME@@ will first look in these directories and then in
1104	F<@@RXVT_LIBDIR@@/urxvt/perl/>.	1106	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
		1107	will be ignored when running setuid/setgid.
1105		1108
1106	See the @@RXVT_NAME@@perl(3) manpage.	1109	See the @@RXVT_NAME@@perl(3) manpage.
		1110
		1111	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1112
		1113	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1114	details.
		1115
		1116	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1117
		1118	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1119	for details.
		1120
		1121	=item B<searchable-scrollback:> I<keysym>
		1122
		1123	Sets the hotkey that starts the incremental scrollback buffer search
		1124	(default: C<M-s>).
		1125
		1126	=item B<urlLauncher>: I<string>
		1127
		1128	Specifies the program to be started with a URL argument. Used by the
		1129	C<selection-popup> and C<mark-urls> perl extensions.
		1130
		1131	=item B<transient-for>: I<windowid>
		1132
		1133	Sets the WM_TRANSIENT_FOR property to the given window iw.
1107		1134
1108	=back	1135	=back
1109		1136
1110	=head1 THE SCROLLBAR	1137	=head1 THE SCROLLBAR
1111		1138
…		…
1164	=head1 CHANGING FONTS	1191	=head1 CHANGING FONTS
1165		1192
1166	Changing fonts (or font sizes, respectively) via the keypad is not yet	1193	Changing fonts (or font sizes, respectively) via the keypad is not yet
1167	supported in rxvt-unicode. Bug me if you need this.	1194	supported in rxvt-unicode. Bug me if you need this.
1168		1195
1169	You can, however, switch fonts at runtime using escape sequences (and	1196	You can, however, switch fonts at runtime using escape sequences, e.g.:
1170	therefore using the menubar), e.g.:
1171		1197
1172	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"	1198	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1199
		1200	You can use keyboard shortcuts, too:
		1201
		1202	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1203	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1173		1204
1174	rxvt-unicode will automatically re-apply these fonts to the output so far.	1205	rxvt-unicode will automatically re-apply these fonts to the output so far.
1175		1206
1176	=head1 ISO 14755 SUPPORT	1207	=head1 ISO 14755 SUPPORT
1177		1208
…		…
1339		1370
1340	=item B<SHELL>	1371	=item B<SHELL>
1341		1372
1342	The shell to be used for command execution, defaults to C</bin/sh>.	1373	The shell to be used for command execution, defaults to C</bin/sh>.
1343		1374
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
1353	=item B<RXVT_SOCKET>	1375	=item B<RXVT_SOCKET>
1354		1376
1355	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1377	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1356	@@RXVT_NAME@@d(1).	1378	@@RXVT_NAME@@d(1).
1357		1379

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.98 by root, Mon Jan 16 15:12:48 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.98 by root, Mon Jan 16 15:12:48 2006 UTC