ViewVC Help

View File | Revision Log | Show Annotations | Download File

/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.215 by sf-exg, Sun May 20 16:34:42 2012 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 pseudo-transparency by using the root pixmap as background; resource B<transparent>.
		130
		131	B<-ip> is still accepted as an obsolete alias but will be removed in
		132	future versions.
114		133
115	=item B<-fade> I<number>	134	=item B<-fade> I<number>
116		135
117	Fade the text by the given percentage when focus is lost. resource B<fading>.	136	Fade the text by the given percentage when focus is lost. Small values
		137	fade a little only, 100 completely replaces all colours by the fade
		138	colour; resource B<fading>.
		139
		140	=item B<-fadecolor> I<colour>
		141
		142	Fade to this colour when fading is used (see B<-fade>). The default colour
		143	is opaque black. resource B<fadeColor>.
118		144
119	=item B<-tint> I<colour>	145	=item B<-tint> I<colour>
120		146
121	Tint the transparent background pixmap with the given colour when	147	Tint the transparent background with the given colour;
122	transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>	148	resource I<tintColor>.
123	option that can be used to brighten or darken the image in addition to
124	tinting it.
125		149
126	=item B<-sh>	150	=item B<-sh> I<number>
127		151
128	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	152	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
129	background image in addition to tinting it (i.e. B<-tint> must be	153	A value of 100 means no shading; resource I<shading>.
130	specified, too, e.g. C<-tint white>).	154
		155	=item B<-blr> I<HxV>
		156
		157	Apply Gaussian Blur with the specified radii to the transparent
		158	background. If a single number is specified, the vertical and
		159	horizontal radii are considered to be the same. Setting one of the
		160	radii to 1 and the other to a large number creates interesting effects
		161	on some backgrounds. The maximum radius value is 128. An horizontal or
		162	vertical radius of 0 disables blurring;
		163	resource I<blurRadius>.
		164
		165	=item B<-icon> I<file>
		166
		167	Compile I<pixbuf>: Use the specified image as application icon. This
		168	is used by many window managers, taskbars and pagers to represent the
		169	application window; resource I<iconFile>.
131		170
132	=item B<-bg> I<colour>	171	=item B<-bg> I<colour>
133		172
134	Window background colour; resource B<background>.	173	Window background colour; resource B<background>.
135		174
136	=item B<-fg> I<colour>	175	=item B<-fg> I<colour>
137		176
138	Window foreground colour; resource B<foreground>.	177	Window foreground colour; resource B<foreground>.
139		178
140	=item B<-pixmap> I<file[;geom]>	179	=item B<-pixmap> I<file[;oplist]>
141		180
142	Compile I<XPM>: Specify XPM file for the background and also optionally	181	Compile I<pixbuf>: Specify image file for the background and also
143	specify its scaling with a geometry string. Note you may need to	182	optionally specify a list of operations to modify it. Note you may need to
144	add quotes to avoid special shell interpretation of the C<;> in the	183	add quotes to avoid special shell interpretation of the C<;> in the
145	command-line; resource B<backgroundPixmap>.	184	command-line; for more details see resource B<backgroundPixmap>.
146		185
147	=item B<-cr> I<colour>	186	=item B<-cr> I<colour>
148		187
149	The cursor colour; resource B<cursorColor>.	188	The cursor colour; resource B<cursorColor>.
150		189
…		…
162	resource B<borderColor>.	201	resource B<borderColor>.
163		202
164	=item B<-fn> I<fontlist>	203	=item B<-fn> I<fontlist>
165		204
166	Select the fonts to be used. This is a comma separated list of font names	205	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	206	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	207	first font defines the cell size for characters; other fonts might be
169	smaller, but not (in general) larger. A (hopefully) reasonable default	208	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.	209	font list is always appended to it. See resource B<font> for more details.
171		210
172	In short, to specify an X11 core font, just specify it's name or prefix it	211	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:>,	212	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
174	e.g.:	213	e.g.:
175		214
176	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	215	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
177	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	216	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
179	See also the question "How does rxvt-unicode choose fonts?" in the FAQ	218	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
180	section of @@RXVT_NAME@@(7).	219	section of @@RXVT_NAME@@(7).
181		220
182	=item B<-fb> I<fontlist>	221	=item B<-fb> I<fontlist>
183		222
184	Compile font-styles: The bold font list to use when bold characters are to	223	Compile I<font-styles>: The bold font list to use when B<bold> characters
185	be printed. See resource B<boldFont> for details.	224	are to be printed. See resource B<boldFont> for details.
186		225
187	=item B<-fi> I<fontlist>	226	=item B<-fi> I<fontlist>
188		227
189	Compile font-styles: The italic font list to use when bold characters are to	228	Compile I<font-styles>: The italic font list to use when I<italic>
190	be printed. See resource B<italicFont> for details.	229	characters are to be printed. See resource B<italicFont> for details.
191		230
192	=item B<-fbi> I<fontlist>	231	=item B<-fbi> I<fontlist>
193		232
194	Compile font-styles: The bold italic font list to use when bold characters are to	233	Compile I<font-styles>: The bold italic font list to use when B<< I<bold
195	be printed. See resource B<boldItalicFont> for details.	234	italic> >> characters are to be printed. See resource B<boldItalicFont>
		235	for details.
		236
		237	=item B<-is>|B<+is>
		238
		239	Compile I<font-styles>: Bold/Blink font styles imply high intensity
		240	foreground/background (default). See resource B<intensityStyles> for
		241	details.
196		242
197	=item B<-name> I<name>	243	=item B<-name> I<name>
198		244
199	Specify the application name under which resources are to be obtained,	245	Specify the application name under which resources are to be obtained,
200	rather than the default executable file name. Name should not contain	246	rather than the default executable file name. Name should not contain
…		…
216		262
217	=item B<-sb>|B<+sb>	263	=item B<-sb>|B<+sb>
218		264
219	Turn on/off scrollbar; resource B<scrollBar>.	265	Turn on/off scrollbar; resource B<scrollBar>.
220		266
		267	=item B<-sr>|B<+sr>
		268
		269	Put scrollbar on right/left; resource B<scrollBar_right>.
		270
		271	=item B<-st>|B<+st>
		272
		273	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		274	resource B<scrollBar_floating>.
		275
221	=item B<-si>|B<+si>	276	=item B<-si>|B<+si>
222		277
223	Turn on/off scroll-to-bottom on TTY output inhibit; resource	278	Turn on/off scroll-to-bottom on TTY output inhibit; resource
224	B<scrollTtyOutput> has opposite effect.	279	B<scrollTtyOutput> has opposite effect.
225		280
…		…
231	=item B<-sw>|B<+sw>	286	=item B<-sw>|B<+sw>
232		287
233	Turn on/off scrolling with the scrollback buffer as new lines appear.	288	Turn on/off scrolling with the scrollback buffer as new lines appear.
234	This only takes effect if B<-si> is also given; resource	289	This only takes effect if B<-si> is also given; resource
235	B<scrollWithBuffer>.	290	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		291
246	=item B<-ptab>|B<+ptab>	292	=item B<-ptab>|B<+ptab>
247		293
248	If enabled (default), "Horizontal Tab" characters are being stored as	294	If enabled (default), "Horizontal Tab" characters are being stored as
249	actual wide characters in the screen buffer, which makes it possible to	295	actual wide characters in the screen buffer, which makes it possible to
…		…
253		299
254	=item B<-bc>|B<+bc>	300	=item B<-bc>|B<+bc>
255		301
256	Blink the cursor; resource B<cursorBlink>.	302	Blink the cursor; resource B<cursorBlink>.
257		303
		304	=item B<-uc>|B<+uc>
		305
		306	Make the cursor underlined; resource B<cursorUnderline>.
		307
