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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.83 by root, Tue Jan 3 22:28:07 2006 UTC vs.
Revision 1.161 by ayin, Sat Jan 26 14:24:42 2008 UTC

…		…
12	emulator intended as an I<xterm>(1) replacement for users who do not	12	emulator intended as an I<xterm>(1) replacement for users who do not
13	require features such as Tektronix 4014 emulation and toolkit-style	13	require features such as Tektronix 4014 emulation and toolkit-style
14	configurability. As a result, B<rxvt-unicode> uses much less swap space --	14	configurability. As a result, B<rxvt-unicode> uses much less swap space --
15	a significant advantage on a machine serving many X sessions.	15	a significant advantage on a machine serving many X sessions.
16		16
		17	This document is also available on the World-Wide-Web at
		18	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
		19
17	=head1 FREQUENTLY ASKED QUESTIONS	20	=head1 FREQUENTLY ASKED QUESTIONS
18		21
19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of	22	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20	frequently asked questions and answer to them and some common	23	frequently asked questions and answer to them and some common
21	problems. That document is also accessible on the World-Wide-Web at	24	problems. That document is also accessible on the World-Wide-Web at
22	L<http://cvs.schmorp.de/browse/checkout/rxvt-unicode/doc/rxvt.7.html>.	25	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23		26
24	=head1 RXVT-UNICODE VS. RXVT	27	=head1 RXVT-UNICODE VS. RXVT
25		28
26	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode	29	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27	internally. That means it can store and display most scripts in the	30	internally. That means it can store and display most scripts in the
28	world. Being a terminal emulator, however, some things are very difficult,	31	world. Being a terminal emulator, however, some things are very difficult,
29	especially cursive scripts such as arabic, vertically written scripts	32	especially cursive scripts such as arabic, vertically written scripts
30	like mongolian or scripts requiring extremely complex combining rules,	33	like mongolian or scripts requiring extremely complex combining rules,
31	like tibetan or devenagari. Don't expect pretty output when using these	34	like tibetan or devanagari. Don't expect pretty output when using these
32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	35	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33	fine, though. A somewhat difficult case are left-to-right scripts, such	36	fine, though. A somewhat difficult case are right-to-left scripts, such
34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	37	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35	belong into the application, not the terminal emulator (too many things --	38	belong in the application, not the terminal emulator (too many things --
36	such as cursor-movement while editing -- break otherwise), but that might	39	such as cursor-movement while editing -- break otherwise), but that might
37	change.	40	change.
38		41
39	If you are looking for a terminal that supports more exotic scripts, let	42	If you are looking for a terminal that supports more exotic scripts, let
40	me recommend C<mlterm>, which is a very userfriendly, lean and clean	43	me recommend C<mlterm>, which is a very user friendly, lean and clean
41	terminal emulator. In fact, the reason rxvt-unicode was born was solely	44	terminal emulator. In fact, the reason rxvt-unicode was born was solely
42	because the author couldn't get C<mlterm> to use one font for latin1 and	45	because the author couldn't get C<mlterm> to use one font for latin1 and
43	another for japanese.	46	another for japanese.
44		47
45	Therefore another design rationale was the use of multiple fonts to	48	Therefore another design rationale was the use of multiple fonts to
46	display characters: The idea of a single unicode font which many other	49	display characters: The idea of a single unicode font which many other
47	programs force onto it's users never made sense to me: You should be able	50	programs force onto its users never made sense to me: You should be able
48	to choose any font for any script freely.	51	to choose any font for any script freely.
49		52
50	Apart from that, rxvt-unicode is also much better internationalised than	53	Apart from that, rxvt-unicode is also much better internationalised than
51	it's predecessor, supports things such as XFT and ISO 14755 that are handy	54	its predecessor, supports things such as XFT and ISO 14755 that are handy
52	in i18n-environments, is faster, and has a lot less bugs than the original	55	in i18n-environments, is faster, and has a lot bugs less than the original
53	rxvt. This all in addition to dozens of other small improvements.	56	rxvt. This all in addition to dozens of other small improvements.
54		57
55	It is still faithfully following the original rxvt idea of being lean	58	It is still faithfully following the original rxvt idea of being lean
56	and nice on resources: for example, you can still configure rxvt-unicode	59	and nice on resources: for example, you can still configure rxvt-unicode
57	without most of it's features to get a lean binary. It also comes with	60	without most of its features to get a lean binary. It also comes with
58	a client/daemon pair that lets you open any number of terminal windows	61	a client/daemon pair that lets you open any number of terminal windows
59	from within a single process, which makes startup time very fast and	62	from within a single process, which makes startup time very fast and
60	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and	63	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
61	@@RXVT_NAME@@c(1) (client).	64	@@RXVT_NAME@@c(1) (client).
62		65
63	It also makes technical information about escape sequences (which have	66	It also makes technical information about escape sequences (which have
64	been extended) easier accessible: see @@RXVT_NAME@@(7) for technical	67	been extended) more accessible: see @@RXVT_NAME@@(7) for technical
65	reference documentation (escape sequences etc.).	68	reference documentation (escape sequences etc.).
66		69
67	=head1 OPTIONS	70	=head1 OPTIONS
68		71
69	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed	72	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
…		…
93		96
94	Attempt to open a window on the named X display (B<-d> still	97	Attempt to open a window on the named X display (B<-d> still
95	respected). In the absence of this option, the display specified by the	98	respected). In the absence of this option, the display specified by the
96	B<DISPLAY> environment variable is used.	99	B<DISPLAY> environment variable is used.
97		100
		101	=item B<-depth> I<bitdepth>
		102
		103	Compile I<xft>: Attempt to find a visual with the given bit depth;
		104	resource B<depth>.
		105
		106	[Please note that many X servers (and libXft) are buggy with
		107	respect to C<-depth 32> and/or alpha channels, and will cause all sorts
		108	of graphical corruption. This is harmless, but we can't do anything about
		109	this, so watch out]
		110
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
102	=item B<-rv>\|B<+rv>	115	=item B<-rv>\|B<+rv>
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 illusion of a transparent window background; resource B<transparent>.
		130
		131	B<-ip> is still accepted as an obsolete alias but will be removed in
		132	future versions.
		133
		134	I<Please address all transparency related issues to Sasha Vasko at
		135	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
