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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.153 by root, Wed Dec 12 19:57:13 2007 UTC vs.
Revision 1.250 by root, Sat Oct 10 20:06:45 2020 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
…		…
245	italic> >> characters are to be printed. See resource B<boldItalicFont>	206	italic> >> characters are to be printed. See resource B<boldItalicFont>
246	for details.	207	for details.
247		208
248	=item B<-is>\|B<+is>	209	=item B<-is>\|B<+is>
249		210
250	Compile I<font-styles>: Bold/Italic font styles imply high intensity	211	Compile I<font-styles>: Bold/Blink font styles imply high intensity
251	foreground/background (default). See resource B<intensityStyles> for	212	foreground/background (default). See resource B<intensityStyles> for
252	details.	213	details.
253		214
254	=item B<-name> I<name>	215	=item B<-name> I<name>
255		216
…		…
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
…		…
272	B<visualBell>.	237	B<visualBell>.
273		238
274	=item B<-sb>\|B<+sb>	239	=item B<-sb>\|B<+sb>
275		240
276	Turn on/off scrollbar; resource B<scrollBar>.	241	Turn on/off scrollbar; resource B<scrollBar>.
		242
		243	=item B<-sr>\|B<+sr>
		244
		245	Put scrollbar on right/left; resource B<scrollBar_right>.
		246
		247	=item B<-st>\|B<+st>
		248
		249	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		250	resource B<scrollBar_floating>.
277		251
278	=item B<-si>\|B<+si>	252	=item B<-si>\|B<+si>
279		253
280	Turn on/off scroll-to-bottom on TTY output inhibit; resource	254	Turn on/off scroll-to-bottom on TTY output inhibit; resource
281	B<scrollTtyOutput> has opposite effect.	255	B<scrollTtyOutput> has opposite effect.
…		…
288	=item B<-sw>\|B<+sw>	262	=item B<-sw>\|B<+sw>
289		263
290	Turn on/off scrolling with the scrollback buffer as new lines appear.	264	Turn on/off scrolling with the scrollback buffer as new lines appear.
291	This only takes effect if B<-si> is also given; resource	265	This only takes effect if B<-si> is also given; resource
292	B<scrollWithBuffer>.	266	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		267
303	=item B<-ptab>\|B<+ptab>	268	=item B<-ptab>\|B<+ptab>
304		269
305	If enabled (default), "Horizontal Tab" characters are being stored as	270	If enabled (default), "Horizontal Tab" characters are being stored as
306	actual wide characters in the screen buffer, which makes it possible to	271	actual wide characters in the screen buffer, which makes it possible to
…		…
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.
…		…
806	text font will being used for the given style.	754	text font will being used for the given style.
807		755
808	=item B<intensityStyles:> I<boolean>	756	=item B<intensityStyles:> I<boolean>
809		757
810	When font styles are not enabled, or this option is enabled (B<True>,	758	When font styles are not enabled, or this option is enabled (B<True>,
811	option B<-is>, the default), bold and italic font styles imply high	759	option B<-is>, the default), bold/blink font styles imply high
812	intensity foreground/background colours. Disabling this option (B<False>,	760	intensity foreground/background colours. Disabling this option (B<False>,
813	option B<+is>) disables this behaviour, the high intensity colours are not	761	option B<+is>) disables this behaviour, the high intensity colours are not
814	reachable.	762	reachable.
815		763
816	=item B<selectstyle:> I<mode>
817
818	Set mouse selection style to B<old> which is 2.20, B<oldword> which
819	is xterm style with 2.20 old word selection, or anything else which
820	gives xterm style selection. Only effective when the original (non-perl)
821	selection code is in use.
822
823	=item B<scrollstyle:> I<mode>
824
825	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
826	the author's favourite.
827
828	=item B<title:> I<string>	764	=item B<title:> I<string>
829		765
830	Set window title string, the default title is the command-line	766	Set window title string, the default title is the command-line
831	specified after the B<-e> option, if any, otherwise the application	767	specified after the B<-e> option, if any, otherwise the application
832	name; option B<-title>.	768	name; option B<-title>.
…		…
845	=item B<urgentOnBell:> I<boolean>	781	=item B<urgentOnBell:> I<boolean>
846		782
847	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.
848	B<False>: do not set the urgency hint [default].	784	B<False>: do not set the urgency hint [default].
849		785
		786	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		787
