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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.58 by root, Wed Feb 16 21:49:36 2005 UTC vs.
Revision 1.170 by root, Sat May 30 08:51:23 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>	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. resource B<fading>.	139	Fade the text by the given percentage when focus is lost. Small values
		140	fade a little only, 100 completely replaces all colours by the fade
		141	colour; resource B<fading>.
		142
		143	=item B<-fadecolor> I<colour>
		144
		145	Fade to this colour when fading is used (see B<-fade>). The default colour
		146	is opaque black. resource B<fadeColor>.
118		147
119	=item B<-tint> I<colour>	148	=item B<-tint> I<colour>
120		149
121	Tint the transparent background pixmap with the given colour when	150	Tint the transparent background pixmap with the given colour when
122	transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>	151	transparency is enabled with B<-tr>. This only works for
		152	non-tiled backgrounds, currently. See also the B<-sh> option that can be
123	option that can be used to brighten or darken the image in addition to	153	used to brighten or darken the image in addition to tinting it.
124	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
		158	I<tintColor>. Example:
125		159
126	=item B<-sh>	160	@@RXVT_NAME@@ -tr -tint blue -sh 40
127		161
		162	=item B<-sh> I<number>
		163
128	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	164	Darken (0 .. 100) or lighten (100 .. 200) the transparent
129	background image in addition to tinting it (i.e. B<-tint> must be	165	background image in addition to (or instead of) tinting it;
130	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>.
131		192
132	=item B<-bg> I<colour>	193	=item B<-bg> I<colour>
133		194
134	Window background colour; resource B<background>.	195	Window background colour; resource B<background>.
135		196
136	=item B<-fg> I<colour>	197	=item B<-fg> I<colour>
137		198
138	Window foreground colour; resource B<foreground>.	199	Window foreground colour; resource B<foreground>.
139		200
140	=item B<-pixmap> I<file[;geom]>	201	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
141		202
142	Compile I<XPM>: Specify XPM file for the background and also optionally	203	Compile I<afterimage>: Specify image file for the background and also
143	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
144	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
145	command-line; resource B<backgroundPixmap>.	206	command-line; for more details see resource B<backgroundPixmap>.
146		207
147	=item B<-cr> I<colour>	208	=item B<-cr> I<colour>
148		209
149	The cursor colour; resource B<cursorColor>.	210	The cursor colour; resource B<cursorColor>.
150		211
…		…
162	resource B<borderColor>.	223	resource B<borderColor>.
163		224
164	=item B<-fn> I<fontlist>	225	=item B<-fn> I<fontlist>
165		226
166	Select the fonts to be used. This is a comma separated list of font names	227	Select the fonts to be used. This is a comma separated list of font names
167	that are used in turn when trying to display Unicode characters. The	228	that are checked in order when trying to find glyphs for characters. The
168	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
169	smaller, but not (in general) larger. A (hopefully) reasonable default	230	smaller, but not (in general) larger. A (hopefully) reasonable default
170	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.
171		232
172	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
173	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:>,
174	e.g.:	235	e.g.:
175		236
176	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	237	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
177	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	238	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
179	See also the question "How does rxvt-unicode choose fonts?" in the FAQ	240	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
180	section of @@RXVT_NAME@@(7).	241	section of @@RXVT_NAME@@(7).
181		242
182	=item B<-fb> I<fontlist>	243	=item B<-fb> I<fontlist>
183		244
184	Compile font-styles: The bold font list to use when bold characters are to	245	Compile I<font-styles>: The bold font list to use when B<bold> characters
185	be printed. See resource B<boldFont> for details.	246	are to be printed. See resource B<boldFont> for details.
186		247
187	=item B<-fi> I<fontlist>	248	=item B<-fi> I<fontlist>
188		249
189	Compile font-styles: The italic font list to use when bold characters are to	250	Compile I<font-styles>: The italic font list to use when I<italic>
190	be printed. See resource B<italicFont> for details.	251	characters are to be printed. See resource B<italicFont> for details.
191		252
192	=item B<-fbi> I<fontlist>	253	=item B<-fbi> I<fontlist>
193		254
194	Compile font-styles: The bold italic font list to use when bold characters are to	255	Compile I<font-styles>: The bold italic font list to use when B<< I<bold
195	be printed. See resource B<boldItalicFont> for details.	256	italic> >> characters are to be printed. See resource B<boldItalicFont>
		257	for details.
		258
		259	=item B<-is>\|B<+is>
		260
		261	Compile I<font-styles>: Bold/Blink font styles imply high intensity
		262	foreground/background (default). See resource B<intensityStyles> for
		263	details.
196		264
197	=item B<-name> I<name>	265	=item B<-name> I<name>
198		266
199	Specify the application name under which resources are to be obtained,	267	Specify the application name under which resources are to be obtained,
200	rather than the default executable file name. Name should not contain	268	rather than the default executable file name. Name should not contain
…		…
216		284
217	=item B<-sb>\|B<+sb>	285	=item B<-sb>\|B<+sb>
218		286
219	Turn on/off scrollbar; resource B<scrollBar>.	287	Turn on/off scrollbar; resource B<scrollBar>.
220		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
221	=item B<-si>\|B<+si>	298	=item B<-si>\|B<+si>
222		299
223	Turn on/off scroll-to-bottom on TTY output inhibit; resource	300	Turn on/off scroll-to-bottom on TTY output inhibit; resource
224	B<scrollTtyOutput> has opposite effect.	301	B<scrollTtyOutput> has opposite effect.
225		302
…		…
231	=item B<-sw>\|B<+sw>	308	=item B<-sw>\|B<+sw>
232		309
233	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.
234	This only takes effect if B<-si> is also given; resource	311	This only takes effect if B<-si> is also given; resource
235	B<scrollWithBuffer>.	312	B<scrollWithBuffer>.
236
237	=item B<-sr>\|B<+sr>
238
239	Put scrollbar on right/left; resource B<scrollBar_right>.
240
241	=item B<-st>\|B<+st>
242
243	Display normal (non XTerm/NeXT) scrollbar without/with a trough;
244	resource B<scrollBar_floating>.
245		313
246	=item B<-ptab>\|B<+ptab>	314	=item B<-ptab>\|B<+ptab>
247		315
248	If enabled (default), "Horizontal Tab" characters are being stored as	316	If enabled (default), "Horizontal Tab" characters are being stored as
249	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
…		…
278		346
279	=item B<-bl>	347	=item B<-bl>
280		348
281	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	349	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
282	if honoured by the WM, the rxvt-unicode window will not have window	350	if honoured by the WM, the rxvt-unicode window will not have window
283	decorations; resource B<borderLess>.	351	decorations; resource B<borderLess>. If the window manager does not
		352	support MWM hints (e.g. kwin), enables override-redirect mode.
		353
		354	=item B<-override-redirect>
		355
		356	Compile I<frills>: Sets override-redirect on the window; resource
		357	B<override-redirect>.
		358
		359	=item B<-sbg>
		360
		361	Compile I<frills>: Disable the usage of the built-in block graphics/line
		362	drawing characters and just rely on what the specified fonts provide. Use
		363	this if you have a good font and want to use its block graphic glyphs;
		364	resource B<skipBuiltinGlyphs>.
284		365
285	=item B<-lsp> I<number>	366	=item B<-lsp> I<number>
286		367
287	Compile I<frills>: Lines (pixel height) to insert between each row of	368	Compile I<frills>: Lines (pixel height) to insert between each row of
288	the display. Useful to work around font rendering problems; resource	369	the display. Useful to work around font rendering problems; resource
289	B<linespace>.	370	B<lineSpace>.
		371
		372	=item B<-letsp> I<number>
		373
		374	Compile I<frills>: Amount to adjust the computed character width by
		375	to control overall letter spacing. Negative values will tighten up the
		376	letter spacing, positive values will space letters out more. Useful to
		377	work around odd font metrics; resource B<letterSpace>.
290		378
291	=item B<-tn> I<termname>	379	=item B<-tn> I<termname>
292		380
293	This option specifies the name of the terminal type to be set in the	381	This option specifies the name of the terminal type to be set in the
294	B<TERM> environment variable. This terminal type must exist in the	382	B<TERM> environment variable. This terminal type must exist in the
…		…
303	given on the command line. If this option is used, it must be the last	391	given on the command line. If this option is used, it must be the last
304	on the command-line. If there is no B<-e> option then the default is to	392	on the command-line. If there is no B<-e> option then the default is to
305	run the program specified by the B<SHELL> environment variable or,	393	run the program specified by the B<SHELL> environment variable or,
306	failing that, I<sh(1)>.	394	failing that, I<sh(1)>.
307		395
		396	Please note that you must specify a program with arguments. If you want to
		397	run shell commands, you have to specify the shell, like this:
		398
		399	@@RXVT_NAME@@ -e sh -c "shell commands"
		400
308	=item B<-title> I<text>	401	=item B<-title> I<text>
309		402
310	Window title (B<-T> still respected); the default title is the basename	403	Window title (B<-T> still respected); the default title is the basename
311	of the program specified after the B<-e> option, if any, otherwise the	404	of the program specified after the B<-e> option, if any, otherwise the
312	application name; resource B<title>.	405	application name; resource B<title>.
…		…
343	for more info.	436	for more info.
344		437
345	=item B<-tcw>	438	=item B<-tcw>
346		439
347	Change the meaning of triple-click selection with the left mouse	440	Change the meaning of triple-click selection with the left mouse
		441	button. Only effective when the original (non-perl) selection code is
348	button. Instead of selecting a full line it will extend the selection the	442	in-use. Instead of selecting a full line it will extend the selection to
349	end of the logical line only. resource B<tripleclickwords>.	443	the end of the logical line only. resource B<tripleclickwords>.
350		444
351	=item B<-insecure>	445	=item B<-insecure>
352		446
353	Enable "insecure" mode, which currently enables most of the escape	447	Enable "insecure" mode, which currently enables most of the escape
354	sequences that echo strings. See the resource B<insecure> for more	448	sequences that echo strings. See the resource B<insecure> for more
…		…
368	=item B<-ssr>\|B<+ssr>	462	=item B<-ssr>\|B<+ssr>
369		463
370	Turn on/off secondary screen scroll (default enabled); resource	464	Turn on/off secondary screen scroll (default enabled); resource
371	B<secondaryScroll>.	465	B<secondaryScroll>.
372		466
		467	=item B<-hold>\|B<+hold>
		468
		469	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		470	will not immediately destroy its window when the program executed within
		471	it exits. Instead, it will wait till it is being killed or closed by the
		472	user; resource B<hold>.
		473
		474	=item B<-cd> I<path>
		475
		476	Sets the working directory for the shell (or the command specified via
		477	B<-e>). The I<path> must be an absolute path and it must exist for
		478	@@RXVT_NAME@@ to start; resource B<chdir>.
		479
		480	=item B<-xrm> I<string>
		481
		482	Works like the X Toolkit option of the same name, by adding the I<string>
		483	as if it were specified in a resource file. Resource values specified this
		484	way take precedence over all other resource specifications.
		485
		486	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		487	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		488	options can be specified as long-options on the commandline, so use
		489	of B<-xrm> is mostly limited to cases where you want to specify other
		490	resources (e.g. for input methods) or for compatibility with other
		491	programs.
		492
373	=item B<-keysym.>I<sym>: I<string>	493	=item B<-keysym.>I<sym> I<string>
374		494
375	Remap a key symbol. See resource B<keysym>.	495	Remap a key symbol. See resource B<keysym>.
376		496
377	=item B<-embed>: I<windowid>	497	=item B<-embed> I<windowid>
378		498
379	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,	499	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
380	which enables applications to easily embed a terminal.	500	which enables applications to easily embed a terminal.
381		501
382	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it	502	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
383	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it	503	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
384	quite a bit, so don't expect it to keep some specific state. It's best to	504	quite a bit, so don't expect it to keep some specific state. It's best to
…		…
387	The window will not be destroyed when @@RXVT_NAME@@ exits.	507	The window will not be destroyed when @@RXVT_NAME@@ exits.
388		508
389	It might be useful to know that @@RXVT_NAME@@ will not close file	509	It might be useful to know that @@RXVT_NAME@@ will not close file
390	descriptors passed to it (except for stdin/out/err, of course), so you	510	descriptors passed to it (except for stdin/out/err, of course), so you
391	can use file descriptors to communicate with the programs within the	511	can use file descriptors to communicate with the programs within the
392	terminal. This works regardless of wether the C<-embed> option was used or	512	terminal. This works regardless of whether the C<-embed> option was used or
393	not.	513	not.
394		514
		515	Here is a short Gtk2-perl snippet that illustrates how this option can be
		516	used (a longer example is in F<doc/embed>):
		517
		518	my $rxvt = new Gtk2::Socket;
		519	$rxvt->signal_connect_after (realize => sub {
		520	my $xid = $_[0]->window->get_xid;
		521	system "@@RXVT_NAME@@ -embed $xid &";
		522	});
		523
		524	=item B<-pty-fd> I<file descriptor>
		525
		526	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
		527	pair but instead use the given file descriptor as the tty master. This is
		528	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
		529	without having to run a program within it.
		530
		531	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
		532	entries and will not tinker with pty/tty permissions - you have to do that
		533	yourself if you want that.
		534
		535	As an extremely special case, specifying C<-1> will completely suppress
		536	pty/tty operations, which is probably only useful in conjunction with some
		537	perl extension that manages the terminal.
		538
		539	Here is a example in perl that illustrates how this option can be used (a
		540	longer example is in F<doc/pty-fd>):
		541
		542	use IO::Pty;
		543	use Fcntl;
		544
		545	my $pty = new IO::Pty;
		546	fcntl $pty, F_SETFD, 0; # clear close-on-exec
		547	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		548	close $pty;
		549
		550	# now communicate with rxvt
		551	my $slave = $pty->slave;
		552	while (<$slave>) { print $slave "got <$_>\n" }
		553
		554	=item B<-pe> I<string>
		555
		556	Comma-separated list of perl extension scripts to use (or not to use) in
		557	this terminal instance. See resource B<perl-ext> for details.
		558
395	=back	559	=back
396		560
397	=head1 RESOURCES (available also as long-options)	561	=head1 RESOURCES
398		562
399	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	563	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
400	options) compiled into your version.	564	options) compiled into your version. All resources are also available as
		565	long-options.
