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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.65 by root, Thu Jun 30 14:00:49 2005 UTC vs.
Revision 1.99 by root, Wed Jan 18 19:43:51 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
…		…
162	resource B<borderColor>.	172	resource B<borderColor>.
163		173
164	=item B<-fn> I<fontlist>	174	=item B<-fn> I<fontlist>
165		175
166	Select the fonts to be used. This is a comma separated list of font names	176	Select the fonts to be used. This is a comma separated list of font names
167	that are used in turn when trying to display Unicode characters. The	177	that are checked in order when trying to find glyphs for characters. The
168	first font defines the cell size for characters; other fonts might be	178	first font defines the cell size for characters; other fonts might be
169	smaller, but not (in general) larger. A (hopefully) reasonable default	179	smaller, but not (in general) larger. A (hopefully) reasonable default
170	font list is always appended to it. See resource B<font> for more details.	180	font list is always appended to it. See resource B<font> for more details.
171		181
172	In short, to specify an X11 core font, just specify it's name or prefix it	182	In short, to specify an X11 core font, just specify it's name or prefix it
…		…
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<-override-redirect>
		303
		304	Compile I<frills>: Sets override-redirect on the window; resource
		305	B<override-redirect>.
		306
		307	=item B<-sbg>
		308
		309	Compile I<frills>: Disable the usage of the built-in block graphics/line
		310	drawing characters and just rely on what the specified fonts provide. Use
		311	this if you have a good font and want to use its block graphic glyphs;
		312	resource B<skipBuiltinGlyphs>.
284		313
285	=item B<-lsp> I<number>	314	=item B<-lsp> I<number>
286		315
287	Compile I<frills>: Lines (pixel height) to insert between each row of	316	Compile I<frills>: Lines (pixel height) to insert between each row of
288	the display. Useful to work around font rendering problems; resource	317	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	332	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	333	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,	334	run the program specified by the B<SHELL> environment variable or,
306	failing that, I<sh(1)>.	335	failing that, I<sh(1)>.
307		336
		337	Please note that you must specify a program with arguments. If you want to
		338	run shell commands, you have to specify the shell, like this:
		339
		340	@@RXVT_NAME@@ -e sh -c "shell commands"
		341
308	=item B<-title> I<text>	342	=item B<-title> I<text>
309		343
310	Window title (B<-T> still respected); the default title is the basename	344	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	345	of the program specified after the B<-e> option, if any, otherwise the
312	application name; resource B<title>.	346	application name; resource B<title>.
…		…
367		401
368	=item B<-ssr>\|B<+ssr>	402	=item B<-ssr>\|B<+ssr>
369		403
370	Turn on/off secondary screen scroll (default enabled); resource	404	Turn on/off secondary screen scroll (default enabled); resource
371	B<secondaryScroll>.	405	B<secondaryScroll>.
		406
		407	=item B<-hold>\|B<+hold>
		408
		409	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		410	will not immediately destroy its window when the program executed within
		411	it exits. Instead, it will wait till it is being killed or closed by the
		412	user; resource B<hold>.
372		413
373	=item B<-keysym.>I<sym> I<string>	414	=item B<-keysym.>I<sym> I<string>
374		415
375	Remap a key symbol. See resource B<keysym>.	416	Remap a key symbol. See resource B<keysym>.
376		417
…		…
399	$rxvt->signal_connect_after (realize => sub {	440	$rxvt->signal_connect_after (realize => sub {
400	my $xid = $_[0]->window->get_xid;	441	my $xid = $_[0]->window->get_xid;
401	system "@@RXVT_NAME@@ -embed $xid &";	442	system "@@RXVT_NAME@@ -embed $xid &";
402	});	443	});
403		444
404	=item B<-pty-fd> I<fileno>	445	=item B<-pty-fd> I<file descriptor>
405		446
406	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	447	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
407	pair but instead use the given filehandle as the tty master. This is	448	pair but instead use the given filehandle as the tty master. This is
408	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator	449	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
409	without having to run a program within it.	450	without having to run a program within it.
410		451
411	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	452	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
412	entries and will not tinker with pty/tty permissions - you have to do that	453	entries and will not tinker with pty/tty permissions - you have to do that
413	yourself if you want that.	454	yourself if you want that.
414		455
		456	As an extremely special case, specifying C<-1> will completely suppress
		457	pty/tty operations.
		458
