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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.78 by root, Mon Jan 2 20:35:39 2006 UTC vs.
Revision 1.148 by ayin, Sat Nov 24 17:07:46 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> \| B<-tr>\|B<+tr>	115	=item B<-ss>\|B<+ss>
111		116
112	Turn on/off inheriting parent window's pixmap. Alternative form is	117	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
113	B<-tr>; resource B<inheritPixmap>.	118
		119	=item B<-tr>\|B<+tr>
		120
		121	Turn on/off illusion of a transparent window background; resource B<transparent>.
		122
		123	B<-ip> is still accepted as an obsolete alias but will be removed in
		124	future versions.
		125
		126	I<Please address all transparency related issues to Sasha Vasko at
		127	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
114		128
115	=item B<-fade> I<number>	129	=item B<-fade> I<number>
116		130
117	Fade the text by the given percentage when focus is lost. Small values	131	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	132	fade a little only, 100 completely replaces all colours by the fade
119	colour; resource B<fading>.	133	colour; resource B<fading>.
120		134
121	=item B<-fadecolor> I<colour>	135	=item B<-fadecolor> I<colour>
122		136
123	Fade to this colour when fading is used (see B<-fade>). The default colour	137	Fade to this colour when fading is used (see B<-fade>). The default colour
124	is black. resource B<fadeColor>.	138	is opaque black. resource B<fadeColor>.
125		139
126	=item B<-tint> I<colour>	140	=item B<-tint> I<colour>
127		141
128	Tint the transparent background pixmap with the given colour when	142	Tint the transparent background pixmap with the given colour when
129	transparency is enabled with B<-tr> or B<-ip>. This only works for	143	transparency is enabled with B<-tr>. This only works for
130	non-tiled backgrounds, currently. See also the B<-sh> option that can be	144	non-tiled backgrounds, currently. See also the B<-sh> option that can be
131	used to brighten or darken the image in addition to tinting it; resource	145	used to brighten or darken the image in addition to tinting it.
		146	Please note that certain tint colours can be applied on the server-side,
		147	thus yielding performance gain of two orders of magnitude. These colours are:
		148	blue, red, green, cyan, magenta, yellow, and those close to them. Also
		149	pure black and pure white colors essentially mean no tinting; resource
132	I<tintColor>. Example:	150	I<tintColor>. Example:
133		151
134	@@RXVT_NAME@@ -tr -tint blue -sh 40	152	@@RXVT_NAME@@ -tr -tint blue -sh 40
135		153
136	=item B<-sh>	154	=item B<-sh> I<number>
137		155
138	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	156	Darken (0 .. 100) or lighten (100 .. 200) the transparent
139	background image in addition to tinting it (i.e. B<-tint> must be	157	background image in addition to (or instead of) tinting it;
140	specified, too, e.g. C<-tint white>).	158	resource I<shading>.
		159
		160	=item B<-blt> I<string>
		161
		162	Specify background blending type. If background pixmap is specified
		163	at the same time as transparency - such pixmap will be blended over
		164	transparency image, using method specified. Supported values are :
		165	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
		166	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
		167	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
		168	alpha-blending. Compile I<afterimage>; resource I<blendType>.
		169
		170	=item B<-blr> I<HxV>
		171
		172	Apply Gaussian Blur with the specified radii to the transparent
		173	background image. If single number is specified - both vertical and
		174	horizontal radii are considered to be the same. Setting one of the
		175	radii to 1 and another to a large number creates interesting effects
		176	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
		177	resource I<blurRadius>.
141		178
142	=item B<-bg> I<colour>	179	=item B<-bg> I<colour>
143		180
144	Window background colour; resource B<background>.	181	Window background colour; resource B<background>.
145		182
146	=item B<-fg> I<colour>	183	=item B<-fg> I<colour>
147		184
148	Window foreground colour; resource B<foreground>.	185	Window foreground colour; resource B<foreground>.
149		186
150	=item B<-pixmap> I<file[;geom]>	187	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
151		188
152	Compile I<XPM>: Specify XPM file for the background and also optionally	189	Compile I<afterimage>: Specify image file for the background and also
153	specify its scaling with a geometry string. Note you may need to	190	optionally specify its scaling with a geometry string. Note you may need to
154	add quotes to avoid special shell interpretation of the C<;> in the	191	add quotes to avoid special shell interpretation of the C<;> in the
155	command-line; resource B<backgroundPixmap>.	192	command-line; for more details see resource B<backgroundPixmap>.
156		193
157	=item B<-cr> I<colour>	194	=item B<-cr> I<colour>
158		195
159	The cursor colour; resource B<cursorColor>.	196	The cursor colour; resource B<cursorColor>.
160		197
…		…
172	resource B<borderColor>.	209	resource B<borderColor>.
173		210
174	=item B<-fn> I<fontlist>	211	=item B<-fn> I<fontlist>
175		212
176	Select the fonts to be used. This is a comma separated list of font names	213	Select the fonts to be used. This is a comma separated list of font names
177	that are used in turn when trying to display Unicode characters. The	214	that are checked in order when trying to find glyphs for characters. The
178	first font defines the cell size for characters; other fonts might be	215	first font defines the cell size for characters; other fonts might be
179	smaller, but not (in general) larger. A (hopefully) reasonable default	216	smaller, but not (in general) larger. A (hopefully) reasonable default
180	font list is always appended to it. See resource B<font> for more details.	217	font list is always appended to it. See resource B<font> for more details.
181		218
182	In short, to specify an X11 core font, just specify it's name or prefix it	219	In short, to specify an X11 core font, just specify its name or prefix it
183	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,	220	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184	e.g.:	221	e.g.:
185		222
186	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	223	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	224	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
189	See also the question "How does rxvt-unicode choose fonts?" in the FAQ	226	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
190	section of @@RXVT_NAME@@(7).	227	section of @@RXVT_NAME@@(7).
191		228
192	=item B<-fb> I<fontlist>	229	=item B<-fb> I<fontlist>
193		230
194	Compile font-styles: The bold font list to use when bold characters are to	231	Compile I<font-styles>: The bold font list to use when B<bold> characters
195	be printed. See resource B<boldFont> for details.	232	are to be printed. See resource B<boldFont> for details.
196		233
197	=item B<-fi> I<fontlist>	234	=item B<-fi> I<fontlist>
198		235
199	Compile font-styles: The italic font list to use when bold characters are to	236	Compile I<font-styles>: The italic font list to use when I<italic>
200	be printed. See resource B<italicFont> for details.	237	characters are to be printed. See resource B<italicFont> for details.
201		238
202	=item B<-fbi> I<fontlist>	239	=item B<-fbi> I<fontlist>
203		240
204	Compile font-styles: The bold italic font list to use when bold characters are to	241	Compile I<font-styles>: The bold italic font list to use when B<< I<bold
205	be printed. See resource B<boldItalicFont> for details.	242	italic> >> characters are to be printed. See resource B<boldItalicFont>
		243	for details.
