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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.48 by root, Thu Feb 3 10:24:10 2005 UTC vs.
Revision 1.130 by sasha, Fri Jun 8 20:04:12 2007 UTC

…		…
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	=head1 FREQUENTLY ASKED QUESTIONS	17	=head1 FREQUENTLY ASKED QUESTIONS
18		18
19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of frequently	19	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.	20	frequently asked questions and answer to them and some common
		21	problems. That document is also accessible on the World-Wide-Web at
		22	L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.
21		23
22	=head1 RXVT-UNICODE VS. RXVT	24	=head1 RXVT-UNICODE VS. RXVT
23		25
24	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode	26	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	27	internally. That means it can store and display most scripts in the
26	world. Being a terminal emulator, however, some things are very difficult,	28	world. Being a terminal emulator, however, some things are very difficult,
27	especially cursive scripts such as arabic, vertically written scripts	29	especially cursive scripts such as arabic, vertically written scripts
28	like mongolian or scripts requiring extremely complex combining rules,	30	like mongolian or scripts requiring extremely complex combining rules,
29	like tibetan or devenagari. Don't expect pretty output when using these	31	like tibetan or devenagari. Don't expect pretty output when using these
30	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
31	fine, though. A somewhat difficult case are left-to-right scripts, such	33	fine, though. A somewhat difficult case are right-to-left scripts, such
32	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
33	belong into the application, not the terminal emulator (too many things --	35	belong into the application, not the terminal emulator (too many things --
34	such as cursor-movement while editing -- break otherwise), but that might	36	such as cursor-movement while editing -- break otherwise), but that might
35	change.	37	change.
36		38
37	If you are looking for a terminal that supports more exotic scripts, let	39	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	40	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	41	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	42	because the author couldn't get C<mlterm> to use one font for latin1 and
41	another for japanese.	43	another for japanese.
42		44
43	Therefore another design rationale was the use of multiple fonts to	45	Therefore another design rationale was the use of multiple fonts to
44	display characters: The idea of a single unicode font which many other	46	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	47	programs force onto its users never made sense to me: You should be able
46	to choose any font for any script freely.	48	to choose any font for any script freely.
47		49
48	Apart from that, rxvt-unicode is also much better internationalised than	50	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	51	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	52	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.	53	rxvt. This all in addition to dozens of other small improvements.
52		54
53	It is still faithfully following the original rxvt idea of being lean	55	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	56	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	57	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	58	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	59	from within a single process, which makes startup time very fast and
58	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and	60	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
59	@@RXVT_NAME@@c(1) (client).	61	@@RXVT_NAME@@c(1) (client).
60		62
61	It also makes technical information about escape sequences (which have	63	It also makes technical information about escape sequences (which have
62	been extended) easier accessible: see @@RXVT_NAME@@(7) for technical	64	been extended) more accessible: see @@RXVT_NAME@@(7) for technical
63	reference documentation (escape sequences etc.).	65	reference documentation (escape sequences etc.).
64		66
65	=head1 OPTIONS	67	=head1 OPTIONS
66		68
67	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed	69	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
…		…
91		93
92	Attempt to open a window on the named X display (B<-d> still	94	Attempt to open a window on the named X display (B<-d> still
93	respected). In the absence of this option, the display specified by the	95	respected). In the absence of this option, the display specified by the
94	B<DISPLAY> environment variable is used.	96	B<DISPLAY> environment variable is used.
95		97
		98	=item B<-depth> I<bitdepth>
		99
		100	Compile I<xft>: Attempt to find a visual with the given bit depth;
		101	resource B<depth>.
		102
96	=item B<-geometry> I<geom>	103	=item B<-geometry> I<geom>
97		104
98	Window geometry (B<-g> still respected); resource B<geometry>.	105	Window geometry (B<-g> still respected); resource B<geometry>.
99		106
100	=item B<-rv>\|B<+rv>	107	=item B<-rv>\|B<+rv>
…		…
103		110
104	=item B<-j>\|B<+j>	111	=item B<-j>\|B<+j>
105		112
106	Turn on/off jump scrolling; resource B<jumpScroll>.	113	Turn on/off jump scrolling; resource B<jumpScroll>.
107		114
108	=item B<-ip>\|B<+ip>	115	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>
109		116
110	Turn on/off inheriting parent window's pixmap. Alternative form is	117	Turn on/off inheriting parent window's pixmap. Alternative form is
111	B<-tr>; resource B<inheritPixmap>.	118	B<-tr>; resource B<inheritPixmap>.
112		119
		120	I<Please note that transparency of any kind if completely unsupported by
		121	the author. Don't bug him with installation questions! Read the FAQ (man 7
		122	@@RXVT_NAME@@)!>
		123
113	=item B<-fade> I<number>	124	=item B<-fade> I<number>
114		125
115	Fade the text by the given percentage when focus is lost. resource B<fading>.	126	Fade the text by the given percentage when focus is lost. Small values
		127	fade a little only, 100 completely replaces all colours by the fade
		128	colour; resource B<fading>.
		129
		130	=item B<-fadecolor> I<colour>
		131
		132	Fade to this colour when fading is used (see B<-fade>). The default colour
		133	is opaque black. resource B<fadeColor>.
116		134
117	=item B<-tint> I<colour>	135	=item B<-tint> I<colour>
118		136
119	Tint the transparent background pixmap with the given colour when	137	Tint the transparent background pixmap with the given colour when
120	transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>	138	transparency is enabled with B<-tr> or B<-ip>. This only works for
121	option that can be used to brighten or darken the image in addition to	139	non-tiled backgrounds, currently. See also the B<-sh> option that can be
122	tinting it.	140	used to brighten or darken the image in addition to tinting it; resource
		141	I<tintColor>. Example:
123		142
124	=item B<-sh>	143	@@RXVT_NAME@@ -tr -tint blue -sh 40
125		144
		145	=item B<-sh> I<number>
		146
126	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	147	Darken (0 .. 100) or lighten (-1 .. -100) the transparent
127	background image in addition to tinting it (i.e. B<-tint> must be	148	background image in addition to (or instead of) tinting it;
128	specified, too, e.g. C<-tint white>).	149	resource I<shading>.
		150
		151	=item B<-blt> I<string>
		152
		153	Specify background blending type. If background pixmap is specified
		154	at the same time as transparency - such pixmap will be blended over
		155	transparency image, using method specified. Supported values are :
		156	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
		157	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
		158	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
		159	alpha-blending; resource I<blendType>.
		160
		161	=item B<-blr> I<number>
		162
		163	Apply Gaussian Blur with the specified radius to the transparent
		164	background image; resource I<blurRadius>.
