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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.132 by root, Mon Jun 18 13:38:12 2007 UTC vs.
Revision 1.165 by root, Thu Oct 2 17:06:50 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>
…		…
114		122
115	=item B<-ss>\|B<+ss>	123	=item B<-ss>\|B<+ss>
116		124
117	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.	125	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118		126
119	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>	127	=item B<-tr>\|B<+tr>
120		128
121	Turn on/off inheriting parent window's pixmap. Alternative form is	129	Turn on/off illusion of a transparent window background; resource B<transparent>.
122	B<-tr>; resource B<inheritPixmap>.
123		130
124	I<Please note that transparency of any kind if completely unsupported by	131	B<-ip> is still accepted as an obsolete alias but will be removed in
125	the author. Don't bug him with installation questions! Read the FAQ (man 7	132	future versions.
126	@@RXVT_NAME@@)!>	133
		134	I<Please address all transparency related issues to Sasha Vasko at
		135	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
127		136
128	=item B<-fade> I<number>	137	=item B<-fade> I<number>
129		138
130	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
131	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
…		…
137	is opaque black. resource B<fadeColor>.	146	is opaque black. resource B<fadeColor>.
138		147
139	=item B<-tint> I<colour>	148	=item B<-tint> I<colour>
140		149
141	Tint the transparent background pixmap with the given colour when	150	Tint the transparent background pixmap with the given colour when
142	transparency is enabled with B<-tr> or B<-ip>. This only works for	151	transparency is enabled with B<-tr>. This only works for
143	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
144	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
145	I<tintColor>. Example:	158	I<tintColor>. Example:
146		159
147	@@RXVT_NAME@@ -tr -tint blue -sh 40	160	@@RXVT_NAME@@ -tr -tint blue -sh 40
148		161
149	=item B<-sh> I<number>	162	=item B<-sh> I<number>
150		163
151	Darken (0 .. 100) or lighten (-1 .. -100) the transparent	164	Darken (0 .. 100) or lighten (100 .. 200) the transparent
152	background image in addition to (or instead of) tinting it;	165	background image in addition to (or instead of) tinting it;
153	resource I<shading>.	166	resource I<shading>.
154		167
155	=item B<-blt> I<string>	168	=item B<-blt> I<string>
156		169
157	Specify background blending type. If background pixmap is specified	170	Specify background blending type. If background pixmap is specified
158	at the same time as transparency - such pixmap will be blended over	171	at the same time as transparency - such pixmap will be blended over
159	transparency image, using method specified. Supported values are :	172	transparency image, using method specified. Supported values are :
160	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,	173	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
161	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,	174	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
162	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is	175	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
163	alpha-blending; resource I<blendType>.	176	alpha-blending. Compile I<afterimage>; resource I<blendType>.
164		177
165	=item B<-blr> I<number>	178	=item B<-blr> I<HxV>
166		179
167	Apply Gaussian Blur with the specified radius to the transparent	180	Apply Gaussian Blur with the specified radii to the transparent
168	background image; resource I<blurRadius>.	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>.
169		186
170	=item B<-bg> I<colour>	187	=item B<-bg> I<colour>
171		188
172	Window background colour; resource B<background>.	189	Window background colour; resource B<background>.
173		190
174	=item B<-fg> I<colour>	191	=item B<-fg> I<colour>
175		192
176	Window foreground colour; resource B<foreground>.	193	Window foreground colour; resource B<foreground>.
177		194
178	=item B<-pixmap> I<file[;geom]>	195	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
179		196
180	Compile I<afterimage>: Specify image file for the background and also	197	Compile I<afterimage>: Specify image file for the background and also
181	optionally specify its scaling with a geometry string. Note you may need to	198	optionally specify its scaling with a geometry string. Note you may need to
182	add quotes to avoid special shell interpretation of the C<;> in the	199	add quotes to avoid special shell interpretation of the C<;> in the
183	command-line; for more details see resource B<backgroundPixmap>.	200	command-line; for more details see resource B<backgroundPixmap>.
184		201
185	=item B<-cr> I<colour>	202	=item B<-cr> I<colour>
…		…
233	italic> >> characters are to be printed. See resource B<boldItalicFont>	250	italic> >> characters are to be printed. See resource B<boldItalicFont>
234	for details.	251	for details.
235		252
236	=item B<-is>\|B<+is>	253	=item B<-is>\|B<+is>
237		254
238	Compile I<font-styles>: Bold/Italic font styles imply high intensity	255	Compile I<font-styles>: Bold/Blink font styles imply high intensity
239	foreground/background (default). See resource B<intensityStyles> for	256	foreground/background (default). See resource B<intensityStyles> for
240	details.	257	details.
241		258
242	=item B<-name> I<name>	259	=item B<-name> I<name>
243		260
…		…
261		278
262	=item B<-sb>\|B<+sb>	279	=item B<-sb>\|B<+sb>
263		280
264	Turn on/off scrollbar; resource B<scrollBar>.	281	Turn on/off scrollbar; resource B<scrollBar>.
265		282
		283	=item B<-sr>\|B<+sr>
		284
		285	Put scrollbar on right/left; resource B<scrollBar_right>.
		286
		287	=item B<-st>\|B<+st>
		288
		289	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		290	resource B<scrollBar_floating>.
		291
