[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.43 by root, Sun Jan 16 19:22:16 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 frequently
		20	asked questions and answer to them and some common problems.
16		21
17	=head1 RXVT-UNICODE VS. RXVT	22	=head1 RXVT-UNICODE VS. RXVT
18		23
19	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode	24	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	25	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	29	like tibetan or devenagari. Don't expect pretty output when using these
25	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	30	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
26	fine, though. A somewhat difficult case are left-to-right scripts, such	31	fine, though. A somewhat difficult case are left-to-right scripts, such
27	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	32	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
28	belong into the application, not the terminal emulator (too many things --	33	belong into the application, not the terminal emulator (too many things --
29	such as cursor-movement while editing -- break othwerwise), but that might	34	such as cursor-movement while editing -- break otherwise), but that might
30	change.	35	change.
31		36
32	If you are looking for a terminal that supports more exotic scripts, let	37	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	38	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	39	terminal emulator. In fact, the reason rxvt-unicode was born was solely
…		…
53	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and	58	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
54	@@RXVT_NAME@@c(1) (client).	59	@@RXVT_NAME@@c(1) (client).
55		60
56	It also makes technical information about escape sequences (which have	61	It also makes technical information about escape sequences (which have
57	been extended) easier accessible: see @@RXVT_NAME@@(7) for technical	62	been extended) easier accessible: see @@RXVT_NAME@@(7) for technical
58	reference documentation (escape sequences etc.) and the FAQ section at the	63	reference documentation (escape sequences etc.).
59	end of this document.
60		64
61	=head1 OPTIONS	65	=head1 OPTIONS
62		66
63	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed	67	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	68	below. In keeping with the smaller-is-better philosophy, options may be
…		…
106	Turn on/off inheriting parent window's pixmap. Alternative form is	110	Turn on/off inheriting parent window's pixmap. Alternative form is
107	B<-tr>; resource B<inheritPixmap>.	111	B<-tr>; resource B<inheritPixmap>.
108		112
109	=item B<-fade> I<number>	113	=item B<-fade> I<number>
110		114
111	Fade the text by the given percentage when focus is lost.	115	Fade the text by the given percentage when focus is lost. resource B<fading>.
112		116
113	=item B<-tint> I<colour>	117	=item B<-tint> I<colour>
114		118
115	Tint the transparent background pixmap with the given colour when	119	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>	120	transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>
…		…
119		123
120	=item B<-sh>	124	=item B<-sh>
121		125
122	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	126	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	127	background image in addition to tinting it (i.e. B<-tint> must be
124	specified, too).	128	specified, too, e.g. C<-tint white>).
125		129
126	=item B<-bg> I<colour>	130	=item B<-bg> I<colour>
127		131
128	Window background colour; resource B<background>.	132	Window background colour; resource B<background>.
129		133
…		…
132	Window foreground colour; resource B<foreground>.	136	Window foreground colour; resource B<foreground>.
133		137
134	=item B<-pixmap> I<file[;geom]>	138	=item B<-pixmap> I<file[;geom]>
135		139
136	Compile I<XPM>: Specify XPM file for the background and also optionally	140	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	141	specify its scaling with a geometry string. Note you may need to
138	quotes to avoid special shell interpretation of the `;' in the	142	add quotes to avoid special shell interpretation of the C<;> in the
139	command-line; resource B<backgroundPixmap>.	143	command-line; resource B<backgroundPixmap>.
140		144
141	=item B<-cr> I<colour>	145	=item B<-cr> I<colour>
142		146
143	The cursor colour; resource B<cursorColor>.	147	The cursor colour; resource B<cursorColor>.
…		…
150		154
151	The mouse pointer background colour; resource B<pointerColor2>.	155	The mouse pointer background colour; resource B<pointerColor2>.
152		156
153	=item B<-bd> I<colour>	157	=item B<-bd> I<colour>
154		158
155	The colour of the border between the xterm scrollbar and the text;	159	The colour of the border around the text area and between the scrollbar and the text;
156	resource B<borderColor>.	160	resource B<borderColor>.
157		161
158	=item B<-fn> I<fontname>	162	=item B<-fn> I<fontlist>
159		163
160	Select the fonts to be used. This is a comma seperated list of font	164	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.	165	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	166	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	167	smaller, but not (in general) larger. A (hopefully) reasonable default
164	appended to it. resource B<font>.	168	font list is always appended to it. See resource B<font> for more details.
		169
		170	In short, to specify an X11 core font, just specify it's name or prefix it
		171	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
		172	e.g.:
		173
		174	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
		175	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
165		176
166	See also the question "How does rxvt-unicode choose fonts?" in the FAQ	177	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
167	section.	178	section of @@RXVT_NAME@@(7).
168		179
169	=item B<-rb>\|B<+rb>	180	=item B<-fb> I<fontlist>
170		181
171	Enable "real bold" support. When this option is on, bold text will be	182	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	183	be printed. See resource B<boldFont> for details.
173	fonts should thus be specified in the font list after their	184
174	corresponding regular fonts. If no bold font can be found, a regular	185	=item B<-fi> I<fontlist>
175	font will be used. resource B<realBold>.	186
		187	Compile font-styles: The italic font list to use when bold characters are to
		188	be printed. See resource B<italicFont> for details.
		189
		190	=item B<-fbi> I<fontlist>
		191
		192	Compile font-styles: The bold italic font list to use when bold characters are to
		193	be printed. See resource B<boldItalicFont> for details.
176		194
177	=item B<-name> I<name>	195	=item B<-name> I<name>
178		196
179	Specify the application name under which resources are to be obtained,	197	Specify the application name under which resources are to be obtained,
180	rather than the default executable file name. Name should not contain	198	rather than the default executable file name. Name should not contain
…		…
221	=item B<-st>\|B<+st>	239	=item B<-st>\|B<+st>
222		240
223	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	241	Display normal (non XTerm/NeXT) scrollbar without/with a trough;
224	resource B<scrollBar_floating>.	242	resource B<scrollBar_floating>.
225		243
		244	=item B<-ptab>\|B<+ptab>
		245
		246	If enabled (default), "Horizontal Tab" characters are being stored as
		247	actual wide characters in the screen buffer, which makes it possible to
		248	select and paste them. Since a horizontal tab is a cursor movement and
		249	not an actual glyph, this can sometimes be visually annoying as the cursor
		250	on a tab character is displayed as a wide cursor; resource B<pastableTabs>.
		251
226	=item B<-bc>\|B<+bc>	252	=item B<-bc>\|B<+bc>
227		253
228	Blink the cursor; resource B<cursorBlink>.	254	Blink the cursor; resource B<cursorBlink>.
229		255
230	=item B<-iconic>	256	=item B<-iconic>
…		…
254	if honoured by the WM, the rxvt-unicode window will not have window	280	if honoured by the WM, the rxvt-unicode window will not have window
255	decorations; resource B<borderLess>.	281	decorations; resource B<borderLess>.
256		282
257	=item B<-lsp> I<number>	283	=item B<-lsp> I<number>
258		284
259	Compile I<linespace>: Lines (pixel height) to insert between each row	285	Compile I<frills>: Lines (pixel height) to insert between each row of
260	of the display; resource B<linespace>.	286	the display. Useful to work around font rendering problems; resource
		287	B<linespace>.
261		288
262	=item B<-tn> I<termname>	289	=item B<-tn> I<termname>
263		290
264	This option specifies the name of the terminal type to be set in the	291	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	292	B<TERM> environment variable. This terminal type must exist in the
…		…
389	high-intensity (bold = bright foreground, blink = bright background)	416	high-intensity (bold = bright foreground, blink = bright background)
390	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	417	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	418	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.	419	names used are listed in the B<COLORS AND GRAPHICS> section.
393		420
		421	Colours higher than 15 cannot be set using resources (yet), but can be
		422	changed using an escape command (see @@RXVT_NAME@@(7)).
		423
		424	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
		425	88 colour support). Colours 80-87 are evenly spaces grey steps.
		426
394	=item B<colorBD:> I<colour>	427	=item B<colorBD:> I<colour>
395		428
		429	=item B<colorIT:> I<colour>
		430
396	Use the specified colour to display bold characters when the foreground	431	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	432	foreground colour is the default. If font styles are not available
398	enabled.	433	(Compile I<styles>) and this option is unset, reverse video is used instead.
399		434
400	=item B<colorUL:> I<colour>	435	=item B<colorUL:> I<colour>
401		436
402	Use the specified colour to display underlined characters when the	437	Use the specified colour to display underlined characters when the
403	foreground colour is the default.	438	foreground colour is the default.
404		439
405	=item B<colorRV:> I<colour>	440	=item B<colorRV:> I<colour>
406		441
407	Use the specified colour as the background for reverse video	442	Use the specified colour as the background for reverse video
408	characters.	443	characters.
		444
		445	=item B<underlineColor:> I<colour>
		446
		447	If set, use the specified colour as the colour for the underline
		448	itself. If unset, use the foreground colour.
409		449
410	=item B<cursorColor:> I<colour>	450	=item B<cursorColor:> I<colour>
411		451
412	Use the specified colour for the cursor. The default is to use the	452	Use the specified colour for the cursor. The default is to use the
413	foreground colour; option B<-cr>.	453	foreground colour; option B<-cr>.
…		…
447	=item B<shading:> I<number>	487	=item B<shading:> I<number>
448		488
449	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	489	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
450	image in addition to tinting it.	490	image in addition to tinting it.
451		491
452	=item B<fading:> I<number>
453
454	Scale the tint colour by the given percentage.
455
456	=item B<scrollColor:> I<colour>	492	=item B<scrollColor:> I<colour>
457		493
458	Use the specified colour for the scrollbar [default #B2B2B2].	494	Use the specified colour for the scrollbar [default #B2B2B2].
459		495
460	=item B<troughColor:> I<colour>	496	=item B<troughColor:> I<colour>
461		497
462	Use the specified colour for the scrollbar's trough area [default	498	Use the specified colour for the scrollbar's trough area [default
463	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	499	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.
		500
		501	=item B<borderColor:> I<colour>
		502
		503	The colour of the border around the text area and between the scrollbar
		504	and the text.
464		505
465	=item B<backgroundPixmap:> I<file[;geom]>	506	=item B<backgroundPixmap:> I<file[;geom]>
466		507
467	Use the specified XPM file (note the `.xpm' extension is optional) for	508	Use the specified XPM file (note the `.xpm' extension is optional) for
468	the background and also optionally specify its scaling with a geometry	509	the background and also optionally specify its scaling with a geometry
…		…
484		525
485	Specify the colon-delimited search path for finding files (XPM and	526	Specify the colon-delimited search path for finding files (XPM and
486	menus), in addition to the paths specified by the B<RXVTPATH> and	527	menus), in addition to the paths specified by the B<RXVTPATH> and
487	B<PATH> environment variables.	528	B<PATH> environment variables.
488		529
489	=item B<font:> I<fontname>	530	=item B<font:> I<fontlist>
490		531
491	Select the fonts to be used. This is a comma seperated list of font	532	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.	533	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	534	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	535	be smaller, but not larger. A reasonable default font list is always
495	appended to it. option B<-fn>.	536	appended to it. option B<-fn>.
496		537
497	=item B<realBold:> I<boolean>	538	Each font can either be a standard X11 core font (XLFD) name, with
		539	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
