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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.88 by root, Sun Jan 8 00:20:12 2006 UTC vs.
Revision 1.104 by root, Wed Jan 25 13:24:45 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
…		…
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<-override-redirect>
		303
		304	Compile I<frills>: Sets override-redirect on the window; resource
		305	B<override-redirect>.
301		306
302	=item B<-sbg>	307	=item B<-sbg>
303		308
304	Compile I<frills>: Disable the usage of the built-in block graphics/line	309	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	310	drawing characters and just rely on what the specified fonts provide. Use
…		…
476	=head1 RESOURCES (available also as long-options)	481	=head1 RESOURCES (available also as long-options)
477		482
478	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	483	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
479	options) compiled into your version.	484	options) compiled into your version.
480		485
481	There are two different methods that @@RXVT_NAME@@ can use to get the	486	You can set and change the resources using X11 tools like B<xrdb>. Many
482	Xresource data: using the X libraries (Xrm*-functions) or internal	487	distribution do also load settings from the B<~/.Xresources> file when X
483	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	488	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
484	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	489	with later settings overwriting earlier ones:
485	resources using X11 tools like B<xrdb>. Many distribution do also load
486	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
487	will consult the following files/resources in order, with later settings
488	overwriting earlier ones:
489		490
490	1. system-wide app-defaults file, either locale-dependent OR global	491	1. system-wide app-defaults file, either locale-dependent OR global
491	2. app-defaults file in $XAPPLRESDIR	492	2. app-defaults file in $XAPPLRESDIR
492	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	493	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
493	4. SCREEN_RESOURCES for the current screen	494	4. SCREEN_RESOURCES for the current screen
494	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	495	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
495		496
496	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
497	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
498	set in XAPPLOADDIR/URxvt (compile-time defined: usually
499	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
500	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
501	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	497	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
502	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows	498	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
503	resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be	499	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
504	easily configured, while the class name B<URxvt> allows resources	500	configured, while the class name B<URxvt> allows resources unique to
505	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	501	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
506	shared between different B<@@RXVT_NAME@@> configurations. If no	502	configurations. If no resources are specified, suitable defaults will
507	resources are specified, suitable defaults will be used. Command-line	503	be used. Command-line arguments can be used to override resource
508	arguments can be used to override resource settings. The following	504	settings. The following resources are supported (you might want to
509	resources are allowed:	505	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		506	extensions not documented here):
510		507
511	=over 4	508	=over 4
512		509
513	=item B<geometry:> I<geom>	510	=item B<geometry:> I<geom>
514		511
…		…
635	of 1 displays the image without any scaling. A scale of 2 to 9	632	of 1 displays the image without any scaling. A scale of 2 to 9
636	specifies an integer number of images in that direction. No image will	633	specifies an integer number of images in that direction. No image will
637	be magnified beyond 10 times its original size. The maximum permitted	634	be magnified beyond 10 times its original size. The maximum permitted
638	scale is 1000. [default 0x0+50+50]	635	scale is 1000. [default 0x0+50+50]
639		636
640	=item B<menu:> I<file[;tag]>
641
642	Read in the specified menu file (note the `.menu' extension is
643	optional) and also optionally specify a starting tag to find. See the
644	reference documentation for details on the syntax for the menuBar.
645
646	=item B<path:> I<path>	637	=item B<path:> I<path>
647		638
648	Specify the colon-delimited search path for finding files (XPM and	639	Specify the colon-delimited search path for finding XPM files.
649	menus), in addition to the paths specified by the B<RXVTPATH> and
650	B<PATH> environment variables.
651		640
652	=item B<font:> I<fontlist>	641	=item B<font:> I<fontlist>
653		642
654	Select the fonts to be used. This is a comma separated list of font	643	Select the fonts to be used. This is a comma separated list of font names
655	names that are used in turn when trying to display Unicode characters.	644	that are checked in order when trying to find glyphs for characters. The
656	The first font defines the cell size for characters; other fonts might	645	first font defines the cell size for characters; other fonts might be
657	be smaller, but not larger. A reasonable default font list is always	646	smaller, but not (in general) larger. A (hopefully) reasonable default
658	appended to it; option B<-fn>.	647	font list is always appended to it; option B<-fn>.
659		648
660	Each font can either be a standard X11 core font (XLFD) name, with	649	Each font can either be a standard X11 core font (XLFD) name, with
661	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.	650	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
662		651
663	In addition, each font can be prefixed with additional hints and	652	In addition, each font can be prefixed with additional hints and
…		…
665	hint currently is C<codeset=codeset-name>, and this is only used for Xft	654	hint currently is C<codeset=codeset-name>, and this is only used for Xft
666	fonts.	655	fonts.
667		656
668	For example, this font resource	657	For example, this font resource
669		658
670	URxvt*font: 9x15bold,\	659	URxvt.font: 9x15bold,\
671	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	660	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
672	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \	661	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
673	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	662	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
674	xft:Code2000:antialias=false	663	xft:Code2000:antialias=false
675		664
…		…
772		761
773	The string will be interpreted as if typed into the shell as-is.	762	The string will be interpreted as if typed into the shell as-is.
774		763
775	Example:	764	Example:
776		765
777	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	766	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
778		767
779	This creates a new file in your home directory with the screen contents	768	This creates a new file in your home directory with the screen contents
780	everytime you hit C<Print>.	769	everytime you hit C<Print>.
781		770
782	=item B<scrollBar:> I<boolean>	771	=item B<scrollBar:> I<boolean>
…		…
907	pressed. If unset it will send the sequence traditionally associated	896	pressed. If unset it will send the sequence traditionally associated
908	with the B<Execute> key.	897	with the B<Execute> key.
909		898
910	=item B<cutchars:> I<string>	899	=item B<cutchars:> I<string>
911		900
912	The characters used as delimiters for double-click word selection. The	901	The characters used as delimiters for double-click word selection.
913	built-in default:	902
		903	When the selection extension is in use (the default if compiled in, see
		904	the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters
		905	will be created (if the resource exists, otherwise, no regex will be
		906	created). In this mode, characters outside ISO-8859-1 can be used.
		907
		908	When the selection extension is not used, only ISO-8859-1 characters can
		909	be used. If not specified, the built-in default is used:
914		910
915	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	911	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>
916		912
917	=item B<preeditType:> I<style>	913	=item B<preeditType:> I<style>
918		914
…		…
954	default. (Note that many other terminals, including xterm, have these	950	default. (Note that many other terminals, including xterm, have these
955	sequences enabled by default, which doesn't make it safer, though).	951	sequences enabled by default, which doesn't make it safer, though).
956		952
957	You can enable them by setting this boolean resource or specifying	953	You can enable them by setting this boolean resource or specifying
958	B<-insecure> as an option. At the moment, this enables display-answer,	954	B<-insecure> as an option. At the moment, this enables display-answer,
959	locale, findfont, icon label and window title requests as well as dynamic	955	locale, findfont, icon label and window title requests.
960	menubar dispatch.
961		956
962	=item B<modifier:> I<modifier>	957	=item B<modifier:> I<modifier>
963		958
964	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	959	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
965	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	960	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
969		964
970	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	965	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
971	character is passed through. It may contain escape values as described	966	character is passed through. It may contain escape values as described
972	in the entry on B<keysym> following.	967	in the entry on B<keysym> following.
973		968
974	=item B<secondaryScreen:> I<bool>	969	=item B<secondaryScreen:> I<boolean>
975		970
976	Turn on/off secondary screen (default enabled).	971	Turn on/off secondary screen (default enabled).
977		972
978	=item B<secondaryScroll:> I<bool>	973	=item B<secondaryScroll:> I<boolean>
979		974
980	Turn on/off secondary screen scroll (default enabled). If the this	975	Turn on/off secondary screen scroll (default enabled). If the this
981	option is enabled, scrolls on the secondary screen will change the	976	option is enabled, scrolls on the secondary screen will change the
982	scrollback buffer and switching to/from the secondary screen will	977	scrollback buffer and switching to/from the secondary screen will
983	instead scroll the screen up.	978	instead scroll the screen up.
984		979
985	=item B<hold>: I<bool>	980	=item B<hold>: I<boolean>
986		981
987	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	982	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
988	will not immediately destroy its window when the program executed within	983	will not immediately destroy its window when the program executed within
989	it exits. Instead, it will wait till it is being killed or closed by the	984	it exits. Instead, it will wait till it is being killed or closed by the
990	user.	985	user.
…		…
1015	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1010	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
1016	C<\000>: octal number) or verbatim control characters (C<^?>: delete,	1011	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1017	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it	1012	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1018	can start or end with whitespace.	1013	can start or end with whitespace.
1019		1014
1020	Please note that you need to double the C<\> when using	1015	Please note that you need to double the C<\> in resource files, as
1021	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can	1016	Xlib itself does it's own de-escaping (you can use C<\033> instead of
1022	use C<\033> instead of C<\e> (and so on), which will work with both Xt and	1017	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1023	@@RXVT_NAME@@'s own processing).	1018	processing).
1024		1019
1025	You can define a range of keysyms in one shot by providing a I<string>	1020	You can define a range of keysyms in one shot by providing a I<string>
1026	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1021	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
1027	should be a character not used by the strings.	1022	should be a character not used by the strings.
1028		1023
…		…
1088		1083
1089	Comma-separated list(s) of perl extension scripts (default: C<default>) to	1084	Comma-separated list(s) of perl extension scripts (default: C<default>) to
1090	use in this terminal instance; option B<-pe>.	1085	use in this terminal instance; option B<-pe>.
1091		1086
1092	Extension names can be prefixed with a C<-> sign to prohibit using	1087	Extension names can be prefixed with a C<-> sign to prohibit using
1093	it. This can be useful to selectively disable some extensions loaded	1088	them. This can be useful to selectively disable some extensions loaded
1094	by default, or specified via the C<perl-ext-common> resource. For	1089	by default, or specified via the C<perl-ext-common> resource. For
1095	example, C<default,-selection> will use all the default extension except	1090	example, C<default,-selection> will use all the default extension except
1096	C<selection>.	1091	C<selection>.
		1092
		1093	Extension names can also be followed by an argument in angle brackets
		1094	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1095	searchable scorllback to Alt/Meta-s). Mentioning the same extension
		1096	multiple times with different arguments will pass multiple arguments to
		1097	the extension.
1097		1098
1098	Each extension is looked up in the library directories, loaded if	1099	Each extension is looked up in the library directories, loaded if
1099	necessary, and bound to the current terminal instance.	1100	necessary, and bound to the current terminal instance.
1100		1101
1101	If both of these resources are the empty string, then the perl	1102	If both of these resources are the empty string, then the perl
…		…
1103	B<perl-ext-common> will be used for extensions that should be available to	1104	B<perl-ext-common> will be used for extensions that should be available to
1104	all instances, while B<perl-ext> is used for specific instances.	1105	all instances, while B<perl-ext> is used for specific instances.
1105		1106
1106	=item B<perl-eval>: I<string>	1107	=item B<perl-eval>: I<string>
1107		1108
1108	Perl code to be evaluated when all extensions have been registered. See the	1109	Perl code to be evaluated when all extensions have been registered. See
1109	@@RXVT_NAME@@perl(3) manpage.	1110	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
		1111	will be ignored when running setuid/setgid.
1110		1112
1111	=item B<perl-lib>: I<path>	1113	=item B<perl-lib>: I<path>
1112		1114
1113	Colon-separated list of additional directories that hold extension	1115	Colon-separated list of additional directories that hold extension
1114	scripts. When looking for extensions specified by the C<perl> resource,	1116	scripts. When looking for extensions specified by the C<perl> resource,
1115	@@RXVT_NAME@@ will first look in these directories and then in	1117	@@RXVT_NAME@@ will first look in these directories and then in
1116	F<@@RXVT_LIBDIR@@/urxvt/perl/>.	1118	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
		1119	will be ignored when running setuid/setgid.
1117		1120
1118	See the @@RXVT_NAME@@perl(3) manpage.	1121	See the @@RXVT_NAME@@perl(3) manpage.
		1122
		1123	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1124
		1125	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1126	details.
		1127
		1128	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1129
		1130	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1131	for details.
		1132
		1133	=item B<searchable-scrollback:> I<keysym>
		1134
		1135	Sets the hotkey that starts the incremental scrollback buffer search
		1136	(default: C<M-s>).
		1137
		1138	=item B<urlLauncher>: I<string>
		1139
		1140	Specifies the program to be started with a URL argument. Used by the
		1141	C<selection-popup> and C<mark-urls> perl extensions.
		1142
		1143	=item B<transient-for>: I<windowid>
		1144
		1145	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1146
		1147	=item B<override-redirect>: I<boolean>
		1148
		1149	Compile I<frills>: Sets override-redirect for the terminal window, making
		1150	it almost invisible to window managers; option B<-override-redirect>.
1119		1151
1120	=back	1152	=back
1121		1153
1122	=head1 THE SCROLLBAR	1154	=head1 THE SCROLLBAR
1123		1155
…		…
1165	selection, and trailing whitespace is visually underlined and removed from	1197	selection, and trailing whitespace is visually underlined and removed from
1166	the selection.	1198	the selection.
1167		1199
1168	=item B<Insertion>:	1200	=item B<Insertion>:
1169		1201
1170	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1202	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1171	an B<@@RXVT_NAME@@> window causes the current text selection to be	1203	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1172	inserted as if it had been typed on the keyboard.	1204	Meta modifier) to be inserted as if it had been typed on the keyboard.
		1205
		1206	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1207	inserted too.
1173		1208
1174	=back	1209	=back
1175		1210
1176	=head1 CHANGING FONTS	1211	=head1 CHANGING FONTS
1177		1212
1178	Changing fonts (or font sizes, respectively) via the keypad is not yet	1213	Changing fonts (or font sizes, respectively) via the keypad is not yet
1179	supported in rxvt-unicode. Bug me if you need this.	1214	supported in rxvt-unicode. Bug me if you need this.
1180		1215
1181	You can, however, switch fonts at runtime using escape sequences (and	1216	You can, however, switch fonts at runtime using escape sequences, e.g.:
1182	therefore using the menubar), e.g.:
1183		1217
1184	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"	1218	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1219
		1220	You can use keyboard shortcuts, too:
		1221
		1222	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1223	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1185		1224
1186	rxvt-unicode will automatically re-apply these fonts to the output so far.	1225	rxvt-unicode will automatically re-apply these fonts to the output so far.
1187		1226
1188	=head1 ISO 14755 SUPPORT	1227	=head1 ISO 14755 SUPPORT
1189		1228
…		…
1351		1390
1352	=item B<SHELL>	1391	=item B<SHELL>
1353		1392
1354	The shell to be used for command execution, defaults to C</bin/sh>.	1393	The shell to be used for command execution, defaults to C</bin/sh>.
1355		1394
1356	=item B<RXVTPATH>
1357
1358	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1359	files.
1360
1361	=item B<PATH>
1362
1363	Used in the same way as C<RXVTPATH>.
1364
1365	=item B<RXVT_SOCKET>	1395	=item B<RXVT_SOCKET>
1366		1396
1367	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1397	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1368	@@RXVT_NAME@@d(1).	1398	@@RXVT_NAME@@d(1).
1369		1399
…		…
1438		1468
1439	Project Coordinator (changes.txt 2.21a to 2.4.5)	1469	Project Coordinator (changes.txt 2.21a to 2.4.5)
1440		1470
1441	=item Geoff Wing L<< <gcw@pobox.com> >>	1471	=item Geoff Wing L<< <gcw@pobox.com> >>
1442		1472
1443	Rewrote screen display and text selection routines. Project Coordinator	1473	Rewrote screen display and text selection routines.
		1474
1444	(changes.txt 2.4.6 - rxvt-unicode)	1475	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1445		1476
1446	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1477	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1447		1478
1448	Forked rxvt-unicode, rewrote most of the display code and internal	1479	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1449	character handling to store text in unicode, improve xterm	1480	extension, random hacks, numerous bugfixes and extensions.
1450	compatibility and apply numerous other bugfixes and extensions.
1451		1481
1452	Project Coordinator (Changes 1.0 -)	1482	Project Coordinator (Changes 1.0 -)
1453		1483
		1484	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1485
		1486	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
		1487
1454	=back	1488	=back
1455		1489

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.88 by root, Sun Jan 8 00:20:12 2006 UTC vs. Revision 1.104 by root, Wed Jan 25 13:24:45 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.88 by root, Sun Jan 8 00:20:12 2006 UTC vs.
Revision 1.104 by root, Wed Jan 25 13:24:45 2006 UTC