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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.117 by root, Fri Jul 28 09:14:10 2006 UTC vs.
Revision 1.214 by sf-exg, Sun May 13 21:34:29 2012 UTC

…		…
12	emulator intended as an I<xterm>(1) replacement for users who do not	12	emulator intended as an I<xterm>(1) replacement for users who do not
13	require features such as Tektronix 4014 emulation and toolkit-style	13	require features such as Tektronix 4014 emulation and toolkit-style
14	configurability. As a result, B<rxvt-unicode> uses much less swap space --	14	configurability. As a result, B<rxvt-unicode> uses much less swap space --
15	a significant advantage on a machine serving many X sessions.	15	a significant advantage on a machine serving many X sessions.
16		16
		17	This document is also available on the World-Wide-Web at
		18	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
		19
17	=head1 FREQUENTLY ASKED QUESTIONS	20	=head1 FREQUENTLY ASKED QUESTIONS
18		21
19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of	22	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	23	frequently asked questions and answer to them and some common
21	problems. That document is also accessible on the World-Wide-Web at	24	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>.	25	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23		26
24	=head1 RXVT-UNICODE VS. RXVT	27	=head1 RXVT-UNICODE VS. RXVT
25		28
26	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode	29	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	30	internally. That means it can store and display most scripts in the
28	world. Being a terminal emulator, however, some things are very difficult,	31	world. Being a terminal emulator, however, some things are very difficult,
29	especially cursive scripts such as arabic, vertically written scripts	32	especially cursive scripts such as arabic, vertically written scripts
30	like mongolian or scripts requiring extremely complex combining rules,	33	like mongolian or scripts requiring extremely complex combining rules,
31	like tibetan or devenagari. Don't expect pretty output when using these	34	like tibetan or devanagari. Don't expect pretty output when using these
32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	35	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33	fine, though. A somewhat difficult case are right-to-left scripts, such	36	fine, though. A somewhat difficult case are right-to-left scripts, such
34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	37	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35	belong into the application, not the terminal emulator (too many things --	38	belong in the application, not the terminal emulator (too many things --
36	such as cursor-movement while editing -- break otherwise), but that might	39	such as cursor-movement while editing -- break otherwise), but that might
37	change.	40	change.
38		41
39	If you are looking for a terminal that supports more exotic scripts, let	42	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	43	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	44	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	45	because the author couldn't get C<mlterm> to use one font for latin1 and
43	another for japanese.	46	another for japanese.
44		47
45	Therefore another design rationale was the use of multiple fonts to	48	Therefore another design rationale was the use of multiple fonts to
…		…
89		92
90	Print out a message describing available options.	93	Print out a message describing available options.
91		94
92	=item B<-display> I<displayname>	95	=item B<-display> I<displayname>
93		96
94	Attempt to open a window on the named X display (B<-d> still	97	Attempt to open a window on the named X display (the older form B<-d>
95	respected). In the absence of this option, the display specified by the	98	is still respected. but deprecated). In the absence of this option, the
96	B<DISPLAY> environment variable is used.	99	display specified by the B<DISPLAY> environment variable is used.
97		100
98	=item B<-depth> I<bitdepth>	101	=item B<-depth> I<bitdepth>
99		102
100	Compile I<xft>: Attempt to find a visual with the given bit depth;	103	Compile I<xft>: Attempt to find a visual with the given bit depth;
101	resource B<depth>.	104	resource B<depth>.
102		105
		106	[Please note that many X servers (and libXft) are buggy with
		107	respect to C<-depth 32> and/or alpha channels, and will cause all sorts
		108	of graphical corruption. This is harmless, but we can't do anything about
		109	this, so watch out]
		110
103	=item B<-geometry> I<geom>	111	=item B<-geometry> I<geom>
104		112
105	Window geometry (B<-g> still respected); resource B<geometry>.	113	Window geometry (B<-g> still respected); resource B<geometry>.
106		114
107	=item B<-rv>\|B<+rv>	115	=item B<-rv>\|B<+rv>
108		116
109	Turn on/off simulated reverse video; resource B<reverseVideo>.	117	Turn on/off simulated reverse video; resource B<reverseVideo>.
110		118
111	=item B<-j>\|B<+j>	119	=item B<-j>\|B<+j>
112		120
113	Turn on/off jump scrolling; resource B<jumpScroll>.	121	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
114		122
115	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>	123	=item B<-ss>\|B<+ss>
116		124
117	Turn on/off inheriting parent window's pixmap. Alternative form is	125	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118	B<-tr>; resource B<inheritPixmap>.
119		126
120	I<Please note that transparency of any kind if completely unsupported by	127	=item B<-tr>\|B<+tr>
121	the author. Don't bug him with installation questions! Read the FAQ (man 7	128
122	@@RXVT_NAME@@)!>	129	Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>.
		130
		131	B<-ip> is still accepted as an obsolete alias but will be removed in
		132	future versions.
123		133
124	=item B<-fade> I<number>	134	=item B<-fade> I<number>
125		135
126	Fade the text by the given percentage when focus is lost. Small values	136	Fade the text by the given percentage when focus is lost. Small values
127	fade a little only, 100 completely replaces all colours by the fade	137	fade a little only, 100 completely replaces all colours by the fade
…		…
132	Fade to this colour when fading is used (see B<-fade>). The default colour	142	Fade to this colour when fading is used (see B<-fade>). The default colour
133	is opaque black. resource B<fadeColor>.	143	is opaque black. resource B<fadeColor>.
134		144
135	=item B<-tint> I<colour>	145	=item B<-tint> I<colour>
136		146
137	Tint the transparent background pixmap with the given colour when	147	Tint the transparent background with the given colour;
138	transparency is enabled with B<-tr> or B<-ip>. This only works for	148	resource I<tintColor>.
139	non-tiled backgrounds, currently. See also the B<-sh> option that can be
140	used to brighten or darken the image in addition to tinting it; resource
141	I<tintColor>. Example:
142		149
143	@@RXVT_NAME@@ -tr -tint blue -sh 40	150	=item B<-sh> I<number>
144		151
145	=item B<-sh>
146
147	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	152	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
148	background image in addition to tinting it (i.e. B<-tint> must be	153	A value of 100 means no shading; resource I<shading>.
149	specified, too, e.g. C<-tint white>).	154
		155	=item B<-blr> I<HxV>
		156
		157	Apply Gaussian Blur with the specified radii to the transparent
		158	background. If a single number is specified, the vertical and
		159	horizontal radii are considered to be the same. Setting one of the
		160	radii to 1 and the other to a large number creates interesting effects
		161	on some backgrounds. The maximum radius value is 128. An horizontal or
		162	vertical radius of 0 disables blurring;
		163	resource I<blurRadius>.
		164
		165	=item B<-icon> I<file>
		166
		167	Compile I<pixbuf>: Use the specified image as application icon. This
		168	is used by many window managers, taskbars and pagers to represent the
		169	application window; resource I<iconFile>.
