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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.12 by root, Mon Aug 16 02:09:28 2004 UTC vs.
Revision 1.58 by root, Wed Feb 16 21:49:36 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
…		…
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. resource B<fading>.
112		118
113	=item B<-tint> I<colour>	119	=item B<-tint> I<colour>
114		120
115	Tint the transparent background pixmap with the given colour when	121	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>	122	transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>
…		…
119		125
120	=item B<-sh>	126	=item B<-sh>
121		127
122	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	128	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	129	background image in addition to tinting it (i.e. B<-tint> must be
124	specified, too).	130	specified, too, e.g. C<-tint white>).
125		131
126	=item B<-bg> I<colour>	132	=item B<-bg> I<colour>
127		133
128	Window background colour; resource B<background>.	134	Window background colour; resource B<background>.
129		135
…		…
132	Window foreground colour; resource B<foreground>.	138	Window foreground colour; resource B<foreground>.
133		139
134	=item B<-pixmap> I<file[;geom]>	140	=item B<-pixmap> I<file[;geom]>
135		141
136	Compile I<XPM>: Specify XPM file for the background and also optionally	142	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	143	specify its scaling with a geometry string. Note you may need to
138	quotes to avoid special shell interpretation of the `;' in the	144	add quotes to avoid special shell interpretation of the C<;> in the
139	command-line; resource B<backgroundPixmap>.	145	command-line; resource B<backgroundPixmap>.
140		146
141	=item B<-cr> I<colour>	147	=item B<-cr> I<colour>
142		148
143	The cursor colour; resource B<cursorColor>.	149	The cursor colour; resource B<cursorColor>.
…		…
150		156
151	The mouse pointer background colour; resource B<pointerColor2>.	157	The mouse pointer background colour; resource B<pointerColor2>.
152		158
153	=item B<-bd> I<colour>	159	=item B<-bd> I<colour>
154		160
155	The colour of the border between the xterm scrollbar and the text;	161	The colour of the border around the text area and between the scrollbar and the text;
156	resource B<borderColor>.	162	resource B<borderColor>.
157		163
158	=item B<-fn> I<fontname>	164	=item B<-fn> I<fontlist>
159		165
160	Select the fonts to be used. This is a comma seperated list of font	166	Select the fonts to be used. This is a comma separated list of font names
161	names that are used in turn when trying to display Unicode characters.	167	that are used in turn when trying to display Unicode characters. The
162	The first font defines the cell size for characters; other fonts might	168	first font defines the cell size for characters; other fonts might be
163	be smaller, but not larger. A reasonable default font list is always	169	smaller, but not (in general) larger. A (hopefully) reasonable default
164	appended to it. resource B<font>.	170	font list is always appended to it. See resource B<font> for more details.
		171
		172	In short, to specify an X11 core font, just specify it's name or prefix it
		173	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
		174	e.g.:
		175
		176	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
		177	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
165		178
166	See also the question "How does rxvt-unicode choose fonts?" in the FAQ	179	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
167	section.	180	section of @@RXVT_NAME@@(7).
168		181
169	=item B<-rb>\|B<+rb>	182	=item B<-fb> I<fontlist>
170		183
171	Enable "real bold" support. When this option is on, bold text will be	184	Compile font-styles: The bold font list to use when bold characters are to
172	displayed using the first available bold font in the font list. Bold	185	be printed. See resource B<boldFont> for details.
173	fonts should thus be specified in the font list after their	186
174	corresponding regular fonts. If no bold font can be found, a regular	187	=item B<-fi> I<fontlist>
175	font will be used. resource B<realBold>.	188
		189	Compile font-styles: The italic font list to use when bold characters are to
		190	be printed. See resource B<italicFont> for details.
		191
		192	=item B<-fbi> I<fontlist>
		193
		194	Compile font-styles: The bold italic font list to use when bold characters are to
		195	be printed. See resource B<boldItalicFont> for details.
176		196
177	=item B<-name> I<name>	197	=item B<-name> I<name>
178		198
179	Specify the application name under which resources are to be obtained,	199	Specify the application name under which resources are to be obtained,
180	rather than the default executable file name. Name should not contain	200	rather than the default executable file name. Name should not contain
…		…
221	=item B<-st>\|B<+st>	241	=item B<-st>\|B<+st>
222		242
223	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	243	Display normal (non XTerm/NeXT) scrollbar without/with a trough;
224	resource B<scrollBar_floating>.	244	resource B<scrollBar_floating>.
225		245
		246	=item B<-ptab>\|B<+ptab>
		247
		248	If enabled (default), "Horizontal Tab" characters are being stored as
		249	actual wide characters in the screen buffer, which makes it possible to
		250	select and paste them. Since a horizontal tab is a cursor movement and
		251	not an actual glyph, this can sometimes be visually annoying as the cursor
		252	on a tab character is displayed as a wide cursor; resource B<pastableTabs>.
		253
226	=item B<-bc>\|B<+bc>	254	=item B<-bc>\|B<+bc>
227		255
228	Blink the cursor; resource B<cursorBlink>.	256	Blink the cursor; resource B<cursorBlink>.
229		257
230	=item B<-iconic>	258	=item B<-iconic>
…		…
254	if honoured by the WM, the rxvt-unicode window will not have window	282	if honoured by the WM, the rxvt-unicode window will not have window
255	decorations; resource B<borderLess>.	283	decorations; resource B<borderLess>.
256		284
257	=item B<-lsp> I<number>	285	=item B<-lsp> I<number>
258		286
259	Compile I<linespace>: Lines (pixel height) to insert between each row	287	Compile I<frills>: Lines (pixel height) to insert between each row of
260	of the display; resource B<linespace>.	288	the display. Useful to work around font rendering problems; resource
		289	B<linespace>.
261		290
262	=item B<-tn> I<termname>	291	=item B<-tn> I<termname>
263		292
264	This option specifies the name of the terminal type to be set in the	293	This option specifies the name of the terminal type to be set in the
265	B<TERM> environment variable. This terminal type must exist in the	294	B<TERM> environment variable. This terminal type must exist in the
…		…
301		330
302	Compile I<XIM>: input method name. resource B<inputMethod>.	331	Compile I<XIM>: input method name. resource B<inputMethod>.
303		332
304	=item B<-imlocale> I<string>	333	=item B<-imlocale> I<string>
305		334
306	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	335	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
307	de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input	336	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
308	extension to be able to input japanese characters while staying in	337	input extension to be able to input japanese characters while staying in
309	another locale.	338	another locale. resource B<imLocale>.
		339
		340	=item B<-imfont> I<fontset>
		341
		342	Set the font set to use for the X Input Method, see resource B<imFont>
		343	for more info.
		344
		345	=item B<-tcw>
		346
		347	Change the meaning of triple-click selection with the left mouse
		348	button. Instead of selecting a full line it will extend the selection the
		349	end of the logical line only. resource B<tripleclickwords>.
310		350
311	=item B<-insecure>	351	=item B<-insecure>
312		352
313	Enable "insecure" mode, which currently enables most of the escape	353	Enable "insecure" mode, which currently enables most of the escape
314	sequences that echo strings. See the resource B<insecure> for more	354	sequences that echo strings. See the resource B<insecure> for more
…		…
328	=item B<-ssr>\|B<+ssr>	368	=item B<-ssr>\|B<+ssr>
329		369
330	Turn on/off secondary screen scroll (default enabled); resource	370	Turn on/off secondary screen scroll (default enabled); resource
331	B<secondaryScroll>.	371	B<secondaryScroll>.
332		372
333	=item B<-xrm> I<resourcestring>	373	=item B<-keysym.>I<sym>: I<string>
334		374
335	No effect on rxvt-unicode. Simply passes through an argument to be made	375	Remap a key symbol. See resource B<keysym>.
336	available in the instance's argument list. Appears in I<WM_COMMAND> in	376
337	some window managers.	377	=item B<-embed>: I<windowid>
		378
		379	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
		380	which enables applications to easily embed a terminal.
		381
		382	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
		383	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
		384	quite a bit, so don't expect it to keep some specific state. It's best to
		385	create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
		386
		387	The window will not be destroyed when @@RXVT_NAME@@ exits.
		388
		389	It might be useful to know that @@RXVT_NAME@@ will not close file
		390	descriptors passed to it (except for stdin/out/err, of course), so you
		391	can use file descriptors to communicate with the programs within the
		392	terminal. This works regardless of wether the C<-embed> option was used or
		393	not.
338		394
339	=back	395	=back
340		396
341	=head1 RESOURCES (available also as long-options)	397	=head1 RESOURCES (available also as long-options)
342		398
…		…
345		401
346	There are two different methods that @@RXVT_NAME@@ can use to get the	402	There are two different methods that @@RXVT_NAME@@ can use to get the
347	Xresource data: using the X libraries (Xrm*-functions) or internal	403	Xresource data: using the X libraries (Xrm*-functions) or internal
348	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	404	Xresources reader (B<~/.Xdefaults>). For the first method (ie.
349	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	405	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the
350	resources using X11 tools like B<xset>. Many distribution do also load	406	resources using X11 tools like B<xrdb>. Many distribution do also load
351	settings from the B<~/.Xresources> file when X starts.	407	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
		408	will consult the following files/resources in order, with later settings
		409	overwriting earlier ones:
		410
		411	1. system-wide app-defaults file, either locale-dependent OR global
		412	2. app-defaults file in $XAPPLRESDIR
		413	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
		414	4. SCREEN_RESOURCES for the current screen
		415	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
352		416
353	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>	417	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
354	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults	418	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
355	set in XAPPLOADDIR/URxvt (compile-time defined: usually	419	set in XAPPLOADDIR/URxvt (compile-time defined: usually
356	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	420	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
…		…
389	high-intensity (bold = bright foreground, blink = bright background)	453	high-intensity (bold = bright foreground, blink = bright background)
390	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	454	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
391	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	455	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
392	names used are listed in the B<COLORS AND GRAPHICS> section.	456	names used are listed in the B<COLORS AND GRAPHICS> section.
393		457
		458	Colours higher than 15 cannot be set using resources (yet), but can be
		459	changed using an escape command (see @@RXVT_NAME@@(7)).
		460
		461	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
		462	88 colour support). Colours 80-87 are evenly spaces grey steps.
		463
394	=item B<colorBD:> I<colour>	464	=item B<colorBD:> I<colour>
395		465
		466	=item B<colorIT:> I<colour>
		467
396	Use the specified colour to display bold characters when the foreground	468	Use the specified colour to display bold or italic characters when the
397	colour is the default. This option will be ignored if B<realBold> is	469	foreground colour is the default. If font styles are not available
398	enabled.	470	(Compile I<styles>) and this option is unset, reverse video is used instead.
399		471
400	=item B<colorUL:> I<colour>	472	=item B<colorUL:> I<colour>
401		473
402	Use the specified colour to display underlined characters when the	474	Use the specified colour to display underlined characters when the
403	foreground colour is the default.	475	foreground colour is the default.
404		476
405	=item B<colorRV:> I<colour>	477	=item B<colorRV:> I<colour>
406		478
407	Use the specified colour as the background for reverse video	479	Use the specified colour as the background for reverse video
408	characters.	480	characters.
		481
		482	=item B<underlineColor:> I<colour>
		483
		484	If set, use the specified colour as the colour for the underline
		485	itself. If unset, use the foreground colour.
409		486
410	=item B<cursorColor:> I<colour>	487	=item B<cursorColor:> I<colour>
411		488
412	Use the specified colour for the cursor. The default is to use the	489	Use the specified colour for the cursor. The default is to use the
413	foreground colour; option B<-cr>.	490	foreground colour; option B<-cr>.
…		…
447	=item B<shading:> I<number>	524	=item B<shading:> I<number>
448		525
449	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	526	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
450	image in addition to tinting it.	527	image in addition to tinting it.
451		528
452	=item B<fading:> I<number>
453
454	Scale the tint colour by the given percentage.
455
456	=item B<scrollColor:> I<colour>	529	=item B<scrollColor:> I<colour>
457		530
458	Use the specified colour for the scrollbar [default #B2B2B2].	531	Use the specified colour for the scrollbar [default #B2B2B2].
459		532
460	=item B<troughColor:> I<colour>	533	=item B<troughColor:> I<colour>
461		534
462	Use the specified colour for the scrollbar's trough area [default	535	Use the specified colour for the scrollbar's trough area [default
463	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	536	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.
		537
		538	=item B<borderColor:> I<colour>
		539
		540	The colour of the border around the text area and between the scrollbar
		541	and the text.
464		542
465	=item B<backgroundPixmap:> I<file[;geom]>	543	=item B<backgroundPixmap:> I<file[;geom]>
466		544
467	Use the specified XPM file (note the `.xpm' extension is optional) for	545	Use the specified XPM file (note the `.xpm' extension is optional) for
468	the background and also optionally specify its scaling with a geometry	546	the background and also optionally specify its scaling with a geometry
…		…
484		562
485	Specify the colon-delimited search path for finding files (XPM and	563	Specify the colon-delimited search path for finding files (XPM and
486	menus), in addition to the paths specified by the B<RXVTPATH> and	564	menus), in addition to the paths specified by the B<RXVTPATH> and
487	B<PATH> environment variables.	565	B<PATH> environment variables.
488		566
489	=item B<font:> I<fontname>	567	=item B<font:> I<fontlist>
490		568
491	Select the fonts to be used. This is a comma seperated list of font	569	Select the fonts to be used. This is a comma separated list of font
492	names that are used in turn when trying to display Unicode characters.	570	names that are used in turn when trying to display Unicode characters.
493	The first font defines the cell size for characters; other fonts might	571	The first font defines the cell size for characters; other fonts might
494	be smaller, but not larger. A reasonable default font list is always	572	be smaller, but not larger. A reasonable default font list is always
495	appended to it. option B<-fn>.	573	appended to it. option B<-fn>.
496		574
497	=item B<realBold:> I<boolean>	575	Each font can either be a standard X11 core font (XLFD) name, with
		576	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