258	=item B<-iconic>	308	=item B<-iconic>
259		309
260	Start iconified, if the window manager supports that option.	310	Start iconified, if the window manager supports that option.
261	Alternative form is B<-ic>.	311	Alternative form is B<-ic>.
262		312
…		…
278		328
279	=item B<-bl>	329	=item B<-bl>
280		330
281	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	331	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	332	if honoured by the WM, the rxvt-unicode window will not have window
283	decorations; resource B<borderLess>.	333	decorations; resource B<borderLess>. If the window manager does not
		334	support MWM hints (e.g. kwin), enables override-redirect mode.
		335
		336	=item B<-override-redirect>
		337
		338	Compile I<frills>: Sets override-redirect on the window; resource
		339	B<override-redirect>.
		340
		341	=item B<-sbg>
		342
		343	Compile I<frills>: Disable the usage of the built-in block graphics/line
		344	drawing characters and just rely on what the specified fonts provide. Use
		345	this if you have a good font and want to use its block graphic glyphs;
		346	resource B<skipBuiltinGlyphs>.
284		347
285	=item B<-lsp> I<number>	348	=item B<-lsp> I<number>
286		349
287	Compile I<frills>: Lines (pixel height) to insert between each row of	350	Compile I<frills>: Lines (pixel height) to insert between each row of
288	the display. Useful to work around font rendering problems; resource	351	the display. Useful to work around font rendering problems; resource
289	B<linespace>.	352	B<lineSpace>.
		353
		354	=item B<-letsp> I<number>
		355
		356	Compile I<frills>: Amount to adjust the computed character width by
		357	to control overall letter spacing. Negative values will tighten up the
		358	letter spacing, positive values will space letters out more. Useful to
		359	work around odd font metrics; resource B<letterSpace>.
290		360
291	=item B<-tn> I<termname>	361	=item B<-tn> I<termname>
292		362
293	This option specifies the name of the terminal type to be set in the	363	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	364	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	373	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	374	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,	375	run the program specified by the B<SHELL> environment variable or,
306	failing that, I<sh(1)>.	376	failing that, I<sh(1)>.
307		377
		378	Please note that you must specify a program with arguments. If you want to
		379	run shell commands, you have to specify the shell, like this:
		380
		381	@@RXVT_NAME@@ -e sh -c "shell commands"
		382
308	=item B<-title> I<text>	383	=item B<-title> I<text>
309		384
310	Window title (B<-T> still respected); the default title is the basename	385	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	386	of the program specified after the B<-e> option, if any, otherwise the
312	application name; resource B<title>.	387	application name; resource B<title>.
…		…
343	for more info.	418	for more info.
344		419
345	=item B<-tcw>	420	=item B<-tcw>
346		421
347	Change the meaning of triple-click selection with the left mouse	422	Change the meaning of triple-click selection with the left mouse
		423	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	424	in-use. Instead of selecting a full line it will extend the selection to
349	end of the logical line only. resource B<tripleclickwords>.	425	the end of the logical line only. resource B<tripleclickwords>.
350		426
351	=item B<-insecure>	427	=item B<-insecure>
352		428
353	Enable "insecure" mode, which currently enables most of the escape	429	Enable "insecure" mode, which currently enables most of the escape
354	sequences that echo strings. See the resource B<insecure> for more	430	sequences that echo strings. See the resource B<insecure> for more
…		…
368	=item B<-ssr>|B<+ssr>	444	=item B<-ssr>|B<+ssr>
369		445
370	Turn on/off secondary screen scroll (default enabled); resource	446	Turn on/off secondary screen scroll (default enabled); resource
371	B<secondaryScroll>.	447	B<secondaryScroll>.
372		448
		449	=item B<-hold>|B<+hold>
		450
		451	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		452	will not immediately destroy its window when the program executed within
		453	it exits. Instead, it will wait till it is being killed or closed by the
		454	user; resource B<hold>.
		455
		456	=item B<-cd> I<path>
		457
		458	Sets the working directory for the shell (or the command specified via
		459	B<-e>). The I<path> must be an absolute path and it must exist for
		460	@@RXVT_NAME@@ to start; resource B<chdir>.
		461
		462	=item B<-xrm> I<string>
		463
		464	Works like the X Toolkit option of the same name, by adding the I<string>
		465	as if it were specified in a resource file. Resource values specified this
		466	way take precedence over all other resource specifications.
		467
		468	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		469	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		470	options can be specified as long-options on the commandline, so use
		471	of B<-xrm> is mostly limited to cases where you want to specify other
		472	resources (e.g. for input methods) or for compatibility with other
		473	programs.
		474
373	=item B<-keysym.>I<sym>: I<string>	475	=item B<-keysym.>I<sym> I<string>
374		476
375	Remap a key symbol. See resource B<keysym>.	477	Remap a key symbol. See resource B<keysym>.
376		478
377	=item B<-embed>: I<windowid>	479	=item B<-embed> I<windowid>
378		480
379	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,	481	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
380	which enables applications to easily embed a terminal.	482	which enables applications to easily embed a terminal.
381		483
382	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it	484	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	485	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	486	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.	489	The window will not be destroyed when @@RXVT_NAME@@ exits.
388		490
389	It might be useful to know that @@RXVT_NAME@@ will not close file	491	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	492	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	493	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	494	terminal. This works regardless of whether the C<-embed> option was used or
393	not.	495	not.
394		496
		497	Here is a short Gtk2-perl snippet that illustrates how this option can be
		498	used (a longer example is in F<doc/embed>):
		499
		500	my $rxvt = new Gtk2::Socket;
		501	$rxvt->signal_connect_after (realize => sub {
		502	my $xid = $_[0]->window->get_xid;
		503	system "@@RXVT_NAME@@ -embed $xid &";
		504	});
		505
		506	=item B<-pty-fd> I<file descriptor>
		507
		508	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
		509	pair but instead use the given file descriptor as the tty master. This is
		510	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
		511	without having to run a program within it.
		512
		513	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
		514	entries and will not tinker with pty/tty permissions - you have to do that
		515	yourself if you want that.
		516
		517	As an extremely special case, specifying C<-1> will completely suppress
		518	pty/tty operations, which is probably only useful in conjunction with some
		519	perl extension that manages the terminal.
		520
		521	Here is a example in perl that illustrates how this option can be used (a
		522	longer example is in F<doc/pty-fd>):
		523
		524	use IO::Pty;
		525	use Fcntl;
		526
		527	my $pty = new IO::Pty;
		528	fcntl $pty, F_SETFD, 0; # clear close-on-exec
		529	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		530	close $pty;
		531
		532	# now communicate with rxvt
		533	my $slave = $pty->slave;
		534	while (<$slave>) { print $slave "got <$_>\n" }
		535
		536	=item B<-pe> I<string>
		537
		538	Comma-separated list of perl extension scripts to use (or not to use) in
		539	this terminal instance. See resource B<perl-ext> for details.
		540
