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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.4 by root, Fri Aug 13 03:47:09 2004 UTC vs.
Revision 1.74 by root, Thu Dec 22 16:44:10 2005 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
125	=item B<-rb>\|B<+rb>	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.:
126		185
127	Enable "real bold" support. When this option is on, bold text will be	186	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
128	displayed using the first available bold font in the font list. Bold	187	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
129	fonts should thus be specified in the font list after their	188
130	corresponding regular fonts. If no bold font can be found, a regular	189	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
131	font will be used. resource B<realBold>.	190	section of @@RXVT_NAME@@(7).
		191
		192	=item B<-fb> I<fontlist>
		193
		194	Compile font-styles: The bold font list to use when bold characters are to
		195	be printed. See resource B<boldFont> for details.
		196
		197	=item B<-fi> I<fontlist>
		198
		199	Compile font-styles: The italic font list to use when bold characters are to
		200	be printed. See resource B<italicFont> for details.
		201
		202	=item B<-fbi> I<fontlist>
		203
		204	Compile font-styles: The bold italic font list to use when bold characters are to
		205	be printed. See resource B<boldItalicFont> for details.
132		206
133	=item B<-name> I<name>	207	=item B<-name> I<name>
134		208
135	Specify the application name under which resources are to be obtained,	209	Specify the application name under which resources are to be obtained,
136	rather than the default executable file name. Name should not contain	210	rather than the default executable file name. Name should not contain
…		…
174		248
175	Put scrollbar on right/left; resource B<scrollBar_right>.	249	Put scrollbar on right/left; resource B<scrollBar_right>.
176		250
177	=item B<-st>\|B<+st>	251	=item B<-st>\|B<+st>
178		252
179	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	253	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
180	resource B<scrollBar_floating>.	254	resource B<scrollBar_floating>.
		255
		256	=item B<-ptab>\|B<+ptab>
		257
		258	If enabled (default), "Horizontal Tab" characters are being stored as
		259	actual wide characters in the screen buffer, which makes it possible to
		260	select and paste them. Since a horizontal tab is a cursor movement and
		261	not an actual glyph, this can sometimes be visually annoying as the cursor
		262	on a tab character is displayed as a wide cursor; resource B<pastableTabs>.
181		263
182	=item B<-bc>\|B<+bc>	264	=item B<-bc>\|B<+bc>
183		265
184	Blink the cursor; resource B<cursorBlink>.	266	Blink the cursor; resource B<cursorBlink>.
185		267
…		…
210	if honoured by the WM, the rxvt-unicode window will not have window	292	if honoured by the WM, the rxvt-unicode window will not have window
211	decorations; resource B<borderLess>.	293	decorations; resource B<borderLess>.
212		294
213	=item B<-lsp> I<number>	295	=item B<-lsp> I<number>
214		296
215	Compile I<linespace>: Lines (pixel height) to insert between each row	297	Compile I<frills>: Lines (pixel height) to insert between each row of
216	of the display; resource B<linespace>.	298	the display. Useful to work around font rendering problems; resource
		299	B<linespace>.
217		300
218	=item B<-tn> I<termname>	301	=item B<-tn> I<termname>
219		302
220	This option specifies the name of the terminal type to be set in the	303	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	304	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	313	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	314	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,	315	run the program specified by the B<SHELL> environment variable or,
233	failing that, I<sh(1)>.	316	failing that, I<sh(1)>.
234		317
		318	Please note that you must specify a program with arguments. If you want to
		319	run shell commands, you have to specify the shell, like this:
		320
		321	@@RXVT_NAME@@ -e sh -c "shell commands"
		322
235	=item B<-title> I<text>	323	=item B<-title> I<text>
236		324
237	Window title (B<-T> still respected); the default title is the basename	325	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	326	of the program specified after the B<-e> option, if any, otherwise the
239	application name; resource B<title>.	327	application name; resource B<title>.
…		…
257		345
258	Compile I<XIM>: input method name. resource B<inputMethod>.	346	Compile I<XIM>: input method name. resource B<inputMethod>.
259		347
260	=item B<-imlocale> I<string>	348	=item B<-imlocale> I<string>
261		349
262	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	350	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	351	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	352	input extension to be able to input japanese characters while staying in
265	another locale.	353	another locale. resource B<imLocale>.
		354
		355	=item B<-imfont> I<fontset>
		356
		357	Set the font set to use for the X Input Method, see resource B<imFont>
		358	for more info.
		359
		360	=item B<-tcw>
		361
		362	Change the meaning of triple-click selection with the left mouse
		363	button. Instead of selecting a full line it will extend the selection the
		364	end of the logical line only. resource B<tripleclickwords>.
