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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.96 by root, Fri Jan 13 12:40:46 2006 UTC vs.
Revision 1.171 by root, Sat May 30 08:53:48 2009 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 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>.
		186
		187	=item B<-icon> I<file>
		188
		189	Compile I<afterimage>: Use the specified image as application icon. This
		190	is used by many window managers, taskbars and pagers to represent the
		191	application window; resource I<iconFile>.
141		192
142	=item B<-bg> I<colour>	193	=item B<-bg> I<colour>
143		194
144	Window background colour; resource B<background>.	195	Window background colour; resource B<background>.
145		196
146	=item B<-fg> I<colour>	197	=item B<-fg> I<colour>
147		198
148	Window foreground colour; resource B<foreground>.	199	Window foreground colour; resource B<foreground>.
149		200
150	=item B<-pixmap> I<file[;geom]>	201	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
151		202
152	Compile I<XPM>: Specify XPM file for the background and also optionally	203	Compile I<afterimage>: Specify image file for the background and also
153	specify its scaling with a geometry string. Note you may need to	204	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	205	add quotes to avoid special shell interpretation of the C<;> in the
155	command-line; resource B<backgroundPixmap>.	206	command-line; for more details see resource B<backgroundPixmap>.
156		207
157	=item B<-cr> I<colour>	208	=item B<-cr> I<colour>
158		209
159	The cursor colour; resource B<cursorColor>.	210	The cursor colour; resource B<cursorColor>.
160		211
…		…
177	that are checked in order when trying to find glyphs for characters. The	228	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	229	first font defines the cell size for characters; other fonts might be
179	smaller, but not (in general) larger. A (hopefully) reasonable default	230	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.	231	font list is always appended to it. See resource B<font> for more details.
181		232
182	In short, to specify an X11 core font, just specify it's name or prefix it	233	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:>,	234	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184	e.g.:	235	e.g.:
185		236
186	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	237	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	238	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
205	italic> >> characters are to be printed. See resource B<boldItalicFont>	256	italic> >> characters are to be printed. See resource B<boldItalicFont>
206	for details.	257	for details.
207		258
208	=item B<-is>\|B<+is>	259	=item B<-is>\|B<+is>
209		260
210	Compile I<font-styles>: Bold/Italic font styles imply high intensity	261	Compile I<font-styles>: Bold/Blink font styles imply high intensity
211	foreground/background (default). See resource B<intensityStyles> for	262	foreground/background (default). See resource B<intensityStyles> for
212	details.	263	details.
213		264
214	=item B<-name> I<name>	265	=item B<-name> I<name>
215		266
…		…
233		284
234	=item B<-sb>\|B<+sb>	285	=item B<-sb>\|B<+sb>
235		286
236	Turn on/off scrollbar; resource B<scrollBar>.	287	Turn on/off scrollbar; resource B<scrollBar>.
237		288
		289	=item B<-sr>\|B<+sr>
		290
		291	Put scrollbar on right/left; resource B<scrollBar_right>.
		292
		293	=item B<-st>\|B<+st>
		294
		295	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		296	resource B<scrollBar_floating>.
		297
238	=item B<-si>\|B<+si>	298	=item B<-si>\|B<+si>
239		299
240	Turn on/off scroll-to-bottom on TTY output inhibit; resource	300	Turn on/off scroll-to-bottom on TTY output inhibit; resource
241	B<scrollTtyOutput> has opposite effect.	301	B<scrollTtyOutput> has opposite effect.
242		302
…		…
248	=item B<-sw>\|B<+sw>	308	=item B<-sw>\|B<+sw>
249		309
250	Turn on/off scrolling with the scrollback buffer as new lines appear.	310	Turn on/off scrolling with the scrollback buffer as new lines appear.
251	This only takes effect if B<-si> is also given; resource	311	This only takes effect if B<-si> is also given; resource
252	B<scrollWithBuffer>.	312	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		313
263	=item B<-ptab>\|B<+ptab>	314	=item B<-ptab>\|B<+ptab>
264		315
265	If enabled (default), "Horizontal Tab" characters are being stored as	316	If enabled (default), "Horizontal Tab" characters are being stored as
266	actual wide characters in the screen buffer, which makes it possible to	317	actual wide characters in the screen buffer, which makes it possible to
…		…
270		321
271	=item B<-bc>\|B<+bc>	322	=item B<-bc>\|B<+bc>
272		323
273	Blink the cursor; resource B<cursorBlink>.	324	Blink the cursor; resource B<cursorBlink>.
274		325
		326	=item B<-uc>\|B<+uc>
		327
		328	Make the cursor underlined; resource B<cursorUnderline>.
		329
275	=item B<-iconic>	330	=item B<-iconic>
276		331
277	Start iconified, if the window manager supports that option.	332	Start iconified, if the window manager supports that option.
278	Alternative form is B<-ic>.	333	Alternative form is B<-ic>.
279		334
…		…
295		350
296	=item B<-bl>	351	=item B<-bl>
297		352
298	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	353	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	354	if honoured by the WM, the rxvt-unicode window will not have window
300	decorations; resource B<borderLess>.	355	decorations; resource B<borderLess>. If the window manager does not
		356	support MWM hints (e.g. kwin), enables override-redirect mode.
		357
		358	=item B<-override-redirect>
		359
		360	Compile I<frills>: Sets override-redirect on the window; resource
		361	B<override-redirect>.