498		577
499	B<True>: Enable "real bold" support. When this option is on, bold text	578	In addition, each font can be prefixed with additional hints and
500	will be displayed using the first available bold font in the font list.	579	specifications enclosed in square brackets (C<[]>). The only available
501	Bold fonts should thus be specified in the font list after their	580	hint currently is C<codeset=codeset-name>, and this is only used for Xft
502	corresponding regular fonts. If no bold font can be found, a regular	581	fonts.
503	font will be used. option B<-rb>. B<False>: Display bold text in a	582
504	regular font, using the color specified with B<colorBD>; option B<+rb>.	583	For example, this font resource
		584
		585	URxvt*font: 9x15bold,\
		586	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
		587	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
		588	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
		589	xft:Code2000:antialias=false
		590
		591	specifies five fonts to be used. The first one is C<9x15bold> (actually
		592	the iso8859-1 version of the second font), which is the base font (because
		593	it is named first) and thus defines the character cell grid to be 9 pixels
		594	wide and 15 pixels high.
		595
		596	The second font is just used to add additional unicode characters not in
		597	the base font, likewise the third, which is unfortunately non-bold, but
		598	the bold version of the font does contain less characters, so this is a
		599	useful supplement.
		600
		601	The third font is an Xft font with aliasing turned off, and the characters
		602	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
		603	contains other characters, but we are not interested in them.
		604
		605	The last font is a useful catch-all font that supplies most of the
		606	remaining unicode characters.
		607
		608	=item B<boldFont:> I<fontlist>
		609
		610	=item B<italicFont:> I<fontlist>
		611
		612	=item B<boldItalicFont:> I<fontlist>
		613
		614	The font list to use for displaying B<bold>, I<italic> or B<< I<bold
		615	italic> >> characters, respectively.
		616
		617	If specified and non-empty, then the syntax is the same as for the
		618	B<font>-resource, and the given font list will be used as is, which makes
		619	it possible to substitute completely different font styles for bold and
		620	italic.
		621
		622	If unset (the default), a suitable font list will be synthesized by
		623	"morphing" the normal text font list into the desired shape. If that is
		624	not possible, replacement fonts of the desired shape will be tried.
		625
		626	If set, but empty, then this specific style is disabled and the normal
		627	text font will being used for the given style.
