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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.75 by root, Tue Dec 27 01:50:00 2005 UTC vs.
Revision 1.151 by root, Wed Dec 12 19:55:55 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 in 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.
		244
		245	=item B<-is>\|B<+is>
		246
		247	Compile I<font-styles>: Bold/Italic font styles imply high intensity
		248	foreground/background (default). See resource B<intensityStyles> for
		249	details.
206		250
207	=item B<-name> I<name>	251	=item B<-name> I<name>
208		252
209	Specify the application name under which resources are to be obtained,	253	Specify the application name under which resources are to be obtained,
210	rather than the default executable file name. Name should not contain	254	rather than the default executable file name. Name should not contain
…		…
290		334
291	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.
292	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
293	decorations; resource B<borderLess>.	337	decorations; resource B<borderLess>.
294		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
295	=item B<-lsp> I<number>	351	=item B<-lsp> I<number>
296		352
297	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
298	the display. Useful to work around font rendering problems; resource	354	the display. Useful to work around font rendering problems; resource
299	B<linespace>.	355	B<lineSpace>.
300		356
301	=item B<-tn> I<termname>	357	=item B<-tn> I<termname>
302		358
303	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
304	B<TERM> environment variable. This terminal type must exist in the	360	B<TERM> environment variable. This terminal type must exist in the
…		…
358	for more info.	414	for more info.
359		415
360	=item B<-tcw>	416	=item B<-tcw>
361		417
362	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
363	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 to
364	end of the logical line only. resource B<tripleclickwords>.	421	the end of the logical line only. resource B<tripleclickwords>.
365		422
366	=item B<-insecure>	423	=item B<-insecure>
367		424
368	Enable "insecure" mode, which currently enables most of the escape	425	Enable "insecure" mode, which currently enables most of the escape
369	sequences that echo strings. See the resource B<insecure> for more	426	sequences that echo strings. See the resource B<insecure> for more
…		…
390	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@@
391	will not immediately destroy its window when the program executed within	448	will not immediately destroy its window when the program executed within
392	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
393	user; resource B<hold>.	450	user; resource B<hold>.
394		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
395	=item B<-keysym.>I<sym> I<string>	465	=item B<-keysym.>I<sym> I<string>
396		466
397	Remap a key symbol. See resource B<keysym>.	467	Remap a key symbol. See resource B<keysym>.
398		468
399	=item B<-embed> I<windowid>	469	=item B<-embed> I<windowid>
400		470
401	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,
402	which enables applications to easily embed a terminal.	472	which enables applications to easily embed a terminal.
403		473
404	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
405	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
406	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
…		…
409	The window will not be destroyed when @@RXVT_NAME@@ exits.	479	The window will not be destroyed when @@RXVT_NAME@@ exits.
410		480
411	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
412	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
413	can use file descriptors to communicate with the programs within the	483	can use file descriptors to communicate with the programs within the
414	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
415	not.	485	not.
416		486
417	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
418	used (a longer example is in F<doc/embed>):	488	used (a longer example is in F<doc/embed>):
419		489
…		…
421	$rxvt->signal_connect_after (realize => sub {	491	$rxvt->signal_connect_after (realize => sub {
422	my $xid = $_[0]->window->get_xid;	492	my $xid = $_[0]->window->get_xid;
423	system "@@RXVT_NAME@@ -embed $xid &";	493	system "@@RXVT_NAME@@ -embed $xid &";
424	});	494	});
425		495
426	=item B<-pty-fd> I<fileno>	496	=item B<-pty-fd> I<file descriptor>
427		497
428	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
429	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
430	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
431	without having to run a program within it.	501	without having to run a program within it.
432		502
433	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
434	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
435	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, which is probably only useful in conjunction with some
		509	perl extension that manages the terminal.
436		510
437	Here is a example in perl that illustrates how this option can be used (a	511	Here is a example in perl that illustrates how this option can be used (a
438	longer example is in F<doc/pty-fd>):	512	longer example is in F<doc/pty-fd>):
439		513
440	use IO::Pty;	514	use IO::Pty;
…		…
447		521
448	# now communicate with rxvt	522	# now communicate with rxvt
449	my $slave = $pty->slave;	523	my $slave = $pty->slave;
450	while (<$slave>) { print $slave "got <$_>\n" }	524	while (<$slave>) { print $slave "got <$_>\n" }
451		525
		526	=item B<-pe> I<string>
		527
		528	Comma-separated list of perl extension scripts to use (or not to use) in
		529	this terminal instance. See resource B<perl-ext> for details.
		530
452	=back	531	=back
453		532
454	=head1 RESOURCES (available also as long-options)	533	=head1 RESOURCES
455		534
456	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	535	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
457	options) compiled into your version.	536	options) compiled into your version. All resources are also available as
		537	long-options.