150		170
151	=item B<-bg> I<colour>	171	=item B<-bg> I<colour>
152		172
153	Window background colour; resource B<background>.	173	Window background colour; resource B<background>.
154		174
155	=item B<-fg> I<colour>	175	=item B<-fg> I<colour>
156		176
157	Window foreground colour; resource B<foreground>.	177	Window foreground colour; resource B<foreground>.
158		178
159	=item B<-pixmap> I<file[;geom]>	179	=item B<-pixmap> I<file[;oplist]>
160		180
161	Compile I<XPM>: Specify XPM file for the background and also optionally	181	Compile I<pixbuf>: Specify image file for the background and also
162	specify its scaling with a geometry string. Note you may need to	182	optionally specify a list of operations to modify it. Note you may need to
163	add quotes to avoid special shell interpretation of the C<;> in the	183	add quotes to avoid special shell interpretation of the C<;> in the
164	command-line; resource B<backgroundPixmap>.	184	command-line; for more details see resource B<backgroundPixmap>.
165		185
166	=item B<-cr> I<colour>	186	=item B<-cr> I<colour>
167		187
168	The cursor colour; resource B<cursorColor>.	188	The cursor colour; resource B<cursorColor>.
169		189
…		…
214	italic> >> characters are to be printed. See resource B<boldItalicFont>	234	italic> >> characters are to be printed. See resource B<boldItalicFont>
215	for details.	235	for details.
216		236
217	=item B<-is>\|B<+is>	237	=item B<-is>\|B<+is>
218		238
219	Compile I<font-styles>: Bold/Italic font styles imply high intensity	239	Compile I<font-styles>: Bold/Blink font styles imply high intensity
220	foreground/background (default). See resource B<intensityStyles> for	240	foreground/background (default). See resource B<intensityStyles> for
221	details.	241	details.
222		242
223	=item B<-name> I<name>	243	=item B<-name> I<name>
224		244
…		…
242		262
243	=item B<-sb>\|B<+sb>	263	=item B<-sb>\|B<+sb>
244		264
245	Turn on/off scrollbar; resource B<scrollBar>.	265	Turn on/off scrollbar; resource B<scrollBar>.
246		266
		267	=item B<-sr>\|B<+sr>
		268
		269	Put scrollbar on right/left; resource B<scrollBar_right>.
		270
		271	=item B<-st>\|B<+st>
		272
		273	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		274	resource B<scrollBar_floating>.
		275
247	=item B<-si>\|B<+si>	276	=item B<-si>\|B<+si>
248		277
249	Turn on/off scroll-to-bottom on TTY output inhibit; resource	278	Turn on/off scroll-to-bottom on TTY output inhibit; resource
250	B<scrollTtyOutput> has opposite effect.	279	B<scrollTtyOutput> has opposite effect.
251		280
…		…
257	=item B<-sw>\|B<+sw>	286	=item B<-sw>\|B<+sw>
258		287
259	Turn on/off scrolling with the scrollback buffer as new lines appear.	288	Turn on/off scrolling with the scrollback buffer as new lines appear.
260	This only takes effect if B<-si> is also given; resource	289	This only takes effect if B<-si> is also given; resource
261	B<scrollWithBuffer>.	290	B<scrollWithBuffer>.
262
263	=item B<-sr>\|B<+sr>
264
265	Put scrollbar on right/left; resource B<scrollBar_right>.
266
267	=item B<-st>\|B<+st>
268
269	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
270	resource B<scrollBar_floating>.
271		291
272	=item B<-ptab>\|B<+ptab>	292	=item B<-ptab>\|B<+ptab>
273		293
274	If enabled (default), "Horizontal Tab" characters are being stored as	294	If enabled (default), "Horizontal Tab" characters are being stored as
275	actual wide characters in the screen buffer, which makes it possible to	295	actual wide characters in the screen buffer, which makes it possible to
…		…
279		299
280	=item B<-bc>\|B<+bc>	300	=item B<-bc>\|B<+bc>
281		301
282	Blink the cursor; resource B<cursorBlink>.	302	Blink the cursor; resource B<cursorBlink>.
283		303
		304	=item B<-uc>\|B<+uc>
		305
		306	Make the cursor underlined; resource B<cursorUnderline>.
		307
284	=item B<-iconic>	308	=item B<-iconic>
285		309
286	Start iconified, if the window manager supports that option.	310	Start iconified, if the window manager supports that option.
287	Alternative form is B<-ic>.	311	Alternative form is B<-ic>.
288		312
…		…
304		328
305	=item B<-bl>	329	=item B<-bl>
306		330
307	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	331	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
308	if honoured by the WM, the rxvt-unicode window will not have window	332	if honoured by the WM, the rxvt-unicode window will not have window
309	decorations; resource B<borderLess>.	333	decorations; resource B<borderLess>. If the window manager does not
		334	support MWM hints (e.g. kwin), enables override-redirect mode.
310		335
311	=item B<-override-redirect>	336	=item B<-override-redirect>
312		337
313	Compile I<frills>: Sets override-redirect on the window; resource	338	Compile I<frills>: Sets override-redirect on the window; resource
314	B<override-redirect>.	339	B<override-redirect>.
…		…
322		347
323	=item B<-lsp> I<number>	348	=item B<-lsp> I<number>
324		349
325	Compile I<frills>: Lines (pixel height) to insert between each row of	350	Compile I<frills>: Lines (pixel height) to insert between each row of
326	the display. Useful to work around font rendering problems; resource	351	the display. Useful to work around font rendering problems; resource
327	B<linespace>.	352	B<lineSpace>.
		353
		354	=item B<-letsp> I<number>
		355
		356	Compile I<frills>: Amount to adjust the computed character width by
		357	to control overall letter spacing. Negative values will tighten up the
		358	letter spacing, positive values will space letters out more. Useful to
		359	work around odd font metrics; resource B<letterSpace>.
328		360
329	=item B<-tn> I<termname>	361	=item B<-tn> I<termname>
330		362
331	This option specifies the name of the terminal type to be set in the	363	This option specifies the name of the terminal type to be set in the
332	B<TERM> environment variable. This terminal type must exist in the	364	B<TERM> environment variable. This terminal type must exist in the
…		…
386	for more info.	418	for more info.
387		419
388	=item B<-tcw>	420	=item B<-tcw>
389		421
390	Change the meaning of triple-click selection with the left mouse	422	Change the meaning of triple-click selection with the left mouse
		423	button. Only effective when the original (non-perl) selection code is
391	button. Instead of selecting a full line it will extend the selection the	424	in-use. Instead of selecting a full line it will extend the selection to
392	end of the logical line only. resource B<tripleclickwords>.	425	the end of the logical line only. resource B<tripleclickwords>.
393		426
394	=item B<-insecure>	427	=item B<-insecure>
395		428
396	Enable "insecure" mode, which currently enables most of the escape	429	Enable "insecure" mode, which currently enables most of the escape
397	sequences that echo strings. See the resource B<insecure> for more	430	sequences that echo strings. See the resource B<insecure> for more
…		…
418	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	451	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
419	will not immediately destroy its window when the program executed within	452	will not immediately destroy its window when the program executed within
420	it exits. Instead, it will wait till it is being killed or closed by the	453	it exits. Instead, it will wait till it is being killed or closed by the
421	user; resource B<hold>.	454	user; resource B<hold>.
422		455
		456	=item B<-cd> I<path>
		457
		458	Sets the working directory for the shell (or the command specified via
		459	B<-e>). The I<path> must be an absolute path and it must exist for
		460	@@RXVT_NAME@@ to start; resource B<chdir>.
		461
		462	=item B<-xrm> I<string>
		463
		464	Works like the X Toolkit option of the same name, by adding the I<string>
		465	as if it were specified in a resource file. Resource values specified this
		466	way take precedence over all other resource specifications.
		467
		468	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		469	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		470	options can be specified as long-options on the commandline, so use
		471	of B<-xrm> is mostly limited to cases where you want to specify other
		472	resources (e.g. for input methods) or for compatibility with other
		473	programs.
		474
