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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.157 by ayin, Sat Jan 19 16:20:09 2008 UTC vs.
Revision 1.244 by sf-exg, Tue Jun 16 11:58:26 2015 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<frills>: 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
		111	=item B<-visual> I<visualID>
		112
		113	Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for
		114	possible visual ids) instead of the default, and also allocate a private
		115	colormap. All visual types except for DirectColor are supported.
		116
106	=item B<-geometry> I<geom>	117	=item B<-geometry> I<geom>
107		118
108	Window geometry (B<-g> still respected); resource B<geometry>.	119	Window geometry (B<-g> still respected); resource B<geometry>.
109		120
110	=item B<-rv>\|B<+rv>	121	=item B<-rv>\|B<+rv>
…		…
116	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.	127	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
117		128
118	=item B<-ss>\|B<+ss>	129	=item B<-ss>\|B<+ss>
119		130
120	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.	131	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
121
122	=item B<-tr>\|B<+tr>
123
124	Turn on/off illusion of a transparent window background; resource B<transparent>.
125
126	B<-ip> is still accepted as an obsolete alias but will be removed in
127	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		132
132	=item B<-fade> I<number>	133	=item B<-fade> I<number>
133		134
134	Fade the text by the given percentage when focus is lost. Small values	135	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	136	fade a little only, 100 completely replaces all colours by the fade
…		…
138	=item B<-fadecolor> I<colour>	139	=item B<-fadecolor> I<colour>
139		140
140	Fade to this colour when fading is used (see B<-fade>). The default colour	141	Fade to this colour when fading is used (see B<-fade>). The default colour
141	is opaque black. resource B<fadeColor>.	142	is opaque black. resource B<fadeColor>.
142		143
143	=item B<-tint> I<colour>	144	=item B<-icon> I<file>
144		145
145	Tint the transparent background pixmap with the given colour when	146	Compile I<pixbuf>: Use the specified image as application icon. This
146	transparency is enabled with B<-tr>. This only works for	147	is used by many window managers, taskbars and pagers to represent the
147	non-tiled backgrounds, currently. See also the B<-sh> option that can be	148	application window; resource I<iconFile>.
148	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,
150	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
152	pure black and pure white colors essentially mean no tinting; resource
153	I<tintColor>. Example:
154
155	@@RXVT_NAME@@ -tr -tint blue -sh 40
156
157	=item B<-sh> I<number>
158
159	Darken (0 .. 100) or lighten (100 .. 200) the transparent
160	background image in addition to (or instead of) tinting it;
161	resource I<shading>.
162
163	=item B<-blt> I<string>
164
165	Specify background blending type. If background pixmap is specified
166	at the same time as transparency - such pixmap will be blended over
167	transparency image, using method specified. Supported values are :
168	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
169	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
171	alpha-blending. Compile I<afterimage>; resource I<blendType>.
172
173	=item B<-blr> I<HxV>
174
175	Apply Gaussian Blur with the specified radii to the transparent
176	background image. If single number is specified - both vertical and
177	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
179	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
180	resource I<blurRadius>.
181		149
182	=item B<-bg> I<colour>	150	=item B<-bg> I<colour>
183		151
184	Window background colour; resource B<background>.	152	Window background colour; resource B<background>.
185		153
186	=item B<-fg> I<colour>	154	=item B<-fg> I<colour>
187		155
188	Window foreground colour; resource B<foreground>.	156	Window foreground colour; resource B<foreground>.
189
190	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
191
192	Compile I<afterimage>: Specify image file for the background and also
193	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
195	command-line; for more details see resource B<backgroundPixmap>.
196		157
197	=item B<-cr> I<colour>	158	=item B<-cr> I<colour>
198		159
199	The cursor colour; resource B<cursorColor>.	160	The cursor colour; resource B<cursorColor>.
200		161
…		…
259		220
260	=item B<-ls>\|B<+ls>	221	=item B<-ls>\|B<+ls>
261		222
262	Start as a login-shell/sub-shell; resource B<loginShell>.	223	Start as a login-shell/sub-shell; resource B<loginShell>.
263		224
		225	=item B<-mc> I<milliseconds>
		226
		227	Specify the maximum time between multi-click selections.
		228
264	=item B<-ut>\|B<+ut>	229	=item B<-ut>\|B<+ut>
265		230
266	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource	231	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
267	B<utmpInhibit>.	232	B<utmpInhibit>.
268		233
…		…
310		275
311	=item B<-bc>\|B<+bc>	276	=item B<-bc>\|B<+bc>
312		277
313	Blink the cursor; resource B<cursorBlink>.	278	Blink the cursor; resource B<cursorBlink>.
314		279
		280	=item B<-uc>\|B<+uc>
		281
		282	Make the cursor underlined; resource B<cursorUnderline>.
		283
315	=item B<-iconic>	284	=item B<-iconic>
316		285
317	Start iconified, if the window manager supports that option.	286	Start iconified, if the window manager supports that option.
318	Alternative form is B<-ic>.	287	Alternative form is B<-ic>.
319		288
…		…
335		304
336	=item B<-bl>	305	=item B<-bl>
337		306
338	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	307	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	308	if honoured by the WM, the rxvt-unicode window will not have window
340	decorations; resource B<borderLess>.	309	decorations; resource B<borderLess>. If the window manager does not
		310	support MWM hints (e.g. kwin), enables override-redirect mode.
341		311
342	=item B<-override-redirect>	312	=item B<-override-redirect>
343		313
344	Compile I<frills>: Sets override-redirect on the window; resource	314	Compile I<frills>: Sets override-redirect on the window; resource
345	B<override-redirect>.	315	B<override-redirect>.
		316
		317	=item B<-dockapp>
		318
		319	Sets the initial state of the window to WithdrawnState, which makes
		320	window managers that support this extension treat it as a dockapp.
346		321
347	=item B<-sbg>	322	=item B<-sbg>
348		323
349	Compile I<frills>: Disable the usage of the built-in block graphics/line	324	Compile I<frills>: Disable the usage of the built-in block graphics/line
350	drawing characters and just rely on what the specified fonts provide. Use	325	drawing characters and just rely on what the specified fonts provide. Use
…		…
354	=item B<-lsp> I<number>	329	=item B<-lsp> I<number>
355		330
356	Compile I<frills>: Lines (pixel height) to insert between each row of	331	Compile I<frills>: Lines (pixel height) to insert between each row of
357	the display. Useful to work around font rendering problems; resource	332	the display. Useful to work around font rendering problems; resource
358	B<lineSpace>.	333	B<lineSpace>.
		334
		335	=item B<-letsp> I<number>
		336
		337	Compile I<frills>: Amount to adjust the computed character width by
		338	to control overall letter spacing. Negative values will tighten up the
		339	letter spacing, positive values will space letters out more. Useful to
		340	work around odd font metrics; resource B<letterSpace>.