850	=item B<visualBell:> I<boolean>	788	=item B<visualBell:> I<boolean>
851		789
852	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>.
853	B<False>: no visual bell [default]; option B<+vb>.	791	B<False>: no visual bell [default]; option B<+vb>.
854		792
…		…
856		794
857	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
858	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
859	[default]; option B<+ls>.	797	[default]; option B<+ls>.
860		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
861	=item B<utmpInhibit:> I<boolean>	804	=item B<utmpInhibit:> I<boolean>
862		805
863	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>;
864	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>
865	[default]; option B<+ut>.	808	[default]; option B<+ut>.
…		…
877	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	820	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
878		821
879	This creates a new file in your home directory with the screen contents	822	This creates a new file in your home directory with the screen contents
880	every time you hit C<Print>.	823	every time you hit C<Print>.
881		824
		825	=item B<scrollstyle:> I<mode>
		826
		827	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		828	the author's favourite.
		829
		830	=item B<thickness:> I<number>
		831
		832	Set the scrollbar width in pixels.
		833
882	=item B<scrollBar:> I<boolean>	834	=item B<scrollBar:> I<boolean>
883		835
884	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	836	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
885	disable the scrollbar; option B<+sb>.	837	disable the scrollbar; option B<+sb>.
886		838
…		…
905	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
906	B<+si>.	858	B<+si>.
907		859
908	=item B<scrollWithBuffer:> I<boolean>	860	=item B<scrollWithBuffer:> I<boolean>
909		861
910	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.
911	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
912	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>.
913		866
914	=item B<scrollTtyKeypress:> I<boolean>	867	=item B<scrollTtyKeypress:> I<boolean>
915		868
916	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
917	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
918	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to	871	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
919	bottom when a non-special key is pressed; option B<+sk>.	872	bottom when a non-special key is pressed; option B<+sk>.
920		873
921	=item B<saveLines:> I<number>	874	=item B<saveLines:> I<number>
922		875
923	Save I<number> lines in the scrollback buffer [default 64]. This	876	Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
924	resource is limited on most machines to 65535; option B<-sl>.
925		877
926	=item B<internalBorder:> I<number>	878	=item B<internalBorder:> I<number>
927		879
928	Internal border of I<number> pixels. This resource is limited to 100;	880	Internal border of I<number> pixels. This resource is limited to 100;
929	option B<-b>.	881	option B<-b>.
…		…
973	=item B<cursorBlink:> I<boolean>	925	=item B<cursorBlink:> I<boolean>
974		926
975	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	927	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
976	option B<-bc>.	928	option B<-bc>.
977		929
		930	=item B<cursorUnderline:> I<boolean>
		931
		932	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		933	option B<-uc>.
		934
