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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.4 by root, Fri Aug 13 03:47:09 2004 UTC vs.
Revision 1.48 by root, Thu Feb 3 10:24:10 2005 UTC

…		…
12	emulator intended as an I<xterm>(1) replacement for users who do not	12	emulator intended as an I<xterm>(1) replacement for users who do not
13	require features such as Tektronix 4014 emulation and toolkit-style	13	require features such as Tektronix 4014 emulation and toolkit-style
14	configurability. As a result, B<rxvt-unicode> uses much less swap space --	14	configurability. As a result, B<rxvt-unicode> uses much less swap space --
15	a significant advantage on a machine serving many X sessions.	15	a significant advantage on a machine serving many X sessions.
16		16
17	See also @@RXVT_NAME@@(7) for technical reference documentation (escape	17	=head1 FREQUENTLY ASKED QUESTIONS
18	sequences etc.) and the FAQ section at the end of this document.	18
		19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of frequently
		20	asked questions and answer to them and some common problems.
		21
		22	=head1 RXVT-UNICODE VS. RXVT
		23
		24	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
		25	internally. That means it can store and display most scripts in the
		26	world. Being a terminal emulator, however, some things are very difficult,
		27	especially cursive scripts such as arabic, vertically written scripts
		28	like mongolian or scripts requiring extremely complex combining rules,
		29	like tibetan or devenagari. Don't expect pretty output when using these
		30	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
		31	fine, though. A somewhat difficult case are left-to-right scripts, such
		32	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
		33	belong into the application, not the terminal emulator (too many things --
		34	such as cursor-movement while editing -- break otherwise), but that might
		35	change.
		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
		43	Therefore another design rationale was the use of multiple fonts to
		44	display characters: The idea of a single unicode font which many other
		45	programs force onto it's users never made sense to me: You should be able
		46	to choose any font for any script freely.
		47
		48	Apart from that, rxvt-unicode is also much better internationalised than
		49	it's predecessor, supports things such as XFT and ISO 14755 that are handy
		50	in i18n-environments, is faster, and has a lot less bugs than the original
		51	rxvt. This all in addition to dozens of other small improvements.
		52
		53	It is still faithfully following the original rxvt idea of being lean
		54	and nice on resources: for example, you can still configure rxvt-unicode
		55	without most of it's features to get a lean binary. It also comes with
		56	a client/daemon pair that lets you open any number of terminal windows
		57	from within a single process, which makes startup time very fast and
		58	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
		59	@@RXVT_NAME@@c(1) (client).
		60
		61	It also makes technical information about escape sequences (which have
		62	been extended) easier accessible: see @@RXVT_NAME@@(7) for technical
		63	reference documentation (escape sequences etc.).
