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

Diff Legend

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