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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.69 by root, Tue Oct 25 19:04:45 2005 UTC vs.
Revision 1.111 by root, Tue Jan 31 00:25:16 2006 UTC

…		…
93		93
94	Attempt to open a window on the named X display (B<-d> still	94	Attempt to open a window on the named X display (B<-d> still
95	respected). In the absence of this option, the display specified by the	95	respected). In the absence of this option, the display specified by the
96	B<DISPLAY> environment variable is used.	96	B<DISPLAY> environment variable is used.
97		97
		98	=item B<-depth> I<bitdepth>
		99
		100	Compile I<xft>: Attempt to find a visual with the given bit depth;
		101	resource B<depth>.
		102
98	=item B<-geometry> I<geom>	103	=item B<-geometry> I<geom>
99		104
100	Window geometry (B<-g> still respected); resource B<geometry>.	105	Window geometry (B<-g> still respected); resource B<geometry>.
101		106
102	=item B<-rv>\|B<+rv>	107	=item B<-rv>\|B<+rv>
…		…
109		114
110	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>	115	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>
111		116
112	Turn on/off inheriting parent window's pixmap. Alternative form is	117	Turn on/off inheriting parent window's pixmap. Alternative form is
113	B<-tr>; resource B<inheritPixmap>.	118	B<-tr>; resource B<inheritPixmap>.
		119
		120	I<Please note that transparency of any kind if completely unsupported by
		121	the author. Don't bug him with installation questions!>
114		122
115	=item B<-fade> I<number>	123	=item B<-fade> I<number>
116		124
117	Fade the text by the given percentage when focus is lost. Small values	125	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	126	fade a little only, 100 completely replaces all colours by the fade
119	colour; resource B<fading>.	127	colour; resource B<fading>.
120		128
121	=item B<-fadecolor> I<colour>	129	=item B<-fadecolor> I<colour>
122		130
123	Fade to this colour when fading is used (see B<-fade>). The default colour	131	Fade to this colour when fading is used (see B<-fade>). The default colour
124	is black. resource B<fadeColor>.	132	is opaque black. resource B<fadeColor>.
125		133
126	=item B<-tint> I<colour>	134	=item B<-tint> I<colour>
127		135
128	Tint the transparent background pixmap with the given colour when	136	Tint the transparent background pixmap with the given colour when
129	transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>	137	transparency is enabled with B<-tr> or B<-ip>. This only works for
130	option that can be used to brighten or darken the image in addition to	138	non-tiled backgrounds, currently. See also the B<-sh> option that can be
131	tinting it; resource I<tintColor>. Example:	139	used to brighten or darken the image in addition to tinting it; resource
		140	I<tintColor>. Example:
132		141
133	@@RXVT_NAME@@ -tr -tint blue -sh 40	142	@@RXVT_NAME@@ -tr -tint blue -sh 40
134		143
135	=item B<-sh>	144	=item B<-sh>
136		145
…		…
171	resource B<borderColor>.	180	resource B<borderColor>.
172		181
173	=item B<-fn> I<fontlist>	182	=item B<-fn> I<fontlist>
174		183
175	Select the fonts to be used. This is a comma separated list of font names	184	Select the fonts to be used. This is a comma separated list of font names
176	that are used in turn when trying to display Unicode characters. The	185	that are checked in order when trying to find glyphs for characters. The
177	first font defines the cell size for characters; other fonts might be	186	first font defines the cell size for characters; other fonts might be
178	smaller, but not (in general) larger. A (hopefully) reasonable default	187	smaller, but not (in general) larger. A (hopefully) reasonable default
179	font list is always appended to it. See resource B<font> for more details.	188	font list is always appended to it. See resource B<font> for more details.
180		189
181	In short, to specify an X11 core font, just specify it's name or prefix it	190	In short, to specify an X11 core font, just specify it's name or prefix it
…		…
188	See also the question "How does rxvt-unicode choose fonts?" in the FAQ	197	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
189	section of @@RXVT_NAME@@(7).	198	section of @@RXVT_NAME@@(7).
190		199
191	=item B<-fb> I<fontlist>	200	=item B<-fb> I<fontlist>
192		201
193	Compile font-styles: The bold font list to use when bold characters are to	202	Compile I<font-styles>: The bold font list to use when B<bold> characters
194	be printed. See resource B<boldFont> for details.	203	are to be printed. See resource B<boldFont> for details.
195		204
196	=item B<-fi> I<fontlist>	205	=item B<-fi> I<fontlist>
197		206
198	Compile font-styles: The italic font list to use when bold characters are to	207	Compile I<font-styles>: The italic font list to use when I<italic>
199	be printed. See resource B<italicFont> for details.	208	characters are to be printed. See resource B<italicFont> for details.
200		209
201	=item B<-fbi> I<fontlist>	210	=item B<-fbi> I<fontlist>
202		211
203	Compile font-styles: The bold italic font list to use when bold characters are to	212	Compile I<font-styles>: The bold italic font list to use when B<< I<bold
204	be printed. See resource B<boldItalicFont> for details.	213	italic> >> characters are to be printed. See resource B<boldItalicFont>
		214	for details.
		215
		216	=item B<-is>\|B<+is>
		217
		218	Compile I<font-styles>: Bold/Italic font styles imply high intensity
		219	foreground/background (default). See resource B<intensityStyles> for
		220	details.
