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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.155 by ayin, Mon Dec 17 23:52:44 2007 UTC vs.
Revision 1.187 by sf-exg, Fri Oct 15 10:46:57 2010 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>.
105		105
		106	[Please note that many X servers (and libXft) are buggy with
		107	respect to C<-depth 32> and/or alpha channels, and will cause all sorts
		108	of graphical corruption. This is harmless, but we can't do anything about
		109	this, so watch out]
		110
106	=item B<-geometry> I<geom>	111	=item B<-geometry> I<geom>
107		112
108	Window geometry (B<-g> still respected); resource B<geometry>.	113	Window geometry (B<-g> still respected); resource B<geometry>.
109		114
110	=item B<-rv>\|B<+rv>	115	=item B<-rv>\|B<+rv>
…		…
123		128
124	Turn on/off illusion of a transparent window background; resource B<transparent>.	129	Turn on/off illusion of a transparent window background; resource B<transparent>.
125		130
126	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
127	future versions.	132	future versions.
128
129	I<Please address all transparency related issues to Sasha Vasko at
130	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
131		133
132	=item B<-fade> I<number>	134	=item B<-fade> I<number>
133		135
134	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
135	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
…		…
147	non-tiled backgrounds, currently. See also the B<-sh> option that can be	149	non-tiled backgrounds, currently. See also the B<-sh> option that can be
148	used to brighten or darken the image in addition to tinting it.	150	used to brighten or darken the image in addition to tinting it.
149	Please note that certain tint colours can be applied on the server-side,	151	Please note that certain tint colours can be applied on the server-side,
150	thus yielding performance gain of two orders of magnitude. These colours are:	152	thus yielding performance gain of two orders of magnitude. These colours are:
151	blue, red, green, cyan, magenta, yellow, and those close to them. Also	153	blue, red, green, cyan, magenta, yellow, and those close to them. Also
152	pure black and pure white colors essentially mean no tinting; resource	154	pure black and pure white colours essentially mean no tinting; resource
153	I<tintColor>. Example:	155	I<tintColor>. Example:
154		156
155	@@RXVT_NAME@@ -tr -tint blue -sh 40	157	@@RXVT_NAME@@ -tr -tint blue -sh 40
156		158
157	=item B<-sh> I<number>	159	=item B<-sh> I<number>
…		…
163	=item B<-blt> I<string>	165	=item B<-blt> I<string>
164		166
165	Specify background blending type. If background pixmap is specified	167	Specify background blending type. If background pixmap is specified
166	at the same time as transparency - such pixmap will be blended over	168	at the same time as transparency - such pixmap will be blended over
167	transparency image, using method specified. Supported values are :	169	transparency image, using method specified. Supported values are :
168	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,	170	B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
169	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,	171	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
170	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is	172	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
171	alpha-blending. Compile I<afterimage>; resource I<blendType>.	173	alpha-blending. Compile I<afterimage>; resource I<blendType>.
172		174
173	=item B<-blr> I<HxV>	175	=item B<-blr> I<HxV>
174		176
175	Apply Gaussian Blur with the specified radii to the transparent	177	Apply Gaussian Blur with the specified radii to the transparent
176	background image. If single number is specified - both vertical and	178	background image. If single number is specified - both vertical and
177	horizontal radii are considered to be the same. Setting one of the	179	horizontal radii are considered to be the same. Setting one of the
178	radii to 1 and another to a large number creates interesting effects	180	radii to 1 and another to a large number creates interesting effects
179	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;	181	on some backgrounds. Maximum radius value is 128. Compile I<afterimage> or I<xft>;
180	resource I<blurRadius>.	182	resource I<blurRadius>.
181		183
		184	=item B<-icon> I<file>
		185
		186	Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
		187	is used by many window managers, taskbars and pagers to represent the
		188	application window; resource I<iconFile>.
		189
