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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.32 by root, Sat Oct 9 11:18:12 2004 UTC vs.
Revision 1.114 by root, Thu Jul 6 19:43:21 2006 UTC

…		…
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	17	=head1 FREQUENTLY ASKED QUESTIONS
18		18
19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of frequently	19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20	asked questions and answer to them and some common problems.	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>.
21		23
22	=head1 RXVT-UNICODE VS. RXVT	24	=head1 RXVT-UNICODE VS. RXVT
23		25
24	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode	26	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
25	internally. That means it can store and display most scripts in the	27	internally. That means it can store and display most scripts in the
…		…
40	because the author couldn't get C<mlterm> to use one font for latin1 and	42	because the author couldn't get C<mlterm> to use one font for latin1 and
41	another for japanese.	43	another for japanese.
42		44
43	Therefore another design rationale was the use of multiple fonts to	45	Therefore another design rationale was the use of multiple fonts to
44	display characters: The idea of a single unicode font which many other	46	display characters: The idea of a single unicode font which many other
45	programs force onto it's users never made sense to me: You should be able	47	programs force onto its users never made sense to me: You should be able
46	to choose any font for any script freely.	48	to choose any font for any script freely.
47		49
48	Apart from that, rxvt-unicode is also much better internationalised than	50	Apart from that, rxvt-unicode is also much better internationalised than
49	it's predecessor, supports things such as XFT and ISO 14755 that are handy	51	its predecessor, supports things such as XFT and ISO 14755 that are handy
50	in i18n-environments, is faster, and has a lot less bugs than the original	52	in i18n-environments, is faster, and has a lot less bugs than the original
51	rxvt. This all in addition to dozens of other small improvements.	53	rxvt. This all in addition to dozens of other small improvements.
52		54
53	It is still faithfully following the original rxvt idea of being lean	55	It is still faithfully following the original rxvt idea of being lean
54	and nice on resources: for example, you can still configure rxvt-unicode	56	and nice on resources: for example, you can still configure rxvt-unicode
55	without most of it's features to get a lean binary. It also comes with	57	without most of its features to get a lean binary. It also comes with
56	a client/daemon pair that lets you open any number of terminal windows	58	a client/daemon pair that lets you open any number of terminal windows
57	from within a single process, which makes startup time very fast and	59	from within a single process, which makes startup time very fast and
58	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and	60	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
59	@@RXVT_NAME@@c(1) (client).	61	@@RXVT_NAME@@c(1) (client).
60		62
…		…
91		93
92	Attempt to open a window on the named X display (B<-d> still	94	Attempt to open a window on the named X display (B<-d> still
93	respected). In the absence of this option, the display specified by the	95	respected). In the absence of this option, the display specified by the
94	B<DISPLAY> environment variable is used.	96	B<DISPLAY> environment variable is used.
95		97
		98	=item B<-depth> I<bitdepth>
		99
		100	Compile I<xft>: Attempt to find a visual with the given bit depth;
		101	resource B<depth>.
		102
96	=item B<-geometry> I<geom>	103	=item B<-geometry> I<geom>
97		104
98	Window geometry (B<-g> still respected); resource B<geometry>.	105	Window geometry (B<-g> still respected); resource B<geometry>.
99		106
100	=item B<-rv>\|B<+rv>	107	=item B<-rv>\|B<+rv>
…		…
103		110
104	=item B<-j>\|B<+j>	111	=item B<-j>\|B<+j>
105		112
106	Turn on/off jump scrolling; resource B<jumpScroll>.	113	Turn on/off jump scrolling; resource B<jumpScroll>.
107		114
108	=item B<-ip>\|B<+ip>	115	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>
109		116
110	Turn on/off inheriting parent window's pixmap. Alternative form is	117	Turn on/off inheriting parent window's pixmap. Alternative form is
111	B<-tr>; resource B<inheritPixmap>.	118	B<-tr>; resource B<inheritPixmap>.
112		119
		120	I<Please note that transparency of any kind if completely unsupported by
		121	the author. Don't bug him with installation questions!>
		122
113	=item B<-fade> I<number>	123	=item B<-fade> I<number>
114		124
115	Fade the text by the given percentage when focus is lost.	125	Fade the text by the given percentage when focus is lost. Small values
		126	fade a little only, 100 completely replaces all colours by the fade
		127	colour; resource B<fading>.
		128
		129	=item B<-fadecolor> I<colour>
		130
		131	Fade to this colour when fading is used (see B<-fade>). The default colour
		132	is opaque black. resource B<fadeColor>.
116		133
117	=item B<-tint> I<colour>	134	=item B<-tint> I<colour>
118		135
119	Tint the transparent background pixmap with the given colour when	136	Tint the transparent background pixmap with the given colour when
120	transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>	137	transparency is enabled with B<-tr> or B<-ip>. This only works for
121	option that can be used to brighten or darken the image in addition to	138	non-tiled backgrounds, currently. See also the B<-sh> option that can be
122	tinting it.	139	used to brighten or darken the image in addition to tinting it; resource
		140	I<tintColor>. Example:
		141
		142	@@RXVT_NAME@@ -tr -tint blue -sh 40