19		64
20	=head1 OPTIONS	65	=head1 OPTIONS
21		66
22	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
23	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
…		…
65	Turn on/off inheriting parent window's pixmap. Alternative form is	110	Turn on/off inheriting parent window's pixmap. Alternative form is
66	B<-tr>; resource B<inheritPixmap>.	111	B<-tr>; resource B<inheritPixmap>.
67		112
68	=item B<-fade> I<number>	113	=item B<-fade> I<number>
69		114
70	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>.
71		116
72	=item B<-tint> I<colour>	117	=item B<-tint> I<colour>
73		118
74	Tint the transparent background pixmap with the given colour when	119	Tint the transparent background pixmap with the given colour when
75	transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>	120	transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>
…		…
78		123
79	=item B<-sh>	124	=item B<-sh>
80		125
81	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	126	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
82	background image in addition to tinting it (i.e. B<-tint> must be	127	background image in addition to tinting it (i.e. B<-tint> must be
83	specified, too).	128	specified, too, e.g. C<-tint white>).
84		129
85	=item B<-bg> I<colour>	130	=item B<-bg> I<colour>
86		131
87	Window background colour; resource B<background>.	132	Window background colour; resource B<background>.
88		133
…		…
91	Window foreground colour; resource B<foreground>.	136	Window foreground colour; resource B<foreground>.
92		137
93	=item B<-pixmap> I<file[;geom]>	138	=item B<-pixmap> I<file[;geom]>
94		139
95	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
96	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
97	quotes to avoid special shell interpretation of the `;' in the	142	add quotes to avoid special shell interpretation of the C<;> in the
98	command-line; resource B<backgroundPixmap>.	143	command-line; resource B<backgroundPixmap>.
99		144
100	=item B<-cr> I<colour>	145	=item B<-cr> I<colour>
101		146
102	The cursor colour; resource B<cursorColor>.	147	The cursor colour; resource B<cursorColor>.
…		…
109		154
110	The mouse pointer background colour; resource B<pointerColor2>.	155	The mouse pointer background colour; resource B<pointerColor2>.
111		156
112	=item B<-bd> I<colour>	157	=item B<-bd> I<colour>
113		158
114	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;
115	resource B<borderColor>.	160	resource B<borderColor>.
116		161
117	=item B<-fn> I<fontname>	162	=item B<-fn> I<fontlist>
118		163
119	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
120	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
121	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
122	be smaller, but not larger. A reasonable default font list is always	167	smaller, but not (in general) larger. A (hopefully) reasonable default
123	appended to it. resource B<font>.	168	font list is always appended to it. See resource B<font> for more details.
124		169
125	=item B<-rb>\|B<+rb>	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.:
126		173
127	Enable "real bold" support. When this option is on, bold text will be	174	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
128	displayed using the first available bold font in the font list. Bold	175	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
129	fonts should thus be specified in the font list after their	176
130	corresponding regular fonts. If no bold font can be found, a regular	177	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
131	font will be used. resource B<realBold>.	178	section of @@RXVT_NAME@@(7).
		179
		180	=item B<-fb> I<fontlist>
		181
		182	Compile font-styles: The bold font list to use when bold characters are to
		183	be printed. See resource B<boldFont> for details.
		184
		185	=item B<-fi> I<fontlist>
		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.
132		194
133	=item B<-name> I<name>	195	=item B<-name> I<name>
134		196
135	Specify the application name under which resources are to be obtained,	197	Specify the application name under which resources are to be obtained,
136	rather than the default executable file name. Name should not contain	198	rather than the default executable file name. Name should not contain
…		…
177	=item B<-st>\|B<+st>	239	=item B<-st>\|B<+st>
178		240
179	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	241	Display normal (non XTerm/NeXT) scrollbar without/with a trough;
180	resource B<scrollBar_floating>.	242	resource B<scrollBar_floating>.
181		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
182	=item B<-bc>\|B<+bc>	252	=item B<-bc>\|B<+bc>
183		253
184	Blink the cursor; resource B<cursorBlink>.	254	Blink the cursor; resource B<cursorBlink>.
185		255
186	=item B<-iconic>	256	=item B<-iconic>
…		…
210	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
211	decorations; resource B<borderLess>.	281	decorations; resource B<borderLess>.
212		282
213	=item B<-lsp> I<number>	283	=item B<-lsp> I<number>
214		284
215	Compile I<linespace>: Lines (pixel height) to insert between each row	285	Compile I<frills>: Lines (pixel height) to insert between each row of
216	of the display; resource B<linespace>.	286	the display. Useful to work around font rendering problems; resource
		287	B<linespace>.
217		288
218	=item B<-tn> I<termname>	289	=item B<-tn> I<termname>
219		290
220	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
221	B<TERM> environment variable. This terminal type must exist in the	292	B<TERM> environment variable. This terminal type must exist in the
…		…
257		328
258	Compile I<XIM>: input method name. resource B<inputMethod>.	329	Compile I<XIM>: input method name. resource B<inputMethod>.
259		330
260	=item B<-imlocale> I<string>	331	=item B<-imlocale> I<string>
261		332
262	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	333	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
263	de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input	334	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
264	extension to be able to input japanese characters while staying in	335	input extension to be able to input japanese characters while staying in
265	another locale.	336	another locale. resource B<imLocale>.
		337
		338	=item B<-imfont> I<fontset>
		339
		340	Set the font set to use for the X Input Method, see resource B<imFont>
		341	for more info.
		342
		343	=item B<-tcw>
		344
		345	Change the meaning of triple-click selection with the left mouse
		346	button. Instead of selecting a full line it will extend the selection the
		347	end of the logical line only. resource B<tripleclickwords>.
266		348
267	=item B<-insecure>	349	=item B<-insecure>
268		350
269	Enable "insecure" mode, which currently enables most of the escape	351	Enable "insecure" mode, which currently enables most of the escape
270	sequences that echo strings. See the resource B<insecure> for more	352	sequences that echo strings. See the resource B<insecure> for more
…		…
345	high-intensity (bold = bright foreground, blink = bright background)	427	high-intensity (bold = bright foreground, blink = bright background)
346	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	428	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
347	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	429	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
348	names used are listed in the B<COLORS AND GRAPHICS> section.	430	names used are listed in the B<COLORS AND GRAPHICS> section.
349		431
		432	Colours higher than 15 cannot be set using resources (yet), but can be
		433	changed using an escape command (see @@RXVT_NAME@@(7)).
		434
		435	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
		436	88 colour support). Colours 80-87 are evenly spaces grey steps.
		437
350	=item B<colorBD:> I<colour>	438	=item B<colorBD:> I<colour>
351		439
		440	=item B<colorIT:> I<colour>
		441
352	Use the specified colour to display bold characters when the foreground	442	Use the specified colour to display bold or italic characters when the
353	colour is the default. This option will be ignored if B<realBold> is	443	foreground colour is the default. If font styles are not available
354	enabled.	444	(Compile I<styles>) and this option is unset, reverse video is used instead.
355		445
356	=item B<colorUL:> I<colour>	446	=item B<colorUL:> I<colour>
357		447
358	Use the specified colour to display underlined characters when the	448	Use the specified colour to display underlined characters when the
359	foreground colour is the default.	449	foreground colour is the default.
360		450
361	=item B<colorRV:> I<colour>	451	=item B<colorRV:> I<colour>
362		452
363	Use the specified colour as the background for reverse video	453	Use the specified colour as the background for reverse video
364	characters.	454	characters.
		455
		456	=item B<underlineColor:> I<colour>
		457
		458	If set, use the specified colour as the colour for the underline
		459	itself. If unset, use the foreground colour.
365		460
366	=item B<cursorColor:> I<colour>	461	=item B<cursorColor:> I<colour>
367		462
368	Use the specified colour for the cursor. The default is to use the	463	Use the specified colour for the cursor. The default is to use the
369	foreground colour; option B<-cr>.	464	foreground colour; option B<-cr>.
…		…
403	=item B<shading:> I<number>	498	=item B<shading:> I<number>
404		499
405	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	500	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
406	image in addition to tinting it.	501	image in addition to tinting it.
407		502
408	=item B<fading:> I<number>
409
410	Scale the tint colour by the given percentage.
411
412	=item B<scrollColor:> I<colour>	503	=item B<scrollColor:> I<colour>
413		504
414	Use the specified colour for the scrollbar [default #B2B2B2].	505	Use the specified colour for the scrollbar [default #B2B2B2].
415		506
416	=item B<troughColor:> I<colour>	507	=item B<troughColor:> I<colour>
417		508
418	Use the specified colour for the scrollbar's trough area [default	509	Use the specified colour for the scrollbar's trough area [default
419	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	510	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.
		511
		512	=item B<borderColor:> I<colour>
		513
		514	The colour of the border around the text area and between the scrollbar
		515	and the text.
420		516
421	=item B<backgroundPixmap:> I<file[;geom]>	517	=item B<backgroundPixmap:> I<file[;geom]>
422		518
423	Use the specified XPM file (note the `.xpm' extension is optional) for	519	Use the specified XPM file (note the `.xpm' extension is optional) for
424	the background and also optionally specify its scaling with a geometry	520	the background and also optionally specify its scaling with a geometry
…		…
440		536
441	Specify the colon-delimited search path for finding files (XPM and	537	Specify the colon-delimited search path for finding files (XPM and
442	menus), in addition to the paths specified by the B<RXVTPATH> and	538	menus), in addition to the paths specified by the B<RXVTPATH> and
443	B<PATH> environment variables.	539	B<PATH> environment variables.
444		540
445	=item B<font:> I<fontname>	541	=item B<font:> I<fontlist>
446		542
447	Select the fonts to be used. This is a comma seperated list of font	543	Select the fonts to be used. This is a comma separated list of font
448	names that are used in turn when trying to display Unicode characters.	544	names that are used in turn when trying to display Unicode characters.
449	The first font defines the cell size for characters; other fonts might	545	The first font defines the cell size for characters; other fonts might
450	be smaller, but not larger. A reasonable default font list is always	546	be smaller, but not larger. A reasonable default font list is always
451	appended to it. option B<-fn>.	547	appended to it. option B<-fn>.
452		548
453	=item B<realBold:> I<boolean>	549	Each font can either be a standard X11 core font (XLFD) name, with
		550	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
