[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.92 by root, Wed Jan 11 02:13:55 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<file descriptor>
		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	As an extremely special case, specifying C<-1> will completely suppress
		452	pty/tty operations.
		453
		454	Here is a example in perl that illustrates how this option can be used (a
		455	longer example is in F<doc/pty-fd>):
		456
		457	use IO::Pty;
		458	use Fcntl;
		459
		460	my $pty = new IO::Pty;
		461	fcntl $pty, F_SETFD, 0; # clear close-on-exec
		462	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		463	close $pty;
		464
		465	# now communicate with rxvt
		466	my $slave = $pty->slave;
		467	while (<$slave>) { print $slave "got <$_>\n" }
		468
371	=item B<-xrm> I<resourcestring>	469	=item B<-pe> I<string>
372		470
373	No effect on rxvt-unicode. Simply passes through an argument to be made	471	Comma-separated list of perl extension scripts to use (or not to use) in
374	available in the instance's argument list. Appears in I<WM_COMMAND> in	472	this terminal instance. See resource B<perl-ext> for details.
375	some window managers.
376		473
377	=back	474	=back
378		475
379	=head1 RESOURCES (available also as long-options)	476	=head1 RESOURCES (available also as long-options)
380		477
…		…
383		480
384	There are two different methods that @@RXVT_NAME@@ can use to get the	481	There are two different methods that @@RXVT_NAME@@ can use to get the
385	Xresource data: using the X libraries (Xrm*-functions) or internal	482	Xresource data: using the X libraries (Xrm*-functions) or internal
386	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	483	Xresources reader (B<~/.Xdefaults>). For the first method (ie.
387	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	484	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	485	resources using X11 tools like B<xrdb>. Many distribution do also load
389	settings from the B<~/.Xresources> file when X starts.	486	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
		487	will consult the following files/resources in order, with later settings
		488	overwriting earlier ones:
		489
		490	1. system-wide app-defaults file, either locale-dependent OR global
		491	2. app-defaults file in $XAPPLRESDIR
		492	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
		493	4. SCREEN_RESOURCES for the current screen
		494	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
390		495
391	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>	496	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
392	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults	497	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
393	set in XAPPLOADDIR/URxvt (compile-time defined: usually	498	set in XAPPLOADDIR/URxvt (compile-time defined: usually
394	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	499	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
…		…
487	artificial transparency. B<False>: do not inherit the parent windows'	592	artificial transparency. B<False>: do not inherit the parent windows'
488	pixmap.	593	pixmap.
489		594
490	=item B<fading:> I<number>	595	=item B<fading:> I<number>
491		596
492	Fade the text by the given percentage when focus is lost.	597	Fade the text by the given percentage when focus is lost; option B<-fade>.
		598
		599	=item B<fadeColor:> I<colour>
		600
		601	Fade to this colour, when fading is used (see B<fading:>). The default
		602	colour is black; option B<-fadecolor>.
493		603
494	=item B<tintColor:> I<colour>	604	=item B<tintColor:> I<colour>
495		605
496	Tint the transparent background pixmap with the given colour.	606	Tint the transparent background pixmap with the given colour; option
		607	B<-tint>.
497		608
498	=item B<shading:> I<number>	609	=item B<shading:> I<number>
499		610
500	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	611	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
501	image in addition to tinting it.	612	image in addition to tinting it.
…		…
505	Use the specified colour for the scrollbar [default #B2B2B2].	616	Use the specified colour for the scrollbar [default #B2B2B2].
506		617
507	=item B<troughColor:> I<colour>	618	=item B<troughColor:> I<colour>
508		619
509	Use the specified colour for the scrollbar's trough area [default	620	Use the specified colour for the scrollbar's trough area [default
510	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	621	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
511		622
512	=item B<borderColor:> I<colour>	623	=item B<borderColor:> I<colour>
513		624
514	The colour of the border around the text area and between the scrollbar	625	The colour of the border around the text area and between the scrollbar
515	and the text.	626	and the text.
…		…
542		653
543	Select the fonts to be used. This is a comma separated list of font	654	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.	655	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	656	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	657	be smaller, but not larger. A reasonable default font list is always
547	appended to it. option B<-fn>.	658	appended to it; option B<-fn>.
548		659
549	Each font can either be a standard X11 core font (XLFD) name, with	660	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:>.	661	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
551		662
552	In addition, each font can be prefixed with additional hints and	663	In addition, each font can be prefixed with additional hints and
…		…
598	not possible, replacement fonts of the desired shape will be tried.	709	not possible, replacement fonts of the desired shape will be tried.
599		710
600	If set, but empty, then this specific style is disabled and the normal	711	If set, but empty, then this specific style is disabled and the normal
601	text font will being used for the given style.	712	text font will being used for the given style.
602		713
		714	=item B<intensityStyles:> I<boolean>
		715
		716	When font styles are not enabled, or this option is enabled (B<True>,
		717	option B<-is>, the default), bold and italic font styles imply high
		718	intensity foreground/backround colours. Disabling this option (B<False>,
		719	option B<+is>) disables this behaviour, the high intensity colours are not
		720	reachable.
		721
603	=item B<selectstyle:> I<mode>	722	=item B<selectstyle:> I<mode>
604		723
605	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	724	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	725	xterm style with 2.20 old word selection, or anything else which gives
607	xterm style selection.	726	xterm style selection.
608		727
609	=item B<scrollstyle:> I<mode>	728	=item B<scrollstyle:> I<mode>
610		729
611	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	730	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
612	the author's favourite..	731	the author's favourite.
613		732
614	=item B<title:> I<string>	733	=item B<title:> I<string>
615		734
616	Set window title string, the default title is the command-line	735	Set window title string, the default title is the command-line
617	specified after the B<-e> option, if any, otherwise the application	736	specified after the B<-e> option, if any, otherwise the application
…		…
649		768
650	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	769	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	770	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.	771	B<Shift-Print> to include the scrollback as well.
653		772
		773	The string will be interpreted as if typed into the shell as-is.
		774
		775	Example:
		776
		777	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		778
		779	This creates a new file in your home directory with the screen contents
		780	everytime you hit C<Print>.
		781
654	=item B<scrollBar:> I<boolean>	782	=item B<scrollBar:> I<boolean>
655		783
656	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	784	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
657	disable the scrollbar; option B<+sb>.	785	disable the scrollbar; option B<+sb>.
658		786
…		…
678	B<+si>.	806	B<+si>.
679		807
680	=item B<scrollWithBuffer:> I<boolean>	808	=item B<scrollWithBuffer:> I<boolean>
681		809
682	B<True>: scroll with scrollback buffer when tty receives new lines (and	810	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	811	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
684	with scrollback buffer when tty recieves new lines; option B<-sw>.	812	with scrollback buffer when tty recieves new lines; option B<+sw>.
685		813
686	=item B<scrollTtyKeypress:> I<boolean>	814	=item B<scrollTtyKeypress:> I<boolean>
687		815
688	B<True>: scroll to bottom when a non-special key is pressed. Special keys	816	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	817	are those which are intercepted by rxvt-unicode for special handling and
…		…
708	=item B<borderLess:> I<boolean>	836	=item B<borderLess:> I<boolean>
709		837
710	Set MWM hints to request a borderless window, i.e. if honoured by the	838	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>.	839	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
712		840
		841	=item B<skipBuiltinGlyphs:> I<boolean>
		842
		843	Compile I<frills>: Disable the usage of the built-in block graphics/line
		844	drawing characters and just rely on what the specified fonts provide. Use
		845	this if you have a good font and want to use its block graphic glyphs;
		846	option B<-sbg>.
		847
713	=item B<termName:> I<termname>	848	=item B<termName:> I<termname>
714		849
715	Specifies the terminal type name to be set in the B<TERM> environment	850	Specifies the terminal type name to be set in the B<TERM> environment
716	variable; option B<-tn>.	851	variable; option B<-tn>.
717		852
…		…
754		889
755	Mouse pointer background colour.	890	Mouse pointer background colour.
756		891
757	=item B<pointerBlankDelay:> I<number>	892	=item B<pointerBlankDelay:> I<number>
758		893
759	Specifies number of seconds before blanking the pointer [default 2].	894	Specifies number of seconds before blanking the pointer [default 2]. Use a
		895	large number (e.g. C<987654321>) to effectively disable the timeout.
760		896
761	=item B<backspacekey:> I<string>	897	=item B<backspacekey:> I<string>
762		898
763	The string to send when the backspace key is pressed. If set to B<DEC>	899	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>	900	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
…		…
789	=item B<imLocale:> I<name>	925	=item B<imLocale:> I<name>
790		926
791	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.	927	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	928	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	929	input extension to be able to input japanese characters while staying in
794	another locale. option B<-imlocale>.	930	another locale; option B<-imlocale>.
795		931
796	=item B<imFont:> I<fontset>	932	=item B<imFont:> I<fontset>
797		933
798	Specify the font-set used for XIM styles C<OverTheSpot> or	934	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	935	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
…		…
804		940
805	=item B<tripleclickwords:> I<boolean>	941	=item B<tripleclickwords:> I<boolean>
806		942
807	Change the meaning of triple-click selection with the left mouse	943	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	944	button. Instead of selecting a full line it will extend the selection to
809	the end of the logical line only. option B<-tcw>.	945	the end of the logical line only; option B<-tcw>.
810		946
811	=item B<insecure:> I<boolean>	947	=item B<insecure:> I<boolean>
812		948
813	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	949	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
814	echo arbitrary strings like the icon name or the locale. This could be	950	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	951	abused if somebody gets 8-bit-clean access to your display, whether
816	throuh a mail client displaying mail bodies unfiltered or though	952	through a mail client displaying mail bodies unfiltered or through
817	write(1). Therefore, these sequences are disabled by default. (Note	953	write(1) or any other means. Therefore, these sequences are disabled by
818	that other terminals, including xterm, have these sequences	954	default. (Note that many other terminals, including xterm, have these
819	enabled by default). You can enable them by setting this boolean	955	sequences enabled by default, which doesn't make it safer, though).
820	resource or specifying B<-insecure> as an option. At the moment, this	956
821	enabled display-answer, locale, findfont, icon label and window title	957	You can enable them by setting this boolean resource or specifying
822	requests as well as dynamic menubar dispatch.	958	B<-insecure> as an option. At the moment, this enables display-answer,
		959	locale, findfont, icon label and window title requests as well as dynamic
		960	menubar dispatch.
823		961
824	=item B<modifier:> I<modifier>	962	=item B<modifier:> I<modifier>
825		963
826	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	964	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	965	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
841		979
842	Turn on/off secondary screen scroll (default enabled). If the this	980	Turn on/off secondary screen scroll (default enabled). If the this
843	option is enabled, scrolls on the secondary screen will change the	981	option is enabled, scrolls on the secondary screen will change the
844	scrollback buffer and switching to/from the secondary screen will	982	scrollback buffer and switching to/from the secondary screen will
845	instead scroll the screen up.	983	instead scroll the screen up.
		984
		985	=item B<hold>: I<bool>
		986
		987	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		988	will not immediately destroy its window when the program executed within
		989	it exits. Instead, it will wait till it is being killed or closed by the
		990	user.
846		991
847	=item B<keysym.>I<sym>: I<string>	992	=item B<keysym.>I<sym>: I<string>
848		993
849	Compile I<frills>: Associate I<string> with keysym I<sym>. The	994	Compile I<frills>: Associate I<string> with keysym I<sym>. The
850	intervening resource name B<keysym.> cannot be omitted.	995	intervening resource name B<keysym.> cannot be omitted.
…		…
896	example the following means "change the current locale to C<zh_CN.GBK>	1041	example the following means "change the current locale to C<zh_CN.GBK>
897	when Control-Meta-c is being pressed":	1042	when Control-Meta-c is being pressed":
898		1043
899	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1044	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
900		1045
		1046	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1047	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1048	manpage. For example, the F<selection> extension (activated via
		1049	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1050
		1051	URxvt.keysym.M-C-c: perl:selection:rot13
		1052
		1053	Due the the large number of modifier combinations, a defined key mapping
		1054	will match if at I<at least> the specified identifiers are being set, and
		1055	no other key mappings with those and more bits are being defined. That
		1056	means that defining a key map for C<a> will automatically provide
		1057	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		1058	mappings themselves.
		1059
		1060	Unfortunately, this will override built-in key mappings. For example
		1061	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		1062	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		1063	user-defined keymap using the C<builtin:> replacement:
		1064
		1065	URxvt.keysym.Insert: <my insert key sequence>
		1066	URxvt.keysym.S-Insert: builtin:
		1067
		1068	The first line defines a mapping for C<Insert> and I<any> combination
		1069	of modifiers. The second line re-establishes the default mapping for
		1070	C<Shift-Insert>.
		1071
901	The following example will map Control-Meta-1 and Control-Meta-2 to	1072	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	1073	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
903	font-switching at runtime:	1074	font-switching at runtime:
904		1075
905	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1076	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
…		…
908	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1079	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
909	info):	1080	info):
910		1081
911	URxvt.keysym.M-C-3: command:\033[8;25;80t	1082	URxvt.keysym.M-C-3: command:\033[8;25;80t
912	URxvt.keysym.M-C-4: command:\033[8;48;110t	1083	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1084
		1085	=item B<perl-ext-common>: I<string>
		1086
		1087	=item B<perl-ext>: I<string>
		1088
		1089	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1090	use in this terminal instance; option B<-pe>.
		1091
		1092	Extension names can be prefixed with a C<-> sign to prohibit using
		1093	them. This can be useful to selectively disable some extensions loaded
		1094	by default, or specified via the C<perl-ext-common> resource. For
		1095	example, C<default,-selection> will use all the default extension except
		1096	C<selection>.
		1097
		1098	Extension names can also be followed by an argument in angle brackets
		1099	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1100	searchable scorllback to Alt/Meta-s). Mentioning the same extension
		1101	multiple times with different arguments will pass multiple arguments to
		1102	the extension.
		1103
		1104	Each extension is looked up in the library directories, loaded if
		1105	necessary, and bound to the current terminal instance.
		1106
		1107	If both of these resources are the empty string, then the perl
		1108	interpreter will not be initialized. The idea behind two options is that
		1109	B<perl-ext-common> will be used for extensions that should be available to
		1110	all instances, while B<perl-ext> is used for specific instances.
		1111
		1112	=item B<perl-eval>: I<string>
		1113
		1114	Perl code to be evaluated when all extensions have been registered. See
		1115	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
		1116	will be ignored when running setuid/setgid.
		1117
		1118	=item B<perl-lib>: I<path>
		1119
		1120	Colon-separated list of additional directories that hold extension
		1121	scripts. When looking for extensions specified by the C<perl> resource,
		1122	@@RXVT_NAME@@ will first look in these directories and then in
		1123	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
		1124	will be ignored when running setuid/setgid.
		1125
		1126	See the @@RXVT_NAME@@perl(3) manpage.
		1127
		1128	=item B<urlLauncher>: I<string>
		1129
		1130	Specifies the program to be started with a URL argument. Used by the
		1131	C<selection-popup> and C<mark-urls> perl extensions.
		1132
		1133	=item B<transient-for>: I<windowid>
		1134
		1135	Sets the WM_TRANSIENT_FOR property to the given window iw.
913		1136
914	=back	1137	=back
915		1138
916	=head1 THE SCROLLBAR	1139	=head1 THE SCROLLBAR
917		1140
…		…
931	the normal text selection/insertion, hold either the Shift or the Meta	1154	the normal text selection/insertion, hold either the Shift or the Meta
932	(Alt) key while performing the desired mouse action.	1155	(Alt) key while performing the desired mouse action.
933		1156
934	If mouse reporting mode is active, the normal scrollbar actions are	1157	If mouse reporting mode is active, the normal scrollbar actions are
935	disabled -- on the assumption that we are using a fullscreen	1158	disabled -- on the assumption that we are using a fullscreen
936	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	1159	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
937	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	1160	(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),	1161	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
939	respectively.	1162	respectively.
940		1163
941	=head1 TEXT SELECTION AND INSERTION	1164	=head1 TEXT SELECTION AND INSERTION
942		1165
943	The behaviour of text selection and insertion mechanism is similar to	1166	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	1175	to select a word; Left triple-click to select the entire logical line
953	(which can span multiple screen lines), unless modified by resource	1176	(which can span multiple screen lines), unless modified by resource
954	B<tripleclickwords>.	1177	B<tripleclickwords>.
955		1178
956	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1179	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	1180	(Compile: I<frills>) will create a rectangular selection instead of a
958	one.	1181	normal one. In this mode, every selected row becomes its own line in the
		1182	selection, and trailing whitespace is visually underlined and removed from
		1183	the selection.
959		1184
960	=item B<Insertion>:	1185	=item B<Insertion>:
961		1186
962	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1187	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	1188	an B<@@RXVT_NAME@@> window causes the current text selection to be
…		…
971	supported in rxvt-unicode. Bug me if you need this.	1196	supported in rxvt-unicode. Bug me if you need this.
972		1197
973	You can, however, switch fonts at runtime using escape sequences (and	1198	You can, however, switch fonts at runtime using escape sequences (and
974	therefore using the menubar), e.g.:	1199	therefore using the menubar), e.g.:
975		1200
976	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1201	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
977		1202
978	rxvt-unicode will automatically re-apply these fonts to the output so far.	1203	rxvt-unicode will automatically re-apply these fonts to the output so far.
979		1204
980	=head1 ISO 14755 SUPPORT	1205	=head1 ISO 14755 SUPPORT
981		1206
…		…
1098		1323
1099	=back	1324	=back
1100		1325
1101	=head1 ENVIRONMENT	1326	=head1 ENVIRONMENT
1102		1327
1103	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>	1328	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	1329
1105	window id number of the B<@@RXVT_NAME@@> window and it also uses and	1330	=over 4
1106	sets the environment variable B<DISPLAY> to specify which display	1331
1107	terminal to use. B<@@RXVT_NAME@@> uses the environment variables	1332	=item B<TERM>
1108	B<RXVTPATH> and B<PATH> to find XPM files.	1333
		1334	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
		1335	resources or on the commandline.
		1336
		1337	=item B<COLORTERM>
		1338
		1339	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
		1340	compiled with XPM support, and optionally with the added extension
		1341	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
		1342
		1343	=item B<COLORFGBG>
		1344
		1345	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
		1346	the colour code used as default foreground/text colour (or the string
		1347	C<default> to indicate that the default-colour escape sequence is to be
		1348	used), C<bg> is the colour code used as default background colour (or the
		1349	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1350	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
		1351	(and do) use this information to optimize screen output.
		1352
		1353	=item B<WINDOWID>
		1354
		1355	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
		1356	window, which usually has subwindows for the scrollbar, the terminal
		1357	window and so on).
		1358
		1359	=item B<TERMINFO>
		1360
		1361	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1362	C<--with-terminfo=PATH>.
		1363
		1364	=item B<DISPLAY>
		1365
		1366	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
		1367	display in it's child processes.
		1368
		1369	=item B<SHELL>
		1370
		1371	The shell to be used for command execution, defaults to C</bin/sh>.
		1372
		1373	=item B<RXVTPATH>
		1374
		1375	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
		1376	files.
		1377
		1378	=item B<PATH>
		1379
		1380	Used in the same way as C<RXVTPATH>.
		1381
		1382	=item B<RXVT_SOCKET>
		1383
		1384	The unix domain socket path used by @@RXVT_NAME@@c(1) and
		1385	@@RXVT_NAME@@d(1).
		1386
		1387	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
		1388
		1389	=item B<HOME>
		1390
		1391	Used to locate the default directory for the unix domain socket for
		1392	daemon communications and to locate various resource files (such as
		1393	C<.Xdefaults>)
		1394
		1395	=item B<XAPPLRESDIR>
		1396
		1397	Directory where various X resource files are being located.
		1398
		1399	=item B<XENVIRONMENT>
		1400
		1401	If set and accessible, gives the name of a X resource file to be loaded by
		1402	@@RXVT_NAME@@.
		1403
		1404	=back
1109		1405
1110	=head1 FILES	1406	=head1 FILES
1111		1407
1112	=over 4	1408	=over 4
1113		1409
…		…
1117		1413
1118	=back	1414	=back
1119		1415
1120	=head1 SEE ALSO	1416	=head1 SEE ALSO
1121		1417
1122	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1418	@@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		1419
1132	=head1 CURRENT PROJECT COORDINATOR	1420	=head1 CURRENT PROJECT COORDINATOR
1133		1421
1134	=over 4	1422	=over 4
1135		1423
1136	=item Project Coordinator	1424	=item Project Coordinator
1137		1425
1138	@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@>	1426	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1139		1427
1140	=item Web page maintainter	1428	L<http://software.schmorp.de/#rxvt-unicode>
1141
1142	@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1143
1144	L<@@RXVT_WEBPAGE@@>
1145		1429
1146	=back	1430	=back
1147		1431
1148	=head1 AUTHORS	1432	=head1 AUTHORS
1149		1433
…		…
1174	=item Geoff Wing L<< <gcw@pobox.com> >>	1458	=item Geoff Wing L<< <gcw@pobox.com> >>
1175		1459
1176	Rewrote screen display and text selection routines. Project Coordinator	1460	Rewrote screen display and text selection routines. Project Coordinator
1177	(changes.txt 2.4.6 - rxvt-unicode)	1461	(changes.txt 2.4.6 - rxvt-unicode)
1178		1462
1179	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>	1463	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1180		1464
1181	Forked rxvt-unicode, rewrote most of the display code and internal	1465	Forked rxvt-unicode, rewrote most of the display code and internal
1182	character handling to store text in unicode, improve xterm	1466	character handling to store text in unicode, improve xterm
1183	compatibility and apply numerous other bugfixes and extensions.	1467	compatibility and apply numerous other bugfixes and extensions.
1184		1468

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.92 by root, Wed Jan 11 02:13:55 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.92 by root, Wed Jan 11 02:13:55 2006 UTC