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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.176 by sf-exg, Sat Apr 17 23:00:45 2010 UTC vs.
Revision 1.260 by root, Fri Dec 23 21:46:46 2022 UTC

…		…
84	far greater than those listed. For example: `@@RXVT_NAME@@ --loginShell --color1	84	far greater than those listed. For example: `@@RXVT_NAME@@ --loginShell --color1
85	Orange'.	85	Orange'.
86		86
87	The following options are available:	87	The following options are available:
88		88
89	=over 4	89	=over
90		90
91	=item B<-help>, B<--help>	91	=item B<-help>, B<--help>
92		92
93	Print out a message describing available options.	93	Print out a message describing available options.
94		94
…		…
98	is still respected. but deprecated). In the absence of this option, the	98	is still respected. but deprecated). In the absence of this option, the
99	display specified by the 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	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	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	108	of graphical corruption. This is harmless, but we can't do anything about
109	this, so watch out]	109	this, so watch out]
110		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
111	=item B<-geometry> I<geom>	117	=item B<-geometry> I<geom>
112		118
113	Window geometry (B<-g> still respected); resource B<geometry>.	119	Window geometry (B<-g> still respected); resource B<geometry>.
114		120
115	=item B<-rv>\|B<+rv>	121	=item B<-rv>\|B<+rv>
…		…
122		128
123	=item B<-ss>\|B<+ss>	129	=item B<-ss>\|B<+ss>
124		130
125	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>.
126		132
127	=item B<-tr>\|B<+tr>	133	=item B<-fps> I<number>
128		134
129	Turn on/off illusion of a transparent window background; resource B<transparent>.	135	Compile I<frills>: Set the refresh interval (in frames per second or
130		136	negative seconds); resource B<refreshRate>.
131	B<-ip> is still accepted as an obsolete alias but will be removed in
132	future versions.
133
134	I<Please address all transparency related issues to Sasha Vasko at
135	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
136		137
137	=item B<-fade> I<number>	138	=item B<-fade> I<number>
138		139
139	Fade the text by the given percentage when focus is lost. Small values	140	Fade the text by the given percentage when focus is lost. Small values
140	fade a little only, 100 completely replaces all colours by the fade	141	fade a little only, 100 completely replaces all colours by the fade
…		…
143	=item B<-fadecolor> I<colour>	144	=item B<-fadecolor> I<colour>
144		145
145	Fade to this colour when fading is used (see B<-fade>). The default colour	146	Fade to this colour when fading is used (see B<-fade>). The default colour
146	is opaque black. resource B<fadeColor>.	147	is opaque black. resource B<fadeColor>.
147		148
148	=item B<-tint> I<colour>
149
150	Tint the transparent background pixmap with the given colour when
151	transparency is enabled with B<-tr>. This only works for
152	non-tiled backgrounds, currently. See also the B<-sh> option that can be
153	used to brighten or darken the image in addition to tinting it.
154	Please note that certain tint colours can be applied on the server-side,
155	thus yielding performance gain of two orders of magnitude. These colours are:
156	blue, red, green, cyan, magenta, yellow, and those close to them. Also
157	pure black and pure white colors essentially mean no tinting; resource
158	I<tintColor>. Example:
159
160	@@RXVT_NAME@@ -tr -tint blue -sh 40
161
162	=item B<-sh> I<number>
163
164	Darken (0 .. 100) or lighten (100 .. 200) the transparent
165	background image in addition to (or instead of) tinting it;
166	resource I<shading>.
167
168	=item B<-blt> I<string>
169
170	Specify background blending type. If background pixmap is specified
171	at the same time as transparency - such pixmap will be blended over
172	transparency image, using method specified. Supported values are :
173	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
174	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
175	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
176	alpha-blending. Compile I<afterimage>; resource I<blendType>.
177
178	=item B<-blr> I<HxV>
179
180	Apply Gaussian Blur with the specified radii to the transparent
181	background image. If single number is specified - both vertical and
182	horizontal radii are considered to be the same. Setting one of the
183	radii to 1 and another to a large number creates interesting effects
184	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
185	resource I<blurRadius>.
186
187	=item B<-icon> I<file>	149	=item B<-icon> I<file>
188		150
189	Compile I<afterimage>: Use the specified image as application icon. This	151	Compile I<pixbuf>: Use the specified image as application icon. This
190	is used by many window managers, taskbars and pagers to represent the	152	is used by many window managers, taskbars and pagers to represent the
191	application window; resource I<iconFile>.	153	application window; resource I<iconFile>.
192		154
193	=item B<-bg> I<colour>	155	=item B<-bg> I<colour>
194		156
195	Window background colour; resource B<background>.	157	Window background colour; resource B<background>.
196		158
197	=item B<-fg> I<colour>	159	=item B<-fg> I<colour>
198		160
199	Window foreground colour; resource B<foreground>.	161	Window foreground colour; resource B<foreground>.
200
201	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
202
203	Compile I<afterimage>: Specify image file for the background and also
204	optionally specify its scaling with a geometry string. Note you may need to
205	add quotes to avoid special shell interpretation of the C<;> in the
206	command-line; for more details see resource B<backgroundPixmap>.
207		162
208	=item B<-cr> I<colour>	163	=item B<-cr> I<colour>
209		164
210	The cursor colour; resource B<cursorColor>.	165	The cursor colour; resource B<cursorColor>.
211		166
…		…
270		225
271	=item B<-ls>\|B<+ls>	226	=item B<-ls>\|B<+ls>
272		227
273	Start as a login-shell/sub-shell; resource B<loginShell>.	228	Start as a login-shell/sub-shell; resource B<loginShell>.
274		229
		230	=item B<-mc> I<milliseconds>
		231
		232	Specify the maximum time between multi-click selections.
		233
275	=item B<-ut>\|B<+ut>	234	=item B<-ut>\|B<+ut>
276		235
277	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource	236	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
278	B<utmpInhibit>.	237	B<utmpInhibit>.
279		238
…		…
357		316
358	=item B<-override-redirect>	317	=item B<-override-redirect>
359		318
360	Compile I<frills>: Sets override-redirect on the window; resource	319	Compile I<frills>: Sets override-redirect on the window; resource
361	B<override-redirect>.	320	B<override-redirect>.
		321
		322	=item B<-dockapp>
		323
		324	Sets the initial state of the window to WithdrawnState, which makes
		325	window managers that support this extension treat it as a dockapp.
