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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.1 by root, Thu Aug 12 20:42:12 2004 UTC vs.
Revision 1.103 by root, Tue Jan 24 17:31:45 2006 UTC

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.1 by root, Thu Aug 12 20:42:12 2004 UTC vs. Revision 1.103 by root, Tue Jan 24 17:31:45 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.1 by root, Thu Aug 12 20:42:12 2004 UTC vs.
Revision 1.103 by root, Tue Jan 24 17:31:45 2006 UTC