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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.70 by root, Tue Oct 25 19:41:21 2005 UTC vs.
Revision 1.92 by root, Wed Jan 11 02:13:55 2006 UTC

…		…
189	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
190	section of @@RXVT_NAME@@(7).	190	section of @@RXVT_NAME@@(7).
191		191
192	=item B<-fb> I<fontlist>	192	=item B<-fb> I<fontlist>
193		193
194	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
195	be printed. See resource B<boldFont> for details.	195	are to be printed. See resource B<boldFont> for details.
196		196
197	=item B<-fi> I<fontlist>	197	=item B<-fi> I<fontlist>
198		198
199	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>
200	be printed. See resource B<italicFont> for details.	200	characters are to be printed. See resource B<italicFont> for details.
201		201
202	=item B<-fbi> I<fontlist>	202	=item B<-fbi> I<fontlist>
203		203
204	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
205	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.
206		213
207	=item B<-name> I<name>	214	=item B<-name> I<name>
208		215
209	Specify the application name under which resources are to be obtained,	216	Specify the application name under which resources are to be obtained,
210	rather than the default executable file name. Name should not contain	217	rather than the default executable file name. Name should not contain
…		…
289	=item B<-bl>	296	=item B<-bl>
290		297
291	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.
292	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
293	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>.
294		308
295	=item B<-lsp> I<number>	309	=item B<-lsp> I<number>
296		310
297	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
298	the display. Useful to work around font rendering problems; resource	312	the display. Useful to work around font rendering problems; resource
…		…
313	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
314	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
315	run the program specified by the B<SHELL> environment variable or,	329	run the program specified by the B<SHELL> environment variable or,
316	failing that, I<sh(1)>.	330	failing that, I<sh(1)>.
317		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
318	=item B<-title> I<text>	337	=item B<-title> I<text>
319		338
320	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
321	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
322	application name; resource B<title>.	341	application name; resource B<title>.
…		…
377		396
378	=item B<-ssr>\|B<+ssr>	397	=item B<-ssr>\|B<+ssr>
379		398
380	Turn on/off secondary screen scroll (default enabled); resource	399	Turn on/off secondary screen scroll (default enabled); resource
381	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>.
382		408
383	=item B<-keysym.>I<sym> I<string>	409	=item B<-keysym.>I<sym> I<string>
384		410
385	Remap a key symbol. See resource B<keysym>.	411	Remap a key symbol. See resource B<keysym>.
386		412
…		…
409	$rxvt->signal_connect_after (realize => sub {	435	$rxvt->signal_connect_after (realize => sub {
410	my $xid = $_[0]->window->get_xid;	436	my $xid = $_[0]->window->get_xid;
411	system "@@RXVT_NAME@@ -embed $xid &";	437	system "@@RXVT_NAME@@ -embed $xid &";
412	});	438	});
413		439
414	=item B<-pty-fd> I<fileno>	440	=item B<-pty-fd> I<file descriptor>
415		441
416	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	442	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
417	pair but instead use the given filehandle as the tty master. This is	443	pair but instead use the given filehandle as the tty master. This is
418	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator	444	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
419	without having to run a program within it.	445	without having to run a program within it.
420		446
421	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	447	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
422	entries and will not tinker with pty/tty permissions - you have to do that	448	entries and will not tinker with pty/tty permissions - you have to do that
423	yourself if you want that.	449	yourself if you want that.
424		450
		451	As an extremely special case, specifying C<-1> will completely suppress
		452	pty/tty operations.
		453
425	Here is a example in perl that illustrates how this option can be used (a	454	Here is a example in perl that illustrates how this option can be used (a
426	longer example is in F<doc/pty-fd>):	455	longer example is in F<doc/pty-fd>):
427		456
428	use IO::Pty;	457	use IO::Pty;
429	use Fcntl;	458	use Fcntl;
…		…
434	close $pty;	463	close $pty;
435		464
436	# now communicate with rxvt	465	# now communicate with rxvt
437	my $slave = $pty->slave;	466	my $slave = $pty->slave;
438	while (<$slave>) { print $slave "got <$_>\n" }	467	while (<$slave>) { print $slave "got <$_>\n" }
		468
		469	=item B<-pe> I<string>
		470
		471	Comma-separated list of perl extension scripts to use (or not to use) in
		472	this terminal instance. See resource B<perl-ext> for details.