359		341
360	=item B<-tn> I<termname>	342	=item B<-tn> I<termname>
361		343
362	This option specifies the name of the terminal type to be set in the	344	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	345	B<TERM> environment variable. This terminal type must exist in the
…		…
398	=item B<-pt> I<style>	380	=item B<-pt> I<style>
399		381
400	Compile I<XIM>: input style for input method; B<OverTheSpot>,	382	Compile I<XIM>: input style for input method; B<OverTheSpot>,
401	B<OffTheSpot>, B<Root>; resource B<preeditType>.	383	B<OffTheSpot>, B<Root>; resource B<preeditType>.
402		384
		385	If the perl extension C<xim-onthespot> is used (which is the default),
		386	then additionally the C<OnTheSpot> preedit type is available.
		387
403	=item B<-im> I<text>	388	=item B<-im> I<text>
404		389
405	Compile I<XIM>: input method name. resource B<inputMethod>.	390	Compile I<XIM>: input method name. resource B<inputMethod>.
406		391
407	=item B<-imlocale> I<string>	392	=item B<-imlocale> I<string>
…		…
449		434
450	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	435	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
451	will not immediately destroy its window when the program executed within	436	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	437	it exits. Instead, it will wait till it is being killed or closed by the
453	user; resource B<hold>.	438	user; resource B<hold>.
		439
		440	=item B<-cd> I<path>
		441
		442	Sets the working directory for the shell (or the command specified via
		443	B<-e>). The I<path> must be an absolute path and it must exist for
		444	@@RXVT_NAME@@ to start; resource B<chdir>.
454		445
455	=item B<-xrm> I<string>	446	=item B<-xrm> I<string>
456		447
457	Works like the X Toolkit option of the same name, by adding the I<string>	448	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	449	as if it were specified in a resource file. Resource values specified this
…		…
542	You can set and change the resources using X11 tools like B<xrdb>. Many	533	You can set and change the resources using X11 tools like B<xrdb>. Many
543	distribution do also load settings from the B<~/.Xresources> file when X	534	distribution do also load settings from the B<~/.Xresources> file when X
544	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	535	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
545	with later settings overwriting earlier ones:	536	with later settings overwriting earlier ones:
546		537
547	1. system-wide app-defaults file, either locale-dependent OR global
548	2. app-defaults file in $XAPPLRESDIR	538	1. app-defaults file in $XAPPLRESDIR
		539	2. $HOME/.Xdefaults
549	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	540	3. RESOURCE_MANAGER property on root-window of screen 0
550	4. SCREEN_RESOURCES for the current screen	541	4. SCREEN_RESOURCES property on root-window of the current screen
551	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	542	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
552	6. resources specified via -xrm on the commandline	543	6. resources specified via -xrm on the commandline
553		544
554	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	545	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
555	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	546	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
…		…
567	=item B<depth:> I<bitdepth>	558	=item B<depth:> I<bitdepth>
568		559
569	Compile I<xft>: Attempt to find a visual with the given bit depth;	560	Compile I<xft>: Attempt to find a visual with the given bit depth;
570	option B<-depth>.	561	option B<-depth>.
571		562
		563	=item B<buffered:> I<boolean>
		564
		565	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		566	On some card/driver combination enabling it slightly decreases
		567	performance, on most it greatly helps it. The slowdown is small, so it
		568	should normally be enabled.
		569
572	=item B<geometry:> I<geom>	570	=item B<geometry:> I<geom>
573		571
574	Create the window with the specified X window geometry [default 80x24];	572	Create the window with the specified X window geometry [default 80x24];
575	option B<-geometry>.	573	option B<-geometry>.
576		574
…		…
589	Use the specified colour for the colour value I<n>, where 0-7	587	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	588	corresponds to low-intensity (normal) colours and 8-15 corresponds to
591	high-intensity (bold = bright foreground, blink = bright background)	589	high-intensity (bold = bright foreground, blink = bright background)
592	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	590	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	591	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.	592	names used are listed in the B<COLOURS AND GRAPHICS> section.
595		593
596	Colours higher than 15 cannot be set using resources (yet), but can be	594	Colours higher than 15 cannot be set using resources (yet), but can be
597	changed using an escape command (see @@RXVT_NAME@@(7)).	595	changed using an escape command (see @@RXVT_NAME@@(7)).
598		596
599	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	597	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
610	=item B<colorUL:> I<colour>	608	=item B<colorUL:> I<colour>
611		609
612	Use the specified colour to display underlined characters when the	610	Use the specified colour to display underlined characters when the
613	foreground colour is the default.	611	foreground colour is the default.
614		612
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>	613	=item B<underlineColor:> I<colour>
621		614
622	If set, use the specified colour as the colour for the underline	615	If set, use the specified colour as the colour for the underline
623	itself. If unset, use the foreground colour.	616	itself. If unset, use the foreground colour.
		617
		618	=item B<highlightColor:> I<colour>
		619
		620	If set, use the specified colour as the background for highlighted
		621	characters. If unset, use reverse video.
		622
		623	=item B<highlightTextColor:> I<colour>
		624
		625	If set and highlightColor is set, use the specified colour as the
		626	foreground for highlighted characters.