395	=back	541	=back
396		542
397	=head1 RESOURCES (available also as long-options)	543	=head1 RESOURCES
398		544
399	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	545	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
400	options) compiled into your version.	546	options) compiled into your version. All resources are also available as
		547	long-options.
401		548
402	There are two different methods that @@RXVT_NAME@@ can use to get the	549	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	550	distribution do also load settings from the B<~/.Xresources> file when X
404	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	551	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	552	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		553
411	1. system-wide app-defaults file, either locale-dependent OR global
412	2. app-defaults file in $XAPPLRESDIR	554	1. app-defaults file in $XAPPLRESDIR
		555	2. $HOME/.Xdefaults
413	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	556	3. RESOURCE_MANAGER property on root-window of screen 0
414	4. SCREEN_RESOURCES for the current screen	557	4. SCREEN_RESOURCES property on root-window of the current screen
415	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	558	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		559	6. resources specified via -xrm on the commandline
416		560
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	561	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	562	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	563	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	564	configured, while the class name B<URxvt> allows resources unique to
426	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	565	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
427	shared between different B<@@RXVT_NAME@@> configurations. If no	566	configurations. If no resources are specified, suitable defaults will
428	resources are specified, suitable defaults will be used. Command-line	567	be used. Command-line arguments can be used to override resource
429	arguments can be used to override resource settings. The following	568	settings. The following resources are supported (you might want to
430	resources are allowed:	569	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		570	extensions not documented here):
431		571
432	=over 4	572	=over 4
		573
		574	=item B<depth:> I<bitdepth>
		575
		576	Compile I<xft>: Attempt to find a visual with the given bit depth;
		577	option B<-depth>.
		578
		579	=item B<buffered:> I<boolean>
		580
		581	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		582	On some card/driver combination enabling it slightly decreases
		583	performance, on most it greatly helps it. The slowdown is small, so it
		584	should normally be enabled.
433		585
434	=item B<geometry:> I<geom>	586	=item B<geometry:> I<geom>
435		587
436	Create the window with the specified X window geometry [default 80x24];	588	Create the window with the specified X window geometry [default 80x24];
437	option B<-geometry>.	589	option B<-geometry>.
…		…
451	Use the specified colour for the colour value I<n>, where 0-7	603	Use the specified colour for the colour value I<n>, where 0-7
452	corresponds to low-intensity (normal) colours and 8-15 corresponds to	604	corresponds to low-intensity (normal) colours and 8-15 corresponds to
453	high-intensity (bold = bright foreground, blink = bright background)	605	high-intensity (bold = bright foreground, blink = bright background)
454	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	606	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
455	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	607	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
456	names used are listed in the B<COLORS AND GRAPHICS> section.	608	names used are listed in the B<COLOURS AND GRAPHICS> section.
457		609
458	Colours higher than 15 cannot be set using resources (yet), but can be	610	Colours higher than 15 cannot be set using resources (yet), but can be
459	changed using an escape command (see @@RXVT_NAME@@(7)).	611	changed using an escape command (see @@RXVT_NAME@@(7)).
460		612
461	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	613	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
472	=item B<colorUL:> I<colour>	624	=item B<colorUL:> I<colour>
473		625
474	Use the specified colour to display underlined characters when the	626	Use the specified colour to display underlined characters when the
475	foreground colour is the default.	627	foreground colour is the default.
476		628
477	=item B<colorRV:> I<colour>
478
479	Use the specified colour as the background for reverse video
480	characters.
481
482	=item B<underlineColor:> I<colour>	629	=item B<underlineColor:> I<colour>
483		630
484	If set, use the specified colour as the colour for the underline	631	If set, use the specified colour as the colour for the underline
485	itself. If unset, use the foreground colour.	632	itself. If unset, use the foreground colour.
		633
		634	=item B<highlightColor:> I<colour>
		635
		636	If set, use the specified colour as the background for highlighted
		637	characters. If unset, use reverse video.
		638
		639	=item B<highlightTextColor:> I<colour>
		640
		641	If set and highlightColor is set, use the specified colour as the
		642	foreground for highlighted characters.
486		643
487	=item B<cursorColor:> I<colour>	644	=item B<cursorColor:> I<colour>
488		645
489	Use the specified colour for the cursor. The default is to use the	646	Use the specified colour for the cursor. The default is to use the
490	foreground colour; option B<-cr>.	647	foreground colour; option B<-cr>.
…		…
497		654
498	=item B<reverseVideo:> I<boolean>	655	=item B<reverseVideo:> I<boolean>
499		656
500	B<True>: simulate reverse video by foreground and background colours;	657	B<True>: simulate reverse video by foreground and background colours;
501	option B<-rv>. B<False>: regular screen colours [default]; option	658	option B<-rv>. B<False>: regular screen colours [default]; option
502	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	659	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
503		660
504	=item B<jumpScroll:> I<boolean>	661	=item B<jumpScroll:> I<boolean>
505		662
506	B<True>: specify that jump scrolling should be used. When scrolling	663	B<True>: specify that jump scrolling should be used. When receiving lots
507	quickly, fewer screen updates are performed [default]; option B<-j>.	664	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		665	has been read, resulting in fewer updates while still displaying every
		666	received line; option B<-j>.
		667
508	B<False>: specify that smooth scrolling should be used; option B<+j>.	668	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		669	force a screen refresh on each new line it received; option B<+j>.
509		670
510	=item B<inheritPixmap:> I<boolean>	671	=item B<skipScroll:> I<boolean>
511		672
512	B<True>: make the background inherit the parent windows' pixmap, giving	673	B<True>: (the default) specify that skip scrolling should be used. When
513	artificial transparency. B<False>: do not inherit the parent windows'	674	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
514	pixmap.	675	(around 60 times per second), resulting in far fewer updates. This can
		676	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		677	option B<-ss>.
		678
		679	B<False>: specify that everything is to be displayed, even
		680	if the refresh is too fast for the human eye to read anything (or the
		681	monitor to display anything); option B<+ss>.
		682
		683	=item B<transparent:> I<boolean>
		684
		685	Turn on/off pseudo-transparency by using the root pixmap as background.
		686
		687	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
		688	future versions.
515		689
516	=item B<fading:> I<number>	690	=item B<fading:> I<number>
517		691
518	Fade the text by the given percentage when focus is lost.	692	Fade the text by the given percentage when focus is lost; option B<-fade>.
		693
		694	=item B<fadeColor:> I<colour>
		695
		696	Fade to this colour, when fading is used (see B<fading:>). The default
		697	colour is black; option B<-fadecolor>.
519		698
520	=item B<tintColor:> I<colour>	699	=item B<tintColor:> I<colour>
521		700
522	Tint the transparent background pixmap with the given colour.	701	Tint the transparent background with the given colour. If the RENDER
		702	extension is not available only black, red, green, yellow, blue,
		703	magenta, cyan and white tints can be performed server-side. Note that
		704	a black tint yields a completely black image while a white tint yields
		705	the image unchanged; option B<-tint>.