505		628
506	=item B<selectstyle:> I<mode>	629	=item B<selectstyle:> I<mode>
507		630
508	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	631	Set mouse selection style to B<old> which is 2.20, B<oldword> which is
509	xterm style with 2.20 old word selection, or anything else which gives	632	xterm style with 2.20 old word selection, or anything else which gives
…		…
580	B<False>: do not scroll to bottom when tty receives output; option	703	B<False>: do not scroll to bottom when tty receives output; option
581	B<+si>.	704	B<+si>.
582		705
583	=item B<scrollWithBuffer:> I<boolean>	706	=item B<scrollWithBuffer:> I<boolean>
584		707
585	B<True>: scroll with scrollback buffer when tty recieves new lines (and	708	B<True>: scroll with scrollback buffer when tty receives new lines (and
586	B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll	709	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
587	with scrollback buffer when tty recieves new lines; option B<-sw>.	710	with scrollback buffer when tty recieves new lines; option B<+sw>.
588		711
589	=item B<scrollTtyKeypress:> I<boolean>	712	=item B<scrollTtyKeypress:> I<boolean>
590		713
591	B<True>: scroll to bottom when a non-special key is pressed. Special keys	714	B<True>: scroll to bottom when a non-special key is pressed. Special keys
592	are those which are intercepted by rxvt-unicode for special handling and	715	are those which are intercepted by rxvt-unicode for special handling and
…		…
631	=item B<mouseWheelScrollPage:> I<boolean>	754	=item B<mouseWheelScrollPage:> I<boolean>
632		755
633	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel	756	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
634	scrolls five lines [default].	757	scrolls five lines [default].
635		758
		759	=item B<pastableTabs:> I<boolean>
		760
		761	B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
		762	movement only; option C<-ptab>.
		763
636	=item B<cursorBlink:> I<boolean>	764	=item B<cursorBlink:> I<boolean>
637		765
638	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	766	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
639	option B<-bc>.	767	option B<-bc>.
640		768
…		…
684		812
685	I<name> of inputMethod to use; option B<-im>.	813	I<name> of inputMethod to use; option B<-im>.
686		814
687	=item B<imLocale:> I<name>	815	=item B<imLocale:> I<name>
688		816
689	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	817	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
690	de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input	818	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
691	extension to be able to input japanese characters while staying in	819	input extension to be able to input japanese characters while staying in
692	another locale. option B<-imlocale>.	820	another locale. option B<-imlocale>.
693		821
694	=item B<insecure>	822	=item B<imFont:> I<fontset>
		823
		824	Specify the font-set used for XIM styles C<OverTheSpot> or
		825	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
		826	by commas), i.e. it's not in the same format as the other font lists used
		827	in @@RXVT_NAME@@. The default will be set-up to chose any suitable found
		828	found, preferably one or two pixels differing in size to the base font.
		829	option B<-imfont>.
		830
		831	=item B<tripleclickwords:> I<boolean>
		832
		833	Change the meaning of triple-click selection with the left mouse
		834	button. Instead of selecting a full line it will extend the selection to
		835	the end of the logical line only. option B<-tcw>.
		836
		837	=item B<insecure:> I<boolean>
695		838
696	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	839	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
697	echo arbitrary strings like the icon name or the locale. This could be	840	echo arbitrary strings like the icon name or the locale. This could be
698	abused if somebody gets 8-bit-clean access to your display, wether	841	abused if somebody gets 8-bit-clean access to your display, whether
699	throuh a mail client displaying mail bodies unfiltered or though	842	throuh a mail client displaying mail bodies unfiltered or though
700	write(1). Therefore, these sequences are disabled by default. (Note	843	write(1). Therefore, these sequences are disabled by default. (Note
701	that other terminals, including xterm, have these sequences	844	that other terminals, including xterm, have these sequences
702	enabled by default). You can enable them by setting this boolean	845	enabled by default). You can enable them by setting this boolean
703	resource or specifying B<-insecure> as an option. At the moment, this	846	resource or specifying B<-insecure> as an option. At the moment, this
…		…
727	scrollback buffer and switching to/from the secondary screen will	870	scrollback buffer and switching to/from the secondary screen will
728	instead scroll the screen up.	871	instead scroll the screen up.
729		872
730	=item B<keysym.>I<sym>: I<string>	873	=item B<keysym.>I<sym>: I<string>
731		874
732	Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may	875	Compile I<frills>: Associate I<string> with keysym I<sym>. The
733	contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:	876	intervening resource name B<keysym.> cannot be omitted.
734	newline, \r: return, \t:	877
		878	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
		879	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
		880	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
		881	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
		882	B<2>, B<3>, B<4>, B<5>.
		883
		884	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
		885	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
		886	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
		887	current application keymap mode state.
		888
		889	The spellings of I<key> can be obtained by using B<xev>(1) command or
		890	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
		891	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
		892	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
		893	performed in an exact manner; however, the closest match is assured.
		894
		895	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
		896	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
735	tab, \000: octal number) or control characters (^?: delete, ^@: null,	897	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
736	^A ...) and may enclosed with double quotes so that it can start or end	898	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
737	with whitespace. The intervening resource name B<keysym.> cannot be	899	can start or end with whitespace.
738	omitted. This resource is only available when compiled with	900
739	KEYSYM_RESOURCE.	901	Please note that you need to double the C<\> when using
		902	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
		903	use C<\033> instead of C<\e> (and so on), which will work with both Xt and
		904	@@RXVT_NAME@@'s own processing).
		905
		906	You can define a range of keysyms in one shot by providing a I<string>
		907	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
		908	should be a character not used by the strings.
		909
		910	Its usage can be demonstrated by an example:
		911
		912	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
		913
		914	The above line is equivalent to the following three lines:
		915
		916	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
		917	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
		918	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
		919
		920	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
		921	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
		922	example the following means "change the current locale to C<zh_CN.GBK>
		923	when Control-Meta-c is being pressed":
		924
		925	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		926
		927	The following example will map Control-Meta-1 and Control-Meta-2 to
		928	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
		929	font-switching at runtime:
		930
		931	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		932	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
		933
		934	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
		935	info):
		936
		937	URxvt.keysym.M-C-3: command:\033[8;25;80t
		938	URxvt.keysym.M-C-4: command:\033[8;48;110t
740		939
741	=back	940	=back
742		941
743	=head1 THE SCROLLBAR	942	=head1 THE SCROLLBAR
744		943
…		…
758	the normal text selection/insertion, hold either the Shift or the Meta	957	the normal text selection/insertion, hold either the Shift or the Meta
759	(Alt) key while performing the desired mouse action.	958	(Alt) key while performing the desired mouse action.
760		959
761	If mouse reporting mode is active, the normal scrollbar actions are	960	If mouse reporting mode is active, the normal scrollbar actions are
762	disabled -- on the assumption that we are using a fullscreen	961	disabled -- on the assumption that we are using a fullscreen
763	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	962	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
764	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	963	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
765	up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down),	964	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
766	respectively.	965	respectively.
767		966
768	=head1 TEXT SELECTION AND INSERTION	967	=head1 TEXT SELECTION AND INSERTION
769		968
770	The behaviour of text selection and insertion mechanism is similar to	969	The behaviour of text selection and insertion mechanism is similar to
…		…
772		971
773	=over 4	972	=over 4
774		973
775	=item B<Selection>:	974	=item B<Selection>:
776		975
777	Left click at the beginning of the region, drag to the end of the	976	Left click at the beginning of the region, drag to the end of the region
778	region and release; Right click to extend the marked region; Left	977	and release; Right click to extend the marked region; Left double-click
779	double-click to select a word; Left triple-click to select the entire	978	to select a word; Left triple-click to select the entire logical line
780	line.	979	(which can span multiple screen lines), unless modified by resource
		980	B<tripleclickwords>.
		981
		982	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
		983	(Compile: I<frills>) will create a rectangular selection instead of a normal
		984	one.
781		985
782	=item B<Insertion>:	986	=item B<Insertion>:
783		987
784	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	988	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
785	an B<@@RXVT_NAME@@> window causes the current text selection to be	989	an B<@@RXVT_NAME@@> window causes the current text selection to be
…		…
807	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1011	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
808	with C<--enable-iso14755>.	1012	with C<--enable-iso14755>.
809		1013
810	=over 4	1014	=over 4
811		1015
812	=item 5.1: Basic method	1016	=item * 5.1: Basic method
813		1017
814	This allows you to enter unicode characters using their hexcode.	1018	This allows you to enter unicode characters using their hexcode.
815		1019
816	Start by pressing and holding both C<Control> and C<Shift>, then enter	1020	Start by pressing and holding both C<Control> and C<Shift>, then enter
817	hex-digits (between one and six). Releasing C<Control> and C<Shift> will	1021	hex-digits (between one and six). Releasing C<Control> and C<Shift> will
…		…
824	address, which you cannot type. Fortunately, the card has the e-mail	1028	address, which you cannot type. Fortunately, the card has the e-mail
825	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily	1029	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
826	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,	1030	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
827	followed by releasing the modifier keys.	1031	followed by releasing the modifier keys.
828		1032
829	=item 5.2: Keyboard symbols entry method	1033	=item * 5.2: Keyboard symbols entry method
830		1034
831	This mode lets you input characters representing the keycap symbols of	1035	This mode lets you input characters representing the keycap symbols of
832	your keyboard, if representable in the current locale encoding.	1036	your keyboard, if representable in the current locale encoding.
833		1037
834	Start by pressing C<Control> and C<Shift> together, then releasing	1038	Start by pressing C<Control> and C<Shift> together, then releasing
835	them. The next special key (cursor keys, home etc.) you enter will not	1039	them. The next special key (cursor keys, home etc.) you enter will not
836	invoke it's usual function but instead will insert the corresponding	1040	invoke it's usual function but instead will insert the corresponding
837	keycap symbol. The symbol will only be entered when the key has been	1041	keycap symbol. The symbol will only be entered when the key has been
838	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1042	released, otherwise pressing e.g. C<Shift> would enter the symbol for
839	C<ISO Level 2 Switch>, although your intention might have beenm to enter a	1043	C<ISO Level 2 Switch>, although your intention might have been to enter a
840	reverse tab (Shift-Tab).	1044	reverse tab (Shift-Tab).
841		1045
842	=item 5.3: Screen-selection entry method	1046	=item * 5.3: Screen-selection entry method
843		1047
844	While this is implemented already (it's basically the selection	1048	While this is implemented already (it's basically the selection
845	mechanism), it could be extended by displaying a unicode character map.	1049	mechanism), it could be extended by displaying a unicode character map.
846		1050
847	=item 5.4: Feedback method for identifying displayed characters for later input	1051	=item * 5.4: Feedback method for identifying displayed characters for later input
848		1052
849	This method lets you display the unicode character code associated with	1053	This method lets you display the unicode character code associated with
850	characters already displayed.	1054	characters already displayed.
851		1055
852	You enter this mode by holding down C<Control> and C<Shift> together, then	1056	You enter this mode by holding down C<Control> and C<Shift> together, then
853	pressing and holding the left mouse button and moving around. The unicode	1057	pressing and holding the left mouse button and moving around. The unicode
854	hex code(s) (it might be a combining character) of the character under the	1058	hex code(s) (it might be a combining character) of the character under the
855	pointer is displayed until you release C<Control> and C<Shift>.	1059	pointer is displayed until you release C<Control> and C<Shift>.
856		1060
		1061	In addition to the hex codes it will display the font used to draw this
		1062	character - due to implementation reasons, characters combined with
		1063	combining characters, line drawing characters and unknown characters will
		1064	always be drawn using the built-in support font.
		1065