266	=item B<-si>\|B<+si>	292	=item B<-si>\|B<+si>
267		293
268	Turn on/off scroll-to-bottom on TTY output inhibit; resource	294	Turn on/off scroll-to-bottom on TTY output inhibit; resource
269	B<scrollTtyOutput> has opposite effect.	295	B<scrollTtyOutput> has opposite effect.
270		296
…		…
276	=item B<-sw>\|B<+sw>	302	=item B<-sw>\|B<+sw>
277		303
278	Turn on/off scrolling with the scrollback buffer as new lines appear.	304	Turn on/off scrolling with the scrollback buffer as new lines appear.
279	This only takes effect if B<-si> is also given; resource	305	This only takes effect if B<-si> is also given; resource
280	B<scrollWithBuffer>.	306	B<scrollWithBuffer>.
281
282	=item B<-sr>\|B<+sr>
283
284	Put scrollbar on right/left; resource B<scrollBar_right>.
285
286	=item B<-st>\|B<+st>
287
288	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
289	resource B<scrollBar_floating>.
290		307
291	=item B<-ptab>\|B<+ptab>	308	=item B<-ptab>\|B<+ptab>
292		309
293	If enabled (default), "Horizontal Tab" characters are being stored as	310	If enabled (default), "Horizontal Tab" characters are being stored as
294	actual wide characters in the screen buffer, which makes it possible to	311	actual wide characters in the screen buffer, which makes it possible to
…		…
323		340
324	=item B<-bl>	341	=item B<-bl>
325		342
326	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	343	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
327	if honoured by the WM, the rxvt-unicode window will not have window	344	if honoured by the WM, the rxvt-unicode window will not have window
328	decorations; resource B<borderLess>.	345	decorations; resource B<borderLess>. If the window manager does not
		346	support MWM hints (e.g. kwin), enables override-redirect mode.
329		347
330	=item B<-override-redirect>	348	=item B<-override-redirect>
331		349
332	Compile I<frills>: Sets override-redirect on the window; resource	350	Compile I<frills>: Sets override-redirect on the window; resource
333	B<override-redirect>.	351	B<override-redirect>.
…		…
341		359
342	=item B<-lsp> I<number>	360	=item B<-lsp> I<number>
343		361
344	Compile I<frills>: Lines (pixel height) to insert between each row of	362	Compile I<frills>: Lines (pixel height) to insert between each row of
345	the display. Useful to work around font rendering problems; resource	363	the display. Useful to work around font rendering problems; resource
346	B<linespace>.	364	B<lineSpace>.
347		365
348	=item B<-tn> I<termname>	366	=item B<-tn> I<termname>
349		367
350	This option specifies the name of the terminal type to be set in the	368	This option specifies the name of the terminal type to be set in the
351	B<TERM> environment variable. This terminal type must exist in the	369	B<TERM> environment variable. This terminal type must exist in the
…		…
406		424
407	=item B<-tcw>	425	=item B<-tcw>
408		426
409	Change the meaning of triple-click selection with the left mouse	427	Change the meaning of triple-click selection with the left mouse
410	button. Only effective when the original (non-perl) selection code is	428	button. Only effective when the original (non-perl) selection code is
411	in-use. Instead of selecting a full line it will extend the selection the	429	in-use. Instead of selecting a full line it will extend the selection to
412	end of the logical line only. resource B<tripleclickwords>.	430	the end of the logical line only. resource B<tripleclickwords>.
413		431
414	=item B<-insecure>	432	=item B<-insecure>
415		433
416	Enable "insecure" mode, which currently enables most of the escape	434	Enable "insecure" mode, which currently enables most of the escape
417	sequences that echo strings. See the resource B<insecure> for more	435	sequences that echo strings. See the resource B<insecure> for more
…		…
437		455
438	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	456	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
439	will not immediately destroy its window when the program executed within	457	will not immediately destroy its window when the program executed within
440	it exits. Instead, it will wait till it is being killed or closed by the	458	it exits. Instead, it will wait till it is being killed or closed by the
441	user; resource B<hold>.	459	user; resource B<hold>.
		460
		461	=item B<-cd> I<path>
		462
		463	Sets the working directory for the shell (or the command specified via
		464	B<-e>). The I<path> must be an absolute path and it must exist for
		465	@@RXVT_NAME@@ to start; resource B<chdir>.
		466
		467	=item B<-xrm> I<string>
		468
		469	Works like the X Toolkit option of the same name, by adding the I<string>
		470	as if it were specified in a resource file. Resource values specified this
		471	way take precedence over all other resource specifications.
		472
		473	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		474	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		475	options can be specified as long-options on the commandline, so use
		476	of B<-xrm> is mostly limited to cases where you want to specify other
		477	resources (e.g. for input methods) or for compatibility with other
		478	programs.