205		221
206	=item B<-name> I<name>	222	=item B<-name> I<name>
207		223
208	Specify the application name under which resources are to be obtained,	224	Specify the application name under which resources are to be obtained,
209	rather than the default executable file name. Name should not contain	225	rather than the default executable file name. Name should not contain
…		…
288	=item B<-bl>	304	=item B<-bl>
289		305
290	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	306	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
291	if honoured by the WM, the rxvt-unicode window will not have window	307	if honoured by the WM, the rxvt-unicode window will not have window
292	decorations; resource B<borderLess>.	308	decorations; resource B<borderLess>.
		309
		310	=item B<-override-redirect>
		311
		312	Compile I<frills>: Sets override-redirect on the window; resource
		313	B<override-redirect>.
		314
		315	=item B<-sbg>
		316
		317	Compile I<frills>: Disable the usage of the built-in block graphics/line
		318	drawing characters and just rely on what the specified fonts provide. Use
		319	this if you have a good font and want to use its block graphic glyphs;
		320	resource B<skipBuiltinGlyphs>.
293		321
294	=item B<-lsp> I<number>	322	=item B<-lsp> I<number>
295		323
296	Compile I<frills>: Lines (pixel height) to insert between each row of	324	Compile I<frills>: Lines (pixel height) to insert between each row of
297	the display. Useful to work around font rendering problems; resource	325	the display. Useful to work around font rendering problems; resource
…		…
312	given on the command line. If this option is used, it must be the last	340	given on the command line. If this option is used, it must be the last
313	on the command-line. If there is no B<-e> option then the default is to	341	on the command-line. If there is no B<-e> option then the default is to
314	run the program specified by the B<SHELL> environment variable or,	342	run the program specified by the B<SHELL> environment variable or,
315	failing that, I<sh(1)>.	343	failing that, I<sh(1)>.
316		344
		345	Please note that you must specify a program with arguments. If you want to
		346	run shell commands, you have to specify the shell, like this:
		347
		348	@@RXVT_NAME@@ -e sh -c "shell commands"
		349
317	=item B<-title> I<text>	350	=item B<-title> I<text>
318		351
319	Window title (B<-T> still respected); the default title is the basename	352	Window title (B<-T> still respected); the default title is the basename
320	of the program specified after the B<-e> option, if any, otherwise the	353	of the program specified after the B<-e> option, if any, otherwise the
321	application name; resource B<title>.	354	application name; resource B<title>.
…		…
376		409
377	=item B<-ssr>\|B<+ssr>	410	=item B<-ssr>\|B<+ssr>
378		411
379	Turn on/off secondary screen scroll (default enabled); resource	412	Turn on/off secondary screen scroll (default enabled); resource
380	B<secondaryScroll>.	413	B<secondaryScroll>.
		414
		415	=item B<-hold>\|B<+hold>
		416
		417	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		418	will not immediately destroy its window when the program executed within
		419	it exits. Instead, it will wait till it is being killed or closed by the
		420	user; resource B<hold>.
