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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.68 by root, Thu Aug 11 02:05:07 2005 UTC vs.
Revision 1.139 by ayin, Wed Oct 17 13:53:42 2007 UTC

…		…
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	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	20	frequently asked questions and answer to them and some common
21	problems. That document is also accessible on the World-Wide-Web at	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>.	22	L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.
23		23
24	=head1 RXVT-UNICODE VS. RXVT	24	=head1 RXVT-UNICODE VS. RXVT
25		25
26	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
27	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
28	world. Being a terminal emulator, however, some things are very difficult,	28	world. Being a terminal emulator, however, some things are very difficult,
29	especially cursive scripts such as arabic, vertically written scripts	29	especially cursive scripts such as arabic, vertically written scripts
30	like mongolian or scripts requiring extremely complex combining rules,	30	like mongolian or scripts requiring extremely complex combining rules,
31	like tibetan or devenagari. Don't expect pretty output when using these	31	like tibetan or devanagari. Don't expect pretty output when using these
32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	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	33	fine, though. A somewhat difficult case are right-to-left scripts, such
34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35	belong into the application, not the terminal emulator (too many things --	35	belong into the application, not the terminal emulator (too many things --
36	such as cursor-movement while editing -- break otherwise), but that might	36	such as cursor-movement while editing -- break otherwise), but that might
37	change.	37	change.
38		38
39	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
40	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
41	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
42	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
43	another for japanese.	43	another for japanese.
44		44
45	Therefore another design rationale was the use of multiple fonts to	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	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	47	programs force onto its users never made sense to me: You should be able
48	to choose any font for any script freely.	48	to choose any font for any script freely.
49		49
50	Apart from that, rxvt-unicode is also much better internationalised than	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	51	its 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	52	in i18n-environments, is faster, and has a lot bugs less than the original
53	rxvt. This all in addition to dozens of other small improvements.	53	rxvt. This all in addition to dozens of other small improvements.
54		54
55	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
56	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
57	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
58	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
59	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
60	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and	60	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
61	@@RXVT_NAME@@c(1) (client).	61	@@RXVT_NAME@@c(1) (client).
62		62
63	It also makes technical information about escape sequences (which have	63	It also makes technical information about escape sequences (which have
64	been extended) easier accessible: see @@RXVT_NAME@@(7) for technical	64	been extended) more accessible: see @@RXVT_NAME@@(7) for technical
65	reference documentation (escape sequences etc.).	65	reference documentation (escape sequences etc.).
66		66
67	=head1 OPTIONS	67	=head1 OPTIONS
68		68
69	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
…		…
93		93
94	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
95	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
96	B<DISPLAY> environment variable is used.	96	B<DISPLAY> environment variable is used.
97		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
98	=item B<-geometry> I<geom>	103	=item B<-geometry> I<geom>
99		104
100	Window geometry (B<-g> still respected); resource B<geometry>.	105	Window geometry (B<-g> still respected); resource B<geometry>.
101		106
102	=item B<-rv>\|B<+rv>	107	=item B<-rv>\|B<+rv>
103		108
104	Turn on/off simulated reverse video; resource B<reverseVideo>.	109	Turn on/off simulated reverse video; resource B<reverseVideo>.
105		110
106	=item B<-j>\|B<+j>	111	=item B<-j>\|B<+j>
107		112
108	Turn on/off jump scrolling; resource B<jumpScroll>.	113	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
109		114
110	=item B<-ip>\|B<+ip>	115	=item B<-ss>\|B<+ss>
		116
		117	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
		118
		119	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>
111		120
112	Turn on/off inheriting parent window's pixmap. Alternative form is	121	Turn on/off inheriting parent window's pixmap. Alternative form is
113	B<-tr>; resource B<inheritPixmap>.	122	B<-tr>; resource B<inheritPixmap>.
		123
		124	I<Please address all transparency related issues to Sasha Vasko at
		125	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
114		126
115	=item B<-fade> I<number>	127	=item B<-fade> I<number>
116		128
117	Fade the text by the given percentage when focus is lost. Small values	129	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	130	fade a little only, 100 completely replaces all colours by the fade
119	colour; resource B<fading>.	131	colour; resource B<fading>.
120		132
121	=item B<-fadecolor> I<colour>	133	=item B<-fadecolor> I<colour>
122		134
123	Fade to this colour when fading is used (see B<-fade>). The default colour	135	Fade to this colour when fading is used (see B<-fade>). The default colour
124	is black. resource B<fadeColor>.	136	is opaque black. resource B<fadeColor>.
125		137
126	=item B<-tint> I<colour>	138	=item B<-tint> I<colour>
127		139
128	Tint the transparent background pixmap with the given colour when	140	Tint the transparent background pixmap with the given colour when
129	transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>	141	transparency is enabled with B<-tr> or B<-ip>. This only works for
		142	non-tiled backgrounds, currently. See also the B<-sh> option that can be
130	option that can be used to brighten or darken the image in addition to	143	used to brighten or darken the image in addition to tinting it.
131	tinting it; resource I<tintColor>.	144	Please note that certain tint colours can be applied on the server-side,
		145	thus yielding performance gain of two orders of magnitude. These colours are:
		146	blue, red, green, cyan, magenta, yellow, and those close to them; resource
		147	I<tintColor>. Example:
132		148
133	=item B<-sh>	149	@@RXVT_NAME@@ -tr -tint blue -sh 40
134		150
		151	=item B<-sh> I<number>
		152
135	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	153	Darken (0 .. 100) or lighten (-1 .. -100) the transparent
136	background image in addition to tinting it (i.e. B<-tint> must be	154	background image in addition to (or instead of) tinting it;
137	specified, too, e.g. C<-tint white>).	155	resource I<shading>.
		156
		157	=item B<-blt> I<string>
		158
		159	Specify background blending type. If background pixmap is specified
		160	at the same time as transparency - such pixmap will be blended over
		161	transparency image, using method specified. Supported values are :
		162	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
		163	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
		164	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
		165	alpha-blending; resource I<blendType>.
		166
		167	=item B<-blr> I<HxV>
		168
		169	Apply Gaussian Blur with the specified radii to the transparent
		170	background image. If single number is specified - both vertical and
		171	horizontal radii are considered to be the same. Setting one of the
		172	radii to 1 and another to a large number creates interesting effects
		173	on some backgrounds. Maximum radius value is 128; resource I<blurRadius>.
