[ViewVC] Diff of: 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.129 by root, Mon May 28 20:34:56 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:
		142
		143	@@RXVT_NAME@@ -tr -tint blue -sh 40
123		144
124	=item B<-sh>	145	=item B<-sh>
125		146
126	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	147	I<number> 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 tinting it (i.e. B<-tint> must be
128	specified, too, e.g. C<-tint white>).	149	specified, too, e.g. C<-tint white>); resource I<shading>.
129		150
130	=item B<-bg> I<colour>	151	=item B<-bg> I<colour>
131		152
132	Window background colour; resource B<background>.	153	Window background colour; resource B<background>.
133		154
…		…
160	resource B<borderColor>.	181	resource B<borderColor>.
161		182
162	=item B<-fn> I<fontlist>	183	=item B<-fn> I<fontlist>
163		184
164	Select the fonts to be used. This is a comma separated list of font names	185	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	186	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	187	first font defines the cell size for characters; other fonts might be
167	smaller, but not (in general) larger. A (hopefully) reasonable default	188	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.	189	font list is always appended to it. See resource B<font> for more details.
169		190
170	In short, to specify an X11 core font, just specify it's name or prefix it	191	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:>,	192	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
172	e.g.:	193	e.g.:
173		194
174	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	195	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
175	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	196	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
177	See also the question "How does rxvt-unicode choose fonts?" in the FAQ	198	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
178	section of @@RXVT_NAME@@(7).	199	section of @@RXVT_NAME@@(7).
179		200
180	=item B<-fb> I<fontlist>	201	=item B<-fb> I<fontlist>
181		202
182	Compile font-styles: The bold font list to use when bold characters are to	203	Compile I<font-styles>: The bold font list to use when B<bold> characters
183	be printed. See resource B<boldFont> for details.	204	are to be printed. See resource B<boldFont> for details.
184		205
185	=item B<-fi> I<fontlist>	206	=item B<-fi> I<fontlist>
186		207
187	Compile font-styles: The italic font list to use when bold characters are to	208	Compile I<font-styles>: The italic font list to use when I<italic>
188	be printed. See resource B<italicFont> for details.	209	characters are to be printed. See resource B<italicFont> for details.
189		210
190	=item B<-fbi> I<fontlist>	211	=item B<-fbi> I<fontlist>
191		212
192	Compile font-styles: The bold italic font list to use when bold characters are to	213	Compile I<font-styles>: The bold italic font list to use when B<< I<bold
193	be printed. See resource B<boldItalicFont> for details.	214	italic> >> characters are to be printed. See resource B<boldItalicFont>
		215	for details.
		216
		217	=item B<-is>\|B<+is>
		218
		219	Compile I<font-styles>: Bold/Italic font styles imply high intensity
		220	foreground/background (default). See resource B<intensityStyles> for
		221	details.
194		222
195	=item B<-name> I<name>	223	=item B<-name> I<name>
196		224
197	Specify the application name under which resources are to be obtained,	225	Specify the application name under which resources are to be obtained,
198	rather than the default executable file name. Name should not contain	226	rather than the default executable file name. Name should not contain
…		…
236		264
237	Put scrollbar on right/left; resource B<scrollBar_right>.	265	Put scrollbar on right/left; resource B<scrollBar_right>.
238		266
239	=item B<-st>\|B<+st>	267	=item B<-st>\|B<+st>
240		268
241	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	269	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
242	resource B<scrollBar_floating>.	270	resource B<scrollBar_floating>.
243		271
244	=item B<-ptab>\|B<+ptab>	272	=item B<-ptab>\|B<+ptab>
245		273
246	If enabled (default), "Horizontal Tab" characters are being stored as	274	If enabled (default), "Horizontal Tab" characters are being stored as
…		…
277	=item B<-bl>	305	=item B<-bl>
278		306
279	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	307	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	308	if honoured by the WM, the rxvt-unicode window will not have window
281	decorations; resource B<borderLess>.	309	decorations; resource B<borderLess>.
		310
		311	=item B<-override-redirect>
		312
		313	Compile I<frills>: Sets override-redirect on the window; resource
		314	B<override-redirect>.
		315
		316	=item B<-sbg>
		317
		318	Compile I<frills>: Disable the usage of the built-in block graphics/line
		319	drawing characters and just rely on what the specified fonts provide. Use
		320	this if you have a good font and want to use its block graphic glyphs;
		321	resource B<skipBuiltinGlyphs>.
282		322
283	=item B<-lsp> I<number>	323	=item B<-lsp> I<number>
284		324
285	Compile I<frills>: Lines (pixel height) to insert between each row of	325	Compile I<frills>: Lines (pixel height) to insert between each row of
286	the display. Useful to work around font rendering problems; resource	326	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	341	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	342	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,	343	run the program specified by the B<SHELL> environment variable or,
304	failing that, I<sh(1)>.	344	failing that, I<sh(1)>.
305		345
		346	Please note that you must specify a program with arguments. If you want to
		347	run shell commands, you have to specify the shell, like this:
		348
		349	@@RXVT_NAME@@ -e sh -c "shell commands"
		350