129		165
130	=item B<-bg> I<colour>	166	=item B<-bg> I<colour>
131		167
132	Window background colour; resource B<background>.	168	Window background colour; resource B<background>.
133		169
…		…
135		171
136	Window foreground colour; resource B<foreground>.	172	Window foreground colour; resource B<foreground>.
137		173
138	=item B<-pixmap> I<file[;geom]>	174	=item B<-pixmap> I<file[;geom]>
139		175
140	Compile I<XPM>: Specify XPM file for the background and also optionally	176	Compile I<afterimage>: Specify image file for the background and also
141	specify its scaling with a geometry string. Note you may need to	177	optionally specify its scaling with a geometry string. Note you may need to
142	add quotes to avoid special shell interpretation of the C<;> in the	178	add quotes to avoid special shell interpretation of the C<;> in the
143	command-line; resource B<backgroundPixmap>.	179	command-line; for more details see resource B<backgroundPixmap>.
144		180
145	=item B<-cr> I<colour>	181	=item B<-cr> I<colour>
146		182
147	The cursor colour; resource B<cursorColor>.	183	The cursor colour; resource B<cursorColor>.
148		184
…		…
160	resource B<borderColor>.	196	resource B<borderColor>.
161		197
162	=item B<-fn> I<fontlist>	198	=item B<-fn> I<fontlist>
163		199
164	Select the fonts to be used. This is a comma separated list of font names	200	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	201	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	202	first font defines the cell size for characters; other fonts might be
167	smaller, but not (in general) larger. A (hopefully) reasonable default	203	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.	204	font list is always appended to it. See resource B<font> for more details.
169		205
170	In short, to specify an X11 core font, just specify it's name or prefix it	206	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:>,	207	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
172	e.g.:	208	e.g.:
173		209
174	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	210	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
175	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	211	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
177	See also the question "How does rxvt-unicode choose fonts?" in the FAQ	213	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
178	section of @@RXVT_NAME@@(7).	214	section of @@RXVT_NAME@@(7).
179		215
180	=item B<-fb> I<fontlist>	216	=item B<-fb> I<fontlist>
181		217
182	Compile font-styles: The bold font list to use when bold characters are to	218	Compile I<font-styles>: The bold font list to use when B<bold> characters
183	be printed. See resource B<boldFont> for details.	219	are to be printed. See resource B<boldFont> for details.
184		220
185	=item B<-fi> I<fontlist>	221	=item B<-fi> I<fontlist>
186		222
187	Compile font-styles: The italic font list to use when bold characters are to	223	Compile I<font-styles>: The italic font list to use when I<italic>
188	be printed. See resource B<italicFont> for details.	224	characters are to be printed. See resource B<italicFont> for details.
189		225
190	=item B<-fbi> I<fontlist>	226	=item B<-fbi> I<fontlist>
191		227
192	Compile font-styles: The bold italic font list to use when bold characters are to	228	Compile I<font-styles>: The bold italic font list to use when B<< I<bold
193	be printed. See resource B<boldItalicFont> for details.	229	italic> >> characters are to be printed. See resource B<boldItalicFont>
		230	for details.
		231
		232	=item B<-is>\|B<+is>
		233
		234	Compile I<font-styles>: Bold/Italic font styles imply high intensity
		235	foreground/background (default). See resource B<intensityStyles> for
		236	details.
194		237
195	=item B<-name> I<name>	238	=item B<-name> I<name>
196		239
197	Specify the application name under which resources are to be obtained,	240	Specify the application name under which resources are to be obtained,
198	rather than the default executable file name. Name should not contain	241	rather than the default executable file name. Name should not contain
…		…
236		279
237	Put scrollbar on right/left; resource B<scrollBar_right>.	280	Put scrollbar on right/left; resource B<scrollBar_right>.
238		281
239	=item B<-st>\|B<+st>	282	=item B<-st>\|B<+st>
240		283
241	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	284	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
242	resource B<scrollBar_floating>.	285	resource B<scrollBar_floating>.
243		286
244	=item B<-ptab>\|B<+ptab>	287	=item B<-ptab>\|B<+ptab>
245		288
246	If enabled (default), "Horizontal Tab" characters are being stored as	289	If enabled (default), "Horizontal Tab" characters are being stored as
…		…
277	=item B<-bl>	320	=item B<-bl>
278		321
279	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	322	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	323	if honoured by the WM, the rxvt-unicode window will not have window
281	decorations; resource B<borderLess>.	324	decorations; resource B<borderLess>.
		325
		326	=item B<-override-redirect>
		327
		328	Compile I<frills>: Sets override-redirect on the window; resource
		329	B<override-redirect>.
		330
		331	=item B<-sbg>
		332
		333	Compile I<frills>: Disable the usage of the built-in block graphics/line
		334	drawing characters and just rely on what the specified fonts provide. Use
		335	this if you have a good font and want to use its block graphic glyphs;
		336	resource B<skipBuiltinGlyphs>.
282		337
283	=item B<-lsp> I<number>	338	=item B<-lsp> I<number>
284		339
285	Compile I<frills>: Lines (pixel height) to insert between each row of	340	Compile I<frills>: Lines (pixel height) to insert between each row of
286	the display. Useful to work around font rendering problems; resource	341	the display. Useful to work around font rendering problems; resource
…		…
301	given on the command line. If this option is used, it must be the last	356	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	357	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,	358	run the program specified by the B<SHELL> environment variable or,
304	failing that, I<sh(1)>.	359	failing that, I<sh(1)>.
305		360
		361	Please note that you must specify a program with arguments. If you want to
		362	run shell commands, you have to specify the shell, like this:
		363
		364	@@RXVT_NAME@@ -e sh -c "shell commands"
		365
306	=item B<-title> I<text>	366	=item B<-title> I<text>
307		367
308	Window title (B<-T> still respected); the default title is the basename	368	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	369	of the program specified after the B<-e> option, if any, otherwise the
310	application name; resource B<title>.	370	application name; resource B<title>.
…		…
341	for more info.	401	for more info.
342		402
343	=item B<-tcw>	403	=item B<-tcw>
344		404
345	Change the meaning of triple-click selection with the left mouse	405	Change the meaning of triple-click selection with the left mouse
		406	button. Only effective when the original (non-perl) selection code is