442		479
443	=item B<-keysym.>I<sym> I<string>	480	=item B<-keysym.>I<sym> I<string>
444		481
445	Remap a key symbol. See resource B<keysym>.	482	Remap a key symbol. See resource B<keysym>.
446		483
…		…
481	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	518	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
482	entries and will not tinker with pty/tty permissions - you have to do that	519	entries and will not tinker with pty/tty permissions - you have to do that
483	yourself if you want that.	520	yourself if you want that.
484		521
485	As an extremely special case, specifying C<-1> will completely suppress	522	As an extremely special case, specifying C<-1> will completely suppress
486	pty/tty operations.	523	pty/tty operations, which is probably only useful in conjunction with some
		524	perl extension that manages the terminal.
487		525
488	Here is a example in perl that illustrates how this option can be used (a	526	Here is a example in perl that illustrates how this option can be used (a
489	longer example is in F<doc/pty-fd>):	527	longer example is in F<doc/pty-fd>):
490		528
491	use IO::Pty;	529	use IO::Pty;
…		…
505	Comma-separated list of perl extension scripts to use (or not to use) in	543	Comma-separated list of perl extension scripts to use (or not to use) in
506	this terminal instance. See resource B<perl-ext> for details.	544	this terminal instance. See resource B<perl-ext> for details.
507		545
508	=back	546	=back
509		547
510	=head1 RESOURCES (available also as long-options)	548	=head1 RESOURCES
511		549
512	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	550	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
513	options) compiled into your version.	551	options) compiled into your version. All resources are also available as
		552	long-options.
514		553
515	You can set and change the resources using X11 tools like B<xrdb>. Many	554	You can set and change the resources using X11 tools like B<xrdb>. Many
516	distribution do also load settings from the B<~/.Xresources> file when X	555	distribution do also load settings from the B<~/.Xresources> file when X
517	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	556	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
518	with later settings overwriting earlier ones:	557	with later settings overwriting earlier ones:
…		…
520	1. system-wide app-defaults file, either locale-dependent OR global	559	1. system-wide app-defaults file, either locale-dependent OR global
521	2. app-defaults file in $XAPPLRESDIR	560	2. app-defaults file in $XAPPLRESDIR
522	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	561	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
523	4. SCREEN_RESOURCES for the current screen	562	4. SCREEN_RESOURCES for the current screen
524	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	563	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		564	6. resources specified via -xrm on the commandline
525		565
526	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	566	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
527	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	567	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
528	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily	568	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
529	configured, while the class name B<URxvt> allows resources unique to	569	configured, while the class name B<URxvt> allows resources unique to
…		…
539	=item B<depth:> I<bitdepth>	579	=item B<depth:> I<bitdepth>
540		580
541	Compile I<xft>: Attempt to find a visual with the given bit depth;	581	Compile I<xft>: Attempt to find a visual with the given bit depth;
542	option B<-depth>.	582	option B<-depth>.
543		583
		584	=item B<buffered:> I<boolean>
		585
		586	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		587	On some card/driver combination enabling it slightly decreases
		588	performance, on most it greatly helps it. The slowdown is small, so it
		589	should normally be enabled.
		590