114		136
115	=item B<-fade> I<number>	137	=item B<-fade> I<number>
116		138
117	Fade the text by the given percentage when focus is lost. Small values	139	Fade the text by the given percentage when focus is lost. Small values
118	fade a little only, 100 completely replaces all colours by the fade	140	fade a little only, 100 completely replaces all colours by the fade
119	colour; resource B<fading>.	141	colour; resource B<fading>.
120		142
121	=item B<-fadecolor> I<colour>	143	=item B<-fadecolor> I<colour>
122		144
123	Fade to this colour when fading is used (see B<-fade>). The default colour	145	Fade to this colour when fading is used (see B<-fade>). The default colour
124	is black. resource B<fadeColor>.	146	is opaque black. resource B<fadeColor>.
125		147
126	=item B<-tint> I<colour>	148	=item B<-tint> I<colour>
127		149
128	Tint the transparent background pixmap with the given colour when	150	Tint the transparent background pixmap with the given colour when
129	transparency is enabled with B<-tr> or B<-ip>. This only works for	151	transparency is enabled with B<-tr>. This only works for
130	non-tiled backgrounds, currently. See also the B<-sh> option that can be	152	non-tiled backgrounds, currently. See also the B<-sh> option that can be
131	used to brighten or darken the image in addition to tinting it; resource	153	used to brighten or darken the image in addition to tinting it.
		154	Please note that certain tint colours can be applied on the server-side,
		155	thus yielding performance gain of two orders of magnitude. These colours are:
		156	blue, red, green, cyan, magenta, yellow, and those close to them. Also
		157	pure black and pure white colors essentially mean no tinting; resource
132	I<tintColor>. Example:	158	I<tintColor>. Example:
133		159
134	@@RXVT_NAME@@ -tr -tint blue -sh 40	160	@@RXVT_NAME@@ -tr -tint blue -sh 40
135		161
136	=item B<-sh>	162	=item B<-sh> I<number>
137		163
138	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	164	Darken (0 .. 100) or lighten (100 .. 200) the transparent
139	background image in addition to tinting it (i.e. B<-tint> must be	165	background image in addition to (or instead of) tinting it;
140	specified, too, e.g. C<-tint white>).	166	resource I<shading>.
		167
		168	=item B<-blt> I<string>
		169
		170	Specify background blending type. If background pixmap is specified
		171	at the same time as transparency - such pixmap will be blended over
		172	transparency image, using method specified. Supported values are :
		173	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
		174	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
		175	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
		176	alpha-blending. Compile I<afterimage>; resource I<blendType>.
		177
		178	=item B<-blr> I<HxV>
		179
		180	Apply Gaussian Blur with the specified radii to the transparent
		181	background image. If single number is specified - both vertical and
		182	horizontal radii are considered to be the same. Setting one of the
		183	radii to 1 and another to a large number creates interesting effects
		184	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
		185	resource I<blurRadius>.
141		186
142	=item B<-bg> I<colour>	187	=item B<-bg> I<colour>
143		188
144	Window background colour; resource B<background>.	189	Window background colour; resource B<background>.
145		190
146	=item B<-fg> I<colour>	191	=item B<-fg> I<colour>
147		192
148	Window foreground colour; resource B<foreground>.	193	Window foreground colour; resource B<foreground>.
149		194
150	=item B<-pixmap> I<file[;geom]>	195	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
151		196
152	Compile I<XPM>: Specify XPM file for the background and also optionally	197	Compile I<afterimage>: Specify image file for the background and also
153	specify its scaling with a geometry string. Note you may need to	198	optionally specify its scaling with a geometry string. Note you may need to
154	add quotes to avoid special shell interpretation of the C<;> in the	199	add quotes to avoid special shell interpretation of the C<;> in the
155	command-line; resource B<backgroundPixmap>.	200	command-line; for more details see resource B<backgroundPixmap>.
156		201
157	=item B<-cr> I<colour>	202	=item B<-cr> I<colour>
158		203
159	The cursor colour; resource B<cursorColor>.	204	The cursor colour; resource B<cursorColor>.
160		205
…		…
172	resource B<borderColor>.	217	resource B<borderColor>.
173		218
174	=item B<-fn> I<fontlist>	219	=item B<-fn> I<fontlist>
175		220
176	Select the fonts to be used. This is a comma separated list of font names	221	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	222	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	223	first font defines the cell size for characters; other fonts might be
179	smaller, but not (in general) larger. A (hopefully) reasonable default	224	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.	225	font list is always appended to it. See resource B<font> for more details.
181		226
182	In short, to specify an X11 core font, just specify it's name or prefix it	227	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:>,	228	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184	e.g.:	229	e.g.:
185		230
186	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	231	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	232	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
189	See also the question "How does rxvt-unicode choose fonts?" in the FAQ	234	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
190	section of @@RXVT_NAME@@(7).	235	section of @@RXVT_NAME@@(7).
191		236
192	=item B<-fb> I<fontlist>	237	=item B<-fb> I<fontlist>
193		238
194	Compile font-styles: The bold font list to use when B<bold> characters are to	239	Compile I<font-styles>: The bold font list to use when B<bold> characters
195	be printed. See resource B<boldFont> for details.	240	are to be printed. See resource B<boldFont> for details.
196		241
197	=item B<-fi> I<fontlist>	242	=item B<-fi> I<fontlist>
198		243
199	Compile font-styles: The italic font list to use when I<italic> characters are to	244	Compile I<font-styles>: The italic font list to use when I<italic>
200	be printed. See resource B<italicFont> for details.	245	characters are to be printed. See resource B<italicFont> for details.
201		246
202	=item B<-fbi> I<fontlist>	247	=item B<-fbi> I<fontlist>
203		248
204	Compile font-styles: The bold italic font list to use when B<< I<bold	249	Compile I<font-styles>: The bold italic font list to use when B<< I<bold
205	italic> >> characters are to be printed. See resource B<boldItalicFont>	250	italic> >> characters are to be printed. See resource B<boldItalicFont>
206	for details.	251	for details.
207		252
208	=item B<-is>\|B<+is>	253	=item B<-is>\|B<+is>
209		254
210	Compile font-styles: Bold/Italic font styles imply high intensity	255	Compile I<font-styles>: Bold/Blink font styles imply high intensity
211	foreground/background (default). See resource B<intensityStyles> for	256	foreground/background (default). See resource B<intensityStyles> for
212	details.	257	details.
213		258
214	=item B<-name> I<name>	259	=item B<-name> I<name>
215		260
…		…
233		278
234	=item B<-sb>\|B<+sb>	279	=item B<-sb>\|B<+sb>
235		280
236	Turn on/off scrollbar; resource B<scrollBar>.	281	Turn on/off scrollbar; resource B<scrollBar>.
237		282
		283	=item B<-sr>\|B<+sr>
		284
		285	Put scrollbar on right/left; resource B<scrollBar_right>.
		286
		287	=item B<-st>\|B<+st>
		288
		289	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		290	resource B<scrollBar_floating>.
		291