523		706
524	=item B<shading:> I<number>	707	=item B<shading:> I<number>
525		708
526	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	709	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
527	image in addition to tinting it.	710	A value of 100 means no shading; option B<-sh>.
		711
		712	=item B<blurRadius:> I<number>
		713
		714	Apply gaussian blur with the specified radius to the transparent
		715	background; option B<-blr>.
		716
		717	=item B<iconFile:> I<file>
		718
		719	Set the application icon pixmap; option B<-icon>.
528		720
529	=item B<scrollColor:> I<colour>	721	=item B<scrollColor:> I<colour>
530		722
531	Use the specified colour for the scrollbar [default #B2B2B2].	723	Use the specified colour for the scrollbar [default #B2B2B2].
532		724
533	=item B<troughColor:> I<colour>	725	=item B<troughColor:> I<colour>
534		726
535	Use the specified colour for the scrollbar's trough area [default	727	Use the specified colour for the scrollbar's trough area [default
536	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	728	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
537		729
538	=item B<borderColor:> I<colour>	730	=item B<borderColor:> I<colour>
539		731
540	The colour of the border around the text area and between the scrollbar	732	The colour of the border around the text area and between the scrollbar
541	and the text.	733	and the text.
542		734
543	=item B<backgroundPixmap:> I<file[;geom]>	735	=item B<backgroundPixmap:> I<file[;oplist]>
544		736
545	Use the specified XPM file (note the `.xpm' extension is optional) for	737	Use the specified image file for the background and also
546	the background and also optionally specify its scaling with a geometry	738	optionally specify a colon separated list of operations to modify it.
547	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	739	Supported operations are:
548	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
550	of 1 displays the image without any scaling. A scale of 2 to 9
551	specifies an integer number of images in that direction. No image will
552	be magnified beyond 10 times its original size. The maximum permitted
553	scale is 1000. [default 0x0+50+50]
554		740
555	=item B<menu:> I<file[;tag]>	741	=over 4
556		742
557	Read in the specified menu file (note the `.menu' extension is	743	=item B<WxH+X+Y>
558	optional) and also optionally specify a starting tag to find. See the	744
559	reference documentation for details on the syntax for the menuBar.	745	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
		746	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
		747	scale of 0 disables scaling.
		748
		749	=item B<op=tile>
		750
		751	enables tiling
		752
		753	=item B<op=keep-aspect>
		754
		755	maintain the image aspect ratio when scaling
		756
		757	=item B<op=root-align>
		758
		759	use the position of the terminal window relative to the root window as
		760	the image offset, simulating a root window background
		761
		762	=back
		763
		764	The default scale and position setting is C<100x100+50+50>.
		765	Alternatively, a predefined set of templates can be used to achieve
		766	the most common setups:
		767
		768	=over 4
		769
		770	=item B<style=tiled>
		771
		772	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		773
		774	=item B<style=aspect-stretched>
		775
		776	the image is scaled to fill the whole window maintaining the aspect
		777	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		778
		779	=item B<style=stretched>
		780
		781	the image is scaled to fill the whole window. Equivalent to 100x100
		782
		783	=item B<style=centered>
		784
		785	the image is centered with no scaling. Equivalent to 0x0+50+50
		786
		787	=item B<style=root-tiled>
		788
		789	the image is tiled with no scaling and using 'root' positioning.
		790	Equivalent to 0x0:op=tile:op=root-align
		791
		792	=back
		793
		794	If multiple templates are specified the last one wins. Note that a
		795	template overrides all the scale, position and operations settings.
		796
		797	If used in conjunction with B<-tr> option, the specified pixmap will be
		798	blended over the transparent background using alpha-blending.
560		799
561	=item B<path:> I<path>	800	=item B<path:> I<path>
562		801
563	Specify the colon-delimited search path for finding files (XPM and	802	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		803
567	=item B<font:> I<fontlist>	804	=item B<font:> I<fontlist>
568		805
569	Select the fonts to be used. This is a comma separated list of font	806	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.	807	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	808	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	809	smaller, but not (in general) larger. A (hopefully) reasonable default
573	appended to it. option B<-fn>.	810	font list is always appended to it; option B<-fn>.
574		811
575	Each font can either be a standard X11 core font (XLFD) name, with	812	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:>.	813	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
577		814
578	In addition, each font can be prefixed with additional hints and	815	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	817	hint currently is C<codeset=codeset-name>, and this is only used for Xft
581	fonts.	818	fonts.
582		819
583	For example, this font resource	820	For example, this font resource
584		821
585	URxvt*font: 9x15bold,\	822	URxvt.font: 9x15bold,\
586	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	823	-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, \	824	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
588	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	825	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
589	xft:Code2000:antialias=false	826	xft:Code2000:antialias=false
590		827
…		…
593	it is named first) and thus defines the character cell grid to be 9 pixels	830	it is named first) and thus defines the character cell grid to be 9 pixels
594	wide and 15 pixels high.	831	wide and 15 pixels high.
595		832
596	The second font is just used to add additional unicode characters not in	833	The second font is just used to add additional unicode characters not in
597	the base font, likewise the third, which is unfortunately non-bold, but	834	the base font, likewise the third, which is unfortunately non-bold, but
598	the bold version of the font does contain less characters, so this is a	835	the bold version of the font does contain fewer characters, so this is a
599	useful supplement.	836	useful supplement.
600		837
601	The third font is an Xft font with aliasing turned off, and the characters	838	The third font is an Xft font with aliasing turned off, and the characters
602	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	839	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
603	contains other characters, but we are not interested in them.	840	contains other characters, but we are not interested in them.
…		…
624	not possible, replacement fonts of the desired shape will be tried.	861	not possible, replacement fonts of the desired shape will be tried.
625		862
626	If set, but empty, then this specific style is disabled and the normal	863	If set, but empty, then this specific style is disabled and the normal
627	text font will being used for the given style.	864	text font will being used for the given style.
628		865
629	=item B<selectstyle:> I<mode>	866	=item B<intensityStyles:> I<boolean>
630		867
631	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	868	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	869	option B<-is>, the default), bold/blink font styles imply high
633	xterm style selection.	870	intensity foreground/background colours. Disabling this option (B<False>,
634		871	option B<+is>) disables this behaviour, the high intensity colours are not
635	=item B<scrollstyle:> I<mode>	872	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		873
640	=item B<title:> I<string>	874	=item B<title:> I<string>
641		875
642	Set window title string, the default title is the command-line	876	Set window title string, the default title is the command-line
643	specified after the B<-e> option, if any, otherwise the application	877	specified after the B<-e> option, if any, otherwise the application
…		…
652	=item B<mapAlert:> I<boolean>	886	=item B<mapAlert:> I<boolean>
653		887
654	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	888	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].	889	de-iconify (map) on receipt of a bell character [default].
656		890
		891	=item B<urgentOnBell:> I<boolean>
		892
		893	B<True>: set the urgency hint for the wm on receipt of a bell character.
		894	B<False>: do not set the urgency hint [default].
		895
		896	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		897