423	=item B<-keysym.>I<sym> I<string>	475	=item B<-keysym.>I<sym> I<string>
424		476
425	Remap a key symbol. See resource B<keysym>.	477	Remap a key symbol. See resource B<keysym>.
426		478
427	=item B<-embed> I<windowid>	479	=item B<-embed> I<windowid>
…		…
437	The window will not be destroyed when @@RXVT_NAME@@ exits.	489	The window will not be destroyed when @@RXVT_NAME@@ exits.
438		490
439	It might be useful to know that @@RXVT_NAME@@ will not close file	491	It might be useful to know that @@RXVT_NAME@@ will not close file
440	descriptors passed to it (except for stdin/out/err, of course), so you	492	descriptors passed to it (except for stdin/out/err, of course), so you
441	can use file descriptors to communicate with the programs within the	493	can use file descriptors to communicate with the programs within the
442	terminal. This works regardless of wether the C<-embed> option was used or	494	terminal. This works regardless of whether the C<-embed> option was used or
443	not.	495	not.
444		496
445	Here is a short Gtk2-perl snippet that illustrates how this option can be	497	Here is a short Gtk2-perl snippet that illustrates how this option can be
446	used (a longer example is in F<doc/embed>):	498	used (a longer example is in F<doc/embed>):
447		499
…		…
452	});	504	});
453		505
454	=item B<-pty-fd> I<file descriptor>	506	=item B<-pty-fd> I<file descriptor>
455		507
456	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	508	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
457	pair but instead use the given filehandle as the tty master. This is	509	pair but instead use the given file descriptor as the tty master. This is
458	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator	510	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
459	without having to run a program within it.	511	without having to run a program within it.
460		512
461	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	513	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
462	entries and will not tinker with pty/tty permissions - you have to do that	514	entries and will not tinker with pty/tty permissions - you have to do that
463	yourself if you want that.	515	yourself if you want that.
464		516
465	As an extremely special case, specifying C<-1> will completely suppress	517	As an extremely special case, specifying C<-1> will completely suppress
466	pty/tty operations.	518	pty/tty operations, which is probably only useful in conjunction with some
		519	perl extension that manages the terminal.
467		520
468	Here is a example in perl that illustrates how this option can be used (a	521	Here is a example in perl that illustrates how this option can be used (a
469	longer example is in F<doc/pty-fd>):	522	longer example is in F<doc/pty-fd>):
470		523
471	use IO::Pty;	524	use IO::Pty;
…		…
485	Comma-separated list of perl extension scripts to use (or not to use) in	538	Comma-separated list of perl extension scripts to use (or not to use) in
486	this terminal instance. See resource B<perl-ext> for details.	539	this terminal instance. See resource B<perl-ext> for details.
487		540
488	=back	541	=back
489		542
490	=head1 RESOURCES (available also as long-options)	543	=head1 RESOURCES
491		544
492	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	545	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
493	options) compiled into your version.	546	options) compiled into your version. All resources are also available as
		547	long-options.
494		548
495	You can set and change the resources using X11 tools like B<xrdb>. Many	549	You can set and change the resources using X11 tools like B<xrdb>. Many
496	distribution do also load settings from the B<~/.Xresources> file when X	550	distribution do also load settings from the B<~/.Xresources> file when X
497	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	551	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
498	with later settings overwriting earlier ones:	552	with later settings overwriting earlier ones:
499		553
500	1. system-wide app-defaults file, either locale-dependent OR global
501	2. app-defaults file in $XAPPLRESDIR	554	1. app-defaults file in $XAPPLRESDIR
		555	2. $HOME/.Xdefaults
502	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	556	3. RESOURCE_MANAGER property on root-window of screen 0
503	4. SCREEN_RESOURCES for the current screen	557	4. SCREEN_RESOURCES property on root-window of the current screen
504	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	558	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		559	6. resources specified via -xrm on the commandline
505		560
506	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	561	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
507	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	562	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
508	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily	563	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
509	configured, while the class name B<URxvt> allows resources unique to	564	configured, while the class name B<URxvt> allows resources unique to
…		…
519	=item B<depth:> I<bitdepth>	574	=item B<depth:> I<bitdepth>
520		575
521	Compile I<xft>: Attempt to find a visual with the given bit depth;	576	Compile I<xft>: Attempt to find a visual with the given bit depth;
522	option B<-depth>.	577	option B<-depth>.
523		578
		579	=item B<buffered:> I<boolean>
		580
		581	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		582	On some card/driver combination enabling it slightly decreases
		583	performance, on most it greatly helps it. The slowdown is small, so it
		584	should normally be enabled.
		585
524	=item B<geometry:> I<geom>	586	=item B<geometry:> I<geom>
525		587
526	Create the window with the specified X window geometry [default 80x24];	588	Create the window with the specified X window geometry [default 80x24];
527	option B<-geometry>.	589	option B<-geometry>.
528		590
…		…
541	Use the specified colour for the colour value I<n>, where 0-7	603	Use the specified colour for the colour value I<n>, where 0-7
542	corresponds to low-intensity (normal) colours and 8-15 corresponds to	604	corresponds to low-intensity (normal) colours and 8-15 corresponds to
543	high-intensity (bold = bright foreground, blink = bright background)	605	high-intensity (bold = bright foreground, blink = bright background)
544	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	606	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
545	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	607	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
546	names used are listed in the B<COLORS AND GRAPHICS> section.	608	names used are listed in the B<COLOURS AND GRAPHICS> section.
547		609
548	Colours higher than 15 cannot be set using resources (yet), but can be	610	Colours higher than 15 cannot be set using resources (yet), but can be
549	changed using an escape command (see @@RXVT_NAME@@(7)).	611	changed using an escape command (see @@RXVT_NAME@@(7)).
550		612
551	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	613	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
562	=item B<colorUL:> I<colour>	624	=item B<colorUL:> I<colour>
563		625
564	Use the specified colour to display underlined characters when the	626	Use the specified colour to display underlined characters when the
565	foreground colour is the default.	627	foreground colour is the default.
566		628
567	=item B<colorRV:> I<colour>
568
569	Use the specified colour as the background for reverse video
570	characters.
571
572	=item B<underlineColor:> I<colour>	629	=item B<underlineColor:> I<colour>
573		630
574	If set, use the specified colour as the colour for the underline	631	If set, use the specified colour as the colour for the underline
575	itself. If unset, use the foreground colour.	632	itself. If unset, use the foreground colour.
		633
		634	=item B<highlightColor:> I<colour>
		635
		636	If set, use the specified colour as the background for highlighted
		637	characters. If unset, use reverse video.
		638
		639	=item B<highlightTextColor:> I<colour>
		640
		641	If set and highlightColor is set, use the specified colour as the
		642	foreground for highlighted characters.