544	=item B<geometry:> I<geom>	591	=item B<geometry:> I<geom>
545		592
546	Create the window with the specified X window geometry [default 80x24];	593	Create the window with the specified X window geometry [default 80x24];
547	option B<-geometry>.	594	option B<-geometry>.
548		595
…		…
631		678
632	B<False>: specify that everything is to be displayed, even	679	B<False>: specify that everything is to be displayed, even
633	if the refresh is too fast for the human eye to read anything (or the	680	if the refresh is too fast for the human eye to read anything (or the
634	monitor to display anything); option B<+ss>.	681	monitor to display anything); option B<+ss>.
635		682
636	=item B<inheritPixmap:> I<boolean>	683	=item B<transparent:> I<boolean>
637		684
638	B<True>: make the background inherit the parent windows' pixmap, giving	685	Turn on/off illusion of a transparent window background.
639	artificial transparency. B<False>: do not inherit the parent windows'
640	pixmap.
641		686
642	I<Please note that transparency of any kind if completely unsupported by	687	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
643	the author. Don't bug him with installation questions!>	688	future versions.
		689
		690	I<Please address all transparency related issues to Sasha Vasko at
		691	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
644		692
645	=item B<fading:> I<number>	693	=item B<fading:> I<number>
646		694
647	Fade the text by the given percentage when focus is lost; option B<-fade>.	695	Fade the text by the given percentage when focus is lost; option B<-fade>.
648		696
…		…
665		713
666	Specify background blending type; option B<-blt>.	714	Specify background blending type; option B<-blt>.
667		715
668	=item B<blurRadius:> I<number>	716	=item B<blurRadius:> I<number>
669		717
670	Apply Gaussian Blurr with the specified radius to the transparent	718	Apply Gaussian Blurr with the specified radius to the transparent
671	background image; option B<-blr>.	719	background image; option B<-blr>.
672		720
673	=item B<scrollColor:> I<colour>	721	=item B<scrollColor:> I<colour>
674		722
675	Use the specified colour for the scrollbar [default #B2B2B2].	723	Use the specified colour for the scrollbar [default #B2B2B2].
…		…
682	=item B<borderColor:> I<colour>	730	=item B<borderColor:> I<colour>
683		731
684	The colour of the border around the text area and between the scrollbar	732	The colour of the border around the text area and between the scrollbar
685	and the text.	733	and the text.
686		734
687	=item B<backgroundPixmap:> I<file[;geom]>	735	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
688		736
689	Use the specified image file for the background and also optionally	737	Use the specified image file for the background and also
690	specify its scaling with a geometry string B<WxH+X+Y>,	738	optionally specify its scaling with a geometry string B<WxH+X+Y>,
691	in which B<"W" / "H"> specify the horizontal/vertical scale (percent),	739	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
692	and B<"X" / "Y"> locate the image centre (percent).	740	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
693	A scale of 0 displays the image with tiling. A scale of 1 displays the	741	centre (percent). A scale of 0 displays the image with tiling. A scale
694	image without any scaling. A scale of 2 to 9 specifies an integer	742	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
695	number of images in that direction. No image will be magnified beyond	743	an integer number of images in that direction. No image will be magnified
696	10 times its original size. The maximum permitted scale is 1000.	744	beyond 10 times its original size. The maximum permitted scale is 1000.
697	Special string of B<"auto"> used as a geometry will cause image to be	745	Additional operations can be specified after colon B<:op1:op2...>.
698	automatically scaled to match window size.	746	Supported operations are:
		747
		748	tile force background image to be tiled and not scaled. Equivalent to 0x0
		749	propscale will scale image keeping proportions
		750	auto will scale image to match window size. Equivalent to 100x100
		751	hscale will scale image horizontally to the window size
		752	vscale will scale image vertically to the window size
		753	scale will scale image to match window size
		754	root will tile image as if it was a root window background, auto-adjusting
		755	whenever terminal window moves
		756
699	If used in conjunction with B<-tr> option - specified pixmap will be	757	If used in conjunction with B<-tr> option, the specified pixmap will be
700	blended over transparency image using either alpha-blending, or any	758	blended over transparency image using either alpha-blending, or any
701	other blending type, specified with B<-blt "type"> option.	759	other blending type, specified with B<-blt "type"> option.
702	[default 0x0+50+50]
703		760
704	=item B<path:> I<path>	761	=item B<path:> I<path>
705		762
706	Specify the colon-delimited search path for finding XPM files.	763	Specify the colon-delimited search path for finding background image files.
707		764
708	=item B<font:> I<fontlist>	765	=item B<font:> I<fontlist>
709		766
710	Select the fonts to be used. This is a comma separated list of font names	767	Select the fonts to be used. This is a comma separated list of font names
711	that are checked in order when trying to find glyphs for characters. The	768	that are checked in order when trying to find glyphs for characters. The
…		…
768	text font will being used for the given style.	825	text font will being used for the given style.
769		826
770	=item B<intensityStyles:> I<boolean>	827	=item B<intensityStyles:> I<boolean>
771		828
772	When font styles are not enabled, or this option is enabled (B<True>,	829	When font styles are not enabled, or this option is enabled (B<True>,
773	option B<-is>, the default), bold and italic font styles imply high	830	option B<-is>, the default), bold/blink font styles imply high
774	intensity foreground/background colours. Disabling this option (B<False>,	831	intensity foreground/background colours. Disabling this option (B<False>,
775	option B<+is>) disables this behaviour, the high intensity colours are not	832	option B<+is>) disables this behaviour, the high intensity colours are not
776	reachable.	833	reachable.
777		834
778	=item B<selectstyle:> I<mode>
779
780	Set mouse selection style to B<old> which is 2.20, B<oldword> which
781	is xterm style with 2.20 old word selection, or anything else which
782	gives xterm style selection. Only effective when the original (non-perl)
783	selection code is in use.
784
785	=item B<scrollstyle:> I<mode>
786
787	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
788	the author's favourite.
789
790	=item B<title:> I<string>	835	=item B<title:> I<string>
791		836
792	Set window title string, the default title is the command-line	837	Set window title string, the default title is the command-line
793	specified after the B<-e> option, if any, otherwise the application	838	specified after the B<-e> option, if any, otherwise the application
794	name; option B<-title>.	839	name; option B<-title>.
…		…
838		883
839	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	884	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
840		885
841	This creates a new file in your home directory with the screen contents	886	This creates a new file in your home directory with the screen contents
842	every time you hit C<Print>.	887	every time you hit C<Print>.
		888
		889	=item B<scrollstyle:> I<mode>
		890
		891	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		892	the author's favourite.
843		893
844	=item B<scrollBar:> I<boolean>	894	=item B<scrollBar:> I<boolean>
845		895
846	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	896	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
847	disable the scrollbar; option B<+sb>.	897	disable the scrollbar; option B<+sb>.
…		…
910	=item B<termName:> I<termname>	960	=item B<termName:> I<termname>
911		961
912	Specifies the terminal type name to be set in the B<TERM> environment	962	Specifies the terminal type name to be set in the B<TERM> environment
913	variable; option B<-tn>.	963	variable; option B<-tn>.
914		964
915	=item B<linespace:> I<number>	965	=item B<lineSpace:> I<number>
916		966
917	Specifies number of lines (pixel height) to insert between each row of	967	Specifies number of lines (pixel height) to insert between each row of
918	the display [default 0]; option B<-lsp>.	968	the display [default 0]; option B<-lsp>.
919		969
920	=item B<meta8:> I<boolean>	970	=item B<meta8:> I<boolean>
…		…
980	will be created). In this mode, characters outside ISO-8859-1 can be used.	1030	will be created). In this mode, characters outside ISO-8859-1 can be used.
981		1031
982	When the selection extension is not used, only ISO-8859-1 characters can	1032	When the selection extension is not used, only ISO-8859-1 characters can
983	be used. If not specified, the built-in default is used:	1033	be used. If not specified, the built-in default is used:
984		1034
985	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1035	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
986		1036
987	=item B<preeditType:> I<style>	1037	=item B<preeditType:> I<style>
988		1038
989	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1039	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
990		1040
…		…
1046		1096
1047	=item B<secondaryScroll:> I<boolean>	1097	=item B<secondaryScroll:> I<boolean>
1048		1098
1049	Turn on/off secondary screen scroll (default enabled). If this	1099	Turn on/off secondary screen scroll (default enabled). If this
1050	option is enabled, scrolls on the secondary screen will change the	1100	option is enabled, scrolls on the secondary screen will change the
1051	scrollback buffer and switching to/from the secondary screen will	1101	scrollback buffer and, when secondaryScreen is off, switching
1052	instead scroll the screen up.	1102	to/from the secondary screen will instead scroll the screen up.
1053		1103
1054	=item B<hold>: I<boolean>	1104	=item B<hold>: I<boolean>
1055		1105
1056	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1106	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1057	will not immediately destroy its window when the program executed within	1107	will not immediately destroy its window when the program executed within
1058	it exits. Instead, it will wait till it is being killed or closed by the	1108	it exits. Instead, it will wait till it is being killed or closed by the
1059	user.	1109	user.
		1110
		1111	=item B<chdir>: I<path>
		1112
		1113	Sets the working directory for the shell (or the command specified via
		1114	B<-e>). The I<path> must be an absolute path and it must exist for
		1115	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1116	directory will be used; option B<-cd>.
