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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.129 by root, Mon May 28 20:34:56 2007 UTC vs.
Revision 1.168 by root, Tue Nov 4 11:03:29 2008 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 illusion of a transparent window background; resource B<transparent>.
		130
		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@@)!>
123		136
124	=item B<-fade> I<number>	137	=item B<-fade> I<number>
125		138
126	Fade the text by the given percentage when focus is lost. Small values	139	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	140	fade a little only, 100 completely replaces all colours by the fade
…		…
133	is opaque black. resource B<fadeColor>.	146	is opaque black. resource B<fadeColor>.
134		147
135	=item B<-tint> I<colour>	148	=item B<-tint> I<colour>
136		149
137	Tint the transparent background pixmap with the given colour when	150	Tint the transparent background pixmap with the given colour when
138	transparency is enabled with B<-tr> or B<-ip>. This only works for	151	transparency is enabled with B<-tr>. This only works for
139	non-tiled backgrounds, currently. See also the B<-sh> option that can be	152	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	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
141	I<tintColor>. Example:	158	I<tintColor>. Example:
142		159
143	@@RXVT_NAME@@ -tr -tint blue -sh 40	160	@@RXVT_NAME@@ -tr -tint blue -sh 40
144		161
145	=item B<-sh>	162	=item B<-sh> I<number>
146		163
147	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	164	Darken (0 .. 100) or lighten (100 .. 200) the transparent
148	background image in addition to tinting it (i.e. B<-tint> must be	165	background image in addition to (or instead of) tinting it;
149	specified, too, e.g. C<-tint white>); resource I<shading>.	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>
		188
		189	Compile I<afterimage>: Use the specified image as application icon. This
		190	is used by many window managers, taskbars and pagers to represent the
		191	appliation window; resource I<iconFile>.
150		192
151	=item B<-bg> I<colour>	193	=item B<-bg> I<colour>
152		194
153	Window background colour; resource B<background>.	195	Window background colour; resource B<background>.
154		196
155	=item B<-fg> I<colour>	197	=item B<-fg> I<colour>
156		198
157	Window foreground colour; resource B<foreground>.	199	Window foreground colour; resource B<foreground>.
158		200
159	=item B<-pixmap> I<file[;geom]>	201	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
160		202
161	Compile I<XPM>: Specify XPM file for the background and also optionally	203	Compile I<afterimage>: Specify image file for the background and also
162	specify its scaling with a geometry string. Note you may need to	204	optionally specify its scaling with a geometry string. Note you may need to
163	add quotes to avoid special shell interpretation of the C<;> in the	205	add quotes to avoid special shell interpretation of the C<;> in the
164	command-line; resource B<backgroundPixmap>.	206	command-line; for more details see resource B<backgroundPixmap>.
165		207
166	=item B<-cr> I<colour>	208	=item B<-cr> I<colour>
167		209
168	The cursor colour; resource B<cursorColor>.	210	The cursor colour; resource B<cursorColor>.
169		211
…		…
214	italic> >> characters are to be printed. See resource B<boldItalicFont>	256	italic> >> characters are to be printed. See resource B<boldItalicFont>
215	for details.	257	for details.
216		258
217	=item B<-is>\|B<+is>	259	=item B<-is>\|B<+is>
218		260
219	Compile I<font-styles>: Bold/Italic font styles imply high intensity	261	Compile I<font-styles>: Bold/Blink font styles imply high intensity
220	foreground/background (default). See resource B<intensityStyles> for	262	foreground/background (default). See resource B<intensityStyles> for
221	details.	263	details.
222		264
223	=item B<-name> I<name>	265	=item B<-name> I<name>
224		266
…		…
242		284
243	=item B<-sb>\|B<+sb>	285	=item B<-sb>\|B<+sb>
244		286
245	Turn on/off scrollbar; resource B<scrollBar>.	287	Turn on/off scrollbar; resource B<scrollBar>.
246		288
		289	=item B<-sr>\|B<+sr>
		290
		291	Put scrollbar on right/left; resource B<scrollBar_right>.
		292
		293	=item B<-st>\|B<+st>
		294
		295	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		296	resource B<scrollBar_floating>.
		297