123		143
124	=item B<-sh>	144	=item B<-sh>
125		145
126	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	146	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
127	background image in addition to tinting it (i.e. B<-tint> must be	147	background image in addition to tinting it (i.e. B<-tint> must be
128	specified, too).	148	specified, too, e.g. C<-tint white>).
129		149
130	=item B<-bg> I<colour>	150	=item B<-bg> I<colour>
131		151
132	Window background colour; resource B<background>.	152	Window background colour; resource B<background>.
133		153
…		…
136	Window foreground colour; resource B<foreground>.	156	Window foreground colour; resource B<foreground>.
137		157
138	=item B<-pixmap> I<file[;geom]>	158	=item B<-pixmap> I<file[;geom]>
139		159
140	Compile I<XPM>: Specify XPM file for the background and also optionally	160	Compile I<XPM>: Specify XPM file for the background and also optionally
141	specify its scaling with a geometry string. Note you may need to add	161	specify its scaling with a geometry string. Note you may need to
142	quotes to avoid special shell interpretation of the `;' in the	162	add quotes to avoid special shell interpretation of the C<;> in the
143	command-line; resource B<backgroundPixmap>.	163	command-line; resource B<backgroundPixmap>.
144		164
145	=item B<-cr> I<colour>	165	=item B<-cr> I<colour>
146		166
147	The cursor colour; resource B<cursorColor>.	167	The cursor colour; resource B<cursorColor>.
…		…
160	resource B<borderColor>.	180	resource B<borderColor>.
161		181
162	=item B<-fn> I<fontlist>	182	=item B<-fn> I<fontlist>
163		183
164	Select the fonts to be used. This is a comma separated list of font names	184	Select the fonts to be used. This is a comma separated list of font names
165	that are used in turn when trying to display Unicode characters. The	185	that are checked in order when trying to find glyphs for characters. The
166	first font defines the cell size for characters; other fonts might be	186	first font defines the cell size for characters; other fonts might be
167	smaller, but not (in general) larger. A reasonable default font list is	187	smaller, but not (in general) larger. A (hopefully) reasonable default
168	always appended to it. See resource B<font> for details.	188	font list is always appended to it. See resource B<font> for more details.
		189
		190	In short, to specify an X11 core font, just specify its name or prefix it
		191	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
		192	e.g.:
		193
		194	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
		195	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
169		196
170	See also the question "How does rxvt-unicode choose fonts?" in the FAQ	197	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
171	section of @@RXVT_NAME@@(7).	198	section of @@RXVT_NAME@@(7).
172		199
173	=item B<-fb> I<fontlist>	200	=item B<-fb> I<fontlist>
174		201
175	Compile font-styles: The bold font list to use when bold characters are to	202	Compile I<font-styles>: The bold font list to use when B<bold> characters
176	be printed. See resource B<boldFont> for details.	203	are to be printed. See resource B<boldFont> for details.
177		204
178	=item B<-fi> I<fontlist>	205	=item B<-fi> I<fontlist>
179		206
180	Compile font-styles: The italic font list to use when bold characters are to	207	Compile I<font-styles>: The italic font list to use when I<italic>
181	be printed. See resource B<italicFont> for details.	208	characters are to be printed. See resource B<italicFont> for details.
182		209
183	=item B<-fbi> I<fontlist>	210	=item B<-fbi> I<fontlist>
184		211
185	Compile font-styles: The bold italic font list to use when bold characters are to	212	Compile I<font-styles>: The bold italic font list to use when B<< I<bold
186	be printed. See resource B<boldItalicFont> for details.	213	italic> >> characters are to be printed. See resource B<boldItalicFont>
		214	for details.
		215
		216	=item B<-is>\|B<+is>
		217
		218	Compile I<font-styles>: Bold/Italic font styles imply high intensity
		219	foreground/background (default). See resource B<intensityStyles> for
		220	details.
187		221
188	=item B<-name> I<name>	222	=item B<-name> I<name>
189		223
190	Specify the application name under which resources are to be obtained,	224	Specify the application name under which resources are to be obtained,
191	rather than the default executable file name. Name should not contain	225	rather than the default executable file name. Name should not contain
…		…
229		263
230	Put scrollbar on right/left; resource B<scrollBar_right>.	264	Put scrollbar on right/left; resource B<scrollBar_right>.
231		265
232	=item B<-st>\|B<+st>	266	=item B<-st>\|B<+st>
233		267
234	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	268	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
235	resource B<scrollBar_floating>.	269	resource B<scrollBar_floating>.
		270
		271	=item B<-ptab>\|B<+ptab>
		272
		273	If enabled (default), "Horizontal Tab" characters are being stored as
		274	actual wide characters in the screen buffer, which makes it possible to
		275	select and paste them. Since a horizontal tab is a cursor movement and
		276	not an actual glyph, this can sometimes be visually annoying as the cursor
		277	on a tab character is displayed as a wide cursor; resource B<pastableTabs>.
236		278
237	=item B<-bc>\|B<+bc>	279	=item B<-bc>\|B<+bc>
238		280
239	Blink the cursor; resource B<cursorBlink>.	281	Blink the cursor; resource B<cursorBlink>.
240		282
…		…
263		305
264	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	306	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
265	if honoured by the WM, the rxvt-unicode window will not have window	307	if honoured by the WM, the rxvt-unicode window will not have window
266	decorations; resource B<borderLess>.	308	decorations; resource B<borderLess>.
267		309
		310	=item B<-override-redirect>
		311
		312	Compile I<frills>: Sets override-redirect on the window; resource
		313	B<override-redirect>.
		314
		315	=item B<-sbg>
		316
		317	Compile I<frills>: Disable the usage of the built-in block graphics/line
		318	drawing characters and just rely on what the specified fonts provide. Use
		319	this if you have a good font and want to use its block graphic glyphs;
		320	resource B<skipBuiltinGlyphs>.
		321
268	=item B<-lsp> I<number>	322	=item B<-lsp> I<number>
269		323
270	Compile I<linespace>: Lines (pixel height) to insert between each row	324	Compile I<frills>: Lines (pixel height) to insert between each row of
271	of the display; resource B<linespace>.	325	the display. Useful to work around font rendering problems; resource
		326	B<linespace>.
272		327
273	=item B<-tn> I<termname>	328	=item B<-tn> I<termname>
274		329
275	This option specifies the name of the terminal type to be set in the	330	This option specifies the name of the terminal type to be set in the
276	B<TERM> environment variable. This terminal type must exist in the	331	B<TERM> environment variable. This terminal type must exist in the
…		…
285	given on the command line. If this option is used, it must be the last	340	given on the command line. If this option is used, it must be the last
286	on the command-line. If there is no B<-e> option then the default is to	341	on the command-line. If there is no B<-e> option then the default is to
287	run the program specified by the B<SHELL> environment variable or,	342	run the program specified by the B<SHELL> environment variable or,
288	failing that, I<sh(1)>.	343	failing that, I<sh(1)>.
289		344
		345	Please note that you must specify a program with arguments. If you want to
		346	run shell commands, you have to specify the shell, like this:
		347
		348	@@RXVT_NAME@@ -e sh -c "shell commands"
		349
290	=item B<-title> I<text>	350	=item B<-title> I<text>
291		351
292	Window title (B<-T> still respected); the default title is the basename	352	Window title (B<-T> still respected); the default title is the basename
293	of the program specified after the B<-e> option, if any, otherwise the	353	of the program specified after the B<-e> option, if any, otherwise the
294	application name; resource B<title>.	354	application name; resource B<title>.
…		…
312		372
313	Compile I<XIM>: input method name. resource B<inputMethod>.	373	Compile I<XIM>: input method name. resource B<inputMethod>.
314		374
315	=item B<-imlocale> I<string>	375	=item B<-imlocale> I<string>
316		376
317	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	377	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
318	de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input	378	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
319	extension to be able to input japanese characters while staying in	379	input extension to be able to input japanese characters while staying in
320	another locale.	380	another locale. resource B<imLocale>.
		381
		382	=item B<-imfont> I<fontset>
		383
		384	Set the font set to use for the X Input Method, see resource B<imFont>
		385	for more info.
		386
		387	=item B<-tcw>
		388
		389	Change the meaning of triple-click selection with the left mouse
		390	button. Instead of selecting a full line it will extend the selection the
		391	end of the logical line only. resource B<tripleclickwords>.
321		392
322	=item B<-insecure>	393	=item B<-insecure>
323		394
324	Enable "insecure" mode, which currently enables most of the escape	395	Enable "insecure" mode, which currently enables most of the escape
325	sequences that echo strings. See the resource B<insecure> for more	396	sequences that echo strings. See the resource B<insecure> for more
…		…
339	=item B<-ssr>\|B<+ssr>	410	=item B<-ssr>\|B<+ssr>
340		411
341	Turn on/off secondary screen scroll (default enabled); resource	412	Turn on/off secondary screen scroll (default enabled); resource
342	B<secondaryScroll>.	413	B<secondaryScroll>.
343		414
		415	=item B<-hold>\|B<+hold>
		416
		417	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		418	will not immediately destroy its window when the program executed within
		419	it exits. Instead, it will wait till it is being killed or closed by the
		420	user; resource B<hold>.
		421
		422	=item B<-keysym.>I<sym> I<string>
		423
		424	Remap a key symbol. See resource B<keysym>.
		425
		426	=item B<-embed> I<windowid>
		427
		428	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
		429	which enables applications to easily embed a terminal.
		430
		431	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
		432	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
		433	quite a bit, so don't expect it to keep some specific state. It's best to
		434	create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
		435
		436	The window will not be destroyed when @@RXVT_NAME@@ exits.
		437
		438	It might be useful to know that @@RXVT_NAME@@ will not close file
		439	descriptors passed to it (except for stdin/out/err, of course), so you
		440	can use file descriptors to communicate with the programs within the
		441	terminal. This works regardless of wether the C<-embed> option was used or
		442	not.
		443
		444	Here is a short Gtk2-perl snippet that illustrates how this option can be
		445	used (a longer example is in F<doc/embed>):
		446
		447	my $rxvt = new Gtk2::Socket;
		448	$rxvt->signal_connect_after (realize => sub {
		449	my $xid = $_[0]->window->get_xid;
		450	system "@@RXVT_NAME@@ -embed $xid &";
		451	});
		452
		453	=item B<-pty-fd> I<file descriptor>
		454
		455	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
		456	pair but instead use the given filehandle as the tty master. This is
		457	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
		458	without having to run a program within it.
		459
		460	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
		461	entries and will not tinker with pty/tty permissions - you have to do that
		462	yourself if you want that.
		463
		464	As an extremely special case, specifying C<-1> will completely suppress
		465	pty/tty operations.
		466
		467	Here is a example in perl that illustrates how this option can be used (a
		468	longer example is in F<doc/pty-fd>):
		469
		470	use IO::Pty;
		471	use Fcntl;
		472
		473	my $pty = new IO::Pty;
		474	fcntl $pty, F_SETFD, 0; # clear close-on-exec
		475	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		476	close $pty;
		477
		478	# now communicate with rxvt
		479	my $slave = $pty->slave;
		480	while (<$slave>) { print $slave "got <$_>\n" }
		481
344	=item B<-xrm> I<resourcestring>	482	=item B<-pe> I<string>
345		483
346	No effect on rxvt-unicode. Simply passes through an argument to be made	484	Comma-separated list of perl extension scripts to use (or not to use) in
347	available in the instance's argument list. Appears in I<WM_COMMAND> in	485	this terminal instance. See resource B<perl-ext> for details.
348	some window managers.
349		486
350	=back	487	=back
351		488
352	=head1 RESOURCES (available also as long-options)	489	=head1 RESOURCES (available also as long-options)
353		490
354	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	491	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
355	options) compiled into your version.	492	options) compiled into your version.
356		493
357	There are two different methods that @@RXVT_NAME@@ can use to get the	494	You can set and change the resources using X11 tools like B<xrdb>. Many
358	Xresource data: using the X libraries (Xrm*-functions) or internal	495	distribution do also load settings from the B<~/.Xresources> file when X
359	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	496	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
360	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	497	with later settings overwriting earlier ones:
361	resources using X11 tools like B<xset>. Many distribution do also load
362	settings from the B<~/.Xresources> file when X starts.
363		498
364	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>	499	1. system-wide app-defaults file, either locale-dependent OR global
365	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults	500	2. app-defaults file in $XAPPLRESDIR
366	set in XAPPLOADDIR/URxvt (compile-time defined: usually	501	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
367	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	502	4. SCREEN_RESOURCES for the current screen
368	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.	503	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		504
369	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	505	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
370	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows	506	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
371	resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be	507	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
372	easily configured, while the class name B<URxvt> allows resources	508	configured, while the class name B<URxvt> allows resources unique to
373	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	509	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
374	shared between different B<@@RXVT_NAME@@> configurations. If no	510	configurations. If no resources are specified, suitable defaults will
375	resources are specified, suitable defaults will be used. Command-line	511	be used. Command-line arguments can be used to override resource
376	arguments can be used to override resource settings. The following	512	settings. The following resources are supported (you might want to
377	resources are allowed:	513	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		514	extensions not documented here):
378		515
379	=over 4	516	=over 4
		517
		518	=item B<depth:> I<bitdepth>
		519
		520	Compile I<xft>: Attempt to find a visual with the given bit depth;
		521	option B<-depth>.
380		522
381	=item B<geometry:> I<geom>	523	=item B<geometry:> I<geom>
382		524
383	Create the window with the specified X window geometry [default 80x24];	525	Create the window with the specified X window geometry [default 80x24];
384	option B<-geometry>.	526	option B<-geometry>.
…		…
412		554
413	=item B<colorIT:> I<colour>	555	=item B<colorIT:> I<colour>
414		556
415	Use the specified colour to display bold or italic characters when the	557	Use the specified colour to display bold or italic characters when the
416	foreground colour is the default. If font styles are not available	558	foreground colour is the default. If font styles are not available
417	(Compile styles) and this option is unset, reverse video is used instead.	559	(Compile I<styles>) and this option is unset, reverse video is used instead.
418		560
419	=item B<colorUL:> I<colour>	561	=item B<colorUL:> I<colour>
420		562
421	Use the specified colour to display underlined characters when the	563	Use the specified colour to display underlined characters when the
422	foreground colour is the default.	564	foreground colour is the default.
423		565
424	=item B<colorRV:> I<colour>	566	=item B<colorRV:> I<colour>
425		567
426	Use the specified colour as the background for reverse video	568	Use the specified colour as the background for reverse video
427	characters.	569	characters.
		570
		571	=item B<underlineColor:> I<colour>
		572
		573	If set, use the specified colour as the colour for the underline
		574	itself. If unset, use the foreground colour.
428		575
429	=item B<cursorColor:> I<colour>	576	=item B<cursorColor:> I<colour>
430		577
431	Use the specified colour for the cursor. The default is to use the	578	Use the specified colour for the cursor. The default is to use the
432	foreground colour; option B<-cr>.	579	foreground colour; option B<-cr>.
…		…
453		600
454	B<True>: make the background inherit the parent windows' pixmap, giving	601	B<True>: make the background inherit the parent windows' pixmap, giving
455	artificial transparency. B<False>: do not inherit the parent windows'	602	artificial transparency. B<False>: do not inherit the parent windows'
456	pixmap.	603	pixmap.
457		604
		605	I<Please note that transparency of any kind if completely unsupported by
		606	the author. Don't bug him with installation questions!>
		607
458	=item B<fading:> I<number>	608	=item B<fading:> I<number>
459		609
460	Fade the text by the given percentage when focus is lost.	610	Fade the text by the given percentage when focus is lost; option B<-fade>.
		611
		612	=item B<fadeColor:> I<colour>
		613
		614	Fade to this colour, when fading is used (see B<fading:>). The default
		615	colour is black; option B<-fadecolor>.
461		616
462	=item B<tintColor:> I<colour>	617	=item B<tintColor:> I<colour>
463		618
464	Tint the transparent background pixmap with the given colour.	619	Tint the transparent background pixmap with the given colour; option
		620	B<-tint>.
465		621
466	=item B<shading:> I<number>	622	=item B<shading:> I<number>
467		623
468	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	624	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
469	image in addition to tinting it.	625	image in addition to tinting it.
…		…
473	Use the specified colour for the scrollbar [default #B2B2B2].	629	Use the specified colour for the scrollbar [default #B2B2B2].
474		630
475	=item B<troughColor:> I<colour>	631	=item B<troughColor:> I<colour>
476		632
477	Use the specified colour for the scrollbar's trough area [default	633	Use the specified colour for the scrollbar's trough area [default
478	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	634	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
479		635
480	=item B<borderColor:> I<colour>	636	=item B<borderColor:> I<colour>
481		637
482	The colour of the border around the text area and between the scrollbar	638	The colour of the border around the text area and between the scrollbar
483	and the text.	639	and the text.
…		…
492	of 1 displays the image without any scaling. A scale of 2 to 9	648	of 1 displays the image without any scaling. A scale of 2 to 9
493	specifies an integer number of images in that direction. No image will	649	specifies an integer number of images in that direction. No image will
494	be magnified beyond 10 times its original size. The maximum permitted	650	be magnified beyond 10 times its original size. The maximum permitted
495	scale is 1000. [default 0x0+50+50]	651	scale is 1000. [default 0x0+50+50]
496		652
497	=item B<menu:> I<file[;tag]>
498
499	Read in the specified menu file (note the `.menu' extension is
500	optional) and also optionally specify a starting tag to find. See the
501	reference documentation for details on the syntax for the menuBar.
502
503	=item B<path:> I<path>	653	=item B<path:> I<path>
504		654
505	Specify the colon-delimited search path for finding files (XPM and	655	Specify the colon-delimited search path for finding XPM files.
506	menus), in addition to the paths specified by the B<RXVTPATH> and
507	B<PATH> environment variables.
508		656
509	=item B<font:> I<fontlist>	657	=item B<font:> I<fontlist>
510		658
511	Select the fonts to be used. This is a comma separated list of font	659	Select the fonts to be used. This is a comma separated list of font names
512	names that are used in turn when trying to display Unicode characters.	660	that are checked in order when trying to find glyphs for characters. The
513	The first font defines the cell size for characters; other fonts might	661	first font defines the cell size for characters; other fonts might be
514	be smaller, but not larger. A reasonable default font list is always	662	smaller, but not (in general) larger. A (hopefully) reasonable default
515	appended to it. option B<-fn>.	663	font list is always appended to it; option B<-fn>.
516		664
517	Each font can either be a standard X11 core font (XLFD) name, with	665	Each font can either be a standard X11 core font (XLFD) name, with
518	optional prefix C<x:> or a Xft font (Compile xft), prefixed with C<xft:>.	666	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
519		667
520	In addition, each font can be prefixed with additional hints and	668	In addition, each font can be prefixed with additional hints and
521	specifications enclosed in square brackets (C<[]>). The only available	669	specifications enclosed in square brackets (C<[]>). The only available
522	hint currently is C<codeset=codeset-name>, and this is only used for Xft	670	hint currently is C<codeset=codeset-name>, and this is only used for Xft
523	fonts.	671	fonts.
524		672
525	For example, this font resource	673	For example, this font resource
526		674
527	URxvt*font: 9x15bold,\	675	URxvt.font: 9x15bold,\
528	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	676	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
529	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \	677	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
530	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	678	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
531	xft:Code2000:antialias=false	679	xft:Code2000:antialias=false
532		680
533	specifies five fonts to be used. The first one is C<9x15bold> (actually	681	specifies five fonts to be used. The first one is C<9x15bold> (actually
534	the iso8859-1 version of the second font), which is the base font (because	682	the iso8859-1 version of the second font), which is the base font (because
535	it is named first) and thus defines the character cell grid to be 9 pixels	683	it is named first) and thus defines the character cell grid to be 9 pixels
536	wide and 15 pixels high.	684	wide and 15 pixels high.
537		685
538	the second font is just used to add additional unicode characters not in	686	The second font is just used to add additional unicode characters not in
539	the base font, likewise the third, which is unfortunately non-bold, but	687	the base font, likewise the third, which is unfortunately non-bold, but
540	the bold version of the font does contain less characters, so this is a	688	the bold version of the font does contain less characters, so this is a
541	useful supplement.	689	useful supplement.
542		690
543	The third font is an Xft font with aliasing turned off, and the characters	691	The third font is an Xft font with aliasing turned off, and the characters
…		…
566	not possible, replacement fonts of the desired shape will be tried.	714	not possible, replacement fonts of the desired shape will be tried.
567		715
568	If set, but empty, then this specific style is disabled and the normal	716	If set, but empty, then this specific style is disabled and the normal
569	text font will being used for the given style.	717	text font will being used for the given style.
570		718
		719	=item B<intensityStyles:> I<boolean>
		720
		721	When font styles are not enabled, or this option is enabled (B<True>,
		722	option B<-is>, the default), bold and italic font styles imply high
		723	intensity foreground/backround colours. Disabling this option (B<False>,
		724	option B<+is>) disables this behaviour, the high intensity colours are not
		725	reachable.
		726
