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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.56 by root, Mon Feb 14 18:47:54 2005 UTC vs.
Revision 1.100 by root, Thu Jan 19 18:02:28 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>.
…		…
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>.
372		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>.
		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
377	=item B<-embed>: I<windowid>	418	=item B<-embed> I<windowid>
378		419
379	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,	420	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
380	which enables applications to easily embed a terminal.	421	which enables applications to easily embed a terminal.
381		422
382	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it	423	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
383	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it	424	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
384	quite a bit, so don't expect it to keep some specific state. It's best to	425	quite a bit, so don't expect it to keep some specific state. It's best to
385	create an extra subwindow for @@RXVT_NAME@@ and leave it alone.	426	create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
		427
		428	The window will not be destroyed when @@RXVT_NAME@@ exits.
386		429
387	It might be useful to know that @@RXVT_NAME@@ will not close file	430	It might be useful to know that @@RXVT_NAME@@ will not close file
388	descriptors passed to it (except for stdin/out/err, of course), so you	431	descriptors passed to it (except for stdin/out/err, of course), so you
389	can use file descriptors to communicate with the programs within the	432	can use file descriptors to communicate with the programs within the
390	terminal. This works regardless of wether the C<-embed> option was used or	433	terminal. This works regardless of wether the C<-embed> option was used or
391	not.	434	not.
392		435
		436	Here is a short Gtk2-perl snippet that illustrates how this option can be
		437	used (a longer example is in F<doc/embed>):
		438
		439	my $rxvt = new Gtk2::Socket;
		440	$rxvt->signal_connect_after (realize => sub {
		441	my $xid = $_[0]->window->get_xid;
		442	system "@@RXVT_NAME@@ -embed $xid &";
		443	});
		444
		445	=item B<-pty-fd> I<file descriptor>
		446
		447	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
		448	pair but instead use the given filehandle as the tty master. This is
		449	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
		450	without having to run a program within it.
		451
		452	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
		453	entries and will not tinker with pty/tty permissions - you have to do that
		454	yourself if you want that.
		455
		456	As an extremely special case, specifying C<-1> will completely suppress
		457	pty/tty operations.
		458
		459	Here is a example in perl that illustrates how this option can be used (a
		460	longer example is in F<doc/pty-fd>):
		461
		462	use IO::Pty;
		463	use Fcntl;
		464
		465	my $pty = new IO::Pty;
		466	fcntl $pty, F_SETFD, 0; # clear close-on-exec
		467	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		468	close $pty;
		469
		470	# now communicate with rxvt
		471	my $slave = $pty->slave;
		472	while (<$slave>) { print $slave "got <$_>\n" }
		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