454		551
455	B<True>: Enable "real bold" support. When this option is on, bold text	552	In addition, each font can be prefixed with additional hints and
456	will be displayed using the first available bold font in the font list.	553	specifications enclosed in square brackets (C<[]>). The only available
457	Bold fonts should thus be specified in the font list after their	554	hint currently is C<codeset=codeset-name>, and this is only used for Xft
458	corresponding regular fonts. If no bold font can be found, a regular	555	fonts.
459	font will be used. option B<-rb>. B<False>: Display bold text in a	556
460	regular font, using the color specified with B<colorBD>; option B<+rb>.	557	For example, this font resource
		558
		559	URxvt*font: 9x15bold,\
		560	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
		561	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
		562	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
		563	xft:Code2000:antialias=false
		564
		565	specifies five fonts to be used. The first one is C<9x15bold> (actually
		566	the iso8859-1 version of the second font), which is the base font (because
		567	it is named first) and thus defines the character cell grid to be 9 pixels
		568	wide and 15 pixels high.
		569
		570	The second font is just used to add additional unicode characters not in
		571	the base font, likewise the third, which is unfortunately non-bold, but
		572	the bold version of the font does contain less characters, so this is a
		573	useful supplement.
		574
		575	The third font is an Xft font with aliasing turned off, and the characters
		576	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
		577	contains other characters, but we are not interested in them.
		578
		579	The last font is a useful catch-all font that supplies most of the
		580	remaining unicode characters.
		581
		582	=item B<boldFont:> I<fontlist>
		583
		584	=item B<italicFont:> I<fontlist>
		585
		586	=item B<boldItalicFont:> I<fontlist>
		587
		588	The font list to use for displaying B<bold>, I<italic> or B<< I<bold
		589	italic> >> characters, respectively.
		590
		591	If specified and non-empty, then the syntax is the same as for the
		592	B<font>-resource, and the given font list will be used as is, which makes
		593	it possible to substitute completely different font styles for bold and
		594	italic.
		595
		596	If unset (the default), a suitable font list will be synthesized by
		597	"morphing" the normal text font list into the desired shape. If that is
		598	not possible, replacement fonts of the desired shape will be tried.
		599
		600	If set, but empty, then this specific style is disabled and the normal
		601	text font will being used for the given style.