182	=item B<-bg> I<colour>	190	=item B<-bg> I<colour>
183		191
184	Window background colour; resource B<background>.	192	Window background colour; resource B<background>.
185		193
186	=item B<-fg> I<colour>	194	=item B<-fg> I<colour>
187		195
188	Window foreground colour; resource B<foreground>.	196	Window foreground colour; resource B<foreground>.
189		197
190	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>	198	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
191		199
192	Compile I<afterimage>: Specify image file for the background and also	200	Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
193	optionally specify its scaling with a geometry string. Note you may need to	201	optionally specify its scaling with a geometry string. Note you may need to
194	add quotes to avoid special shell interpretation of the C<;> in the	202	add quotes to avoid special shell interpretation of the C<;> in the
195	command-line; for more details see resource B<backgroundPixmap>.	203	command-line; for more details see resource B<backgroundPixmap>.
196		204
197	=item B<-cr> I<colour>	205	=item B<-cr> I<colour>
…		…
273		281
274	=item B<-sb>\|B<+sb>	282	=item B<-sb>\|B<+sb>
275		283
276	Turn on/off scrollbar; resource B<scrollBar>.	284	Turn on/off scrollbar; resource B<scrollBar>.
277		285
		286	=item B<-sr>\|B<+sr>
		287
		288	Put scrollbar on right/left; resource B<scrollBar_right>.
		289
		290	=item B<-st>\|B<+st>
		291
		292	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		293	resource B<scrollBar_floating>.
		294
278	=item B<-si>\|B<+si>	295	=item B<-si>\|B<+si>
279		296
280	Turn on/off scroll-to-bottom on TTY output inhibit; resource	297	Turn on/off scroll-to-bottom on TTY output inhibit; resource
281	B<scrollTtyOutput> has opposite effect.	298	B<scrollTtyOutput> has opposite effect.
282		299
…		…
288	=item B<-sw>\|B<+sw>	305	=item B<-sw>\|B<+sw>
289		306
290	Turn on/off scrolling with the scrollback buffer as new lines appear.	307	Turn on/off scrolling with the scrollback buffer as new lines appear.
291	This only takes effect if B<-si> is also given; resource	308	This only takes effect if B<-si> is also given; resource
292	B<scrollWithBuffer>.	309	B<scrollWithBuffer>.
293
294	=item B<-sr>\|B<+sr>
295
296	Put scrollbar on right/left; resource B<scrollBar_right>.
297
298	=item B<-st>\|B<+st>
299
300	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
301	resource B<scrollBar_floating>.
302		310
303	=item B<-ptab>\|B<+ptab>	311	=item B<-ptab>\|B<+ptab>
304		312
305	If enabled (default), "Horizontal Tab" characters are being stored as	313	If enabled (default), "Horizontal Tab" characters are being stored as
306	actual wide characters in the screen buffer, which makes it possible to	314	actual wide characters in the screen buffer, which makes it possible to
…		…
310		318
311	=item B<-bc>\|B<+bc>	319	=item B<-bc>\|B<+bc>
312		320
313	Blink the cursor; resource B<cursorBlink>.	321	Blink the cursor; resource B<cursorBlink>.
314		322
		323	=item B<-uc>\|B<+uc>
		324
		325	Make the cursor underlined; resource B<cursorUnderline>.
		326
315	=item B<-iconic>	327	=item B<-iconic>
316		328
317	Start iconified, if the window manager supports that option.	329	Start iconified, if the window manager supports that option.
318	Alternative form is B<-ic>.	330	Alternative form is B<-ic>.
319		331
…		…
335		347
336	=item B<-bl>	348	=item B<-bl>
337		349
338	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	350	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
339	if honoured by the WM, the rxvt-unicode window will not have window	351	if honoured by the WM, the rxvt-unicode window will not have window
340	decorations; resource B<borderLess>.	352	decorations; resource B<borderLess>. If the window manager does not
		353	support MWM hints (e.g. kwin), enables override-redirect mode.
341		354
342	=item B<-override-redirect>	355	=item B<-override-redirect>
343		356
344	Compile I<frills>: Sets override-redirect on the window; resource	357	Compile I<frills>: Sets override-redirect on the window; resource
345	B<override-redirect>.	358	B<override-redirect>.
…		…
354	=item B<-lsp> I<number>	367	=item B<-lsp> I<number>
355		368
356	Compile I<frills>: Lines (pixel height) to insert between each row of	369	Compile I<frills>: Lines (pixel height) to insert between each row of
357	the display. Useful to work around font rendering problems; resource	370	the display. Useful to work around font rendering problems; resource
358	B<lineSpace>.	371	B<lineSpace>.
		372
		373	=item B<-letsp> I<number>
		374
		375	Compile I<frills>: Amount to adjust the computed character width by
		376	to control overall letter spacing. Negative values will tighten up the
		377	letter spacing, positive values will space letters out more. Useful to
		378	work around odd font metrics; resource B<letterSpace>.