571	=item B<selectstyle:> I<mode>	727	=item B<selectstyle:> I<mode>
572		728
573	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	729	Set mouse selection style to B<old> which is 2.20, B<oldword> which is
574	xterm style with 2.20 old word selection, or anything else which gives	730	xterm style with 2.20 old word selection, or anything else which gives
575	xterm style selection.	731	xterm style selection.
576		732
577	=item B<scrollstyle:> I<mode>	733	=item B<scrollstyle:> I<mode>
578		734
579	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	735	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
580	the author's favourite..	736	the author's favourite.
581		737
582	=item B<title:> I<string>	738	=item B<title:> I<string>
583		739
584	Set window title string, the default title is the command-line	740	Set window title string, the default title is the command-line
585	specified after the B<-e> option, if any, otherwise the application	741	specified after the B<-e> option, if any, otherwise the application
…		…
617		773
618	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	774	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
619	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or	775	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
620	B<Shift-Print> to include the scrollback as well.	776	B<Shift-Print> to include the scrollback as well.
621		777
		778	The string will be interpreted as if typed into the shell as-is.
		779
		780	Example:
		781
		782	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		783
		784	This creates a new file in your home directory with the screen contents
		785	everytime you hit C<Print>.
		786
622	=item B<scrollBar:> I<boolean>	787	=item B<scrollBar:> I<boolean>
623		788
624	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	789	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
625	disable the scrollbar; option B<+sb>.	790	disable the scrollbar; option B<+sb>.
626		791
…		…
646	B<+si>.	811	B<+si>.
647		812
648	=item B<scrollWithBuffer:> I<boolean>	813	=item B<scrollWithBuffer:> I<boolean>
649		814
650	B<True>: scroll with scrollback buffer when tty receives new lines (and	815	B<True>: scroll with scrollback buffer when tty receives new lines (and
651	B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll	816	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
652	with scrollback buffer when tty recieves new lines; option B<-sw>.	817	with scrollback buffer when tty recieves new lines; option B<+sw>.
653		818
654	=item B<scrollTtyKeypress:> I<boolean>	819	=item B<scrollTtyKeypress:> I<boolean>
655		820
656	B<True>: scroll to bottom when a non-special key is pressed. Special keys	821	B<True>: scroll to bottom when a non-special key is pressed. Special keys
657	are those which are intercepted by rxvt-unicode for special handling and	822	are those which are intercepted by rxvt-unicode for special handling and
…		…
676	=item B<borderLess:> I<boolean>	841	=item B<borderLess:> I<boolean>
677		842
678	Set MWM hints to request a borderless window, i.e. if honoured by the	843	Set MWM hints to request a borderless window, i.e. if honoured by the
679	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.	844	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
680		845
		846	=item B<skipBuiltinGlyphs:> I<boolean>
		847
		848	Compile I<frills>: Disable the usage of the built-in block graphics/line
		849	drawing characters and just rely on what the specified fonts provide. Use
		850	this if you have a good font and want to use its block graphic glyphs;
		851	option B<-sbg>.
		852
681	=item B<termName:> I<termname>	853	=item B<termName:> I<termname>
682		854
683	Specifies the terminal type name to be set in the B<TERM> environment	855	Specifies the terminal type name to be set in the B<TERM> environment
684	variable; option B<-tn>.	856	variable; option B<-tn>.
685		857
…		…
695		867
696	=item B<mouseWheelScrollPage:> I<boolean>	868	=item B<mouseWheelScrollPage:> I<boolean>
697		869
698	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel	870	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
699	scrolls five lines [default].	871	scrolls five lines [default].
		872
		873	=item B<pastableTabs:> I<boolean>
		874
		875	B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
		876	movement only; option C<-ptab>.
700		877
701	=item B<cursorBlink:> I<boolean>	878	=item B<cursorBlink:> I<boolean>
702		879
703	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	880	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
704	option B<-bc>.	881	option B<-bc>.
…		…
717		894
718	Mouse pointer background colour.	895	Mouse pointer background colour.
719		896
720	=item B<pointerBlankDelay:> I<number>	897	=item B<pointerBlankDelay:> I<number>
721		898
722	Specifies number of seconds before blanking the pointer [default 2].	899	Specifies number of seconds before blanking the pointer [default 2]. Use a
		900	large number (e.g. C<987654321>) to effectively disable the timeout.
723		901
724	=item B<backspacekey:> I<string>	902	=item B<backspacekey:> I<string>
725		903
726	The string to send when the backspace key is pressed. If set to B<DEC>	904	The string to send when the backspace key is pressed. If set to B<DEC>
727	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	905	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
…		…
734	pressed. If unset it will send the sequence traditionally associated	912	pressed. If unset it will send the sequence traditionally associated
735	with the B<Execute> key.	913	with the B<Execute> key.
736		914
737	=item B<cutchars:> I<string>	915	=item B<cutchars:> I<string>
738		916
739	The characters used as delimiters for double-click word selection. The	917	The characters used as delimiters for double-click word selection
740	built-in default:	918	(whitespace delimiting is added automatically if resource is given).
		919
		920	When the selection extension is in use (the default if compiled in, see
		921	the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters
		922	will be created (if the resource exists, otherwise, no regex will be
		923	created). In this mode, characters outside ISO-8859-1 can be used.
		924
		925	When the selection extension is not used, only ISO-8859-1 characters can
		926	be used. If not specified, the built-in default is used:
741		927
742	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	928	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>
743		929
744	=item B<preeditType:> I<style>	930	=item B<preeditType:> I<style>
745		931
…		…
749		935
750	I<name> of inputMethod to use; option B<-im>.	936	I<name> of inputMethod to use; option B<-im>.
751		937
752	=item B<imLocale:> I<name>	938	=item B<imLocale:> I<name>
753		939
754	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	940	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
755	de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input	941	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
756	extension to be able to input japanese characters while staying in	942	input extension to be able to input japanese characters while staying in
757	another locale. option B<-imlocale>.	943	another locale; option B<-imlocale>.
		944
		945	=item B<imFont:> I<fontset>
		946
		947	Specify the font-set used for XIM styles C<OverTheSpot> or
		948	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
		949	by commas), i.e. it's not in the same format as the other font lists used
		950	in @@RXVT_NAME@@. The default will be set-up to chose any suitable found
		951	found, preferably one or two pixels differing in size to the base font.
		952	option B<-imfont>.
		953
		954	=item B<tripleclickwords:> I<boolean>
		955
		956	Change the meaning of triple-click selection with the left mouse
		957	button. Instead of selecting a full line it will extend the selection to
		958	the end of the logical line only; option B<-tcw>.
758		959
759	=item B<insecure:> I<boolean>	960	=item B<insecure:> I<boolean>
760		961
761	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	962	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
762	echo arbitrary strings like the icon name or the locale. This could be	963	echo arbitrary strings like the icon name or the locale. This could be
763	abused if somebody gets 8-bit-clean access to your display, whether	964	abused if somebody gets 8-bit-clean access to your display, whether
764	throuh a mail client displaying mail bodies unfiltered or though	965	through a mail client displaying mail bodies unfiltered or through
765	write(1). Therefore, these sequences are disabled by default. (Note	966	write(1) or any other means. Therefore, these sequences are disabled by
766	that other terminals, including xterm, have these sequences	967	default. (Note that many other terminals, including xterm, have these
767	enabled by default). You can enable them by setting this boolean	968	sequences enabled by default, which doesn't make it safer, though).
768	resource or specifying B<-insecure> as an option. At the moment, this	969
769	enabled display-answer, locale, findfont, icon label and window title	970	You can enable them by setting this boolean resource or specifying
770	requests as well as dynamic menubar dispatch.	971	B<-insecure> as an option. At the moment, this enables display-answer,
		972	locale, findfont, icon label and window title requests.
771		973
772	=item B<modifier:> I<modifier>	974	=item B<modifier:> I<modifier>
773		975
774	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	976	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
775	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	977	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
779		981
780	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	982	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
781	character is passed through. It may contain escape values as described	983	character is passed through. It may contain escape values as described
782	in the entry on B<keysym> following.	984	in the entry on B<keysym> following.
783		985
784	=item B<secondaryScreen:> I<bool>	986	=item B<secondaryScreen:> I<boolean>
785		987
786	Turn on/off secondary screen (default enabled).	988	Turn on/off secondary screen (default enabled).
787		989
788	=item B<secondaryScroll:> I<bool>	990	=item B<secondaryScroll:> I<boolean>
789		991
790	Turn on/off secondary screen scroll (default enabled). If the this	992	Turn on/off secondary screen scroll (default enabled). If the this
791	option is enabled, scrolls on the secondary screen will change the	993	option is enabled, scrolls on the secondary screen will change the
792	scrollback buffer and switching to/from the secondary screen will	994	scrollback buffer and switching to/from the secondary screen will
793	instead scroll the screen up.	995	instead scroll the screen up.
794		996
		997	=item B<hold>: I<boolean>
		998
		999	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		1000	will not immediately destroy its window when the program executed within
		1001	it exits. Instead, it will wait till it is being killed or closed by the
		1002	user.
		1003
795	=item B<keysym.>I<sym>: I<string>	1004	=item B<keysym.>I<sym>: I<string>
796		1005
797	Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may	1006	Compile I<frills>: Associate I<string> with keysym I<sym>. The
798	contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:	1007	intervening resource name B<keysym.> cannot be omitted.
799	newline, \r: return, \t:	1008
		1009	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
		1010	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
		1011	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
		1012	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
		1013	B<2>, B<3>, B<4>, B<5>.
		1014
		1015	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
		1016	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
		1017	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
		1018	current application keymap mode state.
		1019
		1020	The spellings of I<key> can be obtained by using B<xev>(1) command or
		1021	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
		1022	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
		1023	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
		1024	performed in an exact manner; however, the closest match is assured.
		1025
		1026	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
		1027	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
800	tab, \000: octal number) or control characters (^?: delete, ^@: null,	1028	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
801	^A ...) and may enclosed with double quotes so that it can start or end	1029	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
802	with whitespace. The intervening resource name B<keysym.> cannot be	1030	can start or end with whitespace.
803	omitted. This resource is only available when compiled with	1031
804	KEYSYM_RESOURCE.	1032	Please note that you need to double the C<\> in resource files, as
		1033	Xlib itself does its own de-escaping (you can use C<\033> instead of
		1034	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
		1035	processing).
		1036
		1037	You can define a range of keysyms in one shot by providing a I<string>
		1038	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
		1039	should be a character not used by the strings.
		1040
		1041	Its usage can be demonstrated by an example:
		1042
		1043	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
		1044
		1045	The above line is equivalent to the following three lines:
		1046
		1047	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
		1048	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
		1049	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
		1050
		1051	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
		1052	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
		1053	example the following means "change the current locale to C<zh_CN.GBK>
		1054	when Control-Meta-c is being pressed":
		1055
		1056	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		1057
		1058	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1059	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1060	manpage. For example, the F<selection> extension (activated via
		1061	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1062
		1063	URxvt.keysym.M-C-c: perl:selection:rot13
		1064
		1065	Due the the large number of modifier combinations, a defined key mapping
		1066	will match if at I<at least> the specified identifiers are being set, and
		1067	no other key mappings with those and more bits are being defined. That
		1068	means that defining a key map for C<a> will automatically provide
		1069	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		1070	mappings themselves.
		1071
		1072	Unfortunately, this will override built-in key mappings. For example
		1073	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		1074	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		1075	user-defined keymap using the C<builtin:> replacement:
		1076
		1077	URxvt.keysym.Insert: <my insert key sequence>
		1078	URxvt.keysym.S-Insert: builtin:
		1079
		1080	The first line defines a mapping for C<Insert> and I<any> combination
		1081	of modifiers. The second line re-establishes the default mapping for
		1082	C<Shift-Insert>.
		1083
		1084	The following example will map Control-Meta-1 and Control-Meta-2 to
		1085	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
		1086	font-switching at runtime:
		1087
		1088	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1089	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
		1090
		1091	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
		1092	info):
		1093
		1094	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1095	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1096
		1097	=item B<perl-ext-common>: I<string>
		1098
		1099	=item B<perl-ext>: I<string>
		1100
		1101	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1102	use in this terminal instance; option B<-pe>.
		1103
		1104	Extension names can be prefixed with a C<-> sign to prohibit using
		1105	them. This can be useful to selectively disable some extensions loaded
		1106	by default, or specified via the C<perl-ext-common> resource. For
		1107	example, C<default,-selection> will use all the default extension except
		1108	C<selection>.
		1109
		1110	Extension names can also be followed by an argument in angle brackets
		1111	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1112	searchable scorllback to Alt/Meta-s). Mentioning the same extension
		1113	multiple times with different arguments will pass multiple arguments to
		1114	the extension.
		1115
		1116	Each extension is looked up in the library directories, loaded if
		1117	necessary, and bound to the current terminal instance.
		1118
		1119	If both of these resources are the empty string, then the perl
		1120	interpreter will not be initialized. The idea behind two options is that
		1121	B<perl-ext-common> will be used for extensions that should be available to
		1122	all instances, while B<perl-ext> is used for specific instances.
		1123
		1124	=item B<perl-eval>: I<string>
		1125
		1126	Perl code to be evaluated when all extensions have been registered. See
		1127	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
		1128	will be ignored when running setuid/setgid.
		1129
		1130	=item B<perl-lib>: I<path>
		1131
		1132	Colon-separated list of additional directories that hold extension
		1133	scripts. When looking for extensions specified by the C<perl> resource,
		1134	@@RXVT_NAME@@ will first look in these directories and then in
		1135	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
		1136	will be ignored when running setuid/setgid.
		1137
		1138	See the @@RXVT_NAME@@perl(3) manpage.
		1139
		1140	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1141
		1142	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1143	details.
		1144
		1145	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1146
		1147	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1148	for details.
		1149
		1150	=item B<searchable-scrollback:> I<keysym>
		1151
		1152	Sets the hotkey that starts the incremental scrollback buffer search
		1153	(default: C<M-s>).
		1154
		1155	=item B<urlLauncher>: I<string>
		1156
		1157	Specifies the program to be started with a URL argument. Used by the
		1158	C<selection-popup> and C<mark-urls> perl extensions.
		1159
		1160	=item B<transient-for>: I<windowid>
		1161
		1162	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1163
		1164	=item B<override-redirect>: I<boolean>
		1165
		1166	Compile I<frills>: Sets override-redirect for the terminal window, making
		1167	it almost invisible to window managers; option B<-override-redirect>.
805		1168
806	=back	1169	=back
807		1170
808	=head1 THE SCROLLBAR	1171	=head1 THE SCROLLBAR
809		1172
…		…
823	the normal text selection/insertion, hold either the Shift or the Meta	1186	the normal text selection/insertion, hold either the Shift or the Meta
824	(Alt) key while performing the desired mouse action.	1187	(Alt) key while performing the desired mouse action.
825		1188
826	If mouse reporting mode is active, the normal scrollbar actions are	1189	If mouse reporting mode is active, the normal scrollbar actions are
827	disabled -- on the assumption that we are using a fullscreen	1190	disabled -- on the assumption that we are using a fullscreen
828	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	1191	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
829	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	1192	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
830	up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down),	1193	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
831	respectively.	1194	respectively.
832		1195
833	=head1 TEXT SELECTION AND INSERTION	1196	=head1 TEXT SELECTION AND INSERTION
834		1197
835	The behaviour of text selection and insertion mechanism is similar to	1198	The behaviour of text selection and insertion mechanism is similar to
…		…
837		1200
838	=over 4	1201	=over 4
839		1202
840	=item B<Selection>:	1203	=item B<Selection>:
841		1204
842	Left click at the beginning of the region, drag to the end of the	1205	Left click at the beginning of the region, drag to the end of the region
843	region and release; Right click to extend the marked region; Left	1206	and release; Right click to extend the marked region; Left double-click
844	double-click to select a word; Left triple-click to select the entire	1207	to select a word; Left triple-click to select the entire logical line
845	line.	1208	(which can span multiple screen lines), unless modified by resource
		1209	B<tripleclickwords>.
