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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.69 by root, Tue Oct 25 19:04:45 2005 UTC vs.
Revision 1.105 by root, Wed Jan 25 13:26:48 2006 UTC

…		…
124	is black. resource B<fadeColor>.	124	is black. resource B<fadeColor>.
125		125
126	=item B<-tint> I<colour>	126	=item B<-tint> I<colour>
127		127
128	Tint the transparent background pixmap with the given colour when	128	Tint the transparent background pixmap with the given colour when
129	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
130	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
131	tinting it; resource I<tintColor>. Example:	131	used to brighten or darken the image in addition to tinting it; resource
		132	I<tintColor>. Example:
132		133
133	@@RXVT_NAME@@ -tr -tint blue -sh 40	134	@@RXVT_NAME@@ -tr -tint blue -sh 40
134		135
135	=item B<-sh>	136	=item B<-sh>
136		137
…		…
171	resource B<borderColor>.	172	resource B<borderColor>.
172		173
173	=item B<-fn> I<fontlist>	174	=item B<-fn> I<fontlist>
174		175
175	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
176	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
177	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
178	smaller, but not (in general) larger. A (hopefully) reasonable default	179	smaller, but not (in general) larger. A (hopefully) reasonable default
179	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.
180		181
181	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
…		…
188	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
189	section of @@RXVT_NAME@@(7).	190	section of @@RXVT_NAME@@(7).
190		191
191	=item B<-fb> I<fontlist>	192	=item B<-fb> I<fontlist>
192		193
193	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
194	be printed. See resource B<boldFont> for details.	195	are to be printed. See resource B<boldFont> for details.
195		196
196	=item B<-fi> I<fontlist>	197	=item B<-fi> I<fontlist>
197		198
198	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>
199	be printed. See resource B<italicFont> for details.	200	characters are to be printed. See resource B<italicFont> for details.
200		201
201	=item B<-fbi> I<fontlist>	202	=item B<-fbi> I<fontlist>
202		203
203	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
204	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.
205		213
206	=item B<-name> I<name>	214	=item B<-name> I<name>
207		215
208	Specify the application name under which resources are to be obtained,	216	Specify the application name under which resources are to be obtained,
209	rather than the default executable file name. Name should not contain	217	rather than the default executable file name. Name should not contain
…		…
288	=item B<-bl>	296	=item B<-bl>
289		297
290	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.
291	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
292	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>.
293		313
294	=item B<-lsp> I<number>	314	=item B<-lsp> I<number>
295		315
296	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
297	the display. Useful to work around font rendering problems; resource	317	the display. Useful to work around font rendering problems; resource
…		…
312	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
313	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
314	run the program specified by the B<SHELL> environment variable or,	334	run the program specified by the B<SHELL> environment variable or,
315	failing that, I<sh(1)>.	335	failing that, I<sh(1)>.
316		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
317	=item B<-title> I<text>	342	=item B<-title> I<text>
318		343
319	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
320	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
321	application name; resource B<title>.	346	application name; resource B<title>.
…		…
376		401
377	=item B<-ssr>\|B<+ssr>	402	=item B<-ssr>\|B<+ssr>
378		403
379	Turn on/off secondary screen scroll (default enabled); resource	404	Turn on/off secondary screen scroll (default enabled); resource
380	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>.
381		413
382	=item B<-keysym.>I<sym> I<string>	414	=item B<-keysym.>I<sym> I<string>
383		415
384	Remap a key symbol. See resource B<keysym>.	416	Remap a key symbol. See resource B<keysym>.
385		417
…		…
408	$rxvt->signal_connect_after (realize => sub {	440	$rxvt->signal_connect_after (realize => sub {
409	my $xid = $_[0]->window->get_xid;	441	my $xid = $_[0]->window->get_xid;
410	system "@@RXVT_NAME@@ -embed $xid &";	442	system "@@RXVT_NAME@@ -embed $xid &";
411	});	443	});
412		444
413	=item B<-pty-fd> I<fileno>	445	=item B<-pty-fd> I<file descriptor>
414		446
415	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
416	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
417	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
418	without having to run a program within it.	450	without having to run a program within it.
419		451
420	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
421	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
422	yourself if you want that.	454	yourself if you want that.
423		455
		456	As an extremely special case, specifying C<-1> will completely suppress
		457	pty/tty operations.
		458