624		627
625	=item B<cursorColor:> I<colour>	628	=item B<cursorColor:> I<colour>
626		629
627	Use the specified colour for the cursor. The default is to use the	630	Use the specified colour for the cursor. The default is to use the
628	foreground colour; option B<-cr>.	631	foreground colour; option B<-cr>.
…		…
635		638
636	=item B<reverseVideo:> I<boolean>	639	=item B<reverseVideo:> I<boolean>
637		640
638	B<True>: simulate reverse video by foreground and background colours;	641	B<True>: simulate reverse video by foreground and background colours;
639	option B<-rv>. B<False>: regular screen colours [default]; option	642	option B<-rv>. B<False>: regular screen colours [default]; option
640	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	643	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
641		644
642	=item B<jumpScroll:> I<boolean>	645	=item B<jumpScroll:> I<boolean>
643		646
644	B<True>: specify that jump scrolling should be used. When receiving lots	647	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	648	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
…		…
659		662
660	B<False>: specify that everything is to be displayed, even	663	B<False>: specify that everything is to be displayed, even
661	if the refresh is too fast for the human eye to read anything (or the	664	if the refresh is too fast for the human eye to read anything (or the
662	monitor to display anything); option B<+ss>.	665	monitor to display anything); option B<+ss>.
663		666
664	=item B<transparent:> I<boolean>
665
666	Turn on/off illusion of a transparent window background.
667
668	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
669	future versions.
670
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>	667	=item B<fading:> I<number>
675		668
676	Fade the text by the given percentage when focus is lost; option B<-fade>.	669	Fade the text by the given percentage when focus is lost; option B<-fade>.
677		670
678	=item B<fadeColor:> I<colour>	671	=item B<fadeColor:> I<colour>
679		672
680	Fade to this colour, when fading is used (see B<fading:>). The default	673	Fade to this colour, when fading is used (see B<fading:>). The default
681	colour is black; option B<-fadecolor>.	674	colour is black; option B<-fadecolor>.
682		675
683	=item B<tintColor:> I<colour>	676	=item B<iconFile:> I<file>
684		677
685	Tint the transparent background pixmap with the given colour; option	678	Set the application icon pixmap; option B<-icon>.
686	B<-tint>.
687
688	=item B<shading:> I<number>
689
690	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
691	in addition to tinting it; option B<-sh>.
692
693	=item B<blendType:> I<string>
694
695	Specify background blending type; option B<-blt>.
696
697	=item B<blurRadius:> I<number>
698
699	Apply Gaussian Blurr with the specified radius to the transparent
700	background image; option B<-blr>.
701		679
702	=item B<scrollColor:> I<colour>	680	=item B<scrollColor:> I<colour>
703		681
704	Use the specified colour for the scrollbar [default #B2B2B2].	682	Use the specified colour for the scrollbar [default #B2B2B2].
705		683
…		…
710		688
711	=item B<borderColor:> I<colour>	689	=item B<borderColor:> I<colour>
712		690
713	The colour of the border around the text area and between the scrollbar	691	The colour of the border around the text area and between the scrollbar
714	and the text.	692	and the text.
715
716	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
717
718	Use the specified image file for the background and also
719	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
721	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
723	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
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...>.
727	Supported operations are:
728
729	tile force background image to be tiled and not scaled. Equivalent to 0x0
730	propscale will scale image keeping proportions
731	auto will scale image to match window size. Equivalent to 100x100
732	hscale will scale image horizontally to the window size
733	vscale will scale image vertically to the window size
734	scale will scale image to match window size
735	root will tile image as if it was a root window background, auto-adjusting
736	whenever terminal window moves
737
738	If used in conjunction with B<-tr> option, the specified pixmap will be
739	blended over transparency image using either alpha-blending, or any
740	other blending type, specified with B<-blt "type"> option.
741
742	=item B<path:> I<path>
743
744	Specify the colon-delimited search path for finding background image files.
745		693
746	=item B<font:> I<fontlist>	694	=item B<font:> I<fontlist>
747		695
748	Select the fonts to be used. This is a comma separated list of font names	696	Select the fonts to be used. This is a comma separated list of font names
749	that are checked in order when trying to find glyphs for characters. The	697	that are checked in order when trying to find glyphs for characters. The
…		…
772	it is named first) and thus defines the character cell grid to be 9 pixels	720	it is named first) and thus defines the character cell grid to be 9 pixels
773	wide and 15 pixels high.	721	wide and 15 pixels high.
774		722
775	The second font is just used to add additional unicode characters not in	723	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	724	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	725	the bold version of the font does contain fewer characters, so this is a
778	useful supplement.	726	useful supplement.
779		727
780	The third font is an Xft font with aliasing turned off, and the characters	728	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	729	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.	730	contains other characters, but we are not interested in them.
…		…
833	=item B<urgentOnBell:> I<boolean>	781	=item B<urgentOnBell:> I<boolean>
834		782
835	B<True>: set the urgency hint for the wm on receipt of a bell character.	783	B<True>: set the urgency hint for the wm on receipt of a bell character.
836	B<False>: do not set the urgency hint [default].	784	B<False>: do not set the urgency hint [default].
837		785
		786	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		787