266		365
267	=item B<-insecure>	366	=item B<-insecure>
268		367
269	Enable "insecure" mode, which currently enables most of the escape	368	Enable "insecure" mode, which currently enables most of the escape
270	sequences that echo strings. See the resource B<insecure> for more	369	sequences that echo strings. See the resource B<insecure> for more
…		…
284	=item B<-ssr>\|B<+ssr>	383	=item B<-ssr>\|B<+ssr>
285		384
286	Turn on/off secondary screen scroll (default enabled); resource	385	Turn on/off secondary screen scroll (default enabled); resource
287	B<secondaryScroll>.	386	B<secondaryScroll>.
288		387
289	=item B<-xrm> I<resourcestring>	388	=item B<-hold>\|B<+hold>
290		389
291	No effect on rxvt-unicode. Simply passes through an argument to be made	390	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
292	available in the instance's argument list. Appears in I<WM_COMMAND> in	391	will not immediately destroy its window when the program executed within
293	some window managers.	392	it exits. Instead, it will wait till it is being killed or closed by the
		393	user; resource B<hold>.
		394
		395	=item B<-keysym.>I<sym> I<string>
		396
		397	Remap a key symbol. See resource B<keysym>.
		398
		399	=item B<-embed> I<windowid>
		400
		401	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
		402	which enables applications to easily embed a terminal.
		403
		404	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
		405	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
		406	quite a bit, so don't expect it to keep some specific state. It's best to
		407	create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
		408
		409	The window will not be destroyed when @@RXVT_NAME@@ exits.
		410
		411	It might be useful to know that @@RXVT_NAME@@ will not close file
		412	descriptors passed to it (except for stdin/out/err, of course), so you
		413	can use file descriptors to communicate with the programs within the
		414	terminal. This works regardless of wether the C<-embed> option was used or
		415	not.
		416
		417	Here is a short Gtk2-perl snippet that illustrates how this option can be
		418	used (a longer example is in F<doc/embed>):
		419
		420	my $rxvt = new Gtk2::Socket;
		421	$rxvt->signal_connect_after (realize => sub {
		422	my $xid = $_[0]->window->get_xid;
		423	system "@@RXVT_NAME@@ -embed $xid &";
		424	});
		425
		426	=item B<-pty-fd> I<fileno>
		427
		428	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
		429	pair but instead use the given filehandle as the tty master. This is
		430	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
		431	without having to run a program within it.
		432
		433	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
		434	entries and will not tinker with pty/tty permissions - you have to do that
		435	yourself if you want that.
		436
		437	Here is a example in perl that illustrates how this option can be used (a
		438	longer example is in F<doc/pty-fd>):
		439
		440	use IO::Pty;
		441	use Fcntl;
		442
		443	my $pty = new IO::Pty;
		444	fcntl $pty, F_SETFD, 0; # clear close-on-exec
		445	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		446	close $pty;
		447
		448	# now communicate with rxvt
		449	my $slave = $pty->slave;
		450	while (<$slave>) { print $slave "got <$_>\n" }