846		1210
847	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1211	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
848	(Compile: frills) will create a rectangular selection instead of a normal	1212	(Compile: I<frills>) will create a rectangular selection instead of a
849	one.	1213	normal one. In this mode, every selected row becomes its own line in the
		1214	selection, and trailing whitespace is visually underlined and removed from
		1215	the selection.
850		1216
851	=item B<Insertion>:	1217	=item B<Insertion>:
852		1218
853	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1219	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
854	an B<@@RXVT_NAME@@> window causes the current text selection to be	1220	window causes the value of the PRIMARY selection (or CLIPBOARD with the
855	inserted as if it had been typed on the keyboard.	1221	Meta modifier) to be inserted as if it had been typed on the keyboard.
		1222
		1223	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1224	inserted too.
856		1225
857	=back	1226	=back
858		1227
859	=head1 CHANGING FONTS	1228	=head1 CHANGING FONTS
860		1229
861	Changing fonts (or font sizes, respectively) via the keypad is not yet	1230	Changing fonts (or font sizes, respectively) via the keypad is not yet
862	supported in rxvt-unicode. Bug me if you need this.	1231	supported in rxvt-unicode. Bug me if you need this.
863		1232
864	You can, however, switch fonts at runtime using escape sequences (and	1233	You can, however, switch fonts at runtime using escape sequences, e.g.:
865	therefore using the menubar), e.g.:
866		1234
867	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1235	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1236
		1237	You can use keyboard shortcuts, too:
		1238
		1239	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1240	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
