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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.1 by root, Thu Aug 12 20:42:12 2004 UTC vs.
Revision 1.81 by root, Mon Jan 2 21:41:51 2006 UTC

…		…
2		2
3	rxvt-unicode (ouR XVT, unicode) - (a VT102 emulator for the X window system)	3	rxvt-unicode (ouR XVT, unicode) - (a VT102 emulator for the X window system)
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	B<@@RXVTNAME@@> [options] [-e command [ args ]]	7	B<@@RXVT_NAME@@> [options] [-e command [ args ]]
8		8
9	=head1 DESCRIPTION	9	=head1 DESCRIPTION
10		10
11	B<rxvt-unicode>, version B<@@RXVTVERSION@@>, is a colour vt102 terminal	11	B<rxvt-unicode>, version B<@@RXVT_VERSION@@>, is a colour vt102 terminal
12	emulator intended as an I<xterm>(1) replacement for users who do not	12	emulator intended as an I<xterm>(1) replacement for users who do not
13	require features such as Tektronix 4014 emulation and toolkit-style	13	require features such as Tektronix 4014 emulation and toolkit-style
14	configurability. As a result, B<rxvt-unicode> uses much less swap space --	14	configurability. As a result, B<rxvt-unicode> uses much less swap space --
15	a significant advantage on a machine serving many X sessions.	15	a significant advantage on a machine serving many X sessions.
16		16
		17	=head1 FREQUENTLY ASKED QUESTIONS
		18
		19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
		20	frequently asked questions and answer to them and some common
		21	problems. That document is also accessible on the World-Wide-Web at
		22	L<http://cvs.schmorp.de/browse/checkout/rxvt-unicode/doc/rxvt.7.html>.
		23
		24	=head1 RXVT-UNICODE VS. RXVT
		25
		26	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
		27	internally. That means it can store and display most scripts in the
		28	world. Being a terminal emulator, however, some things are very difficult,
		29	especially cursive scripts such as arabic, vertically written scripts
		30	like mongolian or scripts requiring extremely complex combining rules,
		31	like tibetan or devenagari. Don't expect pretty output when using these
		32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
		33	fine, though. A somewhat difficult case are left-to-right scripts, such
		34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
		35	belong into the application, not the terminal emulator (too many things --
		36	such as cursor-movement while editing -- break otherwise), but that might
		37	change.
		38
		39	If you are looking for a terminal that supports more exotic scripts, let
		40	me recommend C<mlterm>, which is a very userfriendly, lean and clean
		41	terminal emulator. In fact, the reason rxvt-unicode was born was solely
		42	because the author couldn't get C<mlterm> to use one font for latin1 and
		43	another for japanese.
		44
		45	Therefore another design rationale was the use of multiple fonts to
		46	display characters: The idea of a single unicode font which many other
		47	programs force onto it's users never made sense to me: You should be able
		48	to choose any font for any script freely.
		49
		50	Apart from that, rxvt-unicode is also much better internationalised than
		51	it's predecessor, supports things such as XFT and ISO 14755 that are handy
		52	in i18n-environments, is faster, and has a lot less bugs than the original
		53	rxvt. This all in addition to dozens of other small improvements.
		54
		55	It is still faithfully following the original rxvt idea of being lean
		56	and nice on resources: for example, you can still configure rxvt-unicode
		57	without most of it's features to get a lean binary. It also comes with
		58	a client/daemon pair that lets you open any number of terminal windows
		59	from within a single process, which makes startup time very fast and
		60	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
		61	@@RXVT_NAME@@c(1) (client).
		62
		63	It also makes technical information about escape sequences (which have
		64	been extended) easier accessible: see @@RXVT_NAME@@(7) for technical
		65	reference documentation (escape sequences etc.).
		66
17	=head1 OPTIONS	67	=head1 OPTIONS
18		68
19	The B<@@RXVTNAME@@> 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
20	below. In keeping with the smaller-is-better philosophy, options may be	70	below. In keeping with the smaller-is-better philosophy, options may be
21	eliminated or default values chosen at compile-time, so options and	71	eliminated or default values chosen at compile-time, so options and
22	defaults listed may not accurately reflect the version installed on	72	defaults listed may not accurately reflect the version installed on
23	your system. `rxvt -h' gives a list of major compile-time options on	73	your system. `@@RXVT_NAME@@ -h' gives a list of major compile-time options on
24	the I<Options> line. Option descriptions may be prefixed with which	74	the I<Options> line. Option descriptions may be prefixed with which
25	compile option each is dependent upon. e.g. `Compile I<XIM>:' requires	75	compile option each is dependent upon. e.g. `Compile I<XIM>:' requires
26	I<XIM> on the I<Options> line. Note: `rxvt -help' gives a list of all	76	I<XIM> on the I<Options> line. Note: `@@RXVT_NAME@@ -help' gives a list of all
27	command-line options compiled into your version.	77	command-line options compiled into your version.
28		78
29	Note that B<@@RXVTNAME@@> permits the resource name to be used as a	79	Note that B<@@RXVT_NAME@@> permits the resource name to be used as a
30	long-option (--/++ option) so the potential command-line options are	80	long-option (--/++ option) so the potential command-line options are
31	far greater than those listed. For example: `rxvt --loginShell --color1	81	far greater than those listed. For example: `@@RXVT_NAME@@ --loginShell --color1
32	Orange'.	82	Orange'.
33		83
34	The following options are available:	84	The following options are available:
35		85
36	=over 4	86	=over 4
…		…
55		105
56	=item B<-j>\|B<+j>	106	=item B<-j>\|B<+j>
57		107
58	Turn on/off jump scrolling; resource B<jumpScroll>.	108	Turn on/off jump scrolling; resource B<jumpScroll>.
59		109
60	=item B<-ip>\|B<+ip>	110	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>
61		111
62	Turn on/off inheriting parent window's pixmap. Alternative form is	112	Turn on/off inheriting parent window's pixmap. Alternative form is
63	B<-tr>; resource B<inheritPixmap>.	113	B<-tr>; resource B<inheritPixmap>.
64		114
65	=item B<-fade> I<number>	115	=item B<-fade> I<number>
66		116
67	Fade the text by the given percentage when focus is lost.	117	Fade the text by the given percentage when focus is lost. Small values
		118	fade a little only, 100 completely replaces all colours by the fade
		119	colour; resource B<fading>.
		120
		121	=item B<-fadecolor> I<colour>
		122
		123	Fade to this colour when fading is used (see B<-fade>). The default colour
		124	is black. resource B<fadeColor>.
68		125
69	=item B<-tint> I<colour>	126	=item B<-tint> I<colour>
70		127
71	Tint the transparent background pixmap with the given colour when	128	Tint the transparent background pixmap with the given colour when
72	transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>	129	transparency is enabled with B<-tr> or B<-ip>. This only works for
73	option that can be used to brighten or darken the image in addition to	130	non-tiled backgrounds, currently. See also the B<-sh> option that can be
74	tinting it.	131	used to brighten or darken the image in addition to tinting it; resource
		132	I<tintColor>. Example:
		133
		134	@@RXVT_NAME@@ -tr -tint blue -sh 40
