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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.127 by ayin, Wed May 2 23:06:32 2007 UTC vs.
Revision 1.213 by sf-exg, Sat Feb 4 21:47:06 2012 UTC

…		…
12	emulator intended as an I<xterm>(1) replacement for users who do not	12	emulator intended as an I<xterm>(1) replacement for users who do not
13	require features such as Tektronix 4014 emulation and toolkit-style	13	require features such as Tektronix 4014 emulation and toolkit-style
14	configurability. As a result, B<rxvt-unicode> uses much less swap space --	14	configurability. As a result, B<rxvt-unicode> uses much less swap space --
15	a significant advantage on a machine serving many X sessions.	15	a significant advantage on a machine serving many X sessions.
16		16
		17	This document is also available on the World-Wide-Web at
		18	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
		19
17	=head1 FREQUENTLY ASKED QUESTIONS	20	=head1 FREQUENTLY ASKED QUESTIONS
18		21
19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of	22	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20	frequently asked questions and answer to them and some common	23	frequently asked questions and answer to them and some common
21	problems. That document is also accessible on the World-Wide-Web at	24	problems. That document is also accessible on the World-Wide-Web at
22	L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.	25	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23		26
24	=head1 RXVT-UNICODE VS. RXVT	27	=head1 RXVT-UNICODE VS. RXVT
25		28
26	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode	29	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27	internally. That means it can store and display most scripts in the	30	internally. That means it can store and display most scripts in the
28	world. Being a terminal emulator, however, some things are very difficult,	31	world. Being a terminal emulator, however, some things are very difficult,
29	especially cursive scripts such as arabic, vertically written scripts	32	especially cursive scripts such as arabic, vertically written scripts
30	like mongolian or scripts requiring extremely complex combining rules,	33	like mongolian or scripts requiring extremely complex combining rules,
31	like tibetan or devenagari. Don't expect pretty output when using these	34	like tibetan or devanagari. Don't expect pretty output when using these
32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	35	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33	fine, though. A somewhat difficult case are right-to-left scripts, such	36	fine, though. A somewhat difficult case are right-to-left scripts, such
34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	37	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35	belong into the application, not the terminal emulator (too many things --	38	belong in the application, not the terminal emulator (too many things --
36	such as cursor-movement while editing -- break otherwise), but that might	39	such as cursor-movement while editing -- break otherwise), but that might
37	change.	40	change.
38		41
39	If you are looking for a terminal that supports more exotic scripts, let	42	If you are looking for a terminal that supports more exotic scripts, let
40	me recommend C<mlterm>, which is a very user friendly, lean and clean	43	me recommend C<mlterm>, which is a very user friendly, lean and clean
…		…
89		92
90	Print out a message describing available options.	93	Print out a message describing available options.
91		94
92	=item B<-display> I<displayname>	95	=item B<-display> I<displayname>
93		96
94	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>
95	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
96	B<DISPLAY> environment variable is used.	99	display specified by the B<DISPLAY> environment variable is used.
97		100
98	=item B<-depth> I<bitdepth>	101	=item B<-depth> I<bitdepth>
99		102
100	Compile I<xft>: Attempt to find a visual with the given bit depth;	103	Compile I<xft>: Attempt to find a visual with the given bit depth;
101	resource B<depth>.	104	resource B<depth>.
102		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
103	=item B<-geometry> I<geom>	111	=item B<-geometry> I<geom>
104		112
105	Window geometry (B<-g> still respected); resource B<geometry>.	113	Window geometry (B<-g> still respected); resource B<geometry>.
106		114
107	=item B<-rv>\|B<+rv>	115	=item B<-rv>\|B<+rv>
108		116
109	Turn on/off simulated reverse video; resource B<reverseVideo>.	117	Turn on/off simulated reverse video; resource B<reverseVideo>.
110		118
111	=item B<-j>\|B<+j>	119	=item B<-j>\|B<+j>
112		120
113	Turn on/off jump scrolling; resource B<jumpScroll>.	121	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
114		122
115	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>	123	=item B<-ss>\|B<+ss>
116		124
117	Turn on/off inheriting parent window's pixmap. Alternative form is	125	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118	B<-tr>; resource B<inheritPixmap>.
119		126
120	I<Please note that transparency of any kind if completely unsupported by	127	=item B<-tr>\|B<+tr>
121	the author. Don't bug him with installation questions! Read the FAQ (man 7	128
122	@@RXVT_NAME@@)!>	129	Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>.
		130
		131	B<-ip> is still accepted as an obsolete alias but will be removed in
		132	future versions.
123		133
124	=item B<-fade> I<number>	134	=item B<-fade> I<number>
125		135
126	Fade the text by the given percentage when focus is lost. Small values	136	Fade the text by the given percentage when focus is lost. Small values
127	fade a little only, 100 completely replaces all colours by the fade	137	fade a little only, 100 completely replaces all colours by the fade
…		…
132	Fade to this colour when fading is used (see B<-fade>). The default colour	142	Fade to this colour when fading is used (see B<-fade>). The default colour
133	is opaque black. resource B<fadeColor>.	143	is opaque black. resource B<fadeColor>.
134		144
135	=item B<-tint> I<colour>	145	=item B<-tint> I<colour>
136		146
137	Tint the transparent background pixmap with the given colour when	147	Tint the transparent background with the given colour;
138	transparency is enabled with B<-tr> or B<-ip>. This only works for	148	resource I<tintColor>.
139	non-tiled backgrounds, currently. See also the B<-sh> option that can be
140	used to brighten or darken the image in addition to tinting it; resource
141	I<tintColor>. Example:
142		149
143	@@RXVT_NAME@@ -tr -tint blue -sh 40	150	=item B<-sh> I<number>
144		151
145	=item B<-sh>
146
147	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	152	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
148	background image in addition to tinting it (i.e. B<-tint> must be	153	A value of 100 means no shading; resource I<shading>.
149	specified, too, e.g. C<-tint white>); resource I<shading>.	154
		155	=item B<-blr> I<HxV>
		156
		157	Apply Gaussian Blur with the specified radii to the transparent
		158	background. If a single number is specified, the vertical and
		159	horizontal radii are considered to be the same. Setting one of the
		160	radii to 1 and the other to a large number creates interesting effects
		161	on some backgrounds. The maximum radius value is 128. An horizontal or
		162	vertical radius of 0 disables blurring;
		163	resource I<blurRadius>.
		164
		165	=item B<-icon> I<file>
		166
		167	Compile I<pixbuf>: Use the specified image as application icon. This
		168	is used by many window managers, taskbars and pagers to represent the
		169	application window; resource I<iconFile>.