868		1241
869	rxvt-unicode will automatically re-apply these fonts to the output so far.	1242	rxvt-unicode will automatically re-apply these fonts to the output so far.
870		1243
871	=head1 ISO 14755 SUPPORT	1244	=head1 ISO 14755 SUPPORT
872		1245
…		…
876	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1249	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
877	with C<--enable-iso14755>.	1250	with C<--enable-iso14755>.
878		1251
879	=over 4	1252	=over 4
880		1253
881	=item 5.1: Basic method	1254	=item * 5.1: Basic method
882		1255
883	This allows you to enter unicode characters using their hexcode.	1256	This allows you to enter unicode characters using their hexcode.
884		1257
885	Start by pressing and holding both C<Control> and C<Shift>, then enter	1258	Start by pressing and holding both C<Control> and C<Shift>, then enter
886	hex-digits (between one and six). Releasing C<Control> and C<Shift> will	1259	hex-digits (between one and six). Releasing C<Control> and C<Shift> will
…		…
893	address, which you cannot type. Fortunately, the card has the e-mail	1266	address, which you cannot type. Fortunately, the card has the e-mail
894	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily	1267	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
895	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,	1268	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
896	followed by releasing the modifier keys.	1269	followed by releasing the modifier keys.
897		1270
898	=item 5.2: Keyboard symbols entry method	1271	=item * 5.2: Keyboard symbols entry method
899		1272
900	This mode lets you input characters representing the keycap symbols of	1273	This mode lets you input characters representing the keycap symbols of
901	your keyboard, if representable in the current locale encoding.	1274	your keyboard, if representable in the current locale encoding.
902		1275
903	Start by pressing C<Control> and C<Shift> together, then releasing	1276	Start by pressing C<Control> and C<Shift> together, then releasing
904	them. The next special key (cursor keys, home etc.) you enter will not	1277	them. The next special key (cursor keys, home etc.) you enter will not
905	invoke it's usual function but instead will insert the corresponding	1278	invoke its usual function but instead will insert the corresponding
906	keycap symbol. The symbol will only be entered when the key has been	1279	keycap symbol. The symbol will only be entered when the key has been
907	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1280	released, otherwise pressing e.g. C<Shift> would enter the symbol for
908	C<ISO Level 2 Switch>, although your intention might have been to enter a	1281	C<ISO Level 2 Switch>, although your intention might have been to enter a
909	reverse tab (Shift-Tab).	1282	reverse tab (Shift-Tab).
910		1283
911	=item 5.3: Screen-selection entry method	1284	=item * 5.3: Screen-selection entry method
912		1285
913	While this is implemented already (it's basically the selection	1286	While this is implemented already (it's basically the selection
914	mechanism), it could be extended by displaying a unicode character map.	1287	mechanism), it could be extended by displaying a unicode character map.
915		1288
916	=item 5.4: Feedback method for identifying displayed characters for later input	1289	=item * 5.4: Feedback method for identifying displayed characters for later input
917		1290
918	This method lets you display the unicode character code associated with	1291	This method lets you display the unicode character code associated with
919	characters already displayed.	1292	characters already displayed.
920		1293
921	You enter this mode by holding down C<Control> and C<Shift> together, then	1294	You enter this mode by holding down C<Control> and C<Shift> together, then
…		…
933	With respect to conformance, rxvt-unicode is supposed to be compliant to	1306	With respect to conformance, rxvt-unicode is supposed to be compliant to
934	both scenario A and B of ISO 14755, including part 5.2.	1307	both scenario A and B of ISO 14755, including part 5.2.
935		1308
936	=head1 LOGIN STAMP	1309	=head1 LOGIN STAMP
937		1310
938	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so	1311	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
939	that it can be seen via the I<who(1)> command, and can accept messages.	1312	it can be seen via the I<who(1)> command, and can accept messages. To
940	To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on	1313	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
941	some systems.	1314	on some systems or setgid to root or to some other group on others.
942		1315
943	=head1 COLORS AND GRAPHICS	1316	=head1 COLORS AND GRAPHICS
944		1317
945	In addition to the default foreground and background colours,	1318	In addition to the default foreground and background colours,
946	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1319	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
947	high-intensity bold/blink versions of the same). Here is a list of the	1320	high-intensity bold/blink versions of the same). Here is a list of the
948	colours with their B<rgb.txt> names.	1321	colours with their names.
949		1322
950	=begin table	1323	=begin table
951		1324
952	B<color0> (black) = Black	1325	B<color0> (black) = Black
953	B<color1> (red) = Red3	1326	B<color1> (red) = Red3
…		…
973	It is also possible to specify the colour values of B<foreground>,	1346	It is also possible to specify the colour values of B<foreground>,
974	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1347	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
975	a number 0-15, as a convenient shorthand to reference the colour name of	1348	a number 0-15, as a convenient shorthand to reference the colour name of
976	color0-color15.	1349	color0-color15.
977		1350
		1351	In addition to the colours defined above, @@RXVT_NAME@@ offers an
		1352	additional 72 colours. The first 64 of those (with indices 16 to 79)
		1353	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
		1354	16>), followed by 8 additional shades of gray (with indices 80 to 87).
		1355
		1356	Together, all those colours implement the 88 colour xterm colours. Only
		1357	the first 16 can be changed using resources currently, the rest can only
		1358	be changed via command sequences ("escape codes").
		1359
