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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.83 by root, Tue Jan 3 22:28:07 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
…		…
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 instance. See resource B<perl-ext>.	471	Comma-separated list of perl extension scripts to use (or not to use) in
		472	this terminal instance. See resource B<perl-ext> for details.
462		473
463	=back	474	=back
464		475
465	=head1 RESOURCES (available also as long-options)	476	=head1 RESOURCES (available also as long-options)
466		477
467	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	478	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
468	options) compiled into your version.	479	options) compiled into your version.
469		480
470	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
471	Xresource data: using the X libraries (Xrm*-functions) or internal	482	distribution do also load settings from the B<~/.Xresources> file when X
472	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	483	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
473	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	484	with later settings overwriting earlier ones:
474	resources using X11 tools like B<xrdb>. Many distribution do also load
475	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
476	will consult the following files/resources in order, with later settings
477	overwriting earlier ones:
478		485
479	1. system-wide app-defaults file, either locale-dependent OR global	486	1. system-wide app-defaults file, either locale-dependent OR global
480	2. app-defaults file in $XAPPLRESDIR	487	2. app-defaults file in $XAPPLRESDIR
481	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	488	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
482	4. SCREEN_RESOURCES for the current screen	489	4. SCREEN_RESOURCES for the current screen
483	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	490	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
484		491
485	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
486	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
487	set in XAPPLOADDIR/URxvt (compile-time defined: usually
488	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
489	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
490	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	492	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
491	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
492	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
493	easily configured, while the class name B<URxvt> allows resources	495	configured, while the class name B<URxvt> allows resources unique to
494	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	496	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
495	shared between different B<@@RXVT_NAME@@> configurations. If no	497	configurations. If no resources are specified, suitable defaults will
496	resources are specified, suitable defaults will be used. Command-line	498	be used. Command-line arguments can be used to override resource
497	arguments can be used to override resource settings. The following	499	settings. The following resources are supported (you might want to
498	resources are allowed:	500	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		501	extensions not documented here):
499		502
500	=over 4	503	=over 4
501		504
502	=item B<geometry:> I<geom>	505	=item B<geometry:> I<geom>
503		506
…		…
624	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
625	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
626	be magnified beyond 10 times its original size. The maximum permitted	629	be magnified beyond 10 times its original size. The maximum permitted
627	scale is 1000. [default 0x0+50+50]	630	scale is 1000. [default 0x0+50+50]
628		631
629	=item B<menu:> I<file[;tag]>
630
631	Read in the specified menu file (note the `.menu' extension is
632	optional) and also optionally specify a starting tag to find. See the
633	reference documentation for details on the syntax for the menuBar.
634
635	=item B<path:> I<path>	632	=item B<path:> I<path>
636		633
637	Specify the colon-delimited search path for finding files (XPM and	634	Specify the colon-delimited search path for finding XPM files.
638	menus), in addition to the paths specified by the B<RXVTPATH> and
639	B<PATH> environment variables.
640		635
641	=item B<font:> I<fontlist>	636	=item B<font:> I<fontlist>
642		637
643	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
644	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
645	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
646	be smaller, but not larger. A reasonable default font list is always	641	smaller, but not (in general) larger. A (hopefully) reasonable default
647	appended to it; option B<-fn>.	642	font list is always appended to it; option B<-fn>.
648		643
649	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
650	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:>.
651		646
652	In addition, each font can be prefixed with additional hints and	647	In addition, each font can be prefixed with additional hints and
…		…
654	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
655	fonts.	650	fonts.
656		651
657	For example, this font resource	652	For example, this font resource
658		653
659	URxvt*font: 9x15bold,\	654	URxvt.font: 9x15bold,\
660	-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,\
661	-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, \
662	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	657	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
663	xft:Code2000:antialias=false	658	xft:Code2000:antialias=false
664		659
…		…
761		756
762	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.
763		758
764	Example:	759	Example:
765		760
766	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	761	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
767		762
768	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
769	everytime you hit C<Print>.	764	everytime you hit C<Print>.
770		765
771	=item B<scrollBar:> I<boolean>	766	=item B<scrollBar:> I<boolean>
…		…
824		819
825	=item B<borderLess:> I<boolean>	820	=item B<borderLess:> I<boolean>
826		821
827	Set MWM hints to request a borderless window, i.e. if honoured by the	822	Set MWM hints to request a borderless window, i.e. if honoured by the
828	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.	823	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
		824
		825	=item B<skipBuiltinGlyphs:> I<boolean>
		826
		827	Compile I<frills>: Disable the usage of the built-in block graphics/line
		828	drawing characters and just rely on what the specified fonts provide. Use
		829	this if you have a good font and want to use its block graphic glyphs;
		830	option B<-sbg>.
829		831
830	=item B<termName:> I<termname>	832	=item B<termName:> I<termname>
831		833
832	Specifies the terminal type name to be set in the B<TERM> environment	834	Specifies the terminal type name to be set in the B<TERM> environment
833	variable; option B<-tn>.	835	variable; option B<-tn>.
…		…
936	default. (Note that many other terminals, including xterm, have these	938	default. (Note that many other terminals, including xterm, have these
937	sequences enabled by default, which doesn't make it safer, though).	939	sequences enabled by default, which doesn't make it safer, though).
938		940
939	You can enable them by setting this boolean resource or specifying	941	You can enable them by setting this boolean resource or specifying
940	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,
941	locale, findfont, icon label and window title requests as well as dynamic	943	locale, findfont, icon label and window title requests.
942	menubar dispatch.
943		944
944	=item B<modifier:> I<modifier>	945	=item B<modifier:> I<modifier>
945		946
946	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>,
947	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
…		…
997	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,
998	C<\000>: octal number) or verbatim control characters (C<^?>: delete,	999	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
999	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
1000	can start or end with whitespace.	1001	can start or end with whitespace.
1001		1002
1002	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
1003	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
1004	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
1005	@@RXVT_NAME@@'s own processing).	1006	processing).
1006		1007
1007	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>
1008	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1009	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
1009	should be a character not used by the strings.	1010	should be a character not used by the strings.
1010		1011
…		…
1062	info):	1063	info):
1063		1064
1064	URxvt.keysym.M-C-3: command:\033[8;25;80t	1065	URxvt.keysym.M-C-3: command:\033[8;25;80t
1065	URxvt.keysym.M-C-4: command:\033[8;48;110t	1066	URxvt.keysym.M-C-4: command:\033[8;48;110t
1066		1067
		1068	=item B<perl-ext-common>: I<string>
		1069
1067	=item B<perl-ext>: I<string>	1070	=item B<perl-ext>: I<string>
1068		1071
1069	Colon-separated list 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
1070	instance. Each extension is looked up in the library directories, loaded	1087	Each extension is looked up in the library directories, loaded if
1071	if necessary, and bound to the current terminal instance. If this resource	1088	necessary, and bound to the current terminal instance.
1072	is empty or missing, then the perl interpreter will not be initialized;	1089
1073	option B<-pe>.	1090	If both of these resources are the empty string, then the perl
		1091	interpreter will not be initialized. The idea behind two options is that
		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.
1074		1094
1075	=item B<perl-eval>: I<string>	1095	=item B<perl-eval>: I<string>
1076		1096
1077	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
1078	@@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.
1079		1100
1080	=item B<perl-lib>: I<path>	1101	=item B<perl-lib>: I<path>
1081		1102
1082	Colon-separated list of additional directories that hold extension	1103	Colon-separated list of additional directories that hold extension
1083	scripts. When looking for extensions specified by the C<perl> resource,	1104	scripts. When looking for extensions specified by the C<perl> resource,
1084	@@RXVT_NAME@@ will first look in these directories and then in	1105	@@RXVT_NAME@@ will first look in these directories and then in
1085	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.
1086		1108
1087	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.
1088		1134
1089	=back	1135	=back
1090		1136
1091	=head1 THE SCROLLBAR	1137	=head1 THE SCROLLBAR
1092		1138
…		…
1145	=head1 CHANGING FONTS	1191	=head1 CHANGING FONTS
1146		1192
1147	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
1148	supported in rxvt-unicode. Bug me if you need this.	1194	supported in rxvt-unicode. Bug me if you need this.
1149		1195
1150	You can, however, switch fonts at runtime using escape sequences (and	1196	You can, however, switch fonts at runtime using escape sequences, e.g.:
1151	therefore using the menubar), e.g.:
1152		1197
1153	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
1154		1204
1155	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.
1156		1206
1157	=head1 ISO 14755 SUPPORT	1207	=head1 ISO 14755 SUPPORT
1158		1208
…		…
1320		1370
1321	=item B<SHELL>	1371	=item B<SHELL>
1322		1372
1323	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>.
1324		1374
1325	=item B<RXVTPATH>
1326
1327	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1328	files.
1329
1330	=item B<PATH>
1331
1332	Used in the same way as C<RXVTPATH>.
1333
1334	=item B<RXVT_SOCKET>	1375	=item B<RXVT_SOCKET>
1335		1376
1336	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
1337	@@RXVT_NAME@@d(1).	1378	@@RXVT_NAME@@d(1).
1338		1379

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.83 by root, Tue Jan 3 22:28:07 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.83 by root, Tue Jan 3 22:28:07 2006 UTC vs.
Revision 1.98 by root, Mon Jan 16 15:12:48 2006 UTC