[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.85 by root, Wed Jan 4 20:43:37 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 I<font-styles>: The bold font list to use when B<bold> characters
185	be printed. See resource B<boldFont> for details.	195	are to 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 I<font-styles>: The italic font list to use when I<italic>
190	be printed. See resource B<italicFont> for details.	200	characters are to 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 I<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 I<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
…		…
279	=item B<-bl>	296	=item B<-bl>
280		297
281	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.
282	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
283	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>.
284		308
285	=item B<-lsp> I<number>	309	=item B<-lsp> I<number>
286		310
287	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
288	the display. Useful to work around font rendering problems; resource	312	the display. Useful to work around font rendering problems; resource
…		…
303	given on the command line. If this option is used, it must be the last	327	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	328	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,	329	run the program specified by the B<SHELL> environment variable or,
306	failing that, I<sh(1)>.	330	failing that, I<sh(1)>.
307		331
		332	Please note that you must specify a program with arguments. If you want to
		333	run shell commands, you have to specify the shell, like this:
		334
		335	@@RXVT_NAME@@ -e sh -c "shell commands"
		336
308	=item B<-title> I<text>	337	=item B<-title> I<text>
309		338
310	Window title (B<-T> still respected); the default title is the basename	339	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	340	of the program specified after the B<-e> option, if any, otherwise the
312	application name; resource B<title>.	341	application name; resource B<title>.
…		…
367		396
368	=item B<-ssr>\|B<+ssr>	397	=item B<-ssr>\|B<+ssr>
369		398
370	Turn on/off secondary screen scroll (default enabled); resource	399	Turn on/off secondary screen scroll (default enabled); resource
371	B<secondaryScroll>.	400	B<secondaryScroll>.
		401
		402	=item B<-hold>\|B<+hold>
		403
		404	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		405	will not immediately destroy its window when the program executed within
		406	it exits. Instead, it will wait till it is being killed or closed by the
		407	user; resource B<hold>.
372		408
373	=item B<-keysym.>I<sym> I<string>	409	=item B<-keysym.>I<sym> I<string>
374		410
375	Remap a key symbol. See resource B<keysym>.	411	Remap a key symbol. See resource B<keysym>.
376		412
…		…
424	close $pty;	460	close $pty;
425		461
426	# now communicate with rxvt	462	# now communicate with rxvt
427	my $slave = $pty->slave;	463	my $slave = $pty->slave;
428	while (<$slave>) { print $slave "got <$_>\n" }	464	while (<$slave>) { print $slave "got <$_>\n" }
		465
		466	=item B<-pe> I<string>
		467
		468	Colon-separated list of perl extension scripts to use in this terminal
		469	instance. See resource B<perl-ext>.
429		470
430	=back	471	=back
431		472
432	=head1 RESOURCES (available also as long-options)	473	=head1 RESOURCES (available also as long-options)
433		474
…		…
548	artificial transparency. B<False>: do not inherit the parent windows'	589	artificial transparency. B<False>: do not inherit the parent windows'
549	pixmap.	590	pixmap.
550		591
551	=item B<fading:> I<number>	592	=item B<fading:> I<number>
552		593
553	Fade the text by the given percentage when focus is lost.	594	Fade the text by the given percentage when focus is lost; option B<-fade>.
		595
		596	=item B<fadeColor:> I<colour>
		597
		598	Fade to this colour, when fading is used (see B<fading:>). The default
		599	colour is black; option B<-fadecolor>.
554		600
555	=item B<tintColor:> I<colour>	601	=item B<tintColor:> I<colour>
556		602
557	Tint the transparent background pixmap with the given colour.	603	Tint the transparent background pixmap with the given colour; option
		604	B<-tint>.
558		605
559	=item B<shading:> I<number>	606	=item B<shading:> I<number>
560		607
561	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	608	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
562	image in addition to tinting it.	609	image in addition to tinting it.
…		…
603		650
604	Select the fonts to be used. This is a comma separated list of font	651	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.	652	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	653	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	654	be smaller, but not larger. A reasonable default font list is always
608	appended to it. option B<-fn>.	655	appended to it; option B<-fn>.
609		656
610	Each font can either be a standard X11 core font (XLFD) name, with	657	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:>.	658	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
612		659
613	In addition, each font can be prefixed with additional hints and	660	In addition, each font can be prefixed with additional hints and
…		…
659	not possible, replacement fonts of the desired shape will be tried.	706	not possible, replacement fonts of the desired shape will be tried.
660		707
661	If set, but empty, then this specific style is disabled and the normal	708	If set, but empty, then this specific style is disabled and the normal
662	text font will being used for the given style.	709	text font will being used for the given style.
663		710
		711	=item B<intensityStyles:> I<boolean>
		712
		713	When font styles are not enabled, or this option is enabled (B<True>,
		714	option B<-is>, the default), bold and italic font styles imply high
		715	intensity foreground/backround colours. Disabling this option (B<False>,
		716	option B<+is>) disables this behaviour, the high intensity colours are not
		717	reachable.
		718
664	=item B<selectstyle:> I<mode>	719	=item B<selectstyle:> I<mode>
665		720
666	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	721	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	722	xterm style with 2.20 old word selection, or anything else which gives
668	xterm style selection.	723	xterm style selection.
…		…
778	=item B<borderLess:> I<boolean>	833	=item B<borderLess:> I<boolean>
779		834
780	Set MWM hints to request a borderless window, i.e. if honoured by the	835	Set MWM hints to request a borderless window, i.e. if honoured by the
781	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.	836	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
782		837
		838	=item B<skipBuiltinGlyphs:> I<boolean>
		839
		840	Compile I<frills>: Disable the usage of the built-in block graphics/line
		841	drawing characters and just rely on what the specified fonts provide. Use
		842	this if you have a good font and want to use its block graphic glyphs;
		843	option B<-sbg>.
		844
783	=item B<termName:> I<termname>	845	=item B<termName:> I<termname>
784		846
785	Specifies the terminal type name to be set in the B<TERM> environment	847	Specifies the terminal type name to be set in the B<TERM> environment
786	variable; option B<-tn>.	848	variable; option B<-tn>.
787		849
…		…
860	=item B<imLocale:> I<name>	922	=item B<imLocale:> I<name>
861		923
862	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.	924	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	925	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	926	input extension to be able to input japanese characters while staying in
865	another locale. option B<-imlocale>.	927	another locale; option B<-imlocale>.
866		928
867	=item B<imFont:> I<fontset>	929	=item B<imFont:> I<fontset>
868		930
869	Specify the font-set used for XIM styles C<OverTheSpot> or	931	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	932	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
…		…
875		937
876	=item B<tripleclickwords:> I<boolean>	938	=item B<tripleclickwords:> I<boolean>
877		939
878	Change the meaning of triple-click selection with the left mouse	940	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	941	button. Instead of selecting a full line it will extend the selection to
880	the end of the logical line only. option B<-tcw>.	942	the end of the logical line only; option B<-tcw>.
881		943
882	=item B<insecure:> I<boolean>	944	=item B<insecure:> I<boolean>
883		945
884	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	946	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
885	echo arbitrary strings like the icon name or the locale. This could be	947	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	948	abused if somebody gets 8-bit-clean access to your display, whether
887	throuh a mail client displaying mail bodies unfiltered or though	949	through a mail client displaying mail bodies unfiltered or through
888	write(1). Therefore, these sequences are disabled by default. (Note	950	write(1) or any other means. Therefore, these sequences are disabled by
889	that other terminals, including xterm, have these sequences	951	default. (Note that many other terminals, including xterm, have these
890	enabled by default). You can enable them by setting this boolean	952	sequences enabled by default, which doesn't make it safer, though).
891	resource or specifying B<-insecure> as an option. At the moment, this	953
892	enabled display-answer, locale, findfont, icon label and window title	954	You can enable them by setting this boolean resource or specifying
893	requests as well as dynamic menubar dispatch.	955	B<-insecure> as an option. At the moment, this enables display-answer,
		956	locale, findfont, icon label and window title requests as well as dynamic
		957	menubar dispatch.
894		958
895	=item B<modifier:> I<modifier>	959	=item B<modifier:> I<modifier>
896		960
897	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	961	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	962	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
912		976
913	Turn on/off secondary screen scroll (default enabled). If the this	977	Turn on/off secondary screen scroll (default enabled). If the this
914	option is enabled, scrolls on the secondary screen will change the	978	option is enabled, scrolls on the secondary screen will change the
915	scrollback buffer and switching to/from the secondary screen will	979	scrollback buffer and switching to/from the secondary screen will
916	instead scroll the screen up.	980	instead scroll the screen up.
		981
		982	=item B<hold>: I<bool>
		983
		984	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		985	will not immediately destroy its window when the program executed within
		986	it exits. Instead, it will wait till it is being killed or closed by the
		987	user.
917		988
918	=item B<keysym.>I<sym>: I<string>	989	=item B<keysym.>I<sym>: I<string>
919		990
920	Compile I<frills>: Associate I<string> with keysym I<sym>. The	991	Compile I<frills>: Associate I<string> with keysym I<sym>. The
921	intervening resource name B<keysym.> cannot be omitted.	992	intervening resource name B<keysym.> cannot be omitted.
…		…
966	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1037	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>	1038	example the following means "change the current locale to C<zh_CN.GBK>
968	when Control-Meta-c is being pressed":	1039	when Control-Meta-c is being pressed":
969		1040
970	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1041	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		1042
		1043	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1044	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1045	manpage. For example, the F<selection> extension (activated via
		1046	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1047
		1048	URxvt.keysym.M-C-c: perl:selection:rot13
971		1049
972	Due the the large number of modifier combinations, a defined key mapping	1050	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	1051	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	1052	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	1053	means that defining a key map for C<a> will automatically provide
…		…
999	info):	1077	info):
1000		1078
1001	URxvt.keysym.M-C-3: command:\033[8;25;80t	1079	URxvt.keysym.M-C-3: command:\033[8;25;80t
1002	URxvt.keysym.M-C-4: command:\033[8;48;110t	1080	URxvt.keysym.M-C-4: command:\033[8;48;110t
1003		1081
		1082	=item B<perl-ext-common>: I<string>
		1083
		1084	=item B<perl-ext>: I<string>
		1085
		1086	Colon-separated list(s) of perl extension scripts to use in this terminal
		1087	instance. Each extension is looked up in the library directories, loaded
		1088	if necessary, and bound to the current terminal instance. If this
		1089	resource is empty or missing, then the perl interpreter will not be
		1090	initialized. The idea behind two options is that B<perl-ext-common> will
		1091	be used for extensions that should be available to all instances, while
		1092	B<perl-ext> is used for specific instances; option B<-pe>.
		1093
		1094	=item B<perl-eval>: I<string>
		1095
		1096	Perl code to be evaluated when all extensions have been registered. See the
		1097	@@RXVT_NAME@@perl(3) manpage.
		1098
		1099	=item B<perl-lib>: I<path>
		1100
		1101	Colon-separated list of additional directories that hold extension
		1102	scripts. When looking for extensions specified by the C<perl> resource,
		1103	@@RXVT_NAME@@ will first look in these directories and then in
		1104	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
		1105
		1106	See the @@RXVT_NAME@@perl(3) manpage.
		1107
1004	=back	1108	=back
1005		1109
1006	=head1 THE SCROLLBAR	1110	=head1 THE SCROLLBAR
1007		1111
1008	Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window	1112	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	1146	to select a word; Left triple-click to select the entire logical line
1043	(which can span multiple screen lines), unless modified by resource	1147	(which can span multiple screen lines), unless modified by resource
1044	B<tripleclickwords>.	1148	B<tripleclickwords>.
1045		1149
1046	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1150	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	1151	(Compile: I<frills>) will create a rectangular selection instead of a
1048	one.	1152	normal one. In this mode, every selected row becomes its own line in the
		1153	selection, and trailing whitespace is visually underlined and removed from
		1154	the selection.
1049		1155
1050	=item B<Insertion>:	1156	=item B<Insertion>:
1051		1157
1052	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1158	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	1159	an B<@@RXVT_NAME@@> window causes the current text selection to be
…		…
1061	supported in rxvt-unicode. Bug me if you need this.	1167	supported in rxvt-unicode. Bug me if you need this.
1062		1168
1063	You can, however, switch fonts at runtime using escape sequences (and	1169	You can, however, switch fonts at runtime using escape sequences (and
1064	therefore using the menubar), e.g.:	1170	therefore using the menubar), e.g.:
1065		1171
1066	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1172	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1067		1173
1068	rxvt-unicode will automatically re-apply these fonts to the output so far.	1174	rxvt-unicode will automatically re-apply these fonts to the output so far.
1069		1175
1070	=head1 ISO 14755 SUPPORT	1176	=head1 ISO 14755 SUPPORT
1071		1177
…		…
1247	=item B<RXVT_SOCKET>	1353	=item B<RXVT_SOCKET>
1248		1354
1249	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1355	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1250	@@RXVT_NAME@@d(1).	1356	@@RXVT_NAME@@d(1).
1251		1357
1252	Default C<< $HOME/.rxvt-unicode-<nodename >>.	1358	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1253		1359
1254	=item B<HOME>	1360	=item B<HOME>
1255		1361
1256	Used to locate the default directory for the unix domain socket for	1362	Used to locate the default directory for the unix domain socket for
1257	daemon communications and to locate various resource files (such as	1363	daemon communications and to locate various resource files (such as
…		…
1278		1384
1279	=back	1385	=back
1280		1386
1281	=head1 SEE ALSO	1387	=head1 SEE ALSO
1282		1388
1283	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1389	@@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		1390
1293	=head1 CURRENT PROJECT COORDINATOR	1391	=head1 CURRENT PROJECT COORDINATOR
1294		1392
1295	=over 4	1393	=over 4
1296		1394

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.85 by root, Wed Jan 4 20:43:37 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.85 by root, Wed Jan 4 20:43:37 2006 UTC