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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.48 by root, Thu Feb 3 10:24:10 2005 UTC vs.
Revision 1.97 by root, Mon Jan 16 15:07:27 2006 UTC

…		…
14	configurability. As a result, B<rxvt-unicode> uses much less swap space --	14	configurability. As a result, B<rxvt-unicode> uses much less swap space --
15	a significant advantage on a machine serving many X sessions.	15	a significant advantage on a machine serving many X sessions.
16		16
17	=head1 FREQUENTLY ASKED QUESTIONS	17	=head1 FREQUENTLY ASKED QUESTIONS
18		18
19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of frequently	19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20	asked questions and answer to them and some common problems.	20	frequently asked questions and answer to them and some common
		21	problems. That document is also accessible on the World-Wide-Web at
		22	L<http://cvs.schmorp.de/browse/checkout/rxvt-unicode/doc/rxvt.7.html>.
21		23
22	=head1 RXVT-UNICODE VS. RXVT	24	=head1 RXVT-UNICODE VS. RXVT
23		25
24	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode	26	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
25	internally. That means it can store and display most scripts in the	27	internally. That means it can store and display most scripts in the
…		…
103		105
104	=item B<-j>\|B<+j>	106	=item B<-j>\|B<+j>
105		107
106	Turn on/off jump scrolling; resource B<jumpScroll>.	108	Turn on/off jump scrolling; resource B<jumpScroll>.
107		109
108	=item B<-ip>\|B<+ip>	110	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>
109		111
110	Turn on/off inheriting parent window's pixmap. Alternative form is	112	Turn on/off inheriting parent window's pixmap. Alternative form is
111	B<-tr>; resource B<inheritPixmap>.	113	B<-tr>; resource B<inheritPixmap>.
112		114
113	=item B<-fade> I<number>	115	=item B<-fade> I<number>
114		116
115	Fade the text by the given percentage when focus is lost. resource B<fading>.	117	Fade the text by the given percentage when focus is lost. Small values
		118	fade a little only, 100 completely replaces all colours by the fade
		119	colour; resource B<fading>.
		120
		121	=item B<-fadecolor> I<colour>
		122
		123	Fade to this colour when fading is used (see B<-fade>). The default colour
		124	is black. resource B<fadeColor>.
116		125
117	=item B<-tint> I<colour>	126	=item B<-tint> I<colour>
118		127
119	Tint the transparent background pixmap with the given colour when	128	Tint the transparent background pixmap with the given colour when
120	transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>	129	transparency is enabled with B<-tr> or B<-ip>. This only works for
121	option that can be used to brighten or darken the image in addition to	130	non-tiled backgrounds, currently. See also the B<-sh> option that can be
122	tinting it.	131	used to brighten or darken the image in addition to tinting it; resource
		132	I<tintColor>. Example:
		133
		134	@@RXVT_NAME@@ -tr -tint blue -sh 40