238	=item B<-si>\|B<+si>	292	=item B<-si>\|B<+si>
239		293
240	Turn on/off scroll-to-bottom on TTY output inhibit; resource	294	Turn on/off scroll-to-bottom on TTY output inhibit; resource
241	B<scrollTtyOutput> has opposite effect.	295	B<scrollTtyOutput> has opposite effect.
242		296
…		…
248	=item B<-sw>\|B<+sw>	302	=item B<-sw>\|B<+sw>
249		303
250	Turn on/off scrolling with the scrollback buffer as new lines appear.	304	Turn on/off scrolling with the scrollback buffer as new lines appear.
251	This only takes effect if B<-si> is also given; resource	305	This only takes effect if B<-si> is also given; resource
252	B<scrollWithBuffer>.	306	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		307
263	=item B<-ptab>\|B<+ptab>	308	=item B<-ptab>\|B<+ptab>
264		309
265	If enabled (default), "Horizontal Tab" characters are being stored as	310	If enabled (default), "Horizontal Tab" characters are being stored as
266	actual wide characters in the screen buffer, which makes it possible to	311	actual wide characters in the screen buffer, which makes it possible to
…		…
297		342
298	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	343	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
299	if honoured by the WM, the rxvt-unicode window will not have window	344	if honoured by the WM, the rxvt-unicode window will not have window
300	decorations; resource B<borderLess>.	345	decorations; resource B<borderLess>.
301		346
		347	=item B<-override-redirect>
		348
		349	Compile I<frills>: Sets override-redirect on the window; resource
		350	B<override-redirect>.
		351
		352	=item B<-sbg>
		353
		354	Compile I<frills>: Disable the usage of the built-in block graphics/line
		355	drawing characters and just rely on what the specified fonts provide. Use
		356	this if you have a good font and want to use its block graphic glyphs;
		357	resource B<skipBuiltinGlyphs>.
		358
302	=item B<-lsp> I<number>	359	=item B<-lsp> I<number>
303		360
304	Compile I<frills>: Lines (pixel height) to insert between each row of	361	Compile I<frills>: Lines (pixel height) to insert between each row of
305	the display. Useful to work around font rendering problems; resource	362	the display. Useful to work around font rendering problems; resource
306	B<linespace>.	363	B<lineSpace>.
307		364
308	=item B<-tn> I<termname>	365	=item B<-tn> I<termname>
309		366
310	This option specifies the name of the terminal type to be set in the	367	This option specifies the name of the terminal type to be set in the
311	B<TERM> environment variable. This terminal type must exist in the	368	B<TERM> environment variable. This terminal type must exist in the
…		…
365	for more info.	422	for more info.
366		423
367	=item B<-tcw>	424	=item B<-tcw>
368		425
369	Change the meaning of triple-click selection with the left mouse	426	Change the meaning of triple-click selection with the left mouse
		427	button. Only effective when the original (non-perl) selection code is
370	button. Instead of selecting a full line it will extend the selection the	428	in-use. Instead of selecting a full line it will extend the selection to
371	end of the logical line only. resource B<tripleclickwords>.	429	the end of the logical line only. resource B<tripleclickwords>.
372		430
373	=item B<-insecure>	431	=item B<-insecure>
374		432
375	Enable "insecure" mode, which currently enables most of the escape	433	Enable "insecure" mode, which currently enables most of the escape
376	sequences that echo strings. See the resource B<insecure> for more	434	sequences that echo strings. See the resource B<insecure> for more
…		…
397	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	455	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
398	will not immediately destroy its window when the program executed within	456	will not immediately destroy its window when the program executed within
399	it exits. Instead, it will wait till it is being killed or closed by the	457	it exits. Instead, it will wait till it is being killed or closed by the
400	user; resource B<hold>.	458	user; resource B<hold>.
401		459
		460	=item B<-xrm> I<string>
		461
		462	Works like the X Toolkit option of the same name, by adding the I<string>
		463	as if it were specified in a resource file. Resource values specified this
		464	way take precedence over all other resource specifications.
		465
		466	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		467	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		468	options can be specified as long-options on the commandline, so use
		469	of B<-xrm> is mostly limited to cases where you want to specify other
		470	resources (e.g. for input methods) or for compatibility with other
		471	programs.
		472
402	=item B<-keysym.>I<sym> I<string>	473	=item B<-keysym.>I<sym> I<string>
403		474
404	Remap a key symbol. See resource B<keysym>.	475	Remap a key symbol. See resource B<keysym>.
405		476
406	=item B<-embed> I<windowid>	477	=item B<-embed> I<windowid>
407		478
408	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,	479	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
409	which enables applications to easily embed a terminal.	480	which enables applications to easily embed a terminal.
410		481
411	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it	482	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
412	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it	483	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
413	quite a bit, so don't expect it to keep some specific state. It's best to	484	quite a bit, so don't expect it to keep some specific state. It's best to
…		…
416	The window will not be destroyed when @@RXVT_NAME@@ exits.	487	The window will not be destroyed when @@RXVT_NAME@@ exits.
417		488
418	It might be useful to know that @@RXVT_NAME@@ will not close file	489	It might be useful to know that @@RXVT_NAME@@ will not close file
419	descriptors passed to it (except for stdin/out/err, of course), so you	490	descriptors passed to it (except for stdin/out/err, of course), so you
420	can use file descriptors to communicate with the programs within the	491	can use file descriptors to communicate with the programs within the
421	terminal. This works regardless of wether the C<-embed> option was used or	492	terminal. This works regardless of whether the C<-embed> option was used or
422	not.	493	not.
423		494
424	Here is a short Gtk2-perl snippet that illustrates how this option can be	495	Here is a short Gtk2-perl snippet that illustrates how this option can be
425	used (a longer example is in F<doc/embed>):	496	used (a longer example is in F<doc/embed>):
426		497
…		…
428	$rxvt->signal_connect_after (realize => sub {	499	$rxvt->signal_connect_after (realize => sub {
429	my $xid = $_[0]->window->get_xid;	500	my $xid = $_[0]->window->get_xid;
430	system "@@RXVT_NAME@@ -embed $xid &";	501	system "@@RXVT_NAME@@ -embed $xid &";
431	});	502	});
432		503
433	=item B<-pty-fd> I<fileno>	504	=item B<-pty-fd> I<file descriptor>
434		505
435	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	506	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
436	pair but instead use the given filehandle as the tty master. This is	507	pair but instead use the given file descriptor as the tty master. This is
437	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator	508	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
438	without having to run a program within it.	509	without having to run a program within it.
439		510
440	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	511	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
441	entries and will not tinker with pty/tty permissions - you have to do that	512	entries and will not tinker with pty/tty permissions - you have to do that
442	yourself if you want that.	513	yourself if you want that.
		514
		515	As an extremely special case, specifying C<-1> will completely suppress
		516	pty/tty operations, which is probably only useful in conjunction with some
		517	perl extension that manages the terminal.
443		518
444	Here is a example in perl that illustrates how this option can be used (a	519	Here is a example in perl that illustrates how this option can be used (a
445	longer example is in F<doc/pty-fd>):	520	longer example is in F<doc/pty-fd>):
446		521
447	use IO::Pty;	522	use IO::Pty;
…		…
456	my $slave = $pty->slave;	531	my $slave = $pty->slave;
457	while (<$slave>) { print $slave "got <$_>\n" }	532	while (<$slave>) { print $slave "got <$_>\n" }
458		533
459	=item B<-pe> I<string>	534	=item B<-pe> I<string>
460		535
461	Colon-separated list of perl extension scripts to use in this terminal instance. See resource B<perl-ext>.	536	Comma-separated list of perl extension scripts to use (or not to use) in
		537	this terminal instance. See resource B<perl-ext> for details.
