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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.66 by root, Thu Jun 30 14:02:17 2005 UTC vs.
Revision 1.84 by root, Wed Jan 4 05:35:34 2006 UTC

…		…
105		105
106	=item B<-j>\|B<+j>	106	=item B<-j>\|B<+j>
107		107
108	Turn on/off jump scrolling; resource B<jumpScroll>.	108	Turn on/off jump scrolling; resource B<jumpScroll>.
109		109
110	=item B<-ip>\|B<+ip>	110	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>
111		111
112	Turn on/off inheriting parent window's pixmap. Alternative form is	112	Turn on/off inheriting parent window's pixmap. Alternative form is
113	B<-tr>; resource B<inheritPixmap>.	113	B<-tr>; resource B<inheritPixmap>.
114		114
115	=item B<-fade> I<number>	115	=item B<-fade> I<number>
116		116
117	Fade the text by the given percentage when focus is lost. resource B<fading>.	117	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
		119	colour; resource B<fading>.
		120
		121	=item B<-fadecolor> I<colour>
		122
		123	Fade to this colour when fading is used (see B<-fade>). The default colour
		124	is black. resource B<fadeColor>.
118		125
119	=item B<-tint> I<colour>	126	=item B<-tint> I<colour>
120		127
121	Tint the transparent background pixmap with the given colour when	128	Tint the transparent background pixmap with the given colour when
122	transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>	129	transparency is enabled with B<-tr> or B<-ip>. This only works for
123	option that can be used to brighten or darken the image in addition to	130	non-tiled backgrounds, currently. See also the B<-sh> option that can be
124	tinting it.	131	used to brighten or darken the image in addition to tinting it; resource
		132	I<tintColor>. Example:
		133
		134	@@RXVT_NAME@@ -tr -tint blue -sh 40