838	=item B<visualBell:> I<boolean>	788	=item B<visualBell:> I<boolean>
839		789
840	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	790	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
841	B<False>: no visual bell [default]; option B<+vb>.	791	B<False>: no visual bell [default]; option B<+vb>.
842		792
…		…
844		794
845	B<True>: start as a login shell by prepending a `-' to B<argv[0]> of	795	B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
846	the shell; option B<-ls>. B<False>: start as a normal sub-shell	796	the shell; option B<-ls>. B<False>: start as a normal sub-shell
847	[default]; option B<+ls>.	797	[default]; option B<+ls>.
848		798
		799	=item B<multiClickTime:> I<number>
		800
		801	Specify the maximum time in milliseconds between multi-click select
		802	events. The default is 500 milliseconds; option B<-mc>.
		803
849	=item B<utmpInhibit:> I<boolean>	804	=item B<utmpInhibit:> I<boolean>
850		805
851	B<True>: inhibit writing record into the system log file B<utmp>;	806	B<True>: inhibit writing record into the system log file B<utmp>;
852	option B<-ut>. B<False>: write record into the system log file B<utmp>	807	option B<-ut>. B<False>: write record into the system log file B<utmp>
853	[default]; option B<+ut>.	808	[default]; option B<+ut>.
…		…
870	=item B<scrollstyle:> I<mode>	825	=item B<scrollstyle:> I<mode>
871		826
872	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	827	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
873	the author's favourite.	828	the author's favourite.
874		829
		830	=item B<thickness:> I<number>
		831
		832	Set the scrollbar width in pixels.
		833
875	=item B<scrollBar:> I<boolean>	834	=item B<scrollBar:> I<boolean>
876		835
877	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	836	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
878	disable the scrollbar; option B<+sb>.	837	disable the scrollbar; option B<+sb>.
879		838
…		…
898	B<False>: do not scroll to bottom when tty receives output; option	857	B<False>: do not scroll to bottom when tty receives output; option
899	B<+si>.	858	B<+si>.
900		859
901	=item B<scrollWithBuffer:> I<boolean>	860	=item B<scrollWithBuffer:> I<boolean>
902		861
903	B<True>: scroll with scrollback buffer when tty receives new lines (and	862	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
904	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	863	try to show the same lines) and B<scrollTtyOutput> is False; option
905	with scrollback buffer when tty receives new lines; option B<+sw>.	864	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		865	new lines; option B<+sw>.
906		866
907	=item B<scrollTtyKeypress:> I<boolean>	867	=item B<scrollTtyKeypress:> I<boolean>
908		868
909	B<True>: scroll to bottom when a non-special key is pressed. Special keys	869	B<True>: scroll to bottom when a non-special key is pressed. Special keys
910	are those which are intercepted by rxvt-unicode for special handling and	870	are those which are intercepted by rxvt-unicode for special handling and
…		…
966	=item B<cursorBlink:> I<boolean>	926	=item B<cursorBlink:> I<boolean>
967		927
968	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	928	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
969	option B<-bc>.	929	option B<-bc>.
970		930
		931	=item B<cursorUnderline:> I<boolean>
		932
		933	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		934	option B<-uc>.
		935
971	=item B<pointerBlank:> I<boolean>	936	=item B<pointerBlank:> I<boolean>
972		937
973	B<True>: blank the pointer when a key is pressed or after a set number	938	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	939	of seconds of inactivity. B<False>: the pointer is always visible
975	[default].	940	[default].
…		…
980		945
981	=item B<pointerColor2:> I<colour>	946	=item B<pointerColor2:> I<colour>
982		947
983	Mouse pointer background colour.	948	Mouse pointer background colour.
984		949
		950	=item B<pointerShape:> I<string>
		951
		952	Compile I<frills>: Specifies the name of the mouse pointer shape
		953	[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
		954	file for possible values (omit the C<XC_> prefix).
		955
985	=item B<pointerBlankDelay:> I<number>	956	=item B<pointerBlankDelay:> I<number>
986		957
987	Specifies number of seconds before blanking the pointer [default 2]. Use a	958	Specifies number of seconds before blanking the pointer [default 2]. Use a
988	large number (e.g. C<987654321>) to effectively disable the timeout.	959	large number (e.g. C<987654321>) to effectively disable the timeout.
989		960
990	=item B<backspacekey:> I<string>	961	=item B<backspacekey:> I<string>
991		962
992	The string to send when the backspace key is pressed. If set to B<DEC>	963	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>	964	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	965	(code 8) - which can be reversed with the appropriate DEC private mode
995	escape sequence.	966	escape sequence.
996		967
997	=item B<deletekey:> I<string>	968	=item B<deletekey:> I<string>
998		969
…		…
1015		986
1016	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>	987	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
1017		988
1018	=item B<preeditType:> I<style>	989	=item B<preeditType:> I<style>
1019		990
1020	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	991	B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1021		992
1022	=item B<inputMethod:> I<name>	993	=item B<inputMethod:> I<name>
1023		994
1024	I<name> of inputMethod to use; option B<-im>.	995	I<name> of inputMethod to use; option B<-im>.
1025		996
…		…
1077		1048
1078	=item B<secondaryScroll:> I<boolean>	1049	=item B<secondaryScroll:> I<boolean>
1079		1050
1080	Turn on/off secondary screen scroll (default enabled). If this	1051	Turn on/off secondary screen scroll (default enabled). If this
1081	option is enabled, scrolls on the secondary screen will change the	1052	option is enabled, scrolls on the secondary screen will change the
1082	scrollback buffer and switching to/from the secondary screen will	1053	scrollback buffer and, when secondaryScreen is off, switching
1083	instead scroll the screen up.	1054	to/from the secondary screen will instead scroll the screen up.
1084		1055
1085	=item B<hold>: I<boolean>	1056	=item B<hold>: I<boolean>
1086		1057
1087	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1058	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1088	will not immediately destroy its window when the program executed within	1059	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	1060	it exits. Instead, it will wait till it is being killed or closed by the
1090	user.	1061	user.
1091		1062
		1063	=item B<chdir>: I<path>
		1064
		1065	Sets the working directory for the shell (or the command specified via
		1066	B<-e>). The I<path> must be an absolute path and it must exist for
		1067	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1068	directory will be used; option B<-cd>.
		1069
1092	=item B<keysym.>I<sym>: I<string>	1070	=item B<keysym.>I<sym>: I<action>
1093		1071
1094	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1072	Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1095	intervening resource name B<keysym.> cannot be omitted.	1073	resource name B<keysym.> cannot be omitted.
1096		1074
1097	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be	1075	Using this resource, you can map key combinations such as
1098	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,	1076	C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1099	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,	1077	string than would normally result from that combination, making the
1100	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,	1078	terminal scroll up or down the way you want it, or any other thing an
1101	B<2>, B<3>, B<4>, B<5>.	1079	extension might provide.
		1080
		1081	The key combination that triggers the action, I<sym>, has the following format:
		1082
		1083	(modifiers-)key
		1084
		1085	Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
		1086	B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
		1087	B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
		1088	B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
1102		1089
1103	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to	1090	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1104	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr	1091	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1105	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the	1092	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1106	current application keymap mode state.	1093	current application keymap mode state.
1107		1094
1108	The spellings of I<key> can be obtained by using B<xev>(1) command or	1095	Due the the large number of modifier combinations, a key mapping will
1109	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1096	match if I<at least> the specified identifiers are being set, and no other
		1097	key mappings with those and more bits are being defined. That means that
		1098	defining a mapping for C<a> will automatically provide definitions for
		1099	C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
		1100	themselves. See the C<builtin:> action, below, for a way to work around
		1101	this when this is a problem.
		1102
		1103	The spelling of I<key> depends on your implementation of X. An easy way to
		1104	find a key name is to use the B<xev>(1) command. You can find a list by
		1105	looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1110	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1106	the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1111	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1107	value (B<0x0000 - 0xFFFF>).
1112	performed in an exact manner; however, the closest match is assured.
1113		1108
1114	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1109	As with any resource value, the I<action> string may contain backslash
		1110	escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1115	number), see RESOURCES in C<man 7 X> for futher details.	1111	number), see RESOURCES in C<man 7 X> for further details.
1116		1112
1117	You can define a range of keysyms in one shot by providing a I<string>	1113	An action starts with an action prefix that selects a certain type
1118	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1114	of action, followed by a colon. An action string without colons is
		1115	interpreted as a literal string to pass to the tty (as if it was
		1116	prefixed with C<string:>).
		1117
		1118	The following action prefixes are known - extensions can provide
		1119	additional prefixes:
		1120
		1121	=over 4
		1122
		1123	=item string:STRING
		1124
		1125	If the I<action> starts with C<string:> (or otherwise contains no colons),
		1126	then the remaining C<STRING> will be passed to the program running in the
		1127	terminal. For example, you could replace whatever Shift-Tab outputs by the
		1128	string C<echo rm -rf /> followed by a newline:
		1129
		1130	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
		1131
		1132	This could in theory be used to completely redefine your keymap.
		1133
		1134	In addition, for actions of this type, you can define a range of
		1135	keysyms in one shot by loading the C<keysym-list> perl extension and
		1136	providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1119	should be a character not used by the strings.	1137	the delimiter `/' should be a character not used by the strings.