359		379
360	=item B<-tn> I<termname>	380	=item B<-tn> I<termname>
361		381
362	This option specifies the name of the terminal type to be set in the	382	This option specifies the name of the terminal type to be set in the
363	B<TERM> environment variable. This terminal type must exist in the	383	B<TERM> environment variable. This terminal type must exist in the
…		…
449		469
450	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	470	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
451	will not immediately destroy its window when the program executed within	471	will not immediately destroy its window when the program executed within
452	it exits. Instead, it will wait till it is being killed or closed by the	472	it exits. Instead, it will wait till it is being killed or closed by the
453	user; resource B<hold>.	473	user; resource B<hold>.
		474
		475	=item B<-cd> I<path>
		476
		477	Sets the working directory for the shell (or the command specified via
		478	B<-e>). The I<path> must be an absolute path and it must exist for
		479	@@RXVT_NAME@@ to start; resource B<chdir>.
454		480
455	=item B<-xrm> I<string>	481	=item B<-xrm> I<string>
456		482
457	Works like the X Toolkit option of the same name, by adding the I<string>	483	Works like the X Toolkit option of the same name, by adding the I<string>
458	as if it were specified in a resource file. Resource values specified this	484	as if it were specified in a resource file. Resource values specified this
…		…
567	=item B<depth:> I<bitdepth>	593	=item B<depth:> I<bitdepth>
568		594
569	Compile I<xft>: Attempt to find a visual with the given bit depth;	595	Compile I<xft>: Attempt to find a visual with the given bit depth;
570	option B<-depth>.	596	option B<-depth>.
571		597
		598	=item B<buffered:> I<boolean>
		599
		600	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		601	On some card/driver combination enabling it slightly decreases
		602	performance, on most it greatly helps it. The slowdown is small, so it
		603	should normally be enabled.
		604
572	=item B<geometry:> I<geom>	605	=item B<geometry:> I<geom>
573		606
574	Create the window with the specified X window geometry [default 80x24];	607	Create the window with the specified X window geometry [default 80x24];
575	option B<-geometry>.	608	option B<-geometry>.
576		609
…		…
589	Use the specified colour for the colour value I<n>, where 0-7	622	Use the specified colour for the colour value I<n>, where 0-7
590	corresponds to low-intensity (normal) colours and 8-15 corresponds to	623	corresponds to low-intensity (normal) colours and 8-15 corresponds to
591	high-intensity (bold = bright foreground, blink = bright background)	624	high-intensity (bold = bright foreground, blink = bright background)
592	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	625	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
593	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	626	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
594	names used are listed in the B<COLORS AND GRAPHICS> section.	627	names used are listed in the B<COLOURS AND GRAPHICS> section.
595		628
596	Colours higher than 15 cannot be set using resources (yet), but can be	629	Colours higher than 15 cannot be set using resources (yet), but can be
597	changed using an escape command (see @@RXVT_NAME@@(7)).	630	changed using an escape command (see @@RXVT_NAME@@(7)).
598		631
599	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	632	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
610	=item B<colorUL:> I<colour>	643	=item B<colorUL:> I<colour>
611		644
612	Use the specified colour to display underlined characters when the	645	Use the specified colour to display underlined characters when the
613	foreground colour is the default.	646	foreground colour is the default.
614		647
615	=item B<colorRV:> I<colour>
616
617	Use the specified colour as the background for reverse video characters
618	when OPTION_HC is disabled (--disable-frills).
619
620	=item B<underlineColor:> I<colour>	648	=item B<underlineColor:> I<colour>
621		649
622	If set, use the specified colour as the colour for the underline	650	If set, use the specified colour as the colour for the underline
623	itself. If unset, use the foreground colour.	651	itself. If unset, use the foreground colour.
		652
		653	=item B<highlightColor:> I<colour>
		654
		655	If set, use the specified colour as the background for highlighted
		656	characters. If unset, use reverse video.
		657
		658	=item B<highlightTextColor:> I<colour>
		659
		660	If set and highlightColor is set, use the specified colour as the
		661	foreground for highlighted characters.
