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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.98 by root, Mon Jan 16 15:12:48 2006 UTC vs.
Revision 1.158 by root, Wed Jan 23 14:33:42 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/checkout/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 left-to-right 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 userfriendly, lean and clean	43	me recommend C<mlterm>, which is a very user friendly, lean and clean
41	terminal emulator. In fact, the reason rxvt-unicode was born was solely	44	terminal emulator. In fact, the reason rxvt-unicode was born was solely
42	because the author couldn't get C<mlterm> to use one font for latin1 and	45	because the author couldn't get C<mlterm> to use one font for latin1 and
43	another for japanese.	46	another for japanese.
44		47
45	Therefore another design rationale was the use of multiple fonts to	48	Therefore another design rationale was the use of multiple fonts to
46	display characters: The idea of a single unicode font which many other	49	display characters: The idea of a single unicode font which many other
47	programs force onto it's users never made sense to me: You should be able	50	programs force onto its users never made sense to me: You should be able
48	to choose any font for any script freely.	51	to choose any font for any script freely.
49		52
50	Apart from that, rxvt-unicode is also much better internationalised than	53	Apart from that, rxvt-unicode is also much better internationalised than
51	it's predecessor, supports things such as XFT and ISO 14755 that are handy	54	its predecessor, supports things such as XFT and ISO 14755 that are handy
52	in i18n-environments, is faster, and has a lot less bugs than the original	55	in i18n-environments, is faster, and has a lot bugs less than the original
53	rxvt. This all in addition to dozens of other small improvements.	56	rxvt. This all in addition to dozens of other small improvements.
54		57
55	It is still faithfully following the original rxvt idea of being lean	58	It is still faithfully following the original rxvt idea of being lean
56	and nice on resources: for example, you can still configure rxvt-unicode	59	and nice on resources: for example, you can still configure rxvt-unicode
57	without most of it's features to get a lean binary. It also comes with	60	without most of its features to get a lean binary. It also comes with
58	a client/daemon pair that lets you open any number of terminal windows	61	a client/daemon pair that lets you open any number of terminal windows
59	from within a single process, which makes startup time very fast and	62	from within a single process, which makes startup time very fast and
60	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and	63	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
61	@@RXVT_NAME@@c(1) (client).	64	@@RXVT_NAME@@c(1) (client).
62		65
63	It also makes technical information about escape sequences (which have	66	It also makes technical information about escape sequences (which have
64	been extended) easier accessible: see @@RXVT_NAME@@(7) for technical	67	been extended) more accessible: see @@RXVT_NAME@@(7) for technical
65	reference documentation (escape sequences etc.).	68	reference documentation (escape sequences etc.).
66		69
67	=head1 OPTIONS	70	=head1 OPTIONS
68		71
69	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed	72	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
…		…
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 (B<-d> still
95	respected). In the absence of this option, the display specified by the	98	respected). In the absence of this option, the display specified by the
96	B<DISPLAY> environment variable is used.	99	B<DISPLAY> environment variable is used.
97		100
		101	=item B<-depth> I<bitdepth>
		102
		103	Compile I<xft>: Attempt to find a visual with the given bit depth;
		104	resource B<depth>.
		105
98	=item B<-geometry> I<geom>	106	=item B<-geometry> I<geom>
99		107
100	Window geometry (B<-g> still respected); resource B<geometry>.	108	Window geometry (B<-g> still respected); resource B<geometry>.
101		109
102	=item B<-rv>\|B<+rv>	110	=item B<-rv>\|B<+rv>
103		111
104	Turn on/off simulated reverse video; resource B<reverseVideo>.	112	Turn on/off simulated reverse video; resource B<reverseVideo>.
105		113
106	=item B<-j>\|B<+j>	114	=item B<-j>\|B<+j>
107		115
108	Turn on/off jump scrolling; resource B<jumpScroll>.	116	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
109		117
110	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>	118	=item B<-ss>\|B<+ss>
111		119
112	Turn on/off inheriting parent window's pixmap. Alternative form is	120	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
113	B<-tr>; resource B<inheritPixmap>.	121
		122	=item B<-tr>\|B<+tr>
		123
		124	Turn on/off illusion of a transparent window background; resource B<transparent>.
		125
		126	B<-ip> is still accepted as an obsolete alias but will be removed in
		127	future versions.
		128
		129	I<Please address all transparency related issues to Sasha Vasko at
		130	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
114		131
115	=item B<-fade> I<number>	132	=item B<-fade> I<number>
116		133
117	Fade the text by the given percentage when focus is lost. Small values	134	Fade the text by the given percentage when focus is lost. Small values
118	fade a little only, 100 completely replaces all colours by the fade	135	fade a little only, 100 completely replaces all colours by the fade
119	colour; resource B<fading>.	136	colour; resource B<fading>.
120		137
121	=item B<-fadecolor> I<colour>	138	=item B<-fadecolor> I<colour>
122		139
123	Fade to this colour when fading is used (see B<-fade>). The default colour	140	Fade to this colour when fading is used (see B<-fade>). The default colour
124	is black. resource B<fadeColor>.	141	is opaque black. resource B<fadeColor>.
125		142
126	=item B<-tint> I<colour>	143	=item B<-tint> I<colour>
127		144
128	Tint the transparent background pixmap with the given colour when	145	Tint the transparent background pixmap with the given colour when
129	transparency is enabled with B<-tr> or B<-ip>. This only works for	146	transparency is enabled with B<-tr>. This only works for
130	non-tiled backgrounds, currently. See also the B<-sh> option that can be	147	non-tiled backgrounds, currently. See also the B<-sh> option that can be
131	used to brighten or darken the image in addition to tinting it; resource	148	used to brighten or darken the image in addition to tinting it.
		149	Please note that certain tint colours can be applied on the server-side,
		150	thus yielding performance gain of two orders of magnitude. These colours are:
		151	blue, red, green, cyan, magenta, yellow, and those close to them. Also
		152	pure black and pure white colors essentially mean no tinting; resource
