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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.161 by ayin, Sat Jan 26 14:24:42 2008 UTC vs.
Revision 1.212 by sf-exg, Sun Jan 1 14:31:28 2012 UTC

…		…
92		92
93	Print out a message describing available options.	93	Print out a message describing available options.
94		94
95	=item B<-display> I<displayname>	95	=item B<-display> I<displayname>
96		96
97	Attempt to open a window on the named X display (B<-d> still	97	Attempt to open a window on the named X display (the older form B<-d>
98	respected). In the absence of this option, the display specified by the	98	is still respected. but deprecated). In the absence of this option, the
99	B<DISPLAY> environment variable is used.	99	display specified by the B<DISPLAY> environment variable is used.
100		100
101	=item B<-depth> I<bitdepth>	101	=item B<-depth> I<bitdepth>
102		102
103	Compile I<xft>: Attempt to find a visual with the given bit depth;	103	Compile I<xft>: Attempt to find a visual with the given bit depth;
104	resource B<depth>.	104	resource B<depth>.
…		…
124		124
125	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.	125	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
126		126
127	=item B<-tr>\|B<+tr>	127	=item B<-tr>\|B<+tr>
128		128
129	Turn on/off illusion of a transparent window background; resource B<transparent>.	129	Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>.
130		130
131	B<-ip> is still accepted as an obsolete alias but will be removed in	131	B<-ip> is still accepted as an obsolete alias but will be removed in
132	future versions.	132	future versions.
133
134	I<Please address all transparency related issues to Sasha Vasko at
135	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
136		133
137	=item B<-fade> I<number>	134	=item B<-fade> I<number>
138		135
139	Fade the text by the given percentage when focus is lost. Small values	136	Fade the text by the given percentage when focus is lost. Small values
140	fade a little only, 100 completely replaces all colours by the fade	137	fade a little only, 100 completely replaces all colours by the fade
…		…
145	Fade to this colour when fading is used (see B<-fade>). The default colour	142	Fade to this colour when fading is used (see B<-fade>). The default colour
146	is opaque black. resource B<fadeColor>.	143	is opaque black. resource B<fadeColor>.
147		144
148	=item B<-tint> I<colour>	145	=item B<-tint> I<colour>
149		146
150	Tint the transparent background pixmap with the given colour when	147	Tint the transparent background with the given colour;
151	transparency is enabled with B<-tr>. This only works for	148	resource I<tintColor>.
152	non-tiled backgrounds, currently. See also the B<-sh> option that can be
153	used to brighten or darken the image in addition to tinting it.
154	Please note that certain tint colours can be applied on the server-side,
155	thus yielding performance gain of two orders of magnitude. These colours are:
156	blue, red, green, cyan, magenta, yellow, and those close to them. Also
157	pure black and pure white colors essentially mean no tinting; resource
158	I<tintColor>. Example:
159
160	@@RXVT_NAME@@ -tr -tint blue -sh 40
161		149
162	=item B<-sh> I<number>	150	=item B<-sh> I<number>
163		151
164	Darken (0 .. 100) or lighten (100 .. 200) the transparent	152	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
165	background image in addition to (or instead of) tinting it;	153	A value of 100 means no shading; resource I<shading>.
166	resource I<shading>.
167		154
168	=item B<-blt> I<string>	155	=item B<-blt> I<string>
169		156
170	Specify background blending type. If background pixmap is specified	157	Specify background blending type. If background pixmap is specified
171	at the same time as transparency - such pixmap will be blended over	158	at the same time as transparency - such pixmap will be blended over
172	transparency image, using method specified. Supported values are :	159	the transparent background, using the method specified. Supported values are:
173	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,	160	B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
174	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,	161	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
175	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is	162	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
176	alpha-blending. Compile I<afterimage>; resource I<blendType>.	163	alpha-blending. Compile I<afterimage>; resource I<blendType>.
177		164
178	=item B<-blr> I<HxV>	165	=item B<-blr> I<HxV>
179		166
180	Apply Gaussian Blur with the specified radii to the transparent	167	Apply Gaussian Blur with the specified radii to the transparent
181	background image. If single number is specified - both vertical and	168	background. If a single number is specified, the vertical and
182	horizontal radii are considered to be the same. Setting one of the	169	horizontal radii are considered to be the same. Setting one of the
183	radii to 1 and another to a large number creates interesting effects	170	radii to 1 and the other to a large number creates interesting effects
184	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;	171	on some backgrounds. The maximum radius value is 128. An horizontal or
		172	vertical radius of 0 disables blurring;