247	=item B<-si>\|B<+si>	298	=item B<-si>\|B<+si>
248		299
249	Turn on/off scroll-to-bottom on TTY output inhibit; resource	300	Turn on/off scroll-to-bottom on TTY output inhibit; resource
250	B<scrollTtyOutput> has opposite effect.	301	B<scrollTtyOutput> has opposite effect.
251		302
…		…
257	=item B<-sw>\|B<+sw>	308	=item B<-sw>\|B<+sw>
258		309
259	Turn on/off scrolling with the scrollback buffer as new lines appear.	310	Turn on/off scrolling with the scrollback buffer as new lines appear.
260	This only takes effect if B<-si> is also given; resource	311	This only takes effect if B<-si> is also given; resource
261	B<scrollWithBuffer>.	312	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		313
272	=item B<-ptab>\|B<+ptab>	314	=item B<-ptab>\|B<+ptab>
273		315
274	If enabled (default), "Horizontal Tab" characters are being stored as	316	If enabled (default), "Horizontal Tab" characters are being stored as
275	actual wide characters in the screen buffer, which makes it possible to	317	actual wide characters in the screen buffer, which makes it possible to
…		…
304		346
305	=item B<-bl>	347	=item B<-bl>
306		348
307	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	349	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	350	if honoured by the WM, the rxvt-unicode window will not have window
309	decorations; resource B<borderLess>.	351	decorations; resource B<borderLess>. If the window manager does not
		352	support MWM hints (e.g. kwin), enables override-redirect mode.
310		353
311	=item B<-override-redirect>	354	=item B<-override-redirect>
312		355
313	Compile I<frills>: Sets override-redirect on the window; resource	356	Compile I<frills>: Sets override-redirect on the window; resource
314	B<override-redirect>.	357	B<override-redirect>.
…		…
322		365
323	=item B<-lsp> I<number>	366	=item B<-lsp> I<number>
324		367
325	Compile I<frills>: Lines (pixel height) to insert between each row of	368	Compile I<frills>: Lines (pixel height) to insert between each row of
326	the display. Useful to work around font rendering problems; resource	369	the display. Useful to work around font rendering problems; resource
327	B<linespace>.	370	B<lineSpace>.
328		371
329	=item B<-tn> I<termname>	372	=item B<-tn> I<termname>
330		373
331	This option specifies the name of the terminal type to be set in the	374	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	375	B<TERM> environment variable. This terminal type must exist in the
…		…
387		430
388	=item B<-tcw>	431	=item B<-tcw>
389		432
390	Change the meaning of triple-click selection with the left mouse	433	Change the meaning of triple-click selection with the left mouse
391	button. Only effective when the original (non-perl) selection code is	434	button. Only effective when the original (non-perl) selection code is
392	in-use. Instead of selecting a full line it will extend the selection the	435	in-use. Instead of selecting a full line it will extend the selection to
393	end of the logical line only. resource B<tripleclickwords>.	436	the end of the logical line only. resource B<tripleclickwords>.
394		437
395	=item B<-insecure>	438	=item B<-insecure>
396		439
397	Enable "insecure" mode, which currently enables most of the escape	440	Enable "insecure" mode, which currently enables most of the escape
398	sequences that echo strings. See the resource B<insecure> for more	441	sequences that echo strings. See the resource B<insecure> for more
…		…
418		461
419	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	462	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
420	will not immediately destroy its window when the program executed within	463	will not immediately destroy its window when the program executed within
421	it exits. Instead, it will wait till it is being killed or closed by the	464	it exits. Instead, it will wait till it is being killed or closed by the
422	user; resource B<hold>.	465	user; resource B<hold>.
		466
		467	=item B<-cd> I<path>
		468
		469	Sets the working directory for the shell (or the command specified via
		470	B<-e>). The I<path> must be an absolute path and it must exist for
		471	@@RXVT_NAME@@ to start; resource B<chdir>.
		472
		473	=item B<-xrm> I<string>
		474
		475	Works like the X Toolkit option of the same name, by adding the I<string>
		476	as if it were specified in a resource file. Resource values specified this
		477	way take precedence over all other resource specifications.
		478
		479	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		480	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		481	options can be specified as long-options on the commandline, so use
		482	of B<-xrm> is mostly limited to cases where you want to specify other
		483	resources (e.g. for input methods) or for compatibility with other
		484	programs.
