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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.54 by root, Fri Feb 11 18:55:39 2005 UTC vs.
Revision 1.119 by root, Mon Aug 7 16:04:29 2006 UTC

…		…
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 devenagari. Don't expect pretty output when using these
32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33	fine, though. A somewhat difficult case are left-to-right scripts, such	33	fine, though. A somewhat difficult case are right-to-left scripts, such
34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35	belong into the application, not the terminal emulator (too many things --	35	belong into the application, not the terminal emulator (too many things --
36	such as cursor-movement while editing -- break otherwise), but that might	36	such as cursor-movement while editing -- break otherwise), but that might
37	change.	37	change.
38		38
39	If you are looking for a terminal that supports more exotic scripts, let	39	If you are looking for a terminal that supports more exotic scripts, let
40	me recommend C<mlterm>, which is a very userfriendly, lean and clean	40	me recommend C<mlterm>, which is a very user friendly, lean and clean
41	terminal emulator. In fact, the reason rxvt-unicode was born was solely	41	terminal emulator. In fact, the reason rxvt-unicode was born was solely
42	because the author couldn't get C<mlterm> to use one font for latin1 and	42	because the author couldn't get C<mlterm> to use one font for latin1 and
43	another for japanese.	43	another for japanese.
44		44
45	Therefore another design rationale was the use of multiple fonts to	45	Therefore another design rationale was the use of multiple fonts to
46	display characters: The idea of a single unicode font which many other	46	display characters: The idea of a single unicode font which many other
47	programs force onto it's users never made sense to me: You should be able	47	programs force onto its users never made sense to me: You should be able
48	to choose any font for any script freely.	48	to choose any font for any script freely.
49		49
50	Apart from that, rxvt-unicode is also much better internationalised than	50	Apart from that, rxvt-unicode is also much better internationalised than
51	it's predecessor, supports things such as XFT and ISO 14755 that are handy	51	its predecessor, supports things such as XFT and ISO 14755 that are handy
52	in i18n-environments, is faster, and has a lot less bugs than the original	52	in i18n-environments, is faster, and has a lot bugs less than the original
53	rxvt. This all in addition to dozens of other small improvements.	53	rxvt. This all in addition to dozens of other small improvements.
54		54
55	It is still faithfully following the original rxvt idea of being lean	55	It is still faithfully following the original rxvt idea of being lean
56	and nice on resources: for example, you can still configure rxvt-unicode	56	and nice on resources: for example, you can still configure rxvt-unicode
57	without most of it's features to get a lean binary. It also comes with	57	without most of its features to get a lean binary. It also comes with
58	a client/daemon pair that lets you open any number of terminal windows	58	a client/daemon pair that lets you open any number of terminal windows
59	from within a single process, which makes startup time very fast and	59	from within a single process, which makes startup time very fast and
60	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and	60	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
61	@@RXVT_NAME@@c(1) (client).	61	@@RXVT_NAME@@c(1) (client).
62		62
63	It also makes technical information about escape sequences (which have	63	It also makes technical information about escape sequences (which have
64	been extended) easier accessible: see @@RXVT_NAME@@(7) for technical	64	been extended) more accessible: see @@RXVT_NAME@@(7) for technical
65	reference documentation (escape sequences etc.).	65	reference documentation (escape sequences etc.).
66		66
67	=head1 OPTIONS	67	=head1 OPTIONS
68		68
69	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed	69	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
…		…
93		93
94	Attempt to open a window on the named X display (B<-d> still	94	Attempt to open a window on the named X display (B<-d> still
95	respected). In the absence of this option, the display specified by the	95	respected). In the absence of this option, the display specified by the
96	B<DISPLAY> environment variable is used.	96	B<DISPLAY> environment variable is used.
97		97
		98	=item B<-depth> I<bitdepth>
		99
		100	Compile I<xft>: Attempt to find a visual with the given bit depth;
		101	resource B<depth>.
		102
98	=item B<-geometry> I<geom>	103	=item B<-geometry> I<geom>
99		104
100	Window geometry (B<-g> still respected); resource B<geometry>.	105	Window geometry (B<-g> still respected); resource B<geometry>.
101		106
102	=item B<-rv>\|B<+rv>	107	=item B<-rv>\|B<+rv>
…		…
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; resource B<jumpScroll>.
109		114
110	=item B<-ip>\|B<+ip>	115	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>
111		116
112	Turn on/off inheriting parent window's pixmap. Alternative form is	117	Turn on/off inheriting parent window's pixmap. Alternative form is
113	B<-tr>; resource B<inheritPixmap>.	118	B<-tr>; resource B<inheritPixmap>.
114		119
		120	I<Please note that transparency of any kind if completely unsupported by
		121	the author. Don't bug him with installation questions! Read the FAQ (man 7
		122	@@RXVT_NAME@@)!>
		123
115	=item B<-fade> I<number>	124	=item B<-fade> I<number>
116		125
117	Fade the text by the given percentage when focus is lost. resource B<fading>.	126	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
		128	colour; resource B<fading>.
		129
		130	=item B<-fadecolor> I<colour>
		131
		132	Fade to this colour when fading is used (see B<-fade>). The default colour
		133	is opaque black. resource B<fadeColor>.
118		134
119	=item B<-tint> I<colour>	135	=item B<-tint> I<colour>
120		136
121	Tint the transparent background pixmap with the given colour when	137	Tint the transparent background pixmap with the given colour when
122	transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>	138	transparency is enabled with B<-tr> or B<-ip>. This only works for
123	option that can be used to brighten or darken the image in addition to	139	non-tiled backgrounds, currently. See also the B<-sh> option that can be
124	tinting it.	140	used to brighten or darken the image in addition to tinting it; resource
		141	I<tintColor>. Example:
		142
		143	@@RXVT_NAME@@ -tr -tint blue -sh 40