185	resource I<blurRadius>.	173	resource I<blurRadius>.
186		174
		175	=item B<-icon> I<file>
		176
		177	Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
		178	is used by many window managers, taskbars and pagers to represent the
		179	application window; resource I<iconFile>.
		180
187	=item B<-bg> I<colour>	181	=item B<-bg> I<colour>
188		182
189	Window background colour; resource B<background>.	183	Window background colour; resource B<background>.
190		184
191	=item B<-fg> I<colour>	185	=item B<-fg> I<colour>
192		186
193	Window foreground colour; resource B<foreground>.	187	Window foreground colour; resource B<foreground>.
194		188
195	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>	189	=item B<-pixmap> I<file[;oplist]>
196		190
197	Compile I<afterimage>: Specify image file for the background and also	191	Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
198	optionally specify its scaling with a geometry string. Note you may need to	192	optionally specify a list of operations to modify it. Note you may need to
199	add quotes to avoid special shell interpretation of the C<;> in the	193	add quotes to avoid special shell interpretation of the C<;> in the
200	command-line; for more details see resource B<backgroundPixmap>.	194	command-line; for more details see resource B<backgroundPixmap>.
201		195
202	=item B<-cr> I<colour>	196	=item B<-cr> I<colour>
203		197
…		…
315		309
316	=item B<-bc>\|B<+bc>	310	=item B<-bc>\|B<+bc>
317		311
318	Blink the cursor; resource B<cursorBlink>.	312	Blink the cursor; resource B<cursorBlink>.
319		313
		314	=item B<-uc>\|B<+uc>
		315
		316	Make the cursor underlined; resource B<cursorUnderline>.
		317
320	=item B<-iconic>	318	=item B<-iconic>
321		319
322	Start iconified, if the window manager supports that option.	320	Start iconified, if the window manager supports that option.
323	Alternative form is B<-ic>.	321	Alternative form is B<-ic>.
324		322
…		…
340		338
341	=item B<-bl>	339	=item B<-bl>
342		340
343	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	341	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
344	if honoured by the WM, the rxvt-unicode window will not have window	342	if honoured by the WM, the rxvt-unicode window will not have window
345	decorations; resource B<borderLess>.	343	decorations; resource B<borderLess>. If the window manager does not
		344	support MWM hints (e.g. kwin), enables override-redirect mode.
346		345
347	=item B<-override-redirect>	346	=item B<-override-redirect>
348		347
349	Compile I<frills>: Sets override-redirect on the window; resource	348	Compile I<frills>: Sets override-redirect on the window; resource
350	B<override-redirect>.	349	B<override-redirect>.
…		…
359	=item B<-lsp> I<number>	358	=item B<-lsp> I<number>
360		359
361	Compile I<frills>: Lines (pixel height) to insert between each row of	360	Compile I<frills>: Lines (pixel height) to insert between each row of
362	the display. Useful to work around font rendering problems; resource	361	the display. Useful to work around font rendering problems; resource
363	B<lineSpace>.	362	B<lineSpace>.
		363
		364	=item B<-letsp> I<number>
		365
		366	Compile I<frills>: Amount to adjust the computed character width by
		367	to control overall letter spacing. Negative values will tighten up the
		368	letter spacing, positive values will space letters out more. Useful to
		369	work around odd font metrics; resource B<letterSpace>.
364		370
365	=item B<-tn> I<termname>	371	=item B<-tn> I<termname>
366		372
367	This option specifies the name of the terminal type to be set in the	373	This option specifies the name of the terminal type to be set in the
368	B<TERM> environment variable. This terminal type must exist in the	374	B<TERM> environment variable. This terminal type must exist in the
…		…
455	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	461	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
456	will not immediately destroy its window when the program executed within	462	will not immediately destroy its window when the program executed within
457	it exits. Instead, it will wait till it is being killed or closed by the	463	it exits. Instead, it will wait till it is being killed or closed by the
458	user; resource B<hold>.	464	user; resource B<hold>.
459		465
		466	=item B<-cd> I<path>
		467
		468	Sets the working directory for the shell (or the command specified via
		469	B<-e>). The I<path> must be an absolute path and it must exist for
		470	@@RXVT_NAME@@ to start; resource B<chdir>.
		471