132	I<tintColor>. Example:	153	I<tintColor>. Example:
133		154
134	@@RXVT_NAME@@ -tr -tint blue -sh 40	155	@@RXVT_NAME@@ -tr -tint blue -sh 40
135		156
136	=item B<-sh>	157	=item B<-sh> I<number>
137		158
138	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	159	Darken (0 .. 100) or lighten (100 .. 200) the transparent
139	background image in addition to tinting it (i.e. B<-tint> must be	160	background image in addition to (or instead of) tinting it;
140	specified, too, e.g. C<-tint white>).	161	resource I<shading>.
		162
		163	=item B<-blt> I<string>
		164
		165	Specify background blending type. If background pixmap is specified
		166	at the same time as transparency - such pixmap will be blended over
		167	transparency image, using method specified. Supported values are :
		168	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
		169	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
		170	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
		171	alpha-blending. Compile I<afterimage>; resource I<blendType>.
		172
		173	=item B<-blr> I<HxV>
		174
		175	Apply Gaussian Blur with the specified radii to the transparent
		176	background image. If single number is specified - both vertical and
		177	horizontal radii are considered to be the same. Setting one of the
		178	radii to 1 and another to a large number creates interesting effects
		179	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
		180	resource I<blurRadius>.
141		181
142	=item B<-bg> I<colour>	182	=item B<-bg> I<colour>
143		183
144	Window background colour; resource B<background>.	184	Window background colour; resource B<background>.
145		185
146	=item B<-fg> I<colour>	186	=item B<-fg> I<colour>
147		187
148	Window foreground colour; resource B<foreground>.	188	Window foreground colour; resource B<foreground>.
149		189
150	=item B<-pixmap> I<file[;geom]>	190	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
151		191
152	Compile I<XPM>: Specify XPM file for the background and also optionally	192	Compile I<afterimage>: Specify image file for the background and also
153	specify its scaling with a geometry string. Note you may need to	193	optionally specify its scaling with a geometry string. Note you may need to
154	add quotes to avoid special shell interpretation of the C<;> in the	194	add quotes to avoid special shell interpretation of the C<;> in the
155	command-line; resource B<backgroundPixmap>.	195	command-line; for more details see resource B<backgroundPixmap>.
156		196
157	=item B<-cr> I<colour>	197	=item B<-cr> I<colour>
158		198
159	The cursor colour; resource B<cursorColor>.	199	The cursor colour; resource B<cursorColor>.
160		200
…		…
177	that are checked in order when trying to find glyphs for characters. The	217	that are checked in order when trying to find glyphs for characters. The
178	first font defines the cell size for characters; other fonts might be	218	first font defines the cell size for characters; other fonts might be
179	smaller, but not (in general) larger. A (hopefully) reasonable default	219	smaller, but not (in general) larger. A (hopefully) reasonable default
180	font list is always appended to it. See resource B<font> for more details.	220	font list is always appended to it. See resource B<font> for more details.
181		221
182	In short, to specify an X11 core font, just specify it's name or prefix it	222	In short, to specify an X11 core font, just specify its name or prefix it
183	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,	223	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184	e.g.:	224	e.g.:
185		225
186	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	226	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	227	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
205	italic> >> characters are to be printed. See resource B<boldItalicFont>	245	italic> >> characters are to be printed. See resource B<boldItalicFont>
206	for details.	246	for details.
207		247
208	=item B<-is>\|B<+is>	248	=item B<-is>\|B<+is>
209		249
210	Compile I<font-styles>: Bold/Italic font styles imply high intensity	250	Compile I<font-styles>: Bold/Blink font styles imply high intensity
211	foreground/background (default). See resource B<intensityStyles> for	251	foreground/background (default). See resource B<intensityStyles> for
212	details.	252	details.
213		253
214	=item B<-name> I<name>	254	=item B<-name> I<name>
215		255
…		…
233		273
234	=item B<-sb>\|B<+sb>	274	=item B<-sb>\|B<+sb>
235		275
236	Turn on/off scrollbar; resource B<scrollBar>.	276	Turn on/off scrollbar; resource B<scrollBar>.
237		277
		278	=item B<-sr>\|B<+sr>
		279
		280	Put scrollbar on right/left; resource B<scrollBar_right>.
		281
		282	=item B<-st>\|B<+st>
		283
		284	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		285	resource B<scrollBar_floating>.
		286
238	=item B<-si>\|B<+si>	287	=item B<-si>\|B<+si>
239		288
240	Turn on/off scroll-to-bottom on TTY output inhibit; resource	289	Turn on/off scroll-to-bottom on TTY output inhibit; resource
241	B<scrollTtyOutput> has opposite effect.	290	B<scrollTtyOutput> has opposite effect.
242		291
…		…
248	=item B<-sw>\|B<+sw>	297	=item B<-sw>\|B<+sw>
249		298
250	Turn on/off scrolling with the scrollback buffer as new lines appear.	299	Turn on/off scrolling with the scrollback buffer as new lines appear.
251	This only takes effect if B<-si> is also given; resource	300	This only takes effect if B<-si> is also given; resource
252	B<scrollWithBuffer>.	301	B<scrollWithBuffer>.
253
254	=item B<-sr>\|B<+sr>
255
256	Put scrollbar on right/left; resource B<scrollBar_right>.
257
258	=item B<-st>\|B<+st>
259
260	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
261	resource B<scrollBar_floating>.
262		302
263	=item B<-ptab>\|B<+ptab>	303	=item B<-ptab>\|B<+ptab>
264		304
265	If enabled (default), "Horizontal Tab" characters are being stored as	305	If enabled (default), "Horizontal Tab" characters are being stored as
266	actual wide characters in the screen buffer, which makes it possible to	306	actual wide characters in the screen buffer, which makes it possible to
…		…
297		337
298	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	338	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
299	if honoured by the WM, the rxvt-unicode window will not have window	339	if honoured by the WM, the rxvt-unicode window will not have window
300	decorations; resource B<borderLess>.	340	decorations; resource B<borderLess>.
301		341
		342	=item B<-override-redirect>
		343
		344	Compile I<frills>: Sets override-redirect on the window; resource
		345	B<override-redirect>.
		346