415	Here is a example in perl that illustrates how this option can be used (a	459	Here is a example in perl that illustrates how this option can be used (a
416	longer example is in F<doc/pty-fd>):	460	longer example is in F<doc/pty-fd>):
417		461
418	use IO::Pty;	462	use IO::Pty;
419	use Fcntl;	463	use Fcntl;
…		…
425		469
426	# now communicate with rxvt	470	# now communicate with rxvt
427	my $slave = $pty->slave;	471	my $slave = $pty->slave;
428	while (<$slave>) { print $slave "got <$_>\n" }	472	while (<$slave>) { print $slave "got <$_>\n" }
429		473
		474	=item B<-pe> I<string>
		475
		476	Comma-separated list of perl extension scripts to use (or not to use) in
		477	this terminal instance. See resource B<perl-ext> for details.
		478
430	=back	479	=back
431		480
432	=head1 RESOURCES (available also as long-options)	481	=head1 RESOURCES (available also as long-options)
433		482
434	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	483	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
435	options) compiled into your version.	484	options) compiled into your version.
436		485
437	There are two different methods that @@RXVT_NAME@@ can use to get the	486	You can set and change the resources using X11 tools like B<xrdb>. Many
438	Xresource data: using the X libraries (Xrm*-functions) or internal	487	distribution do also load settings from the B<~/.Xresources> file when X
439	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	488	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
440	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	489	with later settings overwriting earlier ones:
441	resources using X11 tools like B<xrdb>. Many distribution do also load
442	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
443	will consult the following files/resources in order, with later settings
444	overwriting earlier ones:
445		490
446	1. system-wide app-defaults file, either locale-dependent OR global	491	1. system-wide app-defaults file, either locale-dependent OR global
447	2. app-defaults file in $XAPPLRESDIR	492	2. app-defaults file in $XAPPLRESDIR
448	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	493	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
449	4. SCREEN_RESOURCES for the current screen	494	4. SCREEN_RESOURCES for the current screen
450	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	495	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
451		496
452	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
453	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
454	set in XAPPLOADDIR/URxvt (compile-time defined: usually
455	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
456	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
457	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	497	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
458	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows	498	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
459	resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be	499	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
460	easily configured, while the class name B<URxvt> allows resources	500	configured, while the class name B<URxvt> allows resources unique to
461	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	501	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
462	shared between different B<@@RXVT_NAME@@> configurations. If no	502	configurations. If no resources are specified, suitable defaults will
463	resources are specified, suitable defaults will be used. Command-line	503	be used. Command-line arguments can be used to override resource
464	arguments can be used to override resource settings. The following	504	settings. The following resources are supported (you might want to
465	resources are allowed:	505	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		506	extensions not documented here):
466		507
467	=over 4	508	=over 4
468		509
469	=item B<geometry:> I<geom>	510	=item B<geometry:> I<geom>
470		511
…		…
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.
…		…
585	of 1 displays the image without any scaling. A scale of 2 to 9	632	of 1 displays the image without any scaling. A scale of 2 to 9
586	specifies an integer number of images in that direction. No image will	633	specifies an integer number of images in that direction. No image will
587	be magnified beyond 10 times its original size. The maximum permitted	634	be magnified beyond 10 times its original size. The maximum permitted
588	scale is 1000. [default 0x0+50+50]	635	scale is 1000. [default 0x0+50+50]
589		636
590	=item B<menu:> I<file[;tag]>
591
592	Read in the specified menu file (note the `.menu' extension is
593	optional) and also optionally specify a starting tag to find. See the
594	reference documentation for details on the syntax for the menuBar.
595
596	=item B<path:> I<path>	637	=item B<path:> I<path>
597		638
598	Specify the colon-delimited search path for finding files (XPM and	639	Specify the colon-delimited search path for finding XPM files.
599	menus), in addition to the paths specified by the B<RXVTPATH> and
600	B<PATH> environment variables.
601		640
602	=item B<font:> I<fontlist>	641	=item B<font:> I<fontlist>
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 names
605	names that are used in turn when trying to display Unicode characters.	644	that are checked in order when trying to find glyphs for characters. The
606	The first font defines the cell size for characters; other fonts might	645	first font defines the cell size for characters; other fonts might be
607	be smaller, but not larger. A reasonable default font list is always	646	smaller, but not (in general) larger. A (hopefully) reasonable default
608	appended to it. option B<-fn>.	647	font list is always 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
…		…
615	hint currently is C<codeset=codeset-name>, and this is only used for Xft	654	hint currently is C<codeset=codeset-name>, and this is only used for Xft
616	fonts.	655	fonts.
617		656
618	For example, this font resource	657	For example, this font resource
619		658
620	URxvt*font: 9x15bold,\	659	URxvt.font: 9x15bold,\
621	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	660	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
622	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \	661	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
623	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	662	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
624	xft:Code2000:antialias=false	663	xft:Code2000:antialias=false
625		664
…		…
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.
…		…
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.
714		761
715	The string will be interpreted as if typed into the shell as-is.	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>.
716		770
717	=item B<scrollBar:> I<boolean>	771	=item B<scrollBar:> I<boolean>
718		772
719	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	773	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
720	disable the scrollbar; option B<+sb>.	774	disable the scrollbar; option B<+sb>.
…		…
771	=item B<borderLess:> I<boolean>	825	=item B<borderLess:> I<boolean>
772		826
773	Set MWM hints to request a borderless window, i.e. if honoured by the	827	Set MWM hints to request a borderless window, i.e. if honoured by the
774	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.	828	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
775		829
		830	=item B<skipBuiltinGlyphs:> I<boolean>
		831
		832	Compile I<frills>: Disable the usage of the built-in block graphics/line
		833	drawing characters and just rely on what the specified fonts provide. Use
		834	this if you have a good font and want to use its block graphic glyphs;
		835	option B<-sbg>.
		836
776	=item B<termName:> I<termname>	837	=item B<termName:> I<termname>
777		838
778	Specifies the terminal type name to be set in the B<TERM> environment	839	Specifies the terminal type name to be set in the B<TERM> environment
779	variable; option B<-tn>.	840	variable; option B<-tn>.
780		841
…		…
853	=item B<imLocale:> I<name>	914	=item B<imLocale:> I<name>
854		915
855	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.	916	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
856	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the	917	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
857	input extension to be able to input japanese characters while staying in	918	input extension to be able to input japanese characters while staying in
858	another locale. option B<-imlocale>.	919	another locale; option B<-imlocale>.
859		920
860	=item B<imFont:> I<fontset>	921	=item B<imFont:> I<fontset>
861		922
862	Specify the font-set used for XIM styles C<OverTheSpot> or	923	Specify the font-set used for XIM styles C<OverTheSpot> or
863	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated	924	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
…		…
868		929
869	=item B<tripleclickwords:> I<boolean>	930	=item B<tripleclickwords:> I<boolean>
870		931
871	Change the meaning of triple-click selection with the left mouse	932	Change the meaning of triple-click selection with the left mouse
872	button. Instead of selecting a full line it will extend the selection to	933	button. Instead of selecting a full line it will extend the selection to
873	the end of the logical line only. option B<-tcw>.	934	the end of the logical line only; option B<-tcw>.
874		935
875	=item B<insecure:> I<boolean>	936	=item B<insecure:> I<boolean>
876		937
877	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	938	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
878	echo arbitrary strings like the icon name or the locale. This could be	939	echo arbitrary strings like the icon name or the locale. This could be
879	abused if somebody gets 8-bit-clean access to your display, whether	940	abused if somebody gets 8-bit-clean access to your display, whether
880	throuh a mail client displaying mail bodies unfiltered or though	941	through a mail client displaying mail bodies unfiltered or through
881	write(1). Therefore, these sequences are disabled by default. (Note	942	write(1) or any other means. Therefore, these sequences are disabled by
882	that other terminals, including xterm, have these sequences	943	default. (Note that many other terminals, including xterm, have these
883	enabled by default). You can enable them by setting this boolean	944	sequences enabled by default, which doesn't make it safer, though).
884	resource or specifying B<-insecure> as an option. At the moment, this	945
885	enabled display-answer, locale, findfont, icon label and window title	946	You can enable them by setting this boolean resource or specifying
886	requests as well as dynamic menubar dispatch.	947	B<-insecure> as an option. At the moment, this enables display-answer,
		948	locale, findfont, icon label and window title requests.
887		949
888	=item B<modifier:> I<modifier>	950	=item B<modifier:> I<modifier>
889		951
890	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	952	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
891	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	953	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
895		957
896	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	958	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
897	character is passed through. It may contain escape values as described	959	character is passed through. It may contain escape values as described
898	in the entry on B<keysym> following.	960	in the entry on B<keysym> following.
899		961
900	=item B<secondaryScreen:> I<bool>	962	=item B<secondaryScreen:> I<boolean>
901		963
902	Turn on/off secondary screen (default enabled).	964	Turn on/off secondary screen (default enabled).
903		965
904	=item B<secondaryScroll:> I<bool>	966	=item B<secondaryScroll:> I<boolean>
905		967
906	Turn on/off secondary screen scroll (default enabled). If the this	968	Turn on/off secondary screen scroll (default enabled). If the this
907	option is enabled, scrolls on the secondary screen will change the	969	option is enabled, scrolls on the secondary screen will change the
908	scrollback buffer and switching to/from the secondary screen will	970	scrollback buffer and switching to/from the secondary screen will
909	instead scroll the screen up.	971	instead scroll the screen up.
		972
		973	=item B<hold>: I<boolean>
		974
		975	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		976	will not immediately destroy its window when the program executed within
		977	it exits. Instead, it will wait till it is being killed or closed by the
		978	user.
910		979
911	=item B<keysym.>I<sym>: I<string>	980	=item B<keysym.>I<sym>: I<string>
912		981
913	Compile I<frills>: Associate I<string> with keysym I<sym>. The	982	Compile I<frills>: Associate I<string> with keysym I<sym>. The
914	intervening resource name B<keysym.> cannot be omitted.	983	intervening resource name B<keysym.> cannot be omitted.
…		…
934	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1003	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
935	C<\000>: octal number) or verbatim control characters (C<^?>: delete,	1004	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
936	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it	1005	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
937	can start or end with whitespace.	1006	can start or end with whitespace.
938		1007
939	Please note that you need to double the C<\> when using	1008	Please note that you need to double the C<\> in resource files, as
940	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can	1009	Xlib itself does it's own de-escaping (you can use C<\033> instead of
941	use C<\033> instead of C<\e> (and so on), which will work with both Xt and	1010	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
942	@@RXVT_NAME@@'s own processing).	1011	processing).
943		1012
944	You can define a range of keysyms in one shot by providing a I<string>	1013	You can define a range of keysyms in one shot by providing a I<string>
945	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1014	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
946	should be a character not used by the strings.	1015	should be a character not used by the strings.
947		1016
…		…
959	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1028	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
960	example the following means "change the current locale to C<zh_CN.GBK>	1029	example the following means "change the current locale to C<zh_CN.GBK>
961	when Control-Meta-c is being pressed":	1030	when Control-Meta-c is being pressed":
962		1031
963	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1032	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		1033
		1034	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1035	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1036	manpage. For example, the F<selection> extension (activated via
		1037	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1038
		1039	URxvt.keysym.M-C-c: perl:selection:rot13
964		1040
965	Due the the large number of modifier combinations, a defined key mapping	1041	Due the the large number of modifier combinations, a defined key mapping
966	will match if at I<at least> the specified identifiers are being set, and	1042	will match if at I<at least> the specified identifiers are being set, and
967	no other key mappings with those and more bits are being defined. That	1043	no other key mappings with those and more bits are being defined. That
968	means that defining a key map for C<a> will automatically provide	1044	means that defining a key map for C<a> will automatically provide
…		…
992	info):	1068	info):
993		1069
994	URxvt.keysym.M-C-3: command:\033[8;25;80t	1070	URxvt.keysym.M-C-3: command:\033[8;25;80t
995	URxvt.keysym.M-C-4: command:\033[8;48;110t	1071	URxvt.keysym.M-C-4: command:\033[8;48;110t
996		1072
		1073	=item B<perl-ext-common>: I<string>
		1074
		1075	=item B<perl-ext>: I<string>
		1076
		1077	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1078	use in this terminal instance; option B<-pe>.
		1079
		1080	Extension names can be prefixed with a C<-> sign to prohibit using
		1081	them. This can be useful to selectively disable some extensions loaded
		1082	by default, or specified via the C<perl-ext-common> resource. For
		1083	example, C<default,-selection> will use all the default extension except
		1084	C<selection>.
		1085
		1086	Extension names can also be followed by an argument in angle brackets
		1087	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1088	searchable scorllback to Alt/Meta-s). Mentioning the same extension
		1089	multiple times with different arguments will pass multiple arguments to
		1090	the extension.
		1091
		1092	Each extension is looked up in the library directories, loaded if
		1093	necessary, and bound to the current terminal instance.
		1094
		1095	If both of these resources are the empty string, then the perl
		1096	interpreter will not be initialized. The idea behind two options is that
		1097	B<perl-ext-common> will be used for extensions that should be available to
		1098	all instances, while B<perl-ext> is used for specific instances.
		1099
		1100	=item B<perl-eval>: I<string>
		1101
		1102	Perl code to be evaluated when all extensions have been registered. See
		1103	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
		1104	will be ignored when running setuid/setgid.
		1105
		1106	=item B<perl-lib>: I<path>
		1107
		1108	Colon-separated list of additional directories that hold extension
		1109	scripts. When looking for extensions specified by the C<perl> resource,
		1110	@@RXVT_NAME@@ will first look in these directories and then in
		1111	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
		1112	will be ignored when running setuid/setgid.
		1113
		1114	See the @@RXVT_NAME@@perl(3) manpage.
		1115
		1116	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1117
		1118	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1119	details.
		1120
		1121	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1122
		1123	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1124	for details.
		1125
		1126	=item B<searchable-scrollback:> I<keysym>
		1127
		1128	Sets the hotkey that starts the incremental scrollback buffer search
		1129	(default: C<M-s>).
		1130
		1131	=item B<urlLauncher>: I<string>
		1132
		1133	Specifies the program to be started with a URL argument. Used by the
		1134	C<selection-popup> and C<mark-urls> perl extensions.
		1135
		1136	=item B<transient-for>: I<windowid>
		1137
		1138	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1139
		1140	=item B<override-redirect>: I<boolean>
		1141
		1142	Compile I<frills>: Sets override-redirect for the terminal window, making
		1143	it almost invisible to window managers; option B<-override-redirect>.
		1144
997	=back	1145	=back
998		1146
999	=head1 THE SCROLLBAR	1147	=head1 THE SCROLLBAR
1000		1148
1001	Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window	1149	Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
…		…
1035	to select a word; Left triple-click to select the entire logical line	1183	to select a word; Left triple-click to select the entire logical line
1036	(which can span multiple screen lines), unless modified by resource	1184	(which can span multiple screen lines), unless modified by resource
1037	B<tripleclickwords>.	1185	B<tripleclickwords>.
1038		1186
1039	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1187	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
1040	(Compile: I<frills>) will create a rectangular selection instead of a normal	1188	(Compile: I<frills>) will create a rectangular selection instead of a
1041	one.	1189	normal one. In this mode, every selected row becomes its own line in the
		1190	selection, and trailing whitespace is visually underlined and removed from
		1191	the selection.
1042		1192
1043	=item B<Insertion>:	1193	=item B<Insertion>:
1044		1194
1045	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1195	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
1046	an B<@@RXVT_NAME@@> window causes the current text selection to be	1196	an B<@@RXVT_NAME@@> window causes the current text selection to be
…		…
1051	=head1 CHANGING FONTS	1201	=head1 CHANGING FONTS
1052		1202
1053	Changing fonts (or font sizes, respectively) via the keypad is not yet	1203	Changing fonts (or font sizes, respectively) via the keypad is not yet
1054	supported in rxvt-unicode. Bug me if you need this.	1204	supported in rxvt-unicode. Bug me if you need this.
1055		1205
1056	You can, however, switch fonts at runtime using escape sequences (and	1206	You can, however, switch fonts at runtime using escape sequences, e.g.:
1057	therefore using the menubar), e.g.:
1058		1207
1059	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1208	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1209
		1210	You can use keyboard shortcuts, too:
		1211
		1212	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1213	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1060		1214
1061	rxvt-unicode will automatically re-apply these fonts to the output so far.	1215	rxvt-unicode will automatically re-apply these fonts to the output so far.
1062		1216
1063	=head1 ISO 14755 SUPPORT	1217	=head1 ISO 14755 SUPPORT
1064		1218
…		…
1226		1380
1227	=item B<SHELL>	1381	=item B<SHELL>
1228		1382
1229	The shell to be used for command execution, defaults to C</bin/sh>.	1383	The shell to be used for command execution, defaults to C</bin/sh>.
1230		1384
1231	=item B<RXVTPATH>
1232
1233	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1234	files.
1235
1236	=item B<PATH>
1237
1238	Used in the same way as C<RXVTPATH>.
1239
1240	=item B<RXVT_SOCKET>	1385	=item B<RXVT_SOCKET>
1241		1386
1242	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1387	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1243	@@RXVT_NAME@@d(1).	1388	@@RXVT_NAME@@d(1).
1244		1389
1245	Default C<< $HOME/.rxvt-unicode-<nodename >>.	1390	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1246		1391
1247	=item B<HOME>	1392	=item B<HOME>
1248		1393
1249	Used to locate the default directory for the unix domain socket for	1394	Used to locate the default directory for the unix domain socket for
1250	daemon communications and to locate various resource files (such as	1395	daemon communications and to locate various resource files (such as
…		…
1271		1416
1272	=back	1417	=back
1273		1418
1274	=head1 SEE ALSO	1419	=head1 SEE ALSO
1275		1420
1276	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1421	@@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)
1277
1278	=head1 BUGS
1279
1280	Check the BUGS file for an up-to-date list.
1281
1282	Cursor change support is not yet implemented.
1283
1284	Click-and-drag doesn't work with X11 mouse report overriding.
1285		1422
1286	=head1 CURRENT PROJECT COORDINATOR	1423	=head1 CURRENT PROJECT COORDINATOR
1287		1424
1288	=over 4	1425	=over 4
1289		1426

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.65 by root, Thu Jun 30 14:00:49 2005 UTC vs. Revision 1.99 by root, Wed Jan 18 19:43:51 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.65 by root, Thu Jun 30 14:00:49 2005 UTC vs.
Revision 1.99 by root, Wed Jan 18 19:43:51 2006 UTC