393	=back	479	=back
394		480
395	=head1 RESOURCES (available also as long-options)	481	=head1 RESOURCES (available also as long-options)
396		482
397	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	483	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
398	options) compiled into your version.	484	options) compiled into your version.
399		485
400	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
401	Xresource data: using the X libraries (Xrm*-functions) or internal	487	distribution do also load settings from the B<~/.Xresources> file when X
402	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	488	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
403	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	489	with later settings overwriting earlier ones:
404	resources using X11 tools like B<xrdb>. Many distribution do also load
405	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
406	will consult the following files/resources in order, with later settings
407	overwriting earlier ones:
408		490
409	1. system-wide app-defaults file, either locale-dependent OR global	491	1. system-wide app-defaults file, either locale-dependent OR global
410	2. app-defaults file in $XAPPLRESDIR	492	2. app-defaults file in $XAPPLRESDIR
411	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	493	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
412	4. SCREEN_RESOURCES for the current screen	494	4. SCREEN_RESOURCES for the current screen
413	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	495	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
414		496
415	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
416	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
417	set in XAPPLOADDIR/URxvt (compile-time defined: usually
418	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
419	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
420	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	497	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
421	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
422	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
423	easily configured, while the class name B<URxvt> allows resources	500	configured, while the class name B<URxvt> allows resources unique to
424	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	501	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
425	shared between different B<@@RXVT_NAME@@> configurations. If no	502	configurations. If no resources are specified, suitable defaults will
426	resources are specified, suitable defaults will be used. Command-line	503	be used. Command-line arguments can be used to override resource
427	arguments can be used to override resource settings. The following	504	settings. The following resources are supported (you might want to
428	resources are allowed:	505	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		506	extensions not documented here):
429		507
430	=over 4	508	=over 4
431		509
432	=item B<geometry:> I<geom>	510	=item B<geometry:> I<geom>
433		511
…		…
511	artificial transparency. B<False>: do not inherit the parent windows'	589	artificial transparency. B<False>: do not inherit the parent windows'
512	pixmap.	590	pixmap.
513		591
514	=item B<fading:> I<number>	592	=item B<fading:> I<number>
515		593
516	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>.
517		600
518	=item B<tintColor:> I<colour>	601	=item B<tintColor:> I<colour>
519		602
520	Tint the transparent background pixmap with the given colour.	603	Tint the transparent background pixmap with the given colour; option
		604	B<-tint>.
521		605
522	=item B<shading:> I<number>	606	=item B<shading:> I<number>
523		607
524	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	608	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
525	image in addition to tinting it.	609	image in addition to tinting it.
…		…
529	Use the specified colour for the scrollbar [default #B2B2B2].	613	Use the specified colour for the scrollbar [default #B2B2B2].
530		614
531	=item B<troughColor:> I<colour>	615	=item B<troughColor:> I<colour>
532		616
533	Use the specified colour for the scrollbar's trough area [default	617	Use the specified colour for the scrollbar's trough area [default
534	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	618	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
535		619
536	=item B<borderColor:> I<colour>	620	=item B<borderColor:> I<colour>
537		621
538	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
539	and the text.	623	and the text.
…		…
548	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
549	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
550	be magnified beyond 10 times its original size. The maximum permitted	634	be magnified beyond 10 times its original size. The maximum permitted
551	scale is 1000. [default 0x0+50+50]	635	scale is 1000. [default 0x0+50+50]
552		636
553	=item B<menu:> I<file[;tag]>
554
555	Read in the specified menu file (note the `.menu' extension is
556	optional) and also optionally specify a starting tag to find. See the
557	reference documentation for details on the syntax for the menuBar.
558
559	=item B<path:> I<path>	637	=item B<path:> I<path>
560		638
561	Specify the colon-delimited search path for finding files (XPM and	639	Specify the colon-delimited search path for finding XPM files.
562	menus), in addition to the paths specified by the B<RXVTPATH> and
563	B<PATH> environment variables.
564		640
565	=item B<font:> I<fontlist>	641	=item B<font:> I<fontlist>
566		642
567	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
568	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
569	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
570	be smaller, but not larger. A reasonable default font list is always	646	smaller, but not (in general) larger. A (hopefully) reasonable default
571	appended to it. option B<-fn>.	647	font list is always appended to it; option B<-fn>.
572		648
573	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
574	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:>.
575		651
576	In addition, each font can be prefixed with additional hints and	652	In addition, each font can be prefixed with additional hints and
…		…
578	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
579	fonts.	655	fonts.
580		656
581	For example, this font resource	657	For example, this font resource
582		658
583	URxvt*font: 9x15bold,\	659	URxvt.font: 9x15bold,\
584	-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,\
585	-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, \
586	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	662	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
587	xft:Code2000:antialias=false	663	xft:Code2000:antialias=false
588		664
…		…
622	not possible, replacement fonts of the desired shape will be tried.	698	not possible, replacement fonts of the desired shape will be tried.
623		699
624	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
625	text font will being used for the given style.	701	text font will being used for the given style.
626		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
627	=item B<selectstyle:> I<mode>	711	=item B<selectstyle:> I<mode>
628		712
629	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
630	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
631	xterm style selection.	715	xterm style selection.
632		716
633	=item B<scrollstyle:> I<mode>	717	=item B<scrollstyle:> I<mode>
634		718
635	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
636	the author's favourite..	720	the author's favourite.
637		721
638	=item B<title:> I<string>	722	=item B<title:> I<string>
639		723
640	Set window title string, the default title is the command-line	724	Set window title string, the default title is the command-line
641	specified after the B<-e> option, if any, otherwise the application	725	specified after the B<-e> option, if any, otherwise the application
…		…
673		757
674	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
675	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
676	B<Shift-Print> to include the scrollback as well.	760	B<Shift-Print> to include the scrollback as well.
677		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>.
		770
678	=item B<scrollBar:> I<boolean>	771	=item B<scrollBar:> I<boolean>
679		772
680	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	773	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
681	disable the scrollbar; option B<+sb>.	774	disable the scrollbar; option B<+sb>.
682		775
…		…
702	B<+si>.	795	B<+si>.
703		796
704	=item B<scrollWithBuffer:> I<boolean>	797	=item B<scrollWithBuffer:> I<boolean>
705		798
706	B<True>: scroll with scrollback buffer when tty receives new lines (and	799	B<True>: scroll with scrollback buffer when tty receives new lines (and
707	B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll	800	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
708	with scrollback buffer when tty recieves new lines; option B<-sw>.	801	with scrollback buffer when tty recieves new lines; option B<+sw>.
709		802
710	=item B<scrollTtyKeypress:> I<boolean>	803	=item B<scrollTtyKeypress:> I<boolean>
711		804
712	B<True>: scroll to bottom when a non-special key is pressed. Special keys	805	B<True>: scroll to bottom when a non-special key is pressed. Special keys
713	are those which are intercepted by rxvt-unicode for special handling and	806	are those which are intercepted by rxvt-unicode for special handling and
…		…
732	=item B<borderLess:> I<boolean>	825	=item B<borderLess:> I<boolean>
733		826
734	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
735	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>.
736		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
737	=item B<termName:> I<termname>	837	=item B<termName:> I<termname>
738		838
739	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
740	variable; option B<-tn>.	840	variable; option B<-tn>.
741		841
…		…
778		878
779	Mouse pointer background colour.	879	Mouse pointer background colour.
780		880
781	=item B<pointerBlankDelay:> I<number>	881	=item B<pointerBlankDelay:> I<number>
782		882
783	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.
784		885
785	=item B<backspacekey:> I<string>	886	=item B<backspacekey:> I<string>
786		887
787	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>
788	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>
…		…
813	=item B<imLocale:> I<name>	914	=item B<imLocale:> I<name>
814		915
815	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.	916	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
816	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the	917	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
817	input extension to be able to input japanese characters while staying in	918	input extension to be able to input japanese characters while staying in
818	another locale. option B<-imlocale>.	919	another locale; option B<-imlocale>.
819		920
820	=item B<imFont:> I<fontset>	921	=item B<imFont:> I<fontset>
821		922
822	Specify the font-set used for XIM styles C<OverTheSpot> or	923	Specify the font-set used for XIM styles C<OverTheSpot> or
823	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated	924	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
…		…
828		929
829	=item B<tripleclickwords:> I<boolean>	930	=item B<tripleclickwords:> I<boolean>
830		931
831	Change the meaning of triple-click selection with the left mouse	932	Change the meaning of triple-click selection with the left mouse
832	button. Instead of selecting a full line it will extend the selection to	933	button. Instead of selecting a full line it will extend the selection to
833	the end of the logical line only. option B<-tcw>.	934	the end of the logical line only; option B<-tcw>.
834		935
835	=item B<insecure:> I<boolean>	936	=item B<insecure:> I<boolean>
836		937
837	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	938	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
838	echo arbitrary strings like the icon name or the locale. This could be	939	echo arbitrary strings like the icon name or the locale. This could be
839	abused if somebody gets 8-bit-clean access to your display, whether	940	abused if somebody gets 8-bit-clean access to your display, whether
840	throuh a mail client displaying mail bodies unfiltered or though	941	through a mail client displaying mail bodies unfiltered or through
841	write(1). Therefore, these sequences are disabled by default. (Note	942	write(1) or any other means. Therefore, these sequences are disabled by
842	that other terminals, including xterm, have these sequences	943	default. (Note that many other terminals, including xterm, have these
843	enabled by default). You can enable them by setting this boolean	944	sequences enabled by default, which doesn't make it safer, though).
844	resource or specifying B<-insecure> as an option. At the moment, this	945
845	enabled display-answer, locale, findfont, icon label and window title	946	You can enable them by setting this boolean resource or specifying
846	requests as well as dynamic menubar dispatch.	947	B<-insecure> as an option. At the moment, this enables display-answer,
		948	locale, findfont, icon label and window title requests.
847		949
848	=item B<modifier:> I<modifier>	950	=item B<modifier:> I<modifier>
849		951
850	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	952	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
851	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	953	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
855		957
856	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	958	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
857	character is passed through. It may contain escape values as described	959	character is passed through. It may contain escape values as described
858	in the entry on B<keysym> following.	960	in the entry on B<keysym> following.
859		961
860	=item B<secondaryScreen:> I<bool>	962	=item B<secondaryScreen:> I<boolean>
861		963
862	Turn on/off secondary screen (default enabled).	964	Turn on/off secondary screen (default enabled).
863		965
864	=item B<secondaryScroll:> I<bool>	966	=item B<secondaryScroll:> I<boolean>
865		967
866	Turn on/off secondary screen scroll (default enabled). If the this	968	Turn on/off secondary screen scroll (default enabled). If the this
867	option is enabled, scrolls on the secondary screen will change the	969	option is enabled, scrolls on the secondary screen will change the
868	scrollback buffer and switching to/from the secondary screen will	970	scrollback buffer and switching to/from the secondary screen will
869	instead scroll the screen up.	971	instead scroll the screen up.
		972
		973	=item B<hold>: I<boolean>
		974
		975	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		976	will not immediately destroy its window when the program executed within
		977	it exits. Instead, it will wait till it is being killed or closed by the
		978	user.
870		979
871	=item B<keysym.>I<sym>: I<string>	980	=item B<keysym.>I<sym>: I<string>
872		981
873	Compile I<frills>: Associate I<string> with keysym I<sym>. The	982	Compile I<frills>: Associate I<string> with keysym I<sym>. The
874	intervening resource name B<keysym.> cannot be omitted.	983	intervening resource name B<keysym.> cannot be omitted.
…		…
894	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1003	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
895	C<\000>: octal number) or verbatim control characters (C<^?>: delete,	1004	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
896	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it	1005	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
897	can start or end with whitespace.	1006	can start or end with whitespace.
898		1007
899	Please note that you need to double the C<\> when using	1008	Please note that you need to double the C<\> in resource files, as
900	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can	1009	Xlib itself does it's own de-escaping (you can use C<\033> instead of
901	use C<\033> instead of C<\e> (and so on), which will work with both Xt and	1010	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
902	@@RXVT_NAME@@'s own processing).	1011	processing).
903		1012
904	You can define a range of keysyms in one shot by providing a I<string>	1013	You can define a range of keysyms in one shot by providing a I<string>
905	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1014	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
906	should be a character not used by the strings.	1015	should be a character not used by the strings.
907		1016
…		…
920	example the following means "change the current locale to C<zh_CN.GBK>	1029	example the following means "change the current locale to C<zh_CN.GBK>
921	when Control-Meta-c is being pressed":	1030	when Control-Meta-c is being pressed":
922		1031
923	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1032	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
924		1033
		1034	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1035	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1036	manpage. For example, the F<selection> extension (activated via
		1037	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1038
		1039	URxvt.keysym.M-C-c: perl:selection:rot13
		1040
		1041	Due the the large number of modifier combinations, a defined key mapping
		1042	will match if at I<at least> the specified identifiers are being set, and
		1043	no other key mappings with those and more bits are being defined. That
		1044	means that defining a key map for C<a> will automatically provide
		1045	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		1046	mappings themselves.
		1047
		1048	Unfortunately, this will override built-in key mappings. For example
		1049	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		1050	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		1051	user-defined keymap using the C<builtin:> replacement:
		1052
		1053	URxvt.keysym.Insert: <my insert key sequence>
		1054	URxvt.keysym.S-Insert: builtin:
		1055
		1056	The first line defines a mapping for C<Insert> and I<any> combination
		1057	of modifiers. The second line re-establishes the default mapping for
		1058	C<Shift-Insert>.
		1059
925	The following example will map Control-Meta-1 and Control-Meta-2 to	1060	The following example will map Control-Meta-1 and Control-Meta-2 to
926	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited	1061	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
927	font-switching at runtime:	1062	font-switching at runtime:
928		1063
929	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1064	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
…		…
932	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1067	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
933	info):	1068	info):
934		1069
935	URxvt.keysym.M-C-3: command:\033[8;25;80t	1070	URxvt.keysym.M-C-3: command:\033[8;25;80t
936	URxvt.keysym.M-C-4: command:\033[8;48;110t	1071	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1072
		1073	=item B<perl-ext-common>: I<string>
		1074
		1075	=item B<perl-ext>: I<string>
		1076
		1077	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1078	use in this terminal instance; option B<-pe>.
		1079
		1080	Extension names can be prefixed with a C<-> sign to prohibit using
		1081	them. This can be useful to selectively disable some extensions loaded
		1082	by default, or specified via the C<perl-ext-common> resource. For
		1083	example, C<default,-selection> will use all the default extension except
		1084	C<selection>.
		1085
		1086	Extension names can also be followed by an argument in angle brackets
		1087	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1088	searchable scorllback to Alt/Meta-s). Mentioning the same extension
		1089	multiple times with different arguments will pass multiple arguments to
		1090	the extension.
		1091
		1092	Each extension is looked up in the library directories, loaded if
		1093	necessary, and bound to the current terminal instance.
		1094
		1095	If both of these resources are the empty string, then the perl
		1096	interpreter will not be initialized. The idea behind two options is that
		1097	B<perl-ext-common> will be used for extensions that should be available to
		1098	all instances, while B<perl-ext> is used for specific instances.
		1099
		1100	=item B<perl-eval>: I<string>
		1101
		1102	Perl code to be evaluated when all extensions have been registered. See
		1103	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
		1104	will be ignored when running setuid/setgid.
		1105
		1106	=item B<perl-lib>: I<path>
		1107
		1108	Colon-separated list of additional directories that hold extension
		1109	scripts. When looking for extensions specified by the C<perl> resource,
		1110	@@RXVT_NAME@@ will first look in these directories and then in
		1111	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
		1112	will be ignored when running setuid/setgid.
		1113
		1114	See the @@RXVT_NAME@@perl(3) manpage.
		1115
		1116	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1117
		1118	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1119	details.
		1120
		1121	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1122
		1123	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1124	for details.
		1125
		1126	=item B<searchable-scrollback:> I<keysym>
		1127
		1128	Sets the hotkey that starts the incremental scrollback buffer search
		1129	(default: C<M-s>).
		1130
		1131	=item B<urlLauncher>: I<string>
		1132
		1133	Specifies the program to be started with a URL argument. Used by the
		1134	C<selection-popup> and C<mark-urls> perl extensions.
		1135
		1136	=item B<transient-for>: I<windowid>
		1137
		1138	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1139
		1140	=item B<override-redirect>: I<boolean>
		1141
		1142	Compile I<frills>: Sets override-redirect for the terminal window, making
		1143	it almost invisible to window managers; option B<-override-redirect>.
937		1144
938	=back	1145	=back
939		1146
940	=head1 THE SCROLLBAR	1147	=head1 THE SCROLLBAR
941		1148
…		…
976	to select a word; Left triple-click to select the entire logical line	1183	to select a word; Left triple-click to select the entire logical line
977	(which can span multiple screen lines), unless modified by resource	1184	(which can span multiple screen lines), unless modified by resource
978	B<tripleclickwords>.	1185	B<tripleclickwords>.
979		1186
980	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1187	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
981	(Compile: I<frills>) will create a rectangular selection instead of a normal	1188	(Compile: I<frills>) will create a rectangular selection instead of a
982	one.	1189	normal one. In this mode, every selected row becomes its own line in the
		1190	selection, and trailing whitespace is visually underlined and removed from
		1191	the selection.
983		1192
984	=item B<Insertion>:	1193	=item B<Insertion>:
985		1194
986	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1195	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
987	an B<@@RXVT_NAME@@> window causes the current text selection to be	1196	an B<@@RXVT_NAME@@> window causes the current text selection to be
…		…
992	=head1 CHANGING FONTS	1201	=head1 CHANGING FONTS
993		1202
994	Changing fonts (or font sizes, respectively) via the keypad is not yet	1203	Changing fonts (or font sizes, respectively) via the keypad is not yet
995	supported in rxvt-unicode. Bug me if you need this.	1204	supported in rxvt-unicode. Bug me if you need this.
996		1205
997	You can, however, switch fonts at runtime using escape sequences (and	1206	You can, however, switch fonts at runtime using escape sequences, e.g.:
998	therefore using the menubar), e.g.:
999		1207
1000	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1208	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1209
		1210	You can use keyboard shortcuts, too:
		1211
		1212	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1213	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1001		1214
1002	rxvt-unicode will automatically re-apply these fonts to the output so far.	1215	rxvt-unicode will automatically re-apply these fonts to the output so far.
1003		1216
1004	=head1 ISO 14755 SUPPORT	1217	=head1 ISO 14755 SUPPORT
1005		1218
…		…
1167		1380
1168	=item B<SHELL>	1381	=item B<SHELL>
1169		1382
1170	The shell to be used for command execution, defaults to C</bin/sh>.	1383	The shell to be used for command execution, defaults to C</bin/sh>.
1171		1384
1172	=item B<RXVTPATH>
1173
1174	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1175	files.
1176
1177	=item B<PATH>
1178
1179	Used in the same way as C<RXVTPATH>.
1180
1181	=item B<RXVT_SOCKET>	1385	=item B<RXVT_SOCKET>
1182		1386
1183	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1387	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1184	@@RXVT_NAME@@d(1).	1388	@@RXVT_NAME@@d(1).
1185		1389
1186	Default C<< $HOME/.rxvt-unicode-<nodename >>.	1390	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1187		1391
1188	=item B<HOME>	1392	=item B<HOME>
1189		1393
1190	Used to locate the default directory for the unix domain socket for	1394	Used to locate the default directory for the unix domain socket for
1191	daemon communications and to locate various resource files (such as	1395	daemon communications and to locate various resource files (such as
…		…
1212		1416
1213	=back	1417	=back
1214		1418
1215	=head1 SEE ALSO	1419	=head1 SEE ALSO
1216		1420
1217	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1421	@@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)
1218
1219	=head1 BUGS
1220
1221	Check the BUGS file for an up-to-date list.
1222
1223	Cursor change support is not yet implemented.
1224
1225	Click-and-drag doesn't work with X11 mouse report overriding.
1226		1422
1227	=head1 CURRENT PROJECT COORDINATOR	1423	=head1 CURRENT PROJECT COORDINATOR
1228		1424
1229	=over 4	1425	=over 4
1230		1426
…		…
1262		1458
1263	Project Coordinator (changes.txt 2.21a to 2.4.5)	1459	Project Coordinator (changes.txt 2.21a to 2.4.5)
1264		1460
1265	=item Geoff Wing L<< <gcw@pobox.com> >>	1461	=item Geoff Wing L<< <gcw@pobox.com> >>
1266		1462
1267	Rewrote screen display and text selection routines. Project Coordinator	1463	Rewrote screen display and text selection routines.
		1464
1268	(changes.txt 2.4.6 - rxvt-unicode)	1465	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1269		1466
1270	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1467	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1271		1468
1272	Forked rxvt-unicode, rewrote most of the display code and internal	1469	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1273	character handling to store text in unicode, improve xterm	1470	extension, random hacks, numerous bugfixes and extensions.
1274	compatibility and apply numerous other bugfixes and extensions.
1275		1471
1276	Project Coordinator (Changes 1.0 -)	1472	Project Coordinator (Changes 1.0 -)
1277		1473
		1474	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1475
		1476	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugxifing.
		1477
1278	=back	1478	=back
1279		1479

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.56 by root, Mon Feb 14 18:47:54 2005 UTC vs. Revision 1.100 by root, Thu Jan 19 18:02:28 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.56 by root, Mon Feb 14 18:47:54 2005 UTC vs.
Revision 1.100 by root, Thu Jan 19 18:02:28 2006 UTC