302	=item B<-sbg>	347	=item B<-sbg>
303		348
304	Compile I<frills>: Disable the usage of the built-in block graphics/line	349	Compile I<frills>: Disable the usage of the built-in block graphics/line
305	drawing characters and just rely on what the specified fonts provide. Use	350	drawing characters and just rely on what the specified fonts provide. Use
306	this if you have a good font and want to use its block graphic glyphs;	351	this if you have a good font and want to use its block graphic glyphs;
…		…
308		353
309	=item B<-lsp> I<number>	354	=item B<-lsp> I<number>
310		355
311	Compile I<frills>: Lines (pixel height) to insert between each row of	356	Compile I<frills>: Lines (pixel height) to insert between each row of
312	the display. Useful to work around font rendering problems; resource	357	the display. Useful to work around font rendering problems; resource
313	B<linespace>.	358	B<lineSpace>.
314		359
315	=item B<-tn> I<termname>	360	=item B<-tn> I<termname>
316		361
317	This option specifies the name of the terminal type to be set in the	362	This option specifies the name of the terminal type to be set in the
318	B<TERM> environment variable. This terminal type must exist in the	363	B<TERM> environment variable. This terminal type must exist in the
…		…
372	for more info.	417	for more info.
373		418
374	=item B<-tcw>	419	=item B<-tcw>
375		420
376	Change the meaning of triple-click selection with the left mouse	421	Change the meaning of triple-click selection with the left mouse
		422	button. Only effective when the original (non-perl) selection code is
377	button. Instead of selecting a full line it will extend the selection the	423	in-use. Instead of selecting a full line it will extend the selection to
378	end of the logical line only. resource B<tripleclickwords>.	424	the end of the logical line only. resource B<tripleclickwords>.
379		425
380	=item B<-insecure>	426	=item B<-insecure>
381		427
382	Enable "insecure" mode, which currently enables most of the escape	428	Enable "insecure" mode, which currently enables most of the escape
383	sequences that echo strings. See the resource B<insecure> for more	429	sequences that echo strings. See the resource B<insecure> for more
…		…
404	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	450	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
405	will not immediately destroy its window when the program executed within	451	will not immediately destroy its window when the program executed within
406	it exits. Instead, it will wait till it is being killed or closed by the	452	it exits. Instead, it will wait till it is being killed or closed by the
407	user; resource B<hold>.	453	user; resource B<hold>.
408		454
		455	=item B<-xrm> I<string>
		456
		457	Works like the X Toolkit option of the same name, by adding the I<string>
		458	as if it were specified in a resource file. Resource values specified this
		459	way take precedence over all other resource specifications.
		460
		461	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		462	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		463	options can be specified as long-options on the commandline, so use
		464	of B<-xrm> is mostly limited to cases where you want to specify other
		465	resources (e.g. for input methods) or for compatibility with other
		466	programs.
		467
409	=item B<-keysym.>I<sym> I<string>	468	=item B<-keysym.>I<sym> I<string>
410		469
411	Remap a key symbol. See resource B<keysym>.	470	Remap a key symbol. See resource B<keysym>.
412		471
413	=item B<-embed> I<windowid>	472	=item B<-embed> I<windowid>
414		473
415	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,	474	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
416	which enables applications to easily embed a terminal.	475	which enables applications to easily embed a terminal.
417		476
418	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it	477	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
419	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it	478	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
420	quite a bit, so don't expect it to keep some specific state. It's best to	479	quite a bit, so don't expect it to keep some specific state. It's best to
…		…
423	The window will not be destroyed when @@RXVT_NAME@@ exits.	482	The window will not be destroyed when @@RXVT_NAME@@ exits.
424		483
425	It might be useful to know that @@RXVT_NAME@@ will not close file	484	It might be useful to know that @@RXVT_NAME@@ will not close file
426	descriptors passed to it (except for stdin/out/err, of course), so you	485	descriptors passed to it (except for stdin/out/err, of course), so you
427	can use file descriptors to communicate with the programs within the	486	can use file descriptors to communicate with the programs within the
428	terminal. This works regardless of wether the C<-embed> option was used or	487	terminal. This works regardless of whether the C<-embed> option was used or
429	not.	488	not.
430		489
431	Here is a short Gtk2-perl snippet that illustrates how this option can be	490	Here is a short Gtk2-perl snippet that illustrates how this option can be
432	used (a longer example is in F<doc/embed>):	491	used (a longer example is in F<doc/embed>):
433		492
…		…
438	});	497	});
439		498
440	=item B<-pty-fd> I<file descriptor>	499	=item B<-pty-fd> I<file descriptor>
441		500
442	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	501	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
443	pair but instead use the given filehandle as the tty master. This is	502	pair but instead use the given file descriptor as the tty master. This is
444	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator	503	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
445	without having to run a program within it.	504	without having to run a program within it.
446		505
447	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	506	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
448	entries and will not tinker with pty/tty permissions - you have to do that	507	entries and will not tinker with pty/tty permissions - you have to do that
449	yourself if you want that.	508	yourself if you want that.
450		509
451	As an extremely special case, specifying C<-1> will completely suppress	510	As an extremely special case, specifying C<-1> will completely suppress
452	pty/tty operations.	511	pty/tty operations, which is probably only useful in conjunction with some
		512	perl extension that manages the terminal.