460	=item B<-xrm> I<string>	472	=item B<-xrm> I<string>
461		473
462	Works like the X Toolkit option of the same name, by adding the I<string>	474	Works like the X Toolkit option of the same name, by adding the I<string>
463	as if it were specified in a resource file. Resource values specified this	475	as if it were specified in a resource file. Resource values specified this
464	way take precedence over all other resource specifications.	476	way take precedence over all other resource specifications.
…		…
547	You can set and change the resources using X11 tools like B<xrdb>. Many	559	You can set and change the resources using X11 tools like B<xrdb>. Many
548	distribution do also load settings from the B<~/.Xresources> file when X	560	distribution do also load settings from the B<~/.Xresources> file when X
549	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	561	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
550	with later settings overwriting earlier ones:	562	with later settings overwriting earlier ones:
551		563
552	1. system-wide app-defaults file, either locale-dependent OR global
553	2. app-defaults file in $XAPPLRESDIR	564	1. app-defaults file in $XAPPLRESDIR
		565	2. $HOME/.Xdefaults
554	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	566	3. RESOURCE_MANAGER property on root-window of screen 0
555	4. SCREEN_RESOURCES for the current screen	567	4. SCREEN_RESOURCES property on root-window of the current screen
556	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	568	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
557	6. resources specified via -xrm on the commandline	569	6. resources specified via -xrm on the commandline
558		570
559	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	571	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
560	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	572	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
…		…
601	Use the specified colour for the colour value I<n>, where 0-7	613	Use the specified colour for the colour value I<n>, where 0-7
602	corresponds to low-intensity (normal) colours and 8-15 corresponds to	614	corresponds to low-intensity (normal) colours and 8-15 corresponds to
603	high-intensity (bold = bright foreground, blink = bright background)	615	high-intensity (bold = bright foreground, blink = bright background)
604	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	616	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
605	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	617	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
606	names used are listed in the B<COLORS AND GRAPHICS> section.	618	names used are listed in the B<COLOURS AND GRAPHICS> section.
607		619
608	Colours higher than 15 cannot be set using resources (yet), but can be	620	Colours higher than 15 cannot be set using resources (yet), but can be
609	changed using an escape command (see @@RXVT_NAME@@(7)).	621	changed using an escape command (see @@RXVT_NAME@@(7)).
610		622
611	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	623	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
622	=item B<colorUL:> I<colour>	634	=item B<colorUL:> I<colour>
623		635
624	Use the specified colour to display underlined characters when the	636	Use the specified colour to display underlined characters when the
625	foreground colour is the default.	637	foreground colour is the default.
626		638
627	=item B<colorRV:> I<colour>
628
629	Use the specified colour as the background for reverse video characters
630	when OPTION_HC is disabled (--disable-frills).
631
632	=item B<underlineColor:> I<colour>	639	=item B<underlineColor:> I<colour>
633		640
634	If set, use the specified colour as the colour for the underline	641	If set, use the specified colour as the colour for the underline
635	itself. If unset, use the foreground colour.	642	itself. If unset, use the foreground colour.
		643
		644	=item B<highlightColor:> I<colour>
		645
		646	If set, use the specified colour as the background for highlighted
		647	characters. If unset, use reverse video.
		648
		649	=item B<highlightTextColor:> I<colour>
		650
		651	If set and highlightColor is set, use the specified colour as the
		652	foreground for highlighted characters.
636		653
637	=item B<cursorColor:> I<colour>	654	=item B<cursorColor:> I<colour>
638		655
639	Use the specified colour for the cursor. The default is to use the	656	Use the specified colour for the cursor. The default is to use the
640	foreground colour; option B<-cr>.	657	foreground colour; option B<-cr>.
…		…
647		664
648	=item B<reverseVideo:> I<boolean>	665	=item B<reverseVideo:> I<boolean>
649		666
650	B<True>: simulate reverse video by foreground and background colours;	667	B<True>: simulate reverse video by foreground and background colours;
651	option B<-rv>. B<False>: regular screen colours [default]; option	668	option B<-rv>. B<False>: regular screen colours [default]; option
652	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	669	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
653		670
654	=item B<jumpScroll:> I<boolean>	671	=item B<jumpScroll:> I<boolean>
655		672
656	B<True>: specify that jump scrolling should be used. When receiving lots	673	B<True>: specify that jump scrolling should be used. When receiving lots
657	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines	674	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
…		…
673	if the refresh is too fast for the human eye to read anything (or the	690	if the refresh is too fast for the human eye to read anything (or the
674	monitor to display anything); option B<+ss>.	691	monitor to display anything); option B<+ss>.
675		692
676	=item B<transparent:> I<boolean>	693	=item B<transparent:> I<boolean>
677		694
678	Turn on/off illusion of a transparent window background.	695	Turn on/off pseudo-transparency by using the root pixmap as background.
679		696
680	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in	697	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
681	future versions.	698	future versions.
682		699
683	I<Please address all transparency related issues to Sasha Vasko at
684	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
685
686	=item B<fading:> I<number>	700	=item B<fading:> I<number>
687		701
688	Fade the text by the given percentage when focus is lost; option B<-fade>.	702	Fade the text by the given percentage when focus is lost; option B<-fade>.
689		703
690	=item B<fadeColor:> I<colour>	704	=item B<fadeColor:> I<colour>
…		…
692	Fade to this colour, when fading is used (see B<fading:>). The default	706	Fade to this colour, when fading is used (see B<fading:>). The default
693	colour is black; option B<-fadecolor>.	707	colour is black; option B<-fadecolor>.
694		708
695	=item B<tintColor:> I<colour>	709	=item B<tintColor:> I<colour>
696		710
697	Tint the transparent background pixmap with the given colour; option	711	Tint the transparent background with the given colour. If the RENDER
698	B<-tint>.	712	extension is not available only black, red, green, yellow, blue,
		713	magenta, cyan and white tints can be performed server-side. Note that
		714	a black tint yields a completely black image while a white tint yields
		715	the image unchanged; option B<-tint>.