381		421
382	=item B<-keysym.>I<sym> I<string>	422	=item B<-keysym.>I<sym> I<string>
383		423
384	Remap a key symbol. See resource B<keysym>.	424	Remap a key symbol. See resource B<keysym>.
385		425
…		…
408	$rxvt->signal_connect_after (realize => sub {	448	$rxvt->signal_connect_after (realize => sub {
409	my $xid = $_[0]->window->get_xid;	449	my $xid = $_[0]->window->get_xid;
410	system "@@RXVT_NAME@@ -embed $xid &";	450	system "@@RXVT_NAME@@ -embed $xid &";
411	});	451	});
412		452
413	=item B<-pty-fd> I<fileno>	453	=item B<-pty-fd> I<file descriptor>
414		454
415	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	455	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
416	pair but instead use the given filehandle as the tty master. This is	456	pair but instead use the given filehandle as the tty master. This is
417	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator	457	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
418	without having to run a program within it.	458	without having to run a program within it.
419		459
420	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	460	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
421	entries and will not tinker with pty/tty permissions - you have to do that	461	entries and will not tinker with pty/tty permissions - you have to do that
422	yourself if you want that.	462	yourself if you want that.
423		463
		464	As an extremely special case, specifying C<-1> will completely suppress
		465	pty/tty operations.
		466
424	Here is a example in perl that illustrates how this option can be used (a	467	Here is a example in perl that illustrates how this option can be used (a
425	longer example is in F<doc/pty-fd>):	468	longer example is in F<doc/pty-fd>):
426		469
427	use IO::Pty;	470	use IO::Pty;
428	use Fcntl;	471	use Fcntl;
…		…
434		477
435	# now communicate with rxvt	478	# now communicate with rxvt
436	my $slave = $pty->slave;	479	my $slave = $pty->slave;
437	while (<$slave>) { print $slave "got <$_>\n" }	480	while (<$slave>) { print $slave "got <$_>\n" }
438		481
		482	=item B<-pe> I<string>
		483
		484	Comma-separated list of perl extension scripts to use (or not to use) in
		485	this terminal instance. See resource B<perl-ext> for details.
		486