301		362
302	=item B<-sbg>	363	=item B<-sbg>
303		364
304	Compile I<frills>: Disable the usage of the built-in block graphics/line	365	Compile I<frills>: Disable the usage of the built-in block graphics/line
305	drawing characters and just rely on what the specified fonts provide. Use	366	drawing characters and just rely on what the specified fonts provide. Use
…		…
308		369
309	=item B<-lsp> I<number>	370	=item B<-lsp> I<number>
310		371
311	Compile I<frills>: Lines (pixel height) to insert between each row of	372	Compile I<frills>: Lines (pixel height) to insert between each row of
312	the display. Useful to work around font rendering problems; resource	373	the display. Useful to work around font rendering problems; resource
313	B<linespace>.	374	B<lineSpace>.
		375
		376	=item B<-letsp> I<number>
		377
		378	Compile I<frills>: Amount to adjust the computed character width by
		379	to control overall letter spacing. Negative values will tighten up the
		380	letter spacing, positive values will space letters out more. Useful to
		381	work around odd font metrics; resource B<letterSpace>.
314		382
315	=item B<-tn> I<termname>	383	=item B<-tn> I<termname>
316		384
317	This option specifies the name of the terminal type to be set in the	385	This option specifies the name of the terminal type to be set in the
318	B<TERM> environment variable. This terminal type must exist in the	386	B<TERM> environment variable. This terminal type must exist in the
…		…
372	for more info.	440	for more info.
373		441
374	=item B<-tcw>	442	=item B<-tcw>
375		443
376	Change the meaning of triple-click selection with the left mouse	444	Change the meaning of triple-click selection with the left mouse
		445	button. Only effective when the original (non-perl) selection code is
377	button. Instead of selecting a full line it will extend the selection the	446	in-use. Instead of selecting a full line it will extend the selection to
378	end of the logical line only. resource B<tripleclickwords>.	447	the end of the logical line only. resource B<tripleclickwords>.
379		448
380	=item B<-insecure>	449	=item B<-insecure>
381		450
382	Enable "insecure" mode, which currently enables most of the escape	451	Enable "insecure" mode, which currently enables most of the escape
383	sequences that echo strings. See the resource B<insecure> for more	452	sequences that echo strings. See the resource B<insecure> for more
…		…
404	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	473	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
405	will not immediately destroy its window when the program executed within	474	will not immediately destroy its window when the program executed within
406	it exits. Instead, it will wait till it is being killed or closed by the	475	it exits. Instead, it will wait till it is being killed or closed by the
407	user; resource B<hold>.	476	user; resource B<hold>.
408		477
		478	=item B<-cd> I<path>
		479
		480	Sets the working directory for the shell (or the command specified via
		481	B<-e>). The I<path> must be an absolute path and it must exist for
		482	@@RXVT_NAME@@ to start; resource B<chdir>.
		483
		484	=item B<-xrm> I<string>
		485
		486	Works like the X Toolkit option of the same name, by adding the I<string>
		487	as if it were specified in a resource file. Resource values specified this
		488	way take precedence over all other resource specifications.
		489
		490	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		491	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		492	options can be specified as long-options on the commandline, so use
		493	of B<-xrm> is mostly limited to cases where you want to specify other
		494	resources (e.g. for input methods) or for compatibility with other
		495	programs.
		496
409	=item B<-keysym.>I<sym> I<string>	497	=item B<-keysym.>I<sym> I<string>
410		498
411	Remap a key symbol. See resource B<keysym>.	499	Remap a key symbol. See resource B<keysym>.
412		500
413	=item B<-embed> I<windowid>	501	=item B<-embed> I<windowid>
414		502
415	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,	503	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
416	which enables applications to easily embed a terminal.	504	which enables applications to easily embed a terminal.
417		505
418	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it	506	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
419	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it	507	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
420	quite a bit, so don't expect it to keep some specific state. It's best to	508	quite a bit, so don't expect it to keep some specific state. It's best to
…		…
423	The window will not be destroyed when @@RXVT_NAME@@ exits.	511	The window will not be destroyed when @@RXVT_NAME@@ exits.
424		512
425	It might be useful to know that @@RXVT_NAME@@ will not close file	513	It might be useful to know that @@RXVT_NAME@@ will not close file
426	descriptors passed to it (except for stdin/out/err, of course), so you	514	descriptors passed to it (except for stdin/out/err, of course), so you
427	can use file descriptors to communicate with the programs within the	515	can use file descriptors to communicate with the programs within the
428	terminal. This works regardless of wether the C<-embed> option was used or	516	terminal. This works regardless of whether the C<-embed> option was used or
429	not.	517	not.
430		518
431	Here is a short Gtk2-perl snippet that illustrates how this option can be	519	Here is a short Gtk2-perl snippet that illustrates how this option can be
432	used (a longer example is in F<doc/embed>):	520	used (a longer example is in F<doc/embed>):
433		521
…		…
438	});	526	});
439		527
440	=item B<-pty-fd> I<file descriptor>	528	=item B<-pty-fd> I<file descriptor>
441		529
442	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	530	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
443	pair but instead use the given filehandle as the tty master. This is	531	pair but instead use the given file descriptor as the tty master. This is
444	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator	532	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
445	without having to run a program within it.	533	without having to run a program within it.
446		534
447	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	535	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
448	entries and will not tinker with pty/tty permissions - you have to do that	536	entries and will not tinker with pty/tty permissions - you have to do that
449	yourself if you want that.	537	yourself if you want that.
450		538
451	As an extremely special case, specifying C<-1> will completely suppress	539	As an extremely special case, specifying C<-1> will completely suppress
452	pty/tty operations.	540	pty/tty operations, which is probably only useful in conjunction with some
		541	perl extension that manages the terminal.
453		542
454	Here is a example in perl that illustrates how this option can be used (a	543	Here is a example in perl that illustrates how this option can be used (a
455	longer example is in F<doc/pty-fd>):	544	longer example is in F<doc/pty-fd>):
456		545
457	use IO::Pty;	546	use IO::Pty;
…		…
471	Comma-separated list of perl extension scripts to use (or not to use) in	560	Comma-separated list of perl extension scripts to use (or not to use) in
472	this terminal instance. See resource B<perl-ext> for details.	561	this terminal instance. See resource B<perl-ext> for details.
473		562
474	=back	563	=back
475		564
476	=head1 RESOURCES (available also as long-options)	565	=head1 RESOURCES
477		566
478	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	567	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
479	options) compiled into your version.	568	options) compiled into your version. All resources are also available as
		569	long-options.