439		473
440	=back	474	=back
441		475
442	=head1 RESOURCES (available also as long-options)	476	=head1 RESOURCES (available also as long-options)
443		477
…		…
619		653
620	Select the fonts to be used. This is a comma separated list of font	654	Select the fonts to be used. This is a comma separated list of font
621	names that are used in turn when trying to display Unicode characters.	655	names that are used in turn when trying to display Unicode characters.
622	The first font defines the cell size for characters; other fonts might	656	The first font defines the cell size for characters; other fonts might
623	be smaller, but not larger. A reasonable default font list is always	657	be smaller, but not larger. A reasonable default font list is always
624	appended to it. option B<-fn>.	658	appended to it; option B<-fn>.
625		659
626	Each font can either be a standard X11 core font (XLFD) name, with	660	Each font can either be a standard X11 core font (XLFD) name, with
627	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.	661	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
628		662
629	In addition, each font can be prefixed with additional hints and	663	In addition, each font can be prefixed with additional hints and
…		…
675	not possible, replacement fonts of the desired shape will be tried.	709	not possible, replacement fonts of the desired shape will be tried.
676		710
677	If set, but empty, then this specific style is disabled and the normal	711	If set, but empty, then this specific style is disabled and the normal
678	text font will being used for the given style.	712	text font will being used for the given style.
679		713
		714	=item B<intensityStyles:> I<boolean>
		715
		716	When font styles are not enabled, or this option is enabled (B<True>,
		717	option B<-is>, the default), bold and italic font styles imply high
		718	intensity foreground/backround colours. Disabling this option (B<False>,
		719	option B<+is>) disables this behaviour, the high intensity colours are not
		720	reachable.
		721
680	=item B<selectstyle:> I<mode>	722	=item B<selectstyle:> I<mode>
681		723
682	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	724	Set mouse selection style to B<old> which is 2.20, B<oldword> which is
683	xterm style with 2.20 old word selection, or anything else which gives	725	xterm style with 2.20 old word selection, or anything else which gives
684	xterm style selection.	726	xterm style selection.
…		…
794	=item B<borderLess:> I<boolean>	836	=item B<borderLess:> I<boolean>
795		837
796	Set MWM hints to request a borderless window, i.e. if honoured by the	838	Set MWM hints to request a borderless window, i.e. if honoured by the
797	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.	839	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
798		840
		841	=item B<skipBuiltinGlyphs:> I<boolean>
		842
		843	Compile I<frills>: Disable the usage of the built-in block graphics/line
		844	drawing characters and just rely on what the specified fonts provide. Use
		845	this if you have a good font and want to use its block graphic glyphs;
		846	option B<-sbg>.
		847
