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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.102 by ayin, Fri Jan 20 18:04:32 2006 UTC vs.
Revision 1.189 by sf-exg, Tue Nov 23 18:52:13 2010 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
…		…
89		92
90	Print out a message describing available options.	93	Print out a message describing available options.
91		94
92	=item B<-display> I<displayname>	95	=item B<-display> I<displayname>
93		96
94	Attempt to open a window on the named X display (B<-d> still	97	Attempt to open a window on the named X display (the older form B<-d>
95	respected). In the absence of this option, the display specified by the	98	is still respected. but deprecated). In the absence of this option, the
96	B<DISPLAY> environment variable is used.	99	display specified by the B<DISPLAY> environment variable is used.
		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
		106	[Please note that many X servers (and libXft) are buggy with
		107	respect to C<-depth 32> and/or alpha channels, and will cause all sorts
		108	of graphical corruption. This is harmless, but we can't do anything about
		109	this, so watch out]
97		110
98	=item B<-geometry> I<geom>	111	=item B<-geometry> I<geom>
99		112
100	Window geometry (B<-g> still respected); resource B<geometry>.	113	Window geometry (B<-g> still respected); resource B<geometry>.
101		114
…		…
103		116
104	Turn on/off simulated reverse video; resource B<reverseVideo>.	117	Turn on/off simulated reverse video; resource B<reverseVideo>.
105		118
106	=item B<-j>\|B<+j>	119	=item B<-j>\|B<+j>
107		120
108	Turn on/off jump scrolling; resource B<jumpScroll>.	121	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
109		122
110	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>	123	=item B<-ss>\|B<+ss>
111		124
112	Turn on/off inheriting parent window's pixmap. Alternative form is	125	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
113	B<-tr>; resource B<inheritPixmap>.	126
		127	=item B<-tr>\|B<+tr>
		128
		129	Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>.
		130
		131	B<-ip> is still accepted as an obsolete alias but will be removed in
		132	future versions.
114		133
115	=item B<-fade> I<number>	134	=item B<-fade> I<number>
116		135
117	Fade the text by the given percentage when focus is lost. Small values	136	Fade the text by the given percentage when focus is lost. Small values
118	fade a little only, 100 completely replaces all colours by the fade	137	fade a little only, 100 completely replaces all colours by the fade
119	colour; resource B<fading>.	138	colour; resource B<fading>.
120		139
121	=item B<-fadecolor> I<colour>	140	=item B<-fadecolor> I<colour>
122		141
123	Fade to this colour when fading is used (see B<-fade>). The default colour	142	Fade to this colour when fading is used (see B<-fade>). The default colour
124	is black. resource B<fadeColor>.	143	is opaque black. resource B<fadeColor>.
125		144
126	=item B<-tint> I<colour>	145	=item B<-tint> I<colour>
127		146
128	Tint the transparent background pixmap with the given colour when	147	Tint the transparent background with the given colour;
129	transparency is enabled with B<-tr> or B<-ip>. This only works for	148	resource I<tintColor>.
130	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
132	I<tintColor>. Example:
133		149
134	@@RXVT_NAME@@ -tr -tint blue -sh 40	150	=item B<-sh> I<number>
135		151
136	=item B<-sh>
137
138	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	152	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
139	background image in addition to tinting it (i.e. B<-tint> must be	153	A value of 100 means no shading; resource I<shading>.
140	specified, too, e.g. C<-tint white>).	154
		155	=item B<-blt> I<string>
		156
		157	Specify background blending type. If background pixmap is specified
		158	at the same time as transparency - such pixmap will be blended over
		159	the transparent background, using the method specified. Supported values are:
		160	B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
		161	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
		162	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
		163	alpha-blending. Compile I<afterimage>; resource I<blendType>.
		164
		165	=item B<-blr> I<HxV>
		166
		167	Apply Gaussian Blur with the specified radii to the transparent
		168	background. If a single number is specified - both vertical and
		169	horizontal radii are considered to be the same. Setting one of the
		170	radii to 1 and another to a large number creates interesting effects
		171	on some backgrounds. Maximum radius value is 128;
		172	resource I<blurRadius>.
		173
		174	=item B<-icon> I<file>
		175
		176	Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
		177	is used by many window managers, taskbars and pagers to represent the
		178	application window; resource I<iconFile>.
141		179
142	=item B<-bg> I<colour>	180	=item B<-bg> I<colour>
143		181
144	Window background colour; resource B<background>.	182	Window background colour; resource B<background>.
145		183
146	=item B<-fg> I<colour>	184	=item B<-fg> I<colour>
147		185
148	Window foreground colour; resource B<foreground>.	186	Window foreground colour; resource B<foreground>.
149		187
150	=item B<-pixmap> I<file[;geom]>	188	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
151		189
152	Compile I<XPM>: Specify XPM file for the background and also optionally	190	Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
153	specify its scaling with a geometry string. Note you may need to	191	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	192	add quotes to avoid special shell interpretation of the C<;> in the
155	command-line; resource B<backgroundPixmap>.	193	command-line; for more details see resource B<backgroundPixmap>.
156		194
157	=item B<-cr> I<colour>	195	=item B<-cr> I<colour>
158		196
159	The cursor colour; resource B<cursorColor>.	197	The cursor colour; resource B<cursorColor>.
160		198
…		…
177	that are checked in order when trying to find glyphs for characters. The	215	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	216	first font defines the cell size for characters; other fonts might be
179	smaller, but not (in general) larger. A (hopefully) reasonable default	217	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.	218	font list is always appended to it. See resource B<font> for more details.
181		219
182	In short, to specify an X11 core font, just specify it's name or prefix it	220	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:>,	221	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184	e.g.:	222	e.g.:
185		223
186	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	224	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	225	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
205	italic> >> characters are to be printed. See resource B<boldItalicFont>	243	italic> >> characters are to be printed. See resource B<boldItalicFont>
206	for details.	244	for details.
207		245
208	=item B<-is>\|B<+is>	246	=item B<-is>\|B<+is>
209		247
210	Compile I<font-styles>: Bold/Italic font styles imply high intensity	248	Compile I<font-styles>: Bold/Blink font styles imply high intensity
211	foreground/background (default). See resource B<intensityStyles> for	249	foreground/background (default). See resource B<intensityStyles> for
212	details.	250	details.
213		251
214	=item B<-name> I<name>	252	=item B<-name> I<name>
215		253
…		…
233		271
234	=item B<-sb>\|B<+sb>	272	=item B<-sb>\|B<+sb>
235		273
236	Turn on/off scrollbar; resource B<scrollBar>.	274	Turn on/off scrollbar; resource B<scrollBar>.
237		275
		276	=item B<-sr>\|B<+sr>
		277
		278	Put scrollbar on right/left; resource B<scrollBar_right>.
		279
		280	=item B<-st>\|B<+st>
		281
		282	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		283	resource B<scrollBar_floating>.
		284
