[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.85 by root, Wed Jan 4 20:43:37 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 I<font-styles>: The bold font list to use when B<bold> characters
183	be printed. See resource B<boldFont> for details.	195	are to 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 I<font-styles>: The italic font list to use when I<italic>
188	be printed. See resource B<italicFont> for details.	200	characters are to 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 I<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 I<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
…		…
277	=item B<-bl>	296	=item B<-bl>
278		297
279	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.
280	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
281	decorations; resource B<borderLess>.	300	decorations; resource B<borderLess>.
		301
		302	=item B<-sbg>
		303
		304	Compile I<frills>: Disable the usage of the built-in block graphics/line
		305	drawing characters and just rely on what the specified fonts provide. Use
		306	this if you have a good font and want to use its block graphic glyphs;
		307	resource B<skipBuiltinGlyphs>.
282		308
283	=item B<-lsp> I<number>	309	=item B<-lsp> I<number>
284		310
285	Compile I<frills>: Lines (pixel height) to insert between each row of	311	Compile I<frills>: Lines (pixel height) to insert between each row of
286	the display. Useful to work around font rendering problems; resource	312	the display. Useful to work around font rendering problems; resource
…		…
301	given on the command line. If this option is used, it must be the last	327	given on the command line. If this option is used, it must be the last
302	on the command-line. If there is no B<-e> option then the default is to	328	on the command-line. If there is no B<-e> option then the default is to
303	run the program specified by the B<SHELL> environment variable or,	329	run the program specified by the B<SHELL> environment variable or,
304	failing that, I<sh(1)>.	330	failing that, I<sh(1)>.
305		331
		332	Please note that you must specify a program with arguments. If you want to
		333	run shell commands, you have to specify the shell, like this:
		334
		335	@@RXVT_NAME@@ -e sh -c "shell commands"
		336
306	=item B<-title> I<text>	337	=item B<-title> I<text>
307		338
308	Window title (B<-T> still respected); the default title is the basename	339	Window title (B<-T> still respected); the default title is the basename
309	of the program specified after the B<-e> option, if any, otherwise the	340	of the program specified after the B<-e> option, if any, otherwise the
310	application name; resource B<title>.	341	application name; resource B<title>.
…		…
366	=item B<-ssr>\|B<+ssr>	397	=item B<-ssr>\|B<+ssr>
367		398
368	Turn on/off secondary screen scroll (default enabled); resource	399	Turn on/off secondary screen scroll (default enabled); resource
369	B<secondaryScroll>.	400	B<secondaryScroll>.
370		401
		402	=item B<-hold>\|B<+hold>
		403
		404	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		405	will not immediately destroy its window when the program executed within
		406	it exits. Instead, it will wait till it is being killed or closed by the
		407	user; resource B<hold>.
		408
		409	=item B<-keysym.>I<sym> I<string>
		410
		411	Remap a key symbol. See resource B<keysym>.
		412
		413	=item B<-embed> I<windowid>
		414
		415	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
		416	which enables applications to easily embed a terminal.
		417
		418	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
		419	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
		420	quite a bit, so don't expect it to keep some specific state. It's best to
		421	create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
		422
		423	The window will not be destroyed when @@RXVT_NAME@@ exits.
		424
		425	It might be useful to know that @@RXVT_NAME@@ will not close file
		426	descriptors passed to it (except for stdin/out/err, of course), so you
		427	can use file descriptors to communicate with the programs within the
		428	terminal. This works regardless of wether the C<-embed> option was used or
		429	not.
		430
		431	Here is a short Gtk2-perl snippet that illustrates how this option can be
		432	used (a longer example is in F<doc/embed>):
		433
		434	my $rxvt = new Gtk2::Socket;
		435	$rxvt->signal_connect_after (realize => sub {
		436	my $xid = $_[0]->window->get_xid;
		437	system "@@RXVT_NAME@@ -embed $xid &";
		438	});
		439
		440	=item B<-pty-fd> I<fileno>
		441
		442	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
		443	pair but instead use the given filehandle as the tty master. This is
		444	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
		445	without having to run a program within it.
		446
		447	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
		448	entries and will not tinker with pty/tty permissions - you have to do that
		449	yourself if you want that.
		450
		451	Here is a example in perl that illustrates how this option can be used (a
		452	longer example is in F<doc/pty-fd>):
		453
		454	use IO::Pty;
		455	use Fcntl;
		456
		457	my $pty = new IO::Pty;
		458	fcntl $pty, F_SETFD, 0; # clear close-on-exec
		459	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		460	close $pty;
		461
		462	# now communicate with rxvt
		463	my $slave = $pty->slave;
		464	while (<$slave>) { print $slave "got <$_>\n" }
		465
371	=item B<-xrm> I<resourcestring>	466	=item B<-pe> I<string>
372		467
373	No effect on rxvt-unicode. Simply passes through an argument to be made	468	Colon-separated list of perl extension scripts to use in this terminal
374	available in the instance's argument list. Appears in I<WM_COMMAND> in	469	instance. See resource B<perl-ext>.
375	some window managers.
376		470
377	=back	471	=back
378		472
379	=head1 RESOURCES (available also as long-options)	473	=head1 RESOURCES (available also as long-options)
380		474
…		…
383		477
384	There are two different methods that @@RXVT_NAME@@ can use to get the	478	There are two different methods that @@RXVT_NAME@@ can use to get the
385	Xresource data: using the X libraries (Xrm*-functions) or internal	479	Xresource data: using the X libraries (Xrm*-functions) or internal
386	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	480	Xresources reader (B<~/.Xdefaults>). For the first method (ie.
387	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	481	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	482	resources using X11 tools like B<xrdb>. Many distribution do also load
389	settings from the B<~/.Xresources> file when X starts.	483	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
		484	will consult the following files/resources in order, with later settings
		485	overwriting earlier ones:
		486
		487	1. system-wide app-defaults file, either locale-dependent OR global
		488	2. app-defaults file in $XAPPLRESDIR
		489	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
		490	4. SCREEN_RESOURCES for the current screen
		491	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
390		492
391	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>	493	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
392	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults	494	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
393	set in XAPPLOADDIR/URxvt (compile-time defined: usually	495	set in XAPPLOADDIR/URxvt (compile-time defined: usually
394	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	496	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
…		…
487	artificial transparency. B<False>: do not inherit the parent windows'	589	artificial transparency. B<False>: do not inherit the parent windows'
488	pixmap.	590	pixmap.
489		591
490	=item B<fading:> I<number>	592	=item B<fading:> I<number>
491		593
492	Fade the text by the given percentage when focus is lost.	594	Fade the text by the given percentage when focus is lost; option B<-fade>.
		595
		596	=item B<fadeColor:> I<colour>
		597
		598	Fade to this colour, when fading is used (see B<fading:>). The default
		599	colour is black; option B<-fadecolor>.
493		600
494	=item B<tintColor:> I<colour>	601	=item B<tintColor:> I<colour>
495		602
496	Tint the transparent background pixmap with the given colour.	603	Tint the transparent background pixmap with the given colour; option
		604	B<-tint>.
497		605
498	=item B<shading:> I<number>	606	=item B<shading:> I<number>
499		607
500	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	608	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
501	image in addition to tinting it.	609	image in addition to tinting it.
…		…
505	Use the specified colour for the scrollbar [default #B2B2B2].	613	Use the specified colour for the scrollbar [default #B2B2B2].
506		614
507	=item B<troughColor:> I<colour>	615	=item B<troughColor:> I<colour>
508		616
509	Use the specified colour for the scrollbar's trough area [default	617	Use the specified colour for the scrollbar's trough area [default
510	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	618	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
511		619
512	=item B<borderColor:> I<colour>	620	=item B<borderColor:> I<colour>
513		621
514	The colour of the border around the text area and between the scrollbar	622	The colour of the border around the text area and between the scrollbar
515	and the text.	623	and the text.
…		…
542		650
543	Select the fonts to be used. This is a comma separated list of font	651	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.	652	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	653	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	654	be smaller, but not larger. A reasonable default font list is always
547	appended to it. option B<-fn>.	655	appended to it; option B<-fn>.
548		656
549	Each font can either be a standard X11 core font (XLFD) name, with	657	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:>.	658	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
551		659
552	In addition, each font can be prefixed with additional hints and	660	In addition, each font can be prefixed with additional hints and
…		…
598	not possible, replacement fonts of the desired shape will be tried.	706	not possible, replacement fonts of the desired shape will be tried.
599		707
600	If set, but empty, then this specific style is disabled and the normal	708	If set, but empty, then this specific style is disabled and the normal
601	text font will being used for the given style.	709	text font will being used for the given style.
602		710
		711	=item B<intensityStyles:> I<boolean>
		712
		713	When font styles are not enabled, or this option is enabled (B<True>,
		714	option B<-is>, the default), bold and italic font styles imply high
		715	intensity foreground/backround colours. Disabling this option (B<False>,
		716	option B<+is>) disables this behaviour, the high intensity colours are not
		717	reachable.
		718
603	=item B<selectstyle:> I<mode>	719	=item B<selectstyle:> I<mode>
604		720
605	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	721	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	722	xterm style with 2.20 old word selection, or anything else which gives
607	xterm style selection.	723	xterm style selection.
608		724
609	=item B<scrollstyle:> I<mode>	725	=item B<scrollstyle:> I<mode>
610		726
611	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	727	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
612	the author's favourite..	728	the author's favourite.
613		729
614	=item B<title:> I<string>	730	=item B<title:> I<string>
615		731
616	Set window title string, the default title is the command-line	732	Set window title string, the default title is the command-line
617	specified after the B<-e> option, if any, otherwise the application	733	specified after the B<-e> option, if any, otherwise the application
…		…
649		765
650	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	766	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	767	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.	768	B<Shift-Print> to include the scrollback as well.
653		769
		770	The string will be interpreted as if typed into the shell as-is.
		771
		772	Example:
		773
		774	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		775
		776	This creates a new file in your home directory with the screen contents
		777	everytime you hit C<Print>.
		778
654	=item B<scrollBar:> I<boolean>	779	=item B<scrollBar:> I<boolean>
655		780
656	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	781	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
657	disable the scrollbar; option B<+sb>.	782	disable the scrollbar; option B<+sb>.
658		783
…		…
678	B<+si>.	803	B<+si>.
679		804
680	=item B<scrollWithBuffer:> I<boolean>	805	=item B<scrollWithBuffer:> I<boolean>
681		806
682	B<True>: scroll with scrollback buffer when tty receives new lines (and	807	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	808	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
684	with scrollback buffer when tty recieves new lines; option B<-sw>.	809	with scrollback buffer when tty recieves new lines; option B<+sw>.
685		810
686	=item B<scrollTtyKeypress:> I<boolean>	811	=item B<scrollTtyKeypress:> I<boolean>
687		812
688	B<True>: scroll to bottom when a non-special key is pressed. Special keys	813	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	814	are those which are intercepted by rxvt-unicode for special handling and
…		…
708	=item B<borderLess:> I<boolean>	833	=item B<borderLess:> I<boolean>
709		834
710	Set MWM hints to request a borderless window, i.e. if honoured by the	835	Set MWM hints to request a borderless window, i.e. if honoured by the
711	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.	836	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
712		837
		838	=item B<skipBuiltinGlyphs:> I<boolean>
		839
		840	Compile I<frills>: Disable the usage of the built-in block graphics/line
		841	drawing characters and just rely on what the specified fonts provide. Use
		842	this if you have a good font and want to use its block graphic glyphs;
		843	option B<-sbg>.
		844
713	=item B<termName:> I<termname>	845	=item B<termName:> I<termname>
714		846
715	Specifies the terminal type name to be set in the B<TERM> environment	847	Specifies the terminal type name to be set in the B<TERM> environment
716	variable; option B<-tn>.	848	variable; option B<-tn>.
717		849
…		…
754		886
755	Mouse pointer background colour.	887	Mouse pointer background colour.
756		888
757	=item B<pointerBlankDelay:> I<number>	889	=item B<pointerBlankDelay:> I<number>
758		890
759	Specifies number of seconds before blanking the pointer [default 2].	891	Specifies number of seconds before blanking the pointer [default 2]. Use a
		892	large number (e.g. C<987654321>) to effectively disable the timeout.
760		893
761	=item B<backspacekey:> I<string>	894	=item B<backspacekey:> I<string>
762		895
763	The string to send when the backspace key is pressed. If set to B<DEC>	896	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>	897	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
…		…
789	=item B<imLocale:> I<name>	922	=item B<imLocale:> I<name>
790		923
791	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.
792	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
793	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
794	another locale. option B<-imlocale>.	927	another locale; option B<-imlocale>.
795		928
796	=item B<imFont:> I<fontset>	929	=item B<imFont:> I<fontset>
797		930
798	Specify the font-set used for XIM styles C<OverTheSpot> or	931	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	932	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
…		…
804		937
805	=item B<tripleclickwords:> I<boolean>	938	=item B<tripleclickwords:> I<boolean>
806		939
807	Change the meaning of triple-click selection with the left mouse	940	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	941	button. Instead of selecting a full line it will extend the selection to
809	the end of the logical line only. option B<-tcw>.	942	the end of the logical line only; option B<-tcw>.
810		943
811	=item B<insecure:> I<boolean>	944	=item B<insecure:> I<boolean>
812		945
813	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	946	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
814	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
815	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
816	throuh a mail client displaying mail bodies unfiltered or though	949	through a mail client displaying mail bodies unfiltered or through
817	write(1). Therefore, these sequences are disabled by default. (Note	950	write(1) or any other means. Therefore, these sequences are disabled by
818	that other terminals, including xterm, have these sequences	951	default. (Note that many other terminals, including xterm, have these
819	enabled by default). You can enable them by setting this boolean	952	sequences enabled by default, which doesn't make it safer, though).
820	resource or specifying B<-insecure> as an option. At the moment, this	953
821	enabled display-answer, locale, findfont, icon label and window title	954	You can enable them by setting this boolean resource or specifying
822	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 as well as dynamic
		957	menubar dispatch.
823		958
824	=item B<modifier:> I<modifier>	959	=item B<modifier:> I<modifier>
825		960
826	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	961	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	962	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
841		976
842	Turn on/off secondary screen scroll (default enabled). If the this	977	Turn on/off secondary screen scroll (default enabled). If the this
843	option is enabled, scrolls on the secondary screen will change the	978	option is enabled, scrolls on the secondary screen will change the
844	scrollback buffer and switching to/from the secondary screen will	979	scrollback buffer and switching to/from the secondary screen will
845	instead scroll the screen up.	980	instead scroll the screen up.
		981
		982	=item B<hold>: I<bool>
		983
		984	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		985	will not immediately destroy its window when the program executed within
		986	it exits. Instead, it will wait till it is being killed or closed by the
		987	user.
846		988
847	=item B<keysym.>I<sym>: I<string>	989	=item B<keysym.>I<sym>: I<string>
848		990
849	Compile I<frills>: Associate I<string> with keysym I<sym>. The	991	Compile I<frills>: Associate I<string> with keysym I<sym>. The
850	intervening resource name B<keysym.> cannot be omitted.	992	intervening resource name B<keysym.> cannot be omitted.
…		…
896	example the following means "change the current locale to C<zh_CN.GBK>	1038	example the following means "change the current locale to C<zh_CN.GBK>
897	when Control-Meta-c is being pressed":	1039	when Control-Meta-c is being pressed":
898		1040
899	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1041	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
900		1042
		1043	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1044	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1045	manpage. For example, the F<selection> extension (activated via
		1046	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1047
		1048	URxvt.keysym.M-C-c: perl:selection:rot13
		1049
		1050	Due the the large number of modifier combinations, a defined key mapping
		1051	will match if at I<at least> the specified identifiers are being set, and
		1052	no other key mappings with those and more bits are being defined. That
		1053	means that defining a key map for C<a> will automatically provide
		1054	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		1055	mappings themselves.
		1056
		1057	Unfortunately, this will override built-in key mappings. For example
		1058	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		1059	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		1060	user-defined keymap using the C<builtin:> replacement:
		1061
		1062	URxvt.keysym.Insert: <my insert key sequence>
		1063	URxvt.keysym.S-Insert: builtin:
		1064
		1065	The first line defines a mapping for C<Insert> and I<any> combination
		1066	of modifiers. The second line re-establishes the default mapping for
		1067	C<Shift-Insert>.
		1068
901	The following example will map Control-Meta-1 and Control-Meta-2 to	1069	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	1070	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
903	font-switching at runtime:	1071	font-switching at runtime:
904		1072
905	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1073	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
…		…
908	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1076	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
909	info):	1077	info):
910		1078
911	URxvt.keysym.M-C-3: command:\033[8;25;80t	1079	URxvt.keysym.M-C-3: command:\033[8;25;80t
912	URxvt.keysym.M-C-4: command:\033[8;48;110t	1080	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1081
		1082	=item B<perl-ext-common>: I<string>
		1083
		1084	=item B<perl-ext>: I<string>
		1085
		1086	Colon-separated list(s) of perl extension scripts to use in this terminal
		1087	instance. Each extension is looked up in the library directories, loaded
		1088	if necessary, and bound to the current terminal instance. If this
		1089	resource is empty or missing, then the perl interpreter will not be
		1090	initialized. The idea behind two options is that B<perl-ext-common> will
		1091	be used for extensions that should be available to all instances, while
		1092	B<perl-ext> is used for specific instances; option B<-pe>.
		1093
		1094	=item B<perl-eval>: I<string>
		1095
		1096	Perl code to be evaluated when all extensions have been registered. See the
		1097	@@RXVT_NAME@@perl(3) manpage.
		1098
		1099	=item B<perl-lib>: I<path>
		1100
		1101	Colon-separated list of additional directories that hold extension
		1102	scripts. When looking for extensions specified by the C<perl> resource,
		1103	@@RXVT_NAME@@ will first look in these directories and then in
		1104	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
		1105
		1106	See the @@RXVT_NAME@@perl(3) manpage.
913		1107
914	=back	1108	=back
915		1109
916	=head1 THE SCROLLBAR	1110	=head1 THE SCROLLBAR
917		1111
…		…
931	the normal text selection/insertion, hold either the Shift or the Meta	1125	the normal text selection/insertion, hold either the Shift or the Meta
932	(Alt) key while performing the desired mouse action.	1126	(Alt) key while performing the desired mouse action.
933		1127
934	If mouse reporting mode is active, the normal scrollbar actions are	1128	If mouse reporting mode is active, the normal scrollbar actions are
935	disabled -- on the assumption that we are using a fullscreen	1129	disabled -- on the assumption that we are using a fullscreen
936	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	1130	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
937	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	1131	(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),	1132	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
939	respectively.	1133	respectively.
940		1134
941	=head1 TEXT SELECTION AND INSERTION	1135	=head1 TEXT SELECTION AND INSERTION
942		1136
943	The behaviour of text selection and insertion mechanism is similar to	1137	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	1146	to select a word; Left triple-click to select the entire logical line
953	(which can span multiple screen lines), unless modified by resource	1147	(which can span multiple screen lines), unless modified by resource
954	B<tripleclickwords>.	1148	B<tripleclickwords>.
955		1149
956	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1150	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	1151	(Compile: I<frills>) will create a rectangular selection instead of a
958	one.	1152	normal one. In this mode, every selected row becomes its own line in the
		1153	selection, and trailing whitespace is visually underlined and removed from
		1154	the selection.
959		1155
960	=item B<Insertion>:	1156	=item B<Insertion>:
961		1157
962	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1158	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	1159	an B<@@RXVT_NAME@@> window causes the current text selection to be
…		…
971	supported in rxvt-unicode. Bug me if you need this.	1167	supported in rxvt-unicode. Bug me if you need this.
972		1168
973	You can, however, switch fonts at runtime using escape sequences (and	1169	You can, however, switch fonts at runtime using escape sequences (and
974	therefore using the menubar), e.g.:	1170	therefore using the menubar), e.g.:
975		1171
976	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1172	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
977		1173
978	rxvt-unicode will automatically re-apply these fonts to the output so far.	1174	rxvt-unicode will automatically re-apply these fonts to the output so far.
979		1175
980	=head1 ISO 14755 SUPPORT	1176	=head1 ISO 14755 SUPPORT
981		1177
…		…
1098		1294
1099	=back	1295	=back
1100		1296
1101	=head1 ENVIRONMENT	1297	=head1 ENVIRONMENT
1102		1298
1103	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>	1299	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	1300
1105	window id number of the B<@@RXVT_NAME@@> window and it also uses and	1301	=over 4
1106	sets the environment variable B<DISPLAY> to specify which display	1302
1107	terminal to use. B<@@RXVT_NAME@@> uses the environment variables	1303	=item B<TERM>
1108	B<RXVTPATH> and B<PATH> to find XPM files.	1304
		1305	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
		1306	resources or on the commandline.
		1307
		1308	=item B<COLORTERM>
		1309
		1310	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
		1311	compiled with XPM support, and optionally with the added extension
		1312	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
		1313
		1314	=item B<COLORFGBG>
		1315
		1316	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
		1317	the colour code used as default foreground/text colour (or the string
		1318	C<default> to indicate that the default-colour escape sequence is to be
		1319	used), C<bg> is the colour code used as default background colour (or the
		1320	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1321	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
		1322	(and do) use this information to optimize screen output.
		1323
		1324	=item B<WINDOWID>
		1325
		1326	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
		1327	window, which usually has subwindows for the scrollbar, the terminal
		1328	window and so on).
		1329
		1330	=item B<TERMINFO>
		1331
		1332	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1333	C<--with-terminfo=PATH>.
		1334
		1335	=item B<DISPLAY>
		1336
		1337	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
		1338	display in it's child processes.
		1339
		1340	=item B<SHELL>
		1341
		1342	The shell to be used for command execution, defaults to C</bin/sh>.
		1343
		1344	=item B<RXVTPATH>
		1345
		1346	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
		1347	files.
		1348
		1349	=item B<PATH>
		1350
		1351	Used in the same way as C<RXVTPATH>.
		1352
		1353	=item B<RXVT_SOCKET>
		1354
		1355	The unix domain socket path used by @@RXVT_NAME@@c(1) and
		1356	@@RXVT_NAME@@d(1).
		1357
		1358	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
		1359
		1360	=item B<HOME>
		1361
		1362	Used to locate the default directory for the unix domain socket for
		1363	daemon communications and to locate various resource files (such as
		1364	C<.Xdefaults>)
		1365
		1366	=item B<XAPPLRESDIR>
		1367
		1368	Directory where various X resource files are being located.
		1369
		1370	=item B<XENVIRONMENT>
		1371
		1372	If set and accessible, gives the name of a X resource file to be loaded by
		1373	@@RXVT_NAME@@.
		1374
		1375	=back
1109		1376
1110	=head1 FILES	1377	=head1 FILES
1111		1378
1112	=over 4	1379	=over 4
1113		1380
…		…
1117		1384
1118	=back	1385	=back
1119		1386
1120	=head1 SEE ALSO	1387	=head1 SEE ALSO
1121		1388
1122	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1389	@@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		1390
1132	=head1 CURRENT PROJECT COORDINATOR	1391	=head1 CURRENT PROJECT COORDINATOR
1133		1392
1134	=over 4	1393	=over 4
1135		1394
1136	=item Project Coordinator	1395	=item Project Coordinator
1137		1396
1138	@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@>	1397	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1139		1398
1140	=item Web page maintainter	1399	L<http://software.schmorp.de/#rxvt-unicode>
1141
1142	@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1143
1144	L<@@RXVT_WEBPAGE@@>
1145		1400
1146	=back	1401	=back
1147		1402
1148	=head1 AUTHORS	1403	=head1 AUTHORS
1149		1404
…		…
1174	=item Geoff Wing L<< <gcw@pobox.com> >>	1429	=item Geoff Wing L<< <gcw@pobox.com> >>
1175		1430
1176	Rewrote screen display and text selection routines. Project Coordinator	1431	Rewrote screen display and text selection routines. Project Coordinator
1177	(changes.txt 2.4.6 - rxvt-unicode)	1432	(changes.txt 2.4.6 - rxvt-unicode)
1178		1433
1179	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>	1434	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1180		1435
1181	Forked rxvt-unicode, rewrote most of the display code and internal	1436	Forked rxvt-unicode, rewrote most of the display code and internal
1182	character handling to store text in unicode, improve xterm	1437	character handling to store text in unicode, improve xterm
1183	compatibility and apply numerous other bugfixes and extensions.	1438	compatibility and apply numerous other bugfixes and extensions.
1184		1439

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.85 by root, Wed Jan 4 20:43:37 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.85 by root, Wed Jan 4 20:43:37 2006 UTC