[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.82 by root, Tue Jan 3 18:11: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
…		…
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 bold characters are to
195	be printed. See resource B<boldItalicFont> for details.	205	be printed. See resource B<boldItalicFont> for details.
		206
		207	=item B<-is>\|B<+is>
		208
		209	Compile font-styles: Bold/Italic font styles imply high intensity
		210	foreground/background (default). See resource B<intensityStyles> for
		211	details.
196		212
197	=item B<-name> I<name>	213	=item B<-name> I<name>
198		214
199	Specify the application name under which resources are to be obtained,	215	Specify the application name under which resources are to be obtained,
200	rather than the default executable file name. Name should not contain	216	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	319	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	320	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,	321	run the program specified by the B<SHELL> environment variable or,
306	failing that, I<sh(1)>.	322	failing that, I<sh(1)>.
307		323
		324	Please note that you must specify a program with arguments. If you want to
		325	run shell commands, you have to specify the shell, like this:
		326
		327	@@RXVT_NAME@@ -e sh -c "shell commands"
		328
308	=item B<-title> I<text>	329	=item B<-title> I<text>
309		330
310	Window title (B<-T> still respected); the default title is the basename	331	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	332	of the program specified after the B<-e> option, if any, otherwise the
312	application name; resource B<title>.	333	application name; resource B<title>.
…		…
367		388
368	=item B<-ssr>\|B<+ssr>	389	=item B<-ssr>\|B<+ssr>
369		390
370	Turn on/off secondary screen scroll (default enabled); resource	391	Turn on/off secondary screen scroll (default enabled); resource
371	B<secondaryScroll>.	392	B<secondaryScroll>.
		393
		394	=item B<-hold>\|B<+hold>
		395
		396	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		397	will not immediately destroy its window when the program executed within
		398	it exits. Instead, it will wait till it is being killed or closed by the
		399	user; resource B<hold>.
372		400
373	=item B<-keysym.>I<sym> I<string>	401	=item B<-keysym.>I<sym> I<string>
374		402
375	Remap a key symbol. See resource B<keysym>.	403	Remap a key symbol. See resource B<keysym>.
376		404
…		…
424	close $pty;	452	close $pty;
425		453
426	# now communicate with rxvt	454	# now communicate with rxvt
427	my $slave = $pty->slave;	455	my $slave = $pty->slave;
428	while (<$slave>) { print $slave "got <$_>\n" }	456	while (<$slave>) { print $slave "got <$_>\n" }
		457
		458	=item B<-pe> I<string>
		459
		460	Colon-separated list of perl extension scripts to use in this terminal instance. See resource B<perl-ext>.
429		461
430	=back	462	=back
431		463
432	=head1 RESOURCES (available also as long-options)	464	=head1 RESOURCES (available also as long-options)
433		465
…		…
548	artificial transparency. B<False>: do not inherit the parent windows'	580	artificial transparency. B<False>: do not inherit the parent windows'
549	pixmap.	581	pixmap.
550		582
551	=item B<fading:> I<number>	583	=item B<fading:> I<number>
552		584
553	Fade the text by the given percentage when focus is lost.	585	Fade the text by the given percentage when focus is lost; option B<-fade>.
		586
		587	=item B<fadeColor:> I<colour>
		588
		589	Fade to this colour, when fading is used (see B<fading:>). The default
		590	colour is black; option B<-fadecolor>.
554		591
555	=item B<tintColor:> I<colour>	592	=item B<tintColor:> I<colour>
556		593
557	Tint the transparent background pixmap with the given colour.	594	Tint the transparent background pixmap with the given colour; option
		595	B<-tint>.
558		596
559	=item B<shading:> I<number>	597	=item B<shading:> I<number>
560		598
561	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	599	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
562	image in addition to tinting it.	600	image in addition to tinting it.
…		…
603		641
604	Select the fonts to be used. This is a comma separated list of font	642	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.	643	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	644	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	645	be smaller, but not larger. A reasonable default font list is always
608	appended to it. option B<-fn>.	646	appended to it; option B<-fn>.
609		647
610	Each font can either be a standard X11 core font (XLFD) name, with	648	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:>.	649	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
612		650
613	In addition, each font can be prefixed with additional hints and	651	In addition, each font can be prefixed with additional hints and
…		…
659	not possible, replacement fonts of the desired shape will be tried.	697	not possible, replacement fonts of the desired shape will be tried.
660		698
661	If set, but empty, then this specific style is disabled and the normal	699	If set, but empty, then this specific style is disabled and the normal
662	text font will being used for the given style.	700	text font will being used for the given style.
663		701
		702	=item B<intensityStyles:> I<boolean>
		703
		704	When font styles are not enabled, or this option is enabled (B<True>,
		705	option B<-is>, the default), bold and italic font styles imply high
		706	intensity foreground/backround colours. Disabling this option (B<False>,
		707	option B<+is>) disables this behaviour, the high intensity colours are not
		708	reachable.
		709
664	=item B<selectstyle:> I<mode>	710	=item B<selectstyle:> I<mode>
665		711
666	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	712	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	713	xterm style with 2.20 old word selection, or anything else which gives
668	xterm style selection.	714	xterm style selection.
…		…
709	=item B<print-pipe:> I<string>	755	=item B<print-pipe:> I<string>
710		756
711	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	757	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	758	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.	759	B<Shift-Print> to include the scrollback as well.
		760
		761	The string will be interpreted as if typed into the shell as-is.
		762
		763	Example:
		764
		765	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		766
		767	This creates a new file in your home directory with the screen contents
		768	everytime you hit C<Print>.
714		769
715	=item B<scrollBar:> I<boolean>	770	=item B<scrollBar:> I<boolean>
716		771
717	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	772	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
718	disable the scrollbar; option B<+sb>.	773	disable the scrollbar; option B<+sb>.
…		…
851	=item B<imLocale:> I<name>	906	=item B<imLocale:> I<name>
852		907
853	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.	908	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	909	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	910	input extension to be able to input japanese characters while staying in
856	another locale. option B<-imlocale>.	911	another locale; option B<-imlocale>.
857		912
858	=item B<imFont:> I<fontset>	913	=item B<imFont:> I<fontset>
859		914
860	Specify the font-set used for XIM styles C<OverTheSpot> or	915	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	916	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
…		…
866		921
867	=item B<tripleclickwords:> I<boolean>	922	=item B<tripleclickwords:> I<boolean>
868		923
869	Change the meaning of triple-click selection with the left mouse	924	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	925	button. Instead of selecting a full line it will extend the selection to
871	the end of the logical line only. option B<-tcw>.	926	the end of the logical line only; option B<-tcw>.
872		927
873	=item B<insecure:> I<boolean>	928	=item B<insecure:> I<boolean>
874		929
875	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	930	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
876	echo arbitrary strings like the icon name or the locale. This could be	931	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	932	abused if somebody gets 8-bit-clean access to your display, whether
878	throuh a mail client displaying mail bodies unfiltered or though	933	through a mail client displaying mail bodies unfiltered or through
879	write(1). Therefore, these sequences are disabled by default. (Note	934	write(1) or any other means. Therefore, these sequences are disabled by
880	that other terminals, including xterm, have these sequences	935	default. (Note that many other terminals, including xterm, have these
881	enabled by default). You can enable them by setting this boolean	936	sequences enabled by default, which doesn't make it safer, though).
882	resource or specifying B<-insecure> as an option. At the moment, this	937
883	enabled display-answer, locale, findfont, icon label and window title	938	You can enable them by setting this boolean resource or specifying
884	requests as well as dynamic menubar dispatch.	939	B<-insecure> as an option. At the moment, this enables display-answer,
		940	locale, findfont, icon label and window title requests as well as dynamic
		941	menubar dispatch.
885		942
886	=item B<modifier:> I<modifier>	943	=item B<modifier:> I<modifier>
887		944
888	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	945	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	946	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
903		960
904	Turn on/off secondary screen scroll (default enabled). If the this	961	Turn on/off secondary screen scroll (default enabled). If the this
905	option is enabled, scrolls on the secondary screen will change the	962	option is enabled, scrolls on the secondary screen will change the
906	scrollback buffer and switching to/from the secondary screen will	963	scrollback buffer and switching to/from the secondary screen will
907	instead scroll the screen up.	964	instead scroll the screen up.
		965
		966	=item B<hold>: I<bool>
		967
		968	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		969	will not immediately destroy its window when the program executed within
		970	it exits. Instead, it will wait till it is being killed or closed by the
		971	user.
908		972
909	=item B<keysym.>I<sym>: I<string>	973	=item B<keysym.>I<sym>: I<string>
910		974
911	Compile I<frills>: Associate I<string> with keysym I<sym>. The	975	Compile I<frills>: Associate I<string> with keysym I<sym>. The
912	intervening resource name B<keysym.> cannot be omitted.	976	intervening resource name B<keysym.> cannot be omitted.
…		…
957	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1021	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>	1022	example the following means "change the current locale to C<zh_CN.GBK>
959	when Control-Meta-c is being pressed":	1023	when Control-Meta-c is being pressed":
960		1024
961	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1025	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		1026
		1027	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1028	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1029	manpage. For example, the F<selection> extension (activated via
		1030	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1031
		1032	URxvt.keysym.M-C-c: perl:selection:rot13
962		1033
963	Due the the large number of modifier combinations, a defined key mapping	1034	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	1035	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	1036	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	1037	means that defining a key map for C<a> will automatically provide
…		…
990	info):	1061	info):
991		1062
992	URxvt.keysym.M-C-3: command:\033[8;25;80t	1063	URxvt.keysym.M-C-3: command:\033[8;25;80t
993	URxvt.keysym.M-C-4: command:\033[8;48;110t	1064	URxvt.keysym.M-C-4: command:\033[8;48;110t
994		1065
		1066	=item B<perl-ext>: I<string>
		1067
		1068	Colon-separated list of perl extension scripts to use in this terminal
		1069	instance. Each extension is looked up in the library directories, loaded
		1070	if necessary, and bound to the current terminal instance. If this resource
		1071	is empty or missing, then the perl interpreter will not be initialized;
		1072	option B<-pe>.
		1073
		1074	=item B<perl-eval>: I<string>
		1075
		1076	Perl code to be evaluated when all extensions have been registered. See the
		1077	@@RXVT_NAME@@perl(3) manpage.
		1078
		1079	=item B<perl-lib>: I<path>
		1080
		1081	Colon-separated list of additional directories that hold extension
		1082	scripts. When looking for extensions specified by the C<perl> resource,
		1083	@@RXVT_NAME@@ will first look in these directories and then in
		1084	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
		1085
		1086	See the @@RXVT_NAME@@perl(3) manpage.
		1087
995	=back	1088	=back
996		1089
997	=head1 THE SCROLLBAR	1090	=head1 THE SCROLLBAR
998		1091
999	Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window	1092	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	1126	to select a word; Left triple-click to select the entire logical line
1034	(which can span multiple screen lines), unless modified by resource	1127	(which can span multiple screen lines), unless modified by resource
1035	B<tripleclickwords>.	1128	B<tripleclickwords>.
1036		1129
1037	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1130	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	1131	(Compile: I<frills>) will create a rectangular selection instead of a
1039	one.	1132	normal one. In this mode, every selected row becomes its own line in the
		1133	selection, and trailing whitespace is visually underlined and removed from
		1134	the selection.
1040		1135
1041	=item B<Insertion>:	1136	=item B<Insertion>:
1042		1137
1043	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1138	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	1139	an B<@@RXVT_NAME@@> window causes the current text selection to be
…		…
1052	supported in rxvt-unicode. Bug me if you need this.	1147	supported in rxvt-unicode. Bug me if you need this.
1053		1148
1054	You can, however, switch fonts at runtime using escape sequences (and	1149	You can, however, switch fonts at runtime using escape sequences (and
1055	therefore using the menubar), e.g.:	1150	therefore using the menubar), e.g.:
1056		1151
1057	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1152	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1058		1153
1059	rxvt-unicode will automatically re-apply these fonts to the output so far.	1154	rxvt-unicode will automatically re-apply these fonts to the output so far.
1060		1155
1061	=head1 ISO 14755 SUPPORT	1156	=head1 ISO 14755 SUPPORT
1062		1157
…		…
1238	=item B<RXVT_SOCKET>	1333	=item B<RXVT_SOCKET>
1239		1334
1240	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1335	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1241	@@RXVT_NAME@@d(1).	1336	@@RXVT_NAME@@d(1).
1242		1337
1243	Default C<< $HOME/.rxvt-unicode-<nodename >>.	1338	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1244		1339
1245	=item B<HOME>	1340	=item B<HOME>
1246		1341
1247	Used to locate the default directory for the unix domain socket for	1342	Used to locate the default directory for the unix domain socket for
1248	daemon communications and to locate various resource files (such as	1343	daemon communications and to locate various resource files (such as
…		…
1269		1364
1270	=back	1365	=back
1271		1366
1272	=head1 SEE ALSO	1367	=head1 SEE ALSO
1273		1368
1274	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1369	@@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		1370
1284	=head1 CURRENT PROJECT COORDINATOR	1371	=head1 CURRENT PROJECT COORDINATOR
1285		1372
1286	=over 4	1373	=over 4
1287		1374

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.82 by root, Tue Jan 3 18:11:34 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.82 by root, Tue Jan 3 18:11:34 2006 UTC