1060		1117
1061	=item B<keysym.>I<sym>: I<string>	1118	=item B<keysym.>I<sym>: I<string>
1062		1119
1063	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1120	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1064	intervening resource name B<keysym.> cannot be omitted.	1121	intervening resource name B<keysym.> cannot be omitted.
…		…
1078	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1135	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1079	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1136	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1080	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1137	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1081	performed in an exact manner; however, the closest match is assured.	1138	performed in an exact manner; however, the closest match is assured.
1082		1139
1083	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1140	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1084	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1141	number), see RESOURCES in C<man 7 X> for futher details.
1085	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1086	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1087	can start or end with whitespace. B<This feature is deprecated and will
1088	be removed>.
1089
1090	Please note that you need to double the C<\> in resource files, as
1091	Xlib itself does its own de-escaping (you can use C<\033> instead of
1092	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1093	processing).
1094		1142
1095	You can define a range of keysyms in one shot by providing a I<string>	1143	You can define a range of keysyms in one shot by providing a I<string>
1096	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1144	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1097	should be a character not used by the strings.	1145	should be a character not used by the strings.
1098		1146
…		…
1305		1353
1306	=head1 ISO 14755 SUPPORT	1354	=head1 ISO 14755 SUPPORT
1307		1355
1308	ISO 14755 is a standard for entering and viewing unicode characters	1356	ISO 14755 is a standard for entering and viewing unicode characters
1309	and character codes using the keyboard. It consists of 4 parts. The	1357	and character codes using the keyboard. It consists of 4 parts. The
1310	first part is available rxvt-unicode has been compiled with	1358	first part is available if rxvt-unicode has been compiled with
1311	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1359	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1312	with C<--enable-iso14755>.	1360	with C<--enable-iso14755>.
1313		1361
1314	=over 4	1362	=over 4
1315		1363
…		…
1434	=back	1482	=back
1435		1483
1436	=head2 ALPHA CHANNEL SUPPORT	1484	=head2 ALPHA CHANNEL SUPPORT
1437		1485
1438	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1486	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1439	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1487	their act together, rxvt-unicode will do it's own alpha channel management:
1440	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1488
1441	in addition to the ones provided by X, where the additional A component	1489	You can prefix any color with an opaquenes percentage enclosed in
		1490	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1491	(0-100) that specifies the opacity of the color, where C<0> is completely
		1492	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1493	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1494	is the recommended format to specify transparency values, and works with
		1495	all ways to specify a colour.
		1496
		1497	For complete control, rxvt-unicode also supports
		1498	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1499	specifications, where the additional C<aaaa> component specifies opacity