624		662
625	=item B<cursorColor:> I<colour>	663	=item B<cursorColor:> I<colour>
626		664
627	Use the specified colour for the cursor. The default is to use the	665	Use the specified colour for the cursor. The default is to use the
628	foreground colour; option B<-cr>.	666	foreground colour; option B<-cr>.
…		…
635		673
636	=item B<reverseVideo:> I<boolean>	674	=item B<reverseVideo:> I<boolean>
637		675
638	B<True>: simulate reverse video by foreground and background colours;	676	B<True>: simulate reverse video by foreground and background colours;
639	option B<-rv>. B<False>: regular screen colours [default]; option	677	option B<-rv>. B<False>: regular screen colours [default]; option
640	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	678	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
641		679
642	=item B<jumpScroll:> I<boolean>	680	=item B<jumpScroll:> I<boolean>
643		681
644	B<True>: specify that jump scrolling should be used. When receiving lots	682	B<True>: specify that jump scrolling should be used. When receiving lots
645	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines	683	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
…		…
666	Turn on/off illusion of a transparent window background.	704	Turn on/off illusion of a transparent window background.
667		705
668	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in	706	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
669	future versions.	707	future versions.
670		708
671	I<Please address all transparency related issues to Sasha Vasko at
672	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
673
674	=item B<fading:> I<number>	709	=item B<fading:> I<number>
675		710
676	Fade the text by the given percentage when focus is lost; option B<-fade>.	711	Fade the text by the given percentage when focus is lost; option B<-fade>.
677		712
678	=item B<fadeColor:> I<colour>	713	=item B<fadeColor:> I<colour>
…		…
694		729
695	Specify background blending type; option B<-blt>.	730	Specify background blending type; option B<-blt>.
696		731
697	=item B<blurRadius:> I<number>	732	=item B<blurRadius:> I<number>
698		733
699	Apply Gaussian Blurr with the specified radius to the transparent	734	Apply gaussian blur with the specified radius to the transparent
700	background image; option B<-blr>.	735	background image; option B<-blr>.
		736
		737	=item B<iconFile:> I<file>
		738
		739	Set the application icon pixmap; option B<-icon>.
