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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.84 by root, Wed Jan 4 05:35:34 2006 UTC vs.
Revision 1.96 by root, Fri Jan 13 12:40:46 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
…		…
189	See also the question "How does rxvt-unicode choose fonts?" in the FAQ	189	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
190	section of @@RXVT_NAME@@(7).	190	section of @@RXVT_NAME@@(7).
191		191
192	=item B<-fb> I<fontlist>	192	=item B<-fb> I<fontlist>
193		193
194	Compile font-styles: The bold font list to use when B<bold> characters are to	194	Compile I<font-styles>: The bold font list to use when B<bold> characters
195	be printed. See resource B<boldFont> for details.	195	are to be printed. See resource B<boldFont> for details.
196		196
197	=item B<-fi> I<fontlist>	197	=item B<-fi> I<fontlist>
198		198
199	Compile font-styles: The italic font list to use when I<italic> characters are to	199	Compile I<font-styles>: The italic font list to use when I<italic>
200	be printed. See resource B<italicFont> for details.	200	characters are to be printed. See resource B<italicFont> for details.
201		201
202	=item B<-fbi> I<fontlist>	202	=item B<-fbi> I<fontlist>
203		203
204	Compile font-styles: The bold italic font list to use when B<< I<bold	204	Compile I<font-styles>: The bold italic font list to use when B<< I<bold
205	italic> >> characters are to be printed. See resource B<boldItalicFont>	205	italic> >> characters are to be printed. See resource B<boldItalicFont>
206	for details.	206	for details.
207		207
208	=item B<-is>\|B<+is>	208	=item B<-is>\|B<+is>
209		209
210	Compile font-styles: Bold/Italic font styles imply high intensity	210	Compile I<font-styles>: Bold/Italic font styles imply high intensity
211	foreground/background (default). See resource B<intensityStyles> for	211	foreground/background (default). See resource B<intensityStyles> for
212	details.	212	details.
213		213
214	=item B<-name> I<name>	214	=item B<-name> I<name>
215		215
…		…
296	=item B<-bl>	296	=item B<-bl>
297		297
298	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	298	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	299	if honoured by the WM, the rxvt-unicode window will not have window
300	decorations; resource B<borderLess>.	300	decorations; resource B<borderLess>.
		301
		302	=item B<-sbg>
		303
		304	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
		306	this if you have a good font and want to use its block graphic glyphs;
		307	resource B<skipBuiltinGlyphs>.
301		308
302	=item B<-lsp> I<number>	309	=item B<-lsp> I<number>
303		310
304	Compile I<frills>: Lines (pixel height) to insert between each row of	311	Compile I<frills>: Lines (pixel height) to insert between each row of
305	the display. Useful to work around font rendering problems; resource	312	the display. Useful to work around font rendering problems; resource
…		…
428	$rxvt->signal_connect_after (realize => sub {	435	$rxvt->signal_connect_after (realize => sub {
429	my $xid = $_[0]->window->get_xid;	436	my $xid = $_[0]->window->get_xid;
430	system "@@RXVT_NAME@@ -embed $xid &";	437	system "@@RXVT_NAME@@ -embed $xid &";
431	});	438	});
432		439
433	=item B<-pty-fd> I<fileno>	440	=item B<-pty-fd> I<file descriptor>
434		441
435	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
436	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
437	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
438	without having to run a program within it.	445	without having to run a program within it.
439		446
440	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
441	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
442	yourself if you want that.	449	yourself if you want that.
443		450
		451	As an extremely special case, specifying C<-1> will completely suppress
		452	pty/tty operations.
		453