362		326
363	=item B<-sbg>	327	=item B<-sbg>
364		328
365	Compile I<frills>: Disable the usage of the built-in block graphics/line	329	Compile I<frills>: Disable the usage of the built-in block graphics/line
366	drawing characters and just rely on what the specified fonts provide. Use	330	drawing characters and just rely on what the specified fonts provide. Use
…		…
421	=item B<-pt> I<style>	385	=item B<-pt> I<style>
422		386
423	Compile I<XIM>: input style for input method; B<OverTheSpot>,	387	Compile I<XIM>: input style for input method; B<OverTheSpot>,
424	B<OffTheSpot>, B<Root>; resource B<preeditType>.	388	B<OffTheSpot>, B<Root>; resource B<preeditType>.
425		389
		390	If the perl extension C<xim-onthespot> is used (which is the default),
		391	then additionally the C<OnTheSpot> preedit type is available.
		392
426	=item B<-im> I<text>	393	=item B<-im> I<text>
427		394
428	Compile I<XIM>: input method name. resource B<inputMethod>.	395	Compile I<XIM>: input method name. resource B<inputMethod>.
429		396
430	=item B<-imlocale> I<string>	397	=item B<-imlocale> I<string>
…		…
444	Change the meaning of triple-click selection with the left mouse	411	Change the meaning of triple-click selection with the left mouse
445	button. Only effective when the original (non-perl) selection code is	412	button. Only effective when the original (non-perl) selection code is
446	in-use. Instead of selecting a full line it will extend the selection to	413	in-use. Instead of selecting a full line it will extend the selection to
447	the end of the logical line only. resource B<tripleclickwords>.	414	the end of the logical line only. resource B<tripleclickwords>.
448		415
		416	=item B<-dpb>\|B<+dpb>
		417
		418	Compile frills: Disable (or enable) emitting bracketed paste mode
		419	sequences (default enabled). Bracketed paste mode allows programs
		420	to detect when something is pasted. Since more and more programs
		421	abuse this, these sequences can be disabled. The command sequences to
		422	enable and query paste mode will still work, but the actual bracket
		423	sequences will no longer be emitted. You can also toggle this from the
		424	ctrl-middle-mouse-button menu; resource B<disablePasteBrackets>.
		425
449	=item B<-insecure>	426	=item B<-insecure>
450		427
451	Enable "insecure" mode, which currently enables most of the escape	428	Enable "insecure" mode, which currently enables most of the escape
452	sequences that echo strings. See the resource B<insecure> for more	429	sequences that echo strings. See the resource B<insecure> for more
453	info.	430	info.
…		…
465		442
466	=item B<-ssr>\|B<+ssr>	443	=item B<-ssr>\|B<+ssr>
467		444
468	Turn on/off secondary screen scroll (default enabled); resource	445	Turn on/off secondary screen scroll (default enabled); resource
469	B<secondaryScroll>.	446	B<secondaryScroll>.
		447
		448	=item B<-rm> I<mode>
		449
		450	Compile I<frills>: Sets long line rewrapping behaviour on window resizes
		451	to one of B<auto> (the default), B<always> or B<never>. The latter two
		452	modes do the obvious, B<auto> rewraps (acts like B<always>) if scrollback
		453	is non-empty, and wings lines (acts like B<never>) otherwise; resource
		454	B<rewrapMode>.
470		455
471	=item B<-hold>\|B<+hold>	456	=item B<-hold>\|B<+hold>
472		457
473	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	458	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
474	will not immediately destroy its window when the program executed within	459	will not immediately destroy its window when the program executed within
…		…
553		538
554	# now communicate with rxvt	539	# now communicate with rxvt
555	my $slave = $pty->slave;	540	my $slave = $pty->slave;
556	while (<$slave>) { print $slave "got <$_>\n" }	541	while (<$slave>) { print $slave "got <$_>\n" }
557		542
		543	Note that, despite what the name might imply, the file descriptor does not
		544	need to be a pty, it can be a bi-directional pipe as well (e.g. a unix
		545	domain or tcp socket). While tty operations cannot be done in this case,
		546	B<@@RXVT_NAME@@> can still be remote controlled with it:
		547
		548	use Socket;
		549	use Fcntl;
		550
		551	socketpair my $URXVT, my $slave, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC;
		552	fcntl $slave, Fcntl::F_SETFD, 0;
		553	system "exec @@RXVT_NAME@@ -pty-fd " . (fileno $slave) . " &";
		554	close $slave;
		555
		556	syswrite $URXVT, "Type a secret password: ";
		557	my $secret = do { local $/ = "\r"; <$URXVT> };
		558	print "Not so secret anymore: $secret\n";
		559
558	=item B<-pe> I<string>	560	=item B<-pe> I<string>
559		561
560	Comma-separated list of perl extension scripts to use (or not to use) in	562	Comma-separated list of perl extension scripts to use (or not to use) in
561	this terminal instance. See resource B<perl-ext> for details.	563	this terminal instance. See resource B<perl-ext> for details.
562		564
…		…
571	You can set and change the resources using X11 tools like B<xrdb>. Many	573	You can set and change the resources using X11 tools like B<xrdb>. Many
572	distribution do also load settings from the B<~/.Xresources> file when X	574	distribution do also load settings from the B<~/.Xresources> file when X
573	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	575	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
574	with later settings overwriting earlier ones:	576	with later settings overwriting earlier ones:
575		577
576	1. system-wide app-defaults file, either locale-dependent OR global
577	2. app-defaults file in $XAPPLRESDIR	578	1. app-defaults file in $XAPPLRESDIR
		579	2. $HOME/.Xdefaults