294		451
295	=back	452	=back
296		453
297	=head1 RESOURCES (available also as long-options)	454	=head1 RESOURCES (available also as long-options)
298		455
…		…
301		458
302	There are two different methods that @@RXVT_NAME@@ can use to get the	459	There are two different methods that @@RXVT_NAME@@ can use to get the
303	Xresource data: using the X libraries (Xrm*-functions) or internal	460	Xresource data: using the X libraries (Xrm*-functions) or internal
304	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	461	Xresources reader (B<~/.Xdefaults>). For the first method (ie.
305	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	462	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	463	resources using X11 tools like B<xrdb>. Many distribution do also load
307	settings from the B<~/.Xresources> file when X starts.	464	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
		465	will consult the following files/resources in order, with later settings
		466	overwriting earlier ones:
		467
		468	1. system-wide app-defaults file, either locale-dependent OR global
		469	2. app-defaults file in $XAPPLRESDIR
		470	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
		471	4. SCREEN_RESOURCES for the current screen
		472	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
308		473
309	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>	474	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
310	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults	475	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
311	set in XAPPLOADDIR/URxvt (compile-time defined: usually	476	set in XAPPLOADDIR/URxvt (compile-time defined: usually
312	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	477	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
…		…
345	high-intensity (bold = bright foreground, blink = bright background)	510	high-intensity (bold = bright foreground, blink = bright background)
346	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	511	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	512	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.	513	names used are listed in the B<COLORS AND GRAPHICS> section.
349		514
		515	Colours higher than 15 cannot be set using resources (yet), but can be
		516	changed using an escape command (see @@RXVT_NAME@@(7)).
		517
		518	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
		519	88 colour support). Colours 80-87 are evenly spaces grey steps.
		520
350	=item B<colorBD:> I<colour>	521	=item B<colorBD:> I<colour>
351		522
		523	=item B<colorIT:> I<colour>
		524
352	Use the specified colour to display bold characters when the foreground	525	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	526	foreground colour is the default. If font styles are not available
354	enabled.	527	(Compile I<styles>) and this option is unset, reverse video is used instead.
355		528
356	=item B<colorUL:> I<colour>	529	=item B<colorUL:> I<colour>
357		530
358	Use the specified colour to display underlined characters when the	531	Use the specified colour to display underlined characters when the
359	foreground colour is the default.	532	foreground colour is the default.
360		533
361	=item B<colorRV:> I<colour>	534	=item B<colorRV:> I<colour>
362		535
363	Use the specified colour as the background for reverse video	536	Use the specified colour as the background for reverse video
364	characters.	537	characters.
		538
		539	=item B<underlineColor:> I<colour>
		540
		541	If set, use the specified colour as the colour for the underline
		542	itself. If unset, use the foreground colour.
365		543
366	=item B<cursorColor:> I<colour>	544	=item B<cursorColor:> I<colour>
367		545
368	Use the specified colour for the cursor. The default is to use the	546	Use the specified colour for the cursor. The default is to use the
369	foreground colour; option B<-cr>.	547	foreground colour; option B<-cr>.
…		…
392	artificial transparency. B<False>: do not inherit the parent windows'	570	artificial transparency. B<False>: do not inherit the parent windows'
393	pixmap.	571	pixmap.
394		572
395	=item B<fading:> I<number>	573	=item B<fading:> I<number>
396		574
397	Fade the text by the given percentage when focus is lost.	575	Fade the text by the given percentage when focus is lost; option B<-fade>.
		576
		577	=item B<fadeColor:> I<colour>
		578
		579	Fade to this colour, when fading is used (see B<fading:>). The default
		580	colour is black; option B<-fadecolor>.
398		581
399	=item B<tintColor:> I<colour>	582	=item B<tintColor:> I<colour>
400		583
401	Tint the transparent background pixmap with the given colour.	584	Tint the transparent background pixmap with the given colour; option
		585	B<-tint>.
402		586
403	=item B<shading:> I<number>	587	=item B<shading:> I<number>
404		588
405	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	589	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
406	image in addition to tinting it.	590	image in addition to tinting it.
407		591
408	=item B<fading:> I<number>
409
410	Scale the tint colour by the given percentage.
411
412	=item B<scrollColor:> I<colour>	592	=item B<scrollColor:> I<colour>
413		593
414	Use the specified colour for the scrollbar [default #B2B2B2].	594	Use the specified colour for the scrollbar [default #B2B2B2].
415		595
416	=item B<troughColor:> I<colour>	596	=item B<troughColor:> I<colour>
417		597
418	Use the specified colour for the scrollbar's trough area [default	598	Use the specified colour for the scrollbar's trough area [default
419	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	599	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
		600
		601	=item B<borderColor:> I<colour>
		602
		603	The colour of the border around the text area and between the scrollbar
		604	and the text.
420		605
421	=item B<backgroundPixmap:> I<file[;geom]>	606	=item B<backgroundPixmap:> I<file[;geom]>
422		607
423	Use the specified XPM file (note the `.xpm' extension is optional) for	608	Use the specified XPM file (note the `.xpm' extension is optional) for
424	the background and also optionally specify its scaling with a geometry	609	the background and also optionally specify its scaling with a geometry
…		…
440		625
441	Specify the colon-delimited search path for finding files (XPM and	626	Specify the colon-delimited search path for finding files (XPM and
442	menus), in addition to the paths specified by the B<RXVTPATH> and	627	menus), in addition to the paths specified by the B<RXVTPATH> and
443	B<PATH> environment variables.	628	B<PATH> environment variables.
444		629
445	=item B<font:> I<fontname>	630	=item B<font:> I<fontlist>
446		631
447	Select the fonts to be used. This is a comma seperated list of font	632	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.	633	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	634	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	635	be smaller, but not larger. A reasonable default font list is always
451	appended to it. option B<-fn>.	636	appended to it. option B<-fn>.
452		637
453	=item B<realBold:> I<boolean>	638	Each font can either be a standard X11 core font (XLFD) name, with
		639	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
454		640
455	B<True>: Enable "real bold" support. When this option is on, bold text	641	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.	642	specifications enclosed in square brackets (C<[]>). The only available
457	Bold fonts should thus be specified in the font list after their	643	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	644	fonts.
459	font will be used. option B<-rb>. B<False>: Display bold text in a	645
460	regular font, using the color specified with B<colorBD>; option B<+rb>.	646	For example, this font resource
		647
		648	URxvt*font: 9x15bold,\
		649	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
		650	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
		651	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
		652	xft:Code2000:antialias=false
		653
		654	specifies five fonts to be used. The first one is C<9x15bold> (actually
		655	the iso8859-1 version of the second font), which is the base font (because
		656	it is named first) and thus defines the character cell grid to be 9 pixels
		657	wide and 15 pixels high.
		658
		659	The second font is just used to add additional unicode characters not in
		660	the base font, likewise the third, which is unfortunately non-bold, but
		661	the bold version of the font does contain less characters, so this is a
		662	useful supplement.
		663
		664	The third font is an Xft font with aliasing turned off, and the characters
		665	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
		666	contains other characters, but we are not interested in them.
		667
		668	The last font is a useful catch-all font that supplies most of the
		669	remaining unicode characters.
		670
		671	=item B<boldFont:> I<fontlist>
		672
		673	=item B<italicFont:> I<fontlist>
		674
		675	=item B<boldItalicFont:> I<fontlist>
		676
		677	The font list to use for displaying B<bold>, I<italic> or B<< I<bold
		678	italic> >> characters, respectively.
		679
		680	If specified and non-empty, then the syntax is the same as for the
		681	B<font>-resource, and the given font list will be used as is, which makes
		682	it possible to substitute completely different font styles for bold and
		683	italic.
		684
		685	If unset (the default), a suitable font list will be synthesized by
		686	"morphing" the normal text font list into the desired shape. If that is
		687	not possible, replacement fonts of the desired shape will be tried.
		688
		689	If set, but empty, then this specific style is disabled and the normal
		690	text font will being used for the given style.
461		691
462	=item B<selectstyle:> I<mode>	692	=item B<selectstyle:> I<mode>
463		693
464	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	694	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	695	xterm style with 2.20 old word selection, or anything else which gives
466	xterm style selection.	696	xterm style selection.
467		697
468	=item B<scrollstyle:> I<mode>	698	=item B<scrollstyle:> I<mode>
469		699
470	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	700	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
471	the author's favourite..	701	the author's favourite.
472		702
473	=item B<title:> I<string>	703	=item B<title:> I<string>
474		704
475	Set window title string, the default title is the command-line	705	Set window title string, the default title is the command-line
476	specified after the B<-e> option, if any, otherwise the application	706	specified after the B<-e> option, if any, otherwise the application
…		…
508		738
509	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	739	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	740	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.	741	B<Shift-Print> to include the scrollback as well.
512		742
		743	The string will be interpreted as if typed into the shell as-is.
		744
		745	Example:
		746
		747	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		748
		749	This creates a new file in your home directory with the screen contents
		750	everytime you hit C<Print>.
		751
513	=item B<scrollBar:> I<boolean>	752	=item B<scrollBar:> I<boolean>
514		753
515	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	754	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
516	disable the scrollbar; option B<+sb>.	755	disable the scrollbar; option B<+sb>.
517		756
…		…
536	B<False>: do not scroll to bottom when tty receives output; option	775	B<False>: do not scroll to bottom when tty receives output; option
537	B<+si>.	776	B<+si>.
538		777
539	=item B<scrollWithBuffer:> I<boolean>	778	=item B<scrollWithBuffer:> I<boolean>
540		779
541	B<True>: scroll with scrollback buffer when tty recieves new lines (and	780	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	781	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
543	with scrollback buffer when tty recieves new lines; option B<-sw>.	782	with scrollback buffer when tty recieves new lines; option B<+sw>.
544		783
545	=item B<scrollTtyKeypress:> I<boolean>	784	=item B<scrollTtyKeypress:> I<boolean>
546		785
547	B<True>: scroll to bottom when a non-special key is pressed. Special keys	786	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	787	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	788	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>.	789	bottom when a non-special key is pressed; option B<+sk>.
551		790
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>	791	=item B<saveLines:> I<number>
563		792
564	Save I<number> lines in the scrollback buffer [default 64]. This	793	Save I<number> lines in the scrollback buffer [default 64]. This
565	resource is limited on most machines to 65535; option B<-sl>.	794	resource is limited on most machines to 65535; option B<-sl>.
566		795
…		…
596		825
597	=item B<mouseWheelScrollPage:> I<boolean>	826	=item B<mouseWheelScrollPage:> I<boolean>
598		827
599	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel	828	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
600	scrolls five lines [default].	829	scrolls five lines [default].
		830
		831	=item B<pastableTabs:> I<boolean>
		832
		833	B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
		834	movement only; option C<-ptab>.
601		835
602	=item B<cursorBlink:> I<boolean>	836	=item B<cursorBlink:> I<boolean>
603		837
604	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	838	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
605	option B<-bc>.	839	option B<-bc>.
…		…
618		852
619	Mouse pointer background colour.	853	Mouse pointer background colour.
620		854
621	=item B<pointerBlankDelay:> I<number>	855	=item B<pointerBlankDelay:> I<number>
622		856
623	Specifies number of seconds before blanking the pointer [default 2].	857	Specifies number of seconds before blanking the pointer [default 2]. Use a
		858	large number (e.g. C<987654321>) to effectively disable the timeout.
624		859
625	=item B<backspacekey:> I<string>	860	=item B<backspacekey:> I<string>
626		861
627	The string to send when the backspace key is pressed. If set to B<DEC>	862	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>	863	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
…		…
650		885
651	I<name> of inputMethod to use; option B<-im>.	886	I<name> of inputMethod to use; option B<-im>.
652		887
653	=item B<imLocale:> I<name>	888	=item B<imLocale:> I<name>
654		889
655	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	890	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	891	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	892	input extension to be able to input japanese characters while staying in
658	another locale. option B<-imlocale>.	893	another locale. option B<-imlocale>.
659		894
660	=item B<insecure>	895	=item B<imFont:> I<fontset>
		896
		897	Specify the font-set used for XIM styles C<OverTheSpot> or
		898	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
		899	by commas), i.e. it's not in the same format as the other font lists used
		900	in @@RXVT_NAME@@. The default will be set-up to chose any suitable found
		901	found, preferably one or two pixels differing in size to the base font.
		902	option B<-imfont>.
		903
		904	=item B<tripleclickwords:> I<boolean>
		905
		906	Change the meaning of triple-click selection with the left mouse
		907	button. Instead of selecting a full line it will extend the selection to
		908	the end of the logical line only. option B<-tcw>.
		909
		910	=item B<insecure:> I<boolean>
661		911
662	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	912	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
663	echo arbitrary strings like the icon name or the locale. This could be	913	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	914	abused if somebody gets 8-bit-clean access to your display, whether
665	throuh a mail client displaying mail bodies unfiltered or though	915	through a mail client displaying mail bodies unfiltered or through
666	write(1). Therefore, these sequences are disabled by default. (Note	916	write(1) or any other means. Therefore, these sequences are disabled by
667	that other terminals, including xterm, have these sequences	917	default. (Note that many other terminals, including xterm, have these
668	enabled by default). You can enable them by setting this boolean	918	sequences enabled by default, which doesn't make it safer, though).
669	resource or specifying B<-insecure> as an option. At the moment, this	919
670	enabled display-answer, locale, findfont, icon label and window title	920	You can enable them by setting this boolean resource or specifying
671	requests as well as dynamic menubar dispatch.	921	B<-insecure> as an option. At the moment, this enables display-answer,
		922	locale, findfont, icon label and window title requests as well as dynamic
		923	menubar dispatch.
672		924
673	=item B<modifier:> I<modifier>	925	=item B<modifier:> I<modifier>
674		926
675	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	927	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	928	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	943	Turn on/off secondary screen scroll (default enabled). If the this
692	option is enabled, scrolls on the secondary screen will change the	944	option is enabled, scrolls on the secondary screen will change the
693	scrollback buffer and switching to/from the secondary screen will	945	scrollback buffer and switching to/from the secondary screen will
694	instead scroll the screen up.	946	instead scroll the screen up.
695		947
		948	=item B<hold>: I<bool>
		949
		950	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		951	will not immediately destroy its window when the program executed within
		952	it exits. Instead, it will wait till it is being killed or closed by the
		953	user.
		954
696	=item B<keysym.>I<sym>: I<string>	955	=item B<keysym.>I<sym>: I<string>
697		956
698	Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may	957	Compile I<frills>: Associate I<string> with keysym I<sym>. The
699	contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:	958	intervening resource name B<keysym.> cannot be omitted.
700	newline, \r: return, \t:	959
		960	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
		961	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
		962	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
		963	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
		964	B<2>, B<3>, B<4>, B<5>.
		965
		966	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
		967	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
		968	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
		969	current application keymap mode state.
		970
		971	The spellings of I<key> can be obtained by using B<xev>(1) command or
		972	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
		973	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
		974	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
		975	performed in an exact manner; however, the closest match is assured.
		976
		977	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
		978	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,	979	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	980	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	981	can start or end with whitespace.
704	omitted. This resource is only available when compiled with	982
705	KEYSYM_RESOURCE.	983	Please note that you need to double the C<\> when using
		984	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
		985	use C<\033> instead of C<\e> (and so on), which will work with both Xt and
		986	@@RXVT_NAME@@'s own processing).
		987
		988	You can define a range of keysyms in one shot by providing a I<string>
		989	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
		990	should be a character not used by the strings.
		991
		992	Its usage can be demonstrated by an example:
		993
		994	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
		995
		996	The above line is equivalent to the following three lines:
		997
		998	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
		999	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
		1000	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
		1001
		1002	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
		1003	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
		1004	example the following means "change the current locale to C<zh_CN.GBK>
		1005	when Control-Meta-c is being pressed":
		1006
		1007	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		1008
		1009	Due the the large number of modifier combinations, a defined key mapping
		1010	will match if at I<at least> the specified identifiers are being set, and
		1011	no other key mappings with those and more bits are being defined. That
		1012	means that defining a key map for C<a> will automatically provide
		1013	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		1014	mappings themselves.
		1015
		1016	Unfortunately, this will override built-in key mappings. For example
		1017	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		1018	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		1019	user-defined keymap using the C<builtin:> replacement:
		1020
		1021	URxvt.keysym.Insert: <my insert key sequence>
		1022	URxvt.keysym.S-Insert: builtin:
		1023
		1024	The first line defines a mapping for C<Insert> and I<any> combination
		1025	of modifiers. The second line re-establishes the default mapping for
		1026	C<Shift-Insert>.
		1027
		1028	The following example will map Control-Meta-1 and Control-Meta-2 to
		1029	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
		1030	font-switching at runtime:
		1031
		1032	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1033	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
		1034
		1035	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
		1036	info):
		1037
		1038	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1039	URxvt.keysym.M-C-4: command:\033[8;48;110t
706		1040
707	=back	1041	=back
708		1042
709	=head1 THE SCROLLBAR	1043	=head1 THE SCROLLBAR
710		1044
…		…
724	the normal text selection/insertion, hold either the Shift or the Meta	1058	the normal text selection/insertion, hold either the Shift or the Meta
725	(Alt) key while performing the desired mouse action.	1059	(Alt) key while performing the desired mouse action.
726		1060
727	If mouse reporting mode is active, the normal scrollbar actions are	1061	If mouse reporting mode is active, the normal scrollbar actions are
728	disabled -- on the assumption that we are using a fullscreen	1062	disabled -- on the assumption that we are using a fullscreen
729	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	1063	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
730	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	1064	(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),	1065	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
732	respectively.	1066	respectively.
733		1067
734	=head1 TEXT SELECTION AND INSERTION	1068	=head1 TEXT SELECTION AND INSERTION
735		1069
736	The behaviour of text selection and insertion mechanism is similar to	1070	The behaviour of text selection and insertion mechanism is similar to
…		…
738		1072
739	=over 4	1073	=over 4
740		1074
741	=item B<Selection>:	1075	=item B<Selection>:
742		1076
743	Left click at the beginning of the region, drag to the end of the	1077	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	1078	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	1079	to select a word; Left triple-click to select the entire logical line
746	line.	1080	(which can span multiple screen lines), unless modified by resource
		1081	B<tripleclickwords>.
		1082
		1083	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
		1084	(Compile: I<frills>) will create a rectangular selection instead of a normal
		1085	one.
747		1086
748	=item B<Insertion>:	1087	=item B<Insertion>:
749		1088
750	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1089	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	1090	an B<@@RXVT_NAME@@> window causes the current text selection to be
…		…
753		1092
754	=back	1093	=back
755		1094
756	=head1 CHANGING FONTS	1095	=head1 CHANGING FONTS
757		1096
758	You can change fonts on-the-fly, which is to say cycle through the	1097	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	1098	supported in rxvt-unicode. Bug me if you need this.
760	B<Shift-KP_Subtract>. Or, alternatively (if enabled) with	1099
761	B<@@HOTKEY@@-@@BIGFONT@@> and B<@@HOTKEY@@-@@SMALLFONT@@>, where the	1100	You can, however, switch fonts at runtime using escape sequences (and
762	actual key can be selected using resources	1101	therefore using the menubar), e.g.:
763	B<smallfont_key>/B<bigfont_key>.	1102
		1103	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1104
		1105	rxvt-unicode will automatically re-apply these fonts to the output so far.
764		1106
765	=head1 ISO 14755 SUPPORT	1107	=head1 ISO 14755 SUPPORT
766		1108
767	Partial ISO 14755-support is implemented. that means that pressing	1109	ISO 14755 is a standard for entering and viewing unicode characters
		1110	and character codes using the keyboard. It consists of 4 parts. The
		1111	first part is available rxvt-unicode has been compiled with
		1112	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
		1113	with C<--enable-iso14755>.
768		1114
769	Section 5.1: Control and Shift together enters unicode input	1115	=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		1116
774	Section 5.2: Pressing and immediately releasing Control and Shift together	1117	=item * 5.1: Basic method
775	enters keycap entry mode for the next key: pressing a function key (tab,	1118
776	return etc..) will enter the unicode character corresponding to the given	1119	This allows you to enter unicode characters using their hexcode.
777	key.	1120
		1121	Start by pressing and holding both C<Control> and C<Shift>, then enter
		1122	hex-digits (between one and six). Releasing C<Control> and C<Shift> will
		1123	commit the character as if it were typed directly. While holding down
		1124	C<Control> and C<Shift> you can also enter multiple characters by pressing
		1125	C<Space>, which will commit the current character and lets you start a new
		1126	one.
		1127
		1128	As an example of use, imagine a business card with a japanese e-mail
		1129	address, which you cannot type. Fortunately, the card has the e-mail
		1130	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
		1131	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
		1132	followed by releasing the modifier keys.
		1133
		1134	=item * 5.2: Keyboard symbols entry method
		1135
		1136	This mode lets you input characters representing the keycap symbols of
		1137	your keyboard, if representable in the current locale encoding.
		1138
		1139	Start by pressing C<Control> and C<Shift> together, then releasing
		1140	them. The next special key (cursor keys, home etc.) you enter will not
		1141	invoke it's usual function but instead will insert the corresponding
		1142	keycap symbol. The symbol will only be entered when the key has been
		1143	released, otherwise pressing e.g. C<Shift> would enter the symbol for
		1144	C<ISO Level 2 Switch>, although your intention might have been to enter a
		1145	reverse tab (Shift-Tab).
		1146
		1147	=item * 5.3: Screen-selection entry method
		1148
		1149	While this is implemented already (it's basically the selection
		1150	mechanism), it could be extended by displaying a unicode character map.
		1151
		1152	=item * 5.4: Feedback method for identifying displayed characters for later input
		1153
		1154	This method lets you display the unicode character code associated with
		1155	characters already displayed.
		1156
		1157	You enter this mode by holding down C<Control> and C<Shift> together, then
		1158	pressing and holding the left mouse button and moving around. The unicode
		1159	hex code(s) (it might be a combining character) of the character under the
		1160	pointer is displayed until you release C<Control> and C<Shift>.
		1161
		1162	In addition to the hex codes it will display the font used to draw this
		1163	character - due to implementation reasons, characters combined with
		1164	combining characters, line drawing characters and unknown characters will
		1165	always be drawn using the built-in support font.
		1166
		1167	=back
		1168
		1169	With respect to conformance, rxvt-unicode is supposed to be compliant to
		1170	both scenario A and B of ISO 14755, including part 5.2.
778		1171
779	=head1 LOGIN STAMP	1172	=head1 LOGIN STAMP
780		1173
781	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so	1174	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.	1175	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	1176	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
784	some systems.	1177	on some systems or setgid to root or to some other group on others.
785		1178
786	=head1 COLORS AND GRAPHICS	1179	=head1 COLORS AND GRAPHICS
787		1180
788	In addition to the default foreground and background colours,	1181	In addition to the default foreground and background colours,
789	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1182	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
…		…
832		1225
833	=back	1226	=back
834		1227
835	=head1 ENVIRONMENT	1228	=head1 ENVIRONMENT
836		1229
837	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>	1230	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	1231
839	window id number of the B<@@RXVT_NAME@@> window and it also uses and	1232	=over 4
840	sets the environment variable B<DISPLAY> to specify which display	1233
841	terminal to use. B<@@RXVT_NAME@@> uses the environment variables	1234	=item B<TERM>
842	B<RXVTPATH> and B<PATH> to find XPM files.	1235
		1236	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
		1237	resources or on the commandline.
		1238
		1239	=item B<COLORTERM>
		1240
		1241	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
		1242	compiled with XPM support, and optionally with the added extension
		1243	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
		1244
		1245	=item B<COLORFGBG>
		1246
		1247	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
		1248	the colour code used as default foreground/text colour (or the string
		1249	C<default> to indicate that the default-colour escape sequence is to be
		1250	used), C<bg> is the colour code used as default background colour (or the
		1251	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1252	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
		1253	(and do) use this information to optimize screen output.
		1254
		1255	=item B<WINDOWID>
		1256
		1257	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
		1258	window, which usually has subwindows for the scrollbar, the terminal
		1259	window and so on).
		1260
		1261	=item B<TERMINFO>
		1262
		1263	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1264	C<--with-terminfo=PATH>.
		1265
		1266	=item B<DISPLAY>
		1267
		1268	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
		1269	display in it's child processes.
		1270
		1271	=item B<SHELL>
		1272
		1273	The shell to be used for command execution, defaults to C</bin/sh>.
		1274
		1275	=item B<RXVTPATH>
		1276
		1277	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
		1278	files.
		1279
		1280	=item B<PATH>
		1281
		1282	Used in the same way as C<RXVTPATH>.
		1283
		1284	=item B<RXVT_SOCKET>
		1285
		1286	The unix domain socket path used by @@RXVT_NAME@@c(1) and
		1287	@@RXVT_NAME@@d(1).
		1288
		1289	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
		1290
		1291	=item B<HOME>
		1292
		1293	Used to locate the default directory for the unix domain socket for
		1294	daemon communications and to locate various resource files (such as
		1295	C<.Xdefaults>)
		1296
		1297	=item B<XAPPLRESDIR>
		1298
		1299	Directory where various X resource files are being located.
		1300
		1301	=item B<XENVIRONMENT>
		1302
		1303	If set and accessible, gives the name of a X resource file to be loaded by
		1304	@@RXVT_NAME@@.
		1305
		1306	=back
843		1307
844	=head1 FILES	1308	=head1 FILES
845		1309
846	=over 4	1310	=over 4
847		1311
848	=item B</etc/utmp>
849
850	System file for login records.
851
852	=item B</usr/lib/X11/rgb.txt>	1312	=item B</usr/lib/X11/rgb.txt>
853		1313
854	Color names.	1314	Color names.
855		1315
856	=back	1316	=back
857		1317
858	=head1 FREQUENTLY ASKED QUESTIONS (FAQ)	1318	=head1 SEE ALSO
		1319
		1320	@@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)
		1321
		1322	=head1 CURRENT PROJECT COORDINATOR
859		1323
860	=over 4	1324	=over 4
861		1325
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	1326	=item Project Coordinator
1096		1327
1097	@@RXVTMAINT@@ L<@@RXVT_MAINTEMAIL@@>	1328	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1098		1329
1099	=item Web page maintainter	1330	L<http://software.schmorp.de/#rxvt-unicode>
1100
1101	@@RXVTWEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1102
1103	L<@@RXVT_WEBPAGE@@>
1104		1331
1105	=back	1332	=back
1106		1333
1107	=head1 AUTHORS	1334	=head1 AUTHORS
1108		1335
…		…
1133	=item Geoff Wing L<< <gcw@pobox.com> >>	1360	=item Geoff Wing L<< <gcw@pobox.com> >>
1134		1361
1135	Rewrote screen display and text selection routines. Project Coordinator	1362	Rewrote screen display and text selection routines. Project Coordinator
1136	(changes.txt 2.4.6 - rxvt-unicode)	1363	(changes.txt 2.4.6 - rxvt-unicode)
1137		1364
1138	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>	1365	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1139		1366
1140	Forked rxvt-unicode, rewrote most of the display code and internal	1367	Forked rxvt-unicode, rewrote most of the display code and internal
1141	character handling to store text in unicode, improve xterm	1368	character handling to store text in unicode, improve xterm
1142	compatibility and apply numerous other bugfixes and extensions.	1369	compatibility and apply numerous other bugfixes and extensions.
1143		1370

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.4 by root, Fri Aug 13 03:47:09 2004 UTC vs. Revision 1.74 by root, Thu Dec 22 16:44:10 2005 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.4 by root, Fri Aug 13 03:47:09 2004 UTC vs.
Revision 1.74 by root, Thu Dec 22 16:44:10 2005 UTC