458		538
459	There are two different methods that @@RXVT_NAME@@ can use to get the	539	You can set and change the resources using X11 tools like B<xrdb>. Many
460	Xresource data: using the X libraries (Xrm*-functions) or internal	540	distribution do also load settings from the B<~/.Xresources> file when X
461	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	541	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
462	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	542	with later settings overwriting earlier ones:
463	resources using X11 tools like B<xrdb>. Many distribution do also load
464	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
465	will consult the following files/resources in order, with later settings
466	overwriting earlier ones:
467		543
468	1. system-wide app-defaults file, either locale-dependent OR global	544	1. system-wide app-defaults file, either locale-dependent OR global
469	2. app-defaults file in $XAPPLRESDIR	545	2. app-defaults file in $XAPPLRESDIR
470	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	546	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
471	4. SCREEN_RESOURCES for the current screen	547	4. SCREEN_RESOURCES for the current screen
472	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	548	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		549	6. resources specified via -xrm on the commandline
473		550
474	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
475	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
476	set in XAPPLOADDIR/URxvt (compile-time defined: usually
477	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
478	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
479	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	551	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
480	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows	552	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
481	resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be	553	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
482	easily configured, while the class name B<URxvt> allows resources	554	configured, while the class name B<URxvt> allows resources unique to
483	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	555	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
484	shared between different B<@@RXVT_NAME@@> configurations. If no	556	configurations. If no resources are specified, suitable defaults will
485	resources are specified, suitable defaults will be used. Command-line	557	be used. Command-line arguments can be used to override resource
486	arguments can be used to override resource settings. The following	558	settings. The following resources are supported (you might want to
487	resources are allowed:	559	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		560	extensions not documented here):
488		561
489	=over 4	562	=over 4
		563
		564	=item B<depth:> I<bitdepth>
		565
		566	Compile I<xft>: Attempt to find a visual with the given bit depth;
		567	option B<-depth>.
490		568
491	=item B<geometry:> I<geom>	569	=item B<geometry:> I<geom>
492		570
493	Create the window with the specified X window geometry [default 80x24];	571	Create the window with the specified X window geometry [default 80x24];
494	option B<-geometry>.	572	option B<-geometry>.
…		…
531	Use the specified colour to display underlined characters when the	609	Use the specified colour to display underlined characters when the
532	foreground colour is the default.	610	foreground colour is the default.
533		611
534	=item B<colorRV:> I<colour>	612	=item B<colorRV:> I<colour>
535		613
536	Use the specified colour as the background for reverse video	614	Use the specified colour as the background for reverse video characters
537	characters.	615	when OPTION_HC is disabled (--disable-frills).
538		616
539	=item B<underlineColor:> I<colour>	617	=item B<underlineColor:> I<colour>
540		618
541	If set, use the specified colour as the colour for the underline	619	If set, use the specified colour as the colour for the underline
542	itself. If unset, use the foreground colour.	620	itself. If unset, use the foreground colour.
…		…
558	option B<-rv>. B<False>: regular screen colours [default]; option	636	option B<-rv>. B<False>: regular screen colours [default]; option
559	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	637	B<+rv>. See note in B<COLORS AND GRAPHICS> section.
560		638
561	=item B<jumpScroll:> I<boolean>	639	=item B<jumpScroll:> I<boolean>
562		640
563	B<True>: specify that jump scrolling should be used. When scrolling	641	B<True>: specify that jump scrolling should be used. When receiving lots
564	quickly, fewer screen updates are performed [default]; option B<-j>.	642	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		643	has been read, resulting in fewer updates while still displaying every
		644	received line; option B<-j>.
		645
565	B<False>: specify that smooth scrolling should be used; option B<+j>.	646	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		647	force a screen refresh on each new line it received; option B<+j>.
566		648
567	=item B<inheritPixmap:> I<boolean>	649	=item B<skipScroll:> I<boolean>
568		650
569	B<True>: make the background inherit the parent windows' pixmap, giving	651	B<True>: (the default) specify that skip scrolling should be used. When
570	artificial transparency. B<False>: do not inherit the parent windows'	652	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
571	pixmap.	653	(around 60 times per second), resulting in far fewer updates. This can
		654	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		655	option B<-ss>.
		656
		657	B<False>: specify that everything is to be displayed, even
		658	if the refresh is too fast for the human eye to read anything (or the
		659	monitor to display anything); option B<+ss>.
		660
		661	=item B<transparent:> I<boolean>
		662
		663	Turn on/off illusion of a transparent window background.
		664
		665	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
		666	future versions.
		667
		668	I<Please address all transparency related issues to Sasha Vasko at
		669	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
572		670
573	=item B<fading:> I<number>	671	=item B<fading:> I<number>
574		672
575	Fade the text by the given percentage when focus is lost; option B<-fade>.	673	Fade the text by the given percentage when focus is lost; option B<-fade>.
576		674
…		…
584	Tint the transparent background pixmap with the given colour; option	682	Tint the transparent background pixmap with the given colour; option
585	B<-tint>.	683	B<-tint>.
586		684
587	=item B<shading:> I<number>	685	=item B<shading:> I<number>
588		686
589	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	687	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
590	image in addition to tinting it.	688	in addition to tinting it; option B<-sh>.
		689
		690	=item B<blendType:> I<string>
		691
		692	Specify background blending type; option B<-blt>.
		693
		694	=item B<blurRadius:> I<number>
		695
		696	Apply Gaussian Blurr with the specified radius to the transparent
		697	background image; option B<-blr>.
591		698
592	=item B<scrollColor:> I<colour>	699	=item B<scrollColor:> I<colour>
593		700
594	Use the specified colour for the scrollbar [default #B2B2B2].	701	Use the specified colour for the scrollbar [default #B2B2B2].
595		702
…		…
601	=item B<borderColor:> I<colour>	708	=item B<borderColor:> I<colour>
602		709
603	The colour of the border around the text area and between the scrollbar	710	The colour of the border around the text area and between the scrollbar
604	and the text.	711	and the text.
605		712
606	=item B<backgroundPixmap:> I<file[;geom]>	713	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
607		714
608	Use the specified XPM file (note the `.xpm' extension is optional) for	715	Use the specified image file for the background and also
609	the background and also optionally specify its scaling with a geometry	716	optionally specify its scaling with a geometry string B<WxH+X+Y>,
610	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	717	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
611	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	718	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
612	centre (percent). A scale of 0 displays the image with tiling. A scale	719	centre (percent). A scale of 0 displays the image with tiling. A scale
613	of 1 displays the image without any scaling. A scale of 2 to 9	720	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
614	specifies an integer number of images in that direction. No image will	721	an integer number of images in that direction. No image will be magnified
615	be magnified beyond 10 times its original size. The maximum permitted	722	beyond 10 times its original size. The maximum permitted scale is 1000.
616	scale is 1000. [default 0x0+50+50]	723	Additional operations can be specified after colon B<:op1:op2...>.
		724	Supported operations are:
617		725
618	=item B<menu:> I<file[;tag]>	726	tile force background image to be tiled and not scaled. Equivalent to 0x0,
		727	propscale will scale image keeping proportions,
		728	auto will scale image to match window size. Equivalent to 100x100;
		729	hscale will scale image horizontally to the window size;
		730	vscale will scale image vertically to the window size;
		731	scale will scale image to match window size;
		732	root will tile image as if it was a root window background, auto-adjusting
		733	whenever terminal window moves.
619		734
620	Read in the specified menu file (note the `.menu' extension is	735	If used in conjunction with B<-tr> option, the specified pixmap will be
621	optional) and also optionally specify a starting tag to find. See the	736	blended over transparency image using either alpha-blending, or any
622	reference documentation for details on the syntax for the menuBar.	737	other blending type, specified with B<-blt "type"> option.
623		738
624	=item B<path:> I<path>	739	=item B<path:> I<path>
625		740
626	Specify the colon-delimited search path for finding files (XPM and	741	Specify the colon-delimited search path for finding background image files.
627	menus), in addition to the paths specified by the B<RXVTPATH> and
628	B<PATH> environment variables.
629		742
630	=item B<font:> I<fontlist>	743	=item B<font:> I<fontlist>
631		744
632	Select the fonts to be used. This is a comma separated list of font	745	Select the fonts to be used. This is a comma separated list of font names
633	names that are used in turn when trying to display Unicode characters.	746	that are checked in order when trying to find glyphs for characters. The
634	The first font defines the cell size for characters; other fonts might	747	first font defines the cell size for characters; other fonts might be
635	be smaller, but not larger. A reasonable default font list is always	748	smaller, but not (in general) larger. A (hopefully) reasonable default
636	appended to it. option B<-fn>.	749	font list is always appended to it; option B<-fn>.
637		750
638	Each font can either be a standard X11 core font (XLFD) name, with	751	Each font can either be a standard X11 core font (XLFD) name, with
639	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.	752	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
640		753
641	In addition, each font can be prefixed with additional hints and	754	In addition, each font can be prefixed with additional hints and
…		…
643	hint currently is C<codeset=codeset-name>, and this is only used for Xft	756	hint currently is C<codeset=codeset-name>, and this is only used for Xft
644	fonts.	757	fonts.
645		758
646	For example, this font resource	759	For example, this font resource
647		760
648	URxvt*font: 9x15bold,\	761	URxvt.font: 9x15bold,\
649	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	762	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
650	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \	763	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
651	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	764	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
652	xft:Code2000:antialias=false	765	xft:Code2000:antialias=false
653		766
…		…
687	not possible, replacement fonts of the desired shape will be tried.	800	not possible, replacement fonts of the desired shape will be tried.
688		801
689	If set, but empty, then this specific style is disabled and the normal	802	If set, but empty, then this specific style is disabled and the normal
690	text font will being used for the given style.	803	text font will being used for the given style.
691		804
		805	=item B<intensityStyles:> I<boolean>
		806
		807	When font styles are not enabled, or this option is enabled (B<True>,
		808	option B<-is>, the default), bold and italic font styles imply high
		809	intensity foreground/background colours. Disabling this option (B<False>,
		810	option B<+is>) disables this behaviour, the high intensity colours are not
		811	reachable.
		812
692	=item B<selectstyle:> I<mode>	813	=item B<selectstyle:> I<mode>
693		814
694	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	815	Set mouse selection style to B<old> which is 2.20, B<oldword> which
695	xterm style with 2.20 old word selection, or anything else which gives	816	is xterm style with 2.20 old word selection, or anything else which
696	xterm style selection.	817	gives xterm style selection. Only effective when the original (non-perl)
		818	selection code is in use.
697		819
698	=item B<scrollstyle:> I<mode>	820	=item B<scrollstyle:> I<mode>
699		821
700	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	822	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
701	the author's favourite.	823	the author's favourite.
…		…
715	=item B<mapAlert:> I<boolean>	837	=item B<mapAlert:> I<boolean>
716		838
717	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	839	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
718	de-iconify (map) on receipt of a bell character [default].	840	de-iconify (map) on receipt of a bell character [default].
719		841
		842	=item B<urgentOnBell:> I<boolean>
		843
		844	B<True>: set the urgency hint for the wm on receipt of a bell character.
		845	B<False>: do not set the urgency hint [default].
		846
720	=item B<visualBell:> I<boolean>	847	=item B<visualBell:> I<boolean>
721		848
722	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	849	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
723	B<False>: no visual bell [default]; option B<+vb>.	850	B<False>: no visual bell [default]; option B<+vb>.
724		851
…		…
742		869
743	The string will be interpreted as if typed into the shell as-is.	870	The string will be interpreted as if typed into the shell as-is.
744		871
745	Example:	872	Example:
746		873
747	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	874	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
748		875
749	This creates a new file in your home directory with the screen contents	876	This creates a new file in your home directory with the screen contents
750	everytime you hit C<Print>.	877	every time you hit C<Print>.
751		878
752	=item B<scrollBar:> I<boolean>	879	=item B<scrollBar:> I<boolean>
753		880
754	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	881	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
755	disable the scrollbar; option B<+sb>.	882	disable the scrollbar; option B<+sb>.
…		…
777		904
778	=item B<scrollWithBuffer:> I<boolean>	905	=item B<scrollWithBuffer:> I<boolean>
779		906
780	B<True>: scroll with scrollback buffer when tty receives new lines (and	907	B<True>: scroll with scrollback buffer when tty receives new lines (and
781	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	908	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
782	with scrollback buffer when tty recieves new lines; option B<+sw>.	909	with scrollback buffer when tty receives new lines; option B<+sw>.
783		910
784	=item B<scrollTtyKeypress:> I<boolean>	911	=item B<scrollTtyKeypress:> I<boolean>
785		912
786	B<True>: scroll to bottom when a non-special key is pressed. Special keys	913	B<True>: scroll to bottom when a non-special key is pressed. Special keys
787	are those which are intercepted by rxvt-unicode for special handling and	914	are those which are intercepted by rxvt-unicode for special handling and
…		…
806	=item B<borderLess:> I<boolean>	933	=item B<borderLess:> I<boolean>
807		934
808	Set MWM hints to request a borderless window, i.e. if honoured by the	935	Set MWM hints to request a borderless window, i.e. if honoured by the
809	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.	936	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
810		937
		938	=item B<skipBuiltinGlyphs:> I<boolean>
		939
		940	Compile I<frills>: Disable the usage of the built-in block graphics/line
		941	drawing characters and just rely on what the specified fonts provide. Use
		942	this if you have a good font and want to use its block graphic glyphs;
		943	option B<-sbg>.
		944
811	=item B<termName:> I<termname>	945	=item B<termName:> I<termname>
812		946
813	Specifies the terminal type name to be set in the B<TERM> environment	947	Specifies the terminal type name to be set in the B<TERM> environment
814	variable; option B<-tn>.	948	variable; option B<-tn>.
815		949
816	=item B<linespace:> I<number>	950	=item B<lineSpace:> I<number>
817		951
818	Specifies number of lines (pixel height) to insert between each row of	952	Specifies number of lines (pixel height) to insert between each row of
819	the display [default 0]; option B<-lsp>.	953	the display [default 0]; option B<-lsp>.
820		954
821	=item B<meta8:> I<boolean>	955	=item B<meta8:> I<boolean>
…		…
870	pressed. If unset it will send the sequence traditionally associated	1004	pressed. If unset it will send the sequence traditionally associated
871	with the B<Execute> key.	1005	with the B<Execute> key.
872		1006
873	=item B<cutchars:> I<string>	1007	=item B<cutchars:> I<string>
874		1008
875	The characters used as delimiters for double-click word selection. The	1009	The characters used as delimiters for double-click word selection
876	built-in default:	1010	(whitespace delimiting is added automatically if resource is given).
877		1011
		1012	When the perl selection extension is in use (the default if compiled
		1013	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		1014	characters will be created (if the resource exists, otherwise, no regex
		1015	will be created). In this mode, characters outside ISO-8859-1 can be used.
		1016
		1017	When the selection extension is not used, only ISO-8859-1 characters can
		1018	be used. If not specified, the built-in default is used:
		1019
878	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1020	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
879		1021
880	=item B<preeditType:> I<style>	1022	=item B<preeditType:> I<style>
881		1023
882	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1024	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
883		1025
…		…
888	=item B<imLocale:> I<name>	1030	=item B<imLocale:> I<name>
889		1031
890	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.	1032	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
891	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the	1033	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
892	input extension to be able to input japanese characters while staying in	1034	input extension to be able to input japanese characters while staying in
893	another locale. option B<-imlocale>.	1035	another locale; option B<-imlocale>.
894		1036
895	=item B<imFont:> I<fontset>	1037	=item B<imFont:> I<fontset>
896		1038
897	Specify the font-set used for XIM styles C<OverTheSpot> or	1039	Specify the font-set used for XIM styles C<OverTheSpot> or
898	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated	1040	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
…		…
903		1045
904	=item B<tripleclickwords:> I<boolean>	1046	=item B<tripleclickwords:> I<boolean>
905		1047
906	Change the meaning of triple-click selection with the left mouse	1048	Change the meaning of triple-click selection with the left mouse
907	button. Instead of selecting a full line it will extend the selection to	1049	button. Instead of selecting a full line it will extend the selection to
908	the end of the logical line only. option B<-tcw>.	1050	the end of the logical line only; option B<-tcw>.
909		1051
910	=item B<insecure:> I<boolean>	1052	=item B<insecure:> I<boolean>
911		1053
912	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	1054	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
913	echo arbitrary strings like the icon name or the locale. This could be	1055	echo arbitrary strings like the icon name or the locale. This could be
…		…
917	default. (Note that many other terminals, including xterm, have these	1059	default. (Note that many other terminals, including xterm, have these
918	sequences enabled by default, which doesn't make it safer, though).	1060	sequences enabled by default, which doesn't make it safer, though).
919		1061
920	You can enable them by setting this boolean resource or specifying	1062	You can enable them by setting this boolean resource or specifying
921	B<-insecure> as an option. At the moment, this enables display-answer,	1063	B<-insecure> as an option. At the moment, this enables display-answer,
922	locale, findfont, icon label and window title requests as well as dynamic	1064	locale, findfont, icon label and window title requests.
923	menubar dispatch.
924		1065
925	=item B<modifier:> I<modifier>	1066	=item B<modifier:> I<modifier>
926		1067
927	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	1068	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
928	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	1069	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
932		1073
933	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	1074	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
934	character is passed through. It may contain escape values as described	1075	character is passed through. It may contain escape values as described
935	in the entry on B<keysym> following.	1076	in the entry on B<keysym> following.
936		1077
937	=item B<secondaryScreen:> I<bool>	1078	=item B<secondaryScreen:> I<boolean>
938		1079
939	Turn on/off secondary screen (default enabled).	1080	Turn on/off secondary screen (default enabled).
940		1081
941	=item B<secondaryScroll:> I<bool>	1082	=item B<secondaryScroll:> I<boolean>
942		1083
943	Turn on/off secondary screen scroll (default enabled). If the this	1084	Turn on/off secondary screen scroll (default enabled). If this
944	option is enabled, scrolls on the secondary screen will change the	1085	option is enabled, scrolls on the secondary screen will change the
945	scrollback buffer and switching to/from the secondary screen will	1086	scrollback buffer and switching to/from the secondary screen will
946	instead scroll the screen up.	1087	instead scroll the screen up.
947		1088
948	=item B<hold>: I<bool>	1089	=item B<hold>: I<boolean>
949		1090
950	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1091	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
951	will not immediately destroy its window when the program executed within	1092	will not immediately destroy its window when the program executed within
952	it exits. Instead, it will wait till it is being killed or closed by the	1093	it exits. Instead, it will wait till it is being killed or closed by the
953	user.	1094	user.
…		…
972	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1113	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
973	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1114	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
974	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1115	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
975	performed in an exact manner; however, the closest match is assured.	1116	performed in an exact manner; however, the closest match is assured.
976		1117
977	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1118	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
978	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1119	number), see RESOURCES in C<man 7 X> for futher details.
979	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
980	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
981	can start or end with whitespace.
982
983	Please note that you need to double the C<\> when using
984	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
985	use C<\033> instead of C<\e> (and so on), which will work with both Xt and
986	@@RXVT_NAME@@'s own processing).
987		1120
988	You can define a range of keysyms in one shot by providing a I<string>	1121	You can define a range of keysyms in one shot by providing a I<string>
989	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1122	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
990	should be a character not used by the strings.	1123	should be a character not used by the strings.
991		1124
992	Its usage can be demonstrated by an example:	1125	Its usage can be demonstrated by an example:
993		1126
994	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1127	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
…		…
1003	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1136	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1004	example the following means "change the current locale to C<zh_CN.GBK>	1137	example the following means "change the current locale to C<zh_CN.GBK>
1005	when Control-Meta-c is being pressed":	1138	when Control-Meta-c is being pressed":
1006		1139
1007	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1140	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		1141
		1142	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1143	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1144	manpage. For example, the F<selection> extension (activated via
		1145	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1146
		1147	URxvt.keysym.M-C-c: perl:selection:rot13
1008		1148
1009	Due the the large number of modifier combinations, a defined key mapping	1149	Due the the large number of modifier combinations, a defined key mapping
1010	will match if at I<at least> the specified identifiers are being set, and	1150	will match if at I<at least> the specified identifiers are being set, and
1011	no other key mappings with those and more bits are being defined. That	1151	no other key mappings with those and more bits are being defined. That
1012	means that defining a key map for C<a> will automatically provide	1152	means that defining a key map for C<a> will automatically provide
…		…
1036	info):	1176	info):
1037		1177
1038	URxvt.keysym.M-C-3: command:\033[8;25;80t	1178	URxvt.keysym.M-C-3: command:\033[8;25;80t
1039	URxvt.keysym.M-C-4: command:\033[8;48;110t	1179	URxvt.keysym.M-C-4: command:\033[8;48;110t
1040		1180
		1181	=item B<perl-ext-common>: I<string>
		1182
		1183	=item B<perl-ext>: I<string>
		1184
		1185	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1186	use in this terminal instance; option B<-pe>.
		1187
		1188	Extension names can be prefixed with a C<-> sign to prohibit using
		1189	them. This can be useful to selectively disable some extensions loaded
		1190	by default, or specified via the C<perl-ext-common> resource. For
		1191	example, C<default,-selection> will use all the default extension except
		1192	C<selection>.
		1193
		1194	Extension names can also be followed by an argument in angle brackets
		1195	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1196	searchable scrollback to Alt/Meta-s). Mentioning the same extension
		1197	multiple times with different arguments will pass multiple arguments to
		1198	the extension.
		1199
		1200	Each extension is looked up in the library directories, loaded if
		1201	necessary, and bound to the current terminal instance.
		1202
		1203	If both of these resources are the empty string, then the perl
		1204	interpreter will not be initialized. The idea behind two options is that
		1205	B<perl-ext-common> will be used for extensions that should be available to
		1206	all instances, while B<perl-ext> is used for specific instances.
		1207
		1208	=item B<perl-eval>: I<string>
		1209
		1210	Perl code to be evaluated when all extensions have been registered. See
		1211	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
		1212	will be ignored when running setuid/setgid.
		1213
		1214	=item B<perl-lib>: I<path>
		1215
		1216	Colon-separated list of additional directories that hold extension
		1217	scripts. When looking for extensions specified by the C<perl> resource,
		1218	@@RXVT_NAME@@ will first look in these directories and then in
		1219	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
		1220	will be ignored when running setuid/setgid.
		1221
		1222	See the @@RXVT_NAME@@perl(3) manpage.
		1223
		1224	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1225
		1226	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1227	details.
		1228
		1229	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1230
		1231	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1232	for details.
		1233
		1234	=item B<searchable-scrollback:> I<keysym>
		1235
		1236	Sets the hotkey that starts the incremental scrollback buffer search
		1237	(default: C<M-s>).
		1238
		1239	=item B<urlLauncher>: I<string>
		1240
		1241	Specifies the program to be started with a URL argument. Used by the
		1242	C<selection-popup> and C<matcher> perl extensions.
		1243
		1244	=item B<transient-for>: I<windowid>
		1245
		1246	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1247
		1248	=item B<override-redirect>: I<boolean>
		1249
		1250	Compile I<frills>: Sets override-redirect for the terminal window, making
		1251	it almost invisible to window managers; option B<-override-redirect>.
		1252
		1253	=item B<iso14755_52:> I<boolean>
		1254
		1255	Turn on/off ISO 14755 5.2 mode (default enabled).
		1256
1041	=back	1257	=back
1042		1258
1043	=head1 THE SCROLLBAR	1259	=head1 THE SCROLLBAR
1044		1260
1045	Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window	1261	Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
…		…
1063	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1279	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1064	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1280	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1065	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1281	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1066	respectively.	1282	respectively.
1067		1283
1068	=head1 TEXT SELECTION AND INSERTION	1284	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1069		1285
1070	The behaviour of text selection and insertion mechanism is similar to	1286	The behaviour of text selection and insertion/pasting mechanism is similar
1071	I<xterm>(1).	1287	to I<xterm>(1).
1072		1288
1073	=over 4	1289	=over 4
1074		1290
1075	=item B<Selection>:	1291	=item B<Selecting>:
1076		1292
1077	Left click at the beginning of the region, drag to the end of the region	1293	Left click at the beginning of the region, drag to the end of the region
1078	and release; Right click to extend the marked region; Left double-click	1294	and release; Right click to extend the marked region; Left double-click
1079	to select a word; Left triple-click to select the entire logical line	1295	to select a word; Left triple-click to select the entire logical line
1080	(which can span multiple screen lines), unless modified by resource	1296	(which can span multiple screen lines), unless modified by resource
…		…
1084	(Compile: I<frills>) will create a rectangular selection instead of a	1300	(Compile: I<frills>) will create a rectangular selection instead of a
1085	normal one. In this mode, every selected row becomes its own line in the	1301	normal one. In this mode, every selected row becomes its own line in the
1086	selection, and trailing whitespace is visually underlined and removed from	1302	selection, and trailing whitespace is visually underlined and removed from
1087	the selection.	1303	the selection.
1088		1304
1089	=item B<Insertion>:	1305	=item B<Pasting>:
1090		1306
1091	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1307	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1092	an B<@@RXVT_NAME@@> window causes the current text selection to be	1308	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1093	inserted as if it had been typed on the keyboard.	1309	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1310
		1311	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1312	inserted too.
1094		1313
1095	=back	1314	=back
1096		1315
1097	=head1 CHANGING FONTS	1316	=head1 CHANGING FONTS
1098		1317
1099	Changing fonts (or font sizes, respectively) via the keypad is not yet	1318	Changing fonts (or font sizes, respectively) via the keypad is not yet
1100	supported in rxvt-unicode. Bug me if you need this.	1319	supported in rxvt-unicode. Bug me if you need this.
1101		1320
1102	You can, however, switch fonts at runtime using escape sequences (and	1321	You can, however, switch fonts at runtime using escape sequences, e.g.:
1103	therefore using the menubar), e.g.:
1104		1322
1105	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"	1323	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1324
		1325	You can use keyboard shortcuts, too:
		1326
		1327	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1328	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1106		1329
1107	rxvt-unicode will automatically re-apply these fonts to the output so far.	1330	rxvt-unicode will automatically re-apply these fonts to the output so far.
1108		1331
1109	=head1 ISO 14755 SUPPORT	1332	=head1 ISO 14755 SUPPORT
1110		1333
1111	ISO 14755 is a standard for entering and viewing unicode characters	1334	ISO 14755 is a standard for entering and viewing unicode characters
1112	and character codes using the keyboard. It consists of 4 parts. The	1335	and character codes using the keyboard. It consists of 4 parts. The
1113	first part is available rxvt-unicode has been compiled with	1336	first part is available if rxvt-unicode has been compiled with
1114	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1337	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1115	with C<--enable-iso14755>.	1338	with C<--enable-iso14755>.
1116		1339
1117	=over 4	1340	=over 4
1118		1341
…		…
1138	This mode lets you input characters representing the keycap symbols of	1361	This mode lets you input characters representing the keycap symbols of
1139	your keyboard, if representable in the current locale encoding.	1362	your keyboard, if representable in the current locale encoding.
1140		1363
1141	Start by pressing C<Control> and C<Shift> together, then releasing	1364	Start by pressing C<Control> and C<Shift> together, then releasing
1142	them. The next special key (cursor keys, home etc.) you enter will not	1365	them. The next special key (cursor keys, home etc.) you enter will not
1143	invoke it's usual function but instead will insert the corresponding	1366	invoke its usual function but instead will insert the corresponding
1144	keycap symbol. The symbol will only be entered when the key has been	1367	keycap symbol. The symbol will only be entered when the key has been
1145	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1368	released, otherwise pressing e.g. C<Shift> would enter the symbol for
1146	C<ISO Level 2 Switch>, although your intention might have been to enter a	1369	C<ISO Level 2 Switch>, although your intention might have been to enter a
1147	reverse tab (Shift-Tab).	1370	reverse tab (Shift-Tab).
1148		1371
…		…
1181	=head1 COLORS AND GRAPHICS	1404	=head1 COLORS AND GRAPHICS
1182		1405
1183	In addition to the default foreground and background colours,	1406	In addition to the default foreground and background colours,
1184	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1407	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1185	high-intensity bold/blink versions of the same). Here is a list of the	1408	high-intensity bold/blink versions of the same). Here is a list of the
1186	colours with their B<rgb.txt> names.	1409	colours with their names.
1187		1410
1188	=begin table	1411	=begin table
1189		1412
1190	B<color0> (black) = Black	1413	B<color0> (black) = Black
1191	B<color1> (red) = Red3	1414	B<color1> (red) = Red3
…		…
1211	It is also possible to specify the colour values of B<foreground>,	1434	It is also possible to specify the colour values of B<foreground>,
1212	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1435	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1213	a number 0-15, as a convenient shorthand to reference the colour name of	1436	a number 0-15, as a convenient shorthand to reference the colour name of
1214	color0-color15.	1437	color0-color15.
1215		1438
		1439	In addition to the colours defined above, @@RXVT_NAME@@ offers an
		1440	additional 72 colours. The first 64 of those (with indices 16 to 79)
		1441	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
		1442	16>), followed by 8 additional shades of gray (with indices 80 to 87).
		1443
		1444	Together, all those colours implement the 88 colour xterm colours. Only
		1445	the first 16 can be changed using resources currently, the rest can only
		1446	be changed via command sequences ("escape codes").
		1447
1216	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1448	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1217	always swapping the foreground/background colours. This is in contrast to	1449	always swapping the foreground/background colours. This is in contrast to
1218	I<xterm>(1) where the colours are only swapped if they have not otherwise	1450	I<xterm>(1) where the colours are only swapped if they have not otherwise
1219	been specified. For example,	1451	been specified. For example,
1220		1452
…		…
1225	would yield White on Black, while on I<xterm>(1) it would yield Black	1457	would yield White on Black, while on I<xterm>(1) it would yield Black
1226	on White.	1458	on White.
1227		1459
1228	=back	1460	=back
1229		1461
		1462	=head2 ALPHA CHANNEL SUPPORT
		1463
		1464	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1465	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
		1466	(recommended, but B<MUST> have 4 digits/component) colour specifications,
		1467	in addition to the ones provided by X, where the additional A component
		1468	specifies opacity (alpha) values. The minimum value of C<0> is completely
		1469	transparent). You can also prefix any color with C<[percent]>, where
		1470	C<percent> is a decimal percentage (0-100) that specifies the opacity of
		1471	the color, where C<0> is completely transparent and C<100> is completelxy
		1472	opaque.
		1473
		1474	You probably need to specify B<"-depth 32">, too, and have the luck that
		1475	your X-server uses ARGB pixel layout, as X is far from just supporting
		1476	ARGB visuals out of the box, and rxvt-unicode just fudges around.
		1477
		1478	For example, the following selects an almost completely transparent red
		1479	background, and an almost opaque pink foreground:
		1480
		1481	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
		1482
		1483	I<Please note that transparency of any kind if completely unsupported by
		1484	the author. Don't bug him with installation questions!>
		1485
1230	=head1 ENVIRONMENT	1486	=head1 ENVIRONMENT
1231		1487
1232	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1488	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1233		1489
1234	=over 4	1490	=over 4
1235		1491
1236	=item B<TERM>	1492	=item B<TERM>
1237		1493
1238	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1494	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1239	resources or on the commandline.	1495	resources or on the command line.
1240		1496
1241	=item B<COLORTERM>	1497	=item B<COLORTERM>
1242		1498
1243	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1499	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1244	compiled with XPM support, and optionally with the added extension	1500	compiled with background image support, and optionally with the added
1245	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1501	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1502	screen.
1246		1503
1247	=item B<COLORFGBG>	1504	=item B<COLORFGBG>
1248		1505
1249	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1506	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1250	the colour code used as default foreground/text colour (or the string	1507	the colour code used as default foreground/text colour (or the string
1251	C<default> to indicate that the default-colour escape sequence is to be	1508	C<default> to indicate that the default-colour escape sequence is to be
1252	used), C<bg> is the colour code used as default background colour (or the	1509	used), C<bg> is the colour code used as default background colour (or the
1253	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1510	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1254	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1511	was compiled with background image support. Libraries like C<ncurses>
1255	(and do) use this information to optimize screen output.	1512	and C<slang> can (and do) use this information to optimize screen output.
1256		1513
1257	=item B<WINDOWID>	1514	=item B<WINDOWID>
1258		1515
1259	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1516	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1260	window, which usually has subwindows for the scrollbar, the terminal	1517	window, which usually has subwindows for the scrollbar, the terminal
…		…
1266	C<--with-terminfo=PATH>.	1523	C<--with-terminfo=PATH>.
1267		1524
1268	=item B<DISPLAY>	1525	=item B<DISPLAY>
1269		1526
1270	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1527	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1271	display in it's child processes.	1528	display in its child processes.
1272		1529
1273	=item B<SHELL>	1530	=item B<SHELL>
1274		1531
1275	The shell to be used for command execution, defaults to C</bin/sh>.	1532	The shell to be used for command execution, defaults to C</bin/sh>.
1276
1277	=item B<RXVTPATH>
1278
1279	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1280	files.
1281
1282	=item B<PATH>
1283
1284	Used in the same way as C<RXVTPATH>.
1285		1533
1286	=item B<RXVT_SOCKET>	1534	=item B<RXVT_SOCKET>
1287		1535
1288	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1536	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1289	@@RXVT_NAME@@d(1).	1537	@@RXVT_NAME@@d(1).
…		…
1327		1575
1328	=item Project Coordinator	1576	=item Project Coordinator
1329		1577
1330	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1578	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1331		1579
1332	L<http://software.schmorp.de/#rxvt-unicode>	1580	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1333		1581
1334	=back	1582	=back
1335		1583
1336	=head1 AUTHORS	1584	=head1 AUTHORS
1337		1585
…		…
1359		1607
1360	Project Coordinator (changes.txt 2.21a to 2.4.5)	1608	Project Coordinator (changes.txt 2.21a to 2.4.5)
1361		1609
1362	=item Geoff Wing L<< <gcw@pobox.com> >>	1610	=item Geoff Wing L<< <gcw@pobox.com> >>
1363		1611
1364	Rewrote screen display and text selection routines. Project Coordinator	1612	Rewrote screen display and text selection routines.
		1613
1365	(changes.txt 2.4.6 - rxvt-unicode)	1614	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1366		1615
1367	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1616	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1368		1617
1369	Forked rxvt-unicode, rewrote most of the display code and internal	1618	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1370	character handling to store text in unicode, improve xterm	1619	extension, random hacks, numerous bugfixes and extensions.
1371	compatibility and apply numerous other bugfixes and extensions.
1372		1620
1373	Project Coordinator (Changes 1.0 -)	1621	Project Coordinator (Changes 1.0 -)
1374		1622
		1623	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1624
		1625	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
		1626
1375	=back	1627	=back
1376		1628

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.75 by root, Tue Dec 27 01:50:00 2005 UTC vs. Revision 1.151 by root, Wed Dec 12 19:55:55 2007 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.75 by root, Tue Dec 27 01:50:00 2005 UTC vs.
Revision 1.151 by root, Wed Dec 12 19:55:55 2007 UTC