462		538
463	=back	539	=back
464		540
465	=head1 RESOURCES (available also as long-options)	541	=head1 RESOURCES
466		542
467	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	543	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
468	options) compiled into your version.	544	options) compiled into your version. All resources are also available as
		545	long-options.
469		546
470	There are two different methods that @@RXVT_NAME@@ can use to get the	547	You can set and change the resources using X11 tools like B<xrdb>. Many
471	Xresource data: using the X libraries (Xrm*-functions) or internal	548	distribution do also load settings from the B<~/.Xresources> file when X
472	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	549	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
473	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	550	with later settings overwriting earlier ones:
474	resources using X11 tools like B<xrdb>. Many distribution do also load
475	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
476	will consult the following files/resources in order, with later settings
477	overwriting earlier ones:
478		551
479	1. system-wide app-defaults file, either locale-dependent OR global	552	1. system-wide app-defaults file, either locale-dependent OR global
480	2. app-defaults file in $XAPPLRESDIR	553	2. app-defaults file in $XAPPLRESDIR
481	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	554	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
482	4. SCREEN_RESOURCES for the current screen	555	4. SCREEN_RESOURCES for the current screen
483	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	556	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		557	6. resources specified via -xrm on the commandline
484		558
485	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
486	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
487	set in XAPPLOADDIR/URxvt (compile-time defined: usually
488	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
489	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
490	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	559	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
491	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows	560	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
492	resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be	561	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
493	easily configured, while the class name B<URxvt> allows resources	562	configured, while the class name B<URxvt> allows resources unique to
494	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	563	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
495	shared between different B<@@RXVT_NAME@@> configurations. If no	564	configurations. If no resources are specified, suitable defaults will
496	resources are specified, suitable defaults will be used. Command-line	565	be used. Command-line arguments can be used to override resource
497	arguments can be used to override resource settings. The following	566	settings. The following resources are supported (you might want to
498	resources are allowed:	567	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		568	extensions not documented here):
499		569
500	=over 4	570	=over 4
		571
		572	=item B<depth:> I<bitdepth>
		573
		574	Compile I<xft>: Attempt to find a visual with the given bit depth;
		575	option B<-depth>.
		576
		577	=item B<buffered:> I<boolean>
		578
		579	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		580	On some card/driver combination enabling it slightly decreases
		581	performance, on most it greatly helps it. The slowdown is small, so it
		582	should normally be enabled.
501		583
502	=item B<geometry:> I<geom>	584	=item B<geometry:> I<geom>
503		585
504	Create the window with the specified X window geometry [default 80x24];	586	Create the window with the specified X window geometry [default 80x24];
505	option B<-geometry>.	587	option B<-geometry>.
…		…
542	Use the specified colour to display underlined characters when the	624	Use the specified colour to display underlined characters when the
543	foreground colour is the default.	625	foreground colour is the default.
544		626
545	=item B<colorRV:> I<colour>	627	=item B<colorRV:> I<colour>
546		628
547	Use the specified colour as the background for reverse video	629	Use the specified colour as the background for reverse video characters
548	characters.	630	when OPTION_HC is disabled (--disable-frills).
549		631
550	=item B<underlineColor:> I<colour>	632	=item B<underlineColor:> I<colour>
551		633
552	If set, use the specified colour as the colour for the underline	634	If set, use the specified colour as the colour for the underline
553	itself. If unset, use the foreground colour.	635	itself. If unset, use the foreground colour.
…		…
569	option B<-rv>. B<False>: regular screen colours [default]; option	651	option B<-rv>. B<False>: regular screen colours [default]; option
570	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	652	B<+rv>. See note in B<COLORS AND GRAPHICS> section.
571		653
572	=item B<jumpScroll:> I<boolean>	654	=item B<jumpScroll:> I<boolean>
573		655
574	B<True>: specify that jump scrolling should be used. When scrolling	656	B<True>: specify that jump scrolling should be used. When receiving lots
575	quickly, fewer screen updates are performed [default]; option B<-j>.	657	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		658	has been read, resulting in fewer updates while still displaying every
		659	received line; option B<-j>.
		660
576	B<False>: specify that smooth scrolling should be used; option B<+j>.	661	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		662	force a screen refresh on each new line it received; option B<+j>.
577		663
578	=item B<inheritPixmap:> I<boolean>	664	=item B<skipScroll:> I<boolean>
579		665
580	B<True>: make the background inherit the parent windows' pixmap, giving	666	B<True>: (the default) specify that skip scrolling should be used. When
581	artificial transparency. B<False>: do not inherit the parent windows'	667	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
582	pixmap.	668	(around 60 times per second), resulting in far fewer updates. This can
		669	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		670	option B<-ss>.
		671
		672	B<False>: specify that everything is to be displayed, even
		673	if the refresh is too fast for the human eye to read anything (or the
		674	monitor to display anything); option B<+ss>.
		675
		676	=item B<transparent:> I<boolean>
		677
		678	Turn on/off illusion of a transparent window background.
		679
		680	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
		681	future versions.
		682
		683	I<Please address all transparency related issues to Sasha Vasko at
		684	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
583		685
584	=item B<fading:> I<number>	686	=item B<fading:> I<number>
585		687
586	Fade the text by the given percentage when focus is lost; option B<-fade>.	688	Fade the text by the given percentage when focus is lost; option B<-fade>.
587		689
…		…
595	Tint the transparent background pixmap with the given colour; option	697	Tint the transparent background pixmap with the given colour; option
596	B<-tint>.	698	B<-tint>.
597		699
598	=item B<shading:> I<number>	700	=item B<shading:> I<number>
599		701
600	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	702	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
601	image in addition to tinting it.	703	in addition to tinting it; option B<-sh>.
		704
		705	=item B<blendType:> I<string>
		706
		707	Specify background blending type; option B<-blt>.
		708
		709	=item B<blurRadius:> I<number>
		710
		711	Apply Gaussian Blurr with the specified radius to the transparent
		712	background image; option B<-blr>.
602		713
603	=item B<scrollColor:> I<colour>	714	=item B<scrollColor:> I<colour>
604		715
605	Use the specified colour for the scrollbar [default #B2B2B2].	716	Use the specified colour for the scrollbar [default #B2B2B2].
606		717
…		…
612	=item B<borderColor:> I<colour>	723	=item B<borderColor:> I<colour>
613		724
614	The colour of the border around the text area and between the scrollbar	725	The colour of the border around the text area and between the scrollbar
615	and the text.	726	and the text.
616		727
617	=item B<backgroundPixmap:> I<file[;geom]>	728	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
618		729
619	Use the specified XPM file (note the `.xpm' extension is optional) for	730	Use the specified image file for the background and also
620	the background and also optionally specify its scaling with a geometry	731	optionally specify its scaling with a geometry string B<WxH+X+Y>,
621	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	732	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
622	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	733	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
623	centre (percent). A scale of 0 displays the image with tiling. A scale	734	centre (percent). A scale of 0 displays the image with tiling. A scale
624	of 1 displays the image without any scaling. A scale of 2 to 9	735	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
625	specifies an integer number of images in that direction. No image will	736	an integer number of images in that direction. No image will be magnified
626	be magnified beyond 10 times its original size. The maximum permitted	737	beyond 10 times its original size. The maximum permitted scale is 1000.
627	scale is 1000. [default 0x0+50+50]	738	Additional operations can be specified after colon B<:op1:op2...>.
		739	Supported operations are:
628		740
629	=item B<menu:> I<file[;tag]>	741	tile force background image to be tiled and not scaled. Equivalent to 0x0
		742	propscale will scale image keeping proportions
		743	auto will scale image to match window size. Equivalent to 100x100
		744	hscale will scale image horizontally to the window size
		745	vscale will scale image vertically to the window size
		746	scale will scale image to match window size
		747	root will tile image as if it was a root window background, auto-adjusting
		748	whenever terminal window moves
630		749
631	Read in the specified menu file (note the `.menu' extension is	750	If used in conjunction with B<-tr> option, the specified pixmap will be
632	optional) and also optionally specify a starting tag to find. See the	751	blended over transparency image using either alpha-blending, or any
633	reference documentation for details on the syntax for the menuBar.	752	other blending type, specified with B<-blt "type"> option.
634		753
635	=item B<path:> I<path>	754	=item B<path:> I<path>
636		755
637	Specify the colon-delimited search path for finding files (XPM and	756	Specify the colon-delimited search path for finding background image files.
638	menus), in addition to the paths specified by the B<RXVTPATH> and
639	B<PATH> environment variables.
640		757
641	=item B<font:> I<fontlist>	758	=item B<font:> I<fontlist>
642		759
643	Select the fonts to be used. This is a comma separated list of font	760	Select the fonts to be used. This is a comma separated list of font names
644	names that are used in turn when trying to display Unicode characters.	761	that are checked in order when trying to find glyphs for characters. The
645	The first font defines the cell size for characters; other fonts might	762	first font defines the cell size for characters; other fonts might be
646	be smaller, but not larger. A reasonable default font list is always	763	smaller, but not (in general) larger. A (hopefully) reasonable default
647	appended to it; option B<-fn>.	764	font list is always appended to it; option B<-fn>.
648		765
649	Each font can either be a standard X11 core font (XLFD) name, with	766	Each font can either be a standard X11 core font (XLFD) name, with
650	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.	767	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
651		768
652	In addition, each font can be prefixed with additional hints and	769	In addition, each font can be prefixed with additional hints and
…		…
654	hint currently is C<codeset=codeset-name>, and this is only used for Xft	771	hint currently is C<codeset=codeset-name>, and this is only used for Xft
655	fonts.	772	fonts.
656		773
657	For example, this font resource	774	For example, this font resource
658		775
659	URxvt*font: 9x15bold,\	776	URxvt.font: 9x15bold,\
660	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	777	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
661	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \	778	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
662	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	779	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
663	xft:Code2000:antialias=false	780	xft:Code2000:antialias=false
664		781
…		…
701	text font will being used for the given style.	818	text font will being used for the given style.
702		819
703	=item B<intensityStyles:> I<boolean>	820	=item B<intensityStyles:> I<boolean>
704		821
705	When font styles are not enabled, or this option is enabled (B<True>,	822	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	823	option B<-is>, the default), bold/blink font styles imply high
707	intensity foreground/backround colours. Disabling this option (B<False>,	824	intensity foreground/background colours. Disabling this option (B<False>,
708	option B<+is>) disables this behaviour, the high intensity colours are not	825	option B<+is>) disables this behaviour, the high intensity colours are not
709	reachable.	826	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		827
722	=item B<title:> I<string>	828	=item B<title:> I<string>
723		829
724	Set window title string, the default title is the command-line	830	Set window title string, the default title is the command-line
725	specified after the B<-e> option, if any, otherwise the application	831	specified after the B<-e> option, if any, otherwise the application
…		…
734	=item B<mapAlert:> I<boolean>	840	=item B<mapAlert:> I<boolean>
735		841
736	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	842	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].	843	de-iconify (map) on receipt of a bell character [default].
738		844
		845	=item B<urgentOnBell:> I<boolean>
		846
		847	B<True>: set the urgency hint for the wm on receipt of a bell character.
		848	B<False>: do not set the urgency hint [default].
		849
739	=item B<visualBell:> I<boolean>	850	=item B<visualBell:> I<boolean>
740		851
741	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	852	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
742	B<False>: no visual bell [default]; option B<+vb>.	853	B<False>: no visual bell [default]; option B<+vb>.
743		854
…		…
761		872
762	The string will be interpreted as if typed into the shell as-is.	873	The string will be interpreted as if typed into the shell as-is.
763		874
764	Example:	875	Example:
765		876
766	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	877	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
767		878
768	This creates a new file in your home directory with the screen contents	879	This creates a new file in your home directory with the screen contents
769	everytime you hit C<Print>.	880	every time you hit C<Print>.
		881
		882	=item B<scrollstyle:> I<mode>
		883
		884	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		885	the author's favourite.
770		886
771	=item B<scrollBar:> I<boolean>	887	=item B<scrollBar:> I<boolean>
772		888
773	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	889	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
774	disable the scrollbar; option B<+sb>.	890	disable the scrollbar; option B<+sb>.
…		…
796		912
797	=item B<scrollWithBuffer:> I<boolean>	913	=item B<scrollWithBuffer:> I<boolean>
798		914
799	B<True>: scroll with scrollback buffer when tty receives new lines (and	915	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	916	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
801	with scrollback buffer when tty recieves new lines; option B<+sw>.	917	with scrollback buffer when tty receives new lines; option B<+sw>.
802		918
803	=item B<scrollTtyKeypress:> I<boolean>	919	=item B<scrollTtyKeypress:> I<boolean>
804		920
805	B<True>: scroll to bottom when a non-special key is pressed. Special keys	921	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	922	are those which are intercepted by rxvt-unicode for special handling and
…		…
825	=item B<borderLess:> I<boolean>	941	=item B<borderLess:> I<boolean>
826		942
827	Set MWM hints to request a borderless window, i.e. if honoured by the	943	Set MWM hints to request a borderless window, i.e. if honoured by the
828	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.	944	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
829		945
		946	=item B<skipBuiltinGlyphs:> I<boolean>
		947
		948	Compile I<frills>: Disable the usage of the built-in block graphics/line
		949	drawing characters and just rely on what the specified fonts provide. Use
		950	this if you have a good font and want to use its block graphic glyphs;
		951	option B<-sbg>.
		952
830	=item B<termName:> I<termname>	953	=item B<termName:> I<termname>
831		954
832	Specifies the terminal type name to be set in the B<TERM> environment	955	Specifies the terminal type name to be set in the B<TERM> environment
833	variable; option B<-tn>.	956	variable; option B<-tn>.
834		957
835	=item B<linespace:> I<number>	958	=item B<lineSpace:> I<number>
836		959
837	Specifies number of lines (pixel height) to insert between each row of	960	Specifies number of lines (pixel height) to insert between each row of
838	the display [default 0]; option B<-lsp>.	961	the display [default 0]; option B<-lsp>.
839		962
840	=item B<meta8:> I<boolean>	963	=item B<meta8:> I<boolean>
…		…
889	pressed. If unset it will send the sequence traditionally associated	1012	pressed. If unset it will send the sequence traditionally associated
890	with the B<Execute> key.	1013	with the B<Execute> key.
891		1014
892	=item B<cutchars:> I<string>	1015	=item B<cutchars:> I<string>
893		1016
894	The characters used as delimiters for double-click word selection. The	1017	The characters used as delimiters for double-click word selection
895	built-in default:	1018	(whitespace delimiting is added automatically if resource is given).
896		1019
		1020	When the perl selection extension is in use (the default if compiled
		1021	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		1022	characters will be created (if the resource exists, otherwise, no regex
		1023	will be created). In this mode, characters outside ISO-8859-1 can be used.
		1024
		1025	When the selection extension is not used, only ISO-8859-1 characters can
		1026	be used. If not specified, the built-in default is used:
		1027
897	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1028	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
898		1029
899	=item B<preeditType:> I<style>	1030	=item B<preeditType:> I<style>
900		1031
901	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1032	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
902		1033
…		…
936	default. (Note that many other terminals, including xterm, have these	1067	default. (Note that many other terminals, including xterm, have these
937	sequences enabled by default, which doesn't make it safer, though).	1068	sequences enabled by default, which doesn't make it safer, though).
938		1069
939	You can enable them by setting this boolean resource or specifying	1070	You can enable them by setting this boolean resource or specifying
940	B<-insecure> as an option. At the moment, this enables display-answer,	1071	B<-insecure> as an option. At the moment, this enables display-answer,
941	locale, findfont, icon label and window title requests as well as dynamic	1072	locale, findfont, icon label and window title requests.
942	menubar dispatch.
943		1073
944	=item B<modifier:> I<modifier>	1074	=item B<modifier:> I<modifier>
945		1075
946	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	1076	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
947	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	1077	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
951		1081
952	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	1082	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
953	character is passed through. It may contain escape values as described	1083	character is passed through. It may contain escape values as described
954	in the entry on B<keysym> following.	1084	in the entry on B<keysym> following.
955		1085
956	=item B<secondaryScreen:> I<bool>	1086	=item B<secondaryScreen:> I<boolean>
957		1087
958	Turn on/off secondary screen (default enabled).	1088	Turn on/off secondary screen (default enabled).
959		1089
960	=item B<secondaryScroll:> I<bool>	1090	=item B<secondaryScroll:> I<boolean>
961		1091
962	Turn on/off secondary screen scroll (default enabled). If the this	1092	Turn on/off secondary screen scroll (default enabled). If this
963	option is enabled, scrolls on the secondary screen will change the	1093	option is enabled, scrolls on the secondary screen will change the
964	scrollback buffer and switching to/from the secondary screen will	1094	scrollback buffer and switching to/from the secondary screen will
965	instead scroll the screen up.	1095	instead scroll the screen up.
966		1096
967	=item B<hold>: I<bool>	1097	=item B<hold>: I<boolean>
968		1098
969	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1099	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
970	will not immediately destroy its window when the program executed within	1100	will not immediately destroy its window when the program executed within
971	it exits. Instead, it will wait till it is being killed or closed by the	1101	it exits. Instead, it will wait till it is being killed or closed by the
972	user.	1102	user.
…		…
991	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1121	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
992	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1122	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
993	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1123	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
994	performed in an exact manner; however, the closest match is assured.	1124	performed in an exact manner; however, the closest match is assured.
995		1125
996	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1126	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
997	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1127	number), see RESOURCES in C<man 7 X> for futher details.
998	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
999	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1000	can start or end with whitespace.
1001
1002	Please note that you need to double the C<\> when using
1003	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
1004	use C<\033> instead of C<\e> (and so on), which will work with both Xt and
1005	@@RXVT_NAME@@'s own processing).
1006		1128
1007	You can define a range of keysyms in one shot by providing a I<string>	1129	You can define a range of keysyms in one shot by providing a I<string>
1008	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1130	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1009	should be a character not used by the strings.	1131	should be a character not used by the strings.
1010		1132
1011	Its usage can be demonstrated by an example:	1133	Its usage can be demonstrated by an example:
1012		1134
1013	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1135	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
…		…
1062	info):	1184	info):
1063		1185
1064	URxvt.keysym.M-C-3: command:\033[8;25;80t	1186	URxvt.keysym.M-C-3: command:\033[8;25;80t
1065	URxvt.keysym.M-C-4: command:\033[8;48;110t	1187	URxvt.keysym.M-C-4: command:\033[8;48;110t
1066		1188
		1189	=item B<perl-ext-common>: I<string>
		1190
1067	=item B<perl-ext>: I<string>	1191	=item B<perl-ext>: I<string>
1068		1192
1069	Colon-separated list of perl extension scripts to use in this terminal	1193	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1194	use in this terminal instance; option B<-pe>.
		1195
		1196	Extension names can be prefixed with a C<-> sign to prohibit using
		1197	them. This can be useful to selectively disable some extensions loaded
		1198	by default, or specified via the C<perl-ext-common> resource. For
		1199	example, C<default,-selection> will use all the default extension except
		1200	C<selection>.
		1201
		1202	Extension names can also be followed by an argument in angle brackets
		1203	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1204	searchable scrollback to Alt/Meta-s). Mentioning the same extension
		1205	multiple times with different arguments will pass multiple arguments to
		1206	the extension.
		1207
1070	instance. Each extension is looked up in the library directories, loaded	1208	Each extension is looked up in the library directories, loaded if
1071	if necessary, and bound to the current terminal instance. If this resource	1209	necessary, and bound to the current terminal instance.
1072	is empty or missing, then the perl interpreter will not be initialized;	1210
1073	option B<-pe>.	1211	If both of these resources are the empty string, then the perl
		1212	interpreter will not be initialized. The idea behind two options is that
		1213	B<perl-ext-common> will be used for extensions that should be available to
		1214	all instances, while B<perl-ext> is used for specific instances.
1074		1215
1075	=item B<perl-eval>: I<string>	1216	=item B<perl-eval>: I<string>
1076		1217
1077	Perl code to be evaluated when all extensions have been registered. See the	1218	Perl code to be evaluated when all extensions have been registered. See
1078	@@RXVT_NAME@@perl(3) manpage.	1219	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
		1220	will be ignored when running setuid/setgid.
1079		1221
1080	=item B<perl-lib>: I<path>	1222	=item B<perl-lib>: I<path>
1081		1223
1082	Colon-separated list of additional directories that hold extension	1224	Colon-separated list of additional directories that hold extension
1083	scripts. When looking for extensions specified by the C<perl> resource,	1225	scripts. When looking for extensions specified by the C<perl> resource,
1084	@@RXVT_NAME@@ will first look in these directories and then in	1226	@@RXVT_NAME@@ will first look in these directories and then in
1085	F<@@RXVT_LIBDIR@@/urxvt/perl/>.	1227	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
		1228	will be ignored when running setuid/setgid.
1086		1229
1087	See the @@RXVT_NAME@@perl(3) manpage.	1230	See the @@RXVT_NAME@@perl(3) manpage.
		1231
		1232	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1233
		1234	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1235	details.
		1236
		1237	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1238
		1239	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1240	for details.
		1241
		1242	=item B<searchable-scrollback:> I<keysym>
		1243
		1244	Sets the hotkey that starts the incremental scrollback buffer search
		1245	(default: C<M-s>).
		1246
		1247	=item B<urlLauncher>: I<string>
		1248
		1249	Specifies the program to be started with a URL argument. Used by the
		1250	C<selection-popup> and C<matcher> perl extensions.
		1251
		1252	=item B<transient-for>: I<windowid>
		1253
		1254	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1255
		1256	=item B<override-redirect>: I<boolean>
		1257
		1258	Compile I<frills>: Sets override-redirect for the terminal window, making
		1259	it almost invisible to window managers; option B<-override-redirect>.
		1260
		1261	=item B<iso14755_52:> I<boolean>
		1262
		1263	Turn on/off ISO 14755 5.2 mode (default enabled).
1088		1264
1089	=back	1265	=back
1090		1266
1091	=head1 THE SCROLLBAR	1267	=head1 THE SCROLLBAR
1092		1268
…		…
1111	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1287	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1112	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1288	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1113	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1289	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1114	respectively.	1290	respectively.
1115		1291
1116	=head1 TEXT SELECTION AND INSERTION	1292	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1117		1293
1118	The behaviour of text selection and insertion mechanism is similar to	1294	The behaviour of text selection and insertion/pasting mechanism is similar
1119	I<xterm>(1).	1295	to I<xterm>(1).
1120		1296
1121	=over 4	1297	=over 4
1122		1298
1123	=item B<Selection>:	1299	=item B<Selecting>:
1124		1300
1125	Left click at the beginning of the region, drag to the end of the region	1301	Left click at the beginning of the region, drag to the end of the region
1126	and release; Right click to extend the marked region; Left double-click	1302	and release; Right click to extend the marked region; Left double-click
1127	to select a word; Left triple-click to select the entire logical line	1303	to select a word; Left triple-click to select the entire logical line
1128	(which can span multiple screen lines), unless modified by resource	1304	(which can span multiple screen lines), unless modified by resource
…		…
1132	(Compile: I<frills>) will create a rectangular selection instead of a	1308	(Compile: I<frills>) will create a rectangular selection instead of a
1133	normal one. In this mode, every selected row becomes its own line in the	1309	normal one. In this mode, every selected row becomes its own line in the
1134	selection, and trailing whitespace is visually underlined and removed from	1310	selection, and trailing whitespace is visually underlined and removed from
1135	the selection.	1311	the selection.
1136		1312
1137	=item B<Insertion>:	1313	=item B<Pasting>:
1138		1314
1139	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1315	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1140	an B<@@RXVT_NAME@@> window causes the current text selection to be	1316	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1141	inserted as if it had been typed on the keyboard.	1317	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1318
		1319	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1320	inserted too.
1142		1321
1143	=back	1322	=back
1144		1323
1145	=head1 CHANGING FONTS	1324	=head1 CHANGING FONTS
1146		1325
1147	Changing fonts (or font sizes, respectively) via the keypad is not yet	1326	Changing fonts (or font sizes, respectively) via the keypad is not yet
1148	supported in rxvt-unicode. Bug me if you need this.	1327	supported in rxvt-unicode. Bug me if you need this.
1149		1328
1150	You can, however, switch fonts at runtime using escape sequences (and	1329	You can, however, switch fonts at runtime using escape sequences, e.g.:
1151	therefore using the menubar), e.g.:
1152		1330
1153	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"	1331	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1332
		1333	You can use keyboard shortcuts, too:
		1334
		1335	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1336	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1154		1337
1155	rxvt-unicode will automatically re-apply these fonts to the output so far.	1338	rxvt-unicode will automatically re-apply these fonts to the output so far.
1156		1339
1157	=head1 ISO 14755 SUPPORT	1340	=head1 ISO 14755 SUPPORT
1158		1341
1159	ISO 14755 is a standard for entering and viewing unicode characters	1342	ISO 14755 is a standard for entering and viewing unicode characters
1160	and character codes using the keyboard. It consists of 4 parts. The	1343	and character codes using the keyboard. It consists of 4 parts. The
1161	first part is available rxvt-unicode has been compiled with	1344	first part is available if rxvt-unicode has been compiled with
1162	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1345	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1163	with C<--enable-iso14755>.	1346	with C<--enable-iso14755>.
1164		1347
1165	=over 4	1348	=over 4
1166		1349
…		…
1186	This mode lets you input characters representing the keycap symbols of	1369	This mode lets you input characters representing the keycap symbols of
1187	your keyboard, if representable in the current locale encoding.	1370	your keyboard, if representable in the current locale encoding.
1188		1371
1189	Start by pressing C<Control> and C<Shift> together, then releasing	1372	Start by pressing C<Control> and C<Shift> together, then releasing
1190	them. The next special key (cursor keys, home etc.) you enter will not	1373	them. The next special key (cursor keys, home etc.) you enter will not
1191	invoke it's usual function but instead will insert the corresponding	1374	invoke its usual function but instead will insert the corresponding
1192	keycap symbol. The symbol will only be entered when the key has been	1375	keycap symbol. The symbol will only be entered when the key has been
1193	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1376	released, otherwise pressing e.g. C<Shift> would enter the symbol for
1194	C<ISO Level 2 Switch>, although your intention might have been to enter a	1377	C<ISO Level 2 Switch>, although your intention might have been to enter a
1195	reverse tab (Shift-Tab).	1378	reverse tab (Shift-Tab).
1196		1379
…		…
1229	=head1 COLORS AND GRAPHICS	1412	=head1 COLORS AND GRAPHICS
1230		1413
1231	In addition to the default foreground and background colours,	1414	In addition to the default foreground and background colours,
1232	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1415	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1233	high-intensity bold/blink versions of the same). Here is a list of the	1416	high-intensity bold/blink versions of the same). Here is a list of the
1234	colours with their B<rgb.txt> names.	1417	colours with their names.
1235		1418
1236	=begin table	1419	=begin table
1237		1420
1238	B<color0> (black) = Black	1421	B<color0> (black) = Black
1239	B<color1> (red) = Red3	1422	B<color1> (red) = Red3
…		…
1259	It is also possible to specify the colour values of B<foreground>,	1442	It is also possible to specify the colour values of B<foreground>,
1260	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1443	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1261	a number 0-15, as a convenient shorthand to reference the colour name of	1444	a number 0-15, as a convenient shorthand to reference the colour name of
1262	color0-color15.	1445	color0-color15.
1263		1446
		1447	In addition to the colours defined above, @@RXVT_NAME@@ offers an
		1448	additional 72 colours. The first 64 of those (with indices 16 to 79)
		1449	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
		1450	16>), followed by 8 additional shades of gray (with indices 80 to 87).
		1451
		1452	Together, all those colours implement the 88 colour xterm colours. Only
		1453	the first 16 can be changed using resources currently, the rest can only
		1454	be changed via command sequences ("escape codes").
		1455
1264	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1456	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1265	always swapping the foreground/background colours. This is in contrast to	1457	always swapping the foreground/background colours. This is in contrast to
1266	I<xterm>(1) where the colours are only swapped if they have not otherwise	1458	I<xterm>(1) where the colours are only swapped if they have not otherwise
1267	been specified. For example,	1459	been specified. For example,
1268		1460
…		…
1273	would yield White on Black, while on I<xterm>(1) it would yield Black	1465	would yield White on Black, while on I<xterm>(1) it would yield Black
1274	on White.	1466	on White.
1275		1467
1276	=back	1468	=back
1277		1469
		1470	=head2 ALPHA CHANNEL SUPPORT
		1471
		1472	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1473	their act together, rxvt-unicode will do it's own alpha channel management:
		1474
		1475	You can prefix any color with an opaquenes percentage enclosed in
		1476	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1477	(0-100) that specifies the opacity of the color, where C<0> is completely
		1478	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1479	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1480	is the recommended format to specify transparency values, and works with
		1481	all ways to specify a colour.
		1482
		1483	For complete control, rxvt-unicode also supports
		1484	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1485	specifications, where the additional C<aaaa> component specifies opacity
		1486	(alpha) values. The minimum value of C<0000> is completely transparent,
		1487	while C<ffff> is completely opaque). The two example colours from
		1488	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1489	C<rgba:0000/ff00/0000/f332>.
		1490
		1491	You probably need to specify B<"-depth 32">, too, to force a visual with
		1492	alpha channels, and have the luck that your X-server uses ARGB pixel
		1493	layout, as X is far from just supporting ARGB visuals out of the box, and
		1494	rxvt-unicode just fudges around.
		1495
		1496	For example, the following selects an almost completely transparent black
		1497	background, and an almost opaque pink foreground:
		1498
		1499	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
		1500
		1501	When not using a background image, then the interpretation of the
		1502	alpha channel is up to your compositing manager (most interpret it as
		1503	transparency of course).
		1504
		1505	When using a background pixmap or pseudo-transparency, then the background
		1506	colour will always behave as if it were completely transparent (so the
		1507	background image shows instead), regardless of how it was specified, while
		1508	other colours will either be transparent as specified (the background
		1509	image will show through) on servers supporting the RENDER extension, or
		1510	fully opaque on servers not supporting the RENDER EXTENSION.
		1511
		1512	Please note that due to bugs in Xft, specifying alpha values might result
		1513	in garbage being displayed when the X-server does not support the RENDER
		1514	extension.
		1515