498		540
499	B<True>: Enable "real bold" support. When this option is on, bold text	541	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.	542	specifications enclosed in square brackets (C<[]>). The only available
501	Bold fonts should thus be specified in the font list after their	543	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	544	fonts.
503	font will be used. option B<-rb>. B<False>: Display bold text in a	545
504	regular font, using the color specified with B<colorBD>; option B<+rb>.	546	For example, this font resource
		547
		548	URxvt*font: 9x15bold,\
		549	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
		550	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
		551	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
		552	xft:Code2000:antialias=false
		553
		554	specifies five fonts to be used. The first one is C<9x15bold> (actually
		555	the iso8859-1 version of the second font), which is the base font (because
		556	it is named first) and thus defines the character cell grid to be 9 pixels
		557	wide and 15 pixels high.
		558
		559	The second font is just used to add additional unicode characters not in
		560	the base font, likewise the third, which is unfortunately non-bold, but
		561	the bold version of the font does contain less characters, so this is a
		562	useful supplement.
		563
		564	The third font is an Xft font with aliasing turned off, and the characters
		565	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
		566	contains other characters, but we are not interested in them.
		567
		568	The last font is a useful catch-all font that supplies most of the
		569	remaining unicode characters.
		570
		571	=item B<boldFont:> I<fontlist>
		572
		573	=item B<italicFont:> I<fontlist>
		574
		575	=item B<boldItalicFont:> I<fontlist>
		576
		577	The font list to use for displaying B<bold>, I<italic> or B<< I<bold
		578	italic> >> characters, respectively.
		579
		580	If specified and non-empty, then the syntax is the same as for the
		581	B<font>-resource, and the given font list will be used as is, which makes
		582	it possible to substitute completely different font styles for bold and
		583	italic.
		584
		585	If unset (the default), a suitable font list will be synthesized by
		586	"morphing" the normal text font list into the desired shape. If that is
		587	not possible, replacement fonts of the desired shape will be tried.
		588
		589	If set, but empty, then this specific style is disabled and the normal
		590	text font will being used for the given style.