439	=back	487	=back
440		488
441	=head1 RESOURCES (available also as long-options)	489	=head1 RESOURCES (available also as long-options)
442		490
443	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	491	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
444	options) compiled into your version.	492	options) compiled into your version.
445		493
446	There are two different methods that @@RXVT_NAME@@ can use to get the	494	You can set and change the resources using X11 tools like B<xrdb>. Many
447	Xresource data: using the X libraries (Xrm*-functions) or internal	495	distribution do also load settings from the B<~/.Xresources> file when X
448	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	496	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
449	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	497	with later settings overwriting earlier ones:
450	resources using X11 tools like B<xrdb>. Many distribution do also load
451	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
452	will consult the following files/resources in order, with later settings
453	overwriting earlier ones:
454		498
455	1. system-wide app-defaults file, either locale-dependent OR global	499	1. system-wide app-defaults file, either locale-dependent OR global
456	2. app-defaults file in $XAPPLRESDIR	500	2. app-defaults file in $XAPPLRESDIR
457	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	501	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
458	4. SCREEN_RESOURCES for the current screen	502	4. SCREEN_RESOURCES for the current screen
459	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	503	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
460		504
461	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
462	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
463	set in XAPPLOADDIR/URxvt (compile-time defined: usually
464	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
465	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
466	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	505	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
467	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows	506	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
468	resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be	507	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
469	easily configured, while the class name B<URxvt> allows resources	508	configured, while the class name B<URxvt> allows resources unique to
470	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	509	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
471	shared between different B<@@RXVT_NAME@@> configurations. If no	510	configurations. If no resources are specified, suitable defaults will
472	resources are specified, suitable defaults will be used. Command-line	511	be used. Command-line arguments can be used to override resource
473	arguments can be used to override resource settings. The following	512	settings. The following resources are supported (you might want to
474	resources are allowed:	513	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		514	extensions not documented here):
475		515
476	=over 4	516	=over 4
		517
		518	=item B<depth:> I<bitdepth>
		519
		520	Compile I<xft>: Attempt to find a visual with the given bit depth;
		521	option B<-depth>.
477		522
478	=item B<geometry:> I<geom>	523	=item B<geometry:> I<geom>
479		524
480	Create the window with the specified X window geometry [default 80x24];	525	Create the window with the specified X window geometry [default 80x24];
481	option B<-geometry>.	526	option B<-geometry>.
…		…
554	=item B<inheritPixmap:> I<boolean>	599	=item B<inheritPixmap:> I<boolean>
555		600
556	B<True>: make the background inherit the parent windows' pixmap, giving	601	B<True>: make the background inherit the parent windows' pixmap, giving
557	artificial transparency. B<False>: do not inherit the parent windows'	602	artificial transparency. B<False>: do not inherit the parent windows'
558	pixmap.	603	pixmap.
		604
		605	I<Please note that transparency of any kind if completely unsupported by
		606	the author. Don't bug him with installation questions!>
559		607
560	=item B<fading:> I<number>	608	=item B<fading:> I<number>
561		609
562	Fade the text by the given percentage when focus is lost; option B<-fade>.	610	Fade the text by the given percentage when focus is lost; option B<-fade>.
563		611
…		…
600	of 1 displays the image without any scaling. A scale of 2 to 9	648	of 1 displays the image without any scaling. A scale of 2 to 9
601	specifies an integer number of images in that direction. No image will	649	specifies an integer number of images in that direction. No image will
602	be magnified beyond 10 times its original size. The maximum permitted	650	be magnified beyond 10 times its original size. The maximum permitted
603	scale is 1000. [default 0x0+50+50]	651	scale is 1000. [default 0x0+50+50]
604		652
605	=item B<menu:> I<file[;tag]>
606
607	Read in the specified menu file (note the `.menu' extension is
608	optional) and also optionally specify a starting tag to find. See the
609	reference documentation for details on the syntax for the menuBar.
610
611	=item B<path:> I<path>	653	=item B<path:> I<path>
612		654
613	Specify the colon-delimited search path for finding files (XPM and	655	Specify the colon-delimited search path for finding XPM files.
614	menus), in addition to the paths specified by the B<RXVTPATH> and
615	B<PATH> environment variables.
616		656
617	=item B<font:> I<fontlist>	657	=item B<font:> I<fontlist>
618		658
619	Select the fonts to be used. This is a comma separated list of font	659	Select the fonts to be used. This is a comma separated list of font names
620	names that are used in turn when trying to display Unicode characters.	660	that are checked in order when trying to find glyphs for characters. The
621	The first font defines the cell size for characters; other fonts might	661	first font defines the cell size for characters; other fonts might be
622	be smaller, but not larger. A reasonable default font list is always	662	smaller, but not (in general) larger. A (hopefully) reasonable default
623	appended to it. option B<-fn>.	663	font list is always appended to it; option B<-fn>.
624		664
625	Each font can either be a standard X11 core font (XLFD) name, with	665	Each font can either be a standard X11 core font (XLFD) name, with
626	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.	666	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
627		667
628	In addition, each font can be prefixed with additional hints and	668	In addition, each font can be prefixed with additional hints and
…		…
630	hint currently is C<codeset=codeset-name>, and this is only used for Xft	670	hint currently is C<codeset=codeset-name>, and this is only used for Xft
631	fonts.	671	fonts.
632		672
633	For example, this font resource	673	For example, this font resource
634		674
635	URxvt*font: 9x15bold,\	675	URxvt.font: 9x15bold,\
636	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	676	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
637	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \	677	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
638	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	678	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
639	xft:Code2000:antialias=false	679	xft:Code2000:antialias=false
640		680
…		…
674	not possible, replacement fonts of the desired shape will be tried.	714	not possible, replacement fonts of the desired shape will be tried.
675		715
676	If set, but empty, then this specific style is disabled and the normal	716	If set, but empty, then this specific style is disabled and the normal
677	text font will being used for the given style.	717	text font will being used for the given style.
678		718
		719	=item B<intensityStyles:> I<boolean>
		720
		721	When font styles are not enabled, or this option is enabled (B<True>,
		722	option B<-is>, the default), bold and italic font styles imply high
		723	intensity foreground/backround colours. Disabling this option (B<False>,
		724	option B<+is>) disables this behaviour, the high intensity colours are not
		725	reachable.
		726
679	=item B<selectstyle:> I<mode>	727	=item B<selectstyle:> I<mode>
680		728
681	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	729	Set mouse selection style to B<old> which is 2.20, B<oldword> which is
682	xterm style with 2.20 old word selection, or anything else which gives	730	xterm style with 2.20 old word selection, or anything else which gives
683	xterm style selection.	731	xterm style selection.
…		…
729		777
730	The string will be interpreted as if typed into the shell as-is.	778	The string will be interpreted as if typed into the shell as-is.
731		779
732	Example:	780	Example:
733		781
734	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	782	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
735		783
736	This creates a new file in your home directory with the screen contents	784	This creates a new file in your home directory with the screen contents
737	everytime you hit C<Print>.	785	everytime you hit C<Print>.
738		786
739	=item B<scrollBar:> I<boolean>	787	=item B<scrollBar:> I<boolean>
…		…
793	=item B<borderLess:> I<boolean>	841	=item B<borderLess:> I<boolean>
794		842
795	Set MWM hints to request a borderless window, i.e. if honoured by the	843	Set MWM hints to request a borderless window, i.e. if honoured by the
796	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.	844	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
797		845
		846	=item B<skipBuiltinGlyphs:> I<boolean>
		847
		848	Compile I<frills>: Disable the usage of the built-in block graphics/line
		849	drawing characters and just rely on what the specified fonts provide. Use
		850	this if you have a good font and want to use its block graphic glyphs;
		851	option B<-sbg>.
		852
798	=item B<termName:> I<termname>	853	=item B<termName:> I<termname>
799		854
800	Specifies the terminal type name to be set in the B<TERM> environment	855	Specifies the terminal type name to be set in the B<TERM> environment
801	variable; option B<-tn>.	856	variable; option B<-tn>.
802		857
…		…
857	pressed. If unset it will send the sequence traditionally associated	912	pressed. If unset it will send the sequence traditionally associated
858	with the B<Execute> key.	913	with the B<Execute> key.
859		914
860	=item B<cutchars:> I<string>	915	=item B<cutchars:> I<string>
861		916
862	The characters used as delimiters for double-click word selection. The	917	The characters used as delimiters for double-click word selection
863	built-in default:	918	(whitespace delimiting is added automatically if resource is given).
		919
		920	When the selection extension is in use (the default if compiled in, see
		921	the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters
		922	will be created (if the resource exists, otherwise, no regex will be
		923	created). In this mode, characters outside ISO-8859-1 can be used.
		924
		925	When the selection extension is not used, only ISO-8859-1 characters can
		926	be used. If not specified, the built-in default is used:
864		927
865	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	928	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>
866		929
867	=item B<preeditType:> I<style>	930	=item B<preeditType:> I<style>
868		931
…		…
875	=item B<imLocale:> I<name>	938	=item B<imLocale:> I<name>
876		939
877	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.	940	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
878	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the	941	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
879	input extension to be able to input japanese characters while staying in	942	input extension to be able to input japanese characters while staying in
880	another locale. option B<-imlocale>.	943	another locale; option B<-imlocale>.
881		944
882	=item B<imFont:> I<fontset>	945	=item B<imFont:> I<fontset>
883		946
884	Specify the font-set used for XIM styles C<OverTheSpot> or	947	Specify the font-set used for XIM styles C<OverTheSpot> or
885	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated	948	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
…		…
890		953
891	=item B<tripleclickwords:> I<boolean>	954	=item B<tripleclickwords:> I<boolean>
892		955
893	Change the meaning of triple-click selection with the left mouse	956	Change the meaning of triple-click selection with the left mouse
894	button. Instead of selecting a full line it will extend the selection to	957	button. Instead of selecting a full line it will extend the selection to
895	the end of the logical line only. option B<-tcw>.	958	the end of the logical line only; option B<-tcw>.
896		959
897	=item B<insecure:> I<boolean>	960	=item B<insecure:> I<boolean>
898		961
899	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	962	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
900	echo arbitrary strings like the icon name or the locale. This could be	963	echo arbitrary strings like the icon name or the locale. This could be
901	abused if somebody gets 8-bit-clean access to your display, whether	964	abused if somebody gets 8-bit-clean access to your display, whether
902	throuh a mail client displaying mail bodies unfiltered or though	965	through a mail client displaying mail bodies unfiltered or through
903	write(1). Therefore, these sequences are disabled by default. (Note	966	write(1) or any other means. Therefore, these sequences are disabled by
904	that other terminals, including xterm, have these sequences	967	default. (Note that many other terminals, including xterm, have these
905	enabled by default). You can enable them by setting this boolean	968	sequences enabled by default, which doesn't make it safer, though).
906	resource or specifying B<-insecure> as an option. At the moment, this	969
907	enabled display-answer, locale, findfont, icon label and window title	970	You can enable them by setting this boolean resource or specifying
908	requests as well as dynamic menubar dispatch.	971	B<-insecure> as an option. At the moment, this enables display-answer,
		972	locale, findfont, icon label and window title requests.
909		973
910	=item B<modifier:> I<modifier>	974	=item B<modifier:> I<modifier>
911		975
912	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	976	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
913	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	977	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
917		981
918	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	982	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
919	character is passed through. It may contain escape values as described	983	character is passed through. It may contain escape values as described
920	in the entry on B<keysym> following.	984	in the entry on B<keysym> following.
921		985
922	=item B<secondaryScreen:> I<bool>	986	=item B<secondaryScreen:> I<boolean>
923		987
924	Turn on/off secondary screen (default enabled).	988	Turn on/off secondary screen (default enabled).
925		989
926	=item B<secondaryScroll:> I<bool>	990	=item B<secondaryScroll:> I<boolean>
927		991
928	Turn on/off secondary screen scroll (default enabled). If the this	992	Turn on/off secondary screen scroll (default enabled). If the this
929	option is enabled, scrolls on the secondary screen will change the	993	option is enabled, scrolls on the secondary screen will change the
930	scrollback buffer and switching to/from the secondary screen will	994	scrollback buffer and switching to/from the secondary screen will
931	instead scroll the screen up.	995	instead scroll the screen up.
		996
		997	=item B<hold>: I<boolean>
		998
		999	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		1000	will not immediately destroy its window when the program executed within
		1001	it exits. Instead, it will wait till it is being killed or closed by the
		1002	user.
932		1003
933	=item B<keysym.>I<sym>: I<string>	1004	=item B<keysym.>I<sym>: I<string>
934		1005
935	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1006	Compile I<frills>: Associate I<string> with keysym I<sym>. The
936	intervening resource name B<keysym.> cannot be omitted.	1007	intervening resource name B<keysym.> cannot be omitted.
…		…
956	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1027	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
957	C<\000>: octal number) or verbatim control characters (C<^?>: delete,	1028	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
958	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it	1029	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
959	can start or end with whitespace.	1030	can start or end with whitespace.
960		1031
961	Please note that you need to double the C<\> when using	1032	Please note that you need to double the C<\> in resource files, as
962	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can	1033	Xlib itself does it's own de-escaping (you can use C<\033> instead of
963	use C<\033> instead of C<\e> (and so on), which will work with both Xt and	1034	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
964	@@RXVT_NAME@@'s own processing).	1035	processing).
965		1036
966	You can define a range of keysyms in one shot by providing a I<string>	1037	You can define a range of keysyms in one shot by providing a I<string>
967	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1038	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
968	should be a character not used by the strings.	1039	should be a character not used by the strings.
969		1040
…		…
981	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1052	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
982	example the following means "change the current locale to C<zh_CN.GBK>	1053	example the following means "change the current locale to C<zh_CN.GBK>
983	when Control-Meta-c is being pressed":	1054	when Control-Meta-c is being pressed":
984		1055
985	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1056	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		1057
		1058	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1059	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1060	manpage. For example, the F<selection> extension (activated via
		1061	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1062
		1063	URxvt.keysym.M-C-c: perl:selection:rot13
986		1064
987	Due the the large number of modifier combinations, a defined key mapping	1065	Due the the large number of modifier combinations, a defined key mapping
988	will match if at I<at least> the specified identifiers are being set, and	1066	will match if at I<at least> the specified identifiers are being set, and
989	no other key mappings with those and more bits are being defined. That	1067	no other key mappings with those and more bits are being defined. That
990	means that defining a key map for C<a> will automatically provide	1068	means that defining a key map for C<a> will automatically provide
…		…
1014	info):	1092	info):
1015		1093
1016	URxvt.keysym.M-C-3: command:\033[8;25;80t	1094	URxvt.keysym.M-C-3: command:\033[8;25;80t
1017	URxvt.keysym.M-C-4: command:\033[8;48;110t	1095	URxvt.keysym.M-C-4: command:\033[8;48;110t
1018		1096
		1097	=item B<perl-ext-common>: I<string>
		1098
		1099	=item B<perl-ext>: I<string>
		1100
		1101	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1102	use in this terminal instance; option B<-pe>.
		1103
		1104	Extension names can be prefixed with a C<-> sign to prohibit using
		1105	them. This can be useful to selectively disable some extensions loaded
		1106	by default, or specified via the C<perl-ext-common> resource. For
		1107	example, C<default,-selection> will use all the default extension except
		1108	C<selection>.
		1109
		1110	Extension names can also be followed by an argument in angle brackets
		1111	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1112	searchable scorllback to Alt/Meta-s). Mentioning the same extension
		1113	multiple times with different arguments will pass multiple arguments to
		1114	the extension.
		1115
		1116	Each extension is looked up in the library directories, loaded if
		1117	necessary, and bound to the current terminal instance.
		1118
		1119	If both of these resources are the empty string, then the perl
		1120	interpreter will not be initialized. The idea behind two options is that
		1121	B<perl-ext-common> will be used for extensions that should be available to
		1122	all instances, while B<perl-ext> is used for specific instances.
		1123
		1124	=item B<perl-eval>: I<string>
		1125
		1126	Perl code to be evaluated when all extensions have been registered. See
		1127	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
		1128	will be ignored when running setuid/setgid.
		1129
		1130	=item B<perl-lib>: I<path>
		1131
		1132	Colon-separated list of additional directories that hold extension
		1133	scripts. When looking for extensions specified by the C<perl> resource,
		1134	@@RXVT_NAME@@ will first look in these directories and then in
		1135	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
		1136	will be ignored when running setuid/setgid.
		1137
		1138	See the @@RXVT_NAME@@perl(3) manpage.
		1139
		1140	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1141
		1142	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1143	details.
		1144
		1145	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1146
		1147	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1148	for details.
		1149
		1150	=item B<searchable-scrollback:> I<keysym>
		1151
		1152	Sets the hotkey that starts the incremental scrollback buffer search
		1153	(default: C<M-s>).
		1154
		1155	=item B<urlLauncher>: I<string>
		1156
		1157	Specifies the program to be started with a URL argument. Used by the
		1158	C<selection-popup> and C<mark-urls> perl extensions.
		1159
		1160	=item B<transient-for>: I<windowid>
		1161
		1162	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1163
		1164	=item B<override-redirect>: I<boolean>
		1165
		1166	Compile I<frills>: Sets override-redirect for the terminal window, making
		1167	it almost invisible to window managers; option B<-override-redirect>.
		1168
1019	=back	1169	=back
1020		1170
1021	=head1 THE SCROLLBAR	1171	=head1 THE SCROLLBAR
1022		1172
1023	Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window	1173	Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
…		…
1057	to select a word; Left triple-click to select the entire logical line	1207	to select a word; Left triple-click to select the entire logical line
1058	(which can span multiple screen lines), unless modified by resource	1208	(which can span multiple screen lines), unless modified by resource
1059	B<tripleclickwords>.	1209	B<tripleclickwords>.
1060		1210
1061	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1211	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
1062	(Compile: I<frills>) will create a rectangular selection instead of a normal	1212	(Compile: I<frills>) will create a rectangular selection instead of a
1063	one.	1213	normal one. In this mode, every selected row becomes its own line in the
		1214	selection, and trailing whitespace is visually underlined and removed from
		1215	the selection.
1064		1216
1065	=item B<Insertion>:	1217	=item B<Insertion>:
1066		1218
1067	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1219	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1068	an B<@@RXVT_NAME@@> window causes the current text selection to be	1220	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1069	inserted as if it had been typed on the keyboard.	1221	Meta modifier) to be inserted as if it had been typed on the keyboard.
		1222
		1223	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1224	inserted too.
1070		1225
1071	=back	1226	=back
1072		1227
1073	=head1 CHANGING FONTS	1228	=head1 CHANGING FONTS
1074		1229
1075	Changing fonts (or font sizes, respectively) via the keypad is not yet	1230	Changing fonts (or font sizes, respectively) via the keypad is not yet
1076	supported in rxvt-unicode. Bug me if you need this.	1231	supported in rxvt-unicode. Bug me if you need this.
1077		1232
1078	You can, however, switch fonts at runtime using escape sequences (and	1233	You can, however, switch fonts at runtime using escape sequences, e.g.:
1079	therefore using the menubar), e.g.:
1080		1234
1081	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1235	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1236
		1237	You can use keyboard shortcuts, too:
		1238
		1239	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1240	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1082		1241
1083	rxvt-unicode will automatically re-apply these fonts to the output so far.	1242	rxvt-unicode will automatically re-apply these fonts to the output so far.
1084		1243
1085	=head1 ISO 14755 SUPPORT	1244	=head1 ISO 14755 SUPPORT
1086		1245
…		…
1157	=head1 COLORS AND GRAPHICS	1316	=head1 COLORS AND GRAPHICS
1158		1317
1159	In addition to the default foreground and background colours,	1318	In addition to the default foreground and background colours,
1160	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1319	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1161	high-intensity bold/blink versions of the same). Here is a list of the	1320	high-intensity bold/blink versions of the same). Here is a list of the
1162	colours with their B<rgb.txt> names.	1321	colours with their names.
1163		1322
1164	=begin table	1323	=begin table
1165		1324
1166	B<color0> (black) = Black	1325	B<color0> (black) = Black
1167	B<color1> (red) = Red3	1326	B<color1> (red) = Red3
…		…
1201	would yield White on Black, while on I<xterm>(1) it would yield Black	1360	would yield White on Black, while on I<xterm>(1) it would yield Black
1202	on White.	1361	on White.
1203		1362
1204	=back	1363	=back
1205		1364
		1365	=head2 ALPHA CHANNEL SUPPORT
		1366
		1367	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1368	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
		1369	(recommended, but B<MUST> have 4 digits/component) colour specifications,
		1370	in addition to the ones provided by X, where the additional A component
		1371	specifies opacity (alpha) values. The minimum value of C<0> is completely
		1372	transparent). You can also prefix any color with C<[a]>, where C<a> is on
		1373	to four hex digits specifiying the opacity value.
		1374
		1375	You probably need to specify B<"-depth 32">, too, and have the luck that
		1376	your X-server uses ARGB pixel layout, as X is far from just supporting
		1377	ARGB visuals out of the box, and rxvt-unicode just fudges around.
		1378
		1379	For example, the following selects an almost completely transparent red
		1380	background, and an almost opaque pink foreground:
		1381
		1382	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"
		1383
		1384	I<Please note that transparency of any kind if completely unsupported by
		1385	the author. Don't bug him with installation questions!>
		1386
1206	=head1 ENVIRONMENT	1387	=head1 ENVIRONMENT
1207		1388
1208	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1389	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1209		1390
1210	=over 4	1391	=over 4
…		…
1248		1429
1249	=item B<SHELL>	1430	=item B<SHELL>
1250		1431
1251	The shell to be used for command execution, defaults to C</bin/sh>.	1432	The shell to be used for command execution, defaults to C</bin/sh>.
1252		1433
1253	=item B<RXVTPATH>
1254
1255	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1256	files.
1257
1258	=item B<PATH>
1259
1260	Used in the same way as C<RXVTPATH>.
1261
1262	=item B<RXVT_SOCKET>	1434	=item B<RXVT_SOCKET>
1263		1435
1264	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1436	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1265	@@RXVT_NAME@@d(1).	1437	@@RXVT_NAME@@d(1).
1266		1438
…		…
1295		1467
1296	=head1 SEE ALSO	1468	=head1 SEE ALSO
1297		1469
1298	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1470	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1299		1471
1300	=head1 BUGS
1301
1302	Check the BUGS file for an up-to-date list.
1303
1304	Cursor change support is not yet implemented.
1305
1306	Click-and-drag doesn't work with X11 mouse report overriding.
1307
1308	=head1 CURRENT PROJECT COORDINATOR	1472	=head1 CURRENT PROJECT COORDINATOR
1309		1473
1310	=over 4	1474	=over 4
1311		1475
1312	=item Project Coordinator	1476	=item Project Coordinator
…		…
1343		1507
1344	Project Coordinator (changes.txt 2.21a to 2.4.5)	1508	Project Coordinator (changes.txt 2.21a to 2.4.5)
1345		1509
1346	=item Geoff Wing L<< <gcw@pobox.com> >>	1510	=item Geoff Wing L<< <gcw@pobox.com> >>
1347		1511
1348	Rewrote screen display and text selection routines. Project Coordinator	1512	Rewrote screen display and text selection routines.
		1513
1349	(changes.txt 2.4.6 - rxvt-unicode)	1514	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1350		1515
1351	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1516	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1352		1517
1353	Forked rxvt-unicode, rewrote most of the display code and internal	1518	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1354	character handling to store text in unicode, improve xterm	1519	extension, random hacks, numerous bugfixes and extensions.
1355	compatibility and apply numerous other bugfixes and extensions.
1356		1520
1357	Project Coordinator (Changes 1.0 -)	1521	Project Coordinator (Changes 1.0 -)
1358		1522
		1523	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1524
		1525	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
		1526
1359	=back	1527	=back
1360		1528

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.69 by root, Tue Oct 25 19:04:45 2005 UTC vs. Revision 1.111 by root, Tue Jan 31 00:25:16 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.69 by root, Tue Oct 25 19:04:45 2005 UTC vs.
Revision 1.111 by root, Tue Jan 31 00:25:16 2006 UTC