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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.22 by root, Tue Aug 24 15:46:27 2004 UTC vs.
Revision 1.73 by root, Thu Dec 15 18:14:08 2005 UTC

…		…
11	B<rxvt-unicode>, version B<@@RXVT_VERSION@@>, is a colour vt102 terminal	11	B<rxvt-unicode>, version B<@@RXVT_VERSION@@>, is a colour vt102 terminal
12	emulator intended as an I<xterm>(1) replacement for users who do not	12	emulator intended as an I<xterm>(1) replacement for users who do not
13	require features such as Tektronix 4014 emulation and toolkit-style	13	require features such as Tektronix 4014 emulation and toolkit-style
14	configurability. As a result, B<rxvt-unicode> uses much less swap space --	14	configurability. As a result, B<rxvt-unicode> uses much less swap space --
15	a significant advantage on a machine serving many X sessions.	15	a significant advantage on a machine serving many X sessions.
		16
		17	=head1 FREQUENTLY ASKED QUESTIONS
		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>.
16		23
17	=head1 RXVT-UNICODE VS. RXVT	24	=head1 RXVT-UNICODE VS. RXVT
18		25
19	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode	26	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
20	internally. That means it can store and display most scripts in the	27	internally. That means it can store and display most scripts in the
…		…
24	like tibetan or devenagari. Don't expect pretty output when using these	31	like tibetan or devenagari. Don't expect pretty output when using these
25	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
26	fine, though. A somewhat difficult case are left-to-right scripts, such	33	fine, though. A somewhat difficult case are left-to-right scripts, such
27	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
28	belong into the application, not the terminal emulator (too many things --	35	belong into the application, not the terminal emulator (too many things --
29	such as cursor-movement while editing -- break othwerwise), but that might	36	such as cursor-movement while editing -- break otherwise), but that might
30	change.	37	change.
31		38
32	If you are looking for a terminal that supports more exotic scripts, let	39	If you are looking for a terminal that supports more exotic scripts, let
33	me recommend C<mlterm>, which is a very userfriendly, lean and clean	40	me recommend C<mlterm>, which is a very userfriendly, lean and clean
34	terminal emulator. In fact, the reason rxvt-unicode was born was solely	41	terminal emulator. In fact, the reason rxvt-unicode was born was solely
…		…
53	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and	60	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
54	@@RXVT_NAME@@c(1) (client).	61	@@RXVT_NAME@@c(1) (client).
55		62
56	It also makes technical information about escape sequences (which have	63	It also makes technical information about escape sequences (which have
57	been extended) easier accessible: see @@RXVT_NAME@@(7) for technical	64	been extended) easier accessible: see @@RXVT_NAME@@(7) for technical
58	reference documentation (escape sequences etc.) and the FAQ section at the	65	reference documentation (escape sequences etc.).
59	end of this document.
60		66
61	=head1 OPTIONS	67	=head1 OPTIONS
62		68
63	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
64	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
…		…
99		105
100	=item B<-j>\|B<+j>	106	=item B<-j>\|B<+j>
101		107
102	Turn on/off jump scrolling; resource B<jumpScroll>.	108	Turn on/off jump scrolling; resource B<jumpScroll>.
103		109
104	=item B<-ip>\|B<+ip>	110	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>
105		111
106	Turn on/off inheriting parent window's pixmap. Alternative form is	112	Turn on/off inheriting parent window's pixmap. Alternative form is
107	B<-tr>; resource B<inheritPixmap>.	113	B<-tr>; resource B<inheritPixmap>.
108		114
109	=item B<-fade> I<number>	115	=item B<-fade> I<number>
110		116
111	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>.
112		125
113	=item B<-tint> I<colour>	126	=item B<-tint> I<colour>
114		127
115	Tint the transparent background pixmap with the given colour when	128	Tint the transparent background pixmap with the given colour when
116	transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>	129	transparency is enabled with B<-tr> or B<-ip>. This only works for
117	option that can be used to brighten or darken the image in addition to	130	non-tiled backgrounds, currently. See also the B<-sh> option that can be
118	tinting it.	131	used to brighten or darken the image in addition to tinting it; resource
		132	I<tintColor>. Example:
		133
		134	@@RXVT_NAME@@ -tr -tint blue -sh 40