138		174
139	=item B<-bg> I<colour>	175	=item B<-bg> I<colour>
140		176
141	Window background colour; resource B<background>.	177	Window background colour; resource B<background>.
142		178
…		…
144		180
145	Window foreground colour; resource B<foreground>.	181	Window foreground colour; resource B<foreground>.
146		182
147	=item B<-pixmap> I<file[;geom]>	183	=item B<-pixmap> I<file[;geom]>
148		184
149	Compile I<XPM>: Specify XPM file for the background and also optionally	185	Compile I<afterimage>: Specify image file for the background and also
150	specify its scaling with a geometry string. Note you may need to	186	optionally specify its scaling with a geometry string. Note you may need to
151	add quotes to avoid special shell interpretation of the C<;> in the	187	add quotes to avoid special shell interpretation of the C<;> in the
152	command-line; resource B<backgroundPixmap>.	188	command-line; for more details see resource B<backgroundPixmap>.
153		189
154	=item B<-cr> I<colour>	190	=item B<-cr> I<colour>
155		191
156	The cursor colour; resource B<cursorColor>.	192	The cursor colour; resource B<cursorColor>.
157		193
…		…
169	resource B<borderColor>.	205	resource B<borderColor>.
170		206
171	=item B<-fn> I<fontlist>	207	=item B<-fn> I<fontlist>
172		208
173	Select the fonts to be used. This is a comma separated list of font names	209	Select the fonts to be used. This is a comma separated list of font names
174	that are used in turn when trying to display Unicode characters. The	210	that are checked in order when trying to find glyphs for characters. The
175	first font defines the cell size for characters; other fonts might be	211	first font defines the cell size for characters; other fonts might be
176	smaller, but not (in general) larger. A (hopefully) reasonable default	212	smaller, but not (in general) larger. A (hopefully) reasonable default
177	font list is always appended to it. See resource B<font> for more details.	213	font list is always appended to it. See resource B<font> for more details.
178		214
179	In short, to specify an X11 core font, just specify it's name or prefix it	215	In short, to specify an X11 core font, just specify its name or prefix it
180	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,	216	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
181	e.g.:	217	e.g.:
182		218
183	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	219	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
184	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	220	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
186	See also the question "How does rxvt-unicode choose fonts?" in the FAQ	222	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
187	section of @@RXVT_NAME@@(7).	223	section of @@RXVT_NAME@@(7).
188		224
189	=item B<-fb> I<fontlist>	225	=item B<-fb> I<fontlist>
190		226
191	Compile font-styles: The bold font list to use when bold characters are to	227	Compile I<font-styles>: The bold font list to use when B<bold> characters
192	be printed. See resource B<boldFont> for details.	228	are to be printed. See resource B<boldFont> for details.
193		229
194	=item B<-fi> I<fontlist>	230	=item B<-fi> I<fontlist>
195		231
196	Compile font-styles: The italic font list to use when bold characters are to	232	Compile I<font-styles>: The italic font list to use when I<italic>
197	be printed. See resource B<italicFont> for details.	233	characters are to be printed. See resource B<italicFont> for details.
198		234
199	=item B<-fbi> I<fontlist>	235	=item B<-fbi> I<fontlist>
200		236
201	Compile font-styles: The bold italic font list to use when bold characters are to	237	Compile I<font-styles>: The bold italic font list to use when B<< I<bold
202	be printed. See resource B<boldItalicFont> for details.	238	italic> >> characters are to be printed. See resource B<boldItalicFont>
		239	for details.
		240
		241	=item B<-is>\|B<+is>
		242
		243	Compile I<font-styles>: Bold/Italic font styles imply high intensity
		244	foreground/background (default). See resource B<intensityStyles> for
		245	details.
203		246
204	=item B<-name> I<name>	247	=item B<-name> I<name>
205		248
206	Specify the application name under which resources are to be obtained,	249	Specify the application name under which resources are to be obtained,
207	rather than the default executable file name. Name should not contain	250	rather than the default executable file name. Name should not contain
…		…
287		330
288	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	331	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
289	if honoured by the WM, the rxvt-unicode window will not have window	332	if honoured by the WM, the rxvt-unicode window will not have window
290	decorations; resource B<borderLess>.	333	decorations; resource B<borderLess>.
291		334
		335	=item B<-override-redirect>
		336
		337	Compile I<frills>: Sets override-redirect on the window; resource
		338	B<override-redirect>.
		339
		340	=item B<-sbg>
		341
		342	Compile I<frills>: Disable the usage of the built-in block graphics/line
		343	drawing characters and just rely on what the specified fonts provide. Use
		344	this if you have a good font and want to use its block graphic glyphs;
		345	resource B<skipBuiltinGlyphs>.
		346
292	=item B<-lsp> I<number>	347	=item B<-lsp> I<number>
293		348
294	Compile I<frills>: Lines (pixel height) to insert between each row of	349	Compile I<frills>: Lines (pixel height) to insert between each row of
295	the display. Useful to work around font rendering problems; resource	350	the display. Useful to work around font rendering problems; resource
296	B<linespace>.	351	B<lineSpace>.
297		352
298	=item B<-tn> I<termname>	353	=item B<-tn> I<termname>
299		354
300	This option specifies the name of the terminal type to be set in the	355	This option specifies the name of the terminal type to be set in the
301	B<TERM> environment variable. This terminal type must exist in the	356	B<TERM> environment variable. This terminal type must exist in the
…		…
310	given on the command line. If this option is used, it must be the last	365	given on the command line. If this option is used, it must be the last
311	on the command-line. If there is no B<-e> option then the default is to	366	on the command-line. If there is no B<-e> option then the default is to
312	run the program specified by the B<SHELL> environment variable or,	367	run the program specified by the B<SHELL> environment variable or,
313	failing that, I<sh(1)>.	368	failing that, I<sh(1)>.
314		369
		370	Please note that you must specify a program with arguments. If you want to
		371	run shell commands, you have to specify the shell, like this:
		372
		373	@@RXVT_NAME@@ -e sh -c "shell commands"
		374
315	=item B<-title> I<text>	375	=item B<-title> I<text>
316		376
317	Window title (B<-T> still respected); the default title is the basename	377	Window title (B<-T> still respected); the default title is the basename
318	of the program specified after the B<-e> option, if any, otherwise the	378	of the program specified after the B<-e> option, if any, otherwise the
319	application name; resource B<title>.	379	application name; resource B<title>.
…		…
350	for more info.	410	for more info.
351		411
352	=item B<-tcw>	412	=item B<-tcw>
353		413
354	Change the meaning of triple-click selection with the left mouse	414	Change the meaning of triple-click selection with the left mouse
		415	button. Only effective when the original (non-perl) selection code is
355	button. Instead of selecting a full line it will extend the selection the	416	in-use. Instead of selecting a full line it will extend the selection the
356	end of the logical line only. resource B<tripleclickwords>.	417	end of the logical line only. resource B<tripleclickwords>.
357		418
358	=item B<-insecure>	419	=item B<-insecure>
359		420
360	Enable "insecure" mode, which currently enables most of the escape	421	Enable "insecure" mode, which currently enables most of the escape
…		…
375	=item B<-ssr>\|B<+ssr>	436	=item B<-ssr>\|B<+ssr>
376		437
377	Turn on/off secondary screen scroll (default enabled); resource	438	Turn on/off secondary screen scroll (default enabled); resource
378	B<secondaryScroll>.	439	B<secondaryScroll>.
379		440
		441	=item B<-hold>\|B<+hold>
		442
		443	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		444	will not immediately destroy its window when the program executed within
		445	it exits. Instead, it will wait till it is being killed or closed by the
		446	user; resource B<hold>.
		447
