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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.104 by root, Wed Jan 25 13:24:45 2006 UTC vs.
Revision 1.177 by root, Sun May 23 00:48:53 2010 UTC

…		…
12	emulator intended as an I<xterm>(1) replacement for users who do not	12	emulator intended as an I<xterm>(1) replacement for users who do not
13	require features such as Tektronix 4014 emulation and toolkit-style	13	require features such as Tektronix 4014 emulation and toolkit-style
14	configurability. As a result, B<rxvt-unicode> uses much less swap space --	14	configurability. As a result, B<rxvt-unicode> uses much less swap space --
15	a significant advantage on a machine serving many X sessions.	15	a significant advantage on a machine serving many X sessions.
16		16
		17	This document is also available on the World-Wide-Web at
		18	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
		19
17	=head1 FREQUENTLY ASKED QUESTIONS	20	=head1 FREQUENTLY ASKED QUESTIONS
18		21
19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of	22	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20	frequently asked questions and answer to them and some common	23	frequently asked questions and answer to them and some common
21	problems. That document is also accessible on the World-Wide-Web at	24	problems. That document is also accessible on the World-Wide-Web at
22	L<http://cvs.schmorp.de/browse/checkout/rxvt-unicode/doc/rxvt.7.html>.	25	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23		26
24	=head1 RXVT-UNICODE VS. RXVT	27	=head1 RXVT-UNICODE VS. RXVT
25		28
26	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode	29	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27	internally. That means it can store and display most scripts in the	30	internally. That means it can store and display most scripts in the
28	world. Being a terminal emulator, however, some things are very difficult,	31	world. Being a terminal emulator, however, some things are very difficult,
29	especially cursive scripts such as arabic, vertically written scripts	32	especially cursive scripts such as arabic, vertically written scripts
30	like mongolian or scripts requiring extremely complex combining rules,	33	like mongolian or scripts requiring extremely complex combining rules,
31	like tibetan or devenagari. Don't expect pretty output when using these	34	like tibetan or devanagari. Don't expect pretty output when using these
32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	35	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33	fine, though. A somewhat difficult case are left-to-right scripts, such	36	fine, though. A somewhat difficult case are right-to-left scripts, such
34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	37	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35	belong into the application, not the terminal emulator (too many things --	38	belong in the application, not the terminal emulator (too many things --
36	such as cursor-movement while editing -- break otherwise), but that might	39	such as cursor-movement while editing -- break otherwise), but that might
37	change.	40	change.
38		41
39	If you are looking for a terminal that supports more exotic scripts, let	42	If you are looking for a terminal that supports more exotic scripts, let
40	me recommend C<mlterm>, which is a very userfriendly, lean and clean	43	me recommend C<mlterm>, which is a very user friendly, lean and clean
41	terminal emulator. In fact, the reason rxvt-unicode was born was solely	44	terminal emulator. In fact, the reason rxvt-unicode was born was solely
42	because the author couldn't get C<mlterm> to use one font for latin1 and	45	because the author couldn't get C<mlterm> to use one font for latin1 and
43	another for japanese.	46	another for japanese.
44		47
45	Therefore another design rationale was the use of multiple fonts to	48	Therefore another design rationale was the use of multiple fonts to
46	display characters: The idea of a single unicode font which many other	49	display characters: The idea of a single unicode font which many other
47	programs force onto it's users never made sense to me: You should be able	50	programs force onto its users never made sense to me: You should be able
48	to choose any font for any script freely.	51	to choose any font for any script freely.
49		52
50	Apart from that, rxvt-unicode is also much better internationalised than	53	Apart from that, rxvt-unicode is also much better internationalised than
51	it's predecessor, supports things such as XFT and ISO 14755 that are handy	54	its predecessor, supports things such as XFT and ISO 14755 that are handy
52	in i18n-environments, is faster, and has a lot less bugs than the original	55	in i18n-environments, is faster, and has a lot bugs less than the original
53	rxvt. This all in addition to dozens of other small improvements.	56	rxvt. This all in addition to dozens of other small improvements.
54		57
55	It is still faithfully following the original rxvt idea of being lean	58	It is still faithfully following the original rxvt idea of being lean
56	and nice on resources: for example, you can still configure rxvt-unicode	59	and nice on resources: for example, you can still configure rxvt-unicode
57	without most of it's features to get a lean binary. It also comes with	60	without most of its features to get a lean binary. It also comes with
58	a client/daemon pair that lets you open any number of terminal windows	61	a client/daemon pair that lets you open any number of terminal windows
59	from within a single process, which makes startup time very fast and	62	from within a single process, which makes startup time very fast and
60	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and	63	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
61	@@RXVT_NAME@@c(1) (client).	64	@@RXVT_NAME@@c(1) (client).
62		65
63	It also makes technical information about escape sequences (which have	66	It also makes technical information about escape sequences (which have
64	been extended) easier accessible: see @@RXVT_NAME@@(7) for technical	67	been extended) more accessible: see @@RXVT_NAME@@(7) for technical
65	reference documentation (escape sequences etc.).	68	reference documentation (escape sequences etc.).
66		69
67	=head1 OPTIONS	70	=head1 OPTIONS
68		71
69	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed	72	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
…		…
89		92
90	Print out a message describing available options.	93	Print out a message describing available options.
91		94
92	=item B<-display> I<displayname>	95	=item B<-display> I<displayname>
93		96
94	Attempt to open a window on the named X display (B<-d> still	97	Attempt to open a window on the named X display (the older form B<-d>
95	respected). In the absence of this option, the display specified by the	98	is still respected. but deprecated). In the absence of this option, the
96	B<DISPLAY> environment variable is used.	99	display specified by the B<DISPLAY> environment variable is used.
		100
		101	=item B<-depth> I<bitdepth>
		102
		103	Compile I<xft>: Attempt to find a visual with the given bit depth;
		104	resource B<depth>.
		105
		106	[Please note that many X servers (and libXft) are buggy with
		107	respect to C<-depth 32> and/or alpha channels, and will cause all sorts
		108	of graphical corruption. This is harmless, but we can't do anything about
		109	this, so watch out]