150		170
151	=item B<-bg> I<colour>	171	=item B<-bg> I<colour>
152		172
153	Window background colour; resource B<background>.	173	Window background colour; resource B<background>.
154		174
155	=item B<-fg> I<colour>	175	=item B<-fg> I<colour>
156		176
157	Window foreground colour; resource B<foreground>.	177	Window foreground colour; resource B<foreground>.
158		178
159	=item B<-pixmap> I<file[;geom]>	179	=item B<-pixmap> I<file[;oplist]>
160		180
161	Compile I<XPM>: Specify XPM file for the background and also optionally	181	Compile I<pixbuf>: Specify image file for the background and also
162	specify its scaling with a geometry string. Note you may need to	182	optionally specify a list of operations to modify it. Note you may need to
163	add quotes to avoid special shell interpretation of the C<;> in the	183	add quotes to avoid special shell interpretation of the C<;> in the
164	command-line; resource B<backgroundPixmap>.	184	command-line; for more details see resource B<backgroundPixmap>.
165		185
166	=item B<-cr> I<colour>	186	=item B<-cr> I<colour>
167		187
168	The cursor colour; resource B<cursorColor>.	188	The cursor colour; resource B<cursorColor>.
169		189
…		…
214	italic> >> characters are to be printed. See resource B<boldItalicFont>	234	italic> >> characters are to be printed. See resource B<boldItalicFont>
215	for details.	235	for details.
216		236
217	=item B<-is>\|B<+is>	237	=item B<-is>\|B<+is>
218		238
219	Compile I<font-styles>: Bold/Italic font styles imply high intensity	239	Compile I<font-styles>: Bold/Blink font styles imply high intensity
220	foreground/background (default). See resource B<intensityStyles> for	240	foreground/background (default). See resource B<intensityStyles> for
221	details.	241	details.
222		242
223	=item B<-name> I<name>	243	=item B<-name> I<name>
224		244
…		…
242		262
243	=item B<-sb>\|B<+sb>	263	=item B<-sb>\|B<+sb>
244		264
245	Turn on/off scrollbar; resource B<scrollBar>.	265	Turn on/off scrollbar; resource B<scrollBar>.
246		266
		267	=item B<-sr>\|B<+sr>
		268
		269	Put scrollbar on right/left; resource B<scrollBar_right>.
		270
		271	=item B<-st>\|B<+st>
		272
		273	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		274	resource B<scrollBar_floating>.
		275
247	=item B<-si>\|B<+si>	276	=item B<-si>\|B<+si>
248		277
249	Turn on/off scroll-to-bottom on TTY output inhibit; resource	278	Turn on/off scroll-to-bottom on TTY output inhibit; resource
250	B<scrollTtyOutput> has opposite effect.	279	B<scrollTtyOutput> has opposite effect.
251		280
…		…
257	=item B<-sw>\|B<+sw>	286	=item B<-sw>\|B<+sw>
258		287
259	Turn on/off scrolling with the scrollback buffer as new lines appear.	288	Turn on/off scrolling with the scrollback buffer as new lines appear.
260	This only takes effect if B<-si> is also given; resource	289	This only takes effect if B<-si> is also given; resource
261	B<scrollWithBuffer>.	290	B<scrollWithBuffer>.
262
263	=item B<-sr>\|B<+sr>
264
265	Put scrollbar on right/left; resource B<scrollBar_right>.
266
267	=item B<-st>\|B<+st>
268
269	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
270	resource B<scrollBar_floating>.
271		291
272	=item B<-ptab>\|B<+ptab>	292	=item B<-ptab>\|B<+ptab>
273		293
274	If enabled (default), "Horizontal Tab" characters are being stored as	294	If enabled (default), "Horizontal Tab" characters are being stored as
275	actual wide characters in the screen buffer, which makes it possible to	295	actual wide characters in the screen buffer, which makes it possible to
…		…
279		299
280	=item B<-bc>\|B<+bc>	300	=item B<-bc>\|B<+bc>
281		301
282	Blink the cursor; resource B<cursorBlink>.	302	Blink the cursor; resource B<cursorBlink>.
283		303
		304	=item B<-uc>\|B<+uc>
		305
		306	Make the cursor underlined; resource B<cursorUnderline>.
		307
284	=item B<-iconic>	308	=item B<-iconic>
285		309
286	Start iconified, if the window manager supports that option.	310	Start iconified, if the window manager supports that option.
287	Alternative form is B<-ic>.	311	Alternative form is B<-ic>.
288		312
…		…
304		328
305	=item B<-bl>	329	=item B<-bl>
306		330
307	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	331	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
308	if honoured by the WM, the rxvt-unicode window will not have window	332	if honoured by the WM, the rxvt-unicode window will not have window
309	decorations; resource B<borderLess>.	333	decorations; resource B<borderLess>. If the window manager does not
		334	support MWM hints (e.g. kwin), enables override-redirect mode.
310		335
311	=item B<-override-redirect>	336	=item B<-override-redirect>
312		337
313	Compile I<frills>: Sets override-redirect on the window; resource	338	Compile I<frills>: Sets override-redirect on the window; resource
314	B<override-redirect>.	339	B<override-redirect>.
…		…
322		347
323	=item B<-lsp> I<number>	348	=item B<-lsp> I<number>
324		349
325	Compile I<frills>: Lines (pixel height) to insert between each row of	350	Compile I<frills>: Lines (pixel height) to insert between each row of
326	the display. Useful to work around font rendering problems; resource	351	the display. Useful to work around font rendering problems; resource
327	B<linespace>.	352	B<lineSpace>.
		353
		354	=item B<-letsp> I<number>
		355
		356	Compile I<frills>: Amount to adjust the computed character width by
		357	to control overall letter spacing. Negative values will tighten up the
		358	letter spacing, positive values will space letters out more. Useful to
		359	work around odd font metrics; resource B<letterSpace>.
328		360
329	=item B<-tn> I<termname>	361	=item B<-tn> I<termname>
330		362
331	This option specifies the name of the terminal type to be set in the	363	This option specifies the name of the terminal type to be set in the
332	B<TERM> environment variable. This terminal type must exist in the	364	B<TERM> environment variable. This terminal type must exist in the
…		…
386	for more info.	418	for more info.
387		419
388	=item B<-tcw>	420	=item B<-tcw>
389		421
390	Change the meaning of triple-click selection with the left mouse	422	Change the meaning of triple-click selection with the left mouse
		423	button. Only effective when the original (non-perl) selection code is
