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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.59 by root, Thu Feb 17 15:07:48 2005 UTC vs.
Revision 1.104 by root, Wed Jan 25 13:24:45 2006 UTC

…		…
105		105
106	=item B<-j>\|B<+j>	106	=item B<-j>\|B<+j>
107		107
108	Turn on/off jump scrolling; resource B<jumpScroll>.	108	Turn on/off jump scrolling; resource B<jumpScroll>.
109		109
110	=item B<-ip>\|B<+ip>	110	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>
111		111
112	Turn on/off inheriting parent window's pixmap. Alternative form is	112	Turn on/off inheriting parent window's pixmap. Alternative form is
113	B<-tr>; resource B<inheritPixmap>.	113	B<-tr>; resource B<inheritPixmap>.
114		114
115	=item B<-fade> I<number>	115	=item B<-fade> I<number>
116		116
117	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>.
118		125
119	=item B<-tint> I<colour>	126	=item B<-tint> I<colour>
120		127
121	Tint the transparent background pixmap with the given colour when	128	Tint the transparent background pixmap with the given colour when
122	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
123	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
124	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
125		135
126	=item B<-sh>	136	=item B<-sh>
127		137
128	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	138	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
129	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
…		…
162	resource B<borderColor>.	172	resource B<borderColor>.
163		173
164	=item B<-fn> I<fontlist>	174	=item B<-fn> I<fontlist>
165		175
166	Select the fonts to be used. This is a comma separated list of font names	176	Select the fonts to be used. This is a comma separated list of font names
167	that are used in turn when trying to display Unicode characters. The	177	that are checked in order when trying to find glyphs for characters. The
168	first font defines the cell size for characters; other fonts might be	178	first font defines the cell size for characters; other fonts might be
169	smaller, but not (in general) larger. A (hopefully) reasonable default	179	smaller, but not (in general) larger. A (hopefully) reasonable default
170	font list is always appended to it. See resource B<font> for more details.	180	font list is always appended to it. See resource B<font> for more details.
171		181
172	In short, to specify an X11 core font, just specify it's name or prefix it	182	In short, to specify an X11 core font, just specify it's name or prefix it
…		…
179	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
180	section of @@RXVT_NAME@@(7).	190	section of @@RXVT_NAME@@(7).
181		191
182	=item B<-fb> I<fontlist>	192	=item B<-fb> I<fontlist>
183		193
184	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
185	be printed. See resource B<boldFont> for details.	195	are to be printed. See resource B<boldFont> for details.
186		196
187	=item B<-fi> I<fontlist>	197	=item B<-fi> I<fontlist>
188		198
189	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>
190	be printed. See resource B<italicFont> for details.	200	characters are to be printed. See resource B<italicFont> for details.
191		201
192	=item B<-fbi> I<fontlist>	202	=item B<-fbi> I<fontlist>
193		203
194	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
195	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.
196		213
197	=item B<-name> I<name>	214	=item B<-name> I<name>
198		215
199	Specify the application name under which resources are to be obtained,	216	Specify the application name under which resources are to be obtained,
200	rather than the default executable file name. Name should not contain	217	rather than the default executable file name. Name should not contain
…		…
238		255
239	Put scrollbar on right/left; resource B<scrollBar_right>.	256	Put scrollbar on right/left; resource B<scrollBar_right>.
240		257
241	=item B<-st>\|B<+st>	258	=item B<-st>\|B<+st>
242		259
243	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	260	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
244	resource B<scrollBar_floating>.	261	resource B<scrollBar_floating>.
245		262
246	=item B<-ptab>\|B<+ptab>	263	=item B<-ptab>\|B<+ptab>
247		264
248	If enabled (default), "Horizontal Tab" characters are being stored as	265	If enabled (default), "Horizontal Tab" characters are being stored as
…		…
279	=item B<-bl>	296	=item B<-bl>
280		297
281	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.
282	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
283	decorations; resource B<borderLess>.	300	decorations; resource B<borderLess>.
		301
		302	=item B<-override-redirect>
		303
		304	Compile I<frills>: Sets override-redirect on the window; resource
		305	B<override-redirect>.
		306
		307	=item B<-sbg>
		308
		309	Compile I<frills>: Disable the usage of the built-in block graphics/line
		310	drawing characters and just rely on what the specified fonts provide. Use
		311	this if you have a good font and want to use its block graphic glyphs;
		312	resource B<skipBuiltinGlyphs>.
