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

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.82 by root, Tue Jan 3 18:11:34 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.82 by root, Tue Jan 3 18:11:34 2006 UTC