423		485
424	=item B<-keysym.>I<sym> I<string>	486	=item B<-keysym.>I<sym> I<string>
425		487
426	Remap a key symbol. See resource B<keysym>.	488	Remap a key symbol. See resource B<keysym>.
427		489
…		…
462	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	524	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
463	entries and will not tinker with pty/tty permissions - you have to do that	525	entries and will not tinker with pty/tty permissions - you have to do that
464	yourself if you want that.	526	yourself if you want that.
465		527
466	As an extremely special case, specifying C<-1> will completely suppress	528	As an extremely special case, specifying C<-1> will completely suppress
467	pty/tty operations.	529	pty/tty operations, which is probably only useful in conjunction with some
		530	perl extension that manages the terminal.
468		531
469	Here is a example in perl that illustrates how this option can be used (a	532	Here is a example in perl that illustrates how this option can be used (a
470	longer example is in F<doc/pty-fd>):	533	longer example is in F<doc/pty-fd>):
471		534
472	use IO::Pty;	535	use IO::Pty;
…		…
486	Comma-separated list of perl extension scripts to use (or not to use) in	549	Comma-separated list of perl extension scripts to use (or not to use) in
487	this terminal instance. See resource B<perl-ext> for details.	550	this terminal instance. See resource B<perl-ext> for details.
488		551
489	=back	552	=back
490		553
491	=head1 RESOURCES (available also as long-options)	554	=head1 RESOURCES
492		555
493	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	556	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
494	options) compiled into your version.	557	options) compiled into your version. All resources are also available as
		558	long-options.
495		559
496	You can set and change the resources using X11 tools like B<xrdb>. Many	560	You can set and change the resources using X11 tools like B<xrdb>. Many
497	distribution do also load settings from the B<~/.Xresources> file when X	561	distribution do also load settings from the B<~/.Xresources> file when X
498	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	562	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
499	with later settings overwriting earlier ones:	563	with later settings overwriting earlier ones:
…		…
501	1. system-wide app-defaults file, either locale-dependent OR global	565	1. system-wide app-defaults file, either locale-dependent OR global
502	2. app-defaults file in $XAPPLRESDIR	566	2. app-defaults file in $XAPPLRESDIR
503	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	567	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
504	4. SCREEN_RESOURCES for the current screen	568	4. SCREEN_RESOURCES for the current screen
505	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	569	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		570	6. resources specified via -xrm on the commandline
506		571
507	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	572	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
508	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	573	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
509	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily	574	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
510	configured, while the class name B<URxvt> allows resources unique to	575	configured, while the class name B<URxvt> allows resources unique to
…		…
520	=item B<depth:> I<bitdepth>	585	=item B<depth:> I<bitdepth>
521		586
522	Compile I<xft>: Attempt to find a visual with the given bit depth;	587	Compile I<xft>: Attempt to find a visual with the given bit depth;
523	option B<-depth>.	588	option B<-depth>.
524		589
		590	=item B<buffered:> I<boolean>
		591
		592	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		593	On some card/driver combination enabling it slightly decreases
		594	performance, on most it greatly helps it. The slowdown is small, so it
		595	should normally be enabled.
		596