238	=item B<-si>\|B<+si>	285	=item B<-si>\|B<+si>
239		286
240	Turn on/off scroll-to-bottom on TTY output inhibit; resource	287	Turn on/off scroll-to-bottom on TTY output inhibit; resource
241	B<scrollTtyOutput> has opposite effect.	288	B<scrollTtyOutput> has opposite effect.
242		289
…		…
248	=item B<-sw>\|B<+sw>	295	=item B<-sw>\|B<+sw>
249		296
250	Turn on/off scrolling with the scrollback buffer as new lines appear.	297	Turn on/off scrolling with the scrollback buffer as new lines appear.
251	This only takes effect if B<-si> is also given; resource	298	This only takes effect if B<-si> is also given; resource
252	B<scrollWithBuffer>.	299	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		300
263	=item B<-ptab>\|B<+ptab>	301	=item B<-ptab>\|B<+ptab>
264		302
265	If enabled (default), "Horizontal Tab" characters are being stored as	303	If enabled (default), "Horizontal Tab" characters are being stored as
266	actual wide characters in the screen buffer, which makes it possible to	304	actual wide characters in the screen buffer, which makes it possible to
…		…
270		308
271	=item B<-bc>\|B<+bc>	309	=item B<-bc>\|B<+bc>
272		310
273	Blink the cursor; resource B<cursorBlink>.	311	Blink the cursor; resource B<cursorBlink>.
274		312
		313	=item B<-uc>\|B<+uc>
		314
		315	Make the cursor underlined; resource B<cursorUnderline>.
		316
275	=item B<-iconic>	317	=item B<-iconic>
276		318
277	Start iconified, if the window manager supports that option.	319	Start iconified, if the window manager supports that option.
278	Alternative form is B<-ic>.	320	Alternative form is B<-ic>.
279		321
…		…
295		337
296	=item B<-bl>	338	=item B<-bl>
297		339
298	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	340	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	341	if honoured by the WM, the rxvt-unicode window will not have window
300	decorations; resource B<borderLess>.	342	decorations; resource B<borderLess>. If the window manager does not
		343	support MWM hints (e.g. kwin), enables override-redirect mode.
301		344
302	=item B<-override-redirect>	345	=item B<-override-redirect>
303		346
304	Compile I<frills>: Sets override-redirect on the window; resource	347	Compile I<frills>: Sets override-redirect on the window; resource
305	B<override-redirect>.	348	B<override-redirect>.
…		…
313		356
314	=item B<-lsp> I<number>	357	=item B<-lsp> I<number>
315		358
316	Compile I<frills>: Lines (pixel height) to insert between each row of	359	Compile I<frills>: Lines (pixel height) to insert between each row of
317	the display. Useful to work around font rendering problems; resource	360	the display. Useful to work around font rendering problems; resource
318	B<linespace>.	361	B<lineSpace>.
		362
		363	=item B<-letsp> I<number>
		364
		365	Compile I<frills>: Amount to adjust the computed character width by
		366	to control overall letter spacing. Negative values will tighten up the
		367	letter spacing, positive values will space letters out more. Useful to
		368	work around odd font metrics; resource B<letterSpace>.
319		369
320	=item B<-tn> I<termname>	370	=item B<-tn> I<termname>
321		371
322	This option specifies the name of the terminal type to be set in the	372	This option specifies the name of the terminal type to be set in the
323	B<TERM> environment variable. This terminal type must exist in the	373	B<TERM> environment variable. This terminal type must exist in the
…		…
377	for more info.	427	for more info.
378		428
379	=item B<-tcw>	429	=item B<-tcw>
380		430
381	Change the meaning of triple-click selection with the left mouse	431	Change the meaning of triple-click selection with the left mouse
		432	button. Only effective when the original (non-perl) selection code is
382	button. Instead of selecting a full line it will extend the selection the	433	in-use. Instead of selecting a full line it will extend the selection to
383	end of the logical line only. resource B<tripleclickwords>.	434	the end of the logical line only. resource B<tripleclickwords>.
384		435
385	=item B<-insecure>	436	=item B<-insecure>
386		437
387	Enable "insecure" mode, which currently enables most of the escape	438	Enable "insecure" mode, which currently enables most of the escape
388	sequences that echo strings. See the resource B<insecure> for more	439	sequences that echo strings. See the resource B<insecure> for more
…		…
409	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	460	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
410	will not immediately destroy its window when the program executed within	461	will not immediately destroy its window when the program executed within
411	it exits. Instead, it will wait till it is being killed or closed by the	462	it exits. Instead, it will wait till it is being killed or closed by the
412	user; resource B<hold>.	463	user; resource B<hold>.
413		464
		465	=item B<-cd> I<path>
		466
		467	Sets the working directory for the shell (or the command specified via
		468	B<-e>). The I<path> must be an absolute path and it must exist for
		469	@@RXVT_NAME@@ to start; resource B<chdir>.
		470
		471	=item B<-xrm> I<string>
		472
		473	Works like the X Toolkit option of the same name, by adding the I<string>
		474	as if it were specified in a resource file. Resource values specified this
		475	way take precedence over all other resource specifications.
		476
		477	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		478	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		479	options can be specified as long-options on the commandline, so use
		480	of B<-xrm> is mostly limited to cases where you want to specify other
		481	resources (e.g. for input methods) or for compatibility with other
		482	programs.
		483
