[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.69 by root, Tue Oct 25 19:04:45 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
…		…
55		105
56	=item B<-j>\|B<+j>	106	=item B<-j>\|B<+j>
57		107
58	Turn on/off jump scrolling; resource B<jumpScroll>.	108	Turn on/off jump scrolling; resource B<jumpScroll>.
59		109
60	=item B<-ip>\|B<+ip>	110	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>
61		111
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. Small values
		118	fade a little only, 100 completely replaces all colours by the fade
		119	colour; resource B<fading>.
		120
		121	=item B<-fadecolor> I<colour>
		122
		123	Fade to this colour when fading is used (see B<-fade>). The default colour
		124	is black. resource B<fadeColor>.
68		125
69	=item B<-tint> I<colour>	126	=item B<-tint> I<colour>
70		127
71	Tint the transparent background pixmap with the given colour when	128	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>	129	transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>
73	option that can be used to brighten or darken the image in addition to	130	option that can be used to brighten or darken the image in addition to
74	tinting it.	131	tinting it; resource I<tintColor>. Example:
		132
		133	@@RXVT_NAME@@ -tr -tint blue -sh 40
75		134
76	=item B<-sh>	135	=item B<-sh>
77		136
78	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	137	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	138	background image in addition to tinting it (i.e. B<-tint> must be
80	specified, too).	139	specified, too, e.g. C<-tint white>).
81		140
82	=item B<-bg> I<colour>	141	=item B<-bg> I<colour>
83		142
84	Window background colour; resource B<background>.	143	Window background colour; resource B<background>.
85		144
…		…
88	Window foreground colour; resource B<foreground>.	147	Window foreground colour; resource B<foreground>.
89		148
90	=item B<-pixmap> I<file[;geom]>	149	=item B<-pixmap> I<file[;geom]>
91		150
92	Compile I<XPM>: Specify XPM file for the background and also optionally	151	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	152	specify its scaling with a geometry string. Note you may need to
94	quotes to avoid special shell interpretation of the `;' in the	153	add quotes to avoid special shell interpretation of the C<;> in the
95	command-line; resource B<backgroundPixmap>.	154	command-line; resource B<backgroundPixmap>.
96		155
97	=item B<-cr> I<colour>	156	=item B<-cr> I<colour>
98		157
99	The cursor colour; resource B<cursorColor>.	158	The cursor colour; resource B<cursorColor>.
…		…
106		165
107	The mouse pointer background colour; resource B<pointerColor2>.	166	The mouse pointer background colour; resource B<pointerColor2>.
108		167
109	=item B<-bd> I<colour>	168	=item B<-bd> I<colour>
110		169
111	The colour of the border between the xterm scrollbar and the text;	170	The colour of the border around the text area and between the scrollbar and the text;
112	resource B<borderColor>.	171	resource B<borderColor>.
113		172
114	=item B<-fn> I<fontname>	173	=item B<-fn> I<fontlist>
115		174
116	Select the fonts to be used. This is a comma seperated list of font	175	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.	176	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	177	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	178	smaller, but not (in general) larger. A (hopefully) reasonable default
120	appended to it. resource B<font>.	179	font list is always appended to it. See resource B<font> for more details.
121		180
122	=item B<-rb>\|B<+rb>	181	In short, to specify an X11 core font, just specify it's name or prefix it
		182	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
		183	e.g.:
123		184
124	Enable "real bold" support. When this option is on, bold text will be	185	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
125	displayed using the first available bold font in the font list. Bold	186	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
126	fonts should thus be specified in the font list after their	187
127	corresponding regular fonts. If no bold font can be found, a regular	188	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
128	font will be used. resource B<realBold>.	189	section of @@RXVT_NAME@@(7).
		190
		191	=item B<-fb> I<fontlist>
		192
		193	Compile font-styles: The bold font list to use when bold characters are to
		194	be printed. See resource B<boldFont> for details.
		195
		196	=item B<-fi> I<fontlist>
		197
		198	Compile font-styles: The italic font list to use when bold characters are to
		199	be printed. See resource B<italicFont> for details.
		200
		201	=item B<-fbi> I<fontlist>
		202
		203	Compile font-styles: The bold italic font list to use when bold characters are to
		204	be printed. See resource B<boldItalicFont> for details.
129		205
130	=item B<-name> I<name>	206	=item B<-name> I<name>
131		207
132	Specify the application name under which resources are to be obtained,	208	Specify the application name under which resources are to be obtained,
133	rather than the default executable file name. Name should not contain	209	rather than the default executable file name. Name should not contain
…		…
171		247
172	Put scrollbar on right/left; resource B<scrollBar_right>.	248	Put scrollbar on right/left; resource B<scrollBar_right>.
173		249
174	=item B<-st>\|B<+st>	250	=item B<-st>\|B<+st>
175		251
176	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	252	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
177	resource B<scrollBar_floating>.	253	resource B<scrollBar_floating>.
		254
		255	=item B<-ptab>\|B<+ptab>
		256
		257	If enabled (default), "Horizontal Tab" characters are being stored as
		258	actual wide characters in the screen buffer, which makes it possible to
		259	select and paste them. Since a horizontal tab is a cursor movement and
		260	not an actual glyph, this can sometimes be visually annoying as the cursor
		261	on a tab character is displayed as a wide cursor; resource B<pastableTabs>.
178		262
179	=item B<-bc>\|B<+bc>	263	=item B<-bc>\|B<+bc>
180		264
181	Blink the cursor; resource B<cursorBlink>.	265	Blink the cursor; resource B<cursorBlink>.
182		266
…		…
202	B<externalBorder>.	286	B<externalBorder>.
203		287
204	=item B<-bl>	288	=item B<-bl>
205		289
206	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	290	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	291	if honoured by the WM, the rxvt-unicode window will not have window
208	decorations; resource B<borderLess>.	292	decorations; resource B<borderLess>.
209		293
210	=item B<-lsp> I<number>	294	=item B<-lsp> I<number>
211		295
212	Compile I<linespace>: Lines (pixel height) to insert between each row	296	Compile I<frills>: Lines (pixel height) to insert between each row of
213	of the display; resource B<linespace>.	297	the display. Useful to work around font rendering problems; resource
		298	B<linespace>.
214		299
215	=item B<-tn> I<termname>	300	=item B<-tn> I<termname>
216		301
217	This option specifies the name of the terminal type to be set in the	302	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	303	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;	304	I<termcap(5)> database and should have I<li#> and I<co#> entries;
220	resource B<termName>.	305	resource B<termName>.
221		306
222	=item B<-e> I<command [arguments]>	307	=item B<-e> I<command [arguments]>
223		308
224	Run the command with its command-line arguments in the B<@@RXVTNAME@@>	309	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	310	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	311	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	312	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	313	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,	314	run the program specified by the B<SHELL> environment variable or,
…		…
254		339
255	Compile I<XIM>: input method name. resource B<inputMethod>.	340	Compile I<XIM>: input method name. resource B<inputMethod>.
256		341
257	=item B<-imlocale> I<string>	342	=item B<-imlocale> I<string>
258		343
259	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	344	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	345	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	346	input extension to be able to input japanese characters while staying in
262	another locale.	347	another locale. resource B<imLocale>.
		348
		349	=item B<-imfont> I<fontset>
		350
		351	Set the font set to use for the X Input Method, see resource B<imFont>
		352	for more info.
		353
		354	=item B<-tcw>
		355
		356	Change the meaning of triple-click selection with the left mouse
		357	button. Instead of selecting a full line it will extend the selection the
		358	end of the logical line only. resource B<tripleclickwords>.
263		359
264	=item B<-insecure>	360	=item B<-insecure>
265		361
266	Enable "insecure" mode, which currently enables most of the escape	362	Enable "insecure" mode, which currently enables most of the escape
267	sequences that echo strings. See the resource B<insecure> for more	363	sequences that echo strings. See the resource B<insecure> for more
…		…
281	=item B<-ssr>\|B<+ssr>	377	=item B<-ssr>\|B<+ssr>
282		378
283	Turn on/off secondary screen scroll (default enabled); resource	379	Turn on/off secondary screen scroll (default enabled); resource
284	B<secondaryScroll>.	380	B<secondaryScroll>.
285		381
286	=item B<-xrm> I<resourcestring>	382	=item B<-keysym.>I<sym> I<string>
287		383
288	No effect on rxvt. Simply passes through an argument to be made	384	Remap a key symbol. See resource B<keysym>.
289	available in the instance's argument list. Appears in I<WM_COMMAND> in	385
290	some window managers.	386	=item B<-embed> I<windowid>
		387
		388	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
		389	which enables applications to easily embed a terminal.
		390
		391	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
		392	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
		393	quite a bit, so don't expect it to keep some specific state. It's best to
		394	create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
		395
		396	The window will not be destroyed when @@RXVT_NAME@@ exits.
		397
		398	It might be useful to know that @@RXVT_NAME@@ will not close file
		399	descriptors passed to it (except for stdin/out/err, of course), so you
		400	can use file descriptors to communicate with the programs within the
		401	terminal. This works regardless of wether the C<-embed> option was used or
		402	not.
		403
		404	Here is a short Gtk2-perl snippet that illustrates how this option can be
		405	used (a longer example is in F<doc/embed>):
		406
		407	my $rxvt = new Gtk2::Socket;
		408	$rxvt->signal_connect_after (realize => sub {
		409	my $xid = $_[0]->window->get_xid;
		410	system "@@RXVT_NAME@@ -embed $xid &";
		411	});
		412
		413	=item B<-pty-fd> I<fileno>
		414
		415	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
		416	pair but instead use the given filehandle as the tty master. This is
		417	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
		418	without having to run a program within it.
		419
		420	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
		421	entries and will not tinker with pty/tty permissions - you have to do that
		422	yourself if you want that.
		423
		424	Here is a example in perl that illustrates how this option can be used (a
		425	longer example is in F<doc/pty-fd>):
		426
		427	use IO::Pty;
		428	use Fcntl;
		429
		430	my $pty = new IO::Pty;
		431	fcntl $pty, F_SETFD, 0; # clear close-on-exec
		432	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		433	close $pty;
		434
		435	# now communicate with rxvt
		436	my $slave = $pty->slave;
		437	while (<$slave>) { print $slave "got <$_>\n" }
291		438
292	=back	439	=back
293		440
294	=head1 RESOURCES (available also as long-options)	441	=head1 RESOURCES (available also as long-options)
295		442
296	Note: `@@RXVTNAME@@ --help' gives a list of all resources (long	443	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
297	options) compiled into your version.	444	options) compiled into your version.
298		445
299	There are two different methods that @@RXVTNAME@@ can use to get the	446	There are two different methods that @@RXVT_NAME@@ can use to get the
300	Xresource data: using the X libraries (Xrm*-functions) or internal	447	Xresource data: using the X libraries (Xrm*-functions) or internal
301	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	448	Xresources reader (B<~/.Xdefaults>). For the first method (ie.
302	B<@@RXVTNAME@@ -h> lists B<XGetDefaults>), you can set and change the	449	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	450	resources using X11 tools like B<xrdb>. Many distribution do also load
304	settings from the B<~/.Xresources> file when X starts.	451	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
		452	will consult the following files/resources in order, with later settings
		453	overwriting earlier ones:
305		454
		455	1. system-wide app-defaults file, either locale-dependent OR global
		456	2. app-defaults file in $XAPPLRESDIR
		457	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
		458	4. SCREEN_RESOURCES for the current screen
		459	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		460
306	If compiled with internal Xresources support (i.e. B<@@RXVTNAME@@ -h>	461	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
307	lists B<.Xdefaults>) then B<@@RXVTNAME@@> accepts application defaults	462	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
308	set in XAPPLOADDIR/URxvt (compile-time defined: usually	463	set in XAPPLOADDIR/URxvt (compile-time defined: usually
309	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	464	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
310	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.	465	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
311	Note that when reading X resources, B<@@RXVTNAME@@> recognizes two	466	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	467	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	468	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	469	easily configured, while the class name B<URxvt> allows resources
315	unique to B<@@RXVTNAME@@>, notably colours and key-handling, to be	470	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be
316	shared between different B<@@RXVTNAME@@> configurations. If no	471	shared between different B<@@RXVT_NAME@@> configurations. If no
317	resources are specified, suitable defaults will be used. Command-line	472	resources are specified, suitable defaults will be used. Command-line
318	arguments can be used to override resource settings. The following	473	arguments can be used to override resource settings. The following
319	resources are allowed:	474	resources are allowed:
320		475
321	=over 4	476	=over 4
…		…
342	high-intensity (bold = bright foreground, blink = bright background)	497	high-intensity (bold = bright foreground, blink = bright background)
343	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	498	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	499	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.	500	names used are listed in the B<COLORS AND GRAPHICS> section.
346		501
		502	Colours higher than 15 cannot be set using resources (yet), but can be
		503	changed using an escape command (see @@RXVT_NAME@@(7)).
		504
		505	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
		506	88 colour support). Colours 80-87 are evenly spaces grey steps.
		507
347	=item B<colorBD:> I<colour>	508	=item B<colorBD:> I<colour>
348		509
		510	=item B<colorIT:> I<colour>
		511
349	Use the specified colour to display bold characters when the foreground	512	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	513	foreground colour is the default. If font styles are not available
351	enabled.	514	(Compile I<styles>) and this option is unset, reverse video is used instead.
352		515
353	=item B<colorUL:> I<colour>	516	=item B<colorUL:> I<colour>
354		517
355	Use the specified colour to display underlined characters when the	518	Use the specified colour to display underlined characters when the
356	foreground colour is the default.	519	foreground colour is the default.
357		520
358	=item B<colorRV:> I<colour>	521	=item B<colorRV:> I<colour>
359		522
360	Use the specified colour as the background for reverse video	523	Use the specified colour as the background for reverse video
361	characters.	524	characters.
		525
		526	=item B<underlineColor:> I<colour>
		527
		528	If set, use the specified colour as the colour for the underline
		529	itself. If unset, use the foreground colour.
362		530
363	=item B<cursorColor:> I<colour>	531	=item B<cursorColor:> I<colour>
364		532
365	Use the specified colour for the cursor. The default is to use the	533	Use the specified colour for the cursor. The default is to use the
366	foreground colour; option B<-cr>.	534	foreground colour; option B<-cr>.
…		…
389	artificial transparency. B<False>: do not inherit the parent windows'	557	artificial transparency. B<False>: do not inherit the parent windows'
390	pixmap.	558	pixmap.
391		559
392	=item B<fading:> I<number>	560	=item B<fading:> I<number>
393		561
394	Fade the text by the given percentage when focus is lost.	562	Fade the text by the given percentage when focus is lost; option B<-fade>.
		563
		564	=item B<fadeColor:> I<colour>
		565
		566	Fade to this colour, when fading is used (see B<fading:>). The default
		567	colour is black; option B<-fadecolor>.
395		568
396	=item B<tintColor:> I<colour>	569	=item B<tintColor:> I<colour>
397		570
398	Tint the transparent background pixmap with the given colour.	571	Tint the transparent background pixmap with the given colour; option
		572	B<-tint>.
399		573
400	=item B<shading:> I<number>	574	=item B<shading:> I<number>
401		575
402	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	576	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
403	image in addition to tinting it.	577	image in addition to tinting it.
404		578
405	=item B<fading:> I<number>
406
407	Scale the tint colour by the given percentage.
408
409	=item B<scrollColor:> I<colour>	579	=item B<scrollColor:> I<colour>
410		580
411	Use the specified colour for the scrollbar [default #B2B2B2].	581	Use the specified colour for the scrollbar [default #B2B2B2].
412		582
413	=item B<troughColor:> I<colour>	583	=item B<troughColor:> I<colour>
414		584
415	Use the specified colour for the scrollbar's trough area [default	585	Use the specified colour for the scrollbar's trough area [default
416	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	586	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
		587
		588	=item B<borderColor:> I<colour>
		589
		590	The colour of the border around the text area and between the scrollbar
		591	and the text.
417		592
418	=item B<backgroundPixmap:> I<file[;geom]>	593	=item B<backgroundPixmap:> I<file[;geom]>
419		594
420	Use the specified XPM file (note the `.xpm' extension is optional) for	595	Use the specified XPM file (note the `.xpm' extension is optional) for
421	the background and also optionally specify its scaling with a geometry	596	the background and also optionally specify its scaling with a geometry
…		…
437		612
438	Specify the colon-delimited search path for finding files (XPM and	613	Specify the colon-delimited search path for finding files (XPM and
439	menus), in addition to the paths specified by the B<RXVTPATH> and	614	menus), in addition to the paths specified by the B<RXVTPATH> and
440	B<PATH> environment variables.	615	B<PATH> environment variables.
441		616
442	=item B<font:> I<fontname>	617	=item B<font:> I<fontlist>
443		618
444	Select the fonts to be used. This is a comma seperated list of font	619	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.	620	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	621	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	622	be smaller, but not larger. A reasonable default font list is always
448	appended to it. option B<-fn>.	623	appended to it. option B<-fn>.
449		624
450	=item B<realBold:> I<boolean>	625	Each font can either be a standard X11 core font (XLFD) name, with
		626	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
451		627
452	B<True>: Enable "real bold" support. When this option is on, bold text	628	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.	629	specifications enclosed in square brackets (C<[]>). The only available
454	Bold fonts should thus be specified in the font list after their	630	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	631	fonts.
456	font will be used. option B<-rb>. B<False>: Display bold text in a	632
457	regular font, using the color specified with B<colorBD>; option B<+rb>.	633	For example, this font resource
		634
		635	URxvt*font: 9x15bold,\
		636	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
		637	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
		638	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
		639	xft:Code2000:antialias=false
		640
		641	specifies five fonts to be used. The first one is C<9x15bold> (actually
		642	the iso8859-1 version of the second font), which is the base font (because
		643	it is named first) and thus defines the character cell grid to be 9 pixels
		644	wide and 15 pixels high.
		645
		646	The second font is just used to add additional unicode characters not in
		647	the base font, likewise the third, which is unfortunately non-bold, but
		648	the bold version of the font does contain less characters, so this is a
		649	useful supplement.
		650
		651	The third font is an Xft font with aliasing turned off, and the characters
		652	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
		653	contains other characters, but we are not interested in them.
		654
		655	The last font is a useful catch-all font that supplies most of the
		656	remaining unicode characters.
		657
		658	=item B<boldFont:> I<fontlist>
		659
		660	=item B<italicFont:> I<fontlist>
		661
		662	=item B<boldItalicFont:> I<fontlist>
		663
		664	The font list to use for displaying B<bold>, I<italic> or B<< I<bold
		665	italic> >> characters, respectively.
		666
		667	If specified and non-empty, then the syntax is the same as for the
		668	B<font>-resource, and the given font list will be used as is, which makes
		669	it possible to substitute completely different font styles for bold and
		670	italic.
		671
		672	If unset (the default), a suitable font list will be synthesized by
		673	"morphing" the normal text font list into the desired shape. If that is
		674	not possible, replacement fonts of the desired shape will be tried.
		675
		676	If set, but empty, then this specific style is disabled and the normal
		677	text font will being used for the given style.
458		678
459	=item B<selectstyle:> I<mode>	679	=item B<selectstyle:> I<mode>
460		680
461	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	681	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	682	xterm style with 2.20 old word selection, or anything else which gives
463	xterm style selection.	683	xterm style selection.
464		684
465	=item B<scrollstyle:> I<mode>	685	=item B<scrollstyle:> I<mode>
466		686
467	Set scrollbar style to B<@@RXVTNAME@@>, B<rxvt>, B<plain>, B<next> or	687	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
468	B<xterm>	688	the author's favourite.
469		689
470	=item B<title:> I<string>	690	=item B<title:> I<string>
471		691
472	Set window title string, the default title is the command-line	692	Set window title string, the default title is the command-line
473	specified after the B<-e> option, if any, otherwise the application	693	specified after the B<-e> option, if any, otherwise the application
…		…
505		725
506	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	726	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
507	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or	727	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
508	B<Shift-Print> to include the scrollback as well.	728	B<Shift-Print> to include the scrollback as well.
509		729
		730	The string will be interpreted as if typed into the shell as-is.
		731
		732	Example:
		733
		734	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		735
		736	This creates a new file in your home directory with the screen contents
		737	everytime you hit C<Print>.
		738
510	=item B<scrollBar:> I<boolean>	739	=item B<scrollBar:> I<boolean>
511		740
512	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	741	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
513	disable the scrollbar; option B<+sb>.	742	disable the scrollbar; option B<+sb>.
514		743
…		…
527	Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar	756	Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar
528	thumb with the pointer on middle button press/drag.	757	thumb with the pointer on middle button press/drag.
529		758
530	=item B<scrollTtyOutput:> I<boolean>	759	=item B<scrollTtyOutput:> I<boolean>
531		760
532	B<True>: scroll to bottom when tty receives output; option B<+si>.	761	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	762	B<False>: do not scroll to bottom when tty receives output; option
534	B<-si>.	763	B<+si>.
535		764
536	=item B<scrollWithBuffer:> I<boolean>	765	=item B<scrollWithBuffer:> I<boolean>
537		766
538	B<True>: scroll with scrollback buffer when tty recieves new lines (and	767	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	768	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
540	with scrollback buffer when tty recieves new lines; option B<-sw>.	769	with scrollback buffer when tty recieves new lines; option B<+sw>.
541		770
542	=item B<scrollTtyKeypress:> I<boolean>	771	=item B<scrollTtyKeypress:> I<boolean>
543		772
544	B<True>: scroll to bottom when a non-special key is pressed. Special	773	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	774	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	775	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>.	776	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		777
559	=item B<saveLines:> I<number>	778	=item B<saveLines:> I<number>
560		779
561	Save I<number> lines in the scrollback buffer [default 64]. This	780	Save I<number> lines in the scrollback buffer [default 64]. This
562	resource is limited on most machines to 65535; option B<-sl>.	781	resource is limited on most machines to 65535; option B<-sl>.
…		…
572	option B<-w>, B<-bw>, B<-borderwidth>.	791	option B<-w>, B<-bw>, B<-borderwidth>.
573		792
574	=item B<borderLess:> I<boolean>	793	=item B<borderLess:> I<boolean>
575		794
576	Set MWM hints to request a borderless window, i.e. if honoured by the	795	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>.	796	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
578		797
579	=item B<termName:> I<termname>	798	=item B<termName:> I<termname>
580		799
581	Specifies the terminal type name to be set in the B<TERM> environment	800	Specifies the terminal type name to be set in the B<TERM> environment
582	variable; option B<-tn>.	801	variable; option B<-tn>.
…		…
593		812
594	=item B<mouseWheelScrollPage:> I<boolean>	813	=item B<mouseWheelScrollPage:> I<boolean>
595		814
596	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel	815	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
597	scrolls five lines [default].	816	scrolls five lines [default].
		817
		818	=item B<pastableTabs:> I<boolean>
		819
		820	B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
		821	movement only; option C<-ptab>.
598		822
599	=item B<cursorBlink:> I<boolean>	823	=item B<cursorBlink:> I<boolean>
600		824
601	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	825	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
602	option B<-bc>.	826	option B<-bc>.
…		…
615		839
616	Mouse pointer background colour.	840	Mouse pointer background colour.
617		841
618	=item B<pointerBlankDelay:> I<number>	842	=item B<pointerBlankDelay:> I<number>
619		843
620	Specifies number of seconds before blanking the pointer [default 2].	844	Specifies number of seconds before blanking the pointer [default 2]. Use a
		845	large number (e.g. C<987654321>) to effectively disable the timeout.
621		846
622	=item B<backspacekey:> I<string>	847	=item B<backspacekey:> I<string>
623		848
624	The string to send when the backspace key is pressed. If set to B<DEC>	849	The string to send when the backspace key is pressed. If set to B<DEC>
625	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	850	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
…		…
647		872
648	I<name> of inputMethod to use; option B<-im>.	873	I<name> of inputMethod to use; option B<-im>.
649		874
650	=item B<imLocale:> I<name>	875	=item B<imLocale:> I<name>
651		876
652	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	877	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	878	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	879	input extension to be able to input japanese characters while staying in
655	another locale. option B<-imlocale>.	880	another locale. option B<-imlocale>.
656		881
657	=item B<insecure>	882	=item B<imFont:> I<fontset>
		883
		884	Specify the font-set used for XIM styles C<OverTheSpot> or
		885	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
		886	by commas), i.e. it's not in the same format as the other font lists used
		887	in @@RXVT_NAME@@. The default will be set-up to chose any suitable found
		888	found, preferably one or two pixels differing in size to the base font.
		889	option B<-imfont>.
		890
		891	=item B<tripleclickwords:> I<boolean>
		892
		893	Change the meaning of triple-click selection with the left mouse
		894	button. Instead of selecting a full line it will extend the selection to
		895	the end of the logical line only. option B<-tcw>.
		896
		897	=item B<insecure:> I<boolean>
658		898
659	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	899	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
660	echo arbitrary strings like the icon name or the locale. This could be	900	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	901	abused if somebody gets 8-bit-clean access to your display, whether
662	throuh a mail client displaying mail bodies unfiltered or though	902	throuh a mail client displaying mail bodies unfiltered or though
663	write(1). Therefore, these sequences are disabled by default. (Note	903	write(1). Therefore, these sequences are disabled by default. (Note
664	that other terminals, including xterm, have these sequences	904	that other terminals, including xterm, have these sequences
665	enabled by default). You can enable them by setting this boolean	905	enabled by default). You can enable them by setting this boolean
666	resource or specifying B<-insecure> as an option. At the moment, this	906	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	913	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
674	B<-mod>.	914	B<-mod>.
675		915
676	=item B<answerbackString:> I<string>	916	=item B<answerbackString:> I<string>
677		917
678	Specify the reply rxvt sends to the shell when an ENQ (control-E)	918	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	919	character is passed through. It may contain escape values as described
680	in the entry on B<keysym> following.	920	in the entry on B<keysym> following.
681		921
682	=item B<secondaryScreen:> I<bool>	922	=item B<secondaryScreen:> I<bool>
683		923
…		…
690	scrollback buffer and switching to/from the secondary screen will	930	scrollback buffer and switching to/from the secondary screen will
691	instead scroll the screen up.	931	instead scroll the screen up.
692		932
693	=item B<keysym.>I<sym>: I<string>	933	=item B<keysym.>I<sym>: I<string>
694		934
695	Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may	935	Compile I<frills>: Associate I<string> with keysym I<sym>. The
696	contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:	936	intervening resource name B<keysym.> cannot be omitted.
697	newline, \r: return, \t:	937
		938	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
		939	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
		940	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
		941	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
		942	B<2>, B<3>, B<4>, B<5>.
		943
		944	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
		945	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
		946	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
		947	current application keymap mode state.
		948
		949	The spellings of I<key> can be obtained by using B<xev>(1) command or
		950	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
		951	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
		952	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
		953	performed in an exact manner; however, the closest match is assured.
		954
		955	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
		956	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,	957	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	958	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	959	can start or end with whitespace.
701	omitted. This resource is only available when compiled with	960
702	KEYSYM_RESOURCE.	961	Please note that you need to double the C<\> when using
		962	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
		963	use C<\033> instead of C<\e> (and so on), which will work with both Xt and
		964	@@RXVT_NAME@@'s own processing).
		965
		966	You can define a range of keysyms in one shot by providing a I<string>
		967	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
		968	should be a character not used by the strings.
		969
		970	Its usage can be demonstrated by an example:
		971
		972	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
		973
		974	The above line is equivalent to the following three lines:
		975
		976	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
		977	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
		978	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
		979
		980	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
		981	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
		982	example the following means "change the current locale to C<zh_CN.GBK>
		983	when Control-Meta-c is being pressed":
		984
		985	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		986
		987	Due the the large number of modifier combinations, a defined key mapping
		988	will match if at I<at least> the specified identifiers are being set, and
		989	no other key mappings with those and more bits are being defined. That
		990	means that defining a key map for C<a> will automatically provide
		991	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		992	mappings themselves.
		993
		994	Unfortunately, this will override built-in key mappings. For example
		995	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		996	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		997	user-defined keymap using the C<builtin:> replacement:
		998
		999	URxvt.keysym.Insert: <my insert key sequence>
		1000	URxvt.keysym.S-Insert: builtin:
		1001
		1002	The first line defines a mapping for C<Insert> and I<any> combination
		1003	of modifiers. The second line re-establishes the default mapping for
		1004	C<Shift-Insert>.
		1005
		1006	The following example will map Control-Meta-1 and Control-Meta-2 to
		1007	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
		1008	font-switching at runtime:
		1009
		1010	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1011	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
		1012
		1013	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
		1014	info):
		1015
		1016	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1017	URxvt.keysym.M-C-4: command:\033[8;48;110t
703		1018
704	=back	1019	=back
705		1020
706	=head1 THE SCROLLBAR	1021	=head1 THE SCROLLBAR
707		1022
708	Lines of text that scroll off the top of the B<@@RXVTNAME@@> window	1023	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	1024	(resource: B<saveLines>) and can be scrolled back using the scrollbar
710	or by keystrokes. The normal B<@@RXVTNAME@@> scrollbar has arrows and	1025	or by keystrokes. The normal B<@@RXVT_NAME@@> scrollbar has arrows and
711	its behaviour is fairly intuitive. The B<xterm-scrollbar> is without	1026	its behaviour is fairly intuitive. The B<xterm-scrollbar> is without
712	arrows and its behaviour mimics that of I<xterm>	1027	arrows and its behaviour mimics that of I<xterm>
713		1028
714	Scroll down with B<Button1> (B<xterm-scrollbar>) or B<Shift-Next>.	1029	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>.	1030	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	1036	the normal text selection/insertion, hold either the Shift or the Meta
722	(Alt) key while performing the desired mouse action.	1037	(Alt) key while performing the desired mouse action.
723		1038
724	If mouse reporting mode is active, the normal scrollbar actions are	1039	If mouse reporting mode is active, the normal scrollbar actions are
725	disabled -- on the assumption that we are using a fullscreen	1040	disabled -- on the assumption that we are using a fullscreen
726	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	1041	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
727	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	1042	(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),	1043	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
729	respectively.	1044	respectively.
730		1045
731	=head1 TEXT SELECTION AND INSERTION	1046	=head1 TEXT SELECTION AND INSERTION
732		1047
733	The behaviour of text selection and insertion mechanism is similar to	1048	The behaviour of text selection and insertion mechanism is similar to
…		…
735		1050
736	=over 4	1051	=over 4
737		1052
738	=item B<Selection>:	1053	=item B<Selection>:
739		1054
740	Left click at the beginning of the region, drag to the end of the	1055	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	1056	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	1057	to select a word; Left triple-click to select the entire logical line
743	line.	1058	(which can span multiple screen lines), unless modified by resource
		1059	B<tripleclickwords>.
		1060
		1061	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
		1062	(Compile: I<frills>) will create a rectangular selection instead of a normal
		1063	one.
744		1064
745	=item B<Insertion>:	1065	=item B<Insertion>:
746		1066
747	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1067	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
748	an B<@@RXVTNAME@@> window causes the current text selection to be	1068	an B<@@RXVT_NAME@@> window causes the current text selection to be
749	inserted as if it had been typed on the keyboard.	1069	inserted as if it had been typed on the keyboard.
750		1070
751	=back	1071	=back
752		1072
753	=head1 CHANGING FONTS	1073	=head1 CHANGING FONTS
754		1074
755	You can change fonts on-the-fly, which is to say cycle through the	1075	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	1076	supported in rxvt-unicode. Bug me if you need this.
757	B<Shift-KP_Subtract>. Or, alternatively (if enabled) with	1077
758	B<@@HOTKEY@@-@@BIGFONT@@> and B<@@HOTKEY@@-@@SMALLFONT@@>, where the	1078	You can, however, switch fonts at runtime using escape sequences (and
759	actual key can be selected using resources	1079	therefore using the menubar), e.g.:
760	B<smallfont_key>/B<bigfont_key>.	1080
		1081	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"
		1082
		1083	rxvt-unicode will automatically re-apply these fonts to the output so far.
		1084
		1085	=head1 ISO 14755 SUPPORT
		1086
		1087	ISO 14755 is a standard for entering and viewing unicode characters
		1088	and character codes using the keyboard. It consists of 4 parts. The
		1089	first part is available rxvt-unicode has been compiled with
		1090	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
		1091	with C<--enable-iso14755>.
		1092
		1093	=over 4
		1094
		1095	=item * 5.1: Basic method
		1096
		1097	This allows you to enter unicode characters using their hexcode.
		1098
		1099	Start by pressing and holding both C<Control> and C<Shift>, then enter
		1100	hex-digits (between one and six). Releasing C<Control> and C<Shift> will
		1101	commit the character as if it were typed directly. While holding down
		1102	C<Control> and C<Shift> you can also enter multiple characters by pressing
		1103	C<Space>, which will commit the current character and lets you start a new
		1104	one.
		1105
		1106	As an example of use, imagine a business card with a japanese e-mail
		1107	address, which you cannot type. Fortunately, the card has the e-mail
		1108	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
		1109	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
		1110	followed by releasing the modifier keys.
		1111
		1112	=item * 5.2: Keyboard symbols entry method
		1113
		1114	This mode lets you input characters representing the keycap symbols of
		1115	your keyboard, if representable in the current locale encoding.
		1116
		1117	Start by pressing C<Control> and C<Shift> together, then releasing
		1118	them. The next special key (cursor keys, home etc.) you enter will not
		1119	invoke it's usual function but instead will insert the corresponding
		1120	keycap symbol. The symbol will only be entered when the key has been
		1121	released, otherwise pressing e.g. C<Shift> would enter the symbol for
		1122	C<ISO Level 2 Switch>, although your intention might have been to enter a
		1123	reverse tab (Shift-Tab).
		1124
		1125	=item * 5.3: Screen-selection entry method
		1126
		1127	While this is implemented already (it's basically the selection
		1128	mechanism), it could be extended by displaying a unicode character map.
		1129
		1130	=item * 5.4: Feedback method for identifying displayed characters for later input
		1131
		1132	This method lets you display the unicode character code associated with
		1133	characters already displayed.
		1134
		1135	You enter this mode by holding down C<Control> and C<Shift> together, then
		1136	pressing and holding the left mouse button and moving around. The unicode
		1137	hex code(s) (it might be a combining character) of the character under the
		1138	pointer is displayed until you release C<Control> and C<Shift>.
		1139
		1140	In addition to the hex codes it will display the font used to draw this
		1141	character - due to implementation reasons, characters combined with
		1142	combining characters, line drawing characters and unknown characters will
		1143	always be drawn using the built-in support font.
		1144
		1145	=back
		1146
		1147	With respect to conformance, rxvt-unicode is supposed to be compliant to
		1148	both scenario A and B of ISO 14755, including part 5.2.
761		1149
762	=head1 LOGIN STAMP	1150	=head1 LOGIN STAMP
763		1151
764	B<@@RXVTNAME@@> tries to write an entry into the I<utmp>(5) file so	1152	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.	1153	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	1154	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
767	some systems.	1155	on some systems or setgid to root or to some other group on others.
768		1156
769	=head1 COLORS AND GRAPHICS	1157	=head1 COLORS AND GRAPHICS
770		1158
771	In addition to the default foreground and background colours,	1159	In addition to the default foreground and background colours,
772	B<@@RXVTNAME@@> can display up to 16 colours (8 ANSI colours plus	1160	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	1161	high-intensity bold/blink versions of the same). Here is a list of the
774	colours with their B<rgb.txt> names.	1162	colours with their B<rgb.txt> names.
775		1163
776	=begin table	1164	=begin table
777		1165
…		…
806	I<xterm>(1) where the colours are only swapped if they have not otherwise	1194	I<xterm>(1) where the colours are only swapped if they have not otherwise
807	been specified. For example,	1195	been specified. For example,
808		1196
809	=over 4	1197	=over 4
810		1198
811	=item B<rxvt -fg Black -bg White -rv>	1199	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
812		1200
813	would yield White on Black, while on I<xterm>(1) it would yield Black	1201	would yield White on Black, while on I<xterm>(1) it would yield Black
814	on White.	1202	on White.
815		1203
816	=back	1204	=back
817		1205
818	=head1 ENVIRONMENT	1206	=head1 ENVIRONMENT
819		1207
820	B<@@RXVTNAME@@> sets the environment variables B<TERM>, B<COLORTERM>	1208	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	1209
822	window id number of the B<@@RXVTNAME@@> window and it also uses and	1210	=over 4
823	sets the environment variable B<DISPLAY> to specify which display	1211
824	terminal to use. B<@@RXVTNAME@@> uses the environment variables	1212	=item B<TERM>
825	B<RXVTPATH> and B<PATH> to find XPM files.	1213
		1214	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
		1215	resources or on the commandline.
		1216
		1217	=item B<COLORTERM>
		1218
		1219	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
		1220	compiled with XPM support, and optionally with the added extension
		1221	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
		1222
		1223	=item B<COLORFGBG>
		1224
		1225	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
		1226	the colour code used as default foreground/text colour (or the string
		1227	C<default> to indicate that the default-colour escape sequence is to be
		1228	used), C<bg> is the colour code used as default background colour (or the
		1229	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1230	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
		1231	(and do) use this information to optimize screen output.
		1232
		1233	=item B<WINDOWID>
		1234
		1235	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
		1236	window, which usually has subwindows for the scrollbar, the terminal
		1237	window and so on).
		1238
		1239	=item B<TERMINFO>
		1240
		1241	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1242	C<--with-terminfo=PATH>.
		1243
		1244	=item B<DISPLAY>
		1245
		1246	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
		1247	display in it's child processes.
		1248
		1249	=item B<SHELL>
		1250
		1251	The shell to be used for command execution, defaults to C</bin/sh>.
		1252
		1253	=item B<RXVTPATH>
		1254
		1255	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
		1256	files.
		1257
		1258	=item B<PATH>
		1259
		1260	Used in the same way as C<RXVTPATH>.
		1261
		1262	=item B<RXVT_SOCKET>
		1263
		1264	The unix domain socket path used by @@RXVT_NAME@@c(1) and
		1265	@@RXVT_NAME@@d(1).
		1266
		1267	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
		1268
		1269	=item B<HOME>
		1270
		1271	Used to locate the default directory for the unix domain socket for
		1272	daemon communications and to locate various resource files (such as
		1273	C<.Xdefaults>)
		1274
		1275	=item B<XAPPLRESDIR>
		1276
		1277	Directory where various X resource files are being located.
		1278
		1279	=item B<XENVIRONMENT>
		1280
		1281	If set and accessible, gives the name of a X resource file to be loaded by
		1282	@@RXVT_NAME@@.
		1283
		1284	=back
826		1285
827	=head1 FILES	1286	=head1 FILES
828		1287
829	=over 4	1288	=over 4
830		1289
831	=item B</etc/utmp>
832
833	System file for login records.
834
835	=item B</usr/lib/X11/rgb.txt>	1290	=item B</usr/lib/X11/rgb.txt>
836		1291
837	Color names.	1292	Color names.
838		1293
839	=back	1294	=back
840		1295
841	=head1 SEEALSO	1296	=head1 SEE ALSO
842		1297
843	I<xterm>(1), I<sh>(1), I<resize>(1), I<X>(1), I<pty>(4), I<tty>(4), I<utmp>(5)	1298	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), 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		1299
847	=head1 BUGS	1300	=head1 BUGS
848		1301
849	Check the BUGS file for an up-to-date list.	1302	Check the BUGS file for an up-to-date list.
850		1303
851	Cursor change support is not yet implemented.	1304	Cursor change support is not yet implemented.
852		1305
853	Click-and-drag doesn't work with X11 mouse report overriding.	1306	Click-and-drag doesn't work with X11 mouse report overriding.
854		1307
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	1308	=head1 CURRENT PROJECT COORDINATOR
860		1309
861	=over 4	1310	=over 4
862		1311
863	=item Project Coordinator	1312	=item Project Coordinator
864		1313
865	@@RXVTMAINT@@ L<@@RXVTMAINTEMAIL@@>	1314	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
866		1315
867	=item Web page maintainter	1316	L<http://software.schmorp.de/#rxvt-unicode>
868
869	@@RXVTWEBMAINT@@ L<@@RXVTWEBMAINTEMAIL@@>
870
871	L<@@RXVTWEBPAGE@@>(@@RXVTWEBPAGE@@)
872		1317
873	=back	1318	=back
874		1319
875	=head1 AUTHORS	1320	=head1 AUTHORS
876		1321
…		…
901	=item Geoff Wing L<< <gcw@pobox.com> >>	1346	=item Geoff Wing L<< <gcw@pobox.com> >>
902		1347
903	Rewrote screen display and text selection routines. Project Coordinator	1348	Rewrote screen display and text selection routines. Project Coordinator
904	(changes.txt 2.4.6 - rxvt-unicode)	1349	(changes.txt 2.4.6 - rxvt-unicode)
905		1350
906	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>	1351	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
907		1352
908	Forked rxvt-unicode, rewrote most of the display code and internal	1353	Forked rxvt-unicode, rewrote most of the display code and internal
909	character handling to store text in unicode, improve xterm	1354	character handling to store text in unicode, improve xterm
910	compatibility and apply numerous other bugfixes and extensions.	1355	compatibility and apply numerous other bugfixes and extensions.
911		1356

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.69 by root, Tue Oct 25 19:04:45 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.69 by root, Tue Oct 25 19:04:45 2005 UTC