525	=item B<geometry:> I<geom>	597	=item B<geometry:> I<geom>
526		598
527	Create the window with the specified X window geometry [default 80x24];	599	Create the window with the specified X window geometry [default 80x24];
528	option B<-geometry>.	600	option B<-geometry>.
529		601
…		…
592	option B<-rv>. B<False>: regular screen colours [default]; option	664	option B<-rv>. B<False>: regular screen colours [default]; option
593	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	665	B<+rv>. See note in B<COLORS AND GRAPHICS> section.
594		666
595	=item B<jumpScroll:> I<boolean>	667	=item B<jumpScroll:> I<boolean>
596		668
597	B<True>: specify that jump scrolling should be used. When scrolling	669	B<True>: specify that jump scrolling should be used. When receiving lots
598	quickly, fewer screen updates are performed [default]; option B<-j>.	670	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		671	has been read, resulting in fewer updates while still displaying every
		672	received line; option B<-j>.
		673
599	B<False>: specify that smooth scrolling should be used; option B<+j>.	674	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		675	force a screen refresh on each new line it received; option B<+j>.
600		676
601	=item B<inheritPixmap:> I<boolean>	677	=item B<skipScroll:> I<boolean>
602		678
603	B<True>: make the background inherit the parent windows' pixmap, giving	679	B<True>: (the default) specify that skip scrolling should be used. When
604	artificial transparency. B<False>: do not inherit the parent windows'	680	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
605	pixmap.	681	(around 60 times per second), resulting in far fewer updates. This can
		682	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		683	option B<-ss>.
606		684
607	I<Please note that transparency of any kind if completely unsupported by	685	B<False>: specify that everything is to be displayed, even
608	the author. Don't bug him with installation questions!>	686	if the refresh is too fast for the human eye to read anything (or the
		687	monitor to display anything); option B<+ss>.
		688
		689	=item B<transparent:> I<boolean>
		690
		691	Turn on/off illusion of a transparent window background.
		692
		693	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
		694	future versions.
		695
		696	I<Please address all transparency related issues to Sasha Vasko at
		697	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
609		698
610	=item B<fading:> I<number>	699	=item B<fading:> I<number>
611		700
612	Fade the text by the given percentage when focus is lost; option B<-fade>.	701	Fade the text by the given percentage when focus is lost; option B<-fade>.
613		702
…		…
624	=item B<shading:> I<number>	713	=item B<shading:> I<number>
625		714
626	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image	715	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
627	in addition to tinting it; option B<-sh>.	716	in addition to tinting it; option B<-sh>.
628		717
		718	=item B<blendType:> I<string>
		719
		720	Specify background blending type; option B<-blt>.
		721
		722	=item B<blurRadius:> I<number>
		723
		724	Apply gaussian blur with the specified radius to the transparent
		725	background image; option B<-blr>.
		726
		727	=item B<iconFile:> I<file>
		728
		729	Set the application icon pixmap; option B<-icon>.
		730
