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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.66 by root, Thu Jun 30 14:02:17 2005 UTC vs.
Revision 1.109 by root, Sun Jan 29 22:27:04 2006 UTC

…		…
93		93
94	Attempt to open a window on the named X display (B<-d> still	94	Attempt to open a window on the named X display (B<-d> still
95	respected). In the absence of this option, the display specified by the	95	respected). In the absence of this option, the display specified by the
96	B<DISPLAY> environment variable is used.	96	B<DISPLAY> environment variable is used.
97		97
		98	=item B<-depth> I<bitdepth>
		99
		100	Compile I<xft>: Attempt to find a visual with the given bit depth;
		101	resource B<depth>.
		102
98	=item B<-geometry> I<geom>	103	=item B<-geometry> I<geom>
99		104
100	Window geometry (B<-g> still respected); resource B<geometry>.	105	Window geometry (B<-g> still respected); resource B<geometry>.
101		106
102	=item B<-rv>\|B<+rv>	107	=item B<-rv>\|B<+rv>
…		…
105		110
106	=item B<-j>\|B<+j>	111	=item B<-j>\|B<+j>
107		112
108	Turn on/off jump scrolling; resource B<jumpScroll>.	113	Turn on/off jump scrolling; resource B<jumpScroll>.
109		114
110	=item B<-ip>\|B<+ip>	115	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>
111		116
112	Turn on/off inheriting parent window's pixmap. Alternative form is	117	Turn on/off inheriting parent window's pixmap. Alternative form is
113	B<-tr>; resource B<inheritPixmap>.	118	B<-tr>; resource B<inheritPixmap>.
114		119
115	=item B<-fade> I<number>	120	=item B<-fade> I<number>
116		121
117	Fade the text by the given percentage when focus is lost. resource B<fading>.	122	Fade the text by the given percentage when focus is lost. Small values
		123	fade a little only, 100 completely replaces all colours by the fade
		124	colour; resource B<fading>.
		125
		126	=item B<-fadecolor> I<colour>
		127
		128	Fade to this colour when fading is used (see B<-fade>). The default colour
		129	is black. resource B<fadeColor>.
118		130
119	=item B<-tint> I<colour>	131	=item B<-tint> I<colour>
120		132
121	Tint the transparent background pixmap with the given colour when	133	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>	134	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	135	non-tiled backgrounds, currently. See also the B<-sh> option that can be
124	tinting it.	136	used to brighten or darken the image in addition to tinting it; resource
		137	I<tintColor>. Example:
		138
		139	@@RXVT_NAME@@ -tr -tint blue -sh 40