284		313
285	=item B<-lsp> I<number>	314	=item B<-lsp> I<number>
286		315
287	Compile I<frills>: Lines (pixel height) to insert between each row of	316	Compile I<frills>: Lines (pixel height) to insert between each row of
288	the display. Useful to work around font rendering problems; resource	317	the display. Useful to work around font rendering problems; resource
…		…
303	given on the command line. If this option is used, it must be the last	332	given on the command line. If this option is used, it must be the last
304	on the command-line. If there is no B<-e> option then the default is to	333	on the command-line. If there is no B<-e> option then the default is to
305	run the program specified by the B<SHELL> environment variable or,	334	run the program specified by the B<SHELL> environment variable or,
306	failing that, I<sh(1)>.	335	failing that, I<sh(1)>.
307		336
		337	Please note that you must specify a program with arguments. If you want to
		338	run shell commands, you have to specify the shell, like this:
		339
		340	@@RXVT_NAME@@ -e sh -c "shell commands"
		341
308	=item B<-title> I<text>	342	=item B<-title> I<text>
309		343
310	Window title (B<-T> still respected); the default title is the basename	344	Window title (B<-T> still respected); the default title is the basename
311	of the program specified after the B<-e> option, if any, otherwise the	345	of the program specified after the B<-e> option, if any, otherwise the
312	application name; resource B<title>.	346	application name; resource B<title>.
…		…
367		401
368	=item B<-ssr>\|B<+ssr>	402	=item B<-ssr>\|B<+ssr>
369		403
370	Turn on/off secondary screen scroll (default enabled); resource	404	Turn on/off secondary screen scroll (default enabled); resource
371	B<secondaryScroll>.	405	B<secondaryScroll>.
		406
		407	=item B<-hold>\|B<+hold>
		408
		409	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		410	will not immediately destroy its window when the program executed within
		411	it exits. Instead, it will wait till it is being killed or closed by the
		412	user; resource B<hold>.
372		413
373	=item B<-keysym.>I<sym> I<string>	414	=item B<-keysym.>I<sym> I<string>
374		415
375	Remap a key symbol. See resource B<keysym>.	416	Remap a key symbol. See resource B<keysym>.
376		417
…		…
393	not.	434	not.
394		435
395	Here is a short Gtk2-perl snippet that illustrates how this option can be	436	Here is a short Gtk2-perl snippet that illustrates how this option can be
396	used (a longer example is in F<doc/embed>):	437	used (a longer example is in F<doc/embed>):
397		438
398	my $rxvt = new Gtk2::DrawingArea;	439	my $rxvt = new Gtk2::Socket;
399	$...->add ($rxvt); # important to add it somewhere first	440	$rxvt->signal_connect_after (realize => sub {
400	$rxvt->realize; # now it can be realized
401	my $xid = $rxvt->window->get_xid;	441	my $xid = $_[0]->window->get_xid;
402
403	system "@@RXVT_NAME@@ -embed $xid &";	442	system "@@RXVT_NAME@@ -embed $xid &";
		443	});
404		444
405	=item B<-pty-fd> I<fileno>	445	=item B<-pty-fd> I<file descriptor>
406		446
407	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	447	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
408	pair but instead use the given filehandle as the tty master. This is	448	pair but instead use the given filehandle as the tty master. This is
409	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator	449	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
410	without having to run a program within it.	450	without having to run a program within it.
411		451
412	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	452	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
413	entries and will not tinker with pty/tty permissions - you have to do that	453	entries and will not tinker with pty/tty permissions - you have to do that
414	yourself if you want that.	454	yourself if you want that.
415		455
		456	As an extremely special case, specifying C<-1> will completely suppress
		457	pty/tty operations.
		458