978	=item B<pointerBlank:> I<boolean>	935	=item B<pointerBlank:> I<boolean>
979		936
980	B<True>: blank the pointer when a key is pressed or after a set number	937	B<True>: blank the pointer when a key is pressed or after a set number
981	of seconds of inactivity. B<False>: the pointer is always visible	938	of seconds of inactivity. B<False>: the pointer is always visible
982	[default].	939	[default].
…		…
987		944
988	=item B<pointerColor2:> I<colour>	945	=item B<pointerColor2:> I<colour>
989		946
990	Mouse pointer background colour.	947	Mouse pointer background colour.
991		948
		949	=item B<pointerShape:> I<string>
		950
		951	Compile I<frills>: Specifies the name of the mouse pointer shape
		952	[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
		953	file for possible values (omit the C<XC_> prefix).
		954
992	=item B<pointerBlankDelay:> I<number>	955	=item B<pointerBlankDelay:> I<number>
993		956
994	Specifies number of seconds before blanking the pointer [default 2]. Use a	957	Specifies number of seconds before blanking the pointer [default 2]. Use a
995	large number (e.g. C<987654321>) to effectively disable the timeout.	958	large number (e.g. C<987654321>) to effectively disable the timeout.
996		959
997	=item B<backspacekey:> I<string>	960	=item B<backspacekey:> I<string>
998		961
999	The string to send when the backspace key is pressed. If set to B<DEC>	962	The string to send when the backspace key is pressed. If set to B<DEC>
1000	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	963	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
1001	(code 8) - which can be reversed with the appropriate DEC private mode	964	(code 8) - which can be reversed with the appropriate DEC private mode
1002	escape sequence.	965	escape sequence.
1003		966
1004	=item B<deletekey:> I<string>	967	=item B<deletekey:> I<string>
1005		968
…		…
1022		985
1023	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>	986	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
1024		987
1025	=item B<preeditType:> I<style>	988	=item B<preeditType:> I<style>
1026		989
1027	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	990	B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1028		991
1029	=item B<inputMethod:> I<name>	992	=item B<inputMethod:> I<name>
1030		993
1031	I<name> of inputMethod to use; option B<-im>.	994	I<name> of inputMethod to use; option B<-im>.
1032		995
…		…
1084		1047
1085	=item B<secondaryScroll:> I<boolean>	1048	=item B<secondaryScroll:> I<boolean>
1086		1049
1087	Turn on/off secondary screen scroll (default enabled). If this	1050	Turn on/off secondary screen scroll (default enabled). If this
1088	option is enabled, scrolls on the secondary screen will change the	1051	option is enabled, scrolls on the secondary screen will change the
1089	scrollback buffer and switching to/from the secondary screen will	1052	scrollback buffer and, when secondaryScreen is off, switching
1090	instead scroll the screen up.	1053	to/from the secondary screen will instead scroll the screen up.
1091		1054
1092	=item B<hold>: I<boolean>	1055	=item B<hold>: I<boolean>
1093		1056
1094	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1057	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1095	will not immediately destroy its window when the program executed within	1058	will not immediately destroy its window when the program executed within
1096	it exits. Instead, it will wait till it is being killed or closed by the	1059	it exits. Instead, it will wait till it is being killed or closed by the
1097	user.	1060	user.
1098		1061
		1062	=item B<chdir>: I<path>
		1063
		1064	Sets the working directory for the shell (or the command specified via
		1065	B<-e>). The I<path> must be an absolute path and it must exist for
		1066	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1067	directory will be used; option B<-cd>.
		1068
1099	=item B<keysym.>I<sym>: I<string>	1069	=item B<keysym.>I<sym>: I<action>
1100		1070
1101	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1071	Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1102	intervening resource name B<keysym.> cannot be omitted.	1072	resource name B<keysym.> cannot be omitted.
1103		1073
1104	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be	1074	Using this resource, you can map key combinations such as
1105	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,	1075	C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1106	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,	1076	string than would normally result from that combination, making the
1107	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,	1077	terminal scroll up or down the way you want it, or any other thing an
1108	B<2>, B<3>, B<4>, B<5>.	1078	extension might provide.
		1079
		1080	The key combination that triggers the action, I<sym>, has the following format:
		1081
		1082	(modifiers-)key
		1083
		1084	Where I<modifiers> can be any combination of the following full or
		1085	abbreviated modifier names:
		1086
		1087	=begin table
		1088
		1089	B<ISOLevel3> B<I>
		1090	B<AppKeypad> B<K>
		1091	B<Control> B<C>
		1092	B<NumLock> B<N>
		1093	B<Shift> B<S>
		1094	B<Meta> B<M> I<or> B<A>
		1095	B<Lock> B<L>
		1096	B<Mod1> B<1>
		1097	B<Mod2> B<2>
		1098	B<Mod3> B<3>
		1099	B<Mod4> B<4>
		1100	B<Mod5> B<5>
		1101
		1102	=end table
1109		1103
1110	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to	1104	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1111	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr	1105	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1112	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the	1106	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1113	current application keymap mode state.	1107	current application keymap mode state.
1114		1108
1115	The spellings of I<key> can be obtained by using B<xev>(1) command or	1109	Due the the large number of modifier combinations, a key mapping will
1116	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1110	match if I<at least> the specified identifiers are being set, and no other
		1111	key mappings with those and more bits are being defined. That means that
		1112	defining a mapping for C<a> will automatically provide definitions for
		1113	C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
		1114	themselves. See the C<builtin:> action, below, for a way to work around
		1115	this when this is a problem.
		1116
		1117	The spelling of I<key> depends on your implementation of X. An easy way to
		1118	find a key name is to use the B<xev>(1) command. You can find a list by
		1119	looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1117	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1120	the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1118	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1121	value (B<0x0000 - 0xFFFF>).
1119	performed in an exact manner; however, the closest match is assured.
1120		1122
1121	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1123	As with any resource value, the I<action> string may contain backslash
		1124	escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1122	number), see RESOURCES in C<man 7 X> for futher details.	1125	number), see RESOURCES in C<man 7 X> for further details.