480		570
481	You can set and change the resources using X11 tools like B<xrdb>. Many	571	You can set and change the resources using X11 tools like B<xrdb>. Many
482	distribution do also load settings from the B<~/.Xresources> file when X	572	distribution do also load settings from the B<~/.Xresources> file when X
483	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	573	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
484	with later settings overwriting earlier ones:	574	with later settings overwriting earlier ones:
…		…
486	1. system-wide app-defaults file, either locale-dependent OR global	576	1. system-wide app-defaults file, either locale-dependent OR global
487	2. app-defaults file in $XAPPLRESDIR	577	2. app-defaults file in $XAPPLRESDIR
488	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	578	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
489	4. SCREEN_RESOURCES for the current screen	579	4. SCREEN_RESOURCES for the current screen
490	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	580	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		581	6. resources specified via -xrm on the commandline
491		582
492	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	583	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
493	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	584	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
494	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily	585	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
495	configured, while the class name B<URxvt> allows resources unique to	586	configured, while the class name B<URxvt> allows resources unique to
…		…
500	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl	591	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
501	extensions not documented here):	592	extensions not documented here):
502		593
503	=over 4	594	=over 4
504		595
		596	=item B<depth:> I<bitdepth>
		597
		598	Compile I<xft>: Attempt to find a visual with the given bit depth;
		599	option B<-depth>.
		600
		601	=item B<buffered:> I<boolean>
		602
		603	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		604	On some card/driver combination enabling it slightly decreases
		605	performance, on most it greatly helps it. The slowdown is small, so it
		606	should normally be enabled.
		607
505	=item B<geometry:> I<geom>	608	=item B<geometry:> I<geom>
506		609
507	Create the window with the specified X window geometry [default 80x24];	610	Create the window with the specified X window geometry [default 80x24];
508	option B<-geometry>.	611	option B<-geometry>.
509		612
…		…
545	Use the specified colour to display underlined characters when the	648	Use the specified colour to display underlined characters when the
546	foreground colour is the default.	649	foreground colour is the default.
547		650
548	=item B<colorRV:> I<colour>	651	=item B<colorRV:> I<colour>
549		652
550	Use the specified colour as the background for reverse video	653	Use the specified colour as the background for reverse video characters
551	characters.	654	when OPTION_HC is disabled (--disable-frills).
552		655
553	=item B<underlineColor:> I<colour>	656	=item B<underlineColor:> I<colour>
554		657
555	If set, use the specified colour as the colour for the underline	658	If set, use the specified colour as the colour for the underline
556	itself. If unset, use the foreground colour.	659	itself. If unset, use the foreground colour.
…		…
572	option B<-rv>. B<False>: regular screen colours [default]; option	675	option B<-rv>. B<False>: regular screen colours [default]; option
573	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	676	B<+rv>. See note in B<COLORS AND GRAPHICS> section.
574		677
575	=item B<jumpScroll:> I<boolean>	678	=item B<jumpScroll:> I<boolean>
576		679
577	B<True>: specify that jump scrolling should be used. When scrolling	680	B<True>: specify that jump scrolling should be used. When receiving lots
578	quickly, fewer screen updates are performed [default]; option B<-j>.	681	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		682	has been read, resulting in fewer updates while still displaying every
		683	received line; option B<-j>.
		684
579	B<False>: specify that smooth scrolling should be used; option B<+j>.	685	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		686	force a screen refresh on each new line it received; option B<+j>.
580		687
581	=item B<inheritPixmap:> I<boolean>	688	=item B<skipScroll:> I<boolean>
582		689
583	B<True>: make the background inherit the parent windows' pixmap, giving	690	B<True>: (the default) specify that skip scrolling should be used. When
584	artificial transparency. B<False>: do not inherit the parent windows'	691	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
585	pixmap.	692	(around 60 times per second), resulting in far fewer updates. This can
		693	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		694	option B<-ss>.
		695
		696	B<False>: specify that everything is to be displayed, even
		697	if the refresh is too fast for the human eye to read anything (or the
		698	monitor to display anything); option B<+ss>.
		699
		700	=item B<transparent:> I<boolean>
		701
		702	Turn on/off illusion of a transparent window background.
		703
		704	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
		705	future versions.
		706
		707	I<Please address all transparency related issues to Sasha Vasko at
		708	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
586		709
587	=item B<fading:> I<number>	710	=item B<fading:> I<number>
588		711
589	Fade the text by the given percentage when focus is lost; option B<-fade>.	712	Fade the text by the given percentage when focus is lost; option B<-fade>.
590		713
…		…
598	Tint the transparent background pixmap with the given colour; option	721	Tint the transparent background pixmap with the given colour; option
599	B<-tint>.	722	B<-tint>.
600		723
601	=item B<shading:> I<number>	724	=item B<shading:> I<number>
602		725
603	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	726	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
604	image in addition to tinting it.	727	in addition to tinting it; option B<-sh>.
		728
		729	=item B<blendType:> I<string>
		730
		731	Specify background blending type; option B<-blt>.
		732
		733	=item B<blurRadius:> I<number>
		734
		735	Apply gaussian blur with the specified radius to the transparent
		736	background image; option B<-blr>.
		737
		738	=item B<iconFile:> I<file>
		739
		740	Set the application icon pixmap; option B<-icon>.
