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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.91 by root, Mon Jan 9 23:00:07 2006 UTC vs.
Revision 1.156 by ayin, Sun Dec 30 22:43:40 2007 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
…		…
172	resource B<borderColor>.	212	resource B<borderColor>.
173		213
174	=item B<-fn> I<fontlist>	214	=item B<-fn> I<fontlist>
175		215
176	Select the fonts to be used. This is a comma separated list of font names	216	Select the fonts to be used. This is a comma separated list of font names
177	that are used in turn when trying to display Unicode 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
…		…
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	There are two different methods that @@RXVT_NAME@@ can use to get the	542	You can set and change the resources using X11 tools like B<xrdb>. Many
482	Xresource data: using the X libraries (Xrm*-functions) or internal	543	distribution do also load settings from the B<~/.Xresources> file when X
483	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	544	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
484	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	545	with later settings overwriting earlier ones:
485	resources using X11 tools like B<xrdb>. Many distribution do also load
486	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
487	will consult the following files/resources in order, with later settings
488	overwriting earlier ones:
489		546
490	1. system-wide app-defaults file, either locale-dependent OR global	547	1. system-wide app-defaults file, either locale-dependent OR global
491	2. app-defaults file in $XAPPLRESDIR	548	2. app-defaults file in $XAPPLRESDIR
492	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	549	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
493	4. SCREEN_RESOURCES for the current screen	550	4. SCREEN_RESOURCES for the current screen
494	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	551	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		552	6. resources specified via -xrm on the commandline
495		553
496	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
497	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
498	set in XAPPLOADDIR/URxvt (compile-time defined: usually
499	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
500	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
501	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	554	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
502	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows	555	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
503	resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be	556	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
504	easily configured, while the class name B<URxvt> allows resources	557	configured, while the class name B<URxvt> allows resources unique to
505	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	558	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
506	shared between different B<@@RXVT_NAME@@> configurations. If no	559	configurations. If no resources are specified, suitable defaults will
507	resources are specified, suitable defaults will be used. Command-line	560	be used. Command-line arguments can be used to override resource
508	arguments can be used to override resource settings. The following	561	settings. The following resources are supported (you might want to
509	resources are allowed:	562	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		563	extensions not documented here):
510		564
511	=over 4	565	=over 4
		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>.
512		571
513	=item B<geometry:> I<geom>	572	=item B<geometry:> I<geom>
514		573
515	Create the window with the specified X window geometry [default 80x24];	574	Create the window with the specified X window geometry [default 80x24];
516	option B<-geometry>.	575	option B<-geometry>.
…		…
553	Use the specified colour to display underlined characters when the	612	Use the specified colour to display underlined characters when the
554	foreground colour is the default.	613	foreground colour is the default.
555		614
556	=item B<colorRV:> I<colour>	615	=item B<colorRV:> I<colour>
557		616
558	Use the specified colour as the background for reverse video	617	Use the specified colour as the background for reverse video characters
559	characters.	618	when OPTION_HC is disabled (--disable-frills).
560		619
561	=item B<underlineColor:> I<colour>	620	=item B<underlineColor:> I<colour>
562		621
563	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
564	itself. If unset, use the foreground colour.	623	itself. If unset, use the foreground colour.
…		…
580	option B<-rv>. B<False>: regular screen colours [default]; option	639	option B<-rv>. B<False>: regular screen colours [default]; option
581	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	640	B<+rv>. See note in B<COLORS AND GRAPHICS> section.
582		641
583	=item B<jumpScroll:> I<boolean>	642	=item B<jumpScroll:> I<boolean>
584		643
585	B<True>: specify that jump scrolling should be used. When scrolling	644	B<True>: specify that jump scrolling should be used. When receiving lots
586	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
587	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>.
588		651
589	=item B<inheritPixmap:> I<boolean>	652	=item B<skipScroll:> I<boolean>
590		653
591	B<True>: make the background inherit the parent windows' pixmap, giving	654	B<True>: (the default) specify that skip scrolling should be used. When
592	artificial transparency. B<False>: do not inherit the parent windows'	655	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
593	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@@)!>
594		673
595	=item B<fading:> I<number>	674	=item B<fading:> I<number>
596		675
597	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>.
598		677
…		…
606	Tint the transparent background pixmap with the given colour; option	685	Tint the transparent background pixmap with the given colour; option
607	B<-tint>.	686	B<-tint>.
608		687
609	=item B<shading:> I<number>	688	=item B<shading:> I<number>
610		689
611	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	690	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
612	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>.
613		701
614	=item B<scrollColor:> I<colour>	702	=item B<scrollColor:> I<colour>
615		703
616	Use the specified colour for the scrollbar [default #B2B2B2].	704	Use the specified colour for the scrollbar [default #B2B2B2].
617		705
…		…
623	=item B<borderColor:> I<colour>	711	=item B<borderColor:> I<colour>
624		712
625	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
626	and the text.	714	and the text.
627		715
628	=item B<backgroundPixmap:> I<file[;geom]>	716	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
629		717
630	Use the specified XPM file (note the `.xpm' extension is optional) for	718	Use the specified image file for the background and also
631	the background and also optionally specify its scaling with a geometry	719	optionally specify its scaling with a geometry string B<WxH+X+Y>,
632	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
633	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	721	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
634	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
635	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
636	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
637	be magnified beyond 10 times its original size. The maximum permitted	725	beyond 10 times its original size. The maximum permitted scale is 1000.
638	scale is 1000. [default 0x0+50+50]	726	Additional operations can be specified after colon B<:op1:op2...>.
		727	Supported operations are:
639		728
640	=item B<menu:> I<file[;tag]>	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
641		737
642	Read in the specified menu file (note the `.menu' extension is	738	If used in conjunction with B<-tr> option, the specified pixmap will be
643	optional) and also optionally specify a starting tag to find. See the	739	blended over transparency image using either alpha-blending, or any
644	reference documentation for details on the syntax for the menuBar.	740	other blending type, specified with B<-blt "type"> option.
645		741
646	=item B<path:> I<path>	742	=item B<path:> I<path>
647		743
648	Specify the colon-delimited search path for finding files (XPM and	744	Specify the colon-delimited search path for finding background image files.
649	menus), in addition to the paths specified by the B<RXVTPATH> and
650	B<PATH> environment variables.
651		745
652	=item B<font:> I<fontlist>	746	=item B<font:> I<fontlist>
653		747
654	Select the fonts to be used. This is a comma separated list of font	748	Select the fonts to be used. This is a comma separated list of font names
655	names that are used in turn when trying to display Unicode characters.	749	that are checked in order when trying to find glyphs for characters. The
656	The first font defines the cell size for characters; other fonts might	750	first font defines the cell size for characters; other fonts might be
657	be smaller, but not larger. A reasonable default font list is always	751	smaller, but not (in general) larger. A (hopefully) reasonable default
658	appended to it; option B<-fn>.	752	font list is always appended to it; option B<-fn>.
659		753
660	Each font can either be a standard X11 core font (XLFD) name, with	754	Each font can either be a standard X11 core font (XLFD) name, with
661	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.	755	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
662		756
663	In addition, each font can be prefixed with additional hints and	757	In addition, each font can be prefixed with additional hints and
…		…
665	hint currently is C<codeset=codeset-name>, and this is only used for Xft	759	hint currently is C<codeset=codeset-name>, and this is only used for Xft
666	fonts.	760	fonts.
667		761
668	For example, this font resource	762	For example, this font resource
669		763
670	URxvt*font: 9x15bold,\	764	URxvt.font: 9x15bold,\
671	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	765	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
672	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \	766	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
673	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	767	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
674	xft:Code2000:antialias=false	768	xft:Code2000:antialias=false
675		769
…		…
712	text font will being used for the given style.	806	text font will being used for the given style.
713		807
714	=item B<intensityStyles:> I<boolean>	808	=item B<intensityStyles:> I<boolean>
715		809
716	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>,
717	option B<-is>, the default), bold and italic font styles imply high	811	option B<-is>, the default), bold/blink font styles imply high
718	intensity foreground/backround colours. Disabling this option (B<False>,	812	intensity foreground/background colours. Disabling this option (B<False>,
719	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
720	reachable.	814	reachable.
721
722	=item B<selectstyle:> I<mode>
723
724	Set mouse selection style to B<old> which is 2.20, B<oldword> which is
725	xterm style with 2.20 old word selection, or anything else which gives
726	xterm style selection.
727		815
728	=item B<scrollstyle:> I<mode>	816	=item B<scrollstyle:> I<mode>
729		817
730	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	818	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
731	the author's favourite.	819	the author's favourite.
…		…
745	=item B<mapAlert:> I<boolean>	833	=item B<mapAlert:> I<boolean>
746		834
747	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	835	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
748	de-iconify (map) on receipt of a bell character [default].	836	de-iconify (map) on receipt of a bell character [default].
749		837
		838	=item B<urgentOnBell:> I<boolean>
		839
		840	B<True>: set the urgency hint for the wm on receipt of a bell character.
		841	B<False>: do not set the urgency hint [default].
		842
750	=item B<visualBell:> I<boolean>	843	=item B<visualBell:> I<boolean>
751		844
752	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	845	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
753	B<False>: no visual bell [default]; option B<+vb>.	846	B<False>: no visual bell [default]; option B<+vb>.
754		847
…		…
772		865
773	The string will be interpreted as if typed into the shell as-is.	866	The string will be interpreted as if typed into the shell as-is.
774		867
775	Example:	868	Example:
776		869
777	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	870	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
778		871
779	This creates a new file in your home directory with the screen contents	872	This creates a new file in your home directory with the screen contents
780	everytime you hit C<Print>.	873	every time you hit C<Print>.
781		874
782	=item B<scrollBar:> I<boolean>	875	=item B<scrollBar:> I<boolean>
783		876
784	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	877	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
785	disable the scrollbar; option B<+sb>.	878	disable the scrollbar; option B<+sb>.
…		…
807		900
808	=item B<scrollWithBuffer:> I<boolean>	901	=item B<scrollWithBuffer:> I<boolean>
809		902
810	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
811	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
812	with scrollback buffer when tty recieves new lines; option B<+sw>.	905	with scrollback buffer when tty receives new lines; option B<+sw>.
813		906
814	=item B<scrollTtyKeypress:> I<boolean>	907	=item B<scrollTtyKeypress:> I<boolean>
815		908
816	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
817	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
…		…
848	=item B<termName:> I<termname>	941	=item B<termName:> I<termname>
849		942
850	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
851	variable; option B<-tn>.	944	variable; option B<-tn>.
852		945
853	=item B<linespace:> I<number>	946	=item B<lineSpace:> I<number>
854		947
855	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
856	the display [default 0]; option B<-lsp>.	949	the display [default 0]; option B<-lsp>.
857		950
858	=item B<meta8:> I<boolean>	951	=item B<meta8:> I<boolean>
…		…
907	pressed. If unset it will send the sequence traditionally associated	1000	pressed. If unset it will send the sequence traditionally associated
908	with the B<Execute> key.	1001	with the B<Execute> key.
909		1002
910	=item B<cutchars:> I<string>	1003	=item B<cutchars:> I<string>
911		1004
912	The characters used as delimiters for double-click word selection. The	1005	The characters used as delimiters for double-click word selection
913	built-in default:	1006	(whitespace delimiting is added automatically if resource is given).
914		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
915	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1016	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
916		1017
917	=item B<preeditType:> I<style>	1018	=item B<preeditType:> I<style>
918		1019
919	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1020	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
920		1021
…		…
954	default. (Note that many other terminals, including xterm, have these	1055	default. (Note that many other terminals, including xterm, have these
955	sequences enabled by default, which doesn't make it safer, though).	1056	sequences enabled by default, which doesn't make it safer, though).
956		1057
957	You can enable them by setting this boolean resource or specifying	1058	You can enable them by setting this boolean resource or specifying
958	B<-insecure> as an option. At the moment, this enables display-answer,	1059	B<-insecure> as an option. At the moment, this enables display-answer,
959	locale, findfont, icon label and window title requests as well as dynamic	1060	locale, findfont, icon label and window title requests.
960	menubar dispatch.
961		1061
962	=item B<modifier:> I<modifier>	1062	=item B<modifier:> I<modifier>
963		1063
964	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	1064	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
965	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	1065	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
969		1069
970	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)
971	character is passed through. It may contain escape values as described	1071	character is passed through. It may contain escape values as described
972	in the entry on B<keysym> following.	1072	in the entry on B<keysym> following.
973		1073
974	=item B<secondaryScreen:> I<bool>	1074	=item B<secondaryScreen:> I<boolean>
975		1075
976	Turn on/off secondary screen (default enabled).	1076	Turn on/off secondary screen (default enabled).
977		1077
978	=item B<secondaryScroll:> I<bool>	1078	=item B<secondaryScroll:> I<boolean>
979		1079
980	Turn on/off secondary screen scroll (default enabled). If the this	1080	Turn on/off secondary screen scroll (default enabled). If this
981	option is enabled, scrolls on the secondary screen will change the	1081	option is enabled, scrolls on the secondary screen will change the
982	scrollback buffer and switching to/from the secondary screen will	1082	scrollback buffer and switching to/from the secondary screen will
983	instead scroll the screen up.	1083	instead scroll the screen up.
984		1084
985	=item B<hold>: I<bool>	1085	=item B<hold>: I<boolean>
986		1086
987	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@@
988	will not immediately destroy its window when the program executed within	1088	will not immediately destroy its window when the program executed within
989	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
990	user.	1090	user.
…		…
1009	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
1010	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
1011	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
1012	performed in an exact manner; however, the closest match is assured.	1112	performed in an exact manner; however, the closest match is assured.
1013		1113
1014	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
1015	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.
1016	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1017	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1018	can start or end with whitespace.
1019
1020	Please note that you need to double the C<\> when using
1021	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
1022	use C<\033> instead of C<\e> (and so on), which will work with both Xt and
1023	@@RXVT_NAME@@'s own processing).
1024		1116
1025	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>
1026	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1118	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1027	should be a character not used by the strings.	1119	should be a character not used by the strings.
1028		1120
1029	Its usage can be demonstrated by an example:	1121	Its usage can be demonstrated by an example:
1030		1122
1031	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1123	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
…		…
1095	example, C<default,-selection> will use all the default extension except	1187	example, C<default,-selection> will use all the default extension except
1096	C<selection>.	1188	C<selection>.
1097		1189
1098	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
1099	(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
1100	searchable scorllback to Alt/Meta-s). Mentioning the same extension	1192	searchable scrollback to Alt/Meta-s). Mentioning the same extension
1101	multiple times with different arguments will pass multiple arguments to	1193	multiple times with different arguments will pass multiple arguments to
1102	the extension.	1194	the extension.
1103		1195
1104	Each extension is looked up in the library directories, loaded if	1196	Each extension is looked up in the library directories, loaded if
1105	necessary, and bound to the current terminal instance.	1197	necessary, and bound to the current terminal instance.
…		…
1123	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1215	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1124	will be ignored when running setuid/setgid.	1216	will be ignored when running setuid/setgid.
1125		1217
1126	See the @@RXVT_NAME@@perl(3) manpage.	1218	See the @@RXVT_NAME@@perl(3) manpage.
1127		1219
		1220	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1221
		1222	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1223	details.
		1224
		1225	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1226
		1227	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1228	for details.
		1229
		1230	=item B<searchable-scrollback:> I<keysym>
		1231
		1232	Sets the hotkey that starts the incremental scrollback buffer search
		1233	(default: C<M-s>).
		1234
		1235	=item B<urlLauncher>: I<string>
		1236
		1237	Specifies the program to be started with a URL argument. Used by the
		1238	C<selection-popup> and C<matcher> perl extensions.
		1239
1128	=item B<transient-for>: I<windowid>	1240	=item B<transient-for>: I<windowid>
1129		1241
1130	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).
1131		1252
1132	=back	1253	=back
1133		1254
1134	=head1 THE SCROLLBAR	1255	=head1 THE SCROLLBAR
1135		1256
…		…
1154	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1275	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1155	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1276	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1156	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),
1157	respectively.	1278	respectively.
1158		1279
1159	=head1 TEXT SELECTION AND INSERTION	1280	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1160		1281
1161	The behaviour of text selection and insertion mechanism is similar to	1282	The behaviour of text selection and insertion/pasting mechanism is similar
1162	I<xterm>(1).	1283	to I<xterm>(1).
1163		1284
1164	=over 4	1285	=over 4
1165		1286
1166	=item B<Selection>:	1287	=item B<Selecting>:
1167		1288
1168	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
1169	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
1170	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
1171	(which can span multiple screen lines), unless modified by resource	1292	(which can span multiple screen lines), unless modified by resource
…		…
1175	(Compile: I<frills>) will create a rectangular selection instead of a	1296	(Compile: I<frills>) will create a rectangular selection instead of a
1176	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
1177	selection, and trailing whitespace is visually underlined and removed from	1298	selection, and trailing whitespace is visually underlined and removed from
1178	the selection.	1299	the selection.
1179		1300
1180	=item B<Insertion>:	1301	=item B<Pasting>:
1181		1302
1182	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@@>
1183	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
1184	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.
1185		1309
1186	=back	1310	=back
1187		1311
1188	=head1 CHANGING FONTS	1312	=head1 CHANGING FONTS
1189		1313
1190	Changing fonts (or font sizes, respectively) via the keypad is not yet	1314	Changing fonts (or font sizes, respectively) via the keypad is not yet
1191	supported in rxvt-unicode. Bug me if you need this.	1315	supported in rxvt-unicode. Bug me if you need this.
1192		1316
1193	You can, however, switch fonts at runtime using escape sequences (and	1317	You can, however, switch fonts at runtime using escape sequences, e.g.:
1194	therefore using the menubar), e.g.:
1195		1318
1196	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"	1319	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1320
		1321	You can use keyboard shortcuts, too:
		1322
		1323	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1324	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1197		1325