444	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
445	longer example is in F<doc/pty-fd>):	455	longer example is in F<doc/pty-fd>):
446		456
447	use IO::Pty;	457	use IO::Pty;
448	use Fcntl;	458	use Fcntl;
…		…
456	my $slave = $pty->slave;	466	my $slave = $pty->slave;
457	while (<$slave>) { print $slave "got <$_>\n" }	467	while (<$slave>) { print $slave "got <$_>\n" }
458		468
459	=item B<-pe> I<string>	469	=item B<-pe> I<string>
460		470
461	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
462	instance. See resource B<perl-ext>.	472	this terminal instance. See resource B<perl-ext> for details.
463		473
464	=back	474	=back
465		475
466	=head1 RESOURCES (available also as long-options)	476	=head1 RESOURCES (available also as long-options)
467		477
468	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	478	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
469	options) compiled into your version.	479	options) compiled into your version.
470		480
471	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
472	Xresource data: using the X libraries (Xrm*-functions) or internal	482	distribution do also load settings from the B<~/.Xresources> file when X
473	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	483	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
474	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	484	with later settings overwriting earlier ones:
475	resources using X11 tools like B<xrdb>. Many distribution do also load
476	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
477	will consult the following files/resources in order, with later settings
478	overwriting earlier ones:
479		485
480	1. system-wide app-defaults file, either locale-dependent OR global	486	1. system-wide app-defaults file, either locale-dependent OR global
481	2. app-defaults file in $XAPPLRESDIR	487	2. app-defaults file in $XAPPLRESDIR
482	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	488	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
483	4. SCREEN_RESOURCES for the current screen	489	4. SCREEN_RESOURCES for the current screen
484	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	490	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
485		491
486	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
487	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
488	set in XAPPLOADDIR/URxvt (compile-time defined: usually
489	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
490	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
491	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	492	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
492	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
493	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
494	easily configured, while the class name B<URxvt> allows resources	495	configured, while the class name B<URxvt> allows resources unique to
495	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	496	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
496	shared between different B<@@RXVT_NAME@@> configurations. If no	497	configurations. If no resources are specified, suitable defaults will
497	resources are specified, suitable defaults will be used. Command-line	498	be used. Command-line arguments can be used to override resource
498	arguments can be used to override resource settings. The following	499	settings. The following resources are supported (you might want to
499	resources are allowed:	500	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		501	extensions not documented here):
500		502
501	=over 4	503	=over 4
502		504
503	=item B<geometry:> I<geom>	505	=item B<geometry:> I<geom>
504		506
…		…
639	menus), in addition to the paths specified by the B<RXVTPATH> and	641	menus), in addition to the paths specified by the B<RXVTPATH> and
640	B<PATH> environment variables.	642	B<PATH> environment variables.
641		643
642	=item B<font:> I<fontlist>	644	=item B<font:> I<fontlist>
643		645
644	Select the fonts to be used. This is a comma separated list of font	646	Select the fonts to be used. This is a comma separated list of font names
645	names that are used in turn when trying to display Unicode characters.	647	that are checked in order when trying to find glyphs for characters. The
646	The first font defines the cell size for characters; other fonts might	648	first font defines the cell size for characters; other fonts might be
647	be smaller, but not larger. A reasonable default font list is always	649	smaller, but not (in general) larger. A (hopefully) reasonable default
648	appended to it; option B<-fn>.	650	font list is always appended to it; option B<-fn>.
649		651
650	Each font can either be a standard X11 core font (XLFD) name, with	652	Each font can either be a standard X11 core font (XLFD) name, with
651	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.	653	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
652		654
653	In addition, each font can be prefixed with additional hints and	655	In addition, each font can be prefixed with additional hints and
…		…
825		827
826	=item B<borderLess:> I<boolean>	828	=item B<borderLess:> I<boolean>
827		829
828	Set MWM hints to request a borderless window, i.e. if honoured by the	830	Set MWM hints to request a borderless window, i.e. if honoured by the
829	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.	831	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
		832
		833	=item B<skipBuiltinGlyphs:> I<boolean>
		834
		835	Compile I<frills>: Disable the usage of the built-in block graphics/line
		836	drawing characters and just rely on what the specified fonts provide. Use
		837	this if you have a good font and want to use its block graphic glyphs;
		838	option B<-sbg>.