414	=item B<-keysym.>I<sym> I<string>	484	=item B<-keysym.>I<sym> I<string>
415		485
416	Remap a key symbol. See resource B<keysym>.	486	Remap a key symbol. See resource B<keysym>.
417		487
418	=item B<-embed> I<windowid>	488	=item B<-embed> I<windowid>
419		489
420	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,	490	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
421	which enables applications to easily embed a terminal.	491	which enables applications to easily embed a terminal.
422		492
423	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it	493	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
424	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it	494	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
425	quite a bit, so don't expect it to keep some specific state. It's best to	495	quite a bit, so don't expect it to keep some specific state. It's best to
…		…
428	The window will not be destroyed when @@RXVT_NAME@@ exits.	498	The window will not be destroyed when @@RXVT_NAME@@ exits.
429		499
430	It might be useful to know that @@RXVT_NAME@@ will not close file	500	It might be useful to know that @@RXVT_NAME@@ will not close file
431	descriptors passed to it (except for stdin/out/err, of course), so you	501	descriptors passed to it (except for stdin/out/err, of course), so you
432	can use file descriptors to communicate with the programs within the	502	can use file descriptors to communicate with the programs within the
433	terminal. This works regardless of wether the C<-embed> option was used or	503	terminal. This works regardless of whether the C<-embed> option was used or
434	not.	504	not.
435		505
436	Here is a short Gtk2-perl snippet that illustrates how this option can be	506	Here is a short Gtk2-perl snippet that illustrates how this option can be
437	used (a longer example is in F<doc/embed>):	507	used (a longer example is in F<doc/embed>):
438		508
…		…
443	});	513	});
444		514
445	=item B<-pty-fd> I<file descriptor>	515	=item B<-pty-fd> I<file descriptor>
446		516
447	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	517	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
448	pair but instead use the given filehandle as the tty master. This is	518	pair but instead use the given file descriptor as the tty master. This is
449	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator	519	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
450	without having to run a program within it.	520	without having to run a program within it.
451		521
452	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	522	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
453	entries and will not tinker with pty/tty permissions - you have to do that	523	entries and will not tinker with pty/tty permissions - you have to do that
454	yourself if you want that.	524	yourself if you want that.
455		525
456	As an extremely special case, specifying C<-1> will completely suppress	526	As an extremely special case, specifying C<-1> will completely suppress
457	pty/tty operations.	527	pty/tty operations, which is probably only useful in conjunction with some
		528	perl extension that manages the terminal.
458		529
459	Here is a example in perl that illustrates how this option can be used (a	530	Here is a example in perl that illustrates how this option can be used (a
460	longer example is in F<doc/pty-fd>):	531	longer example is in F<doc/pty-fd>):
461		532
462	use IO::Pty;	533	use IO::Pty;
…		…
476	Comma-separated list of perl extension scripts to use (or not to use) in	547	Comma-separated list of perl extension scripts to use (or not to use) in
477	this terminal instance. See resource B<perl-ext> for details.	548	this terminal instance. See resource B<perl-ext> for details.
478		549
479	=back	550	=back
480		551
481	=head1 RESOURCES (available also as long-options)	552	=head1 RESOURCES
482		553
483	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	554	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
484	options) compiled into your version.	555	options) compiled into your version. All resources are also available as
		556	long-options.
485		557
486	You can set and change the resources using X11 tools like B<xrdb>. Many	558	You can set and change the resources using X11 tools like B<xrdb>. Many
487	distribution do also load settings from the B<~/.Xresources> file when X	559	distribution do also load settings from the B<~/.Xresources> file when X
488	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	560	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
489	with later settings overwriting earlier ones:	561	with later settings overwriting earlier ones:
…		…
491	1. system-wide app-defaults file, either locale-dependent OR global	563	1. system-wide app-defaults file, either locale-dependent OR global
492	2. app-defaults file in $XAPPLRESDIR	564	2. app-defaults file in $XAPPLRESDIR
493	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	565	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
494	4. SCREEN_RESOURCES for the current screen	566	4. SCREEN_RESOURCES for the current screen
495	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	567	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		568	6. resources specified via -xrm on the commandline
496		569
497	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	570	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
498	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	571	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
499	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily	572	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
500	configured, while the class name B<URxvt> allows resources unique to	573	configured, while the class name B<URxvt> allows resources unique to
…		…
505	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl	578	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
506	extensions not documented here):	579	extensions not documented here):
507		580
508	=over 4	581	=over 4
509		582
		583	=item B<depth:> I<bitdepth>
		584
		585	Compile I<xft>: Attempt to find a visual with the given bit depth;
		586	option B<-depth>.
		587
		588	=item B<buffered:> I<boolean>
		589
		590	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		591	On some card/driver combination enabling it slightly decreases
		592	performance, on most it greatly helps it. The slowdown is small, so it
		593	should normally be enabled.
		594
510	=item B<geometry:> I<geom>	595	=item B<geometry:> I<geom>
511		596
512	Create the window with the specified X window geometry [default 80x24];	597	Create the window with the specified X window geometry [default 80x24];
513	option B<-geometry>.	598	option B<-geometry>.
514		599
…		…
527	Use the specified colour for the colour value I<n>, where 0-7	612	Use the specified colour for the colour value I<n>, where 0-7
528	corresponds to low-intensity (normal) colours and 8-15 corresponds to	613	corresponds to low-intensity (normal) colours and 8-15 corresponds to
529	high-intensity (bold = bright foreground, blink = bright background)	614	high-intensity (bold = bright foreground, blink = bright background)
530	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	615	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
531	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	616	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
532	names used are listed in the B<COLORS AND GRAPHICS> section.	617	names used are listed in the B<COLOURS AND GRAPHICS> section.
533		618
534	Colours higher than 15 cannot be set using resources (yet), but can be	619	Colours higher than 15 cannot be set using resources (yet), but can be
535	changed using an escape command (see @@RXVT_NAME@@(7)).	620	changed using an escape command (see @@RXVT_NAME@@(7)).
536		621
537	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	622	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
548	=item B<colorUL:> I<colour>	633	=item B<colorUL:> I<colour>
549		634
550	Use the specified colour to display underlined characters when the	635	Use the specified colour to display underlined characters when the
551	foreground colour is the default.	636	foreground colour is the default.
552		637
553	=item B<colorRV:> I<colour>
554
555	Use the specified colour as the background for reverse video
556	characters.
557
558	=item B<underlineColor:> I<colour>	638	=item B<underlineColor:> I<colour>
559		639
560	If set, use the specified colour as the colour for the underline	640	If set, use the specified colour as the colour for the underline
561	itself. If unset, use the foreground colour.	641	itself. If unset, use the foreground colour.
		642
		643	=item B<highlightColor:> I<colour>
		644
		645	If set, use the specified colour as the background for highlighted
		646	characters. If unset, use reverse video.
		647
		648	=item B<highlightTextColor:> I<colour>
		649
		650	If set and highlightColor is set, use the specified colour as the
		651	foreground for highlighted characters.
