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

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.35 by root, Wed Dec 15 00:53:23 2004 UTC vs. Revision 1.119 by root, Mon Aug 7 16:04:29 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.35 by root, Wed Dec 15 00:53:23 2004 UTC vs.
Revision 1.119 by root, Mon Aug 7 16:04:29 2006 UTC