306	=item B<-title> I<text>	351	=item B<-title> I<text>
307		352
308	Window title (B<-T> still respected); the default title is the basename	353	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	354	of the program specified after the B<-e> option, if any, otherwise the
310	application name; resource B<title>.	355	application name; resource B<title>.
…		…
328		373
329	Compile I<XIM>: input method name. resource B<inputMethod>.	374	Compile I<XIM>: input method name. resource B<inputMethod>.
330		375
331	=item B<-imlocale> I<string>	376	=item B<-imlocale> I<string>
332		377
333	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	378	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	379	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	380	input extension to be able to input japanese characters while staying in
336	another locale.	381	another locale. resource B<imLocale>.
		382
		383	=item B<-imfont> I<fontset>
		384
		385	Set the font set to use for the X Input Method, see resource B<imFont>
		386	for more info.
		387
		388	=item B<-tcw>
		389
		390	Change the meaning of triple-click selection with the left mouse
		391	button. Only effective when the original (non-perl) selection code is
		392	in-use. Instead of selecting a full line it will extend the selection the
		393	end of the logical line only. resource B<tripleclickwords>.
337		394
338	=item B<-insecure>	395	=item B<-insecure>
339		396
340	Enable "insecure" mode, which currently enables most of the escape	397	Enable "insecure" mode, which currently enables most of the escape
341	sequences that echo strings. See the resource B<insecure> for more	398	sequences that echo strings. See the resource B<insecure> for more
…		…
355	=item B<-ssr>\|B<+ssr>	412	=item B<-ssr>\|B<+ssr>
356		413
357	Turn on/off secondary screen scroll (default enabled); resource	414	Turn on/off secondary screen scroll (default enabled); resource
358	B<secondaryScroll>.	415	B<secondaryScroll>.
359		416
		417	=item B<-hold>\|B<+hold>
		418
		419	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		420	will not immediately destroy its window when the program executed within
		421	it exits. Instead, it will wait till it is being killed or closed by the
		422	user; resource B<hold>.
		423
		424	=item B<-keysym.>I<sym> I<string>
		425
		426	Remap a key symbol. See resource B<keysym>.
		427
		428	=item B<-embed> I<windowid>
		429
		430	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
		431	which enables applications to easily embed a terminal.
		432
		433	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
		434	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
		435	quite a bit, so don't expect it to keep some specific state. It's best to
		436	create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
		437
		438	The window will not be destroyed when @@RXVT_NAME@@ exits.
		439
		440	It might be useful to know that @@RXVT_NAME@@ will not close file
		441	descriptors passed to it (except for stdin/out/err, of course), so you
		442	can use file descriptors to communicate with the programs within the
		443	terminal. This works regardless of whether the C<-embed> option was used or
		444	not.
		445
		446	Here is a short Gtk2-perl snippet that illustrates how this option can be
		447	used (a longer example is in F<doc/embed>):
		448
		449	my $rxvt = new Gtk2::Socket;
		450	$rxvt->signal_connect_after (realize => sub {
		451	my $xid = $_[0]->window->get_xid;
		452	system "@@RXVT_NAME@@ -embed $xid &";
		453	});
		454
		455	=item B<-pty-fd> I<file descriptor>
		456
		457	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
		458	pair but instead use the given file descriptor as the tty master. This is
		459	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
		460	without having to run a program within it.
		461
		462	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
		463	entries and will not tinker with pty/tty permissions - you have to do that
		464	yourself if you want that.
		465
		466	As an extremely special case, specifying C<-1> will completely suppress
		467	pty/tty operations.
		468
		469	Here is a example in perl that illustrates how this option can be used (a
		470	longer example is in F<doc/pty-fd>):
		471
		472	use IO::Pty;
		473	use Fcntl;
		474
		475	my $pty = new IO::Pty;
		476	fcntl $pty, F_SETFD, 0; # clear close-on-exec
		477	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		478	close $pty;
		479
		480	# now communicate with rxvt
		481	my $slave = $pty->slave;
		482	while (<$slave>) { print $slave "got <$_>\n" }
		483