605		741
606	=item B<scrollColor:> I<colour>	742	=item B<scrollColor:> I<colour>
607		743
608	Use the specified colour for the scrollbar [default #B2B2B2].	744	Use the specified colour for the scrollbar [default #B2B2B2].
609		745
…		…
615	=item B<borderColor:> I<colour>	751	=item B<borderColor:> I<colour>
616		752
617	The colour of the border around the text area and between the scrollbar	753	The colour of the border around the text area and between the scrollbar
618	and the text.	754	and the text.
619		755
620	=item B<backgroundPixmap:> I<file[;geom]>	756	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
621		757
622	Use the specified XPM file (note the `.xpm' extension is optional) for	758	Use the specified image file for the background and also
623	the background and also optionally specify its scaling with a geometry	759	optionally specify its scaling with a geometry string B<WxH+X+Y>,
624	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	760	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
625	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	761	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
626	centre (percent). A scale of 0 displays the image with tiling. A scale	762	centre (percent). A scale of 0 displays the image with tiling. A scale
627	of 1 displays the image without any scaling. A scale of 2 to 9	763	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
628	specifies an integer number of images in that direction. No image will	764	an integer number of images in that direction. No image will be magnified
629	be magnified beyond 10 times its original size. The maximum permitted	765	beyond 10 times its original size. The maximum permitted scale is 1000.
630	scale is 1000. [default 0x0+50+50]	766	Additional operations can be specified after colon B<:op1:op2...>.
		767	Supported operations are:
631		768
632	=item B<menu:> I<file[;tag]>	769	tile force background image to be tiled and not scaled. Equivalent to 0x0
		770	propscale will scale image keeping proportions
		771	auto will scale image to match window size. Equivalent to 100x100
		772	hscale will scale image horizontally to the window size
		773	vscale will scale image vertically to the window size
		774	scale will scale image to match window size
		775	root will tile image as if it was a root window background, auto-adjusting
		776	whenever terminal window moves
633		777
634	Read in the specified menu file (note the `.menu' extension is	778	If used in conjunction with B<-tr> option, the specified pixmap will be
635	optional) and also optionally specify a starting tag to find. See the	779	blended over transparency image using either alpha-blending, or any
636	reference documentation for details on the syntax for the menuBar.	780	other blending type, specified with B<-blt "type"> option.
637		781
638	=item B<path:> I<path>	782	=item B<path:> I<path>
639		783
640	Specify the colon-delimited search path for finding files (XPM and	784	Specify the colon-delimited search path for finding background image files.
641	menus), in addition to the paths specified by the B<RXVTPATH> and
642	B<PATH> environment variables.
643		785
644	=item B<font:> I<fontlist>	786	=item B<font:> I<fontlist>
645		787
646	Select the fonts to be used. This is a comma separated list of font names	788	Select the fonts to be used. This is a comma separated list of font names
647	that are checked in order when trying to find glyphs for characters. The	789	that are checked in order when trying to find glyphs for characters. The
…		…
657	hint currently is C<codeset=codeset-name>, and this is only used for Xft	799	hint currently is C<codeset=codeset-name>, and this is only used for Xft
658	fonts.	800	fonts.
659		801
660	For example, this font resource	802	For example, this font resource
661		803
662	URxvt*font: 9x15bold,\	804	URxvt.font: 9x15bold,\
663	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	805	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
664	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \	806	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
665	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	807	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
666	xft:Code2000:antialias=false	808	xft:Code2000:antialias=false
667		809
…		…
704	text font will being used for the given style.	846	text font will being used for the given style.
705		847
706	=item B<intensityStyles:> I<boolean>	848	=item B<intensityStyles:> I<boolean>
707		849
708	When font styles are not enabled, or this option is enabled (B<True>,	850	When font styles are not enabled, or this option is enabled (B<True>,
709	option B<-is>, the default), bold and italic font styles imply high	851	option B<-is>, the default), bold/blink font styles imply high
710	intensity foreground/backround colours. Disabling this option (B<False>,	852	intensity foreground/background colours. Disabling this option (B<False>,
711	option B<+is>) disables this behaviour, the high intensity colours are not	853	option B<+is>) disables this behaviour, the high intensity colours are not
712	reachable.	854	reachable.
713
714	=item B<selectstyle:> I<mode>
715
716	Set mouse selection style to B<old> which is 2.20, B<oldword> which is
717	xterm style with 2.20 old word selection, or anything else which gives
718	xterm style selection.
719
720	=item B<scrollstyle:> I<mode>
721
722	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
723	the author's favourite.
724		855
725	=item B<title:> I<string>	856	=item B<title:> I<string>
726		857
727	Set window title string, the default title is the command-line	858	Set window title string, the default title is the command-line
728	specified after the B<-e> option, if any, otherwise the application	859	specified after the B<-e> option, if any, otherwise the application
…		…
737	=item B<mapAlert:> I<boolean>	868	=item B<mapAlert:> I<boolean>
738		869
739	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	870	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
740	de-iconify (map) on receipt of a bell character [default].	871	de-iconify (map) on receipt of a bell character [default].
741		872
		873	=item B<urgentOnBell:> I<boolean>
		874
		875	B<True>: set the urgency hint for the wm on receipt of a bell character.
		876	B<False>: do not set the urgency hint [default].
		877
		878	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		879
742	=item B<visualBell:> I<boolean>	880	=item B<visualBell:> I<boolean>
743		881
744	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	882	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
745	B<False>: no visual bell [default]; option B<+vb>.	883	B<False>: no visual bell [default]; option B<+vb>.
746		884
…		…
764		902
765	The string will be interpreted as if typed into the shell as-is.	903	The string will be interpreted as if typed into the shell as-is.
766		904
767	Example:	905	Example:
768		906
769	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	907	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
770		908
771	This creates a new file in your home directory with the screen contents	909	This creates a new file in your home directory with the screen contents
772	everytime you hit C<Print>.	910	every time you hit C<Print>.
		911
		912	=item B<scrollstyle:> I<mode>
		913
		914	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		915	the author's favourite.
773		916
774	=item B<scrollBar:> I<boolean>	917	=item B<scrollBar:> I<boolean>
775		918
776	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	919	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
777	disable the scrollbar; option B<+sb>.	920	disable the scrollbar; option B<+sb>.
…		…
799		942
800	=item B<scrollWithBuffer:> I<boolean>	943	=item B<scrollWithBuffer:> I<boolean>
801		944
802	B<True>: scroll with scrollback buffer when tty receives new lines (and	945	B<True>: scroll with scrollback buffer when tty receives new lines (and
803	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	946	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
804	with scrollback buffer when tty recieves new lines; option B<+sw>.	947	with scrollback buffer when tty receives new lines; option B<+sw>.
805		948
806	=item B<scrollTtyKeypress:> I<boolean>	949	=item B<scrollTtyKeypress:> I<boolean>
807		950
808	B<True>: scroll to bottom when a non-special key is pressed. Special keys	951	B<True>: scroll to bottom when a non-special key is pressed. Special keys
809	are those which are intercepted by rxvt-unicode for special handling and	952	are those which are intercepted by rxvt-unicode for special handling and
…		…
840	=item B<termName:> I<termname>	983	=item B<termName:> I<termname>
841		984
842	Specifies the terminal type name to be set in the B<TERM> environment	985	Specifies the terminal type name to be set in the B<TERM> environment
843	variable; option B<-tn>.	986	variable; option B<-tn>.
844		987
845	=item B<linespace:> I<number>	988	=item B<lineSpace:> I<number>
846		989
847	Specifies number of lines (pixel height) to insert between each row of	990	Specifies number of lines (pixel height) to insert between each row of
848	the display [default 0]; option B<-lsp>.	991	the display [default 0]; option B<-lsp>.
849		992
850	=item B<meta8:> I<boolean>	993	=item B<meta8:> I<boolean>
…		…
864		1007
865	=item B<cursorBlink:> I<boolean>	1008	=item B<cursorBlink:> I<boolean>
866		1009
867	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1010	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
868	option B<-bc>.	1011	option B<-bc>.
		1012
		1013	=item B<cursorUnderline:> I<boolean>
		1014
		1015	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1016	option B<-uc>.
869		1017
870	=item B<pointerBlank:> I<boolean>	1018	=item B<pointerBlank:> I<boolean>
871		1019
872	B<True>: blank the pointer when a key is pressed or after a set number	1020	B<True>: blank the pointer when a key is pressed or after a set number
873	of seconds of inactivity. B<False>: the pointer is always visible	1021	of seconds of inactivity. B<False>: the pointer is always visible
…		…
899	pressed. If unset it will send the sequence traditionally associated	1047	pressed. If unset it will send the sequence traditionally associated
900	with the B<Execute> key.	1048	with the B<Execute> key.
901		1049
902	=item B<cutchars:> I<string>	1050	=item B<cutchars:> I<string>
903		1051
904	The characters used as delimiters for double-click word selection. The	1052	The characters used as delimiters for double-click word selection
905	built-in default:	1053	(whitespace delimiting is added automatically if resource is given).
906		1054
		1055	When the perl selection extension is in use (the default if compiled
		1056	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		1057	characters will be created (if the resource exists, otherwise, no regex
		1058	will be created). In this mode, characters outside ISO-8859-1 can be used.
		1059
		1060	When the selection extension is not used, only ISO-8859-1 characters can
		1061	be used. If not specified, the built-in default is used:
		1062
907	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1063	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
908		1064
909	=item B<preeditType:> I<style>	1065	=item B<preeditType:> I<style>
910		1066
911	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1067	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
912		1068
…		…
946	default. (Note that many other terminals, including xterm, have these	1102	default. (Note that many other terminals, including xterm, have these
947	sequences enabled by default, which doesn't make it safer, though).	1103	sequences enabled by default, which doesn't make it safer, though).
948		1104
949	You can enable them by setting this boolean resource or specifying	1105	You can enable them by setting this boolean resource or specifying
950	B<-insecure> as an option. At the moment, this enables display-answer,	1106	B<-insecure> as an option. At the moment, this enables display-answer,
951	locale, findfont, icon label and window title requests as well as dynamic	1107	locale, findfont, icon label and window title requests.
952	menubar dispatch.
953		1108
954	=item B<modifier:> I<modifier>	1109	=item B<modifier:> I<modifier>
955		1110
956	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	1111	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
957	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	1112	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
961		1116
962	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	1117	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
963	character is passed through. It may contain escape values as described	1118	character is passed through. It may contain escape values as described
964	in the entry on B<keysym> following.	1119	in the entry on B<keysym> following.
965		1120
966	=item B<secondaryScreen:> I<bool>	1121	=item B<secondaryScreen:> I<boolean>
967		1122
968	Turn on/off secondary screen (default enabled).	1123	Turn on/off secondary screen (default enabled).
969		1124
970	=item B<secondaryScroll:> I<bool>	1125	=item B<secondaryScroll:> I<boolean>
971		1126
972	Turn on/off secondary screen scroll (default enabled). If the this	1127	Turn on/off secondary screen scroll (default enabled). If this
973	option is enabled, scrolls on the secondary screen will change the	1128	option is enabled, scrolls on the secondary screen will change the
974	scrollback buffer and switching to/from the secondary screen will	1129	scrollback buffer and, when secondaryScreen is off, switching
975	instead scroll the screen up.	1130	to/from the secondary screen will instead scroll the screen up.
976		1131
977	=item B<hold>: I<bool>	1132	=item B<hold>: I<boolean>
978		1133
979	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1134	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
980	will not immediately destroy its window when the program executed within	1135	will not immediately destroy its window when the program executed within
981	it exits. Instead, it will wait till it is being killed or closed by the	1136	it exits. Instead, it will wait till it is being killed or closed by the
982	user.	1137	user.
		1138
		1139	=item B<chdir>: I<path>
		1140
		1141	Sets the working directory for the shell (or the command specified via
		1142	B<-e>). The I<path> must be an absolute path and it must exist for
		1143	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1144	directory will be used; option B<-cd>.
983		1145
984	=item B<keysym.>I<sym>: I<string>	1146	=item B<keysym.>I<sym>: I<string>
985		1147
986	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1148	Compile I<frills>: Associate I<string> with keysym I<sym>. The
987	intervening resource name B<keysym.> cannot be omitted.	1149	intervening resource name B<keysym.> cannot be omitted.
…		…
1001	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1163	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1002	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1164	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1003	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1165	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1004	performed in an exact manner; however, the closest match is assured.	1166	performed in an exact manner; however, the closest match is assured.
1005		1167
1006	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1168	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1007	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1169	number), see RESOURCES in C<man 7 X> for futher details.
1008	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1009	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1010	can start or end with whitespace.
1011
1012	Please note that you need to double the C<\> in resource files, as
1013	Xlib itself does it's own de-escaping (you can use C<\033> instead of
1014	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1015	processing).
1016		1170
1017	You can define a range of keysyms in one shot by providing a I<string>	1171	You can define a range of keysyms in one shot by providing a I<string>
1018	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1172	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1019	should be a character not used by the strings.	1173	should be a character not used by the strings.
1020		1174
1021	Its usage can be demonstrated by an example:	1175	Its usage can be demonstrated by an example:
1022		1176
1023	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1177	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
…		…
1087	example, C<default,-selection> will use all the default extension except	1241	example, C<default,-selection> will use all the default extension except
1088	C<selection>.	1242	C<selection>.
1089		1243
1090	Extension names can also be followed by an argument in angle brackets	1244	Extension names can also be followed by an argument in angle brackets
1091	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1245	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1092	searchable scorllback to Alt/Meta-s). Mentioning the same extension	1246	searchable scrollback to Alt/Meta-s). Mentioning the same extension
1093	multiple times with different arguments will pass multiple arguments to	1247	multiple times with different arguments will pass multiple arguments to
1094	the extension.	1248	the extension.
1095		1249
1096	Each extension is looked up in the library directories, loaded if	1250	Each extension is looked up in the library directories, loaded if
1097	necessary, and bound to the current terminal instance.	1251	necessary, and bound to the current terminal instance.
…		…
1102	all instances, while B<perl-ext> is used for specific instances.	1256	all instances, while B<perl-ext> is used for specific instances.
1103		1257
1104	=item B<perl-eval>: I<string>	1258	=item B<perl-eval>: I<string>
1105		1259
1106	Perl code to be evaluated when all extensions have been registered. See	1260	Perl code to be evaluated when all extensions have been registered. See
1107	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1261	the @@RXVT_NAME@@perl(3) manpage.
1108	will be ignored when running setuid/setgid.
1109		1262
1110	=item B<perl-lib>: I<path>	1263	=item B<perl-lib>: I<path>
1111		1264
1112	Colon-separated list of additional directories that hold extension	1265	Colon-separated list of additional directories that hold extension
1113	scripts. When looking for extensions specified by the C<perl> resource,	1266	scripts. When looking for extensions specified by the C<perl> resource,
1114	@@RXVT_NAME@@ will first look in these directories and then in	1267	@@RXVT_NAME@@ will first look in these directories and then in
1115	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1268	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1116	will be ignored when running setuid/setgid.
1117		1269
1118	See the @@RXVT_NAME@@perl(3) manpage.	1270	See the @@RXVT_NAME@@perl(3) manpage.
1119		1271
1120	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1272	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1121		1273
…		…
1133	(default: C<M-s>).	1285	(default: C<M-s>).
1134		1286
1135	=item B<urlLauncher>: I<string>	1287	=item B<urlLauncher>: I<string>
1136		1288
1137	Specifies the program to be started with a URL argument. Used by the	1289	Specifies the program to be started with a URL argument. Used by the
1138	C<selection-popup> and C<mark-urls> perl extensions.	1290	C<selection-popup> and C<matcher> perl extensions.
1139		1291
1140	=item B<transient-for>: I<windowid>	1292	=item B<transient-for>: I<windowid>
1141		1293
1142	Sets the WM_TRANSIENT_FOR property to the given window iw.	1294	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1295
		1296	=item B<override-redirect>: I<boolean>
		1297
		1298	Compile I<frills>: Sets override-redirect for the terminal window, making
		1299	it almost invisible to window managers; option B<-override-redirect>.
		1300
		1301	=item B<iso14755_52:> I<boolean>
		1302
		1303	Turn on/off ISO 14755 5.2 mode (default enabled).
1143		1304
1144	=back	1305	=back
1145		1306
1146	=head1 THE SCROLLBAR	1307	=head1 THE SCROLLBAR
1147		1308
…		…
1166	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1327	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1167	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1328	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1168	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1329	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1169	respectively.	1330	respectively.
1170		1331
1171	=head1 TEXT SELECTION AND INSERTION	1332	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1172		1333
1173	The behaviour of text selection and insertion mechanism is similar to	1334	The behaviour of text selection and insertion/pasting mechanism is similar
1174	I<xterm>(1).	1335	to I<xterm>(1).
1175		1336
1176	=over 4	1337	=over 4
1177		1338
1178	=item B<Selection>:	1339	=item B<Selecting>:
1179		1340
1180	Left click at the beginning of the region, drag to the end of the region	1341	Left click at the beginning of the region, drag to the end of the region
1181	and release; Right click to extend the marked region; Left double-click	1342	and release; Right click to extend the marked region; Left double-click
1182	to select a word; Left triple-click to select the entire logical line	1343	to select a word; Left triple-click to select the entire logical line
1183	(which can span multiple screen lines), unless modified by resource	1344	(which can span multiple screen lines), unless modified by resource
…		…
1187	(Compile: I<frills>) will create a rectangular selection instead of a	1348	(Compile: I<frills>) will create a rectangular selection instead of a
1188	normal one. In this mode, every selected row becomes its own line in the	1349	normal one. In this mode, every selected row becomes its own line in the
1189	selection, and trailing whitespace is visually underlined and removed from	1350	selection, and trailing whitespace is visually underlined and removed from
1190	the selection.	1351	the selection.
1191		1352
1192	=item B<Insertion>:	1353	=item B<Pasting>:
1193		1354
1194	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1355	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1195	an B<@@RXVT_NAME@@> window causes the current text selection to be	1356	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1196	inserted as if it had been typed on the keyboard.	1357	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1358
		1359	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1360	inserted too.
1197		1361
1198	=back	1362	=back
1199		1363
1200	=head1 CHANGING FONTS	1364	=head1 CHANGING FONTS
1201		1365
1202	Changing fonts (or font sizes, respectively) via the keypad is not yet	1366	Changing fonts (or font sizes, respectively) via the keypad is not yet
1203	supported in rxvt-unicode. Bug me if you need this.	1367	supported in rxvt-unicode. Bug me if you need this.
1204		1368
1205	You can, however, switch fonts at runtime using escape sequences (and	1369	You can, however, switch fonts at runtime using escape sequences, e.g.:
1206	therefore using the menubar), e.g.:
1207		1370
1208	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"	1371	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1372
		1373	You can use keyboard shortcuts, too:
		1374
		1375	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1376	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1209		1377
1210	rxvt-unicode will automatically re-apply these fonts to the output so far.	1378	rxvt-unicode will automatically re-apply these fonts to the output so far.
1211		1379
1212	=head1 ISO 14755 SUPPORT	1380	=head1 ISO 14755 SUPPORT
1213		1381
1214	ISO 14755 is a standard for entering and viewing unicode characters	1382	ISO 14755 is a standard for entering and viewing unicode characters
1215	and character codes using the keyboard. It consists of 4 parts. The	1383	and character codes using the keyboard. It consists of 4 parts. The
1216	first part is available rxvt-unicode has been compiled with	1384	first part is available if rxvt-unicode has been compiled with
1217	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1385	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1218	with C<--enable-iso14755>.	1386	with C<--enable-iso14755>.
1219		1387
1220	=over 4	1388	=over 4
1221		1389
…		…
1241	This mode lets you input characters representing the keycap symbols of	1409	This mode lets you input characters representing the keycap symbols of
1242	your keyboard, if representable in the current locale encoding.	1410	your keyboard, if representable in the current locale encoding.
1243		1411
1244	Start by pressing C<Control> and C<Shift> together, then releasing	1412	Start by pressing C<Control> and C<Shift> together, then releasing
1245	them. The next special key (cursor keys, home etc.) you enter will not	1413	them. The next special key (cursor keys, home etc.) you enter will not
1246	invoke it's usual function but instead will insert the corresponding	1414	invoke its usual function but instead will insert the corresponding
1247	keycap symbol. The symbol will only be entered when the key has been	1415	keycap symbol. The symbol will only be entered when the key has been
1248	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1416	released, otherwise pressing e.g. C<Shift> would enter the symbol for
1249	C<ISO Level 2 Switch>, although your intention might have been to enter a	1417	C<ISO Level 2 Switch>, although your intention might have been to enter a
1250	reverse tab (Shift-Tab).	1418	reverse tab (Shift-Tab).
1251		1419
…		…
1284	=head1 COLORS AND GRAPHICS	1452	=head1 COLORS AND GRAPHICS
1285		1453
1286	In addition to the default foreground and background colours,	1454	In addition to the default foreground and background colours,
1287	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1455	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1288	high-intensity bold/blink versions of the same). Here is a list of the	1456	high-intensity bold/blink versions of the same). Here is a list of the
1289	colours with their B<rgb.txt> names.	1457	colours with their names.
1290		1458
1291	=begin table	1459	=begin table
1292		1460
1293	B<color0> (black) = Black	1461	B<color0> (black) = Black
1294	B<color1> (red) = Red3	1462	B<color1> (red) = Red3
…		…
1314	It is also possible to specify the colour values of B<foreground>,	1482	It is also possible to specify the colour values of B<foreground>,
1315	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1483	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1316	a number 0-15, as a convenient shorthand to reference the colour name of	1484	a number 0-15, as a convenient shorthand to reference the colour name of
1317	color0-color15.	1485	color0-color15.
1318		1486
		1487	In addition to the colours defined above, @@RXVT_NAME@@ offers an
		1488	additional 72 colours. The first 64 of those (with indices 16 to 79)
		1489	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
		1490	16>), followed by 8 additional shades of gray (with indices 80 to 87).
		1491
		1492	Together, all those colours implement the 88 colour xterm colours. Only
		1493	the first 16 can be changed using resources currently, the rest can only
		1494	be changed via command sequences ("escape codes").
		1495
