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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.2 by root, Thu Aug 12 21:30:14 2004 UTC vs.
Revision 1.94 by root, Thu Jan 12 05:37:34 2006 UTC

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.2 by root, Thu Aug 12 21:30:14 2004 UTC vs. Revision 1.94 by root, Thu Jan 12 05:37:34 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.2 by root, Thu Aug 12 21:30:14 2004 UTC vs.
Revision 1.94 by root, Thu Jan 12 05:37:34 2006 UTC