346	button. Instead of selecting a full line it will extend the selection the	407	in-use. Instead of selecting a full line it will extend the selection the
347	end of the logical line only. resource B<tripleclickwords>.	408	end of the logical line only. resource B<tripleclickwords>.
348		409
349	=item B<-insecure>	410	=item B<-insecure>
350		411
351	Enable "insecure" mode, which currently enables most of the escape	412	Enable "insecure" mode, which currently enables most of the escape
…		…
366	=item B<-ssr>\|B<+ssr>	427	=item B<-ssr>\|B<+ssr>
367		428
368	Turn on/off secondary screen scroll (default enabled); resource	429	Turn on/off secondary screen scroll (default enabled); resource
369	B<secondaryScroll>.	430	B<secondaryScroll>.
370		431
		432	=item B<-hold>\|B<+hold>
		433
		434	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		435	will not immediately destroy its window when the program executed within
		436	it exits. Instead, it will wait till it is being killed or closed by the
		437	user; resource B<hold>.
		438
		439	=item B<-keysym.>I<sym> I<string>
		440
		441	Remap a key symbol. See resource B<keysym>.
		442
		443	=item B<-embed> I<windowid>
		444
		445	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
		446	which enables applications to easily embed a terminal.
		447
		448	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
		449	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
		450	quite a bit, so don't expect it to keep some specific state. It's best to
		451	create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
		452
		453	The window will not be destroyed when @@RXVT_NAME@@ exits.
		454
		455	It might be useful to know that @@RXVT_NAME@@ will not close file
		456	descriptors passed to it (except for stdin/out/err, of course), so you
		457	can use file descriptors to communicate with the programs within the
		458	terminal. This works regardless of whether the C<-embed> option was used or
		459	not.
		460
		461	Here is a short Gtk2-perl snippet that illustrates how this option can be
		462	used (a longer example is in F<doc/embed>):
		463
		464	my $rxvt = new Gtk2::Socket;
		465	$rxvt->signal_connect_after (realize => sub {
		466	my $xid = $_[0]->window->get_xid;
		467	system "@@RXVT_NAME@@ -embed $xid &";
		468	});
		469
		470	=item B<-pty-fd> I<file descriptor>
		471
		472	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
		473	pair but instead use the given file descriptor as the tty master. This is
		474	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
		475	without having to run a program within it.
		476
		477	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
		478	entries and will not tinker with pty/tty permissions - you have to do that
		479	yourself if you want that.
		480
		481	As an extremely special case, specifying C<-1> will completely suppress
		482	pty/tty operations.
		483
		484	Here is a example in perl that illustrates how this option can be used (a
		485	longer example is in F<doc/pty-fd>):
		486
		487	use IO::Pty;
		488	use Fcntl;
		489
		490	my $pty = new IO::Pty;
		491	fcntl $pty, F_SETFD, 0; # clear close-on-exec
		492	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		493	close $pty;
		494
		495	# now communicate with rxvt
		496	my $slave = $pty->slave;
		497	while (<$slave>) { print $slave "got <$_>\n" }
		498
