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

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.3 by root, Thu Aug 12 22:22:30 2004 UTC vs. Revision 1.69 by root, Tue Oct 25 19:04:45 2005 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.3 by root, Thu Aug 12 22:22:30 2004 UTC vs.
Revision 1.69 by root, Tue Oct 25 19:04:45 2005 UTC