978	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1360	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
979	always swapping the foreground/background colours. This is in contrast to	1361	always swapping the foreground/background colours. This is in contrast to
980	I<xterm>(1) where the colours are only swapped if they have not otherwise	1362	I<xterm>(1) where the colours are only swapped if they have not otherwise
981	been specified. For example,	1363	been specified. For example,
982		1364
…		…
987	would yield White on Black, while on I<xterm>(1) it would yield Black	1369	would yield White on Black, while on I<xterm>(1) it would yield Black
988	on White.	1370	on White.
989		1371
990	=back	1372	=back
991		1373
		1374	=head2 ALPHA CHANNEL SUPPORT
		1375
		1376	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1377	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
		1378	(recommended, but B<MUST> have 4 digits/component) colour specifications,
		1379	in addition to the ones provided by X, where the additional A component
		1380	specifies opacity (alpha) values. The minimum value of C<0> is completely
		1381	transparent). You can also prefix any color with C<[a]>, where C<a> is on
		1382	to four hex digits specifiying the opacity value.
		1383
		1384	You probably need to specify B<"-depth 32">, too, and have the luck that
		1385	your X-server uses ARGB pixel layout, as X is far from just supporting
		1386	ARGB visuals out of the box, and rxvt-unicode just fudges around.
		1387
		1388	For example, the following selects an almost completely transparent red
		1389	background, and an almost opaque pink foreground:
		1390
		1391	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"
		1392
		1393	I<Please note that transparency of any kind if completely unsupported by
		1394	the author. Don't bug him with installation questions!>
		1395
