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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.48 by root, Thu Feb 3 10:24:10 2005 UTC vs.
Revision 1.83 by root, Tue Jan 3 22:28:07 2006 UTC

…		…
14	configurability. As a result, B<rxvt-unicode> uses much less swap space --	14	configurability. As a result, B<rxvt-unicode> uses much less swap space --
15	a significant advantage on a machine serving many X sessions.	15	a significant advantage on a machine serving many X sessions.
16		16
17	=head1 FREQUENTLY ASKED QUESTIONS	17	=head1 FREQUENTLY ASKED QUESTIONS
18		18
19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of frequently	19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20	asked questions and answer to them and some common problems.	20	frequently asked questions and answer to them and some common
		21	problems. That document is also accessible on the World-Wide-Web at
		22	L<http://cvs.schmorp.de/browse/checkout/rxvt-unicode/doc/rxvt.7.html>.
21		23
22	=head1 RXVT-UNICODE VS. RXVT	24	=head1 RXVT-UNICODE VS. RXVT
23		25
24	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode	26	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
25	internally. That means it can store and display most scripts in the	27	internally. That means it can store and display most scripts in the
…		…
103		105
104	=item B<-j>\|B<+j>	106	=item B<-j>\|B<+j>
105		107
106	Turn on/off jump scrolling; resource B<jumpScroll>.	108	Turn on/off jump scrolling; resource B<jumpScroll>.
107		109
108	=item B<-ip>\|B<+ip>	110	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>
109		111
110	Turn on/off inheriting parent window's pixmap. Alternative form is	112	Turn on/off inheriting parent window's pixmap. Alternative form is
111	B<-tr>; resource B<inheritPixmap>.	113	B<-tr>; resource B<inheritPixmap>.
112		114
113	=item B<-fade> I<number>	115	=item B<-fade> I<number>
114		116
115	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>.
116		125
117	=item B<-tint> I<colour>	126	=item B<-tint> I<colour>
118		127
119	Tint the transparent background pixmap with the given colour when	128	Tint the transparent background pixmap with the given colour when
120	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
121	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
122	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
123		135
124	=item B<-sh>	136	=item B<-sh>
125		137
126	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	138	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
127	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
…		…
177	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
178	section of @@RXVT_NAME@@(7).	190	section of @@RXVT_NAME@@(7).
179		191
180	=item B<-fb> I<fontlist>	192	=item B<-fb> I<fontlist>
181		193
182	Compile font-styles: The bold font list to use when bold characters are to	194	Compile font-styles: The bold font list to use when B<bold> characters are to
183	be printed. See resource B<boldFont> for details.	195	be printed. See resource B<boldFont> for details.
184		196
185	=item B<-fi> I<fontlist>	197	=item B<-fi> I<fontlist>
186		198
187	Compile font-styles: The italic font list to use when bold characters are to	199	Compile font-styles: The italic font list to use when I<italic> characters are to
188	be printed. See resource B<italicFont> for details.	200	be printed. See resource B<italicFont> for details.
189		201
190	=item B<-fbi> I<fontlist>	202	=item B<-fbi> I<fontlist>
191		203
192	Compile font-styles: The bold italic font list to use when bold characters are to	204	Compile font-styles: The bold italic font list to use when B<< I<bold
193	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 font-styles: Bold/Italic font styles imply high intensity
		211	foreground/background (default). See resource B<intensityStyles> for
		212	details.
