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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.57 by root, Mon Feb 14 18:50:57 2005 UTC vs.
Revision 1.97 by root, Mon Jan 16 15:07:27 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<-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>.
284		308
285	=item B<-lsp> I<number>	309	=item B<-lsp> I<number>
286		310
287	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
288	the display. Useful to work around font rendering problems; resource	312	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	327	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	328	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,	329	run the program specified by the B<SHELL> environment variable or,
306	failing that, I<sh(1)>.	330	failing that, I<sh(1)>.
307		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
308	=item B<-title> I<text>	337	=item B<-title> I<text>
309		338
310	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
311	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
312	application name; resource B<title>.	341	application name; resource B<title>.
…		…
368	=item B<-ssr>\|B<+ssr>	397	=item B<-ssr>\|B<+ssr>
369		398
370	Turn on/off secondary screen scroll (default enabled); resource	399	Turn on/off secondary screen scroll (default enabled); resource
371	B<secondaryScroll>.	400	B<secondaryScroll>.
372		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
373	=item B<-keysym.>I<sym>: I<string>	409	=item B<-keysym.>I<sym> I<string>
374		410
375	Remap a key symbol. See resource B<keysym>.	411	Remap a key symbol. See resource B<keysym>.
376		412
377	=item B<-embed>: I<windowid>	413	=item B<-embed> I<windowid>
378		414
379	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,	415	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
380	which enables applications to easily embed a terminal.	416	which enables applications to easily embed a terminal.
381		417
382	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it	418	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
…		…
390	descriptors passed to it (except for stdin/out/err, of course), so you	426	descriptors passed to it (except for stdin/out/err, of course), so you
391	can use file descriptors to communicate with the programs within the	427	can use file descriptors to communicate with the programs within the
392	terminal. This works regardless of wether the C<-embed> option was used or	428	terminal. This works regardless of wether the C<-embed> option was used or
393	not.	429	not.
394		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
		469	=item B<-pe> I<string>
		470
		471	Comma-separated list of perl extension scripts to use (or not to use) in
		472	this terminal instance. See resource B<perl-ext> for details.
		473