75		135
76	=item B<-sh>	136	=item B<-sh>
77		137
78	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	138	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
79	background image in addition to tinting it (i.e. B<-tint> must be	139	background image in addition to tinting it (i.e. B<-tint> must be
80	specified, too).	140	specified, too, e.g. C<-tint white>).
81		141
82	=item B<-bg> I<colour>	142	=item B<-bg> I<colour>
83		143
84	Window background colour; resource B<background>.	144	Window background colour; resource B<background>.
85		145
…		…
88	Window foreground colour; resource B<foreground>.	148	Window foreground colour; resource B<foreground>.
89		149
90	=item B<-pixmap> I<file[;geom]>	150	=item B<-pixmap> I<file[;geom]>
91		151
92	Compile I<XPM>: Specify XPM file for the background and also optionally	152	Compile I<XPM>: Specify XPM file for the background and also optionally
93	specify its scaling with a geometry string. Note you may need to add	153	specify its scaling with a geometry string. Note you may need to
94	quotes to avoid special shell interpretation of the `;' in the	154	add quotes to avoid special shell interpretation of the C<;> in the
95	command-line; resource B<backgroundPixmap>.	155	command-line; resource B<backgroundPixmap>.
96		156
97	=item B<-cr> I<colour>	157	=item B<-cr> I<colour>
98		158
99	The cursor colour; resource B<cursorColor>.	159	The cursor colour; resource B<cursorColor>.
…		…
106		166
107	The mouse pointer background colour; resource B<pointerColor2>.	167	The mouse pointer background colour; resource B<pointerColor2>.
108		168
109	=item B<-bd> I<colour>	169	=item B<-bd> I<colour>
110		170
111	The colour of the border between the xterm scrollbar and the text;	171	The colour of the border around the text area and between the scrollbar and the text;
112	resource B<borderColor>.	172	resource B<borderColor>.
113		173
114	=item B<-fn> I<fontname>	174	=item B<-fn> I<fontlist>
115		175
116	Select the fonts to be used. This is a comma seperated list of font	176	Select the fonts to be used. This is a comma separated list of font names
117	names that are used in turn when trying to display Unicode characters.	177	that are used in turn when trying to display Unicode characters. The
118	The first font defines the cell size for characters; other fonts might	178	first font defines the cell size for characters; other fonts might be
119	be smaller, but not larger. A reasonable default font list is always	179	smaller, but not (in general) larger. A (hopefully) reasonable default
120	appended to it. resource B<font>.	180	font list is always appended to it. See resource B<font> for more details.
121		181
		182	In short, to specify an X11 core font, just specify it's name or prefix it
		183	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
		184	e.g.:
		185
		186	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
		187	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
		188
		189	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
		190	section of @@RXVT_NAME@@(7).
		191
		192	=item B<-fb> I<fontlist>
		193
		194	Compile font-styles: The bold font list to use when bold characters are to
		195	be printed. See resource B<boldFont> for details.
		196
		197	=item B<-fi> I<fontlist>
		198
		199	Compile font-styles: The italic font list to use when bold characters are to
		200	be printed. See resource B<italicFont> for details.
		201
		202	=item B<-fbi> I<fontlist>
		203
		204	Compile font-styles: The bold italic font list to use when bold characters are to
		205	be printed. See resource B<boldItalicFont> for details.
		206
122	=item B<-rb>\|B<+rb>	207	=item B<-is>\|B<+is>
123		208
124	Enable "real bold" support. When this option is on, bold text will be	209	Compile font-styles: Bold/Italic font styles imply high intensity
125	displayed using the first available bold font in the font list. Bold	210	foreground/background (default). See resource B<intensityStyles> for
126	fonts should thus be specified in the font list after their	211	details.
127	corresponding regular fonts. If no bold font can be found, a regular
128	font will be used. resource B<realBold>.
129		212
130	=item B<-name> I<name>	213	=item B<-name> I<name>
131		214
132	Specify the application name under which resources are to be obtained,	215	Specify the application name under which resources are to be obtained,
133	rather than the default executable file name. Name should not contain	216	rather than the default executable file name. Name should not contain
…		…
171		254
172	Put scrollbar on right/left; resource B<scrollBar_right>.	255	Put scrollbar on right/left; resource B<scrollBar_right>.
173		256
174	=item B<-st>\|B<+st>	257	=item B<-st>\|B<+st>
175		258
176	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	259	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
177	resource B<scrollBar_floating>.	260	resource B<scrollBar_floating>.
		261
		262	=item B<-ptab>\|B<+ptab>
		263
		264	If enabled (default), "Horizontal Tab" characters are being stored as
		265	actual wide characters in the screen buffer, which makes it possible to
		266	select and paste them. Since a horizontal tab is a cursor movement and
		267	not an actual glyph, this can sometimes be visually annoying as the cursor
		268	on a tab character is displayed as a wide cursor; resource B<pastableTabs>.
178		269
179	=item B<-bc>\|B<+bc>	270	=item B<-bc>\|B<+bc>
180		271
181	Blink the cursor; resource B<cursorBlink>.	272	Blink the cursor; resource B<cursorBlink>.
182		273
…		…
202	B<externalBorder>.	293	B<externalBorder>.
203		294
204	=item B<-bl>	295	=item B<-bl>
205		296
206	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	297	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
207	if honoured by the WM, the rxvt window will not have window	298	if honoured by the WM, the rxvt-unicode window will not have window
208	decorations; resource B<borderLess>.	299	decorations; resource B<borderLess>.
209		300
210	=item B<-lsp> I<number>	301	=item B<-lsp> I<number>
211		302
212	Compile I<linespace>: Lines (pixel height) to insert between each row	303	Compile I<frills>: Lines (pixel height) to insert between each row of
213	of the display; resource B<linespace>.	304	the display. Useful to work around font rendering problems; resource
		305	B<linespace>.
214		306
215	=item B<-tn> I<termname>	307	=item B<-tn> I<termname>
216		308
217	This option specifies the name of the terminal type to be set in the	309	This option specifies the name of the terminal type to be set in the
218	B<TERM> environment variable. This terminal type must exist in the	310	B<TERM> environment variable. This terminal type must exist in the
219	I<termcap(5)> database and should have I<li#> and I<co#> entries;	311	I<termcap(5)> database and should have I<li#> and I<co#> entries;
220	resource B<termName>.	312	resource B<termName>.
221		313
222	=item B<-e> I<command [arguments]>	314	=item B<-e> I<command [arguments]>
223		315
224	Run the command with its command-line arguments in the B<@@RXVTNAME@@>	316	Run the command with its command-line arguments in the B<@@RXVT_NAME@@>
225	window; also sets the window title and icon name to be the basename of	317	window; also sets the window title and icon name to be the basename of
226	the program being executed if neither I<-title> (I<-T>) nor I<-n> are	318	the program being executed if neither I<-title> (I<-T>) nor I<-n> are
227	given on the command line. If this option is used, it must be the last	319	given on the command line. If this option is used, it must be the last
228	on the command-line. If there is no B<-e> option then the default is to	320	on the command-line. If there is no B<-e> option then the default is to
229	run the program specified by the B<SHELL> environment variable or,	321	run the program specified by the B<SHELL> environment variable or,
230	failing that, I<sh(1)>.	322	failing that, I<sh(1)>.
231		323
		324	Please note that you must specify a program with arguments. If you want to
		325	run shell commands, you have to specify the shell, like this:
		326
		327	@@RXVT_NAME@@ -e sh -c "shell commands"
		328
232	=item B<-title> I<text>	329	=item B<-title> I<text>
233		330
234	Window title (B<-T> still respected); the default title is the basename	331	Window title (B<-T> still respected); the default title is the basename
235	of the program specified after the B<-e> option, if any, otherwise the	332	of the program specified after the B<-e> option, if any, otherwise the
236	application name; resource B<title>.	333	application name; resource B<title>.
…		…
254		351
255	Compile I<XIM>: input method name. resource B<inputMethod>.	352	Compile I<XIM>: input method name. resource B<inputMethod>.
256		353
257	=item B<-imlocale> I<string>	354	=item B<-imlocale> I<string>
258		355
259	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	356	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
260	de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input	357	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
261	extension to be able to input japanese characters while staying in	358	input extension to be able to input japanese characters while staying in
262	another locale.	359	another locale. resource B<imLocale>.
		360
		361	=item B<-imfont> I<fontset>
		362
		363	Set the font set to use for the X Input Method, see resource B<imFont>
		364	for more info.
		365
		366	=item B<-tcw>
		367
		368	Change the meaning of triple-click selection with the left mouse
		369	button. Instead of selecting a full line it will extend the selection the
		370	end of the logical line only. resource B<tripleclickwords>.
263		371
264	=item B<-insecure>	372	=item B<-insecure>
265		373
266	Enable "insecure" mode, which currently enables most of the escape	374	Enable "insecure" mode, which currently enables most of the escape
267	sequences that echo strings. See the resource B<insecure> for more	375	sequences that echo strings. See the resource B<insecure> for more
…		…
281	=item B<-ssr>\|B<+ssr>	389	=item B<-ssr>\|B<+ssr>
282		390
283	Turn on/off secondary screen scroll (default enabled); resource	391	Turn on/off secondary screen scroll (default enabled); resource
284	B<secondaryScroll>.	392	B<secondaryScroll>.
285		393
		394	=item B<-hold>\|B<+hold>
		395
		396	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		397	will not immediately destroy its window when the program executed within
		398	it exits. Instead, it will wait till it is being killed or closed by the
		399	user; resource B<hold>.
		400
		401	=item B<-keysym.>I<sym> I<string>
		402
		403	Remap a key symbol. See resource B<keysym>.
		404
		405	=item B<-embed> I<windowid>
		406
		407	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
		408	which enables applications to easily embed a terminal.
		409
		410	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
		411	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
		412	quite a bit, so don't expect it to keep some specific state. It's best to
		413	create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
		414
		415	The window will not be destroyed when @@RXVT_NAME@@ exits.
		416
		417	It might be useful to know that @@RXVT_NAME@@ will not close file
		418	descriptors passed to it (except for stdin/out/err, of course), so you
		419	can use file descriptors to communicate with the programs within the
		420	terminal. This works regardless of wether the C<-embed> option was used or
		421	not.
		422
		423	Here is a short Gtk2-perl snippet that illustrates how this option can be
		424	used (a longer example is in F<doc/embed>):
		425
		426	my $rxvt = new Gtk2::Socket;
		427	$rxvt->signal_connect_after (realize => sub {
		428	my $xid = $_[0]->window->get_xid;
		429	system "@@RXVT_NAME@@ -embed $xid &";
		430	});
		431
		432	=item B<-pty-fd> I<fileno>
		433
		434	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
		435	pair but instead use the given filehandle as the tty master. This is
		436	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
		437	without having to run a program within it.
		438
		439	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
		440	entries and will not tinker with pty/tty permissions - you have to do that
		441	yourself if you want that.
		442
		443	Here is a example in perl that illustrates how this option can be used (a
		444	longer example is in F<doc/pty-fd>):
		445
		446	use IO::Pty;
		447	use Fcntl;
		448
		449	my $pty = new IO::Pty;
		450	fcntl $pty, F_SETFD, 0; # clear close-on-exec
		451	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		452	close $pty;
		453
		454	# now communicate with rxvt
		455	my $slave = $pty->slave;
		456	while (<$slave>) { print $slave "got <$_>\n" }
		457
286	=item B<-xrm> I<resourcestring>	458	=item B<-pe> I<string>
287		459
288	No effect on rxvt. Simply passes through an argument to be made	460	Colon-separated list of perl extension scripts to use in this terminal instance. See resource B<perl-ext>.
289	available in the instance's argument list. Appears in I<WM_COMMAND> in
290	some window managers.
291		461
292	=back	462	=back
293		463
294	=head1 RESOURCES (available also as long-options)	464	=head1 RESOURCES (available also as long-options)
295		465
296	Note: `@@RXVTNAME@@ --help' gives a list of all resources (long	466	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
297	options) compiled into your version.	467	options) compiled into your version.
298		468
299	There are two different methods that @@RXVTNAME@@ can use to get the	469	There are two different methods that @@RXVT_NAME@@ can use to get the
300	Xresource data: using the X libraries (Xrm*-functions) or internal	470	Xresource data: using the X libraries (Xrm*-functions) or internal
301	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	471	Xresources reader (B<~/.Xdefaults>). For the first method (ie.
302	B<@@RXVTNAME@@ -h> lists B<XGetDefaults>), you can set and change the	472	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the
303	resources using X11 tools like B<xset>. Many distribution do also load	473	resources using X11 tools like B<xrdb>. Many distribution do also load
304	settings from the B<~/.Xresources> file when X starts.	474	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
		475	will consult the following files/resources in order, with later settings
		476	overwriting earlier ones:
305		477
		478	1. system-wide app-defaults file, either locale-dependent OR global
		479	2. app-defaults file in $XAPPLRESDIR
		480	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
		481	4. SCREEN_RESOURCES for the current screen
		482	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		483
306	If compiled with internal Xresources support (i.e. B<@@RXVTNAME@@ -h>	484	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
307	lists B<.Xdefaults>) then B<@@RXVTNAME@@> accepts application defaults	485	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
308	set in XAPPLOADDIR/URxvt (compile-time defined: usually	486	set in XAPPLOADDIR/URxvt (compile-time defined: usually
309	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	487	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
310	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.	488	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
311	Note that when reading X resources, B<@@RXVTNAME@@> recognizes two	489	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two
312	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows	490	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows
313	resources common to both B<@@RXVTNAME@@> and the original I<rxvt> to be	491	resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be
314	easily configured, while the class name B<URxvt> allows resources	492	easily configured, while the class name B<URxvt> allows resources
315	unique to B<@@RXVTNAME@@>, notably colours and key-handling, to be	493	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be
316	shared between different B<@@RXVTNAME@@> configurations. If no	494	shared between different B<@@RXVT_NAME@@> configurations. If no
317	resources are specified, suitable defaults will be used. Command-line	495	resources are specified, suitable defaults will be used. Command-line
318	arguments can be used to override resource settings. The following	496	arguments can be used to override resource settings. The following
319	resources are allowed:	497	resources are allowed:
320		498
321	=over 4	499	=over 4
…		…
342	high-intensity (bold = bright foreground, blink = bright background)	520	high-intensity (bold = bright foreground, blink = bright background)
343	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	521	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
344	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	522	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
345	names used are listed in the B<COLORS AND GRAPHICS> section.	523	names used are listed in the B<COLORS AND GRAPHICS> section.
346		524
		525	Colours higher than 15 cannot be set using resources (yet), but can be
		526	changed using an escape command (see @@RXVT_NAME@@(7)).
		527
		528	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
		529	88 colour support). Colours 80-87 are evenly spaces grey steps.
		530
347	=item B<colorBD:> I<colour>	531	=item B<colorBD:> I<colour>
348		532
		533	=item B<colorIT:> I<colour>
		534
349	Use the specified colour to display bold characters when the foreground	535	Use the specified colour to display bold or italic characters when the
350	colour is the default. This option will be ignored if B<realBold> is	536	foreground colour is the default. If font styles are not available
351	enabled.	537	(Compile I<styles>) and this option is unset, reverse video is used instead.
352		538
353	=item B<colorUL:> I<colour>	539	=item B<colorUL:> I<colour>
354		540
355	Use the specified colour to display underlined characters when the	541	Use the specified colour to display underlined characters when the
356	foreground colour is the default.	542	foreground colour is the default.
357		543
358	=item B<colorRV:> I<colour>	544	=item B<colorRV:> I<colour>
359		545
360	Use the specified colour as the background for reverse video	546	Use the specified colour as the background for reverse video
361	characters.	547	characters.
		548
		549	=item B<underlineColor:> I<colour>
		550
		551	If set, use the specified colour as the colour for the underline
		552	itself. If unset, use the foreground colour.
362		553
363	=item B<cursorColor:> I<colour>	554	=item B<cursorColor:> I<colour>
364		555
365	Use the specified colour for the cursor. The default is to use the	556	Use the specified colour for the cursor. The default is to use the
366	foreground colour; option B<-cr>.	557	foreground colour; option B<-cr>.
…		…
389	artificial transparency. B<False>: do not inherit the parent windows'	580	artificial transparency. B<False>: do not inherit the parent windows'
390	pixmap.	581	pixmap.
391		582
392	=item B<fading:> I<number>	583	=item B<fading:> I<number>
393		584
394	Fade the text by the given percentage when focus is lost.	585	Fade the text by the given percentage when focus is lost; option B<-fade>.
		586
		587	=item B<fadeColor:> I<colour>
		588
		589	Fade to this colour, when fading is used (see B<fading:>). The default
		590	colour is black; option B<-fadecolor>.
395		591
396	=item B<tintColor:> I<colour>	592	=item B<tintColor:> I<colour>
397		593
398	Tint the transparent background pixmap with the given colour.	594	Tint the transparent background pixmap with the given colour; option
		595	B<-tint>.
399		596
400	=item B<shading:> I<number>	597	=item B<shading:> I<number>
401		598
402	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	599	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
403	image in addition to tinting it.	600	image in addition to tinting it.
404		601
405	=item B<fading:> I<number>
406
407	Scale the tint colour by the given percentage.
408
409	=item B<scrollColor:> I<colour>	602	=item B<scrollColor:> I<colour>
410		603
411	Use the specified colour for the scrollbar [default #B2B2B2].	604	Use the specified colour for the scrollbar [default #B2B2B2].
412		605
413	=item B<troughColor:> I<colour>	606	=item B<troughColor:> I<colour>
414		607
415	Use the specified colour for the scrollbar's trough area [default	608	Use the specified colour for the scrollbar's trough area [default
416	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	609	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
		610
		611	=item B<borderColor:> I<colour>
		612
		613	The colour of the border around the text area and between the scrollbar
		614	and the text.
417		615
418	=item B<backgroundPixmap:> I<file[;geom]>	616	=item B<backgroundPixmap:> I<file[;geom]>
419		617
420	Use the specified XPM file (note the `.xpm' extension is optional) for	618	Use the specified XPM file (note the `.xpm' extension is optional) for
421	the background and also optionally specify its scaling with a geometry	619	the background and also optionally specify its scaling with a geometry
…		…
437		635
438	Specify the colon-delimited search path for finding files (XPM and	636	Specify the colon-delimited search path for finding files (XPM and
439	menus), in addition to the paths specified by the B<RXVTPATH> and	637	menus), in addition to the paths specified by the B<RXVTPATH> and
440	B<PATH> environment variables.	638	B<PATH> environment variables.
441		639
442	=item B<font:> I<fontname>	640	=item B<font:> I<fontlist>
443		641
444	Select the fonts to be used. This is a comma seperated list of font	642	Select the fonts to be used. This is a comma separated list of font
445	names that are used in turn when trying to display Unicode characters.	643	names that are used in turn when trying to display Unicode characters.
446	The first font defines the cell size for characters; other fonts might	644	The first font defines the cell size for characters; other fonts might
447	be smaller, but not larger. A reasonable default font list is always	645	be smaller, but not larger. A reasonable default font list is always
448	appended to it. option B<-fn>.	646	appended to it; option B<-fn>.
449		647
450	=item B<realBold:> I<boolean>	648	Each font can either be a standard X11 core font (XLFD) name, with
		649	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
451		650
452	B<True>: Enable "real bold" support. When this option is on, bold text	651	In addition, each font can be prefixed with additional hints and
453	will be displayed using the first available bold font in the font list.	652	specifications enclosed in square brackets (C<[]>). The only available
454	Bold fonts should thus be specified in the font list after their	653	hint currently is C<codeset=codeset-name>, and this is only used for Xft
455	corresponding regular fonts. If no bold font can be found, a regular	654	fonts.
456	font will be used. option B<-rb>. B<False>: Display bold text in a	655
457	regular font, using the color specified with B<colorBD>; option B<+rb>.	656	For example, this font resource
		657
		658	URxvt*font: 9x15bold,\
		659	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
		660	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
		661	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
		662	xft:Code2000:antialias=false
		663
		664	specifies five fonts to be used. The first one is C<9x15bold> (actually
		665	the iso8859-1 version of the second font), which is the base font (because
		666	it is named first) and thus defines the character cell grid to be 9 pixels
		667	wide and 15 pixels high.
		668
		669	The second font is just used to add additional unicode characters not in
		670	the base font, likewise the third, which is unfortunately non-bold, but
		671	the bold version of the font does contain less characters, so this is a
		672	useful supplement.
		673
		674	The third font is an Xft font with aliasing turned off, and the characters
		675	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
		676	contains other characters, but we are not interested in them.
		677
		678	The last font is a useful catch-all font that supplies most of the
		679	remaining unicode characters.
		680
		681	=item B<boldFont:> I<fontlist>
		682
		683	=item B<italicFont:> I<fontlist>
		684
		685	=item B<boldItalicFont:> I<fontlist>
		686
		687	The font list to use for displaying B<bold>, I<italic> or B<< I<bold
		688	italic> >> characters, respectively.
		689
		690	If specified and non-empty, then the syntax is the same as for the
		691	B<font>-resource, and the given font list will be used as is, which makes
		692	it possible to substitute completely different font styles for bold and
		693	italic.
		694
		695	If unset (the default), a suitable font list will be synthesized by
		696	"morphing" the normal text font list into the desired shape. If that is
		697	not possible, replacement fonts of the desired shape will be tried.
		698
		699	If set, but empty, then this specific style is disabled and the normal
		700	text font will being used for the given style.
		701
		702	=item B<intensityStyles:> I<boolean>
		703
		704	When font styles are not enabled, or this option is enabled (B<True>,
		705	option B<-is>, the default), bold and italic font styles imply high
		706	intensity foreground/backround colours. Disabling this option (B<False>,
		707	option B<+is>) disables this behaviour, the high intensity colours are not
		708	reachable.
458		709
459	=item B<selectstyle:> I<mode>	710	=item B<selectstyle:> I<mode>
460		711
461	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	712	Set mouse selection style to B<old> which is 2.20, B<oldword> which is
462	xterm style with 2.20 old word selection, or anything else which gives	713	xterm style with 2.20 old word selection, or anything else which gives
463	xterm style selection.	714	xterm style selection.
464		715
465	=item B<scrollstyle:> I<mode>	716	=item B<scrollstyle:> I<mode>
466		717
467	Set scrollbar style to B<@@RXVTNAME@@>, B<rxvt>, B<plain>, B<next> or	718	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
468	B<xterm>	719	the author's favourite.
469		720
470	=item B<title:> I<string>	721	=item B<title:> I<string>
471		722
472	Set window title string, the default title is the command-line	723	Set window title string, the default title is the command-line
473	specified after the B<-e> option, if any, otherwise the application	724	specified after the B<-e> option, if any, otherwise the application
…		…
505		756
506	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	757	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
507	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or	758	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
508	B<Shift-Print> to include the scrollback as well.	759	B<Shift-Print> to include the scrollback as well.
509		760
		761	The string will be interpreted as if typed into the shell as-is.
		762
		763	Example:
		764
		765	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		766
		767	This creates a new file in your home directory with the screen contents
		768	everytime you hit C<Print>.
		769
510	=item B<scrollBar:> I<boolean>	770	=item B<scrollBar:> I<boolean>
511		771
512	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	772	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
513	disable the scrollbar; option B<+sb>.	773	disable the scrollbar; option B<+sb>.
514		774
…		…
527	Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar	787	Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar
528	thumb with the pointer on middle button press/drag.	788	thumb with the pointer on middle button press/drag.
529		789
530	=item B<scrollTtyOutput:> I<boolean>	790	=item B<scrollTtyOutput:> I<boolean>
531		791
532	B<True>: scroll to bottom when tty receives output; option B<+si>.	792	B<True>: scroll to bottom when tty receives output; option B<-si>.
533	B<False>: do not scroll to bottom when tty receives output; option	793	B<False>: do not scroll to bottom when tty receives output; option
534	B<-si>.	794	B<+si>.
535		795
536	=item B<scrollWithBuffer:> I<boolean>	796	=item B<scrollWithBuffer:> I<boolean>
537		797
538	B<True>: scroll with scrollback buffer when tty recieves new lines (and	798	B<True>: scroll with scrollback buffer when tty receives new lines (and
539	B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll	799	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
540	with scrollback buffer when tty recieves new lines; option B<-sw>.	800	with scrollback buffer when tty recieves new lines; option B<+sw>.
541		801
542	=item B<scrollTtyKeypress:> I<boolean>	802	=item B<scrollTtyKeypress:> I<boolean>
543		803
544	B<True>: scroll to bottom when a non-special key is pressed. Special	804	B<True>: scroll to bottom when a non-special key is pressed. Special keys
545	keys are those which are intercepted by rxvt for special handling and	805	are those which are intercepted by rxvt-unicode for special handling and
546	are not passed onto the shell; option B<-sk>. B<False>: do not scroll	806	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
547	to bottom when a non-special key is pressed; option B<+sk>.	807	bottom when a non-special key is pressed; option B<+sk>.
548
549	=item B<smallfont_key:> I<keysym>
550
551	If enabled, use B<@@HOTKEY@@->I<keysym> to toggle to a smaller font
552	[default B<@@HOTKEY@@-@@SMALLFONT@@>]
553
554	=item B<bigfont_key:> I<keysym>
555
556	If enabled, use B<@@HOTKEY@@->I<keysym> to toggle to a bigger font
557	[default B<@@HOTKEY@@-@@BIGFONT@@>]
558		808
559	=item B<saveLines:> I<number>	809	=item B<saveLines:> I<number>
560		810
561	Save I<number> lines in the scrollback buffer [default 64]. This	811	Save I<number> lines in the scrollback buffer [default 64]. This
562	resource is limited on most machines to 65535; option B<-sl>.	812	resource is limited on most machines to 65535; option B<-sl>.
…		…
572	option B<-w>, B<-bw>, B<-borderwidth>.	822	option B<-w>, B<-bw>, B<-borderwidth>.
573		823
574	=item B<borderLess:> I<boolean>	824	=item B<borderLess:> I<boolean>
575		825
576	Set MWM hints to request a borderless window, i.e. if honoured by the	826	Set MWM hints to request a borderless window, i.e. if honoured by the
577	WM, the rxvt window will not have window decorations; option B<-bl>.	827	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
578		828
579	=item B<termName:> I<termname>	829	=item B<termName:> I<termname>
580		830
581	Specifies the terminal type name to be set in the B<TERM> environment	831	Specifies the terminal type name to be set in the B<TERM> environment
582	variable; option B<-tn>.	832	variable; option B<-tn>.
…		…
593		843
594	=item B<mouseWheelScrollPage:> I<boolean>	844	=item B<mouseWheelScrollPage:> I<boolean>
595		845
596	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel	846	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
597	scrolls five lines [default].	847	scrolls five lines [default].
		848
		849	=item B<pastableTabs:> I<boolean>
		850
		851	B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
		852	movement only; option C<-ptab>.
598		853
599	=item B<cursorBlink:> I<boolean>	854	=item B<cursorBlink:> I<boolean>
600		855
601	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	856	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
602	option B<-bc>.	857	option B<-bc>.
…		…
615		870
616	Mouse pointer background colour.	871	Mouse pointer background colour.
617		872
618	=item B<pointerBlankDelay:> I<number>	873	=item B<pointerBlankDelay:> I<number>
619		874
620	Specifies number of seconds before blanking the pointer [default 2].	875	Specifies number of seconds before blanking the pointer [default 2]. Use a
		876	large number (e.g. C<987654321>) to effectively disable the timeout.
621		877
622	=item B<backspacekey:> I<string>	878	=item B<backspacekey:> I<string>
623		879
624	The string to send when the backspace key is pressed. If set to B<DEC>	880	The string to send when the backspace key is pressed. If set to B<DEC>
625	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	881	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
…		…
647		903
648	I<name> of inputMethod to use; option B<-im>.	904	I<name> of inputMethod to use; option B<-im>.
649		905
650	=item B<imLocale:> I<name>	906	=item B<imLocale:> I<name>
651		907
652	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	908	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
653	de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input	909	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
654	extension to be able to input japanese characters while staying in	910	input extension to be able to input japanese characters while staying in
655	another locale. option B<-imlocale>.	911	another locale; option B<-imlocale>.
656		912
657	=item B<insecure>	913	=item B<imFont:> I<fontset>
		914
		915	Specify the font-set used for XIM styles C<OverTheSpot> or
		916	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
		917	by commas), i.e. it's not in the same format as the other font lists used
		918	in @@RXVT_NAME@@. The default will be set-up to chose any suitable found
		919	found, preferably one or two pixels differing in size to the base font.
		920	option B<-imfont>.
		921
		922	=item B<tripleclickwords:> I<boolean>
		923
		924	Change the meaning of triple-click selection with the left mouse
		925	button. Instead of selecting a full line it will extend the selection to
		926	the end of the logical line only; option B<-tcw>.
		927
		928	=item B<insecure:> I<boolean>
658		929
659	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	930	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
660	echo arbitrary strings like the icon name or the locale. This could be	931	echo arbitrary strings like the icon name or the locale. This could be
661	abused if somebody gets 8-bit-clean access to your display, wether	932	abused if somebody gets 8-bit-clean access to your display, whether
662	throuh a mail client displaying mail bodies unfiltered or though	933	through a mail client displaying mail bodies unfiltered or through
663	write(1). Therefore, these sequences are disabled by default. (Note	934	write(1) or any other means. Therefore, these sequences are disabled by
664	that other terminals, including xterm, have these sequences	935	default. (Note that many other terminals, including xterm, have these
665	enabled by default). You can enable them by setting this boolean	936	sequences enabled by default, which doesn't make it safer, though).
666	resource or specifying B<-insecure> as an option. At the moment, this	937
667	enabled display-answer, locale, findfont, icon label and window title	938	You can enable them by setting this boolean resource or specifying
668	requests as well as dynamic menubar dispatch.	939	B<-insecure> as an option. At the moment, this enables display-answer,
		940	locale, findfont, icon label and window title requests as well as dynamic
		941	menubar dispatch.
669		942
670	=item B<modifier:> I<modifier>	943	=item B<modifier:> I<modifier>
671		944
672	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	945	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
673	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	946	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
674	B<-mod>.	947	B<-mod>.
675		948
676	=item B<answerbackString:> I<string>	949	=item B<answerbackString:> I<string>
677		950
678	Specify the reply rxvt sends to the shell when an ENQ (control-E)	951	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
679	character is passed through. It may contain escape values as described	952	character is passed through. It may contain escape values as described
680	in the entry on B<keysym> following.	953	in the entry on B<keysym> following.
681		954
682	=item B<secondaryScreen:> I<bool>	955	=item B<secondaryScreen:> I<bool>
683		956
…		…
688	Turn on/off secondary screen scroll (default enabled). If the this	961	Turn on/off secondary screen scroll (default enabled). If the this
689	option is enabled, scrolls on the secondary screen will change the	962	option is enabled, scrolls on the secondary screen will change the
690	scrollback buffer and switching to/from the secondary screen will	963	scrollback buffer and switching to/from the secondary screen will
691	instead scroll the screen up.	964	instead scroll the screen up.
692		965
		966	=item B<hold>: I<bool>
		967
		968	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		969	will not immediately destroy its window when the program executed within
		970	it exits. Instead, it will wait till it is being killed or closed by the
		971	user.
		972
693	=item B<keysym.>I<sym>: I<string>	973	=item B<keysym.>I<sym>: I<string>
694		974
695	Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may	975	Compile I<frills>: Associate I<string> with keysym I<sym>. The
696	contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:	976	intervening resource name B<keysym.> cannot be omitted.
697	newline, \r: return, \t:	977
		978	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
		979	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
		980	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
		981	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
		982	B<2>, B<3>, B<4>, B<5>.
		983
		984	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
		985	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
		986	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
		987	current application keymap mode state.
		988
		989	The spellings of I<key> can be obtained by using B<xev>(1) command or
		990	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
		991	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
		992	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
		993	performed in an exact manner; however, the closest match is assured.
		994
		995	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
		996	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
698	tab, \000: octal number) or control characters (^?: delete, ^@: null,	997	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
699	^A ...) and may enclosed with double quotes so that it can start or end	998	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
700	with whitespace. The intervening resource name B<keysym.> cannot be	999	can start or end with whitespace.
701	omitted. This resource is only available when compiled with	1000
702	KEYSYM_RESOURCE.	1001	Please note that you need to double the C<\> when using
		1002	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
		1003	use C<\033> instead of C<\e> (and so on), which will work with both Xt and
		1004	@@RXVT_NAME@@'s own processing).
		1005
		1006	You can define a range of keysyms in one shot by providing a I<string>
		1007	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
		1008	should be a character not used by the strings.
		1009
		1010	Its usage can be demonstrated by an example:
		1011
		1012	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
		1013
		1014	The above line is equivalent to the following three lines:
		1015
		1016	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
		1017	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
		1018	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
		1019
		1020	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
		1021	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
		1022	example the following means "change the current locale to C<zh_CN.GBK>
		1023	when Control-Meta-c is being pressed":
		1024
		1025	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		1026
		1027	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1028	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1029	manpage. For example, the F<selection> extension (activated via
		1030	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1031
		1032	URxvt.keysym.M-C-c: perl:selection:rot13
		1033
		1034	Due the the large number of modifier combinations, a defined key mapping
		1035	will match if at I<at least> the specified identifiers are being set, and
		1036	no other key mappings with those and more bits are being defined. That
		1037	means that defining a key map for C<a> will automatically provide
		1038	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		1039	mappings themselves.
		1040
		1041	Unfortunately, this will override built-in key mappings. For example
		1042	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		1043	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		1044	user-defined keymap using the C<builtin:> replacement:
		1045
		1046	URxvt.keysym.Insert: <my insert key sequence>
		1047	URxvt.keysym.S-Insert: builtin:
		1048
		1049	The first line defines a mapping for C<Insert> and I<any> combination
		1050	of modifiers. The second line re-establishes the default mapping for
		1051	C<Shift-Insert>.
		1052
		1053	The following example will map Control-Meta-1 and Control-Meta-2 to
		1054	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
		1055	font-switching at runtime:
		1056
		1057	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1058	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
		1059
		1060	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
		1061	info):
		1062
		1063	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1064	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1065
		1066	=item B<perl-ext>: I<string>
		1067
		1068	Colon-separated list of perl extension scripts to use in this terminal
		1069	instance. Each extension is looked up in the library directories, loaded
		1070	if necessary, and bound to the current terminal instance; option B<-pe>.
		1071
		1072	=item B<perl-eval>: I<string>
		1073
		1074	Perl code to be evaluated when all extensions have been registered. See the
		1075	@@RXVT_NAME@@perl(3) manpage.
		1076
		1077	=item B<perl-lib>: I<path>
		1078
		1079	Colon-separated list of additional directories that hold extension
		1080	scripts. When looking for extensions specified by the C<perl> resource,
		1081	@@RXVT_NAME@@ will first look in these directories and then in
		1082	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
		1083
		1084	See the @@RXVT_NAME@@perl(3) manpage.
703		1085
704	=back	1086	=back
705		1087
706	=head1 THE SCROLLBAR	1088	=head1 THE SCROLLBAR
707		1089
708	Lines of text that scroll off the top of the B<@@RXVTNAME@@> window	1090	Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
709	(resource: B<saveLines>) and can be scrolled back using the scrollbar	1091	(resource: B<saveLines>) and can be scrolled back using the scrollbar
710	or by keystrokes. The normal B<@@RXVTNAME@@> scrollbar has arrows and	1092	or by keystrokes. The normal B<@@RXVT_NAME@@> scrollbar has arrows and
711	its behaviour is fairly intuitive. The B<xterm-scrollbar> is without	1093	its behaviour is fairly intuitive. The B<xterm-scrollbar> is without
712	arrows and its behaviour mimics that of I<xterm>	1094	arrows and its behaviour mimics that of I<xterm>
713		1095
714	Scroll down with B<Button1> (B<xterm-scrollbar>) or B<Shift-Next>.	1096	Scroll down with B<Button1> (B<xterm-scrollbar>) or B<Shift-Next>.
715	Scroll up with B<Button3> (B<xterm-scrollbar>) or B<Shift-Prior>.	1097	Scroll up with B<Button3> (B<xterm-scrollbar>) or B<Shift-Prior>.
…		…
721	the normal text selection/insertion, hold either the Shift or the Meta	1103	the normal text selection/insertion, hold either the Shift or the Meta
722	(Alt) key while performing the desired mouse action.	1104	(Alt) key while performing the desired mouse action.
723		1105
724	If mouse reporting mode is active, the normal scrollbar actions are	1106	If mouse reporting mode is active, the normal scrollbar actions are
725	disabled -- on the assumption that we are using a fullscreen	1107	disabled -- on the assumption that we are using a fullscreen
726	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	1108	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
727	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	1109	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
728	up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down),	1110	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
729	respectively.	1111	respectively.
730		1112
731	=head1 TEXT SELECTION AND INSERTION	1113	=head1 TEXT SELECTION AND INSERTION
732		1114
733	The behaviour of text selection and insertion mechanism is similar to	1115	The behaviour of text selection and insertion mechanism is similar to
…		…
735		1117
736	=over 4	1118	=over 4
737		1119
738	=item B<Selection>:	1120	=item B<Selection>:
739		1121
740	Left click at the beginning of the region, drag to the end of the	1122	Left click at the beginning of the region, drag to the end of the region
741	region and release; Right click to extend the marked region; Left	1123	and release; Right click to extend the marked region; Left double-click
742	double-click to select a word; Left triple-click to select the entire	1124	to select a word; Left triple-click to select the entire logical line
743	line.	1125	(which can span multiple screen lines), unless modified by resource
		1126	B<tripleclickwords>.
		1127
		1128	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
		1129	(Compile: I<frills>) will create a rectangular selection instead of a
		1130	normal one. In this mode, every selected row becomes its own line in the
		1131	selection, and trailing whitespace is visually underlined and removed from
		1132	the selection.
744		1133
745	=item B<Insertion>:	1134	=item B<Insertion>:
746		1135
747	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1136	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
748	an B<@@RXVTNAME@@> window causes the current text selection to be	1137	an B<@@RXVT_NAME@@> window causes the current text selection to be
749	inserted as if it had been typed on the keyboard.	1138	inserted as if it had been typed on the keyboard.
750		1139
751	=back	1140	=back
752		1141
753	=head1 CHANGING FONTS	1142	=head1 CHANGING FONTS
754		1143
755	You can change fonts on-the-fly, which is to say cycle through the	1144	Changing fonts (or font sizes, respectively) via the keypad is not yet
756	default font and others of various sizes, by using B<Shift-KP_Add> and	1145	supported in rxvt-unicode. Bug me if you need this.
757	B<Shift-KP_Subtract>. Or, alternatively (if enabled) with	1146
758	B<@@HOTKEY@@-@@BIGFONT@@> and B<@@HOTKEY@@-@@SMALLFONT@@>, where the	1147	You can, however, switch fonts at runtime using escape sequences (and
759	actual key can be selected using resources	1148	therefore using the menubar), e.g.:
760	B<smallfont_key>/B<bigfont_key>.	1149
		1150	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1151
		1152	rxvt-unicode will automatically re-apply these fonts to the output so far.
		1153
		1154	=head1 ISO 14755 SUPPORT
		1155
		1156	ISO 14755 is a standard for entering and viewing unicode characters
		1157	and character codes using the keyboard. It consists of 4 parts. The
		1158	first part is available rxvt-unicode has been compiled with
		1159	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
		1160	with C<--enable-iso14755>.
		1161
		1162	=over 4
		1163
		1164	=item * 5.1: Basic method
		1165
		1166	This allows you to enter unicode characters using their hexcode.
		1167
		1168	Start by pressing and holding both C<Control> and C<Shift>, then enter
		1169	hex-digits (between one and six). Releasing C<Control> and C<Shift> will
		1170	commit the character as if it were typed directly. While holding down
		1171	C<Control> and C<Shift> you can also enter multiple characters by pressing
		1172	C<Space>, which will commit the current character and lets you start a new
		1173	one.
		1174
		1175	As an example of use, imagine a business card with a japanese e-mail
		1176	address, which you cannot type. Fortunately, the card has the e-mail
		1177	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
		1178	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
		1179	followed by releasing the modifier keys.
		1180
		1181	=item * 5.2: Keyboard symbols entry method
		1182
		1183	This mode lets you input characters representing the keycap symbols of
		1184	your keyboard, if representable in the current locale encoding.
		1185
		1186	Start by pressing C<Control> and C<Shift> together, then releasing
		1187	them. The next special key (cursor keys, home etc.) you enter will not
		1188	invoke it's usual function but instead will insert the corresponding
		1189	keycap symbol. The symbol will only be entered when the key has been
		1190	released, otherwise pressing e.g. C<Shift> would enter the symbol for
		1191	C<ISO Level 2 Switch>, although your intention might have been to enter a
		1192	reverse tab (Shift-Tab).
		1193
		1194	=item * 5.3: Screen-selection entry method
		1195
		1196	While this is implemented already (it's basically the selection
		1197	mechanism), it could be extended by displaying a unicode character map.
		1198
		1199	=item * 5.4: Feedback method for identifying displayed characters for later input
		1200
		1201	This method lets you display the unicode character code associated with
		1202	characters already displayed.
		1203
		1204	You enter this mode by holding down C<Control> and C<Shift> together, then
		1205	pressing and holding the left mouse button and moving around. The unicode
		1206	hex code(s) (it might be a combining character) of the character under the
		1207	pointer is displayed until you release C<Control> and C<Shift>.
		1208
		1209	In addition to the hex codes it will display the font used to draw this
		1210	character - due to implementation reasons, characters combined with
		1211	combining characters, line drawing characters and unknown characters will
		1212	always be drawn using the built-in support font.
		1213
		1214	=back
		1215
		1216	With respect to conformance, rxvt-unicode is supposed to be compliant to
		1217	both scenario A and B of ISO 14755, including part 5.2.
761		1218
762	=head1 LOGIN STAMP	1219	=head1 LOGIN STAMP
763		1220
764	B<@@RXVTNAME@@> tries to write an entry into the I<utmp>(5) file so	1221	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
765	that it can be seen via the I<who(1)> command, and can accept messages.	1222	it can be seen via the I<who(1)> command, and can accept messages. To
766	To allow this feature, B<@@RXVTNAME@@> must be installed setuid root on	1223	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
767	some systems.	1224	on some systems or setgid to root or to some other group on others.
768		1225
769	=head1 COLORS AND GRAPHICS	1226	=head1 COLORS AND GRAPHICS
770		1227
771	In addition to the default foreground and background colours,	1228	In addition to the default foreground and background colours,
772	B<@@RXVTNAME@@> can display up to 16 colours (8 ANSI colours plus	1229	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
773	high-intensity bold/blink versions of the same). Here is a list of the	1230	high-intensity bold/blink versions of the same). Here is a list of the
774	colours with their B<rgb.txt> names.	1231	colours with their B<rgb.txt> names.
775		1232
776	=begin table	1233	=begin table
777		1234
…		…
806	I<xterm>(1) where the colours are only swapped if they have not otherwise	1263	I<xterm>(1) where the colours are only swapped if they have not otherwise
807	been specified. For example,	1264	been specified. For example,
808		1265
809	=over 4	1266	=over 4
810		1267
811	=item B<rxvt -fg Black -bg White -rv>	1268	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
812		1269
813	would yield White on Black, while on I<xterm>(1) it would yield Black	1270	would yield White on Black, while on I<xterm>(1) it would yield Black
814	on White.	1271	on White.
815		1272
816	=back	1273	=back
817		1274
818	=head1 ENVIRONMENT	1275	=head1 ENVIRONMENT
819		1276
820	B<@@RXVTNAME@@> sets the environment variables B<TERM>, B<COLORTERM>	1277	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
821	and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X	1278
822	window id number of the B<@@RXVTNAME@@> window and it also uses and	1279	=over 4
823	sets the environment variable B<DISPLAY> to specify which display	1280
824	terminal to use. B<@@RXVTNAME@@> uses the environment variables	1281	=item B<TERM>
825	B<RXVTPATH> and B<PATH> to find XPM files.	1282
		1283	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
		1284	resources or on the commandline.
		1285
		1286	=item B<COLORTERM>
		1287
		1288	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
		1289	compiled with XPM support, and optionally with the added extension
		1290	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
		1291
		1292	=item B<COLORFGBG>
		1293
		1294	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
		1295	the colour code used as default foreground/text colour (or the string
		1296	C<default> to indicate that the default-colour escape sequence is to be
		1297	used), C<bg> is the colour code used as default background colour (or the
		1298	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1299	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
		1300	(and do) use this information to optimize screen output.
		1301
		1302	=item B<WINDOWID>
		1303
		1304	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
		1305	window, which usually has subwindows for the scrollbar, the terminal
		1306	window and so on).
		1307
		1308	=item B<TERMINFO>
		1309
		1310	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1311	C<--with-terminfo=PATH>.
		1312
		1313	=item B<DISPLAY>
		1314
		1315	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
		1316	display in it's child processes.
		1317
		1318	=item B<SHELL>
		1319
		1320	The shell to be used for command execution, defaults to C</bin/sh>.
		1321
		1322	=item B<RXVTPATH>
		1323
		1324	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
		1325	files.
		1326
		1327	=item B<PATH>
		1328
		1329	Used in the same way as C<RXVTPATH>.
		1330
		1331	=item B<RXVT_SOCKET>
		1332
		1333	The unix domain socket path used by @@RXVT_NAME@@c(1) and
		1334	@@RXVT_NAME@@d(1).
		1335
		1336	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
		1337
		1338	=item B<HOME>
		1339
		1340	Used to locate the default directory for the unix domain socket for
		1341	daemon communications and to locate various resource files (such as
		1342	C<.Xdefaults>)
		1343
		1344	=item B<XAPPLRESDIR>
		1345
		1346	Directory where various X resource files are being located.
		1347
		1348	=item B<XENVIRONMENT>
		1349
		1350	If set and accessible, gives the name of a X resource file to be loaded by
		1351	@@RXVT_NAME@@.
		1352
		1353	=back
826		1354
827	=head1 FILES	1355	=head1 FILES
828		1356
829	=over 4	1357	=over 4
830		1358
831	=item B</etc/utmp>
832
833	System file for login records.
834
835	=item B</usr/lib/X11/rgb.txt>	1359	=item B</usr/lib/X11/rgb.txt>
836		1360
837	Color names.	1361	Color names.
838		1362
839	=back	1363	=back
840		1364
841	=head1 SEEALSO	1365	=head1 SEE ALSO
842		1366
843	I<xterm>(1), I<sh>(1), I<resize>(1), I<X>(1), I<pty>(4), I<tty>(4), I<utmp>(5)	1367	@@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)
844
845	See rxvtRef.html rxvtRef.txt for detailed information on recognized escape sequences and menuBar syntax, etc.
846
847	=head1 BUGS
848
849	Check the BUGS file for an up-to-date list.
850
851	Cursor change support is not yet implemented.
852
853	Click-and-drag doesn't work with X11 mouse report overriding.
854
855	=head1 FTP LOCATION
856
857	rxvt-+@@RXVTVERSION@@.tar.gz can be found at the following ftp sites L<@@RXVTFTPSITE@@>(@@RXVTFTPSITE@@)
858		1368
859	=head1 CURRENT PROJECT COORDINATOR	1369	=head1 CURRENT PROJECT COORDINATOR
860		1370
861	=over 4	1371	=over 4
862		1372
863	=item Project Coordinator	1373	=item Project Coordinator
864		1374
865	@@RXVTMAINT@@ L<@@RXVTMAINTEMAIL@@>	1375	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
866		1376
867	=item Web page maintainter	1377	L<http://software.schmorp.de/#rxvt-unicode>
868
869	@@RXVTWEBMAINT@@ L<@@RXVTWEBMAINTEMAIL@@>
870
871	L<@@RXVTWEBPAGE@@>(@@RXVTWEBPAGE@@)
872		1378
873	=back	1379	=back
874		1380
875	=head1 AUTHORS	1381	=head1 AUTHORS
876		1382
…		…
901	=item Geoff Wing L<< <gcw@pobox.com> >>	1407	=item Geoff Wing L<< <gcw@pobox.com> >>
902		1408
903	Rewrote screen display and text selection routines. Project Coordinator	1409	Rewrote screen display and text selection routines. Project Coordinator
904	(changes.txt 2.4.6 - rxvt-unicode)	1410	(changes.txt 2.4.6 - rxvt-unicode)
905		1411
906	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>	1412	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
907		1413
908	Forked rxvt-unicode, rewrote most of the display code and internal	1414	Forked rxvt-unicode, rewrote most of the display code and internal
909	character handling to store text in unicode, improve xterm	1415	character handling to store text in unicode, improve xterm
910	compatibility and apply numerous other bugfixes and extensions.	1416	compatibility and apply numerous other bugfixes and extensions.
911		1417

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.1 by root, Thu Aug 12 20:42:12 2004 UTC vs. Revision 1.81 by root, Mon Jan 2 21:41:51 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.1 by root, Thu Aug 12 20:42:12 2004 UTC vs.
Revision 1.81 by root, Mon Jan 2 21:41:51 2006 UTC