391	button. Instead of selecting a full line it will extend the selection the	424	in-use. Instead of selecting a full line it will extend the selection to
392	end of the logical line only. resource B<tripleclickwords>.	425	the end of the logical line only. resource B<tripleclickwords>.
393		426
394	=item B<-insecure>	427	=item B<-insecure>
395		428
396	Enable "insecure" mode, which currently enables most of the escape	429	Enable "insecure" mode, which currently enables most of the escape
397	sequences that echo strings. See the resource B<insecure> for more	430	sequences that echo strings. See the resource B<insecure> for more
…		…
417		450
418	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	451	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
419	will not immediately destroy its window when the program executed within	452	will not immediately destroy its window when the program executed within
420	it exits. Instead, it will wait till it is being killed or closed by the	453	it exits. Instead, it will wait till it is being killed or closed by the
421	user; resource B<hold>.	454	user; resource B<hold>.
		455
		456	=item B<-cd> I<path>
		457
		458	Sets the working directory for the shell (or the command specified via
		459	B<-e>). The I<path> must be an absolute path and it must exist for
		460	@@RXVT_NAME@@ to start; resource B<chdir>.
		461
		462	=item B<-xrm> I<string>
		463
		464	Works like the X Toolkit option of the same name, by adding the I<string>
		465	as if it were specified in a resource file. Resource values specified this
		466	way take precedence over all other resource specifications.
		467
		468	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		469	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		470	options can be specified as long-options on the commandline, so use
		471	of B<-xrm> is mostly limited to cases where you want to specify other
		472	resources (e.g. for input methods) or for compatibility with other
		473	programs.
422		474
423	=item B<-keysym.>I<sym> I<string>	475	=item B<-keysym.>I<sym> I<string>
424		476
425	Remap a key symbol. See resource B<keysym>.	477	Remap a key symbol. See resource B<keysym>.
426		478
…		…
461	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	513	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
462	entries and will not tinker with pty/tty permissions - you have to do that	514	entries and will not tinker with pty/tty permissions - you have to do that
463	yourself if you want that.	515	yourself if you want that.
464		516
465	As an extremely special case, specifying C<-1> will completely suppress	517	As an extremely special case, specifying C<-1> will completely suppress
466	pty/tty operations.	518	pty/tty operations, which is probably only useful in conjunction with some
		519	perl extension that manages the terminal.
467		520
468	Here is a example in perl that illustrates how this option can be used (a	521	Here is a example in perl that illustrates how this option can be used (a
469	longer example is in F<doc/pty-fd>):	522	longer example is in F<doc/pty-fd>):
470		523
471	use IO::Pty;	524	use IO::Pty;
…		…
485	Comma-separated list of perl extension scripts to use (or not to use) in	538	Comma-separated list of perl extension scripts to use (or not to use) in
486	this terminal instance. See resource B<perl-ext> for details.	539	this terminal instance. See resource B<perl-ext> for details.
487		540
488	=back	541	=back
489		542
490	=head1 RESOURCES (available also as long-options)	543	=head1 RESOURCES
491		544
492	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	545	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
493	options) compiled into your version.	546	options) compiled into your version. All resources are also available as
		547	long-options.
494		548
495	You can set and change the resources using X11 tools like B<xrdb>. Many	549	You can set and change the resources using X11 tools like B<xrdb>. Many
496	distribution do also load settings from the B<~/.Xresources> file when X	550	distribution do also load settings from the B<~/.Xresources> file when X
497	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	551	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
498	with later settings overwriting earlier ones:	552	with later settings overwriting earlier ones:
499		553
500	1. system-wide app-defaults file, either locale-dependent OR global
501	2. app-defaults file in $XAPPLRESDIR	554	1. app-defaults file in $XAPPLRESDIR
		555	2. $HOME/.Xdefaults
502	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	556	3. RESOURCE_MANAGER property on root-window of screen 0
503	4. SCREEN_RESOURCES for the current screen	557	4. SCREEN_RESOURCES property on root-window of the current screen
504	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	558	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		559	6. resources specified via -xrm on the commandline
505		560
506	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	561	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
507	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	562	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
508	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily	563	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
509	configured, while the class name B<URxvt> allows resources unique to	564	configured, while the class name B<URxvt> allows resources unique to
…		…
519	=item B<depth:> I<bitdepth>	574	=item B<depth:> I<bitdepth>
520		575
521	Compile I<xft>: Attempt to find a visual with the given bit depth;	576	Compile I<xft>: Attempt to find a visual with the given bit depth;
522	option B<-depth>.	577	option B<-depth>.
523		578
		579	=item B<buffered:> I<boolean>
		580
		581	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		582	On some card/driver combination enabling it slightly decreases
		583	performance, on most it greatly helps it. The slowdown is small, so it
		584	should normally be enabled.
		585
524	=item B<geometry:> I<geom>	586	=item B<geometry:> I<geom>
525		587
526	Create the window with the specified X window geometry [default 80x24];	588	Create the window with the specified X window geometry [default 80x24];
527	option B<-geometry>.	589	option B<-geometry>.
528		590
…		…
541	Use the specified colour for the colour value I<n>, where 0-7	603	Use the specified colour for the colour value I<n>, where 0-7
542	corresponds to low-intensity (normal) colours and 8-15 corresponds to	604	corresponds to low-intensity (normal) colours and 8-15 corresponds to
543	high-intensity (bold = bright foreground, blink = bright background)	605	high-intensity (bold = bright foreground, blink = bright background)
544	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	606	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
545	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	607	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
546	names used are listed in the B<COLORS AND GRAPHICS> section.	608	names used are listed in the B<COLOURS AND GRAPHICS> section.
547		609
548	Colours higher than 15 cannot be set using resources (yet), but can be	610	Colours higher than 15 cannot be set using resources (yet), but can be
549	changed using an escape command (see @@RXVT_NAME@@(7)).	611	changed using an escape command (see @@RXVT_NAME@@(7)).
550		612
551	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	613	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
562	=item B<colorUL:> I<colour>	624	=item B<colorUL:> I<colour>
563		625
564	Use the specified colour to display underlined characters when the	626	Use the specified colour to display underlined characters when the
565	foreground colour is the default.	627	foreground colour is the default.
566		628
567	=item B<colorRV:> I<colour>
568
569	Use the specified colour as the background for reverse video characters
570	when OPTION_HC is disabled (--disable-frills).
571
572	=item B<underlineColor:> I<colour>	629	=item B<underlineColor:> I<colour>
573		630
574	If set, use the specified colour as the colour for the underline	631	If set, use the specified colour as the colour for the underline
575	itself. If unset, use the foreground colour.	632	itself. If unset, use the foreground colour.
		633
		634	=item B<highlightColor:> I<colour>
		635
		636	If set, use the specified colour as the background for highlighted
		637	characters. If unset, use reverse video.
		638
		639	=item B<highlightTextColor:> I<colour>
		640
		641	If set and highlightColor is set, use the specified colour as the
		642	foreground for highlighted characters.