125		135
126	=item B<-sh>	136	=item B<-sh>
127		137
128	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	138	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
129	background image in addition to tinting it (i.e. B<-tint> must be	139	background image in addition to tinting it (i.e. B<-tint> must be
…		…
179	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
180	section of @@RXVT_NAME@@(7).	190	section of @@RXVT_NAME@@(7).
181		191
182	=item B<-fb> I<fontlist>	192	=item B<-fb> I<fontlist>
183		193
184	Compile font-styles: The bold font list to use when bold characters are to	194	Compile font-styles: The bold font list to use when B<bold> characters are to
185	be printed. See resource B<boldFont> for details.	195	be printed. See resource B<boldFont> for details.
186		196
187	=item B<-fi> I<fontlist>	197	=item B<-fi> I<fontlist>
188		198
189	Compile font-styles: The italic font list to use when bold characters are to	199	Compile font-styles: The italic font list to use when I<italic> characters are to
190	be printed. See resource B<italicFont> for details.	200	be printed. See resource B<italicFont> for details.
191		201
192	=item B<-fbi> I<fontlist>	202	=item B<-fbi> I<fontlist>
193		203
194	Compile font-styles: The bold italic font list to use when bold characters are to	204	Compile font-styles: The bold italic font list to use when B<< I<bold
195	be printed. See resource B<boldItalicFont> for details.	205	italic> >> characters are to be printed. See resource B<boldItalicFont>
		206	for details.
		207
		208	=item B<-is>\|B<+is>
		209
		210	Compile font-styles: Bold/Italic font styles imply high intensity
		211	foreground/background (default). See resource B<intensityStyles> for
		212	details.
196		213
197	=item B<-name> I<name>	214	=item B<-name> I<name>
198		215
199	Specify the application name under which resources are to be obtained,	216	Specify the application name under which resources are to be obtained,
200	rather than the default executable file name. Name should not contain	217	rather than the default executable file name. Name should not contain
…		…
303	given on the command line. If this option is used, it must be the last	320	given on the command line. If this option is used, it must be the last
304	on the command-line. If there is no B<-e> option then the default is to	321	on the command-line. If there is no B<-e> option then the default is to
305	run the program specified by the B<SHELL> environment variable or,	322	run the program specified by the B<SHELL> environment variable or,
306	failing that, I<sh(1)>.	323	failing that, I<sh(1)>.
307		324
		325	Please note that you must specify a program with arguments. If you want to
		326	run shell commands, you have to specify the shell, like this:
		327
		328	@@RXVT_NAME@@ -e sh -c "shell commands"
		329
308	=item B<-title> I<text>	330	=item B<-title> I<text>
309		331
310	Window title (B<-T> still respected); the default title is the basename	332	Window title (B<-T> still respected); the default title is the basename
311	of the program specified after the B<-e> option, if any, otherwise the	333	of the program specified after the B<-e> option, if any, otherwise the
312	application name; resource B<title>.	334	application name; resource B<title>.
…		…
367		389
368	=item B<-ssr>\|B<+ssr>	390	=item B<-ssr>\|B<+ssr>
369		391
370	Turn on/off secondary screen scroll (default enabled); resource	392	Turn on/off secondary screen scroll (default enabled); resource
371	B<secondaryScroll>.	393	B<secondaryScroll>.
		394
		395	=item B<-hold>\|B<+hold>
		396
		397	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		398	will not immediately destroy its window when the program executed within
		399	it exits. Instead, it will wait till it is being killed or closed by the
		400	user; resource B<hold>.
372		401
373	=item B<-keysym.>I<sym> I<string>	402	=item B<-keysym.>I<sym> I<string>
374		403
375	Remap a key symbol. See resource B<keysym>.	404	Remap a key symbol. See resource B<keysym>.
376		405
…		…
424	close $pty;	453	close $pty;
425		454
426	# now communicate with rxvt	455	# now communicate with rxvt
427	my $slave = $pty->slave;	456	my $slave = $pty->slave;
428	while (<$slave>) { print $slave "got <$_>\n" }	457	while (<$slave>) { print $slave "got <$_>\n" }
		458
		459	=item B<-pe> I<string>
		460
		461	Colon-separated list of perl extension scripts to use in this terminal
		462	instance. See resource B<perl-ext>.
429		463
430	=back	464	=back
431		465
432	=head1 RESOURCES (available also as long-options)	466	=head1 RESOURCES (available also as long-options)
433		467
…		…
548	artificial transparency. B<False>: do not inherit the parent windows'	582	artificial transparency. B<False>: do not inherit the parent windows'
549	pixmap.	583	pixmap.
550		584
551	=item B<fading:> I<number>	585	=item B<fading:> I<number>
552		586
553	Fade the text by the given percentage when focus is lost.	587	Fade the text by the given percentage when focus is lost; option B<-fade>.
		588
		589	=item B<fadeColor:> I<colour>
		590
		591	Fade to this colour, when fading is used (see B<fading:>). The default
		592	colour is black; option B<-fadecolor>.
554		593
555	=item B<tintColor:> I<colour>	594	=item B<tintColor:> I<colour>
556		595
557	Tint the transparent background pixmap with the given colour.	596	Tint the transparent background pixmap with the given colour; option
		597	B<-tint>.
558		598
559	=item B<shading:> I<number>	599	=item B<shading:> I<number>
560		600
561	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	601	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
562	image in addition to tinting it.	602	image in addition to tinting it.
…		…
603		643
604	Select the fonts to be used. This is a comma separated list of font	644	Select the fonts to be used. This is a comma separated list of font
605	names that are used in turn when trying to display Unicode characters.	645	names that are used in turn when trying to display Unicode characters.
606	The first font defines the cell size for characters; other fonts might	646	The first font defines the cell size for characters; other fonts might
607	be smaller, but not larger. A reasonable default font list is always	647	be smaller, but not larger. A reasonable default font list is always
608	appended to it. option B<-fn>.	648	appended to it; option B<-fn>.
609		649
610	Each font can either be a standard X11 core font (XLFD) name, with	650	Each font can either be a standard X11 core font (XLFD) name, with
611	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.	651	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
612		652
613	In addition, each font can be prefixed with additional hints and	653	In addition, each font can be prefixed with additional hints and
…		…
659	not possible, replacement fonts of the desired shape will be tried.	699	not possible, replacement fonts of the desired shape will be tried.
660		700
661	If set, but empty, then this specific style is disabled and the normal	701	If set, but empty, then this specific style is disabled and the normal
662	text font will being used for the given style.	702	text font will being used for the given style.
663		703
		704	=item B<intensityStyles:> I<boolean>
		705
		706	When font styles are not enabled, or this option is enabled (B<True>,
		707	option B<-is>, the default), bold and italic font styles imply high
		708	intensity foreground/backround colours. Disabling this option (B<False>,
		709	option B<+is>) disables this behaviour, the high intensity colours are not
		710	reachable.
		711
664	=item B<selectstyle:> I<mode>	712	=item B<selectstyle:> I<mode>
665		713
666	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	714	Set mouse selection style to B<old> which is 2.20, B<oldword> which is
667	xterm style with 2.20 old word selection, or anything else which gives	715	xterm style with 2.20 old word selection, or anything else which gives
668	xterm style selection.	716	xterm style selection.
…		…
860	=item B<imLocale:> I<name>	908	=item B<imLocale:> I<name>
861		909
862	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.	910	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
863	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the	911	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
864	input extension to be able to input japanese characters while staying in	912	input extension to be able to input japanese characters while staying in
865	another locale. option B<-imlocale>.	913	another locale; option B<-imlocale>.
866		914
867	=item B<imFont:> I<fontset>	915	=item B<imFont:> I<fontset>
868		916
869	Specify the font-set used for XIM styles C<OverTheSpot> or	917	Specify the font-set used for XIM styles C<OverTheSpot> or
870	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated	918	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
…		…
875		923
876	=item B<tripleclickwords:> I<boolean>	924	=item B<tripleclickwords:> I<boolean>
877		925
878	Change the meaning of triple-click selection with the left mouse	926	Change the meaning of triple-click selection with the left mouse
879	button. Instead of selecting a full line it will extend the selection to	927	button. Instead of selecting a full line it will extend the selection to
880	the end of the logical line only. option B<-tcw>.	928	the end of the logical line only; option B<-tcw>.
881		929
882	=item B<insecure:> I<boolean>	930	=item B<insecure:> I<boolean>
883		931
884	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	932	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
885	echo arbitrary strings like the icon name or the locale. This could be	933	echo arbitrary strings like the icon name or the locale. This could be
886	abused if somebody gets 8-bit-clean access to your display, whether	934	abused if somebody gets 8-bit-clean access to your display, whether
887	throuh a mail client displaying mail bodies unfiltered or though	935	through a mail client displaying mail bodies unfiltered or through
888	write(1). Therefore, these sequences are disabled by default. (Note	936	write(1) or any other means. Therefore, these sequences are disabled by
889	that other terminals, including xterm, have these sequences	937	default. (Note that many other terminals, including xterm, have these
890	enabled by default). You can enable them by setting this boolean	938	sequences enabled by default, which doesn't make it safer, though).
891	resource or specifying B<-insecure> as an option. At the moment, this	939
892	enabled display-answer, locale, findfont, icon label and window title	940	You can enable them by setting this boolean resource or specifying
893	requests as well as dynamic menubar dispatch.	941	B<-insecure> as an option. At the moment, this enables display-answer,
		942	locale, findfont, icon label and window title requests as well as dynamic
		943	menubar dispatch.
894		944
895	=item B<modifier:> I<modifier>	945	=item B<modifier:> I<modifier>
896		946
897	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>,
898	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
…		…
912		962
913	Turn on/off secondary screen scroll (default enabled). If the this	963	Turn on/off secondary screen scroll (default enabled). If the this
914	option is enabled, scrolls on the secondary screen will change the	964	option is enabled, scrolls on the secondary screen will change the
915	scrollback buffer and switching to/from the secondary screen will	965	scrollback buffer and switching to/from the secondary screen will
916	instead scroll the screen up.	966	instead scroll the screen up.
		967
		968	=item B<hold>: I<bool>
		969
		970	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		971	will not immediately destroy its window when the program executed within
		972	it exits. Instead, it will wait till it is being killed or closed by the
		973	user.
917		974
918	=item B<keysym.>I<sym>: I<string>	975	=item B<keysym.>I<sym>: I<string>
919		976
920	Compile I<frills>: Associate I<string> with keysym I<sym>. The	977	Compile I<frills>: Associate I<string> with keysym I<sym>. The
921	intervening resource name B<keysym.> cannot be omitted.	978	intervening resource name B<keysym.> cannot be omitted.
…		…
966	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1023	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
967	example the following means "change the current locale to C<zh_CN.GBK>	1024	example the following means "change the current locale to C<zh_CN.GBK>
968	when Control-Meta-c is being pressed":	1025	when Control-Meta-c is being pressed":
969		1026
970	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1027	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		1028
		1029	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1030	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1031	manpage. For example, the F<selection> extension (activated via
		1032	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1033
		1034	URxvt.keysym.M-C-c: perl:selection:rot13
971		1035
972	Due the the large number of modifier combinations, a defined key mapping	1036	Due the the large number of modifier combinations, a defined key mapping
973	will match if at I<at least> the specified identifiers are being set, and	1037	will match if at I<at least> the specified identifiers are being set, and
974	no other key mappings with those and more bits are being defined. That	1038	no other key mappings with those and more bits are being defined. That
975	means that defining a key map for C<a> will automatically provide	1039	means that defining a key map for C<a> will automatically provide
…		…
999	info):	1063	info):
1000		1064
1001	URxvt.keysym.M-C-3: command:\033[8;25;80t	1065	URxvt.keysym.M-C-3: command:\033[8;25;80t
1002	URxvt.keysym.M-C-4: command:\033[8;48;110t	1066	URxvt.keysym.M-C-4: command:\033[8;48;110t
1003		1067
		1068	=item B<perl-ext-common>: I<string>
		1069
		1070	=item B<perl-ext>: I<string>
		1071
		1072	Colon-separated list(s) of perl extension scripts to use in this terminal
		1073	instance. Each extension is looked up in the library directories, loaded
		1074	if necessary, and bound to the current terminal instance. If this
		1075	resource is empty or missing, then the perl interpreter will not be
		1076	initialized. The idea behind two options is that B<perl-ext-common> will
		1077	be used for extensions that should be available to all instances, while
		1078	B<perl-ext> is used for specific instances; option B<-pe>.
		1079
		1080	=item B<perl-eval>: I<string>
		1081
		1082	Perl code to be evaluated when all extensions have been registered. See the
		1083	@@RXVT_NAME@@perl(3) manpage.
		1084
		1085	=item B<perl-lib>: I<path>
		1086
		1087	Colon-separated list of additional directories that hold extension
		1088	scripts. When looking for extensions specified by the C<perl> resource,
		1089	@@RXVT_NAME@@ will first look in these directories and then in
		1090	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
		1091
		1092	See the @@RXVT_NAME@@perl(3) manpage.
		1093
1004	=back	1094	=back
1005		1095
1006	=head1 THE SCROLLBAR	1096	=head1 THE SCROLLBAR
1007		1097
1008	Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window	1098	Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
…		…
1042	to select a word; Left triple-click to select the entire logical line	1132	to select a word; Left triple-click to select the entire logical line
1043	(which can span multiple screen lines), unless modified by resource	1133	(which can span multiple screen lines), unless modified by resource
1044	B<tripleclickwords>.	1134	B<tripleclickwords>.
1045		1135
1046	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1136	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
1047	(Compile: I<frills>) will create a rectangular selection instead of a normal	1137	(Compile: I<frills>) will create a rectangular selection instead of a
1048	one.	1138	normal one. In this mode, every selected row becomes its own line in the
		1139	selection, and trailing whitespace is visually underlined and removed from
		1140	the selection.
1049		1141
1050	=item B<Insertion>:	1142	=item B<Insertion>:
1051		1143
1052	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1144	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
1053	an B<@@RXVT_NAME@@> window causes the current text selection to be	1145	an B<@@RXVT_NAME@@> window causes the current text selection to be
…		…
1061	supported in rxvt-unicode. Bug me if you need this.	1153	supported in rxvt-unicode. Bug me if you need this.
1062		1154
1063	You can, however, switch fonts at runtime using escape sequences (and	1155	You can, however, switch fonts at runtime using escape sequences (and
1064	therefore using the menubar), e.g.:	1156	therefore using the menubar), e.g.:
1065		1157
1066	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1158	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1067		1159
1068	rxvt-unicode will automatically re-apply these fonts to the output so far.	1160	rxvt-unicode will automatically re-apply these fonts to the output so far.
1069		1161
1070	=head1 ISO 14755 SUPPORT	1162	=head1 ISO 14755 SUPPORT
1071		1163
…		…
1247	=item B<RXVT_SOCKET>	1339	=item B<RXVT_SOCKET>
1248		1340
1249	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1341	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1250	@@RXVT_NAME@@d(1).	1342	@@RXVT_NAME@@d(1).
1251		1343
1252	Default C<< $HOME/.rxvt-unicode-<nodename >>.	1344	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1253		1345
1254	=item B<HOME>	1346	=item B<HOME>
1255		1347
1256	Used to locate the default directory for the unix domain socket for	1348	Used to locate the default directory for the unix domain socket for
1257	daemon communications and to locate various resource files (such as	1349	daemon communications and to locate various resource files (such as
…		…
1278		1370
1279	=back	1371	=back
1280		1372
1281	=head1 SEE ALSO	1373	=head1 SEE ALSO
1282		1374
1283	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1375	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1284
1285	=head1 BUGS
1286
1287	Check the BUGS file for an up-to-date list.
1288
1289	Cursor change support is not yet implemented.
1290
1291	Click-and-drag doesn't work with X11 mouse report overriding.
1292		1376
1293	=head1 CURRENT PROJECT COORDINATOR	1377	=head1 CURRENT PROJECT COORDINATOR
1294		1378
1295	=over 4	1379	=over 4
1296		1380

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.66 by root, Thu Jun 30 14:02:17 2005 UTC vs. Revision 1.84 by root, Wed Jan 4 05:35:34 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.66 by root, Thu Jun 30 14:02:17 2005 UTC vs.
Revision 1.84 by root, Wed Jan 4 05:35:34 2006 UTC