206		244
207	=item B<-is>\|B<+is>	245	=item B<-is>\|B<+is>
208		246
209	Compile font-styles: Bold/Italic font styles imply high intensity	247	Compile I<font-styles>: Bold/Italic font styles imply high intensity
210	foreground/background (default). See resource B<intensityStyles> for	248	foreground/background (default). See resource B<intensityStyles> for
211	details.	249	details.
212		250
213	=item B<-name> I<name>	251	=item B<-name> I<name>
214		252
…		…
296		334
297	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	335	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
298	if honoured by the WM, the rxvt-unicode window will not have window	336	if honoured by the WM, the rxvt-unicode window will not have window
299	decorations; resource B<borderLess>.	337	decorations; resource B<borderLess>.
300		338
		339	=item B<-override-redirect>
		340
		341	Compile I<frills>: Sets override-redirect on the window; resource
		342	B<override-redirect>.
		343
		344	=item B<-sbg>
		345
		346	Compile I<frills>: Disable the usage of the built-in block graphics/line
		347	drawing characters and just rely on what the specified fonts provide. Use
		348	this if you have a good font and want to use its block graphic glyphs;
		349	resource B<skipBuiltinGlyphs>.
		350
301	=item B<-lsp> I<number>	351	=item B<-lsp> I<number>
302		352
303	Compile I<frills>: Lines (pixel height) to insert between each row of	353	Compile I<frills>: Lines (pixel height) to insert between each row of
304	the display. Useful to work around font rendering problems; resource	354	the display. Useful to work around font rendering problems; resource
305	B<linespace>.	355	B<lineSpace>.
306		356
307	=item B<-tn> I<termname>	357	=item B<-tn> I<termname>
308		358
309	This option specifies the name of the terminal type to be set in the	359	This option specifies the name of the terminal type to be set in the
310	B<TERM> environment variable. This terminal type must exist in the	360	B<TERM> environment variable. This terminal type must exist in the
…		…
364	for more info.	414	for more info.
365		415
366	=item B<-tcw>	416	=item B<-tcw>
367		417
368	Change the meaning of triple-click selection with the left mouse	418	Change the meaning of triple-click selection with the left mouse
		419	button. Only effective when the original (non-perl) selection code is
369	button. Instead of selecting a full line it will extend the selection the	420	in-use. Instead of selecting a full line it will extend the selection the
370	end of the logical line only. resource B<tripleclickwords>.	421	end of the logical line only. resource B<tripleclickwords>.
371		422
372	=item B<-insecure>	423	=item B<-insecure>
373		424
374	Enable "insecure" mode, which currently enables most of the escape	425	Enable "insecure" mode, which currently enables most of the escape
…		…
396	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	447	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
397	will not immediately destroy its window when the program executed within	448	will not immediately destroy its window when the program executed within
398	it exits. Instead, it will wait till it is being killed or closed by the	449	it exits. Instead, it will wait till it is being killed or closed by the
399	user; resource B<hold>.	450	user; resource B<hold>.
400		451
		452	=item B<-xrm> I<string>
		453
		454	Works like the X Toolkit option of the same name, by adding the I<string>
		455	as if it were specified in a resource file. Resource values specified this
		456	way take precedence over all other resource specifications.
		457
		458	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		459	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		460	options can be specified as long-options on the commandline, so use
		461	of B<-xrm> is mostly limited to cases where you want to specify other
		462	resources (e.g. for input methods) or for compatibility with other
		463	programs.
		464
401	=item B<-keysym.>I<sym> I<string>	465	=item B<-keysym.>I<sym> I<string>
402		466
403	Remap a key symbol. See resource B<keysym>.	467	Remap a key symbol. See resource B<keysym>.
404		468
405	=item B<-embed> I<windowid>	469	=item B<-embed> I<windowid>
406		470
407	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,	471	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
408	which enables applications to easily embed a terminal.	472	which enables applications to easily embed a terminal.
409		473
410	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it	474	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
411	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it	475	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
412	quite a bit, so don't expect it to keep some specific state. It's best to	476	quite a bit, so don't expect it to keep some specific state. It's best to
…		…
415	The window will not be destroyed when @@RXVT_NAME@@ exits.	479	The window will not be destroyed when @@RXVT_NAME@@ exits.
416		480
417	It might be useful to know that @@RXVT_NAME@@ will not close file	481	It might be useful to know that @@RXVT_NAME@@ will not close file
418	descriptors passed to it (except for stdin/out/err, of course), so you	482	descriptors passed to it (except for stdin/out/err, of course), so you
419	can use file descriptors to communicate with the programs within the	483	can use file descriptors to communicate with the programs within the
420	terminal. This works regardless of wether the C<-embed> option was used or	484	terminal. This works regardless of whether the C<-embed> option was used or
421	not.	485	not.
422		486
423	Here is a short Gtk2-perl snippet that illustrates how this option can be	487	Here is a short Gtk2-perl snippet that illustrates how this option can be
424	used (a longer example is in F<doc/embed>):	488	used (a longer example is in F<doc/embed>):
425		489
…		…
427	$rxvt->signal_connect_after (realize => sub {	491	$rxvt->signal_connect_after (realize => sub {
428	my $xid = $_[0]->window->get_xid;	492	my $xid = $_[0]->window->get_xid;
429	system "@@RXVT_NAME@@ -embed $xid &";	493	system "@@RXVT_NAME@@ -embed $xid &";
430	});	494	});
431		495
432	=item B<-pty-fd> I<fileno>	496	=item B<-pty-fd> I<file descriptor>
433		497
434	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	498	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
435	pair but instead use the given filehandle as the tty master. This is	499	pair but instead use the given file descriptor as the tty master. This is
436	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator	500	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
437	without having to run a program within it.	501	without having to run a program within it.
438		502
439	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	503	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
440	entries and will not tinker with pty/tty permissions - you have to do that	504	entries and will not tinker with pty/tty permissions - you have to do that
441	yourself if you want that.	505	yourself if you want that.
		506
		507	As an extremely special case, specifying C<-1> will completely suppress
		508	pty/tty operations.