699		716
700	=item B<shading:> I<number>	717	=item B<shading:> I<number>
701		718
702	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image	719	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
703	in addition to tinting it; option B<-sh>.	720	A value of 100 means no shading; option B<-sh>.
704		721
705	=item B<blendType:> I<string>	722	=item B<blendType:> I<string>
706		723
707	Specify background blending type; option B<-blt>.	724	Specify background blending type; option B<-blt>.
708		725
709	=item B<blurRadius:> I<number>	726	=item B<blurRadius:> I<number>
710		727
711	Apply Gaussian Blurr with the specified radius to the transparent	728	Apply gaussian blur with the specified radius to the transparent
712	background image; option B<-blr>.	729	background; option B<-blr>.
		730
		731	=item B<iconFile:> I<file>
		732
		733	Set the application icon pixmap; option B<-icon>.
713		734
714	=item B<scrollColor:> I<colour>	735	=item B<scrollColor:> I<colour>
715		736
716	Use the specified colour for the scrollbar [default #B2B2B2].	737	Use the specified colour for the scrollbar [default #B2B2B2].
717		738
…		…
723	=item B<borderColor:> I<colour>	744	=item B<borderColor:> I<colour>
724		745
725	The colour of the border around the text area and between the scrollbar	746	The colour of the border around the text area and between the scrollbar
726	and the text.	747	and the text.
727		748
728	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>	749	=item B<backgroundPixmap:> I<file[;oplist]>
729		750
730	Use the specified image file for the background and also	751	Use the specified image file for the background and also
731	optionally specify its scaling with a geometry string B<WxH+X+Y>,	752	optionally specify a colon separated list of operations to modify it.
732	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
733	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
734	centre (percent). A scale of 0 displays the image with tiling. A scale
735	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
736	an integer number of images in that direction. No image will be magnified
737	beyond 10 times its original size. The maximum permitted scale is 1000.
738	Additional operations can be specified after colon B<:op1:op2...>.
739	Supported operations are:	753	Supported operations are:
740		754
741	tile force background image to be tiled and not scaled. Equivalent to 0x0	755	=over 4
742	propscale will scale image keeping proportions	756
743	auto will scale image to match window size. Equivalent to 100x100	757	=item B<WxH+X+Y>
744	hscale will scale image horizontally to the window size	758
745	vscale will scale image vertically to the window size	759	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
746	scale will scale image to match window size	760	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
747	root will tile image as if it was a root window background, auto-adjusting	761	scale of 0 disables scaling. The maximum permitted scale is 1000.
748	whenever terminal window moves	762
		763	=item B<op=tile>
		764
		765	enables tiling
		766
		767	=item B<op=keep-aspect>
		768
		769	maintain the image aspect ratio when scaling
		770
		771	=item B<op=root-align>
		772
		773	use the position of the terminal window relative to the root window as
		774	the image offset, simulating a root window background
		775
		776	=back
		777
		778	The default scale and position setting is C<100x100+50+50>.
		779	Alternatively, a predefined set of templates can be used to achieve
		780	the most common setups:
		781
		782	=over 4
		783
		784	=item B<style=tiled>
		785
		786	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		787
		788	=item B<style=aspect-stretched>
		789
		790	the image is scaled to fill the whole window maintaining the aspect
		791	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		792
		793	=item B<style=stretched>
		794
		795	the image is scaled to fill the whole window. Equivalent to 100x100
		796
		797	=item B<style=centered>
		798
		799	the image is centered with no scaling. Equivalent to 0x0+50+50
		800
		801	=item B<style=root-tiled>
		802
		803	the image is tiled with no scaling and using 'root' positioning.
		804	Equivalent to 0x0:op=tile:op=root-align
		805
		806	=back
		807
		808	If multiple templates are specified the last one wins. Note that a
		809	template overrides all the scale, position and operations settings.
749		810
750	If used in conjunction with B<-tr> option, the specified pixmap will be	811	If used in conjunction with B<-tr> option, the specified pixmap will be
751	blended over transparency image using either alpha-blending, or any	812	blended over the transparent background using alpha-blending. If I<afterimage>
752	other blending type, specified with B<-blt "type"> option.	813	support has been compiled in it is possible to choose other blending
		814	types with B<-blt "type"> option.
753		815
754	=item B<path:> I<path>	816	=item B<path:> I<path>
755		817
756	Specify the colon-delimited search path for finding background image files.	818	Specify the colon-delimited search path for finding background image files.
757		819
…		…
784	it is named first) and thus defines the character cell grid to be 9 pixels	846	it is named first) and thus defines the character cell grid to be 9 pixels
785	wide and 15 pixels high.	847	wide and 15 pixels high.
786		848
787	The second font is just used to add additional unicode characters not in	849	The second font is just used to add additional unicode characters not in
788	the base font, likewise the third, which is unfortunately non-bold, but	850	the base font, likewise the third, which is unfortunately non-bold, but
789	the bold version of the font does contain less characters, so this is a	851	the bold version of the font does contain fewer characters, so this is a
790	useful supplement.	852	useful supplement.
791		853
792	The third font is an Xft font with aliasing turned off, and the characters	854	The third font is an Xft font with aliasing turned off, and the characters
793	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	855	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
794	contains other characters, but we are not interested in them.	856	contains other characters, but we are not interested in them.
…		…
845	=item B<urgentOnBell:> I<boolean>	907	=item B<urgentOnBell:> I<boolean>
846		908
847	B<True>: set the urgency hint for the wm on receipt of a bell character.	909	B<True>: set the urgency hint for the wm on receipt of a bell character.
848	B<False>: do not set the urgency hint [default].	910	B<False>: do not set the urgency hint [default].
849		911
		912	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		913