1319	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1496	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1320	always swapping the foreground/background colours. This is in contrast to	1497	always swapping the foreground/background colours. This is in contrast to
1321	I<xterm>(1) where the colours are only swapped if they have not otherwise	1498	I<xterm>(1) where the colours are only swapped if they have not otherwise
1322	been specified. For example,	1499	been specified. For example,
1323		1500
…		…
1328	would yield White on Black, while on I<xterm>(1) it would yield Black	1505	would yield White on Black, while on I<xterm>(1) it would yield Black
1329	on White.	1506	on White.
1330		1507
1331	=back	1508	=back
1332		1509
		1510	=head2 ALPHA CHANNEL SUPPORT
		1511
		1512	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1513	their act together, rxvt-unicode will do it's own alpha channel management:
		1514
		1515	You can prefix any color with an opaquenes percentage enclosed in
		1516	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1517	(0-100) that specifies the opacity of the color, where C<0> is completely
		1518	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1519	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1520	is the recommended format to specify transparency values, and works with
		1521	all ways to specify a colour.
		1522
		1523	For complete control, rxvt-unicode also supports
		1524	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1525	specifications, where the additional C<aaaa> component specifies opacity
		1526	(alpha) values. The minimum value of C<0000> is completely transparent,
		1527	while C<ffff> is completely opaque). The two example colours from
		1528	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1529	C<rgba:0000/ff00/0000/f332>.
		1530
		1531	You probably need to specify B<"-depth 32">, too, to force a visual with
		1532	alpha channels, and have the luck that your X-server uses ARGB pixel
		1533	layout, as X is far from just supporting ARGB visuals out of the box, and
		1534	rxvt-unicode just fudges around.
		1535
		1536	For example, the following selects an almost completely transparent black
		1537	background, and an almost opaque pink foreground:
		1538
		1539	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
		1540
		1541	When not using a background image, then the interpretation of the
		1542	alpha channel is up to your compositing manager (most interpret it as
		1543	transparency of course).
		1544
		1545	When using a background pixmap or pseudo-transparency, then the background
		1546	colour will always behave as if it were completely transparent (so the
		1547	background image shows instead), regardless of how it was specified, while
		1548	other colours will either be transparent as specified (the background
		1549	image will show through) on servers supporting the RENDER extension, or
		1550	fully opaque on servers not supporting the RENDER EXTENSION.
		1551
		1552	Please note that due to bugs in Xft, specifying alpha values might result
		1553	in garbage being displayed when the X-server does not support the RENDER
		1554	extension.
		1555