1120		1138
1121	Its usage can be demonstrated by an example:	1139	Its usage can be demonstrated by an example:
1122		1140
1123	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1141	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1124		1142
1125	The above line is equivalent to the following three lines:	1143	The above line is equivalent to the following three lines:
1126		1144
1127	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1145	URxvt.keysym.Meta-Control-0x61: string:\033<a>
1128	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1146	URxvt.keysym.Meta-Control-0x62: string:\033<b>
1129	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1147	URxvt.keysym.Meta-Control-0x63: string:\033<c>
1130		1148
		1149	=item command:STRING
		1150
1131	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1151	If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1132	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1152	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
		1153	the opposite of C<string:> - instead of sending it to the program running
		1154	in the terminal, it will be treated as if it were program output). This is
		1155	most useful to feed command sequences into @@RXVT_NAME@@.
		1156
1133	example the following means "change the current locale to C<zh_CN.GBK>	1157	For example the following means "change the current locale to C<zh_CN.GBK>
1134	when Control-Meta-c is being pressed":	1158	when Control-Meta-c is being pressed":
1135		1159
1136	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1160	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1137		1161
1138	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1162	The following example will map Control-Meta-1 and Control-Meta-2 to
1139	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1163	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1140	manpage. For example, the F<selection> extension (activated via	1164	font-switching at runtime:
1141	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1142		1165
1143	URxvt.keysym.M-C-c: perl:selection:rot13	1166	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1167	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1144		1168
1145	Due the the large number of modifier combinations, a defined key mapping	1169	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1146	will match if at I<at least> the specified identifiers are being set, and	1170	info):
1147	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
1149	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1150	mappings themselves.
1151		1171
1152	Unfortunately, this will override built-in key mappings. For example	1172	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1173	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1174
		1175	=item builtin:
		1176
		1177	The builtin action is the action that @@RXVT_NAME@@ would execute if no
		1178	key binding existed for the key combination. The obvious use is to undo
		1179	the effect of existing bindings. The not so obvious use is to reinstate
		1180	bindings when another binding overrides too many modifiers.
		1181
1153	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s	1182	For example if you overwrite the C<Insert> key you will disable
1154	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the	1183	@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1155	user-defined keymap using the C<builtin:> replacement:	1184	"holes" into the user-defined keymap using the C<builtin:> replacement:
1156		1185
1157	URxvt.keysym.Insert: <my insert key sequence>	1186	URxvt.keysym.Insert: <my insert key sequence>
1158	URxvt.keysym.S-Insert: builtin:	1187	URxvt.keysym.S-Insert: builtin:
1159		1188
1160	The first line defines a mapping for C<Insert> and I<any> combination	1189	The first line defines a mapping for C<Insert> and I<any> combination
1161	of modifiers. The second line re-establishes the default mapping for	1190	of modifiers. The second line re-establishes the default mapping for
1162	C<Shift-Insert>.	1191	C<Shift-Insert>.
1163		1192
1164	The following example will map Control-Meta-1 and Control-Meta-2 to	1193	=item builtin-string:
1165	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1166	font-switching at runtime:
1167		1194
1168	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1195	This action is mainly useful to restore string mappings for keys that
1169	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007	1196	have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
		1197	difficult to explain - basically, this action will send the string to the
		1198	application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
		1199	action for it.