578	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	580	3. RESOURCE_MANAGER property on root-window of screen 0
579	4. SCREEN_RESOURCES for the current screen	581	4. SCREEN_RESOURCES property on root-window of the current screen
580	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	582	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
581	6. resources specified via -xrm on the commandline	583	6. resources specified via -xrm on the commandline
582		584
583	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	585	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
584	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	586	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
…		…
589	be used. Command-line arguments can be used to override resource	591	be used. Command-line arguments can be used to override resource
590	settings. The following resources are supported (you might want to	592	settings. The following resources are supported (you might want to
591	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl	593	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
592	extensions not documented here):	594	extensions not documented here):
593		595
594	=over 4	596	=over
595		597
596	=item B<depth:> I<bitdepth>	598	=item B<depth:> I<bitdepth>
597		599
598	Compile I<xft>: Attempt to find a visual with the given bit depth;	600	Compile I<xft>: Attempt to find a visual with the given bit depth;
599	option B<-depth>.	601	option B<-depth>.
…		…
625	Use the specified colour for the colour value I<n>, where 0-7	627	Use the specified colour for the colour value I<n>, where 0-7
626	corresponds to low-intensity (normal) colours and 8-15 corresponds to	628	corresponds to low-intensity (normal) colours and 8-15 corresponds to
627	high-intensity (bold = bright foreground, blink = bright background)	629	high-intensity (bold = bright foreground, blink = bright background)
628	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	630	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
629	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	631	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
630	names used are listed in the B<COLORS AND GRAPHICS> section.	632	names used are listed in the B<COLOURS AND GRAPHICS> section.
631		633
632	Colours higher than 15 cannot be set using resources (yet), but can be	634	Colours higher than 15 cannot be set using resources (yet), but can be
633	changed using an escape command (see @@RXVT_NAME@@(7)).	635	changed using an escape command (see @@RXVT_NAME@@(7)).
634		636
635	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	637	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
676		678
677	=item B<reverseVideo:> I<boolean>	679	=item B<reverseVideo:> I<boolean>
678		680
679	B<True>: simulate reverse video by foreground and background colours;	681	B<True>: simulate reverse video by foreground and background colours;
680	option B<-rv>. B<False>: regular screen colours [default]; option	682	option B<-rv>. B<False>: regular screen colours [default]; option
681	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	683	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
682		684
683	=item B<jumpScroll:> I<boolean>	685	=item B<jumpScroll:> I<boolean>
684		686
685	B<True>: specify that jump scrolling should be used. When receiving lots	687	B<True>: specify that jump scrolling should be used. When receiving lots
686	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines	688	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
…		…
700		702
701	B<False>: specify that everything is to be displayed, even	703	B<False>: specify that everything is to be displayed, even
702	if the refresh is too fast for the human eye to read anything (or the	704	if the refresh is too fast for the human eye to read anything (or the
703	monitor to display anything); option B<+ss>.	705	monitor to display anything); option B<+ss>.
704		706
705	=item B<transparent:> I<boolean>	707	=item B<refreshRate:> I<number>
706		708
707	Turn on/off illusion of a transparent window background.	709	Compile I<frills>: When positive, sets the maximum refreshes per second
708		710	(the default is C<60>). When zero or negative, sets the minimum interval
709	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in	711	between refreshes, negated. That is, positive numbers limit the number
710	future versions.	712	of refreshes per second to that number, similar to a fps limiter in
711		713	games. Zero or negative numbers get negated and directly set the minimum
712	I<Please address all transparency related issues to Sasha Vasko at	714	interval between refreshs, that is, C<10> and C<-0.1> both specify the
713	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>	715	same refresh interval (likewise C<50> and C<0.02>). Fractional values are
		716	supported; option B<-fps>.