97		110
98	=item B<-geometry> I<geom>	111	=item B<-geometry> I<geom>
99		112
100	Window geometry (B<-g> still respected); resource B<geometry>.	113	Window geometry (B<-g> still respected); resource B<geometry>.
101		114
…		…
103		116
104	Turn on/off simulated reverse video; resource B<reverseVideo>.	117	Turn on/off simulated reverse video; resource B<reverseVideo>.
105		118
106	=item B<-j>\|B<+j>	119	=item B<-j>\|B<+j>
107		120
108	Turn on/off jump scrolling; resource B<jumpScroll>.	121	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
109		122
110	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>	123	=item B<-ss>\|B<+ss>
111		124
112	Turn on/off inheriting parent window's pixmap. Alternative form is	125	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
113	B<-tr>; resource B<inheritPixmap>.	126
		127	=item B<-tr>\|B<+tr>
		128
		129	Turn on/off 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 colours 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> - colour 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.
301		357
302	=item B<-override-redirect>	358	=item B<-override-redirect>
303		359
304	Compile I<frills>: Sets override-redirect on the window; resource	360	Compile I<frills>: Sets override-redirect on the window; resource
305	B<override-redirect>.	361	B<override-redirect>.
…		…
313		369
314	=item B<-lsp> I<number>	370	=item B<-lsp> I<number>
315		371
316	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
317	the display. Useful to work around font rendering problems; resource	373	the display. Useful to work around font rendering problems; resource
318	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>.
319		382
320	=item B<-tn> I<termname>	383	=item B<-tn> I<termname>
321		384
322	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
323	B<TERM> environment variable. This terminal type must exist in the	386	B<TERM> environment variable. This terminal type must exist in the
…		…
377	for more info.	440	for more info.
378		441
379	=item B<-tcw>	442	=item B<-tcw>
380		443
381	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
382	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
383	end of the logical line only. resource B<tripleclickwords>.	447	the end of the logical line only. resource B<tripleclickwords>.
384		448
385	=item B<-insecure>	449	=item B<-insecure>
386		450
387	Enable "insecure" mode, which currently enables most of the escape	451	Enable "insecure" mode, which currently enables most of the escape
388	sequences that echo strings. See the resource B<insecure> for more	452	sequences that echo strings. See the resource B<insecure> for more
…		…
409	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@@
410	will not immediately destroy its window when the program executed within	474	will not immediately destroy its window when the program executed within
411	it exits. Instead, it will wait till it is being killed or closed by the	475	it exits. Instead, it will wait till it is being killed or closed by the
412	user; resource B<hold>.	476	user; resource B<hold>.
413		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
414	=item B<-keysym.>I<sym> I<string>	497	=item B<-keysym.>I<sym> I<string>
415		498
416	Remap a key symbol. See resource B<keysym>.	499	Remap a key symbol. See resource B<keysym>.
417		500
418	=item B<-embed> I<windowid>	501	=item B<-embed> I<windowid>
419		502
420	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,
421	which enables applications to easily embed a terminal.	504	which enables applications to easily embed a terminal.
422		505
423	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
424	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
425	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
…		…
428	The window will not be destroyed when @@RXVT_NAME@@ exits.	511	The window will not be destroyed when @@RXVT_NAME@@ exits.
429		512
430	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
431	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
432	can use file descriptors to communicate with the programs within the	515	can use file descriptors to communicate with the programs within the
433	terminal. This works regardless of wether the C<-embed> option was used or	516	terminal. This works regardless of whether the C<-embed> option was used or
434	not.	517	not.
435		518
436	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
437	used (a longer example is in F<doc/embed>):	520	used (a longer example is in F<doc/embed>):
438		521
…		…
443	});	526	});
444		527
445	=item B<-pty-fd> I<file descriptor>	528	=item B<-pty-fd> I<file descriptor>
446		529
447	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
448	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
449	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
450	without having to run a program within it.	533	without having to run a program within it.
451		534
452	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
453	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
454	yourself if you want that.	537	yourself if you want that.
455		538
456	As an extremely special case, specifying C<-1> will completely suppress	539	As an extremely special case, specifying C<-1> will completely suppress
457	pty/tty operations.	540	pty/tty operations, which is probably only useful in conjunction with some
		541	perl extension that manages the terminal.
458		542
459	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
460	longer example is in F<doc/pty-fd>):	544	longer example is in F<doc/pty-fd>):
461		545
462	use IO::Pty;	546	use IO::Pty;
…		…
476	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
477	this terminal instance. See resource B<perl-ext> for details.	561	this terminal instance. See resource B<perl-ext> for details.
478		562
479	=back	563	=back
480		564
481	=head1 RESOURCES (available also as long-options)	565	=head1 RESOURCES
482		566
483	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	567	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
484	options) compiled into your version.	568	options) compiled into your version. All resources are also available as
		569	long-options.