1170		1200
1171	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1201	An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1172	info):	1202	selection when you press C<Shift-Insert>. With the following bindings, it
		1203	would instead emit the (undocumented, but what applications running in the
		1204	terminal might expect) sequence C<ESC [ 2 $> instead:
1173		1205
1174	URxvt.keysym.M-C-3: command:\033[8;25;80t	1206	URxvt.keysym.S-Insert: builtin-string:
1175	URxvt.keysym.M-C-4: command:\033[8;48;110t	1207	URxvt.keysym.C-S-Insert: builtin:
		1208
		1209	The first line disables the paste functionality for that key
		1210	combination, and the second reinstates the default behaviour for
		1211	C<Control-Shift-Insert>, which would otherwise be overridden.
		1212
		1213	Similarly, to let applications gain access to the C<C-M-c> (copy to
		1214	clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
		1215	this:
		1216
		1217	URxvt.keysym.C-M-c: builtin-string:
		1218	URxvt.keysym.C-M-v: builtin-string:
		1219
		1220	=item EXTENSION:STRING
		1221
		1222	An action of this form invokes the action B<STRING>, if any, provided
		1223	by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
		1224	be loaded automatically if necessary.
		1225
		1226	Not all extensions define actions, but popular extensions that do
		1227	include the I<selection> and I<matcher> extensions (documented in their
		1228	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
		1229	respectively).
		1230
		1231	From the silly examples department, this will rot13-"encrypt"
		1232	@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
		1233	keyboards:
		1234
		1235	URxvt.keysym.M-C-c: selection:rot13
		1236
		1237	=item perl:STRING DEPRECATED
		1238
		1239	This is a deprecated way of invoking commands provided by perl
		1240	extensions. It is still supported, but should not be used anymore.
		1241
		1242	=back
1176		1243
1177	=item B<perl-ext-common>: I<string>	1244	=item B<perl-ext-common>: I<string>
1178		1245
1179	=item B<perl-ext>: I<string>	1246	=item B<perl-ext>: I<string>
1180		1247
…		…
1182	use in this terminal instance; option B<-pe>.	1249	use in this terminal instance; option B<-pe>.
1183		1250
1184	Extension names can be prefixed with a C<-> sign to prohibit using	1251	Extension names can be prefixed with a C<-> sign to prohibit using
1185	them. This can be useful to selectively disable some extensions loaded	1252	them. This can be useful to selectively disable some extensions loaded
1186	by default, or specified via the C<perl-ext-common> resource. For	1253	by default, or specified via the C<perl-ext-common> resource. For
1187	example, C<default,-selection> will use all the default extension except	1254	example, C<default,-selection> will use all the default extensions except
1188	C<selection>.	1255	C<selection>.
1189		1256
1190	Extension names can also be followed by an argument in angle brackets	1257	The default set includes the C<selection>, C<option-popup>,
1191	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1258	C<selection-popup>, C<readline> and C<searchable-scrollback>
1192	searchable scrollback to Alt/Meta-s). Mentioning the same extension	1259	extensions, and extensions which are mentioned in B<keysym> resources.
1193	multiple times with different arguments will pass multiple arguments to	1260
1194	the extension.	1261	Any extension such that a corresponding resource is given on the
		1262	command line is automatically appended to B<perl-ext>.
1195		1263
1196	Each extension is looked up in the library directories, loaded if	1264	Each extension is looked up in the library directories, loaded if
1197	necessary, and bound to the current terminal instance.	1265	necessary, and bound to the current terminal instance. When the library
		1266	search path contains multiple extension files of the same name, then the
		1267	first one found will be used.
1198		1268
1199	If both of these resources are the empty string, then the perl	1269	If both of these resources are the empty string, then the perl interpreter
1200	interpreter will not be initialized. The idea behind two options is that	1270	will not be initialized. The rationale for having two options is that
1201	B<perl-ext-common> will be used for extensions that should be available to	1271	B<perl-ext-common> will be used for extensions that should be available to
1202	all instances, while B<perl-ext> is used for specific instances.	1272	all instances, while B<perl-ext> is used for specific instances.
1203		1273
1204	=item B<perl-eval>: I<string>	1274	=item B<perl-eval>: I<string>
1205		1275
1206	Perl code to be evaluated when all extensions have been registered. See	1276	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	1277	the @@RXVT_NAME@@perl(3) manpage.
1208	will be ignored when running setuid/setgid.
1209		1278
1210	=item B<perl-lib>: I<path>	1279	=item B<perl-lib>: I<path>
1211		1280
1212	Colon-separated list of additional directories that hold extension	1281	Colon-separated list of additional directories that hold extension
1213	scripts. When looking for extensions specified by the C<perl> resource,	1282	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1214	@@RXVT_NAME@@ will first look in these directories and then in	1283	in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1215	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1284	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1216	will be ignored when running setuid/setgid.
1217		1285
1218	See the @@RXVT_NAME@@perl(3) manpage.	1286	See the @@RXVT_NAME@@perl(3) manpage.
1219		1287
1220	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1288	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1221		1289
…		…
1225	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>	1293	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1226		1294
1227	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage	1295	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1228	for details.	1296	for details.
1229		1297
1230	=item B<searchable-scrollback:> I<keysym>	1298	=item B<searchable-scrollback:> I<keysym> DEPRECATED
1231		1299
1232	Sets the hotkey that starts the incremental scrollback buffer search	1300	This resource is deprecated and will be removed. Use a B<keysym> resource
1233	(default: C<M-s>).	1301	instead, e.g.:
1234		1302
		1303	URxvt.keysym.M-s: searchable-scrollback:start
		1304
1235	=item B<urlLauncher>: I<string>	1305	=item B<url-launcher>: I<string>
1236		1306
1237	Specifies the program to be started with a URL argument. Used by the	1307	Specifies the program to be started with a URL argument. Used by the
1238	C<selection-popup> and C<matcher> perl extensions.	1308	C<selection-popup> and C<matcher> perl extensions.
1239		1309
1240	=item B<transient-for>: I<windowid>	1310	=item B<transient-for>: I<windowid>
…		…
1244	=item B<override-redirect>: I<boolean>	1314	=item B<override-redirect>: I<boolean>
1245		1315
1246	Compile I<frills>: Sets override-redirect for the terminal window, making	1316	Compile I<frills>: Sets override-redirect for the terminal window, making
1247	it almost invisible to window managers; option B<-override-redirect>.	1317	it almost invisible to window managers; option B<-override-redirect>.
1248		1318
		1319	=item B<iso14755:> I<boolean>
		1320
		1321	Turn on/off ISO 14755 (default enabled).
		1322
1249	=item B<iso14755_52:> I<boolean>	1323	=item B<iso14755_52:> I<boolean>
1250		1324
1251	Turn on/off ISO 14755 5.2 mode (default enabled).	1325	Turn on/off ISO 14755 5.2 mode (default enabled).
		1326
		1327	=back
		1328
		1329	=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
		1330
		1331	=over 4
		1332
		1333	=item B<-pixmap> I<file[;oplist]>
		1334
		1335	=item B<backgroundPixmap:> I<file[;oplist]>
		1336
		1337	Compile I<pixbuf>: Use the specified image file as the window's
		1338	background and also optionally specify a colon separated list of
		1339	operations to modify it. Note that you may need to quote the C<;>
		1340	character when using the command line option, as C<;> is usually a
		1341	metacharacter in shells. Supported operations are:
		1342
		1343	=over 4
		1344
		1345	=item B<WxH+X+Y>
		1346
		1347	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
		1348	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
		1349	scale of 0 disables scaling.
		1350
		1351	=item B<op=tile>
		1352
		1353	enables tiling
		1354
		1355	=item B<op=keep-aspect>
		1356
		1357	maintain the image aspect ratio when scaling
		1358
		1359	=item B<op=root-align>
		1360
		1361	use the position of the terminal window relative to the root window as
		1362	the image offset, simulating a root window background
		1363
		1364	=back
		1365
		1366	The default scale and position setting is C<100x100+50+50>.
		1367	Alternatively, a predefined set of templates can be used to achieve
		1368	the most common setups:
		1369
		1370	=over 4
		1371
		1372	=item B<style=tiled>
		1373
		1374	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		1375
		1376	=item B<style=aspect-stretched>
		1377
		1378	the image is scaled to fill the whole window maintaining the aspect
		1379	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		1380
		1381	=item B<style=stretched>
		1382
		1383	the image is scaled to fill the whole window. Equivalent to 100x100
		1384
		1385	=item B<style=centered>
		1386
		1387	the image is centered with no scaling. Equivalent to 0x0+50+50
		1388
		1389	=item B<style=root-tiled>
		1390
		1391	the image is tiled with no scaling and using 'root' positioning.
		1392	Equivalent to 0x0:op=tile:op=root-align
		1393
		1394	=back
		1395
		1396	If multiple templates are specified the last one wins. Note that a
		1397	template overrides all the scale, position and operations settings.
		1398
		1399	If used in conjunction with pseudo-transparency, the specified pixmap
		1400	will be blended over the transparent background using alpha-blending.
		1401
		1402	=item B<-tr>\|B<+tr>
		1403
		1404	=item B<transparent:> I<boolean>
		1405
		1406	Turn on/off pseudo-transparency by using the root pixmap as background.
		1407
		1408	B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
		1409	will be removed in future versions.
		1410
		1411	=item B<-tint> I<colour>
		1412
		1413	=item B<tintColor:> I<colour>
		1414
		1415	Tint the transparent background with the given colour. Note that a
		1416	black tint yields a completely black image while a white tint yields
		1417	the image unchanged.
		1418
		1419	=item B<-sh> I<number>
		1420
		1421	=item B<shading:> I<number>
		1422
		1423	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
		1424	A value of 100 means no shading.
		1425
		1426	=item B<-blr> I<HxV>
		1427
		1428	=item B<blurRadius:> I<HxV>
		1429
		1430	Apply gaussian blur with the specified radius to the transparent
		1431	background. If a single number is specified, the vertical and
		1432	horizontal radii are considered to be the same. Setting one of the
		1433	radii to 1 and the other to a large number creates interesting effects
		1434	on some backgrounds. The maximum radius value is 128. An horizontal or
		1435	vertical radius of 0 disables blurring.
		1436
		1437	=item B<path:> I<path>
		1438
		1439	Specify the colon-delimited search path for finding background image files.
1252		1440
1253	=back	1441	=back
1254		1442
1255	=head1 THE SCROLLBAR	1443	=head1 THE SCROLLBAR
1256		1444
…		…
1304	window causes the value of the PRIMARY selection (or CLIPBOARD with the	1492	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1305	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.	1493	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1306		1494
1307	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1495	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1308	inserted too.	1496	inserted too.
		1497
		1498	rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
		1499	<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
		1500	binding causes the value of the internal selection to be copied to the
		1501	CLIPBOARD selection, while the second binding causes the value of the
		1502	CLIPBOARD selection to be inserted.
1309		1503
1310	=back	1504	=back
1311		1505
1312	=head1 CHANGING FONTS	1506	=head1 CHANGING FONTS
1313		1507
…		…
1395	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1589	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	1590	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	1591	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.	1592	on some systems or setgid to root or to some other group on others.
1399		1593
1400	=head1 COLORS AND GRAPHICS	1594	=head1 COLOURS AND GRAPHICS
1401		1595
1402	In addition to the default foreground and background colours,	1596	In addition to the default foreground and background colours,
1403	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1597	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	1598	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1405	colours with their names.	1599	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1600	cube plus a 8 (24) colour greyscale ramp.
		1601
		1602	Here is a list of the ANSI colours with their names.
1406		1603
1407	=begin table	1604	=begin table
1408		1605
1409	B<color0> (black) = Black	1606	B<color0> (black) = Black
1410	B<color1> (red) = Red3	1607	B<color1> (red) = Red3
…		…
1430	It is also possible to specify the colour values of B<foreground>,	1627	It is also possible to specify the colour values of B<foreground>,
1431	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1628	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	1629	a number 0-15, as a convenient shorthand to reference the colour name of
1433	color0-color15.	1630	color0-color15.
1434		1631
1435	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1632	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)	1633	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		1634
		1635	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1636
		1637	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1638	index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
		1639
		1640	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1641	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1642	the RGB cube.
		1643
1440	Together, all those colours implement the 88 colour xterm colours. Only	1644	Together, all those colours implement the 88 (256) colour xterm
1441	the first 16 can be changed using resources currently, the rest can only	1645	colours. Only the first 16 can be changed using resources currently, the
1442	be changed via command sequences ("escape codes").	1646	rest can only be changed via command sequences ("escape codes").
		1647
		1648	Applications are advised to use terminfo or command sequences to discover
		1649	number and RGB values of all colours (yes, you can query this...).
1443		1650
1444	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1651	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1445	always swapping the foreground/background colours. This is in contrast to	1652	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	1653	I<xterm>(1) where the colours are only swapped if they have not otherwise
1447	been specified. For example,	1654	been specified. For example,
1448		1655
1449	=over 4
1450
1451	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1656	@@RXVT_NAME@@ -fg Black -bg White -rv
1452		1657
1453	would yield White on Black, while on I<xterm>(1) it would yield Black	1658	would yield White on Black, while on I<xterm>(1) it would yield Black on
1454	on White.	1659	White.
1455
1456	=back
1457		1660
1458	=head2 ALPHA CHANNEL SUPPORT	1661	=head2 ALPHA CHANNEL SUPPORT
1459		1662
1460	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1663	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>	1664	their act together, rxvt-unicode will do its own alpha channel management:
1462	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1665
1463	in addition to the ones provided by X, where the additional A component	1666	You can prefix any colour with an opaqueness percentage enclosed in
		1667	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1668	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1669	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1670	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1671	is the recommended format to specify transparency values, and works with
		1672	all ways to specify a colour.
		1673
		1674	For complete control, rxvt-unicode also supports
		1675	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1676	specifications, where the additional C<aaaa> component specifies opacity
1464	specifies opacity (alpha) values. The minimum value of C<0> is completely	1677	(alpha) values. The minimum value of C<0000> is completely transparent,
1465	transparent). You can also prefix any color with C<[percent]>, where	1678	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	1679	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	1680	C<rgba:0000/ff00/0000/f332>.
1468	opaque.
1469		1681
1470	You probably need to specify B<"-depth 32">, too, and have the luck that	1682	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	1683	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.	1684	layout, as X is far from just supporting ARGB visuals out of the box, and
		1685	rxvt-unicode just fudges around.
1473		1686
1474	For example, the following selects an almost completely transparent red	1687	For example, the following selects an almost completely transparent black
1475	background, and an almost opaque pink foreground:	1688	background, and an almost opaque pink foreground:
1476		1689
1477	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1690	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1478		1691
1479	I<Please note that transparency of any kind if completely unsupported by	1692	When not using a background image, then the interpretation of the
1480	the author. Don't bug him with installation questions!>	1693	alpha channel is up to your compositing manager (most interpret it as
		1694	transparency of course).
		1695
		1696	When using a background pixmap or pseudo-transparency, then the background
		1697	colour will always behave as if it were completely transparent (so the
		1698	background image shows instead), regardless of how it was specified, while
		1699	other colours will either be transparent as specified (the background
		1700	image will show through) on servers supporting the RENDER extension, or
		1701	fully opaque on servers not supporting the RENDER EXTENSION.
		1702
		1703	Please note that due to bugs in Xft, specifying alpha values might result
		1704	in garbage being displayed when the X-server does not support the RENDER
		1705	extension.
1481		1706
1482	=head1 ENVIRONMENT	1707	=head1 ENVIRONMENT
1483		1708
1484	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1709	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1485		1710
…		…
1519	C<--with-terminfo=PATH>.	1744	C<--with-terminfo=PATH>.
1520		1745
1521	=item B<DISPLAY>	1746	=item B<DISPLAY>
1522		1747
1523	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1748	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1524	display in its child processes.	1749	display in its child processes if C<-display> isn't used to override. It
		1750	defaults to C<:0> if it doesn't exist.
1525		1751
1526	=item B<SHELL>	1752	=item B<SHELL>
1527		1753
1528	The shell to be used for command execution, defaults to C</bin/sh>.	1754	The shell to be used for command execution, defaults to C</bin/sh>.
1529		1755
1530	=item B<RXVT_SOCKET>	1756	=item B<RXVT_SOCKET> [I<sic>]
1531		1757
1532	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1758	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1533	@@RXVT_NAME@@d(1).	1759	@@RXVT_NAME@@d(1).
1534		1760
1535	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1761	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1762
		1763	=item B<URXVT_PERL_LIB>
		1764
		1765	Additional F<:>-separated library search path for perl extensions. Will be
		1766	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1767	directory.
		1768
		1769	=item B<URXVT_PERL_VERBOSITY>
		1770
		1771	See L<@@RXVT_NAME@@perl>(3).
1536		1772
1537	=item B<HOME>	1773	=item B<HOME>
1538		1774
1539	Used to locate the default directory for the unix domain socket for	1775	Used to locate the default directory for the unix domain socket for
1540	daemon communications and to locate various resource files (such as	1776	daemon communications and to locate various resource files (such as
1541	C<.Xdefaults>)	1777	C<.Xdefaults>)
1542		1778
1543	=item B<XAPPLRESDIR>	1779	=item B<XAPPLRESDIR>
1544		1780
1545	Directory where various X resource files are being located.	1781	Directory where application-specific X resource files are located.
1546		1782
1547	=item B<XENVIRONMENT>	1783	=item B<XENVIRONMENT>
1548		1784
1549	If set and accessible, gives the name of a X resource file to be loaded by	1785	If set and accessible, gives the name of a X resource file to be loaded by
1550	@@RXVT_NAME@@.	1786	@@RXVT_NAME@@.
…		…
1555		1791
1556	=over 4	1792	=over 4
1557		1793
1558	=item B</usr/lib/X11/rgb.txt>	1794	=item B</usr/lib/X11/rgb.txt>
1559		1795
1560	Color names.	1796	Colour names.
1561		1797
1562	=back	1798	=back
1563		1799
1564	=head1 SEE ALSO	1800	=head1 SEE ALSO
1565		1801
		1802	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1566	@@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)	1803	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1567		1804