371	=item B<-xrm> I<resourcestring>	499	=item B<-pe> I<string>
372		500
373	No effect on rxvt-unicode. Simply passes through an argument to be made	501	Comma-separated list of perl extension scripts to use (or not to use) in
374	available in the instance's argument list. Appears in I<WM_COMMAND> in	502	this terminal instance. See resource B<perl-ext> for details.
375	some window managers.
376		503
377	=back	504	=back
378		505
379	=head1 RESOURCES (available also as long-options)	506	=head1 RESOURCES (available also as long-options)
380		507
381	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	508	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
382	options) compiled into your version.	509	options) compiled into your version.
383		510
384	There are two different methods that @@RXVT_NAME@@ can use to get the	511	You can set and change the resources using X11 tools like B<xrdb>. Many
385	Xresource data: using the X libraries (Xrm*-functions) or internal	512	distribution do also load settings from the B<~/.Xresources> file when X
386	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	513	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
387	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	514	with later settings overwriting earlier ones:
388	resources using X11 tools like B<xset>. Many distribution do also load
389	settings from the B<~/.Xresources> file when X starts.
390		515
391	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>	516	1. system-wide app-defaults file, either locale-dependent OR global
392	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults	517	2. app-defaults file in $XAPPLRESDIR
393	set in XAPPLOADDIR/URxvt (compile-time defined: usually	518	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
394	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	519	4. SCREEN_RESOURCES for the current screen
395	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.	520	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		521
396	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	522	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
397	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows	523	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
398	resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be	524	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
399	easily configured, while the class name B<URxvt> allows resources	525	configured, while the class name B<URxvt> allows resources unique to
400	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	526	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
401	shared between different B<@@RXVT_NAME@@> configurations. If no	527	configurations. If no resources are specified, suitable defaults will
402	resources are specified, suitable defaults will be used. Command-line	528	be used. Command-line arguments can be used to override resource
403	arguments can be used to override resource settings. The following	529	settings. The following resources are supported (you might want to
404	resources are allowed:	530	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		531	extensions not documented here):
405		532
406	=over 4	533	=over 4
		534
		535	=item B<depth:> I<bitdepth>
		536
		537	Compile I<xft>: Attempt to find a visual with the given bit depth;
		538	option B<-depth>.
407		539
408	=item B<geometry:> I<geom>	540	=item B<geometry:> I<geom>
409		541
410	Create the window with the specified X window geometry [default 80x24];	542	Create the window with the specified X window geometry [default 80x24];
411	option B<-geometry>.	543	option B<-geometry>.
…		…
448	Use the specified colour to display underlined characters when the	580	Use the specified colour to display underlined characters when the
449	foreground colour is the default.	581	foreground colour is the default.
450		582
451	=item B<colorRV:> I<colour>	583	=item B<colorRV:> I<colour>
452		584
453	Use the specified colour as the background for reverse video	585	Use the specified colour as the background for reverse video characters
454	characters.	586	when OPTION_HC is disabled (--disable-frills).
455		587
456	=item B<underlineColor:> I<colour>	588	=item B<underlineColor:> I<colour>
457		589
458	If set, use the specified colour as the colour for the underline	590	If set, use the specified colour as the colour for the underline
459	itself. If unset, use the foreground colour.	591	itself. If unset, use the foreground colour.
…		…
485		617
486	B<True>: make the background inherit the parent windows' pixmap, giving	618	B<True>: make the background inherit the parent windows' pixmap, giving
487	artificial transparency. B<False>: do not inherit the parent windows'	619	artificial transparency. B<False>: do not inherit the parent windows'
488	pixmap.	620	pixmap.
489		621
		622	I<Please note that transparency of any kind if completely unsupported by
		623	the author. Don't bug him with installation questions!>
		624
490	=item B<fading:> I<number>	625	=item B<fading:> I<number>
491		626
492	Fade the text by the given percentage when focus is lost.	627	Fade the text by the given percentage when focus is lost; option B<-fade>.
		628
		629	=item B<fadeColor:> I<colour>
		630
		631	Fade to this colour, when fading is used (see B<fading:>). The default
		632	colour is black; option B<-fadecolor>.
493		633
494	=item B<tintColor:> I<colour>	634	=item B<tintColor:> I<colour>
495		635
496	Tint the transparent background pixmap with the given colour.	636	Tint the transparent background pixmap with the given colour; option
		637	B<-tint>.
497		638
498	=item B<shading:> I<number>	639	=item B<shading:> I<number>
499		640
500	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	641	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
501	image in addition to tinting it.	642	in addition to tinting it; option B<-sh>.
		643
		644	=item B<blendType:> I<string>
		645
		646	Specify background blending type; option B<-blt>.
		647
		648	=item B<blurRadius:> I<number>
		649
		650	Apply Gaussian Blurr with the specified radius to the transparent
		651	background image; option B<-blr>.
502		652
503	=item B<scrollColor:> I<colour>	653	=item B<scrollColor:> I<colour>
504		654
505	Use the specified colour for the scrollbar [default #B2B2B2].	655	Use the specified colour for the scrollbar [default #B2B2B2].
506		656
507	=item B<troughColor:> I<colour>	657	=item B<troughColor:> I<colour>
508		658
509	Use the specified colour for the scrollbar's trough area [default	659	Use the specified colour for the scrollbar's trough area [default
510	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	660	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
511		661
512	=item B<borderColor:> I<colour>	662	=item B<borderColor:> I<colour>
513		663
514	The colour of the border around the text area and between the scrollbar	664	The colour of the border around the text area and between the scrollbar
515	and the text.	665	and the text.
516		666
517	=item B<backgroundPixmap:> I<file[;geom]>	667	=item B<backgroundPixmap:> I<file[;geom]>
518		668
519	Use the specified XPM file (note the `.xpm' extension is optional) for	669	Use the specified image file for the background and also optionally
520	the background and also optionally specify its scaling with a geometry	670	specify its scaling with a geometry string B<WxH+X+Y>,
521	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	671	in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
522	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	672	and B<"X" / "Y"> locate the image centre (percent).
523	centre (percent). A scale of 0 displays the image with tiling. A scale	673	A scale of 0 displays the image with tiling. A scale of 1 displays the
524	of 1 displays the image without any scaling. A scale of 2 to 9	674	image without any scaling. A scale of 2 to 9 specifies an integer
525	specifies an integer number of images in that direction. No image will	675	number of images in that direction. No image will be magnified beyond
526	be magnified beyond 10 times its original size. The maximum permitted	676	10 times its original size. The maximum permitted scale is 1000.
527	scale is 1000. [default 0x0+50+50]	677	Special string of B<"auto"> used as a geometry will cause image to be
528		678	automatically scaled to match window size.
529	=item B<menu:> I<file[;tag]>	679	If used in conjunction with B<-tr> option - specified pixmap will be
530		680	blended over transparency image using either alpha-blending, or any
531	Read in the specified menu file (note the `.menu' extension is	681	other blending type, specified with B<-blt "type"> option.
532	optional) and also optionally specify a starting tag to find. See the	682	[default 0x0+50+50]
533	reference documentation for details on the syntax for the menuBar.
534		683
535	=item B<path:> I<path>	684	=item B<path:> I<path>
536		685
537	Specify the colon-delimited search path for finding files (XPM and	686	Specify the colon-delimited search path for finding XPM files.
538	menus), in addition to the paths specified by the B<RXVTPATH> and
539	B<PATH> environment variables.
540		687
541	=item B<font:> I<fontlist>	688	=item B<font:> I<fontlist>
542		689
543	Select the fonts to be used. This is a comma separated list of font	690	Select the fonts to be used. This is a comma separated list of font names
544	names that are used in turn when trying to display Unicode characters.	691	that are checked in order when trying to find glyphs for characters. The
545	The first font defines the cell size for characters; other fonts might	692	first font defines the cell size for characters; other fonts might be
546	be smaller, but not larger. A reasonable default font list is always	693	smaller, but not (in general) larger. A (hopefully) reasonable default
547	appended to it. option B<-fn>.	694	font list is always appended to it; option B<-fn>.
548		695
549	Each font can either be a standard X11 core font (XLFD) name, with	696	Each font can either be a standard X11 core font (XLFD) name, with
550	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.	697	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
551		698
552	In addition, each font can be prefixed with additional hints and	699	In addition, each font can be prefixed with additional hints and
…		…
554	hint currently is C<codeset=codeset-name>, and this is only used for Xft	701	hint currently is C<codeset=codeset-name>, and this is only used for Xft
555	fonts.	702	fonts.
556		703
557	For example, this font resource	704	For example, this font resource
558		705
559	URxvt*font: 9x15bold,\	706	URxvt.font: 9x15bold,\
560	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	707	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
561	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \	708	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
562	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	709	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
563	xft:Code2000:antialias=false	710	xft:Code2000:antialias=false
564		711
…		…
598	not possible, replacement fonts of the desired shape will be tried.	745	not possible, replacement fonts of the desired shape will be tried.
599		746
600	If set, but empty, then this specific style is disabled and the normal	747	If set, but empty, then this specific style is disabled and the normal
601	text font will being used for the given style.	748	text font will being used for the given style.
602		749
		750	=item B<intensityStyles:> I<boolean>
		751
		752	When font styles are not enabled, or this option is enabled (B<True>,
		753	option B<-is>, the default), bold and italic font styles imply high
		754	intensity foreground/background colours. Disabling this option (B<False>,
		755	option B<+is>) disables this behaviour, the high intensity colours are not
		756	reachable.
		757
603	=item B<selectstyle:> I<mode>	758	=item B<selectstyle:> I<mode>
604		759
605	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	760	Set mouse selection style to B<old> which is 2.20, B<oldword> which
606	xterm style with 2.20 old word selection, or anything else which gives	761	is xterm style with 2.20 old word selection, or anything else which
607	xterm style selection.	762	gives xterm style selection. Only effective when the original (non-perl)
		763	selection code is in use.
608		764
609	=item B<scrollstyle:> I<mode>	765	=item B<scrollstyle:> I<mode>
610		766
611	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	767	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
612	the author's favourite..	768	the author's favourite.
613		769
614	=item B<title:> I<string>	770	=item B<title:> I<string>
615		771
616	Set window title string, the default title is the command-line	772	Set window title string, the default title is the command-line
617	specified after the B<-e> option, if any, otherwise the application	773	specified after the B<-e> option, if any, otherwise the application
…		…
626	=item B<mapAlert:> I<boolean>	782	=item B<mapAlert:> I<boolean>
627		783
628	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	784	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
629	de-iconify (map) on receipt of a bell character [default].	785	de-iconify (map) on receipt of a bell character [default].
630		786
		787	=item B<urgentOnBell:> I<boolean>
		788
		789	B<True>: set the urgency hint for the wm on receipt of a bell character.
		790	B<False>: do not set the urgency hint [default].
		791
631	=item B<visualBell:> I<boolean>	792	=item B<visualBell:> I<boolean>
632		793
633	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	794	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
634	B<False>: no visual bell [default]; option B<+vb>.	795	B<False>: no visual bell [default]; option B<+vb>.
635		796
…		…
649		810
650	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	811	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
651	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or	812	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
652	B<Shift-Print> to include the scrollback as well.	813	B<Shift-Print> to include the scrollback as well.
653		814
		815	The string will be interpreted as if typed into the shell as-is.
		816
		817	Example:
		818
		819	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		820
		821	This creates a new file in your home directory with the screen contents
		822	every time you hit C<Print>.
		823
654	=item B<scrollBar:> I<boolean>	824	=item B<scrollBar:> I<boolean>
655		825
656	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	826	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
657	disable the scrollbar; option B<+sb>.	827	disable the scrollbar; option B<+sb>.
658		828
…		…
678	B<+si>.	848	B<+si>.
679		849
680	=item B<scrollWithBuffer:> I<boolean>	850	=item B<scrollWithBuffer:> I<boolean>
681		851
682	B<True>: scroll with scrollback buffer when tty receives new lines (and	852	B<True>: scroll with scrollback buffer when tty receives new lines (and
683	B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll	853	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
684	with scrollback buffer when tty recieves new lines; option B<-sw>.	854	with scrollback buffer when tty receives new lines; option B<+sw>.
685		855
686	=item B<scrollTtyKeypress:> I<boolean>	856	=item B<scrollTtyKeypress:> I<boolean>
687		857
688	B<True>: scroll to bottom when a non-special key is pressed. Special keys	858	B<True>: scroll to bottom when a non-special key is pressed. Special keys
689	are those which are intercepted by rxvt-unicode for special handling and	859	are those which are intercepted by rxvt-unicode for special handling and
…		…
708	=item B<borderLess:> I<boolean>	878	=item B<borderLess:> I<boolean>
709		879
710	Set MWM hints to request a borderless window, i.e. if honoured by the	880	Set MWM hints to request a borderless window, i.e. if honoured by the
711	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.	881	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
712		882
		883	=item B<skipBuiltinGlyphs:> I<boolean>
		884
		885	Compile I<frills>: Disable the usage of the built-in block graphics/line
		886	drawing characters and just rely on what the specified fonts provide. Use
		887	this if you have a good font and want to use its block graphic glyphs;
		888	option B<-sbg>.
		889
713	=item B<termName:> I<termname>	890	=item B<termName:> I<termname>
714		891
715	Specifies the terminal type name to be set in the B<TERM> environment	892	Specifies the terminal type name to be set in the B<TERM> environment
716	variable; option B<-tn>.	893	variable; option B<-tn>.
717		894
…		…
754		931
755	Mouse pointer background colour.	932	Mouse pointer background colour.
756		933
757	=item B<pointerBlankDelay:> I<number>	934	=item B<pointerBlankDelay:> I<number>
758		935
759	Specifies number of seconds before blanking the pointer [default 2].	936	Specifies number of seconds before blanking the pointer [default 2]. Use a
		937	large number (e.g. C<987654321>) to effectively disable the timeout.
760		938
761	=item B<backspacekey:> I<string>	939	=item B<backspacekey:> I<string>
762		940
763	The string to send when the backspace key is pressed. If set to B<DEC>	941	The string to send when the backspace key is pressed. If set to B<DEC>
764	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	942	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
…		…
771	pressed. If unset it will send the sequence traditionally associated	949	pressed. If unset it will send the sequence traditionally associated
772	with the B<Execute> key.	950	with the B<Execute> key.
773		951
774	=item B<cutchars:> I<string>	952	=item B<cutchars:> I<string>
775		953
776	The characters used as delimiters for double-click word selection. The	954	The characters used as delimiters for double-click word selection
777	built-in default:	955	(whitespace delimiting is added automatically if resource is given).
		956
		957	When the perl selection extension is in use (the default if compiled
		958	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		959	characters will be created (if the resource exists, otherwise, no regex
		960	will be created). In this mode, characters outside ISO-8859-1 can be used.
		961
		962	When the selection extension is not used, only ISO-8859-1 characters can
		963	be used. If not specified, the built-in default is used:
778		964
779	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	965	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>
780		966
781	=item B<preeditType:> I<style>	967	=item B<preeditType:> I<style>
782		968
…		…
789	=item B<imLocale:> I<name>	975	=item B<imLocale:> I<name>
790		976
791	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.	977	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
792	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the	978	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
793	input extension to be able to input japanese characters while staying in	979	input extension to be able to input japanese characters while staying in
794	another locale. option B<-imlocale>.	980	another locale; option B<-imlocale>.
795		981
796	=item B<imFont:> I<fontset>	982	=item B<imFont:> I<fontset>
797		983
798	Specify the font-set used for XIM styles C<OverTheSpot> or	984	Specify the font-set used for XIM styles C<OverTheSpot> or
799	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated	985	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
…		…
804		990
805	=item B<tripleclickwords:> I<boolean>	991	=item B<tripleclickwords:> I<boolean>
806		992
807	Change the meaning of triple-click selection with the left mouse	993	Change the meaning of triple-click selection with the left mouse
808	button. Instead of selecting a full line it will extend the selection to	994	button. Instead of selecting a full line it will extend the selection to
809	the end of the logical line only. option B<-tcw>.	995	the end of the logical line only; option B<-tcw>.
810		996
811	=item B<insecure:> I<boolean>	997	=item B<insecure:> I<boolean>
812		998
813	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	999	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
814	echo arbitrary strings like the icon name or the locale. This could be	1000	echo arbitrary strings like the icon name or the locale. This could be
815	abused if somebody gets 8-bit-clean access to your display, whether	1001	abused if somebody gets 8-bit-clean access to your display, whether
816	throuh a mail client displaying mail bodies unfiltered or though	1002	through a mail client displaying mail bodies unfiltered or through
817	write(1). Therefore, these sequences are disabled by default. (Note	1003	write(1) or any other means. Therefore, these sequences are disabled by
818	that other terminals, including xterm, have these sequences	1004	default. (Note that many other terminals, including xterm, have these
819	enabled by default). You can enable them by setting this boolean	1005	sequences enabled by default, which doesn't make it safer, though).
820	resource or specifying B<-insecure> as an option. At the moment, this	1006
821	enabled display-answer, locale, findfont, icon label and window title	1007	You can enable them by setting this boolean resource or specifying
822	requests as well as dynamic menubar dispatch.	1008	B<-insecure> as an option. At the moment, this enables display-answer,
		1009	locale, findfont, icon label and window title requests.
823		1010
824	=item B<modifier:> I<modifier>	1011	=item B<modifier:> I<modifier>
825		1012
826	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	1013	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
827	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	1014	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
831		1018
832	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	1019	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
833	character is passed through. It may contain escape values as described	1020	character is passed through. It may contain escape values as described
834	in the entry on B<keysym> following.	1021	in the entry on B<keysym> following.
835		1022
836	=item B<secondaryScreen:> I<bool>	1023	=item B<secondaryScreen:> I<boolean>
837		1024
838	Turn on/off secondary screen (default enabled).	1025	Turn on/off secondary screen (default enabled).
839		1026
840	=item B<secondaryScroll:> I<bool>	1027	=item B<secondaryScroll:> I<boolean>
841		1028
842	Turn on/off secondary screen scroll (default enabled). If the this	1029	Turn on/off secondary screen scroll (default enabled). If this
843	option is enabled, scrolls on the secondary screen will change the	1030	option is enabled, scrolls on the secondary screen will change the
844	scrollback buffer and switching to/from the secondary screen will	1031	scrollback buffer and switching to/from the secondary screen will
845	instead scroll the screen up.	1032	instead scroll the screen up.
		1033
		1034	=item B<hold>: I<boolean>
		1035
		1036	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		1037	will not immediately destroy its window when the program executed within
		1038	it exits. Instead, it will wait till it is being killed or closed by the
		1039	user.
846		1040
847	=item B<keysym.>I<sym>: I<string>	1041	=item B<keysym.>I<sym>: I<string>
848		1042
849	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1043	Compile I<frills>: Associate I<string> with keysym I<sym>. The
850	intervening resource name B<keysym.> cannot be omitted.	1044	intervening resource name B<keysym.> cannot be omitted.
…		…
868		1062
869	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1063	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
870	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1064	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
871	C<\000>: octal number) or verbatim control characters (C<^?>: delete,	1065	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
872	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it	1066	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
873	can start or end with whitespace.	1067	can start or end with whitespace. B<This feature is deprecated and will
		1068	be removed>.
874		1069
875	Please note that you need to double the C<\> when using	1070	Please note that you need to double the C<\> in resource files, as
876	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can	1071	Xlib itself does its own de-escaping (you can use C<\033> instead of
877	use C<\033> instead of C<\e> (and so on), which will work with both Xt and	1072	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
878	@@RXVT_NAME@@'s own processing).	1073	processing).
879		1074
880	You can define a range of keysyms in one shot by providing a I<string>	1075	You can define a range of keysyms in one shot by providing a I<string>
881	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1076	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
882	should be a character not used by the strings.	1077	should be a character not used by the strings.
883		1078
884	Its usage can be demonstrated by an example:	1079	Its usage can be demonstrated by an example:
885		1080
886	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1081	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
…		…
896	example the following means "change the current locale to C<zh_CN.GBK>	1091	example the following means "change the current locale to C<zh_CN.GBK>
897	when Control-Meta-c is being pressed":	1092	when Control-Meta-c is being pressed":
898		1093
899	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1094	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
900		1095
		1096	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1097	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1098	manpage. For example, the F<selection> extension (activated via
		1099	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1100
		1101	URxvt.keysym.M-C-c: perl:selection:rot13
		1102
		1103	Due the the large number of modifier combinations, a defined key mapping
		1104	will match if at I<at least> the specified identifiers are being set, and
		1105	no other key mappings with those and more bits are being defined. That
		1106	means that defining a key map for C<a> will automatically provide
		1107	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		1108	mappings themselves.
		1109
		1110	Unfortunately, this will override built-in key mappings. For example
		1111	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		1112	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		1113	user-defined keymap using the C<builtin:> replacement:
		1114
		1115	URxvt.keysym.Insert: <my insert key sequence>
		1116	URxvt.keysym.S-Insert: builtin:
		1117
		1118	The first line defines a mapping for C<Insert> and I<any> combination
		1119	of modifiers. The second line re-establishes the default mapping for
		1120	C<Shift-Insert>.
		1121
901	The following example will map Control-Meta-1 and Control-Meta-2 to	1122	The following example will map Control-Meta-1 and Control-Meta-2 to
902	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited	1123	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
903	font-switching at runtime:	1124	font-switching at runtime:
904		1125
905	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1126	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
…		…
908	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1129	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
909	info):	1130	info):
910		1131
911	URxvt.keysym.M-C-3: command:\033[8;25;80t	1132	URxvt.keysym.M-C-3: command:\033[8;25;80t
912	URxvt.keysym.M-C-4: command:\033[8;48;110t	1133	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1134
		1135	=item B<perl-ext-common>: I<string>
		1136
		1137	=item B<perl-ext>: I<string>
		1138
		1139	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1140	use in this terminal instance; option B<-pe>.
		1141
		1142	Extension names can be prefixed with a C<-> sign to prohibit using
		1143	them. This can be useful to selectively disable some extensions loaded
		1144	by default, or specified via the C<perl-ext-common> resource. For
		1145	example, C<default,-selection> will use all the default extension except
		1146	C<selection>.
		1147
		1148	Extension names can also be followed by an argument in angle brackets
		1149	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1150	searchable scrollback to Alt/Meta-s). Mentioning the same extension
		1151	multiple times with different arguments will pass multiple arguments to
		1152	the extension.
		1153
		1154	Each extension is looked up in the library directories, loaded if
		1155	necessary, and bound to the current terminal instance.
		1156
		1157	If both of these resources are the empty string, then the perl
		1158	interpreter will not be initialized. The idea behind two options is that
		1159	B<perl-ext-common> will be used for extensions that should be available to
		1160	all instances, while B<perl-ext> is used for specific instances.
		1161
		1162	=item B<perl-eval>: I<string>
		1163
		1164	Perl code to be evaluated when all extensions have been registered. See
		1165	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
		1166	will be ignored when running setuid/setgid.
		1167
		1168	=item B<perl-lib>: I<path>
		1169
		1170	Colon-separated list of additional directories that hold extension
		1171	scripts. When looking for extensions specified by the C<perl> resource,
		1172	@@RXVT_NAME@@ will first look in these directories and then in
		1173	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
		1174	will be ignored when running setuid/setgid.
		1175
		1176	See the @@RXVT_NAME@@perl(3) manpage.
		1177
		1178	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1179
		1180	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1181	details.
		1182
		1183	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1184
		1185	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1186	for details.
		1187
		1188	=item B<searchable-scrollback:> I<keysym>
		1189
		1190	Sets the hotkey that starts the incremental scrollback buffer search
		1191	(default: C<M-s>).
		1192
		1193	=item B<urlLauncher>: I<string>
		1194
		1195	Specifies the program to be started with a URL argument. Used by the
		1196	C<selection-popup> and C<matcher> perl extensions.
		1197
		1198	=item B<transient-for>: I<windowid>
		1199
		1200	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1201
		1202	=item B<override-redirect>: I<boolean>
		1203
		1204	Compile I<frills>: Sets override-redirect for the terminal window, making
		1205	it almost invisible to window managers; option B<-override-redirect>.
913		1206
914	=back	1207	=back
915		1208
916	=head1 THE SCROLLBAR	1209	=head1 THE SCROLLBAR
917		1210
…		…
931	the normal text selection/insertion, hold either the Shift or the Meta	1224	the normal text selection/insertion, hold either the Shift or the Meta
932	(Alt) key while performing the desired mouse action.	1225	(Alt) key while performing the desired mouse action.
933		1226
934	If mouse reporting mode is active, the normal scrollbar actions are	1227	If mouse reporting mode is active, the normal scrollbar actions are
935	disabled -- on the assumption that we are using a fullscreen	1228	disabled -- on the assumption that we are using a fullscreen
936	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	1229	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
937	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	1230	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
938	up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down),	1231	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
939	respectively.	1232	respectively.
940		1233
941	=head1 TEXT SELECTION AND INSERTION	1234	=head1 THE SELECTION: SELECTING AND PASTING TEXT
942		1235
943	The behaviour of text selection and insertion mechanism is similar to	1236	The behaviour of text selection and insertion/pasting mechanism is similar
944	I<xterm>(1).	1237	to I<xterm>(1).
945		1238
946	=over 4	1239	=over 4
947		1240
948	=item B<Selection>:	1241	=item B<Selecting>:
949		1242
950	Left click at the beginning of the region, drag to the end of the region	1243	Left click at the beginning of the region, drag to the end of the region
951	and release; Right click to extend the marked region; Left double-click	1244	and release; Right click to extend the marked region; Left double-click
952	to select a word; Left triple-click to select the entire logical line	1245	to select a word; Left triple-click to select the entire logical line
953	(which can span multiple screen lines), unless modified by resource	1246	(which can span multiple screen lines), unless modified by resource
954	B<tripleclickwords>.	1247	B<tripleclickwords>.
955		1248
956	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1249	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
957	(Compile: I<frills>) will create a rectangular selection instead of a normal	1250	(Compile: I<frills>) will create a rectangular selection instead of a
958	one.	1251	normal one. In this mode, every selected row becomes its own line in the
		1252	selection, and trailing whitespace is visually underlined and removed from
		1253	the selection.
959		1254
960	=item B<Insertion>:	1255	=item B<Pasting>:
961		1256
962	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1257	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
963	an B<@@RXVT_NAME@@> window causes the current text selection to be	1258	window causes the value of the PRIMARY selection (or CLIPBOARD with the
964	inserted as if it had been typed on the keyboard.	1259	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1260
		1261	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1262	inserted too.
965		1263
966	=back	1264	=back
967		1265
968	=head1 CHANGING FONTS	1266	=head1 CHANGING FONTS
969		1267
970	Changing fonts (or font sizes, respectively) via the keypad is not yet	1268	Changing fonts (or font sizes, respectively) via the keypad is not yet
971	supported in rxvt-unicode. Bug me if you need this.	1269	supported in rxvt-unicode. Bug me if you need this.
972		1270
973	You can, however, switch fonts at runtime using escape sequences (and	1271	You can, however, switch fonts at runtime using escape sequences, e.g.:
974	therefore using the menubar), e.g.:
975		1272
976	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1273	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1274
		1275	You can use keyboard shortcuts, too:
		1276
		1277	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1278	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
977		1279
978	rxvt-unicode will automatically re-apply these fonts to the output so far.	1280	rxvt-unicode will automatically re-apply these fonts to the output so far.
979		1281
980	=head1 ISO 14755 SUPPORT	1282	=head1 ISO 14755 SUPPORT
981		1283
…		…
1009	This mode lets you input characters representing the keycap symbols of	1311	This mode lets you input characters representing the keycap symbols of
1010	your keyboard, if representable in the current locale encoding.	1312	your keyboard, if representable in the current locale encoding.
1011		1313
1012	Start by pressing C<Control> and C<Shift> together, then releasing	1314	Start by pressing C<Control> and C<Shift> together, then releasing
1013	them. The next special key (cursor keys, home etc.) you enter will not	1315	them. The next special key (cursor keys, home etc.) you enter will not
1014	invoke it's usual function but instead will insert the corresponding	1316	invoke its usual function but instead will insert the corresponding
1015	keycap symbol. The symbol will only be entered when the key has been	1317	keycap symbol. The symbol will only be entered when the key has been
1016	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1318	released, otherwise pressing e.g. C<Shift> would enter the symbol for
1017	C<ISO Level 2 Switch>, although your intention might have been to enter a	1319	C<ISO Level 2 Switch>, although your intention might have been to enter a
1018	reverse tab (Shift-Tab).	1320	reverse tab (Shift-Tab).
1019		1321
…		…
1052	=head1 COLORS AND GRAPHICS	1354	=head1 COLORS AND GRAPHICS
1053		1355
1054	In addition to the default foreground and background colours,	1356	In addition to the default foreground and background colours,
1055	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1357	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1056	high-intensity bold/blink versions of the same). Here is a list of the	1358	high-intensity bold/blink versions of the same). Here is a list of the
1057	colours with their B<rgb.txt> names.	1359	colours with their names.
1058		1360
1059	=begin table	1361	=begin table
1060		1362
1061	B<color0> (black) = Black	1363	B<color0> (black) = Black
1062	B<color1> (red) = Red3	1364	B<color1> (red) = Red3
…		…
1082	It is also possible to specify the colour values of B<foreground>,	1384	It is also possible to specify the colour values of B<foreground>,
1083	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1385	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1084	a number 0-15, as a convenient shorthand to reference the colour name of	1386	a number 0-15, as a convenient shorthand to reference the colour name of
1085	color0-color15.	1387	color0-color15.
1086		1388
		1389	In addition to the colours defined above, @@RXVT_NAME@@ offers an
		1390	additional 72 colours. The first 64 of those (with indices 16 to 79)
		1391	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
		1392	16>), followed by 8 additional shades of gray (with indices 80 to 87).
		1393
		1394	Together, all those colours implement the 88 colour xterm colours. Only
		1395	the first 16 can be changed using resources currently, the rest can only
		1396	be changed via command sequences ("escape codes").
		1397
1087	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1398	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1088	always swapping the foreground/background colours. This is in contrast to	1399	always swapping the foreground/background colours. This is in contrast to
1089	I<xterm>(1) where the colours are only swapped if they have not otherwise	1400	I<xterm>(1) where the colours are only swapped if they have not otherwise
1090	been specified. For example,	1401	been specified. For example,
1091		1402
…		…
1096	would yield White on Black, while on I<xterm>(1) it would yield Black	1407	would yield White on Black, while on I<xterm>(1) it would yield Black
1097	on White.	1408	on White.
1098		1409
1099	=back	1410	=back
1100		1411
		1412	=head2 ALPHA CHANNEL SUPPORT
		1413
		1414	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1415	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
		1416	(recommended, but B<MUST> have 4 digits/component) colour specifications,
		1417	in addition to the ones provided by X, where the additional A component
		1418	specifies opacity (alpha) values. The minimum value of C<0> is completely
		1419	transparent). You can also prefix any color with C<[percent]>, where
		1420	C<percent> is a decimal percentage (0-100) that specifies the opacity of
		1421	the color, where C<0> is completely transparent and C<100> is completelxy
		1422	opaque.
		1423
		1424	You probably need to specify B<"-depth 32">, too, and have the luck that
		1425	your X-server uses ARGB pixel layout, as X is far from just supporting
		1426	ARGB visuals out of the box, and rxvt-unicode just fudges around.
		1427
		1428	For example, the following selects an almost completely transparent red
		1429	background, and an almost opaque pink foreground:
		1430
		1431	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
		1432
		1433	I<Please note that transparency of any kind if completely unsupported by
		1434	the author. Don't bug him with installation questions!>
		1435
1101	=head1 ENVIRONMENT	1436	=head1 ENVIRONMENT
1102		1437
1103	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>	1438	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1104	and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X	1439
1105	window id number of the B<@@RXVT_NAME@@> window and it also uses and	1440	=over 4
1106	sets the environment variable B<DISPLAY> to specify which display	1441
1107	terminal to use. B<@@RXVT_NAME@@> uses the environment variables	1442	=item B<TERM>
1108	B<RXVTPATH> and B<PATH> to find XPM files.	1443
		1444	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
		1445	resources or on the command line.
		1446
		1447	=item B<COLORTERM>
		1448
		1449	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
		1450	compiled with XPM support, and optionally with the added extension
		1451	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
		1452
		1453	=item B<COLORFGBG>
		1454
		1455	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
		1456	the colour code used as default foreground/text colour (or the string
		1457	C<default> to indicate that the default-colour escape sequence is to be
		1458	used), C<bg> is the colour code used as default background colour (or the
		1459	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1460	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
		1461	(and do) use this information to optimize screen output.
		1462
		1463	=item B<WINDOWID>
		1464
		1465	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
		1466	window, which usually has subwindows for the scrollbar, the terminal
		1467	window and so on).
		1468
		1469	=item B<TERMINFO>
		1470
		1471	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1472	C<--with-terminfo=PATH>.
		1473
		1474	=item B<DISPLAY>
		1475
		1476	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
		1477	display in its child processes.
		1478
		1479	=item B<SHELL>
		1480
		1481	The shell to be used for command execution, defaults to C</bin/sh>.
		1482
		1483	=item B<RXVT_SOCKET>
		1484
		1485	The unix domain socket path used by @@RXVT_NAME@@c(1) and
		1486	@@RXVT_NAME@@d(1).
		1487
		1488	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
		1489
		1490	=item B<HOME>
		1491
		1492	Used to locate the default directory for the unix domain socket for
		1493	daemon communications and to locate various resource files (such as
		1494	C<.Xdefaults>)
		1495
		1496	=item B<XAPPLRESDIR>
		1497
		1498	Directory where various X resource files are being located.
		1499
		1500	=item B<XENVIRONMENT>
		1501
		1502	If set and accessible, gives the name of a X resource file to be loaded by
		1503	@@RXVT_NAME@@.
		1504
		1505	=back
1109		1506
1110	=head1 FILES	1507	=head1 FILES
1111		1508
1112	=over 4	1509	=over 4
1113		1510
…		…
1117		1514
1118	=back	1515	=back
1119		1516
1120	=head1 SEE ALSO	1517	=head1 SEE ALSO
1121		1518
1122	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1519	@@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)
1123
1124	=head1 BUGS
1125
1126	Check the BUGS file for an up-to-date list.
1127
1128	Cursor change support is not yet implemented.
1129
1130	Click-and-drag doesn't work with X11 mouse report overriding.
1131		1520
1132	=head1 CURRENT PROJECT COORDINATOR	1521	=head1 CURRENT PROJECT COORDINATOR
1133		1522
1134	=over 4	1523	=over 4
1135		1524
1136	=item Project Coordinator	1525	=item Project Coordinator
1137		1526
1138	@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@>	1527	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1139		1528
1140	=item Web page maintainter	1529	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1141
1142	@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1143
1144	L<@@RXVT_WEBPAGE@@>
1145		1530
1146	=back	1531	=back
1147		1532
1148	=head1 AUTHORS	1533	=head1 AUTHORS
1149		1534
…		…
1171		1556
1172	Project Coordinator (changes.txt 2.21a to 2.4.5)	1557	Project Coordinator (changes.txt 2.21a to 2.4.5)
1173		1558
1174	=item Geoff Wing L<< <gcw@pobox.com> >>	1559	=item Geoff Wing L<< <gcw@pobox.com> >>
1175		1560
1176	Rewrote screen display and text selection routines. Project Coordinator	1561	Rewrote screen display and text selection routines.
		1562
1177	(changes.txt 2.4.6 - rxvt-unicode)	1563	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1178		1564
1179	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>	1565	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1180		1566
1181	Forked rxvt-unicode, rewrote most of the display code and internal	1567	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1182	character handling to store text in unicode, improve xterm	1568	extension, random hacks, numerous bugfixes and extensions.
1183	compatibility and apply numerous other bugfixes and extensions.
1184		1569
1185	Project Coordinator (Changes 1.0 -)	1570	Project Coordinator (Changes 1.0 -)
1186		1571
		1572	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1573
		1574	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
		1575
1187	=back	1576	=back
1188		1577

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.48 by root, Thu Feb 3 10:24:10 2005 UTC vs. Revision 1.130 by sasha, Fri Jun 8 20:04:12 2007 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.48 by root, Thu Feb 3 10:24:10 2005 UTC vs.
Revision 1.130 by sasha, Fri Jun 8 20:04:12 2007 UTC