442		509
443	Here is a example in perl that illustrates how this option can be used (a	510	Here is a example in perl that illustrates how this option can be used (a
444	longer example is in F<doc/pty-fd>):	511	longer example is in F<doc/pty-fd>):
445		512
446	use IO::Pty;	513	use IO::Pty;
…		…
455	my $slave = $pty->slave;	522	my $slave = $pty->slave;
456	while (<$slave>) { print $slave "got <$_>\n" }	523	while (<$slave>) { print $slave "got <$_>\n" }
457		524
458	=item B<-pe> I<string>	525	=item B<-pe> I<string>
459		526
460	Colon-separated list of perl extension scripts to use in this terminal instance. See resource B<perl-ext>.	527	Comma-separated list of perl extension scripts to use (or not to use) in
		528	this terminal instance. See resource B<perl-ext> for details.
461		529
462	=back	530	=back
463		531
464	=head1 RESOURCES (available also as long-options)	532	=head1 RESOURCES (available also as long-options)
465		533
466	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	534	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
467	options) compiled into your version.	535	options) compiled into your version.
468		536
469	There are two different methods that @@RXVT_NAME@@ can use to get the	537	You can set and change the resources using X11 tools like B<xrdb>. Many
470	Xresource data: using the X libraries (Xrm*-functions) or internal	538	distribution do also load settings from the B<~/.Xresources> file when X
471	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	539	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
472	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	540	with later settings overwriting earlier ones:
473	resources using X11 tools like B<xrdb>. Many distribution do also load
474	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
475	will consult the following files/resources in order, with later settings
476	overwriting earlier ones:
477		541
478	1. system-wide app-defaults file, either locale-dependent OR global	542	1. system-wide app-defaults file, either locale-dependent OR global
479	2. app-defaults file in $XAPPLRESDIR	543	2. app-defaults file in $XAPPLRESDIR
480	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	544	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
481	4. SCREEN_RESOURCES for the current screen	545	4. SCREEN_RESOURCES for the current screen
482	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	546	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		547	6. resources specified via -xrm on the commandline
483		548
484	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
485	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
486	set in XAPPLOADDIR/URxvt (compile-time defined: usually
487	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
488	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
489	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	549	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
490	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows	550	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
491	resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be	551	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
492	easily configured, while the class name B<URxvt> allows resources	552	configured, while the class name B<URxvt> allows resources unique to
493	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	553	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
494	shared between different B<@@RXVT_NAME@@> configurations. If no	554	configurations. If no resources are specified, suitable defaults will
495	resources are specified, suitable defaults will be used. Command-line	555	be used. Command-line arguments can be used to override resource
496	arguments can be used to override resource settings. The following	556	settings. The following resources are supported (you might want to
497	resources are allowed:	557	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		558	extensions not documented here):
498		559
499	=over 4	560	=over 4
		561
		562	=item B<depth:> I<bitdepth>
		563
		564	Compile I<xft>: Attempt to find a visual with the given bit depth;
		565	option B<-depth>.
500		566
501	=item B<geometry:> I<geom>	567	=item B<geometry:> I<geom>
502		568
503	Create the window with the specified X window geometry [default 80x24];	569	Create the window with the specified X window geometry [default 80x24];
504	option B<-geometry>.	570	option B<-geometry>.
…		…
541	Use the specified colour to display underlined characters when the	607	Use the specified colour to display underlined characters when the
542	foreground colour is the default.	608	foreground colour is the default.
543		609
544	=item B<colorRV:> I<colour>	610	=item B<colorRV:> I<colour>
545		611
546	Use the specified colour as the background for reverse video	612	Use the specified colour as the background for reverse video characters
547	characters.	613	when OPTION_HC is disabled (--disable-frills).
548		614
549	=item B<underlineColor:> I<colour>	615	=item B<underlineColor:> I<colour>
550		616
551	If set, use the specified colour as the colour for the underline	617	If set, use the specified colour as the colour for the underline
552	itself. If unset, use the foreground colour.	618	itself. If unset, use the foreground colour.
…		…
568	option B<-rv>. B<False>: regular screen colours [default]; option	634	option B<-rv>. B<False>: regular screen colours [default]; option
569	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	635	B<+rv>. See note in B<COLORS AND GRAPHICS> section.
570		636
571	=item B<jumpScroll:> I<boolean>	637	=item B<jumpScroll:> I<boolean>
572		638
573	B<True>: specify that jump scrolling should be used. When scrolling	639	B<True>: specify that jump scrolling should be used. When receiving lots
574	quickly, fewer screen updates are performed [default]; option B<-j>.	640	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		641	has been read, resulting in fewer updates while still displaying every
		642	received line; option B<-j>.
		643
575	B<False>: specify that smooth scrolling should be used; option B<+j>.	644	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		645	force a screen refresh on each new line it received; option B<+j>.
576		646
577	=item B<inheritPixmap:> I<boolean>	647	=item B<skipScroll:> I<boolean>
578		648
579	B<True>: make the background inherit the parent windows' pixmap, giving	649	B<True>: (the default) specify that skip scrolling should be used. When
580	artificial transparency. B<False>: do not inherit the parent windows'	650	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
581	pixmap.	651	(around 60 times per second), resulting in far fewer updates. This can
		652	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		653	option B<-ss>.
		654
		655	B<False>: specify that everything is to be displayed, even
		656	if the refresh is too fast for the human eye to read anything (or the
		657	monitor to display anything); option B<+ss>.
		658
		659	=item B<transparent:> I<boolean>
		660
		661	Turn on/off illusion of a transparent window background.
		662
		663	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
		664	future versions.
		665
		666	I<Please address all transparency related issues to Sasha Vasko at
		667	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
582		668
583	=item B<fading:> I<number>	669	=item B<fading:> I<number>
584		670
585	Fade the text by the given percentage when focus is lost; option B<-fade>.	671	Fade the text by the given percentage when focus is lost; option B<-fade>.
586		672
…		…
594	Tint the transparent background pixmap with the given colour; option	680	Tint the transparent background pixmap with the given colour; option
595	B<-tint>.	681	B<-tint>.
596		682
597	=item B<shading:> I<number>	683	=item B<shading:> I<number>
598		684
599	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	685	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
600	image in addition to tinting it.	686	in addition to tinting it; option B<-sh>.
		687
		688	=item B<blendType:> I<string>
		689
		690	Specify background blending type; option B<-blt>.
		691
		692	=item B<blurRadius:> I<number>
		693
		694	Apply Gaussian Blurr with the specified radius to the transparent
		695	background image; option B<-blr>.
601		696
602	=item B<scrollColor:> I<colour>	697	=item B<scrollColor:> I<colour>
603		698
604	Use the specified colour for the scrollbar [default #B2B2B2].	699	Use the specified colour for the scrollbar [default #B2B2B2].
605		700
…		…
611	=item B<borderColor:> I<colour>	706	=item B<borderColor:> I<colour>
612		707
613	The colour of the border around the text area and between the scrollbar	708	The colour of the border around the text area and between the scrollbar
614	and the text.	709	and the text.
615		710
616	=item B<backgroundPixmap:> I<file[;geom]>	711	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
617		712
618	Use the specified XPM file (note the `.xpm' extension is optional) for	713	Use the specified image file for the background and also
619	the background and also optionally specify its scaling with a geometry	714	optionally specify its scaling with a geometry string B<WxH+X+Y>,
620	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	715	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
621	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	716	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
622	centre (percent). A scale of 0 displays the image with tiling. A scale	717	centre (percent). A scale of 0 displays the image with tiling. A scale
623	of 1 displays the image without any scaling. A scale of 2 to 9	718	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
624	specifies an integer number of images in that direction. No image will	719	an integer number of images in that direction. No image will be magnified
625	be magnified beyond 10 times its original size. The maximum permitted	720	beyond 10 times its original size. The maximum permitted scale is 1000.
626	scale is 1000. [default 0x0+50+50]	721	Additional operations can be specified after colon B<:op1:op2...>.
		722	Supported operations are:
627		723
628	=item B<menu:> I<file[;tag]>	724	tile force background image to be tiled and not scaled. Equivalent to 0x0,
		725	propscale will scale image keeping proportions,
		726	auto will scale image to match window size. Equivalent to 100x100;
		727	hscale will scale image horizontally to the window size;
		728	vscale will scale image vertically to the window size;
		729	scale will scale image to match window size;
		730	root will tile image as if it was a root window background, auto-adjusting
		731	whenever terminal window moves.
629		732
630	Read in the specified menu file (note the `.menu' extension is	733	If used in conjunction with B<-tr> option, the specified pixmap will be
631	optional) and also optionally specify a starting tag to find. See the	734	blended over transparency image using either alpha-blending, or any
632	reference documentation for details on the syntax for the menuBar.	735	other blending type, specified with B<-blt "type"> option.
633		736
634	=item B<path:> I<path>	737	=item B<path:> I<path>
635		738
636	Specify the colon-delimited search path for finding files (XPM and	739	Specify the colon-delimited search path for finding background image files.
637	menus), in addition to the paths specified by the B<RXVTPATH> and
638	B<PATH> environment variables.
639		740
640	=item B<font:> I<fontlist>	741	=item B<font:> I<fontlist>
641		742
642	Select the fonts to be used. This is a comma separated list of font	743	Select the fonts to be used. This is a comma separated list of font names
643	names that are used in turn when trying to display Unicode characters.	744	that are checked in order when trying to find glyphs for characters. The
644	The first font defines the cell size for characters; other fonts might	745	first font defines the cell size for characters; other fonts might be
645	be smaller, but not larger. A reasonable default font list is always	746	smaller, but not (in general) larger. A (hopefully) reasonable default
646	appended to it; option B<-fn>.	747	font list is always appended to it; option B<-fn>.
647		748
648	Each font can either be a standard X11 core font (XLFD) name, with	749	Each font can either be a standard X11 core font (XLFD) name, with
649	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.	750	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
650		751
651	In addition, each font can be prefixed with additional hints and	752	In addition, each font can be prefixed with additional hints and
…		…
653	hint currently is C<codeset=codeset-name>, and this is only used for Xft	754	hint currently is C<codeset=codeset-name>, and this is only used for Xft
654	fonts.	755	fonts.
655		756
656	For example, this font resource	757	For example, this font resource
657		758
658	URxvt*font: 9x15bold,\	759	URxvt.font: 9x15bold,\
659	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	760	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
660	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \	761	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
661	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	762	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
662	xft:Code2000:antialias=false	763	xft:Code2000:antialias=false
663		764
…		…
701		802
702	=item B<intensityStyles:> I<boolean>	803	=item B<intensityStyles:> I<boolean>
703		804
704	When font styles are not enabled, or this option is enabled (B<True>,	805	When font styles are not enabled, or this option is enabled (B<True>,
705	option B<-is>, the default), bold and italic font styles imply high	806	option B<-is>, the default), bold and italic font styles imply high
706	intensity foreground/backround colours. Disabling this option (B<False>,	807	intensity foreground/background colours. Disabling this option (B<False>,
707	option B<+is>) disables this behaviour, the high intensity colours are not	808	option B<+is>) disables this behaviour, the high intensity colours are not
708	reachable.	809	reachable.
709		810
710	=item B<selectstyle:> I<mode>	811	=item B<selectstyle:> I<mode>
711		812
712	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	813	Set mouse selection style to B<old> which is 2.20, B<oldword> which
713	xterm style with 2.20 old word selection, or anything else which gives	814	is xterm style with 2.20 old word selection, or anything else which
714	xterm style selection.	815	gives xterm style selection. Only effective when the original (non-perl)
		816	selection code is in use.
715		817
716	=item B<scrollstyle:> I<mode>	818	=item B<scrollstyle:> I<mode>
717		819
718	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	820	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
719	the author's favourite.	821	the author's favourite.
…		…
733	=item B<mapAlert:> I<boolean>	835	=item B<mapAlert:> I<boolean>
734		836
735	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	837	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
736	de-iconify (map) on receipt of a bell character [default].	838	de-iconify (map) on receipt of a bell character [default].
737		839
		840	=item B<urgentOnBell:> I<boolean>
		841
		842	B<True>: set the urgency hint for the wm on receipt of a bell character.
		843	B<False>: do not set the urgency hint [default].
		844
738	=item B<visualBell:> I<boolean>	845	=item B<visualBell:> I<boolean>
739		846
740	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	847	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
741	B<False>: no visual bell [default]; option B<+vb>.	848	B<False>: no visual bell [default]; option B<+vb>.
742		849
…		…
760		867
761	The string will be interpreted as if typed into the shell as-is.	868	The string will be interpreted as if typed into the shell as-is.
762		869
763	Example:	870	Example:
764		871
765	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	872	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
766		873
767	This creates a new file in your home directory with the screen contents	874	This creates a new file in your home directory with the screen contents
768	everytime you hit C<Print>.	875	every time you hit C<Print>.
769		876
770	=item B<scrollBar:> I<boolean>	877	=item B<scrollBar:> I<boolean>
771		878
772	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	879	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
773	disable the scrollbar; option B<+sb>.	880	disable the scrollbar; option B<+sb>.
…		…
795		902
796	=item B<scrollWithBuffer:> I<boolean>	903	=item B<scrollWithBuffer:> I<boolean>
797		904
798	B<True>: scroll with scrollback buffer when tty receives new lines (and	905	B<True>: scroll with scrollback buffer when tty receives new lines (and
799	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	906	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
800	with scrollback buffer when tty recieves new lines; option B<+sw>.	907	with scrollback buffer when tty receives new lines; option B<+sw>.
801		908
802	=item B<scrollTtyKeypress:> I<boolean>	909	=item B<scrollTtyKeypress:> I<boolean>
803		910
804	B<True>: scroll to bottom when a non-special key is pressed. Special keys	911	B<True>: scroll to bottom when a non-special key is pressed. Special keys
805	are those which are intercepted by rxvt-unicode for special handling and	912	are those which are intercepted by rxvt-unicode for special handling and
…		…
824	=item B<borderLess:> I<boolean>	931	=item B<borderLess:> I<boolean>
825		932
826	Set MWM hints to request a borderless window, i.e. if honoured by the	933	Set MWM hints to request a borderless window, i.e. if honoured by the
827	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.	934	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
828		935
		936	=item B<skipBuiltinGlyphs:> I<boolean>
		937
		938	Compile I<frills>: Disable the usage of the built-in block graphics/line
		939	drawing characters and just rely on what the specified fonts provide. Use
		940	this if you have a good font and want to use its block graphic glyphs;
		941	option B<-sbg>.
		942
829	=item B<termName:> I<termname>	943	=item B<termName:> I<termname>
830		944
831	Specifies the terminal type name to be set in the B<TERM> environment	945	Specifies the terminal type name to be set in the B<TERM> environment
832	variable; option B<-tn>.	946	variable; option B<-tn>.
833		947
834	=item B<linespace:> I<number>	948	=item B<lineSpace:> I<number>
835		949
836	Specifies number of lines (pixel height) to insert between each row of	950	Specifies number of lines (pixel height) to insert between each row of
837	the display [default 0]; option B<-lsp>.	951	the display [default 0]; option B<-lsp>.
838		952
839	=item B<meta8:> I<boolean>	953	=item B<meta8:> I<boolean>
…		…
888	pressed. If unset it will send the sequence traditionally associated	1002	pressed. If unset it will send the sequence traditionally associated
889	with the B<Execute> key.	1003	with the B<Execute> key.
890		1004
891	=item B<cutchars:> I<string>	1005	=item B<cutchars:> I<string>
892		1006
893	The characters used as delimiters for double-click word selection. The	1007	The characters used as delimiters for double-click word selection
894	built-in default:	1008	(whitespace delimiting is added automatically if resource is given).
895		1009
		1010	When the perl selection extension is in use (the default if compiled
		1011	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		1012	characters will be created (if the resource exists, otherwise, no regex
		1013	will be created). In this mode, characters outside ISO-8859-1 can be used.
		1014
		1015	When the selection extension is not used, only ISO-8859-1 characters can
		1016	be used. If not specified, the built-in default is used:
		1017
896	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1018	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
897		1019
898	=item B<preeditType:> I<style>	1020	=item B<preeditType:> I<style>
899		1021
900	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1022	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
901		1023
…		…
935	default. (Note that many other terminals, including xterm, have these	1057	default. (Note that many other terminals, including xterm, have these
936	sequences enabled by default, which doesn't make it safer, though).	1058	sequences enabled by default, which doesn't make it safer, though).
937		1059
938	You can enable them by setting this boolean resource or specifying	1060	You can enable them by setting this boolean resource or specifying
939	B<-insecure> as an option. At the moment, this enables display-answer,	1061	B<-insecure> as an option. At the moment, this enables display-answer,
940	locale, findfont, icon label and window title requests as well as dynamic	1062	locale, findfont, icon label and window title requests.
941	menubar dispatch.
942		1063
943	=item B<modifier:> I<modifier>	1064	=item B<modifier:> I<modifier>
944		1065
945	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	1066	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
946	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	1067	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
950		1071
951	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	1072	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
952	character is passed through. It may contain escape values as described	1073	character is passed through. It may contain escape values as described
953	in the entry on B<keysym> following.	1074	in the entry on B<keysym> following.
954		1075
955	=item B<secondaryScreen:> I<bool>	1076	=item B<secondaryScreen:> I<boolean>
956		1077
957	Turn on/off secondary screen (default enabled).	1078	Turn on/off secondary screen (default enabled).
958		1079
959	=item B<secondaryScroll:> I<bool>	1080	=item B<secondaryScroll:> I<boolean>
960		1081
961	Turn on/off secondary screen scroll (default enabled). If the this	1082	Turn on/off secondary screen scroll (default enabled). If this
962	option is enabled, scrolls on the secondary screen will change the	1083	option is enabled, scrolls on the secondary screen will change the
963	scrollback buffer and switching to/from the secondary screen will	1084	scrollback buffer and switching to/from the secondary screen will
964	instead scroll the screen up.	1085	instead scroll the screen up.
965		1086
966	=item B<hold>: I<bool>	1087	=item B<hold>: I<boolean>
967		1088
968	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1089	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
969	will not immediately destroy its window when the program executed within	1090	will not immediately destroy its window when the program executed within
970	it exits. Instead, it will wait till it is being killed or closed by the	1091	it exits. Instead, it will wait till it is being killed or closed by the
971	user.	1092	user.
…		…
990	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1111	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
991	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1112	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
992	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1113	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
993	performed in an exact manner; however, the closest match is assured.	1114	performed in an exact manner; however, the closest match is assured.
994		1115
995	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1116	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
996	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1117	number), see RESOURCES in C<man 7 X> for futher details.
997	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
998	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
999	can start or end with whitespace.
1000
1001	Please note that you need to double the C<\> when using
1002	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
1003	use C<\033> instead of C<\e> (and so on), which will work with both Xt and
1004	@@RXVT_NAME@@'s own processing).
1005		1118
1006	You can define a range of keysyms in one shot by providing a I<string>	1119	You can define a range of keysyms in one shot by providing a I<string>
1007	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1120	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1008	should be a character not used by the strings.	1121	should be a character not used by the strings.
1009		1122
1010	Its usage can be demonstrated by an example:	1123	Its usage can be demonstrated by an example:
1011		1124
1012	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1125	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
…		…
1021	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1134	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1022	example the following means "change the current locale to C<zh_CN.GBK>	1135	example the following means "change the current locale to C<zh_CN.GBK>
1023	when Control-Meta-c is being pressed":	1136	when Control-Meta-c is being pressed":
1024		1137
1025	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1138	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		1139
		1140	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1141	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1142	manpage. For example, the F<selection> extension (activated via
		1143	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1144
		1145	URxvt.keysym.M-C-c: perl:selection:rot13
1026		1146
1027	Due the the large number of modifier combinations, a defined key mapping	1147	Due the the large number of modifier combinations, a defined key mapping
1028	will match if at I<at least> the specified identifiers are being set, and	1148	will match if at I<at least> the specified identifiers are being set, and
1029	no other key mappings with those and more bits are being defined. That	1149	no other key mappings with those and more bits are being defined. That
1030	means that defining a key map for C<a> will automatically provide	1150	means that defining a key map for C<a> will automatically provide
…		…
1054	info):	1174	info):
1055		1175
1056	URxvt.keysym.M-C-3: command:\033[8;25;80t	1176	URxvt.keysym.M-C-3: command:\033[8;25;80t
1057	URxvt.keysym.M-C-4: command:\033[8;48;110t	1177	URxvt.keysym.M-C-4: command:\033[8;48;110t
1058		1178
		1179	=item B<perl-ext-common>: I<string>
		1180
1059	=item B<perl-ext>: I<string>	1181	=item B<perl-ext>: I<string>
1060		1182
1061	Colon-separated list of perl extension scripts to use in this terminal	1183	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1184	use in this terminal instance; option B<-pe>.
		1185
		1186	Extension names can be prefixed with a C<-> sign to prohibit using
		1187	them. This can be useful to selectively disable some extensions loaded
		1188	by default, or specified via the C<perl-ext-common> resource. For
		1189	example, C<default,-selection> will use all the default extension except
		1190	C<selection>.
		1191
		1192	Extension names can also be followed by an argument in angle brackets
		1193	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1194	searchable scrollback to Alt/Meta-s). Mentioning the same extension
		1195	multiple times with different arguments will pass multiple arguments to
		1196	the extension.
		1197
1062	instance. Each extension is looked up in the library directories, loaded	1198	Each extension is looked up in the library directories, loaded if
1063	if necessary, and bound to the current terminal instance; option B<-pe>.	1199	necessary, and bound to the current terminal instance.
		1200
		1201	If both of these resources are the empty string, then the perl
		1202	interpreter will not be initialized. The idea behind two options is that
		1203	B<perl-ext-common> will be used for extensions that should be available to
		1204	all instances, while B<perl-ext> is used for specific instances.
1064		1205
1065	=item B<perl-eval>: I<string>	1206	=item B<perl-eval>: I<string>
1066		1207
1067	Perl code to be evaluated when all extensions have been registered. See the	1208	Perl code to be evaluated when all extensions have been registered. See
1068	rxvtperl(3) manpage.	1209	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
		1210	will be ignored when running setuid/setgid.
1069		1211
1070	=item B<perl-lib>: I<path>	1212	=item B<perl-lib>: I<path>
1071		1213
1072	Colon-separated list of additional directories that hold extension	1214	Colon-separated list of additional directories that hold extension
1073	scripts. When looking for extensions specified by the C<perl> resource,	1215	scripts. When looking for extensions specified by the C<perl> resource,
1074	@@RXVT_NAME@@ will first look in these directories and then in	1216	@@RXVT_NAME@@ will first look in these directories and then in
1075	F<@@RXVT_LIBDIR@@/urxvt/perl-ext/>.	1217	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
		1218	will be ignored when running setuid/setgid.
1076		1219
1077	See the rxvtperl(3) manpage.	1220	See the @@RXVT_NAME@@perl(3) manpage.
		1221
		1222	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1223
		1224	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1225	details.
		1226
		1227	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1228
		1229	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1230	for details.
		1231
		1232	=item B<searchable-scrollback:> I<keysym>
		1233
		1234	Sets the hotkey that starts the incremental scrollback buffer search
		1235	(default: C<M-s>).
		1236
		1237	=item B<urlLauncher>: I<string>
		1238
		1239	Specifies the program to be started with a URL argument. Used by the
		1240	C<selection-popup> and C<matcher> perl extensions.
		1241
		1242	=item B<transient-for>: I<windowid>
		1243
		1244	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1245
		1246	=item B<override-redirect>: I<boolean>
		1247
		1248	Compile I<frills>: Sets override-redirect for the terminal window, making
		1249	it almost invisible to window managers; option B<-override-redirect>.
		1250
		1251	=item B<iso14755_52:> I<boolean>
		1252
		1253	Turn on/off ISO 14755 5.2 mode (default enabled).
1078		1254
1079	=back	1255	=back
1080		1256
1081	=head1 THE SCROLLBAR	1257	=head1 THE SCROLLBAR
1082		1258
…		…
1101	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1277	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1102	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1278	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1103	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1279	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1104	respectively.	1280	respectively.
1105		1281
1106	=head1 TEXT SELECTION AND INSERTION	1282	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1107		1283
1108	The behaviour of text selection and insertion mechanism is similar to	1284	The behaviour of text selection and insertion/pasting mechanism is similar
1109	I<xterm>(1).	1285	to I<xterm>(1).
1110		1286
1111	=over 4	1287	=over 4
1112		1288
1113	=item B<Selection>:	1289	=item B<Selecting>:
1114		1290
1115	Left click at the beginning of the region, drag to the end of the region	1291	Left click at the beginning of the region, drag to the end of the region
1116	and release; Right click to extend the marked region; Left double-click	1292	and release; Right click to extend the marked region; Left double-click
1117	to select a word; Left triple-click to select the entire logical line	1293	to select a word; Left triple-click to select the entire logical line
1118	(which can span multiple screen lines), unless modified by resource	1294	(which can span multiple screen lines), unless modified by resource
…		…
1122	(Compile: I<frills>) will create a rectangular selection instead of a	1298	(Compile: I<frills>) will create a rectangular selection instead of a
1123	normal one. In this mode, every selected row becomes its own line in the	1299	normal one. In this mode, every selected row becomes its own line in the
1124	selection, and trailing whitespace is visually underlined and removed from	1300	selection, and trailing whitespace is visually underlined and removed from
1125	the selection.	1301	the selection.
1126		1302
1127	=item B<Insertion>:	1303	=item B<Pasting>:
1128		1304
1129	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1305	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1130	an B<@@RXVT_NAME@@> window causes the current text selection to be	1306	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1131	inserted as if it had been typed on the keyboard.	1307	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1308
		1309	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1310	inserted too.
1132		1311
1133	=back	1312	=back
1134		1313
1135	=head1 CHANGING FONTS	1314	=head1 CHANGING FONTS
1136		1315
1137	Changing fonts (or font sizes, respectively) via the keypad is not yet	1316	Changing fonts (or font sizes, respectively) via the keypad is not yet
1138	supported in rxvt-unicode. Bug me if you need this.	1317	supported in rxvt-unicode. Bug me if you need this.
1139		1318
1140	You can, however, switch fonts at runtime using escape sequences (and	1319	You can, however, switch fonts at runtime using escape sequences, e.g.:
1141	therefore using the menubar), e.g.:
1142		1320
1143	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"	1321	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1322
		1323	You can use keyboard shortcuts, too:
		1324
		1325	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1326	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1144		1327
1145	rxvt-unicode will automatically re-apply these fonts to the output so far.	1328	rxvt-unicode will automatically re-apply these fonts to the output so far.
1146		1329
1147	=head1 ISO 14755 SUPPORT	1330	=head1 ISO 14755 SUPPORT
1148		1331
1149	ISO 14755 is a standard for entering and viewing unicode characters	1332	ISO 14755 is a standard for entering and viewing unicode characters
1150	and character codes using the keyboard. It consists of 4 parts. The	1333	and character codes using the keyboard. It consists of 4 parts. The
1151	first part is available rxvt-unicode has been compiled with	1334	first part is available if rxvt-unicode has been compiled with
1152	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1335	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1153	with C<--enable-iso14755>.	1336	with C<--enable-iso14755>.
1154		1337
1155	=over 4	1338	=over 4
1156		1339
…		…
1176	This mode lets you input characters representing the keycap symbols of	1359	This mode lets you input characters representing the keycap symbols of
1177	your keyboard, if representable in the current locale encoding.	1360	your keyboard, if representable in the current locale encoding.
1178		1361
1179	Start by pressing C<Control> and C<Shift> together, then releasing	1362	Start by pressing C<Control> and C<Shift> together, then releasing
1180	them. The next special key (cursor keys, home etc.) you enter will not	1363	them. The next special key (cursor keys, home etc.) you enter will not
1181	invoke it's usual function but instead will insert the corresponding	1364	invoke its usual function but instead will insert the corresponding
1182	keycap symbol. The symbol will only be entered when the key has been	1365	keycap symbol. The symbol will only be entered when the key has been
1183	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1366	released, otherwise pressing e.g. C<Shift> would enter the symbol for
1184	C<ISO Level 2 Switch>, although your intention might have been to enter a	1367	C<ISO Level 2 Switch>, although your intention might have been to enter a
1185	reverse tab (Shift-Tab).	1368	reverse tab (Shift-Tab).
1186		1369
…		…
1219	=head1 COLORS AND GRAPHICS	1402	=head1 COLORS AND GRAPHICS
1220		1403
1221	In addition to the default foreground and background colours,	1404	In addition to the default foreground and background colours,
1222	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1405	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1223	high-intensity bold/blink versions of the same). Here is a list of the	1406	high-intensity bold/blink versions of the same). Here is a list of the
1224	colours with their B<rgb.txt> names.	1407	colours with their names.
1225		1408
1226	=begin table	1409	=begin table
1227		1410
1228	B<color0> (black) = Black	1411	B<color0> (black) = Black
1229	B<color1> (red) = Red3	1412	B<color1> (red) = Red3
…		…
1249	It is also possible to specify the colour values of B<foreground>,	1432	It is also possible to specify the colour values of B<foreground>,
1250	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1433	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1251	a number 0-15, as a convenient shorthand to reference the colour name of	1434	a number 0-15, as a convenient shorthand to reference the colour name of
1252	color0-color15.	1435	color0-color15.
1253		1436
		1437	In addition to the colours defined above, @@RXVT_NAME@@ offers an
		1438	additional 72 colours. The first 64 of those (with indices 16 to 79)
		1439	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
		1440	16>), followed by 8 additional shades of gray (with indices 80 to 87).
		1441
		1442	Together, all those colours implement the 88 colour xterm colours. Only
		1443	the first 16 can be changed using resources currently, the rest can only
		1444	be changed via command sequences ("escape codes").
		1445
1254	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1446	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1255	always swapping the foreground/background colours. This is in contrast to	1447	always swapping the foreground/background colours. This is in contrast to
1256	I<xterm>(1) where the colours are only swapped if they have not otherwise	1448	I<xterm>(1) where the colours are only swapped if they have not otherwise
1257	been specified. For example,	1449	been specified. For example,
1258		1450
…		…
1263	would yield White on Black, while on I<xterm>(1) it would yield Black	1455	would yield White on Black, while on I<xterm>(1) it would yield Black
1264	on White.	1456	on White.
1265		1457
1266	=back	1458	=back
1267		1459
		1460	=head2 ALPHA CHANNEL SUPPORT
		1461
		1462	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1463	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
		1464	(recommended, but B<MUST> have 4 digits/component) colour specifications,
		1465	in addition to the ones provided by X, where the additional A component
		1466	specifies opacity (alpha) values. The minimum value of C<0> is completely
		1467	transparent). You can also prefix any color with C<[percent]>, where
		1468	C<percent> is a decimal percentage (0-100) that specifies the opacity of
		1469	the color, where C<0> is completely transparent and C<100> is completelxy
		1470	opaque.
		1471
		1472	You probably need to specify B<"-depth 32">, too, and have the luck that
		1473	your X-server uses ARGB pixel layout, as X is far from just supporting
		1474	ARGB visuals out of the box, and rxvt-unicode just fudges around.
		1475
		1476	For example, the following selects an almost completely transparent red
		1477	background, and an almost opaque pink foreground:
		1478
		1479	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
		1480
		1481	I<Please note that transparency of any kind if completely unsupported by
		1482	the author. Don't bug him with installation questions!>
		1483
1268	=head1 ENVIRONMENT	1484	=head1 ENVIRONMENT
1269		1485
1270	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1486	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1271		1487
1272	=over 4	1488	=over 4
1273		1489
1274	=item B<TERM>	1490	=item B<TERM>
1275		1491
1276	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1492	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1277	resources or on the commandline.	1493	resources or on the command line.
1278		1494
1279	=item B<COLORTERM>	1495	=item B<COLORTERM>
1280		1496
1281	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1497	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1282	compiled with XPM support, and optionally with the added extension	1498	compiled with background image support, and optionally with the added
1283	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1499	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1500	screen.
1284		1501
1285	=item B<COLORFGBG>	1502	=item B<COLORFGBG>
1286		1503
1287	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1504	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1288	the colour code used as default foreground/text colour (or the string	1505	the colour code used as default foreground/text colour (or the string
1289	C<default> to indicate that the default-colour escape sequence is to be	1506	C<default> to indicate that the default-colour escape sequence is to be
1290	used), C<bg> is the colour code used as default background colour (or the	1507	used), C<bg> is the colour code used as default background colour (or the
1291	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1508	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1292	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1509	was compiled with background image support. Libraries like C<ncurses>
1293	(and do) use this information to optimize screen output.	1510	and C<slang> can (and do) use this information to optimize screen output.
1294		1511
1295	=item B<WINDOWID>	1512	=item B<WINDOWID>
1296		1513
1297	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1514	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1298	window, which usually has subwindows for the scrollbar, the terminal	1515	window, which usually has subwindows for the scrollbar, the terminal
…		…
1304	C<--with-terminfo=PATH>.	1521	C<--with-terminfo=PATH>.
1305		1522
1306	=item B<DISPLAY>	1523	=item B<DISPLAY>
1307		1524
1308	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1525	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1309	display in it's child processes.	1526	display in its child processes.
1310		1527
1311	=item B<SHELL>	1528	=item B<SHELL>
1312		1529
1313	The shell to be used for command execution, defaults to C</bin/sh>.	1530	The shell to be used for command execution, defaults to C</bin/sh>.
1314
1315	=item B<RXVTPATH>
1316
1317	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1318	files.
1319
1320	=item B<PATH>
1321
1322	Used in the same way as C<RXVTPATH>.
1323		1531
1324	=item B<RXVT_SOCKET>	1532	=item B<RXVT_SOCKET>
1325		1533
1326	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1534	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1327	@@RXVT_NAME@@d(1).	1535	@@RXVT_NAME@@d(1).
…		…
1365		1573
1366	=item Project Coordinator	1574	=item Project Coordinator
1367		1575
1368	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1576	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1369		1577
1370	L<http://software.schmorp.de/#rxvt-unicode>	1578	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1371		1579
1372	=back	1580	=back
1373		1581
1374	=head1 AUTHORS	1582	=head1 AUTHORS
1375		1583
…		…
1397		1605
1398	Project Coordinator (changes.txt 2.21a to 2.4.5)	1606	Project Coordinator (changes.txt 2.21a to 2.4.5)
1399		1607
1400	=item Geoff Wing L<< <gcw@pobox.com> >>	1608	=item Geoff Wing L<< <gcw@pobox.com> >>
1401		1609
1402	Rewrote screen display and text selection routines. Project Coordinator	1610	Rewrote screen display and text selection routines.
		1611
1403	(changes.txt 2.4.6 - rxvt-unicode)	1612	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1404		1613
1405	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1614	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1406		1615
1407	Forked rxvt-unicode, rewrote most of the display code and internal	1616	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1408	character handling to store text in unicode, improve xterm	1617	extension, random hacks, numerous bugfixes and extensions.
1409	compatibility and apply numerous other bugfixes and extensions.
1410		1618
1411	Project Coordinator (Changes 1.0 -)	1619	Project Coordinator (Changes 1.0 -)
1412		1620
		1621	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1622
		1623	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
		1624
1413	=back	1625	=back
1414		1626

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.78 by root, Mon Jan 2 20:35:39 2006 UTC vs. Revision 1.148 by ayin, Sat Nov 24 17:07:46 2007 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.78 by root, Mon Jan 2 20:35:39 2006 UTC vs.
Revision 1.148 by ayin, Sat Nov 24 17:07:46 2007 UTC