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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.5 by root, Sat Aug 14 03:00:32 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 -- break othwerwise).	34	such as cursor-movement while editing -- break otherwise), but that might
		35	change.
30		36
		37	If you are looking for a terminal that supports more exotic scripts, let
		38	me recommend C<mlterm>, which is a very userfriendly, lean and clean
		39	terminal emulator. In fact, the reason rxvt-unicode was born was solely
		40	because the author couldn't get C<mlterm> to use one font for latin1 and
		41	another for japanese.
		42
31	Another design rationale was the use of multiple fonts to display	43	Therefore another design rationale was the use of multiple fonts to
32	characters: The idea of a single unicode font which many other programs	44	display characters: The idea of a single unicode font which many other
33	force onto it's users never made sense to me: You should be able to choose	45	programs force onto it's users never made sense to me: You should be able
34	any font for any script.	46	to choose any font for any script freely.
35		47
36	Apart from that, rxvt-unicode is also much better internationalised than	48	Apart from that, rxvt-unicode is also much better internationalised than
37	it's predecessor, supports things such as XFT and ISO 14755 that are handy	49	it's predecessor, supports things such as XFT and ISO 14755 that are handy
38	in i18n-environments, is faster, and has a lot less bugs than the original	50	in i18n-environments, is faster, and has a lot less bugs than the original
39	rxvt. This all in addition to dozens of other small improvements.	51	rxvt. This all in addition to dozens of other small improvements.
…		…
46	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and	58	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
47	@@RXVT_NAME@@c(1) (client).	59	@@RXVT_NAME@@c(1) (client).
48		60
49	It also makes technical information about escape sequences (which have	61	It also makes technical information about escape sequences (which have
50	been extended) easier accessible: see @@RXVT_NAME@@(7) for technical	62	been extended) easier accessible: see @@RXVT_NAME@@(7) for technical
51	reference documentation (escape sequences etc.) and the FAQ section at the	63	reference documentation (escape sequences etc.).
52	end of this document.
53		64
54	=head1 OPTIONS	65	=head1 OPTIONS
55		66
56	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
57	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
…		…
99	Turn on/off inheriting parent window's pixmap. Alternative form is	110	Turn on/off inheriting parent window's pixmap. Alternative form is
100	B<-tr>; resource B<inheritPixmap>.	111	B<-tr>; resource B<inheritPixmap>.
101		112
102	=item B<-fade> I<number>	113	=item B<-fade> I<number>
103		114
104	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>.
105		116
106	=item B<-tint> I<colour>	117	=item B<-tint> I<colour>
107		118
108	Tint the transparent background pixmap with the given colour when	119	Tint the transparent background pixmap with the given colour when
109	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>
…		…
112		123
113	=item B<-sh>	124	=item B<-sh>
114		125
115	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	126	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
116	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
117	specified, too).	128	specified, too, e.g. C<-tint white>).
118		129
119	=item B<-bg> I<colour>	130	=item B<-bg> I<colour>
120		131
121	Window background colour; resource B<background>.	132	Window background colour; resource B<background>.
122		133
…		…
125	Window foreground colour; resource B<foreground>.	136	Window foreground colour; resource B<foreground>.
126		137
127	=item B<-pixmap> I<file[;geom]>	138	=item B<-pixmap> I<file[;geom]>
128		139
129	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
130	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
131	quotes to avoid special shell interpretation of the `;' in the	142	add quotes to avoid special shell interpretation of the C<;> in the
132	command-line; resource B<backgroundPixmap>.	143	command-line; resource B<backgroundPixmap>.
133		144
134	=item B<-cr> I<colour>	145	=item B<-cr> I<colour>
135		146
136	The cursor colour; resource B<cursorColor>.	147	The cursor colour; resource B<cursorColor>.
…		…
143		154
144	The mouse pointer background colour; resource B<pointerColor2>.	155	The mouse pointer background colour; resource B<pointerColor2>.
145		156
146	=item B<-bd> I<colour>	157	=item B<-bd> I<colour>
147		158
148	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;
149	resource B<borderColor>.	160	resource B<borderColor>.
150		161
151	=item B<-fn> I<fontname>	162	=item B<-fn> I<fontlist>
152		163
153	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
154	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
155	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
156	be smaller, but not larger. A reasonable default font list is always	167	smaller, but not (in general) larger. A (hopefully) reasonable default
157	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"
158		176
159	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
160	section.	178	section of @@RXVT_NAME@@(7).
161		179
162	=item B<-rb>\|B<+rb>	180	=item B<-fb> I<fontlist>
163		181
164	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
165	displayed using the first available bold font in the font list. Bold	183	be printed. See resource B<boldFont> for details.
166	fonts should thus be specified in the font list after their	184
167	corresponding regular fonts. If no bold font can be found, a regular	185	=item B<-fi> I<fontlist>
168	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.
169		194
170	=item B<-name> I<name>	195	=item B<-name> I<name>
171		196
172	Specify the application name under which resources are to be obtained,	197	Specify the application name under which resources are to be obtained,
173	rather than the default executable file name. Name should not contain	198	rather than the default executable file name. Name should not contain
…		…
214	=item B<-st>\|B<+st>	239	=item B<-st>\|B<+st>
215		240
216	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	241	Display normal (non XTerm/NeXT) scrollbar without/with a trough;
217	resource B<scrollBar_floating>.	242	resource B<scrollBar_floating>.
218		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
219	=item B<-bc>\|B<+bc>	252	=item B<-bc>\|B<+bc>
220		253
221	Blink the cursor; resource B<cursorBlink>.	254	Blink the cursor; resource B<cursorBlink>.
222		255
223	=item B<-iconic>	256	=item B<-iconic>
…		…
247	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
248	decorations; resource B<borderLess>.	281	decorations; resource B<borderLess>.
249		282
250	=item B<-lsp> I<number>	283	=item B<-lsp> I<number>
251		284
252	Compile I<linespace>: Lines (pixel height) to insert between each row	285	Compile I<frills>: Lines (pixel height) to insert between each row of
253	of the display; resource B<linespace>.	286	the display. Useful to work around font rendering problems; resource
		287	B<linespace>.
254		288
255	=item B<-tn> I<termname>	289	=item B<-tn> I<termname>
256		290
257	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
258	B<TERM> environment variable. This terminal type must exist in the	292	B<TERM> environment variable. This terminal type must exist in the
…		…
382	high-intensity (bold = bright foreground, blink = bright background)	416	high-intensity (bold = bright foreground, blink = bright background)
383	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,
384	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
385	names used are listed in the B<COLORS AND GRAPHICS> section.	419	names used are listed in the B<COLORS AND GRAPHICS> section.
386		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
387	=item B<colorBD:> I<colour>	427	=item B<colorBD:> I<colour>
388		428
		429	=item B<colorIT:> I<colour>
		430
389	Use the specified colour to display bold characters when the foreground	431	Use the specified colour to display bold or italic characters when the
390	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
391	enabled.	433	(Compile I<styles>) and this option is unset, reverse video is used instead.
392		434
393	=item B<colorUL:> I<colour>	435	=item B<colorUL:> I<colour>
394		436
395	Use the specified colour to display underlined characters when the	437	Use the specified colour to display underlined characters when the
396	foreground colour is the default.	438	foreground colour is the default.
397		439
398	=item B<colorRV:> I<colour>	440	=item B<colorRV:> I<colour>
399		441
400	Use the specified colour as the background for reverse video	442	Use the specified colour as the background for reverse video
401	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.
402		449
403	=item B<cursorColor:> I<colour>	450	=item B<cursorColor:> I<colour>
404		451
405	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
406	foreground colour; option B<-cr>.	453	foreground colour; option B<-cr>.
…		…
440	=item B<shading:> I<number>	487	=item B<shading:> I<number>
441		488
442	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	489	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
443	image in addition to tinting it.	490	image in addition to tinting it.
444		491
445	=item B<fading:> I<number>
446
447	Scale the tint colour by the given percentage.
448
449	=item B<scrollColor:> I<colour>	492	=item B<scrollColor:> I<colour>
450		493
451	Use the specified colour for the scrollbar [default #B2B2B2].	494	Use the specified colour for the scrollbar [default #B2B2B2].
452		495
453	=item B<troughColor:> I<colour>	496	=item B<troughColor:> I<colour>
454		497
455	Use the specified colour for the scrollbar's trough area [default	498	Use the specified colour for the scrollbar's trough area [default
456	#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.
457		505
458	=item B<backgroundPixmap:> I<file[;geom]>	506	=item B<backgroundPixmap:> I<file[;geom]>
459		507
460	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
461	the background and also optionally specify its scaling with a geometry	509	the background and also optionally specify its scaling with a geometry
…		…
477		525
478	Specify the colon-delimited search path for finding files (XPM and	526	Specify the colon-delimited search path for finding files (XPM and
479	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
480	B<PATH> environment variables.	528	B<PATH> environment variables.
481		529
482	=item B<font:> I<fontname>	530	=item B<font:> I<fontlist>
483		531
484	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
485	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.
486	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
487	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
488	appended to it. option B<-fn>.	536	appended to it. option B<-fn>.
489		537
490	=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:>.
491		540
492	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
493	will be displayed using the first available bold font in the font list.	542	specifications enclosed in square brackets (C<[]>). The only available
494	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
495	corresponding regular fonts. If no bold font can be found, a regular	544	fonts.
496	font will be used. option B<-rb>. B<False>: Display bold text in a	545
497	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.
498		591
499	=item B<selectstyle:> I<mode>	592	=item B<selectstyle:> I<mode>
500		593
501	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
502	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
…		…
573	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
574	B<+si>.	667	B<+si>.
575		668
576	=item B<scrollWithBuffer:> I<boolean>	669	=item B<scrollWithBuffer:> I<boolean>
577		670
578	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
579	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
580	with scrollback buffer when tty recieves new lines; option B<-sw>.	673	with scrollback buffer when tty recieves new lines; option B<-sw>.
581		674
582	=item B<scrollTtyKeypress:> I<boolean>	675	=item B<scrollTtyKeypress:> I<boolean>
583		676
584	B<True>: scroll to bottom when a non-special key is pressed. Special keys	677	B<True>: scroll to bottom when a non-special key is pressed. Special keys
585	are those which are intercepted by rxvt-unicode for special handling and	678	are those which are intercepted by rxvt-unicode for special handling and
586	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to	679	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
587	bottom when a non-special key is pressed; option B<+sk>.	680	bottom when a non-special key is pressed; option B<+sk>.
588		681
589	=item B<smallfont_key:> I<keysym>
590
591	If enabled, use B<@@HOTKEY@@->I<keysym> to toggle to a smaller font
592	[default B<@@HOTKEY@@-@@SMALLFONT@@>]
593
594	=item B<bigfont_key:> I<keysym>
595
596	If enabled, use B<@@HOTKEY@@->I<keysym> to toggle to a bigger font
597	[default B<@@HOTKEY@@-@@BIGFONT@@>]
598
599	=item B<saveLines:> I<number>	682	=item B<saveLines:> I<number>
600		683
601	Save I<number> lines in the scrollback buffer [default 64]. This	684	Save I<number> lines in the scrollback buffer [default 64]. This
602	resource is limited on most machines to 65535; option B<-sl>.	685	resource is limited on most machines to 65535; option B<-sl>.
603		686
…		…
633		716
634	=item B<mouseWheelScrollPage:> I<boolean>	717	=item B<mouseWheelScrollPage:> I<boolean>
635		718
636	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
637	scrolls five lines [default].	720	scrolls five lines [default].
		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>.
638		726
639	=item B<cursorBlink:> I<boolean>	727	=item B<cursorBlink:> I<boolean>
640		728
641	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];
642	option B<-bc>.	730	option B<-bc>.
…		…
692	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.
693	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
694	extension to be able to input japanese characters while staying in	782	extension to be able to input japanese characters while staying in
695	another locale. option B<-imlocale>.	783	another locale. option B<-imlocale>.
696		784
697	=item B<insecure>	785	=item B<insecure:> I<boolean>
698		786
699	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	787	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
700	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
701	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
702	throuh a mail client displaying mail bodies unfiltered or though	790	throuh a mail client displaying mail bodies unfiltered or though
703	write(1). Therefore, these sequences are disabled by default. (Note	791	write(1). Therefore, these sequences are disabled by default. (Note
704	that other terminals, including xterm, have these sequences	792	that other terminals, including xterm, have these sequences
705	enabled by default). You can enable them by setting this boolean	793	enabled by default). You can enable them by setting this boolean
706	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
…		…
730	scrollback buffer and switching to/from the secondary screen will	818	scrollback buffer and switching to/from the secondary screen will
731	instead scroll the screen up.	819	instead scroll the screen up.
732		820
733	=item B<keysym.>I<sym>: I<string>	821	=item B<keysym.>I<sym>: I<string>
734		822
735	Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may	823	Compile I<frills>: Associate I<string> with keysym I<sym>. The
736	contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:	824	intervening resource name B<keysym.> cannot be omitted.
737	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,
738	tab, \000: octal number) or control characters (^?: delete, ^@: null,	845	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
739	^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
740	with whitespace. The intervening resource name B<keysym.> cannot be	847	can start or end with whitespace.
741	omitted. This resource is only available when compiled with	848
742	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>.
743		867
744	=back	868	=back
745		869
746	=head1 THE SCROLLBAR	870	=head1 THE SCROLLBAR
747		871
…		…
780	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
781	region and release; Right click to extend the marked region; Left	905	region and release; Right click to extend the marked region; Left
782	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
783	line.	907	line.
784		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
785	=item B<Insertion>:	913	=item B<Insertion>:
786		914
787	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
788	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
789	inserted as if it had been typed on the keyboard.	917	inserted as if it had been typed on the keyboard.
790		918
791	=back	919	=back
792		920
793	=head1 CHANGING FONTS	921	=head1 CHANGING FONTS
794		922
795	You can change fonts on-the-fly, which is to say cycle through the	923	Changing fonts (or font sizes, respectively) via the keypad is not yet
796	default font and others of various sizes, by using B<Shift-KP_Add> and	924	supported in rxvt-unicode. Bug me if you need this.
797	B<Shift-KP_Subtract>. Or, alternatively (if enabled) with	925
798	B<@@HOTKEY@@-@@BIGFONT@@> and B<@@HOTKEY@@-@@SMALLFONT@@>, where the	926	You can, however, switch fonts at runtime using escape sequences (and
799	actual key can be selected using resources	927	therefore using the menubar), e.g.:
800	B<smallfont_key>/B<bigfont_key>.	928
		929	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"
		930
		931	rxvt-unicode will automatically re-apply these fonts to the output so far.
801		932
802	=head1 ISO 14755 SUPPORT	933	=head1 ISO 14755 SUPPORT
803		934
804	Partial ISO 14755-support is implemented. that means that pressing	935	ISO 14755 is a standard for entering and viewing unicode characters
		936	and character codes using the keyboard. It consists of 4 parts. The
		937	first part is available rxvt-unicode has been compiled with
		938	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
		939	with C<--enable-iso14755>.
805		940
806	Section 5.1: Control and Shift together enters unicode input	941	=over 4
807	mode. Entering hex digits composes a Unicode character, pressing space or
808	releasing the modifiers commits the keycode and every other key cancels
809	the current input character.
810		942
811	Section 5.2: Pressing and immediately releasing Control and Shift together	943	=item 5.1: Basic method
812	enters keycap entry mode for the next key: pressing a function key (tab,	944
813	return etc..) will enter the unicode character corresponding to the given	945	This allows you to enter unicode characters using their hexcode.
814	key.	946
		947	Start by pressing and holding both C<Control> and C<Shift>, then enter
		948	hex-digits (between one and six). Releasing C<Control> and C<Shift> will
		949	commit the character as if it were typed directly. While holding down
		950	C<Control> and C<Shift> you can also enter multiple characters by pressing
		951	C<Space>, which will commit the current character and lets you start a new
		952	one.
		953
		954	As an example of use, imagine a business card with a japanese e-mail
		955	address, which you cannot type. Fortunately, the card has the e-mail
		956	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
		957	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
		958	followed by releasing the modifier keys.
		959
		960	=item 5.2: Keyboard symbols entry method
		961
		962	This mode lets you input characters representing the keycap symbols of
		963	your keyboard, if representable in the current locale encoding.
		964
		965	Start by pressing C<Control> and C<Shift> together, then releasing
		966	them. The next special key (cursor keys, home etc.) you enter will not
		967	invoke it's usual function but instead will insert the corresponding
		968	keycap symbol. The symbol will only be entered when the key has been
		969	released, otherwise pressing e.g. C<Shift> would enter the symbol for
		970	C<ISO Level 2 Switch>, although your intention might have been to enter a
		971	reverse tab (Shift-Tab).
		972
		973	=item 5.3: Screen-selection entry method
		974
		975	While this is implemented already (it's basically the selection
		976	mechanism), it could be extended by displaying a unicode character map.
		977
		978	=item 5.4: Feedback method for identifying displayed characters for later input
		979
		980	This method lets you display the unicode character code associated with
		981	characters already displayed.
		982
		983	You enter this mode by holding down C<Control> and C<Shift> together, then
		984	pressing and holding the left mouse button and moving around. The unicode
		985	hex code(s) (it might be a combining character) of the character under the
		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.
		992
		993	=back
		994
		995	With respect to conformance, rxvt-unicode is supposed to be compliant to
		996	both scenario A and B of ISO 14755, including part 5.2.
815		997
816	=head1 LOGIN STAMP	998	=head1 LOGIN STAMP
817		999
818	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so	1000	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so
819	that it can be seen via the I<who(1)> command, and can accept messages.	1001	that it can be seen via the I<who(1)> command, and can accept messages.
…		…
867	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
868	on White.	1050	on White.
869		1051
870	=back	1052	=back
871		1053
872	=head1 FREQUENTLY ASKED QUESTIONS (FAQ)
873
874	=over 4
875
876	=item How do I know which rxvt-unicode version I'm using?
877
878	The version number is displayed with the usage (-h). For rxvt-unicode
879	version 2.14 and later, the escape sequence C<ESC[8n> sets the window
880	title to the version number.
881
882	=item Why do the characters look ugly?
883
884	=item How does rxvt-unicode choose fonts?
885
886	Most fonts do not contain the full range of Unicode, which is
887	fine. Chances are that the font you (or the admin/package maintainer of
888	your system/os) have specified does not cover all the characters you want
889	to display.
890
891	B<rxvt-unicode> makes a best-effort try at finding a replacement
892	font. Often the result is fine, but sometimes the chosen font looks
893	bad. In that case, select a font of your taste and add it to the font
894	list, e.g.:
895
896	@@RXVT_NAME@@ -fn basefont,font2,font3...
897
898	When rxvt-unicode sees a character, it will first look at the base
899	font. If the base font does not contain the character, it will go to the
900	next font, and so on.
901
902	The only limitation is that all the fonts must not be larger than the base
903	font, as the base font defines the principial cell size, which must be the
904	same due to the way terminals work.
905
906	=item Why do some chinese characters look so different than others?
907
908	This is because there is a difference between script and language --
909	rxvt-unicode does not know which language the text that is output
910	is, as it only knows the unicode character codes. If rxvt-unicode
911	first sees a japanese character, it might choose a japanese font for
912	it. Subseqzuent japanese characters will take that font. Now, many chinese
913	characters aren't represented in japanese fonts, so when the first
914	non-japanese character comes up, rxvt-unicode will look for a chinese font
915	-- unfortunately at this point, it will still use the japanese font for
916	japanese characters that are also chinese.
917
918	The workaround is easy: just tag a chinese font at the end of your font
919	list (see the previous question). The key is to view the font list as
920	a preference list: If you expect more japanese, list a japanese font
921	first. If you expect more chinese, put a chinese font first.
922
923	In the future it might be possible to switch preferences at runtime (the
924	internal data structure has no problem with using different fonts for
925	the same character at the same time, but no interface for this has been
926	designed yet).
927
928	=item Mouse cut/paste suddenly no longer works.
929
930	Make sure that mouse reporting is actually turned off since killing
931	some editors prematurely may leave the mouse in mouse report mode. I've
932	heard that tcsh may use mouse reporting unless it otherwise specified. A
933	quick check is to see if cut/paste works when the Alt or Shift keys are
934	depressed. See @@RXVT_NAME@@(7)
935
936	=item What's with this bold/blink stuff?
937
938	If no bold colour is set via C<colorBD:>, bold will invert text using the
939	standard foreground colour.
940
941	For the standard background colour, blinking will actually make the
942	text blink when compiled with C<--enable-blinking>. with standard
943	colours. Without C<--enable-blinking>, the blink attribute will be
944	ignored.
945
946	On ANSI colours, bold/blink attributes are used to set high-intensity
947	foreground/background colors.
948
949	color0-7 are the low-intensity colors.
950
951	color8-15 are the corresponding high-intensity colors.
952
953	=item I don't like the screen colors. How do I change them?
954
955	You can change the screen colors at run-time using F<~/.Xdefaults>
956	resources (or as long-options).
957
958	Here are values that are supposed to resemble a VGA screen,
959	including the murky brown that passes for low-intensity yellow:
960
961	Rxvt*color0: #000000
962	Rxvt*color1: #A80000
963	Rxvt*color2: #00A800
964	Rxvt*color3: #A8A800
965	Rxvt*color4: #0000A8
966	Rxvt*color5: #A800A8
967	Rxvt*color6: #00A8A8
968	Rxvt*color7: #A8A8A8
969
970	Rxvt*color8: #000054
971	Rxvt*color9: #FF0054
972	Rxvt*color10: #00FF54
973	Rxvt*color11: #FFFF54
974	Rxvt*color12: #0000FF
975	Rxvt*color13: #FF00FF
976	Rxvt*color14: #00FFFF
977	Rxvt*color15: #FFFFFF
978
979	=item What's with the strange Backspace/Delete key behaviour?
980
981	Assuming that the physical Backspace key corresponds to the
982	BackSpace keysym (not likely for Linux ... see the following
983	question) there are two standard values that can be used for
984	Backspace: C<^H> and C<^?>.
985
986	Historically, either value is correct, but rxvt-unicode adopts the debian
987	policy of using C<^?> when unsure, because it's the one only only correct
988	choice :).
989
990	Rxvt-unicode tries to inherit the current stty settings and uses the value
991	of `erase' to guess the value for backspace. If rxvt-unicode wasn't
992	started from a terminal (say, from a menu or by remote shell), then the
993	system value of `erase', which corresponds to CERASE in <termios.h>, will
994	be used (which may not be the same as your stty setting).
995
996	For starting a new rxvt-unicode:
997
998	# use Backspace = ^H
999	$ stty erase ^H
1000	$ @@RXVT_NAME@@
1001
1002	# use Backspace = ^?
1003	$ stty erase ^?
1004	$ @@RXVT_NAME@@
1005
1006	Toggle with "ESC[36h" / "ESC[36l" as documented in @@RXVT_NAME@@(7).
1007
1008	For an existing rxvt-unicode:
1009
1010	# use Backspace = ^H
1011	$ stty erase ^H
1012	$ echo -n "^[[36h"
1013
1014	# use Backspace = ^?
1015	$ stty erase ^?
1016	$ echo -n "^[[36l"
1017
1018	This helps satisfy some of the Backspace discrepancies that occur, but
1019	if you use Backspace = C<^H>, make sure that the termcap/terminfo value
1020	properly reflects that.
1021
1022	The Delete key is a another casualty of the ill-defined Backspace problem.
1023	To avoid confusion between the Backspace and Delete keys, the Delete
1024	key has been assigned an escape sequence to match the vt100 for Execute
1025	(ESC[3~) and is in the supplied termcap/terminfo.
1026
1027	Some other Backspace problems:
1028
1029	some editors use termcap/terminfo,
1030	some editors (vim I'm told) expect Backspace = ^H,
1031	GNU Emacs (and Emacs-like editors) use ^H for help.
1032
1033	Perhaps someday this will all be resolved in a consistent manner.
1034
1035	=item I don't like the key-bindings. How do I change them?
1036
1037	There are some compile-time selections available via configure. Unless
1038	you have run "configure" with the C<--disable-resources> option you can
1039	use the `keysym' resource to alter the keystrings associated with keysym
1040	0xFF00 - 0xFFFF (function, cursor keys, etc).
1041
1042	Here's an example for a tn3270 session started using `@@RXVT_NAME@@ -name tn3270'
1043
1044	!# ----- special uses ------:
1045	! tn3270 login, remap function and arrow keys.
1046	tn3270font: clean-bold----15-*
1047
1048	! keysym - used by rxvt only
1049	! Delete - ^D
1050	tn3270*keysym.0xFFFF: \004
1051
1052	! Home - ^A
1053	tn3270*keysym.0xFF50: \001
1054	! Left - ^B
1055	tn3270*keysym.0xFF51: \002
1056	! Up - ^P
1057	tn3270*keysym.0xFF52: \020
1058	! Right - ^F
1059	tn3270*keysym.0xFF53: \006
1060	! Down - ^N
1061	tn3270*keysym.0xFF54: \016
1062	! End - ^E
1063	tn3270*keysym.0xFF57: \005
1064
1065	! F1 - F12
1066	tn3270*keysym.0xFFBE: \e1
1067	tn3270*keysym.0xFFBF: \e2
1068	tn3270*keysym.0xFFC0: \e3
1069	tn3270*keysym.0xFFC1: \e4
1070	tn3270*keysym.0xFFC2: \e5
1071	tn3270*keysym.0xFFC3: \e6
1072	tn3270*keysym.0xFFC4: \e7
1073	tn3270*keysym.0xFFC5: \e8
1074	tn3270*keysym.0xFFC6: \e9
1075	tn3270*keysym.0xFFC7: \e0
1076	tn3270*keysym.0xFFC8: \e-
1077	tn3270*keysym.0xFFC9: \e=
1078
1079	! map Prior/Next to F7/F8
1080	tn3270*keysym.0xFF55: \e7
1081	tn3270*keysym.0xFF56: \e8
1082
1083	=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
1084	How do I make use of them? For example, the Sun Keyboard type 4
1085	has the following mappings that rxvt-unicode doesn't recognize.
1086
1087	KP_Insert == Insert
1088	F22 == Print
1089	F27 == Home
1090	F29 == Prior
1091	F33 == End
1092	F35 == Next
1093
1094	Rather than have rxvt-unicode try to accomodate all the various possible keyboard
1095	mappings, it is better to use `xmodmap' to remap the keys as required for
1096	your particular machine.
1097
1098	=item How do I distinguish if I'm running rxvt-unicode or a regular xterm?
1099	I need this to decide about setting colors etc.
1100
1101	rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
1102	check and see if that is set. Note that several programs, JED, slrn,
1103	Midnight Commander automatically check this variable to decide whether or
1104	not to use color.
1105
1106	=item How do I set the correct, full IP address for the DISPLAY variable?
1107
1108	If you've compiled rxvt-unicode with DISPLAY_IS_IP and ahve enabled
1109	insecure mode then it is possible to use the following shell script
1110	snippets to correctly set the display. If your version of rxvt-unicode
1111	wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
1112	the COLORTERM variable can be used to distinguish rxvt-unicode from a
1113	regular xterm.
1114
1115	Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
1116	snippets:
1117
1118	# Bourne/Korn/POSIX family of shells:
1119	[ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
1120	if [ ${TERM:-foo} = xterm ]; then
1121	stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
1122	echo -n '^[Z'
1123	read term_id
1124	stty icanon echo
1125	if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
1126	echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
1127	read DISPLAY # set it in our local shell
1128	fi
1129	fi
1130
1131	=item How do I compile the manual pages for myself?
1132
1133	You need to have a recent version of perl installed as F</usr/bin/perl>,
1134	one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
1135	the doc subdirectory and enter C<make alldoc>.
1136
1137	=back
1138
1139	=head1 ENVIRONMENT	1054	=head1 ENVIRONMENT
1140		1055
1141	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>	1056	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>
1142	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
1143	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
…		…
1175		1090
1176	=over 4	1091	=over 4
1177		1092
1178	=item Project Coordinator	1093	=item Project Coordinator
1179		1094
1180	@@RXVTMAINT@@ L<@@RXVT_MAINTEMAIL@@>	1095	@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@>
1181		1096
1182	=item Web page maintainter	1097	=item Web page maintainter
1183		1098
1184	@@RXVTWEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>	1099	@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1185		1100
1186	L<@@RXVT_WEBPAGE@@>	1101	L<@@RXVT_WEBPAGE@@>
1187		1102
1188	=back	1103	=back
1189		1104

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.5 by root, Sat Aug 14 03:00:32 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.5 by root, Sat Aug 14 03:00:32 2004 UTC vs.
Revision 1.43 by root, Sun Jan 16 19:22:16 2005 UTC