[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.85 by root, Wed Jan 4 20:43:37 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<fileno>
		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	Here is a example in perl that illustrates how this option can be used (a
		452	longer example is in F<doc/pty-fd>):
		453
		454	use IO::Pty;
		455	use Fcntl;
		456
		457	my $pty = new IO::Pty;
		458	fcntl $pty, F_SETFD, 0; # clear close-on-exec
		459	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		460	close $pty;
		461
		462	# now communicate with rxvt
		463	my $slave = $pty->slave;
		464	while (<$slave>) { print $slave "got <$_>\n" }
		465
289	=item B<-xrm> I<resourcestring>	466	=item B<-pe> I<string>
290		467
291	No effect on rxvt. Simply passes through an argument to be made	468	Colon-separated list of perl extension scripts to use in this terminal
292	available in the instance's argument list. Appears in I<WM_COMMAND> in	469	instance. See resource B<perl-ext>.
293	some window managers.
294		470
295	=back	471	=back
296		472
297	=head1 RESOURCES (available also as long-options)	473	=head1 RESOURCES (available also as long-options)
298		474
…		…
301		477
302	There are two different methods that @@RXVT_NAME@@ can use to get the	478	There are two different methods that @@RXVT_NAME@@ can use to get the
303	Xresource data: using the X libraries (Xrm*-functions) or internal	479	Xresource data: using the X libraries (Xrm*-functions) or internal
304	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	480	Xresources reader (B<~/.Xdefaults>). For the first method (ie.
305	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	481	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the
306	resources using X11 tools like B<xset>. Many distribution do also load	482	resources using X11 tools like B<xrdb>. Many distribution do also load
307	settings from the B<~/.Xresources> file when X starts.	483	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
		484	will consult the following files/resources in order, with later settings
		485	overwriting earlier ones:
		486
		487	1. system-wide app-defaults file, either locale-dependent OR global
		488	2. app-defaults file in $XAPPLRESDIR
		489	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
		490	4. SCREEN_RESOURCES for the current screen
		491	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
308		492
309	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>	493	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
310	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults	494	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
311	set in XAPPLOADDIR/URxvt (compile-time defined: usually	495	set in XAPPLOADDIR/URxvt (compile-time defined: usually
312	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	496	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
…		…
345	high-intensity (bold = bright foreground, blink = bright background)	529	high-intensity (bold = bright foreground, blink = bright background)
346	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	530	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	531	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.	532	names used are listed in the B<COLORS AND GRAPHICS> section.
349		533
		534	Colours higher than 15 cannot be set using resources (yet), but can be
		535	changed using an escape command (see @@RXVT_NAME@@(7)).
		536
		537	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
		538	88 colour support). Colours 80-87 are evenly spaces grey steps.
		539
350	=item B<colorBD:> I<colour>	540	=item B<colorBD:> I<colour>
351		541
		542	=item B<colorIT:> I<colour>
		543
352	Use the specified colour to display bold characters when the foreground	544	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	545	foreground colour is the default. If font styles are not available
354	enabled.	546	(Compile I<styles>) and this option is unset, reverse video is used instead.
355		547
356	=item B<colorUL:> I<colour>	548	=item B<colorUL:> I<colour>
357		549
358	Use the specified colour to display underlined characters when the	550	Use the specified colour to display underlined characters when the
359	foreground colour is the default.	551	foreground colour is the default.
360		552
361	=item B<colorRV:> I<colour>	553	=item B<colorRV:> I<colour>
362		554
363	Use the specified colour as the background for reverse video	555	Use the specified colour as the background for reverse video
364	characters.	556	characters.
		557
		558	=item B<underlineColor:> I<colour>
		559
		560	If set, use the specified colour as the colour for the underline
		561	itself. If unset, use the foreground colour.
365		562
366	=item B<cursorColor:> I<colour>	563	=item B<cursorColor:> I<colour>
367		564
368	Use the specified colour for the cursor. The default is to use the	565	Use the specified colour for the cursor. The default is to use the
369	foreground colour; option B<-cr>.	566	foreground colour; option B<-cr>.
…		…
392	artificial transparency. B<False>: do not inherit the parent windows'	589	artificial transparency. B<False>: do not inherit the parent windows'
393	pixmap.	590	pixmap.
394		591
395	=item B<fading:> I<number>	592	=item B<fading:> I<number>
396		593
397	Fade the text by the given percentage when focus is lost.	594	Fade the text by the given percentage when focus is lost; option B<-fade>.
		595
		596	=item B<fadeColor:> I<colour>
		597
		598	Fade to this colour, when fading is used (see B<fading:>). The default
		599	colour is black; option B<-fadecolor>.
398		600
399	=item B<tintColor:> I<colour>	601	=item B<tintColor:> I<colour>
400		602
401	Tint the transparent background pixmap with the given colour.	603	Tint the transparent background pixmap with the given colour; option
		604	B<-tint>.
402		605
403	=item B<shading:> I<number>	606	=item B<shading:> I<number>
404		607
405	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	608	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
406	image in addition to tinting it.	609	image in addition to tinting it.
407		610
408	=item B<fading:> I<number>
409
410	Scale the tint colour by the given percentage.
411
412	=item B<scrollColor:> I<colour>	611	=item B<scrollColor:> I<colour>
413		612
414	Use the specified colour for the scrollbar [default #B2B2B2].	613	Use the specified colour for the scrollbar [default #B2B2B2].
415		614
416	=item B<troughColor:> I<colour>	615	=item B<troughColor:> I<colour>
417		616
418	Use the specified colour for the scrollbar's trough area [default	617	Use the specified colour for the scrollbar's trough area [default
419	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	618	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
		619
		620	=item B<borderColor:> I<colour>
		621
		622	The colour of the border around the text area and between the scrollbar
		623	and the text.
420		624
421	=item B<backgroundPixmap:> I<file[;geom]>	625	=item B<backgroundPixmap:> I<file[;geom]>
422		626
423	Use the specified XPM file (note the `.xpm' extension is optional) for	627	Use the specified XPM file (note the `.xpm' extension is optional) for
424	the background and also optionally specify its scaling with a geometry	628	the background and also optionally specify its scaling with a geometry
…		…
440		644
441	Specify the colon-delimited search path for finding files (XPM and	645	Specify the colon-delimited search path for finding files (XPM and
442	menus), in addition to the paths specified by the B<RXVTPATH> and	646	menus), in addition to the paths specified by the B<RXVTPATH> and
443	B<PATH> environment variables.	647	B<PATH> environment variables.
444		648
445	=item B<font:> I<fontname>	649	=item B<font:> I<fontlist>
446		650
447	Select the fonts to be used. This is a comma seperated list of font	651	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.	652	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	653	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	654	be smaller, but not larger. A reasonable default font list is always
451	appended to it. option B<-fn>.	655	appended to it; option B<-fn>.
452		656
453	=item B<realBold:> I<boolean>	657	Each font can either be a standard X11 core font (XLFD) name, with
		658	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
454		659
455	B<True>: Enable "real bold" support. When this option is on, bold text	660	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.	661	specifications enclosed in square brackets (C<[]>). The only available
457	Bold fonts should thus be specified in the font list after their	662	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	663	fonts.
459	font will be used. option B<-rb>. B<False>: Display bold text in a	664
460	regular font, using the color specified with B<colorBD>; option B<+rb>.	665	For example, this font resource
		666
		667	URxvt*font: 9x15bold,\
		668	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
		669	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
		670	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
		671	xft:Code2000:antialias=false
		672
		673	specifies five fonts to be used. The first one is C<9x15bold> (actually
		674	the iso8859-1 version of the second font), which is the base font (because
		675	it is named first) and thus defines the character cell grid to be 9 pixels
		676	wide and 15 pixels high.
		677
		678	The second font is just used to add additional unicode characters not in
		679	the base font, likewise the third, which is unfortunately non-bold, but
		680	the bold version of the font does contain less characters, so this is a
		681	useful supplement.
		682
		683	The third font is an Xft font with aliasing turned off, and the characters
		684	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
		685	contains other characters, but we are not interested in them.
		686
		687	The last font is a useful catch-all font that supplies most of the
		688	remaining unicode characters.
		689
		690	=item B<boldFont:> I<fontlist>
		691
		692	=item B<italicFont:> I<fontlist>
		693
		694	=item B<boldItalicFont:> I<fontlist>
		695
		696	The font list to use for displaying B<bold>, I<italic> or B<< I<bold
		697	italic> >> characters, respectively.
		698
		699	If specified and non-empty, then the syntax is the same as for the
		700	B<font>-resource, and the given font list will be used as is, which makes
		701	it possible to substitute completely different font styles for bold and
		702	italic.
		703
		704	If unset (the default), a suitable font list will be synthesized by
		705	"morphing" the normal text font list into the desired shape. If that is
		706	not possible, replacement fonts of the desired shape will be tried.
		707
		708	If set, but empty, then this specific style is disabled and the normal
		709	text font will being used for the given style.
		710
		711	=item B<intensityStyles:> I<boolean>
		712
		713	When font styles are not enabled, or this option is enabled (B<True>,
		714	option B<-is>, the default), bold and italic font styles imply high
		715	intensity foreground/backround colours. Disabling this option (B<False>,
		716	option B<+is>) disables this behaviour, the high intensity colours are not
		717	reachable.
461		718
462	=item B<selectstyle:> I<mode>	719	=item B<selectstyle:> I<mode>
463		720
464	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	721	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	722	xterm style with 2.20 old word selection, or anything else which gives
466	xterm style selection.	723	xterm style selection.
467		724
468	=item B<scrollstyle:> I<mode>	725	=item B<scrollstyle:> I<mode>
469		726
470	Set scrollbar style to B<@@RXVT_NAME@@>, B<rxvt>, B<plain>, B<next> or	727	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
471	B<xterm>	728	the author's favourite.
472		729
473	=item B<title:> I<string>	730	=item B<title:> I<string>
474		731
475	Set window title string, the default title is the command-line	732	Set window title string, the default title is the command-line
476	specified after the B<-e> option, if any, otherwise the application	733	specified after the B<-e> option, if any, otherwise the application
…		…
508		765
509	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	766	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	767	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.	768	B<Shift-Print> to include the scrollback as well.
512		769
		770	The string will be interpreted as if typed into the shell as-is.
		771
		772	Example:
		773
		774	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		775
		776	This creates a new file in your home directory with the screen contents
		777	everytime you hit C<Print>.
		778
513	=item B<scrollBar:> I<boolean>	779	=item B<scrollBar:> I<boolean>
514		780
515	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	781	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
516	disable the scrollbar; option B<+sb>.	782	disable the scrollbar; option B<+sb>.
517		783
…		…
530	Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar	796	Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar
531	thumb with the pointer on middle button press/drag.	797	thumb with the pointer on middle button press/drag.
532		798
533	=item B<scrollTtyOutput:> I<boolean>	799	=item B<scrollTtyOutput:> I<boolean>
534		800
535	B<True>: scroll to bottom when tty receives output; option B<+si>.	801	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	802	B<False>: do not scroll to bottom when tty receives output; option
537	B<-si>.	803	B<+si>.
538		804
539	=item B<scrollWithBuffer:> I<boolean>	805	=item B<scrollWithBuffer:> I<boolean>
540		806
541	B<True>: scroll with scrollback buffer when tty recieves new lines (and	807	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	808	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
543	with scrollback buffer when tty recieves new lines; option B<-sw>.	809	with scrollback buffer when tty recieves new lines; option B<+sw>.
544		810
545	=item B<scrollTtyKeypress:> I<boolean>	811	=item B<scrollTtyKeypress:> I<boolean>
546		812
547	B<True>: scroll to bottom when a non-special key is pressed. Special	813	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	814	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	815	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>.	816	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		817
562	=item B<saveLines:> I<number>	818	=item B<saveLines:> I<number>
563		819
564	Save I<number> lines in the scrollback buffer [default 64]. This	820	Save I<number> lines in the scrollback buffer [default 64]. This
565	resource is limited on most machines to 65535; option B<-sl>.	821	resource is limited on most machines to 65535; option B<-sl>.
…		…
575	option B<-w>, B<-bw>, B<-borderwidth>.	831	option B<-w>, B<-bw>, B<-borderwidth>.
576		832
577	=item B<borderLess:> I<boolean>	833	=item B<borderLess:> I<boolean>
578		834
579	Set MWM hints to request a borderless window, i.e. if honoured by the	835	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>.	836	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
		837
		838	=item B<skipBuiltinGlyphs:> I<boolean>
		839
		840	Compile I<frills>: Disable the usage of the built-in block graphics/line
		841	drawing characters and just rely on what the specified fonts provide. Use
		842	this if you have a good font and want to use its block graphic glyphs;
		843	option B<-sbg>.
581		844
582	=item B<termName:> I<termname>	845	=item B<termName:> I<termname>
583		846
584	Specifies the terminal type name to be set in the B<TERM> environment	847	Specifies the terminal type name to be set in the B<TERM> environment
585	variable; option B<-tn>.	848	variable; option B<-tn>.
…		…
596		859
597	=item B<mouseWheelScrollPage:> I<boolean>	860	=item B<mouseWheelScrollPage:> I<boolean>
598		861
599	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel	862	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
600	scrolls five lines [default].	863	scrolls five lines [default].
		864
		865	=item B<pastableTabs:> I<boolean>
		866
		867	B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
		868	movement only; option C<-ptab>.
601		869
602	=item B<cursorBlink:> I<boolean>	870	=item B<cursorBlink:> I<boolean>
603		871
604	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	872	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
605	option B<-bc>.	873	option B<-bc>.
…		…
618		886
619	Mouse pointer background colour.	887	Mouse pointer background colour.
620		888
621	=item B<pointerBlankDelay:> I<number>	889	=item B<pointerBlankDelay:> I<number>
622		890
623	Specifies number of seconds before blanking the pointer [default 2].	891	Specifies number of seconds before blanking the pointer [default 2]. Use a
		892	large number (e.g. C<987654321>) to effectively disable the timeout.
624		893
625	=item B<backspacekey:> I<string>	894	=item B<backspacekey:> I<string>
626		895
627	The string to send when the backspace key is pressed. If set to B<DEC>	896	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>	897	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
…		…
650		919
651	I<name> of inputMethod to use; option B<-im>.	920	I<name> of inputMethod to use; option B<-im>.
652		921
653	=item B<imLocale:> I<name>	922	=item B<imLocale:> I<name>
654		923
655	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	924	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	925	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	926	input extension to be able to input japanese characters while staying in
658	another locale. option B<-imlocale>.	927	another locale; option B<-imlocale>.
659		928
660	=item B<insecure>	929	=item B<imFont:> I<fontset>
		930
		931	Specify the font-set used for XIM styles C<OverTheSpot> or
		932	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
		933	by commas), i.e. it's not in the same format as the other font lists used
		934	in @@RXVT_NAME@@. The default will be set-up to chose any suitable found
		935	found, preferably one or two pixels differing in size to the base font.
		936	option B<-imfont>.
		937
		938	=item B<tripleclickwords:> I<boolean>
		939
		940	Change the meaning of triple-click selection with the left mouse
		941	button. Instead of selecting a full line it will extend the selection to
		942	the end of the logical line only; option B<-tcw>.
		943
		944	=item B<insecure:> I<boolean>
661		945
662	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	946	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
663	echo arbitrary strings like the icon name or the locale. This could be	947	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	948	abused if somebody gets 8-bit-clean access to your display, whether
665	throuh a mail client displaying mail bodies unfiltered or though	949	through a mail client displaying mail bodies unfiltered or through
666	write(1). Therefore, these sequences are disabled by default. (Note	950	write(1) or any other means. Therefore, these sequences are disabled by
667	that other terminals, including xterm, have these sequences	951	default. (Note that many other terminals, including xterm, have these
668	enabled by default). You can enable them by setting this boolean	952	sequences enabled by default, which doesn't make it safer, though).
669	resource or specifying B<-insecure> as an option. At the moment, this	953
670	enabled display-answer, locale, findfont, icon label and window title	954	You can enable them by setting this boolean resource or specifying
671	requests as well as dynamic menubar dispatch.	955	B<-insecure> as an option. At the moment, this enables display-answer,
		956	locale, findfont, icon label and window title requests as well as dynamic
		957	menubar dispatch.
672		958
673	=item B<modifier:> I<modifier>	959	=item B<modifier:> I<modifier>
674		960
675	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	961	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	962	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
677	B<-mod>.	963	B<-mod>.
678		964
679	=item B<answerbackString:> I<string>	965	=item B<answerbackString:> I<string>
680		966
681	Specify the reply rxvt sends to the shell when an ENQ (control-E)	967	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	968	character is passed through. It may contain escape values as described
683	in the entry on B<keysym> following.	969	in the entry on B<keysym> following.
684		970
685	=item B<secondaryScreen:> I<bool>	971	=item B<secondaryScreen:> I<bool>
686		972
…		…
691	Turn on/off secondary screen scroll (default enabled). If the this	977	Turn on/off secondary screen scroll (default enabled). If the this
692	option is enabled, scrolls on the secondary screen will change the	978	option is enabled, scrolls on the secondary screen will change the
693	scrollback buffer and switching to/from the secondary screen will	979	scrollback buffer and switching to/from the secondary screen will
694	instead scroll the screen up.	980	instead scroll the screen up.
695		981
		982	=item B<hold>: I<bool>
		983
		984	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		985	will not immediately destroy its window when the program executed within
		986	it exits. Instead, it will wait till it is being killed or closed by the
		987	user.
		988
696	=item B<keysym.>I<sym>: I<string>	989	=item B<keysym.>I<sym>: I<string>
697		990
698	Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may	991	Compile I<frills>: Associate I<string> with keysym I<sym>. The
699	contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:	992	intervening resource name B<keysym.> cannot be omitted.
700	newline, \r: return, \t:	993
		994	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
		995	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
		996	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
		997	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
		998	B<2>, B<3>, B<4>, B<5>.
		999
		1000	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
		1001	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
		1002	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
		1003	current application keymap mode state.
		1004
		1005	The spellings of I<key> can be obtained by using B<xev>(1) command or
		1006	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
		1007	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
		1008	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
		1009	performed in an exact manner; however, the closest match is assured.
		1010
		1011	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
		1012	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,	1013	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	1014	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	1015	can start or end with whitespace.
704	omitted. This resource is only available when compiled with	1016
705	KEYSYM_RESOURCE.	1017	Please note that you need to double the C<\> when using
		1018	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
		1019	use C<\033> instead of C<\e> (and so on), which will work with both Xt and
		1020	@@RXVT_NAME@@'s own processing).
		1021
		1022	You can define a range of keysyms in one shot by providing a I<string>
		1023	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
		1024	should be a character not used by the strings.
		1025
		1026	Its usage can be demonstrated by an example:
		1027
		1028	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
		1029
		1030	The above line is equivalent to the following three lines:
		1031
		1032	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
		1033	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
		1034	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
		1035
		1036	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
		1037	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
		1038	example the following means "change the current locale to C<zh_CN.GBK>
		1039	when Control-Meta-c is being pressed":
		1040
		1041	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		1042
		1043	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1044	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1045	manpage. For example, the F<selection> extension (activated via
		1046	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1047
		1048	URxvt.keysym.M-C-c: perl:selection:rot13
		1049
		1050	Due the the large number of modifier combinations, a defined key mapping
		1051	will match if at I<at least> the specified identifiers are being set, and
		1052	no other key mappings with those and more bits are being defined. That
		1053	means that defining a key map for C<a> will automatically provide
		1054	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		1055	mappings themselves.
		1056
		1057	Unfortunately, this will override built-in key mappings. For example
		1058	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		1059	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		1060	user-defined keymap using the C<builtin:> replacement:
		1061
		1062	URxvt.keysym.Insert: <my insert key sequence>
		1063	URxvt.keysym.S-Insert: builtin:
		1064
		1065	The first line defines a mapping for C<Insert> and I<any> combination
		1066	of modifiers. The second line re-establishes the default mapping for
		1067	C<Shift-Insert>.
		1068
		1069	The following example will map Control-Meta-1 and Control-Meta-2 to
		1070	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
		1071	font-switching at runtime:
		1072
		1073	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1074	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
		1075
		1076	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
		1077	info):
		1078
		1079	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1080	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1081
		1082	=item B<perl-ext-common>: I<string>
		1083
		1084	=item B<perl-ext>: I<string>
		1085
		1086	Colon-separated list(s) of perl extension scripts to use in this terminal
		1087	instance. Each extension is looked up in the library directories, loaded
		1088	if necessary, and bound to the current terminal instance. If this
		1089	resource is empty or missing, then the perl interpreter will not be
		1090	initialized. The idea behind two options is that B<perl-ext-common> will
		1091	be used for extensions that should be available to all instances, while
		1092	B<perl-ext> is used for specific instances; option B<-pe>.
		1093
		1094	=item B<perl-eval>: I<string>
		1095
		1096	Perl code to be evaluated when all extensions have been registered. See the
		1097	@@RXVT_NAME@@perl(3) manpage.
		1098
		1099	=item B<perl-lib>: I<path>
		1100
		1101	Colon-separated list of additional directories that hold extension
		1102	scripts. When looking for extensions specified by the C<perl> resource,
		1103	@@RXVT_NAME@@ will first look in these directories and then in
		1104	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
		1105
		1106	See the @@RXVT_NAME@@perl(3) manpage.
706		1107
707	=back	1108	=back
708		1109
709	=head1 THE SCROLLBAR	1110	=head1 THE SCROLLBAR
710		1111
…		…
724	the normal text selection/insertion, hold either the Shift or the Meta	1125	the normal text selection/insertion, hold either the Shift or the Meta
725	(Alt) key while performing the desired mouse action.	1126	(Alt) key while performing the desired mouse action.
726		1127
727	If mouse reporting mode is active, the normal scrollbar actions are	1128	If mouse reporting mode is active, the normal scrollbar actions are
728	disabled -- on the assumption that we are using a fullscreen	1129	disabled -- on the assumption that we are using a fullscreen
729	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	1130	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
730	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	1131	(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),	1132	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
732	respectively.	1133	respectively.
733		1134
734	=head1 TEXT SELECTION AND INSERTION	1135	=head1 TEXT SELECTION AND INSERTION
735		1136
736	The behaviour of text selection and insertion mechanism is similar to	1137	The behaviour of text selection and insertion mechanism is similar to
…		…
738		1139
739	=over 4	1140	=over 4
740		1141
741	=item B<Selection>:	1142	=item B<Selection>:
742		1143
743	Left click at the beginning of the region, drag to the end of the	1144	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	1145	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	1146	to select a word; Left triple-click to select the entire logical line
746	line.	1147	(which can span multiple screen lines), unless modified by resource
		1148	B<tripleclickwords>.
		1149
		1150	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
		1151	(Compile: I<frills>) will create a rectangular selection instead of a
		1152	normal one. In this mode, every selected row becomes its own line in the
		1153	selection, and trailing whitespace is visually underlined and removed from
		1154	the selection.
747		1155
748	=item B<Insertion>:	1156	=item B<Insertion>:
749		1157
750	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1158	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	1159	an B<@@RXVT_NAME@@> window causes the current text selection to be
…		…
753		1161
754	=back	1162	=back
755		1163
756	=head1 CHANGING FONTS	1164	=head1 CHANGING FONTS
757		1165
758	You can change fonts on-the-fly, which is to say cycle through the	1166	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	1167	supported in rxvt-unicode. Bug me if you need this.
760	B<Shift-KP_Subtract>. Or, alternatively (if enabled) with	1168
761	B<@@HOTKEY@@-@@BIGFONT@@> and B<@@HOTKEY@@-@@SMALLFONT@@>, where the	1169	You can, however, switch fonts at runtime using escape sequences (and
762	actual key can be selected using resources	1170	therefore using the menubar), e.g.:
763	B<smallfont_key>/B<bigfont_key>.	1171
		1172	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1173
		1174	rxvt-unicode will automatically re-apply these fonts to the output so far.
764		1175
765	=head1 ISO 14755 SUPPORT	1176	=head1 ISO 14755 SUPPORT
766		1177
767	Partial ISO 14755-support is implemented. that means that pressing	1178	ISO 14755 is a standard for entering and viewing unicode characters
		1179	and character codes using the keyboard. It consists of 4 parts. The
		1180	first part is available rxvt-unicode has been compiled with
		1181	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
		1182	with C<--enable-iso14755>.
768		1183
769	Section 5.1: Control and Shift together enters unicode input	1184	=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		1185
774	Section 5.2: Pressing and immediately releasing Control and Shift together	1186	=item * 5.1: Basic method
775	enters keycap entry mode for the next key: pressing a function key (tab,	1187
776	return etc..) will enter the unicode character corresponding to the given	1188	This allows you to enter unicode characters using their hexcode.
777	key.	1189
		1190	Start by pressing and holding both C<Control> and C<Shift>, then enter
		1191	hex-digits (between one and six). Releasing C<Control> and C<Shift> will
		1192	commit the character as if it were typed directly. While holding down
		1193	C<Control> and C<Shift> you can also enter multiple characters by pressing
		1194	C<Space>, which will commit the current character and lets you start a new
		1195	one.
		1196
		1197	As an example of use, imagine a business card with a japanese e-mail
		1198	address, which you cannot type. Fortunately, the card has the e-mail
		1199	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
		1200	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
		1201	followed by releasing the modifier keys.
		1202
		1203	=item * 5.2: Keyboard symbols entry method
		1204
		1205	This mode lets you input characters representing the keycap symbols of
		1206	your keyboard, if representable in the current locale encoding.
		1207
		1208	Start by pressing C<Control> and C<Shift> together, then releasing
		1209	them. The next special key (cursor keys, home etc.) you enter will not
		1210	invoke it's usual function but instead will insert the corresponding
		1211	keycap symbol. The symbol will only be entered when the key has been
		1212	released, otherwise pressing e.g. C<Shift> would enter the symbol for
		1213	C<ISO Level 2 Switch>, although your intention might have been to enter a
		1214	reverse tab (Shift-Tab).
		1215
		1216	=item * 5.3: Screen-selection entry method
		1217
		1218	While this is implemented already (it's basically the selection
		1219	mechanism), it could be extended by displaying a unicode character map.
		1220
		1221	=item * 5.4: Feedback method for identifying displayed characters for later input
		1222
		1223	This method lets you display the unicode character code associated with
		1224	characters already displayed.
		1225
		1226	You enter this mode by holding down C<Control> and C<Shift> together, then
		1227	pressing and holding the left mouse button and moving around. The unicode
		1228	hex code(s) (it might be a combining character) of the character under the
		1229	pointer is displayed until you release C<Control> and C<Shift>.
		1230
		1231	In addition to the hex codes it will display the font used to draw this
		1232	character - due to implementation reasons, characters combined with
		1233	combining characters, line drawing characters and unknown characters will
		1234	always be drawn using the built-in support font.
		1235
		1236	=back
		1237
		1238	With respect to conformance, rxvt-unicode is supposed to be compliant to
		1239	both scenario A and B of ISO 14755, including part 5.2.
778		1240
779	=head1 LOGIN STAMP	1241	=head1 LOGIN STAMP
780		1242
781	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so	1243	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.	1244	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	1245	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
784	some systems.	1246	on some systems or setgid to root or to some other group on others.
785		1247
786	=head1 COLORS AND GRAPHICS	1248	=head1 COLORS AND GRAPHICS
787		1249
788	In addition to the default foreground and background colours,	1250	In addition to the default foreground and background colours,
789	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1251	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	1285	I<xterm>(1) where the colours are only swapped if they have not otherwise
824	been specified. For example,	1286	been specified. For example,
825		1287
826	=over 4	1288	=over 4
827		1289
828	=item B<rxvt -fg Black -bg White -rv>	1290	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
829		1291
830	would yield White on Black, while on I<xterm>(1) it would yield Black	1292	would yield White on Black, while on I<xterm>(1) it would yield Black
831	on White.	1293	on White.
832		1294
833	=back	1295	=back
834		1296
835	=head1 ENVIRONMENT	1297	=head1 ENVIRONMENT
836		1298
837	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>	1299	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	1300
839	window id number of the B<@@RXVT_NAME@@> window and it also uses and	1301	=over 4
840	sets the environment variable B<DISPLAY> to specify which display	1302
841	terminal to use. B<@@RXVT_NAME@@> uses the environment variables	1303	=item B<TERM>
842	B<RXVTPATH> and B<PATH> to find XPM files.	1304
		1305	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
		1306	resources or on the commandline.
		1307
		1308	=item B<COLORTERM>
		1309
		1310	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
		1311	compiled with XPM support, and optionally with the added extension
		1312	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
		1313
		1314	=item B<COLORFGBG>
		1315
		1316	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
		1317	the colour code used as default foreground/text colour (or the string
		1318	C<default> to indicate that the default-colour escape sequence is to be
		1319	used), C<bg> is the colour code used as default background colour (or the
		1320	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1321	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
		1322	(and do) use this information to optimize screen output.
		1323
		1324	=item B<WINDOWID>
		1325
		1326	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
		1327	window, which usually has subwindows for the scrollbar, the terminal
		1328	window and so on).
		1329
		1330	=item B<TERMINFO>
		1331
		1332	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1333	C<--with-terminfo=PATH>.
		1334
		1335	=item B<DISPLAY>
		1336
		1337	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
		1338	display in it's child processes.
		1339
		1340	=item B<SHELL>
		1341
		1342	The shell to be used for command execution, defaults to C</bin/sh>.
		1343
		1344	=item B<RXVTPATH>
		1345
		1346	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
		1347	files.
		1348
		1349	=item B<PATH>
		1350
		1351	Used in the same way as C<RXVTPATH>.
		1352
		1353	=item B<RXVT_SOCKET>
		1354
		1355	The unix domain socket path used by @@RXVT_NAME@@c(1) and
		1356	@@RXVT_NAME@@d(1).
		1357
		1358	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
		1359
		1360	=item B<HOME>
		1361
		1362	Used to locate the default directory for the unix domain socket for
		1363	daemon communications and to locate various resource files (such as
		1364	C<.Xdefaults>)
		1365
		1366	=item B<XAPPLRESDIR>
		1367
		1368	Directory where various X resource files are being located.
		1369
		1370	=item B<XENVIRONMENT>
		1371
		1372	If set and accessible, gives the name of a X resource file to be loaded by
		1373	@@RXVT_NAME@@.
		1374
		1375	=back
843		1376
844	=head1 FILES	1377	=head1 FILES
845		1378
846	=over 4	1379	=over 4
847		1380
848	=item B</etc/utmp>
849
850	System file for login records.
851
852	=item B</usr/lib/X11/rgb.txt>	1381	=item B</usr/lib/X11/rgb.txt>
853		1382
854	Color names.	1383	Color names.
855		1384
856	=back	1385	=back
857		1386
858	=head1 SEEALSO	1387	=head1 SEE ALSO
859		1388
860	I<xterm>(1), I<sh>(1), I<resize>(1), I<X>(1), I<pty>(4), I<tty>(4), I<utmp>(5)	1389	@@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		1390
872	=head1 CURRENT PROJECT COORDINATOR	1391	=head1 CURRENT PROJECT COORDINATOR
873		1392
874	=over 4	1393	=over 4
875		1394
876	=item Project Coordinator	1395	=item Project Coordinator
877		1396
878	@@RXVTMAINT@@ L<@@RXVT_MAINTEMAIL@@>	1397	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
879		1398
880	=item Web page maintainter	1399	L<http://software.schmorp.de/#rxvt-unicode>
881
882	@@RXVTWEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
883
884	L<@@RXVT_WEBPAGE@@>
885		1400
886	=back	1401	=back
887		1402
888	=head1 AUTHORS	1403	=head1 AUTHORS
889		1404
…		…
914	=item Geoff Wing L<< <gcw@pobox.com> >>	1429	=item Geoff Wing L<< <gcw@pobox.com> >>
915		1430
916	Rewrote screen display and text selection routines. Project Coordinator	1431	Rewrote screen display and text selection routines. Project Coordinator
917	(changes.txt 2.4.6 - rxvt-unicode)	1432	(changes.txt 2.4.6 - rxvt-unicode)
918		1433
919	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>	1434	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
920		1435
921	Forked rxvt-unicode, rewrote most of the display code and internal	1436	Forked rxvt-unicode, rewrote most of the display code and internal
922	character handling to store text in unicode, improve xterm	1437	character handling to store text in unicode, improve xterm
923	compatibility and apply numerous other bugfixes and extensions.	1438	compatibility and apply numerous other bugfixes and extensions.
924		1439

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.85 by root, Wed Jan 4 20:43:37 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.85 by root, Wed Jan 4 20:43:37 2006 UTC