701		740
702	=item B<scrollColor:> I<colour>	741	=item B<scrollColor:> I<colour>
703		742
704	Use the specified colour for the scrollbar [default #B2B2B2].	743	Use the specified colour for the scrollbar [default #B2B2B2].
705		744
…		…
715		754
716	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>	755	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
717		756
718	Use the specified image file for the background and also	757	Use the specified image file for the background and also
719	optionally specify its scaling with a geometry string B<WxH+X+Y>,	758	optionally specify its scaling with a geometry string B<WxH+X+Y>,
720	(default C<0x0+50+50>) in which B<"W" / "H"> specify the	759	(default C<100x100+50+50>) in which B<"W" / "H"> specify the
721	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image	760	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
722	centre (percent). A scale of 0 displays the image with tiling. A scale	761	centre (percent). A scale of 0 displays the image with tiling.
723	of 1 displays the image without any scaling. A scale of 2 to 9 specifies	762	The maximum permitted scale is 1000.
724	an integer number of images in that direction. No image will be magnified
725	beyond 10 times its original size. The maximum permitted scale is 1000.
726	Additional operations can be specified after colon B<:op1:op2...>.	763	Additional operations can be specified after colon B<:op1:op2...>.
727	Supported operations are:	764	Supported operations are:
728		765
729	tile force background image to be tiled and not scaled. Equivalent to 0x0,	766	tile force background image to be tiled and not scaled. Equivalent to 0x0
730	propscale will scale image keeping proportions,	767	propscale will scale image keeping proportions
731	auto will scale image to match window size. Equivalent to 100x100;	768	auto will scale image to match window size. Equivalent to 100x100
732	hscale will scale image horizontally to the window size;	769	hscale will scale image horizontally to the window size
733	vscale will scale image vertically to the window size;	770	vscale will scale image vertically to the window size
734	scale will scale image to match window size;	771	scale will scale image to match window size
735	root will tile image as if it was a root window background, auto-adjusting	772	root will tile image as if it was a root window background, auto-adjusting
736	whenever terminal window moves.	773	whenever terminal window moves
737		774
738	If used in conjunction with B<-tr> option, the specified pixmap will be	775	If used in conjunction with B<-tr> option, the specified pixmap will be
739	blended over transparency image using either alpha-blending, or any	776	blended over transparency image using alpha-blending. If I<afterimage>
740	other blending type, specified with B<-blt "type"> option.	777	support has been compiled in it is possible to choose other blending
		778	types with B<-blt "type"> option.
741		779
742	=item B<path:> I<path>	780	=item B<path:> I<path>
743		781
744	Specify the colon-delimited search path for finding background image files.	782	Specify the colon-delimited search path for finding background image files.
745		783
…		…
772	it is named first) and thus defines the character cell grid to be 9 pixels	810	it is named first) and thus defines the character cell grid to be 9 pixels
773	wide and 15 pixels high.	811	wide and 15 pixels high.
774		812
775	The second font is just used to add additional unicode characters not in	813	The second font is just used to add additional unicode characters not in
776	the base font, likewise the third, which is unfortunately non-bold, but	814	the base font, likewise the third, which is unfortunately non-bold, but
777	the bold version of the font does contain less characters, so this is a	815	the bold version of the font does contain fewer characters, so this is a
778	useful supplement.	816	useful supplement.
779		817
780	The third font is an Xft font with aliasing turned off, and the characters	818	The third font is an Xft font with aliasing turned off, and the characters
781	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	819	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
782	contains other characters, but we are not interested in them.	820	contains other characters, but we are not interested in them.
…		…
811	option B<-is>, the default), bold/blink font styles imply high	849	option B<-is>, the default), bold/blink font styles imply high
812	intensity foreground/background colours. Disabling this option (B<False>,	850	intensity foreground/background colours. Disabling this option (B<False>,
813	option B<+is>) disables this behaviour, the high intensity colours are not	851	option B<+is>) disables this behaviour, the high intensity colours are not
814	reachable.	852	reachable.
815		853
816	=item B<scrollstyle:> I<mode>
817
818	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
819	the author's favourite.
820
821	=item B<title:> I<string>	854	=item B<title:> I<string>
822		855
823	Set window title string, the default title is the command-line	856	Set window title string, the default title is the command-line
824	specified after the B<-e> option, if any, otherwise the application	857	specified after the B<-e> option, if any, otherwise the application
825	name; option B<-title>.	858	name; option B<-title>.
…		…
838	=item B<urgentOnBell:> I<boolean>	871	=item B<urgentOnBell:> I<boolean>
839		872
840	B<True>: set the urgency hint for the wm on receipt of a bell character.	873	B<True>: set the urgency hint for the wm on receipt of a bell character.
841	B<False>: do not set the urgency hint [default].	874	B<False>: do not set the urgency hint [default].
842		875
		876	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		877
843	=item B<visualBell:> I<boolean>	878	=item B<visualBell:> I<boolean>
844		879
845	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	880	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
846	B<False>: no visual bell [default]; option B<+vb>.	881	B<False>: no visual bell [default]; option B<+vb>.
847		882
…		…
869		904
870	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	905	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
871		906
872	This creates a new file in your home directory with the screen contents	907	This creates a new file in your home directory with the screen contents
873	every time you hit C<Print>.	908	every time you hit C<Print>.
		909
		910	=item B<scrollstyle:> I<mode>
		911
		912	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		913	the author's favourite.
874		914
875	=item B<scrollBar:> I<boolean>	915	=item B<scrollBar:> I<boolean>
876		916
877	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	917	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
878	disable the scrollbar; option B<+sb>.	918	disable the scrollbar; option B<+sb>.
…		…
966	=item B<cursorBlink:> I<boolean>	1006	=item B<cursorBlink:> I<boolean>
967		1007
968	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1008	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
969	option B<-bc>.	1009	option B<-bc>.
970		1010
		1011	=item B<cursorUnderline:> I<boolean>
		1012
		1013	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1014	option B<-uc>.
		1015