799	=item B<termName:> I<termname>	848	=item B<termName:> I<termname>
800		849
801	Specifies the terminal type name to be set in the B<TERM> environment	850	Specifies the terminal type name to be set in the B<TERM> environment
802	variable; option B<-tn>.	851	variable; option B<-tn>.
803		852
…		…
876	=item B<imLocale:> I<name>	925	=item B<imLocale:> I<name>
877		926
878	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.	927	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
879	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the	928	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
880	input extension to be able to input japanese characters while staying in	929	input extension to be able to input japanese characters while staying in
881	another locale. option B<-imlocale>.	930	another locale; option B<-imlocale>.
882		931
883	=item B<imFont:> I<fontset>	932	=item B<imFont:> I<fontset>
884		933
885	Specify the font-set used for XIM styles C<OverTheSpot> or	934	Specify the font-set used for XIM styles C<OverTheSpot> or
886	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated	935	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
…		…
891		940
892	=item B<tripleclickwords:> I<boolean>	941	=item B<tripleclickwords:> I<boolean>
893		942
894	Change the meaning of triple-click selection with the left mouse	943	Change the meaning of triple-click selection with the left mouse
895	button. Instead of selecting a full line it will extend the selection to	944	button. Instead of selecting a full line it will extend the selection to
896	the end of the logical line only. option B<-tcw>.	945	the end of the logical line only; option B<-tcw>.
897		946
898	=item B<insecure:> I<boolean>	947	=item B<insecure:> I<boolean>
899		948
900	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	949	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
901	echo arbitrary strings like the icon name or the locale. This could be	950	echo arbitrary strings like the icon name or the locale. This could be
902	abused if somebody gets 8-bit-clean access to your display, whether	951	abused if somebody gets 8-bit-clean access to your display, whether
903	throuh a mail client displaying mail bodies unfiltered or though	952	through a mail client displaying mail bodies unfiltered or through
904	write(1). Therefore, these sequences are disabled by default. (Note	953	write(1) or any other means. Therefore, these sequences are disabled by
905	that other terminals, including xterm, have these sequences	954	default. (Note that many other terminals, including xterm, have these
906	enabled by default). You can enable them by setting this boolean	955	sequences enabled by default, which doesn't make it safer, though).
907	resource or specifying B<-insecure> as an option. At the moment, this	956
908	enabled display-answer, locale, findfont, icon label and window title	957	You can enable them by setting this boolean resource or specifying
909	requests as well as dynamic menubar dispatch.	958	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
		960	menubar dispatch.
910		961
911	=item B<modifier:> I<modifier>	962	=item B<modifier:> I<modifier>
912		963
913	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	964	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
914	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	965	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
928		979
929	Turn on/off secondary screen scroll (default enabled). If the this	980	Turn on/off secondary screen scroll (default enabled). If the this
930	option is enabled, scrolls on the secondary screen will change the	981	option is enabled, scrolls on the secondary screen will change the
931	scrollback buffer and switching to/from the secondary screen will	982	scrollback buffer and switching to/from the secondary screen will
932	instead scroll the screen up.	983	instead scroll the screen up.
		984
		985	=item B<hold>: I<bool>
		986
		987	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		988	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
		990	user.
933		991
934	=item B<keysym.>I<sym>: I<string>	992	=item B<keysym.>I<sym>: I<string>
935		993
936	Compile I<frills>: Associate I<string> with keysym I<sym>. The	994	Compile I<frills>: Associate I<string> with keysym I<sym>. The
937	intervening resource name B<keysym.> cannot be omitted.	995	intervening resource name B<keysym.> cannot be omitted.
…		…
982	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1040	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
983	example the following means "change the current locale to C<zh_CN.GBK>	1041	example the following means "change the current locale to C<zh_CN.GBK>
984	when Control-Meta-c is being pressed":	1042	when Control-Meta-c is being pressed":
985		1043
986	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1044	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		1045
		1046	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1047	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1048	manpage. For example, the F<selection> extension (activated via
		1049	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1050
		1051	URxvt.keysym.M-C-c: perl:selection:rot13
987		1052
988	Due the the large number of modifier combinations, a defined key mapping	1053	Due the the large number of modifier combinations, a defined key mapping
989	will match if at I<at least> the specified identifiers are being set, and	1054	will match if at I<at least> the specified identifiers are being set, and
990	no other key mappings with those and more bits are being defined. That	1055	no other key mappings with those and more bits are being defined. That
991	means that defining a key map for C<a> will automatically provide	1056	means that defining a key map for C<a> will automatically provide
…		…
1015	info):	1080	info):
1016		1081
1017	URxvt.keysym.M-C-3: command:\033[8;25;80t	1082	URxvt.keysym.M-C-3: command:\033[8;25;80t
1018	URxvt.keysym.M-C-4: command:\033[8;48;110t	1083	URxvt.keysym.M-C-4: command:\033[8;48;110t
1019		1084
		1085	=item B<perl-ext-common>: I<string>
		1086
		1087	=item B<perl-ext>: I<string>
		1088
		1089	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1090	use in this terminal instance; option B<-pe>.
		1091
		1092	Extension names can be prefixed with a C<-> sign to prohibit using
		1093	them. This can be useful to selectively disable some extensions loaded
		1094	by default, or specified via the C<perl-ext-common> resource. For
		1095	example, C<default,-selection> will use all the default extension except
		1096	C<selection>.
		1097
		1098	Extension names can also be followed by an argument in angle brackets
		1099	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1100	searchable scorllback to Alt/Meta-s). Mentioning the same extension
		1101	multiple times with different arguments will pass multiple arguments to
		1102	the extension.
		1103
		1104	Each extension is looked up in the library directories, loaded if
		1105	necessary, and bound to the current terminal instance.
		1106
		1107	If both of these resources are the empty string, then the perl
		1108	interpreter will not be initialized. The idea behind two options is that
		1109	B<perl-ext-common> will be used for extensions that should be available to
		1110	all instances, while B<perl-ext> is used for specific instances.
		1111
		1112	=item B<perl-eval>: I<string>
		1113
		1114	Perl code to be evaluated when all extensions have been registered. See
		1115	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
		1116	will be ignored when running setuid/setgid.
		1117
		1118	=item B<perl-lib>: I<path>
		1119
		1120	Colon-separated list of additional directories that hold extension
		1121	scripts. When looking for extensions specified by the C<perl> resource,
		1122	@@RXVT_NAME@@ will first look in these directories and then in
		1123	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
		1124	will be ignored when running setuid/setgid.
		1125
		1126	See the @@RXVT_NAME@@perl(3) manpage.
		1127
		1128	=item B<urlLauncher>: I<string>
		1129
		1130	Specifies the program to be started with a URL argument. Used by the
		1131	C<selection-popup> and C<mark-urls> perl extensions.
		1132
		1133	=item B<transient-for>: I<windowid>
		1134
		1135	Sets the WM_TRANSIENT_FOR property to the given window iw.
		1136
1020	=back	1137	=back
1021		1138
1022	=head1 THE SCROLLBAR	1139	=head1 THE SCROLLBAR
1023		1140
1024	Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window	1141	Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
…		…
1058	to select a word; Left triple-click to select the entire logical line	1175	to select a word; Left triple-click to select the entire logical line
1059	(which can span multiple screen lines), unless modified by resource	1176	(which can span multiple screen lines), unless modified by resource
1060	B<tripleclickwords>.	1177	B<tripleclickwords>.
1061		1178
1062	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1179	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
1063	(Compile: I<frills>) will create a rectangular selection instead of a normal	1180	(Compile: I<frills>) will create a rectangular selection instead of a
1064	one.	1181	normal one. In this mode, every selected row becomes its own line in the
		1182	selection, and trailing whitespace is visually underlined and removed from
		1183	the selection.
1065		1184
1066	=item B<Insertion>:	1185	=item B<Insertion>:
1067		1186
1068	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1187	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
1069	an B<@@RXVT_NAME@@> window causes the current text selection to be	1188	an B<@@RXVT_NAME@@> window causes the current text selection to be
…		…
1077	supported in rxvt-unicode. Bug me if you need this.	1196	supported in rxvt-unicode. Bug me if you need this.
1078		1197
1079	You can, however, switch fonts at runtime using escape sequences (and	1198	You can, however, switch fonts at runtime using escape sequences (and
1080	therefore using the menubar), e.g.:	1199	therefore using the menubar), e.g.:
1081		1200
1082	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1201	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1083		1202
1084	rxvt-unicode will automatically re-apply these fonts to the output so far.	1203	rxvt-unicode will automatically re-apply these fonts to the output so far.
1085		1204
1086	=head1 ISO 14755 SUPPORT	1205	=head1 ISO 14755 SUPPORT
1087		1206
…		…
1296		1415
1297	=head1 SEE ALSO	1416	=head1 SEE ALSO
1298		1417
1299	@@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)	1418	@@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)
1300		1419
1301	=head1 BUGS
1302
1303	Check the BUGS file for an up-to-date list.
1304
1305	Cursor change support is not yet implemented.
1306
1307	Click-and-drag doesn't work with X11 mouse report overriding.
1308
1309	=head1 CURRENT PROJECT COORDINATOR	1420	=head1 CURRENT PROJECT COORDINATOR
1310		1421
1311	=over 4	1422	=over 4
1312		1423
1313	=item Project Coordinator	1424	=item Project Coordinator

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.70 by root, Tue Oct 25 19:41:21 2005 UTC vs. Revision 1.92 by root, Wed Jan 11 02:13:55 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.70 by root, Tue Oct 25 19:41:21 2005 UTC vs.
Revision 1.92 by root, Wed Jan 11 02:13:55 2006 UTC