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

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.75 by root, Tue Dec 27 01:50:00 2005 UTC vs. Revision 1.213 by sf-exg, Sat Feb 4 21:47:06 2012 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.75 by root, Tue Dec 27 01:50:00 2005 UTC vs.
Revision 1.213 by sf-exg, Sat Feb 4 21:47:06 2012 UTC