505		591
506	=item B<selectstyle:> I<mode>	592	=item B<selectstyle:> I<mode>
507		593
508	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	594	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	595	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	666	B<False>: do not scroll to bottom when tty receives output; option
581	B<+si>.	667	B<+si>.
582		668
583	=item B<scrollWithBuffer:> I<boolean>	669	=item B<scrollWithBuffer:> I<boolean>
584		670
585	B<True>: scroll with scrollback buffer when tty recieves new lines (and	671	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	672	B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll
587	with scrollback buffer when tty recieves new lines; option B<-sw>.	673	with scrollback buffer when tty recieves new lines; option B<-sw>.
588		674
589	=item B<scrollTtyKeypress:> I<boolean>	675	=item B<scrollTtyKeypress:> I<boolean>
590		676
…		…
631	=item B<mouseWheelScrollPage:> I<boolean>	717	=item B<mouseWheelScrollPage:> I<boolean>
632		718
633	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel	719	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
634	scrolls five lines [default].	720	scrolls five lines [default].
635		721
		722	=item B<pastableTabs:> I<boolean>
		723
		724	B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
		725	movement only; option C<-ptab>.
		726
636	=item B<cursorBlink:> I<boolean>	727	=item B<cursorBlink:> I<boolean>
637		728
638	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	729	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
639	option B<-bc>.	730	option B<-bc>.
640		731
…		…
689	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	780	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.
690	de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input	781	de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input
691	extension to be able to input japanese characters while staying in	782	extension to be able to input japanese characters while staying in
692	another locale. option B<-imlocale>.	783	another locale. option B<-imlocale>.
693		784
694	=item B<insecure>	785	=item B<insecure:> I<boolean>
695		786
696	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	787	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
697	echo arbitrary strings like the icon name or the locale. This could be	788	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	789	abused if somebody gets 8-bit-clean access to your display, whether
699	throuh a mail client displaying mail bodies unfiltered or though	790	throuh a mail client displaying mail bodies unfiltered or though
700	write(1). Therefore, these sequences are disabled by default. (Note	791	write(1). Therefore, these sequences are disabled by default. (Note
701	that other terminals, including xterm, have these sequences	792	that other terminals, including xterm, have these sequences
702	enabled by default). You can enable them by setting this boolean	793	enabled by default). You can enable them by setting this boolean
703	resource or specifying B<-insecure> as an option. At the moment, this	794	resource or specifying B<-insecure> as an option. At the moment, this
…		…
727	scrollback buffer and switching to/from the secondary screen will	818	scrollback buffer and switching to/from the secondary screen will
728	instead scroll the screen up.	819	instead scroll the screen up.
729		820
730	=item B<keysym.>I<sym>: I<string>	821	=item B<keysym.>I<sym>: I<string>
731		822
732	Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may	823	Compile I<frills>: Associate I<string> with keysym I<sym>. The
733	contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:	824	intervening resource name B<keysym.> cannot be omitted.
734	newline, \r: return, \t:	825
		826	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
		827	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
		828	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
		829	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
		830	B<2>, B<3>, B<4>, B<5>.
		831
		832	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
		833	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
		834	keys are being mapped. B<AppKeypad> is a artificial modifier mapped to the
		835	current application keymap mode state.
		836
		837	The spellings of I<key> can be obtained by using B<xev>(1) command or
		838	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
		839	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
		840	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
		841	performed in an exact manner; however, the closest match is assured.
		842
		843	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
		844	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,	845	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	846	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	847	can start or end with whitespace.
738	omitted. This resource is only available when compiled with	848
739	KEYSYM_RESOURCE.	849	You can define a range of keysyms in one shot by providing a I<string>
		850	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
		851	should be a character not used by the strings.
		852
		853	Its usage can be demonstrated by an example:
		854
		855	URxvt.keysym.M-C-0x61: list\|\e<M-C-\|abc\|>
		856
		857	The above line is equivalent to the following three lines:
		858
		859	URxvt.keysym.Meta-Control-0x61: \e<M-C-a>
		860	URxvt.keysym.Meta-Control-0x62: \e<M-C-b>
		861	URxvt.keysym.Meta-Control-0x63: \e<M-C-c>
		862
		863	If I<string> takes the form of C<proto:STRING>, the specified B<STRING> is
		864	interpreted and executed as @@RXVT_NAME@@'s control sequence. For example,
		865	C<proto:\033]701;zh_CN.GBK\007> means: change the current locale to
		866	C<zh_CN.GBK>.