562		652
563	=item B<cursorColor:> I<colour>	653	=item B<cursorColor:> I<colour>
564		654
565	Use the specified colour for the cursor. The default is to use the	655	Use the specified colour for the cursor. The default is to use the
566	foreground colour; option B<-cr>.	656	foreground colour; option B<-cr>.
…		…
573		663
574	=item B<reverseVideo:> I<boolean>	664	=item B<reverseVideo:> I<boolean>
575		665
576	B<True>: simulate reverse video by foreground and background colours;	666	B<True>: simulate reverse video by foreground and background colours;
577	option B<-rv>. B<False>: regular screen colours [default]; option	667	option B<-rv>. B<False>: regular screen colours [default]; option
578	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	668	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
579		669
580	=item B<jumpScroll:> I<boolean>	670	=item B<jumpScroll:> I<boolean>
581		671
582	B<True>: specify that jump scrolling should be used. When scrolling	672	B<True>: specify that jump scrolling should be used. When receiving lots
583	quickly, fewer screen updates are performed [default]; option B<-j>.	673	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		674	has been read, resulting in fewer updates while still displaying every
		675	received line; option B<-j>.
		676
584	B<False>: specify that smooth scrolling should be used; option B<+j>.	677	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		678	force a screen refresh on each new line it received; option B<+j>.
585		679
586	=item B<inheritPixmap:> I<boolean>	680	=item B<skipScroll:> I<boolean>
587		681
588	B<True>: make the background inherit the parent windows' pixmap, giving	682	B<True>: (the default) specify that skip scrolling should be used. When
589	artificial transparency. B<False>: do not inherit the parent windows'	683	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
590	pixmap.	684	(around 60 times per second), resulting in far fewer updates. This can
		685	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		686	option B<-ss>.
		687
		688	B<False>: specify that everything is to be displayed, even
		689	if the refresh is too fast for the human eye to read anything (or the
		690	monitor to display anything); option B<+ss>.
		691
		692	=item B<transparent:> I<boolean>
		693
		694	Turn on/off pseudo-transparency by using the root pixmap as background.
		695
		696	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
		697	future versions.
591		698
592	=item B<fading:> I<number>	699	=item B<fading:> I<number>
593		700
594	Fade the text by the given percentage when focus is lost; option B<-fade>.	701	Fade the text by the given percentage when focus is lost; option B<-fade>.
595		702
…		…
598	Fade to this colour, when fading is used (see B<fading:>). The default	705	Fade to this colour, when fading is used (see B<fading:>). The default
599	colour is black; option B<-fadecolor>.	706	colour is black; option B<-fadecolor>.
600		707
601	=item B<tintColor:> I<colour>	708	=item B<tintColor:> I<colour>
602		709
603	Tint the transparent background pixmap with the given colour; option	710	Tint the transparent background with the given colour; option
604	B<-tint>.	711	B<-tint>.
605		712
606	=item B<shading:> I<number>	713	=item B<shading:> I<number>
607		714
608	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	715	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
609	image in addition to tinting it.	716	A value of 100 means no shading; option B<-sh>.
		717
		718	=item B<blendType:> I<string>
		719
		720	Specify background blending type; option B<-blt>.
		721
		722	=item B<blurRadius:> I<number>
		723
		724	Apply gaussian blur with the specified radius to the transparent
		725	background; option B<-blr>.
		726
		727	=item B<iconFile:> I<file>
		728
		729	Set the application icon pixmap; option B<-icon>.
