[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.57 by root, Mon Feb 14 18:50:57 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
		20	frequently asked questions and answer to them and some common
		21	problems. That document is also accessible on the World-Wide-Web at
		22	L<http://cvs.schmorp.de/browse/checkout/rxvt-unicode/doc/rxvt.7.html>.
		23
		24	=head1 RXVT-UNICODE VS. RXVT
		25
		26	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
		27	internally. That means it can store and display most scripts in the
		28	world. Being a terminal emulator, however, some things are very difficult,
		29	especially cursive scripts such as arabic, vertically written scripts
		30	like mongolian or scripts requiring extremely complex combining rules,
		31	like tibetan or devenagari. Don't expect pretty output when using these
		32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
		33	fine, though. A somewhat difficult case are left-to-right scripts, such
		34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
		35	belong into the application, not the terminal emulator (too many things --
		36	such as cursor-movement while editing -- break otherwise), but that might
		37	change.
		38
		39	If you are looking for a terminal that supports more exotic scripts, let
		40	me recommend C<mlterm>, which is a very userfriendly, lean and clean
		41	terminal emulator. In fact, the reason rxvt-unicode was born was solely
		42	because the author couldn't get C<mlterm> to use one font for latin1 and
		43	another for japanese.
		44
		45	Therefore another design rationale was the use of multiple fonts to
		46	display characters: The idea of a single unicode font which many other
		47	programs force onto it's users never made sense to me: You should be able
		48	to choose any font for any script freely.
		49
		50	Apart from that, rxvt-unicode is also much better internationalised than
		51	it's predecessor, supports things such as XFT and ISO 14755 that are handy
		52	in i18n-environments, is faster, and has a lot less bugs than the original
		53	rxvt. This all in addition to dozens of other small improvements.
		54
		55	It is still faithfully following the original rxvt idea of being lean
		56	and nice on resources: for example, you can still configure rxvt-unicode
		57	without most of it's features to get a lean binary. It also comes with
		58	a client/daemon pair that lets you open any number of terminal windows
		59	from within a single process, which makes startup time very fast and
		60	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
		61	@@RXVT_NAME@@c(1) (client).
		62
		63	It also makes technical information about escape sequences (which have
		64	been extended) easier accessible: see @@RXVT_NAME@@(7) for technical
		65	reference documentation (escape sequences etc.).
		66
17	=head1 OPTIONS	67	=head1 OPTIONS
18		68
19	The B<@@RXVTNAME@@> options (mostly a subset of I<xterm>'s) are listed	69	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
20	below. In keeping with the smaller-is-better philosophy, options may be	70	below. In keeping with the smaller-is-better philosophy, options may be
21	eliminated or default values chosen at compile-time, so options and	71	eliminated or default values chosen at compile-time, so options and
22	defaults listed may not accurately reflect the version installed on	72	defaults listed may not accurately reflect the version installed on
23	your system. `rxvt -h' gives a list of major compile-time options on	73	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	74	the I<Options> line. Option descriptions may be prefixed with which
25	compile option each is dependent upon. e.g. `Compile I<XIM>:' requires	75	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	76	I<XIM> on the I<Options> line. Note: `@@RXVT_NAME@@ -help' gives a list of all
27	command-line options compiled into your version.	77	command-line options compiled into your version.
28		78
29	Note that B<@@RXVTNAME@@> permits the resource name to be used as a	79	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	80	long-option (--/++ option) so the potential command-line options are
31	far greater than those listed. For example: `rxvt --loginShell --color1	81	far greater than those listed. For example: `@@RXVT_NAME@@ --loginShell --color1
32	Orange'.	82	Orange'.
33		83
34	The following options are available:	84	The following options are available:
35		85
36	=over 4	86	=over 4
…		…
62	Turn on/off inheriting parent window's pixmap. Alternative form is	112	Turn on/off inheriting parent window's pixmap. Alternative form is
63	B<-tr>; resource B<inheritPixmap>.	113	B<-tr>; resource B<inheritPixmap>.
64		114
65	=item B<-fade> I<number>	115	=item B<-fade> I<number>
66		116
67	Fade the text by the given percentage when focus is lost.	117	Fade the text by the given percentage when focus is lost. resource B<fading>.
68		118
69	=item B<-tint> I<colour>	119	=item B<-tint> I<colour>
70		120
71	Tint the transparent background pixmap with the given colour when	121	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>	122	transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>
…		…
75		125
76	=item B<-sh>	126	=item B<-sh>
77		127
78	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	128	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	129	background image in addition to tinting it (i.e. B<-tint> must be
80	specified, too).	130	specified, too, e.g. C<-tint white>).
81		131
82	=item B<-bg> I<colour>	132	=item B<-bg> I<colour>
83		133
84	Window background colour; resource B<background>.	134	Window background colour; resource B<background>.
85		135
…		…
88	Window foreground colour; resource B<foreground>.	138	Window foreground colour; resource B<foreground>.
89		139
90	=item B<-pixmap> I<file[;geom]>	140	=item B<-pixmap> I<file[;geom]>
91		141
92	Compile I<XPM>: Specify XPM file for the background and also optionally	142	Compile I<XPM>: Specify XPM file for the background and also optionally
93	specify its scaling with a geometry string. Note you may need to add	143	specify its scaling with a geometry string. Note you may need to
94	quotes to avoid special shell interpretation of the `;' in the	144	add quotes to avoid special shell interpretation of the C<;> in the
95	command-line; resource B<backgroundPixmap>.	145	command-line; resource B<backgroundPixmap>.
96		146
97	=item B<-cr> I<colour>	147	=item B<-cr> I<colour>
98		148
99	The cursor colour; resource B<cursorColor>.	149	The cursor colour; resource B<cursorColor>.
…		…
106		156
107	The mouse pointer background colour; resource B<pointerColor2>.	157	The mouse pointer background colour; resource B<pointerColor2>.
108		158
109	=item B<-bd> I<colour>	159	=item B<-bd> I<colour>
110		160
111	The colour of the border between the xterm scrollbar and the text;	161	The colour of the border around the text area and between the scrollbar and the text;
112	resource B<borderColor>.	162	resource B<borderColor>.
113		163
114	=item B<-fn> I<fontname>	164	=item B<-fn> I<fontlist>
115		165
116	Select the fonts to be used. This is a comma seperated list of font	166	Select the fonts to be used. This is a comma separated list of font names
117	names that are used in turn when trying to display Unicode characters.	167	that are used in turn when trying to display Unicode characters. The
118	The first font defines the cell size for characters; other fonts might	168	first font defines the cell size for characters; other fonts might be
119	be smaller, but not larger. A reasonable default font list is always	169	smaller, but not (in general) larger. A (hopefully) reasonable default
120	appended to it. resource B<font>.	170	font list is always appended to it. See resource B<font> for more details.
121		171
122	=item B<-rb>\|B<+rb>	172	In short, to specify an X11 core font, just specify it's name or prefix it
		173	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
		174	e.g.:
123		175
124	Enable "real bold" support. When this option is on, bold text will be	176	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
125	displayed using the first available bold font in the font list. Bold	177	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
126	fonts should thus be specified in the font list after their	178
127	corresponding regular fonts. If no bold font can be found, a regular	179	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
128	font will be used. resource B<realBold>.	180	section of @@RXVT_NAME@@(7).
		181
		182	=item B<-fb> I<fontlist>
		183
		184	Compile font-styles: The bold font list to use when bold characters are to
		185	be printed. See resource B<boldFont> for details.
		186
		187	=item B<-fi> I<fontlist>
		188
		189	Compile font-styles: The italic font list to use when bold characters are to
		190	be printed. See resource B<italicFont> for details.
		191
		192	=item B<-fbi> I<fontlist>
		193
		194	Compile font-styles: The bold italic font list to use when bold characters are to
		195	be printed. See resource B<boldItalicFont> for details.
129		196
130	=item B<-name> I<name>	197	=item B<-name> I<name>
131		198
132	Specify the application name under which resources are to be obtained,	199	Specify the application name under which resources are to be obtained,
133	rather than the default executable file name. Name should not contain	200	rather than the default executable file name. Name should not contain
…		…
174	=item B<-st>\|B<+st>	241	=item B<-st>\|B<+st>
175		242
176	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	243	Display normal (non XTerm/NeXT) scrollbar without/with a trough;
177	resource B<scrollBar_floating>.	244	resource B<scrollBar_floating>.
178		245
		246	=item B<-ptab>\|B<+ptab>
		247
		248	If enabled (default), "Horizontal Tab" characters are being stored as
		249	actual wide characters in the screen buffer, which makes it possible to
		250	select and paste them. Since a horizontal tab is a cursor movement and
		251	not an actual glyph, this can sometimes be visually annoying as the cursor
		252	on a tab character is displayed as a wide cursor; resource B<pastableTabs>.
		253
179	=item B<-bc>\|B<+bc>	254	=item B<-bc>\|B<+bc>
180		255
181	Blink the cursor; resource B<cursorBlink>.	256	Blink the cursor; resource B<cursorBlink>.
182		257
183	=item B<-iconic>	258	=item B<-iconic>
…		…
202	B<externalBorder>.	277	B<externalBorder>.
203		278
204	=item B<-bl>	279	=item B<-bl>
205		280
206	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	281	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	282	if honoured by the WM, the rxvt-unicode window will not have window
208	decorations; resource B<borderLess>.	283	decorations; resource B<borderLess>.
209		284
210	=item B<-lsp> I<number>	285	=item B<-lsp> I<number>
211		286
212	Compile I<linespace>: Lines (pixel height) to insert between each row	287	Compile I<frills>: Lines (pixel height) to insert between each row of
213	of the display; resource B<linespace>.	288	the display. Useful to work around font rendering problems; resource
		289	B<linespace>.
214		290
215	=item B<-tn> I<termname>	291	=item B<-tn> I<termname>
216		292
217	This option specifies the name of the terminal type to be set in the	293	This option specifies the name of the terminal type to be set in the
218	B<TERM> environment variable. This terminal type must exist in the	294	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;	295	I<termcap(5)> database and should have I<li#> and I<co#> entries;
220	resource B<termName>.	296	resource B<termName>.
221		297
222	=item B<-e> I<command [arguments]>	298	=item B<-e> I<command [arguments]>
223		299
224	Run the command with its command-line arguments in the B<@@RXVTNAME@@>	300	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	301	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	302	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	303	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	304	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,	305	run the program specified by the B<SHELL> environment variable or,
…		…
254		330
255	Compile I<XIM>: input method name. resource B<inputMethod>.	331	Compile I<XIM>: input method name. resource B<inputMethod>.
256		332
257	=item B<-imlocale> I<string>	333	=item B<-imlocale> I<string>
258		334
259	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	335	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
260	de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input	336	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
261	extension to be able to input japanese characters while staying in	337	input extension to be able to input japanese characters while staying in
262	another locale.	338	another locale. resource B<imLocale>.
		339
		340	=item B<-imfont> I<fontset>
		341
		342	Set the font set to use for the X Input Method, see resource B<imFont>
		343	for more info.
		344
		345	=item B<-tcw>
		346
		347	Change the meaning of triple-click selection with the left mouse
		348	button. Instead of selecting a full line it will extend the selection the
		349	end of the logical line only. resource B<tripleclickwords>.
263		350
264	=item B<-insecure>	351	=item B<-insecure>
265		352
266	Enable "insecure" mode, which currently enables most of the escape	353	Enable "insecure" mode, which currently enables most of the escape
267	sequences that echo strings. See the resource B<insecure> for more	354	sequences that echo strings. See the resource B<insecure> for more
…		…
281	=item B<-ssr>\|B<+ssr>	368	=item B<-ssr>\|B<+ssr>
282		369
283	Turn on/off secondary screen scroll (default enabled); resource	370	Turn on/off secondary screen scroll (default enabled); resource
284	B<secondaryScroll>.	371	B<secondaryScroll>.
285		372
286	=item B<-xrm> I<resourcestring>	373	=item B<-keysym.>I<sym>: I<string>
287		374
288	No effect on rxvt. Simply passes through an argument to be made	375	Remap a key symbol. See resource B<keysym>.
289	available in the instance's argument list. Appears in I<WM_COMMAND> in	376
290	some window managers.	377	=item B<-embed>: I<windowid>
		378
		379	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
		380	which enables applications to easily embed a terminal.
		381
		382	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
		383	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
		384	quite a bit, so don't expect it to keep some specific state. It's best to
		385	create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
		386
		387	The window will not be destroyed when @@RXVT_NAME@@ exits.
		388
		389	It might be useful to know that @@RXVT_NAME@@ will not close file
		390	descriptors passed to it (except for stdin/out/err, of course), so you
		391	can use file descriptors to communicate with the programs within the
		392	terminal. This works regardless of wether the C<-embed> option was used or
		393	not.
291		394
292	=back	395	=back
293		396
294	=head1 RESOURCES (available also as long-options)	397	=head1 RESOURCES (available also as long-options)
295		398
296	Note: `@@RXVTNAME@@ --help' gives a list of all resources (long	399	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
297	options) compiled into your version.	400	options) compiled into your version.
298		401
299	There are two different methods that @@RXVTNAME@@ can use to get the	402	There are two different methods that @@RXVT_NAME@@ can use to get the
300	Xresource data: using the X libraries (Xrm*-functions) or internal	403	Xresource data: using the X libraries (Xrm*-functions) or internal
301	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	404	Xresources reader (B<~/.Xdefaults>). For the first method (ie.
302	B<@@RXVTNAME@@ -h> lists B<XGetDefaults>), you can set and change the	405	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	406	resources using X11 tools like B<xrdb>. Many distribution do also load
304	settings from the B<~/.Xresources> file when X starts.	407	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
		408	will consult the following files/resources in order, with later settings
		409	overwriting earlier ones:
305		410
		411	1. system-wide app-defaults file, either locale-dependent OR global
		412	2. app-defaults file in $XAPPLRESDIR
		413	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
		414	4. SCREEN_RESOURCES for the current screen
		415	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		416
306	If compiled with internal Xresources support (i.e. B<@@RXVTNAME@@ -h>	417	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
307	lists B<.Xdefaults>) then B<@@RXVTNAME@@> accepts application defaults	418	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
308	set in XAPPLOADDIR/URxvt (compile-time defined: usually	419	set in XAPPLOADDIR/URxvt (compile-time defined: usually
309	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	420	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
310	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.	421	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
311	Note that when reading X resources, B<@@RXVTNAME@@> recognizes two	422	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	423	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	424	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	425	easily configured, while the class name B<URxvt> allows resources
315	unique to B<@@RXVTNAME@@>, notably colours and key-handling, to be	426	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be
316	shared between different B<@@RXVTNAME@@> configurations. If no	427	shared between different B<@@RXVT_NAME@@> configurations. If no
317	resources are specified, suitable defaults will be used. Command-line	428	resources are specified, suitable defaults will be used. Command-line
318	arguments can be used to override resource settings. The following	429	arguments can be used to override resource settings. The following
319	resources are allowed:	430	resources are allowed:
320		431
321	=over 4	432	=over 4
…		…
342	high-intensity (bold = bright foreground, blink = bright background)	453	high-intensity (bold = bright foreground, blink = bright background)
343	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	454	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
344	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	455	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
345	names used are listed in the B<COLORS AND GRAPHICS> section.	456	names used are listed in the B<COLORS AND GRAPHICS> section.
346		457
		458	Colours higher than 15 cannot be set using resources (yet), but can be
		459	changed using an escape command (see @@RXVT_NAME@@(7)).
		460
		461	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
		462	88 colour support). Colours 80-87 are evenly spaces grey steps.
		463
347	=item B<colorBD:> I<colour>	464	=item B<colorBD:> I<colour>
348		465
		466	=item B<colorIT:> I<colour>
		467
349	Use the specified colour to display bold characters when the foreground	468	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	469	foreground colour is the default. If font styles are not available
351	enabled.	470	(Compile I<styles>) and this option is unset, reverse video is used instead.
352		471
353	=item B<colorUL:> I<colour>	472	=item B<colorUL:> I<colour>
354		473
355	Use the specified colour to display underlined characters when the	474	Use the specified colour to display underlined characters when the
356	foreground colour is the default.	475	foreground colour is the default.
357		476
358	=item B<colorRV:> I<colour>	477	=item B<colorRV:> I<colour>
359		478
360	Use the specified colour as the background for reverse video	479	Use the specified colour as the background for reverse video
361	characters.	480	characters.
		481
		482	=item B<underlineColor:> I<colour>
		483
		484	If set, use the specified colour as the colour for the underline
		485	itself. If unset, use the foreground colour.
362		486
363	=item B<cursorColor:> I<colour>	487	=item B<cursorColor:> I<colour>
364		488
365	Use the specified colour for the cursor. The default is to use the	489	Use the specified colour for the cursor. The default is to use the
366	foreground colour; option B<-cr>.	490	foreground colour; option B<-cr>.
…		…
400	=item B<shading:> I<number>	524	=item B<shading:> I<number>
401		525
402	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	526	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
403	image in addition to tinting it.	527	image in addition to tinting it.
404		528
405	=item B<fading:> I<number>
406
407	Scale the tint colour by the given percentage.
408
409	=item B<scrollColor:> I<colour>	529	=item B<scrollColor:> I<colour>
410		530
411	Use the specified colour for the scrollbar [default #B2B2B2].	531	Use the specified colour for the scrollbar [default #B2B2B2].
412		532
413	=item B<troughColor:> I<colour>	533	=item B<troughColor:> I<colour>
414		534
415	Use the specified colour for the scrollbar's trough area [default	535	Use the specified colour for the scrollbar's trough area [default
416	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	536	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.
		537
		538	=item B<borderColor:> I<colour>
		539
		540	The colour of the border around the text area and between the scrollbar
		541	and the text.
417		542
418	=item B<backgroundPixmap:> I<file[;geom]>	543	=item B<backgroundPixmap:> I<file[;geom]>
419		544
420	Use the specified XPM file (note the `.xpm' extension is optional) for	545	Use the specified XPM file (note the `.xpm' extension is optional) for
421	the background and also optionally specify its scaling with a geometry	546	the background and also optionally specify its scaling with a geometry
…		…
437		562
438	Specify the colon-delimited search path for finding files (XPM and	563	Specify the colon-delimited search path for finding files (XPM and
439	menus), in addition to the paths specified by the B<RXVTPATH> and	564	menus), in addition to the paths specified by the B<RXVTPATH> and
440	B<PATH> environment variables.	565	B<PATH> environment variables.
441		566
442	=item B<font:> I<fontname>	567	=item B<font:> I<fontlist>
443		568
444	Select the fonts to be used. This is a comma seperated list of font	569	Select the fonts to be used. This is a comma separated list of font
445	names that are used in turn when trying to display Unicode characters.	570	names that are used in turn when trying to display Unicode characters.
446	The first font defines the cell size for characters; other fonts might	571	The first font defines the cell size for characters; other fonts might
447	be smaller, but not larger. A reasonable default font list is always	572	be smaller, but not larger. A reasonable default font list is always
448	appended to it. option B<-fn>.	573	appended to it. option B<-fn>.
449		574
450	=item B<realBold:> I<boolean>	575	Each font can either be a standard X11 core font (XLFD) name, with
		576	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
451		577
452	B<True>: Enable "real bold" support. When this option is on, bold text	578	In addition, each font can be prefixed with additional hints and
453	will be displayed using the first available bold font in the font list.	579	specifications enclosed in square brackets (C<[]>). The only available
454	Bold fonts should thus be specified in the font list after their	580	hint currently is C<codeset=codeset-name>, and this is only used for Xft
455	corresponding regular fonts. If no bold font can be found, a regular	581	fonts.
456	font will be used. option B<-rb>. B<False>: Display bold text in a	582
457	regular font, using the color specified with B<colorBD>; option B<+rb>.	583	For example, this font resource
		584
		585	URxvt*font: 9x15bold,\
		586	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
		587	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
		588	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
		589	xft:Code2000:antialias=false
		590
		591	specifies five fonts to be used. The first one is C<9x15bold> (actually
		592	the iso8859-1 version of the second font), which is the base font (because
		593	it is named first) and thus defines the character cell grid to be 9 pixels
		594	wide and 15 pixels high.
		595
		596	The second font is just used to add additional unicode characters not in
		597	the base font, likewise the third, which is unfortunately non-bold, but
		598	the bold version of the font does contain less characters, so this is a
		599	useful supplement.
		600
		601	The third font is an Xft font with aliasing turned off, and the characters
		602	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
		603	contains other characters, but we are not interested in them.
		604
		605	The last font is a useful catch-all font that supplies most of the
		606	remaining unicode characters.
		607
		608	=item B<boldFont:> I<fontlist>
		609
		610	=item B<italicFont:> I<fontlist>
		611
		612	=item B<boldItalicFont:> I<fontlist>
		613
		614	The font list to use for displaying B<bold>, I<italic> or B<< I<bold
		615	italic> >> characters, respectively.
		616
		617	If specified and non-empty, then the syntax is the same as for the
		618	B<font>-resource, and the given font list will be used as is, which makes
		619	it possible to substitute completely different font styles for bold and
		620	italic.
		621
		622	If unset (the default), a suitable font list will be synthesized by
		623	"morphing" the normal text font list into the desired shape. If that is
		624	not possible, replacement fonts of the desired shape will be tried.
		625
		626	If set, but empty, then this specific style is disabled and the normal
		627	text font will being used for the given style.
458		628
459	=item B<selectstyle:> I<mode>	629	=item B<selectstyle:> I<mode>
460		630
461	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	631	Set mouse selection style to B<old> which is 2.20, B<oldword> which is
462	xterm style with 2.20 old word selection, or anything else which gives	632	xterm style with 2.20 old word selection, or anything else which gives
463	xterm style selection.	633	xterm style selection.
464		634
465	=item B<scrollstyle:> I<mode>	635	=item B<scrollstyle:> I<mode>
466		636
467	Set scrollbar style to B<@@RXVTNAME@@>, B<rxvt>, B<plain>, B<next> or	637	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
468	B<xterm>	638	the author's favourite..
469		639
470	=item B<title:> I<string>	640	=item B<title:> I<string>
471		641
472	Set window title string, the default title is the command-line	642	Set window title string, the default title is the command-line
473	specified after the B<-e> option, if any, otherwise the application	643	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	697	Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar
528	thumb with the pointer on middle button press/drag.	698	thumb with the pointer on middle button press/drag.
529		699
530	=item B<scrollTtyOutput:> I<boolean>	700	=item B<scrollTtyOutput:> I<boolean>
531		701
532	B<True>: scroll to bottom when tty receives output; option B<+si>.	702	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	703	B<False>: do not scroll to bottom when tty receives output; option
534	B<-si>.	704	B<+si>.
535		705
536	=item B<scrollWithBuffer:> I<boolean>	706	=item B<scrollWithBuffer:> I<boolean>
537		707
538	B<True>: scroll with scrollback buffer when tty recieves new lines (and	708	B<True>: scroll with scrollback buffer when tty receives new lines (and
539	B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll	709	B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll
540	with scrollback buffer when tty recieves new lines; option B<-sw>.	710	with scrollback buffer when tty recieves new lines; option B<-sw>.
541		711
542	=item B<scrollTtyKeypress:> I<boolean>	712	=item B<scrollTtyKeypress:> I<boolean>
543		713
544	B<True>: scroll to bottom when a non-special key is pressed. Special	714	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	715	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	716	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>.	717	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		718
559	=item B<saveLines:> I<number>	719	=item B<saveLines:> I<number>
560		720
561	Save I<number> lines in the scrollback buffer [default 64]. This	721	Save I<number> lines in the scrollback buffer [default 64]. This
562	resource is limited on most machines to 65535; option B<-sl>.	722	resource is limited on most machines to 65535; option B<-sl>.
…		…
572	option B<-w>, B<-bw>, B<-borderwidth>.	732	option B<-w>, B<-bw>, B<-borderwidth>.
573		733
574	=item B<borderLess:> I<boolean>	734	=item B<borderLess:> I<boolean>
575		735
576	Set MWM hints to request a borderless window, i.e. if honoured by the	736	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>.	737	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
578		738
579	=item B<termName:> I<termname>	739	=item B<termName:> I<termname>
580		740
581	Specifies the terminal type name to be set in the B<TERM> environment	741	Specifies the terminal type name to be set in the B<TERM> environment
582	variable; option B<-tn>.	742	variable; option B<-tn>.
…		…
593		753
594	=item B<mouseWheelScrollPage:> I<boolean>	754	=item B<mouseWheelScrollPage:> I<boolean>
595		755
596	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel	756	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
597	scrolls five lines [default].	757	scrolls five lines [default].
		758
		759	=item B<pastableTabs:> I<boolean>
		760
		761	B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
		762	movement only; option C<-ptab>.
598		763
599	=item B<cursorBlink:> I<boolean>	764	=item B<cursorBlink:> I<boolean>
600		765
601	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	766	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
602	option B<-bc>.	767	option B<-bc>.
…		…
647		812
648	I<name> of inputMethod to use; option B<-im>.	813	I<name> of inputMethod to use; option B<-im>.
649		814
650	=item B<imLocale:> I<name>	815	=item B<imLocale:> I<name>
651		816
652	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	817	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
653	de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input	818	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
654	extension to be able to input japanese characters while staying in	819	input extension to be able to input japanese characters while staying in
655	another locale. option B<-imlocale>.	820	another locale. option B<-imlocale>.
656		821
657	=item B<insecure>	822	=item B<imFont:> I<fontset>
		823
		824	Specify the font-set used for XIM styles C<OverTheSpot> or
		825	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
		826	by commas), i.e. it's not in the same format as the other font lists used
		827	in @@RXVT_NAME@@. The default will be set-up to chose any suitable found
		828	found, preferably one or two pixels differing in size to the base font.
		829	option B<-imfont>.
		830
		831	=item B<tripleclickwords:> I<boolean>
		832
		833	Change the meaning of triple-click selection with the left mouse
		834	button. Instead of selecting a full line it will extend the selection to
		835	the end of the logical line only. option B<-tcw>.
		836
		837	=item B<insecure:> I<boolean>
658		838
659	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	839	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
660	echo arbitrary strings like the icon name or the locale. This could be	840	echo arbitrary strings like the icon name or the locale. This could be
661	abused if somebody gets 8-bit-clean access to your display, wether	841	abused if somebody gets 8-bit-clean access to your display, whether
662	throuh a mail client displaying mail bodies unfiltered or though	842	throuh a mail client displaying mail bodies unfiltered or though
663	write(1). Therefore, these sequences are disabled by default. (Note	843	write(1). Therefore, these sequences are disabled by default. (Note
664	that other terminals, including xterm, have these sequences	844	that other terminals, including xterm, have these sequences
665	enabled by default). You can enable them by setting this boolean	845	enabled by default). You can enable them by setting this boolean
666	resource or specifying B<-insecure> as an option. At the moment, this	846	resource or specifying B<-insecure> as an option. At the moment, this
…		…
673	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	853	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
674	B<-mod>.	854	B<-mod>.
675		855
676	=item B<answerbackString:> I<string>	856	=item B<answerbackString:> I<string>
677		857
678	Specify the reply rxvt sends to the shell when an ENQ (control-E)	858	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	859	character is passed through. It may contain escape values as described
680	in the entry on B<keysym> following.	860	in the entry on B<keysym> following.
681		861
682	=item B<secondaryScreen:> I<bool>	862	=item B<secondaryScreen:> I<bool>
683		863
…		…
690	scrollback buffer and switching to/from the secondary screen will	870	scrollback buffer and switching to/from the secondary screen will
691	instead scroll the screen up.	871	instead scroll the screen up.
692		872
693	=item B<keysym.>I<sym>: I<string>	873	=item B<keysym.>I<sym>: I<string>
694		874
695	Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may	875	Compile I<frills>: Associate I<string> with keysym I<sym>. The
696	contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:	876	intervening resource name B<keysym.> cannot be omitted.
697	newline, \r: return, \t:	877
		878	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
		879	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
		880	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
		881	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
		882	B<2>, B<3>, B<4>, B<5>.
		883
		884	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
		885	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
		886	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
		887	current application keymap mode state.
		888
		889	The spellings of I<key> can be obtained by using B<xev>(1) command or
		890	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
		891	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
		892	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
		893	performed in an exact manner; however, the closest match is assured.
		894
		895	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
		896	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
698	tab, \000: octal number) or control characters (^?: delete, ^@: null,	897	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	898	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	899	can start or end with whitespace.
701	omitted. This resource is only available when compiled with	900
702	KEYSYM_RESOURCE.	901	Please note that you need to double the C<\> when using
		902	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
		903	use C<\033> instead of C<\e> (and so on), which will work with both Xt and
		904	@@RXVT_NAME@@'s own processing).
		905
		906	You can define a range of keysyms in one shot by providing a I<string>
		907	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
		908	should be a character not used by the strings.
		909
		910	Its usage can be demonstrated by an example:
		911
		912	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
		913
		914	The above line is equivalent to the following three lines:
		915
		916	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
		917	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
		918	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
		919
		920	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
		921	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
		922	example the following means "change the current locale to C<zh_CN.GBK>
		923	when Control-Meta-c is being pressed":
		924
		925	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		926
		927	The following example will map Control-Meta-1 and Control-Meta-2 to
		928	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
		929	font-switching at runtime:
		930
		931	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		932	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
		933
		934	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
		935	info):
		936
		937	URxvt.keysym.M-C-3: command:\033[8;25;80t
		938	URxvt.keysym.M-C-4: command:\033[8;48;110t
703		939
704	=back	940	=back
705		941
706	=head1 THE SCROLLBAR	942	=head1 THE SCROLLBAR
707		943
708	Lines of text that scroll off the top of the B<@@RXVTNAME@@> window	944	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	945	(resource: B<saveLines>) and can be scrolled back using the scrollbar
710	or by keystrokes. The normal B<@@RXVTNAME@@> scrollbar has arrows and	946	or by keystrokes. The normal B<@@RXVT_NAME@@> scrollbar has arrows and
711	its behaviour is fairly intuitive. The B<xterm-scrollbar> is without	947	its behaviour is fairly intuitive. The B<xterm-scrollbar> is without
712	arrows and its behaviour mimics that of I<xterm>	948	arrows and its behaviour mimics that of I<xterm>
713		949
714	Scroll down with B<Button1> (B<xterm-scrollbar>) or B<Shift-Next>.	950	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>.	951	Scroll up with B<Button3> (B<xterm-scrollbar>) or B<Shift-Prior>.
…		…
721	the normal text selection/insertion, hold either the Shift or the Meta	957	the normal text selection/insertion, hold either the Shift or the Meta
722	(Alt) key while performing the desired mouse action.	958	(Alt) key while performing the desired mouse action.
723		959
724	If mouse reporting mode is active, the normal scrollbar actions are	960	If mouse reporting mode is active, the normal scrollbar actions are
725	disabled -- on the assumption that we are using a fullscreen	961	disabled -- on the assumption that we are using a fullscreen
726	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	962	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
727	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	963	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
728	up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down),	964	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
729	respectively.	965	respectively.
730		966
731	=head1 TEXT SELECTION AND INSERTION	967	=head1 TEXT SELECTION AND INSERTION
732		968
733	The behaviour of text selection and insertion mechanism is similar to	969	The behaviour of text selection and insertion mechanism is similar to
…		…
735		971
736	=over 4	972	=over 4
737		973
738	=item B<Selection>:	974	=item B<Selection>:
739		975
740	Left click at the beginning of the region, drag to the end of the	976	Left click at the beginning of the region, drag to the end of the region
741	region and release; Right click to extend the marked region; Left	977	and release; Right click to extend the marked region; Left double-click
742	double-click to select a word; Left triple-click to select the entire	978	to select a word; Left triple-click to select the entire logical line
743	line.	979	(which can span multiple screen lines), unless modified by resource
		980	B<tripleclickwords>.
		981
		982	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
		983	(Compile: I<frills>) will create a rectangular selection instead of a normal
		984	one.
744		985
745	=item B<Insertion>:	986	=item B<Insertion>:
746		987
747	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	988	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
748	an B<@@RXVTNAME@@> window causes the current text selection to be	989	an B<@@RXVT_NAME@@> window causes the current text selection to be
749	inserted as if it had been typed on the keyboard.	990	inserted as if it had been typed on the keyboard.
750		991
751	=back	992	=back
752		993
753	=head1 CHANGING FONTS	994	=head1 CHANGING FONTS
754		995
755	You can change fonts on-the-fly, which is to say cycle through the	996	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	997	supported in rxvt-unicode. Bug me if you need this.
757	B<Shift-KP_Subtract>. Or, alternatively (if enabled) with	998
758	B<@@HOTKEY@@-@@BIGFONT@@> and B<@@HOTKEY@@-@@SMALLFONT@@>, where the	999	You can, however, switch fonts at runtime using escape sequences (and
759	actual key can be selected using resources	1000	therefore using the menubar), e.g.:
760	B<smallfont_key>/B<bigfont_key>.	1001
		1002	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"
		1003
		1004	rxvt-unicode will automatically re-apply these fonts to the output so far.
		1005
		1006	=head1 ISO 14755 SUPPORT
		1007
		1008	ISO 14755 is a standard for entering and viewing unicode characters
		1009	and character codes using the keyboard. It consists of 4 parts. The
		1010	first part is available rxvt-unicode has been compiled with
		1011	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
		1012	with C<--enable-iso14755>.
		1013
		1014	=over 4
		1015
		1016	=item * 5.1: Basic method
		1017
		1018	This allows you to enter unicode characters using their hexcode.
		1019
		1020	Start by pressing and holding both C<Control> and C<Shift>, then enter
		1021	hex-digits (between one and six). Releasing C<Control> and C<Shift> will
		1022	commit the character as if it were typed directly. While holding down
		1023	C<Control> and C<Shift> you can also enter multiple characters by pressing
		1024	C<Space>, which will commit the current character and lets you start a new
		1025	one.
		1026
		1027	As an example of use, imagine a business card with a japanese e-mail
		1028	address, which you cannot type. Fortunately, the card has the e-mail
		1029	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
		1030	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
		1031	followed by releasing the modifier keys.
		1032
		1033	=item * 5.2: Keyboard symbols entry method
		1034
		1035	This mode lets you input characters representing the keycap symbols of
		1036	your keyboard, if representable in the current locale encoding.
		1037
		1038	Start by pressing C<Control> and C<Shift> together, then releasing
		1039	them. The next special key (cursor keys, home etc.) you enter will not
		1040	invoke it's usual function but instead will insert the corresponding
		1041	keycap symbol. The symbol will only be entered when the key has been
		1042	released, otherwise pressing e.g. C<Shift> would enter the symbol for
		1043	C<ISO Level 2 Switch>, although your intention might have been to enter a
		1044	reverse tab (Shift-Tab).
		1045
		1046	=item * 5.3: Screen-selection entry method
		1047
		1048	While this is implemented already (it's basically the selection
		1049	mechanism), it could be extended by displaying a unicode character map.
		1050
		1051	=item * 5.4: Feedback method for identifying displayed characters for later input
		1052
		1053	This method lets you display the unicode character code associated with
		1054	characters already displayed.
		1055
		1056	You enter this mode by holding down C<Control> and C<Shift> together, then
		1057	pressing and holding the left mouse button and moving around. The unicode
		1058	hex code(s) (it might be a combining character) of the character under the
		1059	pointer is displayed until you release C<Control> and C<Shift>.
		1060
		1061	In addition to the hex codes it will display the font used to draw this
		1062	character - due to implementation reasons, characters combined with
		1063	combining characters, line drawing characters and unknown characters will
		1064	always be drawn using the built-in support font.
		1065
		1066	=back
		1067
		1068	With respect to conformance, rxvt-unicode is supposed to be compliant to
		1069	both scenario A and B of ISO 14755, including part 5.2.
761		1070
762	=head1 LOGIN STAMP	1071	=head1 LOGIN STAMP
763		1072
764	B<@@RXVTNAME@@> tries to write an entry into the I<utmp>(5) file so	1073	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
765	that it can be seen via the I<who(1)> command, and can accept messages.	1074	it can be seen via the I<who(1)> command, and can accept messages. To
766	To allow this feature, B<@@RXVTNAME@@> must be installed setuid root on	1075	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
767	some systems.	1076	on some systems or setgid to root or to some other group on others.
768		1077
769	=head1 COLORS AND GRAPHICS	1078	=head1 COLORS AND GRAPHICS
770		1079
771	In addition to the default foreground and background colours,	1080	In addition to the default foreground and background colours,
772	B<@@RXVTNAME@@> can display up to 16 colours (8 ANSI colours plus	1081	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	1082	high-intensity bold/blink versions of the same). Here is a list of the
774	colours with their B<rgb.txt> names.	1083	colours with their B<rgb.txt> names.
775		1084
776	=begin table	1085	=begin table
777		1086
…		…
806	I<xterm>(1) where the colours are only swapped if they have not otherwise	1115	I<xterm>(1) where the colours are only swapped if they have not otherwise
807	been specified. For example,	1116	been specified. For example,
808		1117
809	=over 4	1118	=over 4
810		1119
811	=item B<rxvt -fg Black -bg White -rv>	1120	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
812		1121
813	would yield White on Black, while on I<xterm>(1) it would yield Black	1122	would yield White on Black, while on I<xterm>(1) it would yield Black
814	on White.	1123	on White.
815		1124
816	=back	1125	=back
817		1126
818	=head1 ENVIRONMENT	1127	=head1 ENVIRONMENT
819		1128
820	B<@@RXVTNAME@@> sets the environment variables B<TERM>, B<COLORTERM>	1129	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
821	and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X	1130
822	window id number of the B<@@RXVTNAME@@> window and it also uses and	1131	=over 4
823	sets the environment variable B<DISPLAY> to specify which display	1132
824	terminal to use. B<@@RXVTNAME@@> uses the environment variables	1133	=item B<TERM>
825	B<RXVTPATH> and B<PATH> to find XPM files.	1134
		1135	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
		1136	resources or on the commandline.
		1137
		1138	=item B<COLORTERM>
		1139
		1140	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
		1141	compiled with XPM support, and optionally with the added extension
		1142	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
		1143
		1144	=item B<COLORFGBG>
		1145
		1146	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
		1147	the colour code used as default foreground/text colour (or the string
		1148	C<default> to indicate that the default-colour escape sequence is to be
		1149	used), C<bg> is the colour code used as default background colour (or the
		1150	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1151	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
		1152	(and do) use this information to optimize screen output.
		1153
		1154	=item B<WINDOWID>
		1155
		1156	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
		1157	window, which usually has subwindows for the scrollbar, the terminal
		1158	window and so on).
		1159
		1160	=item B<TERMINFO>
		1161
		1162	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1163	C<--with-terminfo=PATH>.
		1164
		1165	=item B<DISPLAY>
		1166
		1167	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
		1168	display in it's child processes.
		1169
		1170	=item B<SHELL>
		1171
		1172	The shell to be used for command execution, defaults to C</bin/sh>.
		1173
		1174	=item B<RXVTPATH>
		1175
		1176	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
		1177	files.
		1178
		1179	=item B<PATH>
		1180
		1181	Used in the same way as C<RXVTPATH>.
		1182
		1183	=item B<RXVT_SOCKET>
		1184
		1185	The unix domain socket path used by @@RXVT_NAME@@c(1) and
		1186	@@RXVT_NAME@@d(1).
		1187
		1188	Default C<< $HOME/.rxvt-unicode-<nodename >>.
		1189
		1190	=item B<HOME>
		1191
		1192	Used to locate the default directory for the unix domain socket for
		1193	daemon communications and to locate various resource files (such as
		1194	C<.Xdefaults>)
		1195
		1196	=item B<XAPPLRESDIR>
		1197
		1198	Directory where various X resource files are being located.
		1199
		1200	=item B<XENVIRONMENT>
		1201
		1202	If set and accessible, gives the name of a X resource file to be loaded by
		1203	@@RXVT_NAME@@.
		1204
		1205	=back
826		1206
827	=head1 FILES	1207	=head1 FILES
828		1208
829	=over 4	1209	=over 4
830		1210
831	=item B</etc/utmp>
832
833	System file for login records.
834
835	=item B</usr/lib/X11/rgb.txt>	1211	=item B</usr/lib/X11/rgb.txt>
836		1212
837	Color names.	1213	Color names.
838		1214
839	=back	1215	=back
840		1216
841	=head1 SEEALSO	1217	=head1 SEE ALSO
842		1218
843	I<xterm>(1), I<sh>(1), I<resize>(1), I<X>(1), I<pty>(4), I<tty>(4), I<utmp>(5)	1219	@@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		1220
847	=head1 BUGS	1221	=head1 BUGS
848		1222
849	Check the BUGS file for an up-to-date list.	1223	Check the BUGS file for an up-to-date list.
850		1224
851	Cursor change support is not yet implemented.	1225	Cursor change support is not yet implemented.
852		1226
853	Click-and-drag doesn't work with X11 mouse report overriding.	1227	Click-and-drag doesn't work with X11 mouse report overriding.
854		1228
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	1229	=head1 CURRENT PROJECT COORDINATOR
860		1230
861	=over 4	1231	=over 4
862		1232
863	=item Project Coordinator	1233	=item Project Coordinator
864		1234
865	@@RXVTMAINT@@ L<@@RXVTMAINTEMAIL@@>	1235	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
866		1236
867	=item Web page maintainter	1237	L<http://software.schmorp.de/#rxvt-unicode>
868
869	@@RXVTWEBMAINT@@ L<@@RXVTWEBMAINTEMAIL@@>
870
871	L<@@RXVTWEBPAGE@@>(@@RXVTWEBPAGE@@)
872		1238
873	=back	1239	=back
874		1240
875	=head1 AUTHORS	1241	=head1 AUTHORS
876		1242
…		…
901	=item Geoff Wing L<< <gcw@pobox.com> >>	1267	=item Geoff Wing L<< <gcw@pobox.com> >>
902		1268
903	Rewrote screen display and text selection routines. Project Coordinator	1269	Rewrote screen display and text selection routines. Project Coordinator
904	(changes.txt 2.4.6 - rxvt-unicode)	1270	(changes.txt 2.4.6 - rxvt-unicode)
905		1271
906	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>	1272	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
907		1273
908	Forked rxvt-unicode, rewrote most of the display code and internal	1274	Forked rxvt-unicode, rewrote most of the display code and internal
909	character handling to store text in unicode, improve xterm	1275	character handling to store text in unicode, improve xterm
910	compatibility and apply numerous other bugfixes and extensions.	1276	compatibility and apply numerous other bugfixes and extensions.
911		1277

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.57 by root, Mon Feb 14 18:50:57 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.57 by root, Mon Feb 14 18:50:57 2005 UTC