424	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
425	longer example is in F<doc/pty-fd>):	460	longer example is in F<doc/pty-fd>):
426		461
427	use IO::Pty;	462	use IO::Pty;
428	use Fcntl;	463	use Fcntl;
…		…
434		469
435	# now communicate with rxvt	470	# now communicate with rxvt
436	my $slave = $pty->slave;	471	my $slave = $pty->slave;
437	while (<$slave>) { print $slave "got <$_>\n" }	472	while (<$slave>) { print $slave "got <$_>\n" }
438		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
439	=back	479	=back
440		480
441	=head1 RESOURCES (available also as long-options)	481	=head1 RESOURCES (available also as long-options)
442		482
443	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	483	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
444	options) compiled into your version.	484	options) compiled into your version.
445		485
446	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
447	Xresource data: using the X libraries (Xrm*-functions) or internal	487	distribution do also load settings from the B<~/.Xresources> file when X
448	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	488	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
449	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	489	with later settings overwriting earlier ones:
450	resources using X11 tools like B<xrdb>. Many distribution do also load
451	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
452	will consult the following files/resources in order, with later settings
453	overwriting earlier ones:
454		490
455	1. system-wide app-defaults file, either locale-dependent OR global	491	1. system-wide app-defaults file, either locale-dependent OR global
456	2. app-defaults file in $XAPPLRESDIR	492	2. app-defaults file in $XAPPLRESDIR
457	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	493	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
458	4. SCREEN_RESOURCES for the current screen	494	4. SCREEN_RESOURCES for the current screen
459	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	495	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
460		496
461	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
462	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
463	set in XAPPLOADDIR/URxvt (compile-time defined: usually
464	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
465	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
466	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	497	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
467	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
468	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
469	easily configured, while the class name B<URxvt> allows resources	500	configured, while the class name B<URxvt> allows resources unique to
470	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	501	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
471	shared between different B<@@RXVT_NAME@@> configurations. If no	502	configurations. If no resources are specified, suitable defaults will
472	resources are specified, suitable defaults will be used. Command-line	503	be used. Command-line arguments can be used to override resource
473	arguments can be used to override resource settings. The following	504	settings. The following resources are supported (you might want to
474	resources are allowed:	505	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		506	extensions not documented here):
475		507
476	=over 4	508	=over 4
477		509
478	=item B<geometry:> I<geom>	510	=item B<geometry:> I<geom>
479		511
…		…
600	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
601	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
602	be magnified beyond 10 times its original size. The maximum permitted	634	be magnified beyond 10 times its original size. The maximum permitted
603	scale is 1000. [default 0x0+50+50]	635	scale is 1000. [default 0x0+50+50]
604		636
605	=item B<menu:> I<file[;tag]>
606
607	Read in the specified menu file (note the `.menu' extension is
608	optional) and also optionally specify a starting tag to find. See the
609	reference documentation for details on the syntax for the menuBar.
610
611	=item B<path:> I<path>	637	=item B<path:> I<path>
612		638
613	Specify the colon-delimited search path for finding files (XPM and	639	Specify the colon-delimited search path for finding XPM files.
614	menus), in addition to the paths specified by the B<RXVTPATH> and
615	B<PATH> environment variables.
616		640
617	=item B<font:> I<fontlist>	641	=item B<font:> I<fontlist>
618		642
619	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
620	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
621	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
622	be smaller, but not larger. A reasonable default font list is always	646	smaller, but not (in general) larger. A (hopefully) reasonable default
623	appended to it. option B<-fn>.	647	font list is always appended to it; option B<-fn>.
624		648
625	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
626	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:>.
627		651
628	In addition, each font can be prefixed with additional hints and	652	In addition, each font can be prefixed with additional hints and
…		…
630	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
631	fonts.	655	fonts.
632		656
633	For example, this font resource	657	For example, this font resource
634		658
635	URxvt*font: 9x15bold,\	659	URxvt.font: 9x15bold,\
636	-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,\
637	-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, \
638	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	662	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
639	xft:Code2000:antialias=false	663	xft:Code2000:antialias=false
640		664
…		…
674	not possible, replacement fonts of the desired shape will be tried.	698	not possible, replacement fonts of the desired shape will be tried.
675		699
676	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
677	text font will being used for the given style.	701	text font will being used for the given style.
678		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
679	=item B<selectstyle:> I<mode>	711	=item B<selectstyle:> I<mode>
680		712
681	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
682	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
683	xterm style selection.	715	xterm style selection.
…		…
729		761
730	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.
731		763
732	Example:	764	Example:
733		765
734	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	766	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
735		767
736	This creates a new file in your home directory with the screen contents	768	This creates a new file in your home directory with the screen contents
737	everytime you hit C<Print>.	769	everytime you hit C<Print>.
738		770
739	=item B<scrollBar:> I<boolean>	771	=item B<scrollBar:> I<boolean>
…		…
793	=item B<borderLess:> I<boolean>	825	=item B<borderLess:> I<boolean>
794		826
795	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
796	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>.
797		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
798	=item B<termName:> I<termname>	837	=item B<termName:> I<termname>
799		838
800	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
801	variable; option B<-tn>.	840	variable; option B<-tn>.
802		841
…		…
857	pressed. If unset it will send the sequence traditionally associated	896	pressed. If unset it will send the sequence traditionally associated
858	with the B<Execute> key.	897	with the B<Execute> key.
859		898
860	=item B<cutchars:> I<string>	899	=item B<cutchars:> I<string>
861		900
862	The characters used as delimiters for double-click word selection. The	901	The characters used as delimiters for double-click word selection
863	built-in default:	902	(whitespace delimiting is added automatically if resource is given).
		903
		904	When the selection extension is in use (the default if compiled in, see
		905	the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters
		906	will be created (if the resource exists, otherwise, no regex will be
		907	created). In this mode, characters outside ISO-8859-1 can be used.
		908
		909	When the selection extension is not used, only ISO-8859-1 characters can
		910	be used. If not specified, the built-in default is used:
864		911
865	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	912	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>
866		913
867	=item B<preeditType:> I<style>	914	=item B<preeditType:> I<style>
868		915
…		…
875	=item B<imLocale:> I<name>	922	=item B<imLocale:> I<name>
876		923
877	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.
878	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
879	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
880	another locale. option B<-imlocale>.	927	another locale; option B<-imlocale>.
881		928
882	=item B<imFont:> I<fontset>	929	=item B<imFont:> I<fontset>
883		930
884	Specify the font-set used for XIM styles C<OverTheSpot> or	931	Specify the font-set used for XIM styles C<OverTheSpot> or
885	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
…		…
890		937
891	=item B<tripleclickwords:> I<boolean>	938	=item B<tripleclickwords:> I<boolean>
892		939
893	Change the meaning of triple-click selection with the left mouse	940	Change the meaning of triple-click selection with the left mouse
894	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
895	the end of the logical line only. option B<-tcw>.	942	the end of the logical line only; option B<-tcw>.
896		943
897	=item B<insecure:> I<boolean>	944	=item B<insecure:> I<boolean>
898		945
899	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	946	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
900	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
901	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
902	throuh a mail client displaying mail bodies unfiltered or though	949	through a mail client displaying mail bodies unfiltered or through
903	write(1). Therefore, these sequences are disabled by default. (Note	950	write(1) or any other means. Therefore, these sequences are disabled by
904	that other terminals, including xterm, have these sequences	951	default. (Note that many other terminals, including xterm, have these
905	enabled by default). You can enable them by setting this boolean	952	sequences enabled by default, which doesn't make it safer, though).
906	resource or specifying B<-insecure> as an option. At the moment, this	953
907	enabled display-answer, locale, findfont, icon label and window title	954	You can enable them by setting this boolean resource or specifying
908	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.
909		957
910	=item B<modifier:> I<modifier>	958	=item B<modifier:> I<modifier>
911		959
912	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	960	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
913	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	961	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
917		965
918	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	966	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
919	character is passed through. It may contain escape values as described	967	character is passed through. It may contain escape values as described
920	in the entry on B<keysym> following.	968	in the entry on B<keysym> following.
921		969
922	=item B<secondaryScreen:> I<bool>	970	=item B<secondaryScreen:> I<boolean>
923		971
924	Turn on/off secondary screen (default enabled).	972	Turn on/off secondary screen (default enabled).
925		973
926	=item B<secondaryScroll:> I<bool>	974	=item B<secondaryScroll:> I<boolean>
927		975
928	Turn on/off secondary screen scroll (default enabled). If the this	976	Turn on/off secondary screen scroll (default enabled). If the this
929	option is enabled, scrolls on the secondary screen will change the	977	option is enabled, scrolls on the secondary screen will change the
930	scrollback buffer and switching to/from the secondary screen will	978	scrollback buffer and switching to/from the secondary screen will
931	instead scroll the screen up.	979	instead scroll the screen up.
		980
		981	=item B<hold>: I<boolean>
		982
		983	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		984	will not immediately destroy its window when the program executed within
		985	it exits. Instead, it will wait till it is being killed or closed by the
		986	user.
932		987
933	=item B<keysym.>I<sym>: I<string>	988	=item B<keysym.>I<sym>: I<string>
934		989
935	Compile I<frills>: Associate I<string> with keysym I<sym>. The	990	Compile I<frills>: Associate I<string> with keysym I<sym>. The
936	intervening resource name B<keysym.> cannot be omitted.	991	intervening resource name B<keysym.> cannot be omitted.
…		…
956	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1011	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
957	C<\000>: octal number) or verbatim control characters (C<^?>: delete,	1012	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
958	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it	1013	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
959	can start or end with whitespace.	1014	can start or end with whitespace.
960		1015
961	Please note that you need to double the C<\> when using	1016	Please note that you need to double the C<\> in resource files, as
962	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can	1017	Xlib itself does it's own de-escaping (you can use C<\033> instead of
963	use C<\033> instead of C<\e> (and so on), which will work with both Xt and	1018	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
964	@@RXVT_NAME@@'s own processing).	1019	processing).
965		1020
966	You can define a range of keysyms in one shot by providing a I<string>	1021	You can define a range of keysyms in one shot by providing a I<string>
967	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1022	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
968	should be a character not used by the strings.	1023	should be a character not used by the strings.
969		1024
…		…
981	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1036	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
982	example the following means "change the current locale to C<zh_CN.GBK>	1037	example the following means "change the current locale to C<zh_CN.GBK>
983	when Control-Meta-c is being pressed":	1038	when Control-Meta-c is being pressed":
984		1039
985	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1040	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		1041
		1042	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1043	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1044	manpage. For example, the F<selection> extension (activated via
		1045	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1046
		1047	URxvt.keysym.M-C-c: perl:selection:rot13
986		1048
987	Due the the large number of modifier combinations, a defined key mapping	1049	Due the the large number of modifier combinations, a defined key mapping
988	will match if at I<at least> the specified identifiers are being set, and	1050	will match if at I<at least> the specified identifiers are being set, and
989	no other key mappings with those and more bits are being defined. That	1051	no other key mappings with those and more bits are being defined. That
990	means that defining a key map for C<a> will automatically provide	1052	means that defining a key map for C<a> will automatically provide
…		…
1014	info):	1076	info):
1015		1077
1016	URxvt.keysym.M-C-3: command:\033[8;25;80t	1078	URxvt.keysym.M-C-3: command:\033[8;25;80t
1017	URxvt.keysym.M-C-4: command:\033[8;48;110t	1079	URxvt.keysym.M-C-4: command:\033[8;48;110t
1018		1080
		1081	=item B<perl-ext-common>: I<string>
		1082
		1083	=item B<perl-ext>: I<string>
		1084
		1085	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1086	use in this terminal instance; option B<-pe>.
		1087
		1088	Extension names can be prefixed with a C<-> sign to prohibit using
		1089	them. This can be useful to selectively disable some extensions loaded
		1090	by default, or specified via the C<perl-ext-common> resource. For
		1091	example, C<default,-selection> will use all the default extension except
		1092	C<selection>.
		1093
		1094	Extension names can also be followed by an argument in angle brackets
		1095	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1096	searchable scorllback to Alt/Meta-s). Mentioning the same extension
		1097	multiple times with different arguments will pass multiple arguments to
		1098	the extension.
		1099
		1100	Each extension is looked up in the library directories, loaded if
		1101	necessary, and bound to the current terminal instance.
		1102
		1103	If both of these resources are the empty string, then the perl
		1104	interpreter will not be initialized. The idea behind two options is that
		1105	B<perl-ext-common> will be used for extensions that should be available to
		1106	all instances, while B<perl-ext> is used for specific instances.
		1107
		1108	=item B<perl-eval>: I<string>
		1109
		1110	Perl code to be evaluated when all extensions have been registered. See
		1111	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
		1112	will be ignored when running setuid/setgid.
		1113
		1114	=item B<perl-lib>: I<path>
		1115
		1116	Colon-separated list of additional directories that hold extension
		1117	scripts. When looking for extensions specified by the C<perl> resource,
		1118	@@RXVT_NAME@@ will first look in these directories and then in
		1119	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
		1120	will be ignored when running setuid/setgid.
		1121
		1122	See the @@RXVT_NAME@@perl(3) manpage.
		1123
		1124	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1125
		1126	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1127	details.
		1128
		1129	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1130
		1131	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1132	for details.
		1133
		1134	=item B<searchable-scrollback:> I<keysym>
		1135
		1136	Sets the hotkey that starts the incremental scrollback buffer search
		1137	(default: C<M-s>).
		1138
		1139	=item B<urlLauncher>: I<string>
		1140
		1141	Specifies the program to be started with a URL argument. Used by the
		1142	C<selection-popup> and C<mark-urls> perl extensions.
		1143
		1144	=item B<transient-for>: I<windowid>
		1145
		1146	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1147
		1148	=item B<override-redirect>: I<boolean>
		1149
		1150	Compile I<frills>: Sets override-redirect for the terminal window, making
		1151	it almost invisible to window managers; option B<-override-redirect>.
		1152
1019	=back	1153	=back
1020		1154
1021	=head1 THE SCROLLBAR	1155	=head1 THE SCROLLBAR
1022		1156
1023	Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window	1157	Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
…		…
1057	to select a word; Left triple-click to select the entire logical line	1191	to select a word; Left triple-click to select the entire logical line
1058	(which can span multiple screen lines), unless modified by resource	1192	(which can span multiple screen lines), unless modified by resource
1059	B<tripleclickwords>.	1193	B<tripleclickwords>.
1060		1194
1061	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1195	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
1062	(Compile: I<frills>) will create a rectangular selection instead of a normal	1196	(Compile: I<frills>) will create a rectangular selection instead of a
1063	one.	1197	normal one. In this mode, every selected row becomes its own line in the
		1198	selection, and trailing whitespace is visually underlined and removed from
		1199	the selection.
1064		1200
1065	=item B<Insertion>:	1201	=item B<Insertion>:
1066		1202
1067	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1203	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1068	an B<@@RXVT_NAME@@> window causes the current text selection to be	1204	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1069	inserted as if it had been typed on the keyboard.	1205	Meta modifier) to be inserted as if it had been typed on the keyboard.
		1206
		1207	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1208	inserted too.
1070		1209
1071	=back	1210	=back
1072		1211
1073	=head1 CHANGING FONTS	1212	=head1 CHANGING FONTS
1074		1213
1075	Changing fonts (or font sizes, respectively) via the keypad is not yet	1214	Changing fonts (or font sizes, respectively) via the keypad is not yet
1076	supported in rxvt-unicode. Bug me if you need this.	1215	supported in rxvt-unicode. Bug me if you need this.
1077		1216
1078	You can, however, switch fonts at runtime using escape sequences (and	1217	You can, however, switch fonts at runtime using escape sequences, e.g.:
1079	therefore using the menubar), e.g.:
1080		1218
1081	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1219	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1220
		1221	You can use keyboard shortcuts, too:
		1222
		1223	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1224	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1082		1225
1083	rxvt-unicode will automatically re-apply these fonts to the output so far.	1226	rxvt-unicode will automatically re-apply these fonts to the output so far.
1084		1227
1085	=head1 ISO 14755 SUPPORT	1228	=head1 ISO 14755 SUPPORT
1086		1229
…		…
1248		1391
1249	=item B<SHELL>	1392	=item B<SHELL>
1250		1393
1251	The shell to be used for command execution, defaults to C</bin/sh>.	1394	The shell to be used for command execution, defaults to C</bin/sh>.
1252		1395
1253	=item B<RXVTPATH>
1254
1255	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1256	files.
1257
1258	=item B<PATH>
1259
1260	Used in the same way as C<RXVTPATH>.
1261
1262	=item B<RXVT_SOCKET>	1396	=item B<RXVT_SOCKET>
1263		1397
1264	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1398	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1265	@@RXVT_NAME@@d(1).	1399	@@RXVT_NAME@@d(1).
1266		1400
…		…
1295		1429
1296	=head1 SEE ALSO	1430	=head1 SEE ALSO
1297		1431
1298	@@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)	1432	@@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)
1299		1433
1300	=head1 BUGS
1301
1302	Check the BUGS file for an up-to-date list.
1303
1304	Cursor change support is not yet implemented.
1305
1306	Click-and-drag doesn't work with X11 mouse report overriding.
1307
1308	=head1 CURRENT PROJECT COORDINATOR	1434	=head1 CURRENT PROJECT COORDINATOR
1309		1435
1310	=over 4	1436	=over 4
1311		1437
1312	=item Project Coordinator	1438	=item Project Coordinator
…		…
1343		1469
1344	Project Coordinator (changes.txt 2.21a to 2.4.5)	1470	Project Coordinator (changes.txt 2.21a to 2.4.5)
1345		1471
1346	=item Geoff Wing L<< <gcw@pobox.com> >>	1472	=item Geoff Wing L<< <gcw@pobox.com> >>
1347		1473
1348	Rewrote screen display and text selection routines. Project Coordinator	1474	Rewrote screen display and text selection routines.
		1475
1349	(changes.txt 2.4.6 - rxvt-unicode)	1476	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1350		1477
1351	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1478	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1352		1479
1353	Forked rxvt-unicode, rewrote most of the display code and internal	1480	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1354	character handling to store text in unicode, improve xterm	1481	extension, random hacks, numerous bugfixes and extensions.
1355	compatibility and apply numerous other bugfixes and extensions.
1356		1482
1357	Project Coordinator (Changes 1.0 -)	1483	Project Coordinator (Changes 1.0 -)
1358		1484
		1485	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1486
		1487	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
		1488
1359	=back	1489	=back
1360		1490

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.69 by root, Tue Oct 25 19:04:45 2005 UTC vs. Revision 1.105 by root, Wed Jan 25 13:26:48 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.69 by root, Tue Oct 25 19:04:45 2005 UTC vs.
Revision 1.105 by root, Wed Jan 25 13:26:48 2006 UTC