714		717
715	=item B<fading:> I<number>	718	=item B<fading:> I<number>
716		719
717	Fade the text by the given percentage when focus is lost; option B<-fade>.	720	Fade the text by the given percentage when focus is lost; option B<-fade>.
718		721
719	=item B<fadeColor:> I<colour>	722	=item B<fadeColor:> I<colour>
720		723
721	Fade to this colour, when fading is used (see B<fading:>). The default	724	Fade to this colour, when fading is used (see B<fading:>). The default
722	colour is black; option B<-fadecolor>.	725	colour is black; option B<-fadecolor>.
723		726
724	=item B<tintColor:> I<colour>
725
726	Tint the transparent background pixmap with the given colour; option
727	B<-tint>.
728
729	=item B<shading:> I<number>
730
731	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
732	in addition to tinting it; option B<-sh>.
733
734	=item B<blendType:> I<string>
735
736	Specify background blending type; option B<-blt>.
737
738	=item B<blurRadius:> I<number>
739
740	Apply gaussian blur with the specified radius to the transparent
741	background image; option B<-blr>.
742
743	=item B<iconFile:> I<file>	727	=item B<iconFile:> I<file>
744		728
745	Set the application icon pixmap; option B<-icon>.	729	Set the application icon pixmap; option B<-icon>.
746		730
747	=item B<scrollColor:> I<colour>	731	=item B<scrollColor:> I<colour>
…		…
755		739
756	=item B<borderColor:> I<colour>	740	=item B<borderColor:> I<colour>
757		741
758	The colour of the border around the text area and between the scrollbar	742	The colour of the border around the text area and between the scrollbar
759	and the text.	743	and the text.
760
761	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
762
763	Use the specified image file for the background and also
764	optionally specify its scaling with a geometry string B<WxH+X+Y>,
765	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
766	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
767	centre (percent). A scale of 0 displays the image with tiling. A scale
768	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
769	an integer number of images in that direction. No image will be magnified
770	beyond 10 times its original size. The maximum permitted scale is 1000.
771	Additional operations can be specified after colon B<:op1:op2...>.
772	Supported operations are:
773
774	tile force background image to be tiled and not scaled. Equivalent to 0x0
775	propscale will scale image keeping proportions
776	auto will scale image to match window size. Equivalent to 100x100
777	hscale will scale image horizontally to the window size
778	vscale will scale image vertically to the window size
779	scale will scale image to match window size
780	root will tile image as if it was a root window background, auto-adjusting
781	whenever terminal window moves
782
783	If used in conjunction with B<-tr> option, the specified pixmap will be
784	blended over transparency image using either alpha-blending, or any
785	other blending type, specified with B<-blt "type"> option.
786
787	=item B<path:> I<path>
788
789	Specify the colon-delimited search path for finding background image files.
790		744
791	=item B<font:> I<fontlist>	745	=item B<font:> I<fontlist>
792		746
793	Select the fonts to be used. This is a comma separated list of font names	747	Select the fonts to be used. This is a comma separated list of font names
794	that are checked in order when trying to find glyphs for characters. The	748	that are checked in order when trying to find glyphs for characters. The
…		…
891		845
892	B<True>: start as a login shell by prepending a `-' to B<argv[0]> of	846	B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
893	the shell; option B<-ls>. B<False>: start as a normal sub-shell	847	the shell; option B<-ls>. B<False>: start as a normal sub-shell
894	[default]; option B<+ls>.	848	[default]; option B<+ls>.
895		849
		850	=item B<multiClickTime:> I<number>
		851
		852	Specify the maximum time in milliseconds between multi-click select
		853	events. The default is 500 milliseconds; option B<-mc>.
		854
896	=item B<utmpInhibit:> I<boolean>	855	=item B<utmpInhibit:> I<boolean>
897		856
898	B<True>: inhibit writing record into the system log file B<utmp>;	857	B<True>: inhibit writing record into the system log file B<utmp>;
899	option B<-ut>. B<False>: write record into the system log file B<utmp>	858	option B<-ut>. B<False>: write record into the system log file B<utmp>
900	[default]; option B<+ut>.	859	[default]; option B<+ut>.
…		…
917	=item B<scrollstyle:> I<mode>	876	=item B<scrollstyle:> I<mode>
918		877
919	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	878	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
920	the author's favourite.	879	the author's favourite.
921		880
		881	=item B<thickness:> I<number>
		882
		883	Set the scrollbar width in pixels.
		884
922	=item B<scrollBar:> I<boolean>	885	=item B<scrollBar:> I<boolean>
923		886
924	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	887	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
925	disable the scrollbar; option B<+sb>.	888	disable the scrollbar; option B<+sb>.
926		889
…		…
945	B<False>: do not scroll to bottom when tty receives output; option	908	B<False>: do not scroll to bottom when tty receives output; option
946	B<+si>.	909	B<+si>.
947		910
948	=item B<scrollWithBuffer:> I<boolean>	911	=item B<scrollWithBuffer:> I<boolean>
949		912
950	B<True>: scroll with scrollback buffer when tty receives new lines (and	913	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
951	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	914	try to show the same lines) and B<scrollTtyOutput> is False; option
952	with scrollback buffer when tty receives new lines; option B<+sw>.	915	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		916	new lines; option B<+sw>.
953		917
954	=item B<scrollTtyKeypress:> I<boolean>	918	=item B<scrollTtyKeypress:> I<boolean>
955		919
956	B<True>: scroll to bottom when a non-special key is pressed. Special keys	920	B<True>: scroll to bottom when a non-special key is pressed. Special keys
957	are those which are intercepted by rxvt-unicode for special handling and	921	are those which are intercepted by rxvt-unicode for special handling and
958	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to	922	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
959	bottom when a non-special key is pressed; option B<+sk>.	923	bottom when a non-special key is pressed; option B<+sk>.
960		924
961	=item B<saveLines:> I<number>	925	=item B<saveLines:> I<number>
962		926
963	Save I<number> lines in the scrollback buffer [default 64]. This	927	Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
964	resource is limited on most machines to 65535; option B<-sl>.
965		928
966	=item B<internalBorder:> I<number>	929	=item B<internalBorder:> I<number>
967		930
968	Internal border of I<number> pixels. This resource is limited to 100;	931	Internal border of I<number> pixels. This resource is limited to 100;
969	option B<-b>.	932	option B<-b>.
…		…
1032		995
1033	=item B<pointerColor2:> I<colour>	996	=item B<pointerColor2:> I<colour>
1034		997
1035	Mouse pointer background colour.	998	Mouse pointer background colour.
1036		999
		1000	=item B<pointerShape:> I<string>
		1001
		1002	Compile I<frills>: Specifies the name of the mouse pointer shape
		1003	[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
		1004	file for possible values (omit the C<XC_> prefix).
		1005
1037	=item B<pointerBlankDelay:> I<number>	1006	=item B<pointerBlankDelay:> I<number>
1038		1007
1039	Specifies number of seconds before blanking the pointer [default 2]. Use a	1008	Specifies number of seconds before blanking the pointer [default 2]. Use a
1040	large number (e.g. C<987654321>) to effectively disable the timeout.	1009	large number (e.g. C<987654321>) to effectively disable the timeout.
1041		1010
1042	=item B<backspacekey:> I<string>	1011	=item B<backspacekey:> I<string>
1043		1012
1044	The string to send when the backspace key is pressed. If set to B<DEC>	1013	The string to send when the backspace key is pressed. If set to B<DEC>
1045	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	1014	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
1046	(code 8) - which can be reversed with the appropriate DEC private mode	1015	(code 8) - which can be reversed with the appropriate DEC private mode
1047	escape sequence.	1016	escape sequence.
1048		1017
1049	=item B<deletekey:> I<string>	1018	=item B<deletekey:> I<string>
1050		1019
…		…
1067		1036
1068	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>	1037	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
1069		1038
1070	=item B<preeditType:> I<style>	1039	=item B<preeditType:> I<style>
1071		1040
1072	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1041	B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1073		1042
1074	=item B<inputMethod:> I<name>	1043	=item B<inputMethod:> I<name>
1075		1044
1076	I<name> of inputMethod to use; option B<-im>.	1045	I<name> of inputMethod to use; option B<-im>.
1077		1046
…		…
1095		1064
1096	Change the meaning of triple-click selection with the left mouse	1065	Change the meaning of triple-click selection with the left mouse
1097	button. Instead of selecting a full line it will extend the selection to	1066	button. Instead of selecting a full line it will extend the selection to
1098	the end of the logical line only; option B<-tcw>.	1067	the end of the logical line only; option B<-tcw>.
1099		1068
		1069	=item B<disablePasteBrackets:> I<boolean>
		1070
		1071	Prevent emission of paste bracket sequences; option B<-dpb>.
		1072
1100	=item B<insecure:> I<boolean>	1073	=item B<insecure:> I<boolean>
1101		1074
1102	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	1075	Enable "insecure" mode. Rxvt-unicode offers some escape sequences that
1103	echo arbitrary strings like the icon name or the locale. This could be	1076	echo arbitrary strings like the icon name or the locale. This could be
1104	abused if somebody gets 8-bit-clean access to your display, whether	1077	abused if somebody gets 8-bit-clean access to your display, whether
1105	through a mail client displaying mail bodies unfiltered or through	1078	through a mail client displaying mail bodies unfiltered or through
1106	write(1) or any other means. Therefore, these sequences are disabled by	1079	write(1) or any other means. Therefore, these sequences are disabled by
1107	default. (Note that many other terminals, including xterm, have these	1080	default. (Note that many other terminals, including xterm, have these
…		…
1125		1098
1126	=item B<secondaryScreen:> I<boolean>	1099	=item B<secondaryScreen:> I<boolean>
1127		1100
1128	Turn on/off secondary screen (default enabled).	1101	Turn on/off secondary screen (default enabled).
1129		1102
		1103	=item B<rewrapMode:> I<mode>
		1104
		1105	Sets long line rewrap behaviour on window resize to one of B<auto>
		1106	(default), B<always> or B<never>.
		1107
1130	=item B<secondaryScroll:> I<boolean>	1108	=item B<secondaryScroll:> I<boolean>
1131		1109
1132	Turn on/off secondary screen scroll (default enabled). If this	1110	Turn on/off secondary screen scroll (default enabled). If this
1133	option is enabled, scrolls on the secondary screen will change the	1111	option is enabled, scrolls on the secondary screen will change the
1134	scrollback buffer and, when secondaryScreen is off, switching	1112	scrollback buffer and, when secondaryScreen is off, switching
…		…
1146	Sets the working directory for the shell (or the command specified via	1124	Sets the working directory for the shell (or the command specified via
1147	B<-e>). The I<path> must be an absolute path and it must exist for	1125	B<-e>). The I<path> must be an absolute path and it must exist for
1148	@@RXVT_NAME@@ to start. If it isn't specified then the current working	1126	@@RXVT_NAME@@ to start. If it isn't specified then the current working
1149	directory will be used; option B<-cd>.	1127	directory will be used; option B<-cd>.
1150		1128
1151	=item B<keysym.>I<sym>: I<string>	1129	=item B<keysym.>I<sym>: I<action>
1152		1130
1153	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1131	Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1154	intervening resource name B<keysym.> cannot be omitted.	1132	resource name B<keysym.> cannot be omitted.
1155		1133
1156	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be	1134	Using this resource, you can map key combinations such as
1157	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,	1135	C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1158	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,	1136	string than would normally result from that combination, making the
1159	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,	1137	terminal scroll up or down the way you want it, or any other thing an
1160	B<2>, B<3>, B<4>, B<5>.	1138	extension might provide.
		1139
		1140	The key combination that triggers the action, I<sym>, has the following format:
		1141
		1142	(modifiers-)key
		1143
		1144	Where I<modifiers> can be any combination of the following full or
		1145	abbreviated modifier names:
		1146
		1147	=begin table
		1148
		1149	B<ISOLevel3> B<I>
		1150	B<AppKeypad> B<K>
		1151	B<Control> B<C>
		1152	B<NumLock> B<N>
		1153	B<Shift> B<S>
		1154	B<Meta> B<M> I<or> B<A>
		1155	B<Lock> B<L>
		1156	B<Mod1> B<1>
		1157	B<Mod2> B<2>
		1158	B<Mod3> B<3>
		1159	B<Mod4> B<4>
		1160	B<Mod5> B<5>
		1161
		1162	=end table
1161		1163
1162	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to	1164	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1163	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr	1165	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1164	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the	1166	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1165	current application keymap mode state.	1167	current application keymap mode state.
1166		1168
1167	The spellings of I<key> can be obtained by using B<xev>(1) command or	1169	Due the the large number of modifier combinations, a key mapping will
1168	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1170	match if I<at least> the specified identifiers are being set, and no other
		1171	key mappings with those and more bits are being defined. That means that
		1172	defining a mapping for C<a> will automatically provide definitions for
		1173	C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
		1174	themselves. See the C<builtin:> action, below, for a way to work around
		1175	this when this is a problem.
		1176
		1177	The spelling of I<key> depends on your implementation of X. An easy way to
		1178	find a key name is to use the B<xev>(1) command. You can find a list by
		1179	looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1169	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1180	the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1170	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1181	value (B<0x0000 - 0xFFFF>).
1171	performed in an exact manner; however, the closest match is assured.
1172		1182
1173	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1183	As with any resource value, the I<action> string may contain backslash
		1184	escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1174	number), see RESOURCES in C<man 7 X> for futher details.	1185	number), see RESOURCES in C<man 7 X> for further details.
1175		1186
1176	You can define a range of keysyms in one shot by providing a I<string>	1187	An action starts with an action prefix that selects a certain type
1177	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1188	of action, followed by a colon. An action string without colons is
		1189	interpreted as a literal string to pass to the tty (as if it was
		1190	prefixed with C<string:>).
		1191
		1192	The following action prefixes are known - extensions can provide
		1193	additional prefixes:
		1194
		1195	=over
		1196
		1197	=item string:STRING
		1198
		1199	If the I<action> starts with C<string:> (or otherwise contains no colons),
		1200	then the remaining C<STRING> will be passed to the program running in the
		1201	terminal. For example, you could replace whatever Shift-Tab outputs by the
		1202	string C<echo rm -rf /> followed by a newline:
		1203
		1204	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
		1205
		1206	This could in theory be used to completely redefine your keymap.
		1207
		1208	In addition, for actions of this type, you can define a range of
		1209	keysyms in one shot by loading the C<keysym-list> perl extension and
		1210	providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1178	should be a character not used by the strings.	1211	the delimiter `/' should be a character not used by the strings.