1442	specifies opacity (alpha) values. The minimum value of C<0> is completely	1500	(alpha) values. The minimum value of C<0000> is completely transparent,
1443	transparent). You can also prefix any color with C<[percent]>, where	1501	while C<ffff> is completely opaque). The two example colours from
1444	C<percent> is a decimal percentage (0-100) that specifies the opacity of	1502	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1445	the color, where C<0> is completely transparent and C<100> is completelxy	1503	C<rgba:0000/ff00/0000/f332>.
1446	opaque.
1447		1504
1448	You probably need to specify B<"-depth 32">, too, and have the luck that	1505	You probably need to specify B<"-depth 32">, too, to force a visual with
1449	your X-server uses ARGB pixel layout, as X is far from just supporting	1506	alpha channels, and have the luck that your X-server uses ARGB pixel
1450	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1507	layout, as X is far from just supporting ARGB visuals out of the box, and
		1508	rxvt-unicode just fudges around.
1451		1509
1452	For example, the following selects an almost completely transparent red	1510	For example, the following selects an almost completely transparent black
1453	background, and an almost opaque pink foreground:	1511	background, and an almost opaque pink foreground:
1454		1512
1455	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1513	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1456		1514
1457	I<Please note that transparency of any kind if completely unsupported by	1515	When not using a background image, then the interpretation of the
1458	the author. Don't bug him with installation questions!>	1516	alpha channel is up to your compositing manager (most interpret it as
		1517	transparency of course).
		1518
		1519	When using a background pixmap or pseudo-transparency, then the background
		1520	colour will always behave as if it were completely transparent (so the
		1521	background image shows instead), regardless of how it was specified, while
		1522	other colours will either be transparent as specified (the background
		1523	image will show through) on servers supporting the RENDER extension, or
		1524	fully opaque on servers not supporting the RENDER EXTENSION.
		1525
		1526	Please note that due to bugs in Xft, specifying alpha values might result
		1527	in garbage being displayed when the X-server does not support the RENDER
		1528	extension.