857	=back	1066	=back
858		1067
859	With respect to conformance, rxvt-unicode is supposed to be compliant to	1068	With respect to conformance, rxvt-unicode is supposed to be compliant to
860	both scenario A and B of ISO 14755, including part 5.2.	1069	both scenario A and B of ISO 14755, including part 5.2.
861		1070
862	=head1 LOGIN STAMP	1071	=head1 LOGIN STAMP
863		1072
864	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so	1073	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
865	that it can be seen via the I<who(1)> command, and can accept messages.	1074	it can be seen via the I<who(1)> command, and can accept messages. To
866	To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on	1075	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
867	some systems.	1076	on some systems or setgid to root or to some other group on others.
868		1077
869	=head1 COLORS AND GRAPHICS	1078	=head1 COLORS AND GRAPHICS
870		1079
871	In addition to the default foreground and background colours,	1080	In addition to the default foreground and background colours,
872	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1081	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
…		…
913	would yield White on Black, while on I<xterm>(1) it would yield Black	1122	would yield White on Black, while on I<xterm>(1) it would yield Black
914	on White.	1123	on White.
915		1124
916	=back	1125	=back
917		1126
918	=head1 FREQUENTLY ASKED QUESTIONS (FAQ)	1127	=head1 ENVIRONMENT
		1128
		1129	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