194		213
195	=item B<-name> I<name>	214	=item B<-name> I<name>
196		215
197	Specify the application name under which resources are to be obtained,	216	Specify the application name under which resources are to be obtained,
198	rather than the default executable file name. Name should not contain	217	rather than the default executable file name. Name should not contain
…		…
236		255
237	Put scrollbar on right/left; resource B<scrollBar_right>.	256	Put scrollbar on right/left; resource B<scrollBar_right>.
238		257
239	=item B<-st>\|B<+st>	258	=item B<-st>\|B<+st>
240		259
241	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	260	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
242	resource B<scrollBar_floating>.	261	resource B<scrollBar_floating>.
243		262
244	=item B<-ptab>\|B<+ptab>	263	=item B<-ptab>\|B<+ptab>
245		264
246	If enabled (default), "Horizontal Tab" characters are being stored as	265	If enabled (default), "Horizontal Tab" characters are being stored as
…		…
301	given on the command line. If this option is used, it must be the last	320	given on the command line. If this option is used, it must be the last
302	on the command-line. If there is no B<-e> option then the default is to	321	on the command-line. If there is no B<-e> option then the default is to
303	run the program specified by the B<SHELL> environment variable or,	322	run the program specified by the B<SHELL> environment variable or,
304	failing that, I<sh(1)>.	323	failing that, I<sh(1)>.
305		324
		325	Please note that you must specify a program with arguments. If you want to
		326	run shell commands, you have to specify the shell, like this:
		327
		328	@@RXVT_NAME@@ -e sh -c "shell commands"
		329
306	=item B<-title> I<text>	330	=item B<-title> I<text>
307		331
308	Window title (B<-T> still respected); the default title is the basename	332	Window title (B<-T> still respected); the default title is the basename
309	of the program specified after the B<-e> option, if any, otherwise the	333	of the program specified after the B<-e> option, if any, otherwise the
310	application name; resource B<title>.	334	application name; resource B<title>.
…		…
366	=item B<-ssr>\|B<+ssr>	390	=item B<-ssr>\|B<+ssr>
367		391
368	Turn on/off secondary screen scroll (default enabled); resource	392	Turn on/off secondary screen scroll (default enabled); resource
369	B<secondaryScroll>.	393	B<secondaryScroll>.
370		394
		395	=item B<-hold>\|B<+hold>
		396
		397	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		398	will not immediately destroy its window when the program executed within
		399	it exits. Instead, it will wait till it is being killed or closed by the
		400	user; resource B<hold>.
		401
		402	=item B<-keysym.>I<sym> I<string>
		403
		404	Remap a key symbol. See resource B<keysym>.
		405
		406	=item B<-embed> I<windowid>
		407
		408	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
		409	which enables applications to easily embed a terminal.
		410
		411	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
		412	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
		413	quite a bit, so don't expect it to keep some specific state. It's best to
		414	create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
		415
		416	The window will not be destroyed when @@RXVT_NAME@@ exits.
		417
		418	It might be useful to know that @@RXVT_NAME@@ will not close file
		419	descriptors passed to it (except for stdin/out/err, of course), so you
		420	can use file descriptors to communicate with the programs within the
		421	terminal. This works regardless of wether the C<-embed> option was used or
		422	not.
		423
		424	Here is a short Gtk2-perl snippet that illustrates how this option can be
		425	used (a longer example is in F<doc/embed>):
		426
		427	my $rxvt = new Gtk2::Socket;
		428	$rxvt->signal_connect_after (realize => sub {
		429	my $xid = $_[0]->window->get_xid;
		430	system "@@RXVT_NAME@@ -embed $xid &";
		431	});
		432
		433	=item B<-pty-fd> I<fileno>
		434
		435	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
		436	pair but instead use the given filehandle as the tty master. This is
		437	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
		438	without having to run a program within it.
		439
		440	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
		441	entries and will not tinker with pty/tty permissions - you have to do that
		442	yourself if you want that.
		443
		444	Here is a example in perl that illustrates how this option can be used (a
		445	longer example is in F<doc/pty-fd>):
		446
		447	use IO::Pty;
		448	use Fcntl;
		449
		450	my $pty = new IO::Pty;
		451	fcntl $pty, F_SETFD, 0; # clear close-on-exec
		452	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		453	close $pty;
		454
		455	# now communicate with rxvt
		456	my $slave = $pty->slave;
		457	while (<$slave>) { print $slave "got <$_>\n" }
		458