1459		1529
1460	=head1 ENVIRONMENT	1530	=head1 ENVIRONMENT
1461		1531
1462	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1532	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1463		1533
…		…
1469	resources or on the command line.	1539	resources or on the command line.
1470		1540
1471	=item B<COLORTERM>	1541	=item B<COLORTERM>
1472		1542
1473	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was	1543	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1474	compiled with XPM support, and optionally with the added extension	1544	compiled with background image support, and optionally with the added
1475	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1545	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1546	screen.
1476		1547
1477	=item B<COLORFGBG>	1548	=item B<COLORFGBG>
1478		1549
1479	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1550	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1480	the colour code used as default foreground/text colour (or the string	1551	the colour code used as default foreground/text colour (or the string
1481	C<default> to indicate that the default-colour escape sequence is to be	1552	C<default> to indicate that the default-colour escape sequence is to be
1482	used), C<bg> is the colour code used as default background colour (or the	1553	used), C<bg> is the colour code used as default background colour (or the
1483	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1554	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1484	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1555	was compiled with background image support. Libraries like C<ncurses>
1485	(and do) use this information to optimize screen output.	1556	and C<slang> can (and do) use this information to optimize screen output.
1486		1557
1487	=item B<WINDOWID>	1558	=item B<WINDOWID>
1488		1559
1489	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1560	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1490	window, which usually has subwindows for the scrollbar, the terminal	1561	window, which usually has subwindows for the scrollbar, the terminal
…		…
1496	C<--with-terminfo=PATH>.	1567	C<--with-terminfo=PATH>.
1497		1568
1498	=item B<DISPLAY>	1569	=item B<DISPLAY>
1499		1570
1500	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1571	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1501	display in its child processes.	1572	display in its child processes if C<-display> isn't used to override. It
		1573	defaults to C<:0> if it doesn't exist.
1502		1574
1503	=item B<SHELL>	1575	=item B<SHELL>
1504		1576
1505	The shell to be used for command execution, defaults to C</bin/sh>.	1577	The shell to be used for command execution, defaults to C</bin/sh>.
1506		1578
…		…
1581	Project Coordinator (changes.txt 2.21a to 2.4.5)	1653	Project Coordinator (changes.txt 2.21a to 2.4.5)
1582		1654
1583	=item Geoff Wing L<< <gcw@pobox.com> >>	1655	=item Geoff Wing L<< <gcw@pobox.com> >>
1584		1656
1585	Rewrote screen display and text selection routines.	1657	Rewrote screen display and text selection routines.
1586		1658
1587	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1659	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1588		1660
1589	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1661	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1590		1662
1591	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1663	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.132 by root, Mon Jun 18 13:38:12 2007 UTC vs. Revision 1.165 by root, Thu Oct 2 17:06:50 2008 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.132 by root, Mon Jun 18 13:38:12 2007 UTC vs.
Revision 1.165 by root, Thu Oct 2 17:06:50 2008 UTC