576		643
577	=item B<cursorColor:> I<colour>	644	=item B<cursorColor:> I<colour>
578		645
579	Use the specified colour for the cursor. The default is to use the	646	Use the specified colour for the cursor. The default is to use the
580	foreground colour; option B<-cr>.	647	foreground colour; option B<-cr>.
…		…
587		654
588	=item B<reverseVideo:> I<boolean>	655	=item B<reverseVideo:> I<boolean>
589		656
590	B<True>: simulate reverse video by foreground and background colours;	657	B<True>: simulate reverse video by foreground and background colours;
591	option B<-rv>. B<False>: regular screen colours [default]; option	658	option B<-rv>. B<False>: regular screen colours [default]; option
592	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	659	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
593		660
594	=item B<jumpScroll:> I<boolean>	661	=item B<jumpScroll:> I<boolean>
595		662
596	B<True>: specify that jump scrolling should be used. When scrolling	663	B<True>: specify that jump scrolling should be used. When receiving lots
597	quickly, fewer screen updates are performed [default]; option B<-j>.	664	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		665	has been read, resulting in fewer updates while still displaying every
		666	received line; option B<-j>.
		667
598	B<False>: specify that smooth scrolling should be used; option B<+j>.	668	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		669	force a screen refresh on each new line it received; option B<+j>.
599		670
600	=item B<inheritPixmap:> I<boolean>	671	=item B<skipScroll:> I<boolean>
601		672
602	B<True>: make the background inherit the parent windows' pixmap, giving	673	B<True>: (the default) specify that skip scrolling should be used. When
603	artificial transparency. B<False>: do not inherit the parent windows'	674	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
604	pixmap.	675	(around 60 times per second), resulting in far fewer updates. This can
		676	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		677	option B<-ss>.
605		678
606	I<Please note that transparency of any kind if completely unsupported by	679	B<False>: specify that everything is to be displayed, even
607	the author. Don't bug him with installation questions!>	680	if the refresh is too fast for the human eye to read anything (or the
		681	monitor to display anything); option B<+ss>.
		682
		683	=item B<transparent:> I<boolean>
		684
		685	Turn on/off pseudo-transparency by using the root pixmap as background.
		686
		687	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
		688	future versions.
608		689
609	=item B<fading:> I<number>	690	=item B<fading:> I<number>
610		691
611	Fade the text by the given percentage when focus is lost; option B<-fade>.	692	Fade the text by the given percentage when focus is lost; option B<-fade>.
612		693
…		…
615	Fade to this colour, when fading is used (see B<fading:>). The default	696	Fade to this colour, when fading is used (see B<fading:>). The default
616	colour is black; option B<-fadecolor>.	697	colour is black; option B<-fadecolor>.
617		698
618	=item B<tintColor:> I<colour>	699	=item B<tintColor:> I<colour>
619		700
620	Tint the transparent background pixmap with the given colour; option	701	Tint the transparent background with the given colour. If the RENDER
621	B<-tint>.	702	extension is not available only black, red, green, yellow, blue,
		703	magenta, cyan and white tints can be performed server-side. Note that
		704	a black tint yields a completely black image while a white tint yields
		705	the image unchanged; option B<-tint>.
622		706
623	=item B<shading:> I<number>	707	=item B<shading:> I<number>
624		708
625	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image	709	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
626	in addition to tinting it; option B<-sh>.	710	A value of 100 means no shading; option B<-sh>.
		711
		712	=item B<blendType:> I<string>
		713
		714	Specify background blending type; option B<-blt>.
		715
		716	=item B<blurRadius:> I<number>
		717
		718	Apply gaussian blur with the specified radius to the transparent
		719	background; option B<-blr>.
		720
		721	=item B<iconFile:> I<file>
		722
		723	Set the application icon pixmap; option B<-icon>.
