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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.1 by root, Thu Aug 12 20:42:12 2004 UTC vs.
Revision 1.43 by root, Sun Jan 16 19:22:16 2005 UTC

…		…
2		2
3	rxvt-unicode (ouR XVT, unicode) - (a VT102 emulator for the X window system)	3	rxvt-unicode (ouR XVT, unicode) - (a VT102 emulator for the X window system)
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	B<@@RXVTNAME@@> [options] [-e command [ args ]]	7	B<@@RXVT_NAME@@> [options] [-e command [ args ]]
8		8
9	=head1 DESCRIPTION	9	=head1 DESCRIPTION
10		10
11	B<rxvt-unicode>, version B<@@RXVTVERSION@@>, 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		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.
		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.).
		64
17	=head1 OPTIONS	65	=head1 OPTIONS
18		66
19	The B<@@RXVTNAME@@> 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
20	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
21	eliminated or default values chosen at compile-time, so options and	69	eliminated or default values chosen at compile-time, so options and
22	defaults listed may not accurately reflect the version installed on	70	defaults listed may not accurately reflect the version installed on
23	your system. `rxvt -h' gives a list of major compile-time options on	71	your system. `@@RXVT_NAME@@ -h' gives a list of major compile-time options on
24	the I<Options> line. Option descriptions may be prefixed with which	72	the I<Options> line. Option descriptions may be prefixed with which
25	compile option each is dependent upon. e.g. `Compile I<XIM>:' requires	73	compile option each is dependent upon. e.g. `Compile I<XIM>:' requires
26	I<XIM> on the I<Options> line. Note: `rxvt -help' gives a list of all	74	I<XIM> on the I<Options> line. Note: `@@RXVT_NAME@@ -help' gives a list of all
27	command-line options compiled into your version.	75	command-line options compiled into your version.
28		76
29	Note that B<@@RXVTNAME@@> permits the resource name to be used as a	77	Note that B<@@RXVT_NAME@@> permits the resource name to be used as a
30	long-option (--/++ option) so the potential command-line options are	78	long-option (--/++ option) so the potential command-line options are
31	far greater than those listed. For example: `rxvt --loginShell --color1	79	far greater than those listed. For example: `@@RXVT_NAME@@ --loginShell --color1
32	Orange'.	80	Orange'.
33		81
34	The following options are available:	82	The following options are available:
35		83
36	=over 4	84	=over 4
…		…
62	Turn on/off inheriting parent window's pixmap. Alternative form is	110	Turn on/off inheriting parent window's pixmap. Alternative form is
63	B<-tr>; resource B<inheritPixmap>.	111	B<-tr>; resource B<inheritPixmap>.
64		112
65	=item B<-fade> I<number>	113	=item B<-fade> I<number>
66		114
67	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>.
68		116
69	=item B<-tint> I<colour>	117	=item B<-tint> I<colour>
70		118
71	Tint the transparent background pixmap with the given colour when	119	Tint the transparent background pixmap with the given colour when
72	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>
…		…
75		123
76	=item B<-sh>	124	=item B<-sh>
77		125
78	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	126	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
79	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
80	specified, too).	128	specified, too, e.g. C<-tint white>).
81		129
82	=item B<-bg> I<colour>	130	=item B<-bg> I<colour>
83		131
84	Window background colour; resource B<background>.	132	Window background colour; resource B<background>.
85		133
…		…
88	Window foreground colour; resource B<foreground>.	136	Window foreground colour; resource B<foreground>.
89		137
90	=item B<-pixmap> I<file[;geom]>	138	=item B<-pixmap> I<file[;geom]>
91		139
92	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
93	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
94	quotes to avoid special shell interpretation of the `;' in the	142	add quotes to avoid special shell interpretation of the C<;> in the
95	command-line; resource B<backgroundPixmap>.	143	command-line; resource B<backgroundPixmap>.
96		144
97	=item B<-cr> I<colour>	145	=item B<-cr> I<colour>
98		146
99	The cursor colour; resource B<cursorColor>.	147	The cursor colour; resource B<cursorColor>.
…		…
106		154
107	The mouse pointer background colour; resource B<pointerColor2>.	155	The mouse pointer background colour; resource B<pointerColor2>.
108		156
109	=item B<-bd> I<colour>	157	=item B<-bd> I<colour>
110		158
111	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;
112	resource B<borderColor>.	160	resource B<borderColor>.
113		161
114	=item B<-fn> I<fontname>	162	=item B<-fn> I<fontlist>
115		163
116	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
117	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
118	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
119	be smaller, but not larger. A reasonable default font list is always	167	smaller, but not (in general) larger. A (hopefully) reasonable default
120	appended to it. resource B<font>.	168	font list is always appended to it. See resource B<font> for more details.
121		169
122	=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.:
123		173
124	Enable "real bold" support. When this option is on, bold text will be	174	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
125	displayed using the first available bold font in the font list. Bold	175	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
126	fonts should thus be specified in the font list after their	176
127	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
128	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.
129		194
130	=item B<-name> I<name>	195	=item B<-name> I<name>
131		196
132	Specify the application name under which resources are to be obtained,	197	Specify the application name under which resources are to be obtained,
133	rather than the default executable file name. Name should not contain	198	rather than the default executable file name. Name should not contain
…		…
174	=item B<-st>\|B<+st>	239	=item B<-st>\|B<+st>
175		240
176	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	241	Display normal (non XTerm/NeXT) scrollbar without/with a trough;
177	resource B<scrollBar_floating>.	242	resource B<scrollBar_floating>.
178		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
179	=item B<-bc>\|B<+bc>	252	=item B<-bc>\|B<+bc>
180		253
181	Blink the cursor; resource B<cursorBlink>.	254	Blink the cursor; resource B<cursorBlink>.
182		255
183	=item B<-iconic>	256	=item B<-iconic>
…		…
202	B<externalBorder>.	275	B<externalBorder>.
203		276
204	=item B<-bl>	277	=item B<-bl>
205		278
206	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	279	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
207	if honoured by the WM, the rxvt window will not have window	280	if honoured by the WM, the rxvt-unicode window will not have window
208	decorations; resource B<borderLess>.	281	decorations; resource B<borderLess>.
209		282
210	=item B<-lsp> I<number>	283	=item B<-lsp> I<number>
211		284
212	Compile I<linespace>: Lines (pixel height) to insert between each row	285	Compile I<frills>: Lines (pixel height) to insert between each row of
213	of the display; resource B<linespace>.	286	the display. Useful to work around font rendering problems; resource
		287	B<linespace>.
214		288
215	=item B<-tn> I<termname>	289	=item B<-tn> I<termname>
216		290
217	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
218	B<TERM> environment variable. This terminal type must exist in the	292	B<TERM> environment variable. This terminal type must exist in the
219	I<termcap(5)> database and should have I<li#> and I<co#> entries;	293	I<termcap(5)> database and should have I<li#> and I<co#> entries;
220	resource B<termName>.	294	resource B<termName>.
221		295
222	=item B<-e> I<command [arguments]>	296	=item B<-e> I<command [arguments]>
223		297
224	Run the command with its command-line arguments in the B<@@RXVTNAME@@>	298	Run the command with its command-line arguments in the B<@@RXVT_NAME@@>
225	window; also sets the window title and icon name to be the basename of	299	window; also sets the window title and icon name to be the basename of
226	the program being executed if neither I<-title> (I<-T>) nor I<-n> are	300	the program being executed if neither I<-title> (I<-T>) nor I<-n> are
227	given on the command line. If this option is used, it must be the last	301	given on the command line. If this option is used, it must be the last
228	on the command-line. If there is no B<-e> option then the default is to	302	on the command-line. If there is no B<-e> option then the default is to
229	run the program specified by the B<SHELL> environment variable or,	303	run the program specified by the B<SHELL> environment variable or,
…		…
283	Turn on/off secondary screen scroll (default enabled); resource	357	Turn on/off secondary screen scroll (default enabled); resource
284	B<secondaryScroll>.	358	B<secondaryScroll>.
285		359
286	=item B<-xrm> I<resourcestring>	360	=item B<-xrm> I<resourcestring>
287		361
288	No effect on rxvt. Simply passes through an argument to be made	362	No effect on rxvt-unicode. Simply passes through an argument to be made
289	available in the instance's argument list. Appears in I<WM_COMMAND> in	363	available in the instance's argument list. Appears in I<WM_COMMAND> in
290	some window managers.	364	some window managers.
291		365
292	=back	366	=back
293		367
294	=head1 RESOURCES (available also as long-options)	368	=head1 RESOURCES (available also as long-options)
295		369
296	Note: `@@RXVTNAME@@ --help' gives a list of all resources (long	370	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
297	options) compiled into your version.	371	options) compiled into your version.
298		372
299	There are two different methods that @@RXVTNAME@@ can use to get the	373	There are two different methods that @@RXVT_NAME@@ can use to get the
300	Xresource data: using the X libraries (Xrm*-functions) or internal	374	Xresource data: using the X libraries (Xrm*-functions) or internal
301	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	375	Xresources reader (B<~/.Xdefaults>). For the first method (ie.
302	B<@@RXVTNAME@@ -h> lists B<XGetDefaults>), you can set and change the	376	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the
303	resources using X11 tools like B<xset>. Many distribution do also load	377	resources using X11 tools like B<xset>. Many distribution do also load
304	settings from the B<~/.Xresources> file when X starts.	378	settings from the B<~/.Xresources> file when X starts.
305		379
306	If compiled with internal Xresources support (i.e. B<@@RXVTNAME@@ -h>	380	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
307	lists B<.Xdefaults>) then B<@@RXVTNAME@@> accepts application defaults	381	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
308	set in XAPPLOADDIR/URxvt (compile-time defined: usually	382	set in XAPPLOADDIR/URxvt (compile-time defined: usually
309	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	383	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
310	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.	384	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
311	Note that when reading X resources, B<@@RXVTNAME@@> recognizes two	385	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two
312	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows	386	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows
313	resources common to both B<@@RXVTNAME@@> and the original I<rxvt> to be	387	resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be
314	easily configured, while the class name B<URxvt> allows resources	388	easily configured, while the class name B<URxvt> allows resources
315	unique to B<@@RXVTNAME@@>, notably colours and key-handling, to be	389	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be
316	shared between different B<@@RXVTNAME@@> configurations. If no	390	shared between different B<@@RXVT_NAME@@> configurations. If no
317	resources are specified, suitable defaults will be used. Command-line	391	resources are specified, suitable defaults will be used. Command-line
318	arguments can be used to override resource settings. The following	392	arguments can be used to override resource settings. The following
319	resources are allowed:	393	resources are allowed:
320		394
321	=over 4	395	=over 4
…		…
342	high-intensity (bold = bright foreground, blink = bright background)	416	high-intensity (bold = bright foreground, blink = bright background)
343	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,
344	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
345	names used are listed in the B<COLORS AND GRAPHICS> section.	419	names used are listed in the B<COLORS AND GRAPHICS> section.
346		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
347	=item B<colorBD:> I<colour>	427	=item B<colorBD:> I<colour>
348		428
		429	=item B<colorIT:> I<colour>
		430
349	Use the specified colour to display bold characters when the foreground	431	Use the specified colour to display bold or italic characters when the
350	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
351	enabled.	433	(Compile I<styles>) and this option is unset, reverse video is used instead.
352		434
353	=item B<colorUL:> I<colour>	435	=item B<colorUL:> I<colour>
354		436
355	Use the specified colour to display underlined characters when the	437	Use the specified colour to display underlined characters when the
356	foreground colour is the default.	438	foreground colour is the default.
357		439
358	=item B<colorRV:> I<colour>	440	=item B<colorRV:> I<colour>
359		441
360	Use the specified colour as the background for reverse video	442	Use the specified colour as the background for reverse video
361	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.
362		449
363	=item B<cursorColor:> I<colour>	450	=item B<cursorColor:> I<colour>
364		451
365	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
366	foreground colour; option B<-cr>.	453	foreground colour; option B<-cr>.
…		…
400	=item B<shading:> I<number>	487	=item B<shading:> I<number>
401		488
402	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	489	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
403	image in addition to tinting it.	490	image in addition to tinting it.
404		491
405	=item B<fading:> I<number>
406
407	Scale the tint colour by the given percentage.
408
409	=item B<scrollColor:> I<colour>	492	=item B<scrollColor:> I<colour>
410		493
411	Use the specified colour for the scrollbar [default #B2B2B2].	494	Use the specified colour for the scrollbar [default #B2B2B2].
412		495
413	=item B<troughColor:> I<colour>	496	=item B<troughColor:> I<colour>
414		497
415	Use the specified colour for the scrollbar's trough area [default	498	Use the specified colour for the scrollbar's trough area [default
416	#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.
417		505
418	=item B<backgroundPixmap:> I<file[;geom]>	506	=item B<backgroundPixmap:> I<file[;geom]>
419		507
420	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
421	the background and also optionally specify its scaling with a geometry	509	the background and also optionally specify its scaling with a geometry
…		…
437		525
438	Specify the colon-delimited search path for finding files (XPM and	526	Specify the colon-delimited search path for finding files (XPM and
439	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
440	B<PATH> environment variables.	528	B<PATH> environment variables.
441		529
442	=item B<font:> I<fontname>	530	=item B<font:> I<fontlist>
443		531
444	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
445	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.
446	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
447	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
448	appended to it. option B<-fn>.	536	appended to it. option B<-fn>.
449		537
450	=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:>.
451		540
452	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
453	will be displayed using the first available bold font in the font list.	542	specifications enclosed in square brackets (C<[]>). The only available
454	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
455	corresponding regular fonts. If no bold font can be found, a regular	544	fonts.
456	font will be used. option B<-rb>. B<False>: Display bold text in a	545
457	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.
458		591
459	=item B<selectstyle:> I<mode>	592	=item B<selectstyle:> I<mode>
460		593
461	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
462	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
463	xterm style selection.	596	xterm style selection.
464		597
465	=item B<scrollstyle:> I<mode>	598	=item B<scrollstyle:> I<mode>
466		599
467	Set scrollbar style to B<@@RXVTNAME@@>, B<rxvt>, B<plain>, B<next> or	600	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
468	B<xterm>	601	the author's favourite..
469		602
470	=item B<title:> I<string>	603	=item B<title:> I<string>
471		604
472	Set window title string, the default title is the command-line	605	Set window title string, the default title is the command-line
473	specified after the B<-e> option, if any, otherwise the application	606	specified after the B<-e> option, if any, otherwise the application
…		…
527	Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar	660	Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar
528	thumb with the pointer on middle button press/drag.	661	thumb with the pointer on middle button press/drag.
529		662
530	=item B<scrollTtyOutput:> I<boolean>	663	=item B<scrollTtyOutput:> I<boolean>
531		664
532	B<True>: scroll to bottom when tty receives output; option B<+si>.	665	B<True>: scroll to bottom when tty receives output; option B<-si>.
533	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
534	B<-si>.	667	B<+si>.
535		668
536	=item B<scrollWithBuffer:> I<boolean>	669	=item B<scrollWithBuffer:> I<boolean>
537		670
538	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
539	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
540	with scrollback buffer when tty recieves new lines; option B<-sw>.	673	with scrollback buffer when tty recieves new lines; option B<-sw>.
541		674
542	=item B<scrollTtyKeypress:> I<boolean>	675	=item B<scrollTtyKeypress:> I<boolean>
543		676
544	B<True>: scroll to bottom when a non-special key is pressed. Special	677	B<True>: scroll to bottom when a non-special key is pressed. Special keys
545	keys are those which are intercepted by rxvt for special handling and	678	are those which are intercepted by rxvt-unicode for special handling and
546	are not passed onto the shell; option B<-sk>. B<False>: do not scroll	679	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
547	to bottom when a non-special key is pressed; option B<+sk>.	680	bottom when a non-special key is pressed; option B<+sk>.
548
549	=item B<smallfont_key:> I<keysym>
550
551	If enabled, use B<@@HOTKEY@@->I<keysym> to toggle to a smaller font
552	[default B<@@HOTKEY@@-@@SMALLFONT@@>]
553
554	=item B<bigfont_key:> I<keysym>
555
556	If enabled, use B<@@HOTKEY@@->I<keysym> to toggle to a bigger font
557	[default B<@@HOTKEY@@-@@BIGFONT@@>]
558		681
559	=item B<saveLines:> I<number>	682	=item B<saveLines:> I<number>
560		683
561	Save I<number> lines in the scrollback buffer [default 64]. This	684	Save I<number> lines in the scrollback buffer [default 64]. This
562	resource is limited on most machines to 65535; option B<-sl>.	685	resource is limited on most machines to 65535; option B<-sl>.
…		…
572	option B<-w>, B<-bw>, B<-borderwidth>.	695	option B<-w>, B<-bw>, B<-borderwidth>.
573		696
574	=item B<borderLess:> I<boolean>	697	=item B<borderLess:> I<boolean>
575		698
576	Set MWM hints to request a borderless window, i.e. if honoured by the	699	Set MWM hints to request a borderless window, i.e. if honoured by the
577	WM, the rxvt window will not have window decorations; option B<-bl>.	700	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
578		701
579	=item B<termName:> I<termname>	702	=item B<termName:> I<termname>
580		703
581	Specifies the terminal type name to be set in the B<TERM> environment	704	Specifies the terminal type name to be set in the B<TERM> environment
582	variable; option B<-tn>.	705	variable; option B<-tn>.
…		…
593		716
594	=item B<mouseWheelScrollPage:> I<boolean>	717	=item B<mouseWheelScrollPage:> I<boolean>
595		718
596	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
597	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>.
598		726
599	=item B<cursorBlink:> I<boolean>	727	=item B<cursorBlink:> I<boolean>
600		728
601	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];
602	option B<-bc>.	730	option B<-bc>.
…		…
652	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.
653	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
654	extension to be able to input japanese characters while staying in	782	extension to be able to input japanese characters while staying in
655	another locale. option B<-imlocale>.	783	another locale. option B<-imlocale>.
656		784
657	=item B<insecure>	785	=item B<insecure:> I<boolean>
658		786
659	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	787	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
660	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
661	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
662	throuh a mail client displaying mail bodies unfiltered or though	790	throuh a mail client displaying mail bodies unfiltered or though
663	write(1). Therefore, these sequences are disabled by default. (Note	791	write(1). Therefore, these sequences are disabled by default. (Note
664	that other terminals, including xterm, have these sequences	792	that other terminals, including xterm, have these sequences
665	enabled by default). You can enable them by setting this boolean	793	enabled by default). You can enable them by setting this boolean
666	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
…		…
673	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	801	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
674	B<-mod>.	802	B<-mod>.
675		803
676	=item B<answerbackString:> I<string>	804	=item B<answerbackString:> I<string>
677		805
678	Specify the reply rxvt sends to the shell when an ENQ (control-E)	806	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
679	character is passed through. It may contain escape values as described	807	character is passed through. It may contain escape values as described
680	in the entry on B<keysym> following.	808	in the entry on B<keysym> following.
681		809
682	=item B<secondaryScreen:> I<bool>	810	=item B<secondaryScreen:> I<bool>
683		811
…		…
690	scrollback buffer and switching to/from the secondary screen will	818	scrollback buffer and switching to/from the secondary screen will
691	instead scroll the screen up.	819	instead scroll the screen up.
692		820
693	=item B<keysym.>I<sym>: I<string>	821	=item B<keysym.>I<sym>: I<string>
694		822
695	Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may	823	Compile I<frills>: Associate I<string> with keysym I<sym>. The
696	contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:	824	intervening resource name B<keysym.> cannot be omitted.
697	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,
698	tab, \000: octal number) or control characters (^?: delete, ^@: null,	845	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
699	^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
700	with whitespace. The intervening resource name B<keysym.> cannot be	847	can start or end with whitespace.
701	omitted. This resource is only available when compiled with	848
702	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>.
703		867
704	=back	868	=back
705		869
706	=head1 THE SCROLLBAR	870	=head1 THE SCROLLBAR
707		871
708	Lines of text that scroll off the top of the B<@@RXVTNAME@@> window	872	Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
709	(resource: B<saveLines>) and can be scrolled back using the scrollbar	873	(resource: B<saveLines>) and can be scrolled back using the scrollbar
710	or by keystrokes. The normal B<@@RXVTNAME@@> scrollbar has arrows and	874	or by keystrokes. The normal B<@@RXVT_NAME@@> scrollbar has arrows and
711	its behaviour is fairly intuitive. The B<xterm-scrollbar> is without	875	its behaviour is fairly intuitive. The B<xterm-scrollbar> is without
712	arrows and its behaviour mimics that of I<xterm>	876	arrows and its behaviour mimics that of I<xterm>
713		877
714	Scroll down with B<Button1> (B<xterm-scrollbar>) or B<Shift-Next>.	878	Scroll down with B<Button1> (B<xterm-scrollbar>) or B<Shift-Next>.
715	Scroll up with B<Button3> (B<xterm-scrollbar>) or B<Shift-Prior>.	879	Scroll up with B<Button3> (B<xterm-scrollbar>) or B<Shift-Prior>.
…		…
740	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
741	region and release; Right click to extend the marked region; Left	905	region and release; Right click to extend the marked region; Left
742	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
743	line.	907	line.
744		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
745	=item B<Insertion>:	913	=item B<Insertion>:
746		914
747	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
748	an B<@@RXVTNAME@@> window causes the current text selection to be	916	an B<@@RXVT_NAME@@> window causes the current text selection to be
749	inserted as if it had been typed on the keyboard.	917	inserted as if it had been typed on the keyboard.
750		918
751	=back	919	=back
752		920
753	=head1 CHANGING FONTS	921	=head1 CHANGING FONTS
754		922
755	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
756	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.
757	B<Shift-KP_Subtract>. Or, alternatively (if enabled) with	925
758	B<@@HOTKEY@@-@@BIGFONT@@> and B<@@HOTKEY@@-@@SMALLFONT@@>, where the	926	You can, however, switch fonts at runtime using escape sequences (and
759	actual key can be selected using resources	927	therefore using the menubar), e.g.:
760	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.
		932
		933	=head1 ISO 14755 SUPPORT
		934
		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>.
		940
		941	=over 4
		942
		943	=item 5.1: Basic method
		944
		945	This allows you to enter unicode characters using their hexcode.
		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.
761		997
762	=head1 LOGIN STAMP	998	=head1 LOGIN STAMP
763		999
764	B<@@RXVTNAME@@> 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
765	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.
766	To allow this feature, B<@@RXVTNAME@@> must be installed setuid root on	1002	To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on
767	some systems.	1003	some systems.
768		1004
769	=head1 COLORS AND GRAPHICS	1005	=head1 COLORS AND GRAPHICS
770		1006
771	In addition to the default foreground and background colours,	1007	In addition to the default foreground and background colours,
772	B<@@RXVTNAME@@> can display up to 16 colours (8 ANSI colours plus	1008	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
773	high-intensity bold/blink versions of the same). Here is a list of the	1009	high-intensity bold/blink versions of the same). Here is a list of the
774	colours with their B<rgb.txt> names.	1010	colours with their B<rgb.txt> names.
775		1011
776	=begin table	1012	=begin table
777		1013
…		…
806	I<xterm>(1) where the colours are only swapped if they have not otherwise	1042	I<xterm>(1) where the colours are only swapped if they have not otherwise
807	been specified. For example,	1043	been specified. For example,
808		1044
809	=over 4	1045	=over 4
810		1046
811	=item B<rxvt -fg Black -bg White -rv>	1047	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
812		1048
813	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
814	on White.	1050	on White.
815		1051
816	=back	1052	=back
817		1053
818	=head1 ENVIRONMENT	1054	=head1 ENVIRONMENT
819		1055
820	B<@@RXVTNAME@@> sets the environment variables B<TERM>, B<COLORTERM>	1056	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>
821	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
822	window id number of the B<@@RXVTNAME@@> window and it also uses and	1058	window id number of the B<@@RXVT_NAME@@> window and it also uses and
823	sets the environment variable B<DISPLAY> to specify which display	1059	sets the environment variable B<DISPLAY> to specify which display
824	terminal to use. B<@@RXVTNAME@@> uses the environment variables	1060	terminal to use. B<@@RXVT_NAME@@> uses the environment variables
825	B<RXVTPATH> and B<PATH> to find XPM files.	1061	B<RXVTPATH> and B<PATH> to find XPM files.
826		1062
827	=head1 FILES	1063	=head1 FILES
828		1064
829	=over 4	1065	=over 4
…		…
836		1072
837	Color names.	1073	Color names.
838		1074
839	=back	1075	=back
840		1076
841	=head1 SEEALSO	1077	=head1 SEE ALSO
842		1078
843	I<xterm>(1), I<sh>(1), I<resize>(1), I<X>(1), I<pty>(4), I<tty>(4), I<utmp>(5)	1079	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
844
845	See rxvtRef.html rxvtRef.txt for detailed information on recognized escape sequences and menuBar syntax, etc.
846		1080
847	=head1 BUGS	1081	=head1 BUGS
848		1082
849	Check the BUGS file for an up-to-date list.	1083	Check the BUGS file for an up-to-date list.
850		1084
851	Cursor change support is not yet implemented.	1085	Cursor change support is not yet implemented.
852		1086
853	Click-and-drag doesn't work with X11 mouse report overriding.	1087	Click-and-drag doesn't work with X11 mouse report overriding.
854		1088
855	=head1 FTP LOCATION
856
857	rxvt-+@@RXVTVERSION@@.tar.gz can be found at the following ftp sites L<@@RXVTFTPSITE@@>(@@RXVTFTPSITE@@)
858
859	=head1 CURRENT PROJECT COORDINATOR	1089	=head1 CURRENT PROJECT COORDINATOR
860		1090
861	=over 4	1091	=over 4
862		1092
863	=item Project Coordinator	1093	=item Project Coordinator
864		1094
865	@@RXVTMAINT@@ L<@@RXVTMAINTEMAIL@@>	1095	@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@>
866		1096
867	=item Web page maintainter	1097	=item Web page maintainter
868		1098
869	@@RXVTWEBMAINT@@ L<@@RXVTWEBMAINTEMAIL@@>	1099	@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
870		1100
871	L<@@RXVTWEBPAGE@@>(@@RXVTWEBPAGE@@)	1101	L<@@RXVT_WEBPAGE@@>
872		1102
873	=back	1103	=back
874		1104
875	=head1 AUTHORS	1105	=head1 AUTHORS
876		1106

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.1 by root, Thu Aug 12 20:42:12 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.1 by root, Thu Aug 12 20:42:12 2004 UTC vs.
Revision 1.43 by root, Sun Jan 16 19:22:16 2005 UTC