971	=item B<pointerBlank:> I<boolean>	1016	=item B<pointerBlank:> I<boolean>
972		1017
973	B<True>: blank the pointer when a key is pressed or after a set number	1018	B<True>: blank the pointer when a key is pressed or after a set number
974	of seconds of inactivity. B<False>: the pointer is always visible	1019	of seconds of inactivity. B<False>: the pointer is always visible
975	[default].	1020	[default].
…		…
988	large number (e.g. C<987654321>) to effectively disable the timeout.	1033	large number (e.g. C<987654321>) to effectively disable the timeout.
989		1034
990	=item B<backspacekey:> I<string>	1035	=item B<backspacekey:> I<string>
991		1036
992	The string to send when the backspace key is pressed. If set to B<DEC>	1037	The string to send when the backspace key is pressed. If set to B<DEC>
993	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	1038	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
994	(code 8) - which can be reversed with the appropriate DEC private mode	1039	(code 8) - which can be reversed with the appropriate DEC private mode
995	escape sequence.	1040	escape sequence.
996		1041
997	=item B<deletekey:> I<string>	1042	=item B<deletekey:> I<string>
998		1043
…		…
1077		1122
1078	=item B<secondaryScroll:> I<boolean>	1123	=item B<secondaryScroll:> I<boolean>
1079		1124
1080	Turn on/off secondary screen scroll (default enabled). If this	1125	Turn on/off secondary screen scroll (default enabled). If this
1081	option is enabled, scrolls on the secondary screen will change the	1126	option is enabled, scrolls on the secondary screen will change the
1082	scrollback buffer and switching to/from the secondary screen will	1127	scrollback buffer and, when secondaryScreen is off, switching
1083	instead scroll the screen up.	1128	to/from the secondary screen will instead scroll the screen up.
1084		1129
1085	=item B<hold>: I<boolean>	1130	=item B<hold>: I<boolean>
1086		1131
1087	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1132	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1088	will not immediately destroy its window when the program executed within	1133	will not immediately destroy its window when the program executed within
1089	it exits. Instead, it will wait till it is being killed or closed by the	1134	it exits. Instead, it will wait till it is being killed or closed by the
1090	user.	1135	user.
		1136
		1137	=item B<chdir>: I<path>
		1138
		1139	Sets the working directory for the shell (or the command specified via
		1140	B<-e>). The I<path> must be an absolute path and it must exist for
		1141	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1142	directory will be used; option B<-cd>.