992	=head1 ENVIRONMENT	1396	=head1 ENVIRONMENT
993		1397
994	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>	1398	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
995	and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X	1399
996	window id number of the B<@@RXVT_NAME@@> window and it also uses and	1400	=over 4
997	sets the environment variable B<DISPLAY> to specify which display	1401
998	terminal to use. B<@@RXVT_NAME@@> uses the environment variables	1402	=item B<TERM>
999	B<RXVTPATH> and B<PATH> to find XPM files.	1403
		1404	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
		1405	resources or on the commandline.
		1406
		1407	=item B<COLORTERM>
		1408
		1409	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
		1410	compiled with XPM support, and optionally with the added extension
		1411	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
		1412
		1413	=item B<COLORFGBG>
		1414
		1415	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
		1416	the colour code used as default foreground/text colour (or the string
		1417	C<default> to indicate that the default-colour escape sequence is to be
		1418	used), C<bg> is the colour code used as default background colour (or the
		1419	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1420	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
		1421	(and do) use this information to optimize screen output.
		1422
		1423	=item B<WINDOWID>
		1424
		1425	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
		1426	window, which usually has subwindows for the scrollbar, the terminal
		1427	window and so on).
		1428
		1429	=item B<TERMINFO>
		1430
		1431	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1432	C<--with-terminfo=PATH>.
		1433
		1434	=item B<DISPLAY>
		1435
		1436	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
		1437	display in its child processes.
		1438
		1439	=item B<SHELL>
		1440
		1441	The shell to be used for command execution, defaults to C</bin/sh>.
		1442
		1443	=item B<RXVT_SOCKET>
		1444
		1445	The unix domain socket path used by @@RXVT_NAME@@c(1) and
		1446	@@RXVT_NAME@@d(1).
		1447
		1448	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
		1449
		1450	=item B<HOME>
		1451
		1452	Used to locate the default directory for the unix domain socket for
		1453	daemon communications and to locate various resource files (such as
		1454	C<.Xdefaults>)
		1455
		1456	=item B<XAPPLRESDIR>
		1457
		1458	Directory where various X resource files are being located.
		1459
		1460	=item B<XENVIRONMENT>
		1461
		1462	If set and accessible, gives the name of a X resource file to be loaded by
		1463	@@RXVT_NAME@@.
		1464
		1465	=back