850	=item B<visualBell:> I<boolean>	914	=item B<visualBell:> I<boolean>
851		915
852	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	916	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
853	B<False>: no visual bell [default]; option B<+vb>.	917	B<False>: no visual bell [default]; option B<+vb>.
854		918
…		…
882	=item B<scrollstyle:> I<mode>	946	=item B<scrollstyle:> I<mode>
883		947
884	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	948	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
885	the author's favourite.	949	the author's favourite.
886		950
		951	=item B<thickness:> I<number>
		952
		953	Set the scrollbar width in pixels.
		954
887	=item B<scrollBar:> I<boolean>	955	=item B<scrollBar:> I<boolean>
888		956
889	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	957	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
890	disable the scrollbar; option B<+sb>.	958	disable the scrollbar; option B<+sb>.
891		959
…		…
910	B<False>: do not scroll to bottom when tty receives output; option	978	B<False>: do not scroll to bottom when tty receives output; option
911	B<+si>.	979	B<+si>.
912		980
913	=item B<scrollWithBuffer:> I<boolean>	981	=item B<scrollWithBuffer:> I<boolean>
914		982
915	B<True>: scroll with scrollback buffer when tty receives new lines (and	983	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
916	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	984	try to show the same lines) and B<scrollTtyOutput> is False; option
917	with scrollback buffer when tty receives new lines; option B<+sw>.	985	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		986	new lines; option B<+sw>.
918		987
919	=item B<scrollTtyKeypress:> I<boolean>	988	=item B<scrollTtyKeypress:> I<boolean>
920		989
921	B<True>: scroll to bottom when a non-special key is pressed. Special keys	990	B<True>: scroll to bottom when a non-special key is pressed. Special keys
922	are those which are intercepted by rxvt-unicode for special handling and	991	are those which are intercepted by rxvt-unicode for special handling and
…		…
978	=item B<cursorBlink:> I<boolean>	1047	=item B<cursorBlink:> I<boolean>
979		1048
980	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1049	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
981	option B<-bc>.	1050	option B<-bc>.
982		1051
		1052	=item B<cursorUnderline:> I<boolean>
		1053
		1054	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1055	option B<-uc>.
		1056