461		602
462	=item B<selectstyle:> I<mode>	603	=item B<selectstyle:> I<mode>
463		604
464	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	605	Set mouse selection style to B<old> which is 2.20, B<oldword> which is
465	xterm style with 2.20 old word selection, or anything else which gives	606	xterm style with 2.20 old word selection, or anything else which gives
…		…
536	B<False>: do not scroll to bottom when tty receives output; option	677	B<False>: do not scroll to bottom when tty receives output; option
537	B<+si>.	678	B<+si>.
538		679
539	=item B<scrollWithBuffer:> I<boolean>	680	=item B<scrollWithBuffer:> I<boolean>
540		681
541	B<True>: scroll with scrollback buffer when tty recieves new lines (and	682	B<True>: scroll with scrollback buffer when tty receives new lines (and
542	B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll	683	B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll
543	with scrollback buffer when tty recieves new lines; option B<-sw>.	684	with scrollback buffer when tty recieves new lines; option B<-sw>.
544		685
545	=item B<scrollTtyKeypress:> I<boolean>	686	=item B<scrollTtyKeypress:> I<boolean>
546		687
547	B<True>: scroll to bottom when a non-special key is pressed. Special keys	688	B<True>: scroll to bottom when a non-special key is pressed. Special keys
548	are those which are intercepted by rxvt-unicode for special handling and	689	are those which are intercepted by rxvt-unicode for special handling and
549	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to	690	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
550	bottom when a non-special key is pressed; option B<+sk>.	691	bottom when a non-special key is pressed; option B<+sk>.
551		692
552	=item B<smallfont_key:> I<keysym>
553
554	If enabled, use B<@@HOTKEY@@->I<keysym> to toggle to a smaller font
555	[default B<@@HOTKEY@@-@@SMALLFONT@@>]
556
557	=item B<bigfont_key:> I<keysym>
558
559	If enabled, use B<@@HOTKEY@@->I<keysym> to toggle to a bigger font
560	[default B<@@HOTKEY@@-@@BIGFONT@@>]
561
562	=item B<saveLines:> I<number>	693	=item B<saveLines:> I<number>
563		694
564	Save I<number> lines in the scrollback buffer [default 64]. This	695	Save I<number> lines in the scrollback buffer [default 64]. This
565	resource is limited on most machines to 65535; option B<-sl>.	696	resource is limited on most machines to 65535; option B<-sl>.
566		697
…		…
596		727
597	=item B<mouseWheelScrollPage:> I<boolean>	728	=item B<mouseWheelScrollPage:> I<boolean>
598		729
599	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel	730	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
600	scrolls five lines [default].	731	scrolls five lines [default].
		732
		733	=item B<pastableTabs:> I<boolean>
		734
		735	B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
		736	movement only; option C<-ptab>.
601		737
602	=item B<cursorBlink:> I<boolean>	738	=item B<cursorBlink:> I<boolean>
603		739
604	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	740	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
605	option B<-bc>.	741	option B<-bc>.
…		…
650		786
651	I<name> of inputMethod to use; option B<-im>.	787	I<name> of inputMethod to use; option B<-im>.
652		788
653	=item B<imLocale:> I<name>	789	=item B<imLocale:> I<name>
654		790
655	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	791	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
656	de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input	792	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
657	extension to be able to input japanese characters while staying in	793	input extension to be able to input japanese characters while staying in
658	another locale. option B<-imlocale>.	794	another locale. option B<-imlocale>.
659		795
660	=item B<insecure>	796	=item B<imFont:> I<fontset>
		797
		798	Specify the font-set used for XIM styles C<OverTheSpot> or
		799	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
		800	by commas), i.e. it's not in the same format as the other font lists used
		801	in @@RXVT_NAME@@. The default will be set-up to chose any suitable found
		802	found, preferably one or two pixels differing in size to the base font.
		803	option B<-imfont>.
		804
		805	=item B<tripleclickwords:> I<boolean>
		806
		807	Change the meaning of triple-click selection with the left mouse
		808	button. Instead of selecting a full line it will extend the selection to
		809	the end of the logical line only. option B<-tcw>.
		810
		811	=item B<insecure:> I<boolean>
661		812
662	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	813	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
663	echo arbitrary strings like the icon name or the locale. This could be	814	echo arbitrary strings like the icon name or the locale. This could be
664	abused if somebody gets 8-bit-clean access to your display, wether	815	abused if somebody gets 8-bit-clean access to your display, whether
665	throuh a mail client displaying mail bodies unfiltered or though	816	throuh a mail client displaying mail bodies unfiltered or though
666	write(1). Therefore, these sequences are disabled by default. (Note	817	write(1). Therefore, these sequences are disabled by default. (Note
667	that other terminals, including xterm, have these sequences	818	that other terminals, including xterm, have these sequences
668	enabled by default). You can enable them by setting this boolean	819	enabled by default). You can enable them by setting this boolean
669	resource or specifying B<-insecure> as an option. At the moment, this	820	resource or specifying B<-insecure> as an option. At the moment, this
…		…
693	scrollback buffer and switching to/from the secondary screen will	844	scrollback buffer and switching to/from the secondary screen will
694	instead scroll the screen up.	845	instead scroll the screen up.
695		846
696	=item B<keysym.>I<sym>: I<string>	847	=item B<keysym.>I<sym>: I<string>
697		848
698	Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may	849	Compile I<frills>: Associate I<string> with keysym I<sym>. The
699	contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:	850	intervening resource name B<keysym.> cannot be omitted.
700	newline, \r: return, \t:	851
		852	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
		853	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
		854	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
		855	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
		856	B<2>, B<3>, B<4>, B<5>.
		857
		858	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
		859	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
		860	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
		861	current application keymap mode state.
		862
		863	The spellings of I<key> can be obtained by using B<xev>(1) command or
		864	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
		865	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
		866	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
		867	performed in an exact manner; however, the closest match is assured.
		868
		869	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
		870	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
701	tab, \000: octal number) or control characters (^?: delete, ^@: null,	871	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
702	^A ...) and may enclosed with double quotes so that it can start or end	872	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
703	with whitespace. The intervening resource name B<keysym.> cannot be	873	can start or end with whitespace.
704	omitted. This resource is only available when compiled with	874
705	KEYSYM_RESOURCE.	875	Please note that you need to double the C<\> when using
		876	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
		877	use C<\033> instead of C<\e> (and so on), which will work with both Xt and
		878	@@RXVT_NAME@@'s own processing).
		879
		880	You can define a range of keysyms in one shot by providing a I<string>
		881	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
		882	should be a character not used by the strings.
		883
		884	Its usage can be demonstrated by an example:
		885
		886	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
		887
		888	The above line is equivalent to the following three lines:
		889
		890	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
		891	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
		892	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
		893
		894	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
		895	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
		896	example the following means "change the current locale to C<zh_CN.GBK>
		897	when Control-Meta-c is being pressed":
		898
		899	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		900
		901	The following example will map Control-Meta-1 and Control-Meta-2 to
		902	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
		903	font-switching at runtime:
		904
		905	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		906	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
		907
		908	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
		909	info):
		910
		911	URxvt.keysym.M-C-3: command:\033[8;25;80t
		912	URxvt.keysym.M-C-4: command:\033[8;48;110t
706		913
707	=back	914	=back
708		915
709	=head1 THE SCROLLBAR	916	=head1 THE SCROLLBAR
710		917
…		…
738		945
739	=over 4	946	=over 4
740		947
741	=item B<Selection>:	948	=item B<Selection>:
742		949
743	Left click at the beginning of the region, drag to the end of the	950	Left click at the beginning of the region, drag to the end of the region
744	region and release; Right click to extend the marked region; Left	951	and release; Right click to extend the marked region; Left double-click
745	double-click to select a word; Left triple-click to select the entire	952	to select a word; Left triple-click to select the entire logical line
746	line.	953	(which can span multiple screen lines), unless modified by resource
		954	B<tripleclickwords>.
		955
		956	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
		957	(Compile: I<frills>) will create a rectangular selection instead of a normal
		958	one.
747		959
748	=item B<Insertion>:	960	=item B<Insertion>:
749		961
750	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	962	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
751	an B<@@RXVT_NAME@@> window causes the current text selection to be	963	an B<@@RXVT_NAME@@> window causes the current text selection to be
…		…
753		965
754	=back	966	=back
755		967
756	=head1 CHANGING FONTS	968	=head1 CHANGING FONTS
757		969
758	You can change fonts on-the-fly, which is to say cycle through the	970	Changing fonts (or font sizes, respectively) via the keypad is not yet
759	default font and others of various sizes, by using B<Shift-KP_Add> and	971	supported in rxvt-unicode. Bug me if you need this.
760	B<Shift-KP_Subtract>. Or, alternatively (if enabled) with	972
761	B<@@HOTKEY@@-@@BIGFONT@@> and B<@@HOTKEY@@-@@SMALLFONT@@>, where the	973	You can, however, switch fonts at runtime using escape sequences (and
762	actual key can be selected using resources	974	therefore using the menubar), e.g.:
763	B<smallfont_key>/B<bigfont_key>.	975
		976	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"
		977
		978	rxvt-unicode will automatically re-apply these fonts to the output so far.
764		979
765	=head1 ISO 14755 SUPPORT	980	=head1 ISO 14755 SUPPORT
766		981
767	Partial ISO 14755-support is implemented. that means that pressing	982	ISO 14755 is a standard for entering and viewing unicode characters
		983	and character codes using the keyboard. It consists of 4 parts. The
		984	first part is available rxvt-unicode has been compiled with
		985	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
		986	with C<--enable-iso14755>.
768		987
769	Section 5.1: Control and Shift together enters unicode input	988	=over 4
770	mode. Entering hex digits composes a Unicode character, pressing space or
771	releasing the modifiers commits the keycode and every other key cancels
772	the current input character.
773		989
774	Section 5.2: Pressing and immediately releasing Control and Shift together	990	=item * 5.1: Basic method
775	enters keycap entry mode for the next key: pressing a function key (tab,	991
776	return etc..) will enter the unicode character corresponding to the given	992	This allows you to enter unicode characters using their hexcode.
777	key.	993
		994	Start by pressing and holding both C<Control> and C<Shift>, then enter
		995	hex-digits (between one and six). Releasing C<Control> and C<Shift> will
		996	commit the character as if it were typed directly. While holding down
		997	C<Control> and C<Shift> you can also enter multiple characters by pressing
		998	C<Space>, which will commit the current character and lets you start a new
		999	one.
		1000
		1001	As an example of use, imagine a business card with a japanese e-mail
		1002	address, which you cannot type. Fortunately, the card has the e-mail
		1003	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
		1004	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
		1005	followed by releasing the modifier keys.
		1006
		1007	=item * 5.2: Keyboard symbols entry method
		1008
		1009	This mode lets you input characters representing the keycap symbols of
		1010	your keyboard, if representable in the current locale encoding.
		1011
		1012	Start by pressing C<Control> and C<Shift> together, then releasing
		1013	them. The next special key (cursor keys, home etc.) you enter will not
		1014	invoke it's usual function but instead will insert the corresponding
		1015	keycap symbol. The symbol will only be entered when the key has been
		1016	released, otherwise pressing e.g. C<Shift> would enter the symbol for
		1017	C<ISO Level 2 Switch>, although your intention might have been to enter a
		1018	reverse tab (Shift-Tab).
		1019
		1020	=item * 5.3: Screen-selection entry method
		1021
		1022	While this is implemented already (it's basically the selection
		1023	mechanism), it could be extended by displaying a unicode character map.
		1024
		1025	=item * 5.4: Feedback method for identifying displayed characters for later input
		1026
		1027	This method lets you display the unicode character code associated with
		1028	characters already displayed.
		1029
		1030	You enter this mode by holding down C<Control> and C<Shift> together, then
		1031	pressing and holding the left mouse button and moving around. The unicode
		1032	hex code(s) (it might be a combining character) of the character under the
		1033	pointer is displayed until you release C<Control> and C<Shift>.
		1034
		1035	In addition to the hex codes it will display the font used to draw this
		1036	character - due to implementation reasons, characters combined with
		1037	combining characters, line drawing characters and unknown characters will
		1038	always be drawn using the built-in support font.
		1039
		1040	=back
		1041
		1042	With respect to conformance, rxvt-unicode is supposed to be compliant to
		1043	both scenario A and B of ISO 14755, including part 5.2.
778		1044
779	=head1 LOGIN STAMP	1045	=head1 LOGIN STAMP
780		1046
781	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so	1047	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
782	that it can be seen via the I<who(1)> command, and can accept messages.	1048	it can be seen via the I<who(1)> command, and can accept messages. To
783	To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on	1049	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
784	some systems.	1050	on some systems or setgid to root or to some other group on others.
785		1051
786	=head1 COLORS AND GRAPHICS	1052	=head1 COLORS AND GRAPHICS
787		1053
788	In addition to the default foreground and background colours,	1054	In addition to the default foreground and background colours,
789	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1055	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
…		…
843		1109
844	=head1 FILES	1110	=head1 FILES
845		1111
846	=over 4	1112	=over 4
847		1113
848	=item B</etc/utmp>
849
850	System file for login records.
851
852	=item B</usr/lib/X11/rgb.txt>	1114	=item B</usr/lib/X11/rgb.txt>
853		1115
854	Color names.	1116	Color names.
855		1117
856	=back	1118	=back
857		1119
858	=head1 FREQUENTLY ASKED QUESTIONS (FAQ)	1120	=head1 SEE ALSO
		1121
		1122	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
		1123
		1124	=head1 BUGS
		1125
		1126	Check the BUGS file for an up-to-date list.
		1127
		1128	Cursor change support is not yet implemented.
		1129
		1130	Click-and-drag doesn't work with X11 mouse report overriding.
		1131
		1132	=head1 CURRENT PROJECT COORDINATOR
859		1133
860	=over 4	1134	=over 4
861		1135
862	=item How do I know which rxvt-unicode version I'm using?
863
864	The version number is displayed with the usage (-h). For rxvt-unicode
865	version 2.14 and later, the escape sequence C<ESC[8n> sets the window
866	title to the version number.
867
868	=item Mouse cut/paste suddenly no longer works.
869
870	Make sure that mouse reporting is actually turned off since killing
871	some editors prematurely may leave the mouse in mouse report mode. I've
872	heard that tcsh may use mouse reporting unless it otherwise specified. A
873	quick check is to see if cut/paste works when the Alt or Shift keys are
874	depressed. See @@RXVT_NAME@@(7)
875
876	=item What's with this bold/blink stuff?
877
878	If no bold colour is set via C<colorBD:>, bold will invert text using the
879	standard foreground colour.
880
881	For the standard background colour, blinking will actually make the
882	text blink when compiled with C<--enable-blinking>. with standard
883	colours. Without C<--enable-blinking>, the blink attribute will be
884	ignored.
885
886	On ANSI colours, bold/blink attributes are used to set high-intensity
887	foreground/background colors.
888
889	color0-7 are the low-intensity colors.
890
891	color8-15 are the corresponding high-intensity colors.
892
893	=item I don't like the screen colors. How do I change them?
894
895	You can change the screen colors at run-time using F<~/.Xdefaults>
896	resources (or as long-options).
897
898	Here are values that are supposed to resemble a VGA screen,
899	including the murky brown that passes for low-intensity yellow:
900
901	Rxvt*color0: #000000
902	Rxvt*color1: #A80000
903	Rxvt*color2: #00A800
904	Rxvt*color3: #A8A800
905	Rxvt*color4: #0000A8
906	Rxvt*color5: #A800A8
907	Rxvt*color6: #00A8A8
908	Rxvt*color7: #A8A8A8
909
910	Rxvt*color8: #000054
911	Rxvt*color9: #FF0054
912	Rxvt*color10: #00FF54
913	Rxvt*color11: #FFFF54
914	Rxvt*color12: #0000FF
915	Rxvt*color13: #FF00FF
916	Rxvt*color14: #00FFFF
917	Rxvt*color15: #FFFFFF
918
919	=item What's with the strange Backspace/Delete key behaviour?
920
921	Assuming that the physical Backspace key corresponds to the
922	BackSpace keysym (not likely for Linux ... see the following
923	question) there are two standard values that can be used for
924	Backspace: C<^H> and C<^?>.
925
926	Historically, either value is correct, but rxvt-unicode adopts the debian
927	policy of using C<^?> when unsure, because it's the one only only correct
928	choice :).
929
930	Rxvt-unicode tries to inherit the current stty settings and uses the value
931	of `erase' to guess the value for backspace. If rxvt-unicode wasn't
932	started from a terminal (say, from a menu or by remote shell), then the
933	system value of `erase', which corresponds to CERASE in <termios.h>, will
934	be used (which may not be the same as your stty setting).
935
936	For starting a new rxvt-unicode:
937
938	# use Backspace = ^H
939	$ stty erase ^H
940	$ @@RXVT_NAME@@
941
942	# use Backspace = ^?
943	$ stty erase ^?
944	$ @@RXVT_NAME@@
945
946	Toggle with "ESC[36h" / "ESC[36l" as documented in @@RXVT_NAME@@(7).
947
948	For an existing rxvt-unicode:
949
950	# use Backspace = ^H
951	$ stty erase ^H
952	$ echo -n "^[[36h"
953
954	# use Backspace = ^?
955	$ stty erase ^?
956	$ echo -n "^[[36l"
957
958	This helps satisfy some of the Backspace discrepancies that occur, but
959	if you use Backspace = C<^H>, make sure that the termcap/terminfo value
960	properly reflects that.
961
962	The Delete key is a another casualty of the ill-defined Backspace problem.
963	To avoid confusion between the Backspace and Delete keys, the Delete
964	key has been assigned an escape sequence to match the vt100 for Execute
965	(ESC[3~) and is in the supplied termcap/terminfo.
966
967	Some other Backspace problems:
968
969	some editors use termcap/terminfo,
970	some editors (vim I'm told) expect Backspace = ^H,
971	GNU Emacs (and Emacs-like editors) use ^H for help.
972
973	Perhaps someday this will all be resolved in a consistent manner.
974
975	=item I don't like the key-bindings. How do I change them?
976
977	There are some compile-time selections available via configure. Unless
978	you have run "configure" with the C<--disable-resources> option you can
979	use the `keysym' resource to alter the keystrings associated with keysym
980	0xFF00 - 0xFFFF (function, cursor keys, etc).
981
982	Here's an example for a tn3270 session started using `@@RXVT_NAME@@ -name tn3270'
983
984	!# ----- special uses ------:
985	! tn3270 login, remap function and arrow keys.
986	tn3270font: clean-bold----15-*
987
988	! keysym - used by rxvt only
989	! Delete - ^D
990	tn3270*keysym.0xFFFF: \004
991
992	! Home - ^A
993	tn3270*keysym.0xFF50: \001
994	! Left - ^B
995	tn3270*keysym.0xFF51: \002
996	! Up - ^P
997	tn3270*keysym.0xFF52: \020
998	! Right - ^F
999	tn3270*keysym.0xFF53: \006
1000	! Down - ^N
1001	tn3270*keysym.0xFF54: \016
1002	! End - ^E
1003	tn3270*keysym.0xFF57: \005
1004
1005	! F1 - F12
1006	tn3270*keysym.0xFFBE: \e1
1007	tn3270*keysym.0xFFBF: \e2
1008	tn3270*keysym.0xFFC0: \e3
1009	tn3270*keysym.0xFFC1: \e4
1010	tn3270*keysym.0xFFC2: \e5
1011	tn3270*keysym.0xFFC3: \e6
1012	tn3270*keysym.0xFFC4: \e7
1013	tn3270*keysym.0xFFC5: \e8
1014	tn3270*keysym.0xFFC6: \e9
1015	tn3270*keysym.0xFFC7: \e0
1016	tn3270*keysym.0xFFC8: \e-
1017	tn3270*keysym.0xFFC9: \e=
1018
1019	! map Prior/Next to F7/F8
1020	tn3270*keysym.0xFF55: \e7
1021	tn3270*keysym.0xFF56: \e8
1022
1023	=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
1024	How do I make use of them? For example, the Sun Keyboard type 4
1025	has the following mappings that rxvt-unicode doesn't recognize.
1026
1027	KP_Insert == Insert
1028	F22 == Print
1029	F27 == Home
1030	F29 == Prior
1031	F33 == End
1032	F35 == Next
1033
1034	Rather than have rxvt-unicode try to accomodate all the various possible keyboard
1035	mappings, it is better to use `xmodmap' to remap the keys as required for
1036	your particular machine.
1037
1038	=item How do I distinguish if I'm running rxvt-unicode or a regular xterm?
1039	I need this to decide about setting colors etc.
1040
1041	rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
1042	check and see if that is set. Note that several programs, JED, slrn,
1043	Midnight Commander automatically check this variable to decide whether or
1044	not to use color.
1045
1046	=item How do I set the correct, full IP address for the DISPLAY variable?
1047
1048	If you've compiled rxvt-unicode with DISPLAY_IS_IP and ahve enabled
1049	insecure mode then it is possible to use the following shell script
1050	snippets to correctly set the display. If your version of rxvt-unicode
1051	wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
1052	the COLORTERM variable can be used to distinguish rxvt-unicode from a
1053	regular xterm.
1054
1055	Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
1056	snippets:
1057
1058	# Bourne/Korn/POSIX family of shells:
1059	[ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
1060	if [ ${TERM:-foo} = xterm ]; then
1061	stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
1062	echo -n '^[Z'
1063	read term_id
1064	stty icanon echo
1065	if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
1066	echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
1067	read DISPLAY # set it in our local shell
1068	fi
1069	fi
1070
1071	=item How do I compile the manual pages for myself?
1072
1073	You need to have a recent version of perl installed as F</usr/bin/perl>,
1074	one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
1075	the doc subdirectory and enter C<make alldoc>.
1076
1077	=back
1078
1079	=head1 SEE ALSO
1080
1081	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1082
1083	=head1 BUGS
1084
1085	Check the BUGS file for an up-to-date list.
1086
1087	Cursor change support is not yet implemented.
1088
1089	Click-and-drag doesn't work with X11 mouse report overriding.
1090
1091	=head1 CURRENT PROJECT COORDINATOR
1092
1093	=over 4
1094
1095	=item Project Coordinator	1136	=item Project Coordinator
1096		1137
1097	@@RXVTMAINT@@ L<@@RXVT_MAINTEMAIL@@>	1138	@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@>
1098		1139
1099	=item Web page maintainter	1140	=item Web page maintainter
1100		1141
1101	@@RXVTWEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>	1142	@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1102		1143
1103	L<@@RXVT_WEBPAGE@@>	1144	L<@@RXVT_WEBPAGE@@>
1104		1145
1105	=back	1146	=back
1106		1147

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.4 by root, Fri Aug 13 03:47:09 2004 UTC vs. Revision 1.48 by root, Thu Feb 3 10:24:10 2005 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.4 by root, Fri Aug 13 03:47:09 2004 UTC vs.
Revision 1.48 by root, Thu Feb 3 10:24:10 2005 UTC