1198	rxvt-unicode will automatically re-apply these fonts to the output so far.	1326	rxvt-unicode will automatically re-apply these fonts to the output so far.
1199		1327
1200	=head1 ISO 14755 SUPPORT	1328	=head1 ISO 14755 SUPPORT
1201		1329
1202	ISO 14755 is a standard for entering and viewing unicode characters	1330	ISO 14755 is a standard for entering and viewing unicode characters
1203	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
1204	first part is available rxvt-unicode has been compiled with	1332	first part is available if rxvt-unicode has been compiled with
1205	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
1206	with C<--enable-iso14755>.	1334	with C<--enable-iso14755>.
1207		1335
1208	=over 4	1336	=over 4
1209		1337
…		…
1229	This mode lets you input characters representing the keycap symbols of	1357	This mode lets you input characters representing the keycap symbols of
1230	your keyboard, if representable in the current locale encoding.	1358	your keyboard, if representable in the current locale encoding.
1231		1359
1232	Start by pressing C<Control> and C<Shift> together, then releasing	1360	Start by pressing C<Control> and C<Shift> together, then releasing
1233	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
1234	invoke it's usual function but instead will insert the corresponding	1362	invoke its usual function but instead will insert the corresponding
1235	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
1236	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
1237	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
1238	reverse tab (Shift-Tab).	1366	reverse tab (Shift-Tab).
1239		1367
…		…
1272	=head1 COLORS AND GRAPHICS	1400	=head1 COLORS AND GRAPHICS
1273		1401
1274	In addition to the default foreground and background colours,	1402	In addition to the default foreground and background colours,
1275	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
1276	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
1277	colours with their B<rgb.txt> names.	1405	colours with their names.
1278		1406
1279	=begin table	1407	=begin table
1280		1408
1281	B<color0> (black) = Black	1409	B<color0> (black) = Black
1282	B<color1> (red) = Red3	1410	B<color1> (red) = Red3
…		…
1302	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>,
1303	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1431	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1304	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
1305	color0-color15.	1433	color0-color15.
1306		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
1307	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1444	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1308	always swapping the foreground/background colours. This is in contrast to	1445	always swapping the foreground/background colours. This is in contrast to
1309	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
1310	been specified. For example,	1447	been specified. For example,
1311		1448
…		…
1316	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
1317	on White.	1454	on White.
1318		1455
1319	=back	1456	=back
1320		1457
		1458	=head2 ALPHA CHANNEL SUPPORT
		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 support C<rgba:rrrr/gggg/bbbb/aaaa>
		1462	(recommended, but B<MUST> have 4 digits/component) colour specifications,
		1463	in addition to the ones provided by X, where the additional A component
		1464	specifies opacity (alpha) values. The minimum value of C<0> is completely
		1465	transparent). You can also prefix any color with C<[percent]>, where
		1466	C<percent> is a decimal percentage (0-100) that specifies the opacity of
		1467	the color, where C<0> is completely transparent and C<100> is completelxy
		1468	opaque.
		1469
		1470	You probably need to specify B<"-depth 32">, too, and have the luck that
		1471	your X-server uses ARGB pixel layout, as X is far from just supporting
		1472	ARGB visuals out of the box, and rxvt-unicode just fudges around.
		1473
		1474	For example, the following selects an almost completely transparent red
		1475	background, and an almost opaque pink foreground:
		1476
		1477	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
		1478
		1479	I<Please note that transparency of any kind if completely unsupported by
		1480	the author. Don't bug him with installation questions!>
		1481
