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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.64 by root, Fri Jun 17 12:05:31 2005 UTC vs.
Revision 1.83 by root, Tue Jan 3 22:28:07 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 instance. See resource B<perl-ext>.
429		462
430	=back	463	=back
431		464
432	=head1 RESOURCES (available also as long-options)	465	=head1 RESOURCES (available also as long-options)
433		466
…		…
548	artificial transparency. B<False>: do not inherit the parent windows'	581	artificial transparency. B<False>: do not inherit the parent windows'
549	pixmap.	582	pixmap.
550		583
551	=item B<fading:> I<number>	584	=item B<fading:> I<number>
552		585
553	Fade the text by the given percentage when focus is lost.	586	Fade the text by the given percentage when focus is lost; option B<-fade>.
		587
		588	=item B<fadeColor:> I<colour>
		589
		590	Fade to this colour, when fading is used (see B<fading:>). The default
		591	colour is black; option B<-fadecolor>.
554		592
555	=item B<tintColor:> I<colour>	593	=item B<tintColor:> I<colour>
556		594
557	Tint the transparent background pixmap with the given colour.	595	Tint the transparent background pixmap with the given colour; option
		596	B<-tint>.
558		597
559	=item B<shading:> I<number>	598	=item B<shading:> I<number>
560		599
561	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	600	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
562	image in addition to tinting it.	601	image in addition to tinting it.
…		…
603		642
604	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
605	names that are used in turn when trying to display Unicode characters.	644	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	645	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	646	be smaller, but not larger. A reasonable default font list is always
608	appended to it. option B<-fn>.	647	appended to it; option B<-fn>.
609		648
610	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
611	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:>.
612		651
613	In addition, each font can be prefixed with additional hints and	652	In addition, each font can be prefixed with additional hints and
…		…
659	not possible, replacement fonts of the desired shape will be tried.	698	not possible, replacement fonts of the desired shape will be tried.
660		699
661	If set, but empty, then this specific style is disabled and the normal	700	If set, but empty, then this specific style is disabled and the normal
662	text font will being used for the given style.	701	text font will being used for the given style.
663		702
		703	=item B<intensityStyles:> I<boolean>
		704
		705	When font styles are not enabled, or this option is enabled (B<True>,
		706	option B<-is>, the default), bold and italic font styles imply high
		707	intensity foreground/backround colours. Disabling this option (B<False>,
		708	option B<+is>) disables this behaviour, the high intensity colours are not
		709	reachable.
		710
664	=item B<selectstyle:> I<mode>	711	=item B<selectstyle:> I<mode>
665		712
666	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	713	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	714	xterm style with 2.20 old word selection, or anything else which gives
668	xterm style selection.	715	xterm style selection.
…		…
709	=item B<print-pipe:> I<string>	756	=item B<print-pipe:> I<string>
710		757
711	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	758	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
712	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or	759	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
713	B<Shift-Print> to include the scrollback as well.	760	B<Shift-Print> to include the scrollback as well.
		761
		762	The string will be interpreted as if typed into the shell as-is.
		763
		764	Example:
		765
		766	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		767
		768	This creates a new file in your home directory with the screen contents
		769	everytime you hit C<Print>.