983	=item B<pointerBlank:> I<boolean>	1057	=item B<pointerBlank:> I<boolean>
984		1058
985	B<True>: blank the pointer when a key is pressed or after a set number	1059	B<True>: blank the pointer when a key is pressed or after a set number
986	of seconds of inactivity. B<False>: the pointer is always visible	1060	of seconds of inactivity. B<False>: the pointer is always visible
987	[default].	1061	[default].
…		…
1000	large number (e.g. C<987654321>) to effectively disable the timeout.	1074	large number (e.g. C<987654321>) to effectively disable the timeout.
1001		1075
1002	=item B<backspacekey:> I<string>	1076	=item B<backspacekey:> I<string>
1003		1077
1004	The string to send when the backspace key is pressed. If set to B<DEC>	1078	The string to send when the backspace key is pressed. If set to B<DEC>
1005	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	1079	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
1006	(code 8) - which can be reversed with the appropriate DEC private mode	1080	(code 8) - which can be reversed with the appropriate DEC private mode
1007	escape sequence.	1081	escape sequence.
1008		1082
1009	=item B<deletekey:> I<string>	1083	=item B<deletekey:> I<string>
1010		1084
…		…
1089		1163
1090	=item B<secondaryScroll:> I<boolean>	1164	=item B<secondaryScroll:> I<boolean>
1091		1165
1092	Turn on/off secondary screen scroll (default enabled). If this	1166	Turn on/off secondary screen scroll (default enabled). If this
1093	option is enabled, scrolls on the secondary screen will change the	1167	option is enabled, scrolls on the secondary screen will change the
1094	scrollback buffer and switching to/from the secondary screen will	1168	scrollback buffer and, when secondaryScreen is off, switching
1095	instead scroll the screen up.	1169	to/from the secondary screen will instead scroll the screen up.
1096		1170
1097	=item B<hold>: I<boolean>	1171	=item B<hold>: I<boolean>
1098		1172
1099	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1173	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1100	will not immediately destroy its window when the program executed within	1174	will not immediately destroy its window when the program executed within
1101	it exits. Instead, it will wait till it is being killed or closed by the	1175	it exits. Instead, it will wait till it is being killed or closed by the
1102	user.	1176	user.
		1177
		1178	=item B<chdir>: I<path>
		1179
		1180	Sets the working directory for the shell (or the command specified via
		1181	B<-e>). The I<path> must be an absolute path and it must exist for
		1182	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1183	directory will be used; option B<-cd>.
1103		1184
1104	=item B<keysym.>I<sym>: I<string>	1185	=item B<keysym.>I<sym>: I<string>
1105		1186
1106	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1187	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1107	intervening resource name B<keysym.> cannot be omitted.	1188	intervening resource name B<keysym.> cannot be omitted.
…		…
1122	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1203	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1123	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1204	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1124	performed in an exact manner; however, the closest match is assured.	1205	performed in an exact manner; however, the closest match is assured.
1125		1206
1126	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1207	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1127	number), see RESOURCES in C<man 7 X> for futher details.	1208	number), see RESOURCES in C<man 7 X> for further details.
1128		1209
1129	You can define a range of keysyms in one shot by providing a I<string>	1210	You can define a range of keysyms in one shot by
		1211	loading the C<keysym-list> perl extension and providing a I<string>