125		140
126	=item B<-sh>	141	=item B<-sh>
127		142
128	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	143	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	144	background image in addition to tinting it (i.e. B<-tint> must be
…		…
162	resource B<borderColor>.	177	resource B<borderColor>.
163		178
164	=item B<-fn> I<fontlist>	179	=item B<-fn> I<fontlist>
165		180
166	Select the fonts to be used. This is a comma separated list of font names	181	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	182	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	183	first font defines the cell size for characters; other fonts might be
169	smaller, but not (in general) larger. A (hopefully) reasonable default	184	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.	185	font list is always appended to it. See resource B<font> for more details.
171		186
172	In short, to specify an X11 core font, just specify it's name or prefix it	187	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	194	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
180	section of @@RXVT_NAME@@(7).	195	section of @@RXVT_NAME@@(7).
181		196
182	=item B<-fb> I<fontlist>	197	=item B<-fb> I<fontlist>
183		198
184	Compile font-styles: The bold font list to use when bold characters are to	199	Compile I<font-styles>: The bold font list to use when B<bold> characters
185	be printed. See resource B<boldFont> for details.	200	are to be printed. See resource B<boldFont> for details.
186		201
187	=item B<-fi> I<fontlist>	202	=item B<-fi> I<fontlist>
188		203
189	Compile font-styles: The italic font list to use when bold characters are to	204	Compile I<font-styles>: The italic font list to use when I<italic>
190	be printed. See resource B<italicFont> for details.	205	characters are to be printed. See resource B<italicFont> for details.
191		206
192	=item B<-fbi> I<fontlist>	207	=item B<-fbi> I<fontlist>
193		208
194	Compile font-styles: The bold italic font list to use when bold characters are to	209	Compile I<font-styles>: The bold italic font list to use when B<< I<bold
195	be printed. See resource B<boldItalicFont> for details.	210	italic> >> characters are to be printed. See resource B<boldItalicFont>
		211	for details.
		212
		213	=item B<-is>\|B<+is>
		214
		215	Compile I<font-styles>: Bold/Italic font styles imply high intensity
		216	foreground/background (default). See resource B<intensityStyles> for
		217	details.
196		218
197	=item B<-name> I<name>	219	=item B<-name> I<name>
198		220
199	Specify the application name under which resources are to be obtained,	221	Specify the application name under which resources are to be obtained,
200	rather than the default executable file name. Name should not contain	222	rather than the default executable file name. Name should not contain
…		…
279	=item B<-bl>	301	=item B<-bl>
280		302
281	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	303	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	304	if honoured by the WM, the rxvt-unicode window will not have window
283	decorations; resource B<borderLess>.	305	decorations; resource B<borderLess>.
		306
		307	=item B<-override-redirect>
		308
		309	Compile I<frills>: Sets override-redirect on the window; resource
		310	B<override-redirect>.
		311
		312	=item B<-sbg>
		313
		314	Compile I<frills>: Disable the usage of the built-in block graphics/line
		315	drawing characters and just rely on what the specified fonts provide. Use
		316	this if you have a good font and want to use its block graphic glyphs;
		317	resource B<skipBuiltinGlyphs>.
284		318
285	=item B<-lsp> I<number>	319	=item B<-lsp> I<number>
286		320
287	Compile I<frills>: Lines (pixel height) to insert between each row of	321	Compile I<frills>: Lines (pixel height) to insert between each row of
288	the display. Useful to work around font rendering problems; resource	322	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	337	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	338	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,	339	run the program specified by the B<SHELL> environment variable or,
306	failing that, I<sh(1)>.	340	failing that, I<sh(1)>.
307		341
		342	Please note that you must specify a program with arguments. If you want to
		343	run shell commands, you have to specify the shell, like this:
		344
		345	@@RXVT_NAME@@ -e sh -c "shell commands"
		346
308	=item B<-title> I<text>	347	=item B<-title> I<text>
309		348
310	Window title (B<-T> still respected); the default title is the basename	349	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	350	of the program specified after the B<-e> option, if any, otherwise the
312	application name; resource B<title>.	351	application name; resource B<title>.
…		…
367		406
368	=item B<-ssr>\|B<+ssr>	407	=item B<-ssr>\|B<+ssr>
369		408
370	Turn on/off secondary screen scroll (default enabled); resource	409	Turn on/off secondary screen scroll (default enabled); resource
371	B<secondaryScroll>.	410	B<secondaryScroll>.
		411
		412	=item B<-hold>\|B<+hold>
		413
		414	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		415	will not immediately destroy its window when the program executed within
		416	it exits. Instead, it will wait till it is being killed or closed by the
		417	user; resource B<hold>.
372		418
373	=item B<-keysym.>I<sym> I<string>	419	=item B<-keysym.>I<sym> I<string>
374		420
375	Remap a key symbol. See resource B<keysym>.	421	Remap a key symbol. See resource B<keysym>.
376		422
…		…
399	$rxvt->signal_connect_after (realize => sub {	445	$rxvt->signal_connect_after (realize => sub {
400	my $xid = $_[0]->window->get_xid;	446	my $xid = $_[0]->window->get_xid;
401	system "@@RXVT_NAME@@ -embed $xid &";	447	system "@@RXVT_NAME@@ -embed $xid &";
402	});	448	});
403		449
404	=item B<-pty-fd> I<fileno>	450	=item B<-pty-fd> I<file descriptor>
405		451
406	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	452	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
407	pair but instead use the given filehandle as the tty master. This is	453	pair but instead use the given filehandle as the tty master. This is
408	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator	454	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
409	without having to run a program within it.	455	without having to run a program within it.
410		456
411	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	457	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
412	entries and will not tinker with pty/tty permissions - you have to do that	458	entries and will not tinker with pty/tty permissions - you have to do that
413	yourself if you want that.	459	yourself if you want that.
414		460
		461	As an extremely special case, specifying C<-1> will completely suppress
		462	pty/tty operations.
		463
415	Here is a example in perl that illustrates how this option can be used (a	464	Here is a example in perl that illustrates how this option can be used (a
416	longer example is in F<doc/pty-fd>):	465	longer example is in F<doc/pty-fd>):
417		466
418	use IO::Pty;	467	use IO::Pty;
419	use Fcntl;	468	use Fcntl;
…		…
425		474
426	# now communicate with rxvt	475	# now communicate with rxvt
427	my $slave = $pty->slave;	476	my $slave = $pty->slave;
428	while (<$slave>) { print $slave "got <$_>\n" }	477	while (<$slave>) { print $slave "got <$_>\n" }
429		478
		479	=item B<-pe> I<string>
		480
		481	Comma-separated list of perl extension scripts to use (or not to use) in
		482	this terminal instance. See resource B<perl-ext> for details.
		483
430	=back	484	=back
431		485
432	=head1 RESOURCES (available also as long-options)	486	=head1 RESOURCES (available also as long-options)
433		487
434	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	488	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
435	options) compiled into your version.	489	options) compiled into your version.
436		490
437	There are two different methods that @@RXVT_NAME@@ can use to get the	491	You can set and change the resources using X11 tools like B<xrdb>. Many
438	Xresource data: using the X libraries (Xrm*-functions) or internal	492	distribution do also load settings from the B<~/.Xresources> file when X
439	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	493	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
440	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	494	with later settings overwriting earlier ones:
441	resources using X11 tools like B<xrdb>. Many distribution do also load
442	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
443	will consult the following files/resources in order, with later settings
444	overwriting earlier ones:
445		495
446	1. system-wide app-defaults file, either locale-dependent OR global	496	1. system-wide app-defaults file, either locale-dependent OR global
447	2. app-defaults file in $XAPPLRESDIR	497	2. app-defaults file in $XAPPLRESDIR
448	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	498	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
449	4. SCREEN_RESOURCES for the current screen	499	4. SCREEN_RESOURCES for the current screen
450	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	500	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
451		501
452	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
453	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
454	set in XAPPLOADDIR/URxvt (compile-time defined: usually
455	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
456	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
457	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	502	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
458	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows	503	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
459	resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be	504	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
460	easily configured, while the class name B<URxvt> allows resources	505	configured, while the class name B<URxvt> allows resources unique to
461	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	506	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
462	shared between different B<@@RXVT_NAME@@> configurations. If no	507	configurations. If no resources are specified, suitable defaults will
463	resources are specified, suitable defaults will be used. Command-line	508	be used. Command-line arguments can be used to override resource
464	arguments can be used to override resource settings. The following	509	settings. The following resources are supported (you might want to
465	resources are allowed:	510	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		511	extensions not documented here):
466		512
467	=over 4	513	=over 4
		514
		515	=item B<depth:> I<bitdepth>
		516
		517	Compile I<xft>: Attempt to find a visual with the given bit depth;
		518	option B<-depth>.
468		519
469	=item B<geometry:> I<geom>	520	=item B<geometry:> I<geom>
470		521
471	Create the window with the specified X window geometry [default 80x24];	522	Create the window with the specified X window geometry [default 80x24];
472	option B<-geometry>.	523	option B<-geometry>.
…		…
548	artificial transparency. B<False>: do not inherit the parent windows'	599	artificial transparency. B<False>: do not inherit the parent windows'
549	pixmap.	600	pixmap.
550		601
551	=item B<fading:> I<number>	602	=item B<fading:> I<number>
552		603
553	Fade the text by the given percentage when focus is lost.	604	Fade the text by the given percentage when focus is lost; option B<-fade>.
		605
		606	=item B<fadeColor:> I<colour>
		607
		608	Fade to this colour, when fading is used (see B<fading:>). The default
		609	colour is black; option B<-fadecolor>.
554		610
555	=item B<tintColor:> I<colour>	611	=item B<tintColor:> I<colour>
556		612
557	Tint the transparent background pixmap with the given colour.	613	Tint the transparent background pixmap with the given colour; option
		614	B<-tint>.
558		615
559	=item B<shading:> I<number>	616	=item B<shading:> I<number>
560		617
561	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	618	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
562	image in addition to tinting it.	619	image in addition to tinting it.
…		…
585	of 1 displays the image without any scaling. A scale of 2 to 9	642	of 1 displays the image without any scaling. A scale of 2 to 9
586	specifies an integer number of images in that direction. No image will	643	specifies an integer number of images in that direction. No image will
587	be magnified beyond 10 times its original size. The maximum permitted	644	be magnified beyond 10 times its original size. The maximum permitted
588	scale is 1000. [default 0x0+50+50]	645	scale is 1000. [default 0x0+50+50]
589		646
590	=item B<menu:> I<file[;tag]>
591
592	Read in the specified menu file (note the `.menu' extension is
593	optional) and also optionally specify a starting tag to find. See the
594	reference documentation for details on the syntax for the menuBar.
595
596	=item B<path:> I<path>	647	=item B<path:> I<path>
597		648
598	Specify the colon-delimited search path for finding files (XPM and	649	Specify the colon-delimited search path for finding XPM files.
599	menus), in addition to the paths specified by the B<RXVTPATH> and
600	B<PATH> environment variables.
601		650
602	=item B<font:> I<fontlist>	651	=item B<font:> I<fontlist>
603		652
604	Select the fonts to be used. This is a comma separated list of font	653	Select the fonts to be used. This is a comma separated list of font names
605	names that are used in turn when trying to display Unicode characters.	654	that are checked in order when trying to find glyphs for characters. The
606	The first font defines the cell size for characters; other fonts might	655	first font defines the cell size for characters; other fonts might be
607	be smaller, but not larger. A reasonable default font list is always	656	smaller, but not (in general) larger. A (hopefully) reasonable default
608	appended to it. option B<-fn>.	657	font list is always appended to it; option B<-fn>.
609		658
610	Each font can either be a standard X11 core font (XLFD) name, with	659	Each font can either be a standard X11 core font (XLFD) name, with
611	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.	660	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
612		661
613	In addition, each font can be prefixed with additional hints and	662	In addition, each font can be prefixed with additional hints and
…		…
615	hint currently is C<codeset=codeset-name>, and this is only used for Xft	664	hint currently is C<codeset=codeset-name>, and this is only used for Xft
616	fonts.	665	fonts.
617		666
618	For example, this font resource	667	For example, this font resource
619		668
620	URxvt*font: 9x15bold,\	669	URxvt.font: 9x15bold,\
621	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	670	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
622	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \	671	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
623	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	672	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
624	xft:Code2000:antialias=false	673	xft:Code2000:antialias=false
625		674
…		…
659	not possible, replacement fonts of the desired shape will be tried.	708	not possible, replacement fonts of the desired shape will be tried.
660		709
661	If set, but empty, then this specific style is disabled and the normal	710	If set, but empty, then this specific style is disabled and the normal
662	text font will being used for the given style.	711	text font will being used for the given style.
663		712
		713	=item B<intensityStyles:> I<boolean>
		714
		715	When font styles are not enabled, or this option is enabled (B<True>,
		716	option B<-is>, the default), bold and italic font styles imply high
		717	intensity foreground/backround colours. Disabling this option (B<False>,
		718	option B<+is>) disables this behaviour, the high intensity colours are not
		719	reachable.
		720
664	=item B<selectstyle:> I<mode>	721	=item B<selectstyle:> I<mode>
665		722
666	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	723	Set mouse selection style to B<old> which is 2.20, B<oldword> which is
667	xterm style with 2.20 old word selection, or anything else which gives	724	xterm style with 2.20 old word selection, or anything else which gives
668	xterm style selection.	725	xterm style selection.
…		…
714		771
715	The string will be interpreted as if typed into the shell as-is.	772	The string will be interpreted as if typed into the shell as-is.
716		773
717	Example:	774	Example:
718		775
719	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	776	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
720		777
721	This creates a new file in your home directory with the screen contents	778	This creates a new file in your home directory with the screen contents
722	everytime you hit C<Print>.	779	everytime you hit C<Print>.
723		780
724	=item B<scrollBar:> I<boolean>	781	=item B<scrollBar:> I<boolean>
…		…
778	=item B<borderLess:> I<boolean>	835	=item B<borderLess:> I<boolean>
779		836
780	Set MWM hints to request a borderless window, i.e. if honoured by the	837	Set MWM hints to request a borderless window, i.e. if honoured by the
781	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.	838	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
782		839
		840	=item B<skipBuiltinGlyphs:> I<boolean>
		841
		842	Compile I<frills>: Disable the usage of the built-in block graphics/line
		843	drawing characters and just rely on what the specified fonts provide. Use
		844	this if you have a good font and want to use its block graphic glyphs;
		845	option B<-sbg>.
		846
783	=item B<termName:> I<termname>	847	=item B<termName:> I<termname>
784		848
785	Specifies the terminal type name to be set in the B<TERM> environment	849	Specifies the terminal type name to be set in the B<TERM> environment
786	variable; option B<-tn>.	850	variable; option B<-tn>.
787		851
…		…
842	pressed. If unset it will send the sequence traditionally associated	906	pressed. If unset it will send the sequence traditionally associated
843	with the B<Execute> key.	907	with the B<Execute> key.
844		908
845	=item B<cutchars:> I<string>	909	=item B<cutchars:> I<string>
846		910
847	The characters used as delimiters for double-click word selection. The	911	The characters used as delimiters for double-click word selection
848	built-in default:	912	(whitespace delimiting is added automatically if resource is given).
		913
		914	When the selection extension is in use (the default if compiled in, see
		915	the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters
		916	will be created (if the resource exists, otherwise, no regex will be
		917	created). In this mode, characters outside ISO-8859-1 can be used.
		918
		919	When the selection extension is not used, only ISO-8859-1 characters can
		920	be used. If not specified, the built-in default is used:
849		921
850	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	922	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>
851		923
852	=item B<preeditType:> I<style>	924	=item B<preeditType:> I<style>
853		925
…		…
860	=item B<imLocale:> I<name>	932	=item B<imLocale:> I<name>
861		933
862	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.	934	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
863	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the	935	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
864	input extension to be able to input japanese characters while staying in	936	input extension to be able to input japanese characters while staying in
865	another locale. option B<-imlocale>.	937	another locale; option B<-imlocale>.
866		938
867	=item B<imFont:> I<fontset>	939	=item B<imFont:> I<fontset>
868		940
869	Specify the font-set used for XIM styles C<OverTheSpot> or	941	Specify the font-set used for XIM styles C<OverTheSpot> or
870	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated	942	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
…		…
875		947
876	=item B<tripleclickwords:> I<boolean>	948	=item B<tripleclickwords:> I<boolean>
877		949
878	Change the meaning of triple-click selection with the left mouse	950	Change the meaning of triple-click selection with the left mouse
879	button. Instead of selecting a full line it will extend the selection to	951	button. Instead of selecting a full line it will extend the selection to
880	the end of the logical line only. option B<-tcw>.	952	the end of the logical line only; option B<-tcw>.
881		953
882	=item B<insecure:> I<boolean>	954	=item B<insecure:> I<boolean>
883		955
884	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	956	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
885	echo arbitrary strings like the icon name or the locale. This could be	957	echo arbitrary strings like the icon name or the locale. This could be
886	abused if somebody gets 8-bit-clean access to your display, whether	958	abused if somebody gets 8-bit-clean access to your display, whether
887	throuh a mail client displaying mail bodies unfiltered or though	959	through a mail client displaying mail bodies unfiltered or through
888	write(1). Therefore, these sequences are disabled by default. (Note	960	write(1) or any other means. Therefore, these sequences are disabled by
889	that other terminals, including xterm, have these sequences	961	default. (Note that many other terminals, including xterm, have these
890	enabled by default). You can enable them by setting this boolean	962	sequences enabled by default, which doesn't make it safer, though).
891	resource or specifying B<-insecure> as an option. At the moment, this	963
892	enabled display-answer, locale, findfont, icon label and window title	964	You can enable them by setting this boolean resource or specifying
893	requests as well as dynamic menubar dispatch.	965	B<-insecure> as an option. At the moment, this enables display-answer,
		966	locale, findfont, icon label and window title requests.
894		967
895	=item B<modifier:> I<modifier>	968	=item B<modifier:> I<modifier>
896		969
897	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	970	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
898	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	971	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
902		975
903	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	976	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
904	character is passed through. It may contain escape values as described	977	character is passed through. It may contain escape values as described
905	in the entry on B<keysym> following.	978	in the entry on B<keysym> following.
906		979
907	=item B<secondaryScreen:> I<bool>	980	=item B<secondaryScreen:> I<boolean>
908		981
909	Turn on/off secondary screen (default enabled).	982	Turn on/off secondary screen (default enabled).
910		983
911	=item B<secondaryScroll:> I<bool>	984	=item B<secondaryScroll:> I<boolean>
912		985
913	Turn on/off secondary screen scroll (default enabled). If the this	986	Turn on/off secondary screen scroll (default enabled). If the this
914	option is enabled, scrolls on the secondary screen will change the	987	option is enabled, scrolls on the secondary screen will change the
915	scrollback buffer and switching to/from the secondary screen will	988	scrollback buffer and switching to/from the secondary screen will
916	instead scroll the screen up.	989	instead scroll the screen up.
		990
		991	=item B<hold>: I<boolean>
		992
		993	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		994	will not immediately destroy its window when the program executed within
		995	it exits. Instead, it will wait till it is being killed or closed by the
		996	user.
917		997
918	=item B<keysym.>I<sym>: I<string>	998	=item B<keysym.>I<sym>: I<string>
919		999
920	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1000	Compile I<frills>: Associate I<string> with keysym I<sym>. The
921	intervening resource name B<keysym.> cannot be omitted.	1001	intervening resource name B<keysym.> cannot be omitted.
…		…
941	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1021	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
942	C<\000>: octal number) or verbatim control characters (C<^?>: delete,	1022	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
943	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it	1023	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
944	can start or end with whitespace.	1024	can start or end with whitespace.
945		1025
946	Please note that you need to double the C<\> when using	1026	Please note that you need to double the C<\> in resource files, as
947	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can	1027	Xlib itself does it's own de-escaping (you can use C<\033> instead of
948	use C<\033> instead of C<\e> (and so on), which will work with both Xt and	1028	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
949	@@RXVT_NAME@@'s own processing).	1029	processing).
950		1030
951	You can define a range of keysyms in one shot by providing a I<string>	1031	You can define a range of keysyms in one shot by providing a I<string>
952	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1032	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
953	should be a character not used by the strings.	1033	should be a character not used by the strings.
954		1034
…		…
966	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1046	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
967	example the following means "change the current locale to C<zh_CN.GBK>	1047	example the following means "change the current locale to C<zh_CN.GBK>
968	when Control-Meta-c is being pressed":	1048	when Control-Meta-c is being pressed":
969		1049
970	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1050	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		1051
		1052	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1053	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1054	manpage. For example, the F<selection> extension (activated via
		1055	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1056
		1057	URxvt.keysym.M-C-c: perl:selection:rot13
971		1058
972	Due the the large number of modifier combinations, a defined key mapping	1059	Due the the large number of modifier combinations, a defined key mapping
973	will match if at I<at least> the specified identifiers are being set, and	1060	will match if at I<at least> the specified identifiers are being set, and
974	no other key mappings with those and more bits are being defined. That	1061	no other key mappings with those and more bits are being defined. That
975	means that defining a key map for C<a> will automatically provide	1062	means that defining a key map for C<a> will automatically provide
…		…
999	info):	1086	info):
1000		1087
1001	URxvt.keysym.M-C-3: command:\033[8;25;80t	1088	URxvt.keysym.M-C-3: command:\033[8;25;80t
1002	URxvt.keysym.M-C-4: command:\033[8;48;110t	1089	URxvt.keysym.M-C-4: command:\033[8;48;110t
1003		1090
		1091	=item B<perl-ext-common>: I<string>
		1092
		1093	=item B<perl-ext>: I<string>
		1094
		1095	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1096	use in this terminal instance; option B<-pe>.
		1097
		1098	Extension names can be prefixed with a C<-> sign to prohibit using
		1099	them. This can be useful to selectively disable some extensions loaded
		1100	by default, or specified via the C<perl-ext-common> resource. For
		1101	example, C<default,-selection> will use all the default extension except
		1102	C<selection>.
		1103
		1104	Extension names can also be followed by an argument in angle brackets
		1105	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1106	searchable scorllback to Alt/Meta-s). Mentioning the same extension
		1107	multiple times with different arguments will pass multiple arguments to
		1108	the extension.
		1109
		1110	Each extension is looked up in the library directories, loaded if
		1111	necessary, and bound to the current terminal instance.
		1112
		1113	If both of these resources are the empty string, then the perl
		1114	interpreter will not be initialized. The idea behind two options is that
		1115	B<perl-ext-common> will be used for extensions that should be available to
		1116	all instances, while B<perl-ext> is used for specific instances.
		1117
		1118	=item B<perl-eval>: I<string>
		1119
		1120	Perl code to be evaluated when all extensions have been registered. See
		1121	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
		1122	will be ignored when running setuid/setgid.
		1123
		1124	=item B<perl-lib>: I<path>
		1125
		1126	Colon-separated list of additional directories that hold extension
		1127	scripts. When looking for extensions specified by the C<perl> resource,
		1128	@@RXVT_NAME@@ will first look in these directories and then in
		1129	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
		1130	will be ignored when running setuid/setgid.
		1131
		1132	See the @@RXVT_NAME@@perl(3) manpage.
		1133
		1134	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1135
		1136	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1137	details.
		1138
		1139	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1140
		1141	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1142	for details.
		1143
		1144	=item B<searchable-scrollback:> I<keysym>
		1145
		1146	Sets the hotkey that starts the incremental scrollback buffer search
		1147	(default: C<M-s>).
		1148
		1149	=item B<urlLauncher>: I<string>
		1150
		1151	Specifies the program to be started with a URL argument. Used by the
		1152	C<selection-popup> and C<mark-urls> perl extensions.
		1153
		1154	=item B<transient-for>: I<windowid>
		1155
		1156	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1157
		1158	=item B<override-redirect>: I<boolean>
		1159
		1160	Compile I<frills>: Sets override-redirect for the terminal window, making
		1161	it almost invisible to window managers; option B<-override-redirect>.
		1162
1004	=back	1163	=back
1005		1164
1006	=head1 THE SCROLLBAR	1165	=head1 THE SCROLLBAR
1007		1166
1008	Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window	1167	Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
…		…
1042	to select a word; Left triple-click to select the entire logical line	1201	to select a word; Left triple-click to select the entire logical line
1043	(which can span multiple screen lines), unless modified by resource	1202	(which can span multiple screen lines), unless modified by resource
1044	B<tripleclickwords>.	1203	B<tripleclickwords>.
1045		1204
1046	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1205	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
1047	(Compile: I<frills>) will create a rectangular selection instead of a normal	1206	(Compile: I<frills>) will create a rectangular selection instead of a
1048	one.	1207	normal one. In this mode, every selected row becomes its own line in the
		1208	selection, and trailing whitespace is visually underlined and removed from
		1209	the selection.
1049		1210
1050	=item B<Insertion>:	1211	=item B<Insertion>:
1051		1212
1052	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1213	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1053	an B<@@RXVT_NAME@@> window causes the current text selection to be	1214	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1054	inserted as if it had been typed on the keyboard.	1215	Meta modifier) to be inserted as if it had been typed on the keyboard.
		1216
		1217	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1218	inserted too.
1055		1219
1056	=back	1220	=back
1057		1221
1058	=head1 CHANGING FONTS	1222	=head1 CHANGING FONTS
1059		1223
1060	Changing fonts (or font sizes, respectively) via the keypad is not yet	1224	Changing fonts (or font sizes, respectively) via the keypad is not yet
1061	supported in rxvt-unicode. Bug me if you need this.	1225	supported in rxvt-unicode. Bug me if you need this.
1062		1226
1063	You can, however, switch fonts at runtime using escape sequences (and	1227	You can, however, switch fonts at runtime using escape sequences, e.g.:
1064	therefore using the menubar), e.g.:
1065		1228
1066	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1229	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1230
		1231	You can use keyboard shortcuts, too:
		1232
		1233	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1234	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1067		1235
1068	rxvt-unicode will automatically re-apply these fonts to the output so far.	1236	rxvt-unicode will automatically re-apply these fonts to the output so far.
1069		1237
1070	=head1 ISO 14755 SUPPORT	1238	=head1 ISO 14755 SUPPORT
1071		1239
…		…
1142	=head1 COLORS AND GRAPHICS	1310	=head1 COLORS AND GRAPHICS
1143		1311
1144	In addition to the default foreground and background colours,	1312	In addition to the default foreground and background colours,
1145	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1313	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1146	high-intensity bold/blink versions of the same). Here is a list of the	1314	high-intensity bold/blink versions of the same). Here is a list of the
1147	colours with their B<rgb.txt> names.	1315	colours with their names.
1148		1316
1149	=begin table	1317	=begin table
1150		1318
1151	B<color0> (black) = Black	1319	B<color0> (black) = Black
1152	B<color1> (red) = Red3	1320	B<color1> (red) = Red3
…		…
1172	It is also possible to specify the colour values of B<foreground>,	1340	It is also possible to specify the colour values of B<foreground>,
1173	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1341	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1174	a number 0-15, as a convenient shorthand to reference the colour name of	1342	a number 0-15, as a convenient shorthand to reference the colour name of
1175	color0-color15.	1343	color0-color15.
1176		1344
		1345	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1346	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
		1347	(recommended, but B<MUST> have 4 digits/component), C<#ARGB>, C<#AARRGGBB>
		1348	and C<#AAAARRRRGGGGBBBB> colour specifications, in addition to the ones
		1349	provided by X, where the additional A component specifies alpha (opacity)
		1350	values (0 is completely transparent and the maximum is opaque). You
		1351	probably need to specify B<"-depth 32">, too, and have the luck that your
		1352	X-server uses ARGB pixel layout, as X is far from just supporting ARGB
		1353	visuals out of the box, and rxvt-unicode just fudges around.
		1354
1177	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1355	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1178	always swapping the foreground/background colours. This is in contrast to	1356	always swapping the foreground/background colours. This is in contrast to
1179	I<xterm>(1) where the colours are only swapped if they have not otherwise	1357	I<xterm>(1) where the colours are only swapped if they have not otherwise
1180	been specified. For example,	1358	been specified. For example,
1181		1359
…		…
1233		1411
1234	=item B<SHELL>	1412	=item B<SHELL>
1235		1413
1236	The shell to be used for command execution, defaults to C</bin/sh>.	1414	The shell to be used for command execution, defaults to C</bin/sh>.
1237		1415
1238	=item B<RXVTPATH>
1239
1240	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1241	files.
1242
1243	=item B<PATH>
1244
1245	Used in the same way as C<RXVTPATH>.
1246
1247	=item B<RXVT_SOCKET>	1416	=item B<RXVT_SOCKET>
1248		1417
1249	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1418	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1250	@@RXVT_NAME@@d(1).	1419	@@RXVT_NAME@@d(1).
1251		1420
1252	Default C<< $HOME/.rxvt-unicode-<nodename >>.	1421	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1253		1422
1254	=item B<HOME>	1423	=item B<HOME>
1255		1424
1256	Used to locate the default directory for the unix domain socket for	1425	Used to locate the default directory for the unix domain socket for
1257	daemon communications and to locate various resource files (such as	1426	daemon communications and to locate various resource files (such as
…		…
1278		1447
1279	=back	1448	=back
1280		1449
1281	=head1 SEE ALSO	1450	=head1 SEE ALSO
1282		1451
1283	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1452	@@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)
1284
1285	=head1 BUGS
1286
1287	Check the BUGS file for an up-to-date list.
1288
1289	Cursor change support is not yet implemented.
1290
1291	Click-and-drag doesn't work with X11 mouse report overriding.
1292		1453
1293	=head1 CURRENT PROJECT COORDINATOR	1454	=head1 CURRENT PROJECT COORDINATOR
1294		1455
1295	=over 4	1456	=over 4
1296		1457
…		…
1328		1489
1329	Project Coordinator (changes.txt 2.21a to 2.4.5)	1490	Project Coordinator (changes.txt 2.21a to 2.4.5)
1330		1491
1331	=item Geoff Wing L<< <gcw@pobox.com> >>	1492	=item Geoff Wing L<< <gcw@pobox.com> >>
1332		1493
1333	Rewrote screen display and text selection routines. Project Coordinator	1494	Rewrote screen display and text selection routines.
		1495
1334	(changes.txt 2.4.6 - rxvt-unicode)	1496	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1335		1497
1336	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1498	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1337		1499
1338	Forked rxvt-unicode, rewrote most of the display code and internal	1500	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1339	character handling to store text in unicode, improve xterm	1501	extension, random hacks, numerous bugfixes and extensions.
1340	compatibility and apply numerous other bugfixes and extensions.
1341		1502
1342	Project Coordinator (Changes 1.0 -)	1503	Project Coordinator (Changes 1.0 -)
1343		1504
		1505	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1506
		1507	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
		1508
1344	=back	1509	=back
1345		1510

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.66 by root, Thu Jun 30 14:02:17 2005 UTC vs. Revision 1.109 by root, Sun Jan 29 22:27:04 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.66 by root, Thu Jun 30 14:02:17 2005 UTC vs.
Revision 1.109 by root, Sun Jan 29 22:27:04 2006 UTC