1179		1212
1180	Its usage can be demonstrated by an example:	1213	Its usage can be demonstrated by an example:
1181		1214
1182	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1215	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1183		1216
1184	The above line is equivalent to the following three lines:	1217	The above line is equivalent to the following three lines:
1185		1218
1186	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1219	URxvt.keysym.Meta-Control-0x61: string:\033<a>
1187	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1220	URxvt.keysym.Meta-Control-0x62: string:\033<b>
1188	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1221	URxvt.keysym.Meta-Control-0x63: string:\033<c>
1189		1222
		1223	=item command:STRING
		1224
1190	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1225	If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1191	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1226	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
		1227	the opposite of C<string:> - instead of sending it to the program running
		1228	in the terminal, it will be treated as if it were program output). This is
		1229	most useful to feed command sequences into @@RXVT_NAME@@.
		1230
1192	example the following means "change the current locale to C<zh_CN.GBK>	1231	For example the following means "change the current locale to C<zh_CN.GBK>
1193	when Control-Meta-c is being pressed":	1232	when Control-Meta-c is being pressed":
1194		1233
1195	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1234	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1196		1235
1197	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1236	The following example will map Control-Meta-1 and Control-Meta-2 to
1198	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)	1237	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1199	manpage. For example, the F<selection> extension (activated via	1238	font-switching at runtime:
1200	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1201		1239
1202	URxvt.keysym.M-C-c: perl:selection:rot13	1240	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1241	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1203		1242
1204	Due the the large number of modifier combinations, a defined key mapping	1243	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1205	will match if at I<at least> the specified identifiers are being set, and	1244	info):
1206	no other key mappings with those and more bits are being defined. That
1207	means that defining a key map for C<a> will automatically provide
1208	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1209	mappings themselves.
1210		1245
1211	Unfortunately, this will override built-in key mappings. For example	1246	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1247	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1248
		1249	=item builtin:
		1250
		1251	The builtin action is the action that @@RXVT_NAME@@ would execute if no
		1252	key binding existed for the key combination. The obvious use is to undo
		1253	the effect of existing bindings. The not so obvious use is to reinstate
		1254	bindings when another binding overrides too many modifiers.
		1255