1321	=head1 ENVIRONMENT	1482	=head1 ENVIRONMENT
1322		1483
1323	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1484	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1324		1485
1325	=over 4	1486	=over 4
1326		1487
1327	=item B<TERM>	1488	=item B<TERM>
1328		1489
1329	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1490	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1330	resources or on the commandline.	1491	resources or on the command line.
1331		1492
1332	=item B<COLORTERM>	1493	=item B<COLORTERM>
1333		1494
1334	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1495	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1335	compiled with XPM support, and optionally with the added extension	1496	compiled with background image support, and optionally with the added
1336	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1497	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1498	screen.
1337		1499
1338	=item B<COLORFGBG>	1500	=item B<COLORFGBG>
1339		1501
1340	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1502	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1341	the colour code used as default foreground/text colour (or the string	1503	the colour code used as default foreground/text colour (or the string
1342	C<default> to indicate that the default-colour escape sequence is to be	1504	C<default> to indicate that the default-colour escape sequence is to be
1343	used), C<bg> is the colour code used as default background colour (or the	1505	used), C<bg> is the colour code used as default background colour (or the
1344	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1506	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1345	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1507	was compiled with background image support. Libraries like C<ncurses>
1346	(and do) use this information to optimize screen output.	1508	and C<slang> can (and do) use this information to optimize screen output.
1347		1509
1348	=item B<WINDOWID>	1510	=item B<WINDOWID>
1349		1511
1350	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1512	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1351	window, which usually has subwindows for the scrollbar, the terminal	1513	window, which usually has subwindows for the scrollbar, the terminal
…		…
1357	C<--with-terminfo=PATH>.	1519	C<--with-terminfo=PATH>.
1358		1520
1359	=item B<DISPLAY>	1521	=item B<DISPLAY>
1360		1522
1361	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1523	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1362	display in it's child processes.	1524	display in its child processes.
1363		1525
1364	=item B<SHELL>	1526	=item B<SHELL>
1365		1527
1366	The shell to be used for command execution, defaults to C</bin/sh>.	1528	The shell to be used for command execution, defaults to C</bin/sh>.
1367
1368	=item B<RXVTPATH>
1369
1370	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1371	files.
1372
1373	=item B<PATH>
1374
1375	Used in the same way as C<RXVTPATH>.
1376		1529
1377	=item B<RXVT_SOCKET>	1530	=item B<RXVT_SOCKET>
1378		1531
1379	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1532	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1380	@@RXVT_NAME@@d(1).	1533	@@RXVT_NAME@@d(1).
…		…
1418		1571
1419	=item Project Coordinator	1572	=item Project Coordinator
1420		1573
1421	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1574	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1422		1575
1423	L<http://software.schmorp.de/#rxvt-unicode>	1576	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1424		1577
1425	=back	1578	=back
1426		1579
1427	=head1 AUTHORS	1580	=head1 AUTHORS
1428		1581
…		…
1450		1603
1451	Project Coordinator (changes.txt 2.21a to 2.4.5)	1604	Project Coordinator (changes.txt 2.21a to 2.4.5)
1452		1605
1453	=item Geoff Wing L<< <gcw@pobox.com> >>	1606	=item Geoff Wing L<< <gcw@pobox.com> >>
1454		1607
1455	Rewrote screen display and text selection routines. Project Coordinator	1608	Rewrote screen display and text selection routines.
		1609
1456	(changes.txt 2.4.6 - rxvt-unicode)	1610	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1457		1611
1458	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1612	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1459		1613
1460	Forked rxvt-unicode, rewrote most of the display code and internal	1614	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1461	character handling to store text in unicode, improve xterm	1615	extension, random hacks, numerous bugfixes and extensions.
1462	compatibility and apply numerous other bugfixes and extensions.
1463		1616
1464	Project Coordinator (Changes 1.0 -)	1617	Project Coordinator (Changes 1.0 -)
1465		1618
		1619	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1620
		1621	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
		1622
1466	=back	1623	=back
1467		1624

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.91 by root, Mon Jan 9 23:00:07 2006 UTC vs. Revision 1.156 by ayin, Sun Dec 30 22:43:40 2007 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.91 by root, Mon Jan 9 23:00:07 2006 UTC vs.
Revision 1.156 by ayin, Sun Dec 30 22:43:40 2007 UTC