1130	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1212	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1131	should be a character not used by the strings.	1213	should be a character not used by the strings.
1132		1214
1133	Its usage can be demonstrated by an example:	1215	Its usage can be demonstrated by an example:
1134		1216
1135	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1217	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1136		1218
1137	The above line is equivalent to the following three lines:	1219	The above line is equivalent to the following three lines:
1138		1220
1139	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1221	URxvt.keysym.Meta-Control-0x61: \033<a>
1140	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1222	URxvt.keysym.Meta-Control-0x62: \033<b>
1141	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1223	URxvt.keysym.Meta-Control-0x63: \033<c>
1142		1224
1143	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1225	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1144	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1226	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1145	example the following means "change the current locale to C<zh_CN.GBK>	1227	example the following means "change the current locale to C<zh_CN.GBK>
1146	when Control-Meta-c is being pressed":	1228	when Control-Meta-c is being pressed":
1147		1229
1148	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1230	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1149		1231
1150	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1232	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1151	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1233	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1152	manpage. For example, the F<selection> extension (activated via	1234	manpage. For example, the F<selection> extension (activated via
1153	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1235	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1154		1236
1155	URxvt.keysym.M-C-c: perl:selection:rot13	1237	URxvt.keysym.M-C-c: perl:selection:rot13
1156		1238
1157	Due the the large number of modifier combinations, a defined key mapping	1239	Due the the large number of modifier combinations, a defined key mapping
1158	will match if at I<at least> the specified identifiers are being set, and	1240	will match if I<at least> the specified identifiers are being set, and
1159	no other key mappings with those and more bits are being defined. That	1241	no other key mappings with those and more bits are being defined. That
1160	means that defining a key map for C<a> will automatically provide	1242	means that defining a key map for C<a> will automatically provide
1161	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined	1243	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1162	mappings themselves.	1244	mappings themselves.
1163		1245
…		…
1214	all instances, while B<perl-ext> is used for specific instances.	1296	all instances, while B<perl-ext> is used for specific instances.
1215		1297
1216	=item B<perl-eval>: I<string>	1298	=item B<perl-eval>: I<string>
1217		1299
1218	Perl code to be evaluated when all extensions have been registered. See	1300	Perl code to be evaluated when all extensions have been registered. See
1219	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1301	the @@RXVT_NAME@@perl(3) manpage.
1220	will be ignored when running setuid/setgid.
1221		1302
1222	=item B<perl-lib>: I<path>	1303	=item B<perl-lib>: I<path>
1223		1304
1224	Colon-separated list of additional directories that hold extension	1305	Colon-separated list of additional directories that hold extension
1225	scripts. When looking for extensions specified by the C<perl> resource,	1306	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
1226	@@RXVT_NAME@@ will first look in these directories and then in	1307	look in these directories, then in $HOME/.urxvt/ext and lastly in
1227	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1308	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1228	will be ignored when running setuid/setgid.
1229		1309
1230	See the @@RXVT_NAME@@perl(3) manpage.	1310	See the @@RXVT_NAME@@perl(3) manpage.
1231		1311
1232	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1312	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1233		1313
…		…
1255		1335
1256	=item B<override-redirect>: I<boolean>	1336	=item B<override-redirect>: I<boolean>
1257		1337
1258	Compile I<frills>: Sets override-redirect for the terminal window, making	1338	Compile I<frills>: Sets override-redirect for the terminal window, making
1259	it almost invisible to window managers; option B<-override-redirect>.	1339	it almost invisible to window managers; option B<-override-redirect>.
		1340
		1341	=item B<iso14755:> I<boolean>
		1342
		1343	Turn on/off ISO 14755 (default enabled).
1260		1344
1261	=item B<iso14755_52:> I<boolean>	1345	=item B<iso14755_52:> I<boolean>
1262		1346
1263	Turn on/off ISO 14755 5.2 mode (default enabled).	1347	Turn on/off ISO 14755 5.2 mode (default enabled).
1264		1348
…		…
1407	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1491	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1408	it can be seen via the I<who(1)> command, and can accept messages. To	1492	it can be seen via the I<who(1)> command, and can accept messages. To
1409	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1493	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1410	on some systems or setgid to root or to some other group on others.	1494	on some systems or setgid to root or to some other group on others.
1411		1495
1412	=head1 COLORS AND GRAPHICS	1496	=head1 COLOURS AND GRAPHICS
1413		1497
1414	In addition to the default foreground and background colours,	1498	In addition to the default foreground and background colours,
1415	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1499	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1416	high-intensity bold/blink versions of the same). Here is a list of the	1500	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1417	colours with their names.	1501	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1502	cube plus a 8 (24) colour greyscale ramp.
		1503
		1504	Here is a list of the ANSI colours with their names.
1418		1505
1419	=begin table	1506	=begin table
1420		1507
1421	B<color0> (black) = Black	1508	B<color0> (black) = Black
1422	B<color1> (red) = Red3	1509	B<color1> (red) = Red3
…		…
1442	It is also possible to specify the colour values of B<foreground>,	1529	It is also possible to specify the colour values of B<foreground>,
1443	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1530	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1444	a number 0-15, as a convenient shorthand to reference the colour name of	1531	a number 0-15, as a convenient shorthand to reference the colour name of
1445	color0-color15.	1532	color0-color15.
1446		1533
1447	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1534	The following text gives values for the standard 88 colour mode (and
1448	additional 72 colours. The first 64 of those (with indices 16 to 79)	1535	values for the 256 colour mode in parentheses).
1449	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1450	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1451		1536
		1537	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1538
		1539	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1540	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1541
		1542	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1543	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1544	the RGB cube.
		1545
1452	Together, all those colours implement the 88 colour xterm colours. Only	1546	Together, all those colours implement the 88 (256) colour xterm
1453	the first 16 can be changed using resources currently, the rest can only	1547	colours. Only the first 16 can be changed using resources currently, the
1454	be changed via command sequences ("escape codes").	1548	rest can only be changed via command sequences ("escape codes").
		1549
		1550	Applications are advised to use terminfo or command sequences to discover
		1551	number and RGB values of all colours (yes, you can query this...).
1455		1552
1456	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1553	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1457	always swapping the foreground/background colours. This is in contrast to	1554	always swapping the foreground/background colours. This is in contrast to
1458	I<xterm>(1) where the colours are only swapped if they have not otherwise	1555	I<xterm>(1) where the colours are only swapped if they have not otherwise
1459	been specified. For example,	1556	been specified. For example,
1460		1557
1461	=over 4
1462
1463	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1558	@@RXVT_NAME@@ -fg Black -bg White -rv
1464		1559
1465	would yield White on Black, while on I<xterm>(1) it would yield Black	1560	would yield White on Black, while on I<xterm>(1) it would yield Black on
1466	on White.	1561	White.
1467
1468	=back
1469		1562
1470	=head2 ALPHA CHANNEL SUPPORT	1563	=head2 ALPHA CHANNEL SUPPORT
1471		1564
1472	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1565	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1473	their act together, rxvt-unicode will do it's own alpha channel management:	1566	their act together, rxvt-unicode will do its own alpha channel management:
1474		1567
1475	You can prefix any color with an opaquenes percentage enclosed in	1568	You can prefix any colour with an opaqueness percentage enclosed in
1476	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage	1569	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1477	(0-100) that specifies the opacity of the color, where C<0> is completely	1570	(0-100) that specifies the opacity of the colour, where C<0> is completely
1478	transparent and C<100> is completely opaque. For example, C<[50]red> is a	1571	transparent and C<100> is completely opaque. For example, C<[50]red> is a
1479	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This	1572	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1480	is the recommended format to specify transparency values, and works with	1573	is the recommended format to specify transparency values, and works with
1481	all ways to specify a colour.	1574	all ways to specify a colour.
1482		1575
…		…
1553	C<--with-terminfo=PATH>.	1646	C<--with-terminfo=PATH>.
1554		1647
1555	=item B<DISPLAY>	1648	=item B<DISPLAY>
1556		1649
1557	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1650	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1558	display in its child processes.	1651	display in its child processes if C<-display> isn't used to override. It
		1652	defaults to C<:0> if it doesn't exist.
1559		1653
1560	=item B<SHELL>	1654	=item B<SHELL>
1561		1655
1562	The shell to be used for command execution, defaults to C</bin/sh>.	1656	The shell to be used for command execution, defaults to C</bin/sh>.
1563		1657
1564	=item B<RXVT_SOCKET>	1658	=item B<RXVT_SOCKET>
1565		1659
1566	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1660	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1567	@@RXVT_NAME@@d(1).	1661	@@RXVT_NAME@@d(1).
1568		1662
1569	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1663	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1570		1664
1571	=item B<HOME>	1665	=item B<HOME>
1572		1666
1573	Used to locate the default directory for the unix domain socket for	1667	Used to locate the default directory for the unix domain socket for
1574	daemon communications and to locate various resource files (such as	1668	daemon communications and to locate various resource files (such as
1575	C<.Xdefaults>)	1669	C<.Xdefaults>)
1576		1670
1577	=item B<XAPPLRESDIR>	1671	=item B<XAPPLRESDIR>
1578		1672
1579	Directory where various X resource files are being located.	1673	Directory where application-specific X resource files are located.
1580		1674
1581	=item B<XENVIRONMENT>	1675	=item B<XENVIRONMENT>
1582		1676
1583	If set and accessible, gives the name of a X resource file to be loaded by	1677	If set and accessible, gives the name of a X resource file to be loaded by
1584	@@RXVT_NAME@@.	1678	@@RXVT_NAME@@.
…		…
1589		1683
1590	=over 4	1684	=over 4
1591		1685
1592	=item B</usr/lib/X11/rgb.txt>	1686	=item B</usr/lib/X11/rgb.txt>
1593		1687
1594	Color names.	1688	Colour names.
1595		1689
1596	=back	1690	=back
1597		1691
1598	=head1 SEE ALSO	1692	=head1 SEE ALSO
1599		1693
…		…
1650		1744
1651	Project Coordinator (Changes 1.0 -)	1745	Project Coordinator (Changes 1.0 -)
1652		1746
1653	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1747	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1654		1748
1655	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1749	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1656		1750
1657	=back	1751	=back
1658		1752

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.161 by ayin, Sat Jan 26 14:24:42 2008 UTC vs. Revision 1.212 by sf-exg, Sun Jan 1 14:31:28 2012 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.161 by ayin, Sat Jan 26 14:24:42 2008 UTC vs.
Revision 1.212 by sf-exg, Sun Jan 1 14:31:28 2012 UTC