657	=item B<visualBell:> I<boolean>	898	=item B<visualBell:> I<boolean>
658		899
659	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	900	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
660	B<False>: no visual bell [default]; option B<+vb>.	901	B<False>: no visual bell [default]; option B<+vb>.
661		902
…		…
675		916
676	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	917	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	918	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.	919	B<Shift-Print> to include the scrollback as well.
679		920
		921	The string will be interpreted as if typed into the shell as-is.
		922
		923	Example:
		924
		925	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		926
		927	This creates a new file in your home directory with the screen contents
		928	every time you hit C<Print>.
		929
		930	=item B<scrollstyle:> I<mode>
		931
		932	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		933	the author's favourite.
		934
		935	=item B<thickness:> I<number>
		936
		937	Set the scrollbar width in pixels.
		938
680	=item B<scrollBar:> I<boolean>	939	=item B<scrollBar:> I<boolean>
681		940
682	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	941	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
683	disable the scrollbar; option B<+sb>.	942	disable the scrollbar; option B<+sb>.
684		943
…		…
703	B<False>: do not scroll to bottom when tty receives output; option	962	B<False>: do not scroll to bottom when tty receives output; option
704	B<+si>.	963	B<+si>.
705		964
706	=item B<scrollWithBuffer:> I<boolean>	965	=item B<scrollWithBuffer:> I<boolean>
707		966
708	B<True>: scroll with scrollback buffer when tty receives new lines (and	967	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
709	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	968	try to show the same lines) and B<scrollTtyOutput> is False; option
710	with scrollback buffer when tty recieves new lines; option B<+sw>.	969	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		970	new lines; option B<+sw>.
711		971
712	=item B<scrollTtyKeypress:> I<boolean>	972	=item B<scrollTtyKeypress:> I<boolean>
713		973
714	B<True>: scroll to bottom when a non-special key is pressed. Special keys	974	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	975	are those which are intercepted by rxvt-unicode for special handling and
…		…
734	=item B<borderLess:> I<boolean>	994	=item B<borderLess:> I<boolean>
735		995
736	Set MWM hints to request a borderless window, i.e. if honoured by the	996	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>.	997	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
738		998
		999	=item B<skipBuiltinGlyphs:> I<boolean>
		1000
		1001	Compile I<frills>: Disable the usage of the built-in block graphics/line
		1002	drawing characters and just rely on what the specified fonts provide. Use
		1003	this if you have a good font and want to use its block graphic glyphs;
		1004	option B<-sbg>.
		1005
739	=item B<termName:> I<termname>	1006	=item B<termName:> I<termname>
740		1007
741	Specifies the terminal type name to be set in the B<TERM> environment	1008	Specifies the terminal type name to be set in the B<TERM> environment
742	variable; option B<-tn>.	1009	variable; option B<-tn>.
743		1010
744	=item B<linespace:> I<number>	1011	=item B<lineSpace:> I<number>
745		1012
746	Specifies number of lines (pixel height) to insert between each row of	1013	Specifies number of lines (pixel height) to insert between each row of
747	the display [default 0]; option B<-lsp>.	1014	the display [default 0]; option B<-lsp>.
748		1015
749	=item B<meta8:> I<boolean>	1016	=item B<meta8:> I<boolean>
…		…
763		1030
764	=item B<cursorBlink:> I<boolean>	1031	=item B<cursorBlink:> I<boolean>
765		1032
766	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1033	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
767	option B<-bc>.	1034	option B<-bc>.
		1035
		1036	=item B<cursorUnderline:> I<boolean>
		1037
		1038	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1039	option B<-uc>.
768		1040
769	=item B<pointerBlank:> I<boolean>	1041	=item B<pointerBlank:> I<boolean>
770		1042
771	B<True>: blank the pointer when a key is pressed or after a set number	1043	B<True>: blank the pointer when a key is pressed or after a set number
772	of seconds of inactivity. B<False>: the pointer is always visible	1044	of seconds of inactivity. B<False>: the pointer is always visible
…		…
780		1052
781	Mouse pointer background colour.	1053	Mouse pointer background colour.
782		1054
783	=item B<pointerBlankDelay:> I<number>	1055	=item B<pointerBlankDelay:> I<number>
784		1056
785	Specifies number of seconds before blanking the pointer [default 2].	1057	Specifies number of seconds before blanking the pointer [default 2]. Use a
		1058	large number (e.g. C<987654321>) to effectively disable the timeout.