485		570
486	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
487	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
488	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	573	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
489	with later settings overwriting earlier ones:	574	with later settings overwriting earlier ones:
…		…
491	1. system-wide app-defaults file, either locale-dependent OR global	576	1. system-wide app-defaults file, either locale-dependent OR global
492	2. app-defaults file in $XAPPLRESDIR	577	2. app-defaults file in $XAPPLRESDIR
493	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	578	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
494	4. SCREEN_RESOURCES for the current screen	579	4. SCREEN_RESOURCES for the current screen
495	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	580	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		581	6. resources specified via -xrm on the commandline
496		582
497	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
498	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
499	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
500	configured, while the class name B<URxvt> allows resources unique to	586	configured, while the class name B<URxvt> allows resources unique to
…		…
505	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
506	extensions not documented here):	592	extensions not documented here):
507		593
508	=over 4	594	=over 4
509		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
510	=item B<geometry:> I<geom>	608	=item B<geometry:> I<geom>
511		609
512	Create the window with the specified X window geometry [default 80x24];	610	Create the window with the specified X window geometry [default 80x24];
513	option B<-geometry>.	611	option B<-geometry>.
514		612
…		…
527	Use the specified colour for the colour value I<n>, where 0-7	625	Use the specified colour for the colour value I<n>, where 0-7
528	corresponds to low-intensity (normal) colours and 8-15 corresponds to	626	corresponds to low-intensity (normal) colours and 8-15 corresponds to
529	high-intensity (bold = bright foreground, blink = bright background)	627	high-intensity (bold = bright foreground, blink = bright background)
530	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	628	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
531	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	629	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
532	names used are listed in the B<COLORS AND GRAPHICS> section.	630	names used are listed in the B<COLOURS AND GRAPHICS> section.
533		631
534	Colours higher than 15 cannot be set using resources (yet), but can be	632	Colours higher than 15 cannot be set using resources (yet), but can be
535	changed using an escape command (see @@RXVT_NAME@@(7)).	633	changed using an escape command (see @@RXVT_NAME@@(7)).
536		634
537	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	635	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
548	=item B<colorUL:> I<colour>	646	=item B<colorUL:> I<colour>
549		647
550	Use the specified colour to display underlined characters when the	648	Use the specified colour to display underlined characters when the
551	foreground colour is the default.	649	foreground colour is the default.
552		650
553	=item B<colorRV:> I<colour>
554
555	Use the specified colour as the background for reverse video
556	characters.
557
558	=item B<underlineColor:> I<colour>	651	=item B<underlineColor:> I<colour>
559		652
560	If set, use the specified colour as the colour for the underline	653	If set, use the specified colour as the colour for the underline
561	itself. If unset, use the foreground colour.	654	itself. If unset, use the foreground colour.
		655
		656	=item B<highlightColor:> I<colour>
		657
		658	If set, use the specified colour as the background for highlighted
		659	characters. If unset, use reverse video.
		660
		661	=item B<highlightTextColor:> I<colour>
		662
		663	If set and highlightColor is set, use the specified colour as the
		664	foreground for highlighted characters.
562		665
563	=item B<cursorColor:> I<colour>	666	=item B<cursorColor:> I<colour>
564		667
565	Use the specified colour for the cursor. The default is to use the	668	Use the specified colour for the cursor. The default is to use the
566	foreground colour; option B<-cr>.	669	foreground colour; option B<-cr>.
…		…
573		676
574	=item B<reverseVideo:> I<boolean>	677	=item B<reverseVideo:> I<boolean>
575		678
576	B<True>: simulate reverse video by foreground and background colours;	679	B<True>: simulate reverse video by foreground and background colours;
577	option B<-rv>. B<False>: regular screen colours [default]; option	680	option B<-rv>. B<False>: regular screen colours [default]; option
578	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	681	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
579		682
580	=item B<jumpScroll:> I<boolean>	683	=item B<jumpScroll:> I<boolean>
581		684
582	B<True>: specify that jump scrolling should be used. When scrolling	685	B<True>: specify that jump scrolling should be used. When receiving lots
583	quickly, fewer screen updates are performed [default]; option B<-j>.	686	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		687	has been read, resulting in fewer updates while still displaying every
		688	received line; option B<-j>.
		689
584	B<False>: specify that smooth scrolling should be used; option B<+j>.	690	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		691	force a screen refresh on each new line it received; option B<+j>.
585		692
586	=item B<inheritPixmap:> I<boolean>	693	=item B<skipScroll:> I<boolean>
587		694
588	B<True>: make the background inherit the parent windows' pixmap, giving	695	B<True>: (the default) specify that skip scrolling should be used. When
589	artificial transparency. B<False>: do not inherit the parent windows'	696	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
590	pixmap.	697	(around 60 times per second), resulting in far fewer updates. This can
		698	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		699	option B<-ss>.
		700
		701	B<False>: specify that everything is to be displayed, even
		702	if the refresh is too fast for the human eye to read anything (or the
		703	monitor to display anything); option B<+ss>.
		704
		705	=item B<transparent:> I<boolean>
		706
		707	Turn on/off illusion of a transparent window background.
		708
		709	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
		710	future versions.
		711
		712	I<Please address all transparency related issues to Sasha Vasko at
		713	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
591		714
592	=item B<fading:> I<number>	715	=item B<fading:> I<number>
593		716
594	Fade the text by the given percentage when focus is lost; option B<-fade>.	717	Fade the text by the given percentage when focus is lost; option B<-fade>.
595		718
…		…
603	Tint the transparent background pixmap with the given colour; option	726	Tint the transparent background pixmap with the given colour; option
604	B<-tint>.	727	B<-tint>.
605		728
606	=item B<shading:> I<number>	729	=item B<shading:> I<number>
607		730
608	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	731	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
609	image in addition to tinting it.	732	in addition to tinting it; option B<-sh>.
		733
		734	=item B<blendType:> I<string>
		735
		736	Specify background blending type; option B<-blt>.
		737
		738	=item B<blurRadius:> I<number>
		739
		740	Apply gaussian blur with the specified radius to the transparent
		741	background image; option B<-blr>.
		742
		743	=item B<iconFile:> I<file>
		744
		745	Set the application icon pixmap; option B<-icon>.