453		513
454	Here is a example in perl that illustrates how this option can be used (a	514	Here is a example in perl that illustrates how this option can be used (a
455	longer example is in F<doc/pty-fd>):	515	longer example is in F<doc/pty-fd>):
456		516
457	use IO::Pty;	517	use IO::Pty;
…		…
471	Comma-separated list of perl extension scripts to use (or not to use) in	531	Comma-separated list of perl extension scripts to use (or not to use) in
472	this terminal instance. See resource B<perl-ext> for details.	532	this terminal instance. See resource B<perl-ext> for details.
473		533
474	=back	534	=back
475		535
476	=head1 RESOURCES (available also as long-options)	536	=head1 RESOURCES
477		537
478	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	538	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
479	options) compiled into your version.	539	options) compiled into your version. All resources are also available as
		540	long-options.
480		541
481	You can set and change the resources using X11 tools like B<xrdb>. Many	542	You can set and change the resources using X11 tools like B<xrdb>. Many
482	distribution do also load settings from the B<~/.Xresources> file when X	543	distribution do also load settings from the B<~/.Xresources> file when X
483	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	544	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
484	with later settings overwriting earlier ones:	545	with later settings overwriting earlier ones:
…		…
486	1. system-wide app-defaults file, either locale-dependent OR global	547	1. system-wide app-defaults file, either locale-dependent OR global
487	2. app-defaults file in $XAPPLRESDIR	548	2. app-defaults file in $XAPPLRESDIR
488	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	549	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
489	4. SCREEN_RESOURCES for the current screen	550	4. SCREEN_RESOURCES for the current screen
490	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	551	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		552	6. resources specified via -xrm on the commandline
491		553
492	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	554	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
493	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	555	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
494	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily	556	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
495	configured, while the class name B<URxvt> allows resources unique to	557	configured, while the class name B<URxvt> allows resources unique to
…		…
500	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl	562	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
501	extensions not documented here):	563	extensions not documented here):
502		564
503	=over 4	565	=over 4
504		566
		567	=item B<depth:> I<bitdepth>
		568
		569	Compile I<xft>: Attempt to find a visual with the given bit depth;
		570	option B<-depth>.
		571
505	=item B<geometry:> I<geom>	572	=item B<geometry:> I<geom>
506		573
507	Create the window with the specified X window geometry [default 80x24];	574	Create the window with the specified X window geometry [default 80x24];
508	option B<-geometry>.	575	option B<-geometry>.
509		576
…		…
545	Use the specified colour to display underlined characters when the	612	Use the specified colour to display underlined characters when the
546	foreground colour is the default.	613	foreground colour is the default.
547		614
548	=item B<colorRV:> I<colour>	615	=item B<colorRV:> I<colour>
549		616
550	Use the specified colour as the background for reverse video	617	Use the specified colour as the background for reverse video characters
551	characters.	618	when OPTION_HC is disabled (--disable-frills).
552		619
553	=item B<underlineColor:> I<colour>	620	=item B<underlineColor:> I<colour>
554		621
555	If set, use the specified colour as the colour for the underline	622	If set, use the specified colour as the colour for the underline
556	itself. If unset, use the foreground colour.	623	itself. If unset, use the foreground colour.
…		…
572	option B<-rv>. B<False>: regular screen colours [default]; option	639	option B<-rv>. B<False>: regular screen colours [default]; option
573	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	640	B<+rv>. See note in B<COLORS AND GRAPHICS> section.
574		641
575	=item B<jumpScroll:> I<boolean>	642	=item B<jumpScroll:> I<boolean>
576		643
577	B<True>: specify that jump scrolling should be used. When scrolling	644	B<True>: specify that jump scrolling should be used. When receiving lots
578	quickly, fewer screen updates are performed [default]; option B<-j>.	645	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		646	has been read, resulting in fewer updates while still displaying every
		647	received line; option B<-j>.
		648
579	B<False>: specify that smooth scrolling should be used; option B<+j>.	649	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		650	force a screen refresh on each new line it received; option B<+j>.
580		651
581	=item B<inheritPixmap:> I<boolean>	652	=item B<skipScroll:> I<boolean>
582		653
583	B<True>: make the background inherit the parent windows' pixmap, giving	654	B<True>: (the default) specify that skip scrolling should be used. When
584	artificial transparency. B<False>: do not inherit the parent windows'	655	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
585	pixmap.	656	(around 60 times per second), resulting in far fewer updates. This can
		657	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		658	option B<-ss>.
		659
		660	B<False>: specify that everything is to be displayed, even
		661	if the refresh is too fast for the human eye to read anything (or the
		662	monitor to display anything); option B<+ss>.
		663
		664	=item B<transparent:> I<boolean>
		665
		666	Turn on/off illusion of a transparent window background.
		667
		668	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
		669	future versions.
		670
		671	I<Please address all transparency related issues to Sasha Vasko at
		672	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
586		673
587	=item B<fading:> I<number>	674	=item B<fading:> I<number>
588		675
589	Fade the text by the given percentage when focus is lost; option B<-fade>.	676	Fade the text by the given percentage when focus is lost; option B<-fade>.
590		677
…		…
598	Tint the transparent background pixmap with the given colour; option	685	Tint the transparent background pixmap with the given colour; option
599	B<-tint>.	686	B<-tint>.
600		687
601	=item B<shading:> I<number>	688	=item B<shading:> I<number>
602		689
603	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	690	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
604	image in addition to tinting it.	691	in addition to tinting it; option B<-sh>.
		692
		693	=item B<blendType:> I<string>
		694
		695	Specify background blending type; option B<-blt>.
		696
		697	=item B<blurRadius:> I<number>
		698
		699	Apply Gaussian Blurr with the specified radius to the transparent
		700	background image; option B<-blr>.