1123		1126
1124	You can define a range of keysyms in one shot by providing a I<string>	1127	An action starts with an action prefix that selects a certain type
1125	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1128	of action, followed by a colon. An action string without colons is
		1129	interpreted as a literal string to pass to the tty (as if it was
		1130	prefixed with C<string:>).
		1131
		1132	The following action prefixes are known - extensions can provide
		1133	additional prefixes:
		1134
		1135	=over 4
		1136
		1137	=item string:STRING
		1138
		1139	If the I<action> starts with C<string:> (or otherwise contains no colons),
		1140	then the remaining C<STRING> will be passed to the program running in the
		1141	terminal. For example, you could replace whatever Shift-Tab outputs by the
		1142	string C<echo rm -rf /> followed by a newline:
		1143
		1144	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
		1145
		1146	This could in theory be used to completely redefine your keymap.
		1147
		1148	In addition, for actions of this type, you can define a range of
		1149	keysyms in one shot by loading the C<keysym-list> perl extension and
		1150	providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1126	should be a character not used by the strings.	1151	the delimiter `/' should be a character not used by the strings.
1127		1152
1128	Its usage can be demonstrated by an example:	1153	Its usage can be demonstrated by an example:
1129		1154
1130	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1155	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1131		1156
1132	The above line is equivalent to the following three lines:	1157	The above line is equivalent to the following three lines:
1133		1158
1134	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1159	URxvt.keysym.Meta-Control-0x61: string:\033<a>
1135	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1160	URxvt.keysym.Meta-Control-0x62: string:\033<b>
1136	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1161	URxvt.keysym.Meta-Control-0x63: string:\033<c>
1137		1162
		1163	=item command:STRING
		1164
1138	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1165	If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1139	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1166	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
		1167	the opposite of C<string:> - instead of sending it to the program running
		1168	in the terminal, it will be treated as if it were program output). This is
		1169	most useful to feed command sequences into @@RXVT_NAME@@.
		1170
1140	example the following means "change the current locale to C<zh_CN.GBK>	1171	For example the following means "change the current locale to C<zh_CN.GBK>
1141	when Control-Meta-c is being pressed":	1172	when Control-Meta-c is being pressed":
1142		1173
1143	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1174	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1144		1175
1145	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1176	The following example will map Control-Meta-1 and Control-Meta-2 to
1146	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1177	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1147	manpage. For example, the F<selection> extension (activated via	1178	font-switching at runtime:
1148	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1149		1179
1150	URxvt.keysym.M-C-c: perl:selection:rot13	1180	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1181	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1151		1182
1152	Due the the large number of modifier combinations, a defined key mapping	1183	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1153	will match if at I<at least> the specified identifiers are being set, and	1184	info):
1154	no other key mappings with those and more bits are being defined. That
1155	means that defining a key map for C<a> will automatically provide
1156	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1157	mappings themselves.
1158		1185
1159	Unfortunately, this will override built-in key mappings. For example	1186	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1187	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1188
		1189	=item builtin:
		1190
		1191	The builtin action is the action that @@RXVT_NAME@@ would execute if no
		1192	key binding existed for the key combination. The obvious use is to undo
		1193	the effect of existing bindings. The not so obvious use is to reinstate
		1194	bindings when another binding overrides too many modifiers.
		1195
1160	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s	1196	For example if you overwrite the C<Insert> key you will disable
1161	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the	1197	@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1162	user-defined keymap using the C<builtin:> replacement:	1198	"holes" into the user-defined keymap using the C<builtin:> replacement:
1163		1199
1164	URxvt.keysym.Insert: <my insert key sequence>	1200	URxvt.keysym.Insert: <my insert key sequence>
1165	URxvt.keysym.S-Insert: builtin:	1201	URxvt.keysym.S-Insert: builtin:
1166		1202
1167	The first line defines a mapping for C<Insert> and I<any> combination	1203	The first line defines a mapping for C<Insert> and I<any> combination
1168	of modifiers. The second line re-establishes the default mapping for	1204	of modifiers. The second line re-establishes the default mapping for
1169	C<Shift-Insert>.	1205	C<Shift-Insert>.
1170		1206
1171	The following example will map Control-Meta-1 and Control-Meta-2 to	1207	=item builtin-string:
1172	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1173	font-switching at runtime:
1174		1208
1175	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1209	This action is mainly useful to restore string mappings for keys that
1176	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007	1210	have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
		1211	difficult to explain - basically, this action will send the string to the
		1212	application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
		1213	action for it.
1177		1214
1178	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1215	An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1179	info):	1216	selection when you press C<Shift-Insert>. With the following bindings, it
		1217	would instead emit the (undocumented, but what applications running in the
		1218	terminal might expect) sequence C<ESC [ 2 $> instead:
1180		1219
1181	URxvt.keysym.M-C-3: command:\033[8;25;80t	1220	URxvt.keysym.S-Insert: builtin-string:
1182	URxvt.keysym.M-C-4: command:\033[8;48;110t	1221	URxvt.keysym.C-S-Insert: builtin:
		1222
		1223	The first line disables the paste functionality for that key
		1224	combination, and the second reinstates the default behaviour for
		1225	C<Control-Shift-Insert>, which would otherwise be overridden.
		1226
		1227	Similarly, to let applications gain access to the C<C-M-c> (copy to
		1228	clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
		1229	this:
		1230
		1231	URxvt.keysym.C-M-c: builtin-string:
		1232	URxvt.keysym.C-M-v: builtin-string:
		1233
		1234	=item EXTENSION:STRING
		1235
		1236	An action of this form invokes the action B<STRING>, if any, provided
		1237	by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
		1238	be loaded automatically if necessary.
		1239
		1240	Not all extensions define actions, but popular extensions that do
		1241	include the I<selection> and I<matcher> extensions (documented in their
		1242	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
		1243	respectively).
		1244
		1245	From the silly examples department, this will rot13-"encrypt"
		1246	@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
		1247	keyboards:
		1248
		1249	URxvt.keysym.M-C-c: selection:rot13
		1250
		1251	=item perl:STRING DEPRECATED
		1252
		1253	This is a deprecated way of invoking commands provided by perl
		1254	extensions. It is still supported, but should not be used anymore.
		1255
		1256	=back
1183		1257
1184	=item B<perl-ext-common>: I<string>	1258	=item B<perl-ext-common>: I<string>
1185		1259
1186	=item B<perl-ext>: I<string>	1260	=item B<perl-ext>: I<string>
1187		1261
…		…
1189	use in this terminal instance; option B<-pe>.	1263	use in this terminal instance; option B<-pe>.
1190		1264
1191	Extension names can be prefixed with a C<-> sign to prohibit using	1265	Extension names can be prefixed with a C<-> sign to prohibit using
1192	them. This can be useful to selectively disable some extensions loaded	1266	them. This can be useful to selectively disable some extensions loaded
1193	by default, or specified via the C<perl-ext-common> resource. For	1267	by default, or specified via the C<perl-ext-common> resource. For
1194	example, C<default,-selection> will use all the default extension except	1268	example, C<default,-selection> will use all the default extensions except
1195	C<selection>.	1269	C<selection>.
1196		1270
1197	Extension names can also be followed by an argument in angle brackets	1271	The default set includes the C<selection>, C<option-popup>,
1198	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1272	C<selection-popup>, C<readline> and C<searchable-scrollback>
1199	searchable scrollback to Alt/Meta-s). Mentioning the same extension	1273	extensions, and extensions which are mentioned in B<keysym> resources.
1200	multiple times with different arguments will pass multiple arguments to	1274
1201	the extension.	1275	Any extension such that a corresponding resource is given on the
		1276	command line is automatically appended to B<perl-ext>.
1202		1277
1203	Each extension is looked up in the library directories, loaded if	1278	Each extension is looked up in the library directories, loaded if
1204	necessary, and bound to the current terminal instance.	1279	necessary, and bound to the current terminal instance. When the library
		1280	search path contains multiple extension files of the same name, then the
		1281	first one found will be used.
1205		1282
1206	If both of these resources are the empty string, then the perl	1283	If both of these resources are the empty string, then the perl interpreter
1207	interpreter will not be initialized. The idea behind two options is that	1284	will not be initialized. The rationale for having two options is that
1208	B<perl-ext-common> will be used for extensions that should be available to	1285	B<perl-ext-common> will be used for extensions that should be available to
1209	all instances, while B<perl-ext> is used for specific instances.	1286	all instances, while B<perl-ext> is used for specific instances.
1210		1287
1211	=item B<perl-eval>: I<string>	1288	=item B<perl-eval>: I<string>
1212		1289
1213	Perl code to be evaluated when all extensions have been registered. See	1290	Perl code to be evaluated when all extensions have been registered. See
1214	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1291	the @@RXVT_NAME@@perl(3) manpage.
1215	will be ignored when running setuid/setgid.
1216		1292
1217	=item B<perl-lib>: I<path>	1293	=item B<perl-lib>: I<path>
1218		1294
1219	Colon-separated list of additional directories that hold extension	1295	Colon-separated list of additional directories that hold extension
1220	scripts. When looking for extensions specified by the C<perl> resource,	1296	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1221	@@RXVT_NAME@@ will first look in these directories and then in	1297	in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1222	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1298	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1223	will be ignored when running setuid/setgid.
1224		1299
1225	See the @@RXVT_NAME@@perl(3) manpage.	1300	See the @@RXVT_NAME@@perl(3) manpage.
1226		1301
1227	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1302	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1228		1303
…		…
1232	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>	1307	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1233		1308
1234	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage	1309	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1235	for details.	1310	for details.
1236		1311
1237	=item B<searchable-scrollback:> I<keysym>	1312	=item B<searchable-scrollback:> I<keysym> DEPRECATED
1238		1313
1239	Sets the hotkey that starts the incremental scrollback buffer search	1314	This resource is deprecated and will be removed. Use a B<keysym> resource
1240	(default: C<M-s>).	1315	instead, e.g.:
1241		1316
		1317	URxvt.keysym.M-s: searchable-scrollback:start
		1318
1242	=item B<urlLauncher>: I<string>	1319	=item B<url-launcher>: I<string>
1243		1320
1244	Specifies the program to be started with a URL argument. Used by the	1321	Specifies the program to be started with a URL argument. Used by the
1245	C<selection-popup> and C<matcher> perl extensions.	1322	C<selection-popup> and C<matcher> perl extensions.
1246		1323
1247	=item B<transient-for>: I<windowid>	1324	=item B<transient-for>: I<windowid>
…		…
1250		1327
1251	=item B<override-redirect>: I<boolean>	1328	=item B<override-redirect>: I<boolean>
1252		1329
1253	Compile I<frills>: Sets override-redirect for the terminal window, making	1330	Compile I<frills>: Sets override-redirect for the terminal window, making
1254	it almost invisible to window managers; option B<-override-redirect>.	1331	it almost invisible to window managers; option B<-override-redirect>.
		1332
		1333	=item B<iso14755:> I<boolean>
		1334
		1335	Turn on/off ISO 14755 (default enabled).
1255		1336
1256	=item B<iso14755_52:> I<boolean>	1337	=item B<iso14755_52:> I<boolean>
1257		1338
1258	Turn on/off ISO 14755 5.2 mode (default enabled).	1339	Turn on/off ISO 14755 5.2 mode (default enabled).
1259		1340
…		…
1311	window causes the value of the PRIMARY selection (or CLIPBOARD with the	1392	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1312	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.	1393	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1313		1394
1314	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1395	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1315	inserted too.	1396	inserted too.
		1397
		1398	rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
		1399	<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
		1400	binding causes the value of the internal selection to be copied to the
		1401	CLIPBOARD selection, while the second binding causes the value of the
		1402	CLIPBOARD selection to be inserted.
1316		1403
1317	=back	1404	=back
1318		1405
1319	=head1 CHANGING FONTS	1406	=head1 CHANGING FONTS
1320		1407
…		…
1402	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1489	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1403	it can be seen via the I<who(1)> command, and can accept messages. To	1490	it can be seen via the I<who(1)> command, and can accept messages. To
1404	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1491	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1405	on some systems or setgid to root or to some other group on others.	1492	on some systems or setgid to root or to some other group on others.
1406		1493
1407	=head1 COLORS AND GRAPHICS	1494	=head1 COLOURS AND GRAPHICS
1408		1495
1409	In addition to the default foreground and background colours,	1496	In addition to the default foreground and background colours,
1410	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1497	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1411	high-intensity bold/blink versions of the same). Here is a list of the	1498	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1412	colours with their names.	1499	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1500	cube plus a 8 (24) colour greyscale ramp.
		1501
		1502	B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
		1503	C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
		1504	number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
		1505	colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
		1506	24-bit colour space. When indexing collisions happen, the nearest old colour in
		1507	the cube will be adapted to the new 24-bit RGB colour. That means one cannot
		1508	use many similar 24-bit colours. It's typically not a problem in common
		1509	scenarios.
		1510
		1511	Here is a list of the ANSI colours with their names.
1413		1512
1414	=begin table	1513	=begin table
1415		1514
1416	B<color0> (black) = Black	1515	B<color0> (black) = Black
1417	B<color1> (red) = Red3	1516	B<color1> (red) = Red3
…		…
1437	It is also possible to specify the colour values of B<foreground>,	1536	It is also possible to specify the colour values of B<foreground>,
1438	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1537	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1439	a number 0-15, as a convenient shorthand to reference the colour name of	1538	a number 0-15, as a convenient shorthand to reference the colour name of
1440	color0-color15.	1539	color0-color15.
1441		1540
1442	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1541	The following text gives values for the standard 88 colour mode (and
1443	additional 72 colours. The first 64 of those (with indices 16 to 79)	1542	values for the 256 colour mode in parentheses).
1444	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1445	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1446		1543
		1544	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1545
		1546	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1547	index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
		1548
		1549	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1550	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1551	the RGB cube.
		1552
1447	Together, all those colours implement the 88 colour xterm colours. Only	1553	Together, all those colours implement the 88 (256) colour xterm
1448	the first 16 can be changed using resources currently, the rest can only	1554	colours. Only the first 16 can be changed using resources currently, the
1449	be changed via command sequences ("escape codes").	1555	rest can only be changed via command sequences ("escape codes").
		1556
		1557	Applications are advised to use terminfo or command sequences to discover
		1558	number and RGB values of all colours (yes, you can query this...).
1450		1559
1451	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1560	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1452	always swapping the foreground/background colours. This is in contrast to	1561	always swapping the foreground/background colours. This is in contrast to
1453	I<xterm>(1) where the colours are only swapped if they have not otherwise	1562	I<xterm>(1) where the colours are only swapped if they have not otherwise
1454	been specified. For example,	1563	been specified. For example,
1455		1564
1456	=over 4
1457
1458	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1565	@@RXVT_NAME@@ -fg Black -bg White -rv
1459		1566
1460	would yield White on Black, while on I<xterm>(1) it would yield Black	1567	would yield White on Black, while on I<xterm>(1) it would yield Black on
1461	on White.	1568	White.
1462
1463	=back
1464		1569
1465	=head2 ALPHA CHANNEL SUPPORT	1570	=head2 ALPHA CHANNEL SUPPORT
1466		1571
1467	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1572	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1468	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1573	their act together, rxvt-unicode will do its own alpha channel management:
1469	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1574
1470	in addition to the ones provided by X, where the additional A component	1575	You can prefix any colour with an opaqueness percentage enclosed in
		1576	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1577	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1578	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1579	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1580	is the recommended format to specify transparency values, and works with
		1581	all ways to specify a colour.
		1582
		1583	For complete control, rxvt-unicode also supports
		1584	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1585	specifications, where the additional C<aaaa> component specifies opacity
1471	specifies opacity (alpha) values. The minimum value of C<0> is completely	1586	(alpha) values. The minimum value of C<0000> is completely transparent,
1472	transparent). You can also prefix any color with C<[percent]>, where	1587	while C<ffff> is completely opaque). The two example colours from
1473	C<percent> is a decimal percentage (0-100) that specifies the opacity of	1588	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1474	the color, where C<0> is completely transparent and C<100> is completelxy	1589	C<rgba:0000/ff00/0000/f332>.
1475	opaque.
1476		1590
1477	You probably need to specify B<"-depth 32">, too, and have the luck that	1591	You probably need to specify B<"-depth 32">, too, to force a visual with
1478	your X-server uses ARGB pixel layout, as X is far from just supporting	1592	alpha channels, and have the luck that your X-server uses ARGB pixel
1479	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1593	layout, as X is far from just supporting ARGB visuals out of the box, and
		1594	rxvt-unicode just fudges around.
1480		1595
1481	For example, the following selects an almost completely transparent red	1596	For example, the following selects an almost completely transparent black
1482	background, and an almost opaque pink foreground:	1597	background, and an almost opaque pink foreground:
1483		1598
1484	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1599	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1485		1600
1486	I<Please note that transparency of any kind if completely unsupported by	1601	When not using a background image, then the interpretation of the
1487	the author. Don't bug him with installation questions!>	1602	alpha channel is up to your compositing manager (most interpret it as
		1603	transparency of course).
		1604
		1605	When using a background pixmap or pseudo-transparency, then the background
		1606	colour will always behave as if it were completely transparent (so the
		1607	background image shows instead), regardless of how it was specified, while
		1608	other colours will either be transparent as specified (the background
		1609	image will show through) on servers supporting the RENDER extension, or
		1610	fully opaque on servers not supporting the RENDER EXTENSION.
		1611
		1612	Please note that due to bugs in Xft, specifying alpha values might result
		1613	in garbage being displayed when the X-server does not support the RENDER
		1614	extension.
1488		1615
1489	=head1 ENVIRONMENT	1616	=head1 ENVIRONMENT
1490		1617
1491	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1618	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1492		1619
…		…
1526	C<--with-terminfo=PATH>.	1653	C<--with-terminfo=PATH>.
1527		1654
1528	=item B<DISPLAY>	1655	=item B<DISPLAY>
1529		1656
1530	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1657	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1531	display in its child processes.	1658	display in its child processes if C<-display> isn't used to override. It
		1659	defaults to C<:0> if it doesn't exist.
1532		1660
1533	=item B<SHELL>	1661	=item B<SHELL>
1534		1662
1535	The shell to be used for command execution, defaults to C</bin/sh>.	1663	The shell to be used for command execution, defaults to C</bin/sh>.
1536		1664
1537	=item B<RXVT_SOCKET>	1665	=item B<RXVT_SOCKET> [I<sic>]
1538		1666
1539	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1667	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1540	@@RXVT_NAME@@d(1).	1668	@@RXVT_NAME@@d(1).
1541		1669
1542	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1670	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1671
		1672	=item B<URXVT_PERL_LIB>
		1673
		1674	Additional F<:>-separated library search path for perl extensions. Will be
		1675	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1676	directory.
		1677
		1678	=item B<URXVT_PERL_VERBOSITY>
		1679
		1680	See L<@@RXVT_NAME@@perl>(3).
1543		1681
1544	=item B<HOME>	1682	=item B<HOME>
1545		1683
1546	Used to locate the default directory for the unix domain socket for	1684	Used to locate the default directory for the unix domain socket for
1547	daemon communications and to locate various resource files (such as	1685	daemon communications and to locate various resource files (such as
1548	C<.Xdefaults>)	1686	C<.Xdefaults>)
1549		1687
1550	=item B<XAPPLRESDIR>	1688	=item B<XAPPLRESDIR>
1551		1689
1552	Directory where various X resource files are being located.	1690	Directory where application-specific X resource files are located.
1553		1691
1554	=item B<XENVIRONMENT>	1692	=item B<XENVIRONMENT>
1555		1693
1556	If set and accessible, gives the name of a X resource file to be loaded by	1694	If set and accessible, gives the name of a X resource file to be loaded by
1557	@@RXVT_NAME@@.	1695	@@RXVT_NAME@@.
…		…
1562		1700
1563	=over 4	1701	=over 4
1564		1702
1565	=item B</usr/lib/X11/rgb.txt>	1703	=item B</usr/lib/X11/rgb.txt>
1566		1704
1567	Color names.	1705	Colour names.
1568		1706
1569	=back	1707	=back
1570		1708
1571	=head1 SEE ALSO	1709	=head1 SEE ALSO
1572		1710
		1711	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1573	@@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)	1712	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1574		1713
1575	=head1 CURRENT PROJECT COORDINATOR	1714	=head1 CURRENT PROJECT COORDINATOR
1576		1715
1577	=over 4	1716	=over 4
1578		1717
1579	=item Project Coordinator	1718	=item Project Coordinator
1580		1719
1581	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1720	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1582		1721
1583	L<http://software.schmorp.de/pkg/rxvt-unicode.html>	1722	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1584		1723
1585	=back	1724	=back
1586		1725
…		…
1590		1729
1591	=item John Bovey	1730	=item John Bovey
1592		1731
1593	University of Kent, 1992, wrote the original Xvt.	1732	University of Kent, 1992, wrote the original Xvt.
1594		1733
1595	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>	1734	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1596		1735
1597	very heavily modified Xvt and came up with Rxvt	1736	very heavily modified Xvt and came up with Rxvt
1598		1737
1599	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>	1738	=item Angelo Haritsis <ah@doc.ic.ac.uk>
1600		1739
1601	wrote the Greek Keyboard Input (no longer in code)	1740	wrote the Greek Keyboard Input (no longer in code)
1602		1741
1603	=item mj olesen L<< <olesen@me.QueensU.CA> >>	1742	=item mj olesen <olesen@me.QueensU.CA>
1604		1743
1605	Wrote the menu system.	1744	Wrote the menu system.
1606		1745
1607	Project Coordinator (changes.txt 2.11 to 2.21)	1746	Project Coordinator (changes.txt 2.11 to 2.21)
1608		1747
1609	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>	1748	=item Oezguer Kesim <kesim@math.fu-berlin.de>
1610		1749
1611	Project Coordinator (changes.txt 2.21a to 2.4.5)	1750	Project Coordinator (changes.txt 2.21a to 2.4.5)
1612		1751
1613	=item Geoff Wing L<< <gcw@pobox.com> >>	1752	=item Geoff Wing <gcw@pobox.com>
1614		1753
1615	Rewrote screen display and text selection routines.	1754	Rewrote screen display and text selection routines.
1616		1755
1617	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1756	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1618		1757
1619	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1758	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1620		1759
1621	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1760	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1622	extension, random hacks, numerous bugfixes and extensions.	1761	extension, random hacks, numerous bugfixes and extensions.
1623		1762
1624	Project Coordinator (Changes 1.0 -)	1763	Project Coordinator (Changes 1.0 -)
1625		1764
1626	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1765	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1627		1766
1628	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1767	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1629		1768
1630	=back	1769	=back
1631		1770

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.153 by root, Wed Dec 12 19:57:13 2007 UTC vs. Revision 1.250 by root, Sat Oct 10 20:06:45 2020 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.153 by root, Wed Dec 12 19:57:13 2007 UTC vs.
Revision 1.250 by root, Sat Oct 10 20:06:45 2020 UTC