371	=item B<-xrm> I<resourcestring>	459	=item B<-pe> I<string>
372		460
373	No effect on rxvt-unicode. Simply passes through an argument to be made	461	Colon-separated list of perl extension scripts to use in this terminal instance. See resource B<perl-ext>.
374	available in the instance's argument list. Appears in I<WM_COMMAND> in
375	some window managers.
376		462
377	=back	463	=back
378		464
379	=head1 RESOURCES (available also as long-options)	465	=head1 RESOURCES (available also as long-options)
380		466
…		…
383		469
384	There are two different methods that @@RXVT_NAME@@ can use to get the	470	There are two different methods that @@RXVT_NAME@@ can use to get the
385	Xresource data: using the X libraries (Xrm*-functions) or internal	471	Xresource data: using the X libraries (Xrm*-functions) or internal
386	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	472	Xresources reader (B<~/.Xdefaults>). For the first method (ie.
387	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	473	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the
388	resources using X11 tools like B<xset>. Many distribution do also load	474	resources using X11 tools like B<xrdb>. Many distribution do also load
389	settings from the B<~/.Xresources> file when X starts.	475	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
		476	will consult the following files/resources in order, with later settings
		477	overwriting earlier ones:
		478
		479	1. system-wide app-defaults file, either locale-dependent OR global
		480	2. app-defaults file in $XAPPLRESDIR
		481	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
		482	4. SCREEN_RESOURCES for the current screen
		483	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
390		484
391	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>	485	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
392	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults	486	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
393	set in XAPPLOADDIR/URxvt (compile-time defined: usually	487	set in XAPPLOADDIR/URxvt (compile-time defined: usually
394	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	488	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
…		…
487	artificial transparency. B<False>: do not inherit the parent windows'	581	artificial transparency. B<False>: do not inherit the parent windows'
488	pixmap.	582	pixmap.
489		583
490	=item B<fading:> I<number>	584	=item B<fading:> I<number>
491		585
492	Fade the text by the given percentage when focus is lost.	586	Fade the text by the given percentage when focus is lost; option B<-fade>.
		587
		588	=item B<fadeColor:> I<colour>
		589
		590	Fade to this colour, when fading is used (see B<fading:>). The default
		591	colour is black; option B<-fadecolor>.
493		592
494	=item B<tintColor:> I<colour>	593	=item B<tintColor:> I<colour>
495		594
496	Tint the transparent background pixmap with the given colour.	595	Tint the transparent background pixmap with the given colour; option
		596	B<-tint>.
497		597
498	=item B<shading:> I<number>	598	=item B<shading:> I<number>
499		599
500	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	600	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
501	image in addition to tinting it.	601	image in addition to tinting it.
…		…
505	Use the specified colour for the scrollbar [default #B2B2B2].	605	Use the specified colour for the scrollbar [default #B2B2B2].
506		606
507	=item B<troughColor:> I<colour>	607	=item B<troughColor:> I<colour>
508		608
509	Use the specified colour for the scrollbar's trough area [default	609	Use the specified colour for the scrollbar's trough area [default
510	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	610	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
511		611
512	=item B<borderColor:> I<colour>	612	=item B<borderColor:> I<colour>
513		613
514	The colour of the border around the text area and between the scrollbar	614	The colour of the border around the text area and between the scrollbar
515	and the text.	615	and the text.
…		…
542		642
543	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
544	names that are used in turn when trying to display Unicode characters.	644	names that are used in turn when trying to display Unicode characters.
545	The first font defines the cell size for characters; other fonts might	645	The first font defines the cell size for characters; other fonts might
546	be smaller, but not larger. A reasonable default font list is always	646	be smaller, but not larger. A reasonable default font list is always
547	appended to it. option B<-fn>.	647	appended to it; option B<-fn>.
548		648
549	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
550	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:>.
551		651
552	In addition, each font can be prefixed with additional hints and	652	In addition, each font can be prefixed with additional hints and
…		…
598	not possible, replacement fonts of the desired shape will be tried.	698	not possible, replacement fonts of the desired shape will be tried.
599		699
600	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
601	text font will being used for the given style.	701	text font will being used for the given style.
602		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
603	=item B<selectstyle:> I<mode>	711	=item B<selectstyle:> I<mode>
604		712
605	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
606	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
607	xterm style selection.	715	xterm style selection.
608		716
609	=item B<scrollstyle:> I<mode>	717	=item B<scrollstyle:> I<mode>
610		718
611	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	719	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
612	the author's favourite..	720	the author's favourite.
613		721
614	=item B<title:> I<string>	722	=item B<title:> I<string>
615		723
616	Set window title string, the default title is the command-line	724	Set window title string, the default title is the command-line
617	specified after the B<-e> option, if any, otherwise the application	725	specified after the B<-e> option, if any, otherwise the application
…		…
649		757
650	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
651	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
652	B<Shift-Print> to include the scrollback as well.	760	B<Shift-Print> to include the scrollback as well.
653		761
		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>.
		770
654	=item B<scrollBar:> I<boolean>	771	=item B<scrollBar:> I<boolean>
655		772
656	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	773	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
657	disable the scrollbar; option B<+sb>.	774	disable the scrollbar; option B<+sb>.
658		775
…		…
678	B<+si>.	795	B<+si>.
679		796
680	=item B<scrollWithBuffer:> I<boolean>	797	=item B<scrollWithBuffer:> I<boolean>
681		798
682	B<True>: scroll with scrollback buffer when tty receives new lines (and	799	B<True>: scroll with scrollback buffer when tty receives new lines (and
683	B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll	800	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
684	with scrollback buffer when tty recieves new lines; option B<-sw>.	801	with scrollback buffer when tty recieves new lines; option B<+sw>.
685		802
686	=item B<scrollTtyKeypress:> I<boolean>	803	=item B<scrollTtyKeypress:> I<boolean>
687		804
688	B<True>: scroll to bottom when a non-special key is pressed. Special keys	805	B<True>: scroll to bottom when a non-special key is pressed. Special keys
689	are those which are intercepted by rxvt-unicode for special handling and	806	are those which are intercepted by rxvt-unicode for special handling and
…		…
754		871
755	Mouse pointer background colour.	872	Mouse pointer background colour.
756		873
757	=item B<pointerBlankDelay:> I<number>	874	=item B<pointerBlankDelay:> I<number>
758		875
759	Specifies number of seconds before blanking the pointer [default 2].	876	Specifies number of seconds before blanking the pointer [default 2]. Use a
		877	large number (e.g. C<987654321>) to effectively disable the timeout.
760		878
761	=item B<backspacekey:> I<string>	879	=item B<backspacekey:> I<string>
762		880
763	The string to send when the backspace key is pressed. If set to B<DEC>	881	The string to send when the backspace key is pressed. If set to B<DEC>
764	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	882	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
…		…
789	=item B<imLocale:> I<name>	907	=item B<imLocale:> I<name>
790		908
791	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.	909	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
792	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the	910	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
793	input extension to be able to input japanese characters while staying in	911	input extension to be able to input japanese characters while staying in
794	another locale. option B<-imlocale>.	912	another locale; option B<-imlocale>.
795		913
796	=item B<imFont:> I<fontset>	914	=item B<imFont:> I<fontset>
797		915
798	Specify the font-set used for XIM styles C<OverTheSpot> or	916	Specify the font-set used for XIM styles C<OverTheSpot> or
799	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated	917	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
…		…
804		922
805	=item B<tripleclickwords:> I<boolean>	923	=item B<tripleclickwords:> I<boolean>
806		924
807	Change the meaning of triple-click selection with the left mouse	925	Change the meaning of triple-click selection with the left mouse
808	button. Instead of selecting a full line it will extend the selection to	926	button. Instead of selecting a full line it will extend the selection to
809	the end of the logical line only. option B<-tcw>.	927	the end of the logical line only; option B<-tcw>.
810		928
811	=item B<insecure:> I<boolean>	929	=item B<insecure:> I<boolean>
812		930
813	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	931	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
814	echo arbitrary strings like the icon name or the locale. This could be	932	echo arbitrary strings like the icon name or the locale. This could be
815	abused if somebody gets 8-bit-clean access to your display, whether	933	abused if somebody gets 8-bit-clean access to your display, whether
816	throuh a mail client displaying mail bodies unfiltered or though	934	through a mail client displaying mail bodies unfiltered or through
817	write(1). Therefore, these sequences are disabled by default. (Note	935	write(1) or any other means. Therefore, these sequences are disabled by
818	that other terminals, including xterm, have these sequences	936	default. (Note that many other terminals, including xterm, have these
819	enabled by default). You can enable them by setting this boolean	937	sequences enabled by default, which doesn't make it safer, though).
820	resource or specifying B<-insecure> as an option. At the moment, this	938
821	enabled display-answer, locale, findfont, icon label and window title	939	You can enable them by setting this boolean resource or specifying
822	requests as well as dynamic menubar dispatch.	940	B<-insecure> as an option. At the moment, this enables display-answer,
		941	locale, findfont, icon label and window title requests as well as dynamic
		942	menubar dispatch.
823		943
824	=item B<modifier:> I<modifier>	944	=item B<modifier:> I<modifier>
825		945
826	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	946	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
827	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	947	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
841		961
842	Turn on/off secondary screen scroll (default enabled). If the this	962	Turn on/off secondary screen scroll (default enabled). If the this
843	option is enabled, scrolls on the secondary screen will change the	963	option is enabled, scrolls on the secondary screen will change the
844	scrollback buffer and switching to/from the secondary screen will	964	scrollback buffer and switching to/from the secondary screen will
845	instead scroll the screen up.	965	instead scroll the screen up.
		966
		967	=item B<hold>: I<bool>
		968
		969	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		970	will not immediately destroy its window when the program executed within
		971	it exits. Instead, it will wait till it is being killed or closed by the
		972	user.
846		973
847	=item B<keysym.>I<sym>: I<string>	974	=item B<keysym.>I<sym>: I<string>
848		975
849	Compile I<frills>: Associate I<string> with keysym I<sym>. The	976	Compile I<frills>: Associate I<string> with keysym I<sym>. The
850	intervening resource name B<keysym.> cannot be omitted.	977	intervening resource name B<keysym.> cannot be omitted.
…		…
896	example the following means "change the current locale to C<zh_CN.GBK>	1023	example the following means "change the current locale to C<zh_CN.GBK>
897	when Control-Meta-c is being pressed":	1024	when Control-Meta-c is being pressed":
898		1025
899	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1026	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
900		1027
		1028	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1029	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1030	manpage. For example, the F<selection> extension (activated via
		1031	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1032
		1033	URxvt.keysym.M-C-c: perl:selection:rot13
		1034
		1035	Due the the large number of modifier combinations, a defined key mapping
		1036	will match if at I<at least> the specified identifiers are being set, and
		1037	no other key mappings with those and more bits are being defined. That
		1038	means that defining a key map for C<a> will automatically provide
		1039	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		1040	mappings themselves.
		1041
		1042	Unfortunately, this will override built-in key mappings. For example
		1043	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		1044	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		1045	user-defined keymap using the C<builtin:> replacement:
		1046
		1047	URxvt.keysym.Insert: <my insert key sequence>
		1048	URxvt.keysym.S-Insert: builtin:
		1049
		1050	The first line defines a mapping for C<Insert> and I<any> combination
		1051	of modifiers. The second line re-establishes the default mapping for
		1052	C<Shift-Insert>.
		1053
901	The following example will map Control-Meta-1 and Control-Meta-2 to	1054	The following example will map Control-Meta-1 and Control-Meta-2 to
902	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited	1055	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
903	font-switching at runtime:	1056	font-switching at runtime:
904		1057
905	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1058	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
…		…
908	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1061	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
909	info):	1062	info):
910		1063
911	URxvt.keysym.M-C-3: command:\033[8;25;80t	1064	URxvt.keysym.M-C-3: command:\033[8;25;80t
912	URxvt.keysym.M-C-4: command:\033[8;48;110t	1065	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1066
		1067	=item B<perl-ext>: I<string>
		1068
		1069	Colon-separated list of perl extension scripts to use in this terminal
		1070	instance. Each extension is looked up in the library directories, loaded
		1071	if necessary, and bound to the current terminal instance. If this resource
		1072	is empty or missing, then the perl interpreter will not be initialized;
		1073	option B<-pe>.
		1074
		1075	=item B<perl-eval>: I<string>
		1076
		1077	Perl code to be evaluated when all extensions have been registered. See the
		1078	@@RXVT_NAME@@perl(3) manpage.
		1079
		1080	=item B<perl-lib>: I<path>
		1081
		1082	Colon-separated list of additional directories that hold extension
		1083	scripts. When looking for extensions specified by the C<perl> resource,
		1084	@@RXVT_NAME@@ will first look in these directories and then in
		1085	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
		1086
		1087	See the @@RXVT_NAME@@perl(3) manpage.
913		1088
914	=back	1089	=back
915		1090
916	=head1 THE SCROLLBAR	1091	=head1 THE SCROLLBAR
917		1092
…		…
931	the normal text selection/insertion, hold either the Shift or the Meta	1106	the normal text selection/insertion, hold either the Shift or the Meta
932	(Alt) key while performing the desired mouse action.	1107	(Alt) key while performing the desired mouse action.
933		1108
934	If mouse reporting mode is active, the normal scrollbar actions are	1109	If mouse reporting mode is active, the normal scrollbar actions are
935	disabled -- on the assumption that we are using a fullscreen	1110	disabled -- on the assumption that we are using a fullscreen
936	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	1111	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
937	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	1112	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
938	up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down),	1113	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
939	respectively.	1114	respectively.
940		1115
941	=head1 TEXT SELECTION AND INSERTION	1116	=head1 TEXT SELECTION AND INSERTION
942		1117
943	The behaviour of text selection and insertion mechanism is similar to	1118	The behaviour of text selection and insertion mechanism is similar to
…		…
952	to select a word; Left triple-click to select the entire logical line	1127	to select a word; Left triple-click to select the entire logical line
953	(which can span multiple screen lines), unless modified by resource	1128	(which can span multiple screen lines), unless modified by resource
954	B<tripleclickwords>.	1129	B<tripleclickwords>.
955		1130
956	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1131	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
957	(Compile: I<frills>) will create a rectangular selection instead of a normal	1132	(Compile: I<frills>) will create a rectangular selection instead of a
958	one.	1133	normal one. In this mode, every selected row becomes its own line in the
		1134	selection, and trailing whitespace is visually underlined and removed from
		1135	the selection.
959		1136
960	=item B<Insertion>:	1137	=item B<Insertion>:
961		1138
962	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1139	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
963	an B<@@RXVT_NAME@@> window causes the current text selection to be	1140	an B<@@RXVT_NAME@@> window causes the current text selection to be
…		…
971	supported in rxvt-unicode. Bug me if you need this.	1148	supported in rxvt-unicode. Bug me if you need this.
972		1149
973	You can, however, switch fonts at runtime using escape sequences (and	1150	You can, however, switch fonts at runtime using escape sequences (and
974	therefore using the menubar), e.g.:	1151	therefore using the menubar), e.g.:
975		1152
976	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1153	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
977		1154
978	rxvt-unicode will automatically re-apply these fonts to the output so far.	1155	rxvt-unicode will automatically re-apply these fonts to the output so far.
979		1156
980	=head1 ISO 14755 SUPPORT	1157	=head1 ISO 14755 SUPPORT
981		1158
…		…
1098		1275
1099	=back	1276	=back
1100		1277
1101	=head1 ENVIRONMENT	1278	=head1 ENVIRONMENT
1102		1279
1103	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>	1280	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1104	and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X	1281
1105	window id number of the B<@@RXVT_NAME@@> window and it also uses and	1282	=over 4
1106	sets the environment variable B<DISPLAY> to specify which display	1283
1107	terminal to use. B<@@RXVT_NAME@@> uses the environment variables	1284	=item B<TERM>
1108	B<RXVTPATH> and B<PATH> to find XPM files.	1285
		1286	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
		1287	resources or on the commandline.
		1288
		1289	=item B<COLORTERM>
		1290
		1291	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
		1292	compiled with XPM support, and optionally with the added extension
		1293	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
		1294
		1295	=item B<COLORFGBG>
		1296
		1297	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
		1298	the colour code used as default foreground/text colour (or the string
		1299	C<default> to indicate that the default-colour escape sequence is to be
		1300	used), C<bg> is the colour code used as default background colour (or the
		1301	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1302	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
		1303	(and do) use this information to optimize screen output.
		1304
		1305	=item B<WINDOWID>
		1306
		1307	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
		1308	window, which usually has subwindows for the scrollbar, the terminal
		1309	window and so on).
		1310
		1311	=item B<TERMINFO>
		1312
		1313	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1314	C<--with-terminfo=PATH>.
		1315
		1316	=item B<DISPLAY>
		1317
		1318	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
		1319	display in it's child processes.
		1320
		1321	=item B<SHELL>
		1322
		1323	The shell to be used for command execution, defaults to C</bin/sh>.
		1324
		1325	=item B<RXVTPATH>
		1326
		1327	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
		1328	files.
		1329
		1330	=item B<PATH>
		1331
		1332	Used in the same way as C<RXVTPATH>.
		1333
		1334	=item B<RXVT_SOCKET>
		1335
		1336	The unix domain socket path used by @@RXVT_NAME@@c(1) and
		1337	@@RXVT_NAME@@d(1).
		1338
		1339	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
		1340
		1341	=item B<HOME>
		1342
		1343	Used to locate the default directory for the unix domain socket for
		1344	daemon communications and to locate various resource files (such as
		1345	C<.Xdefaults>)
		1346
		1347	=item B<XAPPLRESDIR>
		1348
		1349	Directory where various X resource files are being located.
		1350
		1351	=item B<XENVIRONMENT>
		1352
		1353	If set and accessible, gives the name of a X resource file to be loaded by
		1354	@@RXVT_NAME@@.
		1355
		1356	=back
1109		1357
1110	=head1 FILES	1358	=head1 FILES
1111		1359
1112	=over 4	1360	=over 4
1113		1361
…		…
1117		1365
1118	=back	1366	=back
1119		1367
1120	=head1 SEE ALSO	1368	=head1 SEE ALSO
1121		1369
1122	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1370	@@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)
1123
1124	=head1 BUGS
1125
1126	Check the BUGS file for an up-to-date list.
1127
1128	Cursor change support is not yet implemented.
1129
1130	Click-and-drag doesn't work with X11 mouse report overriding.
1131		1371
1132	=head1 CURRENT PROJECT COORDINATOR	1372	=head1 CURRENT PROJECT COORDINATOR
1133		1373
1134	=over 4	1374	=over 4
1135		1375
1136	=item Project Coordinator	1376	=item Project Coordinator
1137		1377
1138	@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@>	1378	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1139		1379
1140	=item Web page maintainter	1380	L<http://software.schmorp.de/#rxvt-unicode>
1141
1142	@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1143
1144	L<@@RXVT_WEBPAGE@@>
1145		1381
1146	=back	1382	=back
1147		1383
1148	=head1 AUTHORS	1384	=head1 AUTHORS
1149		1385
…		…
1174	=item Geoff Wing L<< <gcw@pobox.com> >>	1410	=item Geoff Wing L<< <gcw@pobox.com> >>
1175		1411
1176	Rewrote screen display and text selection routines. Project Coordinator	1412	Rewrote screen display and text selection routines. Project Coordinator
1177	(changes.txt 2.4.6 - rxvt-unicode)	1413	(changes.txt 2.4.6 - rxvt-unicode)
1178		1414
1179	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>	1415	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1180		1416
1181	Forked rxvt-unicode, rewrote most of the display code and internal	1417	Forked rxvt-unicode, rewrote most of the display code and internal
1182	character handling to store text in unicode, improve xterm	1418	character handling to store text in unicode, improve xterm
1183	compatibility and apply numerous other bugfixes and extensions.	1419	compatibility and apply numerous other bugfixes and extensions.
1184		1420

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.48 by root, Thu Feb 3 10:24:10 2005 UTC vs. Revision 1.83 by root, Tue Jan 3 22:28:07 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.48 by root, Thu Feb 3 10:24:10 2005 UTC vs.
Revision 1.83 by root, Tue Jan 3 22:28:07 2006 UTC