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

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.68 by root, Thu Aug 11 02:05:07 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.68 by root, Thu Aug 11 02:05:07 2005 UTC