610		746
611	=item B<scrollColor:> I<colour>	747	=item B<scrollColor:> I<colour>
612		748
613	Use the specified colour for the scrollbar [default #B2B2B2].	749	Use the specified colour for the scrollbar [default #B2B2B2].
614		750
…		…
620	=item B<borderColor:> I<colour>	756	=item B<borderColor:> I<colour>
621		757
622	The colour of the border around the text area and between the scrollbar	758	The colour of the border around the text area and between the scrollbar
623	and the text.	759	and the text.
624		760
625	=item B<backgroundPixmap:> I<file[;geom]>	761	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
626		762
627	Use the specified XPM file (note the `.xpm' extension is optional) for	763	Use the specified image file for the background and also
628	the background and also optionally specify its scaling with a geometry	764	optionally specify its scaling with a geometry string B<WxH+X+Y>,
629	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	765	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
630	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	766	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
631	centre (percent). A scale of 0 displays the image with tiling. A scale	767	centre (percent). A scale of 0 displays the image with tiling. A scale
632	of 1 displays the image without any scaling. A scale of 2 to 9	768	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
633	specifies an integer number of images in that direction. No image will	769	an integer number of images in that direction. No image will be magnified
634	be magnified beyond 10 times its original size. The maximum permitted	770	beyond 10 times its original size. The maximum permitted scale is 1000.
635	scale is 1000. [default 0x0+50+50]	771	Additional operations can be specified after colon B<:op1:op2...>.
		772	Supported operations are:
		773
		774	tile force background image to be tiled and not scaled. Equivalent to 0x0
		775	propscale will scale image keeping proportions
		776	auto will scale image to match window size. Equivalent to 100x100
		777	hscale will scale image horizontally to the window size
		778	vscale will scale image vertically to the window size
		779	scale will scale image to match window size
		780	root will tile image as if it was a root window background, auto-adjusting
		781	whenever terminal window moves
		782
		783	If used in conjunction with B<-tr> option, the specified pixmap will be
		784	blended over transparency image using either alpha-blending, or any
		785	other blending type, specified with B<-blt "type"> option.
636		786
637	=item B<path:> I<path>	787	=item B<path:> I<path>
638		788
639	Specify the colon-delimited search path for finding XPM files.	789	Specify the colon-delimited search path for finding background image files.
640		790
641	=item B<font:> I<fontlist>	791	=item B<font:> I<fontlist>
642		792
643	Select the fonts to be used. This is a comma separated list of font names	793	Select the fonts to be used. This is a comma separated list of font names
644	that are checked in order when trying to find glyphs for characters. The	794	that are checked in order when trying to find glyphs for characters. The
…		…
667	it is named first) and thus defines the character cell grid to be 9 pixels	817	it is named first) and thus defines the character cell grid to be 9 pixels
668	wide and 15 pixels high.	818	wide and 15 pixels high.
669		819
670	The second font is just used to add additional unicode characters not in	820	The second font is just used to add additional unicode characters not in
671	the base font, likewise the third, which is unfortunately non-bold, but	821	the base font, likewise the third, which is unfortunately non-bold, but
672	the bold version of the font does contain less characters, so this is a	822	the bold version of the font does contain fewer characters, so this is a
673	useful supplement.	823	useful supplement.
674		824
675	The third font is an Xft font with aliasing turned off, and the characters	825	The third font is an Xft font with aliasing turned off, and the characters
676	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	826	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
677	contains other characters, but we are not interested in them.	827	contains other characters, but we are not interested in them.
…		…
701	text font will being used for the given style.	851	text font will being used for the given style.
702		852
703	=item B<intensityStyles:> I<boolean>	853	=item B<intensityStyles:> I<boolean>
704		854
705	When font styles are not enabled, or this option is enabled (B<True>,	855	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	856	option B<-is>, the default), bold/blink font styles imply high
707	intensity foreground/backround colours. Disabling this option (B<False>,	857	intensity foreground/background colours. Disabling this option (B<False>,
708	option B<+is>) disables this behaviour, the high intensity colours are not	858	option B<+is>) disables this behaviour, the high intensity colours are not
709	reachable.	859	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		860
722	=item B<title:> I<string>	861	=item B<title:> I<string>
723		862
724	Set window title string, the default title is the command-line	863	Set window title string, the default title is the command-line
725	specified after the B<-e> option, if any, otherwise the application	864	specified after the B<-e> option, if any, otherwise the application
…		…
734	=item B<mapAlert:> I<boolean>	873	=item B<mapAlert:> I<boolean>
735		874
736	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	875	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].	876	de-iconify (map) on receipt of a bell character [default].
738		877
		878	=item B<urgentOnBell:> I<boolean>
		879
		880	B<True>: set the urgency hint for the wm on receipt of a bell character.
		881	B<False>: do not set the urgency hint [default].
		882
		883	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		884
739	=item B<visualBell:> I<boolean>	885	=item B<visualBell:> I<boolean>
740		886
741	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	887	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
742	B<False>: no visual bell [default]; option B<+vb>.	888	B<False>: no visual bell [default]; option B<+vb>.
743		889
…		…
764	Example:	910	Example:
765		911
766	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	912	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
767		913
768	This creates a new file in your home directory with the screen contents	914	This creates a new file in your home directory with the screen contents
769	everytime you hit C<Print>.	915	every time you hit C<Print>.
		916
		917	=item B<scrollstyle:> I<mode>
		918
		919	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		920	the author's favourite.
770		921
771	=item B<scrollBar:> I<boolean>	922	=item B<scrollBar:> I<boolean>
772		923
773	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	924	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
774	disable the scrollbar; option B<+sb>.	925	disable the scrollbar; option B<+sb>.
…		…
796		947
797	=item B<scrollWithBuffer:> I<boolean>	948	=item B<scrollWithBuffer:> I<boolean>
798		949
799	B<True>: scroll with scrollback buffer when tty receives new lines (and	950	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	951	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
801	with scrollback buffer when tty recieves new lines; option B<+sw>.	952	with scrollback buffer when tty receives new lines; option B<+sw>.
802		953
803	=item B<scrollTtyKeypress:> I<boolean>	954	=item B<scrollTtyKeypress:> I<boolean>
804		955
805	B<True>: scroll to bottom when a non-special key is pressed. Special keys	956	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	957	are those which are intercepted by rxvt-unicode for special handling and
…		…
837	=item B<termName:> I<termname>	988	=item B<termName:> I<termname>
838		989
839	Specifies the terminal type name to be set in the B<TERM> environment	990	Specifies the terminal type name to be set in the B<TERM> environment
840	variable; option B<-tn>.	991	variable; option B<-tn>.
841		992
842	=item B<linespace:> I<number>	993	=item B<lineSpace:> I<number>
843		994
844	Specifies number of lines (pixel height) to insert between each row of	995	Specifies number of lines (pixel height) to insert between each row of
845	the display [default 0]; option B<-lsp>.	996	the display [default 0]; option B<-lsp>.
846		997
847	=item B<meta8:> I<boolean>	998	=item B<meta8:> I<boolean>
…		…
861		1012
862	=item B<cursorBlink:> I<boolean>	1013	=item B<cursorBlink:> I<boolean>
863		1014
864	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1015	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
865	option B<-bc>.	1016	option B<-bc>.
		1017
		1018	=item B<cursorUnderline:> I<boolean>
		1019
		1020	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1021	option B<-uc>.
866		1022
867	=item B<pointerBlank:> I<boolean>	1023	=item B<pointerBlank:> I<boolean>
868		1024
869	B<True>: blank the pointer when a key is pressed or after a set number	1025	B<True>: blank the pointer when a key is pressed or after a set number
870	of seconds of inactivity. B<False>: the pointer is always visible	1026	of seconds of inactivity. B<False>: the pointer is always visible
…		…
896	pressed. If unset it will send the sequence traditionally associated	1052	pressed. If unset it will send the sequence traditionally associated
897	with the B<Execute> key.	1053	with the B<Execute> key.
898		1054
899	=item B<cutchars:> I<string>	1055	=item B<cutchars:> I<string>
900		1056
901	The characters used as delimiters for double-click word selection.	1057	The characters used as delimiters for double-click word selection
		1058	(whitespace delimiting is added automatically if resource is given).
902		1059
903	When the selection extension is in use (the default if compiled in, see	1060	When the perl selection extension is in use (the default if compiled
904	the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters	1061	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
905	will be created (if the resource exists, otherwise, no regex will be	1062	characters will be created (if the resource exists, otherwise, no regex
906	created). In this mode, characters outside ISO-8859-1 can be used.	1063	will be created). In this mode, characters outside ISO-8859-1 can be used.
907		1064
908	When the selection extension is not used, only ISO-8859-1 characters can	1065	When the selection extension is not used, only ISO-8859-1 characters can
909	be used. If not specified, the built-in default is used:	1066	be used. If not specified, the built-in default is used:
910		1067
911	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1068	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
912		1069
913	=item B<preeditType:> I<style>	1070	=item B<preeditType:> I<style>
914		1071
915	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1072	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
916		1073
…		…
970		1127
971	Turn on/off secondary screen (default enabled).	1128	Turn on/off secondary screen (default enabled).
972		1129
973	=item B<secondaryScroll:> I<boolean>	1130	=item B<secondaryScroll:> I<boolean>
974		1131
975	Turn on/off secondary screen scroll (default enabled). If the this	1132	Turn on/off secondary screen scroll (default enabled). If this
976	option is enabled, scrolls on the secondary screen will change the	1133	option is enabled, scrolls on the secondary screen will change the
977	scrollback buffer and switching to/from the secondary screen will	1134	scrollback buffer and, when secondaryScreen is off, switching
978	instead scroll the screen up.	1135	to/from the secondary screen will instead scroll the screen up.
979		1136
980	=item B<hold>: I<boolean>	1137	=item B<hold>: I<boolean>
981		1138
982	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1139	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
983	will not immediately destroy its window when the program executed within	1140	will not immediately destroy its window when the program executed within
984	it exits. Instead, it will wait till it is being killed or closed by the	1141	it exits. Instead, it will wait till it is being killed or closed by the
985	user.	1142	user.
		1143
		1144	=item B<chdir>: I<path>
		1145
		1146	Sets the working directory for the shell (or the command specified via
		1147	B<-e>). The I<path> must be an absolute path and it must exist for
		1148	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1149	directory will be used; option B<-cd>.
986		1150
987	=item B<keysym.>I<sym>: I<string>	1151	=item B<keysym.>I<sym>: I<string>
988		1152
989	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1153	Compile I<frills>: Associate I<string> with keysym I<sym>. The
990	intervening resource name B<keysym.> cannot be omitted.	1154	intervening resource name B<keysym.> cannot be omitted.
…		…
1004	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1168	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1005	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1169	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1006	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1170	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1007	performed in an exact manner; however, the closest match is assured.	1171	performed in an exact manner; however, the closest match is assured.
1008		1172
1009	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1173	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1010	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1174	number), see RESOURCES in C<man 7 X> for futher details.
1011	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1012	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1013	can start or end with whitespace.
1014
1015	Please note that you need to double the C<\> in resource files, as
1016	Xlib itself does it's own de-escaping (you can use C<\033> instead of
1017	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1018	processing).
1019		1175
1020	You can define a range of keysyms in one shot by providing a I<string>	1176	You can define a range of keysyms in one shot by providing a I<string>
1021	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1177	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1022	should be a character not used by the strings.	1178	should be a character not used by the strings.
1023		1179
1024	Its usage can be demonstrated by an example:	1180	Its usage can be demonstrated by an example:
1025		1181
1026	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1182	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
…		…
1037	when Control-Meta-c is being pressed":	1193	when Control-Meta-c is being pressed":
1038		1194
1039	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1195	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1040		1196
1041	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1197	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1042	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1198	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1043	manpage. For example, the F<selection> extension (activated via	1199	manpage. For example, the F<selection> extension (activated via
1044	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1200	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1045		1201
1046	URxvt.keysym.M-C-c: perl:selection:rot13	1202	URxvt.keysym.M-C-c: perl:selection:rot13
1047		1203
…		…
1090	example, C<default,-selection> will use all the default extension except	1246	example, C<default,-selection> will use all the default extension except
1091	C<selection>.	1247	C<selection>.
1092		1248
1093	Extension names can also be followed by an argument in angle brackets	1249	Extension names can also be followed by an argument in angle brackets
1094	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1250	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1095	searchable scorllback to Alt/Meta-s). Mentioning the same extension	1251	searchable scrollback to Alt/Meta-s). Mentioning the same extension
1096	multiple times with different arguments will pass multiple arguments to	1252	multiple times with different arguments will pass multiple arguments to
1097	the extension.	1253	the extension.
1098		1254
1099	Each extension is looked up in the library directories, loaded if	1255	Each extension is looked up in the library directories, loaded if
1100	necessary, and bound to the current terminal instance.	1256	necessary, and bound to the current terminal instance.
…		…
1105	all instances, while B<perl-ext> is used for specific instances.	1261	all instances, while B<perl-ext> is used for specific instances.
1106		1262
1107	=item B<perl-eval>: I<string>	1263	=item B<perl-eval>: I<string>
1108		1264
1109	Perl code to be evaluated when all extensions have been registered. See	1265	Perl code to be evaluated when all extensions have been registered. See
1110	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1266	the @@RXVT_NAME@@perl(3) manpage.
1111	will be ignored when running setuid/setgid.
1112		1267
1113	=item B<perl-lib>: I<path>	1268	=item B<perl-lib>: I<path>
1114		1269
1115	Colon-separated list of additional directories that hold extension	1270	Colon-separated list of additional directories that hold extension
1116	scripts. When looking for extensions specified by the C<perl> resource,	1271	scripts. When looking for extensions specified by the C<perl> resource,
1117	@@RXVT_NAME@@ will first look in these directories and then in	1272	@@RXVT_NAME@@ will first look in these directories and then in
1118	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1273	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1119	will be ignored when running setuid/setgid.
1120		1274
1121	See the @@RXVT_NAME@@perl(3) manpage.	1275	See the @@RXVT_NAME@@perl(3) manpage.
1122		1276
1123	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1277	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1124		1278
…		…
1136	(default: C<M-s>).	1290	(default: C<M-s>).
1137		1291
1138	=item B<urlLauncher>: I<string>	1292	=item B<urlLauncher>: I<string>
1139		1293
1140	Specifies the program to be started with a URL argument. Used by the	1294	Specifies the program to be started with a URL argument. Used by the
1141	C<selection-popup> and C<mark-urls> perl extensions.	1295	C<selection-popup> and C<matcher> perl extensions.
1142		1296
1143	=item B<transient-for>: I<windowid>	1297	=item B<transient-for>: I<windowid>
1144		1298
1145	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.	1299	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1146		1300
1147	=item B<override-redirect>: I<boolean>	1301	=item B<override-redirect>: I<boolean>
1148		1302
1149	Compile I<frills>: Sets override-redirect for the terminal window, making	1303	Compile I<frills>: Sets override-redirect for the terminal window, making
1150	it almost invisible to window managers; option B<-override-redirect>.	1304	it almost invisible to window managers; option B<-override-redirect>.
		1305
		1306	=item B<iso14755:> I<boolean>
		1307
		1308	Turn on/off ISO 14755 (default enabled).
		1309
		1310	=item B<iso14755_52:> I<boolean>
		1311
		1312	Turn on/off ISO 14755 5.2 mode (default enabled).
1151		1313
1152	=back	1314	=back
1153		1315
1154	=head1 THE SCROLLBAR	1316	=head1 THE SCROLLBAR
1155		1317
…		…
1174	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1336	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1175	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1337	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1176	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1338	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1177	respectively.	1339	respectively.
1178		1340
1179	=head1 TEXT SELECTION AND INSERTION	1341	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1180		1342
1181	The behaviour of text selection and insertion mechanism is similar to	1343	The behaviour of text selection and insertion/pasting mechanism is similar
1182	I<xterm>(1).	1344	to I<xterm>(1).
1183		1345
1184	=over 4	1346	=over 4
1185		1347
1186	=item B<Selection>:	1348	=item B<Selecting>:
1187		1349
1188	Left click at the beginning of the region, drag to the end of the region	1350	Left click at the beginning of the region, drag to the end of the region
1189	and release; Right click to extend the marked region; Left double-click	1351	and release; Right click to extend the marked region; Left double-click
1190	to select a word; Left triple-click to select the entire logical line	1352	to select a word; Left triple-click to select the entire logical line
1191	(which can span multiple screen lines), unless modified by resource	1353	(which can span multiple screen lines), unless modified by resource
…		…
1195	(Compile: I<frills>) will create a rectangular selection instead of a	1357	(Compile: I<frills>) will create a rectangular selection instead of a
1196	normal one. In this mode, every selected row becomes its own line in the	1358	normal one. In this mode, every selected row becomes its own line in the
1197	selection, and trailing whitespace is visually underlined and removed from	1359	selection, and trailing whitespace is visually underlined and removed from
1198	the selection.	1360	the selection.
1199		1361
1200	=item B<Insertion>:	1362	=item B<Pasting>:
1201		1363
1202	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>	1364	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1203	window causes the value of the PRIMARY selection (or CLIPBOARD with the	1365	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1204	Meta modifier) to be inserted as if it had been typed on the keyboard.	1366	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1205		1367
1206	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1368	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1207	inserted too.	1369	inserted too.
1208		1370
1209	=back	1371	=back
…		…
1226		1388
1227	=head1 ISO 14755 SUPPORT	1389	=head1 ISO 14755 SUPPORT
1228		1390
1229	ISO 14755 is a standard for entering and viewing unicode characters	1391	ISO 14755 is a standard for entering and viewing unicode characters
1230	and character codes using the keyboard. It consists of 4 parts. The	1392	and character codes using the keyboard. It consists of 4 parts. The
1231	first part is available rxvt-unicode has been compiled with	1393	first part is available if rxvt-unicode has been compiled with
1232	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1394	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1233	with C<--enable-iso14755>.	1395	with C<--enable-iso14755>.
1234		1396
1235	=over 4	1397	=over 4
1236		1398
…		…
1256	This mode lets you input characters representing the keycap symbols of	1418	This mode lets you input characters representing the keycap symbols of
1257	your keyboard, if representable in the current locale encoding.	1419	your keyboard, if representable in the current locale encoding.
1258		1420
1259	Start by pressing C<Control> and C<Shift> together, then releasing	1421	Start by pressing C<Control> and C<Shift> together, then releasing
1260	them. The next special key (cursor keys, home etc.) you enter will not	1422	them. The next special key (cursor keys, home etc.) you enter will not
1261	invoke it's usual function but instead will insert the corresponding	1423	invoke its usual function but instead will insert the corresponding
1262	keycap symbol. The symbol will only be entered when the key has been	1424	keycap symbol. The symbol will only be entered when the key has been
1263	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1425	released, otherwise pressing e.g. C<Shift> would enter the symbol for
1264	C<ISO Level 2 Switch>, although your intention might have been to enter a	1426	C<ISO Level 2 Switch>, although your intention might have been to enter a
1265	reverse tab (Shift-Tab).	1427	reverse tab (Shift-Tab).
1266		1428
…		…
1294	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1456	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1295	it can be seen via the I<who(1)> command, and can accept messages. To	1457	it can be seen via the I<who(1)> command, and can accept messages. To
1296	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1458	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1297	on some systems or setgid to root or to some other group on others.	1459	on some systems or setgid to root or to some other group on others.
1298		1460
1299	=head1 COLORS AND GRAPHICS	1461	=head1 COLOURS AND GRAPHICS
1300		1462
1301	In addition to the default foreground and background colours,	1463	In addition to the default foreground and background colours,
1302	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1464	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1303	high-intensity bold/blink versions of the same). Here is a list of the	1465	high-intensity bold/blink versions of the same). Here is a list of the
1304	colours with their B<rgb.txt> names.	1466	colours with their names.
1305		1467
1306	=begin table	1468	=begin table
1307		1469
1308	B<color0> (black) = Black	1470	B<color0> (black) = Black
1309	B<color1> (red) = Red3	1471	B<color1> (red) = Red3
…		…
1329	It is also possible to specify the colour values of B<foreground>,	1491	It is also possible to specify the colour values of B<foreground>,
1330	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1492	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1331	a number 0-15, as a convenient shorthand to reference the colour name of	1493	a number 0-15, as a convenient shorthand to reference the colour name of
1332	color0-color15.	1494	color0-color15.
1333		1495
		1496	In addition to the colours defined above, @@RXVT_NAME@@ offers an
		1497	additional 72 colours. The first 64 of those (with indices 16 to 79)
		1498	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
		1499	16>), followed by 8 additional shades of gray (with indices 80 to 87).
		1500
		1501	Together, all those colours implement the 88 colour xterm colours. Only
		1502	the first 16 can be changed using resources currently, the rest can only
		1503	be changed via command sequences ("escape codes").
		1504
1334	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1505	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1335	always swapping the foreground/background colours. This is in contrast to	1506	always swapping the foreground/background colours. This is in contrast to
1336	I<xterm>(1) where the colours are only swapped if they have not otherwise	1507	I<xterm>(1) where the colours are only swapped if they have not otherwise
1337	been specified. For example,	1508	been specified. For example,
1338		1509
		1510	@@RXVT_NAME@@ -fg Black -bg White -rv
		1511
		1512	would yield White on Black, while on I<xterm>(1) it would yield Black on
		1513	White.
		1514
		1515	=head2 ALPHA CHANNEL SUPPORT
		1516
		1517	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1518	their act together, rxvt-unicode will do it's own alpha channel management:
		1519
		1520	You can prefix any colour with an opaquenes percentage enclosed in
		1521	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1522	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1523	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1524	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1525	is the recommended format to specify transparency values, and works with
		1526	all ways to specify a colour.
		1527
		1528	For complete control, rxvt-unicode also supports
		1529	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1530	specifications, where the additional C<aaaa> component specifies opacity
		1531	(alpha) values. The minimum value of C<0000> is completely transparent,
		1532	while C<ffff> is completely opaque). The two example colours from
		1533	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1534	C<rgba:0000/ff00/0000/f332>.
		1535
		1536	You probably need to specify B<"-depth 32">, too, to force a visual with
		1537	alpha channels, and have the luck that your X-server uses ARGB pixel
		1538	layout, as X is far from just supporting ARGB visuals out of the box, and
		1539	rxvt-unicode just fudges around.
		1540
		1541	For example, the following selects an almost completely transparent black
		1542	background, and an almost opaque pink foreground:
		1543
		1544	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
		1545
		1546	When not using a background image, then the interpretation of the
		1547	alpha channel is up to your compositing manager (most interpret it as
		1548	transparency of course).
		1549
		1550	When using a background pixmap or pseudo-transparency, then the background
		1551	colour will always behave as if it were completely transparent (so the
		1552	background image shows instead), regardless of how it was specified, while
		1553	other colours will either be transparent as specified (the background
		1554	image will show through) on servers supporting the RENDER extension, or
		1555	fully opaque on servers not supporting the RENDER EXTENSION.
		1556
		1557	Please note that due to bugs in Xft, specifying alpha values might result
		1558	in garbage being displayed when the X-server does not support the RENDER
		1559	extension.
		1560
		1561	=head1 ENVIRONMENT
		1562
		1563	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
		1564
1339	=over 4	1565	=over 4
1340		1566
1341	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
1342
1343	would yield White on Black, while on I<xterm>(1) it would yield Black
1344	on White.
1345
1346	=back
1347
1348	=head1 ENVIRONMENT
1349
1350	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1351
1352	=over 4
1353
1354	=item B<TERM>	1567	=item B<TERM>
1355		1568
1356	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1569	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1357	resources or on the commandline.	1570	resources or on the command line.
1358		1571
1359	=item B<COLORTERM>	1572	=item B<COLORTERM>
1360		1573
1361	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1574	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1362	compiled with XPM support, and optionally with the added extension	1575	compiled with background image support, and optionally with the added
1363	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1576	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1577	screen.
1364		1578
1365	=item B<COLORFGBG>	1579	=item B<COLORFGBG>
1366		1580
1367	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1581	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1368	the colour code used as default foreground/text colour (or the string	1582	the colour code used as default foreground/text colour (or the string
1369	C<default> to indicate that the default-colour escape sequence is to be	1583	C<default> to indicate that the default-colour escape sequence is to be
1370	used), C<bg> is the colour code used as default background colour (or the	1584	used), C<bg> is the colour code used as default background colour (or the
1371	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1585	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1372	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1586	was compiled with background image support. Libraries like C<ncurses>
1373	(and do) use this information to optimize screen output.	1587	and C<slang> can (and do) use this information to optimize screen output.
1374		1588
1375	=item B<WINDOWID>	1589	=item B<WINDOWID>
1376		1590
1377	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1591	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1378	window, which usually has subwindows for the scrollbar, the terminal	1592	window, which usually has subwindows for the scrollbar, the terminal
…		…
1384	C<--with-terminfo=PATH>.	1598	C<--with-terminfo=PATH>.
1385		1599
1386	=item B<DISPLAY>	1600	=item B<DISPLAY>
1387		1601
1388	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1602	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1389	display in it's child processes.	1603	display in its child processes if C<-display> isn't used to override. It
		1604	defaults to C<:0> if it doesn't exist.
1390		1605
1391	=item B<SHELL>	1606	=item B<SHELL>
1392		1607
1393	The shell to be used for command execution, defaults to C</bin/sh>.	1608	The shell to be used for command execution, defaults to C</bin/sh>.
1394		1609
…		…
1420		1635
1421	=over 4	1636	=over 4
1422		1637
1423	=item B</usr/lib/X11/rgb.txt>	1638	=item B</usr/lib/X11/rgb.txt>
1424		1639
1425	Color names.	1640	Colour names.
1426		1641
1427	=back	1642	=back
1428		1643
1429	=head1 SEE ALSO	1644	=head1 SEE ALSO
1430		1645
…		…
1436		1651
1437	=item Project Coordinator	1652	=item Project Coordinator
1438		1653
1439	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1654	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1440		1655
1441	L<http://software.schmorp.de/#rxvt-unicode>	1656	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1442		1657
1443	=back	1658	=back
1444		1659
1445	=head1 AUTHORS	1660	=head1 AUTHORS
1446		1661
…		…
1469	Project Coordinator (changes.txt 2.21a to 2.4.5)	1684	Project Coordinator (changes.txt 2.21a to 2.4.5)
1470		1685
1471	=item Geoff Wing L<< <gcw@pobox.com> >>	1686	=item Geoff Wing L<< <gcw@pobox.com> >>
1472		1687
1473	Rewrote screen display and text selection routines.	1688	Rewrote screen display and text selection routines.
1474		1689
1475	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1690	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1476		1691
1477	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1692	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1478		1693
1479	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1694	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.104 by root, Wed Jan 25 13:24:45 2006 UTC vs. Revision 1.177 by root, Sun May 23 00:48:53 2010 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.104 by root, Wed Jan 25 13:24:45 2006 UTC vs.
Revision 1.177 by root, Sun May 23 00:48:53 2010 UTC