119		135
120	=item B<-sh>	136	=item B<-sh>
121		137
122	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	138	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
123	background image in addition to tinting it (i.e. B<-tint> must be	139	background image in addition to tinting it (i.e. B<-tint> must be
124	specified, too).	140	specified, too, e.g. C<-tint white>).
125		141
126	=item B<-bg> I<colour>	142	=item B<-bg> I<colour>
127		143
128	Window background colour; resource B<background>.	144	Window background colour; resource B<background>.
129		145
…		…
132	Window foreground colour; resource B<foreground>.	148	Window foreground colour; resource B<foreground>.
133		149
134	=item B<-pixmap> I<file[;geom]>	150	=item B<-pixmap> I<file[;geom]>
135		151
136	Compile I<XPM>: Specify XPM file for the background and also optionally	152	Compile I<XPM>: Specify XPM file for the background and also optionally
137	specify its scaling with a geometry string. Note you may need to add	153	specify its scaling with a geometry string. Note you may need to
138	quotes to avoid special shell interpretation of the `;' in the	154	add quotes to avoid special shell interpretation of the C<;> in the
139	command-line; resource B<backgroundPixmap>.	155	command-line; resource B<backgroundPixmap>.
140		156
141	=item B<-cr> I<colour>	157	=item B<-cr> I<colour>
142		158
143	The cursor colour; resource B<cursorColor>.	159	The cursor colour; resource B<cursorColor>.
…		…
158	=item B<-fn> I<fontlist>	174	=item B<-fn> I<fontlist>
159		175
160	Select the fonts to be used. This is a comma separated list of font names	176	Select the fonts to be used. This is a comma separated list of font names
161	that are used in turn when trying to display Unicode characters. The	177	that are used in turn when trying to display Unicode characters. The
162	first font defines the cell size for characters; other fonts might be	178	first font defines the cell size for characters; other fonts might be
163	smaller, but not (in general) larger. A reasonable default font list is	179	smaller, but not (in general) larger. A (hopefully) reasonable default
164	always appended to it. See resource B<font> for details.	180	font list is always appended to it. See resource B<font> for more details.
		181
		182	In short, to specify an X11 core font, just specify it's name or prefix it
		183	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
		184	e.g.:
		185
		186	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
		187	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
165		188
166	See also the question "How does rxvt-unicode choose fonts?" in the FAQ	189	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
167	section.	190	section of @@RXVT_NAME@@(7).
168		191
169	=item B<-fb> I<fontlist>	192	=item B<-fb> I<fontlist>
170		193
171	Compile font-styles: The bold font list to use when bold characters are to	194	Compile font-styles: The bold font list to use when bold characters are to
172	be printed. See resource B<boldFont> for details.	195	be printed. See resource B<boldFont> for details.
…		…
225		248
226	Put scrollbar on right/left; resource B<scrollBar_right>.	249	Put scrollbar on right/left; resource B<scrollBar_right>.
227		250
228	=item B<-st>\|B<+st>	251	=item B<-st>\|B<+st>
229		252
230	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	253	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
231	resource B<scrollBar_floating>.	254	resource B<scrollBar_floating>.
		255
		256	=item B<-ptab>\|B<+ptab>
		257
		258	If enabled (default), "Horizontal Tab" characters are being stored as
		259	actual wide characters in the screen buffer, which makes it possible to
		260	select and paste them. Since a horizontal tab is a cursor movement and
		261	not an actual glyph, this can sometimes be visually annoying as the cursor
		262	on a tab character is displayed as a wide cursor; resource B<pastableTabs>.
232		263
233	=item B<-bc>\|B<+bc>	264	=item B<-bc>\|B<+bc>
234		265
235	Blink the cursor; resource B<cursorBlink>.	266	Blink the cursor; resource B<cursorBlink>.
236		267
…		…
261	if honoured by the WM, the rxvt-unicode window will not have window	292	if honoured by the WM, the rxvt-unicode window will not have window
262	decorations; resource B<borderLess>.	293	decorations; resource B<borderLess>.
263		294
264	=item B<-lsp> I<number>	295	=item B<-lsp> I<number>
265		296
266	Compile I<linespace>: Lines (pixel height) to insert between each row	297	Compile I<frills>: Lines (pixel height) to insert between each row of
267	of the display; resource B<linespace>.	298	the display. Useful to work around font rendering problems; resource
		299	B<linespace>.
268		300
269	=item B<-tn> I<termname>	301	=item B<-tn> I<termname>
270		302
271	This option specifies the name of the terminal type to be set in the	303	This option specifies the name of the terminal type to be set in the
272	B<TERM> environment variable. This terminal type must exist in the	304	B<TERM> environment variable. This terminal type must exist in the
…		…
308		340
309	Compile I<XIM>: input method name. resource B<inputMethod>.	341	Compile I<XIM>: input method name. resource B<inputMethod>.
310		342
311	=item B<-imlocale> I<string>	343	=item B<-imlocale> I<string>
312		344
313	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	345	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
314	de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input	346	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
315	extension to be able to input japanese characters while staying in	347	input extension to be able to input japanese characters while staying in
316	another locale.	348	another locale. resource B<imLocale>.
		349
		350	=item B<-imfont> I<fontset>
		351
		352	Set the font set to use for the X Input Method, see resource B<imFont>
		353	for more info.
		354
		355	=item B<-tcw>
		356
		357	Change the meaning of triple-click selection with the left mouse
		358	button. Instead of selecting a full line it will extend the selection the
		359	end of the logical line only. resource B<tripleclickwords>.
317		360
318	=item B<-insecure>	361	=item B<-insecure>
319		362
320	Enable "insecure" mode, which currently enables most of the escape	363	Enable "insecure" mode, which currently enables most of the escape
321	sequences that echo strings. See the resource B<insecure> for more	364	sequences that echo strings. See the resource B<insecure> for more
…		…
335	=item B<-ssr>\|B<+ssr>	378	=item B<-ssr>\|B<+ssr>
336		379
337	Turn on/off secondary screen scroll (default enabled); resource	380	Turn on/off secondary screen scroll (default enabled); resource
338	B<secondaryScroll>.	381	B<secondaryScroll>.
339		382
340	=item B<-xrm> I<resourcestring>	383	=item B<-keysym.>I<sym> I<string>
341		384
342	No effect on rxvt-unicode. Simply passes through an argument to be made	385	Remap a key symbol. See resource B<keysym>.
343	available in the instance's argument list. Appears in I<WM_COMMAND> in	386
344	some window managers.	387	=item B<-embed> I<windowid>
		388
		389	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
		390	which enables applications to easily embed a terminal.
		391
		392	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
		393	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
		394	quite a bit, so don't expect it to keep some specific state. It's best to
		395	create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
		396
		397	The window will not be destroyed when @@RXVT_NAME@@ exits.
		398
		399	It might be useful to know that @@RXVT_NAME@@ will not close file
		400	descriptors passed to it (except for stdin/out/err, of course), so you
		401	can use file descriptors to communicate with the programs within the
		402	terminal. This works regardless of wether the C<-embed> option was used or
		403	not.
		404
		405	Here is a short Gtk2-perl snippet that illustrates how this option can be
		406	used (a longer example is in F<doc/embed>):
		407
		408	my $rxvt = new Gtk2::Socket;
		409	$rxvt->signal_connect_after (realize => sub {
		410	my $xid = $_[0]->window->get_xid;
		411	system "@@RXVT_NAME@@ -embed $xid &";
		412	});
		413
		414	=item B<-pty-fd> I<fileno>
		415
		416	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
		417	pair but instead use the given filehandle as the tty master. This is
		418	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
		419	without having to run a program within it.
		420
		421	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
		422	entries and will not tinker with pty/tty permissions - you have to do that
		423	yourself if you want that.
		424
		425	Here is a example in perl that illustrates how this option can be used (a
		426	longer example is in F<doc/pty-fd>):
		427
		428	use IO::Pty;
		429	use Fcntl;
		430
		431	my $pty = new IO::Pty;
		432	fcntl $pty, F_SETFD, 0; # clear close-on-exec
		433	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		434	close $pty;
		435
		436	# now communicate with rxvt
		437	my $slave = $pty->slave;
		438	while (<$slave>) { print $slave "got <$_>\n" }
345		439
346	=back	440	=back
347		441
348	=head1 RESOURCES (available also as long-options)	442	=head1 RESOURCES (available also as long-options)
349		443
…		…
352		446
353	There are two different methods that @@RXVT_NAME@@ can use to get the	447	There are two different methods that @@RXVT_NAME@@ can use to get the
354	Xresource data: using the X libraries (Xrm*-functions) or internal	448	Xresource data: using the X libraries (Xrm*-functions) or internal
355	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	449	Xresources reader (B<~/.Xdefaults>). For the first method (ie.
356	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	450	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the
357	resources using X11 tools like B<xset>. Many distribution do also load	451	resources using X11 tools like B<xrdb>. Many distribution do also load
358	settings from the B<~/.Xresources> file when X starts.	452	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
		453	will consult the following files/resources in order, with later settings
		454	overwriting earlier ones:
		455
		456	1. system-wide app-defaults file, either locale-dependent OR global
		457	2. app-defaults file in $XAPPLRESDIR
		458	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
		459	4. SCREEN_RESOURCES for the current screen
		460	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
359		461
360	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>	462	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
361	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults	463	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
362	set in XAPPLOADDIR/URxvt (compile-time defined: usually	464	set in XAPPLOADDIR/URxvt (compile-time defined: usually
363	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	465	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
…		…
408		510
409	=item B<colorIT:> I<colour>	511	=item B<colorIT:> I<colour>
410		512
411	Use the specified colour to display bold or italic characters when the	513	Use the specified colour to display bold or italic characters when the
412	foreground colour is the default. If font styles are not available	514	foreground colour is the default. If font styles are not available
413	(Compile styles) and this option is unset, reverse video is used instead.	515	(Compile I<styles>) and this option is unset, reverse video is used instead.
414		516
415	=item B<colorUL:> I<colour>	517	=item B<colorUL:> I<colour>
416		518
417	Use the specified colour to display underlined characters when the	519	Use the specified colour to display underlined characters when the
418	foreground colour is the default.	520	foreground colour is the default.
419		521
420	=item B<colorRV:> I<colour>	522	=item B<colorRV:> I<colour>
421		523
422	Use the specified colour as the background for reverse video	524	Use the specified colour as the background for reverse video
423	characters.	525	characters.
		526
		527	=item B<underlineColor:> I<colour>
		528
		529	If set, use the specified colour as the colour for the underline
		530	itself. If unset, use the foreground colour.
424		531
425	=item B<cursorColor:> I<colour>	532	=item B<cursorColor:> I<colour>
426		533
427	Use the specified colour for the cursor. The default is to use the	534	Use the specified colour for the cursor. The default is to use the
428	foreground colour; option B<-cr>.	535	foreground colour; option B<-cr>.
…		…
451	artificial transparency. B<False>: do not inherit the parent windows'	558	artificial transparency. B<False>: do not inherit the parent windows'
452	pixmap.	559	pixmap.
453		560
454	=item B<fading:> I<number>	561	=item B<fading:> I<number>
455		562
456	Fade the text by the given percentage when focus is lost.	563	Fade the text by the given percentage when focus is lost; option B<-fade>.
		564
		565	=item B<fadeColor:> I<colour>
		566
		567	Fade to this colour, when fading is used (see B<fading:>). The default
		568	colour is black; option B<-fadecolor>.
457		569
458	=item B<tintColor:> I<colour>	570	=item B<tintColor:> I<colour>
459		571
460	Tint the transparent background pixmap with the given colour.	572	Tint the transparent background pixmap with the given colour; option
		573	B<-tint>.
461		574
462	=item B<shading:> I<number>	575	=item B<shading:> I<number>
463		576
464	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	577	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
465	image in addition to tinting it.	578	image in addition to tinting it.
466		579
467	=item B<fading:> I<number>
468
469	Scale the tint colour by the given percentage.
470
471	=item B<scrollColor:> I<colour>	580	=item B<scrollColor:> I<colour>
472		581
473	Use the specified colour for the scrollbar [default #B2B2B2].	582	Use the specified colour for the scrollbar [default #B2B2B2].
474		583
475	=item B<troughColor:> I<colour>	584	=item B<troughColor:> I<colour>
476		585
477	Use the specified colour for the scrollbar's trough area [default	586	Use the specified colour for the scrollbar's trough area [default
478	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	587	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
479		588
480	=item B<borderColor:> I<colour>	589	=item B<borderColor:> I<colour>
481		590
482	The colour of the border around the text area and between the scrollbar	591	The colour of the border around the text area and between the scrollbar
483	and the text.	592	and the text.
…		…
513	The first font defines the cell size for characters; other fonts might	622	The first font defines the cell size for characters; other fonts might
514	be smaller, but not larger. A reasonable default font list is always	623	be smaller, but not larger. A reasonable default font list is always
515	appended to it. option B<-fn>.	624	appended to it. option B<-fn>.
516		625
517	Each font can either be a standard X11 core font (XLFD) name, with	626	Each font can either be a standard X11 core font (XLFD) name, with
518	optional prefix C<x:> or a Xft font (Compile xft), prefixed with C<xft:>.	627	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
519		628
520	In addition, each font can be prefixed with additional hints and	629	In addition, each font can be prefixed with additional hints and
521	specifications enclosed in square brackets (C<[]>). The only available	630	specifications enclosed in square brackets (C<[]>). The only available
522	hint currently is C<codeset=codeset-name>, and this is only used for Xft	631	hint currently is C<codeset=codeset-name>, and this is only used for Xft
523	fonts.	632	fonts.
…		…
533	specifies five fonts to be used. The first one is C<9x15bold> (actually	642	specifies five fonts to be used. The first one is C<9x15bold> (actually
534	the iso8859-1 version of the second font), which is the base font (because	643	the iso8859-1 version of the second font), which is the base font (because
535	it is named first) and thus defines the character cell grid to be 9 pixels	644	it is named first) and thus defines the character cell grid to be 9 pixels
536	wide and 15 pixels high.	645	wide and 15 pixels high.
537		646
538	the second font is just used to add additional unicode characters not in	647	The second font is just used to add additional unicode characters not in
539	the base font, likewise the third, which is unfortunately non-bold, but	648	the base font, likewise the third, which is unfortunately non-bold, but
540	the bold version of the font does contain less characters, so this is a	649	the bold version of the font does contain less characters, so this is a
541	useful supplement.	650	useful supplement.
542		651
543	The third font is an Xft font with aliasing turned off, and the characters	652	The third font is an Xft font with aliasing turned off, and the characters
…		…
575	xterm style selection.	684	xterm style selection.
576		685
577	=item B<scrollstyle:> I<mode>	686	=item B<scrollstyle:> I<mode>
578		687
579	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	688	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
580	the author's favourite..	689	the author's favourite.
581		690
582	=item B<title:> I<string>	691	=item B<title:> I<string>
583		692
584	Set window title string, the default title is the command-line	693	Set window title string, the default title is the command-line
585	specified after the B<-e> option, if any, otherwise the application	694	specified after the B<-e> option, if any, otherwise the application
…		…
617		726
618	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	727	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
619	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or	728	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
620	B<Shift-Print> to include the scrollback as well.	729	B<Shift-Print> to include the scrollback as well.
621		730
		731	The string will be interpreted as if typed into the shell as-is.
		732
		733	Example:
		734
		735	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		736
		737	This creates a new file in your home directory with the screen contents
		738	everytime you hit C<Print>.
		739
622	=item B<scrollBar:> I<boolean>	740	=item B<scrollBar:> I<boolean>
623		741
624	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	742	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
625	disable the scrollbar; option B<+sb>.	743	disable the scrollbar; option B<+sb>.
626		744
…		…
645	B<False>: do not scroll to bottom when tty receives output; option	763	B<False>: do not scroll to bottom when tty receives output; option
646	B<+si>.	764	B<+si>.
647		765
648	=item B<scrollWithBuffer:> I<boolean>	766	=item B<scrollWithBuffer:> I<boolean>
649		767
650	B<True>: scroll with scrollback buffer when tty recieves new lines (and	768	B<True>: scroll with scrollback buffer when tty receives new lines (and
651	B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll	769	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
652	with scrollback buffer when tty recieves new lines; option B<-sw>.	770	with scrollback buffer when tty recieves new lines; option B<+sw>.
653		771
654	=item B<scrollTtyKeypress:> I<boolean>	772	=item B<scrollTtyKeypress:> I<boolean>
655		773
656	B<True>: scroll to bottom when a non-special key is pressed. Special keys	774	B<True>: scroll to bottom when a non-special key is pressed. Special keys
657	are those which are intercepted by rxvt-unicode for special handling and	775	are those which are intercepted by rxvt-unicode for special handling and
…		…
696	=item B<mouseWheelScrollPage:> I<boolean>	814	=item B<mouseWheelScrollPage:> I<boolean>
697		815
698	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel	816	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
699	scrolls five lines [default].	817	scrolls five lines [default].
700		818
		819	=item B<pastableTabs:> I<boolean>
		820
		821	B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
		822	movement only; option C<-ptab>.
		823
701	=item B<cursorBlink:> I<boolean>	824	=item B<cursorBlink:> I<boolean>
702		825
703	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	826	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
704	option B<-bc>.	827	option B<-bc>.
705		828
…		…
717		840
718	Mouse pointer background colour.	841	Mouse pointer background colour.
719		842
720	=item B<pointerBlankDelay:> I<number>	843	=item B<pointerBlankDelay:> I<number>
721		844
722	Specifies number of seconds before blanking the pointer [default 2].	845	Specifies number of seconds before blanking the pointer [default 2]. Use a
		846	large number (e.g. C<987654321>) to effectively disable the timeout.
723		847
724	=item B<backspacekey:> I<string>	848	=item B<backspacekey:> I<string>
725		849
726	The string to send when the backspace key is pressed. If set to B<DEC>	850	The string to send when the backspace key is pressed. If set to B<DEC>
727	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	851	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
…		…
749		873
750	I<name> of inputMethod to use; option B<-im>.	874	I<name> of inputMethod to use; option B<-im>.
751		875
752	=item B<imLocale:> I<name>	876	=item B<imLocale:> I<name>
753		877
754	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	878	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
755	de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input	879	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
756	extension to be able to input japanese characters while staying in	880	input extension to be able to input japanese characters while staying in
757	another locale. option B<-imlocale>.	881	another locale. option B<-imlocale>.
		882
		883	=item B<imFont:> I<fontset>
		884
		885	Specify the font-set used for XIM styles C<OverTheSpot> or
		886	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
		887	by commas), i.e. it's not in the same format as the other font lists used
		888	in @@RXVT_NAME@@. The default will be set-up to chose any suitable found
		889	found, preferably one or two pixels differing in size to the base font.
		890	option B<-imfont>.
		891
		892	=item B<tripleclickwords:> I<boolean>
		893
		894	Change the meaning of triple-click selection with the left mouse
		895	button. Instead of selecting a full line it will extend the selection to
		896	the end of the logical line only. option B<-tcw>.
758		897
759	=item B<insecure:> I<boolean>	898	=item B<insecure:> I<boolean>
760		899
761	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	900	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
762	echo arbitrary strings like the icon name or the locale. This could be	901	echo arbitrary strings like the icon name or the locale. This could be
763	abused if somebody gets 8-bit-clean access to your display, wether	902	abused if somebody gets 8-bit-clean access to your display, whether
764	throuh a mail client displaying mail bodies unfiltered or though	903	through a mail client displaying mail bodies unfiltered or through
765	write(1). Therefore, these sequences are disabled by default. (Note	904	write(1) or any other means. Therefore, these sequences are disabled by
766	that other terminals, including xterm, have these sequences	905	default. (Note that many other terminals, including xterm, have these
767	enabled by default). You can enable them by setting this boolean	906	sequences enabled by default, which doesn't make it safer, though).
768	resource or specifying B<-insecure> as an option. At the moment, this	907
769	enabled display-answer, locale, findfont, icon label and window title	908	You can enable them by setting this boolean resource or specifying
770	requests as well as dynamic menubar dispatch.	909	B<-insecure> as an option. At the moment, this enables display-answer,
		910	locale, findfont, icon label and window title requests as well as dynamic
		911	menubar dispatch.
771		912
772	=item B<modifier:> I<modifier>	913	=item B<modifier:> I<modifier>
773		914
774	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	915	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
775	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	916	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
792	scrollback buffer and switching to/from the secondary screen will	933	scrollback buffer and switching to/from the secondary screen will
793	instead scroll the screen up.	934	instead scroll the screen up.
794		935
795	=item B<keysym.>I<sym>: I<string>	936	=item B<keysym.>I<sym>: I<string>
796		937
797	Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may	938	Compile I<frills>: Associate I<string> with keysym I<sym>. The
798	contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:	939	intervening resource name B<keysym.> cannot be omitted.
799	newline, \r: return, \t:	940
		941	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
		942	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
		943	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
		944	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
		945	B<2>, B<3>, B<4>, B<5>.
		946
		947	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
		948	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
		949	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
		950	current application keymap mode state.
		951
		952	The spellings of I<key> can be obtained by using B<xev>(1) command or
		953	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
		954	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
		955	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
		956	performed in an exact manner; however, the closest match is assured.
		957
		958	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
		959	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
800	tab, \000: octal number) or control characters (^?: delete, ^@: null,	960	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
801	^A ...) and may enclosed with double quotes so that it can start or end	961	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
802	with whitespace. The intervening resource name B<keysym.> cannot be	962	can start or end with whitespace.
803	omitted. This resource is only available when compiled with	963
804	KEYSYM_RESOURCE.	964	Please note that you need to double the C<\> when using
		965	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
		966	use C<\033> instead of C<\e> (and so on), which will work with both Xt and
		967	@@RXVT_NAME@@'s own processing).
		968
		969	You can define a range of keysyms in one shot by providing a I<string>
		970	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
		971	should be a character not used by the strings.
		972
		973	Its usage can be demonstrated by an example:
		974
		975	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
		976
		977	The above line is equivalent to the following three lines:
		978
		979	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
		980	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
		981	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
		982
		983	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
		984	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
		985	example the following means "change the current locale to C<zh_CN.GBK>
		986	when Control-Meta-c is being pressed":
		987
		988	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		989
		990	Due the the large number of modifier combinations, a defined key mapping
		991	will match if at I<at least> the specified identifiers are being set, and
		992	no other key mappings with those and more bits are being defined. That
		993	means that defining a key map for C<a> will automatically provide
		994	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		995	mappings themselves.
		996
		997	Unfortunately, this will override built-in key mappings. For example
		998	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		999	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		1000	user-defined keymap using the C<builtin:> replacement:
		1001
		1002	URxvt.keysym.Insert: <my insert key sequence>
		1003	URxvt.keysym.S-Insert: builtin:
		1004
		1005	The first line defines a mapping for C<Insert> and I<any> combination
		1006	of modifiers. The second line re-establishes the default mapping for
		1007	C<Shift-Insert>.
		1008
		1009	The following example will map Control-Meta-1 and Control-Meta-2 to
		1010	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
		1011	font-switching at runtime:
		1012
		1013	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1014	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
		1015
		1016	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
		1017	info):
		1018
		1019	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1020	URxvt.keysym.M-C-4: command:\033[8;48;110t
805		1021
806	=back	1022	=back
807		1023
808	=head1 THE SCROLLBAR	1024	=head1 THE SCROLLBAR
809		1025
…		…
823	the normal text selection/insertion, hold either the Shift or the Meta	1039	the normal text selection/insertion, hold either the Shift or the Meta
824	(Alt) key while performing the desired mouse action.	1040	(Alt) key while performing the desired mouse action.
825		1041
826	If mouse reporting mode is active, the normal scrollbar actions are	1042	If mouse reporting mode is active, the normal scrollbar actions are
827	disabled -- on the assumption that we are using a fullscreen	1043	disabled -- on the assumption that we are using a fullscreen
828	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	1044	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
829	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	1045	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
830	up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down),	1046	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
831	respectively.	1047	respectively.
832		1048
833	=head1 TEXT SELECTION AND INSERTION	1049	=head1 TEXT SELECTION AND INSERTION
834		1050
835	The behaviour of text selection and insertion mechanism is similar to	1051	The behaviour of text selection and insertion mechanism is similar to
…		…
837		1053
838	=over 4	1054	=over 4
839		1055
840	=item B<Selection>:	1056	=item B<Selection>:
841		1057
842	Left click at the beginning of the region, drag to the end of the	1058	Left click at the beginning of the region, drag to the end of the region
843	region and release; Right click to extend the marked region; Left	1059	and release; Right click to extend the marked region; Left double-click
844	double-click to select a word; Left triple-click to select the entire	1060	to select a word; Left triple-click to select the entire logical line
845	line.	1061	(which can span multiple screen lines), unless modified by resource
		1062	B<tripleclickwords>.
		1063
		1064	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
		1065	(Compile: I<frills>) will create a rectangular selection instead of a normal
		1066	one.
846		1067
847	=item B<Insertion>:	1068	=item B<Insertion>:
848		1069
849	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1070	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
850	an B<@@RXVT_NAME@@> window causes the current text selection to be	1071	an B<@@RXVT_NAME@@> window causes the current text selection to be
…		…
858	supported in rxvt-unicode. Bug me if you need this.	1079	supported in rxvt-unicode. Bug me if you need this.
859		1080
860	You can, however, switch fonts at runtime using escape sequences (and	1081	You can, however, switch fonts at runtime using escape sequences (and
861	therefore using the menubar), e.g.:	1082	therefore using the menubar), e.g.:
862		1083
863	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1084	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
864		1085
865	rxvt-unicode will automatically re-apply these fonts to the output so far.	1086	rxvt-unicode will automatically re-apply these fonts to the output so far.
866		1087
867	=head1 ISO 14755 SUPPORT	1088	=head1 ISO 14755 SUPPORT
868		1089
…		…
872	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1093	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
873	with C<--enable-iso14755>.	1094	with C<--enable-iso14755>.
874		1095
875	=over 4	1096	=over 4
876		1097
877	=item 5.1: Basic method	1098	=item * 5.1: Basic method
878		1099
879	This allows you to enter unicode characters using their hexcode.	1100	This allows you to enter unicode characters using their hexcode.
880		1101
881	Start by pressing and holding both C<Control> and C<Shift>, then enter	1102	Start by pressing and holding both C<Control> and C<Shift>, then enter
882	hex-digits (between one and six). Releasing C<Control> and C<Shift> will	1103	hex-digits (between one and six). Releasing C<Control> and C<Shift> will
…		…
889	address, which you cannot type. Fortunately, the card has the e-mail	1110	address, which you cannot type. Fortunately, the card has the e-mail
890	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily	1111	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
891	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,	1112	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
892	followed by releasing the modifier keys.	1113	followed by releasing the modifier keys.
893		1114
894	=item 5.2: Keyboard symbols entry method	1115	=item * 5.2: Keyboard symbols entry method
895		1116
896	This mode lets you input characters representing the keycap symbols of	1117	This mode lets you input characters representing the keycap symbols of
897	your keyboard, if representable in the current locale encoding.	1118	your keyboard, if representable in the current locale encoding.
898		1119
899	Start by pressing C<Control> and C<Shift> together, then releasing	1120	Start by pressing C<Control> and C<Shift> together, then releasing
900	them. The next special key (cursor keys, home etc.) you enter will not	1121	them. The next special key (cursor keys, home etc.) you enter will not
901	invoke it's usual function but instead will insert the corresponding	1122	invoke it's usual function but instead will insert the corresponding
902	keycap symbol. The symbol will only be entered when the key has been	1123	keycap symbol. The symbol will only be entered when the key has been
903	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1124	released, otherwise pressing e.g. C<Shift> would enter the symbol for
904	C<ISO Level 2 Switch>, although your intention might have beenm to enter a	1125	C<ISO Level 2 Switch>, although your intention might have been to enter a
905	reverse tab (Shift-Tab).	1126	reverse tab (Shift-Tab).
906		1127
907	=item 5.3: Screen-selection entry method	1128	=item * 5.3: Screen-selection entry method
908		1129
909	While this is implemented already (it's basically the selection	1130	While this is implemented already (it's basically the selection
910	mechanism), it could be extended by displaying a unicode character map.	1131	mechanism), it could be extended by displaying a unicode character map.
911		1132
912	=item 5.4: Feedback method for identifying displayed characters for later input	1133	=item * 5.4: Feedback method for identifying displayed characters for later input
913		1134
914	This method lets you display the unicode character code associated with	1135	This method lets you display the unicode character code associated with
915	characters already displayed.	1136	characters already displayed.
916		1137
917	You enter this mode by holding down C<Control> and C<Shift> together, then	1138	You enter this mode by holding down C<Control> and C<Shift> together, then
…		…
929	With respect to conformance, rxvt-unicode is supposed to be compliant to	1150	With respect to conformance, rxvt-unicode is supposed to be compliant to
930	both scenario A and B of ISO 14755, including part 5.2.	1151	both scenario A and B of ISO 14755, including part 5.2.
931		1152
932	=head1 LOGIN STAMP	1153	=head1 LOGIN STAMP
933		1154
934	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so	1155	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
935	that it can be seen via the I<who(1)> command, and can accept messages.	1156	it can be seen via the I<who(1)> command, and can accept messages. To
936	To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on	1157	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
937	some systems.	1158	on some systems or setgid to root or to some other group on others.
938		1159
939	=head1 COLORS AND GRAPHICS	1160	=head1 COLORS AND GRAPHICS
940		1161
941	In addition to the default foreground and background colours,	1162	In addition to the default foreground and background colours,
942	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1163	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
…		…
983	would yield White on Black, while on I<xterm>(1) it would yield Black	1204	would yield White on Black, while on I<xterm>(1) it would yield Black
984	on White.	1205	on White.
985		1206
986	=back	1207	=back
987		1208
988	=head1 FREQUENTLY ASKED QUESTIONS (FAQ)	1209	=head1 ENVIRONMENT
		1210
		1211	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
989		1212
990	=over 4	1213	=over 4
991		1214
992	=item How do I know which rxvt-unicode version I'm using?	1215	=item B<TERM>
993		1216
994	The version number is displayed with the usage (-h). Also the escape	1217	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
995	sequence C<ESC[8n> sets the window title to the version number.	1218	resources or on the commandline.
996		1219
997	=item When I log-in to another system it tells me about missing terminfo data?	1220	=item B<COLORTERM>
998		1221
999	The terminal description used by rxvt-unicode is not as widely available	1222	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
1000	as that for xterm, or even rxvt (for which the same problem often arises).	1223	compiled with XPM support, and optionally with the added extension
		1224	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1001		1225
1002	The correct solution for this problem is to install the terminfo, this can be done	1226	=item B<COLORFGBG>
1003	like this:
1004		1227
1005	infocmp rxvt-unicode >rxvt.unicode.tic	1228	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1006	scp rxvt-unicode.tic remotesystem:	1229	the colour code used as default foreground/text colour (or the string
1007	ssh remotesystem tic rxvt-unicode.tic	1230	C<default> to indicate that the default-colour escape sequence is to be
1008		1231	used), C<bg> is the colour code used as default background colour (or the
1009	... or by installing rxvt-unicode normally on the remote system,	1232	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1233	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
		1234	(and do) use this information to optimize screen output.
1010		1235
1011	If you cannot or do not want to do this, then you can simply set	1236	=item B<WINDOWID>
1012	C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
1013	problems arising, which includes wrong keymapping, less and different
1014	colours and some refresh errors in fullscreen applications. It's a nice
1015	quick-and-dirty workaround for rare cases, though.
1016		1237
1017	If you always want to do this you can either recompile rxvt-unicode with	1238	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1018	the desired TERM value or use a resource to set it:	1239	window, which usually has subwindows for the scrollbar, the terminal
		1240	window and so on).
1019		1241
1020	URxvt.termName: rxvt	1242	=item B<TERMINFO>
1021		1243
1022	=item How can I configure rxvt-unicode so that it looks similar to the original rxvt?	1244	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1245	C<--with-terminfo=PATH>.
1023		1246
1024	Felix von Leitner says that these two lines, in your F<.Xdefaults>, will make rxvt-unicode	1247	=item B<DISPLAY>
1025	behave similar to the original rxvt:
1026		1248
1027	URxvt.font: -misc-fixed-medium-r-semicondensed--13-120-75-75-c-60-iso8859-1	1249	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1028	URxvt.boldFont: -misc-fixed-bold-r-semicondensed--13-120-75-75-c-60-iso8859-1	1250	display in it's child processes.
1029		1251
1030	=item Rxvt-unicode does not seem to understand the selected encoding?	1252	=item B<SHELL>
1031		1253
1032	=item Unicode does not seem to work?	1254	The shell to be used for command execution, defaults to C</bin/sh>.
1033		1255
1034	If you encounter strange problems like typing an accented character but	1256	=item B<RXVTPATH>
1035	getting two unrelated other characters or similar, or if program output is
1036	subtly garbled, then you should check your locale settings.
1037		1257
1038	Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the	1258	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1039	programs. Often rxvt-unicode is started in the C<C> locale, while the	1259	files.
1040	login script running within the rxvt-unicode window changes the locale to
1041	sth. else, e.h. C<en_GB.UTF-8>. Needless to say, this is not going to work.
1042		1260
1043	The best thing is to fix your startup environment, as you will likely run	1261	=item B<PATH>
1044	into other problems. If nothing works you can try this in your .profile.
1045		1262
1046	printf '\e]701;%s\007' "$LC_CTYPE"	1263	Used in the same way as C<RXVTPATH>.
1047		1264
1048	If this doesn't work, then maybe you use a C<LC_CTYPE> specification not	1265	=item B<RXVT_SOCKET>
1049	supported on your systems. Some systems have a C<locale> comamnd which
1050	displays this. If it displays sth. like:
1051		1266
1052	locale: Cannot set LC_CTYPE to default locale: ...	1267	The unix domain socket path used by @@RXVT_NAME@@c(1) and
		1268	@@RXVT_NAME@@d(1).
1053		1269
1054	Then the locale you specified is not supported on your system.	1270	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1055		1271
1056	If nothing works and you are sure that everything is set correctly then	1272	=item B<HOME>
1057	you will need to remember a little known fact: Some programs just don't
1058	support locales :(
1059		1273
1060	=item Why do the characters look ugly?	1274	Used to locate the default directory for the unix domain socket for
		1275	daemon communications and to locate various resource files (such as
		1276	C<.Xdefaults>)
1061		1277
1062	=item How does rxvt-unicode choose fonts?	1278	=item B<XAPPLRESDIR>
1063		1279
1064	Most fonts do not contain the full range of Unicode, which is	1280	Directory where various X resource files are being located.
1065	fine. Chances are that the font you (or the admin/package maintainer of
1066	your system/os) have specified does not cover all the characters you want
1067	to display.
1068		1281
1069	B<rxvt-unicode> makes a best-effort try at finding a replacement	1282	=item B<XENVIRONMENT>
1070	font. Often the result is fine, but sometimes the chosen font looks
1071	bad. Many fonts have totally strange characters that don't resemble the
1072	correct glyph at all, and rxvt-unicode lacks the artificial intelligence
1073	to detetc that a specific glyph is wrong: it has to believe the font that
1074	the characters it contains indeed look correct.
1075		1283
1076	In that case, select a font of your taste and add it to the font list,	1284	If set and accessible, gives the name of a X resource file to be loaded by
1077	e.g.:
1078
1079	@@RXVT_NAME@@ -fn basefont,font2,font3...
1080
1081	When rxvt-unicode sees a character, it will first look at the base
1082	font. If the base font does not contain the character, it will go to the
1083	next font, and so on. Specifying your own fonts will also speed up this
1084	search and use less resources within rxvt-unicode and the X-server.
1085
1086	The only limitation is that all the fonts must not be larger than the base
1087	font, as the base font defines the principial cell size, which must be the
1088	same due to the way terminals work.
1089
1090	=item Why do some chinese characters look so different than others?
1091
1092	This is because there is a difference between script and language --
1093	rxvt-unicode does not know which language the text that is output
1094	is, as it only knows the unicode character codes. If rxvt-unicode
1095	first sees a japanese character, it might choose a japanese font for
1096	it. Subseqzuent japanese characters will take that font. Now, many chinese
1097	characters aren't represented in japanese fonts, so when the first
1098	non-japanese character comes up, rxvt-unicode will look for a chinese font
1099	-- unfortunately at this point, it will still use the japanese font for
1100	japanese characters that are also chinese.
1101
1102	The workaround is easy: just tag a chinese font at the end of your font
1103	list (see the previous question). The key is to view the font list as
1104	a preference list: If you expect more japanese, list a japanese font
1105	first. If you expect more chinese, put a chinese font first.
1106
1107	In the future it might be possible to switch preferences at runtime (the
1108	internal data structure has no problem with using different fonts for
1109	the same character at the same time, but no interface for this has been
1110	designed yet).
1111
1112	=item How can I keep rxvt-unicode from using reverse video so much?
1113
1114	First of all, make sure you are running with the right terminfo
1115	(C<urxvt>), which will get rid of most of these effects. Then make sure
1116	you have specified colours for italic and bold, as otherwise rxvt-unicode
1117	might use reverse video to simulate the effect:
1118
1119	URxvt*colorBD: white
1120	URxvt*colorIT: green
1121
1122	=item Some programs assume totally weird colours (red instead of blue), how can I fix that?
1123
1124	For some unexplainable reason, some programs (i.e. irssi) assume a very
1125	weird colour palette when confronted with a terminal with more than the
1126	standard 8 colours (rxvt-unicode supports 88). The right fix is, of
1127	course, to fix these programs not to assume non-ISO colours without very
1128	good reasons.
1129
1130	In the meantime, you can either edit your C<urxvt> terminfo definition to
1131	only claim 8 colour support or use C<TERM=rxvt>, which will fix colours
1132	but keep you from using other rxvt-unicode features.
1133
1134	=item How does rxvt-unicode determine the encoding to use?
1135
1136	=item Is there an option to switch encodings?
1137
1138	Unlike some other terminals, rxvt-unicode has no encoding switch, and no
1139	specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
1140	UTF-8 or any other encodings with respect to terminal I/O.
1141
1142	The reasons is that there exists a perfectly fine mechanism for selecting
1143	the encoding, doing I/O and (most important) communicating this to all
1144	applications so everybody agrees on character properties such as width and
1145	code number. This mechanism is the I<locale>.
1146
1147	Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
1148	programs doing the same (that is, most) will automatically agree in the
1149	interpretation of characters.
1150
1151	Unfortunately, there is no system-independent way to select locales, nor
1152	is there a standard on how locale specifiers will look like.
1153
1154	On most systems, the content of the C<LC_CTYPE> environment variable
1155	contains an arbitrary string which corresponds to an already-installed
1156	locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
1157	C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
1158	(i.e. C<de> or C<german>) are also common.
1159
1160	Rxvt-unicode ignores all other locale categories, and except for
1161	the encoding, ignores country or language-specific settings,
1162	i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the same for rxvt-unicode.
1163
1164	If you want to use a specific encoding you have to make sure you start
1165	rxvt-unicode with the correct C<LC_CTYPE> category.
1166
1167	=item Can I switch locales at runtime?
1168
1169	Yes, using an escape sequence. Try sth. like this, which sets
1170	rxvt-unicode's idea of C<LC_CTYPE>.
1171
1172	printf '\e]701;%s\007' ja_JP.SJIS
1173
1174	See also the previous question.
1175
1176	Sometimes this capability is rather handy when you want to work in one
1177	locale (e.g. C<de_DE.UTF-8>) but some programs don't support UTF-8. For
1178	example, I use this script to start C<xjdic>, which first switches to a
1179	locale supported by xjdic and back later:
1180
1181	printf '\e]701;%s\007' ja_JP.SJIS
1182	xjdic -js
1183	printf '\e]701;%s\007' de_DE.UTF-8
1184
1185	=item Can I switch the fonts at runtime?
1186
1187	Yes, using an escape sequence. Try sth. like this, which has the same
1188	effect as using the C<-fn> switch, and takes effect immediately:
1189
1190	printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
1191
1192	This is useful if you e.g. work primarily with japanese (and prefer a
1193	japanese font), but you have to switch to chinese temporarily, where
1194	japanese fonts would only be in your way.
1195
1196	You can think of this as a kind of manual ISO-2022 switching.
1197
1198	=item Why do italic characters look as if clipped?
1199
1200	Many fonts have difficulties with italic characters and hinting. For
1201	example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
1202	Mono> completely fails in it's italic face. A workaround is to enable
1203	freetype autohinting, i.e. like this:
1204
1205	URxvt*italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
1206	URxvt*boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
1207
1208	=item My input method wants <some encoding> but I want UTF-8, what can I do?
1209
1210	You cna specify separate locales for the input method and the rest of the
1211	terminal, using the resource C<imlocale>:
1212
1213	URxvt*imlocale: ja_JP.EUC-JP
1214
1215	Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
1216	use your input method. Please note, however, that you will not be able to
1217	input characters outside C<EUC-JP> in a normal way then, as your input
1218	method limits you.
1219
1220	=item Rxvt-unicode uses gobs of memory, how can I reduce that?
1221
1222	Rxvt-unicode tries to obey the rule of not charging you for sth. you
1223	don't use. One thing you should try is to configure out all settings that
1224	you don't need, for example, Xft support is a resource hog by design,
1225	when used. Compiling it out ensures that no Xft font will be loaded
1226	accidentally when rxvt-unicode tries to find a font for your characters.
1227
1228	Also, many people (me included) like large windows and even larger
1229	scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
1230	6 bytes per screen cell. For a 160x?? window this amounts to almost a
1231	kilobyte per line. A scorllback buffer of 10000 lines will then (if full)
1232	use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
1233	rxvt-unicode then uses 8 bytes per screen cell.
1234
1235	=item Can I speed up Xft rendering somehow?
1236
1237	Yes, the most obvious way to speed it up is to avoid Xft entirely, as
1238	it is simply slow. If you still want Xft fonts you might try to disable
1239	antialiasing (by appending C<:antialiasing=false>), which saves lots of
1240	memory and also speeds up rendering considerably.
1241
1242	=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
1243
1244	Rxvt-unicode will use whatever you specify as a font. If it needs to
1245	fall back to it's default font search list it will prefer X11 core
1246	fonts, because they are small and fast, and then use Xft fonts. It has
1247	antialiaisng disabled for most of them, because the author thinks they
1248	look best that way.
1249
1250	If you want antialiasing, you have to specify the fonts manually.
1251
1252	=item Mouse cut/paste suddenly no longer works.
1253
1254	Make sure that mouse reporting is actually turned off since killing
1255	some editors prematurely may leave the mouse in mouse report mode. I've
1256	heard that tcsh may use mouse reporting unless it otherwise specified. A
1257	quick check is to see if cut/paste works when the Alt or Shift keys are
1258	depressed. See @@RXVT_NAME@@(7)
1259
1260	=item What's with this bold/blink stuff?
1261
1262	If no bold colour is set via C<colorBD:>, bold will invert text using the
1263	standard foreground colour.
1264
1265	For the standard background colour, blinking will actually make the
1266	text blink when compiled with C<--enable-blinking>. with standard
1267	colours. Without C<--enable-blinking>, the blink attribute will be
1268	ignored.
1269
1270	On ANSI colours, bold/blink attributes are used to set high-intensity
1271	foreground/background colors.
1272
1273	color0-7 are the low-intensity colors.
1274
1275	color8-15 are the corresponding high-intensity colors.
1276
1277	=item I don't like the screen colors. How do I change them?
1278
1279	You can change the screen colors at run-time using F<~/.Xdefaults>
1280	resources (or as long-options).
1281
1282	Here are values that are supposed to resemble a VGA screen,
1283	including the murky brown that passes for low-intensity yellow:
1284
1285	Rxvt*color0: #000000
1286	Rxvt*color1: #A80000
1287	Rxvt*color2: #00A800
1288	Rxvt*color3: #A8A800
1289	Rxvt*color4: #0000A8
1290	Rxvt*color5: #A800A8
1291	Rxvt*color6: #00A8A8
1292	Rxvt*color7: #A8A8A8
1293
1294	Rxvt*color8: #000054
1295	Rxvt*color9: #FF0054
1296	Rxvt*color10: #00FF54
1297	Rxvt*color11: #FFFF54
1298	Rxvt*color12: #0000FF
1299	Rxvt*color13: #FF00FF
1300	Rxvt*color14: #00FFFF
1301	Rxvt*color15: #FFFFFF
1302
1303	=item What's with the strange Backspace/Delete key behaviour?
1304
1305	Assuming that the physical Backspace key corresponds to the
1306	BackSpace keysym (not likely for Linux ... see the following
1307	question) there are two standard values that can be used for
1308	Backspace: C<^H> and C<^?>.
1309
1310	Historically, either value is correct, but rxvt-unicode adopts the debian
1311	policy of using C<^?> when unsure, because it's the one only only correct
1312	choice :).
1313
1314	Rxvt-unicode tries to inherit the current stty settings and uses the value
1315	of `erase' to guess the value for backspace. If rxvt-unicode wasn't
1316	started from a terminal (say, from a menu or by remote shell), then the
1317	system value of `erase', which corresponds to CERASE in <termios.h>, will
1318	be used (which may not be the same as your stty setting).
1319
1320	For starting a new rxvt-unicode:
1321
1322	# use Backspace = ^H
1323	$ stty erase ^H
1324	$ @@RXVT_NAME@@	1285	@@RXVT_NAME@@.
1325
1326	# use Backspace = ^?
1327	$ stty erase ^?
1328	$ @@RXVT_NAME@@
1329
1330	Toggle with "ESC[36h" / "ESC[36l" as documented in @@RXVT_NAME@@(7).
1331
1332	For an existing rxvt-unicode:
1333
1334	# use Backspace = ^H
1335	$ stty erase ^H
1336	$ echo -n "^[[36h"
1337
1338	# use Backspace = ^?
1339	$ stty erase ^?
1340	$ echo -n "^[[36l"
1341
1342	This helps satisfy some of the Backspace discrepancies that occur, but
1343	if you use Backspace = C<^H>, make sure that the termcap/terminfo value
1344	properly reflects that.
1345
1346	The Delete key is a another casualty of the ill-defined Backspace problem.
1347	To avoid confusion between the Backspace and Delete keys, the Delete
1348	key has been assigned an escape sequence to match the vt100 for Execute
1349	(ESC[3~) and is in the supplied termcap/terminfo.
1350
1351	Some other Backspace problems:
1352
1353	some editors use termcap/terminfo,
1354	some editors (vim I'm told) expect Backspace = ^H,
1355	GNU Emacs (and Emacs-like editors) use ^H for help.
1356
1357	Perhaps someday this will all be resolved in a consistent manner.
1358
1359	=item I don't like the key-bindings. How do I change them?
1360
1361	There are some compile-time selections available via configure. Unless
1362	you have run "configure" with the C<--disable-resources> option you can
1363	use the `keysym' resource to alter the keystrings associated with keysym
1364	0xFF00 - 0xFFFF (function, cursor keys, etc).
1365
1366	Here's an example for a tn3270 session started using `@@RXVT_NAME@@ -name tn3270'
1367
1368	!# ----- special uses ------:
1369	! tn3270 login, remap function and arrow keys.
1370	tn3270font: clean-bold----15-*
1371
1372	! keysym - used by rxvt only
1373	! Delete - ^D
1374	tn3270*keysym.0xFFFF: \004
1375
1376	! Home - ^A
1377	tn3270*keysym.0xFF50: \001
1378	! Left - ^B
1379	tn3270*keysym.0xFF51: \002
1380	! Up - ^P
1381	tn3270*keysym.0xFF52: \020
1382	! Right - ^F
1383	tn3270*keysym.0xFF53: \006
1384	! Down - ^N
1385	tn3270*keysym.0xFF54: \016
1386	! End - ^E
1387	tn3270*keysym.0xFF57: \005
1388
1389	! F1 - F12
1390	tn3270*keysym.0xFFBE: \e1
1391	tn3270*keysym.0xFFBF: \e2
1392	tn3270*keysym.0xFFC0: \e3
1393	tn3270*keysym.0xFFC1: \e4
1394	tn3270*keysym.0xFFC2: \e5
1395	tn3270*keysym.0xFFC3: \e6
1396	tn3270*keysym.0xFFC4: \e7
1397	tn3270*keysym.0xFFC5: \e8
1398	tn3270*keysym.0xFFC6: \e9
1399	tn3270*keysym.0xFFC7: \e0
1400	tn3270*keysym.0xFFC8: \e-
1401	tn3270*keysym.0xFFC9: \e=
1402
1403	! map Prior/Next to F7/F8
1404	tn3270*keysym.0xFF55: \e7
1405	tn3270*keysym.0xFF56: \e8
1406
1407	=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
1408	How do I make use of them? For example, the Sun Keyboard type 4
1409	has the following mappings that rxvt-unicode doesn't recognize.
1410
1411	KP_Insert == Insert
1412	F22 == Print
1413	F27 == Home
1414	F29 == Prior
1415	F33 == End
1416	F35 == Next
1417
1418	Rather than have rxvt-unicode try to accomodate all the various possible keyboard
1419	mappings, it is better to use `xmodmap' to remap the keys as required for
1420	your particular machine.
1421
1422	=item How do I distinguish if I'm running rxvt-unicode or a regular xterm?
1423	I need this to decide about setting colors etc.
1424
1425	rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
1426	check and see if that is set. Note that several programs, JED, slrn,
1427	Midnight Commander automatically check this variable to decide whether or
1428	not to use color.
1429
1430	=item How do I set the correct, full IP address for the DISPLAY variable?
1431
1432	If you've compiled rxvt-unicode with DISPLAY_IS_IP and ahve enabled
1433	insecure mode then it is possible to use the following shell script
1434	snippets to correctly set the display. If your version of rxvt-unicode
1435	wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
1436	the COLORTERM variable can be used to distinguish rxvt-unicode from a
1437	regular xterm.
1438
1439	Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
1440	snippets:
1441
1442	# Bourne/Korn/POSIX family of shells:
1443	[ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
1444	if [ ${TERM:-foo} = xterm ]; then
1445	stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
1446	echo -n '^[Z'
1447	read term_id
1448	stty icanon echo
1449	if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
1450	echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
1451	read DISPLAY # set it in our local shell
1452	fi
1453	fi
1454
1455	=item How do I compile the manual pages for myself?
1456
1457	You need to have a recent version of perl installed as F</usr/bin/perl>,
1458	one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
1459	the doc subdirectory and enter C<make alldoc>.
1460		1286
1461	=back	1287	=back
1462		1288
1463	=head1 ENVIRONMENT
1464
1465	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>
1466	and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X
1467	window id number of the B<@@RXVT_NAME@@> window and it also uses and
1468	sets the environment variable B<DISPLAY> to specify which display
1469	terminal to use. B<@@RXVT_NAME@@> uses the environment variables
1470	B<RXVTPATH> and B<PATH> to find XPM files.
1471
1472	=head1 FILES	1289	=head1 FILES
1473		1290
1474	=over 4	1291	=over 4
1475		1292
1476	=item B</etc/utmp>
1477
1478	System file for login records.
1479
1480	=item B</usr/lib/X11/rgb.txt>	1293	=item B</usr/lib/X11/rgb.txt>
1481		1294
1482	Color names.	1295	Color names.
1483		1296
1484	=back	1297	=back
1485		1298
1486	=head1 SEE ALSO	1299	=head1 SEE ALSO
1487		1300
1488	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1301	@@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)
1489
1490	=head1 BUGS
1491
1492	Check the BUGS file for an up-to-date list.
1493
1494	Cursor change support is not yet implemented.
1495
1496	Click-and-drag doesn't work with X11 mouse report overriding.
1497		1302
1498	=head1 CURRENT PROJECT COORDINATOR	1303	=head1 CURRENT PROJECT COORDINATOR
1499		1304
1500	=over 4	1305	=over 4
1501		1306
1502	=item Project Coordinator	1307	=item Project Coordinator
1503		1308
1504	@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@>	1309	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1505		1310
1506	=item Web page maintainter	1311	L<http://software.schmorp.de/#rxvt-unicode>
1507
1508	@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1509
1510	L<@@RXVT_WEBPAGE@@>
1511		1312
1512	=back	1313	=back
1513		1314
1514	=head1 AUTHORS	1315	=head1 AUTHORS
1515		1316
…		…
1540	=item Geoff Wing L<< <gcw@pobox.com> >>	1341	=item Geoff Wing L<< <gcw@pobox.com> >>
1541		1342
1542	Rewrote screen display and text selection routines. Project Coordinator	1343	Rewrote screen display and text selection routines. Project Coordinator
1543	(changes.txt 2.4.6 - rxvt-unicode)	1344	(changes.txt 2.4.6 - rxvt-unicode)
1544		1345
1545	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>	1346	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1546		1347
1547	Forked rxvt-unicode, rewrote most of the display code and internal	1348	Forked rxvt-unicode, rewrote most of the display code and internal
1548	character handling to store text in unicode, improve xterm	1349	character handling to store text in unicode, improve xterm
1549	compatibility and apply numerous other bugfixes and extensions.	1350	compatibility and apply numerous other bugfixes and extensions.
1550		1351

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.22 by root, Tue Aug 24 15:46:27 2004 UTC vs. Revision 1.73 by root, Thu Dec 15 18:14:08 2005 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.22 by root, Tue Aug 24 15:46:27 2004 UTC vs.
Revision 1.73 by root, Thu Dec 15 18:14:08 2005 UTC