1091		1143
1092	=item B<keysym.>I<sym>: I<string>	1144	=item B<keysym.>I<sym>: I<string>
1093		1145
1094	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1146	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1095	intervening resource name B<keysym.> cannot be omitted.	1147	intervening resource name B<keysym.> cannot be omitted.
…		…
1110	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1162	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1111	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1163	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1112	performed in an exact manner; however, the closest match is assured.	1164	performed in an exact manner; however, the closest match is assured.
1113		1165
1114	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1166	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1115	number), see RESOURCES in C<man 7 X> for futher details.	1167	number), see RESOURCES in C<man 7 X> for further details.
1116		1168
1117	You can define a range of keysyms in one shot by providing a I<string>	1169	You can define a range of keysyms in one shot by providing a I<string>
1118	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1170	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1119	should be a character not used by the strings.	1171	should be a character not used by the strings.
1120		1172
…		…
1134	when Control-Meta-c is being pressed":	1186	when Control-Meta-c is being pressed":
1135		1187
1136	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1188	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1137		1189
1138	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1190	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1139	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1191	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1140	manpage. For example, the F<selection> extension (activated via	1192	manpage. For example, the F<selection> extension (activated via
1141	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1193	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1142		1194
1143	URxvt.keysym.M-C-c: perl:selection:rot13	1195	URxvt.keysym.M-C-c: perl:selection:rot13
1144		1196
1145	Due the the large number of modifier combinations, a defined key mapping	1197	Due the the large number of modifier combinations, a defined key mapping
1146	will match if at I<at least> the specified identifiers are being set, and	1198	will match if I<at least> the specified identifiers are being set, and
1147	no other key mappings with those and more bits are being defined. That	1199	no other key mappings with those and more bits are being defined. That
1148	means that defining a key map for C<a> will automatically provide	1200	means that defining a key map for C<a> will automatically provide
1149	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined	1201	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1150	mappings themselves.	1202	mappings themselves.
1151		1203
…		…
1202	all instances, while B<perl-ext> is used for specific instances.	1254	all instances, while B<perl-ext> is used for specific instances.
1203		1255
1204	=item B<perl-eval>: I<string>	1256	=item B<perl-eval>: I<string>
1205		1257
1206	Perl code to be evaluated when all extensions have been registered. See	1258	Perl code to be evaluated when all extensions have been registered. See
1207	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1259	the @@RXVT_NAME@@perl(3) manpage.
1208	will be ignored when running setuid/setgid.
1209		1260
1210	=item B<perl-lib>: I<path>	1261	=item B<perl-lib>: I<path>
1211		1262
1212	Colon-separated list of additional directories that hold extension	1263	Colon-separated list of additional directories that hold extension
1213	scripts. When looking for extensions specified by the C<perl> resource,	1264	scripts. When looking for extensions specified by the C<perl> resource,
1214	@@RXVT_NAME@@ will first look in these directories and then in	1265	@@RXVT_NAME@@ will first look in these directories and then in
1215	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1266	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1216	will be ignored when running setuid/setgid.
1217		1267
1218	See the @@RXVT_NAME@@perl(3) manpage.	1268	See the @@RXVT_NAME@@perl(3) manpage.
1219		1269
1220	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1270	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1221		1271
…		…
1243		1293
1244	=item B<override-redirect>: I<boolean>	1294	=item B<override-redirect>: I<boolean>
1245		1295
1246	Compile I<frills>: Sets override-redirect for the terminal window, making	1296	Compile I<frills>: Sets override-redirect for the terminal window, making
1247	it almost invisible to window managers; option B<-override-redirect>.	1297	it almost invisible to window managers; option B<-override-redirect>.
		1298
		1299	=item B<iso14755:> I<boolean>
		1300
		1301	Turn on/off ISO 14755 (default enabled).
1248		1302
1249	=item B<iso14755_52:> I<boolean>	1303	=item B<iso14755_52:> I<boolean>
1250		1304
1251	Turn on/off ISO 14755 5.2 mode (default enabled).	1305	Turn on/off ISO 14755 5.2 mode (default enabled).
1252		1306
…		…
1395	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1449	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1396	it can be seen via the I<who(1)> command, and can accept messages. To	1450	it can be seen via the I<who(1)> command, and can accept messages. To
1397	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1451	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1398	on some systems or setgid to root or to some other group on others.	1452	on some systems or setgid to root or to some other group on others.
1399		1453
1400	=head1 COLORS AND GRAPHICS	1454	=head1 COLOURS AND GRAPHICS
1401		1455
1402	In addition to the default foreground and background colours,	1456	In addition to the default foreground and background colours,
1403	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1457	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1404	high-intensity bold/blink versions of the same). Here is a list of the	1458	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1405	colours with their names.	1459	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1460	cube plus a 8 (24) colour greyscale ramp.
		1461
		1462	Here is a list of the ANSI colours with their names.
1406		1463
1407	=begin table	1464	=begin table
1408		1465
1409	B<color0> (black) = Black	1466	B<color0> (black) = Black
1410	B<color1> (red) = Red3	1467	B<color1> (red) = Red3
…		…
1430	It is also possible to specify the colour values of B<foreground>,	1487	It is also possible to specify the colour values of B<foreground>,
1431	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1488	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1432	a number 0-15, as a convenient shorthand to reference the colour name of	1489	a number 0-15, as a convenient shorthand to reference the colour name of
1433	color0-color15.	1490	color0-color15.
1434		1491
1435	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1492	The following text gives values for the standard 88 colour mode (and
1436	additional 72 colours. The first 64 of those (with indices 16 to 79)	1493	values for the 256 colour mode in parentheses).
1437	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1438	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1439		1494
		1495	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1496
		1497	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1498	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1499
		1500	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1501	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1502	the RGB cube.
		1503
1440	Together, all those colours implement the 88 colour xterm colours. Only	1504	Together, all those colours implement the 88 (256) colour xterm
1441	the first 16 can be changed using resources currently, the rest can only	1505	colours. Only the first 16 can be changed using resources currently, the
1442	be changed via command sequences ("escape codes").	1506	rest can only be changed via command sequences ("escape codes").
		1507
		1508	Applications are advised to use terminfo or command sequences to discover
		1509	number and RGB values of all colours (yes, you can query this...).
1443		1510
1444	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1511	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1445	always swapping the foreground/background colours. This is in contrast to	1512	always swapping the foreground/background colours. This is in contrast to
1446	I<xterm>(1) where the colours are only swapped if they have not otherwise	1513	I<xterm>(1) where the colours are only swapped if they have not otherwise
1447	been specified. For example,	1514	been specified. For example,
1448		1515
1449	=over 4
1450
1451	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1516	@@RXVT_NAME@@ -fg Black -bg White -rv
1452		1517
1453	would yield White on Black, while on I<xterm>(1) it would yield Black	1518	would yield White on Black, while on I<xterm>(1) it would yield Black on
1454	on White.	1519	White.
1455
1456	=back
1457		1520
1458	=head2 ALPHA CHANNEL SUPPORT	1521	=head2 ALPHA CHANNEL SUPPORT
1459		1522
1460	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1523	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1461	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1524	their act together, rxvt-unicode will do it's own alpha channel management:
1462	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1525
1463	in addition to the ones provided by X, where the additional A component	1526	You can prefix any colour with an opaqueness percentage enclosed in
		1527	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1528	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1529	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1530	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1531	is the recommended format to specify transparency values, and works with
		1532	all ways to specify a colour.
		1533
		1534	For complete control, rxvt-unicode also supports
		1535	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1536	specifications, where the additional C<aaaa> component specifies opacity
1464	specifies opacity (alpha) values. The minimum value of C<0> is completely	1537	(alpha) values. The minimum value of C<0000> is completely transparent,
1465	transparent). You can also prefix any color with C<[percent]>, where	1538	while C<ffff> is completely opaque). The two example colours from
1466	C<percent> is a decimal percentage (0-100) that specifies the opacity of	1539	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1467	the color, where C<0> is completely transparent and C<100> is completelxy	1540	C<rgba:0000/ff00/0000/f332>.
1468	opaque.
1469		1541
1470	You probably need to specify B<"-depth 32">, too, and have the luck that	1542	You probably need to specify B<"-depth 32">, too, to force a visual with
1471	your X-server uses ARGB pixel layout, as X is far from just supporting	1543	alpha channels, and have the luck that your X-server uses ARGB pixel
1472	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1544	layout, as X is far from just supporting ARGB visuals out of the box, and
		1545	rxvt-unicode just fudges around.