1568	=head1 CURRENT PROJECT COORDINATOR	1805	=head1 CURRENT PROJECT COORDINATOR
1569		1806
1570	=over 4	1807	=over 4
1571		1808
1572	=item Project Coordinator	1809	=item Project Coordinator
1573		1810
1574	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1811	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1575		1812
1576	L<http://software.schmorp.de/pkg/rxvt-unicode.html>	1813	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1577		1814
1578	=back	1815	=back
1579		1816
…		…
1583		1820
1584	=item John Bovey	1821	=item John Bovey
1585		1822
1586	University of Kent, 1992, wrote the original Xvt.	1823	University of Kent, 1992, wrote the original Xvt.
1587		1824
1588	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>	1825	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1589		1826
1590	very heavily modified Xvt and came up with Rxvt	1827	very heavily modified Xvt and came up with Rxvt
1591		1828
1592	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>	1829	=item Angelo Haritsis <ah@doc.ic.ac.uk>
1593		1830
1594	wrote the Greek Keyboard Input (no longer in code)	1831	wrote the Greek Keyboard Input (no longer in code)
1595		1832
1596	=item mj olesen L<< <olesen@me.QueensU.CA> >>	1833	=item mj olesen <olesen@me.QueensU.CA>
1597		1834
1598	Wrote the menu system.	1835	Wrote the menu system.
1599		1836
1600	Project Coordinator (changes.txt 2.11 to 2.21)	1837	Project Coordinator (changes.txt 2.11 to 2.21)
1601		1838
1602	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>	1839	=item Oezguer Kesim <kesim@math.fu-berlin.de>
1603		1840
1604	Project Coordinator (changes.txt 2.21a to 2.4.5)	1841	Project Coordinator (changes.txt 2.21a to 2.4.5)
1605		1842
1606	=item Geoff Wing L<< <gcw@pobox.com> >>	1843	=item Geoff Wing <gcw@pobox.com>
1607		1844
1608	Rewrote screen display and text selection routines.	1845	Rewrote screen display and text selection routines.
1609		1846
1610	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1847	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1611		1848
1612	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1849	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1613		1850
1614	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1851	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1615	extension, random hacks, numerous bugfixes and extensions.	1852	extension, random hacks, numerous bugfixes and extensions.
1616		1853
1617	Project Coordinator (Changes 1.0 -)	1854	Project Coordinator (Changes 1.0 -)
1618		1855
1619	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1856	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1620		1857
1621	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1858	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1622		1859
1623	=back	1860	=back
1624		1861

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.157 by ayin, Sat Jan 19 16:20:09 2008 UTC vs. Revision 1.244 by sf-exg, Tue Jun 16 11:58:26 2015 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.157 by ayin, Sat Jan 19 16:20:09 2008 UTC vs.
Revision 1.244 by sf-exg, Tue Jun 16 11:58:26 2015 UTC