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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.3 by root, Thu Aug 12 22:22:30 2004 UTC vs.
Revision 1.91 by root, Mon Jan 9 23:00:07 2006 UTC

…		…
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.) and the FAQ section at the end of this document.	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
…		…
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
…		…
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-unicode 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-unicode. 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
…		…
301		480
302	There are two different methods that @@RXVT_NAME@@ can use to get the	481	There are two different methods that @@RXVT_NAME@@ can use to get the
303	Xresource data: using the X libraries (Xrm*-functions) or internal	482	Xresource data: using the X libraries (Xrm*-functions) or internal
304	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	483	Xresources reader (B<~/.Xdefaults>). For the first method (ie.
305	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	484	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	485	resources using X11 tools like B<xrdb>. Many distribution do also load
307	settings from the B<~/.Xresources> file when X starts.	486	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
		487	will consult the following files/resources in order, with later settings
		488	overwriting earlier ones:
		489
		490	1. system-wide app-defaults file, either locale-dependent OR global
		491	2. app-defaults file in $XAPPLRESDIR
		492	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
		493	4. SCREEN_RESOURCES for the current screen
		494	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
308		495
309	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>	496	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
310	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults	497	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
311	set in XAPPLOADDIR/URxvt (compile-time defined: usually	498	set in XAPPLOADDIR/URxvt (compile-time defined: usually
312	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	499	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
…		…
345	high-intensity (bold = bright foreground, blink = bright background)	532	high-intensity (bold = bright foreground, blink = bright background)
346	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	533	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	534	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.	535	names used are listed in the B<COLORS AND GRAPHICS> section.
349		536
		537	Colours higher than 15 cannot be set using resources (yet), but can be
		538	changed using an escape command (see @@RXVT_NAME@@(7)).
		539
		540	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
		541	88 colour support). Colours 80-87 are evenly spaces grey steps.
		542
350	=item B<colorBD:> I<colour>	543	=item B<colorBD:> I<colour>
351		544
		545	=item B<colorIT:> I<colour>
		546
352	Use the specified colour to display bold characters when the foreground	547	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	548	foreground colour is the default. If font styles are not available
354	enabled.	549	(Compile I<styles>) and this option is unset, reverse video is used instead.
355		550
356	=item B<colorUL:> I<colour>	551	=item B<colorUL:> I<colour>
357		552
358	Use the specified colour to display underlined characters when the	553	Use the specified colour to display underlined characters when the
359	foreground colour is the default.	554	foreground colour is the default.
360		555
361	=item B<colorRV:> I<colour>	556	=item B<colorRV:> I<colour>
362		557
363	Use the specified colour as the background for reverse video	558	Use the specified colour as the background for reverse video
364	characters.	559	characters.
		560
		561	=item B<underlineColor:> I<colour>
		562
		563	If set, use the specified colour as the colour for the underline
		564	itself. If unset, use the foreground colour.
365		565
366	=item B<cursorColor:> I<colour>	566	=item B<cursorColor:> I<colour>
367		567
368	Use the specified colour for the cursor. The default is to use the	568	Use the specified colour for the cursor. The default is to use the
369	foreground colour; option B<-cr>.	569	foreground colour; option B<-cr>.
…		…
392	artificial transparency. B<False>: do not inherit the parent windows'	592	artificial transparency. B<False>: do not inherit the parent windows'
393	pixmap.	593	pixmap.
394		594
395	=item B<fading:> I<number>	595	=item B<fading:> I<number>
396		596
397	Fade the text by the given percentage when focus is lost.	597	Fade the text by the given percentage when focus is lost; option B<-fade>.
		598
		599	=item B<fadeColor:> I<colour>
		600
		601	Fade to this colour, when fading is used (see B<fading:>). The default
		602	colour is black; option B<-fadecolor>.
398		603
399	=item B<tintColor:> I<colour>	604	=item B<tintColor:> I<colour>
400		605
401	Tint the transparent background pixmap with the given colour.	606	Tint the transparent background pixmap with the given colour; option
		607	B<-tint>.
402		608
403	=item B<shading:> I<number>	609	=item B<shading:> I<number>
404		610
405	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	611	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
406	image in addition to tinting it.	612	image in addition to tinting it.
407		613
408	=item B<fading:> I<number>
409
410	Scale the tint colour by the given percentage.
411
412	=item B<scrollColor:> I<colour>	614	=item B<scrollColor:> I<colour>
413		615
414	Use the specified colour for the scrollbar [default #B2B2B2].	616	Use the specified colour for the scrollbar [default #B2B2B2].
415		617
416	=item B<troughColor:> I<colour>	618	=item B<troughColor:> I<colour>
417		619
418	Use the specified colour for the scrollbar's trough area [default	620	Use the specified colour for the scrollbar's trough area [default
419	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	621	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
		622
		623	=item B<borderColor:> I<colour>
		624
		625	The colour of the border around the text area and between the scrollbar
		626	and the text.
420		627
421	=item B<backgroundPixmap:> I<file[;geom]>	628	=item B<backgroundPixmap:> I<file[;geom]>
422		629
423	Use the specified XPM file (note the `.xpm' extension is optional) for	630	Use the specified XPM file (note the `.xpm' extension is optional) for
424	the background and also optionally specify its scaling with a geometry	631	the background and also optionally specify its scaling with a geometry
…		…
440		647
441	Specify the colon-delimited search path for finding files (XPM and	648	Specify the colon-delimited search path for finding files (XPM and
442	menus), in addition to the paths specified by the B<RXVTPATH> and	649	menus), in addition to the paths specified by the B<RXVTPATH> and
443	B<PATH> environment variables.	650	B<PATH> environment variables.
444		651
445	=item B<font:> I<fontname>	652	=item B<font:> I<fontlist>
446		653
447	Select the fonts to be used. This is a comma seperated list of font	654	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.	655	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	656	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	657	be smaller, but not larger. A reasonable default font list is always
451	appended to it. option B<-fn>.	658	appended to it; option B<-fn>.
452		659
453	=item B<realBold:> I<boolean>	660	Each font can either be a standard X11 core font (XLFD) name, with
		661	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
454		662
455	B<True>: Enable "real bold" support. When this option is on, bold text	663	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.	664	specifications enclosed in square brackets (C<[]>). The only available
457	Bold fonts should thus be specified in the font list after their	665	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	666	fonts.
459	font will be used. option B<-rb>. B<False>: Display bold text in a	667
460	regular font, using the color specified with B<colorBD>; option B<+rb>.	668	For example, this font resource
		669
		670	URxvt*font: 9x15bold,\
		671	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
		672	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
		673	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
		674	xft:Code2000:antialias=false
		675
		676	specifies five fonts to be used. The first one is C<9x15bold> (actually
		677	the iso8859-1 version of the second font), which is the base font (because
		678	it is named first) and thus defines the character cell grid to be 9 pixels
		679	wide and 15 pixels high.
		680
		681	The second font is just used to add additional unicode characters not in
		682	the base font, likewise the third, which is unfortunately non-bold, but
		683	the bold version of the font does contain less characters, so this is a
		684	useful supplement.
		685
		686	The third font is an Xft font with aliasing turned off, and the characters
		687	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
		688	contains other characters, but we are not interested in them.
		689
		690	The last font is a useful catch-all font that supplies most of the
		691	remaining unicode characters.
		692
		693	=item B<boldFont:> I<fontlist>
		694
		695	=item B<italicFont:> I<fontlist>
		696
		697	=item B<boldItalicFont:> I<fontlist>
		698
		699	The font list to use for displaying B<bold>, I<italic> or B<< I<bold
		700	italic> >> characters, respectively.
		701
		702	If specified and non-empty, then the syntax is the same as for the
		703	B<font>-resource, and the given font list will be used as is, which makes
		704	it possible to substitute completely different font styles for bold and
		705	italic.
		706
		707	If unset (the default), a suitable font list will be synthesized by
		708	"morphing" the normal text font list into the desired shape. If that is
		709	not possible, replacement fonts of the desired shape will be tried.
		710
		711	If set, but empty, then this specific style is disabled and the normal
		712	text font will being used for the given style.
		713
		714	=item B<intensityStyles:> I<boolean>
		715
		716	When font styles are not enabled, or this option is enabled (B<True>,
		717	option B<-is>, the default), bold and italic font styles imply high
		718	intensity foreground/backround colours. Disabling this option (B<False>,
		719	option B<+is>) disables this behaviour, the high intensity colours are not
		720	reachable.
461		721
462	=item B<selectstyle:> I<mode>	722	=item B<selectstyle:> I<mode>
463		723
464	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	724	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	725	xterm style with 2.20 old word selection, or anything else which gives
466	xterm style selection.	726	xterm style selection.
467		727
468	=item B<scrollstyle:> I<mode>	728	=item B<scrollstyle:> I<mode>
469		729
470	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	730	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
471	the author's favourite..	731	the author's favourite.
472		732
473	=item B<title:> I<string>	733	=item B<title:> I<string>
474		734
475	Set window title string, the default title is the command-line	735	Set window title string, the default title is the command-line
476	specified after the B<-e> option, if any, otherwise the application	736	specified after the B<-e> option, if any, otherwise the application
…		…
508		768
509	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	769	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	770	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.	771	B<Shift-Print> to include the scrollback as well.
512		772
		773	The string will be interpreted as if typed into the shell as-is.
		774
		775	Example:
		776
		777	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		778
		779	This creates a new file in your home directory with the screen contents
		780	everytime you hit C<Print>.
		781
513	=item B<scrollBar:> I<boolean>	782	=item B<scrollBar:> I<boolean>
514		783
515	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	784	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
516	disable the scrollbar; option B<+sb>.	785	disable the scrollbar; option B<+sb>.
517		786
…		…
530	Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar	799	Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar
531	thumb with the pointer on middle button press/drag.	800	thumb with the pointer on middle button press/drag.
532		801
533	=item B<scrollTtyOutput:> I<boolean>	802	=item B<scrollTtyOutput:> I<boolean>
534		803
535	B<True>: scroll to bottom when tty receives output; option B<+si>.	804	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	805	B<False>: do not scroll to bottom when tty receives output; option
537	B<-si>.	806	B<+si>.
538		807
539	=item B<scrollWithBuffer:> I<boolean>	808	=item B<scrollWithBuffer:> I<boolean>
540		809
541	B<True>: scroll with scrollback buffer when tty recieves new lines (and	810	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	811	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
543	with scrollback buffer when tty recieves new lines; option B<-sw>.	812	with scrollback buffer when tty recieves new lines; option B<+sw>.
544		813
545	=item B<scrollTtyKeypress:> I<boolean>	814	=item B<scrollTtyKeypress:> I<boolean>
546		815
547	B<True>: scroll to bottom when a non-special key is pressed. Special keys	816	B<True>: scroll to bottom when a non-special key is pressed. Special keys
548	are those which are intercepted by rxvt-unicode for special handling and	817	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 to	818	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
550	bottom when a non-special key is pressed; option B<+sk>.	819	bottom when a non-special key is pressed; option B<+sk>.
551		820
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
562	=item B<saveLines:> I<number>	821	=item B<saveLines:> I<number>
563		822
564	Save I<number> lines in the scrollback buffer [default 64]. This	823	Save I<number> lines in the scrollback buffer [default 64]. This
565	resource is limited on most machines to 65535; option B<-sl>.	824	resource is limited on most machines to 65535; option B<-sl>.
566		825
…		…
577	=item B<borderLess:> I<boolean>	836	=item B<borderLess:> I<boolean>
578		837
579	Set MWM hints to request a borderless window, i.e. if honoured by the	838	Set MWM hints to request a borderless window, i.e. if honoured by the
580	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.	839	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
581		840
		841	=item B<skipBuiltinGlyphs:> I<boolean>
		842
		843	Compile I<frills>: Disable the usage of the built-in block graphics/line
		844	drawing characters and just rely on what the specified fonts provide. Use
		845	this if you have a good font and want to use its block graphic glyphs;
		846	option B<-sbg>.
		847
582	=item B<termName:> I<termname>	848	=item B<termName:> I<termname>
583		849
584	Specifies the terminal type name to be set in the B<TERM> environment	850	Specifies the terminal type name to be set in the B<TERM> environment
585	variable; option B<-tn>.	851	variable; option B<-tn>.
586		852
…		…
596		862
597	=item B<mouseWheelScrollPage:> I<boolean>	863	=item B<mouseWheelScrollPage:> I<boolean>
598		864
599	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel	865	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
600	scrolls five lines [default].	866	scrolls five lines [default].
		867
		868	=item B<pastableTabs:> I<boolean>
		869
		870	B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
		871	movement only; option C<-ptab>.
601		872
602	=item B<cursorBlink:> I<boolean>	873	=item B<cursorBlink:> I<boolean>
603		874
604	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	875	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
605	option B<-bc>.	876	option B<-bc>.
…		…
618		889
619	Mouse pointer background colour.	890	Mouse pointer background colour.
620		891
621	=item B<pointerBlankDelay:> I<number>	892	=item B<pointerBlankDelay:> I<number>
622		893
623	Specifies number of seconds before blanking the pointer [default 2].	894	Specifies number of seconds before blanking the pointer [default 2]. Use a
		895	large number (e.g. C<987654321>) to effectively disable the timeout.
624		896
625	=item B<backspacekey:> I<string>	897	=item B<backspacekey:> I<string>
626		898
627	The string to send when the backspace key is pressed. If set to B<DEC>	899	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>	900	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
…		…
650		922
651	I<name> of inputMethod to use; option B<-im>.	923	I<name> of inputMethod to use; option B<-im>.
652		924
653	=item B<imLocale:> I<name>	925	=item B<imLocale:> I<name>
654		926
655	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	927	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	928	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	929	input extension to be able to input japanese characters while staying in
658	another locale. option B<-imlocale>.	930	another locale; option B<-imlocale>.
659		931
660	=item B<insecure>	932	=item B<imFont:> I<fontset>
		933
		934	Specify the font-set used for XIM styles C<OverTheSpot> or
		935	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
		936	by commas), i.e. it's not in the same format as the other font lists used
		937	in @@RXVT_NAME@@. The default will be set-up to chose any suitable found
		938	found, preferably one or two pixels differing in size to the base font.
		939	option B<-imfont>.
		940
		941	=item B<tripleclickwords:> I<boolean>
		942
		943	Change the meaning of triple-click selection with the left mouse
		944	button. Instead of selecting a full line it will extend the selection to
		945	the end of the logical line only; option B<-tcw>.
		946
		947	=item B<insecure:> I<boolean>
661		948
662	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	949	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
663	echo arbitrary strings like the icon name or the locale. This could be	950	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	951	abused if somebody gets 8-bit-clean access to your display, whether
665	throuh a mail client displaying mail bodies unfiltered or though	952	through a mail client displaying mail bodies unfiltered or through
666	write(1). Therefore, these sequences are disabled by default. (Note	953	write(1) or any other means. Therefore, these sequences are disabled by
667	that other terminals, including xterm, have these sequences	954	default. (Note that many other terminals, including xterm, have these
668	enabled by default). You can enable them by setting this boolean	955	sequences enabled by default, which doesn't make it safer, though).
669	resource or specifying B<-insecure> as an option. At the moment, this	956
670	enabled display-answer, locale, findfont, icon label and window title	957	You can enable them by setting this boolean resource or specifying
671	requests as well as dynamic menubar dispatch.	958	B<-insecure> as an option. At the moment, this enables display-answer,
		959	locale, findfont, icon label and window title requests as well as dynamic
		960	menubar dispatch.
672		961
673	=item B<modifier:> I<modifier>	962	=item B<modifier:> I<modifier>
674		963
675	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	964	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	965	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
691	Turn on/off secondary screen scroll (default enabled). If the this	980	Turn on/off secondary screen scroll (default enabled). If the this
692	option is enabled, scrolls on the secondary screen will change the	981	option is enabled, scrolls on the secondary screen will change the
693	scrollback buffer and switching to/from the secondary screen will	982	scrollback buffer and switching to/from the secondary screen will
694	instead scroll the screen up.	983	instead scroll the screen up.
695		984
		985	=item B<hold>: I<bool>
		986
		987	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		988	will not immediately destroy its window when the program executed within
		989	it exits. Instead, it will wait till it is being killed or closed by the
		990	user.
		991
696	=item B<keysym.>I<sym>: I<string>	992	=item B<keysym.>I<sym>: I<string>
697		993
698	Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may	994	Compile I<frills>: Associate I<string> with keysym I<sym>. The
699	contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:	995	intervening resource name B<keysym.> cannot be omitted.
700	newline, \r: return, \t:	996
		997	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
		998	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
		999	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
		1000	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
		1001	B<2>, B<3>, B<4>, B<5>.
		1002
		1003	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
		1004	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
		1005	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
		1006	current application keymap mode state.
		1007
		1008	The spellings of I<key> can be obtained by using B<xev>(1) command or
		1009	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
		1010	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
		1011	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
		1012	performed in an exact manner; however, the closest match is assured.
		1013
		1014	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
		1015	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,	1016	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	1017	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	1018	can start or end with whitespace.
704	omitted. This resource is only available when compiled with	1019
705	KEYSYM_RESOURCE.	1020	Please note that you need to double the C<\> when using
		1021	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
		1022	use C<\033> instead of C<\e> (and so on), which will work with both Xt and
		1023	@@RXVT_NAME@@'s own processing).
		1024
		1025	You can define a range of keysyms in one shot by providing a I<string>
		1026	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
		1027	should be a character not used by the strings.
		1028
		1029	Its usage can be demonstrated by an example:
		1030
		1031	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
		1032
		1033	The above line is equivalent to the following three lines:
		1034
		1035	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
		1036	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
		1037	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
		1038
		1039	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
		1040	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
		1041	example the following means "change the current locale to C<zh_CN.GBK>
		1042	when Control-Meta-c is being pressed":
		1043
		1044	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		1045
		1046	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1047	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1048	manpage. For example, the F<selection> extension (activated via
		1049	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1050
		1051	URxvt.keysym.M-C-c: perl:selection:rot13
		1052
		1053	Due the the large number of modifier combinations, a defined key mapping
		1054	will match if at I<at least> the specified identifiers are being set, and
		1055	no other key mappings with those and more bits are being defined. That
		1056	means that defining a key map for C<a> will automatically provide
		1057	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		1058	mappings themselves.
		1059
		1060	Unfortunately, this will override built-in key mappings. For example
		1061	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		1062	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		1063	user-defined keymap using the C<builtin:> replacement:
		1064
		1065	URxvt.keysym.Insert: <my insert key sequence>
		1066	URxvt.keysym.S-Insert: builtin:
		1067
		1068	The first line defines a mapping for C<Insert> and I<any> combination
		1069	of modifiers. The second line re-establishes the default mapping for
		1070	C<Shift-Insert>.
		1071
		1072	The following example will map Control-Meta-1 and Control-Meta-2 to
		1073	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
		1074	font-switching at runtime:
		1075
		1076	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1077	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
		1078
		1079	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
		1080	info):
		1081
		1082	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1083	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1084
		1085	=item B<perl-ext-common>: I<string>
		1086
		1087	=item B<perl-ext>: I<string>
		1088
		1089	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1090	use in this terminal instance; option B<-pe>.
		1091
		1092	Extension names can be prefixed with a C<-> sign to prohibit using
		1093	them. This can be useful to selectively disable some extensions loaded
		1094	by default, or specified via the C<perl-ext-common> resource. For
		1095	example, C<default,-selection> will use all the default extension except
		1096	C<selection>.
		1097
		1098	Extension names can also be followed by an argument in angle brackets
		1099	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1100	searchable scorllback to Alt/Meta-s). Mentioning the same extension
		1101	multiple times with different arguments will pass multiple arguments to
		1102	the extension.
		1103
		1104	Each extension is looked up in the library directories, loaded if
		1105	necessary, and bound to the current terminal instance.
		1106
		1107	If both of these resources are the empty string, then the perl
		1108	interpreter will not be initialized. The idea behind two options is that
		1109	B<perl-ext-common> will be used for extensions that should be available to
		1110	all instances, while B<perl-ext> is used for specific instances.
		1111
		1112	=item B<perl-eval>: I<string>
		1113
		1114	Perl code to be evaluated when all extensions have been registered. See
		1115	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
		1116	will be ignored when running setuid/setgid.
		1117
		1118	=item B<perl-lib>: I<path>
		1119
		1120	Colon-separated list of additional directories that hold extension
		1121	scripts. When looking for extensions specified by the C<perl> resource,
		1122	@@RXVT_NAME@@ will first look in these directories and then in
		1123	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
		1124	will be ignored when running setuid/setgid.
		1125
		1126	See the @@RXVT_NAME@@perl(3) manpage.
		1127
		1128	=item B<transient-for>: I<windowid>
		1129
		1130	Sets the WM_TRANSIENT_FOR property to the given window iw.
706		1131
707	=back	1132	=back
708		1133
709	=head1 THE SCROLLBAR	1134	=head1 THE SCROLLBAR
710		1135
…		…
724	the normal text selection/insertion, hold either the Shift or the Meta	1149	the normal text selection/insertion, hold either the Shift or the Meta
725	(Alt) key while performing the desired mouse action.	1150	(Alt) key while performing the desired mouse action.
726		1151
727	If mouse reporting mode is active, the normal scrollbar actions are	1152	If mouse reporting mode is active, the normal scrollbar actions are
728	disabled -- on the assumption that we are using a fullscreen	1153	disabled -- on the assumption that we are using a fullscreen
729	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	1154	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
730	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	1155	(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),	1156	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
732	respectively.	1157	respectively.
733		1158
734	=head1 TEXT SELECTION AND INSERTION	1159	=head1 TEXT SELECTION AND INSERTION
735		1160
736	The behaviour of text selection and insertion mechanism is similar to	1161	The behaviour of text selection and insertion mechanism is similar to
…		…
738		1163
739	=over 4	1164	=over 4
740		1165
741	=item B<Selection>:	1166	=item B<Selection>:
742		1167
743	Left click at the beginning of the region, drag to the end of the	1168	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	1169	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	1170	to select a word; Left triple-click to select the entire logical line
746	line.	1171	(which can span multiple screen lines), unless modified by resource
		1172	B<tripleclickwords>.
		1173
		1174	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
		1175	(Compile: I<frills>) will create a rectangular selection instead of a
		1176	normal one. In this mode, every selected row becomes its own line in the
		1177	selection, and trailing whitespace is visually underlined and removed from
		1178	the selection.
747		1179
748	=item B<Insertion>:	1180	=item B<Insertion>:
749		1181
750	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1182	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	1183	an B<@@RXVT_NAME@@> window causes the current text selection to be
…		…
753		1185
754	=back	1186	=back
755		1187
756	=head1 CHANGING FONTS	1188	=head1 CHANGING FONTS
757		1189
758	You can change fonts on-the-fly, which is to say cycle through the	1190	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	1191	supported in rxvt-unicode. Bug me if you need this.
760	B<Shift-KP_Subtract>. Or, alternatively (if enabled) with	1192
761	B<@@HOTKEY@@-@@BIGFONT@@> and B<@@HOTKEY@@-@@SMALLFONT@@>, where the	1193	You can, however, switch fonts at runtime using escape sequences (and
762	actual key can be selected using resources	1194	therefore using the menubar), e.g.:
763	B<smallfont_key>/B<bigfont_key>.	1195
		1196	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1197
		1198	rxvt-unicode will automatically re-apply these fonts to the output so far.
764		1199
765	=head1 ISO 14755 SUPPORT	1200	=head1 ISO 14755 SUPPORT
766		1201
767	Partial ISO 14755-support is implemented. that means that pressing	1202	ISO 14755 is a standard for entering and viewing unicode characters
		1203	and character codes using the keyboard. It consists of 4 parts. The
		1204	first part is available rxvt-unicode has been compiled with
		1205	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
		1206	with C<--enable-iso14755>.
768		1207
769	Section 5.1: Control and Shift together enters unicode input	1208	=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		1209
774	Section 5.2: Pressing and immediately releasing Control and Shift together	1210	=item * 5.1: Basic method
775	enters keycap entry mode for the next key: pressing a function key (tab,	1211
776	return etc..) will enter the unicode character corresponding to the given	1212	This allows you to enter unicode characters using their hexcode.
777	key.	1213
		1214	Start by pressing and holding both C<Control> and C<Shift>, then enter
		1215	hex-digits (between one and six). Releasing C<Control> and C<Shift> will
		1216	commit the character as if it were typed directly. While holding down
		1217	C<Control> and C<Shift> you can also enter multiple characters by pressing
		1218	C<Space>, which will commit the current character and lets you start a new
		1219	one.
		1220
		1221	As an example of use, imagine a business card with a japanese e-mail
		1222	address, which you cannot type. Fortunately, the card has the e-mail
		1223	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
		1224	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
		1225	followed by releasing the modifier keys.
		1226
		1227	=item * 5.2: Keyboard symbols entry method
		1228
		1229	This mode lets you input characters representing the keycap symbols of
		1230	your keyboard, if representable in the current locale encoding.
		1231
		1232	Start by pressing C<Control> and C<Shift> together, then releasing
		1233	them. The next special key (cursor keys, home etc.) you enter will not
		1234	invoke it's usual function but instead will insert the corresponding
		1235	keycap symbol. The symbol will only be entered when the key has been
		1236	released, otherwise pressing e.g. C<Shift> would enter the symbol for
		1237	C<ISO Level 2 Switch>, although your intention might have been to enter a
		1238	reverse tab (Shift-Tab).
		1239
		1240	=item * 5.3: Screen-selection entry method
		1241
		1242	While this is implemented already (it's basically the selection
		1243	mechanism), it could be extended by displaying a unicode character map.
		1244
		1245	=item * 5.4: Feedback method for identifying displayed characters for later input
		1246
		1247	This method lets you display the unicode character code associated with
		1248	characters already displayed.
		1249
		1250	You enter this mode by holding down C<Control> and C<Shift> together, then
		1251	pressing and holding the left mouse button and moving around. The unicode
		1252	hex code(s) (it might be a combining character) of the character under the
		1253	pointer is displayed until you release C<Control> and C<Shift>.
		1254
		1255	In addition to the hex codes it will display the font used to draw this
		1256	character - due to implementation reasons, characters combined with
		1257	combining characters, line drawing characters and unknown characters will
		1258	always be drawn using the built-in support font.
		1259
		1260	=back
		1261
		1262	With respect to conformance, rxvt-unicode is supposed to be compliant to
		1263	both scenario A and B of ISO 14755, including part 5.2.
778		1264
779	=head1 LOGIN STAMP	1265	=head1 LOGIN STAMP
780		1266
781	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so	1267	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.	1268	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	1269	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
784	some systems.	1270	on some systems or setgid to root or to some other group on others.
785		1271
786	=head1 COLORS AND GRAPHICS	1272	=head1 COLORS AND GRAPHICS
787		1273
788	In addition to the default foreground and background colours,	1274	In addition to the default foreground and background colours,
789	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1275	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
…		…
832		1318
833	=back	1319	=back
834		1320
835	=head1 ENVIRONMENT	1321	=head1 ENVIRONMENT
836		1322
837	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>	1323	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	1324
839	window id number of the B<@@RXVT_NAME@@> window and it also uses and	1325	=over 4
840	sets the environment variable B<DISPLAY> to specify which display	1326
841	terminal to use. B<@@RXVT_NAME@@> uses the environment variables	1327	=item B<TERM>
842	B<RXVTPATH> and B<PATH> to find XPM files.	1328
		1329	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
		1330	resources or on the commandline.
		1331
		1332	=item B<COLORTERM>
		1333
		1334	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
		1335	compiled with XPM support, and optionally with the added extension
		1336	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
		1337
		1338	=item B<COLORFGBG>
		1339
		1340	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
		1341	the colour code used as default foreground/text colour (or the string
		1342	C<default> to indicate that the default-colour escape sequence is to be
		1343	used), C<bg> is the colour code used as default background colour (or the
		1344	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1345	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
		1346	(and do) use this information to optimize screen output.
		1347
		1348	=item B<WINDOWID>
		1349
		1350	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
		1351	window, which usually has subwindows for the scrollbar, the terminal
		1352	window and so on).
		1353
		1354	=item B<TERMINFO>
		1355
		1356	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1357	C<--with-terminfo=PATH>.
		1358
		1359	=item B<DISPLAY>
		1360
		1361	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
		1362	display in it's child processes.
		1363
		1364	=item B<SHELL>
		1365
		1366	The shell to be used for command execution, defaults to C</bin/sh>.
		1367
		1368	=item B<RXVTPATH>
		1369
		1370	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
		1371	files.
		1372
		1373	=item B<PATH>
		1374
		1375	Used in the same way as C<RXVTPATH>.
		1376
		1377	=item B<RXVT_SOCKET>
		1378
		1379	The unix domain socket path used by @@RXVT_NAME@@c(1) and
		1380	@@RXVT_NAME@@d(1).
		1381
		1382	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
		1383
		1384	=item B<HOME>
		1385
		1386	Used to locate the default directory for the unix domain socket for
		1387	daemon communications and to locate various resource files (such as
		1388	C<.Xdefaults>)
		1389
		1390	=item B<XAPPLRESDIR>
		1391
		1392	Directory where various X resource files are being located.
		1393
		1394	=item B<XENVIRONMENT>
		1395
		1396	If set and accessible, gives the name of a X resource file to be loaded by
		1397	@@RXVT_NAME@@.
		1398
		1399	=back
843		1400
844	=head1 FILES	1401	=head1 FILES
845		1402
846	=over 4	1403	=over 4
847		1404
848	=item B</etc/utmp>
849
850	System file for login records.
851
852	=item B</usr/lib/X11/rgb.txt>	1405	=item B</usr/lib/X11/rgb.txt>
853		1406
854	Color names.	1407	Color names.
855		1408
856	=back	1409	=back
857		1410
858	=head1 FREQUENTLY ASKED QUESTIONS (FAQ)	1411	=head1 SEE ALSO
		1412
		1413	@@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)
		1414
		1415	=head1 CURRENT PROJECT COORDINATOR
859		1416
860	=over 4	1417	=over 4
861		1418
862	=item How do I know which rxvt-unicode version I'm using?
863
864	The version number is displayed with the usage (-h). For rxvt-unicode
865	version 2.14 and later, the escape sequence C<ESC[8n> sets the window
866	title to the version number.
867
868	=item Mouse cut/paste suddenly no longer works.
869
870	Make sure that mouse reporting is actually turned off since killing
871	some editors prematurely may leave the mouse in mouse report mode. I've
872	heard that tcsh may use mouse reporting unless it otherwise specified. A
873	quick check is to see if cut/paste works when the Alt or Shift keys are
874	depressed. See @@RXVT_NAME@@(7)
875
876	=item What's with this bold/blink stuff?
877
878	If no bold colour is set via C<colorBD:>, bold will invert text using the
879	standard foreground colour.
880
881	For the standard background colour, blinking will actually make the
882	text blink when compiled with C<--enable-blinking>. with standard
883	colours. Without C<--enable-blinking>, the blink attribute will be
884	ignored.
885
886	On ANSI colours, bold/blink attributes are used to set high-intensity
887	foreground/background colors.
888
889	color0-7 are the low-intensity colors.
890
891	color8-15 are the corresponding high-intensity colors.
892
893	=item I don't like the screen colors. How do I change them?
894
895	You can change the screen colors at run-time using F<~/.Xdefaults>
896	resources (or as long-options).
897
898	Here are values that are supposed to resemble a VGA screen,
899	including the murky brown that passes for low-intensity yellow:
900
901	Rxvt*color0: #000000
902	Rxvt*color1: #A80000
903	Rxvt*color2: #00A800
904	Rxvt*color3: #A8A800
905	Rxvt*color4: #0000A8
906	Rxvt*color5: #A800A8
907	Rxvt*color6: #00A8A8
908	Rxvt*color7: #A8A8A8
909
910	Rxvt*color8: #000054
911	Rxvt*color9: #FF0054
912	Rxvt*color10: #00FF54
913	Rxvt*color11: #FFFF54
914	Rxvt*color12: #0000FF
915	Rxvt*color13: #FF00FF
916	Rxvt*color14: #00FFFF
917	Rxvt*color15: #FFFFFF
918
919	=item What's with the strange Backspace/Delete key behaviour?
920
921	Assuming that the physical Backspace key corresponds to the
922	BackSpace keysym (not likely for Linux ... see the following
923	question) there are two standard values that can be used for
924	Backspace: C<^H> and C<^?>.
925
926	Historically, either value is correct, but rxvt-unicode adopts the debian
927	policy of using C<^?> when unsure, because it's the one only only correct
928	choice :).
929
930	Rxvt-unicode tries to inherit the current stty settings and uses the value
931	of `erase' to guess the value for backspace. If rxvt-unicode wasn't
932	started from a terminal (say, from a menu or by remote shell), then the
933	system value of `erase', which corresponds to CERASE in <termios.h>, will
934	be used (which may not be the same as your stty setting).
935
936	For starting a new rxvt-unicode:
937
938	# use Backspace = ^H
939	$ stty erase ^H
940	$ @@RXVT_NAME@@
941
942	# use Backspace = ^?
943	$ stty erase ^?
944	$ @@RXVT_NAME@@
945
946	Toggle with "ESC[36h" / "ESC[36l" as documented in @@RXVT_NAME@@(7).
947
948	For an existing rxvt-unicode:
949
950	# use Backspace = ^H
951	$ stty erase ^H
952	$ echo -n "^[[36h"
953
954	# use Backspace = ^?
955	$ stty erase ^?
956	$ echo -n "^[[36l"
957
958	This helps satisfy some of the Backspace discrepancies that occur, but
959	if you use Backspace = C<^H>, make sure that the termcap/terminfo value
960	properly reflects that.
961
962	The Delete key is a another casualty of the ill-defined Backspace problem.
963	To avoid confusion between the Backspace and Delete keys, the Delete
964	key has been assigned an escape sequence to match the vt100 for Execute
965	(ESC[3~) and is in the supplied termcap/terminfo.
966
967	Some other Backspace problems:
968
969	some editors use termcap/terminfo,
970	some editors (vim I'm told) expect Backspace = ^H,
971	GNU Emacs (and Emacs-like editors) use ^H for help.
972
973	Perhaps someday this will all be resolved in a consistent manner.
974
975	=item I don't like the key-bindings. How do I change them?
976
977	There are some compile-time selections available via configure. Unless
978	you have run "configure" with the C<--disable-resources> option you can
979	use the `keysym' resource to alter the keystrings associated with keysym
980	0xFF00 - 0xFFFF (function, cursor keys, etc).
981
982	Here's an example for a tn3270 session started using `@@RXVT_NAME@@ -name tn3270'
983
984	!# ----- special uses ------:
985	! tn3270 login, remap function and arrow keys.
986	tn3270font: clean-bold----15-*
987
988	! keysym - used by rxvt only
989	! Delete - ^D
990	tn3270*keysym.0xFFFF: \004
991
992	! Home - ^A
993	tn3270*keysym.0xFF50: \001
994	! Left - ^B
995	tn3270*keysym.0xFF51: \002
996	! Up - ^P
997	tn3270*keysym.0xFF52: \020
998	! Right - ^F
999	tn3270*keysym.0xFF53: \006
1000	! Down - ^N
1001	tn3270*keysym.0xFF54: \016
1002	! End - ^E
1003	tn3270*keysym.0xFF57: \005
1004
1005	! F1 - F12
1006	tn3270*keysym.0xFFBE: \e1
1007	tn3270*keysym.0xFFBF: \e2
1008	tn3270*keysym.0xFFC0: \e3
1009	tn3270*keysym.0xFFC1: \e4
1010	tn3270*keysym.0xFFC2: \e5
1011	tn3270*keysym.0xFFC3: \e6
1012	tn3270*keysym.0xFFC4: \e7
1013	tn3270*keysym.0xFFC5: \e8
1014	tn3270*keysym.0xFFC6: \e9
1015	tn3270*keysym.0xFFC7: \e0
1016	tn3270*keysym.0xFFC8: \e-
1017	tn3270*keysym.0xFFC9: \e=
1018
1019	! map Prior/Next to F7/F8
1020	tn3270*keysym.0xFF55: \e7
1021	tn3270*keysym.0xFF56: \e8
1022
1023	=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
1024	How do I make use of them? For example, the Sun Keyboard type 4
1025	has the following mappings that rxvt-unicode doesn't recognize.
1026
1027	KP_Insert == Insert
1028	F22 == Print
1029	F27 == Home
1030	F29 == Prior
1031	F33 == End
1032	F35 == Next
1033
1034	Rather than have rxvt-unicode try to accomodate all the various possible keyboard
1035	mappings, it is better to use `xmodmap' to remap the keys as required for
1036	your particular machine.
1037
1038	=item How do I distinguish if I'm running rxvt-unicode or a regular xterm?
1039	I need this to decide about setting colors etc.
1040
1041	rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
1042	check and see if that is set. Note that several programs, JED, slrn,
1043	Midnight Commander automatically check this variable to decide whether or
1044	not to use color.
1045
1046	=item How do I set the correct, full IP address for the DISPLAY variable?
1047
1048	If you've compiled rxvt-unicode with DISPLAY_IS_IP and ahve enabled
1049	insecure mode then it is possible to use the following shell script
1050	snippets to correctly set the display. If your version of rxvt-unicode
1051	wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
1052	the COLORTERM variable can be used to distinguish rxvt-unicode from a
1053	regular xterm.
1054
1055	Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
1056	snippets:
1057
1058	# Bourne/Korn/POSIX family of shells:
1059	[ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
1060	if [ ${TERM:-foo} = xterm ]; then
1061	stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
1062	echo -n '^[Z'
1063	read term_id
1064	stty icanon echo
1065	if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
1066	echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
1067	read DISPLAY # set it in our local shell
1068	fi
1069	fi
1070
1071	=item How do I compile the manual pages for myself?
1072
1073	You need to have a recent version of perl installed as F</usr/bin/perl>,
1074	one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
1075	the doc subdirectory and enter C<make alldoc>.
1076
1077	=back
1078
1079	=head1 SEE ALSO
1080
1081	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1082
1083	=head1 BUGS
1084
1085	Check the BUGS file for an up-to-date list.
1086
1087	Cursor change support is not yet implemented.
1088
1089	Click-and-drag doesn't work with X11 mouse report overriding.
1090
1091	=head1 CURRENT PROJECT COORDINATOR
1092
1093	=over 4
1094
1095	=item Project Coordinator	1419	=item Project Coordinator
1096		1420
1097	@@RXVTMAINT@@ L<@@RXVT_MAINTEMAIL@@>	1421	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1098		1422
1099	=item Web page maintainter	1423	L<http://software.schmorp.de/#rxvt-unicode>
1100
1101	@@RXVTWEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1102
1103	L<@@RXVT_WEBPAGE@@>
1104		1424
1105	=back	1425	=back
1106		1426
1107	=head1 AUTHORS	1427	=head1 AUTHORS
1108		1428
…		…
1133	=item Geoff Wing L<< <gcw@pobox.com> >>	1453	=item Geoff Wing L<< <gcw@pobox.com> >>
1134		1454
1135	Rewrote screen display and text selection routines. Project Coordinator	1455	Rewrote screen display and text selection routines. Project Coordinator
1136	(changes.txt 2.4.6 - rxvt-unicode)	1456	(changes.txt 2.4.6 - rxvt-unicode)
1137		1457
1138	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>	1458	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1139		1459
1140	Forked rxvt-unicode, rewrote most of the display code and internal	1460	Forked rxvt-unicode, rewrote most of the display code and internal
1141	character handling to store text in unicode, improve xterm	1461	character handling to store text in unicode, improve xterm
1142	compatibility and apply numerous other bugfixes and extensions.	1462	compatibility and apply numerous other bugfixes and extensions.
1143		1463

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.3 by root, Thu Aug 12 22:22:30 2004 UTC vs. Revision 1.91 by root, Mon Jan 9 23:00:07 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.3 by root, Thu Aug 12 22:22:30 2004 UTC vs.
Revision 1.91 by root, Mon Jan 9 23:00:07 2006 UTC