1000		1466
1001	=head1 FILES	1467	=head1 FILES
1002		1468
1003	=over 4	1469	=over 4
1004		1470
1005	=item B</etc/utmp>
1006
1007	System file for login records.
1008
1009	=item B</usr/lib/X11/rgb.txt>	1471	=item B</usr/lib/X11/rgb.txt>
1010		1472
1011	Color names.	1473	Color names.
1012		1474
1013	=back	1475	=back
1014		1476
1015	=head1 SEE ALSO	1477	=head1 SEE ALSO
1016		1478
1017	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1479	@@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)
1018
1019	=head1 BUGS
1020
1021	Check the BUGS file for an up-to-date list.
1022
1023	Cursor change support is not yet implemented.
1024
1025	Click-and-drag doesn't work with X11 mouse report overriding.
1026		1480
1027	=head1 CURRENT PROJECT COORDINATOR	1481	=head1 CURRENT PROJECT COORDINATOR
1028		1482
1029	=over 4	1483	=over 4
1030		1484
1031	=item Project Coordinator	1485	=item Project Coordinator
1032		1486
1033	@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@>	1487	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1034		1488
1035	=item Web page maintainter	1489	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1036
1037	@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1038
1039	L<@@RXVT_WEBPAGE@@>
1040		1490
1041	=back	1491	=back
1042		1492
1043	=head1 AUTHORS	1493	=head1 AUTHORS
1044		1494
…		…
1066		1516
1067	Project Coordinator (changes.txt 2.21a to 2.4.5)	1517	Project Coordinator (changes.txt 2.21a to 2.4.5)
1068		1518
1069	=item Geoff Wing L<< <gcw@pobox.com> >>	1519	=item Geoff Wing L<< <gcw@pobox.com> >>
1070		1520
1071	Rewrote screen display and text selection routines. Project Coordinator	1521	Rewrote screen display and text selection routines.
		1522
1072	(changes.txt 2.4.6 - rxvt-unicode)	1523	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1073		1524
1074	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>	1525	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1075		1526
1076	Forked rxvt-unicode, rewrote most of the display code and internal	1527	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1077	character handling to store text in unicode, improve xterm	1528	extension, random hacks, numerous bugfixes and extensions.
1078	compatibility and apply numerous other bugfixes and extensions.
1079		1529
1080	Project Coordinator (Changes 1.0 -)	1530	Project Coordinator (Changes 1.0 -)
1081		1531
		1532	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1533
		1534	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
		1535
1082	=back	1536	=back
1083		1537

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.32 by root, Sat Oct 9 11:18:12 2004 UTC vs. Revision 1.114 by root, Thu Jul 6 19:43:21 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.32 by root, Sat Oct 9 11:18:12 2004 UTC vs.
Revision 1.114 by root, Thu Jul 6 19:43:21 2006 UTC