125		144
126	=item B<-sh>	145	=item B<-sh>
127		146
128	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	147	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
129	background image in addition to tinting it (i.e. B<-tint> must be	148	background image in addition to tinting it (i.e. B<-tint> must be
…		…
162	resource B<borderColor>.	181	resource B<borderColor>.
163		182
164	=item B<-fn> I<fontlist>	183	=item B<-fn> I<fontlist>
165		184
166	Select the fonts to be used. This is a comma separated list of font names	185	Select the fonts to be used. This is a comma separated list of font names
167	that are used in turn when trying to display Unicode characters. The	186	that are checked in order when trying to find glyphs for characters. The
168	first font defines the cell size for characters; other fonts might be	187	first font defines the cell size for characters; other fonts might be
169	smaller, but not (in general) larger. A (hopefully) reasonable default	188	smaller, but not (in general) larger. A (hopefully) reasonable default
170	font list is always appended to it. See resource B<font> for more details.	189	font list is always appended to it. See resource B<font> for more details.
171		190
172	In short, to specify an X11 core font, just specify it's name or prefix it	191	In short, to specify an X11 core font, just specify its name or prefix it
173	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,	192	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
174	e.g.:	193	e.g.:
175		194
176	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	195	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
177	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	196	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
179	See also the question "How does rxvt-unicode choose fonts?" in the FAQ	198	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
180	section of @@RXVT_NAME@@(7).	199	section of @@RXVT_NAME@@(7).
181		200
182	=item B<-fb> I<fontlist>	201	=item B<-fb> I<fontlist>
183		202
184	Compile font-styles: The bold font list to use when bold characters are to	203	Compile I<font-styles>: The bold font list to use when B<bold> characters
185	be printed. See resource B<boldFont> for details.	204	are to be printed. See resource B<boldFont> for details.
186		205
187	=item B<-fi> I<fontlist>	206	=item B<-fi> I<fontlist>
188		207
189	Compile font-styles: The italic font list to use when bold characters are to	208	Compile I<font-styles>: The italic font list to use when I<italic>
190	be printed. See resource B<italicFont> for details.	209	characters are to be printed. See resource B<italicFont> for details.
191		210
192	=item B<-fbi> I<fontlist>	211	=item B<-fbi> I<fontlist>
193		212
194	Compile font-styles: The bold italic font list to use when bold characters are to	213	Compile I<font-styles>: The bold italic font list to use when B<< I<bold
195	be printed. See resource B<boldItalicFont> for details.	214	italic> >> characters are to be printed. See resource B<boldItalicFont>
		215	for details.
		216
		217	=item B<-is>\|B<+is>
		218
		219	Compile I<font-styles>: Bold/Italic font styles imply high intensity
		220	foreground/background (default). See resource B<intensityStyles> for
		221	details.
196		222
197	=item B<-name> I<name>	223	=item B<-name> I<name>
198		224
199	Specify the application name under which resources are to be obtained,	225	Specify the application name under which resources are to be obtained,
200	rather than the default executable file name. Name should not contain	226	rather than the default executable file name. Name should not contain
…		…
238		264
239	Put scrollbar on right/left; resource B<scrollBar_right>.	265	Put scrollbar on right/left; resource B<scrollBar_right>.
240		266
241	=item B<-st>\|B<+st>	267	=item B<-st>\|B<+st>
242		268
243	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	269	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
244	resource B<scrollBar_floating>.	270	resource B<scrollBar_floating>.
245		271
246	=item B<-ptab>\|B<+ptab>	272	=item B<-ptab>\|B<+ptab>
247		273
248	If enabled (default), "Horizontal Tab" characters are being stored as	274	If enabled (default), "Horizontal Tab" characters are being stored as
…		…
279	=item B<-bl>	305	=item B<-bl>
280		306
281	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	307	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
282	if honoured by the WM, the rxvt-unicode window will not have window	308	if honoured by the WM, the rxvt-unicode window will not have window
283	decorations; resource B<borderLess>.	309	decorations; resource B<borderLess>.
		310
		311	=item B<-override-redirect>
		312
		313	Compile I<frills>: Sets override-redirect on the window; resource
		314	B<override-redirect>.
		315
		316	=item B<-sbg>
		317
		318	Compile I<frills>: Disable the usage of the built-in block graphics/line
		319	drawing characters and just rely on what the specified fonts provide. Use
		320	this if you have a good font and want to use its block graphic glyphs;
		321	resource B<skipBuiltinGlyphs>.
284		322
285	=item B<-lsp> I<number>	323	=item B<-lsp> I<number>
286		324
287	Compile I<frills>: Lines (pixel height) to insert between each row of	325	Compile I<frills>: Lines (pixel height) to insert between each row of
288	the display. Useful to work around font rendering problems; resource	326	the display. Useful to work around font rendering problems; resource
…		…
303	given on the command line. If this option is used, it must be the last	341	given on the command line. If this option is used, it must be the last
304	on the command-line. If there is no B<-e> option then the default is to	342	on the command-line. If there is no B<-e> option then the default is to
305	run the program specified by the B<SHELL> environment variable or,	343	run the program specified by the B<SHELL> environment variable or,
306	failing that, I<sh(1)>.	344	failing that, I<sh(1)>.
307		345
		346	Please note that you must specify a program with arguments. If you want to
		347	run shell commands, you have to specify the shell, like this:
		348
		349	@@RXVT_NAME@@ -e sh -c "shell commands"
		350
308	=item B<-title> I<text>	351	=item B<-title> I<text>
309		352
310	Window title (B<-T> still respected); the default title is the basename	353	Window title (B<-T> still respected); the default title is the basename
311	of the program specified after the B<-e> option, if any, otherwise the	354	of the program specified after the B<-e> option, if any, otherwise the
312	application name; resource B<title>.	355	application name; resource B<title>.
…		…
368	=item B<-ssr>\|B<+ssr>	411	=item B<-ssr>\|B<+ssr>
369		412
370	Turn on/off secondary screen scroll (default enabled); resource	413	Turn on/off secondary screen scroll (default enabled); resource
371	B<secondaryScroll>.	414	B<secondaryScroll>.
372		415
		416	=item B<-hold>\|B<+hold>
		417
		418	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		419	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
		421	user; resource B<hold>.
		422
373	=item B<-keysym.>I<sym>: I<string>	423	=item B<-keysym.>I<sym> I<string>
374		424
375	Remap a key symbol. See resource B<keysym>.	425	Remap a key symbol. See resource B<keysym>.
376		426
		427	=item B<-embed> I<windowid>
		428
		429	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
		430	which enables applications to easily embed a terminal.
		431
		432	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
		433	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
		434	quite a bit, so don't expect it to keep some specific state. It's best to
		435	create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
		436
		437	The window will not be destroyed when @@RXVT_NAME@@ exits.
		438
		439	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
		441	can use file descriptors to communicate with the programs within the
		442	terminal. This works regardless of whether the C<-embed> option was used or
		443	not.
		444
		445	Here is a short Gtk2-perl snippet that illustrates how this option can be
		446	used (a longer example is in F<doc/embed>):
		447
		448	my $rxvt = new Gtk2::Socket;
		449	$rxvt->signal_connect_after (realize => sub {
		450	my $xid = $_[0]->window->get_xid;
		451	system "@@RXVT_NAME@@ -embed $xid &";
		452	});
		453
		454	=item B<-pty-fd> I<file descriptor>
		455
		456	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
		457	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
		459	without having to run a program within it.
		460
		461	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
		463	yourself if you want that.
		464
		465	As an extremely special case, specifying C<-1> will completely suppress
		466	pty/tty operations.
		467
		468	Here is a example in perl that illustrates how this option can be used (a
		469	longer example is in F<doc/pty-fd>):
		470
		471	use IO::Pty;
		472	use Fcntl;
		473
		474	my $pty = new IO::Pty;
		475	fcntl $pty, F_SETFD, 0; # clear close-on-exec
		476	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		477	close $pty;
		478
		479	# now communicate with rxvt
		480	my $slave = $pty->slave;
		481	while (<$slave>) { print $slave "got <$_>\n" }
		482
377	=item B<-xrm> I<resourcestring>	483	=item B<-pe> I<string>
378		484
379	No effect on rxvt-unicode. Simply passes through an argument to be made	485	Comma-separated list of perl extension scripts to use (or not to use) in
380	available in the instance's argument list. Appears in I<WM_COMMAND> in	486	this terminal instance. See resource B<perl-ext> for details.
381	some window managers.
382		487
383	=back	488	=back
384		489
385	=head1 RESOURCES (available also as long-options)	490	=head1 RESOURCES (available also as long-options)
386		491
387	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	492	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
388	options) compiled into your version.	493	options) compiled into your version.
389		494
390	There are two different methods that @@RXVT_NAME@@ can use to get the	495	You can set and change the resources using X11 tools like B<xrdb>. Many
391	Xresource data: using the X libraries (Xrm*-functions) or internal	496	distribution do also load settings from the B<~/.Xresources> file when X
392	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	497	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
393	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	498	with later settings overwriting earlier ones:
394	resources using X11 tools like B<xrdb>. Many distribution do also load
395	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
396	will consult the following files/resources in order, with later settings
397	overwriting earlier ones:
398		499
399	1. system-wide app-defaults file, either locale-dependent OR global	500	1. system-wide app-defaults file, either locale-dependent OR global
400	2. app-defaults file in $XAPPLRESDIR	501	2. app-defaults file in $XAPPLRESDIR
401	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	502	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
402	4. SCREEN_RESOURCES for the current screen	503	4. SCREEN_RESOURCES for the current screen
403	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	504	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
404		505
405	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
406	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
407	set in XAPPLOADDIR/URxvt (compile-time defined: usually
408	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
409	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
410	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	506	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
411	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows	507	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
412	resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be	508	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
413	easily configured, while the class name B<URxvt> allows resources	509	configured, while the class name B<URxvt> allows resources unique to
414	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	510	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
415	shared between different B<@@RXVT_NAME@@> configurations. If no	511	configurations. If no resources are specified, suitable defaults will
416	resources are specified, suitable defaults will be used. Command-line	512	be used. Command-line arguments can be used to override resource
417	arguments can be used to override resource settings. The following	513	settings. The following resources are supported (you might want to
418	resources are allowed:	514	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		515	extensions not documented here):
419		516
420	=over 4	517	=over 4
		518
		519	=item B<depth:> I<bitdepth>
		520
		521	Compile I<xft>: Attempt to find a visual with the given bit depth;
		522	option B<-depth>.
421		523
422	=item B<geometry:> I<geom>	524	=item B<geometry:> I<geom>
423		525
424	Create the window with the specified X window geometry [default 80x24];	526	Create the window with the specified X window geometry [default 80x24];
425	option B<-geometry>.	527	option B<-geometry>.
…		…
499		601
500	B<True>: make the background inherit the parent windows' pixmap, giving	602	B<True>: make the background inherit the parent windows' pixmap, giving
501	artificial transparency. B<False>: do not inherit the parent windows'	603	artificial transparency. B<False>: do not inherit the parent windows'
502	pixmap.	604	pixmap.
503		605
		606	I<Please note that transparency of any kind if completely unsupported by
		607	the author. Don't bug him with installation questions!>
		608
504	=item B<fading:> I<number>	609	=item B<fading:> I<number>
505		610
506	Fade the text by the given percentage when focus is lost.	611	Fade the text by the given percentage when focus is lost; option B<-fade>.
		612
		613	=item B<fadeColor:> I<colour>
		614
		615	Fade to this colour, when fading is used (see B<fading:>). The default
		616	colour is black; option B<-fadecolor>.
507		617
508	=item B<tintColor:> I<colour>	618	=item B<tintColor:> I<colour>
509		619
510	Tint the transparent background pixmap with the given colour.	620	Tint the transparent background pixmap with the given colour; option
		621	B<-tint>.
511		622
512	=item B<shading:> I<number>	623	=item B<shading:> I<number>
513		624
514	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	625	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
515	image in addition to tinting it.	626	image in addition to tinting it.
…		…
519	Use the specified colour for the scrollbar [default #B2B2B2].	630	Use the specified colour for the scrollbar [default #B2B2B2].
520		631
521	=item B<troughColor:> I<colour>	632	=item B<troughColor:> I<colour>
522		633
523	Use the specified colour for the scrollbar's trough area [default	634	Use the specified colour for the scrollbar's trough area [default
524	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	635	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
525		636
526	=item B<borderColor:> I<colour>	637	=item B<borderColor:> I<colour>
527		638
528	The colour of the border around the text area and between the scrollbar	639	The colour of the border around the text area and between the scrollbar
529	and the text.	640	and the text.
…		…
538	of 1 displays the image without any scaling. A scale of 2 to 9	649	of 1 displays the image without any scaling. A scale of 2 to 9
539	specifies an integer number of images in that direction. No image will	650	specifies an integer number of images in that direction. No image will
540	be magnified beyond 10 times its original size. The maximum permitted	651	be magnified beyond 10 times its original size. The maximum permitted
541	scale is 1000. [default 0x0+50+50]	652	scale is 1000. [default 0x0+50+50]
542		653
543	=item B<menu:> I<file[;tag]>
544
545	Read in the specified menu file (note the `.menu' extension is
546	optional) and also optionally specify a starting tag to find. See the
547	reference documentation for details on the syntax for the menuBar.
548
549	=item B<path:> I<path>	654	=item B<path:> I<path>
550		655
551	Specify the colon-delimited search path for finding files (XPM and	656	Specify the colon-delimited search path for finding XPM files.
552	menus), in addition to the paths specified by the B<RXVTPATH> and
553	B<PATH> environment variables.
554		657
555	=item B<font:> I<fontlist>	658	=item B<font:> I<fontlist>
556		659
557	Select the fonts to be used. This is a comma separated list of font	660	Select the fonts to be used. This is a comma separated list of font names
558	names that are used in turn when trying to display Unicode characters.	661	that are checked in order when trying to find glyphs for characters. The
559	The first font defines the cell size for characters; other fonts might	662	first font defines the cell size for characters; other fonts might be
560	be smaller, but not larger. A reasonable default font list is always	663	smaller, but not (in general) larger. A (hopefully) reasonable default
561	appended to it. option B<-fn>.	664	font list is always appended to it; option B<-fn>.
562		665
563	Each font can either be a standard X11 core font (XLFD) name, with	666	Each font can either be a standard X11 core font (XLFD) name, with
564	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.	667	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
565		668
566	In addition, each font can be prefixed with additional hints and	669	In addition, each font can be prefixed with additional hints and
…		…
568	hint currently is C<codeset=codeset-name>, and this is only used for Xft	671	hint currently is C<codeset=codeset-name>, and this is only used for Xft
569	fonts.	672	fonts.
570		673
571	For example, this font resource	674	For example, this font resource
572		675
573	URxvt*font: 9x15bold,\	676	URxvt.font: 9x15bold,\
574	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	677	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
575	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \	678	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
576	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	679	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
577	xft:Code2000:antialias=false	680	xft:Code2000:antialias=false
578		681
…		…
612	not possible, replacement fonts of the desired shape will be tried.	715	not possible, replacement fonts of the desired shape will be tried.
613		716
614	If set, but empty, then this specific style is disabled and the normal	717	If set, but empty, then this specific style is disabled and the normal
615	text font will being used for the given style.	718	text font will being used for the given style.
616		719
		720	=item B<intensityStyles:> I<boolean>
		721
		722	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
		724	intensity foreground/background colours. Disabling this option (B<False>,
		725	option B<+is>) disables this behaviour, the high intensity colours are not
		726	reachable.
		727
617	=item B<selectstyle:> I<mode>	728	=item B<selectstyle:> I<mode>
618		729
619	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	730	Set mouse selection style to B<old> which is 2.20, B<oldword> which is
620	xterm style with 2.20 old word selection, or anything else which gives	731	xterm style with 2.20 old word selection, or anything else which gives
621	xterm style selection.	732	xterm style selection.
622		733
623	=item B<scrollstyle:> I<mode>	734	=item B<scrollstyle:> I<mode>
624		735
625	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	736	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
626	the author's favourite..	737	the author's favourite.
627		738
628	=item B<title:> I<string>	739	=item B<title:> I<string>
629		740
630	Set window title string, the default title is the command-line	741	Set window title string, the default title is the command-line
631	specified after the B<-e> option, if any, otherwise the application	742	specified after the B<-e> option, if any, otherwise the application
…		…
663		774
664	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	775	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
665	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or	776	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
666	B<Shift-Print> to include the scrollback as well.	777	B<Shift-Print> to include the scrollback as well.
667		778
		779	The string will be interpreted as if typed into the shell as-is.
		780
		781	Example:
		782
		783	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		784
		785	This creates a new file in your home directory with the screen contents
		786	every time you hit C<Print>.
		787
668	=item B<scrollBar:> I<boolean>	788	=item B<scrollBar:> I<boolean>
669		789
670	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	790	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
671	disable the scrollbar; option B<+sb>.	791	disable the scrollbar; option B<+sb>.
672		792
…		…
692	B<+si>.	812	B<+si>.
693		813
694	=item B<scrollWithBuffer:> I<boolean>	814	=item B<scrollWithBuffer:> I<boolean>
695		815
696	B<True>: scroll with scrollback buffer when tty receives new lines (and	816	B<True>: scroll with scrollback buffer when tty receives new lines (and
697	B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll	817	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
698	with scrollback buffer when tty recieves new lines; option B<-sw>.	818	with scrollback buffer when tty receives new lines; option B<+sw>.
699		819
700	=item B<scrollTtyKeypress:> I<boolean>	820	=item B<scrollTtyKeypress:> I<boolean>
701		821
702	B<True>: scroll to bottom when a non-special key is pressed. Special keys	822	B<True>: scroll to bottom when a non-special key is pressed. Special keys
703	are those which are intercepted by rxvt-unicode for special handling and	823	are those which are intercepted by rxvt-unicode for special handling and
…		…
722	=item B<borderLess:> I<boolean>	842	=item B<borderLess:> I<boolean>
723		843
724	Set MWM hints to request a borderless window, i.e. if honoured by the	844	Set MWM hints to request a borderless window, i.e. if honoured by the
725	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.	845	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
726		846
		847	=item B<skipBuiltinGlyphs:> I<boolean>
		848
		849	Compile I<frills>: Disable the usage of the built-in block graphics/line
		850	drawing characters and just rely on what the specified fonts provide. Use
		851	this if you have a good font and want to use its block graphic glyphs;
		852	option B<-sbg>.
		853
727	=item B<termName:> I<termname>	854	=item B<termName:> I<termname>
728		855
729	Specifies the terminal type name to be set in the B<TERM> environment	856	Specifies the terminal type name to be set in the B<TERM> environment
730	variable; option B<-tn>.	857	variable; option B<-tn>.
731		858
…		…
768		895
769	Mouse pointer background colour.	896	Mouse pointer background colour.
770		897
771	=item B<pointerBlankDelay:> I<number>	898	=item B<pointerBlankDelay:> I<number>
772		899
773	Specifies number of seconds before blanking the pointer [default 2].	900	Specifies number of seconds before blanking the pointer [default 2]. Use a
		901	large number (e.g. C<987654321>) to effectively disable the timeout.
774		902
775	=item B<backspacekey:> I<string>	903	=item B<backspacekey:> I<string>
776		904
777	The string to send when the backspace key is pressed. If set to B<DEC>	905	The string to send when the backspace key is pressed. If set to B<DEC>
778	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	906	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
…		…
785	pressed. If unset it will send the sequence traditionally associated	913	pressed. If unset it will send the sequence traditionally associated
786	with the B<Execute> key.	914	with the B<Execute> key.
787		915
788	=item B<cutchars:> I<string>	916	=item B<cutchars:> I<string>
789		917
790	The characters used as delimiters for double-click word selection. The	918	The characters used as delimiters for double-click word selection
791	built-in default:	919	(whitespace delimiting is added automatically if resource is given).
		920
		921	When the selection extension is in use (the default if compiled in, see
		922	the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters
		923	will be created (if the resource exists, otherwise, no regex will be
		924	created). In this mode, characters outside ISO-8859-1 can be used.
		925
		926	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:
792		928
793	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	929	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>
794		930
795	=item B<preeditType:> I<style>	931	=item B<preeditType:> I<style>
796		932
…		…
803	=item B<imLocale:> I<name>	939	=item B<imLocale:> I<name>
804		940
805	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.	941	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
806	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the	942	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
807	input extension to be able to input japanese characters while staying in	943	input extension to be able to input japanese characters while staying in
808	another locale. option B<-imlocale>.	944	another locale; option B<-imlocale>.
809		945
810	=item B<imFont:> I<fontset>	946	=item B<imFont:> I<fontset>
811		947
812	Specify the font-set used for XIM styles C<OverTheSpot> or	948	Specify the font-set used for XIM styles C<OverTheSpot> or
813	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated	949	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
…		…
818		954
819	=item B<tripleclickwords:> I<boolean>	955	=item B<tripleclickwords:> I<boolean>
820		956
821	Change the meaning of triple-click selection with the left mouse	957	Change the meaning of triple-click selection with the left mouse
822	button. Instead of selecting a full line it will extend the selection to	958	button. Instead of selecting a full line it will extend the selection to
823	the end of the logical line only. option B<-tcw>.	959	the end of the logical line only; option B<-tcw>.
824		960
825	=item B<insecure:> I<boolean>	961	=item B<insecure:> I<boolean>
826		962
827	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	963	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
828	echo arbitrary strings like the icon name or the locale. This could be	964	echo arbitrary strings like the icon name or the locale. This could be
829	abused if somebody gets 8-bit-clean access to your display, whether	965	abused if somebody gets 8-bit-clean access to your display, whether
830	throuh a mail client displaying mail bodies unfiltered or though	966	through a mail client displaying mail bodies unfiltered or through
831	write(1). Therefore, these sequences are disabled by default. (Note	967	write(1) or any other means. Therefore, these sequences are disabled by
832	that other terminals, including xterm, have these sequences	968	default. (Note that many other terminals, including xterm, have these
833	enabled by default). You can enable them by setting this boolean	969	sequences enabled by default, which doesn't make it safer, though).
834	resource or specifying B<-insecure> as an option. At the moment, this	970
835	enabled display-answer, locale, findfont, icon label and window title	971	You can enable them by setting this boolean resource or specifying
836	requests as well as dynamic menubar dispatch.	972	B<-insecure> as an option. At the moment, this enables display-answer,
		973	locale, findfont, icon label and window title requests.
837		974
838	=item B<modifier:> I<modifier>	975	=item B<modifier:> I<modifier>
839		976
840	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	977	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
841	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	978	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
845		982
846	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	983	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
847	character is passed through. It may contain escape values as described	984	character is passed through. It may contain escape values as described
848	in the entry on B<keysym> following.	985	in the entry on B<keysym> following.
849		986
850	=item B<secondaryScreen:> I<bool>	987	=item B<secondaryScreen:> I<boolean>
851		988
852	Turn on/off secondary screen (default enabled).	989	Turn on/off secondary screen (default enabled).
853		990
854	=item B<secondaryScroll:> I<bool>	991	=item B<secondaryScroll:> I<boolean>
855		992
856	Turn on/off secondary screen scroll (default enabled). If the this	993	Turn on/off secondary screen scroll (default enabled). If the this
857	option is enabled, scrolls on the secondary screen will change the	994	option is enabled, scrolls on the secondary screen will change the
858	scrollback buffer and switching to/from the secondary screen will	995	scrollback buffer and switching to/from the secondary screen will
859	instead scroll the screen up.	996	instead scroll the screen up.
		997
		998	=item B<hold>: I<boolean>
		999
		1000	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		1001	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
		1003	user.
860		1004
861	=item B<keysym.>I<sym>: I<string>	1005	=item B<keysym.>I<sym>: I<string>
862		1006
863	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1007	Compile I<frills>: Associate I<string> with keysym I<sym>. The
864	intervening resource name B<keysym.> cannot be omitted.	1008	intervening resource name B<keysym.> cannot be omitted.
…		…
884	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1028	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
885	C<\000>: octal number) or verbatim control characters (C<^?>: delete,	1029	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
886	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it	1030	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
887	can start or end with whitespace.	1031	can start or end with whitespace.
888		1032
889	Please note that you need to double the C<\> when using	1033	Please note that you need to double the C<\> in resource files, as
890	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can	1034	Xlib itself does its own de-escaping (you can use C<\033> instead of
891	use C<\033> instead of C<\e> (and so on), which will work with both Xt and	1035	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
892	@@RXVT_NAME@@'s own processing).	1036	processing).
893		1037
894	You can define a range of keysyms in one shot by providing a I<string>	1038	You can define a range of keysyms in one shot by providing a I<string>
895	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1039	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
896	should be a character not used by the strings.	1040	should be a character not used by the strings.
897		1041
898	Its usage can be demonstrated by an example:	1042	Its usage can be demonstrated by an example:
899		1043
900	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1044	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
…		…
910	example the following means "change the current locale to C<zh_CN.GBK>	1054	example the following means "change the current locale to C<zh_CN.GBK>
911	when Control-Meta-c is being pressed":	1055	when Control-Meta-c is being pressed":
912		1056
913	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1057	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
914		1058
		1059	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)
		1061	manpage. For example, the F<selection> extension (activated via
		1062	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1063
		1064	URxvt.keysym.M-C-c: perl:selection:rot13
		1065
		1066	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
		1068	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
		1070	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		1071	mappings themselves.
		1072
		1073	Unfortunately, this will override built-in key mappings. For example
		1074	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		1075	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		1076	user-defined keymap using the C<builtin:> replacement:
		1077
		1078	URxvt.keysym.Insert: <my insert key sequence>
		1079	URxvt.keysym.S-Insert: builtin:
		1080
		1081	The first line defines a mapping for C<Insert> and I<any> combination
		1082	of modifiers. The second line re-establishes the default mapping for
		1083	C<Shift-Insert>.
		1084
915	The following example will map Control-Meta-1 and Control-Meta-2 to	1085	The following example will map Control-Meta-1 and Control-Meta-2 to
916	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited	1086	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
917	font-switching at runtime:	1087	font-switching at runtime:
918		1088
919	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1089	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
…		…
922	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1092	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
923	info):	1093	info):
924		1094
925	URxvt.keysym.M-C-3: command:\033[8;25;80t	1095	URxvt.keysym.M-C-3: command:\033[8;25;80t
926	URxvt.keysym.M-C-4: command:\033[8;48;110t	1096	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1097
		1098	=item B<perl-ext-common>: I<string>
		1099
		1100	=item B<perl-ext>: I<string>
		1101
		1102	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1103	use in this terminal instance; option B<-pe>.
		1104
		1105	Extension names can be prefixed with a C<-> sign to prohibit using
		1106	them. This can be useful to selectively disable some extensions loaded
		1107	by default, or specified via the C<perl-ext-common> resource. For
		1108	example, C<default,-selection> will use all the default extension except
		1109	C<selection>.
		1110
		1111	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
		1113	searchable scrollback to Alt/Meta-s). Mentioning the same extension
		1114	multiple times with different arguments will pass multiple arguments to
		1115	the extension.
		1116
		1117	Each extension is looked up in the library directories, loaded if
		1118	necessary, and bound to the current terminal instance.
		1119
		1120	If both of these resources are the empty string, then the perl
		1121	interpreter will not be initialized. The idea behind two options is that
		1122	B<perl-ext-common> will be used for extensions that should be available to
		1123	all instances, while B<perl-ext> is used for specific instances.
		1124
		1125	=item B<perl-eval>: I<string>
		1126
		1127	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
		1129	will be ignored when running setuid/setgid.
		1130
		1131	=item B<perl-lib>: I<path>
		1132
		1133	Colon-separated list of additional directories that hold extension
		1134	scripts. When looking for extensions specified by the C<perl> resource,
		1135	@@RXVT_NAME@@ will first look in these directories and then in
		1136	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
		1137	will be ignored when running setuid/setgid.
		1138
		1139	See the @@RXVT_NAME@@perl(3) manpage.
		1140
		1141	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1142
		1143	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1144	details.
		1145
		1146	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1147
		1148	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1149	for details.
		1150
		1151	=item B<searchable-scrollback:> I<keysym>
		1152
		1153	Sets the hotkey that starts the incremental scrollback buffer search
		1154	(default: C<M-s>).
		1155
		1156	=item B<urlLauncher>: I<string>
		1157
		1158	Specifies the program to be started with a URL argument. Used by the
		1159	C<selection-popup> and C<mark-urls> perl extensions.
		1160
		1161	=item B<transient-for>: I<windowid>
		1162
		1163	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1164
		1165	=item B<override-redirect>: I<boolean>
		1166
		1167	Compile I<frills>: Sets override-redirect for the terminal window, making
		1168	it almost invisible to window managers; option B<-override-redirect>.
927		1169
928	=back	1170	=back
929		1171
930	=head1 THE SCROLLBAR	1172	=head1 THE SCROLLBAR
931		1173
…		…
966	to select a word; Left triple-click to select the entire logical line	1208	to select a word; Left triple-click to select the entire logical line
967	(which can span multiple screen lines), unless modified by resource	1209	(which can span multiple screen lines), unless modified by resource
968	B<tripleclickwords>.	1210	B<tripleclickwords>.
969		1211
970	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1212	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
971	(Compile: I<frills>) will create a rectangular selection instead of a normal	1213	(Compile: I<frills>) will create a rectangular selection instead of a
972	one.	1214	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
		1216	the selection.
973		1217
974	=item B<Insertion>:	1218	=item B<Insertion>:
975		1219
976	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1220	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
977	an B<@@RXVT_NAME@@> window causes the current text selection to be	1221	window causes the value of the PRIMARY selection (or CLIPBOARD with the
978	inserted as if it had been typed on the keyboard.	1222	Meta modifier) to be inserted as if it had been typed on the keyboard.
		1223
		1224	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1225	inserted too.
979		1226
980	=back	1227	=back
981		1228
982	=head1 CHANGING FONTS	1229	=head1 CHANGING FONTS
983		1230
984	Changing fonts (or font sizes, respectively) via the keypad is not yet	1231	Changing fonts (or font sizes, respectively) via the keypad is not yet
985	supported in rxvt-unicode. Bug me if you need this.	1232	supported in rxvt-unicode. Bug me if you need this.
986		1233
987	You can, however, switch fonts at runtime using escape sequences (and	1234	You can, however, switch fonts at runtime using escape sequences, e.g.:
988	therefore using the menubar), e.g.:
989		1235
990	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1236	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1237
		1238	You can use keyboard shortcuts, too:
		1239
		1240	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1241	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
991		1242
992	rxvt-unicode will automatically re-apply these fonts to the output so far.	1243	rxvt-unicode will automatically re-apply these fonts to the output so far.
993		1244
994	=head1 ISO 14755 SUPPORT	1245	=head1 ISO 14755 SUPPORT
995		1246
…		…
1023	This mode lets you input characters representing the keycap symbols of	1274	This mode lets you input characters representing the keycap symbols of
1024	your keyboard, if representable in the current locale encoding.	1275	your keyboard, if representable in the current locale encoding.
1025		1276
1026	Start by pressing C<Control> and C<Shift> together, then releasing	1277	Start by pressing C<Control> and C<Shift> together, then releasing
1027	them. The next special key (cursor keys, home etc.) you enter will not	1278	them. The next special key (cursor keys, home etc.) you enter will not
1028	invoke it's usual function but instead will insert the corresponding	1279	invoke its usual function but instead will insert the corresponding
1029	keycap symbol. The symbol will only be entered when the key has been	1280	keycap symbol. The symbol will only be entered when the key has been
1030	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1281	released, otherwise pressing e.g. C<Shift> would enter the symbol for
1031	C<ISO Level 2 Switch>, although your intention might have been to enter a	1282	C<ISO Level 2 Switch>, although your intention might have been to enter a
1032	reverse tab (Shift-Tab).	1283	reverse tab (Shift-Tab).
1033		1284
…		…
1066	=head1 COLORS AND GRAPHICS	1317	=head1 COLORS AND GRAPHICS
1067		1318
1068	In addition to the default foreground and background colours,	1319	In addition to the default foreground and background colours,
1069	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1320	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1070	high-intensity bold/blink versions of the same). Here is a list of the	1321	high-intensity bold/blink versions of the same). Here is a list of the
1071	colours with their B<rgb.txt> names.	1322	colours with their names.
1072		1323
1073	=begin table	1324	=begin table
1074		1325
1075	B<color0> (black) = Black	1326	B<color0> (black) = Black
1076	B<color1> (red) = Red3	1327	B<color1> (red) = Red3
…		…
1096	It is also possible to specify the colour values of B<foreground>,	1347	It is also possible to specify the colour values of B<foreground>,
1097	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1348	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1098	a number 0-15, as a convenient shorthand to reference the colour name of	1349	a number 0-15, as a convenient shorthand to reference the colour name of
1099	color0-color15.	1350	color0-color15.
1100		1351
		1352	In addition to the colours defined above, @@RXVT_NAME@@ offers an
		1353	additional 72 colours. The first 64 of those (with indices 16 to 79)
		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
		1357	Together, all those colours implement the 88 colour xterm colours. Only
		1358	the first 16 can be changed using resources currently, the rest can only
		1359	be changed via command sequences ("escape codes").
		1360
1101	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1361	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1102	always swapping the foreground/background colours. This is in contrast to	1362	always swapping the foreground/background colours. This is in contrast to
1103	I<xterm>(1) where the colours are only swapped if they have not otherwise	1363	I<xterm>(1) where the colours are only swapped if they have not otherwise
1104	been specified. For example,	1364	been specified. For example,
1105		1365
…		…
1110	would yield White on Black, while on I<xterm>(1) it would yield Black	1370	would yield White on Black, while on I<xterm>(1) it would yield Black
1111	on White.	1371	on White.
1112		1372
1113	=back	1373	=back
1114		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
1115	=head1 ENVIRONMENT	1397	=head1 ENVIRONMENT
1116		1398
1117	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1399	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1118		1400
1119	=over 4	1401	=over 4
1120		1402
1121	=item B<TERM>	1403	=item B<TERM>
1122		1404
1123	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1405	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1124	resources or on the commandline.	1406	resources or on the command line.
1125		1407
1126	=item B<COLORTERM>	1408	=item B<COLORTERM>
1127		1409
1128	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1410	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1129	compiled with XPM support, and optionally with the added extension	1411	compiled with XPM support, and optionally with the added extension
1130	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1412	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1131		1413
1132	=item B<COLORFGBG>	1414	=item B<COLORFGBG>
1133		1415
…		…
1151	C<--with-terminfo=PATH>.	1433	C<--with-terminfo=PATH>.
1152		1434
1153	=item B<DISPLAY>	1435	=item B<DISPLAY>
1154		1436
1155	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1437	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1156	display in it's child processes.	1438	display in its child processes.
1157		1439
1158	=item B<SHELL>	1440	=item B<SHELL>
1159		1441
1160	The shell to be used for command execution, defaults to C</bin/sh>.	1442	The shell to be used for command execution, defaults to C</bin/sh>.
1161
1162	=item B<RXVTPATH>
1163
1164	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1165	files.
1166
1167	=item B<PATH>
1168
1169	Used in the same way as C<RXVTPATH>.
1170		1443
1171	=item B<RXVT_SOCKET>	1444	=item B<RXVT_SOCKET>
1172		1445
1173	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1446	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1174	@@RXVT_NAME@@d(1).	1447	@@RXVT_NAME@@d(1).
1175		1448
1176	Default C<< $HOME/.rxvt-unicode-<nodename >>.	1449	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1177		1450
1178	=item B<HOME>	1451	=item B<HOME>
1179		1452
1180	Used to locate the default directory for the unix domain socket for	1453	Used to locate the default directory for the unix domain socket for
1181	daemon communications and to locate various resource files (such as	1454	daemon communications and to locate various resource files (such as
…		…
1202		1475
1203	=back	1476	=back
1204		1477
1205	=head1 SEE ALSO	1478	=head1 SEE ALSO
1206		1479
1207	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1480	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1208
1209	=head1 BUGS
1210
1211	Check the BUGS file for an up-to-date list.
1212
1213	Cursor change support is not yet implemented.
1214
1215	Click-and-drag doesn't work with X11 mouse report overriding.
1216		1481
1217	=head1 CURRENT PROJECT COORDINATOR	1482	=head1 CURRENT PROJECT COORDINATOR
1218		1483
1219	=over 4	1484	=over 4
1220		1485
1221	=item Project Coordinator	1486	=item Project Coordinator
1222		1487
1223	@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@>	1488	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1224		1489
1225	L<@@RXVT_WEBPAGE@@>	1490	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1226		1491
1227	=back	1492	=back
1228		1493
1229	=head1 AUTHORS	1494	=head1 AUTHORS
1230		1495
…		…
1252		1517
1253	Project Coordinator (changes.txt 2.21a to 2.4.5)	1518	Project Coordinator (changes.txt 2.21a to 2.4.5)
1254		1519
1255	=item Geoff Wing L<< <gcw@pobox.com> >>	1520	=item Geoff Wing L<< <gcw@pobox.com> >>
1256		1521
1257	Rewrote screen display and text selection routines. Project Coordinator	1522	Rewrote screen display and text selection routines.
		1523
1258	(changes.txt 2.4.6 - rxvt-unicode)	1524	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1259		1525
1260	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>	1526	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1261		1527
1262	Forked rxvt-unicode, rewrote most of the display code and internal	1528	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1263	character handling to store text in unicode, improve xterm	1529	extension, random hacks, numerous bugfixes and extensions.
1264	compatibility and apply numerous other bugfixes and extensions.
1265		1530
1266	Project Coordinator (Changes 1.0 -)	1531	Project Coordinator (Changes 1.0 -)
1267		1532
		1533	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1534
		1535	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
		1536
1268	=back	1537	=back
1269		1538

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.54 by root, Fri Feb 11 18:55:39 2005 UTC vs. Revision 1.119 by root, Mon Aug 7 16:04:29 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.54 by root, Fri Feb 11 18:55:39 2005 UTC vs.
Revision 1.119 by root, Mon Aug 7 16:04:29 2006 UTC