714		770
715	=item B<scrollBar:> I<boolean>	771	=item B<scrollBar:> I<boolean>
716		772
717	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	773	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
718	disable the scrollbar; option B<+sb>.	774	disable the scrollbar; option B<+sb>.
…		…
851	=item B<imLocale:> I<name>	907	=item B<imLocale:> I<name>
852		908
853	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.	909	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
854	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the	910	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
855	input extension to be able to input japanese characters while staying in	911	input extension to be able to input japanese characters while staying in
856	another locale. option B<-imlocale>.	912	another locale; option B<-imlocale>.
857		913
858	=item B<imFont:> I<fontset>	914	=item B<imFont:> I<fontset>
859		915
860	Specify the font-set used for XIM styles C<OverTheSpot> or	916	Specify the font-set used for XIM styles C<OverTheSpot> or
861	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated	917	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
…		…
866		922
867	=item B<tripleclickwords:> I<boolean>	923	=item B<tripleclickwords:> I<boolean>
868		924
869	Change the meaning of triple-click selection with the left mouse	925	Change the meaning of triple-click selection with the left mouse
870	button. Instead of selecting a full line it will extend the selection to	926	button. Instead of selecting a full line it will extend the selection to
871	the end of the logical line only. option B<-tcw>.	927	the end of the logical line only; option B<-tcw>.
872		928
873	=item B<insecure:> I<boolean>	929	=item B<insecure:> I<boolean>
874		930
875	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	931	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
876	echo arbitrary strings like the icon name or the locale. This could be	932	echo arbitrary strings like the icon name or the locale. This could be
877	abused if somebody gets 8-bit-clean access to your display, whether	933	abused if somebody gets 8-bit-clean access to your display, whether
878	throuh a mail client displaying mail bodies unfiltered or though	934	through a mail client displaying mail bodies unfiltered or through
879	write(1). Therefore, these sequences are disabled by default. (Note	935	write(1) or any other means. Therefore, these sequences are disabled by
880	that other terminals, including xterm, have these sequences	936	default. (Note that many other terminals, including xterm, have these
881	enabled by default). You can enable them by setting this boolean	937	sequences enabled by default, which doesn't make it safer, though).
882	resource or specifying B<-insecure> as an option. At the moment, this	938
883	enabled display-answer, locale, findfont, icon label and window title	939	You can enable them by setting this boolean resource or specifying
884	requests as well as dynamic menubar dispatch.	940	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
		942	menubar dispatch.
885		943
886	=item B<modifier:> I<modifier>	944	=item B<modifier:> I<modifier>
887		945
888	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	946	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
889	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	947	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
903		961
904	Turn on/off secondary screen scroll (default enabled). If the this	962	Turn on/off secondary screen scroll (default enabled). If the this
905	option is enabled, scrolls on the secondary screen will change the	963	option is enabled, scrolls on the secondary screen will change the
906	scrollback buffer and switching to/from the secondary screen will	964	scrollback buffer and switching to/from the secondary screen will
907	instead scroll the screen up.	965	instead scroll the screen up.
		966
		967	=item B<hold>: I<bool>
		968
		969	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		970	will not immediately destroy its window when the program executed within
		971	it exits. Instead, it will wait till it is being killed or closed by the
		972	user.
908		973
909	=item B<keysym.>I<sym>: I<string>	974	=item B<keysym.>I<sym>: I<string>
910		975
911	Compile I<frills>: Associate I<string> with keysym I<sym>. The	976	Compile I<frills>: Associate I<string> with keysym I<sym>. The
912	intervening resource name B<keysym.> cannot be omitted.	977	intervening resource name B<keysym.> cannot be omitted.
…		…
957	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1022	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
958	example the following means "change the current locale to C<zh_CN.GBK>	1023	example the following means "change the current locale to C<zh_CN.GBK>
959	when Control-Meta-c is being pressed":	1024	when Control-Meta-c is being pressed":
960		1025
961	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1026	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		1027
		1028	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1029	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1030	manpage. For example, the F<selection> extension (activated via
		1031	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1032
		1033	URxvt.keysym.M-C-c: perl:selection:rot13
962		1034
963	Due the the large number of modifier combinations, a defined key mapping	1035	Due the the large number of modifier combinations, a defined key mapping
964	will match if at I<at least> the specified identifiers are being set, and	1036	will match if at I<at least> the specified identifiers are being set, and
965	no other key mappings with those and more bits are being defined. That	1037	no other key mappings with those and more bits are being defined. That
966	means that defining a key map for C<a> will automatically provide	1038	means that defining a key map for C<a> will automatically provide
…		…
990	info):	1062	info):
991		1063
992	URxvt.keysym.M-C-3: command:\033[8;25;80t	1064	URxvt.keysym.M-C-3: command:\033[8;25;80t
993	URxvt.keysym.M-C-4: command:\033[8;48;110t	1065	URxvt.keysym.M-C-4: command:\033[8;48;110t
994		1066
		1067	=item B<perl-ext>: I<string>
		1068
		1069	Colon-separated list of perl extension scripts to use in this terminal
		1070	instance. Each extension is looked up in the library directories, loaded
		1071	if necessary, and bound to the current terminal instance. If this resource
		1072	is empty or missing, then the perl interpreter will not be initialized;
		1073	option B<-pe>.
		1074
		1075	=item B<perl-eval>: I<string>
		1076
		1077	Perl code to be evaluated when all extensions have been registered. See the
		1078	@@RXVT_NAME@@perl(3) manpage.
		1079
		1080	=item B<perl-lib>: I<path>
		1081
		1082	Colon-separated list of additional directories that hold extension
		1083	scripts. When looking for extensions specified by the C<perl> resource,
		1084	@@RXVT_NAME@@ will first look in these directories and then in
		1085	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
		1086
		1087	See the @@RXVT_NAME@@perl(3) manpage.
		1088
995	=back	1089	=back
996		1090
997	=head1 THE SCROLLBAR	1091	=head1 THE SCROLLBAR
998		1092
999	Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window	1093	Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
…		…
1033	to select a word; Left triple-click to select the entire logical line	1127	to select a word; Left triple-click to select the entire logical line
1034	(which can span multiple screen lines), unless modified by resource	1128	(which can span multiple screen lines), unless modified by resource
1035	B<tripleclickwords>.	1129	B<tripleclickwords>.
1036		1130
1037	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1131	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
1038	(Compile: I<frills>) will create a rectangular selection instead of a normal	1132	(Compile: I<frills>) will create a rectangular selection instead of a
1039	one.	1133	normal one. In this mode, every selected row becomes its own line in the
		1134	selection, and trailing whitespace is visually underlined and removed from
		1135	the selection.
1040		1136
1041	=item B<Insertion>:	1137	=item B<Insertion>:
1042		1138
1043	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1139	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
1044	an B<@@RXVT_NAME@@> window causes the current text selection to be	1140	an B<@@RXVT_NAME@@> window causes the current text selection to be
…		…
1052	supported in rxvt-unicode. Bug me if you need this.	1148	supported in rxvt-unicode. Bug me if you need this.
1053		1149
1054	You can, however, switch fonts at runtime using escape sequences (and	1150	You can, however, switch fonts at runtime using escape sequences (and
1055	therefore using the menubar), e.g.:	1151	therefore using the menubar), e.g.:
1056		1152
1057	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1153	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1058		1154
1059	rxvt-unicode will automatically re-apply these fonts to the output so far.	1155	rxvt-unicode will automatically re-apply these fonts to the output so far.
1060		1156
1061	=head1 ISO 14755 SUPPORT	1157	=head1 ISO 14755 SUPPORT
1062		1158
…		…
1238	=item B<RXVT_SOCKET>	1334	=item B<RXVT_SOCKET>
1239		1335
1240	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1336	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1241	@@RXVT_NAME@@d(1).	1337	@@RXVT_NAME@@d(1).
1242		1338
1243	Default C<< $HOME/.rxvt-unicode-<nodename >>.	1339	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1244		1340
1245	=item B<HOME>	1341	=item B<HOME>
1246		1342
1247	Used to locate the default directory for the unix domain socket for	1343	Used to locate the default directory for the unix domain socket for
1248	daemon communications and to locate various resource files (such as	1344	daemon communications and to locate various resource files (such as
…		…
1269		1365
1270	=back	1366	=back
1271		1367
1272	=head1 SEE ALSO	1368	=head1 SEE ALSO
1273		1369
1274	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1370	@@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)
1275
1276	=head1 BUGS
1277
1278	Check the BUGS file for an up-to-date list.
1279
1280	Cursor change support is not yet implemented.
1281
1282	Click-and-drag doesn't work with X11 mouse report overriding.
1283		1371
1284	=head1 CURRENT PROJECT COORDINATOR	1372	=head1 CURRENT PROJECT COORDINATOR
1285		1373
1286	=over 4	1374	=over 4
1287		1375

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.64 by root, Fri Jun 17 12:05:31 2005 UTC vs. Revision 1.83 by root, Tue Jan 3 22:28:07 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.64 by root, Fri Jun 17 12:05:31 2005 UTC vs.
Revision 1.83 by root, Tue Jan 3 22:28:07 2006 UTC