123		135
124	=item B<-sh>	136	=item B<-sh>
125		137
126	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	138	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
127	background image in addition to tinting it (i.e. B<-tint> must be	139	background image in addition to tinting it (i.e. B<-tint> must be
…		…
160	resource B<borderColor>.	172	resource B<borderColor>.
161		173
162	=item B<-fn> I<fontlist>	174	=item B<-fn> I<fontlist>
163		175
164	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
165	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
166	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
167	smaller, but not (in general) larger. A (hopefully) reasonable default	179	smaller, but not (in general) larger. A (hopefully) reasonable default
168	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.
169		181
170	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
…		…
177	See also the question "How does rxvt-unicode choose fonts?" in the FAQ	189	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
178	section of @@RXVT_NAME@@(7).	190	section of @@RXVT_NAME@@(7).
179		191
180	=item B<-fb> I<fontlist>	192	=item B<-fb> I<fontlist>
181		193
182	Compile font-styles: The bold font list to use when bold characters are to	194	Compile I<font-styles>: The bold font list to use when B<bold> characters
183	be printed. See resource B<boldFont> for details.	195	are to be printed. See resource B<boldFont> for details.
184		196
185	=item B<-fi> I<fontlist>	197	=item B<-fi> I<fontlist>
186		198
187	Compile font-styles: The italic font list to use when bold characters are to	199	Compile I<font-styles>: The italic font list to use when I<italic>
188	be printed. See resource B<italicFont> for details.	200	characters are to be printed. See resource B<italicFont> for details.
189		201
190	=item B<-fbi> I<fontlist>	202	=item B<-fbi> I<fontlist>
191		203
192	Compile font-styles: The bold italic font list to use when bold characters are to	204	Compile I<font-styles>: The bold italic font list to use when B<< I<bold
193	be printed. See resource B<boldItalicFont> for details.	205	italic> >> characters are to be printed. See resource B<boldItalicFont>
		206	for details.
		207
		208	=item B<-is>\|B<+is>
		209
		210	Compile I<font-styles>: Bold/Italic font styles imply high intensity
		211	foreground/background (default). See resource B<intensityStyles> for
		212	details.
194		213
195	=item B<-name> I<name>	214	=item B<-name> I<name>
196		215
197	Specify the application name under which resources are to be obtained,	216	Specify the application name under which resources are to be obtained,
198	rather than the default executable file name. Name should not contain	217	rather than the default executable file name. Name should not contain
…		…
236		255
237	Put scrollbar on right/left; resource B<scrollBar_right>.	256	Put scrollbar on right/left; resource B<scrollBar_right>.
238		257
239	=item B<-st>\|B<+st>	258	=item B<-st>\|B<+st>
240		259
241	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	260	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
242	resource B<scrollBar_floating>.	261	resource B<scrollBar_floating>.
243		262
244	=item B<-ptab>\|B<+ptab>	263	=item B<-ptab>\|B<+ptab>
245		264
246	If enabled (default), "Horizontal Tab" characters are being stored as	265	If enabled (default), "Horizontal Tab" characters are being stored as
…		…
277	=item B<-bl>	296	=item B<-bl>
278		297
279	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	298	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
280	if honoured by the WM, the rxvt-unicode window will not have window	299	if honoured by the WM, the rxvt-unicode window will not have window
281	decorations; resource B<borderLess>.	300	decorations; resource B<borderLess>.
		301
		302	=item B<-sbg>
		303
		304	Compile I<frills>: Disable the usage of the built-in block graphics/line
		305	drawing characters and just rely on what the specified fonts provide. Use
		306	this if you have a good font and want to use its block graphic glyphs;
		307	resource B<skipBuiltinGlyphs>.
282		308
283	=item B<-lsp> I<number>	309	=item B<-lsp> I<number>
284		310
285	Compile I<frills>: Lines (pixel height) to insert between each row of	311	Compile I<frills>: Lines (pixel height) to insert between each row of
286	the display. Useful to work around font rendering problems; resource	312	the display. Useful to work around font rendering problems; resource
…		…
301	given on the command line. If this option is used, it must be the last	327	given on the command line. If this option is used, it must be the last
302	on the command-line. If there is no B<-e> option then the default is to	328	on the command-line. If there is no B<-e> option then the default is to
303	run the program specified by the B<SHELL> environment variable or,	329	run the program specified by the B<SHELL> environment variable or,
304	failing that, I<sh(1)>.	330	failing that, I<sh(1)>.
305		331
		332	Please note that you must specify a program with arguments. If you want to
		333	run shell commands, you have to specify the shell, like this:
		334
		335	@@RXVT_NAME@@ -e sh -c "shell commands"
		336
306	=item B<-title> I<text>	337	=item B<-title> I<text>
307		338
308	Window title (B<-T> still respected); the default title is the basename	339	Window title (B<-T> still respected); the default title is the basename
309	of the program specified after the B<-e> option, if any, otherwise the	340	of the program specified after the B<-e> option, if any, otherwise the
310	application name; resource B<title>.	341	application name; resource B<title>.
…		…
366	=item B<-ssr>\|B<+ssr>	397	=item B<-ssr>\|B<+ssr>
367		398
368	Turn on/off secondary screen scroll (default enabled); resource	399	Turn on/off secondary screen scroll (default enabled); resource
369	B<secondaryScroll>.	400	B<secondaryScroll>.
370		401
		402	=item B<-hold>\|B<+hold>
		403
		404	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		405	will not immediately destroy its window when the program executed within
		406	it exits. Instead, it will wait till it is being killed or closed by the
		407	user; resource B<hold>.
		408
		409	=item B<-keysym.>I<sym> I<string>
		410
		411	Remap a key symbol. See resource B<keysym>.
		412
		413	=item B<-embed> I<windowid>
		414
		415	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
		416	which enables applications to easily embed a terminal.
		417
		418	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
		419	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
		420	quite a bit, so don't expect it to keep some specific state. It's best to
		421	create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
		422
		423	The window will not be destroyed when @@RXVT_NAME@@ exits.
		424
		425	It might be useful to know that @@RXVT_NAME@@ will not close file
		426	descriptors passed to it (except for stdin/out/err, of course), so you
		427	can use file descriptors to communicate with the programs within the
		428	terminal. This works regardless of wether the C<-embed> option was used or
		429	not.
		430
		431	Here is a short Gtk2-perl snippet that illustrates how this option can be
		432	used (a longer example is in F<doc/embed>):
		433
		434	my $rxvt = new Gtk2::Socket;
		435	$rxvt->signal_connect_after (realize => sub {
		436	my $xid = $_[0]->window->get_xid;
		437	system "@@RXVT_NAME@@ -embed $xid &";
		438	});
		439
		440	=item B<-pty-fd> I<file descriptor>
		441
		442	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
		443	pair but instead use the given filehandle as the tty master. This is
		444	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
		445	without having to run a program within it.
		446
		447	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
		448	entries and will not tinker with pty/tty permissions - you have to do that
		449	yourself if you want that.
		450
		451	As an extremely special case, specifying C<-1> will completely suppress
		452	pty/tty operations.
		453
		454	Here is a example in perl that illustrates how this option can be used (a
		455	longer example is in F<doc/pty-fd>):
		456
		457	use IO::Pty;
		458	use Fcntl;
		459
		460	my $pty = new IO::Pty;
		461	fcntl $pty, F_SETFD, 0; # clear close-on-exec
		462	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		463	close $pty;
		464
		465	# now communicate with rxvt
		466	my $slave = $pty->slave;
		467	while (<$slave>) { print $slave "got <$_>\n" }
		468
371	=item B<-xrm> I<resourcestring>	469	=item B<-pe> I<string>
372		470
373	No effect on rxvt-unicode. Simply passes through an argument to be made	471	Comma-separated list of perl extension scripts to use (or not to use) in
374	available in the instance's argument list. Appears in I<WM_COMMAND> in	472	this terminal instance. See resource B<perl-ext> for details.
375	some window managers.
376		473
377	=back	474	=back
378		475
379	=head1 RESOURCES (available also as long-options)	476	=head1 RESOURCES (available also as long-options)
380		477
381	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	478	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
382	options) compiled into your version.	479	options) compiled into your version.
383		480
384	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
385	Xresource data: using the X libraries (Xrm*-functions) or internal	482	distribution do also load settings from the B<~/.Xresources> file when X
386	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	483	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
387	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	484	with later settings overwriting earlier ones:
388	resources using X11 tools like B<xset>. Many distribution do also load
389	settings from the B<~/.Xresources> file when X starts.
390		485
391	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>	486	1. system-wide app-defaults file, either locale-dependent OR global
392	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults	487	2. app-defaults file in $XAPPLRESDIR
393	set in XAPPLOADDIR/URxvt (compile-time defined: usually	488	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
394	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	489	4. SCREEN_RESOURCES for the current screen
395	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.	490	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		491
396	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	492	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
397	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
398	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
399	easily configured, while the class name B<URxvt> allows resources	495	configured, while the class name B<URxvt> allows resources unique to
400	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	496	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
401	shared between different B<@@RXVT_NAME@@> configurations. If no	497	configurations. If no resources are specified, suitable defaults will
402	resources are specified, suitable defaults will be used. Command-line	498	be used. Command-line arguments can be used to override resource
403	arguments can be used to override resource settings. The following	499	settings. The following resources are supported (you might want to
404	resources are allowed:	500	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		501	extensions not documented here):
405		502
406	=over 4	503	=over 4
407		504
408	=item B<geometry:> I<geom>	505	=item B<geometry:> I<geom>
409		506
…		…
487	artificial transparency. B<False>: do not inherit the parent windows'	584	artificial transparency. B<False>: do not inherit the parent windows'
488	pixmap.	585	pixmap.
489		586
490	=item B<fading:> I<number>	587	=item B<fading:> I<number>
491		588
492	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>.
493		595
494	=item B<tintColor:> I<colour>	596	=item B<tintColor:> I<colour>
495		597
496	Tint the transparent background pixmap with the given colour.	598	Tint the transparent background pixmap with the given colour; option
		599	B<-tint>.
497		600
498	=item B<shading:> I<number>	601	=item B<shading:> I<number>
499		602
500	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	603	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
501	image in addition to tinting it.	604	image in addition to tinting it.
…		…
505	Use the specified colour for the scrollbar [default #B2B2B2].	608	Use the specified colour for the scrollbar [default #B2B2B2].
506		609
507	=item B<troughColor:> I<colour>	610	=item B<troughColor:> I<colour>
508		611
509	Use the specified colour for the scrollbar's trough area [default	612	Use the specified colour for the scrollbar's trough area [default
510	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	613	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
511		614
512	=item B<borderColor:> I<colour>	615	=item B<borderColor:> I<colour>
513		616
514	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
515	and the text.	618	and the text.
…		…
524	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
525	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
526	be magnified beyond 10 times its original size. The maximum permitted	629	be magnified beyond 10 times its original size. The maximum permitted
527	scale is 1000. [default 0x0+50+50]	630	scale is 1000. [default 0x0+50+50]
528		631
529	=item B<menu:> I<file[;tag]>
530
531	Read in the specified menu file (note the `.menu' extension is
532	optional) and also optionally specify a starting tag to find. See the
533	reference documentation for details on the syntax for the menuBar.
534
535	=item B<path:> I<path>	632	=item B<path:> I<path>
536		633
537	Specify the colon-delimited search path for finding files (XPM and	634	Specify the colon-delimited search path for finding XPM files.
538	menus), in addition to the paths specified by the B<RXVTPATH> and
539	B<PATH> environment variables.
540		635
541	=item B<font:> I<fontlist>	636	=item B<font:> I<fontlist>
542		637
543	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
544	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
545	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
546	be smaller, but not larger. A reasonable default font list is always	641	smaller, but not (in general) larger. A (hopefully) reasonable default
547	appended to it. option B<-fn>.	642	font list is always appended to it; option B<-fn>.
548		643
549	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
550	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:>.
551		646
552	In addition, each font can be prefixed with additional hints and	647	In addition, each font can be prefixed with additional hints and
…		…
554	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
555	fonts.	650	fonts.
556		651
557	For example, this font resource	652	For example, this font resource
558		653
559	URxvt*font: 9x15bold,\	654	URxvt.font: 9x15bold,\
560	-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,\
561	-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, \
562	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	657	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
563	xft:Code2000:antialias=false	658	xft:Code2000:antialias=false
564		659
…		…
598	not possible, replacement fonts of the desired shape will be tried.	693	not possible, replacement fonts of the desired shape will be tried.
599		694
600	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
601	text font will being used for the given style.	696	text font will being used for the given style.
602		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
603	=item B<selectstyle:> I<mode>	706	=item B<selectstyle:> I<mode>
604		707
605	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
606	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
607	xterm style selection.	710	xterm style selection.
608		711
609	=item B<scrollstyle:> I<mode>	712	=item B<scrollstyle:> I<mode>
610		713
611	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
612	the author's favourite..	715	the author's favourite.
613		716
614	=item B<title:> I<string>	717	=item B<title:> I<string>
615		718
616	Set window title string, the default title is the command-line	719	Set window title string, the default title is the command-line
617	specified after the B<-e> option, if any, otherwise the application	720	specified after the B<-e> option, if any, otherwise the application
…		…
649		752
650	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
651	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
652	B<Shift-Print> to include the scrollback as well.	755	B<Shift-Print> to include the scrollback as well.
653		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
654	=item B<scrollBar:> I<boolean>	766	=item B<scrollBar:> I<boolean>
655		767
656	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	768	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
657	disable the scrollbar; option B<+sb>.	769	disable the scrollbar; option B<+sb>.
658		770
…		…
678	B<+si>.	790	B<+si>.
679		791
680	=item B<scrollWithBuffer:> I<boolean>	792	=item B<scrollWithBuffer:> I<boolean>
681		793
682	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
683	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
684	with scrollback buffer when tty recieves new lines; option B<-sw>.	796	with scrollback buffer when tty recieves new lines; option B<+sw>.
685		797
686	=item B<scrollTtyKeypress:> I<boolean>	798	=item B<scrollTtyKeypress:> I<boolean>
687		799
688	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
689	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
…		…
708	=item B<borderLess:> I<boolean>	820	=item B<borderLess:> I<boolean>
709		821
710	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
711	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>.
712		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
713	=item B<termName:> I<termname>	832	=item B<termName:> I<termname>
714		833
715	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
716	variable; option B<-tn>.	835	variable; option B<-tn>.
717		836
…		…
754		873
755	Mouse pointer background colour.	874	Mouse pointer background colour.
756		875
757	=item B<pointerBlankDelay:> I<number>	876	=item B<pointerBlankDelay:> I<number>
758		877
759	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.
760		880
761	=item B<backspacekey:> I<string>	881	=item B<backspacekey:> I<string>
762		882
763	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>
764	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>
…		…
789	=item B<imLocale:> I<name>	909	=item B<imLocale:> I<name>
790		910
791	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.
792	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
793	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
794	another locale. option B<-imlocale>.	914	another locale; option B<-imlocale>.
795		915
796	=item B<imFont:> I<fontset>	916	=item B<imFont:> I<fontset>
797		917
798	Specify the font-set used for XIM styles C<OverTheSpot> or	918	Specify the font-set used for XIM styles C<OverTheSpot> or
799	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated	919	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
…		…
804		924
805	=item B<tripleclickwords:> I<boolean>	925	=item B<tripleclickwords:> I<boolean>
806		926
807	Change the meaning of triple-click selection with the left mouse	927	Change the meaning of triple-click selection with the left mouse
808	button. Instead of selecting a full line it will extend the selection to	928	button. Instead of selecting a full line it will extend the selection to
809	the end of the logical line only. option B<-tcw>.	929	the end of the logical line only; option B<-tcw>.
810		930
811	=item B<insecure:> I<boolean>	931	=item B<insecure:> I<boolean>
812		932
813	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	933	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
814	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
815	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
816	throuh a mail client displaying mail bodies unfiltered or though	936	through a mail client displaying mail bodies unfiltered or through
817	write(1). Therefore, these sequences are disabled by default. (Note	937	write(1) or any other means. Therefore, these sequences are disabled by
818	that other terminals, including xterm, have these sequences	938	default. (Note that many other terminals, including xterm, have these
819	enabled by default). You can enable them by setting this boolean	939	sequences enabled by default, which doesn't make it safer, though).
820	resource or specifying B<-insecure> as an option. At the moment, this	940
821	enabled display-answer, locale, findfont, icon label and window title	941	You can enable them by setting this boolean resource or specifying
822	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.
823		944
824	=item B<modifier:> I<modifier>	945	=item B<modifier:> I<modifier>
825		946
826	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>,
827	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
…		…
841		962
842	Turn on/off secondary screen scroll (default enabled). If the this	963	Turn on/off secondary screen scroll (default enabled). If the this
843	option is enabled, scrolls on the secondary screen will change the	964	option is enabled, scrolls on the secondary screen will change the
844	scrollback buffer and switching to/from the secondary screen will	965	scrollback buffer and switching to/from the secondary screen will
845	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.
846		974
847	=item B<keysym.>I<sym>: I<string>	975	=item B<keysym.>I<sym>: I<string>
848		976
849	Compile I<frills>: Associate I<string> with keysym I<sym>. The	977	Compile I<frills>: Associate I<string> with keysym I<sym>. The
850	intervening resource name B<keysym.> cannot be omitted.	978	intervening resource name B<keysym.> cannot be omitted.
…		…
870	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,
871	C<\000>: octal number) or verbatim control characters (C<^?>: delete,	999	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
872	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
873	can start or end with whitespace.	1001	can start or end with whitespace.
874		1002
875	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
876	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
877	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
878	@@RXVT_NAME@@'s own processing).	1006	processing).
879		1007
880	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>
881	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1009	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
882	should be a character not used by the strings.	1010	should be a character not used by the strings.
883		1011
…		…
896	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>
897	when Control-Meta-c is being pressed":	1025	when Control-Meta-c is being pressed":
898		1026
899	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
900		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
901	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
902	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
903	font-switching at runtime:	1057	font-switching at runtime:
904		1058
905	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1059	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
…		…
908	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
909	info):	1063	info):
910		1064
911	URxvt.keysym.M-C-3: command:\033[8;25;80t	1065	URxvt.keysym.M-C-3: command:\033[8;25;80t
912	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.
913		1134
914	=back	1135	=back
915		1136
916	=head1 THE SCROLLBAR	1137	=head1 THE SCROLLBAR
917		1138
…		…
931	the normal text selection/insertion, hold either the Shift or the Meta	1152	the normal text selection/insertion, hold either the Shift or the Meta
932	(Alt) key while performing the desired mouse action.	1153	(Alt) key while performing the desired mouse action.
933		1154
934	If mouse reporting mode is active, the normal scrollbar actions are	1155	If mouse reporting mode is active, the normal scrollbar actions are
935	disabled -- on the assumption that we are using a fullscreen	1156	disabled -- on the assumption that we are using a fullscreen
936	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	1157	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
937	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	1158	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
938	up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down),	1159	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
939	respectively.	1160	respectively.
940		1161
941	=head1 TEXT SELECTION AND INSERTION	1162	=head1 TEXT SELECTION AND INSERTION
942		1163
943	The behaviour of text selection and insertion mechanism is similar to	1164	The behaviour of text selection and insertion mechanism is similar to
…		…
952	to select a word; Left triple-click to select the entire logical line	1173	to select a word; Left triple-click to select the entire logical line
953	(which can span multiple screen lines), unless modified by resource	1174	(which can span multiple screen lines), unless modified by resource
954	B<tripleclickwords>.	1175	B<tripleclickwords>.
955		1176
956	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)
957	(Compile: I<frills>) will create a rectangular selection instead of a normal	1178	(Compile: I<frills>) will create a rectangular selection instead of a
958	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.
959		1182
960	=item B<Insertion>:	1183	=item B<Insertion>:
961		1184
962	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
963	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
…		…
968	=head1 CHANGING FONTS	1191	=head1 CHANGING FONTS
969		1192
970	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
971	supported in rxvt-unicode. Bug me if you need this.	1194	supported in rxvt-unicode. Bug me if you need this.
972		1195
973	You can, however, switch fonts at runtime using escape sequences (and	1196	You can, however, switch fonts at runtime using escape sequences, e.g.:
974	therefore using the menubar), e.g.:
975		1197
976	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
977		1204
978	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.
979		1206
980	=head1 ISO 14755 SUPPORT	1207	=head1 ISO 14755 SUPPORT
981		1208
…		…
1098		1325
1099	=back	1326	=back
1100		1327
1101	=head1 ENVIRONMENT	1328	=head1 ENVIRONMENT
1102		1329
1103	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>	1330	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1104	and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X	1331
1105	window id number of the B<@@RXVT_NAME@@> window and it also uses and	1332	=over 4
1106	sets the environment variable B<DISPLAY> to specify which display	1333
1107	terminal to use. B<@@RXVT_NAME@@> uses the environment variables	1334	=item B<TERM>
1108	B<RXVTPATH> and B<PATH> to find XPM files.	1335
		1336	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
		1337	resources or on the commandline.
		1338
		1339	=item B<COLORTERM>
		1340
		1341	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
		1342	compiled with XPM support, and optionally with the added extension
		1343	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
		1344
		1345	=item B<COLORFGBG>
		1346
		1347	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
		1348	the colour code used as default foreground/text colour (or the string
		1349	C<default> to indicate that the default-colour escape sequence is to be
		1350	used), C<bg> is the colour code used as default background colour (or the
		1351	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1352	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
		1353	(and do) use this information to optimize screen output.
		1354
		1355	=item B<WINDOWID>
		1356
		1357	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
		1358	window, which usually has subwindows for the scrollbar, the terminal
		1359	window and so on).
		1360
		1361	=item B<TERMINFO>
		1362
		1363	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1364	C<--with-terminfo=PATH>.
		1365
		1366	=item B<DISPLAY>
		1367
		1368	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
		1369	display in it's child processes.
		1370
		1371	=item B<SHELL>
		1372
		1373	The shell to be used for command execution, defaults to C</bin/sh>.
		1374
		1375	=item B<RXVTPATH>
		1376
		1377	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
		1378	files.
		1379
		1380	=item B<PATH>
		1381
		1382	Used in the same way as C<RXVTPATH>.
		1383
		1384	=item B<RXVT_SOCKET>
		1385
		1386	The unix domain socket path used by @@RXVT_NAME@@c(1) and
		1387	@@RXVT_NAME@@d(1).
		1388
		1389	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
		1390
		1391	=item B<HOME>
		1392
		1393	Used to locate the default directory for the unix domain socket for
		1394	daemon communications and to locate various resource files (such as
		1395	C<.Xdefaults>)
		1396
		1397	=item B<XAPPLRESDIR>
		1398
		1399	Directory where various X resource files are being located.
		1400
		1401	=item B<XENVIRONMENT>
		1402
		1403	If set and accessible, gives the name of a X resource file to be loaded by
		1404	@@RXVT_NAME@@.
		1405
		1406	=back
1109		1407
1110	=head1 FILES	1408	=head1 FILES
1111		1409
1112	=over 4	1410	=over 4
1113		1411
…		…
1117		1415
1118	=back	1416	=back
1119		1417
1120	=head1 SEE ALSO	1418	=head1 SEE ALSO
1121		1419
1122	@@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)
1123
1124	=head1 BUGS
1125
1126	Check the BUGS file for an up-to-date list.
1127
1128	Cursor change support is not yet implemented.
1129
1130	Click-and-drag doesn't work with X11 mouse report overriding.
1131		1421
1132	=head1 CURRENT PROJECT COORDINATOR	1422	=head1 CURRENT PROJECT COORDINATOR
1133		1423
1134	=over 4	1424	=over 4
1135		1425
1136	=item Project Coordinator	1426	=item Project Coordinator
1137		1427
1138	@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@>	1428	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1139		1429
1140	=item Web page maintainter	1430	L<http://software.schmorp.de/#rxvt-unicode>
1141
1142	@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1143
1144	L<@@RXVT_WEBPAGE@@>
1145		1431
1146	=back	1432	=back
1147		1433
1148	=head1 AUTHORS	1434	=head1 AUTHORS
1149		1435
…		…
1174	=item Geoff Wing L<< <gcw@pobox.com> >>	1460	=item Geoff Wing L<< <gcw@pobox.com> >>
1175		1461
1176	Rewrote screen display and text selection routines. Project Coordinator	1462	Rewrote screen display and text selection routines. Project Coordinator
1177	(changes.txt 2.4.6 - rxvt-unicode)	1463	(changes.txt 2.4.6 - rxvt-unicode)
1178		1464
1179	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>	1465	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1180		1466
1181	Forked rxvt-unicode, rewrote most of the display code and internal	1467	Forked rxvt-unicode, rewrote most of the display code and internal
1182	character handling to store text in unicode, improve xterm	1468	character handling to store text in unicode, improve xterm
1183	compatibility and apply numerous other bugfixes and extensions.	1469	compatibility and apply numerous other bugfixes and extensions.
1184		1470

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.48 by root, Thu Feb 3 10:24:10 2005 UTC vs. Revision 1.97 by root, Mon Jan 16 15:07:27 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.48 by root, Thu Feb 3 10:24:10 2005 UTC vs.
Revision 1.97 by root, Mon Jan 16 15:07:27 2006 UTC