740		867
741	=back	868	=back
742		869
743	=head1 THE SCROLLBAR	870	=head1 THE SCROLLBAR
744		871
…		…
777	Left click at the beginning of the region, drag to the end of the	904	Left click at the beginning of the region, drag to the end of the
778	region and release; Right click to extend the marked region; Left	905	region and release; Right click to extend the marked region; Left
779	double-click to select a word; Left triple-click to select the entire	906	double-click to select a word; Left triple-click to select the entire
780	line.	907	line.
781		908
		909	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
		910	(Compile: I<frills>) will create a rectangular selection instead of a normal
		911	one.
		912
782	=item B<Insertion>:	913	=item B<Insertion>:
783		914
784	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	915	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	916	an B<@@RXVT_NAME@@> window causes the current text selection to be
786	inserted as if it had been typed on the keyboard.	917	inserted as if it had been typed on the keyboard.
…		…
834	Start by pressing C<Control> and C<Shift> together, then releasing	965	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	966	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	967	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	968	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	969	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	970	C<ISO Level 2 Switch>, although your intention might have been to enter a
840	reverse tab (Shift-Tab).	971	reverse tab (Shift-Tab).
841		972
842	=item 5.3: Screen-selection entry method	973	=item 5.3: Screen-selection entry method
843		974
844	While this is implemented already (it's basically the selection	975	While this is implemented already (it's basically the selection
…		…
851		982
852	You enter this mode by holding down C<Control> and C<Shift> together, then	983	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	984	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	985	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>.	986	pointer is displayed until you release C<Control> and C<Shift>.
		987
		988	In addition to the hex codes it will display the font used to draw this
		989	character - due to implementation reasons, characters combined with
		990	combining characters, line drawing characters and unknown characters will
		991	always be drawn using the built-in support font.
856		992
857	=back	993	=back
858		994
859	With respect to conformance, rxvt-unicode is supposed to be compliant to	995	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.	996	both scenario A and B of ISO 14755, including part 5.2.
…		…
913	would yield White on Black, while on I<xterm>(1) it would yield Black	1049	would yield White on Black, while on I<xterm>(1) it would yield Black
914	on White.	1050	on White.
915		1051
916	=back	1052	=back
917		1053
918	=head1 FREQUENTLY ASKED QUESTIONS (FAQ)
919
920	=over 4
921
922	=item How do I know which rxvt-unicode version I'm using?
923
924	The version number is displayed with the usage (-h). For rxvt-unicode
925	version 2.14 and later, the escape sequence C<ESC[8n> sets the window
926	title to the version number.
927
928	=item Rxvt-unicode does not seem to understand the selected encoding?
929
930	=item Unicode does not seem to work?
931
932	If you encounter strange problems like typing an accented character but
933	getting two unrelated other characters or similar, or if program output is
934	subtly garbled, then you should check your locale settings.
935
936	Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
937	programs. Often rxvt-unicode is started in the C<C> locale, while the
938	login script running within the rxvt-unicode window changes the locale to
939	sth. else, e.h. C<en_GB.UTF-8>. Needless to say, this is not going to work.
940
941	The best thing is to fix your startup environment, as you will likely run
942	into other problems. If nothing works you can try this in your .profile.
943
944	printf '\e]701;%s\007' "$LC_CTYPE"
945
946	If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
947	supported on your systems. Some systems have a C<locale> comamnd which
948	displays this. If it displays sth. like:
949
950	locale: Cannot set LC_CTYPE to default locale: ...
951
952	Then the locale you specified is not supported on your system.
953
954	If nothing works and you are sure that everything is set correctly then
955	you will need to remember a little known fact: Some programs just don't
956	support locales :(
957
958	=item Why do the characters look ugly?
959
960	=item How does rxvt-unicode choose fonts?
961
962	Most fonts do not contain the full range of Unicode, which is
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
967	B<rxvt-unicode> makes a best-effort try at finding a replacement
968	font. Often the result is fine, but sometimes the chosen font looks
969	bad. In that case, select a font of your taste and add it to the font
970	list, e.g.:
971
972	@@RXVT_NAME@@ -fn basefont,font2,font3...
973
974	When rxvt-unicode sees a character, it will first look at the base
975	font. If the base font does not contain the character, it will go to the
976	next font, and so on.
977
978	The only limitation is that all the fonts must not be larger than the base
979	font, as the base font defines the principial cell size, which must be the
980	same due to the way terminals work.
981
982	=item Why do some chinese characters look so different than others?
983
984	This is because there is a difference between script and language --
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
994	The workaround is easy: just tag a chinese font at the end of your font
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
999	In the future it might be possible to switch preferences at runtime (the
1000	internal data structure has no problem with using different fonts for
1001	the same character at the same time, but no interface for this has been
1002	designed yet).
1003
1004	=item How does rxvt-unicode determine the encoding to use?
1005
1006	=item Is there an option to switch encodings?
1007
1008	Unlike some other terminals, rxvt-unicode has no encoding switch, and no
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
1012	The reasons is that there exists a perfectly fine mechanism for selecting
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@@
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
1277	=back
1278
1279	=head1 ENVIRONMENT	1054	=head1 ENVIRONMENT
1280		1055
1281	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>	1056	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	1057	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	1058	window id number of the B<@@RXVT_NAME@@> window and it also uses and

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.43 by root, Sun Jan 16 19:22:16 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.43 by root, Sun Jan 16 19:22:16 2005 UTC