627		724
628	=item B<scrollColor:> I<colour>	725	=item B<scrollColor:> I<colour>
629		726
630	Use the specified colour for the scrollbar [default #B2B2B2].	727	Use the specified colour for the scrollbar [default #B2B2B2].
631		728
…		…
637	=item B<borderColor:> I<colour>	734	=item B<borderColor:> I<colour>
638		735
639	The colour of the border around the text area and between the scrollbar	736	The colour of the border around the text area and between the scrollbar
640	and the text.	737	and the text.
641		738
642	=item B<backgroundPixmap:> I<file[;geom]>	739	=item B<backgroundPixmap:> I<file[;oplist]>
643		740
644	Use the specified XPM file (note the `.xpm' extension is optional) for	741	Use the specified image file for the background and also
645	the background and also optionally specify its scaling with a geometry	742	optionally specify a colon separated list of operations to modify it.
646	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	743	Supported operations are:
647	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	744
648	centre (percent). A scale of 0 displays the image with tiling. A scale	745	=over 4
649	of 1 displays the image without any scaling. A scale of 2 to 9	746
650	specifies an integer number of images in that direction. No image will	747	=item B<WxH+X+Y>
651	be magnified beyond 10 times its original size. The maximum permitted	748
652	scale is 1000. [default 0x0+50+50]	749	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
		750	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
		751	scale of 0 disables scaling. The maximum permitted scale is 1000.
		752
		753	=item B<op=tile>
		754
		755	enables tiling
		756
		757	=item B<op=keep-aspect>
		758
		759	maintain the image aspect ratio when scaling
		760
		761	=item B<op=root-align>
		762
		763	use the position of the terminal window relative to the root window as
		764	the image offset, simulating a root window background
		765
		766	=back
		767
		768	The default scale and position setting is C<100x100+50+50>.
		769	Alternatively, a predefined set of templates can be used to achieve
		770	the most common setups:
		771
		772	=over 4
		773
		774	=item B<style=tiled>
		775
		776	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		777
		778	=item B<style=aspect-stretched>
		779
		780	the image is scaled to fill the whole window maintaining the aspect
		781	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		782
		783	=item B<style=stretched>
		784
		785	the image is scaled to fill the whole window. Equivalent to 100x100
		786
		787	=item B<style=centered>
		788
		789	the image is centered with no scaling. Equivalent to 0x0+50+50
		790
		791	=item B<style=root-tiled>
		792
		793	the image is tiled with no scaling and using 'root' positioning.
		794	Equivalent to 0x0:op=tile:op=root-align
		795
		796	=back
		797
		798	If multiple templates are specified the last one wins. Note that a
		799	template overrides all the scale, position and operations settings.
		800
		801	If used in conjunction with B<-tr> option, the specified pixmap will be
		802	blended over the transparent background using alpha-blending.
653		803
654	=item B<path:> I<path>	804	=item B<path:> I<path>
655		805
656	Specify the colon-delimited search path for finding XPM files.	806	Specify the colon-delimited search path for finding background image files.
657		807
658	=item B<font:> I<fontlist>	808	=item B<font:> I<fontlist>
659		809
660	Select the fonts to be used. This is a comma separated list of font names	810	Select the fonts to be used. This is a comma separated list of font names
661	that are checked in order when trying to find glyphs for characters. The	811	that are checked in order when trying to find glyphs for characters. The
…		…
684	it is named first) and thus defines the character cell grid to be 9 pixels	834	it is named first) and thus defines the character cell grid to be 9 pixels
685	wide and 15 pixels high.	835	wide and 15 pixels high.
686		836
687	The second font is just used to add additional unicode characters not in	837	The second font is just used to add additional unicode characters not in
688	the base font, likewise the third, which is unfortunately non-bold, but	838	the base font, likewise the third, which is unfortunately non-bold, but
689	the bold version of the font does contain less characters, so this is a	839	the bold version of the font does contain fewer characters, so this is a
690	useful supplement.	840	useful supplement.
691		841
692	The third font is an Xft font with aliasing turned off, and the characters	842	The third font is an Xft font with aliasing turned off, and the characters
693	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	843	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
694	contains other characters, but we are not interested in them.	844	contains other characters, but we are not interested in them.
…		…
718	text font will being used for the given style.	868	text font will being used for the given style.
719		869
720	=item B<intensityStyles:> I<boolean>	870	=item B<intensityStyles:> I<boolean>
721		871
722	When font styles are not enabled, or this option is enabled (B<True>,	872	When font styles are not enabled, or this option is enabled (B<True>,
723	option B<-is>, the default), bold and italic font styles imply high	873	option B<-is>, the default), bold/blink font styles imply high
724	intensity foreground/background colours. Disabling this option (B<False>,	874	intensity foreground/background colours. Disabling this option (B<False>,
725	option B<+is>) disables this behaviour, the high intensity colours are not	875	option B<+is>) disables this behaviour, the high intensity colours are not
726	reachable.	876	reachable.
727		877
728	=item B<selectstyle:> I<mode>
729
730	Set mouse selection style to B<old> which is 2.20, B<oldword> which is
731	xterm style with 2.20 old word selection, or anything else which gives
732	xterm style selection.
733
734	=item B<scrollstyle:> I<mode>
735
736	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
737	the author's favourite.
738
739	=item B<title:> I<string>	878	=item B<title:> I<string>
740		879
741	Set window title string, the default title is the command-line	880	Set window title string, the default title is the command-line
742	specified after the B<-e> option, if any, otherwise the application	881	specified after the B<-e> option, if any, otherwise the application
743	name; option B<-title>.	882	name; option B<-title>.
…		…
756	=item B<urgentOnBell:> I<boolean>	895	=item B<urgentOnBell:> I<boolean>
757		896
758	B<True>: set the urgency hint for the wm on receipt of a bell character.	897	B<True>: set the urgency hint for the wm on receipt of a bell character.
759	B<False>: do not set the urgency hint [default].	898	B<False>: do not set the urgency hint [default].
760		899
		900	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		901
761	=item B<visualBell:> I<boolean>	902	=item B<visualBell:> I<boolean>
762		903
763	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	904	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
764	B<False>: no visual bell [default]; option B<+vb>.	905	B<False>: no visual bell [default]; option B<+vb>.
765		906
…		…
788	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	929	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
789		930
790	This creates a new file in your home directory with the screen contents	931	This creates a new file in your home directory with the screen contents
791	every time you hit C<Print>.	932	every time you hit C<Print>.
792		933
		934	=item B<scrollstyle:> I<mode>
		935
		936	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		937	the author's favourite.
		938
		939	=item B<thickness:> I<number>
		940
		941	Set the scrollbar width in pixels.
		942
793	=item B<scrollBar:> I<boolean>	943	=item B<scrollBar:> I<boolean>
794		944
795	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	945	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
796	disable the scrollbar; option B<+sb>.	946	disable the scrollbar; option B<+sb>.
797		947
…		…
816	B<False>: do not scroll to bottom when tty receives output; option	966	B<False>: do not scroll to bottom when tty receives output; option
817	B<+si>.	967	B<+si>.
818		968
819	=item B<scrollWithBuffer:> I<boolean>	969	=item B<scrollWithBuffer:> I<boolean>
820		970
821	B<True>: scroll with scrollback buffer when tty receives new lines (and	971	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
822	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	972	try to show the same lines) and B<scrollTtyOutput> is False; option
823	with scrollback buffer when tty receives new lines; option B<+sw>.	973	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		974	new lines; option B<+sw>.
824		975
825	=item B<scrollTtyKeypress:> I<boolean>	976	=item B<scrollTtyKeypress:> I<boolean>
826		977
827	B<True>: scroll to bottom when a non-special key is pressed. Special keys	978	B<True>: scroll to bottom when a non-special key is pressed. Special keys
828	are those which are intercepted by rxvt-unicode for special handling and	979	are those which are intercepted by rxvt-unicode for special handling and
…		…
859	=item B<termName:> I<termname>	1010	=item B<termName:> I<termname>
860		1011
861	Specifies the terminal type name to be set in the B<TERM> environment	1012	Specifies the terminal type name to be set in the B<TERM> environment
862	variable; option B<-tn>.	1013	variable; option B<-tn>.
863		1014
864	=item B<linespace:> I<number>	1015	=item B<lineSpace:> I<number>
865		1016
866	Specifies number of lines (pixel height) to insert between each row of	1017	Specifies number of lines (pixel height) to insert between each row of
867	the display [default 0]; option B<-lsp>.	1018	the display [default 0]; option B<-lsp>.
868		1019
869	=item B<meta8:> I<boolean>	1020	=item B<meta8:> I<boolean>
…		…
883		1034
884	=item B<cursorBlink:> I<boolean>	1035	=item B<cursorBlink:> I<boolean>
885		1036
886	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1037	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
887	option B<-bc>.	1038	option B<-bc>.
		1039
		1040	=item B<cursorUnderline:> I<boolean>
		1041
		1042	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1043	option B<-uc>.
888		1044
889	=item B<pointerBlank:> I<boolean>	1045	=item B<pointerBlank:> I<boolean>
890		1046
891	B<True>: blank the pointer when a key is pressed or after a set number	1047	B<True>: blank the pointer when a key is pressed or after a set number
892	of seconds of inactivity. B<False>: the pointer is always visible	1048	of seconds of inactivity. B<False>: the pointer is always visible
…		…
906	large number (e.g. C<987654321>) to effectively disable the timeout.	1062	large number (e.g. C<987654321>) to effectively disable the timeout.
907		1063
908	=item B<backspacekey:> I<string>	1064	=item B<backspacekey:> I<string>
909		1065
910	The string to send when the backspace key is pressed. If set to B<DEC>	1066	The string to send when the backspace key is pressed. If set to B<DEC>
911	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	1067	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
912	(code 8) - which can be reversed with the appropriate DEC private mode	1068	(code 8) - which can be reversed with the appropriate DEC private mode
913	escape sequence.	1069	escape sequence.
914		1070
915	=item B<deletekey:> I<string>	1071	=item B<deletekey:> I<string>
916		1072
…		…
921	=item B<cutchars:> I<string>	1077	=item B<cutchars:> I<string>
922		1078
923	The characters used as delimiters for double-click word selection	1079	The characters used as delimiters for double-click word selection
924	(whitespace delimiting is added automatically if resource is given).	1080	(whitespace delimiting is added automatically if resource is given).
925		1081
926	When the selection extension is in use (the default if compiled in, see	1082	When the perl selection extension is in use (the default if compiled
927	the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters	1083	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
928	will be created (if the resource exists, otherwise, no regex will be	1084	characters will be created (if the resource exists, otherwise, no regex
929	created). In this mode, characters outside ISO-8859-1 can be used.	1085	will be created). In this mode, characters outside ISO-8859-1 can be used.
930		1086
931	When the selection extension is not used, only ISO-8859-1 characters can	1087	When the selection extension is not used, only ISO-8859-1 characters can
932	be used. If not specified, the built-in default is used:	1088	be used. If not specified, the built-in default is used:
933		1089
934	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1090	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
935		1091
936	=item B<preeditType:> I<style>	1092	=item B<preeditType:> I<style>
937		1093
938	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1094	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
939		1095
…		…
995		1151
996	=item B<secondaryScroll:> I<boolean>	1152	=item B<secondaryScroll:> I<boolean>
997		1153
998	Turn on/off secondary screen scroll (default enabled). If this	1154	Turn on/off secondary screen scroll (default enabled). If this
999	option is enabled, scrolls on the secondary screen will change the	1155	option is enabled, scrolls on the secondary screen will change the
1000	scrollback buffer and switching to/from the secondary screen will	1156	scrollback buffer and, when secondaryScreen is off, switching
1001	instead scroll the screen up.	1157	to/from the secondary screen will instead scroll the screen up.
1002		1158
1003	=item B<hold>: I<boolean>	1159	=item B<hold>: I<boolean>
1004		1160
1005	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1161	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1006	will not immediately destroy its window when the program executed within	1162	will not immediately destroy its window when the program executed within
1007	it exits. Instead, it will wait till it is being killed or closed by the	1163	it exits. Instead, it will wait till it is being killed or closed by the
1008	user.	1164	user.
		1165
		1166	=item B<chdir>: I<path>
		1167
		1168	Sets the working directory for the shell (or the command specified via
		1169	B<-e>). The I<path> must be an absolute path and it must exist for
		1170	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1171	directory will be used; option B<-cd>.
1009		1172
1010	=item B<keysym.>I<sym>: I<string>	1173	=item B<keysym.>I<sym>: I<string>
1011		1174
1012	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1175	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1013	intervening resource name B<keysym.> cannot be omitted.	1176	intervening resource name B<keysym.> cannot be omitted.
…		…
1027	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1190	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1028	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1191	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1029	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1192	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1030	performed in an exact manner; however, the closest match is assured.	1193	performed in an exact manner; however, the closest match is assured.
1031		1194
1032	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1195	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1033	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1196	number), see RESOURCES in C<man 7 X> for further details.
1034	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1035	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1036	can start or end with whitespace. B<This feature is deprecated and will
1037	be removed>.
1038		1197
1039	Please note that you need to double the C<\> in resource files, as
1040	Xlib itself does its own de-escaping (you can use C<\033> instead of
1041	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1042	processing).
1043
1044	You can define a range of keysyms in one shot by providing a I<string>	1198	You can define a range of keysyms in one shot by
		1199	loading the C<keysym-list> perl extension and providing a I<string>
1045	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1200	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1046	should be a character not used by the strings.	1201	should be a character not used by the strings.
1047		1202
1048	Its usage can be demonstrated by an example:	1203	Its usage can be demonstrated by an example:
1049		1204
1050	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1205	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1051		1206
1052	The above line is equivalent to the following three lines:	1207	The above line is equivalent to the following three lines:
1053		1208
1054	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1209	URxvt.keysym.Meta-Control-0x61: \033<a>
1055	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1210	URxvt.keysym.Meta-Control-0x62: \033<b>
1056	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1211	URxvt.keysym.Meta-Control-0x63: \033<c>
1057		1212
1058	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1213	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1059	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1214	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1060	example the following means "change the current locale to C<zh_CN.GBK>	1215	example the following means "change the current locale to C<zh_CN.GBK>
1061	when Control-Meta-c is being pressed":	1216	when Control-Meta-c is being pressed":
1062		1217
1063	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1218	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1064		1219
1065	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1220	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1066	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1221	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1067	manpage. For example, the F<selection> extension (activated via	1222	manpage. For example, the F<selection> extension (activated via
1068	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1223	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1069		1224
1070	URxvt.keysym.M-C-c: perl:selection:rot13	1225	URxvt.keysym.M-C-c: perl:selection:rot13
1071		1226
1072	Due the the large number of modifier combinations, a defined key mapping	1227	Due the the large number of modifier combinations, a defined key mapping
1073	will match if at I<at least> the specified identifiers are being set, and	1228	will match if I<at least> the specified identifiers are being set, and
1074	no other key mappings with those and more bits are being defined. That	1229	no other key mappings with those and more bits are being defined. That
1075	means that defining a key map for C<a> will automatically provide	1230	means that defining a key map for C<a> will automatically provide
1076	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined	1231	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1077	mappings themselves.	1232	mappings themselves.
1078		1233
…		…
1129	all instances, while B<perl-ext> is used for specific instances.	1284	all instances, while B<perl-ext> is used for specific instances.
1130		1285
1131	=item B<perl-eval>: I<string>	1286	=item B<perl-eval>: I<string>
1132		1287
1133	Perl code to be evaluated when all extensions have been registered. See	1288	Perl code to be evaluated when all extensions have been registered. See
1134	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1289	the @@RXVT_NAME@@perl(3) manpage.
1135	will be ignored when running setuid/setgid.
1136		1290
1137	=item B<perl-lib>: I<path>	1291	=item B<perl-lib>: I<path>
1138		1292
1139	Colon-separated list of additional directories that hold extension	1293	Colon-separated list of additional directories that hold extension
1140	scripts. When looking for extensions specified by the C<perl> resource,	1294	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
1141	@@RXVT_NAME@@ will first look in these directories and then in	1295	look in these directories, then in $HOME/.urxvt/ext and lastly in
1142	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1296	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1143	will be ignored when running setuid/setgid.
1144		1297
1145	See the @@RXVT_NAME@@perl(3) manpage.	1298	See the @@RXVT_NAME@@perl(3) manpage.
1146		1299
1147	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1300	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1148		1301
…		…
1170		1323
1171	=item B<override-redirect>: I<boolean>	1324	=item B<override-redirect>: I<boolean>
1172		1325
1173	Compile I<frills>: Sets override-redirect for the terminal window, making	1326	Compile I<frills>: Sets override-redirect for the terminal window, making
1174	it almost invisible to window managers; option B<-override-redirect>.	1327	it almost invisible to window managers; option B<-override-redirect>.
		1328
		1329	=item B<iso14755:> I<boolean>
		1330
		1331	Turn on/off ISO 14755 (default enabled).
		1332
		1333	=item B<iso14755_52:> I<boolean>
		1334
		1335	Turn on/off ISO 14755 5.2 mode (default enabled).
1175		1336
1176	=back	1337	=back
1177		1338
1178	=head1 THE SCROLLBAR	1339	=head1 THE SCROLLBAR
1179		1340
…		…
1198	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1359	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1199	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1360	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1200	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1361	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1201	respectively.	1362	respectively.
1202		1363
1203	=head1 TEXT SELECTION AND INSERTION	1364	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1204		1365
1205	The behaviour of text selection and insertion mechanism is similar to	1366	The behaviour of text selection and insertion/pasting mechanism is similar
1206	I<xterm>(1).	1367	to I<xterm>(1).
1207		1368
1208	=over 4	1369	=over 4
1209		1370
1210	=item B<Selection>:	1371	=item B<Selecting>:
1211		1372
1212	Left click at the beginning of the region, drag to the end of the region	1373	Left click at the beginning of the region, drag to the end of the region
1213	and release; Right click to extend the marked region; Left double-click	1374	and release; Right click to extend the marked region; Left double-click
1214	to select a word; Left triple-click to select the entire logical line	1375	to select a word; Left triple-click to select the entire logical line
1215	(which can span multiple screen lines), unless modified by resource	1376	(which can span multiple screen lines), unless modified by resource
…		…
1219	(Compile: I<frills>) will create a rectangular selection instead of a	1380	(Compile: I<frills>) will create a rectangular selection instead of a
1220	normal one. In this mode, every selected row becomes its own line in the	1381	normal one. In this mode, every selected row becomes its own line in the
1221	selection, and trailing whitespace is visually underlined and removed from	1382	selection, and trailing whitespace is visually underlined and removed from
1222	the selection.	1383	the selection.
1223		1384
1224	=item B<Insertion>:	1385	=item B<Pasting>:
1225		1386
1226	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>	1387	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1227	window causes the value of the PRIMARY selection (or CLIPBOARD with the	1388	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1228	Meta modifier) to be inserted as if it had been typed on the keyboard.	1389	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1229		1390
1230	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1391	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1231	inserted too.	1392	inserted too.
1232		1393
1233	=back	1394	=back
…		…
1250		1411
1251	=head1 ISO 14755 SUPPORT	1412	=head1 ISO 14755 SUPPORT
1252		1413
1253	ISO 14755 is a standard for entering and viewing unicode characters	1414	ISO 14755 is a standard for entering and viewing unicode characters
1254	and character codes using the keyboard. It consists of 4 parts. The	1415	and character codes using the keyboard. It consists of 4 parts. The
1255	first part is available rxvt-unicode has been compiled with	1416	first part is available if rxvt-unicode has been compiled with
1256	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1417	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1257	with C<--enable-iso14755>.	1418	with C<--enable-iso14755>.
1258		1419
1259	=over 4	1420	=over 4
1260		1421
…		…
1318	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1479	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1319	it can be seen via the I<who(1)> command, and can accept messages. To	1480	it can be seen via the I<who(1)> command, and can accept messages. To
1320	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1481	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1321	on some systems or setgid to root or to some other group on others.	1482	on some systems or setgid to root or to some other group on others.
1322		1483
1323	=head1 COLORS AND GRAPHICS	1484	=head1 COLOURS AND GRAPHICS
1324		1485
1325	In addition to the default foreground and background colours,	1486	In addition to the default foreground and background colours,
1326	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1487	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1327	high-intensity bold/blink versions of the same). Here is a list of the	1488	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1328	colours with their names.	1489	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1490	cube plus a 8 (24) colour greyscale ramp.
		1491
		1492	Here is a list of the ANSI colours with their names.
1329		1493
1330	=begin table	1494	=begin table
1331		1495
1332	B<color0> (black) = Black	1496	B<color0> (black) = Black
1333	B<color1> (red) = Red3	1497	B<color1> (red) = Red3
…		…
1353	It is also possible to specify the colour values of B<foreground>,	1517	It is also possible to specify the colour values of B<foreground>,
1354	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1518	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1355	a number 0-15, as a convenient shorthand to reference the colour name of	1519	a number 0-15, as a convenient shorthand to reference the colour name of
1356	color0-color15.	1520	color0-color15.
1357		1521
1358	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1522	The following text gives values for the standard 88 colour mode (and
1359	additional 72 colours. The first 64 of those (with indices 16 to 79)	1523	values for the 256 colour mode in parentheses).
1360	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1361	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1362		1524
		1525	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1526
		1527	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1528	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1529
		1530	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1531	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1532	the RGB cube.
		1533
1363	Together, all those colours implement the 88 colour xterm colours. Only	1534	Together, all those colours implement the 88 (256) colour xterm
1364	the first 16 can be changed using resources currently, the rest can only	1535	colours. Only the first 16 can be changed using resources currently, the
1365	be changed via command sequences ("escape codes").	1536	rest can only be changed via command sequences ("escape codes").
		1537
		1538	Applications are advised to use terminfo or command sequences to discover
		1539	number and RGB values of all colours (yes, you can query this...).
1366		1540
1367	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1541	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1368	always swapping the foreground/background colours. This is in contrast to	1542	always swapping the foreground/background colours. This is in contrast to
1369	I<xterm>(1) where the colours are only swapped if they have not otherwise	1543	I<xterm>(1) where the colours are only swapped if they have not otherwise
1370	been specified. For example,	1544	been specified. For example,
1371		1545
1372	=over 4
1373
1374	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1546	@@RXVT_NAME@@ -fg Black -bg White -rv
1375		1547
1376	would yield White on Black, while on I<xterm>(1) it would yield Black	1548	would yield White on Black, while on I<xterm>(1) it would yield Black on
1377	on White.	1549	White.
1378
1379	=back
1380		1550
1381	=head2 ALPHA CHANNEL SUPPORT	1551	=head2 ALPHA CHANNEL SUPPORT
1382		1552
1383	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1553	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1384	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1554	their act together, rxvt-unicode will do its own alpha channel management:
1385	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1555
1386	in addition to the ones provided by X, where the additional A component	1556	You can prefix any colour with an opaqueness percentage enclosed in
		1557	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1558	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1559	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1560	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1561	is the recommended format to specify transparency values, and works with
		1562	all ways to specify a colour.
		1563
		1564	For complete control, rxvt-unicode also supports
		1565	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1566	specifications, where the additional C<aaaa> component specifies opacity
1387	specifies opacity (alpha) values. The minimum value of C<0> is completely	1567	(alpha) values. The minimum value of C<0000> is completely transparent,
1388	transparent). You can also prefix any color with C<[percent]>, where	1568	while C<ffff> is completely opaque). The two example colours from
1389	C<percent> is a decimal percentage (0-100) that specifies the opacity of	1569	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1390	the color, where C<0> is completely transparent and C<100> is completelxy	1570	C<rgba:0000/ff00/0000/f332>.
1391	opaque.
1392		1571
1393	You probably need to specify B<"-depth 32">, too, and have the luck that	1572	You probably need to specify B<"-depth 32">, too, to force a visual with
1394	your X-server uses ARGB pixel layout, as X is far from just supporting	1573	alpha channels, and have the luck that your X-server uses ARGB pixel
1395	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1574	layout, as X is far from just supporting ARGB visuals out of the box, and
		1575	rxvt-unicode just fudges around.
1396		1576
1397	For example, the following selects an almost completely transparent red	1577	For example, the following selects an almost completely transparent black
1398	background, and an almost opaque pink foreground:	1578	background, and an almost opaque pink foreground:
1399		1579
1400	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1580	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1401		1581
1402	I<Please note that transparency of any kind if completely unsupported by	1582	When not using a background image, then the interpretation of the
1403	the author. Don't bug him with installation questions!>	1583	alpha channel is up to your compositing manager (most interpret it as
		1584	transparency of course).
		1585
		1586	When using a background pixmap or pseudo-transparency, then the background
		1587	colour will always behave as if it were completely transparent (so the
		1588	background image shows instead), regardless of how it was specified, while
		1589	other colours will either be transparent as specified (the background
		1590	image will show through) on servers supporting the RENDER extension, or
		1591	fully opaque on servers not supporting the RENDER EXTENSION.
		1592
		1593	Please note that due to bugs in Xft, specifying alpha values might result
		1594	in garbage being displayed when the X-server does not support the RENDER
		1595	extension.
1404		1596
1405	=head1 ENVIRONMENT	1597	=head1 ENVIRONMENT
1406		1598
1407	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1599	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1408		1600
…		…
1414	resources or on the command line.	1606	resources or on the command line.
1415		1607
1416	=item B<COLORTERM>	1608	=item B<COLORTERM>
1417		1609
1418	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was	1610	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1419	compiled with XPM support, and optionally with the added extension	1611	compiled with background image support, and optionally with the added
1420	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1612	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1613	screen.
1421		1614
1422	=item B<COLORFGBG>	1615	=item B<COLORFGBG>
1423		1616
1424	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1617	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1425	the colour code used as default foreground/text colour (or the string	1618	the colour code used as default foreground/text colour (or the string
1426	C<default> to indicate that the default-colour escape sequence is to be	1619	C<default> to indicate that the default-colour escape sequence is to be
1427	used), C<bg> is the colour code used as default background colour (or the	1620	used), C<bg> is the colour code used as default background colour (or the
1428	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1621	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1429	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1622	was compiled with background image support. Libraries like C<ncurses>
1430	(and do) use this information to optimize screen output.	1623	and C<slang> can (and do) use this information to optimize screen output.
1431		1624
1432	=item B<WINDOWID>	1625	=item B<WINDOWID>
1433		1626
1434	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1627	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1435	window, which usually has subwindows for the scrollbar, the terminal	1628	window, which usually has subwindows for the scrollbar, the terminal
…		…
1441	C<--with-terminfo=PATH>.	1634	C<--with-terminfo=PATH>.
1442		1635
1443	=item B<DISPLAY>	1636	=item B<DISPLAY>
1444		1637
1445	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1638	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1446	display in its child processes.	1639	display in its child processes if C<-display> isn't used to override. It
		1640	defaults to C<:0> if it doesn't exist.
1447		1641
1448	=item B<SHELL>	1642	=item B<SHELL>
1449		1643
1450	The shell to be used for command execution, defaults to C</bin/sh>.	1644	The shell to be used for command execution, defaults to C</bin/sh>.
1451		1645
1452	=item B<RXVT_SOCKET>	1646	=item B<RXVT_SOCKET>
1453		1647
1454	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1648	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1455	@@RXVT_NAME@@d(1).	1649	@@RXVT_NAME@@d(1).
1456		1650
1457	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1651	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1458		1652
1459	=item B<HOME>	1653	=item B<HOME>
1460		1654
1461	Used to locate the default directory for the unix domain socket for	1655	Used to locate the default directory for the unix domain socket for
1462	daemon communications and to locate various resource files (such as	1656	daemon communications and to locate various resource files (such as
1463	C<.Xdefaults>)	1657	C<.Xdefaults>)
1464		1658
1465	=item B<XAPPLRESDIR>	1659	=item B<XAPPLRESDIR>
1466		1660
1467	Directory where various X resource files are being located.	1661	Directory where application-specific X resource files are located.
1468		1662
1469	=item B<XENVIRONMENT>	1663	=item B<XENVIRONMENT>
1470		1664
1471	If set and accessible, gives the name of a X resource file to be loaded by	1665	If set and accessible, gives the name of a X resource file to be loaded by
1472	@@RXVT_NAME@@.	1666	@@RXVT_NAME@@.
…		…
1477		1671
1478	=over 4	1672	=over 4
1479		1673
1480	=item B</usr/lib/X11/rgb.txt>	1674	=item B</usr/lib/X11/rgb.txt>
1481		1675
1482	Color names.	1676	Colour names.
1483		1677
1484	=back	1678	=back
1485		1679
1486	=head1 SEE ALSO	1680	=head1 SEE ALSO
1487		1681
…		…
1526	Project Coordinator (changes.txt 2.21a to 2.4.5)	1720	Project Coordinator (changes.txt 2.21a to 2.4.5)
1527		1721
1528	=item Geoff Wing L<< <gcw@pobox.com> >>	1722	=item Geoff Wing L<< <gcw@pobox.com> >>
1529		1723
1530	Rewrote screen display and text selection routines.	1724	Rewrote screen display and text selection routines.
1531		1725
1532	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1726	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1533		1727
1534	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1728	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1535		1729
1536	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1730	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
…		…
1538		1732
1539	Project Coordinator (Changes 1.0 -)	1733	Project Coordinator (Changes 1.0 -)
1540		1734
1541	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1735	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1542		1736
1543	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1737	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1544		1738
1545	=back	1739	=back
1546		1740

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.127 by ayin, Wed May 2 23:06:32 2007 UTC vs. Revision 1.213 by sf-exg, Sat Feb 4 21:47:06 2012 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.127 by ayin, Wed May 2 23:06:32 2007 UTC vs.
Revision 1.213 by sf-exg, Sat Feb 4 21:47:06 2012 UTC