1212	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s	1256	For example if you overwrite the C<Insert> key you will disable
1213	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the	1257	@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1214	user-defined keymap using the C<builtin:> replacement:	1258	"holes" into the user-defined keymap using the C<builtin:> replacement:
1215		1259
1216	URxvt.keysym.Insert: <my insert key sequence>	1260	URxvt.keysym.Insert: <my insert key sequence>
1217	URxvt.keysym.S-Insert: builtin:	1261	URxvt.keysym.S-Insert: builtin:
1218		1262
1219	The first line defines a mapping for C<Insert> and I<any> combination	1263	The first line defines a mapping for C<Insert> and I<any> combination
1220	of modifiers. The second line re-establishes the default mapping for	1264	of modifiers. The second line re-establishes the default mapping for
1221	C<Shift-Insert>.	1265	C<Shift-Insert>.
1222		1266
1223	The following example will map Control-Meta-1 and Control-Meta-2 to	1267	=item builtin-string:
1224	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1225	font-switching at runtime:
1226		1268
1227	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1269	This action is mainly useful to restore string mappings for keys that
1228	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007	1270	have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
		1271	difficult to explain - basically, this action will send the string to the
		1272	application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
		1273	action for it.
1229		1274
1230	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1275	An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1231	info):	1276	selection when you press C<Shift-Insert>. With the following bindings, it
		1277	would instead emit the (undocumented, but what applications running in the
		1278	terminal might expect) sequence C<ESC [ 2 $> instead:
1232		1279
1233	URxvt.keysym.M-C-3: command:\033[8;25;80t	1280	URxvt.keysym.S-Insert: builtin-string:
1234	URxvt.keysym.M-C-4: command:\033[8;48;110t	1281	URxvt.keysym.C-S-Insert: builtin:
		1282
		1283	The first line disables the paste functionality for that key
		1284	combination, and the second reinstates the default behaviour for
		1285	C<Control-Shift-Insert>, which would otherwise be overridden.
		1286
		1287	Similarly, to let applications gain access to the C<C-M-c> (copy to
		1288	clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
		1289	this:
		1290
		1291	URxvt.keysym.C-M-c: builtin-string:
		1292	URxvt.keysym.C-M-v: builtin-string:
		1293
		1294	=item EXTENSION:STRING
		1295
		1296	An action of this form invokes the action B<STRING>, if any, provided
		1297	by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
		1298	be loaded automatically if necessary.
		1299
		1300	Not all extensions define actions, but popular extensions that do
		1301	include the I<selection> and I<matcher> extensions (documented in their
		1302	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
		1303	respectively).
		1304
		1305	From the silly examples department, this will rot13-"encrypt"
		1306	@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
		1307	keyboards:
		1308
		1309	URxvt.keysym.M-C-c: selection:rot13
		1310
		1311	=item perl:STRING DEPRECATED
		1312
		1313	This is a deprecated way of invoking commands provided by perl
		1314	extensions. It is still supported, but should not be used anymore.
		1315
		1316	=back
1235		1317
1236	=item B<perl-ext-common>: I<string>	1318	=item B<perl-ext-common>: I<string>
1237		1319
1238	=item B<perl-ext>: I<string>	1320	=item B<perl-ext>: I<string>
1239		1321
1240	Comma-separated list(s) of perl extension scripts (default: C<default>) to	1322	Comma-separated list(s) of perl extension scripts (default: C<default>) to
1241	use in this terminal instance; option B<-pe>.	1323	use in this terminal instance; option B<-pe>.
1242		1324
1243	Extension names can be prefixed with a C<-> sign to prohibit using	1325	Extension names can be prefixed with a C<-> sign to remove them again, in
1244	them. This can be useful to selectively disable some extensions loaded	1326	case they had been specified earlier. This can be useful to selectively
1245	by default, or specified via the C<perl-ext-common> resource. For	1327	disable some extensions loaded by default, or specified via the
1246	example, C<default,-selection> will use all the default extension except	1328	C<perl-ext-common> resource. For example, C<default,-selection> will use
1247	C<selection>.	1329	all the default extensions except C<selection>.
1248		1330
1249	Extension names can also be followed by an argument in angle brackets	1331	To prohibit autoloading of extensions, you can prefix them with C</>,
1250	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1332	which will make urxvt refuse to automatically load them (this can be
1251	searchable scrollback to Alt/Meta-s). Mentioning the same extension	1333	overridden, however, by specifying the extension name again without a
1252	multiple times with different arguments will pass multiple arguments to	1334	prefix, though). This does not prohibit extensions themselves loading
1253	the extension.	1335	other extensions. For example, C<default,/background> will keep the
		1336	C<background> extension from being loaded when a background OSC sequence
		1337	is received.
		1338
		1339	The default set includes the C<selection>, C<option-popup>,
		1340	C<selection-popup>, C<readline>, C<searchable-scrollback> and
		1341	C<confirm-paste> extensions, as well as any extensions which are mentioned
		1342	in B<keysym> resources.
		1343
		1344	Any extension such that a corresponding resource is given on the
		1345	command line is automatically appended to B<perl-ext>.
1254		1346
1255	Each extension is looked up in the library directories, loaded if	1347	Each extension is looked up in the library directories, loaded if
1256	necessary, and bound to the current terminal instance.	1348	necessary, and bound to the current terminal instance. When the library
		1349	search path contains multiple extension files of the same name, then the
		1350	first one found will be used.
1257		1351
1258	If both of these resources are the empty string, then the perl	1352	If both of these resources are the empty string, then the perl interpreter
1259	interpreter will not be initialized. The idea behind two options is that	1353	will not be initialized. The rationale for having two options is that
1260	B<perl-ext-common> will be used for extensions that should be available to	1354	B<perl-ext-common> will be used for extensions that should be available to
1261	all instances, while B<perl-ext> is used for specific instances.	1355	all instances, while B<perl-ext> is used for specific instances.
1262		1356
1263	=item B<perl-eval>: I<string>	1357	=item B<perl-eval>: I<string>
1264		1358
…		…
1266	the @@RXVT_NAME@@perl(3) manpage.	1360	the @@RXVT_NAME@@perl(3) manpage.
1267		1361
1268	=item B<perl-lib>: I<path>	1362	=item B<perl-lib>: I<path>
1269		1363
1270	Colon-separated list of additional directories that hold extension	1364	Colon-separated list of additional directories that hold extension
1271	scripts. When looking for extensions specified by the C<perl> resource,	1365	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1272	@@RXVT_NAME@@ will first look in these directories and then in	1366	in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1273	F<@@RXVT_LIBDIR@@/urxvt/perl/>.	1367	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1274		1368
1275	See the @@RXVT_NAME@@perl(3) manpage.	1369	See the @@RXVT_NAME@@perl(3) manpage.
1276		1370
1277	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1371	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1278		1372
…		…
1282	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>	1376	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1283		1377
1284	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage	1378	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1285	for details.	1379	for details.
1286		1380
1287	=item B<searchable-scrollback:> I<keysym>	1381	=item B<searchable-scrollback:> I<keysym> DEPRECATED
1288		1382
1289	Sets the hotkey that starts the incremental scrollback buffer search	1383	This resource is deprecated and will be removed. Use a B<keysym> resource
1290	(default: C<M-s>).	1384	instead, e.g.:
1291		1385
		1386	URxvt.keysym.M-s: searchable-scrollback:start
		1387
1292	=item B<urlLauncher>: I<string>	1388	=item B<url-launcher>: I<string>
1293		1389
1294	Specifies the program to be started with a URL argument. Used by the	1390	Specifies the program to be started with a URL argument. Used by the
1295	C<selection-popup> and C<matcher> perl extensions.	1391	C<selection-popup> and C<matcher> perl extensions.
1296		1392
1297	=item B<transient-for>: I<windowid>	1393	=item B<transient-for>: I<windowid>
…		…
1341	=head1 THE SELECTION: SELECTING AND PASTING TEXT	1437	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1342		1438
1343	The behaviour of text selection and insertion/pasting mechanism is similar	1439	The behaviour of text selection and insertion/pasting mechanism is similar
1344	to I<xterm>(1).	1440	to I<xterm>(1).
1345		1441
1346	=over 4	1442	=over
1347		1443
1348	=item B<Selecting>:	1444	=item B<Selecting>:
1349		1445
1350	Left click at the beginning of the region, drag to the end of the region	1446	Left click at the beginning of the region, drag to the end of the region
1351	and release; Right click to extend the marked region; Left double-click	1447	and release; Right click to extend the marked region; Left double-click
…		…
1366	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.	1462	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1367		1463
1368	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1464	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1369	inserted too.	1465	inserted too.
1370		1466
		1467	rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
		1468	<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
		1469	binding causes the value of the internal selection to be copied to the
		1470	CLIPBOARD selection, while the second binding causes the value of the
		1471	CLIPBOARD selection to be inserted.
		1472
1371	=back	1473	=back
1372		1474
1373	=head1 CHANGING FONTS	1475	=head1 CHANGING FONTS
1374		1476
1375	Changing fonts (or font sizes, respectively) via the keypad is not yet	1477	Changing fonts (or font sizes, respectively) via the keypad is not yet
…		…
1392	and character codes using the keyboard. It consists of 4 parts. The	1494	and character codes using the keyboard. It consists of 4 parts. The
1393	first part is available if rxvt-unicode has been compiled with	1495	first part is available if rxvt-unicode has been compiled with
1394	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1496	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1395	with C<--enable-iso14755>.	1497	with C<--enable-iso14755>.
1396		1498
1397	=over 4	1499	=over
1398		1500
1399	=item * 5.1: Basic method	1501	=item * 5.1: Basic method
1400		1502
1401	This allows you to enter unicode characters using their hexcode.	1503	This allows you to enter unicode characters using their hexcode.
1402		1504
…		…
1456	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1558	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1457	it can be seen via the I<who(1)> command, and can accept messages. To	1559	it can be seen via the I<who(1)> command, and can accept messages. To
1458	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1560	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1459	on some systems or setgid to root or to some other group on others.	1561	on some systems or setgid to root or to some other group on others.
1460		1562
1461	=head1 COLORS AND GRAPHICS	1563	=head1 COLOURS AND GRAPHICS
1462		1564
1463	In addition to the default foreground and background colours,	1565	In addition to the default foreground and background colours,
1464	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1566	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1465	high-intensity bold/blink versions of the same). Here is a list of the	1567	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1466	colours with their names.	1568	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1569	cube plus a 8 (24) colour greyscale ramp.
		1570
		1571	B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
		1572	C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
		1573	number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
		1574	colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
		1575	24-bit colour space. When indexing collisions happen, the nearest old colour in
		1576	the cube will be adapted to the new 24-bit RGB colour. That means one cannot
		1577	use many similar 24-bit colours. It's typically not a problem in common
		1578	scenarios.
		1579
		1580	Here is a list of the ANSI colours with their names.
1467		1581
1468	=begin table	1582	=begin table
1469		1583
1470	B<color0> (black) = Black	1584	B<color0> (black) = Black
1471	B<color1> (red) = Red3	1585	B<color1> (red) = Red3
…		…
1491	It is also possible to specify the colour values of B<foreground>,	1605	It is also possible to specify the colour values of B<foreground>,
1492	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1606	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1493	a number 0-15, as a convenient shorthand to reference the colour name of	1607	a number 0-15, as a convenient shorthand to reference the colour name of
1494	color0-color15.	1608	color0-color15.
1495		1609
1496	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1610	The following text gives values for the standard 88 colour mode (and
1497	additional 72 colours. The first 64 of those (with indices 16 to 79)	1611	values for the 256 colour mode in parentheses).
1498	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1499	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1500		1612
		1613	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1614
		1615	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1616	index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
		1617
		1618	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1619	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1620	the RGB cube.
		1621
1501	Together, all those colours implement the 88 colour xterm colours. Only	1622	Together, all those colours implement the 88 (256) colour xterm
1502	the first 16 can be changed using resources currently, the rest can only	1623	colours. Only the first 16 can be changed using resources currently, the
1503	be changed via command sequences ("escape codes").	1624	rest can only be changed via command sequences ("escape codes").
		1625
		1626	Applications are advised to use terminfo or command sequences to discover
		1627	number and RGB values of all colours (yes, you can query this...).
1504		1628
1505	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1629	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1506	always swapping the foreground/background colours. This is in contrast to	1630	always swapping the foreground/background colours. This is in contrast to
1507	I<xterm>(1) where the colours are only swapped if they have not otherwise	1631	I<xterm>(1) where the colours are only swapped if they have not otherwise
1508	been specified. For example,	1632	been specified. For example,
…		…
1513	White.	1637	White.
1514		1638
1515	=head2 ALPHA CHANNEL SUPPORT	1639	=head2 ALPHA CHANNEL SUPPORT
1516		1640
1517	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1641	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1518	their act together, rxvt-unicode will do it's own alpha channel management:	1642	their act together, rxvt-unicode will do its own alpha channel management:
1519		1643
1520	You can prefix any color with an opaquenes percentage enclosed in	1644	You can prefix any colour with an opaqueness percentage enclosed in
1521	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage	1645	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1522	(0-100) that specifies the opacity of the color, where C<0> is completely	1646	(0-100) that specifies the opacity of the colour, where C<0> is completely
1523	transparent and C<100> is completely opaque. For example, C<[50]red> is a	1647	transparent and C<100> is completely opaque. For example, C<[50]red> is a
1524	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This	1648	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1525	is the recommended format to specify transparency values, and works with	1649	is the recommended format to specify transparency values, and works with
1526	all ways to specify a colour.	1650	all ways to specify a colour.
1527		1651
…		…
1560		1684
1561	=head1 ENVIRONMENT	1685	=head1 ENVIRONMENT
1562		1686
1563	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1687	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1564		1688
1565	=over 4	1689	=over
1566		1690
1567	=item B<TERM>	1691	=item B<TERM>
1568		1692
1569	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1693	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1570	resources or on the command line.	1694	resources or on the command line.
…		…
1605		1729
1606	=item B<SHELL>	1730	=item B<SHELL>
1607		1731
1608	The shell to be used for command execution, defaults to C</bin/sh>.	1732	The shell to be used for command execution, defaults to C</bin/sh>.
1609		1733
1610	=item B<RXVT_SOCKET>	1734	=item B<RXVT_SOCKET> [I<sic>]
1611		1735
1612	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1736	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1613	@@RXVT_NAME@@d(1).	1737	@@RXVT_NAME@@d(1).
1614		1738
1615	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1739	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1740
		1741	=item B<URXVT_PERL_LIB>
		1742
		1743	Additional F<:>-separated library search path for perl extensions. Will be
		1744	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1745	directory.
		1746
		1747	=item B<URXVT_PERL_VERBOSITY>
		1748
		1749	See L<@@RXVT_NAME@@perl>(3).
1616		1750
1617	=item B<HOME>	1751	=item B<HOME>
1618		1752
1619	Used to locate the default directory for the unix domain socket for	1753	Used to locate the default directory for the unix domain socket for
1620	daemon communications and to locate various resource files (such as	1754	daemon communications and to locate various resource files (such as
1621	C<.Xdefaults>)	1755	C<.Xdefaults>)
1622		1756
1623	=item B<XAPPLRESDIR>	1757	=item B<XAPPLRESDIR>
1624		1758
1625	Directory where various X resource files are being located.	1759	Directory where application-specific X resource files are located.
1626		1760
1627	=item B<XENVIRONMENT>	1761	=item B<XENVIRONMENT>
1628		1762
1629	If set and accessible, gives the name of a X resource file to be loaded by	1763	If set and accessible, gives the name of a X resource file to be loaded by
1630	@@RXVT_NAME@@.	1764	@@RXVT_NAME@@.
1631		1765
1632	=back	1766	=back
1633		1767
1634	=head1 FILES	1768	=head1 FILES
1635		1769
1636	=over 4	1770	=over
1637		1771
1638	=item B</usr/lib/X11/rgb.txt>	1772	=item B</usr/lib/X11/rgb.txt>
1639		1773
1640	Color names.	1774	Colour names.
1641		1775
1642	=back	1776	=back
1643		1777
1644	=head1 SEE ALSO	1778	=head1 SEE ALSO
1645		1779
		1780	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1646	@@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)	1781	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1647		1782
1648	=head1 CURRENT PROJECT COORDINATOR	1783	=head1 CURRENT PROJECT COORDINATOR
1649		1784
1650	=over 4	1785	=over
1651		1786
1652	=item Project Coordinator	1787	=item Project Coordinator
1653		1788
1654	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1789	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1655		1790
1656	L<http://software.schmorp.de/pkg/rxvt-unicode.html>	1791	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1657		1792
1658	=back	1793	=back
1659		1794
1660	=head1 AUTHORS	1795	=head1 AUTHORS
1661		1796
1662	=over 4	1797	=over
1663		1798
1664	=item John Bovey	1799	=item John Bovey
1665		1800
1666	University of Kent, 1992, wrote the original Xvt.	1801	University of Kent, 1992, wrote the original Xvt.
1667		1802
1668	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>	1803	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1669		1804
1670	very heavily modified Xvt and came up with Rxvt	1805	very heavily modified Xvt and came up with Rxvt
1671		1806
1672	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>	1807	=item Angelo Haritsis <ah@doc.ic.ac.uk>
1673		1808
1674	wrote the Greek Keyboard Input (no longer in code)	1809	wrote the Greek Keyboard Input (no longer in code)
1675		1810
1676	=item mj olesen L<< <olesen@me.QueensU.CA> >>	1811	=item mj olesen <olesen@me.QueensU.CA>
1677		1812
1678	Wrote the menu system.	1813	Wrote the menu system.
1679		1814
1680	Project Coordinator (changes.txt 2.11 to 2.21)	1815	Project Coordinator (changes.txt 2.11 to 2.21)
1681		1816
1682	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>	1817	=item Oezguer Kesim <kesim@math.fu-berlin.de>
1683		1818
1684	Project Coordinator (changes.txt 2.21a to 2.4.5)	1819	Project Coordinator (changes.txt 2.21a to 2.4.5)
1685		1820
1686	=item Geoff Wing L<< <gcw@pobox.com> >>	1821	=item Geoff Wing <gcw@pobox.com>
1687		1822
1688	Rewrote screen display and text selection routines.	1823	Rewrote screen display and text selection routines.
1689		1824
1690	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1825	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1691		1826
1692	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1827	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1693		1828
1694	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1829	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1695	extension, random hacks, numerous bugfixes and extensions.	1830	extension, random hacks, numerous bugfixes and extensions.
1696		1831
1697	Project Coordinator (Changes 1.0 -)	1832	Project Coordinator (Changes 1.0 -)
1698		1833
1699	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1834	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1700		1835
1701	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1836	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1702		1837
1703	=back	1838	=back
1704		1839

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.176 by sf-exg, Sat Apr 17 23:00:45 2010 UTC vs. Revision 1.260 by root, Fri Dec 23 21:46:46 2022 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.176 by sf-exg, Sat Apr 17 23:00:45 2010 UTC vs.
Revision 1.260 by root, Fri Dec 23 21:46:46 2022 UTC