610		730
611	=item B<scrollColor:> I<colour>	731	=item B<scrollColor:> I<colour>
612		732
613	Use the specified colour for the scrollbar [default #B2B2B2].	733	Use the specified colour for the scrollbar [default #B2B2B2].
614		734
…		…
620	=item B<borderColor:> I<colour>	740	=item B<borderColor:> I<colour>
621		741
622	The colour of the border around the text area and between the scrollbar	742	The colour of the border around the text area and between the scrollbar
623	and the text.	743	and the text.
624		744
625	=item B<backgroundPixmap:> I<file[;geom]>	745	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
626		746
627	Use the specified XPM file (note the `.xpm' extension is optional) for	747	Use the specified image file for the background and also
628	the background and also optionally specify its scaling with a geometry	748	optionally specify its scaling with a geometry string B<WxH+X+Y>,
629	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	749	(default C<100x100+50+50>) in which B<"W" / "H"> specify the
630	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	750	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
631	centre (percent). A scale of 0 displays the image with tiling. A scale	751	centre (percent). A scale of 0 displays the image with tiling.
632	of 1 displays the image without any scaling. A scale of 2 to 9	752	The maximum permitted scale is 1000.
633	specifies an integer number of images in that direction. No image will	753	Additional operations can be specified after colon B<:op1:op2...>.
634	be magnified beyond 10 times its original size. The maximum permitted	754	Supported operations are:
635	scale is 1000. [default 0x0+50+50]	755
		756	tile force background image to be tiled and not scaled. Equivalent to 0x0
		757	propscale will scale image keeping proportions
		758	auto will scale image to match window size. Equivalent to 100x100
		759	hscale will scale image horizontally to the window size
		760	vscale will scale image vertically to the window size
		761	scale will scale image to match window size
		762	root will tile image as if it was a root window background, auto-adjusting
		763	whenever terminal window moves
		764
		765	If used in conjunction with B<-tr> option, the specified pixmap will be
		766	blended over the transparent background using alpha-blending. If I<afterimage>
		767	support has been compiled in it is possible to choose other blending
		768	types with B<-blt "type"> option.
636		769
637	=item B<path:> I<path>	770	=item B<path:> I<path>
638		771
639	Specify the colon-delimited search path for finding XPM files.	772	Specify the colon-delimited search path for finding background image files.
640		773
641	=item B<font:> I<fontlist>	774	=item B<font:> I<fontlist>
642		775
643	Select the fonts to be used. This is a comma separated list of font names	776	Select the fonts to be used. This is a comma separated list of font names
644	that are checked in order when trying to find glyphs for characters. The	777	that are checked in order when trying to find glyphs for characters. The
…		…
667	it is named first) and thus defines the character cell grid to be 9 pixels	800	it is named first) and thus defines the character cell grid to be 9 pixels
668	wide and 15 pixels high.	801	wide and 15 pixels high.
669		802
670	The second font is just used to add additional unicode characters not in	803	The second font is just used to add additional unicode characters not in
671	the base font, likewise the third, which is unfortunately non-bold, but	804	the base font, likewise the third, which is unfortunately non-bold, but
672	the bold version of the font does contain less characters, so this is a	805	the bold version of the font does contain fewer characters, so this is a
673	useful supplement.	806	useful supplement.
674		807
675	The third font is an Xft font with aliasing turned off, and the characters	808	The third font is an Xft font with aliasing turned off, and the characters
676	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	809	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
677	contains other characters, but we are not interested in them.	810	contains other characters, but we are not interested in them.
…		…
701	text font will being used for the given style.	834	text font will being used for the given style.
702		835
703	=item B<intensityStyles:> I<boolean>	836	=item B<intensityStyles:> I<boolean>
704		837
705	When font styles are not enabled, or this option is enabled (B<True>,	838	When font styles are not enabled, or this option is enabled (B<True>,
706	option B<-is>, the default), bold and italic font styles imply high	839	option B<-is>, the default), bold/blink font styles imply high
707	intensity foreground/backround colours. Disabling this option (B<False>,	840	intensity foreground/background colours. Disabling this option (B<False>,
708	option B<+is>) disables this behaviour, the high intensity colours are not	841	option B<+is>) disables this behaviour, the high intensity colours are not
709	reachable.	842	reachable.
710
711	=item B<selectstyle:> I<mode>
712
713	Set mouse selection style to B<old> which is 2.20, B<oldword> which is
714	xterm style with 2.20 old word selection, or anything else which gives
715	xterm style selection.
716
717	=item B<scrollstyle:> I<mode>
718
719	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
720	the author's favourite.
721		843
722	=item B<title:> I<string>	844	=item B<title:> I<string>
723		845
724	Set window title string, the default title is the command-line	846	Set window title string, the default title is the command-line
725	specified after the B<-e> option, if any, otherwise the application	847	specified after the B<-e> option, if any, otherwise the application
…		…
734	=item B<mapAlert:> I<boolean>	856	=item B<mapAlert:> I<boolean>
735		857
736	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	858	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
737	de-iconify (map) on receipt of a bell character [default].	859	de-iconify (map) on receipt of a bell character [default].
738		860
		861	=item B<urgentOnBell:> I<boolean>
		862
		863	B<True>: set the urgency hint for the wm on receipt of a bell character.
		864	B<False>: do not set the urgency hint [default].
		865
		866	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		867
739	=item B<visualBell:> I<boolean>	868	=item B<visualBell:> I<boolean>
740		869
741	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	870	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
742	B<False>: no visual bell [default]; option B<+vb>.	871	B<False>: no visual bell [default]; option B<+vb>.
743		872
…		…
764	Example:	893	Example:
765		894
766	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	895	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
767		896
768	This creates a new file in your home directory with the screen contents	897	This creates a new file in your home directory with the screen contents
769	everytime you hit C<Print>.	898	every time you hit C<Print>.
		899
		900	=item B<scrollstyle:> I<mode>
		901
		902	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		903	the author's favourite.
770		904
771	=item B<scrollBar:> I<boolean>	905	=item B<scrollBar:> I<boolean>
772		906
773	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	907	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
774	disable the scrollbar; option B<+sb>.	908	disable the scrollbar; option B<+sb>.
…		…
796		930
797	=item B<scrollWithBuffer:> I<boolean>	931	=item B<scrollWithBuffer:> I<boolean>
798		932
799	B<True>: scroll with scrollback buffer when tty receives new lines (and	933	B<True>: scroll with scrollback buffer when tty receives new lines (and
800	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	934	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
801	with scrollback buffer when tty recieves new lines; option B<+sw>.	935	with scrollback buffer when tty receives new lines; option B<+sw>.
802		936
803	=item B<scrollTtyKeypress:> I<boolean>	937	=item B<scrollTtyKeypress:> I<boolean>
804		938
805	B<True>: scroll to bottom when a non-special key is pressed. Special keys	939	B<True>: scroll to bottom when a non-special key is pressed. Special keys
806	are those which are intercepted by rxvt-unicode for special handling and	940	are those which are intercepted by rxvt-unicode for special handling and
…		…
837	=item B<termName:> I<termname>	971	=item B<termName:> I<termname>
838		972
839	Specifies the terminal type name to be set in the B<TERM> environment	973	Specifies the terminal type name to be set in the B<TERM> environment
840	variable; option B<-tn>.	974	variable; option B<-tn>.
841		975
842	=item B<linespace:> I<number>	976	=item B<lineSpace:> I<number>
843		977
844	Specifies number of lines (pixel height) to insert between each row of	978	Specifies number of lines (pixel height) to insert between each row of
845	the display [default 0]; option B<-lsp>.	979	the display [default 0]; option B<-lsp>.
846		980
847	=item B<meta8:> I<boolean>	981	=item B<meta8:> I<boolean>
…		…
861		995
862	=item B<cursorBlink:> I<boolean>	996	=item B<cursorBlink:> I<boolean>
863		997
864	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	998	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
865	option B<-bc>.	999	option B<-bc>.
		1000
		1001	=item B<cursorUnderline:> I<boolean>
		1002
		1003	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1004	option B<-uc>.
866		1005
867	=item B<pointerBlank:> I<boolean>	1006	=item B<pointerBlank:> I<boolean>
868		1007
869	B<True>: blank the pointer when a key is pressed or after a set number	1008	B<True>: blank the pointer when a key is pressed or after a set number
870	of seconds of inactivity. B<False>: the pointer is always visible	1009	of seconds of inactivity. B<False>: the pointer is always visible
…		…
884	large number (e.g. C<987654321>) to effectively disable the timeout.	1023	large number (e.g. C<987654321>) to effectively disable the timeout.
885		1024
886	=item B<backspacekey:> I<string>	1025	=item B<backspacekey:> I<string>
887		1026
888	The string to send when the backspace key is pressed. If set to B<DEC>	1027	The string to send when the backspace key is pressed. If set to B<DEC>
889	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	1028	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
890	(code 8) - which can be reversed with the appropriate DEC private mode	1029	(code 8) - which can be reversed with the appropriate DEC private mode
891	escape sequence.	1030	escape sequence.
892		1031
893	=item B<deletekey:> I<string>	1032	=item B<deletekey:> I<string>
894		1033
…		…
896	pressed. If unset it will send the sequence traditionally associated	1035	pressed. If unset it will send the sequence traditionally associated
897	with the B<Execute> key.	1036	with the B<Execute> key.
898		1037
899	=item B<cutchars:> I<string>	1038	=item B<cutchars:> I<string>
900		1039
901	The characters used as delimiters for double-click word selection. The	1040	The characters used as delimiters for double-click word selection
902	built-in default:	1041	(whitespace delimiting is added automatically if resource is given).
903		1042
		1043	When the perl selection extension is in use (the default if compiled
		1044	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		1045	characters will be created (if the resource exists, otherwise, no regex
		1046	will be created). In this mode, characters outside ISO-8859-1 can be used.
		1047
		1048	When the selection extension is not used, only ISO-8859-1 characters can
		1049	be used. If not specified, the built-in default is used:
		1050
904	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1051	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
905		1052
906	=item B<preeditType:> I<style>	1053	=item B<preeditType:> I<style>
907		1054
908	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1055	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
909		1056
…		…
963		1110
964	Turn on/off secondary screen (default enabled).	1111	Turn on/off secondary screen (default enabled).
965		1112
966	=item B<secondaryScroll:> I<boolean>	1113	=item B<secondaryScroll:> I<boolean>
967		1114
968	Turn on/off secondary screen scroll (default enabled). If the this	1115	Turn on/off secondary screen scroll (default enabled). If this
969	option is enabled, scrolls on the secondary screen will change the	1116	option is enabled, scrolls on the secondary screen will change the
970	scrollback buffer and switching to/from the secondary screen will	1117	scrollback buffer and, when secondaryScreen is off, switching
971	instead scroll the screen up.	1118	to/from the secondary screen will instead scroll the screen up.
972		1119
973	=item B<hold>: I<boolean>	1120	=item B<hold>: I<boolean>
974		1121
975	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1122	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
976	will not immediately destroy its window when the program executed within	1123	will not immediately destroy its window when the program executed within
977	it exits. Instead, it will wait till it is being killed or closed by the	1124	it exits. Instead, it will wait till it is being killed or closed by the
978	user.	1125	user.
		1126
		1127	=item B<chdir>: I<path>
		1128
		1129	Sets the working directory for the shell (or the command specified via
		1130	B<-e>). The I<path> must be an absolute path and it must exist for
		1131	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1132	directory will be used; option B<-cd>.
979		1133
980	=item B<keysym.>I<sym>: I<string>	1134	=item B<keysym.>I<sym>: I<string>
981		1135
982	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1136	Compile I<frills>: Associate I<string> with keysym I<sym>. The
983	intervening resource name B<keysym.> cannot be omitted.	1137	intervening resource name B<keysym.> cannot be omitted.
…		…
997	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1151	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
998	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1152	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
999	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1153	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1000	performed in an exact manner; however, the closest match is assured.	1154	performed in an exact manner; however, the closest match is assured.
1001		1155
1002	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1156	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1003	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1157	number), see RESOURCES in C<man 7 X> for further details.
1004	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1005	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1006	can start or end with whitespace.
1007
1008	Please note that you need to double the C<\> in resource files, as
1009	Xlib itself does it's own de-escaping (you can use C<\033> instead of
1010	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1011	processing).
1012		1158
1013	You can define a range of keysyms in one shot by providing a I<string>	1159	You can define a range of keysyms in one shot by providing a I<string>
1014	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1160	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1015	should be a character not used by the strings.	1161	should be a character not used by the strings.
1016		1162
1017	Its usage can be demonstrated by an example:	1163	Its usage can be demonstrated by an example:
1018		1164
1019	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1165	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
…		…
1030	when Control-Meta-c is being pressed":	1176	when Control-Meta-c is being pressed":
1031		1177
1032	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1178	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1033		1179
1034	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1180	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1035	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1181	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1036	manpage. For example, the F<selection> extension (activated via	1182	manpage. For example, the F<selection> extension (activated via
1037	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1183	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1038		1184
1039	URxvt.keysym.M-C-c: perl:selection:rot13	1185	URxvt.keysym.M-C-c: perl:selection:rot13
1040		1186
1041	Due the the large number of modifier combinations, a defined key mapping	1187	Due the the large number of modifier combinations, a defined key mapping
1042	will match if at I<at least> the specified identifiers are being set, and	1188	will match if I<at least> the specified identifiers are being set, and
1043	no other key mappings with those and more bits are being defined. That	1189	no other key mappings with those and more bits are being defined. That
1044	means that defining a key map for C<a> will automatically provide	1190	means that defining a key map for C<a> will automatically provide
1045	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined	1191	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1046	mappings themselves.	1192	mappings themselves.
1047		1193
…		…
1083	example, C<default,-selection> will use all the default extension except	1229	example, C<default,-selection> will use all the default extension except
1084	C<selection>.	1230	C<selection>.
1085		1231
1086	Extension names can also be followed by an argument in angle brackets	1232	Extension names can also be followed by an argument in angle brackets
1087	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1233	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1088	searchable scorllback to Alt/Meta-s). Mentioning the same extension	1234	searchable scrollback to Alt/Meta-s). Mentioning the same extension
1089	multiple times with different arguments will pass multiple arguments to	1235	multiple times with different arguments will pass multiple arguments to
1090	the extension.	1236	the extension.
1091		1237
1092	Each extension is looked up in the library directories, loaded if	1238	Each extension is looked up in the library directories, loaded if
1093	necessary, and bound to the current terminal instance.	1239	necessary, and bound to the current terminal instance.
…		…
1098	all instances, while B<perl-ext> is used for specific instances.	1244	all instances, while B<perl-ext> is used for specific instances.
1099		1245
1100	=item B<perl-eval>: I<string>	1246	=item B<perl-eval>: I<string>
1101		1247
1102	Perl code to be evaluated when all extensions have been registered. See	1248	Perl code to be evaluated when all extensions have been registered. See
1103	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1249	the @@RXVT_NAME@@perl(3) manpage.
1104	will be ignored when running setuid/setgid.
1105		1250
1106	=item B<perl-lib>: I<path>	1251	=item B<perl-lib>: I<path>
1107		1252
1108	Colon-separated list of additional directories that hold extension	1253	Colon-separated list of additional directories that hold extension
1109	scripts. When looking for extensions specified by the C<perl> resource,	1254	scripts. When looking for extensions specified by the C<perl> resource,
1110	@@RXVT_NAME@@ will first look in these directories and then in	1255	@@RXVT_NAME@@ will first look in these directories and then in
1111	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1256	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1112	will be ignored when running setuid/setgid.
1113		1257
1114	See the @@RXVT_NAME@@perl(3) manpage.	1258	See the @@RXVT_NAME@@perl(3) manpage.
1115		1259
1116	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1260	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1117		1261
…		…
1129	(default: C<M-s>).	1273	(default: C<M-s>).
1130		1274
1131	=item B<urlLauncher>: I<string>	1275	=item B<urlLauncher>: I<string>
1132		1276
1133	Specifies the program to be started with a URL argument. Used by the	1277	Specifies the program to be started with a URL argument. Used by the
1134	C<selection-popup> and C<mark-urls> perl extensions.	1278	C<selection-popup> and C<matcher> perl extensions.
1135		1279
1136	=item B<transient-for>: I<windowid>	1280	=item B<transient-for>: I<windowid>
1137		1281
1138	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.	1282	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1139		1283
1140	=item B<override-redirect>: I<boolean>	1284	=item B<override-redirect>: I<boolean>
1141		1285
1142	Compile I<frills>: Sets override-redirect for the terminal window, making	1286	Compile I<frills>: Sets override-redirect for the terminal window, making
1143	it almost invisible to window managers; option B<-override-redirect>.	1287	it almost invisible to window managers; option B<-override-redirect>.
		1288
		1289	=item B<iso14755:> I<boolean>
		1290
		1291	Turn on/off ISO 14755 (default enabled).
		1292
		1293	=item B<iso14755_52:> I<boolean>
		1294
		1295	Turn on/off ISO 14755 5.2 mode (default enabled).
1144		1296
1145	=back	1297	=back
1146		1298
1147	=head1 THE SCROLLBAR	1299	=head1 THE SCROLLBAR
1148		1300
…		…
1167	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1319	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1168	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1320	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1169	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1321	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1170	respectively.	1322	respectively.
1171		1323
1172	=head1 TEXT SELECTION AND INSERTION	1324	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1173		1325
1174	The behaviour of text selection and insertion mechanism is similar to	1326	The behaviour of text selection and insertion/pasting mechanism is similar
1175	I<xterm>(1).	1327	to I<xterm>(1).
1176		1328
1177	=over 4	1329	=over 4
1178		1330
1179	=item B<Selection>:	1331	=item B<Selecting>:
1180		1332
1181	Left click at the beginning of the region, drag to the end of the region	1333	Left click at the beginning of the region, drag to the end of the region
1182	and release; Right click to extend the marked region; Left double-click	1334	and release; Right click to extend the marked region; Left double-click
1183	to select a word; Left triple-click to select the entire logical line	1335	to select a word; Left triple-click to select the entire logical line
1184	(which can span multiple screen lines), unless modified by resource	1336	(which can span multiple screen lines), unless modified by resource
…		…
1188	(Compile: I<frills>) will create a rectangular selection instead of a	1340	(Compile: I<frills>) will create a rectangular selection instead of a
1189	normal one. In this mode, every selected row becomes its own line in the	1341	normal one. In this mode, every selected row becomes its own line in the
1190	selection, and trailing whitespace is visually underlined and removed from	1342	selection, and trailing whitespace is visually underlined and removed from
1191	the selection.	1343	the selection.
1192		1344
1193	=item B<Insertion>:	1345	=item B<Pasting>:
1194		1346
1195	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@> window	1347	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1196	causes the value of the PRIMARY selection (Shift for CLIPBOARD) to be inserted	1348	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1197	as if it had been typed on the keyboard.	1349	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1350
1198	B<Shift-Insert> causes the value of the PRIMARY selection to be inserted too.	1351	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1352	inserted too.
1199		1353
1200	=back	1354	=back
1201		1355
1202	=head1 CHANGING FONTS	1356	=head1 CHANGING FONTS
1203		1357
…		…
1217		1371
1218	=head1 ISO 14755 SUPPORT	1372	=head1 ISO 14755 SUPPORT
1219		1373
1220	ISO 14755 is a standard for entering and viewing unicode characters	1374	ISO 14755 is a standard for entering and viewing unicode characters
1221	and character codes using the keyboard. It consists of 4 parts. The	1375	and character codes using the keyboard. It consists of 4 parts. The
1222	first part is available rxvt-unicode has been compiled with	1376	first part is available if rxvt-unicode has been compiled with
1223	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1377	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1224	with C<--enable-iso14755>.	1378	with C<--enable-iso14755>.
1225		1379
1226	=over 4	1380	=over 4
1227		1381
…		…
1247	This mode lets you input characters representing the keycap symbols of	1401	This mode lets you input characters representing the keycap symbols of
1248	your keyboard, if representable in the current locale encoding.	1402	your keyboard, if representable in the current locale encoding.
1249		1403
1250	Start by pressing C<Control> and C<Shift> together, then releasing	1404	Start by pressing C<Control> and C<Shift> together, then releasing
1251	them. The next special key (cursor keys, home etc.) you enter will not	1405	them. The next special key (cursor keys, home etc.) you enter will not
1252	invoke it's usual function but instead will insert the corresponding	1406	invoke its usual function but instead will insert the corresponding
1253	keycap symbol. The symbol will only be entered when the key has been	1407	keycap symbol. The symbol will only be entered when the key has been
1254	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1408	released, otherwise pressing e.g. C<Shift> would enter the symbol for
1255	C<ISO Level 2 Switch>, although your intention might have been to enter a	1409	C<ISO Level 2 Switch>, although your intention might have been to enter a
1256	reverse tab (Shift-Tab).	1410	reverse tab (Shift-Tab).
1257		1411
…		…
1285	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1439	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1286	it can be seen via the I<who(1)> command, and can accept messages. To	1440	it can be seen via the I<who(1)> command, and can accept messages. To
1287	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1441	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1288	on some systems or setgid to root or to some other group on others.	1442	on some systems or setgid to root or to some other group on others.
1289		1443
1290	=head1 COLORS AND GRAPHICS	1444	=head1 COLOURS AND GRAPHICS
1291		1445
1292	In addition to the default foreground and background colours,	1446	In addition to the default foreground and background colours,
1293	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1447	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1294	high-intensity bold/blink versions of the same). Here is a list of the	1448	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1295	colours with their B<rgb.txt> names.	1449	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1450	cube plus a 8 (24) colour greyscale ramp.
		1451
		1452	Here is a list of the ANSI colours with their names.
1296		1453
1297	=begin table	1454	=begin table
1298		1455
1299	B<color0> (black) = Black	1456	B<color0> (black) = Black
1300	B<color1> (red) = Red3	1457	B<color1> (red) = Red3
…		…
1320	It is also possible to specify the colour values of B<foreground>,	1477	It is also possible to specify the colour values of B<foreground>,
1321	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1478	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1322	a number 0-15, as a convenient shorthand to reference the colour name of	1479	a number 0-15, as a convenient shorthand to reference the colour name of
1323	color0-color15.	1480	color0-color15.
1324		1481
		1482	The following text gives values for the standard 88 colour mode (and
		1483	values for the 256 colour mode in parentheses).
		1484
		1485	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1486
		1487	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1488	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1489
		1490	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1491	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1492	the RGB cube.
		1493
		1494	Together, all those colours implement the 88 (256) colour xterm
		1495	colours. Only the first 16 can be changed using resources currently, the
		1496	rest can only be changed via command sequences ("escape codes").
		1497
		1498	Applications are advised to use terminfo or command sequences to discover
		1499	number and RGB values of all colours (yes, you can query this...).
		1500
1325	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1501	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1326	always swapping the foreground/background colours. This is in contrast to	1502	always swapping the foreground/background colours. This is in contrast to
1327	I<xterm>(1) where the colours are only swapped if they have not otherwise	1503	I<xterm>(1) where the colours are only swapped if they have not otherwise
1328	been specified. For example,	1504	been specified. For example,
1329		1505
		1506	@@RXVT_NAME@@ -fg Black -bg White -rv
		1507
		1508	would yield White on Black, while on I<xterm>(1) it would yield Black on
		1509	White.
		1510
		1511	=head2 ALPHA CHANNEL SUPPORT
		1512
		1513	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1514	their act together, rxvt-unicode will do it's own alpha channel management:
		1515
		1516	You can prefix any colour with an opaqueness percentage enclosed in
		1517	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1518	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1519	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1520	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1521	is the recommended format to specify transparency values, and works with
		1522	all ways to specify a colour.
		1523
		1524	For complete control, rxvt-unicode also supports
		1525	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1526	specifications, where the additional C<aaaa> component specifies opacity
		1527	(alpha) values. The minimum value of C<0000> is completely transparent,
		1528	while C<ffff> is completely opaque). The two example colours from
		1529	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1530	C<rgba:0000/ff00/0000/f332>.
		1531
		1532	You probably need to specify B<"-depth 32">, too, to force a visual with
		1533	alpha channels, and have the luck that your X-server uses ARGB pixel
		1534	layout, as X is far from just supporting ARGB visuals out of the box, and
		1535	rxvt-unicode just fudges around.
		1536
		1537	For example, the following selects an almost completely transparent black
		1538	background, and an almost opaque pink foreground:
		1539
		1540	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
		1541
		1542	When not using a background image, then the interpretation of the
		1543	alpha channel is up to your compositing manager (most interpret it as
		1544	transparency of course).
		1545
		1546	When using a background pixmap or pseudo-transparency, then the background
		1547	colour will always behave as if it were completely transparent (so the
		1548	background image shows instead), regardless of how it was specified, while
		1549	other colours will either be transparent as specified (the background
		1550	image will show through) on servers supporting the RENDER extension, or
		1551	fully opaque on servers not supporting the RENDER EXTENSION.
		1552
		1553	Please note that due to bugs in Xft, specifying alpha values might result
		1554	in garbage being displayed when the X-server does not support the RENDER
		1555	extension.
		1556
		1557	=head1 ENVIRONMENT
		1558
		1559	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
		1560
1330	=over 4	1561	=over 4
1331		1562
1332	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
1333
1334	would yield White on Black, while on I<xterm>(1) it would yield Black
1335	on White.
1336
1337	=back
1338
1339	=head1 ENVIRONMENT
1340
1341	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1342
1343	=over 4
1344
1345	=item B<TERM>	1563	=item B<TERM>
1346		1564
1347	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1565	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1348	resources or on the commandline.	1566	resources or on the command line.
1349		1567
1350	=item B<COLORTERM>	1568	=item B<COLORTERM>
1351		1569
1352	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1570	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1353	compiled with XPM support, and optionally with the added extension	1571	compiled with background image support, and optionally with the added
1354	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1572	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1573	screen.
1355		1574
1356	=item B<COLORFGBG>	1575	=item B<COLORFGBG>
1357		1576
1358	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1577	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1359	the colour code used as default foreground/text colour (or the string	1578	the colour code used as default foreground/text colour (or the string
1360	C<default> to indicate that the default-colour escape sequence is to be	1579	C<default> to indicate that the default-colour escape sequence is to be
1361	used), C<bg> is the colour code used as default background colour (or the	1580	used), C<bg> is the colour code used as default background colour (or the
1362	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1581	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1363	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1582	was compiled with background image support. Libraries like C<ncurses>
1364	(and do) use this information to optimize screen output.	1583	and C<slang> can (and do) use this information to optimize screen output.
1365		1584
1366	=item B<WINDOWID>	1585	=item B<WINDOWID>
1367		1586
1368	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1587	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1369	window, which usually has subwindows for the scrollbar, the terminal	1588	window, which usually has subwindows for the scrollbar, the terminal
…		…
1375	C<--with-terminfo=PATH>.	1594	C<--with-terminfo=PATH>.
1376		1595
1377	=item B<DISPLAY>	1596	=item B<DISPLAY>
1378		1597
1379	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1598	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1380	display in it's child processes.	1599	display in its child processes if C<-display> isn't used to override. It
		1600	defaults to C<:0> if it doesn't exist.
1381		1601
1382	=item B<SHELL>	1602	=item B<SHELL>
1383		1603
1384	The shell to be used for command execution, defaults to C</bin/sh>.	1604	The shell to be used for command execution, defaults to C</bin/sh>.
1385		1605
…		…
1411		1631
1412	=over 4	1632	=over 4
1413		1633
1414	=item B</usr/lib/X11/rgb.txt>	1634	=item B</usr/lib/X11/rgb.txt>
1415		1635
1416	Color names.	1636	Colour names.
1417		1637
1418	=back	1638	=back
1419		1639
1420	=head1 SEE ALSO	1640	=head1 SEE ALSO
1421		1641
…		…
1427		1647
1428	=item Project Coordinator	1648	=item Project Coordinator
1429		1649
1430	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1650	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1431		1651
1432	L<http://software.schmorp.de/#rxvt-unicode>	1652	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1433		1653
1434	=back	1654	=back
1435		1655
1436	=head1 AUTHORS	1656	=head1 AUTHORS
1437		1657
…		…
1460	Project Coordinator (changes.txt 2.21a to 2.4.5)	1680	Project Coordinator (changes.txt 2.21a to 2.4.5)
1461		1681
1462	=item Geoff Wing L<< <gcw@pobox.com> >>	1682	=item Geoff Wing L<< <gcw@pobox.com> >>
1463		1683
1464	Rewrote screen display and text selection routines.	1684	Rewrote screen display and text selection routines.
1465		1685
1466	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1686	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1467		1687
1468	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1688	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1469		1689
1470	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1690	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.102 by ayin, Fri Jan 20 18:04:32 2006 UTC vs. Revision 1.189 by sf-exg, Tue Nov 23 18:52:13 2010 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.102 by ayin, Fri Jan 20 18:04:32 2006 UTC vs.
Revision 1.189 by sf-exg, Tue Nov 23 18:52:13 2010 UTC