416	Here is a example in perl that illustrates how this option can be used (a	459	Here is a example in perl that illustrates how this option can be used (a
417	longer example is in F<doc/pty-fd>):	460	longer example is in F<doc/pty-fd>):
418		461
419	use IO::Pty;	462	use IO::Pty;
420	use Fcntl;	463	use Fcntl;
421		464
422	my $pty = new IO::Pty;	465	my $pty = new IO::Pty;
423	fcntl $pty, F_SETFD, 0; # clear close-on-exec	466	fcntl $pty, F_SETFD, 0; # clear close-on-exec
424
425	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";	467	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		468	close $pty;
426		469
427	# now communicate with rxvt	470	# now communicate with rxvt
428	my $slave = $pty->slave;	471	my $slave = $pty->slave;
429	while (<$slave>) { print $slave "got <$_>\n" }	472	while (<$slave>) { print $slave "got <$_>\n" }
430		473
		474	=item B<-pe> I<string>
		475
		476	Comma-separated list of perl extension scripts to use (or not to use) in
		477	this terminal instance. See resource B<perl-ext> for details.
		478
431	=back	479	=back
432		480
433	=head1 RESOURCES (available also as long-options)	481	=head1 RESOURCES (available also as long-options)
434		482
435	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	483	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
436	options) compiled into your version.	484	options) compiled into your version.
437		485
438	There are two different methods that @@RXVT_NAME@@ can use to get the	486	You can set and change the resources using X11 tools like B<xrdb>. Many
439	Xresource data: using the X libraries (Xrm*-functions) or internal	487	distribution do also load settings from the B<~/.Xresources> file when X
440	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	488	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
441	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	489	with later settings overwriting earlier ones:
442	resources using X11 tools like B<xrdb>. Many distribution do also load
443	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
444	will consult the following files/resources in order, with later settings
445	overwriting earlier ones:
446		490
447	1. system-wide app-defaults file, either locale-dependent OR global	491	1. system-wide app-defaults file, either locale-dependent OR global
448	2. app-defaults file in $XAPPLRESDIR	492	2. app-defaults file in $XAPPLRESDIR
449	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	493	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
450	4. SCREEN_RESOURCES for the current screen	494	4. SCREEN_RESOURCES for the current screen
451	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	495	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
452		496
453	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
454	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
455	set in XAPPLOADDIR/URxvt (compile-time defined: usually
456	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
457	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
458	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	497	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
459	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows	498	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
460	resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be	499	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
461	easily configured, while the class name B<URxvt> allows resources	500	configured, while the class name B<URxvt> allows resources unique to
462	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	501	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
463	shared between different B<@@RXVT_NAME@@> configurations. If no	502	configurations. If no resources are specified, suitable defaults will
464	resources are specified, suitable defaults will be used. Command-line	503	be used. Command-line arguments can be used to override resource
465	arguments can be used to override resource settings. The following	504	settings. The following resources are supported (you might want to
466	resources are allowed:	505	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		506	extensions not documented here):
467		507
468	=over 4	508	=over 4
469		509
470	=item B<geometry:> I<geom>	510	=item B<geometry:> I<geom>
471		511
…		…
549	artificial transparency. B<False>: do not inherit the parent windows'	589	artificial transparency. B<False>: do not inherit the parent windows'
550	pixmap.	590	pixmap.
551		591
552	=item B<fading:> I<number>	592	=item B<fading:> I<number>
553		593
554	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>.
555		600
556	=item B<tintColor:> I<colour>	601	=item B<tintColor:> I<colour>
557		602
558	Tint the transparent background pixmap with the given colour.	603	Tint the transparent background pixmap with the given colour; option
		604	B<-tint>.
559		605
560	=item B<shading:> I<number>	606	=item B<shading:> I<number>
561		607
562	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	608	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
563	image in addition to tinting it.	609	image in addition to tinting it.
…		…
567	Use the specified colour for the scrollbar [default #B2B2B2].	613	Use the specified colour for the scrollbar [default #B2B2B2].
568		614
569	=item B<troughColor:> I<colour>	615	=item B<troughColor:> I<colour>
570		616
571	Use the specified colour for the scrollbar's trough area [default	617	Use the specified colour for the scrollbar's trough area [default
572	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	618	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
573		619
574	=item B<borderColor:> I<colour>	620	=item B<borderColor:> I<colour>
575		621
576	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
577	and the text.	623	and the text.
…		…
586	of 1 displays the image without any scaling. A scale of 2 to 9	632	of 1 displays the image without any scaling. A scale of 2 to 9
587	specifies an integer number of images in that direction. No image will	633	specifies an integer number of images in that direction. No image will
588	be magnified beyond 10 times its original size. The maximum permitted	634	be magnified beyond 10 times its original size. The maximum permitted
589	scale is 1000. [default 0x0+50+50]	635	scale is 1000. [default 0x0+50+50]
590		636
591	=item B<menu:> I<file[;tag]>
592
593	Read in the specified menu file (note the `.menu' extension is
594	optional) and also optionally specify a starting tag to find. See the
595	reference documentation for details on the syntax for the menuBar.
596
597	=item B<path:> I<path>	637	=item B<path:> I<path>
598		638
599	Specify the colon-delimited search path for finding files (XPM and	639	Specify the colon-delimited search path for finding XPM files.
600	menus), in addition to the paths specified by the B<RXVTPATH> and
601	B<PATH> environment variables.
602		640
603	=item B<font:> I<fontlist>	641	=item B<font:> I<fontlist>
604		642
605	Select the fonts to be used. This is a comma separated list of font	643	Select the fonts to be used. This is a comma separated list of font names
606	names that are used in turn when trying to display Unicode characters.	644	that are checked in order when trying to find glyphs for characters. The
607	The first font defines the cell size for characters; other fonts might	645	first font defines the cell size for characters; other fonts might be
608	be smaller, but not larger. A reasonable default font list is always	646	smaller, but not (in general) larger. A (hopefully) reasonable default
609	appended to it. option B<-fn>.	647	font list is always appended to it; option B<-fn>.
610		648
611	Each font can either be a standard X11 core font (XLFD) name, with	649	Each font can either be a standard X11 core font (XLFD) name, with
612	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.	650	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
613		651
614	In addition, each font can be prefixed with additional hints and	652	In addition, each font can be prefixed with additional hints and
…		…
616	hint currently is C<codeset=codeset-name>, and this is only used for Xft	654	hint currently is C<codeset=codeset-name>, and this is only used for Xft
617	fonts.	655	fonts.
618		656
619	For example, this font resource	657	For example, this font resource
620		658
621	URxvt*font: 9x15bold,\	659	URxvt.font: 9x15bold,\
622	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	660	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
623	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \	661	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
624	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	662	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
625	xft:Code2000:antialias=false	663	xft:Code2000:antialias=false
626		664
…		…
660	not possible, replacement fonts of the desired shape will be tried.	698	not possible, replacement fonts of the desired shape will be tried.
661		699
662	If set, but empty, then this specific style is disabled and the normal	700	If set, but empty, then this specific style is disabled and the normal
663	text font will being used for the given style.	701	text font will being used for the given style.
664		702
		703	=item B<intensityStyles:> I<boolean>
		704
		705	When font styles are not enabled, or this option is enabled (B<True>,
		706	option B<-is>, the default), bold and italic font styles imply high
		707	intensity foreground/backround colours. Disabling this option (B<False>,
		708	option B<+is>) disables this behaviour, the high intensity colours are not
		709	reachable.
		710
665	=item B<selectstyle:> I<mode>	711	=item B<selectstyle:> I<mode>
666		712
667	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	713	Set mouse selection style to B<old> which is 2.20, B<oldword> which is
668	xterm style with 2.20 old word selection, or anything else which gives	714	xterm style with 2.20 old word selection, or anything else which gives
669	xterm style selection.	715	xterm style selection.
670		716
671	=item B<scrollstyle:> I<mode>	717	=item B<scrollstyle:> I<mode>
672		718
673	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	719	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
674	the author's favourite..	720	the author's favourite.
675		721
676	=item B<title:> I<string>	722	=item B<title:> I<string>
677		723
678	Set window title string, the default title is the command-line	724	Set window title string, the default title is the command-line
679	specified after the B<-e> option, if any, otherwise the application	725	specified after the B<-e> option, if any, otherwise the application
…		…
710	=item B<print-pipe:> I<string>	756	=item B<print-pipe:> I<string>
711		757
712	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	758	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
713	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or	759	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
714	B<Shift-Print> to include the scrollback as well.	760	B<Shift-Print> to include the scrollback as well.
		761
		762	The string will be interpreted as if typed into the shell as-is.
		763
		764	Example:
		765
		766	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		767
		768	This creates a new file in your home directory with the screen contents
		769	everytime you hit C<Print>.
715		770
716	=item B<scrollBar:> I<boolean>	771	=item B<scrollBar:> I<boolean>
717		772
718	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	773	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
719	disable the scrollbar; option B<+sb>.	774	disable the scrollbar; option B<+sb>.
…		…
770	=item B<borderLess:> I<boolean>	825	=item B<borderLess:> I<boolean>
771		826
772	Set MWM hints to request a borderless window, i.e. if honoured by the	827	Set MWM hints to request a borderless window, i.e. if honoured by the
773	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.	828	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
774		829
		830	=item B<skipBuiltinGlyphs:> I<boolean>
		831
		832	Compile I<frills>: Disable the usage of the built-in block graphics/line
		833	drawing characters and just rely on what the specified fonts provide. Use
		834	this if you have a good font and want to use its block graphic glyphs;
		835	option B<-sbg>.
		836
775	=item B<termName:> I<termname>	837	=item B<termName:> I<termname>
776		838
777	Specifies the terminal type name to be set in the B<TERM> environment	839	Specifies the terminal type name to be set in the B<TERM> environment
778	variable; option B<-tn>.	840	variable; option B<-tn>.
779		841
…		…
816		878
817	Mouse pointer background colour.	879	Mouse pointer background colour.
818		880
819	=item B<pointerBlankDelay:> I<number>	881	=item B<pointerBlankDelay:> I<number>
820		882
821	Specifies number of seconds before blanking the pointer [default 2].	883	Specifies number of seconds before blanking the pointer [default 2]. Use a
		884	large number (e.g. C<987654321>) to effectively disable the timeout.
822		885
823	=item B<backspacekey:> I<string>	886	=item B<backspacekey:> I<string>
824		887
825	The string to send when the backspace key is pressed. If set to B<DEC>	888	The string to send when the backspace key is pressed. If set to B<DEC>
826	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	889	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
…		…
833	pressed. If unset it will send the sequence traditionally associated	896	pressed. If unset it will send the sequence traditionally associated
834	with the B<Execute> key.	897	with the B<Execute> key.
835		898
836	=item B<cutchars:> I<string>	899	=item B<cutchars:> I<string>
837		900
838	The characters used as delimiters for double-click word selection. The	901	The characters used as delimiters for double-click word selection.
839	built-in default:	902
		903	When the selection extension is in use (the default if compiled in, see
		904	the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters
		905	will be created (if the resource exists, otherwise, no regex will be
		906	created). In this mode, characters outside ISO-8859-1 can be used.
		907
		908	When the selection extension is not used, only ISO-8859-1 characters can
		909	be used. If not specified, the built-in default is used:
840		910
841	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	911	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>
842		912
843	=item B<preeditType:> I<style>	913	=item B<preeditType:> I<style>
844		914
…		…
851	=item B<imLocale:> I<name>	921	=item B<imLocale:> I<name>
852		922
853	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.	923	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
854	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the	924	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
855	input extension to be able to input japanese characters while staying in	925	input extension to be able to input japanese characters while staying in
856	another locale. option B<-imlocale>.	926	another locale; option B<-imlocale>.
857		927
858	=item B<imFont:> I<fontset>	928	=item B<imFont:> I<fontset>
859		929
860	Specify the font-set used for XIM styles C<OverTheSpot> or	930	Specify the font-set used for XIM styles C<OverTheSpot> or
861	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated	931	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
…		…
866		936
867	=item B<tripleclickwords:> I<boolean>	937	=item B<tripleclickwords:> I<boolean>
868		938
869	Change the meaning of triple-click selection with the left mouse	939	Change the meaning of triple-click selection with the left mouse
870	button. Instead of selecting a full line it will extend the selection to	940	button. Instead of selecting a full line it will extend the selection to
871	the end of the logical line only. option B<-tcw>.	941	the end of the logical line only; option B<-tcw>.
872		942
873	=item B<insecure:> I<boolean>	943	=item B<insecure:> I<boolean>
874		944
875	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	945	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
876	echo arbitrary strings like the icon name or the locale. This could be	946	echo arbitrary strings like the icon name or the locale. This could be
877	abused if somebody gets 8-bit-clean access to your display, whether	947	abused if somebody gets 8-bit-clean access to your display, whether
878	throuh a mail client displaying mail bodies unfiltered or though	948	through a mail client displaying mail bodies unfiltered or through
879	write(1). Therefore, these sequences are disabled by default. (Note	949	write(1) or any other means. Therefore, these sequences are disabled by
880	that other terminals, including xterm, have these sequences	950	default. (Note that many other terminals, including xterm, have these
881	enabled by default). You can enable them by setting this boolean	951	sequences enabled by default, which doesn't make it safer, though).
882	resource or specifying B<-insecure> as an option. At the moment, this	952
883	enabled display-answer, locale, findfont, icon label and window title	953	You can enable them by setting this boolean resource or specifying
884	requests as well as dynamic menubar dispatch.	954	B<-insecure> as an option. At the moment, this enables display-answer,
		955	locale, findfont, icon label and window title requests.
885		956
886	=item B<modifier:> I<modifier>	957	=item B<modifier:> I<modifier>
887		958
888	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	959	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
889	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	960	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
893		964
894	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	965	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
895	character is passed through. It may contain escape values as described	966	character is passed through. It may contain escape values as described
896	in the entry on B<keysym> following.	967	in the entry on B<keysym> following.
897		968
898	=item B<secondaryScreen:> I<bool>	969	=item B<secondaryScreen:> I<boolean>
899		970
900	Turn on/off secondary screen (default enabled).	971	Turn on/off secondary screen (default enabled).
901		972
902	=item B<secondaryScroll:> I<bool>	973	=item B<secondaryScroll:> I<boolean>
903		974
904	Turn on/off secondary screen scroll (default enabled). If the this	975	Turn on/off secondary screen scroll (default enabled). If the this
905	option is enabled, scrolls on the secondary screen will change the	976	option is enabled, scrolls on the secondary screen will change the
906	scrollback buffer and switching to/from the secondary screen will	977	scrollback buffer and switching to/from the secondary screen will
907	instead scroll the screen up.	978	instead scroll the screen up.
		979
		980	=item B<hold>: I<boolean>
		981
		982	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		983	will not immediately destroy its window when the program executed within
		984	it exits. Instead, it will wait till it is being killed or closed by the
		985	user.
908		986
909	=item B<keysym.>I<sym>: I<string>	987	=item B<keysym.>I<sym>: I<string>
910		988
911	Compile I<frills>: Associate I<string> with keysym I<sym>. The	989	Compile I<frills>: Associate I<string> with keysym I<sym>. The
912	intervening resource name B<keysym.> cannot be omitted.	990	intervening resource name B<keysym.> cannot be omitted.
…		…
932	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1010	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
933	C<\000>: octal number) or verbatim control characters (C<^?>: delete,	1011	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
934	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it	1012	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
935	can start or end with whitespace.	1013	can start or end with whitespace.
936		1014
937	Please note that you need to double the C<\> when using	1015	Please note that you need to double the C<\> in resource files, as
938	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can	1016	Xlib itself does it's own de-escaping (you can use C<\033> instead of
939	use C<\033> instead of C<\e> (and so on), which will work with both Xt and	1017	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
940	@@RXVT_NAME@@'s own processing).	1018	processing).
941		1019
942	You can define a range of keysyms in one shot by providing a I<string>	1020	You can define a range of keysyms in one shot by providing a I<string>
943	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1021	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
944	should be a character not used by the strings.	1022	should be a character not used by the strings.
945		1023
…		…
958	example the following means "change the current locale to C<zh_CN.GBK>	1036	example the following means "change the current locale to C<zh_CN.GBK>
959	when Control-Meta-c is being pressed":	1037	when Control-Meta-c is being pressed":
960		1038
961	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1039	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
962		1040
		1041	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1042	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1043	manpage. For example, the F<selection> extension (activated via
		1044	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1045
		1046	URxvt.keysym.M-C-c: perl:selection:rot13
		1047
		1048	Due the the large number of modifier combinations, a defined key mapping
		1049	will match if at I<at least> the specified identifiers are being set, and
		1050	no other key mappings with those and more bits are being defined. That
		1051	means that defining a key map for C<a> will automatically provide
		1052	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		1053	mappings themselves.
		1054
		1055	Unfortunately, this will override built-in key mappings. For example
		1056	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		1057	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		1058	user-defined keymap using the C<builtin:> replacement:
		1059
		1060	URxvt.keysym.Insert: <my insert key sequence>
		1061	URxvt.keysym.S-Insert: builtin:
		1062
		1063	The first line defines a mapping for C<Insert> and I<any> combination
		1064	of modifiers. The second line re-establishes the default mapping for
		1065	C<Shift-Insert>.
		1066
963	The following example will map Control-Meta-1 and Control-Meta-2 to	1067	The following example will map Control-Meta-1 and Control-Meta-2 to
964	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited	1068	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
965	font-switching at runtime:	1069	font-switching at runtime:
966		1070
967	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1071	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
…		…
970	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1074	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
971	info):	1075	info):
972		1076
973	URxvt.keysym.M-C-3: command:\033[8;25;80t	1077	URxvt.keysym.M-C-3: command:\033[8;25;80t
974	URxvt.keysym.M-C-4: command:\033[8;48;110t	1078	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1079
		1080	=item B<perl-ext-common>: I<string>
		1081
		1082	=item B<perl-ext>: I<string>
		1083
		1084	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1085	use in this terminal instance; option B<-pe>.
		1086
		1087	Extension names can be prefixed with a C<-> sign to prohibit using
		1088	them. This can be useful to selectively disable some extensions loaded
		1089	by default, or specified via the C<perl-ext-common> resource. For
		1090	example, C<default,-selection> will use all the default extension except
		1091	C<selection>.
		1092
		1093	Extension names can also be followed by an argument in angle brackets
		1094	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1095	searchable scorllback to Alt/Meta-s). Mentioning the same extension
		1096	multiple times with different arguments will pass multiple arguments to
		1097	the extension.
		1098
		1099	Each extension is looked up in the library directories, loaded if
		1100	necessary, and bound to the current terminal instance.
		1101
		1102	If both of these resources are the empty string, then the perl
		1103	interpreter will not be initialized. The idea behind two options is that
		1104	B<perl-ext-common> will be used for extensions that should be available to
		1105	all instances, while B<perl-ext> is used for specific instances.
		1106
		1107	=item B<perl-eval>: I<string>
		1108
		1109	Perl code to be evaluated when all extensions have been registered. See
		1110	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
		1111	will be ignored when running setuid/setgid.
		1112
		1113	=item B<perl-lib>: I<path>
		1114
		1115	Colon-separated list of additional directories that hold extension
		1116	scripts. When looking for extensions specified by the C<perl> resource,
		1117	@@RXVT_NAME@@ will first look in these directories and then in
		1118	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
		1119	will be ignored when running setuid/setgid.
		1120
		1121	See the @@RXVT_NAME@@perl(3) manpage.
		1122
		1123	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1124
		1125	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1126	details.
		1127
		1128	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1129
		1130	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1131	for details.
		1132
		1133	=item B<searchable-scrollback:> I<keysym>
		1134
		1135	Sets the hotkey that starts the incremental scrollback buffer search
		1136	(default: C<M-s>).
		1137
		1138	=item B<urlLauncher>: I<string>
		1139
		1140	Specifies the program to be started with a URL argument. Used by the
		1141	C<selection-popup> and C<mark-urls> perl extensions.
		1142
		1143	=item B<transient-for>: I<windowid>
		1144
		1145	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1146
		1147	=item B<override-redirect>: I<boolean>
		1148
		1149	Compile I<frills>: Sets override-redirect for the terminal window, making
		1150	it almost invisible to window managers; option B<-override-redirect>.
975		1151
976	=back	1152	=back
977		1153
978	=head1 THE SCROLLBAR	1154	=head1 THE SCROLLBAR
979		1155
…		…
1014	to select a word; Left triple-click to select the entire logical line	1190	to select a word; Left triple-click to select the entire logical line
1015	(which can span multiple screen lines), unless modified by resource	1191	(which can span multiple screen lines), unless modified by resource
1016	B<tripleclickwords>.	1192	B<tripleclickwords>.
1017		1193
1018	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1194	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
1019	(Compile: I<frills>) will create a rectangular selection instead of a normal	1195	(Compile: I<frills>) will create a rectangular selection instead of a
1020	one.	1196	normal one. In this mode, every selected row becomes its own line in the
		1197	selection, and trailing whitespace is visually underlined and removed from
		1198	the selection.
1021		1199
1022	=item B<Insertion>:	1200	=item B<Insertion>:
1023		1201
1024	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1202	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1025	an B<@@RXVT_NAME@@> window causes the current text selection to be	1203	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1026	inserted as if it had been typed on the keyboard.	1204	Meta modifier) to be inserted as if it had been typed on the keyboard.
		1205
		1206	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1207	inserted too.
1027		1208
1028	=back	1209	=back
1029		1210
1030	=head1 CHANGING FONTS	1211	=head1 CHANGING FONTS
1031		1212
1032	Changing fonts (or font sizes, respectively) via the keypad is not yet	1213	Changing fonts (or font sizes, respectively) via the keypad is not yet
1033	supported in rxvt-unicode. Bug me if you need this.	1214	supported in rxvt-unicode. Bug me if you need this.
1034		1215
1035	You can, however, switch fonts at runtime using escape sequences (and	1216	You can, however, switch fonts at runtime using escape sequences, e.g.:
1036	therefore using the menubar), e.g.:
1037		1217
1038	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1218	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1219
		1220	You can use keyboard shortcuts, too:
		1221
		1222	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1223	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1039		1224
1040	rxvt-unicode will automatically re-apply these fonts to the output so far.	1225	rxvt-unicode will automatically re-apply these fonts to the output so far.
1041		1226
1042	=head1 ISO 14755 SUPPORT	1227	=head1 ISO 14755 SUPPORT
1043		1228
…		…
1205		1390
1206	=item B<SHELL>	1391	=item B<SHELL>
1207		1392
1208	The shell to be used for command execution, defaults to C</bin/sh>.	1393	The shell to be used for command execution, defaults to C</bin/sh>.
1209		1394
1210	=item B<RXVTPATH>
1211
1212	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1213	files.
1214
1215	=item B<PATH>
1216
1217	Used in the same way as C<RXVTPATH>.
1218
1219	=item B<RXVT_SOCKET>	1395	=item B<RXVT_SOCKET>
1220		1396
1221	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1397	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1222	@@RXVT_NAME@@d(1).	1398	@@RXVT_NAME@@d(1).
1223		1399
1224	Default C<< $HOME/.rxvt-unicode-<nodename >>.	1400	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1225		1401
1226	=item B<HOME>	1402	=item B<HOME>
1227		1403
1228	Used to locate the default directory for the unix domain socket for	1404	Used to locate the default directory for the unix domain socket for
1229	daemon communications and to locate various resource files (such as	1405	daemon communications and to locate various resource files (such as
…		…
1250		1426
1251	=back	1427	=back
1252		1428
1253	=head1 SEE ALSO	1429	=head1 SEE ALSO
1254		1430
1255	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1431	@@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)
1256
1257	=head1 BUGS
1258
1259	Check the BUGS file for an up-to-date list.
1260
1261	Cursor change support is not yet implemented.
1262
1263	Click-and-drag doesn't work with X11 mouse report overriding.
1264		1432
1265	=head1 CURRENT PROJECT COORDINATOR	1433	=head1 CURRENT PROJECT COORDINATOR
1266		1434
1267	=over 4	1435	=over 4
1268		1436
…		…
1300		1468
1301	Project Coordinator (changes.txt 2.21a to 2.4.5)	1469	Project Coordinator (changes.txt 2.21a to 2.4.5)
1302		1470
1303	=item Geoff Wing L<< <gcw@pobox.com> >>	1471	=item Geoff Wing L<< <gcw@pobox.com> >>
1304		1472
1305	Rewrote screen display and text selection routines. Project Coordinator	1473	Rewrote screen display and text selection routines.
		1474
1306	(changes.txt 2.4.6 - rxvt-unicode)	1475	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1307		1476
1308	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1477	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1309		1478
1310	Forked rxvt-unicode, rewrote most of the display code and internal	1479	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1311	character handling to store text in unicode, improve xterm	1480	extension, random hacks, numerous bugfixes and extensions.
1312	compatibility and apply numerous other bugfixes and extensions.
1313		1481
1314	Project Coordinator (Changes 1.0 -)	1482	Project Coordinator (Changes 1.0 -)
1315		1483
		1484	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1485
		1486	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
		1487
1316	=back	1488	=back
1317		1489

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.59 by root, Thu Feb 17 15:07:48 2005 UTC vs. Revision 1.104 by root, Wed Jan 25 13:24:45 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.59 by root, Thu Feb 17 15:07:48 2005 UTC vs.
Revision 1.104 by root, Wed Jan 25 13:24:45 2006 UTC