380	=item B<-keysym.>I<sym> I<string>	448	=item B<-keysym.>I<sym> I<string>
381		449
382	Remap a key symbol. See resource B<keysym>.	450	Remap a key symbol. See resource B<keysym>.
383		451
384	=item B<-embed> I<windowid>	452	=item B<-embed> I<windowid>
385		453
386	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,	454	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
387	which enables applications to easily embed a terminal.	455	which enables applications to easily embed a terminal.
388		456
389	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it	457	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
390	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it	458	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
391	quite a bit, so don't expect it to keep some specific state. It's best to	459	quite a bit, so don't expect it to keep some specific state. It's best to
…		…
394	The window will not be destroyed when @@RXVT_NAME@@ exits.	462	The window will not be destroyed when @@RXVT_NAME@@ exits.
395		463
396	It might be useful to know that @@RXVT_NAME@@ will not close file	464	It might be useful to know that @@RXVT_NAME@@ will not close file
397	descriptors passed to it (except for stdin/out/err, of course), so you	465	descriptors passed to it (except for stdin/out/err, of course), so you
398	can use file descriptors to communicate with the programs within the	466	can use file descriptors to communicate with the programs within the
399	terminal. This works regardless of wether the C<-embed> option was used or	467	terminal. This works regardless of whether the C<-embed> option was used or
400	not.	468	not.
401		469
402	Here is a short Gtk2-perl snippet that illustrates how this option can be	470	Here is a short Gtk2-perl snippet that illustrates how this option can be
403	used (a longer example is in F<doc/embed>):	471	used (a longer example is in F<doc/embed>):
404		472
…		…
406	$rxvt->signal_connect_after (realize => sub {	474	$rxvt->signal_connect_after (realize => sub {
407	my $xid = $_[0]->window->get_xid;	475	my $xid = $_[0]->window->get_xid;
408	system "@@RXVT_NAME@@ -embed $xid &";	476	system "@@RXVT_NAME@@ -embed $xid &";
409	});	477	});
410		478
411	=item B<-pty-fd> I<fileno>	479	=item B<-pty-fd> I<file descriptor>
412		480
413	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	481	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
414	pair but instead use the given filehandle as the tty master. This is	482	pair but instead use the given file descriptor as the tty master. This is
415	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator	483	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
416	without having to run a program within it.	484	without having to run a program within it.
417		485
418	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	486	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
419	entries and will not tinker with pty/tty permissions - you have to do that	487	entries and will not tinker with pty/tty permissions - you have to do that
420	yourself if you want that.	488	yourself if you want that.
		489
		490	As an extremely special case, specifying C<-1> will completely suppress
		491	pty/tty operations.
421		492
422	Here is a example in perl that illustrates how this option can be used (a	493	Here is a example in perl that illustrates how this option can be used (a
423	longer example is in F<doc/pty-fd>):	494	longer example is in F<doc/pty-fd>):
424		495
425	use IO::Pty;	496	use IO::Pty;
…		…
432		503
433	# now communicate with rxvt	504	# now communicate with rxvt
434	my $slave = $pty->slave;	505	my $slave = $pty->slave;
435	while (<$slave>) { print $slave "got <$_>\n" }	506	while (<$slave>) { print $slave "got <$_>\n" }
436		507
		508	=item B<-pe> I<string>
		509
		510	Comma-separated list of perl extension scripts to use (or not to use) in
		511	this terminal instance. See resource B<perl-ext> for details.
		512