360	=item B<-xrm> I<resourcestring>	484	=item B<-pe> I<string>
361		485
362	No effect on rxvt-unicode. Simply passes through an argument to be made	486	Comma-separated list of perl extension scripts to use (or not to use) in
363	available in the instance's argument list. Appears in I<WM_COMMAND> in	487	this terminal instance. See resource B<perl-ext> for details.
364	some window managers.
365		488
366	=back	489	=back
367		490
368	=head1 RESOURCES (available also as long-options)	491	=head1 RESOURCES (available also as long-options)
369		492
370	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	493	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
371	options) compiled into your version.	494	options) compiled into your version.
372		495
373	There are two different methods that @@RXVT_NAME@@ can use to get the	496	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	497	distribution do also load settings from the B<~/.Xresources> file when X
375	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	498	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	499	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		500
380	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>	501	1. system-wide app-defaults file, either locale-dependent OR global
381	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults	502	2. app-defaults file in $XAPPLRESDIR
382	set in XAPPLOADDIR/URxvt (compile-time defined: usually	503	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
383	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	504	4. SCREEN_RESOURCES for the current screen
384	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.	505	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		506
385	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	507	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	508	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	509	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	510	configured, while the class name B<URxvt> allows resources unique to
389	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	511	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
390	shared between different B<@@RXVT_NAME@@> configurations. If no	512	configurations. If no resources are specified, suitable defaults will
391	resources are specified, suitable defaults will be used. Command-line	513	be used. Command-line arguments can be used to override resource
392	arguments can be used to override resource settings. The following	514	settings. The following resources are supported (you might want to
393	resources are allowed:	515	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		516	extensions not documented here):
394		517
395	=over 4	518	=over 4
		519
		520	=item B<depth:> I<bitdepth>
		521
		522	Compile I<xft>: Attempt to find a visual with the given bit depth;
		523	option B<-depth>.
396		524
397	=item B<geometry:> I<geom>	525	=item B<geometry:> I<geom>
398		526
399	Create the window with the specified X window geometry [default 80x24];	527	Create the window with the specified X window geometry [default 80x24];
400	option B<-geometry>.	528	option B<-geometry>.
…		…
437	Use the specified colour to display underlined characters when the	565	Use the specified colour to display underlined characters when the
438	foreground colour is the default.	566	foreground colour is the default.
439		567
440	=item B<colorRV:> I<colour>	568	=item B<colorRV:> I<colour>
441		569
442	Use the specified colour as the background for reverse video	570	Use the specified colour as the background for reverse video characters
443	characters.	571	when OPTION_HC is disabled (--disable-frills).
444		572
445	=item B<underlineColor:> I<colour>	573	=item B<underlineColor:> I<colour>
446		574
447	If set, use the specified colour as the colour for the underline	575	If set, use the specified colour as the colour for the underline
448	itself. If unset, use the foreground colour.	576	itself. If unset, use the foreground colour.
…		…
474		602
475	B<True>: make the background inherit the parent windows' pixmap, giving	603	B<True>: make the background inherit the parent windows' pixmap, giving
476	artificial transparency. B<False>: do not inherit the parent windows'	604	artificial transparency. B<False>: do not inherit the parent windows'
477	pixmap.	605	pixmap.
478		606
		607	I<Please note that transparency of any kind if completely unsupported by
		608	the author. Don't bug him with installation questions!>
		609
479	=item B<fading:> I<number>	610	=item B<fading:> I<number>
480		611
481	Fade the text by the given percentage when focus is lost.	612	Fade the text by the given percentage when focus is lost; option B<-fade>.
		613
		614	=item B<fadeColor:> I<colour>
		615
		616	Fade to this colour, when fading is used (see B<fading:>). The default
		617	colour is black; option B<-fadecolor>.
482		618
483	=item B<tintColor:> I<colour>	619	=item B<tintColor:> I<colour>
484		620
485	Tint the transparent background pixmap with the given colour.	621	Tint the transparent background pixmap with the given colour; option
		622	B<-tint>.
486		623
487	=item B<shading:> I<number>	624	=item B<shading:> I<number>
488		625
489	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	626	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
490	image in addition to tinting it.	627	in addition to tinting it; option B<-sh>.
491		628
492	=item B<scrollColor:> I<colour>	629	=item B<scrollColor:> I<colour>
493		630
494	Use the specified colour for the scrollbar [default #B2B2B2].	631	Use the specified colour for the scrollbar [default #B2B2B2].
495		632
496	=item B<troughColor:> I<colour>	633	=item B<troughColor:> I<colour>
497		634
498	Use the specified colour for the scrollbar's trough area [default	635	Use the specified colour for the scrollbar's trough area [default
499	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	636	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
500		637
501	=item B<borderColor:> I<colour>	638	=item B<borderColor:> I<colour>
502		639
503	The colour of the border around the text area and between the scrollbar	640	The colour of the border around the text area and between the scrollbar
504	and the text.	641	and the text.
…		…
513	of 1 displays the image without any scaling. A scale of 2 to 9	650	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	651	specifies an integer number of images in that direction. No image will
515	be magnified beyond 10 times its original size. The maximum permitted	652	be magnified beyond 10 times its original size. The maximum permitted
516	scale is 1000. [default 0x0+50+50]	653	scale is 1000. [default 0x0+50+50]
517		654
518	=item B<menu:> I<file[;tag]>
519
520	Read in the specified menu file (note the `.menu' extension is
521	optional) and also optionally specify a starting tag to find. See the
522	reference documentation for details on the syntax for the menuBar.
523
524	=item B<path:> I<path>	655	=item B<path:> I<path>
525		656
526	Specify the colon-delimited search path for finding files (XPM and	657	Specify the colon-delimited search path for finding XPM files.
527	menus), in addition to the paths specified by the B<RXVTPATH> and
528	B<PATH> environment variables.
529		658
530	=item B<font:> I<fontlist>	659	=item B<font:> I<fontlist>
531		660
532	Select the fonts to be used. This is a comma separated list of font	661	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.	662	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	663	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	664	smaller, but not (in general) larger. A (hopefully) reasonable default
536	appended to it. option B<-fn>.	665	font list is always appended to it; option B<-fn>.
537		666
538	Each font can either be a standard X11 core font (XLFD) name, with	667	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:>.	668	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
540		669
541	In addition, each font can be prefixed with additional hints and	670	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	672	hint currently is C<codeset=codeset-name>, and this is only used for Xft
544	fonts.	673	fonts.
545		674
546	For example, this font resource	675	For example, this font resource
547		676
548	URxvt*font: 9x15bold,\	677	URxvt.font: 9x15bold,\
549	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	678	-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, \	679	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
551	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	680	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
552	xft:Code2000:antialias=false	681	xft:Code2000:antialias=false
553		682
…		…
587	not possible, replacement fonts of the desired shape will be tried.	716	not possible, replacement fonts of the desired shape will be tried.
588		717
589	If set, but empty, then this specific style is disabled and the normal	718	If set, but empty, then this specific style is disabled and the normal
590	text font will being used for the given style.	719	text font will being used for the given style.
591		720
		721	=item B<intensityStyles:> I<boolean>
		722
		723	When font styles are not enabled, or this option is enabled (B<True>,
		724	option B<-is>, the default), bold and italic font styles imply high
		725	intensity foreground/background colours. Disabling this option (B<False>,
		726	option B<+is>) disables this behaviour, the high intensity colours are not
		727	reachable.
		728
592	=item B<selectstyle:> I<mode>	729	=item B<selectstyle:> I<mode>
593		730
594	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	731	Set mouse selection style to B<old> which is 2.20, B<oldword> which
595	xterm style with 2.20 old word selection, or anything else which gives	732	is xterm style with 2.20 old word selection, or anything else which
596	xterm style selection.	733	gives xterm style selection. Only effective when the original (non-perl)
		734	selection code is in use.
597		735
598	=item B<scrollstyle:> I<mode>	736	=item B<scrollstyle:> I<mode>
599		737
600	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	738	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
601	the author's favourite..	739	the author's favourite.
602		740
603	=item B<title:> I<string>	741	=item B<title:> I<string>
604		742
605	Set window title string, the default title is the command-line	743	Set window title string, the default title is the command-line
606	specified after the B<-e> option, if any, otherwise the application	744	specified after the B<-e> option, if any, otherwise the application
…		…
615	=item B<mapAlert:> I<boolean>	753	=item B<mapAlert:> I<boolean>
616		754
617	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	755	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].	756	de-iconify (map) on receipt of a bell character [default].
619		757
		758	=item B<urgentOnBell:> I<boolean>
		759
		760	B<True>: set the urgency hint for the wm on receipt of a bell character.
		761	B<False>: do not set the urgency hint [default].
		762
620	=item B<visualBell:> I<boolean>	763	=item B<visualBell:> I<boolean>
621		764
622	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	765	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
623	B<False>: no visual bell [default]; option B<+vb>.	766	B<False>: no visual bell [default]; option B<+vb>.
624		767
…		…
638		781
639	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	782	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	783	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.	784	B<Shift-Print> to include the scrollback as well.
642		785
		786	The string will be interpreted as if typed into the shell as-is.
		787
		788	Example:
		789
		790	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		791
		792	This creates a new file in your home directory with the screen contents
		793	every time you hit C<Print>.
		794
643	=item B<scrollBar:> I<boolean>	795	=item B<scrollBar:> I<boolean>
644		796
645	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	797	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
646	disable the scrollbar; option B<+sb>.	798	disable the scrollbar; option B<+sb>.
647		799
…		…
667	B<+si>.	819	B<+si>.
668		820
669	=item B<scrollWithBuffer:> I<boolean>	821	=item B<scrollWithBuffer:> I<boolean>
670		822
671	B<True>: scroll with scrollback buffer when tty receives new lines (and	823	B<True>: scroll with scrollback buffer when tty receives new lines (and
672	B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll	824	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
673	with scrollback buffer when tty recieves new lines; option B<-sw>.	825	with scrollback buffer when tty receives new lines; option B<+sw>.
674		826
675	=item B<scrollTtyKeypress:> I<boolean>	827	=item B<scrollTtyKeypress:> I<boolean>
676		828
677	B<True>: scroll to bottom when a non-special key is pressed. Special keys	829	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	830	are those which are intercepted by rxvt-unicode for special handling and
…		…
697	=item B<borderLess:> I<boolean>	849	=item B<borderLess:> I<boolean>
698		850
699	Set MWM hints to request a borderless window, i.e. if honoured by the	851	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>.	852	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
701		853
		854	=item B<skipBuiltinGlyphs:> I<boolean>
		855
		856	Compile I<frills>: Disable the usage of the built-in block graphics/line
		857	drawing characters and just rely on what the specified fonts provide. Use
		858	this if you have a good font and want to use its block graphic glyphs;
		859	option B<-sbg>.
		860
702	=item B<termName:> I<termname>	861	=item B<termName:> I<termname>
703		862
704	Specifies the terminal type name to be set in the B<TERM> environment	863	Specifies the terminal type name to be set in the B<TERM> environment
705	variable; option B<-tn>.	864	variable; option B<-tn>.
706		865
…		…
743		902
744	Mouse pointer background colour.	903	Mouse pointer background colour.
745		904
746	=item B<pointerBlankDelay:> I<number>	905	=item B<pointerBlankDelay:> I<number>
747		906
748	Specifies number of seconds before blanking the pointer [default 2].	907	Specifies number of seconds before blanking the pointer [default 2]. Use a
		908	large number (e.g. C<987654321>) to effectively disable the timeout.
749		909
750	=item B<backspacekey:> I<string>	910	=item B<backspacekey:> I<string>
751		911
752	The string to send when the backspace key is pressed. If set to B<DEC>	912	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>	913	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
…		…
760	pressed. If unset it will send the sequence traditionally associated	920	pressed. If unset it will send the sequence traditionally associated
761	with the B<Execute> key.	921	with the B<Execute> key.
762		922
763	=item B<cutchars:> I<string>	923	=item B<cutchars:> I<string>
764		924
765	The characters used as delimiters for double-click word selection. The	925	The characters used as delimiters for double-click word selection
766	built-in default:	926	(whitespace delimiting is added automatically if resource is given).
		927
		928	When the perl selection extension is in use (the default if compiled
		929	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		930	characters will be created (if the resource exists, otherwise, no regex
		931	will be created). In this mode, characters outside ISO-8859-1 can be used.
		932
		933	When the selection extension is not used, only ISO-8859-1 characters can
		934	be used. If not specified, the built-in default is used:
767		935
768	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	936	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>
769		937
770	=item B<preeditType:> I<style>	938	=item B<preeditType:> I<style>
771		939
…		…
775		943
776	I<name> of inputMethod to use; option B<-im>.	944	I<name> of inputMethod to use; option B<-im>.
777		945
778	=item B<imLocale:> I<name>	946	=item B<imLocale:> I<name>
779		947
780	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	948	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	949	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	950	input extension to be able to input japanese characters while staying in
783	another locale. option B<-imlocale>.	951	another locale; option B<-imlocale>.
		952
		953	=item B<imFont:> I<fontset>
		954
		955	Specify the font-set used for XIM styles C<OverTheSpot> or
		956	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
		957	by commas), i.e. it's not in the same format as the other font lists used
		958	in @@RXVT_NAME@@. The default will be set-up to chose any suitable found
		959	found, preferably one or two pixels differing in size to the base font.
		960	option B<-imfont>.
		961
		962	=item B<tripleclickwords:> I<boolean>
		963
		964	Change the meaning of triple-click selection with the left mouse
		965	button. Instead of selecting a full line it will extend the selection to
		966	the end of the logical line only; option B<-tcw>.
784		967
785	=item B<insecure:> I<boolean>	968	=item B<insecure:> I<boolean>
786		969
787	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	970	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
788	echo arbitrary strings like the icon name or the locale. This could be	971	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	972	abused if somebody gets 8-bit-clean access to your display, whether
790	throuh a mail client displaying mail bodies unfiltered or though	973	through a mail client displaying mail bodies unfiltered or through
791	write(1). Therefore, these sequences are disabled by default. (Note	974	write(1) or any other means. Therefore, these sequences are disabled by
792	that other terminals, including xterm, have these sequences	975	default. (Note that many other terminals, including xterm, have these
793	enabled by default). You can enable them by setting this boolean	976	sequences enabled by default, which doesn't make it safer, though).
794	resource or specifying B<-insecure> as an option. At the moment, this	977
795	enabled display-answer, locale, findfont, icon label and window title	978	You can enable them by setting this boolean resource or specifying
796	requests as well as dynamic menubar dispatch.	979	B<-insecure> as an option. At the moment, this enables display-answer,
		980	locale, findfont, icon label and window title requests.
797		981
798	=item B<modifier:> I<modifier>	982	=item B<modifier:> I<modifier>
799		983
800	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	984	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	985	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
805		989
806	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	990	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	991	character is passed through. It may contain escape values as described
808	in the entry on B<keysym> following.	992	in the entry on B<keysym> following.
809		993
810	=item B<secondaryScreen:> I<bool>	994	=item B<secondaryScreen:> I<boolean>
811		995
812	Turn on/off secondary screen (default enabled).	996	Turn on/off secondary screen (default enabled).
813		997
814	=item B<secondaryScroll:> I<bool>	998	=item B<secondaryScroll:> I<boolean>
815		999
816	Turn on/off secondary screen scroll (default enabled). If the this	1000	Turn on/off secondary screen scroll (default enabled). If this
817	option is enabled, scrolls on the secondary screen will change the	1001	option is enabled, scrolls on the secondary screen will change the
818	scrollback buffer and switching to/from the secondary screen will	1002	scrollback buffer and switching to/from the secondary screen will
819	instead scroll the screen up.	1003	instead scroll the screen up.
		1004
		1005	=item B<hold>: I<boolean>
		1006
		1007	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		1008	will not immediately destroy its window when the program executed within
		1009	it exits. Instead, it will wait till it is being killed or closed by the
		1010	user.
820		1011
821	=item B<keysym.>I<sym>: I<string>	1012	=item B<keysym.>I<sym>: I<string>
822		1013
823	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1014	Compile I<frills>: Associate I<string> with keysym I<sym>. The
824	intervening resource name B<keysym.> cannot be omitted.	1015	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>,	1020	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>.	1021	B<2>, B<3>, B<4>, B<5>.
831		1022
832	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to	1023	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	1024	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	1025	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
835	current application keymap mode state.	1026	current application keymap mode state.
836		1027
837	The spellings of I<key> can be obtained by using B<xev>(1) command or	1028	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	1029	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	1030	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
…		…
842		1033
843	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1034	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
844	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1035	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
845	C<\000>: octal number) or verbatim control characters (C<^?>: delete,	1036	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	1037	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
847	can start or end with whitespace.	1038	can start or end with whitespace. B<This feature is deprecated and will
		1039	be removed>.
		1040
		1041	Please note that you need to double the C<\> in resource files, as
		1042	Xlib itself does its own de-escaping (you can use C<\033> instead of
		1043	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
		1044	processing).
848		1045
849	You can define a range of keysyms in one shot by providing a I<string>	1046	You can define a range of keysyms in one shot by providing a I<string>
850	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1047	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
851	should be a character not used by the strings.	1048	should be a character not used by the strings.
852		1049
853	Its usage can be demonstrated by an example:	1050	Its usage can be demonstrated by an example:
854		1051
855	URxvt.keysym.M-C-0x61: list\|\e<M-C-\|abc\|>	1052	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
856		1053
857	The above line is equivalent to the following three lines:	1054	The above line is equivalent to the following three lines:
858		1055
859	URxvt.keysym.Meta-Control-0x61: \e<M-C-a>	1056	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
860	URxvt.keysym.Meta-Control-0x62: \e<M-C-b>	1057	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
861	URxvt.keysym.Meta-Control-0x63: \e<M-C-c>	1058	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
862		1059
863	If I<string> takes the form of C<proto:STRING>, the specified B<STRING> is	1060	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,	1061	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	1062	example the following means "change the current locale to C<zh_CN.GBK>
866	C<zh_CN.GBK>.	1063	when Control-Meta-c is being pressed":
		1064
		1065	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		1066
		1067	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1068	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1069	manpage. For example, the F<selection> extension (activated via
		1070	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1071
		1072	URxvt.keysym.M-C-c: perl:selection:rot13
		1073
		1074	Due the the large number of modifier combinations, a defined key mapping
		1075	will match if at I<at least> the specified identifiers are being set, and
		1076	no other key mappings with those and more bits are being defined. That
		1077	means that defining a key map for C<a> will automatically provide
		1078	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		1079	mappings themselves.
		1080
		1081	Unfortunately, this will override built-in key mappings. For example
		1082	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		1083	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		1084	user-defined keymap using the C<builtin:> replacement:
		1085
		1086	URxvt.keysym.Insert: <my insert key sequence>
		1087	URxvt.keysym.S-Insert: builtin:
		1088
		1089	The first line defines a mapping for C<Insert> and I<any> combination
		1090	of modifiers. The second line re-establishes the default mapping for
		1091	C<Shift-Insert>.
		1092
		1093	The following example will map Control-Meta-1 and Control-Meta-2 to
		1094	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
		1095	font-switching at runtime:
		1096
		1097	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1098	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
		1099
		1100	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
		1101	info):
		1102
		1103	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1104	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1105
		1106	=item B<perl-ext-common>: I<string>
		1107
		1108	=item B<perl-ext>: I<string>
		1109
		1110	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1111	use in this terminal instance; option B<-pe>.
		1112
		1113	Extension names can be prefixed with a C<-> sign to prohibit using
		1114	them. This can be useful to selectively disable some extensions loaded
		1115	by default, or specified via the C<perl-ext-common> resource. For
		1116	example, C<default,-selection> will use all the default extension except
		1117	C<selection>.
		1118
		1119	Extension names can also be followed by an argument in angle brackets
		1120	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1121	searchable scrollback to Alt/Meta-s). Mentioning the same extension
		1122	multiple times with different arguments will pass multiple arguments to
		1123	the extension.
		1124
		1125	Each extension is looked up in the library directories, loaded if
		1126	necessary, and bound to the current terminal instance.
		1127
		1128	If both of these resources are the empty string, then the perl
		1129	interpreter will not be initialized. The idea behind two options is that
		1130	B<perl-ext-common> will be used for extensions that should be available to
		1131	all instances, while B<perl-ext> is used for specific instances.
		1132
		1133	=item B<perl-eval>: I<string>
		1134
		1135	Perl code to be evaluated when all extensions have been registered. See
		1136	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
		1137	will be ignored when running setuid/setgid.
		1138
		1139	=item B<perl-lib>: I<path>
		1140
		1141	Colon-separated list of additional directories that hold extension
		1142	scripts. When looking for extensions specified by the C<perl> resource,
		1143	@@RXVT_NAME@@ will first look in these directories and then in
		1144	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
		1145	will be ignored when running setuid/setgid.
		1146
		1147	See the @@RXVT_NAME@@perl(3) manpage.
		1148
		1149	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1150
		1151	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1152	details.
		1153
		1154	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1155
		1156	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1157	for details.
		1158
		1159	=item B<searchable-scrollback:> I<keysym>
		1160
		1161	Sets the hotkey that starts the incremental scrollback buffer search
		1162	(default: C<M-s>).
		1163
		1164	=item B<urlLauncher>: I<string>
		1165
		1166	Specifies the program to be started with a URL argument. Used by the
		1167	C<selection-popup> and C<matcher> perl extensions.
		1168
		1169	=item B<transient-for>: I<windowid>
		1170
		1171	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1172
		1173	=item B<override-redirect>: I<boolean>
		1174
		1175	Compile I<frills>: Sets override-redirect for the terminal window, making
		1176	it almost invisible to window managers; option B<-override-redirect>.
867		1177
868	=back	1178	=back
869		1179
870	=head1 THE SCROLLBAR	1180	=head1 THE SCROLLBAR
871		1181
…		…
885	the normal text selection/insertion, hold either the Shift or the Meta	1195	the normal text selection/insertion, hold either the Shift or the Meta
886	(Alt) key while performing the desired mouse action.	1196	(Alt) key while performing the desired mouse action.
887		1197
888	If mouse reporting mode is active, the normal scrollbar actions are	1198	If mouse reporting mode is active, the normal scrollbar actions are
889	disabled -- on the assumption that we are using a fullscreen	1199	disabled -- on the assumption that we are using a fullscreen
890	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	1200	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
891	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	1201	(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),	1202	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
893	respectively.	1203	respectively.
894		1204
895	=head1 TEXT SELECTION AND INSERTION	1205	=head1 THE SELECTION: SELECTING AND PASTING TEXT
896		1206
897	The behaviour of text selection and insertion mechanism is similar to	1207	The behaviour of text selection and insertion/pasting mechanism is similar
898	I<xterm>(1).	1208	to I<xterm>(1).
899		1209
900	=over 4	1210	=over 4
901		1211
902	=item B<Selection>:	1212	=item B<Selecting>:
903		1213
904	Left click at the beginning of the region, drag to the end of the	1214	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	1215	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	1216	to select a word; Left triple-click to select the entire logical line
907	line.	1217	(which can span multiple screen lines), unless modified by resource
		1218	B<tripleclickwords>.
908		1219
909	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1220	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	1221	(Compile: I<frills>) will create a rectangular selection instead of a
911	one.	1222	normal one. In this mode, every selected row becomes its own line in the
		1223	selection, and trailing whitespace is visually underlined and removed from
		1224	the selection.
912		1225
913	=item B<Insertion>:	1226	=item B<Pasting>:
914		1227
915	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1228	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	1229	window causes the value of the PRIMARY selection (or CLIPBOARD with the
917	inserted as if it had been typed on the keyboard.	1230	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1231
		1232	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1233	inserted too.
918		1234
919	=back	1235	=back
920		1236
921	=head1 CHANGING FONTS	1237	=head1 CHANGING FONTS
922		1238
923	Changing fonts (or font sizes, respectively) via the keypad is not yet	1239	Changing fonts (or font sizes, respectively) via the keypad is not yet
924	supported in rxvt-unicode. Bug me if you need this.	1240	supported in rxvt-unicode. Bug me if you need this.
925		1241
926	You can, however, switch fonts at runtime using escape sequences (and	1242	You can, however, switch fonts at runtime using escape sequences, e.g.:
927	therefore using the menubar), e.g.:
928		1243
929	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1244	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1245
		1246	You can use keyboard shortcuts, too:
		1247
		1248	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1249	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
930		1250
931	rxvt-unicode will automatically re-apply these fonts to the output so far.	1251	rxvt-unicode will automatically re-apply these fonts to the output so far.
932		1252
933	=head1 ISO 14755 SUPPORT	1253	=head1 ISO 14755 SUPPORT
934		1254
…		…
938	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1258	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
939	with C<--enable-iso14755>.	1259	with C<--enable-iso14755>.
940		1260
941	=over 4	1261	=over 4
942		1262
943	=item 5.1: Basic method	1263	=item * 5.1: Basic method
944		1264
945	This allows you to enter unicode characters using their hexcode.	1265	This allows you to enter unicode characters using their hexcode.
946		1266
947	Start by pressing and holding both C<Control> and C<Shift>, then enter	1267	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	1268	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	1275	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	1276	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>,	1277	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.	1278	followed by releasing the modifier keys.
959		1279
960	=item 5.2: Keyboard symbols entry method	1280	=item * 5.2: Keyboard symbols entry method
961		1281
962	This mode lets you input characters representing the keycap symbols of	1282	This mode lets you input characters representing the keycap symbols of
963	your keyboard, if representable in the current locale encoding.	1283	your keyboard, if representable in the current locale encoding.
964		1284
965	Start by pressing C<Control> and C<Shift> together, then releasing	1285	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	1286	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	1287	invoke its usual function but instead will insert the corresponding
968	keycap symbol. The symbol will only be entered when the key has been	1288	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	1289	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	1290	C<ISO Level 2 Switch>, although your intention might have been to enter a
971	reverse tab (Shift-Tab).	1291	reverse tab (Shift-Tab).
972		1292
973	=item 5.3: Screen-selection entry method	1293	=item * 5.3: Screen-selection entry method
974		1294
975	While this is implemented already (it's basically the selection	1295	While this is implemented already (it's basically the selection
976	mechanism), it could be extended by displaying a unicode character map.	1296	mechanism), it could be extended by displaying a unicode character map.
977		1297
978	=item 5.4: Feedback method for identifying displayed characters for later input	1298	=item * 5.4: Feedback method for identifying displayed characters for later input
979		1299
980	This method lets you display the unicode character code associated with	1300	This method lets you display the unicode character code associated with
981	characters already displayed.	1301	characters already displayed.
982		1302
983	You enter this mode by holding down C<Control> and C<Shift> together, then	1303	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	1315	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.	1316	both scenario A and B of ISO 14755, including part 5.2.
997		1317
998	=head1 LOGIN STAMP	1318	=head1 LOGIN STAMP
999		1319
1000	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so	1320	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.	1321	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	1322	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1003	some systems.	1323	on some systems or setgid to root or to some other group on others.
1004		1324
1005	=head1 COLORS AND GRAPHICS	1325	=head1 COLORS AND GRAPHICS
1006		1326
1007	In addition to the default foreground and background colours,	1327	In addition to the default foreground and background colours,
1008	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1328	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1009	high-intensity bold/blink versions of the same). Here is a list of the	1329	high-intensity bold/blink versions of the same). Here is a list of the
1010	colours with their B<rgb.txt> names.	1330	colours with their names.
1011		1331
1012	=begin table	1332	=begin table
1013		1333
1014	B<color0> (black) = Black	1334	B<color0> (black) = Black
1015	B<color1> (red) = Red3	1335	B<color1> (red) = Red3
…		…
1035	It is also possible to specify the colour values of B<foreground>,	1355	It is also possible to specify the colour values of B<foreground>,
1036	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1356	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	1357	a number 0-15, as a convenient shorthand to reference the colour name of
1038	color0-color15.	1358	color0-color15.
1039		1359
		1360	In addition to the colours defined above, @@RXVT_NAME@@ offers an
		1361	additional 72 colours. The first 64 of those (with indices 16 to 79)
		1362	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
		1363	16>), followed by 8 additional shades of gray (with indices 80 to 87).
		1364
		1365	Together, all those colours implement the 88 colour xterm colours. Only
		1366	the first 16 can be changed using resources currently, the rest can only
		1367	be changed via command sequences ("escape codes").
		1368
1040	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1369	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1041	always swapping the foreground/background colours. This is in contrast to	1370	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	1371	I<xterm>(1) where the colours are only swapped if they have not otherwise
1043	been specified. For example,	1372	been specified. For example,
1044		1373
…		…
1049	would yield White on Black, while on I<xterm>(1) it would yield Black	1378	would yield White on Black, while on I<xterm>(1) it would yield Black
1050	on White.	1379	on White.
1051		1380
1052	=back	1381	=back
1053		1382
		1383	=head2 ALPHA CHANNEL SUPPORT
		1384
		1385	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1386	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
		1387	(recommended, but B<MUST> have 4 digits/component) colour specifications,
		1388	in addition to the ones provided by X, where the additional A component
		1389	specifies opacity (alpha) values. The minimum value of C<0> is completely
		1390	transparent). You can also prefix any color with C<[percent]>, where
		1391	C<percent> is a decimal percentage (0-100) that specifies the opacity of
		1392	the color, where C<0> is completely transparent and C<100> is completelxy
		1393	opaque.
		1394
		1395	You probably need to specify B<"-depth 32">, too, and have the luck that
		1396	your X-server uses ARGB pixel layout, as X is far from just supporting
		1397	ARGB visuals out of the box, and rxvt-unicode just fudges around.
		1398
		1399	For example, the following selects an almost completely transparent red
		1400	background, and an almost opaque pink foreground:
		1401
		1402	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
		1403
		1404	I<Please note that transparency of any kind if completely unsupported by
		1405	the author. Don't bug him with installation questions!>
		1406
1054	=head1 ENVIRONMENT	1407	=head1 ENVIRONMENT
1055		1408
1056	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>	1409	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1057	and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X	1410
1058	window id number of the B<@@RXVT_NAME@@> window and it also uses and	1411	=over 4
1059	sets the environment variable B<DISPLAY> to specify which display	1412
1060	terminal to use. B<@@RXVT_NAME@@> uses the environment variables	1413	=item B<TERM>
1061	B<RXVTPATH> and B<PATH> to find XPM files.	1414
		1415	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
		1416	resources or on the command line.
		1417
		1418	=item B<COLORTERM>
		1419
		1420	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
		1421	compiled with XPM support, and optionally with the added extension
		1422	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
		1423
		1424	=item B<COLORFGBG>
		1425
		1426	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
		1427	the colour code used as default foreground/text colour (or the string
		1428	C<default> to indicate that the default-colour escape sequence is to be
		1429	used), C<bg> is the colour code used as default background colour (or the
		1430	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1431	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
		1432	(and do) use this information to optimize screen output.
		1433
		1434	=item B<WINDOWID>
		1435
		1436	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
		1437	window, which usually has subwindows for the scrollbar, the terminal
		1438	window and so on).
		1439
		1440	=item B<TERMINFO>
		1441
		1442	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1443	C<--with-terminfo=PATH>.
		1444
		1445	=item B<DISPLAY>
		1446
		1447	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
		1448	display in its child processes.
		1449
		1450	=item B<SHELL>
		1451
		1452	The shell to be used for command execution, defaults to C</bin/sh>.
		1453
		1454	=item B<RXVT_SOCKET>
		1455
		1456	The unix domain socket path used by @@RXVT_NAME@@c(1) and
		1457	@@RXVT_NAME@@d(1).
		1458
		1459	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
		1460
		1461	=item B<HOME>
		1462
		1463	Used to locate the default directory for the unix domain socket for
		1464	daemon communications and to locate various resource files (such as
		1465	C<.Xdefaults>)
		1466
		1467	=item B<XAPPLRESDIR>
		1468
		1469	Directory where various X resource files are being located.
		1470
		1471	=item B<XENVIRONMENT>
		1472
		1473	If set and accessible, gives the name of a X resource file to be loaded by
		1474	@@RXVT_NAME@@.
		1475
		1476	=back
1062		1477
1063	=head1 FILES	1478	=head1 FILES
1064		1479
1065	=over 4	1480	=over 4
1066		1481
1067	=item B</etc/utmp>
1068
1069	System file for login records.
1070
1071	=item B</usr/lib/X11/rgb.txt>	1482	=item B</usr/lib/X11/rgb.txt>
1072		1483
1073	Color names.	1484	Color names.
1074		1485
1075	=back	1486	=back
1076		1487
1077	=head1 SEE ALSO	1488	=head1 SEE ALSO
1078		1489
1079	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1490	@@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		1491
1089	=head1 CURRENT PROJECT COORDINATOR	1492	=head1 CURRENT PROJECT COORDINATOR
1090		1493
1091	=over 4	1494	=over 4
1092		1495
1093	=item Project Coordinator	1496	=item Project Coordinator
1094		1497
1095	@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@>	1498	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1096		1499
1097	=item Web page maintainter	1500	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1098
1099	@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1100
1101	L<@@RXVT_WEBPAGE@@>
1102		1501
1103	=back	1502	=back
1104		1503
1105	=head1 AUTHORS	1504	=head1 AUTHORS
1106		1505
…		…
1128		1527
1129	Project Coordinator (changes.txt 2.21a to 2.4.5)	1528	Project Coordinator (changes.txt 2.21a to 2.4.5)
1130		1529
1131	=item Geoff Wing L<< <gcw@pobox.com> >>	1530	=item Geoff Wing L<< <gcw@pobox.com> >>
1132		1531
1133	Rewrote screen display and text selection routines. Project Coordinator	1532	Rewrote screen display and text selection routines.
		1533
1134	(changes.txt 2.4.6 - rxvt-unicode)	1534	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1135		1535
1136	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>	1536	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1137		1537
1138	Forked rxvt-unicode, rewrote most of the display code and internal	1538	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1139	character handling to store text in unicode, improve xterm	1539	extension, random hacks, numerous bugfixes and extensions.
1140	compatibility and apply numerous other bugfixes and extensions.
1141		1540
1142	Project Coordinator (Changes 1.0 -)	1541	Project Coordinator (Changes 1.0 -)
1143		1542
		1543	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1544
		1545	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
		1546
1144	=back	1547	=back
1145		1548

Diff Legend

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

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.129 by root, Mon May 28 20:34:56 2007 UTC

Diff Legend

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.129 by root, Mon May 28 20:34:56 2007 UTC