786		1059
787	=item B<backspacekey:> I<string>	1060	=item B<backspacekey:> I<string>
788		1061
789	The string to send when the backspace key is pressed. If set to B<DEC>	1062	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>	1063	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
791	(code 8) - which can be reversed with the appropriate DEC private mode	1064	(code 8) - which can be reversed with the appropriate DEC private mode
792	escape sequence.	1065	escape sequence.
793		1066
794	=item B<deletekey:> I<string>	1067	=item B<deletekey:> I<string>
795		1068
…		…
797	pressed. If unset it will send the sequence traditionally associated	1070	pressed. If unset it will send the sequence traditionally associated
798	with the B<Execute> key.	1071	with the B<Execute> key.
799		1072
800	=item B<cutchars:> I<string>	1073	=item B<cutchars:> I<string>
801		1074
802	The characters used as delimiters for double-click word selection. The	1075	The characters used as delimiters for double-click word selection
803	built-in default:	1076	(whitespace delimiting is added automatically if resource is given).
804		1077
		1078	When the perl selection extension is in use (the default if compiled
		1079	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		1080	characters will be created (if the resource exists, otherwise, no regex
		1081	will be created). In this mode, characters outside ISO-8859-1 can be used.
		1082
		1083	When the selection extension is not used, only ISO-8859-1 characters can
		1084	be used. If not specified, the built-in default is used:
		1085
805	B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>	1086	B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
806		1087
807	=item B<preeditType:> I<style>	1088	=item B<preeditType:> I<style>
808		1089
809	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1090	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
810		1091
…		…
815	=item B<imLocale:> I<name>	1096	=item B<imLocale:> I<name>
816		1097
817	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.	1098	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	1099	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	1100	input extension to be able to input japanese characters while staying in
820	another locale. option B<-imlocale>.	1101	another locale; option B<-imlocale>.
821		1102
822	=item B<imFont:> I<fontset>	1103	=item B<imFont:> I<fontset>
823		1104
824	Specify the font-set used for XIM styles C<OverTheSpot> or	1105	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	1106	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
…		…
830		1111
831	=item B<tripleclickwords:> I<boolean>	1112	=item B<tripleclickwords:> I<boolean>
832		1113
833	Change the meaning of triple-click selection with the left mouse	1114	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	1115	button. Instead of selecting a full line it will extend the selection to
835	the end of the logical line only. option B<-tcw>.	1116	the end of the logical line only; option B<-tcw>.
836		1117
837	=item B<insecure:> I<boolean>	1118	=item B<insecure:> I<boolean>
838		1119
839	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	1120	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
840	echo arbitrary strings like the icon name or the locale. This could be	1121	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	1122	abused if somebody gets 8-bit-clean access to your display, whether
842	throuh a mail client displaying mail bodies unfiltered or though	1123	through a mail client displaying mail bodies unfiltered or through
843	write(1). Therefore, these sequences are disabled by default. (Note	1124	write(1) or any other means. Therefore, these sequences are disabled by
844	that other terminals, including xterm, have these sequences	1125	default. (Note that many other terminals, including xterm, have these
845	enabled by default). You can enable them by setting this boolean	1126	sequences enabled by default, which doesn't make it safer, though).
846	resource or specifying B<-insecure> as an option. At the moment, this	1127
847	enabled display-answer, locale, findfont, icon label and window title	1128	You can enable them by setting this boolean resource or specifying
848	requests as well as dynamic menubar dispatch.	1129	B<-insecure> as an option. At the moment, this enables display-answer,
		1130	locale, findfont, icon label and window title requests.
849		1131
850	=item B<modifier:> I<modifier>	1132	=item B<modifier:> I<modifier>
851		1133
852	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	1134	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	1135	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
857		1139
858	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	1140	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	1141	character is passed through. It may contain escape values as described
860	in the entry on B<keysym> following.	1142	in the entry on B<keysym> following.
861		1143
862	=item B<secondaryScreen:> I<bool>	1144	=item B<secondaryScreen:> I<boolean>
863		1145
864	Turn on/off secondary screen (default enabled).	1146	Turn on/off secondary screen (default enabled).
865		1147
866	=item B<secondaryScroll:> I<bool>	1148	=item B<secondaryScroll:> I<boolean>
867		1149
868	Turn on/off secondary screen scroll (default enabled). If the this	1150	Turn on/off secondary screen scroll (default enabled). If this
869	option is enabled, scrolls on the secondary screen will change the	1151	option is enabled, scrolls on the secondary screen will change the
870	scrollback buffer and switching to/from the secondary screen will	1152	scrollback buffer and, when secondaryScreen is off, switching
871	instead scroll the screen up.	1153	to/from the secondary screen will instead scroll the screen up.
		1154
		1155	=item B<hold>: I<boolean>
		1156
		1157	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		1158	will not immediately destroy its window when the program executed within
		1159	it exits. Instead, it will wait till it is being killed or closed by the
		1160	user.
		1161
		1162	=item B<chdir>: I<path>
		1163
		1164	Sets the working directory for the shell (or the command specified via
		1165	B<-e>). The I<path> must be an absolute path and it must exist for
		1166	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1167	directory will be used; option B<-cd>.
872		1168
873	=item B<keysym.>I<sym>: I<string>	1169	=item B<keysym.>I<sym>: I<string>
874		1170
875	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1171	Compile I<frills>: Associate I<string> with keysym I<sym>. The
876	intervening resource name B<keysym.> cannot be omitted.	1172	intervening resource name B<keysym.> cannot be omitted.
…		…
890	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1186	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	1187	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	1188	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.	1189	performed in an exact manner; however, the closest match is assured.
894		1190
895	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1191	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,	1192	number), see RESOURCES in C<man 7 X> for further 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		1193
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
906	You can define a range of keysyms in one shot by providing a I<string>	1194	You can define a range of keysyms in one shot by
		1195	loading the C<keysym-list> perl extension and providing a I<string>
907	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1196	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
908	should be a character not used by the strings.	1197	should be a character not used by the strings.
909		1198
910	Its usage can be demonstrated by an example:	1199	Its usage can be demonstrated by an example:
911		1200
912	URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>	1201	URxvt.keysym.M-C-0x61: list|\033<|abc|>
913		1202
914	The above line is equivalent to the following three lines:	1203	The above line is equivalent to the following three lines:
915		1204
916	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1205	URxvt.keysym.Meta-Control-0x61: \033<a>
917	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1206	URxvt.keysym.Meta-Control-0x62: \033<b>
918	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1207	URxvt.keysym.Meta-Control-0x63: \033<c>
919		1208
920	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1209	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
921	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1210	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
922	example the following means "change the current locale to C<zh_CN.GBK>	1211	example the following means "change the current locale to C<zh_CN.GBK>
923	when Control-Meta-c is being pressed":	1212	when Control-Meta-c is being pressed":
924		1213
925	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1214	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
926		1215
		1216	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1217	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1218	manpage. For example, the F<selection> extension (activated via
		1219	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1220
		1221	URxvt.keysym.M-C-c: perl:selection:rot13
		1222
		1223	Due the the large number of modifier combinations, a defined key mapping
		1224	will match if I<at least> the specified identifiers are being set, and
		1225	no other key mappings with those and more bits are being defined. That
		1226	means that defining a key map for C<a> will automatically provide
		1227	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		1228	mappings themselves.
		1229
		1230	Unfortunately, this will override built-in key mappings. For example
		1231	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		1232	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		1233	user-defined keymap using the C<builtin:> replacement:
		1234
		1235	URxvt.keysym.Insert: <my insert key sequence>
		1236	URxvt.keysym.S-Insert: builtin:
		1237
		1238	The first line defines a mapping for C<Insert> and I<any> combination
		1239	of modifiers. The second line re-establishes the default mapping for
		1240	C<Shift-Insert>.
		1241
927	The following example will map Control-Meta-1 and Control-Meta-2 to	1242	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	1243	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
929	font-switching at runtime:	1244	font-switching at runtime:
930		1245
931	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1246	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
…		…
934	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1249	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
935	info):	1250	info):
936		1251
937	URxvt.keysym.M-C-3: command:\033[8;25;80t	1252	URxvt.keysym.M-C-3: command:\033[8;25;80t
938	URxvt.keysym.M-C-4: command:\033[8;48;110t	1253	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1254
		1255	=item B<perl-ext-common>: I<string>
		1256
		1257	=item B<perl-ext>: I<string>
		1258
		1259	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1260	use in this terminal instance; option B<-pe>.
		1261
		1262	Extension names can be prefixed with a C<-> sign to prohibit using
		1263	them. This can be useful to selectively disable some extensions loaded
		1264	by default, or specified via the C<perl-ext-common> resource. For
		1265	example, C<default,-selection> will use all the default extension except
		1266	C<selection>.
		1267
		1268	Extension names can also be followed by an argument in angle brackets
		1269	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1270	searchable scrollback to Alt/Meta-s). Mentioning the same extension
		1271	multiple times with different arguments will pass multiple arguments to
		1272	the extension.
		1273
		1274	Each extension is looked up in the library directories, loaded if
		1275	necessary, and bound to the current terminal instance.
		1276
		1277	If both of these resources are the empty string, then the perl
		1278	interpreter will not be initialized. The idea behind two options is that
		1279	B<perl-ext-common> will be used for extensions that should be available to
		1280	all instances, while B<perl-ext> is used for specific instances.
		1281
		1282	=item B<perl-eval>: I<string>
		1283
		1284	Perl code to be evaluated when all extensions have been registered. See
		1285	the @@RXVT_NAME@@perl(3) manpage.
		1286
		1287	=item B<perl-lib>: I<path>
		1288
		1289	Colon-separated list of additional directories that hold extension
		1290	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
		1291	look in these directories, then in $HOME/.urxvt/ext and lastly in
		1292	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
		1293
		1294	See the @@RXVT_NAME@@perl(3) manpage.
		1295
		1296	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1297
		1298	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1299	details.
		1300
		1301	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1302
		1303	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1304	for details.
		1305
		1306	=item B<searchable-scrollback:> I<keysym>
		1307
		1308	Sets the hotkey that starts the incremental scrollback buffer search
		1309	(default: C<M-s>).
		1310
		1311	=item B<urlLauncher>: I<string>
		1312
		1313	Specifies the program to be started with a URL argument. Used by the
		1314	C<selection-popup> and C<matcher> perl extensions.
		1315
		1316	=item B<transient-for>: I<windowid>
		1317
		1318	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1319
		1320	=item B<override-redirect>: I<boolean>
		1321
		1322	Compile I<frills>: Sets override-redirect for the terminal window, making
		1323	it almost invisible to window managers; option B<-override-redirect>.
		1324
		1325	=item B<iso14755:> I<boolean>
		1326
		1327	Turn on/off ISO 14755 (default enabled).
		1328
		1329	=item B<iso14755_52:> I<boolean>
		1330
		1331	Turn on/off ISO 14755 5.2 mode (default enabled).
939		1332
940	=back	1333	=back
941		1334
942	=head1 THE SCROLLBAR	1335	=head1 THE SCROLLBAR
943		1336
…		…
962	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1355	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
963	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1356	(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),	1357	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
965	respectively.	1358	respectively.
966		1359
967	=head1 TEXT SELECTION AND INSERTION	1360	=head1 THE SELECTION: SELECTING AND PASTING TEXT
968		1361
969	The behaviour of text selection and insertion mechanism is similar to	1362	The behaviour of text selection and insertion/pasting mechanism is similar
970	I<xterm>(1).	1363	to I<xterm>(1).
971		1364
972	=over 4	1365	=over 4
973		1366
974	=item B<Selection>:	1367	=item B<Selecting>:
975		1368
976	Left click at the beginning of the region, drag to the end of the region	1369	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	1370	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	1371	to select a word; Left triple-click to select the entire logical line
979	(which can span multiple screen lines), unless modified by resource	1372	(which can span multiple screen lines), unless modified by resource
980	B<tripleclickwords>.	1373	B<tripleclickwords>.
981		1374
982	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1375	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	1376	(Compile: I<frills>) will create a rectangular selection instead of a
984	one.	1377	normal one. In this mode, every selected row becomes its own line in the
		1378	selection, and trailing whitespace is visually underlined and removed from
		1379	the selection.
985		1380
986	=item B<Insertion>:	1381	=item B<Pasting>:
987		1382
988	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1383	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	1384	window causes the value of the PRIMARY selection (or CLIPBOARD with the
990	inserted as if it had been typed on the keyboard.	1385	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1386
		1387	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1388	inserted too.
991		1389
992	=back	1390	=back
993		1391
994	=head1 CHANGING FONTS	1392	=head1 CHANGING FONTS
995		1393
996	Changing fonts (or font sizes, respectively) via the keypad is not yet	1394	Changing fonts (or font sizes, respectively) via the keypad is not yet
997	supported in rxvt-unicode. Bug me if you need this.	1395	supported in rxvt-unicode. Bug me if you need this.
998		1396
999	You can, however, switch fonts at runtime using escape sequences (and	1397	You can, however, switch fonts at runtime using escape sequences, e.g.:
1000	therefore using the menubar), e.g.:
1001		1398
1002	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1399	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1400
		1401	You can use keyboard shortcuts, too:
		1402
		1403	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1404	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1003		1405
1004	rxvt-unicode will automatically re-apply these fonts to the output so far.	1406	rxvt-unicode will automatically re-apply these fonts to the output so far.
1005		1407
1006	=head1 ISO 14755 SUPPORT	1408	=head1 ISO 14755 SUPPORT
1007		1409
1008	ISO 14755 is a standard for entering and viewing unicode characters	1410	ISO 14755 is a standard for entering and viewing unicode characters
1009	and character codes using the keyboard. It consists of 4 parts. The	1411	and character codes using the keyboard. It consists of 4 parts. The
1010	first part is available rxvt-unicode has been compiled with	1412	first part is available if rxvt-unicode has been compiled with
1011	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1413	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1012	with C<--enable-iso14755>.	1414	with C<--enable-iso14755>.
1013		1415
1014	=over 4	1416	=over 4
1015		1417
…		…
1035	This mode lets you input characters representing the keycap symbols of	1437	This mode lets you input characters representing the keycap symbols of
1036	your keyboard, if representable in the current locale encoding.	1438	your keyboard, if representable in the current locale encoding.
1037		1439
1038	Start by pressing C<Control> and C<Shift> together, then releasing	1440	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	1441	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	1442	invoke its usual function but instead will insert the corresponding
1041	keycap symbol. The symbol will only be entered when the key has been	1443	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	1444	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	1445	C<ISO Level 2 Switch>, although your intention might have been to enter a
1044	reverse tab (Shift-Tab).	1446	reverse tab (Shift-Tab).
1045		1447
…		…
1073	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1475	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1074	it can be seen via the I<who(1)> command, and can accept messages. To	1476	it can be seen via the I<who(1)> command, and can accept messages. To
1075	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1477	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1076	on some systems or setgid to root or to some other group on others.	1478	on some systems or setgid to root or to some other group on others.
1077		1479
1078	=head1 COLORS AND GRAPHICS	1480	=head1 COLOURS AND GRAPHICS
1079		1481
1080	In addition to the default foreground and background colours,	1482	In addition to the default foreground and background colours,
1081	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1483	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1082	high-intensity bold/blink versions of the same). Here is a list of the	1484	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1083	colours with their B<rgb.txt> names.	1485	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1486	cube plus a 8 (24) colour greyscale ramp.
		1487
		1488	Here is a list of the ANSI colours with their names.
1084		1489
1085	=begin table	1490	=begin table
1086		1491
1087	B<color0> (black) = Black	1492	B<color0> (black) = Black
1088	B<color1> (red) = Red3	1493	B<color1> (red) = Red3
…		…
1108	It is also possible to specify the colour values of B<foreground>,	1513	It is also possible to specify the colour values of B<foreground>,
1109	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1514	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	1515	a number 0-15, as a convenient shorthand to reference the colour name of
1111	color0-color15.	1516	color0-color15.
1112		1517
		1518	The following text gives values for the standard 88 colour mode (and
		1519	values for the 256 colour mode in parentheses).
		1520
		1521	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1522
		1523	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1524	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1525
		1526	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1527	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1528	the RGB cube.
		1529
		1530	Together, all those colours implement the 88 (256) colour xterm
		1531	colours. Only the first 16 can be changed using resources currently, the
		1532	rest can only be changed via command sequences ("escape codes").
		1533
		1534	Applications are advised to use terminfo or command sequences to discover
		1535	number and RGB values of all colours (yes, you can query this...).
		1536
1113	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1537	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1114	always swapping the foreground/background colours. This is in contrast to	1538	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	1539	I<xterm>(1) where the colours are only swapped if they have not otherwise
1116	been specified. For example,	1540	been specified. For example,
1117		1541
		1542	@@RXVT_NAME@@ -fg Black -bg White -rv
		1543
		1544	would yield White on Black, while on I<xterm>(1) it would yield Black on
		1545	White.
		1546
		1547	=head2 ALPHA CHANNEL SUPPORT
		1548
		1549	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1550	their act together, rxvt-unicode will do its own alpha channel management:
		1551
		1552	You can prefix any colour with an opaqueness percentage enclosed in
		1553	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1554	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1555	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1556	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1557	is the recommended format to specify transparency values, and works with
		1558	all ways to specify a colour.
		1559
		1560	For complete control, rxvt-unicode also supports
		1561	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1562	specifications, where the additional C<aaaa> component specifies opacity
		1563	(alpha) values. The minimum value of C<0000> is completely transparent,
		1564	while C<ffff> is completely opaque). The two example colours from
		1565	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1566	C<rgba:0000/ff00/0000/f332>.
		1567
		1568	You probably need to specify B<"-depth 32">, too, to force a visual with
		1569	alpha channels, and have the luck that your X-server uses ARGB pixel
		1570	layout, as X is far from just supporting ARGB visuals out of the box, and
		1571	rxvt-unicode just fudges around.
		1572
		1573	For example, the following selects an almost completely transparent black
		1574	background, and an almost opaque pink foreground:
		1575
		1576	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
		1577
		1578	When not using a background image, then the interpretation of the
		1579	alpha channel is up to your compositing manager (most interpret it as
		1580	transparency of course).
		1581
		1582	When using a background pixmap or pseudo-transparency, then the background
		1583	colour will always behave as if it were completely transparent (so the
		1584	background image shows instead), regardless of how it was specified, while
		1585	other colours will either be transparent as specified (the background
		1586	image will show through) on servers supporting the RENDER extension, or
		1587	fully opaque on servers not supporting the RENDER EXTENSION.
		1588
		1589	Please note that due to bugs in Xft, specifying alpha values might result
		1590	in garbage being displayed when the X-server does not support the RENDER
		1591	extension.
		1592
		1593	=head1 ENVIRONMENT
		1594
		1595	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
		1596
1118	=over 4	1597	=over 4
1119		1598
1120	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
1121
1122	would yield White on Black, while on I<xterm>(1) it would yield Black
1123	on White.
1124
1125	=back
1126
1127	=head1 ENVIRONMENT
1128
1129	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1130
1131	=over 4
1132
1133	=item B<TERM>	1599	=item B<TERM>
1134		1600
1135	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1601	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1136	resources or on the commandline.	1602	resources or on the command line.
1137		1603
1138	=item B<COLORTERM>	1604	=item B<COLORTERM>
1139		1605
1140	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1606	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1141	compiled with XPM support, and optionally with the added extension	1607	compiled with background image support, and optionally with the added
1142	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1608	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1609	screen.
1143		1610
1144	=item B<COLORFGBG>	1611	=item B<COLORFGBG>
1145		1612
1146	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1613	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	1614	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	1615	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	1616	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@@	1617	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	1618	was compiled with background image support. Libraries like C<ncurses>
1152	(and do) use this information to optimize screen output.	1619	and C<slang> can (and do) use this information to optimize screen output.
1153		1620
1154	=item B<WINDOWID>	1621	=item B<WINDOWID>
1155		1622
1156	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1623	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	1624	window, which usually has subwindows for the scrollbar, the terminal
…		…
1163	C<--with-terminfo=PATH>.	1630	C<--with-terminfo=PATH>.
1164		1631
1165	=item B<DISPLAY>	1632	=item B<DISPLAY>
1166		1633
1167	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1634	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1168	display in it's child processes.	1635	display in its child processes if C<-display> isn't used to override. It
		1636	defaults to C<:0> if it doesn't exist.
1169		1637
1170	=item B<SHELL>	1638	=item B<SHELL>
1171		1639
1172	The shell to be used for command execution, defaults to C</bin/sh>.	1640	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		1641
1183	=item B<RXVT_SOCKET>	1642	=item B<RXVT_SOCKET>
1184		1643
1185	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1644	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1186	@@RXVT_NAME@@d(1).	1645	@@RXVT_NAME@@d(1).
1187		1646
1188	Default C<< $HOME/.rxvt-unicode-<nodename >>.	1647	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1189		1648
1190	=item B<HOME>	1649	=item B<HOME>
1191		1650
1192	Used to locate the default directory for the unix domain socket for	1651	Used to locate the default directory for the unix domain socket for
1193	daemon communications and to locate various resource files (such as	1652	daemon communications and to locate various resource files (such as
1194	C<.Xdefaults>)	1653	C<.Xdefaults>)
1195		1654
1196	=item B<XAPPLRESDIR>	1655	=item B<XAPPLRESDIR>
1197		1656
1198	Directory where various X resource files are being located.	1657	Directory where application-specific X resource files are located.
1199		1658
1200	=item B<XENVIRONMENT>	1659	=item B<XENVIRONMENT>
1201		1660
1202	If set and accessible, gives the name of a X resource file to be loaded by	1661	If set and accessible, gives the name of a X resource file to be loaded by
1203	@@RXVT_NAME@@.	1662	@@RXVT_NAME@@.
…		…
1208		1667
1209	=over 4	1668	=over 4
1210		1669
1211	=item B</usr/lib/X11/rgb.txt>	1670	=item B</usr/lib/X11/rgb.txt>
1212		1671
1213	Color names.	1672	Colour names.
1214		1673
1215	=back	1674	=back
1216		1675
1217	=head1 SEE ALSO	1676	=head1 SEE ALSO
1218		1677
1219	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1678	@@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		1679
1229	=head1 CURRENT PROJECT COORDINATOR	1680	=head1 CURRENT PROJECT COORDINATOR
1230		1681
1231	=over 4	1682	=over 4
1232		1683
1233	=item Project Coordinator	1684	=item Project Coordinator
1234		1685
1235	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1686	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1236		1687
1237	L<http://software.schmorp.de/#rxvt-unicode>	1688	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1238		1689
1239	=back	1690	=back
1240		1691
1241	=head1 AUTHORS	1692	=head1 AUTHORS
1242		1693
…		…
1264		1715
1265	Project Coordinator (changes.txt 2.21a to 2.4.5)	1716	Project Coordinator (changes.txt 2.21a to 2.4.5)
1266		1717
1267	=item Geoff Wing L<< <gcw@pobox.com> >>	1718	=item Geoff Wing L<< <gcw@pobox.com> >>
1268		1719
1269	Rewrote screen display and text selection routines. Project Coordinator	1720	Rewrote screen display and text selection routines.
		1721
1270	(changes.txt 2.4.6 - rxvt-unicode)	1722	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1271		1723
1272	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1724	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1273		1725
1274	Forked rxvt-unicode, rewrote most of the display code and internal	1726	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1275	character handling to store text in unicode, improve xterm	1727	extension, random hacks, numerous bugfixes and extensions.
1276	compatibility and apply numerous other bugfixes and extensions.
1277		1728
1278	Project Coordinator (Changes 1.0 -)	1729	Project Coordinator (Changes 1.0 -)
1279		1730
		1731	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1732
		1733	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
		1734
1280	=back	1735	=back
1281		1736

Diff Legend

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