1333	=head1 ENVIRONMENT	1556	=head1 ENVIRONMENT
1334		1557
1335	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1558	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1336		1559
1337	=over 4	1560	=over 4
1338		1561
1339	=item B<TERM>	1562	=item B<TERM>
1340		1563
1341	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1564	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1342	resources or on the commandline.	1565	resources or on the command line.
1343		1566
1344	=item B<COLORTERM>	1567	=item B<COLORTERM>
1345		1568
1346	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1569	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1347	compiled with XPM support, and optionally with the added extension	1570	compiled with background image support, and optionally with the added
1348	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1571	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1572	screen.
1349		1573
1350	=item B<COLORFGBG>	1574	=item B<COLORFGBG>
1351		1575
1352	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1576	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1353	the colour code used as default foreground/text colour (or the string	1577	the colour code used as default foreground/text colour (or the string
1354	C<default> to indicate that the default-colour escape sequence is to be	1578	C<default> to indicate that the default-colour escape sequence is to be
1355	used), C<bg> is the colour code used as default background colour (or the	1579	used), C<bg> is the colour code used as default background colour (or the
1356	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1580	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1357	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1581	was compiled with background image support. Libraries like C<ncurses>
1358	(and do) use this information to optimize screen output.	1582	and C<slang> can (and do) use this information to optimize screen output.
1359		1583
1360	=item B<WINDOWID>	1584	=item B<WINDOWID>
1361		1585
1362	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1586	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1363	window, which usually has subwindows for the scrollbar, the terminal	1587	window, which usually has subwindows for the scrollbar, the terminal
…		…
1369	C<--with-terminfo=PATH>.	1593	C<--with-terminfo=PATH>.
1370		1594
1371	=item B<DISPLAY>	1595	=item B<DISPLAY>
1372		1596
1373	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1597	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1374	display in it's child processes.	1598	display in its child processes if C<-display> isn't used to override. It
		1599	defaults to C<:0> if it doesn't exist.
1375		1600
1376	=item B<SHELL>	1601	=item B<SHELL>
1377		1602
1378	The shell to be used for command execution, defaults to C</bin/sh>.	1603	The shell to be used for command execution, defaults to C</bin/sh>.
1379
1380	=item B<RXVTPATH>
1381
1382	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1383	files.
1384
1385	=item B<PATH>
1386
1387	Used in the same way as C<RXVTPATH>.
1388		1604
1389	=item B<RXVT_SOCKET>	1605	=item B<RXVT_SOCKET>
1390		1606
1391	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1607	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1392	@@RXVT_NAME@@d(1).	1608	@@RXVT_NAME@@d(1).
…		…
1430		1646
1431	=item Project Coordinator	1647	=item Project Coordinator
1432		1648
1433	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1649	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1434		1650
1435	L<http://software.schmorp.de/#rxvt-unicode>	1651	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1436		1652
1437	=back	1653	=back
1438		1654
1439	=head1 AUTHORS	1655	=head1 AUTHORS
1440		1656
…		…
1462		1678
1463	Project Coordinator (changes.txt 2.21a to 2.4.5)	1679	Project Coordinator (changes.txt 2.21a to 2.4.5)
1464		1680
1465	=item Geoff Wing L<< <gcw@pobox.com> >>	1681	=item Geoff Wing L<< <gcw@pobox.com> >>
1466		1682
1467	Rewrote screen display and text selection routines. Project Coordinator	1683	Rewrote screen display and text selection routines.
		1684
1468	(changes.txt 2.4.6 - rxvt-unicode)	1685	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1469		1686
1470	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1687	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1471		1688
1472	Forked rxvt-unicode, rewrote most of the display code and internal	1689	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1473	character handling to store text in unicode, improve xterm	1690	extension, random hacks, numerous bugfixes and extensions.
1474	compatibility and apply numerous other bugfixes and extensions.
1475		1691
1476	Project Coordinator (Changes 1.0 -)	1692	Project Coordinator (Changes 1.0 -)
1477		1693
		1694	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1695
		1696	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
		1697
1478	=back	1698	=back
1479		1699

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.96 by root, Fri Jan 13 12:40:46 2006 UTC vs. Revision 1.171 by root, Sat May 30 08:53:48 2009 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.96 by root, Fri Jan 13 12:40:46 2006 UTC vs.
Revision 1.171 by root, Sat May 30 08:53:48 2009 UTC