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

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.83 by root, Tue Jan 3 22:28:07 2006 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.83 by root, Tue Jan 3 22:28:07 2006 UTC