919		1130
920	=over 4	1131	=over 4
921		1132
922	=item How do I know which rxvt-unicode version I'm using?	1133	=item B<TERM>
923		1134
924	The version number is displayed with the usage (-h). For rxvt-unicode	1135	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
925	version 2.14 and later, the escape sequence C<ESC[8n> sets the window	1136	resources or on the commandline.
926	title to the version number.
927		1137
928	=item Rxvt-unicode does not seem to understand the selected encoding?	1138	=item B<COLORTERM>
929		1139
930	=item Unicode does not seem to work?	1140	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
		1141	compiled with XPM support, and optionally with the added extension
		1142	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
931		1143
932	If you encounter strange problems like typing an accented character but	1144	=item B<COLORFGBG>
933	getting two unrelated other characters or similar, or if program output is
934	subtly garbled, then you should check your locale settings.
935		1145
936	Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the	1146	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
937	programs. Often rxvt-unicode is started in the C<C> locale, while the	1147	the colour code used as default foreground/text colour (or the string
938	login script running within the rxvt-unicode window changes the locale to	1148	C<default> to indicate that the default-colour escape sequence is to be
939	sth. else, e.h. C<en_GB.UTF-8>. Needless to say, this is not going to work.	1149	used), C<bg> is the colour code used as default background colour (or the
		1150	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1151	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
		1152	(and do) use this information to optimize screen output.
940		1153
941	The best thing is to fix your startup environment, as you will likely run	1154	=item B<WINDOWID>
942	into other problems. If nothing works you can try this in your .profile.
943		1155
944	printf '\e]701;%s\007' "$LC_CTYPE"	1156	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
		1157	window, which usually has subwindows for the scrollbar, the terminal
		1158	window and so on).
945		1159
946	If this doesn't work, then maybe you use a C<LC_CTYPE> specification not	1160	=item B<TERMINFO>
947	supported on your systems. Some systems have a C<locale> comamnd which
948	displays this. If it displays sth. like:
949		1161
950	locale: Cannot set LC_CTYPE to default locale: ...	1162	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1163	C<--with-terminfo=PATH>.
951		1164
952	Then the locale you specified is not supported on your system.	1165	=item B<DISPLAY>
953		1166
954	If nothing works and you are sure that everything is set correctly then	1167	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
955	you will need to remember a little known fact: Some programs just don't	1168	display in it's child processes.
956	support locales :(
957		1169
958	=item Why do the characters look ugly?	1170	=item B<SHELL>
959		1171
960	=item How does rxvt-unicode choose fonts?	1172	The shell to be used for command execution, defaults to C</bin/sh>.
961		1173
962	Most fonts do not contain the full range of Unicode, which is	1174	=item B<RXVTPATH>
963	fine. Chances are that the font you (or the admin/package maintainer of
964	your system/os) have specified does not cover all the characters you want
965	to display.
966		1175
967	B<rxvt-unicode> makes a best-effort try at finding a replacement	1176	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
968	font. Often the result is fine, but sometimes the chosen font looks	1177	files.
969	bad. In that case, select a font of your taste and add it to the font
970	list, e.g.:
971		1178
972	@@RXVT_NAME@@ -fn basefont,font2,font3...	1179	=item B<PATH>
973		1180
974	When rxvt-unicode sees a character, it will first look at the base	1181	Used in the same way as C<RXVTPATH>.
975	font. If the base font does not contain the character, it will go to the
976	next font, and so on.
977		1182
978	The only limitation is that all the fonts must not be larger than the base	1183	=item B<RXVT_SOCKET>
979	font, as the base font defines the principial cell size, which must be the
980	same due to the way terminals work.
981		1184
982	=item Why do some chinese characters look so different than others?	1185	The unix domain socket path used by @@RXVT_NAME@@c(1) and
		1186	@@RXVT_NAME@@d(1).
983		1187
984	This is because there is a difference between script and language --	1188	Default C<< $HOME/.rxvt-unicode-<nodename >>.
985	rxvt-unicode does not know which language the text that is output
986	is, as it only knows the unicode character codes. If rxvt-unicode
987	first sees a japanese character, it might choose a japanese font for
988	it. Subseqzuent japanese characters will take that font. Now, many chinese
989	characters aren't represented in japanese fonts, so when the first
990	non-japanese character comes up, rxvt-unicode will look for a chinese font
991	-- unfortunately at this point, it will still use the japanese font for
992	japanese characters that are also chinese.
993		1189
994	The workaround is easy: just tag a chinese font at the end of your font	1190	=item B<HOME>
995	list (see the previous question). The key is to view the font list as
996	a preference list: If you expect more japanese, list a japanese font
997	first. If you expect more chinese, put a chinese font first.
998		1191
999	In the future it might be possible to switch preferences at runtime (the	1192	Used to locate the default directory for the unix domain socket for
1000	internal data structure has no problem with using different fonts for	1193	daemon communications and to locate various resource files (such as
1001	the same character at the same time, but no interface for this has been	1194	C<.Xdefaults>)
1002	designed yet).
1003		1195
1004	=item How does rxvt-unicode determine the encoding to use?	1196	=item B<XAPPLRESDIR>
1005		1197
1006	=item Is there an option to switch encodings?	1198	Directory where various X resource files are being located.
1007		1199
1008	Unlike some other terminals, rxvt-unicode has no encoding switch, and no	1200	=item B<XENVIRONMENT>
1009	specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
1010	UTF-8 or any other encodings with respect to terminal I/O.
1011		1201
1012	The reasons is that there exists a perfectly fine mechanism for selecting	1202	If set and accessible, gives the name of a X resource file to be loaded by
1013	the encoding, doing I/O and (most important) communicating this to all
1014	applications so everybody agrees on character properties such as width and
1015	code number. This mechanism is the I<locale>.
1016
1017	Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
1018	programs doing the same (that is, most) will automatically agree in the
1019	interpretation of characters.
1020
1021	Unfortunately, there is no system-independent way to select locales, nor
1022	is there a standard on how locale specifiers will look like.
1023
1024	On most systems, the content of the C<LC_CTYPE> environment variable
1025	contains an arbitrary string which corresponds to an already-installed
1026	locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
1027	C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
1028	(i.e. C<de> or C<german>) are also common.
1029
1030	Rxvt-unicode ignores all other locale categories, and except for
1031	the encoding, ignores country or language-specific settings,
1032	i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the same for rxvt-unicode.
1033
1034	If you want to use a specific encoding you have to make sure you start
1035	rxvt-unicode with the correct C<LC_CTYPE> category.
1036
1037	=item Can I switch locales at runtime?
1038
1039	Yes, using an escape sequence. Try sth. like this, which sets
1040	rxvt-unicode's idea of C<LC_CTYPE>.
1041
1042	printf '\e]701;%s\007' ja_JP.SJIS
1043
1044	See also the previous question.
1045
1046	Sometimes this capability is rather handy when you want to work in one
1047	locale (e.g. C<de_DE.UTF-8>) but some programs don't support UTF-8. For
1048	example, I use this script to start C<xjdic>, which first switches to a
1049	locale supported by xjdic and back later:
1050
1051	printf '\e]701;%s\007' ja_JP.SJIS
1052	xjdic -js
1053	printf '\e]701;%s\007' de_DE.UTF-8
1054
1055	=item Can I switch the fonts at runtime?
1056
1057	Yes, using an escape sequence. Try sth. like this, which has the same
1058	effect as using the C<-fn> switch, and takes effect immediately:
1059
1060	printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
1061
1062	This is useful if you e.g. work primarily with japanese (and prefer a
1063	japanese font), but you have to switch to chinese temporarily, where
1064	japanese fonts would only be in your way.
1065
1066	You can think of this as a kind of manual ISO-2022 switching.
1067
1068	=item Mouse cut/paste suddenly no longer works.
1069
1070	Make sure that mouse reporting is actually turned off since killing
1071	some editors prematurely may leave the mouse in mouse report mode. I've
1072	heard that tcsh may use mouse reporting unless it otherwise specified. A
1073	quick check is to see if cut/paste works when the Alt or Shift keys are
1074	depressed. See @@RXVT_NAME@@(7)
1075
1076	=item What's with this bold/blink stuff?
1077
1078	If no bold colour is set via C<colorBD:>, bold will invert text using the
1079	standard foreground colour.
1080
1081	For the standard background colour, blinking will actually make the
1082	text blink when compiled with C<--enable-blinking>. with standard
1083	colours. Without C<--enable-blinking>, the blink attribute will be
1084	ignored.
1085
1086	On ANSI colours, bold/blink attributes are used to set high-intensity
1087	foreground/background colors.
1088
1089	color0-7 are the low-intensity colors.
1090
1091	color8-15 are the corresponding high-intensity colors.
1092
1093	=item I don't like the screen colors. How do I change them?
1094
1095	You can change the screen colors at run-time using F<~/.Xdefaults>
1096	resources (or as long-options).
1097
1098	Here are values that are supposed to resemble a VGA screen,
1099	including the murky brown that passes for low-intensity yellow:
1100
1101	Rxvt*color0: #000000
1102	Rxvt*color1: #A80000
1103	Rxvt*color2: #00A800
1104	Rxvt*color3: #A8A800
1105	Rxvt*color4: #0000A8
1106	Rxvt*color5: #A800A8
1107	Rxvt*color6: #00A8A8
1108	Rxvt*color7: #A8A8A8
1109
1110	Rxvt*color8: #000054
1111	Rxvt*color9: #FF0054
1112	Rxvt*color10: #00FF54
1113	Rxvt*color11: #FFFF54
1114	Rxvt*color12: #0000FF
1115	Rxvt*color13: #FF00FF
1116	Rxvt*color14: #00FFFF
1117	Rxvt*color15: #FFFFFF
1118
1119	=item What's with the strange Backspace/Delete key behaviour?
1120
1121	Assuming that the physical Backspace key corresponds to the
1122	BackSpace keysym (not likely for Linux ... see the following
1123	question) there are two standard values that can be used for
1124	Backspace: C<^H> and C<^?>.
1125
1126	Historically, either value is correct, but rxvt-unicode adopts the debian
1127	policy of using C<^?> when unsure, because it's the one only only correct
1128	choice :).
1129
1130	Rxvt-unicode tries to inherit the current stty settings and uses the value
1131	of `erase' to guess the value for backspace. If rxvt-unicode wasn't
1132	started from a terminal (say, from a menu or by remote shell), then the
1133	system value of `erase', which corresponds to CERASE in <termios.h>, will
1134	be used (which may not be the same as your stty setting).
1135
1136	For starting a new rxvt-unicode:
1137
1138	# use Backspace = ^H
1139	$ stty erase ^H
1140	$ @@RXVT_NAME@@	1203	@@RXVT_NAME@@.
1141
1142	# use Backspace = ^?
1143	$ stty erase ^?
1144	$ @@RXVT_NAME@@
1145
1146	Toggle with "ESC[36h" / "ESC[36l" as documented in @@RXVT_NAME@@(7).
1147
1148	For an existing rxvt-unicode:
1149
1150	# use Backspace = ^H
1151	$ stty erase ^H
1152	$ echo -n "^[[36h"
1153
1154	# use Backspace = ^?
1155	$ stty erase ^?
1156	$ echo -n "^[[36l"
1157
1158	This helps satisfy some of the Backspace discrepancies that occur, but
1159	if you use Backspace = C<^H>, make sure that the termcap/terminfo value
1160	properly reflects that.
1161
1162	The Delete key is a another casualty of the ill-defined Backspace problem.
1163	To avoid confusion between the Backspace and Delete keys, the Delete
1164	key has been assigned an escape sequence to match the vt100 for Execute
1165	(ESC[3~) and is in the supplied termcap/terminfo.
1166
1167	Some other Backspace problems:
1168
1169	some editors use termcap/terminfo,
1170	some editors (vim I'm told) expect Backspace = ^H,
1171	GNU Emacs (and Emacs-like editors) use ^H for help.
1172
1173	Perhaps someday this will all be resolved in a consistent manner.
1174
1175	=item I don't like the key-bindings. How do I change them?
1176
1177	There are some compile-time selections available via configure. Unless
1178	you have run "configure" with the C<--disable-resources> option you can
1179	use the `keysym' resource to alter the keystrings associated with keysym
1180	0xFF00 - 0xFFFF (function, cursor keys, etc).
1181
1182	Here's an example for a tn3270 session started using `@@RXVT_NAME@@ -name tn3270'
1183
1184	!# ----- special uses ------:
1185	! tn3270 login, remap function and arrow keys.
1186	tn3270font: clean-bold----15-*
1187
1188	! keysym - used by rxvt only
1189	! Delete - ^D
1190	tn3270*keysym.0xFFFF: \004
1191
1192	! Home - ^A
1193	tn3270*keysym.0xFF50: \001
1194	! Left - ^B
1195	tn3270*keysym.0xFF51: \002
1196	! Up - ^P
1197	tn3270*keysym.0xFF52: \020
1198	! Right - ^F
1199	tn3270*keysym.0xFF53: \006
1200	! Down - ^N
1201	tn3270*keysym.0xFF54: \016
1202	! End - ^E
1203	tn3270*keysym.0xFF57: \005
1204
1205	! F1 - F12
1206	tn3270*keysym.0xFFBE: \e1
1207	tn3270*keysym.0xFFBF: \e2
1208	tn3270*keysym.0xFFC0: \e3
1209	tn3270*keysym.0xFFC1: \e4
1210	tn3270*keysym.0xFFC2: \e5
1211	tn3270*keysym.0xFFC3: \e6
1212	tn3270*keysym.0xFFC4: \e7
1213	tn3270*keysym.0xFFC5: \e8
1214	tn3270*keysym.0xFFC6: \e9
1215	tn3270*keysym.0xFFC7: \e0
1216	tn3270*keysym.0xFFC8: \e-
1217	tn3270*keysym.0xFFC9: \e=
1218
1219	! map Prior/Next to F7/F8
1220	tn3270*keysym.0xFF55: \e7
1221	tn3270*keysym.0xFF56: \e8
1222
1223	=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
1224	How do I make use of them? For example, the Sun Keyboard type 4
1225	has the following mappings that rxvt-unicode doesn't recognize.
1226
1227	KP_Insert == Insert
1228	F22 == Print
1229	F27 == Home
1230	F29 == Prior
1231	F33 == End
1232	F35 == Next
1233
1234	Rather than have rxvt-unicode try to accomodate all the various possible keyboard
1235	mappings, it is better to use `xmodmap' to remap the keys as required for
1236	your particular machine.
1237
1238	=item How do I distinguish if I'm running rxvt-unicode or a regular xterm?
1239	I need this to decide about setting colors etc.
1240
1241	rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
1242	check and see if that is set. Note that several programs, JED, slrn,
1243	Midnight Commander automatically check this variable to decide whether or
1244	not to use color.
1245
1246	=item How do I set the correct, full IP address for the DISPLAY variable?
1247
1248	If you've compiled rxvt-unicode with DISPLAY_IS_IP and ahve enabled
1249	insecure mode then it is possible to use the following shell script
1250	snippets to correctly set the display. If your version of rxvt-unicode
1251	wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
1252	the COLORTERM variable can be used to distinguish rxvt-unicode from a
1253	regular xterm.
1254
1255	Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
1256	snippets:
1257
1258	# Bourne/Korn/POSIX family of shells:
1259	[ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
1260	if [ ${TERM:-foo} = xterm ]; then
1261	stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
1262	echo -n '^[Z'
1263	read term_id
1264	stty icanon echo
1265	if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
1266	echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
1267	read DISPLAY # set it in our local shell
1268	fi
1269	fi
1270
1271	=item How do I compile the manual pages for myself?
1272
1273	You need to have a recent version of perl installed as F</usr/bin/perl>,
1274	one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
1275	the doc subdirectory and enter C<make alldoc>.
1276		1204
1277	=back	1205	=back
1278		1206
1279	=head1 ENVIRONMENT
1280
1281	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>
1282	and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X
1283	window id number of the B<@@RXVT_NAME@@> window and it also uses and
1284	sets the environment variable B<DISPLAY> to specify which display
1285	terminal to use. B<@@RXVT_NAME@@> uses the environment variables
1286	B<RXVTPATH> and B<PATH> to find XPM files.
1287
1288	=head1 FILES	1207	=head1 FILES
1289		1208
1290	=over 4	1209	=over 4
1291		1210
1292	=item B</etc/utmp>
1293
1294	System file for login records.
1295
1296	=item B</usr/lib/X11/rgb.txt>	1211	=item B</usr/lib/X11/rgb.txt>
1297		1212
1298	Color names.	1213	Color names.
1299		1214
1300	=back	1215	=back
…		…
1315		1230
1316	=over 4	1231	=over 4
1317		1232
1318	=item Project Coordinator	1233	=item Project Coordinator
1319		1234
1320	@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@>	1235	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1321		1236
1322	=item Web page maintainter	1237	L<http://software.schmorp.de/#rxvt-unicode>
1323
1324	@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1325
1326	L<@@RXVT_WEBPAGE@@>
1327		1238
1328	=back	1239	=back
1329		1240
1330	=head1 AUTHORS	1241	=head1 AUTHORS
1331		1242
…		…
1356	=item Geoff Wing L<< <gcw@pobox.com> >>	1267	=item Geoff Wing L<< <gcw@pobox.com> >>
1357		1268
1358	Rewrote screen display and text selection routines. Project Coordinator	1269	Rewrote screen display and text selection routines. Project Coordinator
1359	(changes.txt 2.4.6 - rxvt-unicode)	1270	(changes.txt 2.4.6 - rxvt-unicode)
1360		1271
1361	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>	1272	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1362		1273
1363	Forked rxvt-unicode, rewrote most of the display code and internal	1274	Forked rxvt-unicode, rewrote most of the display code and internal
1364	character handling to store text in unicode, improve xterm	1275	character handling to store text in unicode, improve xterm
1365	compatibility and apply numerous other bugfixes and extensions.	1276	compatibility and apply numerous other bugfixes and extensions.
1366		1277

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.12 by root, Mon Aug 16 02:09:28 2004 UTC vs. Revision 1.58 by root, Wed Feb 16 21:49:36 2005 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.12 by root, Mon Aug 16 02:09:28 2004 UTC vs.
Revision 1.58 by root, Wed Feb 16 21:49:36 2005 UTC