576		643
577	=item B<cursorColor:> I<colour>	644	=item B<cursorColor:> I<colour>
578		645
579	Use the specified colour for the cursor. The default is to use the	646	Use the specified colour for the cursor. The default is to use the
580	foreground colour; option B<-cr>.	647	foreground colour; option B<-cr>.
…		…
587		654
588	=item B<reverseVideo:> I<boolean>	655	=item B<reverseVideo:> I<boolean>
589		656
590	B<True>: simulate reverse video by foreground and background colours;	657	B<True>: simulate reverse video by foreground and background colours;
591	option B<-rv>. B<False>: regular screen colours [default]; option	658	option B<-rv>. B<False>: regular screen colours [default]; option
592	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	659	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
593		660
594	=item B<jumpScroll:> I<boolean>	661	=item B<jumpScroll:> I<boolean>
595		662
596	B<True>: specify that jump scrolling should be used. When scrolling	663	B<True>: specify that jump scrolling should be used. When receiving lots
597	quickly, fewer screen updates are performed [default]; option B<-j>.	664	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		665	has been read, resulting in fewer updates while still displaying every
		666	received line; option B<-j>.
		667
598	B<False>: specify that smooth scrolling should be used; option B<+j>.	668	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		669	force a screen refresh on each new line it received; option B<+j>.
599		670
600	=item B<inheritPixmap:> I<boolean>	671	=item B<skipScroll:> I<boolean>
601		672
602	B<True>: make the background inherit the parent windows' pixmap, giving	673	B<True>: (the default) specify that skip scrolling should be used. When
603	artificial transparency. B<False>: do not inherit the parent windows'	674	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
604	pixmap.	675	(around 60 times per second), resulting in far fewer updates. This can
		676	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		677	option B<-ss>.
605		678
606	I<Please note that transparency of any kind if completely unsupported by	679	B<False>: specify that everything is to be displayed, even
607	the author. Don't bug him with installation questions!>	680	if the refresh is too fast for the human eye to read anything (or the
		681	monitor to display anything); option B<+ss>.
		682
		683	=item B<transparent:> I<boolean>
		684
		685	Turn on/off pseudo-transparency by using the root pixmap as background.
		686
		687	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
		688	future versions.
608		689
609	=item B<fading:> I<number>	690	=item B<fading:> I<number>
610		691
611	Fade the text by the given percentage when focus is lost; option B<-fade>.	692	Fade the text by the given percentage when focus is lost; option B<-fade>.
612		693
…		…
615	Fade to this colour, when fading is used (see B<fading:>). The default	696	Fade to this colour, when fading is used (see B<fading:>). The default
616	colour is black; option B<-fadecolor>.	697	colour is black; option B<-fadecolor>.
617		698
618	=item B<tintColor:> I<colour>	699	=item B<tintColor:> I<colour>
619		700
620	Tint the transparent background pixmap with the given colour; option	701	Tint the transparent background with the given colour. If the RENDER
621	B<-tint>.	702	extension is not available only black, red, green, yellow, blue,
		703	magenta, cyan and white tints can be performed server-side. Note that
		704	a black tint yields a completely black image while a white tint yields
		705	the image unchanged; option B<-tint>.
622		706
623	=item B<shading:> I<number>	707	=item B<shading:> I<number>
624		708
625	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	709	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
626	image in addition to tinting it.	710	A value of 100 means no shading; option B<-sh>.
		711
		712	=item B<blurRadius:> I<number>
		713
		714	Apply gaussian blur with the specified radius to the transparent
		715	background; option B<-blr>.
		716
		717	=item B<iconFile:> I<file>
		718
		719	Set the application icon pixmap; option B<-icon>.