437	=back	513	=back
438		514
439	=head1 RESOURCES (available also as long-options)	515	=head1 RESOURCES (available also as long-options)
440		516
441	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	517	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
442	options) compiled into your version.	518	options) compiled into your version.
443		519
444	There are two different methods that @@RXVT_NAME@@ can use to get the	520	You can set and change the resources using X11 tools like B<xrdb>. Many
445	Xresource data: using the X libraries (Xrm*-functions) or internal	521	distribution do also load settings from the B<~/.Xresources> file when X
446	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	522	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
447	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	523	with later settings overwriting earlier ones:
448	resources using X11 tools like B<xrdb>. Many distribution do also load
449	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
450	will consult the following files/resources in order, with later settings
451	overwriting earlier ones:
452		524
453	1. system-wide app-defaults file, either locale-dependent OR global	525	1. system-wide app-defaults file, either locale-dependent OR global
454	2. app-defaults file in $XAPPLRESDIR	526	2. app-defaults file in $XAPPLRESDIR
455	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	527	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
456	4. SCREEN_RESOURCES for the current screen	528	4. SCREEN_RESOURCES for the current screen
457	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	529	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
458		530
459	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
460	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
461	set in XAPPLOADDIR/URxvt (compile-time defined: usually
462	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
463	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
464	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	531	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
465	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows	532	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
466	resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be	533	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
467	easily configured, while the class name B<URxvt> allows resources	534	configured, while the class name B<URxvt> allows resources unique to
468	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	535	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
469	shared between different B<@@RXVT_NAME@@> configurations. If no	536	configurations. If no resources are specified, suitable defaults will
470	resources are specified, suitable defaults will be used. Command-line	537	be used. Command-line arguments can be used to override resource
471	arguments can be used to override resource settings. The following	538	settings. The following resources are supported (you might want to
472	resources are allowed:	539	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		540	extensions not documented here):
473		541
474	=over 4	542	=over 4
		543
		544	=item B<depth:> I<bitdepth>
		545
		546	Compile I<xft>: Attempt to find a visual with the given bit depth;
		547	option B<-depth>.
475		548
476	=item B<geometry:> I<geom>	549	=item B<geometry:> I<geom>
477		550
478	Create the window with the specified X window geometry [default 80x24];	551	Create the window with the specified X window geometry [default 80x24];
479	option B<-geometry>.	552	option B<-geometry>.
…		…
516	Use the specified colour to display underlined characters when the	589	Use the specified colour to display underlined characters when the
517	foreground colour is the default.	590	foreground colour is the default.
518		591
519	=item B<colorRV:> I<colour>	592	=item B<colorRV:> I<colour>
520		593
521	Use the specified colour as the background for reverse video	594	Use the specified colour as the background for reverse video characters
522	characters.	595	when OPTION_HC is disabled (--disable-frills).
523		596
524	=item B<underlineColor:> I<colour>	597	=item B<underlineColor:> I<colour>
525		598
526	If set, use the specified colour as the colour for the underline	599	If set, use the specified colour as the colour for the underline
527	itself. If unset, use the foreground colour.	600	itself. If unset, use the foreground colour.
…		…
543	option B<-rv>. B<False>: regular screen colours [default]; option	616	option B<-rv>. B<False>: regular screen colours [default]; option
544	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	617	B<+rv>. See note in B<COLORS AND GRAPHICS> section.
545		618
546	=item B<jumpScroll:> I<boolean>	619	=item B<jumpScroll:> I<boolean>
547		620
548	B<True>: specify that jump scrolling should be used. When scrolling	621	B<True>: specify that jump scrolling should be used. When receiving lots
549	quickly, fewer screen updates are performed [default]; option B<-j>.	622	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		623	has been read, resulting in fewer updates while still displaying every
		624	received line; option B<-j>.
		625
550	B<False>: specify that smooth scrolling should be used; option B<+j>.	626	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		627	force a screen refresh on each new line it received; option B<+j>.
		628
		629	=item B<skipScroll:> I<boolean>
		630
		631	B<True>: (the default) specify that skip scrolling should be used. When
		632	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
		633	(around 60 times per second), resulting in far fewer updates. This can
		634	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		635	option B<-ss>.
		636
		637	B<False>: specify that everything is to be displayed, even
		638	if the refresh is too fast for the human eye to read anything (or the
		639	monitor to display anything); option B<+ss>.
551		640
552	=item B<inheritPixmap:> I<boolean>	641	=item B<inheritPixmap:> I<boolean>
553		642
554	B<True>: make the background inherit the parent windows' pixmap, giving	643	B<True>: make the background inherit the parent windows' pixmap, giving
555	artificial transparency. B<False>: do not inherit the parent windows'	644	artificial transparency. B<False>: do not inherit the parent windows'
556	pixmap.	645	pixmap.
557		646
		647	I<Please note that transparency of any kind if completely unsupported by
		648	the author. Don't bug him with installation questions!>
		649
558	=item B<fading:> I<number>	650	=item B<fading:> I<number>
559		651
560	Fade the text by the given percentage when focus is lost; option B<-fade>.	652	Fade the text by the given percentage when focus is lost; option B<-fade>.
561		653
562	=item B<fadeColor:> I<colour>	654	=item B<fadeColor:> I<colour>
…		…
569	Tint the transparent background pixmap with the given colour; option	661	Tint the transparent background pixmap with the given colour; option
570	B<-tint>.	662	B<-tint>.
571		663
572	=item B<shading:> I<number>	664	=item B<shading:> I<number>
573		665
574	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	666	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
575	image in addition to tinting it.	667	in addition to tinting it; option B<-sh>.
		668
		669	=item B<blendType:> I<string>
		670
		671	Specify background blending type; option B<-blt>.
		672
		673	=item B<blurRadius:> I<number>
		674
		675	Apply Gaussian Blurr with the specified radius to the transparent
		676	background image; option B<-blr>.
576		677
577	=item B<scrollColor:> I<colour>	678	=item B<scrollColor:> I<colour>
578		679
579	Use the specified colour for the scrollbar [default #B2B2B2].	680	Use the specified colour for the scrollbar [default #B2B2B2].
580		681
…		…
588	The colour of the border around the text area and between the scrollbar	689	The colour of the border around the text area and between the scrollbar
589	and the text.	690	and the text.
590		691
591	=item B<backgroundPixmap:> I<file[;geom]>	692	=item B<backgroundPixmap:> I<file[;geom]>
592		693
593	Use the specified XPM file (note the `.xpm' extension is optional) for	694	Use the specified image file for the background and also optionally
594	the background and also optionally specify its scaling with a geometry	695	specify its scaling with a geometry string B<WxH+X+Y>,
595	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	696	in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
596	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	697	and B<"X" / "Y"> locate the image centre (percent).
597	centre (percent). A scale of 0 displays the image with tiling. A scale	698	A scale of 0 displays the image with tiling. A scale of 1 displays the
598	of 1 displays the image without any scaling. A scale of 2 to 9	699	image without any scaling. A scale of 2 to 9 specifies an integer
599	specifies an integer number of images in that direction. No image will	700	number of images in that direction. No image will be magnified beyond
600	be magnified beyond 10 times its original size. The maximum permitted	701	10 times its original size. The maximum permitted scale is 1000.
601	scale is 1000. [default 0x0+50+50]	702	Special string of B<"auto"> used as a geometry will cause image to be
602		703	automatically scaled to match window size.
603	=item B<menu:> I<file[;tag]>	704	If used in conjunction with B<-tr> option - specified pixmap will be
604		705	blended over transparency image using either alpha-blending, or any
605	Read in the specified menu file (note the `.menu' extension is	706	other blending type, specified with B<-blt "type"> option.
606	optional) and also optionally specify a starting tag to find. See the	707	[default 0x0+50+50]
607	reference documentation for details on the syntax for the menuBar.
608		708
609	=item B<path:> I<path>	709	=item B<path:> I<path>
610		710
611	Specify the colon-delimited search path for finding files (XPM and	711	Specify the colon-delimited search path for finding background image files.
612	menus), in addition to the paths specified by the B<RXVTPATH> and
613	B<PATH> environment variables.
614		712
615	=item B<font:> I<fontlist>	713	=item B<font:> I<fontlist>
616		714
617	Select the fonts to be used. This is a comma separated list of font	715	Select the fonts to be used. This is a comma separated list of font names
618	names that are used in turn when trying to display Unicode characters.	716	that are checked in order when trying to find glyphs for characters. The
619	The first font defines the cell size for characters; other fonts might	717	first font defines the cell size for characters; other fonts might be
620	be smaller, but not larger. A reasonable default font list is always	718	smaller, but not (in general) larger. A (hopefully) reasonable default
621	appended to it. option B<-fn>.	719	font list is always appended to it; option B<-fn>.
622		720
623	Each font can either be a standard X11 core font (XLFD) name, with	721	Each font can either be a standard X11 core font (XLFD) name, with
624	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.	722	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
625		723
626	In addition, each font can be prefixed with additional hints and	724	In addition, each font can be prefixed with additional hints and
…		…
628	hint currently is C<codeset=codeset-name>, and this is only used for Xft	726	hint currently is C<codeset=codeset-name>, and this is only used for Xft
629	fonts.	727	fonts.
630		728
631	For example, this font resource	729	For example, this font resource
632		730
633	URxvt*font: 9x15bold,\	731	URxvt.font: 9x15bold,\
634	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	732	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
635	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \	733	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
636	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	734	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
637	xft:Code2000:antialias=false	735	xft:Code2000:antialias=false
638		736
…		…
672	not possible, replacement fonts of the desired shape will be tried.	770	not possible, replacement fonts of the desired shape will be tried.
673		771
674	If set, but empty, then this specific style is disabled and the normal	772	If set, but empty, then this specific style is disabled and the normal
675	text font will being used for the given style.	773	text font will being used for the given style.
676		774
		775	=item B<intensityStyles:> I<boolean>
		776
		777	When font styles are not enabled, or this option is enabled (B<True>,
		778	option B<-is>, the default), bold and italic font styles imply high
		779	intensity foreground/background colours. Disabling this option (B<False>,
		780	option B<+is>) disables this behaviour, the high intensity colours are not
		781	reachable.
		782
677	=item B<selectstyle:> I<mode>	783	=item B<selectstyle:> I<mode>
678		784
679	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	785	Set mouse selection style to B<old> which is 2.20, B<oldword> which
680	xterm style with 2.20 old word selection, or anything else which gives	786	is xterm style with 2.20 old word selection, or anything else which
681	xterm style selection.	787	gives xterm style selection. Only effective when the original (non-perl)
		788	selection code is in use.
682		789
683	=item B<scrollstyle:> I<mode>	790	=item B<scrollstyle:> I<mode>
684		791
685	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	792	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
686	the author's favourite.	793	the author's favourite.
…		…
700	=item B<mapAlert:> I<boolean>	807	=item B<mapAlert:> I<boolean>
701		808
702	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	809	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
703	de-iconify (map) on receipt of a bell character [default].	810	de-iconify (map) on receipt of a bell character [default].
704		811
		812	=item B<urgentOnBell:> I<boolean>
		813
		814	B<True>: set the urgency hint for the wm on receipt of a bell character.
		815	B<False>: do not set the urgency hint [default].
		816
705	=item B<visualBell:> I<boolean>	817	=item B<visualBell:> I<boolean>
706		818
707	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	819	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
708	B<False>: no visual bell [default]; option B<+vb>.	820	B<False>: no visual bell [default]; option B<+vb>.
709		821
…		…
727		839
728	The string will be interpreted as if typed into the shell as-is.	840	The string will be interpreted as if typed into the shell as-is.
729		841
730	Example:	842	Example:
731		843
732	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	844	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
733		845
734	This creates a new file in your home directory with the screen contents	846	This creates a new file in your home directory with the screen contents
735	everytime you hit C<Print>.	847	every time you hit C<Print>.
736		848
737	=item B<scrollBar:> I<boolean>	849	=item B<scrollBar:> I<boolean>
738		850
739	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	851	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
740	disable the scrollbar; option B<+sb>.	852	disable the scrollbar; option B<+sb>.
…		…
762		874
763	=item B<scrollWithBuffer:> I<boolean>	875	=item B<scrollWithBuffer:> I<boolean>
764		876
765	B<True>: scroll with scrollback buffer when tty receives new lines (and	877	B<True>: scroll with scrollback buffer when tty receives new lines (and
766	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	878	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
767	with scrollback buffer when tty recieves new lines; option B<+sw>.	879	with scrollback buffer when tty receives new lines; option B<+sw>.
768		880
769	=item B<scrollTtyKeypress:> I<boolean>	881	=item B<scrollTtyKeypress:> I<boolean>
770		882
771	B<True>: scroll to bottom when a non-special key is pressed. Special keys	883	B<True>: scroll to bottom when a non-special key is pressed. Special keys
772	are those which are intercepted by rxvt-unicode for special handling and	884	are those which are intercepted by rxvt-unicode for special handling and
…		…
791	=item B<borderLess:> I<boolean>	903	=item B<borderLess:> I<boolean>
792		904
793	Set MWM hints to request a borderless window, i.e. if honoured by the	905	Set MWM hints to request a borderless window, i.e. if honoured by the
794	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.	906	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
795		907
		908	=item B<skipBuiltinGlyphs:> I<boolean>
		909
		910	Compile I<frills>: Disable the usage of the built-in block graphics/line
		911	drawing characters and just rely on what the specified fonts provide. Use
		912	this if you have a good font and want to use its block graphic glyphs;
		913	option B<-sbg>.
		914
796	=item B<termName:> I<termname>	915	=item B<termName:> I<termname>
797		916
798	Specifies the terminal type name to be set in the B<TERM> environment	917	Specifies the terminal type name to be set in the B<TERM> environment
799	variable; option B<-tn>.	918	variable; option B<-tn>.
800		919
801	=item B<linespace:> I<number>	920	=item B<lineSpace:> I<number>
802		921
803	Specifies number of lines (pixel height) to insert between each row of	922	Specifies number of lines (pixel height) to insert between each row of
804	the display [default 0]; option B<-lsp>.	923	the display [default 0]; option B<-lsp>.
805		924
806	=item B<meta8:> I<boolean>	925	=item B<meta8:> I<boolean>
…		…
855	pressed. If unset it will send the sequence traditionally associated	974	pressed. If unset it will send the sequence traditionally associated
856	with the B<Execute> key.	975	with the B<Execute> key.
857		976
858	=item B<cutchars:> I<string>	977	=item B<cutchars:> I<string>
859		978
860	The characters used as delimiters for double-click word selection. The	979	The characters used as delimiters for double-click word selection
861	built-in default:	980	(whitespace delimiting is added automatically if resource is given).
		981
		982	When the perl selection extension is in use (the default if compiled
		983	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		984	characters will be created (if the resource exists, otherwise, no regex
		985	will be created). In this mode, characters outside ISO-8859-1 can be used.
		986
		987	When the selection extension is not used, only ISO-8859-1 characters can
		988	be used. If not specified, the built-in default is used:
862		989
863	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	990	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>
864		991
865	=item B<preeditType:> I<style>	992	=item B<preeditType:> I<style>
866		993
…		…
873	=item B<imLocale:> I<name>	1000	=item B<imLocale:> I<name>
874		1001
875	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.	1002	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
876	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the	1003	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
877	input extension to be able to input japanese characters while staying in	1004	input extension to be able to input japanese characters while staying in
878	another locale. option B<-imlocale>.	1005	another locale; option B<-imlocale>.
879		1006
880	=item B<imFont:> I<fontset>	1007	=item B<imFont:> I<fontset>
881		1008
882	Specify the font-set used for XIM styles C<OverTheSpot> or	1009	Specify the font-set used for XIM styles C<OverTheSpot> or
883	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated	1010	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
…		…
888		1015
889	=item B<tripleclickwords:> I<boolean>	1016	=item B<tripleclickwords:> I<boolean>
890		1017
891	Change the meaning of triple-click selection with the left mouse	1018	Change the meaning of triple-click selection with the left mouse
892	button. Instead of selecting a full line it will extend the selection to	1019	button. Instead of selecting a full line it will extend the selection to
893	the end of the logical line only. option B<-tcw>.	1020	the end of the logical line only; option B<-tcw>.
894		1021
895	=item B<insecure:> I<boolean>	1022	=item B<insecure:> I<boolean>
896		1023
897	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	1024	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
898	echo arbitrary strings like the icon name or the locale. This could be	1025	echo arbitrary strings like the icon name or the locale. This could be
899	abused if somebody gets 8-bit-clean access to your display, whether	1026	abused if somebody gets 8-bit-clean access to your display, whether
900	throuh a mail client displaying mail bodies unfiltered or though	1027	through a mail client displaying mail bodies unfiltered or through
901	write(1). Therefore, these sequences are disabled by default. (Note	1028	write(1) or any other means. Therefore, these sequences are disabled by
902	that other terminals, including xterm, have these sequences	1029	default. (Note that many other terminals, including xterm, have these
903	enabled by default). You can enable them by setting this boolean	1030	sequences enabled by default, which doesn't make it safer, though).
904	resource or specifying B<-insecure> as an option. At the moment, this	1031
905	enabled display-answer, locale, findfont, icon label and window title	1032	You can enable them by setting this boolean resource or specifying
906	requests as well as dynamic menubar dispatch.	1033	B<-insecure> as an option. At the moment, this enables display-answer,
		1034	locale, findfont, icon label and window title requests.
907		1035
908	=item B<modifier:> I<modifier>	1036	=item B<modifier:> I<modifier>
909		1037
910	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	1038	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
911	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	1039	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
915		1043
916	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	1044	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
917	character is passed through. It may contain escape values as described	1045	character is passed through. It may contain escape values as described
918	in the entry on B<keysym> following.	1046	in the entry on B<keysym> following.
919		1047
920	=item B<secondaryScreen:> I<bool>	1048	=item B<secondaryScreen:> I<boolean>
921		1049
922	Turn on/off secondary screen (default enabled).	1050	Turn on/off secondary screen (default enabled).
923		1051
924	=item B<secondaryScroll:> I<bool>	1052	=item B<secondaryScroll:> I<boolean>
925		1053
926	Turn on/off secondary screen scroll (default enabled). If the this	1054	Turn on/off secondary screen scroll (default enabled). If this
927	option is enabled, scrolls on the secondary screen will change the	1055	option is enabled, scrolls on the secondary screen will change the
928	scrollback buffer and switching to/from the secondary screen will	1056	scrollback buffer and switching to/from the secondary screen will
929	instead scroll the screen up.	1057	instead scroll the screen up.
		1058
		1059	=item B<hold>: I<boolean>
		1060
		1061	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		1062	will not immediately destroy its window when the program executed within
		1063	it exits. Instead, it will wait till it is being killed or closed by the
		1064	user.
930		1065
931	=item B<keysym.>I<sym>: I<string>	1066	=item B<keysym.>I<sym>: I<string>
932		1067
933	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1068	Compile I<frills>: Associate I<string> with keysym I<sym>. The
934	intervening resource name B<keysym.> cannot be omitted.	1069	intervening resource name B<keysym.> cannot be omitted.
…		…
948	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1083	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
949	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1084	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
950	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1085	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
951	performed in an exact manner; however, the closest match is assured.	1086	performed in an exact manner; however, the closest match is assured.
952		1087
953	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1088	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
954	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1089	number), see RESOURCES in C<man 7 X> for futher details.
955	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
956	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
957	can start or end with whitespace.
958
959	Please note that you need to double the C<\> when using
960	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
961	use C<\033> instead of C<\e> (and so on), which will work with both Xt and
962	@@RXVT_NAME@@'s own processing).
963		1090
964	You can define a range of keysyms in one shot by providing a I<string>	1091	You can define a range of keysyms in one shot by providing a I<string>
965	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1092	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
966	should be a character not used by the strings.	1093	should be a character not used by the strings.
967		1094
968	Its usage can be demonstrated by an example:	1095	Its usage can be demonstrated by an example:
969		1096
970	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1097	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
…		…
979	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1106	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
980	example the following means "change the current locale to C<zh_CN.GBK>	1107	example the following means "change the current locale to C<zh_CN.GBK>
981	when Control-Meta-c is being pressed":	1108	when Control-Meta-c is being pressed":
982		1109
983	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1110	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		1111
		1112	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1113	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1114	manpage. For example, the F<selection> extension (activated via
		1115	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1116
		1117	URxvt.keysym.M-C-c: perl:selection:rot13
984		1118
985	Due the the large number of modifier combinations, a defined key mapping	1119	Due the the large number of modifier combinations, a defined key mapping
986	will match if at I<at least> the specified identifiers are being set, and	1120	will match if at I<at least> the specified identifiers are being set, and
987	no other key mappings with those and more bits are being defined. That	1121	no other key mappings with those and more bits are being defined. That
988	means that defining a key map for C<a> will automatically provide	1122	means that defining a key map for C<a> will automatically provide
…		…
1012	info):	1146	info):
1013		1147
1014	URxvt.keysym.M-C-3: command:\033[8;25;80t	1148	URxvt.keysym.M-C-3: command:\033[8;25;80t
1015	URxvt.keysym.M-C-4: command:\033[8;48;110t	1149	URxvt.keysym.M-C-4: command:\033[8;48;110t
1016		1150
		1151	=item B<perl-ext-common>: I<string>
		1152
		1153	=item B<perl-ext>: I<string>
		1154
		1155	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1156	use in this terminal instance; option B<-pe>.
		1157
		1158	Extension names can be prefixed with a C<-> sign to prohibit using
		1159	them. This can be useful to selectively disable some extensions loaded
		1160	by default, or specified via the C<perl-ext-common> resource. For
		1161	example, C<default,-selection> will use all the default extension except
		1162	C<selection>.
		1163
		1164	Extension names can also be followed by an argument in angle brackets
		1165	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1166	searchable scrollback to Alt/Meta-s). Mentioning the same extension
		1167	multiple times with different arguments will pass multiple arguments to
		1168	the extension.
		1169
		1170	Each extension is looked up in the library directories, loaded if
		1171	necessary, and bound to the current terminal instance.
		1172
		1173	If both of these resources are the empty string, then the perl
		1174	interpreter will not be initialized. The idea behind two options is that
		1175	B<perl-ext-common> will be used for extensions that should be available to
		1176	all instances, while B<perl-ext> is used for specific instances.
		1177
		1178	=item B<perl-eval>: I<string>
		1179
		1180	Perl code to be evaluated when all extensions have been registered. See
		1181	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
		1182	will be ignored when running setuid/setgid.
		1183
		1184	=item B<perl-lib>: I<path>
		1185
		1186	Colon-separated list of additional directories that hold extension
		1187	scripts. When looking for extensions specified by the C<perl> resource,
		1188	@@RXVT_NAME@@ will first look in these directories and then in
		1189	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
		1190	will be ignored when running setuid/setgid.
		1191
		1192	See the @@RXVT_NAME@@perl(3) manpage.
		1193
		1194	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1195
		1196	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1197	details.
		1198
		1199	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1200
		1201	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1202	for details.
		1203
		1204	=item B<searchable-scrollback:> I<keysym>
		1205
		1206	Sets the hotkey that starts the incremental scrollback buffer search
		1207	(default: C<M-s>).
		1208
		1209	=item B<urlLauncher>: I<string>
		1210
		1211	Specifies the program to be started with a URL argument. Used by the
		1212	C<selection-popup> and C<matcher> perl extensions.
		1213
		1214	=item B<transient-for>: I<windowid>
		1215
		1216	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1217
		1218	=item B<override-redirect>: I<boolean>
		1219
		1220	Compile I<frills>: Sets override-redirect for the terminal window, making
		1221	it almost invisible to window managers; option B<-override-redirect>.
		1222
		1223	=item B<iso14755_52:> I<boolean>
		1224
		1225	Turn on/off ISO 14755 5.2 mode (default enabled).
		1226
1017	=back	1227	=back
1018		1228
1019	=head1 THE SCROLLBAR	1229	=head1 THE SCROLLBAR
1020		1230
1021	Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window	1231	Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
…		…
1039	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1249	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1040	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1250	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1041	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1251	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1042	respectively.	1252	respectively.
1043		1253
1044	=head1 TEXT SELECTION AND INSERTION	1254	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1045		1255
1046	The behaviour of text selection and insertion mechanism is similar to	1256	The behaviour of text selection and insertion/pasting mechanism is similar
1047	I<xterm>(1).	1257	to I<xterm>(1).
1048		1258
1049	=over 4	1259	=over 4
1050		1260
1051	=item B<Selection>:	1261	=item B<Selecting>:
1052		1262
1053	Left click at the beginning of the region, drag to the end of the region	1263	Left click at the beginning of the region, drag to the end of the region
1054	and release; Right click to extend the marked region; Left double-click	1264	and release; Right click to extend the marked region; Left double-click
1055	to select a word; Left triple-click to select the entire logical line	1265	to select a word; Left triple-click to select the entire logical line
1056	(which can span multiple screen lines), unless modified by resource	1266	(which can span multiple screen lines), unless modified by resource
1057	B<tripleclickwords>.	1267	B<tripleclickwords>.
1058		1268
1059	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1269	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
1060	(Compile: I<frills>) will create a rectangular selection instead of a normal	1270	(Compile: I<frills>) will create a rectangular selection instead of a
1061	one.	1271	normal one. In this mode, every selected row becomes its own line in the
		1272	selection, and trailing whitespace is visually underlined and removed from
		1273	the selection.
1062		1274
1063	=item B<Insertion>:	1275	=item B<Pasting>:
1064		1276
1065	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1277	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1066	an B<@@RXVT_NAME@@> window causes the current text selection to be	1278	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1067	inserted as if it had been typed on the keyboard.	1279	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1280
		1281	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1282	inserted too.
1068		1283
1069	=back	1284	=back
1070		1285
1071	=head1 CHANGING FONTS	1286	=head1 CHANGING FONTS
1072		1287
1073	Changing fonts (or font sizes, respectively) via the keypad is not yet	1288	Changing fonts (or font sizes, respectively) via the keypad is not yet
1074	supported in rxvt-unicode. Bug me if you need this.	1289	supported in rxvt-unicode. Bug me if you need this.
1075		1290
1076	You can, however, switch fonts at runtime using escape sequences (and	1291	You can, however, switch fonts at runtime using escape sequences, e.g.:
1077	therefore using the menubar), e.g.:
1078		1292
1079	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1293	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1294
		1295	You can use keyboard shortcuts, too:
		1296
		1297	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1298	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1080		1299
1081	rxvt-unicode will automatically re-apply these fonts to the output so far.	1300	rxvt-unicode will automatically re-apply these fonts to the output so far.
1082		1301
1083	=head1 ISO 14755 SUPPORT	1302	=head1 ISO 14755 SUPPORT
1084		1303
1085	ISO 14755 is a standard for entering and viewing unicode characters	1304	ISO 14755 is a standard for entering and viewing unicode characters
1086	and character codes using the keyboard. It consists of 4 parts. The	1305	and character codes using the keyboard. It consists of 4 parts. The
1087	first part is available rxvt-unicode has been compiled with	1306	first part is available if rxvt-unicode has been compiled with
1088	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1307	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1089	with C<--enable-iso14755>.	1308	with C<--enable-iso14755>.
1090		1309
1091	=over 4	1310	=over 4
1092		1311
…		…
1112	This mode lets you input characters representing the keycap symbols of	1331	This mode lets you input characters representing the keycap symbols of
1113	your keyboard, if representable in the current locale encoding.	1332	your keyboard, if representable in the current locale encoding.
1114		1333
1115	Start by pressing C<Control> and C<Shift> together, then releasing	1334	Start by pressing C<Control> and C<Shift> together, then releasing
1116	them. The next special key (cursor keys, home etc.) you enter will not	1335	them. The next special key (cursor keys, home etc.) you enter will not
1117	invoke it's usual function but instead will insert the corresponding	1336	invoke its usual function but instead will insert the corresponding
1118	keycap symbol. The symbol will only be entered when the key has been	1337	keycap symbol. The symbol will only be entered when the key has been
1119	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1338	released, otherwise pressing e.g. C<Shift> would enter the symbol for
1120	C<ISO Level 2 Switch>, although your intention might have been to enter a	1339	C<ISO Level 2 Switch>, although your intention might have been to enter a
1121	reverse tab (Shift-Tab).	1340	reverse tab (Shift-Tab).
1122		1341
…		…
1155	=head1 COLORS AND GRAPHICS	1374	=head1 COLORS AND GRAPHICS
1156		1375
1157	In addition to the default foreground and background colours,	1376	In addition to the default foreground and background colours,
1158	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1377	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1159	high-intensity bold/blink versions of the same). Here is a list of the	1378	high-intensity bold/blink versions of the same). Here is a list of the
1160	colours with their B<rgb.txt> names.	1379	colours with their names.
1161		1380
1162	=begin table	1381	=begin table
1163		1382
1164	B<color0> (black) = Black	1383	B<color0> (black) = Black
1165	B<color1> (red) = Red3	1384	B<color1> (red) = Red3
…		…
1185	It is also possible to specify the colour values of B<foreground>,	1404	It is also possible to specify the colour values of B<foreground>,
1186	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1405	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1187	a number 0-15, as a convenient shorthand to reference the colour name of	1406	a number 0-15, as a convenient shorthand to reference the colour name of
1188	color0-color15.	1407	color0-color15.
1189		1408
		1409	In addition to the colours defined above, @@RXVT_NAME@@ offers an
		1410	additional 72 colours. The first 64 of those (with indices 16 to 79)
		1411	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
		1412	16>), followed by 8 additional shades of gray (with indices 80 to 87).
		1413
		1414	Together, all those colours implement the 88 colour xterm colours. Only
		1415	the first 16 can be changed using resources currently, the rest can only
		1416	be changed via command sequences ("escape codes").
		1417
1190	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1418	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1191	always swapping the foreground/background colours. This is in contrast to	1419	always swapping the foreground/background colours. This is in contrast to
1192	I<xterm>(1) where the colours are only swapped if they have not otherwise	1420	I<xterm>(1) where the colours are only swapped if they have not otherwise
1193	been specified. For example,	1421	been specified. For example,
1194		1422
…		…
1199	would yield White on Black, while on I<xterm>(1) it would yield Black	1427	would yield White on Black, while on I<xterm>(1) it would yield Black
1200	on White.	1428	on White.
1201		1429
1202	=back	1430	=back
1203		1431
		1432	=head2 ALPHA CHANNEL SUPPORT
		1433
		1434	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1435	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
		1436	(recommended, but B<MUST> have 4 digits/component) colour specifications,
		1437	in addition to the ones provided by X, where the additional A component
		1438	specifies opacity (alpha) values. The minimum value of C<0> is completely
		1439	transparent). You can also prefix any color with C<[percent]>, where
		1440	C<percent> is a decimal percentage (0-100) that specifies the opacity of
		1441	the color, where C<0> is completely transparent and C<100> is completelxy
		1442	opaque.
		1443
		1444	You probably need to specify B<"-depth 32">, too, and have the luck that
		1445	your X-server uses ARGB pixel layout, as X is far from just supporting
		1446	ARGB visuals out of the box, and rxvt-unicode just fudges around.
		1447
		1448	For example, the following selects an almost completely transparent red
		1449	background, and an almost opaque pink foreground:
		1450
		1451	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
		1452
		1453	I<Please note that transparency of any kind if completely unsupported by
		1454	the author. Don't bug him with installation questions!>
		1455
1204	=head1 ENVIRONMENT	1456	=head1 ENVIRONMENT
1205		1457
1206	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1458	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1207		1459
1208	=over 4	1460	=over 4
1209		1461
1210	=item B<TERM>	1462	=item B<TERM>
1211		1463
1212	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1464	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1213	resources or on the commandline.	1465	resources or on the command line.
1214		1466
1215	=item B<COLORTERM>	1467	=item B<COLORTERM>
1216		1468
1217	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1469	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1218	compiled with XPM support, and optionally with the added extension	1470	compiled with background image support, and optionally with the added
1219	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1471	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1472	screen.
1220		1473
1221	=item B<COLORFGBG>	1474	=item B<COLORFGBG>
1222		1475
1223	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1476	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1224	the colour code used as default foreground/text colour (or the string	1477	the colour code used as default foreground/text colour (or the string
1225	C<default> to indicate that the default-colour escape sequence is to be	1478	C<default> to indicate that the default-colour escape sequence is to be
1226	used), C<bg> is the colour code used as default background colour (or the	1479	used), C<bg> is the colour code used as default background colour (or the
1227	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1480	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1228	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1481	was compiled with background image support. Libraries like C<ncurses>
1229	(and do) use this information to optimize screen output.	1482	and C<slang> can (and do) use this information to optimize screen output.
1230		1483
1231	=item B<WINDOWID>	1484	=item B<WINDOWID>
1232		1485
1233	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1486	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1234	window, which usually has subwindows for the scrollbar, the terminal	1487	window, which usually has subwindows for the scrollbar, the terminal
…		…
1240	C<--with-terminfo=PATH>.	1493	C<--with-terminfo=PATH>.
1241		1494
1242	=item B<DISPLAY>	1495	=item B<DISPLAY>
1243		1496
1244	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1497	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1245	display in it's child processes.	1498	display in its child processes.
1246		1499
1247	=item B<SHELL>	1500	=item B<SHELL>
1248		1501
1249	The shell to be used for command execution, defaults to C</bin/sh>.	1502	The shell to be used for command execution, defaults to C</bin/sh>.
1250
1251	=item B<RXVTPATH>
1252
1253	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1254	files.
1255
1256	=item B<PATH>
1257
1258	Used in the same way as C<RXVTPATH>.
1259		1503
1260	=item B<RXVT_SOCKET>	1504	=item B<RXVT_SOCKET>
1261		1505
1262	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1506	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1263	@@RXVT_NAME@@d(1).	1507	@@RXVT_NAME@@d(1).
…		…
1293		1537
1294	=head1 SEE ALSO	1538	=head1 SEE ALSO
1295		1539
1296	@@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)	1540	@@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)
1297		1541
1298	=head1 BUGS
1299
1300	Check the BUGS file for an up-to-date list.
1301
1302	Cursor change support is not yet implemented.
1303
1304	Click-and-drag doesn't work with X11 mouse report overriding.
1305
1306	=head1 CURRENT PROJECT COORDINATOR	1542	=head1 CURRENT PROJECT COORDINATOR
1307		1543
1308	=over 4	1544	=over 4
1309		1545
1310	=item Project Coordinator	1546	=item Project Coordinator
1311		1547
1312	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1548	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1313		1549
1314	L<http://software.schmorp.de/#rxvt-unicode>	1550	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1315		1551
1316	=back	1552	=back
1317		1553
1318	=head1 AUTHORS	1554	=head1 AUTHORS
1319		1555
…		…
1341		1577
1342	Project Coordinator (changes.txt 2.21a to 2.4.5)	1578	Project Coordinator (changes.txt 2.21a to 2.4.5)
1343		1579
1344	=item Geoff Wing L<< <gcw@pobox.com> >>	1580	=item Geoff Wing L<< <gcw@pobox.com> >>
1345		1581
1346	Rewrote screen display and text selection routines. Project Coordinator	1582	Rewrote screen display and text selection routines.
		1583
1347	(changes.txt 2.4.6 - rxvt-unicode)	1584	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1348		1585
1349	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1586	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1350		1587
1351	Forked rxvt-unicode, rewrote most of the display code and internal	1588	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1352	character handling to store text in unicode, improve xterm	1589	extension, random hacks, numerous bugfixes and extensions.
1353	compatibility and apply numerous other bugfixes and extensions.
1354		1590
1355	Project Coordinator (Changes 1.0 -)	1591	Project Coordinator (Changes 1.0 -)
1356		1592
		1593	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1594
		1595	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
		1596
1357	=back	1597	=back
1358		1598

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.68 by root, Thu Aug 11 02:05:07 2005 UTC vs. Revision 1.139 by ayin, Wed Oct 17 13:53:42 2007 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.68 by root, Thu Aug 11 02:05:07 2005 UTC vs.
Revision 1.139 by ayin, Wed Oct 17 13:53:42 2007 UTC