401		566
402	There are two different methods that @@RXVT_NAME@@ can use to get the	567	You can set and change the resources using X11 tools like B<xrdb>. Many
403	Xresource data: using the X libraries (Xrm*-functions) or internal	568	distribution do also load settings from the B<~/.Xresources> file when X
404	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	569	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
405	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	570	with later settings overwriting earlier ones:
406	resources using X11 tools like B<xrdb>. Many distribution do also load
407	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
408	will consult the following files/resources in order, with later settings
409	overwriting earlier ones:
410		571
411	1. system-wide app-defaults file, either locale-dependent OR global	572	1. system-wide app-defaults file, either locale-dependent OR global
412	2. app-defaults file in $XAPPLRESDIR	573	2. app-defaults file in $XAPPLRESDIR
413	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	574	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
414	4. SCREEN_RESOURCES for the current screen	575	4. SCREEN_RESOURCES for the current screen
415	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	576	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		577	6. resources specified via -xrm on the commandline
416		578
417	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
418	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
419	set in XAPPLOADDIR/URxvt (compile-time defined: usually
420	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
421	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
422	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	579	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
423	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows	580	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
424	resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be	581	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
425	easily configured, while the class name B<URxvt> allows resources	582	configured, while the class name B<URxvt> allows resources unique to
426	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	583	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
427	shared between different B<@@RXVT_NAME@@> configurations. If no	584	configurations. If no resources are specified, suitable defaults will
428	resources are specified, suitable defaults will be used. Command-line	585	be used. Command-line arguments can be used to override resource
429	arguments can be used to override resource settings. The following	586	settings. The following resources are supported (you might want to
430	resources are allowed:	587	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		588	extensions not documented here):
431		589
432	=over 4	590	=over 4
		591
		592	=item B<depth:> I<bitdepth>
		593
		594	Compile I<xft>: Attempt to find a visual with the given bit depth;
		595	option B<-depth>.
		596
		597	=item B<buffered:> I<boolean>
		598
		599	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		600	On some card/driver combination enabling it slightly decreases
		601	performance, on most it greatly helps it. The slowdown is small, so it
		602	should normally be enabled.
433		603
434	=item B<geometry:> I<geom>	604	=item B<geometry:> I<geom>
435		605
436	Create the window with the specified X window geometry [default 80x24];	606	Create the window with the specified X window geometry [default 80x24];
437	option B<-geometry>.	607	option B<-geometry>.
…		…
474	Use the specified colour to display underlined characters when the	644	Use the specified colour to display underlined characters when the
475	foreground colour is the default.	645	foreground colour is the default.
476		646
477	=item B<colorRV:> I<colour>	647	=item B<colorRV:> I<colour>
478		648
479	Use the specified colour as the background for reverse video	649	Use the specified colour as the background for reverse video characters
480	characters.	650	when OPTION_HC is disabled (--disable-frills).
481		651
482	=item B<underlineColor:> I<colour>	652	=item B<underlineColor:> I<colour>
483		653
484	If set, use the specified colour as the colour for the underline	654	If set, use the specified colour as the colour for the underline
485	itself. If unset, use the foreground colour.	655	itself. If unset, use the foreground colour.
…		…
501	option B<-rv>. B<False>: regular screen colours [default]; option	671	option B<-rv>. B<False>: regular screen colours [default]; option
502	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	672	B<+rv>. See note in B<COLORS AND GRAPHICS> section.
503		673
504	=item B<jumpScroll:> I<boolean>	674	=item B<jumpScroll:> I<boolean>
505		675
506	B<True>: specify that jump scrolling should be used. When scrolling	676	B<True>: specify that jump scrolling should be used. When receiving lots
507	quickly, fewer screen updates are performed [default]; option B<-j>.	677	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		678	has been read, resulting in fewer updates while still displaying every
		679	received line; option B<-j>.
		680
508	B<False>: specify that smooth scrolling should be used; option B<+j>.	681	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		682	force a screen refresh on each new line it received; option B<+j>.
509		683
510	=item B<inheritPixmap:> I<boolean>	684	=item B<skipScroll:> I<boolean>
511		685
512	B<True>: make the background inherit the parent windows' pixmap, giving	686	B<True>: (the default) specify that skip scrolling should be used. When
513	artificial transparency. B<False>: do not inherit the parent windows'	687	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
514	pixmap.	688	(around 60 times per second), resulting in far fewer updates. This can
		689	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		690	option B<-ss>.
		691
		692	B<False>: specify that everything is to be displayed, even
		693	if the refresh is too fast for the human eye to read anything (or the
		694	monitor to display anything); option B<+ss>.
		695
		696	=item B<transparent:> I<boolean>
		697
		698	Turn on/off illusion of a transparent window background.
		699
		700	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
		701	future versions.
		702
		703	I<Please address all transparency related issues to Sasha Vasko at
		704	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
515		705
516	=item B<fading:> I<number>	706	=item B<fading:> I<number>
517		707
518	Fade the text by the given percentage when focus is lost.	708	Fade the text by the given percentage when focus is lost; option B<-fade>.
		709
		710	=item B<fadeColor:> I<colour>
		711
		712	Fade to this colour, when fading is used (see B<fading:>). The default
		713	colour is black; option B<-fadecolor>.
519		714
520	=item B<tintColor:> I<colour>	715	=item B<tintColor:> I<colour>
521		716
522	Tint the transparent background pixmap with the given colour.	717	Tint the transparent background pixmap with the given colour; option
		718	B<-tint>.
523		719
524	=item B<shading:> I<number>	720	=item B<shading:> I<number>
525		721
526	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	722	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
527	image in addition to tinting it.	723	in addition to tinting it; option B<-sh>.
		724
		725	=item B<blendType:> I<string>
		726
		727	Specify background blending type; option B<-blt>.
		728
		729	=item B<blurRadius:> I<number>
		730
		731	Apply gaussian blur with the specified radius to the transparent
		732	background image; option B<-blr>.
		733
		734	=item B<iconFile:> I<file>
		735
		736	Set the application icon pixmap; option B<-icon>.
528		737
529	=item B<scrollColor:> I<colour>	738	=item B<scrollColor:> I<colour>
530		739
531	Use the specified colour for the scrollbar [default #B2B2B2].	740	Use the specified colour for the scrollbar [default #B2B2B2].
532		741
533	=item B<troughColor:> I<colour>	742	=item B<troughColor:> I<colour>
534		743
535	Use the specified colour for the scrollbar's trough area [default	744	Use the specified colour for the scrollbar's trough area [default
536	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	745	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
537		746
538	=item B<borderColor:> I<colour>	747	=item B<borderColor:> I<colour>
539		748
540	The colour of the border around the text area and between the scrollbar	749	The colour of the border around the text area and between the scrollbar
541	and the text.	750	and the text.
542		751
543	=item B<backgroundPixmap:> I<file[;geom]>	752	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
544		753
545	Use the specified XPM file (note the `.xpm' extension is optional) for	754	Use the specified image file for the background and also
546	the background and also optionally specify its scaling with a geometry	755	optionally specify its scaling with a geometry string B<WxH+X+Y>,
547	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	756	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
548	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	757	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
549	centre (percent). A scale of 0 displays the image with tiling. A scale	758	centre (percent). A scale of 0 displays the image with tiling. A scale
550	of 1 displays the image without any scaling. A scale of 2 to 9	759	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
551	specifies an integer number of images in that direction. No image will	760	an integer number of images in that direction. No image will be magnified
552	be magnified beyond 10 times its original size. The maximum permitted	761	beyond 10 times its original size. The maximum permitted scale is 1000.
553	scale is 1000. [default 0x0+50+50]	762	Additional operations can be specified after colon B<:op1:op2...>.
		763	Supported operations are:
554		764
555	=item B<menu:> I<file[;tag]>	765	tile force background image to be tiled and not scaled. Equivalent to 0x0
		766	propscale will scale image keeping proportions
		767	auto will scale image to match window size. Equivalent to 100x100
		768	hscale will scale image horizontally to the window size
		769	vscale will scale image vertically to the window size
		770	scale will scale image to match window size
		771	root will tile image as if it was a root window background, auto-adjusting
		772	whenever terminal window moves
556		773
557	Read in the specified menu file (note the `.menu' extension is	774	If used in conjunction with B<-tr> option, the specified pixmap will be
558	optional) and also optionally specify a starting tag to find. See the	775	blended over transparency image using either alpha-blending, or any
559	reference documentation for details on the syntax for the menuBar.	776	other blending type, specified with B<-blt "type"> option.
560		777
561	=item B<path:> I<path>	778	=item B<path:> I<path>
562		779
563	Specify the colon-delimited search path for finding files (XPM and	780	Specify the colon-delimited search path for finding background image files.
564	menus), in addition to the paths specified by the B<RXVTPATH> and
565	B<PATH> environment variables.
566		781
567	=item B<font:> I<fontlist>	782	=item B<font:> I<fontlist>
568		783
569	Select the fonts to be used. This is a comma separated list of font	784	Select the fonts to be used. This is a comma separated list of font names
570	names that are used in turn when trying to display Unicode characters.	785	that are checked in order when trying to find glyphs for characters. The
571	The first font defines the cell size for characters; other fonts might	786	first font defines the cell size for characters; other fonts might be
572	be smaller, but not larger. A reasonable default font list is always	787	smaller, but not (in general) larger. A (hopefully) reasonable default
573	appended to it. option B<-fn>.	788	font list is always appended to it; option B<-fn>.
574		789
575	Each font can either be a standard X11 core font (XLFD) name, with	790	Each font can either be a standard X11 core font (XLFD) name, with
576	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.	791	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
577		792
578	In addition, each font can be prefixed with additional hints and	793	In addition, each font can be prefixed with additional hints and
…		…
580	hint currently is C<codeset=codeset-name>, and this is only used for Xft	795	hint currently is C<codeset=codeset-name>, and this is only used for Xft
581	fonts.	796	fonts.
582		797
583	For example, this font resource	798	For example, this font resource
584		799
585	URxvt*font: 9x15bold,\	800	URxvt.font: 9x15bold,\
586	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	801	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
587	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \	802	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
588	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	803	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
589	xft:Code2000:antialias=false	804	xft:Code2000:antialias=false
590		805
…		…
624	not possible, replacement fonts of the desired shape will be tried.	839	not possible, replacement fonts of the desired shape will be tried.
625		840
626	If set, but empty, then this specific style is disabled and the normal	841	If set, but empty, then this specific style is disabled and the normal
627	text font will being used for the given style.	842	text font will being used for the given style.
628		843
629	=item B<selectstyle:> I<mode>	844	=item B<intensityStyles:> I<boolean>
630		845
631	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	846	When font styles are not enabled, or this option is enabled (B<True>,
632	xterm style with 2.20 old word selection, or anything else which gives	847	option B<-is>, the default), bold/blink font styles imply high
633	xterm style selection.	848	intensity foreground/background colours. Disabling this option (B<False>,
634		849	option B<+is>) disables this behaviour, the high intensity colours are not
635	=item B<scrollstyle:> I<mode>	850	reachable.
636
637	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
638	the author's favourite..
639		851
640	=item B<title:> I<string>	852	=item B<title:> I<string>
641		853
642	Set window title string, the default title is the command-line	854	Set window title string, the default title is the command-line
643	specified after the B<-e> option, if any, otherwise the application	855	specified after the B<-e> option, if any, otherwise the application
…		…
652	=item B<mapAlert:> I<boolean>	864	=item B<mapAlert:> I<boolean>
653		865
654	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	866	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
655	de-iconify (map) on receipt of a bell character [default].	867	de-iconify (map) on receipt of a bell character [default].
656		868
		869	=item B<urgentOnBell:> I<boolean>
		870
		871	B<True>: set the urgency hint for the wm on receipt of a bell character.
		872	B<False>: do not set the urgency hint [default].
		873
		874	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		875
657	=item B<visualBell:> I<boolean>	876	=item B<visualBell:> I<boolean>
658		877
659	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	878	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
660	B<False>: no visual bell [default]; option B<+vb>.	879	B<False>: no visual bell [default]; option B<+vb>.
661		880
…		…
675		894
676	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	895	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
677	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or	896	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
678	B<Shift-Print> to include the scrollback as well.	897	B<Shift-Print> to include the scrollback as well.
679		898
		899	The string will be interpreted as if typed into the shell as-is.
		900
		901	Example:
		902
		903	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		904
		905	This creates a new file in your home directory with the screen contents
		906	every time you hit C<Print>.
		907
		908	=item B<scrollstyle:> I<mode>
		909
		910	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		911	the author's favourite.
		912
680	=item B<scrollBar:> I<boolean>	913	=item B<scrollBar:> I<boolean>
681		914
682	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	915	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
683	disable the scrollbar; option B<+sb>.	916	disable the scrollbar; option B<+sb>.
684		917
…		…
705		938
706	=item B<scrollWithBuffer:> I<boolean>	939	=item B<scrollWithBuffer:> I<boolean>
707		940
708	B<True>: scroll with scrollback buffer when tty receives new lines (and	941	B<True>: scroll with scrollback buffer when tty receives new lines (and
709	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	942	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
710	with scrollback buffer when tty recieves new lines; option B<+sw>.	943	with scrollback buffer when tty receives new lines; option B<+sw>.
711		944
712	=item B<scrollTtyKeypress:> I<boolean>	945	=item B<scrollTtyKeypress:> I<boolean>
713		946
714	B<True>: scroll to bottom when a non-special key is pressed. Special keys	947	B<True>: scroll to bottom when a non-special key is pressed. Special keys
715	are those which are intercepted by rxvt-unicode for special handling and	948	are those which are intercepted by rxvt-unicode for special handling and
…		…
734	=item B<borderLess:> I<boolean>	967	=item B<borderLess:> I<boolean>
735		968
736	Set MWM hints to request a borderless window, i.e. if honoured by the	969	Set MWM hints to request a borderless window, i.e. if honoured by the
737	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.	970	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
738		971
		972	=item B<skipBuiltinGlyphs:> I<boolean>
		973
		974	Compile I<frills>: Disable the usage of the built-in block graphics/line
		975	drawing characters and just rely on what the specified fonts provide. Use
		976	this if you have a good font and want to use its block graphic glyphs;
		977	option B<-sbg>.
		978
739	=item B<termName:> I<termname>	979	=item B<termName:> I<termname>
740		980
741	Specifies the terminal type name to be set in the B<TERM> environment	981	Specifies the terminal type name to be set in the B<TERM> environment
742	variable; option B<-tn>.	982	variable; option B<-tn>.
743		983
744	=item B<linespace:> I<number>	984	=item B<lineSpace:> I<number>
745		985
746	Specifies number of lines (pixel height) to insert between each row of	986	Specifies number of lines (pixel height) to insert between each row of
747	the display [default 0]; option B<-lsp>.	987	the display [default 0]; option B<-lsp>.
748		988
749	=item B<meta8:> I<boolean>	989	=item B<meta8:> I<boolean>
…		…
780		1020
781	Mouse pointer background colour.	1021	Mouse pointer background colour.
782		1022
783	=item B<pointerBlankDelay:> I<number>	1023	=item B<pointerBlankDelay:> I<number>
784		1024
785	Specifies number of seconds before blanking the pointer [default 2].	1025	Specifies number of seconds before blanking the pointer [default 2]. Use a
		1026	large number (e.g. C<987654321>) to effectively disable the timeout.
786		1027
787	=item B<backspacekey:> I<string>	1028	=item B<backspacekey:> I<string>
788		1029
789	The string to send when the backspace key is pressed. If set to B<DEC>	1030	The string to send when the backspace key is pressed. If set to B<DEC>
790	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	1031	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
…		…
797	pressed. If unset it will send the sequence traditionally associated	1038	pressed. If unset it will send the sequence traditionally associated
798	with the B<Execute> key.	1039	with the B<Execute> key.
799		1040
800	=item B<cutchars:> I<string>	1041	=item B<cutchars:> I<string>
801		1042
802	The characters used as delimiters for double-click word selection. The	1043	The characters used as delimiters for double-click word selection
803	built-in default:	1044	(whitespace delimiting is added automatically if resource is given).
804		1045
		1046	When the perl selection extension is in use (the default if compiled
		1047	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		1048	characters will be created (if the resource exists, otherwise, no regex
		1049	will be created). In this mode, characters outside ISO-8859-1 can be used.
		1050
		1051	When the selection extension is not used, only ISO-8859-1 characters can
		1052	be used. If not specified, the built-in default is used:
		1053
805	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1054	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
806		1055
807	=item B<preeditType:> I<style>	1056	=item B<preeditType:> I<style>
808		1057
809	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1058	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
810		1059
…		…
815	=item B<imLocale:> I<name>	1064	=item B<imLocale:> I<name>
816		1065
817	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.	1066	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
818	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the	1067	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
819	input extension to be able to input japanese characters while staying in	1068	input extension to be able to input japanese characters while staying in
820	another locale. option B<-imlocale>.	1069	another locale; option B<-imlocale>.
821		1070
822	=item B<imFont:> I<fontset>	1071	=item B<imFont:> I<fontset>
823		1072
824	Specify the font-set used for XIM styles C<OverTheSpot> or	1073	Specify the font-set used for XIM styles C<OverTheSpot> or
825	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated	1074	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
…		…
830		1079
831	=item B<tripleclickwords:> I<boolean>	1080	=item B<tripleclickwords:> I<boolean>
832		1081
833	Change the meaning of triple-click selection with the left mouse	1082	Change the meaning of triple-click selection with the left mouse
834	button. Instead of selecting a full line it will extend the selection to	1083	button. Instead of selecting a full line it will extend the selection to
835	the end of the logical line only. option B<-tcw>.	1084	the end of the logical line only; option B<-tcw>.
836		1085
837	=item B<insecure:> I<boolean>	1086	=item B<insecure:> I<boolean>
838		1087
839	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	1088	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
840	echo arbitrary strings like the icon name or the locale. This could be	1089	echo arbitrary strings like the icon name or the locale. This could be
841	abused if somebody gets 8-bit-clean access to your display, whether	1090	abused if somebody gets 8-bit-clean access to your display, whether
842	throuh a mail client displaying mail bodies unfiltered or though	1091	through a mail client displaying mail bodies unfiltered or through
843	write(1). Therefore, these sequences are disabled by default. (Note	1092	write(1) or any other means. Therefore, these sequences are disabled by
844	that other terminals, including xterm, have these sequences	1093	default. (Note that many other terminals, including xterm, have these
845	enabled by default). You can enable them by setting this boolean	1094	sequences enabled by default, which doesn't make it safer, though).
846	resource or specifying B<-insecure> as an option. At the moment, this	1095
847	enabled display-answer, locale, findfont, icon label and window title	1096	You can enable them by setting this boolean resource or specifying
848	requests as well as dynamic menubar dispatch.	1097	B<-insecure> as an option. At the moment, this enables display-answer,
		1098	locale, findfont, icon label and window title requests.
849		1099
850	=item B<modifier:> I<modifier>	1100	=item B<modifier:> I<modifier>
851		1101
852	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	1102	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
853	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	1103	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
857		1107
858	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	1108	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
859	character is passed through. It may contain escape values as described	1109	character is passed through. It may contain escape values as described
860	in the entry on B<keysym> following.	1110	in the entry on B<keysym> following.
861		1111
862	=item B<secondaryScreen:> I<bool>	1112	=item B<secondaryScreen:> I<boolean>
863		1113
864	Turn on/off secondary screen (default enabled).	1114	Turn on/off secondary screen (default enabled).
865		1115
866	=item B<secondaryScroll:> I<bool>	1116	=item B<secondaryScroll:> I<boolean>
867		1117
868	Turn on/off secondary screen scroll (default enabled). If the this	1118	Turn on/off secondary screen scroll (default enabled). If this
869	option is enabled, scrolls on the secondary screen will change the	1119	option is enabled, scrolls on the secondary screen will change the
870	scrollback buffer and switching to/from the secondary screen will	1120	scrollback buffer and, when secondaryScreen is off, switching
871	instead scroll the screen up.	1121	to/from the secondary screen will instead scroll the screen up.
		1122
		1123	=item B<hold>: I<boolean>
		1124
		1125	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		1126	will not immediately destroy its window when the program executed within
		1127	it exits. Instead, it will wait till it is being killed or closed by the
		1128	user.
		1129
		1130	=item B<chdir>: I<path>
		1131
		1132	Sets the working directory for the shell (or the command specified via
		1133	B<-e>). The I<path> must be an absolute path and it must exist for
		1134	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1135	directory will be used; option B<-cd>.
872		1136
873	=item B<keysym.>I<sym>: I<string>	1137	=item B<keysym.>I<sym>: I<string>
874		1138
875	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1139	Compile I<frills>: Associate I<string> with keysym I<sym>. The
876	intervening resource name B<keysym.> cannot be omitted.	1140	intervening resource name B<keysym.> cannot be omitted.
…		…
890	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1154	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
891	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1155	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
892	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1156	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
893	performed in an exact manner; however, the closest match is assured.	1157	performed in an exact manner; however, the closest match is assured.
894		1158
895	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1159	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
896	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1160	number), see RESOURCES in C<man 7 X> for futher details.
897	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
898	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
899	can start or end with whitespace.
900
901	Please note that you need to double the C<\> when using
902	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
903	use C<\033> instead of C<\e> (and so on), which will work with both Xt and
904	@@RXVT_NAME@@'s own processing).
905		1161
906	You can define a range of keysyms in one shot by providing a I<string>	1162	You can define a range of keysyms in one shot by providing a I<string>
907	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1163	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
908	should be a character not used by the strings.	1164	should be a character not used by the strings.
909		1165
910	Its usage can be demonstrated by an example:	1166	Its usage can be demonstrated by an example:
911		1167
912	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1168	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
…		…
922	example the following means "change the current locale to C<zh_CN.GBK>	1178	example the following means "change the current locale to C<zh_CN.GBK>
923	when Control-Meta-c is being pressed":	1179	when Control-Meta-c is being pressed":
924		1180
925	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1181	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
926		1182
		1183	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1184	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1185	manpage. For example, the F<selection> extension (activated via
		1186	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1187
		1188	URxvt.keysym.M-C-c: perl:selection:rot13
		1189
		1190	Due the the large number of modifier combinations, a defined key mapping
		1191	will match if at I<at least> the specified identifiers are being set, and
		1192	no other key mappings with those and more bits are being defined. That
		1193	means that defining a key map for C<a> will automatically provide
		1194	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		1195	mappings themselves.
		1196
		1197	Unfortunately, this will override built-in key mappings. For example
		1198	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		1199	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		1200	user-defined keymap using the C<builtin:> replacement:
		1201
		1202	URxvt.keysym.Insert: <my insert key sequence>
		1203	URxvt.keysym.S-Insert: builtin:
		1204
		1205	The first line defines a mapping for C<Insert> and I<any> combination
		1206	of modifiers. The second line re-establishes the default mapping for
		1207	C<Shift-Insert>.
		1208
927	The following example will map Control-Meta-1 and Control-Meta-2 to	1209	The following example will map Control-Meta-1 and Control-Meta-2 to
928	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited	1210	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
929	font-switching at runtime:	1211	font-switching at runtime:
930		1212
931	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1213	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
…		…
934	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1216	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
935	info):	1217	info):
936		1218
937	URxvt.keysym.M-C-3: command:\033[8;25;80t	1219	URxvt.keysym.M-C-3: command:\033[8;25;80t
938	URxvt.keysym.M-C-4: command:\033[8;48;110t	1220	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1221
		1222	=item B<perl-ext-common>: I<string>
		1223
		1224	=item B<perl-ext>: I<string>
		1225
		1226	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1227	use in this terminal instance; option B<-pe>.
		1228
		1229	Extension names can be prefixed with a C<-> sign to prohibit using
		1230	them. This can be useful to selectively disable some extensions loaded
		1231	by default, or specified via the C<perl-ext-common> resource. For
		1232	example, C<default,-selection> will use all the default extension except
		1233	C<selection>.
		1234
		1235	Extension names can also be followed by an argument in angle brackets
		1236	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1237	searchable scrollback to Alt/Meta-s). Mentioning the same extension
		1238	multiple times with different arguments will pass multiple arguments to
		1239	the extension.
		1240
		1241	Each extension is looked up in the library directories, loaded if
		1242	necessary, and bound to the current terminal instance.
		1243
		1244	If both of these resources are the empty string, then the perl
		1245	interpreter will not be initialized. The idea behind two options is that
		1246	B<perl-ext-common> will be used for extensions that should be available to
		1247	all instances, while B<perl-ext> is used for specific instances.
		1248
		1249	=item B<perl-eval>: I<string>
		1250
		1251	Perl code to be evaluated when all extensions have been registered. See
		1252	the @@RXVT_NAME@@perl(3) manpage.
		1253
		1254	=item B<perl-lib>: I<path>
		1255
		1256	Colon-separated list of additional directories that hold extension
		1257	scripts. When looking for extensions specified by the C<perl> resource,
		1258	@@RXVT_NAME@@ will first look in these directories and then in
		1259	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
		1260
		1261	See the @@RXVT_NAME@@perl(3) manpage.
		1262
		1263	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1264
		1265	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1266	details.
		1267
		1268	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1269
		1270	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1271	for details.
		1272
		1273	=item B<searchable-scrollback:> I<keysym>
		1274
		1275	Sets the hotkey that starts the incremental scrollback buffer search
		1276	(default: C<M-s>).
		1277
		1278	=item B<urlLauncher>: I<string>
		1279
		1280	Specifies the program to be started with a URL argument. Used by the
		1281	C<selection-popup> and C<matcher> perl extensions.
		1282
		1283	=item B<transient-for>: I<windowid>
		1284
		1285	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1286
		1287	=item B<override-redirect>: I<boolean>
		1288
		1289	Compile I<frills>: Sets override-redirect for the terminal window, making
		1290	it almost invisible to window managers; option B<-override-redirect>.
		1291
		1292	=item B<iso14755_52:> I<boolean>
		1293
		1294	Turn on/off ISO 14755 5.2 mode (default enabled).
939		1295
940	=back	1296	=back
941		1297
942	=head1 THE SCROLLBAR	1298	=head1 THE SCROLLBAR
943		1299
…		…
962	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1318	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
963	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1319	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
964	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1320	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
965	respectively.	1321	respectively.
966		1322
967	=head1 TEXT SELECTION AND INSERTION	1323	=head1 THE SELECTION: SELECTING AND PASTING TEXT
968		1324
969	The behaviour of text selection and insertion mechanism is similar to	1325	The behaviour of text selection and insertion/pasting mechanism is similar
970	I<xterm>(1).	1326	to I<xterm>(1).
971		1327
972	=over 4	1328	=over 4
973		1329
974	=item B<Selection>:	1330	=item B<Selecting>:
975		1331
976	Left click at the beginning of the region, drag to the end of the region	1332	Left click at the beginning of the region, drag to the end of the region
977	and release; Right click to extend the marked region; Left double-click	1333	and release; Right click to extend the marked region; Left double-click
978	to select a word; Left triple-click to select the entire logical line	1334	to select a word; Left triple-click to select the entire logical line
979	(which can span multiple screen lines), unless modified by resource	1335	(which can span multiple screen lines), unless modified by resource
980	B<tripleclickwords>.	1336	B<tripleclickwords>.
981		1337
982	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1338	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
983	(Compile: I<frills>) will create a rectangular selection instead of a normal	1339	(Compile: I<frills>) will create a rectangular selection instead of a
984	one.	1340	normal one. In this mode, every selected row becomes its own line in the
		1341	selection, and trailing whitespace is visually underlined and removed from
		1342	the selection.
985		1343
986	=item B<Insertion>:	1344	=item B<Pasting>:
987		1345
988	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1346	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
989	an B<@@RXVT_NAME@@> window causes the current text selection to be	1347	window causes the value of the PRIMARY selection (or CLIPBOARD with the
990	inserted as if it had been typed on the keyboard.	1348	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1349
		1350	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1351	inserted too.
991		1352
992	=back	1353	=back
993		1354
994	=head1 CHANGING FONTS	1355	=head1 CHANGING FONTS
995		1356
996	Changing fonts (or font sizes, respectively) via the keypad is not yet	1357	Changing fonts (or font sizes, respectively) via the keypad is not yet
997	supported in rxvt-unicode. Bug me if you need this.	1358	supported in rxvt-unicode. Bug me if you need this.
998		1359
999	You can, however, switch fonts at runtime using escape sequences (and	1360	You can, however, switch fonts at runtime using escape sequences, e.g.:
1000	therefore using the menubar), e.g.:
1001		1361
1002	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1362	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1363
		1364	You can use keyboard shortcuts, too:
		1365
		1366	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1367	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1003		1368
1004	rxvt-unicode will automatically re-apply these fonts to the output so far.	1369	rxvt-unicode will automatically re-apply these fonts to the output so far.
1005		1370
1006	=head1 ISO 14755 SUPPORT	1371	=head1 ISO 14755 SUPPORT
1007		1372
1008	ISO 14755 is a standard for entering and viewing unicode characters	1373	ISO 14755 is a standard for entering and viewing unicode characters
1009	and character codes using the keyboard. It consists of 4 parts. The	1374	and character codes using the keyboard. It consists of 4 parts. The
1010	first part is available rxvt-unicode has been compiled with	1375	first part is available if rxvt-unicode has been compiled with
1011	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1376	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1012	with C<--enable-iso14755>.	1377	with C<--enable-iso14755>.
1013		1378
1014	=over 4	1379	=over 4
1015		1380
…		…
1035	This mode lets you input characters representing the keycap symbols of	1400	This mode lets you input characters representing the keycap symbols of
1036	your keyboard, if representable in the current locale encoding.	1401	your keyboard, if representable in the current locale encoding.
1037		1402
1038	Start by pressing C<Control> and C<Shift> together, then releasing	1403	Start by pressing C<Control> and C<Shift> together, then releasing
1039	them. The next special key (cursor keys, home etc.) you enter will not	1404	them. The next special key (cursor keys, home etc.) you enter will not
1040	invoke it's usual function but instead will insert the corresponding	1405	invoke its usual function but instead will insert the corresponding
1041	keycap symbol. The symbol will only be entered when the key has been	1406	keycap symbol. The symbol will only be entered when the key has been
1042	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1407	released, otherwise pressing e.g. C<Shift> would enter the symbol for
1043	C<ISO Level 2 Switch>, although your intention might have been to enter a	1408	C<ISO Level 2 Switch>, although your intention might have been to enter a
1044	reverse tab (Shift-Tab).	1409	reverse tab (Shift-Tab).
1045		1410
…		…
1078	=head1 COLORS AND GRAPHICS	1443	=head1 COLORS AND GRAPHICS
1079		1444
1080	In addition to the default foreground and background colours,	1445	In addition to the default foreground and background colours,
1081	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1446	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1082	high-intensity bold/blink versions of the same). Here is a list of the	1447	high-intensity bold/blink versions of the same). Here is a list of the
1083	colours with their B<rgb.txt> names.	1448	colours with their names.
1084		1449
1085	=begin table	1450	=begin table
1086		1451
1087	B<color0> (black) = Black	1452	B<color0> (black) = Black
1088	B<color1> (red) = Red3	1453	B<color1> (red) = Red3
…		…
1108	It is also possible to specify the colour values of B<foreground>,	1473	It is also possible to specify the colour values of B<foreground>,
1109	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1474	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1110	a number 0-15, as a convenient shorthand to reference the colour name of	1475	a number 0-15, as a convenient shorthand to reference the colour name of
1111	color0-color15.	1476	color0-color15.
1112		1477
		1478	In addition to the colours defined above, @@RXVT_NAME@@ offers an
		1479	additional 72 colours. The first 64 of those (with indices 16 to 79)
		1480	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
		1481	16>), followed by 8 additional shades of gray (with indices 80 to 87).
		1482
		1483	Together, all those colours implement the 88 colour xterm colours. Only
		1484	the first 16 can be changed using resources currently, the rest can only
		1485	be changed via command sequences ("escape codes").
		1486
1113	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1487	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1114	always swapping the foreground/background colours. This is in contrast to	1488	always swapping the foreground/background colours. This is in contrast to
1115	I<xterm>(1) where the colours are only swapped if they have not otherwise	1489	I<xterm>(1) where the colours are only swapped if they have not otherwise
1116	been specified. For example,	1490	been specified. For example,
1117		1491
…		…
1122	would yield White on Black, while on I<xterm>(1) it would yield Black	1496	would yield White on Black, while on I<xterm>(1) it would yield Black
1123	on White.	1497	on White.
1124		1498
1125	=back	1499	=back
1126		1500
		1501	=head2 ALPHA CHANNEL SUPPORT
		1502
		1503	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1504	their act together, rxvt-unicode will do it's own alpha channel management:
		1505
		1506	You can prefix any color with an opaquenes percentage enclosed in
		1507	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1508	(0-100) that specifies the opacity of the color, where C<0> is completely
		1509	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1510	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1511	is the recommended format to specify transparency values, and works with
		1512	all ways to specify a colour.
		1513
		1514	For complete control, rxvt-unicode also supports
		1515	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1516	specifications, where the additional C<aaaa> component specifies opacity
		1517	(alpha) values. The minimum value of C<0000> is completely transparent,
		1518	while C<ffff> is completely opaque). The two example colours from
		1519	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1520	C<rgba:0000/ff00/0000/f332>.
		1521
		1522	You probably need to specify B<"-depth 32">, too, to force a visual with
		1523	alpha channels, and have the luck that your X-server uses ARGB pixel
		1524	layout, as X is far from just supporting ARGB visuals out of the box, and
		1525	rxvt-unicode just fudges around.
		1526
		1527	For example, the following selects an almost completely transparent black
		1528	background, and an almost opaque pink foreground:
		1529
		1530	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
		1531
		1532	When not using a background image, then the interpretation of the
		1533	alpha channel is up to your compositing manager (most interpret it as
		1534	transparency of course).
		1535
		1536	When using a background pixmap or pseudo-transparency, then the background
		1537	colour will always behave as if it were completely transparent (so the
		1538	background image shows instead), regardless of how it was specified, while
		1539	other colours will either be transparent as specified (the background
		1540	image will show through) on servers supporting the RENDER extension, or
		1541	fully opaque on servers not supporting the RENDER EXTENSION.
		1542
		1543	Please note that due to bugs in Xft, specifying alpha values might result
		1544	in garbage being displayed when the X-server does not support the RENDER
		1545	extension.
		1546
1127	=head1 ENVIRONMENT	1547	=head1 ENVIRONMENT
1128		1548
1129	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1549	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1130		1550
1131	=over 4	1551	=over 4
1132		1552
1133	=item B<TERM>	1553	=item B<TERM>
1134		1554
1135	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1555	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1136	resources or on the commandline.	1556	resources or on the command line.
1137		1557
1138	=item B<COLORTERM>	1558	=item B<COLORTERM>
1139		1559
1140	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1560	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1141	compiled with XPM support, and optionally with the added extension	1561	compiled with background image support, and optionally with the added
1142	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1562	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1563	screen.
1143		1564
1144	=item B<COLORFGBG>	1565	=item B<COLORFGBG>
1145		1566
1146	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1567	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1147	the colour code used as default foreground/text colour (or the string	1568	the colour code used as default foreground/text colour (or the string
1148	C<default> to indicate that the default-colour escape sequence is to be	1569	C<default> to indicate that the default-colour escape sequence is to be
1149	used), C<bg> is the colour code used as default background colour (or the	1570	used), C<bg> is the colour code used as default background colour (or the
1150	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1571	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1151	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1572	was compiled with background image support. Libraries like C<ncurses>
1152	(and do) use this information to optimize screen output.	1573	and C<slang> can (and do) use this information to optimize screen output.
1153		1574
1154	=item B<WINDOWID>	1575	=item B<WINDOWID>
1155		1576
1156	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1577	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1157	window, which usually has subwindows for the scrollbar, the terminal	1578	window, which usually has subwindows for the scrollbar, the terminal
…		…
1163	C<--with-terminfo=PATH>.	1584	C<--with-terminfo=PATH>.
1164		1585
1165	=item B<DISPLAY>	1586	=item B<DISPLAY>
1166		1587
1167	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1588	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1168	display in it's child processes.	1589	display in its child processes if C<-display> isn't used to override. It
		1590	defaults to C<:0> if it doesn't exist.
1169		1591
1170	=item B<SHELL>	1592	=item B<SHELL>
1171		1593
1172	The shell to be used for command execution, defaults to C</bin/sh>.	1594	The shell to be used for command execution, defaults to C</bin/sh>.
1173
1174	=item B<RXVTPATH>
1175
1176	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1177	files.
1178
1179	=item B<PATH>
1180
1181	Used in the same way as C<RXVTPATH>.
1182		1595
1183	=item B<RXVT_SOCKET>	1596	=item B<RXVT_SOCKET>
1184		1597
1185	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1598	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1186	@@RXVT_NAME@@d(1).	1599	@@RXVT_NAME@@d(1).
1187		1600
1188	Default C<< $HOME/.rxvt-unicode-<nodename >>.	1601	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1189		1602
1190	=item B<HOME>	1603	=item B<HOME>
1191		1604
1192	Used to locate the default directory for the unix domain socket for	1605	Used to locate the default directory for the unix domain socket for
1193	daemon communications and to locate various resource files (such as	1606	daemon communications and to locate various resource files (such as
…		…
1214		1627
1215	=back	1628	=back
1216		1629
1217	=head1 SEE ALSO	1630	=head1 SEE ALSO
1218		1631
1219	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1632	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1220
1221	=head1 BUGS
1222
1223	Check the BUGS file for an up-to-date list.
1224
1225	Cursor change support is not yet implemented.
1226
1227	Click-and-drag doesn't work with X11 mouse report overriding.
1228		1633
1229	=head1 CURRENT PROJECT COORDINATOR	1634	=head1 CURRENT PROJECT COORDINATOR
1230		1635
1231	=over 4	1636	=over 4
1232		1637
1233	=item Project Coordinator	1638	=item Project Coordinator
1234		1639
1235	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1640	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1236		1641
1237	L<http://software.schmorp.de/#rxvt-unicode>	1642	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1238		1643
1239	=back	1644	=back
1240		1645
1241	=head1 AUTHORS	1646	=head1 AUTHORS
1242		1647
…		…
1264		1669
1265	Project Coordinator (changes.txt 2.21a to 2.4.5)	1670	Project Coordinator (changes.txt 2.21a to 2.4.5)
1266		1671
1267	=item Geoff Wing L<< <gcw@pobox.com> >>	1672	=item Geoff Wing L<< <gcw@pobox.com> >>
1268		1673
1269	Rewrote screen display and text selection routines. Project Coordinator	1674	Rewrote screen display and text selection routines.
		1675
1270	(changes.txt 2.4.6 - rxvt-unicode)	1676	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1271		1677
1272	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1678	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1273		1679
1274	Forked rxvt-unicode, rewrote most of the display code and internal	1680	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1275	character handling to store text in unicode, improve xterm	1681	extension, random hacks, numerous bugfixes and extensions.
1276	compatibility and apply numerous other bugfixes and extensions.
1277		1682
1278	Project Coordinator (Changes 1.0 -)	1683	Project Coordinator (Changes 1.0 -)
1279		1684
		1685	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1686
		1687	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
		1688
1280	=back	1689	=back
1281		1690

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.58 by root, Wed Feb 16 21:49:36 2005 UTC vs. Revision 1.170 by root, Sat May 30 08:51:23 2009 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.58 by root, Wed Feb 16 21:49:36 2005 UTC vs.
Revision 1.170 by root, Sat May 30 08:51:23 2009 UTC