1473		1546
1474	For example, the following selects an almost completely transparent red	1547	For example, the following selects an almost completely transparent black
1475	background, and an almost opaque pink foreground:	1548	background, and an almost opaque pink foreground:
1476		1549
1477	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1550	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1478		1551
1479	I<Please note that transparency of any kind if completely unsupported by	1552	When not using a background image, then the interpretation of the
1480	the author. Don't bug him with installation questions!>	1553	alpha channel is up to your compositing manager (most interpret it as
		1554	transparency of course).
		1555
		1556	When using a background pixmap or pseudo-transparency, then the background
		1557	colour will always behave as if it were completely transparent (so the
		1558	background image shows instead), regardless of how it was specified, while
		1559	other colours will either be transparent as specified (the background
		1560	image will show through) on servers supporting the RENDER extension, or
		1561	fully opaque on servers not supporting the RENDER EXTENSION.
		1562
		1563	Please note that due to bugs in Xft, specifying alpha values might result
		1564	in garbage being displayed when the X-server does not support the RENDER
		1565	extension.
1481		1566
1482	=head1 ENVIRONMENT	1567	=head1 ENVIRONMENT
1483		1568
1484	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1569	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1485		1570
…		…
1519	C<--with-terminfo=PATH>.	1604	C<--with-terminfo=PATH>.
1520		1605
1521	=item B<DISPLAY>	1606	=item B<DISPLAY>
1522		1607
1523	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1608	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1524	display in its child processes.	1609	display in its child processes if C<-display> isn't used to override. It
		1610	defaults to C<:0> if it doesn't exist.
1525		1611
1526	=item B<SHELL>	1612	=item B<SHELL>
1527		1613
1528	The shell to be used for command execution, defaults to C</bin/sh>.	1614	The shell to be used for command execution, defaults to C</bin/sh>.
1529		1615
…		…
1555		1641
1556	=over 4	1642	=over 4
1557		1643
1558	=item B</usr/lib/X11/rgb.txt>	1644	=item B</usr/lib/X11/rgb.txt>
1559		1645
1560	Color names.	1646	Colour names.
1561		1647
1562	=back	1648	=back
1563		1649
1564	=head1 SEE ALSO	1650	=head1 SEE ALSO
1565		1651

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.155 by ayin, Mon Dec 17 23:52:44 2007 UTC vs. Revision 1.187 by sf-exg, Fri Oct 15 10:46:57 2010 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.155 by ayin, Mon Dec 17 23:52:44 2007 UTC vs.
Revision 1.187 by sf-exg, Fri Oct 15 10:46:57 2010 UTC