629	=item B<scrollColor:> I<colour>	731	=item B<scrollColor:> I<colour>
630		732
631	Use the specified colour for the scrollbar [default #B2B2B2].	733	Use the specified colour for the scrollbar [default #B2B2B2].
632		734
633	=item B<troughColor:> I<colour>	735	=item B<troughColor:> I<colour>
…		…
638	=item B<borderColor:> I<colour>	740	=item B<borderColor:> I<colour>
639		741
640	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
641	and the text.	743	and the text.
642		744
643	=item B<backgroundPixmap:> I<file[;geom]>	745	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
644		746
645	Use the specified XPM file (note the `.xpm' extension is optional) for	747	Use the specified image file for the background and also
646	the background and also optionally specify its scaling with a geometry	748	optionally specify its scaling with a geometry string B<WxH+X+Y>,
647	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	749	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
648	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	750	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
649	centre (percent). A scale of 0 displays the image with tiling. A scale	751	centre (percent). A scale of 0 displays the image with tiling. A scale
650	of 1 displays the image without any scaling. A scale of 2 to 9	752	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
651	specifies an integer number of images in that direction. No image will	753	an integer number of images in that direction. No image will be magnified
652	be magnified beyond 10 times its original size. The maximum permitted	754	beyond 10 times its original size. The maximum permitted scale is 1000.
653	scale is 1000. [default 0x0+50+50]	755	Additional operations can be specified after colon B<:op1:op2...>.
		756	Supported operations are:
		757
		758	tile force background image to be tiled and not scaled. Equivalent to 0x0
		759	propscale will scale image keeping proportions
		760	auto will scale image to match window size. Equivalent to 100x100
		761	hscale will scale image horizontally to the window size
		762	vscale will scale image vertically to the window size
		763	scale will scale image to match window size
		764	root will tile image as if it was a root window background, auto-adjusting
		765	whenever terminal window moves
		766
		767	If used in conjunction with B<-tr> option, the specified pixmap will be
		768	blended over transparency image using either alpha-blending, or any
		769	other blending type, specified with B<-blt "type"> option.
654		770
655	=item B<path:> I<path>	771	=item B<path:> I<path>
656		772
657	Specify the colon-delimited search path for finding XPM files.	773	Specify the colon-delimited search path for finding background image files.
658		774
659	=item B<font:> I<fontlist>	775	=item B<font:> I<fontlist>
660		776
661	Select the fonts to be used. This is a comma separated list of font names	777	Select the fonts to be used. This is a comma separated list of font names
662	that are checked in order when trying to find glyphs for characters. The	778	that are checked in order when trying to find glyphs for characters. The
…		…
719	text font will being used for the given style.	835	text font will being used for the given style.
720		836
721	=item B<intensityStyles:> I<boolean>	837	=item B<intensityStyles:> I<boolean>
722		838
723	When font styles are not enabled, or this option is enabled (B<True>,	839	When font styles are not enabled, or this option is enabled (B<True>,
724	option B<-is>, the default), bold and italic font styles imply high	840	option B<-is>, the default), bold/blink font styles imply high
725	intensity foreground/background colours. Disabling this option (B<False>,	841	intensity foreground/background colours. Disabling this option (B<False>,
726	option B<+is>) disables this behaviour, the high intensity colours are not	842	option B<+is>) disables this behaviour, the high intensity colours are not
727	reachable.	843	reachable.
728		844
729	=item B<selectstyle:> I<mode>
730
731	Set mouse selection style to B<old> which is 2.20, B<oldword> which
732	is xterm style with 2.20 old word selection, or anything else which
733	gives xterm style selection. Only effective when the original (non-perl)
734	selection code is in use.
735
736	=item B<scrollstyle:> I<mode>
737
738	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
739	the author's favourite.
740
741	=item B<title:> I<string>	845	=item B<title:> I<string>
742		846
743	Set window title string, the default title is the command-line	847	Set window title string, the default title is the command-line
744	specified after the B<-e> option, if any, otherwise the application	848	specified after the B<-e> option, if any, otherwise the application
745	name; option B<-title>.	849	name; option B<-title>.
…		…
758	=item B<urgentOnBell:> I<boolean>	862	=item B<urgentOnBell:> I<boolean>
759		863
760	B<True>: set the urgency hint for the wm on receipt of a bell character.	864	B<True>: set the urgency hint for the wm on receipt of a bell character.
761	B<False>: do not set the urgency hint [default].	865	B<False>: do not set the urgency hint [default].
762		866
		867	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		868
763	=item B<visualBell:> I<boolean>	869	=item B<visualBell:> I<boolean>
764		870
765	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	871	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
766	B<False>: no visual bell [default]; option B<+vb>.	872	B<False>: no visual bell [default]; option B<+vb>.
767		873
…		…
789		895
790	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	896	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
791		897
792	This creates a new file in your home directory with the screen contents	898	This creates a new file in your home directory with the screen contents
793	every time you hit C<Print>.	899	every time you hit C<Print>.
		900
		901	=item B<scrollstyle:> I<mode>
		902
		903	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		904	the author's favourite.
794		905
795	=item B<scrollBar:> I<boolean>	906	=item B<scrollBar:> I<boolean>
796		907
797	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	908	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
798	disable the scrollbar; option B<+sb>.	909	disable the scrollbar; option B<+sb>.
…		…
861	=item B<termName:> I<termname>	972	=item B<termName:> I<termname>
862		973
863	Specifies the terminal type name to be set in the B<TERM> environment	974	Specifies the terminal type name to be set in the B<TERM> environment
864	variable; option B<-tn>.	975	variable; option B<-tn>.
865		976
866	=item B<linespace:> I<number>	977	=item B<lineSpace:> I<number>
867		978
868	Specifies number of lines (pixel height) to insert between each row of	979	Specifies number of lines (pixel height) to insert between each row of
869	the display [default 0]; option B<-lsp>.	980	the display [default 0]; option B<-lsp>.
870		981
871	=item B<meta8:> I<boolean>	982	=item B<meta8:> I<boolean>
…		…
931	will be created). In this mode, characters outside ISO-8859-1 can be used.	1042	will be created). In this mode, characters outside ISO-8859-1 can be used.
932		1043
933	When the selection extension is not used, only ISO-8859-1 characters can	1044	When the selection extension is not used, only ISO-8859-1 characters can
934	be used. If not specified, the built-in default is used:	1045	be used. If not specified, the built-in default is used:
935		1046
936	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1047	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
937		1048
938	=item B<preeditType:> I<style>	1049	=item B<preeditType:> I<style>
939		1050
940	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1051	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
941		1052
…		…
997		1108
998	=item B<secondaryScroll:> I<boolean>	1109	=item B<secondaryScroll:> I<boolean>
999		1110
1000	Turn on/off secondary screen scroll (default enabled). If this	1111	Turn on/off secondary screen scroll (default enabled). If this
1001	option is enabled, scrolls on the secondary screen will change the	1112	option is enabled, scrolls on the secondary screen will change the
1002	scrollback buffer and switching to/from the secondary screen will	1113	scrollback buffer and, when secondaryScreen is off, switching
1003	instead scroll the screen up.	1114	to/from the secondary screen will instead scroll the screen up.
1004		1115
1005	=item B<hold>: I<boolean>	1116	=item B<hold>: I<boolean>
1006		1117
1007	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1118	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1008	will not immediately destroy its window when the program executed within	1119	will not immediately destroy its window when the program executed within
1009	it exits. Instead, it will wait till it is being killed or closed by the	1120	it exits. Instead, it will wait till it is being killed or closed by the
1010	user.	1121	user.
		1122
		1123	=item B<chdir>: I<path>
		1124
		1125	Sets the working directory for the shell (or the command specified via
		1126	B<-e>). The I<path> must be an absolute path and it must exist for
		1127	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1128	directory will be used; option B<-cd>.
1011		1129
1012	=item B<keysym.>I<sym>: I<string>	1130	=item B<keysym.>I<sym>: I<string>
1013		1131
1014	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1132	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1015	intervening resource name B<keysym.> cannot be omitted.	1133	intervening resource name B<keysym.> cannot be omitted.
…		…
1029	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1147	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1030	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1148	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1031	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1149	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1032	performed in an exact manner; however, the closest match is assured.	1150	performed in an exact manner; however, the closest match is assured.
1033		1151
1034	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1152	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1035	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1153	number), see RESOURCES in C<man 7 X> for futher details.
1036	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1037	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1038	can start or end with whitespace. B<This feature is deprecated and will
1039	be removed>.
1040
1041	Please note that you need to double the C<\> in resource files, as
1042	Xlib itself does its own de-escaping (you can use C<\033> instead of
1043	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1044	processing).
1045		1154
1046	You can define a range of keysyms in one shot by providing a I<string>	1155	You can define a range of keysyms in one shot by providing a I<string>
1047	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1156	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1048	should be a character not used by the strings.	1157	should be a character not used by the strings.
1049		1158
…		…
1131	all instances, while B<perl-ext> is used for specific instances.	1240	all instances, while B<perl-ext> is used for specific instances.
1132		1241
1133	=item B<perl-eval>: I<string>	1242	=item B<perl-eval>: I<string>
1134		1243
1135	Perl code to be evaluated when all extensions have been registered. See	1244	Perl code to be evaluated when all extensions have been registered. See
1136	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1245	the @@RXVT_NAME@@perl(3) manpage.
1137	will be ignored when running setuid/setgid.
1138		1246
1139	=item B<perl-lib>: I<path>	1247	=item B<perl-lib>: I<path>
1140		1248
1141	Colon-separated list of additional directories that hold extension	1249	Colon-separated list of additional directories that hold extension
1142	scripts. When looking for extensions specified by the C<perl> resource,	1250	scripts. When looking for extensions specified by the C<perl> resource,
1143	@@RXVT_NAME@@ will first look in these directories and then in	1251	@@RXVT_NAME@@ will first look in these directories and then in
1144	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1252	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1145	will be ignored when running setuid/setgid.
1146		1253
1147	See the @@RXVT_NAME@@perl(3) manpage.	1254	See the @@RXVT_NAME@@perl(3) manpage.
1148		1255
1149	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1256	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1150		1257
…		…
1172		1279
1173	=item B<override-redirect>: I<boolean>	1280	=item B<override-redirect>: I<boolean>
1174		1281
1175	Compile I<frills>: Sets override-redirect for the terminal window, making	1282	Compile I<frills>: Sets override-redirect for the terminal window, making
1176	it almost invisible to window managers; option B<-override-redirect>.	1283	it almost invisible to window managers; option B<-override-redirect>.
		1284
		1285	=item B<iso14755_52:> I<boolean>
		1286
		1287	Turn on/off ISO 14755 5.2 mode (default enabled).
1177		1288
1178	=back	1289	=back
1179		1290
1180	=head1 THE SCROLLBAR	1291	=head1 THE SCROLLBAR
1181		1292
…		…
1252		1363
1253	=head1 ISO 14755 SUPPORT	1364	=head1 ISO 14755 SUPPORT
1254		1365
1255	ISO 14755 is a standard for entering and viewing unicode characters	1366	ISO 14755 is a standard for entering and viewing unicode characters
1256	and character codes using the keyboard. It consists of 4 parts. The	1367	and character codes using the keyboard. It consists of 4 parts. The
1257	first part is available rxvt-unicode has been compiled with	1368	first part is available if rxvt-unicode has been compiled with
1258	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1369	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1259	with C<--enable-iso14755>.	1370	with C<--enable-iso14755>.
1260		1371
1261	=over 4	1372	=over 4
1262		1373
…		…
1381	=back	1492	=back
1382		1493
1383	=head2 ALPHA CHANNEL SUPPORT	1494	=head2 ALPHA CHANNEL SUPPORT
1384		1495
1385	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1496	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1386	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1497	their act together, rxvt-unicode will do it's own alpha channel management:
1387	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1498
1388	in addition to the ones provided by X, where the additional A component	1499	You can prefix any color with an opaquenes percentage enclosed in
		1500	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1501	(0-100) that specifies the opacity of the color, where C<0> is completely
		1502	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1503	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1504	is the recommended format to specify transparency values, and works with
		1505	all ways to specify a colour.
		1506
		1507	For complete control, rxvt-unicode also supports
		1508	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1509	specifications, where the additional C<aaaa> component specifies opacity
1389	specifies opacity (alpha) values. The minimum value of C<0> is completely	1510	(alpha) values. The minimum value of C<0000> is completely transparent,
1390	transparent). You can also prefix any color with C<[percent]>, where	1511	while C<ffff> is completely opaque). The two example colours from
1391	C<percent> is a decimal percentage (0-100) that specifies the opacity of	1512	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1392	the color, where C<0> is completely transparent and C<100> is completelxy	1513	C<rgba:0000/ff00/0000/f332>.
1393	opaque.
1394		1514
1395	You probably need to specify B<"-depth 32">, too, and have the luck that	1515	You probably need to specify B<"-depth 32">, too, to force a visual with
1396	your X-server uses ARGB pixel layout, as X is far from just supporting	1516	alpha channels, and have the luck that your X-server uses ARGB pixel
1397	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1517	layout, as X is far from just supporting ARGB visuals out of the box, and
		1518	rxvt-unicode just fudges around.
1398		1519
1399	For example, the following selects an almost completely transparent red	1520	For example, the following selects an almost completely transparent black
1400	background, and an almost opaque pink foreground:	1521	background, and an almost opaque pink foreground:
1401		1522
1402	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1523	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1403		1524
1404	I<Please note that transparency of any kind if completely unsupported by	1525	When not using a background image, then the interpretation of the
1405	the author. Don't bug him with installation questions!>	1526	alpha channel is up to your compositing manager (most interpret it as
		1527	transparency of course).
		1528
		1529	When using a background pixmap or pseudo-transparency, then the background
		1530	colour will always behave as if it were completely transparent (so the
		1531	background image shows instead), regardless of how it was specified, while
		1532	other colours will either be transparent as specified (the background
		1533	image will show through) on servers supporting the RENDER extension, or
		1534	fully opaque on servers not supporting the RENDER EXTENSION.
		1535
		1536	Please note that due to bugs in Xft, specifying alpha values might result
		1537	in garbage being displayed when the X-server does not support the RENDER
		1538	extension.
1406		1539
1407	=head1 ENVIRONMENT	1540	=head1 ENVIRONMENT
1408		1541
1409	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1542	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1410		1543
…		…
1416	resources or on the command line.	1549	resources or on the command line.
1417		1550
1418	=item B<COLORTERM>	1551	=item B<COLORTERM>
1419		1552
1420	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was	1553	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1421	compiled with XPM support, and optionally with the added extension	1554	compiled with background image support, and optionally with the added
1422	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1555	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1556	screen.
1423		1557
1424	=item B<COLORFGBG>	1558	=item B<COLORFGBG>
1425		1559
1426	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1560	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1427	the colour code used as default foreground/text colour (or the string	1561	the colour code used as default foreground/text colour (or the string
1428	C<default> to indicate that the default-colour escape sequence is to be	1562	C<default> to indicate that the default-colour escape sequence is to be
1429	used), C<bg> is the colour code used as default background colour (or the	1563	used), C<bg> is the colour code used as default background colour (or the
1430	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1564	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1431	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1565	was compiled with background image support. Libraries like C<ncurses>
1432	(and do) use this information to optimize screen output.	1566	and C<slang> can (and do) use this information to optimize screen output.
1433		1567
1434	=item B<WINDOWID>	1568	=item B<WINDOWID>
1435		1569
1436	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1570	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1437	window, which usually has subwindows for the scrollbar, the terminal	1571	window, which usually has subwindows for the scrollbar, the terminal
…		…
1443	C<--with-terminfo=PATH>.	1577	C<--with-terminfo=PATH>.
1444		1578
1445	=item B<DISPLAY>	1579	=item B<DISPLAY>
1446		1580
1447	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1581	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1448	display in its child processes.	1582	display in its child processes if C<-display> isn't used to override. It
		1583	defaults to C<:0> if it doesn't exist.
1449		1584
1450	=item B<SHELL>	1585	=item B<SHELL>
1451		1586
1452	The shell to be used for command execution, defaults to C</bin/sh>.	1587	The shell to be used for command execution, defaults to C</bin/sh>.
1453		1588
…		…
1528	Project Coordinator (changes.txt 2.21a to 2.4.5)	1663	Project Coordinator (changes.txt 2.21a to 2.4.5)
1529		1664
1530	=item Geoff Wing L<< <gcw@pobox.com> >>	1665	=item Geoff Wing L<< <gcw@pobox.com> >>
1531		1666
1532	Rewrote screen display and text selection routines.	1667	Rewrote screen display and text selection routines.
1533		1668
1534	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1669	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1535		1670
1536	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1671	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1537		1672
1538	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1673	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.129 by root, Mon May 28 20:34:56 2007 UTC vs. Revision 1.168 by root, Tue Nov 4 11:03:29 2008 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.129 by root, Mon May 28 20:34:56 2007 UTC vs.
Revision 1.168 by root, Tue Nov 4 11:03:29 2008 UTC