830		839
831	=item B<termName:> I<termname>	840	=item B<termName:> I<termname>
832		841
833	Specifies the terminal type name to be set in the B<TERM> environment	842	Specifies the terminal type name to be set in the B<TERM> environment
834	variable; option B<-tn>.	843	variable; option B<-tn>.
…		…
998	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1007	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
999	C<\000>: octal number) or verbatim control characters (C<^?>: delete,	1008	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1000	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it	1009	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1001	can start or end with whitespace.	1010	can start or end with whitespace.
1002		1011
1003	Please note that you need to double the C<\> when using	1012	Please note that you need to double the C<\> in resource files, as
1004	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can	1013	Xlib itself does it's own de-escaping (you can use C<\033> instead of
1005	use C<\033> instead of C<\e> (and so on), which will work with both Xt and	1014	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1006	@@RXVT_NAME@@'s own processing).	1015	processing).
1007		1016
1008	You can define a range of keysyms in one shot by providing a I<string>	1017	You can define a range of keysyms in one shot by providing a I<string>
1009	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1018	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
1010	should be a character not used by the strings.	1019	should be a character not used by the strings.
1011		1020
…		…
1067		1076
1068	=item B<perl-ext-common>: I<string>	1077	=item B<perl-ext-common>: I<string>
1069		1078
1070	=item B<perl-ext>: I<string>	1079	=item B<perl-ext>: I<string>
1071		1080
1072	Colon-separated list(s) of perl extension scripts to use in this terminal	1081	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1082	use in this terminal instance; option B<-pe>.
		1083
		1084	Extension names can be prefixed with a C<-> sign to prohibit using
		1085	them. This can be useful to selectively disable some extensions loaded
		1086	by default, or specified via the C<perl-ext-common> resource. For
		1087	example, C<default,-selection> will use all the default extension except
		1088	C<selection>.
		1089
		1090	Extension names can also be followed by an argument in angle brackets
		1091	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1092	searchable scorllback to Alt/Meta-s). Mentioning the same extension
		1093	multiple times with different arguments will pass multiple arguments to
		1094	the extension.
		1095
1073	instance. Each extension is looked up in the library directories, loaded	1096	Each extension is looked up in the library directories, loaded if
1074	if necessary, and bound to the current terminal instance. If this	1097	necessary, and bound to the current terminal instance.
1075	resource is empty or missing, then the perl interpreter will not be	1098
1076	initialized. The idea behind two options is that B<perl-ext-common> will	1099	If both of these resources are the empty string, then the perl
1077	be used for extensions that should be available to all instances, while	1100	interpreter will not be initialized. The idea behind two options is that
1078	B<perl-ext> is used for specific instances; option B<-pe>.	1101	B<perl-ext-common> will be used for extensions that should be available to
		1102	all instances, while B<perl-ext> is used for specific instances.
1079		1103
1080	=item B<perl-eval>: I<string>	1104	=item B<perl-eval>: I<string>
1081		1105
1082	Perl code to be evaluated when all extensions have been registered. See the	1106	Perl code to be evaluated when all extensions have been registered. See
1083	@@RXVT_NAME@@perl(3) manpage.	1107	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
		1108	will be ignored when running setuid/setgid.
1084		1109
1085	=item B<perl-lib>: I<path>	1110	=item B<perl-lib>: I<path>
1086		1111
1087	Colon-separated list of additional directories that hold extension	1112	Colon-separated list of additional directories that hold extension
1088	scripts. When looking for extensions specified by the C<perl> resource,	1113	scripts. When looking for extensions specified by the C<perl> resource,
1089	@@RXVT_NAME@@ will first look in these directories and then in	1114	@@RXVT_NAME@@ will first look in these directories and then in
1090	F<@@RXVT_LIBDIR@@/urxvt/perl/>.	1115	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
		1116	will be ignored when running setuid/setgid.
1091		1117
1092	See the @@RXVT_NAME@@perl(3) manpage.	1118	See the @@RXVT_NAME@@perl(3) manpage.
		1119
		1120	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1121
		1122	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1123	details.
		1124
		1125	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1126
		1127	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1128	for details.
		1129
		1130	=item B<searchable-scrollback:> I<keysym>
		1131
		1132	Sets the hotkey that starts the incremental scrollback buffer search
		1133	(default: C<M-s>).
		1134
		1135	=item B<urlLauncher>: I<string>
		1136
		1137	Specifies the program to be started with a URL argument. Used by the
		1138	C<selection-popup> and C<mark-urls> perl extensions.
		1139
		1140	=item B<transient-for>: I<windowid>
		1141
		1142	Sets the WM_TRANSIENT_FOR property to the given window iw.
1093		1143
1094	=back	1144	=back
1095		1145
1096	=head1 THE SCROLLBAR	1146	=head1 THE SCROLLBAR
1097		1147

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.84 by root, Wed Jan 4 05:35:34 2006 UTC vs. Revision 1.96 by root, Fri Jan 13 12:40:46 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.84 by root, Wed Jan 4 05:35:34 2006 UTC vs.
Revision 1.96 by root, Fri Jan 13 12:40:46 2006 UTC