1278	=head1 ENVIRONMENT	1516	=head1 ENVIRONMENT
1279		1517
1280	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1518	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1281		1519
1282	=over 4	1520	=over 4
1283		1521
1284	=item B<TERM>	1522	=item B<TERM>
1285		1523
1286	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1524	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1287	resources or on the commandline.	1525	resources or on the command line.
1288		1526
1289	=item B<COLORTERM>	1527	=item B<COLORTERM>
1290		1528
1291	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1529	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1292	compiled with XPM support, and optionally with the added extension	1530	compiled with background image support, and optionally with the added
1293	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1531	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1532	screen.
1294		1533
1295	=item B<COLORFGBG>	1534	=item B<COLORFGBG>
1296		1535
1297	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1536	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1298	the colour code used as default foreground/text colour (or the string	1537	the colour code used as default foreground/text colour (or the string
1299	C<default> to indicate that the default-colour escape sequence is to be	1538	C<default> to indicate that the default-colour escape sequence is to be
1300	used), C<bg> is the colour code used as default background colour (or the	1539	used), C<bg> is the colour code used as default background colour (or the
1301	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1540	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1302	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1541	was compiled with background image support. Libraries like C<ncurses>
1303	(and do) use this information to optimize screen output.	1542	and C<slang> can (and do) use this information to optimize screen output.
1304		1543
1305	=item B<WINDOWID>	1544	=item B<WINDOWID>
1306		1545
1307	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1546	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1308	window, which usually has subwindows for the scrollbar, the terminal	1547	window, which usually has subwindows for the scrollbar, the terminal
…		…
1314	C<--with-terminfo=PATH>.	1553	C<--with-terminfo=PATH>.
1315		1554
1316	=item B<DISPLAY>	1555	=item B<DISPLAY>
1317		1556
1318	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1557	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1319	display in it's child processes.	1558	display in its child processes.
1320		1559
1321	=item B<SHELL>	1560	=item B<SHELL>
1322		1561
1323	The shell to be used for command execution, defaults to C</bin/sh>.	1562	The shell to be used for command execution, defaults to C</bin/sh>.
1324
1325	=item B<RXVTPATH>
1326
1327	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1328	files.
1329
1330	=item B<PATH>
1331
1332	Used in the same way as C<RXVTPATH>.
1333		1563
1334	=item B<RXVT_SOCKET>	1564	=item B<RXVT_SOCKET>
1335		1565
1336	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1566	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1337	@@RXVT_NAME@@d(1).	1567	@@RXVT_NAME@@d(1).
…		…
1375		1605
1376	=item Project Coordinator	1606	=item Project Coordinator
1377		1607
1378	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1608	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1379		1609
1380	L<http://software.schmorp.de/#rxvt-unicode>	1610	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1381		1611
1382	=back	1612	=back
1383		1613
1384	=head1 AUTHORS	1614	=head1 AUTHORS
1385		1615
…		…
1407		1637
1408	Project Coordinator (changes.txt 2.21a to 2.4.5)	1638	Project Coordinator (changes.txt 2.21a to 2.4.5)
1409		1639
1410	=item Geoff Wing L<< <gcw@pobox.com> >>	1640	=item Geoff Wing L<< <gcw@pobox.com> >>
1411		1641
1412	Rewrote screen display and text selection routines. Project Coordinator	1642	Rewrote screen display and text selection routines.
		1643
1413	(changes.txt 2.4.6 - rxvt-unicode)	1644	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1414		1645
1415	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1646	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1416		1647
1417	Forked rxvt-unicode, rewrote most of the display code and internal	1648	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1418	character handling to store text in unicode, improve xterm	1649	extension, random hacks, numerous bugfixes and extensions.
1419	compatibility and apply numerous other bugfixes and extensions.
1420		1650
1421	Project Coordinator (Changes 1.0 -)	1651	Project Coordinator (Changes 1.0 -)
1422		1652
		1653	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1654
		1655	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
		1656
1423	=back	1657	=back
1424		1658

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.83 by root, Tue Jan 3 22:28:07 2006 UTC vs. Revision 1.161 by ayin, Sat Jan 26 14:24:42 2008 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.83 by root, Tue Jan 3 22:28:07 2006 UTC vs.
Revision 1.161 by ayin, Sat Jan 26 14:24:42 2008 UTC