[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.98 by root, Mon Jan 16 15:12:48 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 checked in order when trying to find glyphs for 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 I<font-styles>: The bold font list to use when B<bold> characters
		195	are to be printed. See resource B<boldFont> for details.
		196
		197	=item B<-fi> I<fontlist>
		198
		199	Compile I<font-styles>: The italic font list to use when I<italic>
		200	characters are to be printed. See resource B<italicFont> for details.
		201
		202	=item B<-fbi> I<fontlist>
		203
		204	Compile I<font-styles>: The bold italic font list to use when B<< I<bold
		205	italic> >> characters are to be printed. See resource B<boldItalicFont>
		206	for details.
		207
122	=item B<-rb>\|B<+rb>	208	=item B<-is>\|B<+is>
123		209
124	Enable "real bold" support. When this option is on, bold text will be	210	Compile I<font-styles>: Bold/Italic font styles imply high intensity
125	displayed using the first available bold font in the font list. Bold	211	foreground/background (default). See resource B<intensityStyles> for
126	fonts should thus be specified in the font list after their	212	details.
127	corresponding regular fonts. If no bold font can be found, a regular
128	font will be used. resource B<realBold>.
129		213
130	=item B<-name> I<name>	214	=item B<-name> I<name>
131		215
132	Specify the application name under which resources are to be obtained,	216	Specify the application name under which resources are to be obtained,
133	rather than the default executable file name. Name should not contain	217	rather than the default executable file name. Name should not contain
…		…
171		255
172	Put scrollbar on right/left; resource B<scrollBar_right>.	256	Put scrollbar on right/left; resource B<scrollBar_right>.
173		257
174	=item B<-st>\|B<+st>	258	=item B<-st>\|B<+st>
175		259
176	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	260	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
177	resource B<scrollBar_floating>.	261	resource B<scrollBar_floating>.
		262
		263	=item B<-ptab>\|B<+ptab>
		264
		265	If enabled (default), "Horizontal Tab" characters are being stored as
		266	actual wide characters in the screen buffer, which makes it possible to
		267	select and paste them. Since a horizontal tab is a cursor movement and
		268	not an actual glyph, this can sometimes be visually annoying as the cursor
		269	on a tab character is displayed as a wide cursor; resource B<pastableTabs>.
178		270
179	=item B<-bc>\|B<+bc>	271	=item B<-bc>\|B<+bc>
180		272
181	Blink the cursor; resource B<cursorBlink>.	273	Blink the cursor; resource B<cursorBlink>.
182		274
…		…
202	B<externalBorder>.	294	B<externalBorder>.
203		295
204	=item B<-bl>	296	=item B<-bl>
205		297
206	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	298	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	299	if honoured by the WM, the rxvt-unicode window will not have window
208	decorations; resource B<borderLess>.	300	decorations; resource B<borderLess>.
209		301
		302	=item B<-sbg>
		303
		304	Compile I<frills>: Disable the usage of the built-in block graphics/line
		305	drawing characters and just rely on what the specified fonts provide. Use
		306	this if you have a good font and want to use its block graphic glyphs;
		307	resource B<skipBuiltinGlyphs>.
		308
210	=item B<-lsp> I<number>	309	=item B<-lsp> I<number>
211		310
212	Compile I<linespace>: Lines (pixel height) to insert between each row	311	Compile I<frills>: Lines (pixel height) to insert between each row of
213	of the display; resource B<linespace>.	312	the display. Useful to work around font rendering problems; resource
		313	B<linespace>.
214		314
215	=item B<-tn> I<termname>	315	=item B<-tn> I<termname>
216		316
217	This option specifies the name of the terminal type to be set in the	317	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	318	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;	319	I<termcap(5)> database and should have I<li#> and I<co#> entries;
220	resource B<termName>.	320	resource B<termName>.
221		321
222	=item B<-e> I<command [arguments]>	322	=item B<-e> I<command [arguments]>
223		323
224	Run the command with its command-line arguments in the B<@@RXVTNAME@@>	324	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	325	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	326	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	327	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	328	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,	329	run the program specified by the B<SHELL> environment variable or,
230	failing that, I<sh(1)>.	330	failing that, I<sh(1)>.
231		331
		332	Please note that you must specify a program with arguments. If you want to
		333	run shell commands, you have to specify the shell, like this:
		334
		335	@@RXVT_NAME@@ -e sh -c "shell commands"
		336
232	=item B<-title> I<text>	337	=item B<-title> I<text>
233		338
234	Window title (B<-T> still respected); the default title is the basename	339	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	340	of the program specified after the B<-e> option, if any, otherwise the
236	application name; resource B<title>.	341	application name; resource B<title>.
…		…
254		359
255	Compile I<XIM>: input method name. resource B<inputMethod>.	360	Compile I<XIM>: input method name. resource B<inputMethod>.
256		361
257	=item B<-imlocale> I<string>	362	=item B<-imlocale> I<string>
258		363
259	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	364	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	365	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	366	input extension to be able to input japanese characters while staying in
262	another locale.	367	another locale. resource B<imLocale>.
		368
		369	=item B<-imfont> I<fontset>
		370
		371	Set the font set to use for the X Input Method, see resource B<imFont>
		372	for more info.
		373
		374	=item B<-tcw>
		375
		376	Change the meaning of triple-click selection with the left mouse
		377	button. Instead of selecting a full line it will extend the selection the
		378	end of the logical line only. resource B<tripleclickwords>.
263		379
264	=item B<-insecure>	380	=item B<-insecure>
265		381
266	Enable "insecure" mode, which currently enables most of the escape	382	Enable "insecure" mode, which currently enables most of the escape
267	sequences that echo strings. See the resource B<insecure> for more	383	sequences that echo strings. See the resource B<insecure> for more
…		…
281	=item B<-ssr>\|B<+ssr>	397	=item B<-ssr>\|B<+ssr>
282		398
283	Turn on/off secondary screen scroll (default enabled); resource	399	Turn on/off secondary screen scroll (default enabled); resource
284	B<secondaryScroll>.	400	B<secondaryScroll>.
285		401
		402	=item B<-hold>\|B<+hold>
		403
		404	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		405	will not immediately destroy its window when the program executed within
		406	it exits. Instead, it will wait till it is being killed or closed by the
		407	user; resource B<hold>.
		408
		409	=item B<-keysym.>I<sym> I<string>
		410
		411	Remap a key symbol. See resource B<keysym>.
		412
		413	=item B<-embed> I<windowid>
		414
		415	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
		416	which enables applications to easily embed a terminal.
		417
		418	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
		419	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
		420	quite a bit, so don't expect it to keep some specific state. It's best to
		421	create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
		422
		423	The window will not be destroyed when @@RXVT_NAME@@ exits.
		424
		425	It might be useful to know that @@RXVT_NAME@@ will not close file
		426	descriptors passed to it (except for stdin/out/err, of course), so you
		427	can use file descriptors to communicate with the programs within the
		428	terminal. This works regardless of wether the C<-embed> option was used or
		429	not.
		430
		431	Here is a short Gtk2-perl snippet that illustrates how this option can be
		432	used (a longer example is in F<doc/embed>):
		433
		434	my $rxvt = new Gtk2::Socket;
		435	$rxvt->signal_connect_after (realize => sub {
		436	my $xid = $_[0]->window->get_xid;
		437	system "@@RXVT_NAME@@ -embed $xid &";
		438	});
		439
		440	=item B<-pty-fd> I<file descriptor>
		441
		442	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
		443	pair but instead use the given filehandle as the tty master. This is
		444	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
		445	without having to run a program within it.
		446
		447	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
		448	entries and will not tinker with pty/tty permissions - you have to do that
		449	yourself if you want that.
		450
		451	As an extremely special case, specifying C<-1> will completely suppress
		452	pty/tty operations.
		453
		454	Here is a example in perl that illustrates how this option can be used (a
		455	longer example is in F<doc/pty-fd>):
		456
		457	use IO::Pty;
		458	use Fcntl;
		459
		460	my $pty = new IO::Pty;
		461	fcntl $pty, F_SETFD, 0; # clear close-on-exec
		462	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		463	close $pty;
		464
		465	# now communicate with rxvt
		466	my $slave = $pty->slave;
		467	while (<$slave>) { print $slave "got <$_>\n" }
		468
286	=item B<-xrm> I<resourcestring>	469	=item B<-pe> I<string>
287		470
288	No effect on rxvt. Simply passes through an argument to be made	471	Comma-separated list of perl extension scripts to use (or not to use) in
289	available in the instance's argument list. Appears in I<WM_COMMAND> in	472	this terminal instance. See resource B<perl-ext> for details.
290	some window managers.
291		473
292	=back	474	=back
293		475
294	=head1 RESOURCES (available also as long-options)	476	=head1 RESOURCES (available also as long-options)
295		477
296	Note: `@@RXVTNAME@@ --help' gives a list of all resources (long	478	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
297	options) compiled into your version.	479	options) compiled into your version.
298		480
299	There are two different methods that @@RXVTNAME@@ can use to get the	481	You can set and change the resources using X11 tools like B<xrdb>. Many
300	Xresource data: using the X libraries (Xrm*-functions) or internal	482	distribution do also load settings from the B<~/.Xresources> file when X
301	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	483	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
302	B<@@RXVTNAME@@ -h> lists B<XGetDefaults>), you can set and change the	484	with later settings overwriting earlier ones:
303	resources using X11 tools like B<xset>. Many distribution do also load
304	settings from the B<~/.Xresources> file when X starts.
305		485
306	If compiled with internal Xresources support (i.e. B<@@RXVTNAME@@ -h>	486	1. system-wide app-defaults file, either locale-dependent OR global
307	lists B<.Xdefaults>) then B<@@RXVTNAME@@> accepts application defaults	487	2. app-defaults file in $XAPPLRESDIR
308	set in XAPPLOADDIR/URxvt (compile-time defined: usually	488	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
309	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	489	4. SCREEN_RESOURCES for the current screen
310	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.	490	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		491
311	Note that when reading X resources, B<@@RXVTNAME@@> recognizes two	492	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
312	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows	493	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
313	resources common to both B<@@RXVTNAME@@> and the original I<rxvt> to be	494	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
314	easily configured, while the class name B<URxvt> allows resources	495	configured, while the class name B<URxvt> allows resources unique to
315	unique to B<@@RXVTNAME@@>, notably colours and key-handling, to be	496	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
316	shared between different B<@@RXVTNAME@@> configurations. If no	497	configurations. If no resources are specified, suitable defaults will
317	resources are specified, suitable defaults will be used. Command-line	498	be used. Command-line arguments can be used to override resource
318	arguments can be used to override resource settings. The following	499	settings. The following resources are supported (you might want to
319	resources are allowed:	500	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		501	extensions not documented here):
320		502
321	=over 4	503	=over 4
322		504
323	=item B<geometry:> I<geom>	505	=item B<geometry:> I<geom>
324		506
…		…
342	high-intensity (bold = bright foreground, blink = bright background)	524	high-intensity (bold = bright foreground, blink = bright background)
343	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	525	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	526	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.	527	names used are listed in the B<COLORS AND GRAPHICS> section.
346		528
		529	Colours higher than 15 cannot be set using resources (yet), but can be
		530	changed using an escape command (see @@RXVT_NAME@@(7)).
		531
		532	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
		533	88 colour support). Colours 80-87 are evenly spaces grey steps.
		534
347	=item B<colorBD:> I<colour>	535	=item B<colorBD:> I<colour>
348		536
		537	=item B<colorIT:> I<colour>
		538
349	Use the specified colour to display bold characters when the foreground	539	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	540	foreground colour is the default. If font styles are not available
351	enabled.	541	(Compile I<styles>) and this option is unset, reverse video is used instead.
352		542
353	=item B<colorUL:> I<colour>	543	=item B<colorUL:> I<colour>
354		544
355	Use the specified colour to display underlined characters when the	545	Use the specified colour to display underlined characters when the
356	foreground colour is the default.	546	foreground colour is the default.
357		547
358	=item B<colorRV:> I<colour>	548	=item B<colorRV:> I<colour>
359		549
360	Use the specified colour as the background for reverse video	550	Use the specified colour as the background for reverse video
361	characters.	551	characters.
		552
		553	=item B<underlineColor:> I<colour>
		554
		555	If set, use the specified colour as the colour for the underline
		556	itself. If unset, use the foreground colour.
362		557
363	=item B<cursorColor:> I<colour>	558	=item B<cursorColor:> I<colour>
364		559
365	Use the specified colour for the cursor. The default is to use the	560	Use the specified colour for the cursor. The default is to use the
366	foreground colour; option B<-cr>.	561	foreground colour; option B<-cr>.
…		…
389	artificial transparency. B<False>: do not inherit the parent windows'	584	artificial transparency. B<False>: do not inherit the parent windows'
390	pixmap.	585	pixmap.
391		586
392	=item B<fading:> I<number>	587	=item B<fading:> I<number>
393		588
394	Fade the text by the given percentage when focus is lost.	589	Fade the text by the given percentage when focus is lost; option B<-fade>.
		590
		591	=item B<fadeColor:> I<colour>
		592
		593	Fade to this colour, when fading is used (see B<fading:>). The default
		594	colour is black; option B<-fadecolor>.
395		595
396	=item B<tintColor:> I<colour>	596	=item B<tintColor:> I<colour>
397		597
398	Tint the transparent background pixmap with the given colour.	598	Tint the transparent background pixmap with the given colour; option
		599	B<-tint>.
399		600
400	=item B<shading:> I<number>	601	=item B<shading:> I<number>
401		602
402	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	603	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
403	image in addition to tinting it.	604	image in addition to tinting it.
404		605
405	=item B<fading:> I<number>
406
407	Scale the tint colour by the given percentage.
408
409	=item B<scrollColor:> I<colour>	606	=item B<scrollColor:> I<colour>
410		607
411	Use the specified colour for the scrollbar [default #B2B2B2].	608	Use the specified colour for the scrollbar [default #B2B2B2].
412		609
413	=item B<troughColor:> I<colour>	610	=item B<troughColor:> I<colour>
414		611
415	Use the specified colour for the scrollbar's trough area [default	612	Use the specified colour for the scrollbar's trough area [default
416	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	613	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
		614
		615	=item B<borderColor:> I<colour>
		616
		617	The colour of the border around the text area and between the scrollbar
		618	and the text.
417		619
418	=item B<backgroundPixmap:> I<file[;geom]>	620	=item B<backgroundPixmap:> I<file[;geom]>
419		621
420	Use the specified XPM file (note the `.xpm' extension is optional) for	622	Use the specified XPM file (note the `.xpm' extension is optional) for
421	the background and also optionally specify its scaling with a geometry	623	the background and also optionally specify its scaling with a geometry
…		…
425	of 1 displays the image without any scaling. A scale of 2 to 9	627	of 1 displays the image without any scaling. A scale of 2 to 9
426	specifies an integer number of images in that direction. No image will	628	specifies an integer number of images in that direction. No image will
427	be magnified beyond 10 times its original size. The maximum permitted	629	be magnified beyond 10 times its original size. The maximum permitted
428	scale is 1000. [default 0x0+50+50]	630	scale is 1000. [default 0x0+50+50]
429		631
430	=item B<menu:> I<file[;tag]>
431
432	Read in the specified menu file (note the `.menu' extension is
433	optional) and also optionally specify a starting tag to find. See the
434	reference documentation for details on the syntax for the menuBar.
435
436	=item B<path:> I<path>	632	=item B<path:> I<path>
437		633
438	Specify the colon-delimited search path for finding files (XPM and	634	Specify the colon-delimited search path for finding XPM files.
439	menus), in addition to the paths specified by the B<RXVTPATH> and
440	B<PATH> environment variables.
441		635
442	=item B<font:> I<fontname>	636	=item B<font:> I<fontlist>
443		637
444	Select the fonts to be used. This is a comma seperated list of font	638	Select the fonts to be used. This is a comma separated list of font names
445	names that are used in turn when trying to display Unicode characters.	639	that are checked in order when trying to find glyphs for characters. The
446	The first font defines the cell size for characters; other fonts might	640	first font defines the cell size for characters; other fonts might be
447	be smaller, but not larger. A reasonable default font list is always	641	smaller, but not (in general) larger. A (hopefully) reasonable default
448	appended to it. option B<-fn>.	642	font list is always appended to it; option B<-fn>.
449		643
450	=item B<realBold:> I<boolean>	644	Each font can either be a standard X11 core font (XLFD) name, with
		645	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
451		646
452	B<True>: Enable "real bold" support. When this option is on, bold text	647	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.	648	specifications enclosed in square brackets (C<[]>). The only available
454	Bold fonts should thus be specified in the font list after their	649	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	650	fonts.
456	font will be used. option B<-rb>. B<False>: Display bold text in a	651
457	regular font, using the color specified with B<colorBD>; option B<+rb>.	652	For example, this font resource
		653
		654	URxvt.font: 9x15bold,\
		655	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
		656	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
		657	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
		658	xft:Code2000:antialias=false
		659
		660	specifies five fonts to be used. The first one is C<9x15bold> (actually
		661	the iso8859-1 version of the second font), which is the base font (because
		662	it is named first) and thus defines the character cell grid to be 9 pixels
		663	wide and 15 pixels high.
		664
		665	The second font is just used to add additional unicode characters not in
		666	the base font, likewise the third, which is unfortunately non-bold, but
		667	the bold version of the font does contain less characters, so this is a
		668	useful supplement.
		669
		670	The third font is an Xft font with aliasing turned off, and the characters
		671	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
		672	contains other characters, but we are not interested in them.
		673
		674	The last font is a useful catch-all font that supplies most of the
		675	remaining unicode characters.
		676
		677	=item B<boldFont:> I<fontlist>
		678
		679	=item B<italicFont:> I<fontlist>
		680
		681	=item B<boldItalicFont:> I<fontlist>
		682
		683	The font list to use for displaying B<bold>, I<italic> or B<< I<bold
		684	italic> >> characters, respectively.
		685
		686	If specified and non-empty, then the syntax is the same as for the
		687	B<font>-resource, and the given font list will be used as is, which makes
		688	it possible to substitute completely different font styles for bold and
		689	italic.
		690
		691	If unset (the default), a suitable font list will be synthesized by
		692	"morphing" the normal text font list into the desired shape. If that is
		693	not possible, replacement fonts of the desired shape will be tried.
		694
		695	If set, but empty, then this specific style is disabled and the normal
		696	text font will being used for the given style.
		697
		698	=item B<intensityStyles:> I<boolean>
		699
		700	When font styles are not enabled, or this option is enabled (B<True>,
		701	option B<-is>, the default), bold and italic font styles imply high
		702	intensity foreground/backround colours. Disabling this option (B<False>,
		703	option B<+is>) disables this behaviour, the high intensity colours are not
		704	reachable.
458		705
459	=item B<selectstyle:> I<mode>	706	=item B<selectstyle:> I<mode>
460		707
461	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	708	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	709	xterm style with 2.20 old word selection, or anything else which gives
463	xterm style selection.	710	xterm style selection.
464		711
465	=item B<scrollstyle:> I<mode>	712	=item B<scrollstyle:> I<mode>
466		713
467	Set scrollbar style to B<@@RXVTNAME@@>, B<rxvt>, B<plain>, B<next> or	714	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
468	B<xterm>	715	the author's favourite.
469		716
470	=item B<title:> I<string>	717	=item B<title:> I<string>
471		718
472	Set window title string, the default title is the command-line	719	Set window title string, the default title is the command-line
473	specified after the B<-e> option, if any, otherwise the application	720	specified after the B<-e> option, if any, otherwise the application
…		…
505		752
506	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	753	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	754	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.	755	B<Shift-Print> to include the scrollback as well.
509		756
		757	The string will be interpreted as if typed into the shell as-is.
		758
		759	Example:
		760
		761	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		762
		763	This creates a new file in your home directory with the screen contents
		764	everytime you hit C<Print>.
		765
510	=item B<scrollBar:> I<boolean>	766	=item B<scrollBar:> I<boolean>
511		767
512	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	768	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
513	disable the scrollbar; option B<+sb>.	769	disable the scrollbar; option B<+sb>.
514		770
…		…
527	Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar	783	Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar
528	thumb with the pointer on middle button press/drag.	784	thumb with the pointer on middle button press/drag.
529		785
530	=item B<scrollTtyOutput:> I<boolean>	786	=item B<scrollTtyOutput:> I<boolean>
531		787
532	B<True>: scroll to bottom when tty receives output; option B<+si>.	788	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	789	B<False>: do not scroll to bottom when tty receives output; option
534	B<-si>.	790	B<+si>.
535		791
536	=item B<scrollWithBuffer:> I<boolean>	792	=item B<scrollWithBuffer:> I<boolean>
537		793
538	B<True>: scroll with scrollback buffer when tty recieves new lines (and	794	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	795	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
540	with scrollback buffer when tty recieves new lines; option B<-sw>.	796	with scrollback buffer when tty recieves new lines; option B<+sw>.
541		797
542	=item B<scrollTtyKeypress:> I<boolean>	798	=item B<scrollTtyKeypress:> I<boolean>
543		799
544	B<True>: scroll to bottom when a non-special key is pressed. Special	800	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	801	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	802	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>.	803	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		804
559	=item B<saveLines:> I<number>	805	=item B<saveLines:> I<number>
560		806
561	Save I<number> lines in the scrollback buffer [default 64]. This	807	Save I<number> lines in the scrollback buffer [default 64]. This
562	resource is limited on most machines to 65535; option B<-sl>.	808	resource is limited on most machines to 65535; option B<-sl>.
…		…
572	option B<-w>, B<-bw>, B<-borderwidth>.	818	option B<-w>, B<-bw>, B<-borderwidth>.
573		819
574	=item B<borderLess:> I<boolean>	820	=item B<borderLess:> I<boolean>
575		821
576	Set MWM hints to request a borderless window, i.e. if honoured by the	822	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>.	823	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
		824
		825	=item B<skipBuiltinGlyphs:> I<boolean>
		826
		827	Compile I<frills>: Disable the usage of the built-in block graphics/line
		828	drawing characters and just rely on what the specified fonts provide. Use
		829	this if you have a good font and want to use its block graphic glyphs;
		830	option B<-sbg>.
578		831
579	=item B<termName:> I<termname>	832	=item B<termName:> I<termname>
580		833
581	Specifies the terminal type name to be set in the B<TERM> environment	834	Specifies the terminal type name to be set in the B<TERM> environment
582	variable; option B<-tn>.	835	variable; option B<-tn>.
…		…
593		846
594	=item B<mouseWheelScrollPage:> I<boolean>	847	=item B<mouseWheelScrollPage:> I<boolean>
595		848
596	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel	849	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
597	scrolls five lines [default].	850	scrolls five lines [default].
		851
		852	=item B<pastableTabs:> I<boolean>
		853
		854	B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
		855	movement only; option C<-ptab>.
598		856
599	=item B<cursorBlink:> I<boolean>	857	=item B<cursorBlink:> I<boolean>
600		858
601	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	859	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
602	option B<-bc>.	860	option B<-bc>.
…		…
615		873
616	Mouse pointer background colour.	874	Mouse pointer background colour.
617		875
618	=item B<pointerBlankDelay:> I<number>	876	=item B<pointerBlankDelay:> I<number>
619		877
620	Specifies number of seconds before blanking the pointer [default 2].	878	Specifies number of seconds before blanking the pointer [default 2]. Use a
		879	large number (e.g. C<987654321>) to effectively disable the timeout.
621		880
622	=item B<backspacekey:> I<string>	881	=item B<backspacekey:> I<string>
623		882
624	The string to send when the backspace key is pressed. If set to B<DEC>	883	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>	884	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
…		…
647		906
648	I<name> of inputMethod to use; option B<-im>.	907	I<name> of inputMethod to use; option B<-im>.
649		908
650	=item B<imLocale:> I<name>	909	=item B<imLocale:> I<name>
651		910
652	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	911	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	912	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	913	input extension to be able to input japanese characters while staying in
655	another locale. option B<-imlocale>.	914	another locale; option B<-imlocale>.
656		915
657	=item B<insecure>	916	=item B<imFont:> I<fontset>
		917
		918	Specify the font-set used for XIM styles C<OverTheSpot> or
		919	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
		920	by commas), i.e. it's not in the same format as the other font lists used
		921	in @@RXVT_NAME@@. The default will be set-up to chose any suitable found
		922	found, preferably one or two pixels differing in size to the base font.
		923	option B<-imfont>.
		924
		925	=item B<tripleclickwords:> I<boolean>
		926
		927	Change the meaning of triple-click selection with the left mouse
		928	button. Instead of selecting a full line it will extend the selection to
		929	the end of the logical line only; option B<-tcw>.
		930
		931	=item B<insecure:> I<boolean>
658		932
659	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	933	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
660	echo arbitrary strings like the icon name or the locale. This could be	934	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	935	abused if somebody gets 8-bit-clean access to your display, whether
662	throuh a mail client displaying mail bodies unfiltered or though	936	through a mail client displaying mail bodies unfiltered or through
663	write(1). Therefore, these sequences are disabled by default. (Note	937	write(1) or any other means. Therefore, these sequences are disabled by
664	that other terminals, including xterm, have these sequences	938	default. (Note that many other terminals, including xterm, have these
665	enabled by default). You can enable them by setting this boolean	939	sequences enabled by default, which doesn't make it safer, though).
666	resource or specifying B<-insecure> as an option. At the moment, this	940
667	enabled display-answer, locale, findfont, icon label and window title	941	You can enable them by setting this boolean resource or specifying
668	requests as well as dynamic menubar dispatch.	942	B<-insecure> as an option. At the moment, this enables display-answer,
		943	locale, findfont, icon label and window title requests.
669		944
670	=item B<modifier:> I<modifier>	945	=item B<modifier:> I<modifier>
671		946
672	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	947	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	948	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
674	B<-mod>.	949	B<-mod>.
675		950
676	=item B<answerbackString:> I<string>	951	=item B<answerbackString:> I<string>
677		952
678	Specify the reply rxvt sends to the shell when an ENQ (control-E)	953	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	954	character is passed through. It may contain escape values as described
680	in the entry on B<keysym> following.	955	in the entry on B<keysym> following.
681		956
682	=item B<secondaryScreen:> I<bool>	957	=item B<secondaryScreen:> I<bool>
683		958
…		…
688	Turn on/off secondary screen scroll (default enabled). If the this	963	Turn on/off secondary screen scroll (default enabled). If the this
689	option is enabled, scrolls on the secondary screen will change the	964	option is enabled, scrolls on the secondary screen will change the
690	scrollback buffer and switching to/from the secondary screen will	965	scrollback buffer and switching to/from the secondary screen will
691	instead scroll the screen up.	966	instead scroll the screen up.
692		967
		968	=item B<hold>: I<bool>
		969
		970	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		971	will not immediately destroy its window when the program executed within
		972	it exits. Instead, it will wait till it is being killed or closed by the
		973	user.
		974
693	=item B<keysym.>I<sym>: I<string>	975	=item B<keysym.>I<sym>: I<string>
694		976
695	Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may	977	Compile I<frills>: Associate I<string> with keysym I<sym>. The
696	contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:	978	intervening resource name B<keysym.> cannot be omitted.
697	newline, \r: return, \t:	979
		980	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
		981	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
		982	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
		983	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
		984	B<2>, B<3>, B<4>, B<5>.
		985
		986	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
		987	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
		988	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
		989	current application keymap mode state.
		990
		991	The spellings of I<key> can be obtained by using B<xev>(1) command or
		992	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
		993	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
		994	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
		995	performed in an exact manner; however, the closest match is assured.
		996
		997	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
		998	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,	999	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	1000	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	1001	can start or end with whitespace.
701	omitted. This resource is only available when compiled with	1002
702	KEYSYM_RESOURCE.	1003	Please note that you need to double the C<\> in resource files, as
		1004	Xlib itself does it's own de-escaping (you can use C<\033> instead of
		1005	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
		1006	processing).
		1007
		1008	You can define a range of keysyms in one shot by providing a I<string>
		1009	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
		1010	should be a character not used by the strings.
		1011
		1012	Its usage can be demonstrated by an example:
		1013
		1014	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
		1015
		1016	The above line is equivalent to the following three lines:
		1017
		1018	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
		1019	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
		1020	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
		1021
		1022	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
		1023	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
		1024	example the following means "change the current locale to C<zh_CN.GBK>
		1025	when Control-Meta-c is being pressed":
		1026
		1027	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		1028
		1029	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1030	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1031	manpage. For example, the F<selection> extension (activated via
		1032	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1033
		1034	URxvt.keysym.M-C-c: perl:selection:rot13
		1035
		1036	Due the the large number of modifier combinations, a defined key mapping
		1037	will match if at I<at least> the specified identifiers are being set, and
		1038	no other key mappings with those and more bits are being defined. That
		1039	means that defining a key map for C<a> will automatically provide
		1040	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		1041	mappings themselves.
		1042
		1043	Unfortunately, this will override built-in key mappings. For example
		1044	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		1045	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		1046	user-defined keymap using the C<builtin:> replacement:
		1047
		1048	URxvt.keysym.Insert: <my insert key sequence>
		1049	URxvt.keysym.S-Insert: builtin:
		1050
		1051	The first line defines a mapping for C<Insert> and I<any> combination
		1052	of modifiers. The second line re-establishes the default mapping for
		1053	C<Shift-Insert>.
		1054
		1055	The following example will map Control-Meta-1 and Control-Meta-2 to
		1056	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
		1057	font-switching at runtime:
		1058
		1059	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1060	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
		1061
		1062	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
		1063	info):
		1064
		1065	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1066	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1067
		1068	=item B<perl-ext-common>: I<string>
		1069
		1070	=item B<perl-ext>: I<string>
		1071
		1072	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1073	use in this terminal instance; option B<-pe>.
		1074
		1075	Extension names can be prefixed with a C<-> sign to prohibit using
		1076	them. This can be useful to selectively disable some extensions loaded
		1077	by default, or specified via the C<perl-ext-common> resource. For
		1078	example, C<default,-selection> will use all the default extension except
		1079	C<selection>.
		1080
		1081	Extension names can also be followed by an argument in angle brackets
		1082	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1083	searchable scorllback to Alt/Meta-s). Mentioning the same extension
		1084	multiple times with different arguments will pass multiple arguments to
		1085	the extension.
		1086
		1087	Each extension is looked up in the library directories, loaded if
		1088	necessary, and bound to the current terminal instance.
		1089
		1090	If both of these resources are the empty string, then the perl
		1091	interpreter will not be initialized. The idea behind two options is that
		1092	B<perl-ext-common> will be used for extensions that should be available to
		1093	all instances, while B<perl-ext> is used for specific instances.
		1094
		1095	=item B<perl-eval>: I<string>
		1096
		1097	Perl code to be evaluated when all extensions have been registered. See
		1098	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
		1099	will be ignored when running setuid/setgid.
		1100
		1101	=item B<perl-lib>: I<path>
		1102
		1103	Colon-separated list of additional directories that hold extension
		1104	scripts. When looking for extensions specified by the C<perl> resource,
		1105	@@RXVT_NAME@@ will first look in these directories and then in
		1106	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
		1107	will be ignored when running setuid/setgid.
		1108
		1109	See the @@RXVT_NAME@@perl(3) manpage.
		1110
		1111	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1112
		1113	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1114	details.
		1115
		1116	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1117
		1118	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1119	for details.
		1120
		1121	=item B<searchable-scrollback:> I<keysym>
		1122
		1123	Sets the hotkey that starts the incremental scrollback buffer search
		1124	(default: C<M-s>).
		1125
		1126	=item B<urlLauncher>: I<string>
		1127
		1128	Specifies the program to be started with a URL argument. Used by the
		1129	C<selection-popup> and C<mark-urls> perl extensions.
		1130
		1131	=item B<transient-for>: I<windowid>
		1132
		1133	Sets the WM_TRANSIENT_FOR property to the given window iw.
703		1134
704	=back	1135	=back
705		1136
706	=head1 THE SCROLLBAR	1137	=head1 THE SCROLLBAR
707		1138
708	Lines of text that scroll off the top of the B<@@RXVTNAME@@> window	1139	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	1140	(resource: B<saveLines>) and can be scrolled back using the scrollbar
710	or by keystrokes. The normal B<@@RXVTNAME@@> scrollbar has arrows and	1141	or by keystrokes. The normal B<@@RXVT_NAME@@> scrollbar has arrows and
711	its behaviour is fairly intuitive. The B<xterm-scrollbar> is without	1142	its behaviour is fairly intuitive. The B<xterm-scrollbar> is without
712	arrows and its behaviour mimics that of I<xterm>	1143	arrows and its behaviour mimics that of I<xterm>
713		1144
714	Scroll down with B<Button1> (B<xterm-scrollbar>) or B<Shift-Next>.	1145	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>.	1146	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	1152	the normal text selection/insertion, hold either the Shift or the Meta
722	(Alt) key while performing the desired mouse action.	1153	(Alt) key while performing the desired mouse action.
723		1154
724	If mouse reporting mode is active, the normal scrollbar actions are	1155	If mouse reporting mode is active, the normal scrollbar actions are
725	disabled -- on the assumption that we are using a fullscreen	1156	disabled -- on the assumption that we are using a fullscreen
726	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	1157	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
727	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	1158	(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),	1159	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
729	respectively.	1160	respectively.
730		1161
731	=head1 TEXT SELECTION AND INSERTION	1162	=head1 TEXT SELECTION AND INSERTION
732		1163
733	The behaviour of text selection and insertion mechanism is similar to	1164	The behaviour of text selection and insertion mechanism is similar to
…		…
735		1166
736	=over 4	1167	=over 4
737		1168
738	=item B<Selection>:	1169	=item B<Selection>:
739		1170
740	Left click at the beginning of the region, drag to the end of the	1171	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	1172	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	1173	to select a word; Left triple-click to select the entire logical line
743	line.	1174	(which can span multiple screen lines), unless modified by resource
		1175	B<tripleclickwords>.
		1176
		1177	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
		1178	(Compile: I<frills>) will create a rectangular selection instead of a
		1179	normal one. In this mode, every selected row becomes its own line in the
		1180	selection, and trailing whitespace is visually underlined and removed from
		1181	the selection.
744		1182
745	=item B<Insertion>:	1183	=item B<Insertion>:
746		1184
747	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1185	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
748	an B<@@RXVTNAME@@> window causes the current text selection to be	1186	an B<@@RXVT_NAME@@> window causes the current text selection to be
749	inserted as if it had been typed on the keyboard.	1187	inserted as if it had been typed on the keyboard.
750		1188
751	=back	1189	=back
752		1190
753	=head1 CHANGING FONTS	1191	=head1 CHANGING FONTS
754		1192
755	You can change fonts on-the-fly, which is to say cycle through the	1193	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	1194	supported in rxvt-unicode. Bug me if you need this.
757	B<Shift-KP_Subtract>. Or, alternatively (if enabled) with	1195
758	B<@@HOTKEY@@-@@BIGFONT@@> and B<@@HOTKEY@@-@@SMALLFONT@@>, where the	1196	You can, however, switch fonts at runtime using escape sequences, e.g.:
759	actual key can be selected using resources	1197
760	B<smallfont_key>/B<bigfont_key>.	1198	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1199
		1200	You can use keyboard shortcuts, too:
		1201
		1202	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1203	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
		1204
		1205	rxvt-unicode will automatically re-apply these fonts to the output so far.
		1206
		1207	=head1 ISO 14755 SUPPORT
		1208
		1209	ISO 14755 is a standard for entering and viewing unicode characters
		1210	and character codes using the keyboard. It consists of 4 parts. The
		1211	first part is available rxvt-unicode has been compiled with
		1212	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
		1213	with C<--enable-iso14755>.
		1214
		1215	=over 4
		1216
		1217	=item * 5.1: Basic method
		1218
		1219	This allows you to enter unicode characters using their hexcode.
		1220
		1221	Start by pressing and holding both C<Control> and C<Shift>, then enter
		1222	hex-digits (between one and six). Releasing C<Control> and C<Shift> will
		1223	commit the character as if it were typed directly. While holding down
		1224	C<Control> and C<Shift> you can also enter multiple characters by pressing
		1225	C<Space>, which will commit the current character and lets you start a new
		1226	one.
		1227
		1228	As an example of use, imagine a business card with a japanese e-mail
		1229	address, which you cannot type. Fortunately, the card has the e-mail
		1230	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
		1231	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
		1232	followed by releasing the modifier keys.
		1233
		1234	=item * 5.2: Keyboard symbols entry method
		1235
		1236	This mode lets you input characters representing the keycap symbols of
		1237	your keyboard, if representable in the current locale encoding.
		1238
		1239	Start by pressing C<Control> and C<Shift> together, then releasing
		1240	them. The next special key (cursor keys, home etc.) you enter will not
		1241	invoke it's usual function but instead will insert the corresponding
		1242	keycap symbol. The symbol will only be entered when the key has been
		1243	released, otherwise pressing e.g. C<Shift> would enter the symbol for
		1244	C<ISO Level 2 Switch>, although your intention might have been to enter a
		1245	reverse tab (Shift-Tab).
		1246
		1247	=item * 5.3: Screen-selection entry method
		1248
		1249	While this is implemented already (it's basically the selection
		1250	mechanism), it could be extended by displaying a unicode character map.
		1251
		1252	=item * 5.4: Feedback method for identifying displayed characters for later input
		1253
		1254	This method lets you display the unicode character code associated with
		1255	characters already displayed.
		1256
		1257	You enter this mode by holding down C<Control> and C<Shift> together, then
		1258	pressing and holding the left mouse button and moving around. The unicode
		1259	hex code(s) (it might be a combining character) of the character under the
		1260	pointer is displayed until you release C<Control> and C<Shift>.
		1261
		1262	In addition to the hex codes it will display the font used to draw this
		1263	character - due to implementation reasons, characters combined with
		1264	combining characters, line drawing characters and unknown characters will
		1265	always be drawn using the built-in support font.
		1266
		1267	=back
		1268
		1269	With respect to conformance, rxvt-unicode is supposed to be compliant to
		1270	both scenario A and B of ISO 14755, including part 5.2.
761		1271
762	=head1 LOGIN STAMP	1272	=head1 LOGIN STAMP
763		1273
764	B<@@RXVTNAME@@> tries to write an entry into the I<utmp>(5) file so	1274	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.	1275	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	1276	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
767	some systems.	1277	on some systems or setgid to root or to some other group on others.
768		1278
769	=head1 COLORS AND GRAPHICS	1279	=head1 COLORS AND GRAPHICS
770		1280
771	In addition to the default foreground and background colours,	1281	In addition to the default foreground and background colours,
772	B<@@RXVTNAME@@> can display up to 16 colours (8 ANSI colours plus	1282	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	1283	high-intensity bold/blink versions of the same). Here is a list of the
774	colours with their B<rgb.txt> names.	1284	colours with their B<rgb.txt> names.
775		1285
776	=begin table	1286	=begin table
777		1287
…		…
806	I<xterm>(1) where the colours are only swapped if they have not otherwise	1316	I<xterm>(1) where the colours are only swapped if they have not otherwise
807	been specified. For example,	1317	been specified. For example,
808		1318
809	=over 4	1319	=over 4
810		1320
811	=item B<rxvt -fg Black -bg White -rv>	1321	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
812		1322
813	would yield White on Black, while on I<xterm>(1) it would yield Black	1323	would yield White on Black, while on I<xterm>(1) it would yield Black
814	on White.	1324	on White.
815		1325
816	=back	1326	=back
817		1327
818	=head1 ENVIRONMENT	1328	=head1 ENVIRONMENT
819		1329
820	B<@@RXVTNAME@@> sets the environment variables B<TERM>, B<COLORTERM>	1330	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	1331
822	window id number of the B<@@RXVTNAME@@> window and it also uses and	1332	=over 4
823	sets the environment variable B<DISPLAY> to specify which display	1333
824	terminal to use. B<@@RXVTNAME@@> uses the environment variables	1334	=item B<TERM>
825	B<RXVTPATH> and B<PATH> to find XPM files.	1335
		1336	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
		1337	resources or on the commandline.
		1338
		1339	=item B<COLORTERM>
		1340
		1341	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
		1342	compiled with XPM support, and optionally with the added extension
		1343	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
		1344
		1345	=item B<COLORFGBG>
		1346
		1347	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
		1348	the colour code used as default foreground/text colour (or the string
		1349	C<default> to indicate that the default-colour escape sequence is to be
		1350	used), C<bg> is the colour code used as default background colour (or the
		1351	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1352	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
		1353	(and do) use this information to optimize screen output.
		1354
		1355	=item B<WINDOWID>
		1356
		1357	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
		1358	window, which usually has subwindows for the scrollbar, the terminal
		1359	window and so on).
		1360
		1361	=item B<TERMINFO>
		1362
		1363	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1364	C<--with-terminfo=PATH>.
		1365
		1366	=item B<DISPLAY>
		1367
		1368	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
		1369	display in it's child processes.
		1370
		1371	=item B<SHELL>
		1372
		1373	The shell to be used for command execution, defaults to C</bin/sh>.
		1374
		1375	=item B<RXVT_SOCKET>
		1376
		1377	The unix domain socket path used by @@RXVT_NAME@@c(1) and
		1378	@@RXVT_NAME@@d(1).
		1379
		1380	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
		1381
		1382	=item B<HOME>
		1383
		1384	Used to locate the default directory for the unix domain socket for
		1385	daemon communications and to locate various resource files (such as
		1386	C<.Xdefaults>)
		1387
		1388	=item B<XAPPLRESDIR>
		1389
		1390	Directory where various X resource files are being located.
		1391
		1392	=item B<XENVIRONMENT>
		1393
		1394	If set and accessible, gives the name of a X resource file to be loaded by
		1395	@@RXVT_NAME@@.
		1396
		1397	=back
826		1398
827	=head1 FILES	1399	=head1 FILES
828		1400
829	=over 4	1401	=over 4
830		1402
831	=item B</etc/utmp>
832
833	System file for login records.
834
835	=item B</usr/lib/X11/rgb.txt>	1403	=item B</usr/lib/X11/rgb.txt>
836		1404
837	Color names.	1405	Color names.
838		1406
839	=back	1407	=back
840		1408
841	=head1 SEEALSO	1409	=head1 SEE ALSO
842		1410
843	I<xterm>(1), I<sh>(1), I<resize>(1), I<X>(1), I<pty>(4), I<tty>(4), I<utmp>(5)	1411	@@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		1412
859	=head1 CURRENT PROJECT COORDINATOR	1413	=head1 CURRENT PROJECT COORDINATOR
860		1414
861	=over 4	1415	=over 4
862		1416
863	=item Project Coordinator	1417	=item Project Coordinator
864		1418
865	@@RXVTMAINT@@ L<@@RXVTMAINTEMAIL@@>	1419	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
866		1420
867	=item Web page maintainter	1421	L<http://software.schmorp.de/#rxvt-unicode>
868
869	@@RXVTWEBMAINT@@ L<@@RXVTWEBMAINTEMAIL@@>
870
871	L<@@RXVTWEBPAGE@@>(@@RXVTWEBPAGE@@)
872		1422
873	=back	1423	=back
874		1424
875	=head1 AUTHORS	1425	=head1 AUTHORS
876		1426
…		…
901	=item Geoff Wing L<< <gcw@pobox.com> >>	1451	=item Geoff Wing L<< <gcw@pobox.com> >>
902		1452
903	Rewrote screen display and text selection routines. Project Coordinator	1453	Rewrote screen display and text selection routines. Project Coordinator
904	(changes.txt 2.4.6 - rxvt-unicode)	1454	(changes.txt 2.4.6 - rxvt-unicode)
905		1455
906	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>	1456	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
907		1457
908	Forked rxvt-unicode, rewrote most of the display code and internal	1458	Forked rxvt-unicode, rewrote most of the display code and internal
909	character handling to store text in unicode, improve xterm	1459	character handling to store text in unicode, improve xterm
910	compatibility and apply numerous other bugfixes and extensions.	1460	compatibility and apply numerous other bugfixes and extensions.
911		1461

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.98 by root, Mon Jan 16 15:12:48 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.98 by root, Mon Jan 16 15:12:48 2006 UTC