627		720
628	=item B<scrollColor:> I<colour>	721	=item B<scrollColor:> I<colour>
629		722
630	Use the specified colour for the scrollbar [default #B2B2B2].	723	Use the specified colour for the scrollbar [default #B2B2B2].
631		724
…		…
637	=item B<borderColor:> I<colour>	730	=item B<borderColor:> I<colour>
638		731
639	The colour of the border around the text area and between the scrollbar	732	The colour of the border around the text area and between the scrollbar
640	and the text.	733	and the text.
641		734
642	=item B<backgroundPixmap:> I<file[;geom]>	735	=item B<backgroundPixmap:> I<file[;oplist]>
643		736
644	Use the specified XPM file (note the `.xpm' extension is optional) for	737	Use the specified image file for the background and also
645	the background and also optionally specify its scaling with a geometry	738	optionally specify a colon separated list of operations to modify it.
646	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	739	Supported operations are:
647	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	740
648	centre (percent). A scale of 0 displays the image with tiling. A scale	741	=over 4
649	of 1 displays the image without any scaling. A scale of 2 to 9	742
650	specifies an integer number of images in that direction. No image will	743	=item B<WxH+X+Y>
651	be magnified beyond 10 times its original size. The maximum permitted	744
652	scale is 1000. [default 0x0+50+50]	745	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
		746	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
		747	scale of 0 disables scaling. The maximum permitted scale is 1000.
		748
		749	=item B<op=tile>
		750
		751	enables tiling
		752
		753	=item B<op=keep-aspect>
		754
		755	maintain the image aspect ratio when scaling
		756
		757	=item B<op=root-align>
		758
		759	use the position of the terminal window relative to the root window as
		760	the image offset, simulating a root window background
		761
		762	=back
		763
		764	The default scale and position setting is C<100x100+50+50>.
		765	Alternatively, a predefined set of templates can be used to achieve
		766	the most common setups:
		767
		768	=over 4
		769
		770	=item B<style=tiled>
		771
		772	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		773
		774	=item B<style=aspect-stretched>
		775
		776	the image is scaled to fill the whole window maintaining the aspect
		777	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		778
		779	=item B<style=stretched>
		780
		781	the image is scaled to fill the whole window. Equivalent to 100x100
		782
		783	=item B<style=centered>
		784
		785	the image is centered with no scaling. Equivalent to 0x0+50+50
		786
		787	=item B<style=root-tiled>
		788
		789	the image is tiled with no scaling and using 'root' positioning.
		790	Equivalent to 0x0:op=tile:op=root-align
		791
		792	=back
		793
		794	If multiple templates are specified the last one wins. Note that a
		795	template overrides all the scale, position and operations settings.
		796
		797	If used in conjunction with B<-tr> option, the specified pixmap will be
		798	blended over the transparent background using alpha-blending.
653		799
654	=item B<path:> I<path>	800	=item B<path:> I<path>
655		801
656	Specify the colon-delimited search path for finding XPM files.	802	Specify the colon-delimited search path for finding background image files.
657		803
658	=item B<font:> I<fontlist>	804	=item B<font:> I<fontlist>
659		805
660	Select the fonts to be used. This is a comma separated list of font names	806	Select the fonts to be used. This is a comma separated list of font names
661	that are checked in order when trying to find glyphs for characters. The	807	that are checked in order when trying to find glyphs for characters. The
…		…
684	it is named first) and thus defines the character cell grid to be 9 pixels	830	it is named first) and thus defines the character cell grid to be 9 pixels
685	wide and 15 pixels high.	831	wide and 15 pixels high.
686		832
687	The second font is just used to add additional unicode characters not in	833	The second font is just used to add additional unicode characters not in
688	the base font, likewise the third, which is unfortunately non-bold, but	834	the base font, likewise the third, which is unfortunately non-bold, but
689	the bold version of the font does contain less characters, so this is a	835	the bold version of the font does contain fewer characters, so this is a
690	useful supplement.	836	useful supplement.
691		837
692	The third font is an Xft font with aliasing turned off, and the characters	838	The third font is an Xft font with aliasing turned off, and the characters
693	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	839	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
694	contains other characters, but we are not interested in them.	840	contains other characters, but we are not interested in them.
…		…
718	text font will being used for the given style.	864	text font will being used for the given style.
719		865
720	=item B<intensityStyles:> I<boolean>	866	=item B<intensityStyles:> I<boolean>
721		867
722	When font styles are not enabled, or this option is enabled (B<True>,	868	When font styles are not enabled, or this option is enabled (B<True>,
723	option B<-is>, the default), bold and italic font styles imply high	869	option B<-is>, the default), bold/blink font styles imply high
724	intensity foreground/backround colours. Disabling this option (B<False>,	870	intensity foreground/background colours. Disabling this option (B<False>,
725	option B<+is>) disables this behaviour, the high intensity colours are not	871	option B<+is>) disables this behaviour, the high intensity colours are not
726	reachable.	872	reachable.
727
728	=item B<selectstyle:> I<mode>
729
730	Set mouse selection style to B<old> which is 2.20, B<oldword> which is
731	xterm style with 2.20 old word selection, or anything else which gives
732	xterm style selection.
733
734	=item B<scrollstyle:> I<mode>
735
736	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
737	the author's favourite.
738		873
739	=item B<title:> I<string>	874	=item B<title:> I<string>
740		875
741	Set window title string, the default title is the command-line	876	Set window title string, the default title is the command-line
742	specified after the B<-e> option, if any, otherwise the application	877	specified after the B<-e> option, if any, otherwise the application
…		…
751	=item B<mapAlert:> I<boolean>	886	=item B<mapAlert:> I<boolean>
752		887
753	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	888	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
754	de-iconify (map) on receipt of a bell character [default].	889	de-iconify (map) on receipt of a bell character [default].
755		890
		891	=item B<urgentOnBell:> I<boolean>
		892
		893	B<True>: set the urgency hint for the wm on receipt of a bell character.
		894	B<False>: do not set the urgency hint [default].
		895
		896	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		897
756	=item B<visualBell:> I<boolean>	898	=item B<visualBell:> I<boolean>
757		899
758	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	900	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
759	B<False>: no visual bell [default]; option B<+vb>.	901	B<False>: no visual bell [default]; option B<+vb>.
760		902
…		…
781	Example:	923	Example:
782		924
783	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	925	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
784		926
785	This creates a new file in your home directory with the screen contents	927	This creates a new file in your home directory with the screen contents
786	everytime you hit C<Print>.	928	every time you hit C<Print>.
		929
		930	=item B<scrollstyle:> I<mode>
		931
		932	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		933	the author's favourite.
		934
		935	=item B<thickness:> I<number>
		936
		937	Set the scrollbar width in pixels.
787		938
788	=item B<scrollBar:> I<boolean>	939	=item B<scrollBar:> I<boolean>
789		940
790	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	941	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
791	disable the scrollbar; option B<+sb>.	942	disable the scrollbar; option B<+sb>.
…		…
811	B<False>: do not scroll to bottom when tty receives output; option	962	B<False>: do not scroll to bottom when tty receives output; option
812	B<+si>.	963	B<+si>.
813		964
814	=item B<scrollWithBuffer:> I<boolean>	965	=item B<scrollWithBuffer:> I<boolean>
815		966
816	B<True>: scroll with scrollback buffer when tty receives new lines (and	967	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
817	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	968	try to show the same lines) and B<scrollTtyOutput> is False; option
818	with scrollback buffer when tty recieves new lines; option B<+sw>.	969	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		970	new lines; option B<+sw>.
819		971
820	=item B<scrollTtyKeypress:> I<boolean>	972	=item B<scrollTtyKeypress:> I<boolean>
821		973
822	B<True>: scroll to bottom when a non-special key is pressed. Special keys	974	B<True>: scroll to bottom when a non-special key is pressed. Special keys
823	are those which are intercepted by rxvt-unicode for special handling and	975	are those which are intercepted by rxvt-unicode for special handling and
…		…
854	=item B<termName:> I<termname>	1006	=item B<termName:> I<termname>
855		1007
856	Specifies the terminal type name to be set in the B<TERM> environment	1008	Specifies the terminal type name to be set in the B<TERM> environment
857	variable; option B<-tn>.	1009	variable; option B<-tn>.
858		1010
859	=item B<linespace:> I<number>	1011	=item B<lineSpace:> I<number>
860		1012
861	Specifies number of lines (pixel height) to insert between each row of	1013	Specifies number of lines (pixel height) to insert between each row of
862	the display [default 0]; option B<-lsp>.	1014	the display [default 0]; option B<-lsp>.
863		1015
864	=item B<meta8:> I<boolean>	1016	=item B<meta8:> I<boolean>
…		…
878		1030
879	=item B<cursorBlink:> I<boolean>	1031	=item B<cursorBlink:> I<boolean>
880		1032
881	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1033	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
882	option B<-bc>.	1034	option B<-bc>.
		1035
		1036	=item B<cursorUnderline:> I<boolean>
		1037
		1038	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1039	option B<-uc>.
883		1040
884	=item B<pointerBlank:> I<boolean>	1041	=item B<pointerBlank:> I<boolean>
885		1042
886	B<True>: blank the pointer when a key is pressed or after a set number	1043	B<True>: blank the pointer when a key is pressed or after a set number
887	of seconds of inactivity. B<False>: the pointer is always visible	1044	of seconds of inactivity. B<False>: the pointer is always visible
…		…
901	large number (e.g. C<987654321>) to effectively disable the timeout.	1058	large number (e.g. C<987654321>) to effectively disable the timeout.
902		1059
903	=item B<backspacekey:> I<string>	1060	=item B<backspacekey:> I<string>
904		1061
905	The string to send when the backspace key is pressed. If set to B<DEC>	1062	The string to send when the backspace key is pressed. If set to B<DEC>
906	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	1063	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
907	(code 8) - which can be reversed with the appropriate DEC private mode	1064	(code 8) - which can be reversed with the appropriate DEC private mode
908	escape sequence.	1065	escape sequence.
909		1066
910	=item B<deletekey:> I<string>	1067	=item B<deletekey:> I<string>
911		1068
…		…
916	=item B<cutchars:> I<string>	1073	=item B<cutchars:> I<string>
917		1074
918	The characters used as delimiters for double-click word selection	1075	The characters used as delimiters for double-click word selection
919	(whitespace delimiting is added automatically if resource is given).	1076	(whitespace delimiting is added automatically if resource is given).
920		1077
921	When the selection extension is in use (the default if compiled in, see	1078	When the perl selection extension is in use (the default if compiled
922	the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters	1079	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
923	will be created (if the resource exists, otherwise, no regex will be	1080	characters will be created (if the resource exists, otherwise, no regex
924	created). In this mode, characters outside ISO-8859-1 can be used.	1081	will be created). In this mode, characters outside ISO-8859-1 can be used.
925		1082
926	When the selection extension is not used, only ISO-8859-1 characters can	1083	When the selection extension is not used, only ISO-8859-1 characters can
927	be used. If not specified, the built-in default is used:	1084	be used. If not specified, the built-in default is used:
928		1085
929	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1086	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
930		1087
931	=item B<preeditType:> I<style>	1088	=item B<preeditType:> I<style>
932		1089
933	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1090	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
934		1091
…		…
988		1145
989	Turn on/off secondary screen (default enabled).	1146	Turn on/off secondary screen (default enabled).
990		1147
991	=item B<secondaryScroll:> I<boolean>	1148	=item B<secondaryScroll:> I<boolean>
992		1149
993	Turn on/off secondary screen scroll (default enabled). If the this	1150	Turn on/off secondary screen scroll (default enabled). If this
994	option is enabled, scrolls on the secondary screen will change the	1151	option is enabled, scrolls on the secondary screen will change the
995	scrollback buffer and switching to/from the secondary screen will	1152	scrollback buffer and, when secondaryScreen is off, switching
996	instead scroll the screen up.	1153	to/from the secondary screen will instead scroll the screen up.
997		1154
998	=item B<hold>: I<boolean>	1155	=item B<hold>: I<boolean>
999		1156
1000	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1157	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1001	will not immediately destroy its window when the program executed within	1158	will not immediately destroy its window when the program executed within
1002	it exits. Instead, it will wait till it is being killed or closed by the	1159	it exits. Instead, it will wait till it is being killed or closed by the
1003	user.	1160	user.
		1161
		1162	=item B<chdir>: I<path>
		1163
		1164	Sets the working directory for the shell (or the command specified via
		1165	B<-e>). The I<path> must be an absolute path and it must exist for
		1166	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1167	directory will be used; option B<-cd>.
1004		1168
1005	=item B<keysym.>I<sym>: I<string>	1169	=item B<keysym.>I<sym>: I<string>
1006		1170
1007	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1171	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1008	intervening resource name B<keysym.> cannot be omitted.	1172	intervening resource name B<keysym.> cannot be omitted.
…		…
1022	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1186	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1023	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1187	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1024	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1188	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1025	performed in an exact manner; however, the closest match is assured.	1189	performed in an exact manner; however, the closest match is assured.
1026		1190
1027	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1191	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1028	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1192	number), see RESOURCES in C<man 7 X> for further details.
1029	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1030	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1031	can start or end with whitespace.
1032		1193
1033	Please note that you need to double the C<\> in resource files, as
1034	Xlib itself does its own de-escaping (you can use C<\033> instead of
1035	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1036	processing).
1037
1038	You can define a range of keysyms in one shot by providing a I<string>	1194	You can define a range of keysyms in one shot by
		1195	loading the C<keysym-list> perl extension and providing a I<string>
1039	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1196	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1040	should be a character not used by the strings.	1197	should be a character not used by the strings.
1041		1198
1042	Its usage can be demonstrated by an example:	1199	Its usage can be demonstrated by an example:
1043		1200
1044	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1201	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1045		1202
1046	The above line is equivalent to the following three lines:	1203	The above line is equivalent to the following three lines:
1047		1204
1048	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1205	URxvt.keysym.Meta-Control-0x61: \033<a>
1049	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1206	URxvt.keysym.Meta-Control-0x62: \033<b>
1050	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1207	URxvt.keysym.Meta-Control-0x63: \033<c>
1051		1208
1052	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1209	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1053	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1210	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1054	example the following means "change the current locale to C<zh_CN.GBK>	1211	example the following means "change the current locale to C<zh_CN.GBK>
1055	when Control-Meta-c is being pressed":	1212	when Control-Meta-c is being pressed":
1056		1213
1057	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1214	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1058		1215
1059	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1216	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1060	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1217	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1061	manpage. For example, the F<selection> extension (activated via	1218	manpage. For example, the F<selection> extension (activated via
1062	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1219	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1063		1220
1064	URxvt.keysym.M-C-c: perl:selection:rot13	1221	URxvt.keysym.M-C-c: perl:selection:rot13
1065		1222
1066	Due the the large number of modifier combinations, a defined key mapping	1223	Due the the large number of modifier combinations, a defined key mapping
1067	will match if at I<at least> the specified identifiers are being set, and	1224	will match if I<at least> the specified identifiers are being set, and
1068	no other key mappings with those and more bits are being defined. That	1225	no other key mappings with those and more bits are being defined. That
1069	means that defining a key map for C<a> will automatically provide	1226	means that defining a key map for C<a> will automatically provide
1070	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined	1227	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1071	mappings themselves.	1228	mappings themselves.
1072		1229
…		…
1108	example, C<default,-selection> will use all the default extension except	1265	example, C<default,-selection> will use all the default extension except
1109	C<selection>.	1266	C<selection>.
1110		1267
1111	Extension names can also be followed by an argument in angle brackets	1268	Extension names can also be followed by an argument in angle brackets
1112	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1269	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1113	searchable scorllback to Alt/Meta-s). Mentioning the same extension	1270	searchable scrollback to Alt/Meta-s). Mentioning the same extension
1114	multiple times with different arguments will pass multiple arguments to	1271	multiple times with different arguments will pass multiple arguments to
1115	the extension.	1272	the extension.
1116		1273
1117	Each extension is looked up in the library directories, loaded if	1274	Each extension is looked up in the library directories, loaded if
1118	necessary, and bound to the current terminal instance.	1275	necessary, and bound to the current terminal instance.
…		…
1123	all instances, while B<perl-ext> is used for specific instances.	1280	all instances, while B<perl-ext> is used for specific instances.
1124		1281
1125	=item B<perl-eval>: I<string>	1282	=item B<perl-eval>: I<string>
1126		1283
1127	Perl code to be evaluated when all extensions have been registered. See	1284	Perl code to be evaluated when all extensions have been registered. See
1128	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1285	the @@RXVT_NAME@@perl(3) manpage.
1129	will be ignored when running setuid/setgid.
1130		1286
1131	=item B<perl-lib>: I<path>	1287	=item B<perl-lib>: I<path>
1132		1288
1133	Colon-separated list of additional directories that hold extension	1289	Colon-separated list of additional directories that hold extension
1134	scripts. When looking for extensions specified by the C<perl> resource,	1290	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
1135	@@RXVT_NAME@@ will first look in these directories and then in	1291	look in these directories, then in $HOME/.urxvt/ext and lastly in
1136	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1292	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1137	will be ignored when running setuid/setgid.
1138		1293
1139	See the @@RXVT_NAME@@perl(3) manpage.	1294	See the @@RXVT_NAME@@perl(3) manpage.
1140		1295
1141	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1296	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1142		1297
…		…
1154	(default: C<M-s>).	1309	(default: C<M-s>).
1155		1310
1156	=item B<urlLauncher>: I<string>	1311	=item B<urlLauncher>: I<string>
1157		1312
1158	Specifies the program to be started with a URL argument. Used by the	1313	Specifies the program to be started with a URL argument. Used by the
1159	C<selection-popup> and C<mark-urls> perl extensions.	1314	C<selection-popup> and C<matcher> perl extensions.
1160		1315
1161	=item B<transient-for>: I<windowid>	1316	=item B<transient-for>: I<windowid>
1162		1317
1163	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.	1318	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1164		1319
1165	=item B<override-redirect>: I<boolean>	1320	=item B<override-redirect>: I<boolean>
1166		1321
1167	Compile I<frills>: Sets override-redirect for the terminal window, making	1322	Compile I<frills>: Sets override-redirect for the terminal window, making
1168	it almost invisible to window managers; option B<-override-redirect>.	1323	it almost invisible to window managers; option B<-override-redirect>.
		1324
		1325	=item B<iso14755:> I<boolean>
		1326
		1327	Turn on/off ISO 14755 (default enabled).
		1328
		1329	=item B<iso14755_52:> I<boolean>
		1330
		1331	Turn on/off ISO 14755 5.2 mode (default enabled).
1169		1332
1170	=back	1333	=back
1171		1334
1172	=head1 THE SCROLLBAR	1335	=head1 THE SCROLLBAR
1173		1336
…		…
1192	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1355	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1193	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1356	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1194	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1357	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1195	respectively.	1358	respectively.
1196		1359
1197	=head1 TEXT SELECTION AND INSERTION	1360	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1198		1361
1199	The behaviour of text selection and insertion mechanism is similar to	1362	The behaviour of text selection and insertion/pasting mechanism is similar
1200	I<xterm>(1).	1363	to I<xterm>(1).
1201		1364
1202	=over 4	1365	=over 4
1203		1366
1204	=item B<Selection>:	1367	=item B<Selecting>:
1205		1368
1206	Left click at the beginning of the region, drag to the end of the region	1369	Left click at the beginning of the region, drag to the end of the region
1207	and release; Right click to extend the marked region; Left double-click	1370	and release; Right click to extend the marked region; Left double-click
1208	to select a word; Left triple-click to select the entire logical line	1371	to select a word; Left triple-click to select the entire logical line
1209	(which can span multiple screen lines), unless modified by resource	1372	(which can span multiple screen lines), unless modified by resource
…		…
1213	(Compile: I<frills>) will create a rectangular selection instead of a	1376	(Compile: I<frills>) will create a rectangular selection instead of a
1214	normal one. In this mode, every selected row becomes its own line in the	1377	normal one. In this mode, every selected row becomes its own line in the
1215	selection, and trailing whitespace is visually underlined and removed from	1378	selection, and trailing whitespace is visually underlined and removed from
1216	the selection.	1379	the selection.
1217		1380
1218	=item B<Insertion>:	1381	=item B<Pasting>:
1219		1382
1220	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>	1383	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1221	window causes the value of the PRIMARY selection (or CLIPBOARD with the	1384	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1222	Meta modifier) to be inserted as if it had been typed on the keyboard.	1385	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1223		1386
1224	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1387	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1225	inserted too.	1388	inserted too.
1226		1389
1227	=back	1390	=back
…		…
1244		1407
1245	=head1 ISO 14755 SUPPORT	1408	=head1 ISO 14755 SUPPORT
1246		1409
1247	ISO 14755 is a standard for entering and viewing unicode characters	1410	ISO 14755 is a standard for entering and viewing unicode characters
1248	and character codes using the keyboard. It consists of 4 parts. The	1411	and character codes using the keyboard. It consists of 4 parts. The
1249	first part is available rxvt-unicode has been compiled with	1412	first part is available if rxvt-unicode has been compiled with
1250	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1413	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1251	with C<--enable-iso14755>.	1414	with C<--enable-iso14755>.
1252		1415
1253	=over 4	1416	=over 4
1254		1417
…		…
1312	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1475	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1313	it can be seen via the I<who(1)> command, and can accept messages. To	1476	it can be seen via the I<who(1)> command, and can accept messages. To
1314	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1477	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1315	on some systems or setgid to root or to some other group on others.	1478	on some systems or setgid to root or to some other group on others.
1316		1479
1317	=head1 COLORS AND GRAPHICS	1480	=head1 COLOURS AND GRAPHICS
1318		1481
1319	In addition to the default foreground and background colours,	1482	In addition to the default foreground and background colours,
1320	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1483	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1321	high-intensity bold/blink versions of the same). Here is a list of the	1484	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1322	colours with their names.	1485	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1486	cube plus a 8 (24) colour greyscale ramp.
		1487
		1488	Here is a list of the ANSI colours with their names.
1323		1489
1324	=begin table	1490	=begin table
1325		1491
1326	B<color0> (black) = Black	1492	B<color0> (black) = Black
1327	B<color1> (red) = Red3	1493	B<color1> (red) = Red3
…		…
1347	It is also possible to specify the colour values of B<foreground>,	1513	It is also possible to specify the colour values of B<foreground>,
1348	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1514	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1349	a number 0-15, as a convenient shorthand to reference the colour name of	1515	a number 0-15, as a convenient shorthand to reference the colour name of
1350	color0-color15.	1516	color0-color15.
1351		1517
1352	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1518	The following text gives values for the standard 88 colour mode (and
1353	additional 72 colours. The first 64 of those (with indices 16 to 79)	1519	values for the 256 colour mode in parentheses).
1354	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1355	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1356		1520
		1521	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1522
		1523	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1524	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1525
		1526	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1527	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1528	the RGB cube.
		1529
1357	Together, all those colours implement the 88 colour xterm colours. Only	1530	Together, all those colours implement the 88 (256) colour xterm
1358	the first 16 can be changed using resources currently, the rest can only	1531	colours. Only the first 16 can be changed using resources currently, the
1359	be changed via command sequences ("escape codes").	1532	rest can only be changed via command sequences ("escape codes").
		1533
		1534	Applications are advised to use terminfo or command sequences to discover
		1535	number and RGB values of all colours (yes, you can query this...).
1360		1536
1361	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1537	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1362	always swapping the foreground/background colours. This is in contrast to	1538	always swapping the foreground/background colours. This is in contrast to
1363	I<xterm>(1) where the colours are only swapped if they have not otherwise	1539	I<xterm>(1) where the colours are only swapped if they have not otherwise
1364	been specified. For example,	1540	been specified. For example,
1365		1541
		1542	@@RXVT_NAME@@ -fg Black -bg White -rv
		1543
		1544	would yield White on Black, while on I<xterm>(1) it would yield Black on
		1545	White.
		1546
		1547	=head2 ALPHA CHANNEL SUPPORT
		1548
		1549	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1550	their act together, rxvt-unicode will do its own alpha channel management:
		1551
		1552	You can prefix any colour with an opaqueness percentage enclosed in
		1553	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1554	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1555	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1556	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1557	is the recommended format to specify transparency values, and works with
		1558	all ways to specify a colour.
		1559
		1560	For complete control, rxvt-unicode also supports
		1561	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1562	specifications, where the additional C<aaaa> component specifies opacity
		1563	(alpha) values. The minimum value of C<0000> is completely transparent,
		1564	while C<ffff> is completely opaque). The two example colours from
		1565	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1566	C<rgba:0000/ff00/0000/f332>.
		1567
		1568	You probably need to specify B<"-depth 32">, too, to force a visual with
		1569	alpha channels, and have the luck that your X-server uses ARGB pixel
		1570	layout, as X is far from just supporting ARGB visuals out of the box, and
		1571	rxvt-unicode just fudges around.
		1572
		1573	For example, the following selects an almost completely transparent black
		1574	background, and an almost opaque pink foreground:
		1575
		1576	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
		1577
		1578	When not using a background image, then the interpretation of the
		1579	alpha channel is up to your compositing manager (most interpret it as
		1580	transparency of course).
		1581
		1582	When using a background pixmap or pseudo-transparency, then the background
		1583	colour will always behave as if it were completely transparent (so the
		1584	background image shows instead), regardless of how it was specified, while
		1585	other colours will either be transparent as specified (the background
		1586	image will show through) on servers supporting the RENDER extension, or
		1587	fully opaque on servers not supporting the RENDER EXTENSION.
		1588
		1589	Please note that due to bugs in Xft, specifying alpha values might result
		1590	in garbage being displayed when the X-server does not support the RENDER
		1591	extension.
		1592
		1593	=head1 ENVIRONMENT
		1594
		1595	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
		1596
1366	=over 4	1597	=over 4
1367		1598
1368	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
1369
1370	would yield White on Black, while on I<xterm>(1) it would yield Black
1371	on White.
1372
1373	=back
1374
1375	=head2 ALPHA CHANNEL SUPPORT
1376
1377	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1378	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1379	(recommended, but B<MUST> have 4 digits/component) colour specifications,
1380	in addition to the ones provided by X, where the additional A component
1381	specifies opacity (alpha) values. The minimum value of C<0> is completely
1382	transparent). You can also prefix any color with C<[a]>, where C<a> is on
1383	to four hex digits specifiying the opacity value.
1384
1385	You probably need to specify B<"-depth 32">, too, and have the luck that
1386	your X-server uses ARGB pixel layout, as X is far from just supporting
1387	ARGB visuals out of the box, and rxvt-unicode just fudges around.
1388
1389	For example, the following selects an almost completely transparent red
1390	background, and an almost opaque pink foreground:
1391
1392	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"
1393
1394	I<Please note that transparency of any kind if completely unsupported by
1395	the author. Don't bug him with installation questions!>
1396
1397	=head1 ENVIRONMENT
1398
1399	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1400
1401	=over 4
1402
1403	=item B<TERM>	1599	=item B<TERM>
1404		1600
1405	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1601	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1406	resources or on the commandline.	1602	resources or on the command line.
1407		1603
1408	=item B<COLORTERM>	1604	=item B<COLORTERM>
1409		1605
1410	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1606	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1411	compiled with XPM support, and optionally with the added extension	1607	compiled with background image support, and optionally with the added
1412	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1608	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1609	screen.
1413		1610
1414	=item B<COLORFGBG>	1611	=item B<COLORFGBG>
1415		1612
1416	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1613	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1417	the colour code used as default foreground/text colour (or the string	1614	the colour code used as default foreground/text colour (or the string
1418	C<default> to indicate that the default-colour escape sequence is to be	1615	C<default> to indicate that the default-colour escape sequence is to be
1419	used), C<bg> is the colour code used as default background colour (or the	1616	used), C<bg> is the colour code used as default background colour (or the
1420	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1617	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1421	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1618	was compiled with background image support. Libraries like C<ncurses>
1422	(and do) use this information to optimize screen output.	1619	and C<slang> can (and do) use this information to optimize screen output.
1423		1620
1424	=item B<WINDOWID>	1621	=item B<WINDOWID>
1425		1622
1426	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1623	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1427	window, which usually has subwindows for the scrollbar, the terminal	1624	window, which usually has subwindows for the scrollbar, the terminal
…		…
1433	C<--with-terminfo=PATH>.	1630	C<--with-terminfo=PATH>.
1434		1631
1435	=item B<DISPLAY>	1632	=item B<DISPLAY>
1436		1633
1437	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1634	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1438	display in its child processes.	1635	display in its child processes if C<-display> isn't used to override. It
		1636	defaults to C<:0> if it doesn't exist.
1439		1637
1440	=item B<SHELL>	1638	=item B<SHELL>
1441		1639
1442	The shell to be used for command execution, defaults to C</bin/sh>.	1640	The shell to be used for command execution, defaults to C</bin/sh>.
1443		1641
1444	=item B<RXVT_SOCKET>	1642	=item B<RXVT_SOCKET>
1445		1643
1446	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1644	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1447	@@RXVT_NAME@@d(1).	1645	@@RXVT_NAME@@d(1).
1448		1646
1449	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1647	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1450		1648
1451	=item B<HOME>	1649	=item B<HOME>
1452		1650
1453	Used to locate the default directory for the unix domain socket for	1651	Used to locate the default directory for the unix domain socket for
1454	daemon communications and to locate various resource files (such as	1652	daemon communications and to locate various resource files (such as
1455	C<.Xdefaults>)	1653	C<.Xdefaults>)
1456		1654
1457	=item B<XAPPLRESDIR>	1655	=item B<XAPPLRESDIR>
1458		1656
1459	Directory where various X resource files are being located.	1657	Directory where application-specific X resource files are located.
1460		1658
1461	=item B<XENVIRONMENT>	1659	=item B<XENVIRONMENT>
1462		1660
1463	If set and accessible, gives the name of a X resource file to be loaded by	1661	If set and accessible, gives the name of a X resource file to be loaded by
1464	@@RXVT_NAME@@.	1662	@@RXVT_NAME@@.
…		…
1469		1667
1470	=over 4	1668	=over 4
1471		1669
1472	=item B</usr/lib/X11/rgb.txt>	1670	=item B</usr/lib/X11/rgb.txt>
1473		1671
1474	Color names.	1672	Colour names.
1475		1673
1476	=back	1674	=back
1477		1675
1478	=head1 SEE ALSO	1676	=head1 SEE ALSO
1479		1677
…		…
1518	Project Coordinator (changes.txt 2.21a to 2.4.5)	1716	Project Coordinator (changes.txt 2.21a to 2.4.5)
1519		1717
1520	=item Geoff Wing L<< <gcw@pobox.com> >>	1718	=item Geoff Wing L<< <gcw@pobox.com> >>
1521		1719
1522	Rewrote screen display and text selection routines.	1720	Rewrote screen display and text selection routines.
1523		1721
1524	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1722	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1525		1723
1526	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1724	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1527		1725
1528	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1726	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
…		…
1530		1728
1531	Project Coordinator (Changes 1.0 -)	1729	Project Coordinator (Changes 1.0 -)
1532		1730
1533	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1731	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1534		1732
1535	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1733	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1536		1734
1537	=back	1735	=back
1538		1736

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.117 by root, Fri Jul 28 09:14:10 2006 UTC vs. Revision 1.214 by sf-exg, Sun May 13 21:34:29 2012 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.117 by root, Fri Jul 28 09:14:10 2006 UTC vs.
Revision 1.214 by sf-exg, Sun May 13 21:34:29 2012 UTC