605		701
606	=item B<scrollColor:> I<colour>	702	=item B<scrollColor:> I<colour>
607		703
608	Use the specified colour for the scrollbar [default #B2B2B2].	704	Use the specified colour for the scrollbar [default #B2B2B2].
609		705
…		…
615	=item B<borderColor:> I<colour>	711	=item B<borderColor:> I<colour>
616		712
617	The colour of the border around the text area and between the scrollbar	713	The colour of the border around the text area and between the scrollbar
618	and the text.	714	and the text.
619		715
620	=item B<backgroundPixmap:> I<file[;geom]>	716	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
621		717
622	Use the specified XPM file (note the `.xpm' extension is optional) for	718	Use the specified image file for the background and also
623	the background and also optionally specify its scaling with a geometry	719	optionally specify its scaling with a geometry string B<WxH+X+Y>,
624	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	720	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
625	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	721	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
626	centre (percent). A scale of 0 displays the image with tiling. A scale	722	centre (percent). A scale of 0 displays the image with tiling. A scale
627	of 1 displays the image without any scaling. A scale of 2 to 9	723	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
628	specifies an integer number of images in that direction. No image will	724	an integer number of images in that direction. No image will be magnified
629	be magnified beyond 10 times its original size. The maximum permitted	725	beyond 10 times its original size. The maximum permitted scale is 1000.
630	scale is 1000. [default 0x0+50+50]	726	Additional operations can be specified after colon B<:op1:op2...>.
		727	Supported operations are:
		728
		729	tile force background image to be tiled and not scaled. Equivalent to 0x0
		730	propscale will scale image keeping proportions
		731	auto will scale image to match window size. Equivalent to 100x100
		732	hscale will scale image horizontally to the window size
		733	vscale will scale image vertically to the window size
		734	scale will scale image to match window size
		735	root will tile image as if it was a root window background, auto-adjusting
		736	whenever terminal window moves
		737
		738	If used in conjunction with B<-tr> option, the specified pixmap will be
		739	blended over transparency image using either alpha-blending, or any
		740	other blending type, specified with B<-blt "type"> option.
631		741
632	=item B<path:> I<path>	742	=item B<path:> I<path>
633		743
634	Specify the colon-delimited search path for finding XPM files.	744	Specify the colon-delimited search path for finding background image files.
635		745
636	=item B<font:> I<fontlist>	746	=item B<font:> I<fontlist>
637		747
638	Select the fonts to be used. This is a comma separated list of font names	748	Select the fonts to be used. This is a comma separated list of font names
639	that are checked in order when trying to find glyphs for characters. The	749	that are checked in order when trying to find glyphs for characters. The
…		…
696	text font will being used for the given style.	806	text font will being used for the given style.
697		807
698	=item B<intensityStyles:> I<boolean>	808	=item B<intensityStyles:> I<boolean>
699		809
700	When font styles are not enabled, or this option is enabled (B<True>,	810	When font styles are not enabled, or this option is enabled (B<True>,
701	option B<-is>, the default), bold and italic font styles imply high	811	option B<-is>, the default), bold/blink font styles imply high
702	intensity foreground/backround colours. Disabling this option (B<False>,	812	intensity foreground/background colours. Disabling this option (B<False>,
703	option B<+is>) disables this behaviour, the high intensity colours are not	813	option B<+is>) disables this behaviour, the high intensity colours are not
704	reachable.	814	reachable.
705
706	=item B<selectstyle:> I<mode>
707
708	Set mouse selection style to B<old> which is 2.20, B<oldword> which is
709	xterm style with 2.20 old word selection, or anything else which gives
710	xterm style selection.
711
712	=item B<scrollstyle:> I<mode>
713
714	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
715	the author's favourite.
716		815
717	=item B<title:> I<string>	816	=item B<title:> I<string>
718		817
719	Set window title string, the default title is the command-line	818	Set window title string, the default title is the command-line
720	specified after the B<-e> option, if any, otherwise the application	819	specified after the B<-e> option, if any, otherwise the application
…		…
729	=item B<mapAlert:> I<boolean>	828	=item B<mapAlert:> I<boolean>
730		829
731	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	830	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
732	de-iconify (map) on receipt of a bell character [default].	831	de-iconify (map) on receipt of a bell character [default].
733		832
		833	=item B<urgentOnBell:> I<boolean>
		834
		835	B<True>: set the urgency hint for the wm on receipt of a bell character.
		836	B<False>: do not set the urgency hint [default].
		837
734	=item B<visualBell:> I<boolean>	838	=item B<visualBell:> I<boolean>
735		839
736	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	840	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
737	B<False>: no visual bell [default]; option B<+vb>.	841	B<False>: no visual bell [default]; option B<+vb>.
738		842
…		…
759	Example:	863	Example:
760		864
761	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	865	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
762		866
763	This creates a new file in your home directory with the screen contents	867	This creates a new file in your home directory with the screen contents
764	everytime you hit C<Print>.	868	every time you hit C<Print>.
		869
		870	=item B<scrollstyle:> I<mode>
		871
		872	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		873	the author's favourite.
765		874
766	=item B<scrollBar:> I<boolean>	875	=item B<scrollBar:> I<boolean>
767		876
768	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	877	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
769	disable the scrollbar; option B<+sb>.	878	disable the scrollbar; option B<+sb>.
…		…
791		900
792	=item B<scrollWithBuffer:> I<boolean>	901	=item B<scrollWithBuffer:> I<boolean>
793		902
794	B<True>: scroll with scrollback buffer when tty receives new lines (and	903	B<True>: scroll with scrollback buffer when tty receives new lines (and
795	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	904	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
796	with scrollback buffer when tty recieves new lines; option B<+sw>.	905	with scrollback buffer when tty receives new lines; option B<+sw>.
797		906
798	=item B<scrollTtyKeypress:> I<boolean>	907	=item B<scrollTtyKeypress:> I<boolean>
799		908
800	B<True>: scroll to bottom when a non-special key is pressed. Special keys	909	B<True>: scroll to bottom when a non-special key is pressed. Special keys
801	are those which are intercepted by rxvt-unicode for special handling and	910	are those which are intercepted by rxvt-unicode for special handling and
…		…
832	=item B<termName:> I<termname>	941	=item B<termName:> I<termname>
833		942
834	Specifies the terminal type name to be set in the B<TERM> environment	943	Specifies the terminal type name to be set in the B<TERM> environment
835	variable; option B<-tn>.	944	variable; option B<-tn>.
836		945
837	=item B<linespace:> I<number>	946	=item B<lineSpace:> I<number>
838		947
839	Specifies number of lines (pixel height) to insert between each row of	948	Specifies number of lines (pixel height) to insert between each row of
840	the display [default 0]; option B<-lsp>.	949	the display [default 0]; option B<-lsp>.
841		950
842	=item B<meta8:> I<boolean>	951	=item B<meta8:> I<boolean>
…		…
891	pressed. If unset it will send the sequence traditionally associated	1000	pressed. If unset it will send the sequence traditionally associated
892	with the B<Execute> key.	1001	with the B<Execute> key.
893		1002
894	=item B<cutchars:> I<string>	1003	=item B<cutchars:> I<string>
895		1004
896	The characters used as delimiters for double-click word selection. The	1005	The characters used as delimiters for double-click word selection
897	built-in default:	1006	(whitespace delimiting is added automatically if resource is given).
898		1007
		1008	When the perl selection extension is in use (the default if compiled
		1009	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		1010	characters will be created (if the resource exists, otherwise, no regex
		1011	will be created). In this mode, characters outside ISO-8859-1 can be used.
		1012
		1013	When the selection extension is not used, only ISO-8859-1 characters can
		1014	be used. If not specified, the built-in default is used:
		1015
899	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1016	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
900		1017
901	=item B<preeditType:> I<style>	1018	=item B<preeditType:> I<style>
902		1019
903	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1020	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
904		1021
…		…
952		1069
953	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	1070	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
954	character is passed through. It may contain escape values as described	1071	character is passed through. It may contain escape values as described
955	in the entry on B<keysym> following.	1072	in the entry on B<keysym> following.
956		1073
957	=item B<secondaryScreen:> I<bool>	1074	=item B<secondaryScreen:> I<boolean>
958		1075
959	Turn on/off secondary screen (default enabled).	1076	Turn on/off secondary screen (default enabled).
960		1077
961	=item B<secondaryScroll:> I<bool>	1078	=item B<secondaryScroll:> I<boolean>
962		1079
963	Turn on/off secondary screen scroll (default enabled). If the this	1080	Turn on/off secondary screen scroll (default enabled). If this
964	option is enabled, scrolls on the secondary screen will change the	1081	option is enabled, scrolls on the secondary screen will change the
965	scrollback buffer and switching to/from the secondary screen will	1082	scrollback buffer and switching to/from the secondary screen will
966	instead scroll the screen up.	1083	instead scroll the screen up.
967		1084
968	=item B<hold>: I<bool>	1085	=item B<hold>: I<boolean>
969		1086
970	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1087	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
971	will not immediately destroy its window when the program executed within	1088	will not immediately destroy its window when the program executed within
972	it exits. Instead, it will wait till it is being killed or closed by the	1089	it exits. Instead, it will wait till it is being killed or closed by the
973	user.	1090	user.
…		…
992	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1109	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
993	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1110	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
994	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1111	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
995	performed in an exact manner; however, the closest match is assured.	1112	performed in an exact manner; however, the closest match is assured.
996		1113
997	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1114	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
998	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1115	number), see RESOURCES in C<man 7 X> for futher details.
999	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1000	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1001	can start or end with whitespace.
1002
1003	Please note that you need to double the C<\> in resource files, as
1004	Xlib itself does it's own de-escaping (you can use C<\033> instead of
1005	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1006	processing).
1007		1116
1008	You can define a range of keysyms in one shot by providing a I<string>	1117	You can define a range of keysyms in one shot by providing a I<string>
1009	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1118	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1010	should be a character not used by the strings.	1119	should be a character not used by the strings.
1011		1120
1012	Its usage can be demonstrated by an example:	1121	Its usage can be demonstrated by an example:
1013		1122
1014	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1123	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
…		…
1078	example, C<default,-selection> will use all the default extension except	1187	example, C<default,-selection> will use all the default extension except
1079	C<selection>.	1188	C<selection>.
1080		1189
1081	Extension names can also be followed by an argument in angle brackets	1190	Extension names can also be followed by an argument in angle brackets
1082	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1191	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1083	searchable scorllback to Alt/Meta-s). Mentioning the same extension	1192	searchable scrollback to Alt/Meta-s). Mentioning the same extension
1084	multiple times with different arguments will pass multiple arguments to	1193	multiple times with different arguments will pass multiple arguments to
1085	the extension.	1194	the extension.
1086		1195
1087	Each extension is looked up in the library directories, loaded if	1196	Each extension is looked up in the library directories, loaded if
1088	necessary, and bound to the current terminal instance.	1197	necessary, and bound to the current terminal instance.
…		…
1124	(default: C<M-s>).	1233	(default: C<M-s>).
1125		1234
1126	=item B<urlLauncher>: I<string>	1235	=item B<urlLauncher>: I<string>
1127		1236
1128	Specifies the program to be started with a URL argument. Used by the	1237	Specifies the program to be started with a URL argument. Used by the
1129	C<selection-popup> and C<mark-urls> perl extensions.	1238	C<selection-popup> and C<matcher> perl extensions.
1130		1239
1131	=item B<transient-for>: I<windowid>	1240	=item B<transient-for>: I<windowid>
1132		1241
1133	Sets the WM_TRANSIENT_FOR property to the given window iw.	1242	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1243
		1244	=item B<override-redirect>: I<boolean>
		1245
		1246	Compile I<frills>: Sets override-redirect for the terminal window, making
		1247	it almost invisible to window managers; option B<-override-redirect>.
		1248
		1249	=item B<iso14755_52:> I<boolean>
		1250
		1251	Turn on/off ISO 14755 5.2 mode (default enabled).
1134		1252
1135	=back	1253	=back
1136		1254
1137	=head1 THE SCROLLBAR	1255	=head1 THE SCROLLBAR
1138		1256
…		…
1157	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1275	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1158	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1276	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1159	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1277	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1160	respectively.	1278	respectively.
1161		1279
1162	=head1 TEXT SELECTION AND INSERTION	1280	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1163		1281
1164	The behaviour of text selection and insertion mechanism is similar to	1282	The behaviour of text selection and insertion/pasting mechanism is similar
1165	I<xterm>(1).	1283	to I<xterm>(1).
1166		1284
1167	=over 4	1285	=over 4
1168		1286
1169	=item B<Selection>:	1287	=item B<Selecting>:
1170		1288
1171	Left click at the beginning of the region, drag to the end of the region	1289	Left click at the beginning of the region, drag to the end of the region
1172	and release; Right click to extend the marked region; Left double-click	1290	and release; Right click to extend the marked region; Left double-click
1173	to select a word; Left triple-click to select the entire logical line	1291	to select a word; Left triple-click to select the entire logical line
1174	(which can span multiple screen lines), unless modified by resource	1292	(which can span multiple screen lines), unless modified by resource
…		…
1178	(Compile: I<frills>) will create a rectangular selection instead of a	1296	(Compile: I<frills>) will create a rectangular selection instead of a
1179	normal one. In this mode, every selected row becomes its own line in the	1297	normal one. In this mode, every selected row becomes its own line in the
1180	selection, and trailing whitespace is visually underlined and removed from	1298	selection, and trailing whitespace is visually underlined and removed from
1181	the selection.	1299	the selection.
1182		1300
1183	=item B<Insertion>:	1301	=item B<Pasting>:
1184		1302
1185	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1303	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1186	an B<@@RXVT_NAME@@> window causes the current text selection to be	1304	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1187	inserted as if it had been typed on the keyboard.	1305	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1306
		1307	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1308	inserted too.
1188		1309
1189	=back	1310	=back
1190		1311
1191	=head1 CHANGING FONTS	1312	=head1 CHANGING FONTS
1192		1313
…		…
1206		1327
1207	=head1 ISO 14755 SUPPORT	1328	=head1 ISO 14755 SUPPORT
1208		1329
1209	ISO 14755 is a standard for entering and viewing unicode characters	1330	ISO 14755 is a standard for entering and viewing unicode characters
1210	and character codes using the keyboard. It consists of 4 parts. The	1331	and character codes using the keyboard. It consists of 4 parts. The
1211	first part is available rxvt-unicode has been compiled with	1332	first part is available if rxvt-unicode has been compiled with
1212	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1333	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1213	with C<--enable-iso14755>.	1334	with C<--enable-iso14755>.
1214		1335
1215	=over 4	1336	=over 4
1216		1337
…		…
1236	This mode lets you input characters representing the keycap symbols of	1357	This mode lets you input characters representing the keycap symbols of
1237	your keyboard, if representable in the current locale encoding.	1358	your keyboard, if representable in the current locale encoding.
1238		1359
1239	Start by pressing C<Control> and C<Shift> together, then releasing	1360	Start by pressing C<Control> and C<Shift> together, then releasing
1240	them. The next special key (cursor keys, home etc.) you enter will not	1361	them. The next special key (cursor keys, home etc.) you enter will not
1241	invoke it's usual function but instead will insert the corresponding	1362	invoke its usual function but instead will insert the corresponding
1242	keycap symbol. The symbol will only be entered when the key has been	1363	keycap symbol. The symbol will only be entered when the key has been
1243	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1364	released, otherwise pressing e.g. C<Shift> would enter the symbol for
1244	C<ISO Level 2 Switch>, although your intention might have been to enter a	1365	C<ISO Level 2 Switch>, although your intention might have been to enter a
1245	reverse tab (Shift-Tab).	1366	reverse tab (Shift-Tab).
1246		1367
…		…
1279	=head1 COLORS AND GRAPHICS	1400	=head1 COLORS AND GRAPHICS
1280		1401
1281	In addition to the default foreground and background colours,	1402	In addition to the default foreground and background colours,
1282	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1403	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1283	high-intensity bold/blink versions of the same). Here is a list of the	1404	high-intensity bold/blink versions of the same). Here is a list of the
1284	colours with their B<rgb.txt> names.	1405	colours with their names.
1285		1406
1286	=begin table	1407	=begin table
1287		1408
1288	B<color0> (black) = Black	1409	B<color0> (black) = Black
1289	B<color1> (red) = Red3	1410	B<color1> (red) = Red3
…		…
1309	It is also possible to specify the colour values of B<foreground>,	1430	It is also possible to specify the colour values of B<foreground>,
1310	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1431	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1311	a number 0-15, as a convenient shorthand to reference the colour name of	1432	a number 0-15, as a convenient shorthand to reference the colour name of
1312	color0-color15.	1433	color0-color15.
1313		1434
		1435	In addition to the colours defined above, @@RXVT_NAME@@ offers an
		1436	additional 72 colours. The first 64 of those (with indices 16 to 79)
		1437	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
		1438	16>), followed by 8 additional shades of gray (with indices 80 to 87).
		1439
		1440	Together, all those colours implement the 88 colour xterm colours. Only
		1441	the first 16 can be changed using resources currently, the rest can only
		1442	be changed via command sequences ("escape codes").
		1443
1314	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1444	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1315	always swapping the foreground/background colours. This is in contrast to	1445	always swapping the foreground/background colours. This is in contrast to
1316	I<xterm>(1) where the colours are only swapped if they have not otherwise	1446	I<xterm>(1) where the colours are only swapped if they have not otherwise
1317	been specified. For example,	1447	been specified. For example,
1318		1448
…		…
1323	would yield White on Black, while on I<xterm>(1) it would yield Black	1453	would yield White on Black, while on I<xterm>(1) it would yield Black
1324	on White.	1454	on White.
1325		1455
1326	=back	1456	=back
1327		1457
		1458	=head2 ALPHA CHANNEL SUPPORT / TRANSPARENT COLOURS
		1459
		1460	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1461	their act together, rxvt-unicode will do it's own alpha channel management:
		1462
		1463	You can prefix any color with an opaquenes percentage enclosed in
		1464	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1465	(0-100) that specifies the opacity of the color, where C<0> is completely
		1466	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1467	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1468	is the recommended format to specify transparency values, and works with
		1469	all ways to specify a colour.
		1470
		1471	For complete control, rxvt-unicode also supports
		1472	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1473	specifications, where the additional C<aaaa> component specifies opacity
		1474	(alpha) values. The minimum value of C<0000> is completely transparent,
		1475	while C<ffff> is completely opaque). The two example colours from
		1476	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1477	C<rgba:0000/ff00/0000/f332>.
		1478
		1479	You probably need to specify B<"-depth 32">, too, to force a visual with
		1480	alpha channels, and have the luck that your X-server uses ARGB pixel
		1481	layout, as X is far from just supporting ARGB visuals out of the box, and
		1482	rxvt-unicode just fudges around.
		1483
		1484	For example, the following selects an almost completely transparent black
		1485	background, and an almost opaque pink foreground:
		1486
		1487	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
		1488
		1489	When not using a background image, then the interpretation of the
		1490	alpha channel is up to your compositing manager (most interpret it as
		1491	transparency of course).
		1492
		1493	When using a background pixmap or pseudo-transparency, then the background
		1494	colour will always behave as if it were completely transparent (so the
		1495	background image shows instead), regardless of how it was specified, while
		1496	other colours will either be transparent as specified (the background
		1497	image will show through) on servers supporting the RENDER extension, or
		1498	fully opaque on servers not supporting the RENDER EXTENSION.
		1499
		1500	Please note that due to bugs in Xft, specifying alpha values might result
		1501	in garbage being displayed when the X-server does not support the RENDER
		1502	extension.
		1503
1328	=head1 ENVIRONMENT	1504	=head1 ENVIRONMENT
1329		1505
1330	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1506	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1331		1507
1332	=over 4	1508	=over 4
1333		1509
1334	=item B<TERM>	1510	=item B<TERM>
1335		1511
1336	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1512	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1337	resources or on the commandline.	1513	resources or on the command line.
1338		1514
1339	=item B<COLORTERM>	1515	=item B<COLORTERM>
1340		1516
1341	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1517	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1342	compiled with XPM support, and optionally with the added extension	1518	compiled with background image support, and optionally with the added
1343	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1519	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1520	screen.
1344		1521
1345	=item B<COLORFGBG>	1522	=item B<COLORFGBG>
1346		1523
1347	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1524	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1348	the colour code used as default foreground/text colour (or the string	1525	the colour code used as default foreground/text colour (or the string
1349	C<default> to indicate that the default-colour escape sequence is to be	1526	C<default> to indicate that the default-colour escape sequence is to be
1350	used), C<bg> is the colour code used as default background colour (or the	1527	used), C<bg> is the colour code used as default background colour (or the
1351	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1528	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1352	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1529	was compiled with background image support. Libraries like C<ncurses>
1353	(and do) use this information to optimize screen output.	1530	and C<slang> can (and do) use this information to optimize screen output.
1354		1531
1355	=item B<WINDOWID>	1532	=item B<WINDOWID>
1356		1533
1357	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1534	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1358	window, which usually has subwindows for the scrollbar, the terminal	1535	window, which usually has subwindows for the scrollbar, the terminal
…		…
1364	C<--with-terminfo=PATH>.	1541	C<--with-terminfo=PATH>.
1365		1542
1366	=item B<DISPLAY>	1543	=item B<DISPLAY>
1367		1544
1368	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1545	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1369	display in it's child processes.	1546	display in its child processes.
1370		1547
1371	=item B<SHELL>	1548	=item B<SHELL>
1372		1549
1373	The shell to be used for command execution, defaults to C</bin/sh>.	1550	The shell to be used for command execution, defaults to C</bin/sh>.
1374		1551
…		…
1416		1593
1417	=item Project Coordinator	1594	=item Project Coordinator
1418		1595
1419	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1596	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1420		1597
1421	L<http://software.schmorp.de/#rxvt-unicode>	1598	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1422		1599
1423	=back	1600	=back
1424		1601
1425	=head1 AUTHORS	1602	=head1 AUTHORS
1426		1603
…		…
1448		1625
1449	Project Coordinator (changes.txt 2.21a to 2.4.5)	1626	Project Coordinator (changes.txt 2.21a to 2.4.5)
1450		1627
1451	=item Geoff Wing L<< <gcw@pobox.com> >>	1628	=item Geoff Wing L<< <gcw@pobox.com> >>
1452		1629
1453	Rewrote screen display and text selection routines. Project Coordinator	1630	Rewrote screen display and text selection routines.
		1631
1454	(changes.txt 2.4.6 - rxvt-unicode)	1632	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1455		1633
1456	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1634	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1457		1635
1458	Forked rxvt-unicode, rewrote most of the display code and internal	1636	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1459	character handling to store text in unicode, improve xterm	1637	extension, random hacks, numerous bugfixes and extensions.
1460	compatibility and apply numerous other bugfixes and extensions.
1461		1638
1462	Project Coordinator (Changes 1.0 -)	1639	Project Coordinator (Changes 1.0 -)
1463		1640
		1641	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1642
		1643	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
		1644
1464	=back	1645	=back
1465		1646

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.98 by root, Mon Jan 16 15:12:48 2006 UTC vs. Revision 1.158 by root, Wed Jan 23 14:33:42 2008 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.98 by root, Mon Jan 16 15:12:48 2006 UTC vs.
Revision 1.158 by root, Wed Jan 23 14:33:42 2008 UTC