395	=back	474	=back
396		475
397	=head1 RESOURCES (available also as long-options)	476	=head1 RESOURCES (available also as long-options)
398		477
399	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	478	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
400	options) compiled into your version.	479	options) compiled into your version.
401		480
402	There are two different methods that @@RXVT_NAME@@ can use to get the	481	You can set and change the resources using X11 tools like B<xrdb>. Many
403	Xresource data: using the X libraries (Xrm*-functions) or internal	482	distribution do also load settings from the B<~/.Xresources> file when X
404	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	483	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
405	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	484	with later settings overwriting earlier ones:
406	resources using X11 tools like B<xrdb>. Many distribution do also load
407	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
408	will consult the following files/resources in order, with later settings
409	overwriting earlier ones:
410		485
411	1. system-wide app-defaults file, either locale-dependent OR global	486	1. system-wide app-defaults file, either locale-dependent OR global
412	2. app-defaults file in $XAPPLRESDIR	487	2. app-defaults file in $XAPPLRESDIR
413	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	488	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
414	4. SCREEN_RESOURCES for the current screen	489	4. SCREEN_RESOURCES for the current screen
415	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	490	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
416		491
417	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
418	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
419	set in XAPPLOADDIR/URxvt (compile-time defined: usually
420	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
421	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
422	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	492	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
423	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows	493	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
424	resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be	494	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
425	easily configured, while the class name B<URxvt> allows resources	495	configured, while the class name B<URxvt> allows resources unique to
426	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	496	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
427	shared between different B<@@RXVT_NAME@@> configurations. If no	497	configurations. If no resources are specified, suitable defaults will
428	resources are specified, suitable defaults will be used. Command-line	498	be used. Command-line arguments can be used to override resource
429	arguments can be used to override resource settings. The following	499	settings. The following resources are supported (you might want to
430	resources are allowed:	500	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		501	extensions not documented here):
431		502
432	=over 4	503	=over 4
433		504
434	=item B<geometry:> I<geom>	505	=item B<geometry:> I<geom>
435		506
…		…
513	artificial transparency. B<False>: do not inherit the parent windows'	584	artificial transparency. B<False>: do not inherit the parent windows'
514	pixmap.	585	pixmap.
515		586
516	=item B<fading:> I<number>	587	=item B<fading:> I<number>
517		588
518	Fade the text by the given percentage when focus is lost.	589	Fade the text by the given percentage when focus is lost; option B<-fade>.
		590
		591	=item B<fadeColor:> I<colour>
		592
		593	Fade to this colour, when fading is used (see B<fading:>). The default
		594	colour is black; option B<-fadecolor>.
519		595
520	=item B<tintColor:> I<colour>	596	=item B<tintColor:> I<colour>
521		597
522	Tint the transparent background pixmap with the given colour.	598	Tint the transparent background pixmap with the given colour; option
		599	B<-tint>.
523		600
524	=item B<shading:> I<number>	601	=item B<shading:> I<number>
525		602
526	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	603	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
527	image in addition to tinting it.	604	image in addition to tinting it.
…		…
531	Use the specified colour for the scrollbar [default #B2B2B2].	608	Use the specified colour for the scrollbar [default #B2B2B2].
532		609
533	=item B<troughColor:> I<colour>	610	=item B<troughColor:> I<colour>
534		611
535	Use the specified colour for the scrollbar's trough area [default	612	Use the specified colour for the scrollbar's trough area [default
536	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	613	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
537		614
538	=item B<borderColor:> I<colour>	615	=item B<borderColor:> I<colour>
539		616
540	The colour of the border around the text area and between the scrollbar	617	The colour of the border around the text area and between the scrollbar
541	and the text.	618	and the text.
…		…
550	of 1 displays the image without any scaling. A scale of 2 to 9	627	of 1 displays the image without any scaling. A scale of 2 to 9
551	specifies an integer number of images in that direction. No image will	628	specifies an integer number of images in that direction. No image will
552	be magnified beyond 10 times its original size. The maximum permitted	629	be magnified beyond 10 times its original size. The maximum permitted
553	scale is 1000. [default 0x0+50+50]	630	scale is 1000. [default 0x0+50+50]
554		631
555	=item B<menu:> I<file[;tag]>
556
557	Read in the specified menu file (note the `.menu' extension is
558	optional) and also optionally specify a starting tag to find. See the
559	reference documentation for details on the syntax for the menuBar.
560
561	=item B<path:> I<path>	632	=item B<path:> I<path>
562		633
563	Specify the colon-delimited search path for finding files (XPM and	634	Specify the colon-delimited search path for finding XPM files.
564	menus), in addition to the paths specified by the B<RXVTPATH> and
565	B<PATH> environment variables.
566		635
567	=item B<font:> I<fontlist>	636	=item B<font:> I<fontlist>
568		637
569	Select the fonts to be used. This is a comma separated list of font	638	Select the fonts to be used. This is a comma separated list of font names
570	names that are used in turn when trying to display Unicode characters.	639	that are checked in order when trying to find glyphs for characters. The
571	The first font defines the cell size for characters; other fonts might	640	first font defines the cell size for characters; other fonts might be
572	be smaller, but not larger. A reasonable default font list is always	641	smaller, but not (in general) larger. A (hopefully) reasonable default
573	appended to it. option B<-fn>.	642	font list is always appended to it; option B<-fn>.
574		643
575	Each font can either be a standard X11 core font (XLFD) name, with	644	Each font can either be a standard X11 core font (XLFD) name, with
576	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.	645	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
577		646
578	In addition, each font can be prefixed with additional hints and	647	In addition, each font can be prefixed with additional hints and
…		…
580	hint currently is C<codeset=codeset-name>, and this is only used for Xft	649	hint currently is C<codeset=codeset-name>, and this is only used for Xft
581	fonts.	650	fonts.
582		651
583	For example, this font resource	652	For example, this font resource
584		653
585	URxvt*font: 9x15bold,\	654	URxvt.font: 9x15bold,\
586	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	655	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
587	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \	656	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
588	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	657	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
589	xft:Code2000:antialias=false	658	xft:Code2000:antialias=false
590		659
…		…
624	not possible, replacement fonts of the desired shape will be tried.	693	not possible, replacement fonts of the desired shape will be tried.
625		694
626	If set, but empty, then this specific style is disabled and the normal	695	If set, but empty, then this specific style is disabled and the normal
627	text font will being used for the given style.	696	text font will being used for the given style.
628		697
		698	=item B<intensityStyles:> I<boolean>
		699
		700	When font styles are not enabled, or this option is enabled (B<True>,
		701	option B<-is>, the default), bold and italic font styles imply high
		702	intensity foreground/backround colours. Disabling this option (B<False>,
		703	option B<+is>) disables this behaviour, the high intensity colours are not
		704	reachable.
		705
629	=item B<selectstyle:> I<mode>	706	=item B<selectstyle:> I<mode>
630		707
631	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	708	Set mouse selection style to B<old> which is 2.20, B<oldword> which is
632	xterm style with 2.20 old word selection, or anything else which gives	709	xterm style with 2.20 old word selection, or anything else which gives
633	xterm style selection.	710	xterm style selection.
634		711
635	=item B<scrollstyle:> I<mode>	712	=item B<scrollstyle:> I<mode>
636		713
637	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	714	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
638	the author's favourite..	715	the author's favourite.
639		716
640	=item B<title:> I<string>	717	=item B<title:> I<string>
641		718
642	Set window title string, the default title is the command-line	719	Set window title string, the default title is the command-line
643	specified after the B<-e> option, if any, otherwise the application	720	specified after the B<-e> option, if any, otherwise the application
…		…
675		752
676	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	753	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
677	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or	754	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
678	B<Shift-Print> to include the scrollback as well.	755	B<Shift-Print> to include the scrollback as well.
679		756
		757	The string will be interpreted as if typed into the shell as-is.
		758
		759	Example:
		760
		761	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		762
		763	This creates a new file in your home directory with the screen contents
		764	everytime you hit C<Print>.
		765
680	=item B<scrollBar:> I<boolean>	766	=item B<scrollBar:> I<boolean>
681		767
682	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	768	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
683	disable the scrollbar; option B<+sb>.	769	disable the scrollbar; option B<+sb>.
684		770
…		…
704	B<+si>.	790	B<+si>.
705		791
706	=item B<scrollWithBuffer:> I<boolean>	792	=item B<scrollWithBuffer:> I<boolean>
707		793
708	B<True>: scroll with scrollback buffer when tty receives new lines (and	794	B<True>: scroll with scrollback buffer when tty receives new lines (and
709	B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll	795	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
710	with scrollback buffer when tty recieves new lines; option B<-sw>.	796	with scrollback buffer when tty recieves new lines; option B<+sw>.
711		797
712	=item B<scrollTtyKeypress:> I<boolean>	798	=item B<scrollTtyKeypress:> I<boolean>
713		799
714	B<True>: scroll to bottom when a non-special key is pressed. Special keys	800	B<True>: scroll to bottom when a non-special key is pressed. Special keys
715	are those which are intercepted by rxvt-unicode for special handling and	801	are those which are intercepted by rxvt-unicode for special handling and
…		…
734	=item B<borderLess:> I<boolean>	820	=item B<borderLess:> I<boolean>
735		821
736	Set MWM hints to request a borderless window, i.e. if honoured by the	822	Set MWM hints to request a borderless window, i.e. if honoured by the
737	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.	823	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
738		824
		825	=item B<skipBuiltinGlyphs:> I<boolean>
		826
		827	Compile I<frills>: Disable the usage of the built-in block graphics/line
		828	drawing characters and just rely on what the specified fonts provide. Use
		829	this if you have a good font and want to use its block graphic glyphs;
		830	option B<-sbg>.
		831
739	=item B<termName:> I<termname>	832	=item B<termName:> I<termname>
740		833
741	Specifies the terminal type name to be set in the B<TERM> environment	834	Specifies the terminal type name to be set in the B<TERM> environment
742	variable; option B<-tn>.	835	variable; option B<-tn>.
743		836
…		…
780		873
781	Mouse pointer background colour.	874	Mouse pointer background colour.
782		875
783	=item B<pointerBlankDelay:> I<number>	876	=item B<pointerBlankDelay:> I<number>
784		877
785	Specifies number of seconds before blanking the pointer [default 2].	878	Specifies number of seconds before blanking the pointer [default 2]. Use a
		879	large number (e.g. C<987654321>) to effectively disable the timeout.
786		880
787	=item B<backspacekey:> I<string>	881	=item B<backspacekey:> I<string>
788		882
789	The string to send when the backspace key is pressed. If set to B<DEC>	883	The string to send when the backspace key is pressed. If set to B<DEC>
790	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	884	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
…		…
815	=item B<imLocale:> I<name>	909	=item B<imLocale:> I<name>
816		910
817	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.	911	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
818	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the	912	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
819	input extension to be able to input japanese characters while staying in	913	input extension to be able to input japanese characters while staying in
820	another locale. option B<-imlocale>.	914	another locale; option B<-imlocale>.
821		915
822	=item B<imFont:> I<fontset>	916	=item B<imFont:> I<fontset>
823		917
824	Specify the font-set used for XIM styles C<OverTheSpot> or	918	Specify the font-set used for XIM styles C<OverTheSpot> or
825	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated	919	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
…		…
830		924
831	=item B<tripleclickwords:> I<boolean>	925	=item B<tripleclickwords:> I<boolean>
832		926
833	Change the meaning of triple-click selection with the left mouse	927	Change the meaning of triple-click selection with the left mouse
834	button. Instead of selecting a full line it will extend the selection to	928	button. Instead of selecting a full line it will extend the selection to
835	the end of the logical line only. option B<-tcw>.	929	the end of the logical line only; option B<-tcw>.
836		930
837	=item B<insecure:> I<boolean>	931	=item B<insecure:> I<boolean>
838		932
839	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	933	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
840	echo arbitrary strings like the icon name or the locale. This could be	934	echo arbitrary strings like the icon name or the locale. This could be
841	abused if somebody gets 8-bit-clean access to your display, whether	935	abused if somebody gets 8-bit-clean access to your display, whether
842	throuh a mail client displaying mail bodies unfiltered or though	936	through a mail client displaying mail bodies unfiltered or through
843	write(1). Therefore, these sequences are disabled by default. (Note	937	write(1) or any other means. Therefore, these sequences are disabled by
844	that other terminals, including xterm, have these sequences	938	default. (Note that many other terminals, including xterm, have these
845	enabled by default). You can enable them by setting this boolean	939	sequences enabled by default, which doesn't make it safer, though).
846	resource or specifying B<-insecure> as an option. At the moment, this	940
847	enabled display-answer, locale, findfont, icon label and window title	941	You can enable them by setting this boolean resource or specifying
848	requests as well as dynamic menubar dispatch.	942	B<-insecure> as an option. At the moment, this enables display-answer,
		943	locale, findfont, icon label and window title requests.
849		944
850	=item B<modifier:> I<modifier>	945	=item B<modifier:> I<modifier>
851		946
852	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	947	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
853	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	948	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
867		962
868	Turn on/off secondary screen scroll (default enabled). If the this	963	Turn on/off secondary screen scroll (default enabled). If the this
869	option is enabled, scrolls on the secondary screen will change the	964	option is enabled, scrolls on the secondary screen will change the
870	scrollback buffer and switching to/from the secondary screen will	965	scrollback buffer and switching to/from the secondary screen will
871	instead scroll the screen up.	966	instead scroll the screen up.
		967
		968	=item B<hold>: I<bool>
		969
		970	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		971	will not immediately destroy its window when the program executed within
		972	it exits. Instead, it will wait till it is being killed or closed by the
		973	user.
872		974
873	=item B<keysym.>I<sym>: I<string>	975	=item B<keysym.>I<sym>: I<string>
874		976
875	Compile I<frills>: Associate I<string> with keysym I<sym>. The	977	Compile I<frills>: Associate I<string> with keysym I<sym>. The
876	intervening resource name B<keysym.> cannot be omitted.	978	intervening resource name B<keysym.> cannot be omitted.
…		…
896	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	998	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
897	C<\000>: octal number) or verbatim control characters (C<^?>: delete,	999	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
898	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it	1000	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
899	can start or end with whitespace.	1001	can start or end with whitespace.
900		1002
901	Please note that you need to double the C<\> when using	1003	Please note that you need to double the C<\> in resource files, as
902	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can	1004	Xlib itself does it's own de-escaping (you can use C<\033> instead of
903	use C<\033> instead of C<\e> (and so on), which will work with both Xt and	1005	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
904	@@RXVT_NAME@@'s own processing).	1006	processing).
905		1007
906	You can define a range of keysyms in one shot by providing a I<string>	1008	You can define a range of keysyms in one shot by providing a I<string>
907	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1009	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
908	should be a character not used by the strings.	1010	should be a character not used by the strings.
909		1011
…		…
922	example the following means "change the current locale to C<zh_CN.GBK>	1024	example the following means "change the current locale to C<zh_CN.GBK>
923	when Control-Meta-c is being pressed":	1025	when Control-Meta-c is being pressed":
924		1026
925	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1027	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
926		1028
		1029	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1030	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1031	manpage. For example, the F<selection> extension (activated via
		1032	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1033
		1034	URxvt.keysym.M-C-c: perl:selection:rot13
		1035
		1036	Due the the large number of modifier combinations, a defined key mapping
		1037	will match if at I<at least> the specified identifiers are being set, and
		1038	no other key mappings with those and more bits are being defined. That
		1039	means that defining a key map for C<a> will automatically provide
		1040	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		1041	mappings themselves.
		1042
		1043	Unfortunately, this will override built-in key mappings. For example
		1044	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		1045	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		1046	user-defined keymap using the C<builtin:> replacement:
		1047
		1048	URxvt.keysym.Insert: <my insert key sequence>
		1049	URxvt.keysym.S-Insert: builtin:
		1050
		1051	The first line defines a mapping for C<Insert> and I<any> combination
		1052	of modifiers. The second line re-establishes the default mapping for
		1053	C<Shift-Insert>.
		1054
927	The following example will map Control-Meta-1 and Control-Meta-2 to	1055	The following example will map Control-Meta-1 and Control-Meta-2 to
928	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited	1056	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
929	font-switching at runtime:	1057	font-switching at runtime:
930		1058
931	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1059	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
…		…
934	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1062	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
935	info):	1063	info):
936		1064
937	URxvt.keysym.M-C-3: command:\033[8;25;80t	1065	URxvt.keysym.M-C-3: command:\033[8;25;80t
938	URxvt.keysym.M-C-4: command:\033[8;48;110t	1066	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1067
		1068	=item B<perl-ext-common>: I<string>
		1069
		1070	=item B<perl-ext>: I<string>
		1071
		1072	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1073	use in this terminal instance; option B<-pe>.
		1074
		1075	Extension names can be prefixed with a C<-> sign to prohibit using
		1076	them. This can be useful to selectively disable some extensions loaded
		1077	by default, or specified via the C<perl-ext-common> resource. For
		1078	example, C<default,-selection> will use all the default extension except
		1079	C<selection>.
		1080
		1081	Extension names can also be followed by an argument in angle brackets
		1082	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1083	searchable scorllback to Alt/Meta-s). Mentioning the same extension
		1084	multiple times with different arguments will pass multiple arguments to
		1085	the extension.
		1086
		1087	Each extension is looked up in the library directories, loaded if
		1088	necessary, and bound to the current terminal instance.
		1089
		1090	If both of these resources are the empty string, then the perl
		1091	interpreter will not be initialized. The idea behind two options is that
		1092	B<perl-ext-common> will be used for extensions that should be available to
		1093	all instances, while B<perl-ext> is used for specific instances.
		1094
		1095	=item B<perl-eval>: I<string>
		1096
		1097	Perl code to be evaluated when all extensions have been registered. See
		1098	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
		1099	will be ignored when running setuid/setgid.
		1100
		1101	=item B<perl-lib>: I<path>
		1102
		1103	Colon-separated list of additional directories that hold extension
		1104	scripts. When looking for extensions specified by the C<perl> resource,
		1105	@@RXVT_NAME@@ will first look in these directories and then in
		1106	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
		1107	will be ignored when running setuid/setgid.
		1108
		1109	See the @@RXVT_NAME@@perl(3) manpage.
		1110
		1111	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1112
		1113	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1114	details.
		1115
		1116	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1117
		1118	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1119	for details.
		1120
		1121	=item B<searchable-scrollback:> I<keysym>
		1122
		1123	Sets the hotkey that starts the incremental scrollback buffer search
		1124	(default: C<M-s>).
		1125
		1126	=item B<urlLauncher>: I<string>
		1127
		1128	Specifies the program to be started with a URL argument. Used by the
		1129	C<selection-popup> and C<mark-urls> perl extensions.
		1130
		1131	=item B<transient-for>: I<windowid>
		1132
		1133	Sets the WM_TRANSIENT_FOR property to the given window iw.
939		1134
940	=back	1135	=back
941		1136
942	=head1 THE SCROLLBAR	1137	=head1 THE SCROLLBAR
943		1138
…		…
978	to select a word; Left triple-click to select the entire logical line	1173	to select a word; Left triple-click to select the entire logical line
979	(which can span multiple screen lines), unless modified by resource	1174	(which can span multiple screen lines), unless modified by resource
980	B<tripleclickwords>.	1175	B<tripleclickwords>.
981		1176
982	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1177	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
983	(Compile: I<frills>) will create a rectangular selection instead of a normal	1178	(Compile: I<frills>) will create a rectangular selection instead of a
984	one.	1179	normal one. In this mode, every selected row becomes its own line in the
		1180	selection, and trailing whitespace is visually underlined and removed from
		1181	the selection.
985		1182
986	=item B<Insertion>:	1183	=item B<Insertion>:
987		1184
988	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1185	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
989	an B<@@RXVT_NAME@@> window causes the current text selection to be	1186	an B<@@RXVT_NAME@@> window causes the current text selection to be
…		…
994	=head1 CHANGING FONTS	1191	=head1 CHANGING FONTS
995		1192
996	Changing fonts (or font sizes, respectively) via the keypad is not yet	1193	Changing fonts (or font sizes, respectively) via the keypad is not yet
997	supported in rxvt-unicode. Bug me if you need this.	1194	supported in rxvt-unicode. Bug me if you need this.
998		1195
999	You can, however, switch fonts at runtime using escape sequences (and	1196	You can, however, switch fonts at runtime using escape sequences, e.g.:
1000	therefore using the menubar), e.g.:
1001		1197
1002	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1198	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1199
		1200	You can use keyboard shortcuts, too:
		1201
		1202	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1203	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1003		1204
1004	rxvt-unicode will automatically re-apply these fonts to the output so far.	1205	rxvt-unicode will automatically re-apply these fonts to the output so far.
1005		1206
1006	=head1 ISO 14755 SUPPORT	1207	=head1 ISO 14755 SUPPORT
1007		1208
…		…
1183	=item B<RXVT_SOCKET>	1384	=item B<RXVT_SOCKET>
1184		1385
1185	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1386	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1186	@@RXVT_NAME@@d(1).	1387	@@RXVT_NAME@@d(1).
1187		1388
1188	Default C<< $HOME/.rxvt-unicode-<nodename >>.	1389	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1189		1390
1190	=item B<HOME>	1391	=item B<HOME>
1191		1392
1192	Used to locate the default directory for the unix domain socket for	1393	Used to locate the default directory for the unix domain socket for
1193	daemon communications and to locate various resource files (such as	1394	daemon communications and to locate various resource files (such as
…		…
1214		1415
1215	=back	1416	=back
1216		1417
1217	=head1 SEE ALSO	1418	=head1 SEE ALSO
1218		1419
1219	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1420	@@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)
1220
1221	=head1 BUGS
1222
1223	Check the BUGS file for an up-to-date list.
1224
1225	Cursor change support is not yet implemented.
1226
1227	Click-and-drag doesn't work with X11 mouse report overriding.
1228		1421
1229	=head1 CURRENT PROJECT COORDINATOR	1422	=head1 CURRENT PROJECT COORDINATOR
1230		1423
1231	=over 4	1424	=over 4
1232		1425

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.57 by root, Mon Feb 14 18:50:57 2005 UTC vs. Revision 1.97 by root, Mon Jan 16 15:07:27 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.57 by root, Mon Feb 14 18:50:57 2005 UTC vs.
Revision 1.97 by root, Mon Jan 16 15:07:27 2006 UTC