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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.59 by root, Thu Feb 17 15:07:48 2005 UTC vs.
Revision 1.116 by root, Mon Jul 10 04:03:09 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
…		…
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!>
		122
115	=item B<-fade> I<number>	123	=item B<-fade> I<number>
116		124
117	Fade the text by the given percentage when focus is lost. resource B<fading>.	125	Fade the text by the given percentage when focus is lost. Small values
		126	fade a little only, 100 completely replaces all colours by the fade
		127	colour; resource B<fading>.
		128
		129	=item B<-fadecolor> I<colour>
		130
		131	Fade to this colour when fading is used (see B<-fade>). The default colour
		132	is opaque black. resource B<fadeColor>.
118		133
119	=item B<-tint> I<colour>	134	=item B<-tint> I<colour>
120		135
121	Tint the transparent background pixmap with the given colour when	136	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>	137	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	138	non-tiled backgrounds, currently. See also the B<-sh> option that can be
124	tinting it.	139	used to brighten or darken the image in addition to tinting it; resource
		140	I<tintColor>. Example:
		141
		142	@@RXVT_NAME@@ -tr -tint blue -sh 40
125		143
126	=item B<-sh>	144	=item B<-sh>
127		145
128	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	146	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	147	background image in addition to tinting it (i.e. B<-tint> must be
…		…
162	resource B<borderColor>.	180	resource B<borderColor>.
163		181
164	=item B<-fn> I<fontlist>	182	=item B<-fn> I<fontlist>
165		183
166	Select the fonts to be used. This is a comma separated list of font names	184	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	185	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	186	first font defines the cell size for characters; other fonts might be
169	smaller, but not (in general) larger. A (hopefully) reasonable default	187	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.	188	font list is always appended to it. See resource B<font> for more details.
171		189
172	In short, to specify an X11 core font, just specify it's name or prefix it	190	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:>,	191	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
174	e.g.:	192	e.g.:
175		193
176	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	194	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
177	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	195	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
179	See also the question "How does rxvt-unicode choose fonts?" in the FAQ	197	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
180	section of @@RXVT_NAME@@(7).	198	section of @@RXVT_NAME@@(7).
181		199
182	=item B<-fb> I<fontlist>	200	=item B<-fb> I<fontlist>
183		201
184	Compile font-styles: The bold font list to use when bold characters are to	202	Compile I<font-styles>: The bold font list to use when B<bold> characters
185	be printed. See resource B<boldFont> for details.	203	are to be printed. See resource B<boldFont> for details.
186		204
187	=item B<-fi> I<fontlist>	205	=item B<-fi> I<fontlist>
188		206
189	Compile font-styles: The italic font list to use when bold characters are to	207	Compile I<font-styles>: The italic font list to use when I<italic>
190	be printed. See resource B<italicFont> for details.	208	characters are to be printed. See resource B<italicFont> for details.
191		209
192	=item B<-fbi> I<fontlist>	210	=item B<-fbi> I<fontlist>
193		211
194	Compile font-styles: The bold italic font list to use when bold characters are to	212	Compile I<font-styles>: The bold italic font list to use when B<< I<bold
195	be printed. See resource B<boldItalicFont> for details.	213	italic> >> characters are to be printed. See resource B<boldItalicFont>
		214	for details.
		215
		216	=item B<-is>\|B<+is>
		217
		218	Compile I<font-styles>: Bold/Italic font styles imply high intensity
		219	foreground/background (default). See resource B<intensityStyles> for
		220	details.
196		221
197	=item B<-name> I<name>	222	=item B<-name> I<name>
198		223
199	Specify the application name under which resources are to be obtained,	224	Specify the application name under which resources are to be obtained,
200	rather than the default executable file name. Name should not contain	225	rather than the default executable file name. Name should not contain
…		…
238		263
239	Put scrollbar on right/left; resource B<scrollBar_right>.	264	Put scrollbar on right/left; resource B<scrollBar_right>.
240		265
241	=item B<-st>\|B<+st>	266	=item B<-st>\|B<+st>
242		267
243	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	268	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
244	resource B<scrollBar_floating>.	269	resource B<scrollBar_floating>.
245		270
246	=item B<-ptab>\|B<+ptab>	271	=item B<-ptab>\|B<+ptab>
247		272
248	If enabled (default), "Horizontal Tab" characters are being stored as	273	If enabled (default), "Horizontal Tab" characters are being stored as
…		…
279	=item B<-bl>	304	=item B<-bl>
280		305
281	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	306	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	307	if honoured by the WM, the rxvt-unicode window will not have window
283	decorations; resource B<borderLess>.	308	decorations; resource B<borderLess>.
		309
		310	=item B<-override-redirect>
		311
		312	Compile I<frills>: Sets override-redirect on the window; resource
		313	B<override-redirect>.
		314
		315	=item B<-sbg>
		316
		317	Compile I<frills>: Disable the usage of the built-in block graphics/line
		318	drawing characters and just rely on what the specified fonts provide. Use
		319	this if you have a good font and want to use its block graphic glyphs;
		320	resource B<skipBuiltinGlyphs>.
284		321
285	=item B<-lsp> I<number>	322	=item B<-lsp> I<number>
286		323
287	Compile I<frills>: Lines (pixel height) to insert between each row of	324	Compile I<frills>: Lines (pixel height) to insert between each row of
288	the display. Useful to work around font rendering problems; resource	325	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	340	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	341	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,	342	run the program specified by the B<SHELL> environment variable or,
306	failing that, I<sh(1)>.	343	failing that, I<sh(1)>.
307		344
		345	Please note that you must specify a program with arguments. If you want to
		346	run shell commands, you have to specify the shell, like this:
		347
		348	@@RXVT_NAME@@ -e sh -c "shell commands"
		349
308	=item B<-title> I<text>	350	=item B<-title> I<text>
309		351
310	Window title (B<-T> still respected); the default title is the basename	352	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	353	of the program specified after the B<-e> option, if any, otherwise the
312	application name; resource B<title>.	354	application name; resource B<title>.
…		…
368	=item B<-ssr>\|B<+ssr>	410	=item B<-ssr>\|B<+ssr>
369		411
370	Turn on/off secondary screen scroll (default enabled); resource	412	Turn on/off secondary screen scroll (default enabled); resource
371	B<secondaryScroll>.	413	B<secondaryScroll>.
372		414
		415	=item B<-hold>\|B<+hold>
		416
		417	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		418	will not immediately destroy its window when the program executed within
		419	it exits. Instead, it will wait till it is being killed or closed by the
		420	user; resource B<hold>.
		421
373	=item B<-keysym.>I<sym> I<string>	422	=item B<-keysym.>I<sym> I<string>
374		423
375	Remap a key symbol. See resource B<keysym>.	424	Remap a key symbol. See resource B<keysym>.
376		425
377	=item B<-embed> I<windowid>	426	=item B<-embed> I<windowid>
378		427
379	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,	428	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
380	which enables applications to easily embed a terminal.	429	which enables applications to easily embed a terminal.
381		430
382	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it	431	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
383	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it	432	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
384	quite a bit, so don't expect it to keep some specific state. It's best to	433	quite a bit, so don't expect it to keep some specific state. It's best to
…		…
393	not.	442	not.
394		443
395	Here is a short Gtk2-perl snippet that illustrates how this option can be	444	Here is a short Gtk2-perl snippet that illustrates how this option can be
396	used (a longer example is in F<doc/embed>):	445	used (a longer example is in F<doc/embed>):
397		446
398	my $rxvt = new Gtk2::DrawingArea;	447	my $rxvt = new Gtk2::Socket;
399	$...->add ($rxvt); # important to add it somewhere first	448	$rxvt->signal_connect_after (realize => sub {
400	$rxvt->realize; # now it can be realized
401	my $xid = $rxvt->window->get_xid;	449	my $xid = $_[0]->window->get_xid;
402
403	system "@@RXVT_NAME@@ -embed $xid &";	450	system "@@RXVT_NAME@@ -embed $xid &";
		451	});
404		452
405	=item B<-pty-fd> I<fileno>	453	=item B<-pty-fd> I<file descriptor>
406		454
407	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	455	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
408	pair but instead use the given filehandle as the tty master. This is	456	pair but instead use the given filehandle as the tty master. This is
409	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator	457	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
410	without having to run a program within it.	458	without having to run a program within it.
411		459
412	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	460	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
413	entries and will not tinker with pty/tty permissions - you have to do that	461	entries and will not tinker with pty/tty permissions - you have to do that
414	yourself if you want that.	462	yourself if you want that.
415		463
		464	As an extremely special case, specifying C<-1> will completely suppress
		465	pty/tty operations.
		466
416	Here is a example in perl that illustrates how this option can be used (a	467	Here is a example in perl that illustrates how this option can be used (a
417	longer example is in F<doc/pty-fd>):	468	longer example is in F<doc/pty-fd>):
418		469
419	use IO::Pty;	470	use IO::Pty;
420	use Fcntl;	471	use Fcntl;
421		472
422	my $pty = new IO::Pty;	473	my $pty = new IO::Pty;
423	fcntl $pty, F_SETFD, 0; # clear close-on-exec	474	fcntl $pty, F_SETFD, 0; # clear close-on-exec
424
425	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";	475	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		476	close $pty;
426		477
427	# now communicate with rxvt	478	# now communicate with rxvt
428	my $slave = $pty->slave;	479	my $slave = $pty->slave;
429	while (<$slave>) { print $slave "got <$_>\n" }	480	while (<$slave>) { print $slave "got <$_>\n" }
430		481
		482	=item B<-pe> I<string>
		483
		484	Comma-separated list of perl extension scripts to use (or not to use) in
		485	this terminal instance. See resource B<perl-ext> for details.
		486
431	=back	487	=back
432		488
433	=head1 RESOURCES (available also as long-options)	489	=head1 RESOURCES (available also as long-options)
434		490
435	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	491	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
436	options) compiled into your version.	492	options) compiled into your version.
437		493
438	There are two different methods that @@RXVT_NAME@@ can use to get the	494	You can set and change the resources using X11 tools like B<xrdb>. Many
439	Xresource data: using the X libraries (Xrm*-functions) or internal	495	distribution do also load settings from the B<~/.Xresources> file when X
440	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	496	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
441	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	497	with later settings overwriting earlier ones:
442	resources using X11 tools like B<xrdb>. Many distribution do also load
443	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
444	will consult the following files/resources in order, with later settings
445	overwriting earlier ones:
446		498
447	1. system-wide app-defaults file, either locale-dependent OR global	499	1. system-wide app-defaults file, either locale-dependent OR global
448	2. app-defaults file in $XAPPLRESDIR	500	2. app-defaults file in $XAPPLRESDIR
449	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	501	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
450	4. SCREEN_RESOURCES for the current screen	502	4. SCREEN_RESOURCES for the current screen
451	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	503	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
452		504
453	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
454	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
455	set in XAPPLOADDIR/URxvt (compile-time defined: usually
456	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
457	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
458	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	505	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
459	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows	506	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
460	resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be	507	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
461	easily configured, while the class name B<URxvt> allows resources	508	configured, while the class name B<URxvt> allows resources unique to
462	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	509	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
463	shared between different B<@@RXVT_NAME@@> configurations. If no	510	configurations. If no resources are specified, suitable defaults will
464	resources are specified, suitable defaults will be used. Command-line	511	be used. Command-line arguments can be used to override resource
465	arguments can be used to override resource settings. The following	512	settings. The following resources are supported (you might want to
466	resources are allowed:	513	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		514	extensions not documented here):
467		515
468	=over 4	516	=over 4
		517
		518	=item B<depth:> I<bitdepth>
		519
		520	Compile I<xft>: Attempt to find a visual with the given bit depth;
		521	option B<-depth>.
469		522
470	=item B<geometry:> I<geom>	523	=item B<geometry:> I<geom>
471		524
472	Create the window with the specified X window geometry [default 80x24];	525	Create the window with the specified X window geometry [default 80x24];
473	option B<-geometry>.	526	option B<-geometry>.
…		…
547		600
548	B<True>: make the background inherit the parent windows' pixmap, giving	601	B<True>: make the background inherit the parent windows' pixmap, giving
549	artificial transparency. B<False>: do not inherit the parent windows'	602	artificial transparency. B<False>: do not inherit the parent windows'
550	pixmap.	603	pixmap.
551		604
		605	I<Please note that transparency of any kind if completely unsupported by
		606	the author. Don't bug him with installation questions!>
		607
552	=item B<fading:> I<number>	608	=item B<fading:> I<number>
553		609
554	Fade the text by the given percentage when focus is lost.	610	Fade the text by the given percentage when focus is lost; option B<-fade>.
		611
		612	=item B<fadeColor:> I<colour>
		613
		614	Fade to this colour, when fading is used (see B<fading:>). The default
		615	colour is black; option B<-fadecolor>.
555		616
556	=item B<tintColor:> I<colour>	617	=item B<tintColor:> I<colour>
557		618
558	Tint the transparent background pixmap with the given colour.	619	Tint the transparent background pixmap with the given colour; option
		620	B<-tint>.
559		621
560	=item B<shading:> I<number>	622	=item B<shading:> I<number>
561		623
562	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	624	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
563	image in addition to tinting it.	625	image in addition to tinting it.
…		…
567	Use the specified colour for the scrollbar [default #B2B2B2].	629	Use the specified colour for the scrollbar [default #B2B2B2].
568		630
569	=item B<troughColor:> I<colour>	631	=item B<troughColor:> I<colour>
570		632
571	Use the specified colour for the scrollbar's trough area [default	633	Use the specified colour for the scrollbar's trough area [default
572	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	634	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
573		635
574	=item B<borderColor:> I<colour>	636	=item B<borderColor:> I<colour>
575		637
576	The colour of the border around the text area and between the scrollbar	638	The colour of the border around the text area and between the scrollbar
577	and the text.	639	and the text.
…		…
586	of 1 displays the image without any scaling. A scale of 2 to 9	648	of 1 displays the image without any scaling. A scale of 2 to 9
587	specifies an integer number of images in that direction. No image will	649	specifies an integer number of images in that direction. No image will
588	be magnified beyond 10 times its original size. The maximum permitted	650	be magnified beyond 10 times its original size. The maximum permitted
589	scale is 1000. [default 0x0+50+50]	651	scale is 1000. [default 0x0+50+50]
590		652
591	=item B<menu:> I<file[;tag]>
592
593	Read in the specified menu file (note the `.menu' extension is
594	optional) and also optionally specify a starting tag to find. See the
595	reference documentation for details on the syntax for the menuBar.
596
597	=item B<path:> I<path>	653	=item B<path:> I<path>
598		654
599	Specify the colon-delimited search path for finding files (XPM and	655	Specify the colon-delimited search path for finding XPM files.
600	menus), in addition to the paths specified by the B<RXVTPATH> and
601	B<PATH> environment variables.
602		656
603	=item B<font:> I<fontlist>	657	=item B<font:> I<fontlist>
604		658
605	Select the fonts to be used. This is a comma separated list of font	659	Select the fonts to be used. This is a comma separated list of font names
606	names that are used in turn when trying to display Unicode characters.	660	that are checked in order when trying to find glyphs for characters. The
607	The first font defines the cell size for characters; other fonts might	661	first font defines the cell size for characters; other fonts might be
608	be smaller, but not larger. A reasonable default font list is always	662	smaller, but not (in general) larger. A (hopefully) reasonable default
609	appended to it. option B<-fn>.	663	font list is always appended to it; option B<-fn>.
610		664
611	Each font can either be a standard X11 core font (XLFD) name, with	665	Each font can either be a standard X11 core font (XLFD) name, with
612	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.	666	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
613		667
614	In addition, each font can be prefixed with additional hints and	668	In addition, each font can be prefixed with additional hints and
…		…
616	hint currently is C<codeset=codeset-name>, and this is only used for Xft	670	hint currently is C<codeset=codeset-name>, and this is only used for Xft
617	fonts.	671	fonts.
618		672
619	For example, this font resource	673	For example, this font resource
620		674
621	URxvt*font: 9x15bold,\	675	URxvt.font: 9x15bold,\
622	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	676	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
623	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \	677	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
624	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	678	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
625	xft:Code2000:antialias=false	679	xft:Code2000:antialias=false
626		680
…		…
660	not possible, replacement fonts of the desired shape will be tried.	714	not possible, replacement fonts of the desired shape will be tried.
661		715
662	If set, but empty, then this specific style is disabled and the normal	716	If set, but empty, then this specific style is disabled and the normal
663	text font will being used for the given style.	717	text font will being used for the given style.
664		718
		719	=item B<intensityStyles:> I<boolean>
		720
		721	When font styles are not enabled, or this option is enabled (B<True>,
		722	option B<-is>, the default), bold and italic font styles imply high
		723	intensity foreground/backround colours. Disabling this option (B<False>,
		724	option B<+is>) disables this behaviour, the high intensity colours are not
		725	reachable.
		726
665	=item B<selectstyle:> I<mode>	727	=item B<selectstyle:> I<mode>
666		728
667	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	729	Set mouse selection style to B<old> which is 2.20, B<oldword> which is
668	xterm style with 2.20 old word selection, or anything else which gives	730	xterm style with 2.20 old word selection, or anything else which gives
669	xterm style selection.	731	xterm style selection.
670		732
671	=item B<scrollstyle:> I<mode>	733	=item B<scrollstyle:> I<mode>
672		734
673	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	735	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
674	the author's favourite..	736	the author's favourite.
675		737
676	=item B<title:> I<string>	738	=item B<title:> I<string>
677		739
678	Set window title string, the default title is the command-line	740	Set window title string, the default title is the command-line
679	specified after the B<-e> option, if any, otherwise the application	741	specified after the B<-e> option, if any, otherwise the application
…		…
710	=item B<print-pipe:> I<string>	772	=item B<print-pipe:> I<string>
711		773
712	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	774	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
713	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or	775	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
714	B<Shift-Print> to include the scrollback as well.	776	B<Shift-Print> to include the scrollback as well.
		777
		778	The string will be interpreted as if typed into the shell as-is.
		779
		780	Example:
		781
		782	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		783
		784	This creates a new file in your home directory with the screen contents
		785	everytime you hit C<Print>.
715		786
716	=item B<scrollBar:> I<boolean>	787	=item B<scrollBar:> I<boolean>
717		788
718	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	789	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
719	disable the scrollbar; option B<+sb>.	790	disable the scrollbar; option B<+sb>.
…		…
770	=item B<borderLess:> I<boolean>	841	=item B<borderLess:> I<boolean>
771		842
772	Set MWM hints to request a borderless window, i.e. if honoured by the	843	Set MWM hints to request a borderless window, i.e. if honoured by the
773	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.	844	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
774		845
		846	=item B<skipBuiltinGlyphs:> I<boolean>
		847
		848	Compile I<frills>: Disable the usage of the built-in block graphics/line
		849	drawing characters and just rely on what the specified fonts provide. Use
		850	this if you have a good font and want to use its block graphic glyphs;
		851	option B<-sbg>.
		852
775	=item B<termName:> I<termname>	853	=item B<termName:> I<termname>
776		854
777	Specifies the terminal type name to be set in the B<TERM> environment	855	Specifies the terminal type name to be set in the B<TERM> environment
778	variable; option B<-tn>.	856	variable; option B<-tn>.
779		857
…		…
816		894
817	Mouse pointer background colour.	895	Mouse pointer background colour.
818		896
819	=item B<pointerBlankDelay:> I<number>	897	=item B<pointerBlankDelay:> I<number>
820		898
821	Specifies number of seconds before blanking the pointer [default 2].	899	Specifies number of seconds before blanking the pointer [default 2]. Use a
		900	large number (e.g. C<987654321>) to effectively disable the timeout.
822		901
823	=item B<backspacekey:> I<string>	902	=item B<backspacekey:> I<string>
824		903
825	The string to send when the backspace key is pressed. If set to B<DEC>	904	The string to send when the backspace key is pressed. If set to B<DEC>
826	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	905	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
…		…
833	pressed. If unset it will send the sequence traditionally associated	912	pressed. If unset it will send the sequence traditionally associated
834	with the B<Execute> key.	913	with the B<Execute> key.
835		914
836	=item B<cutchars:> I<string>	915	=item B<cutchars:> I<string>
837		916
838	The characters used as delimiters for double-click word selection. The	917	The characters used as delimiters for double-click word selection
839	built-in default:	918	(whitespace delimiting is added automatically if resource is given).
		919
		920	When the selection extension is in use (the default if compiled in, see
		921	the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters
		922	will be created (if the resource exists, otherwise, no regex will be
		923	created). In this mode, characters outside ISO-8859-1 can be used.
		924
		925	When the selection extension is not used, only ISO-8859-1 characters can
		926	be used. If not specified, the built-in default is used:
840		927
841	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	928	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>
842		929
843	=item B<preeditType:> I<style>	930	=item B<preeditType:> I<style>
844		931
…		…
851	=item B<imLocale:> I<name>	938	=item B<imLocale:> I<name>
852		939
853	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.	940	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
854	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the	941	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
855	input extension to be able to input japanese characters while staying in	942	input extension to be able to input japanese characters while staying in
856	another locale. option B<-imlocale>.	943	another locale; option B<-imlocale>.
857		944
858	=item B<imFont:> I<fontset>	945	=item B<imFont:> I<fontset>
859		946
860	Specify the font-set used for XIM styles C<OverTheSpot> or	947	Specify the font-set used for XIM styles C<OverTheSpot> or
861	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated	948	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
…		…
866		953
867	=item B<tripleclickwords:> I<boolean>	954	=item B<tripleclickwords:> I<boolean>
868		955
869	Change the meaning of triple-click selection with the left mouse	956	Change the meaning of triple-click selection with the left mouse
870	button. Instead of selecting a full line it will extend the selection to	957	button. Instead of selecting a full line it will extend the selection to
871	the end of the logical line only. option B<-tcw>.	958	the end of the logical line only; option B<-tcw>.
872		959
873	=item B<insecure:> I<boolean>	960	=item B<insecure:> I<boolean>
874		961
875	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	962	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
876	echo arbitrary strings like the icon name or the locale. This could be	963	echo arbitrary strings like the icon name or the locale. This could be
877	abused if somebody gets 8-bit-clean access to your display, whether	964	abused if somebody gets 8-bit-clean access to your display, whether
878	throuh a mail client displaying mail bodies unfiltered or though	965	through a mail client displaying mail bodies unfiltered or through
879	write(1). Therefore, these sequences are disabled by default. (Note	966	write(1) or any other means. Therefore, these sequences are disabled by
880	that other terminals, including xterm, have these sequences	967	default. (Note that many other terminals, including xterm, have these
881	enabled by default). You can enable them by setting this boolean	968	sequences enabled by default, which doesn't make it safer, though).
882	resource or specifying B<-insecure> as an option. At the moment, this	969
883	enabled display-answer, locale, findfont, icon label and window title	970	You can enable them by setting this boolean resource or specifying
884	requests as well as dynamic menubar dispatch.	971	B<-insecure> as an option. At the moment, this enables display-answer,
		972	locale, findfont, icon label and window title requests.
885		973
886	=item B<modifier:> I<modifier>	974	=item B<modifier:> I<modifier>
887		975
888	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	976	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
889	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	977	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
893		981
894	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	982	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
895	character is passed through. It may contain escape values as described	983	character is passed through. It may contain escape values as described
896	in the entry on B<keysym> following.	984	in the entry on B<keysym> following.
897		985
898	=item B<secondaryScreen:> I<bool>	986	=item B<secondaryScreen:> I<boolean>
899		987
900	Turn on/off secondary screen (default enabled).	988	Turn on/off secondary screen (default enabled).
901		989
902	=item B<secondaryScroll:> I<bool>	990	=item B<secondaryScroll:> I<boolean>
903		991
904	Turn on/off secondary screen scroll (default enabled). If the this	992	Turn on/off secondary screen scroll (default enabled). If the this
905	option is enabled, scrolls on the secondary screen will change the	993	option is enabled, scrolls on the secondary screen will change the
906	scrollback buffer and switching to/from the secondary screen will	994	scrollback buffer and switching to/from the secondary screen will
907	instead scroll the screen up.	995	instead scroll the screen up.
		996
		997	=item B<hold>: I<boolean>
		998
		999	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		1000	will not immediately destroy its window when the program executed within
		1001	it exits. Instead, it will wait till it is being killed or closed by the
		1002	user.
908		1003
909	=item B<keysym.>I<sym>: I<string>	1004	=item B<keysym.>I<sym>: I<string>
910		1005
911	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1006	Compile I<frills>: Associate I<string> with keysym I<sym>. The
912	intervening resource name B<keysym.> cannot be omitted.	1007	intervening resource name B<keysym.> cannot be omitted.
…		…
932	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1027	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
933	C<\000>: octal number) or verbatim control characters (C<^?>: delete,	1028	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
934	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it	1029	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
935	can start or end with whitespace.	1030	can start or end with whitespace.
936		1031
937	Please note that you need to double the C<\> when using	1032	Please note that you need to double the C<\> in resource files, as
938	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can	1033	Xlib itself does its own de-escaping (you can use C<\033> instead of
939	use C<\033> instead of C<\e> (and so on), which will work with both Xt and	1034	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
940	@@RXVT_NAME@@'s own processing).	1035	processing).
941		1036
942	You can define a range of keysyms in one shot by providing a I<string>	1037	You can define a range of keysyms in one shot by providing a I<string>
943	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1038	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
944	should be a character not used by the strings.	1039	should be a character not used by the strings.
945		1040
…		…
958	example the following means "change the current locale to C<zh_CN.GBK>	1053	example the following means "change the current locale to C<zh_CN.GBK>
959	when Control-Meta-c is being pressed":	1054	when Control-Meta-c is being pressed":
960		1055
961	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1056	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
962		1057
		1058	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1059	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1060	manpage. For example, the F<selection> extension (activated via
		1061	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1062
		1063	URxvt.keysym.M-C-c: perl:selection:rot13
		1064
		1065	Due the the large number of modifier combinations, a defined key mapping
		1066	will match if at I<at least> the specified identifiers are being set, and
		1067	no other key mappings with those and more bits are being defined. That
		1068	means that defining a key map for C<a> will automatically provide
		1069	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		1070	mappings themselves.
		1071
		1072	Unfortunately, this will override built-in key mappings. For example
		1073	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		1074	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		1075	user-defined keymap using the C<builtin:> replacement:
		1076
		1077	URxvt.keysym.Insert: <my insert key sequence>
		1078	URxvt.keysym.S-Insert: builtin:
		1079
		1080	The first line defines a mapping for C<Insert> and I<any> combination
		1081	of modifiers. The second line re-establishes the default mapping for
		1082	C<Shift-Insert>.
		1083
963	The following example will map Control-Meta-1 and Control-Meta-2 to	1084	The following example will map Control-Meta-1 and Control-Meta-2 to
964	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited	1085	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
965	font-switching at runtime:	1086	font-switching at runtime:
966		1087
967	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1088	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
…		…
970	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1091	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
971	info):	1092	info):
972		1093
973	URxvt.keysym.M-C-3: command:\033[8;25;80t	1094	URxvt.keysym.M-C-3: command:\033[8;25;80t
974	URxvt.keysym.M-C-4: command:\033[8;48;110t	1095	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1096
		1097	=item B<perl-ext-common>: I<string>
		1098
		1099	=item B<perl-ext>: I<string>
		1100
		1101	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1102	use in this terminal instance; option B<-pe>.
		1103
		1104	Extension names can be prefixed with a C<-> sign to prohibit using
		1105	them. This can be useful to selectively disable some extensions loaded
		1106	by default, or specified via the C<perl-ext-common> resource. For
		1107	example, C<default,-selection> will use all the default extension except
		1108	C<selection>.
		1109
		1110	Extension names can also be followed by an argument in angle brackets
		1111	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1112	searchable scorllback to Alt/Meta-s). Mentioning the same extension
		1113	multiple times with different arguments will pass multiple arguments to
		1114	the extension.
		1115
		1116	Each extension is looked up in the library directories, loaded if
		1117	necessary, and bound to the current terminal instance.
		1118
		1119	If both of these resources are the empty string, then the perl
		1120	interpreter will not be initialized. The idea behind two options is that
		1121	B<perl-ext-common> will be used for extensions that should be available to
		1122	all instances, while B<perl-ext> is used for specific instances.
		1123
		1124	=item B<perl-eval>: I<string>
		1125
		1126	Perl code to be evaluated when all extensions have been registered. See
		1127	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
		1128	will be ignored when running setuid/setgid.
		1129
		1130	=item B<perl-lib>: I<path>
		1131
		1132	Colon-separated list of additional directories that hold extension
		1133	scripts. When looking for extensions specified by the C<perl> resource,
		1134	@@RXVT_NAME@@ will first look in these directories and then in
		1135	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
		1136	will be ignored when running setuid/setgid.
		1137
		1138	See the @@RXVT_NAME@@perl(3) manpage.
		1139
		1140	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1141
		1142	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1143	details.
		1144
		1145	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1146
		1147	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1148	for details.
		1149
		1150	=item B<searchable-scrollback:> I<keysym>
		1151
		1152	Sets the hotkey that starts the incremental scrollback buffer search
		1153	(default: C<M-s>).
		1154
		1155	=item B<urlLauncher>: I<string>
		1156
		1157	Specifies the program to be started with a URL argument. Used by the
		1158	C<selection-popup> and C<mark-urls> perl extensions.
		1159
		1160	=item B<transient-for>: I<windowid>
		1161
		1162	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1163
		1164	=item B<override-redirect>: I<boolean>
		1165
		1166	Compile I<frills>: Sets override-redirect for the terminal window, making
		1167	it almost invisible to window managers; option B<-override-redirect>.
975		1168
976	=back	1169	=back
977		1170
978	=head1 THE SCROLLBAR	1171	=head1 THE SCROLLBAR
979		1172
…		…
1014	to select a word; Left triple-click to select the entire logical line	1207	to select a word; Left triple-click to select the entire logical line
1015	(which can span multiple screen lines), unless modified by resource	1208	(which can span multiple screen lines), unless modified by resource
1016	B<tripleclickwords>.	1209	B<tripleclickwords>.
1017		1210
1018	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1211	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
1019	(Compile: I<frills>) will create a rectangular selection instead of a normal	1212	(Compile: I<frills>) will create a rectangular selection instead of a
1020	one.	1213	normal one. In this mode, every selected row becomes its own line in the
		1214	selection, and trailing whitespace is visually underlined and removed from
		1215	the selection.
1021		1216
1022	=item B<Insertion>:	1217	=item B<Insertion>:
1023		1218
1024	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1219	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1025	an B<@@RXVT_NAME@@> window causes the current text selection to be	1220	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1026	inserted as if it had been typed on the keyboard.	1221	Meta modifier) to be inserted as if it had been typed on the keyboard.
		1222
		1223	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1224	inserted too.
1027		1225
1028	=back	1226	=back
1029		1227
1030	=head1 CHANGING FONTS	1228	=head1 CHANGING FONTS
1031		1229
1032	Changing fonts (or font sizes, respectively) via the keypad is not yet	1230	Changing fonts (or font sizes, respectively) via the keypad is not yet
1033	supported in rxvt-unicode. Bug me if you need this.	1231	supported in rxvt-unicode. Bug me if you need this.
1034		1232
1035	You can, however, switch fonts at runtime using escape sequences (and	1233	You can, however, switch fonts at runtime using escape sequences, e.g.:
1036	therefore using the menubar), e.g.:
1037		1234
1038	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1235	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1236
		1237	You can use keyboard shortcuts, too:
		1238
		1239	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1240	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1039		1241
1040	rxvt-unicode will automatically re-apply these fonts to the output so far.	1242	rxvt-unicode will automatically re-apply these fonts to the output so far.
1041		1243
1042	=head1 ISO 14755 SUPPORT	1244	=head1 ISO 14755 SUPPORT
1043		1245
…		…
1071	This mode lets you input characters representing the keycap symbols of	1273	This mode lets you input characters representing the keycap symbols of
1072	your keyboard, if representable in the current locale encoding.	1274	your keyboard, if representable in the current locale encoding.
1073		1275
1074	Start by pressing C<Control> and C<Shift> together, then releasing	1276	Start by pressing C<Control> and C<Shift> together, then releasing
1075	them. The next special key (cursor keys, home etc.) you enter will not	1277	them. The next special key (cursor keys, home etc.) you enter will not
1076	invoke it's usual function but instead will insert the corresponding	1278	invoke its usual function but instead will insert the corresponding
1077	keycap symbol. The symbol will only be entered when the key has been	1279	keycap symbol. The symbol will only be entered when the key has been
1078	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1280	released, otherwise pressing e.g. C<Shift> would enter the symbol for
1079	C<ISO Level 2 Switch>, although your intention might have been to enter a	1281	C<ISO Level 2 Switch>, although your intention might have been to enter a
1080	reverse tab (Shift-Tab).	1282	reverse tab (Shift-Tab).
1081		1283
…		…
1114	=head1 COLORS AND GRAPHICS	1316	=head1 COLORS AND GRAPHICS
1115		1317
1116	In addition to the default foreground and background colours,	1318	In addition to the default foreground and background colours,
1117	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1319	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1118	high-intensity bold/blink versions of the same). Here is a list of the	1320	high-intensity bold/blink versions of the same). Here is a list of the
1119	colours with their B<rgb.txt> names.	1321	colours with their names.
1120		1322
1121	=begin table	1323	=begin table
1122		1324
1123	B<color0> (black) = Black	1325	B<color0> (black) = Black
1124	B<color1> (red) = Red3	1326	B<color1> (red) = Red3
…		…
1144	It is also possible to specify the colour values of B<foreground>,	1346	It is also possible to specify the colour values of B<foreground>,
1145	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1347	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1146	a number 0-15, as a convenient shorthand to reference the colour name of	1348	a number 0-15, as a convenient shorthand to reference the colour name of
1147	color0-color15.	1349	color0-color15.
1148		1350
		1351	In addition to the colours defined above, @@RXVT_NAME@@ offers an
		1352	additional 72 colours. The first 64 of those (with indices 16 to 79)
		1353	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
		1354	16>), followed by 8 additional shades of gray (with indices 80 to 87).
		1355
		1356	Together, all those colours implement the 88 colour xterm colours. Only
		1357	the first 16 can be changed using resources currently, the rest can only
		1358	be changed via command sequences ("escape codes").
		1359
1149	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1360	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1150	always swapping the foreground/background colours. This is in contrast to	1361	always swapping the foreground/background colours. This is in contrast to
1151	I<xterm>(1) where the colours are only swapped if they have not otherwise	1362	I<xterm>(1) where the colours are only swapped if they have not otherwise
1152	been specified. For example,	1363	been specified. For example,
1153		1364
…		…
1157		1368
1158	would yield White on Black, while on I<xterm>(1) it would yield Black	1369	would yield White on Black, while on I<xterm>(1) it would yield Black
1159	on White.	1370	on White.
1160		1371
1161	=back	1372	=back
		1373
		1374	=head2 ALPHA CHANNEL SUPPORT
		1375
		1376	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1377	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
		1378	(recommended, but B<MUST> have 4 digits/component) colour specifications,
		1379	in addition to the ones provided by X, where the additional A component
		1380	specifies opacity (alpha) values. The minimum value of C<0> is completely
		1381	transparent). You can also prefix any color with C<[a]>, where C<a> is on
		1382	to four hex digits specifiying the opacity value.
		1383
		1384	You probably need to specify B<"-depth 32">, too, and have the luck that
		1385	your X-server uses ARGB pixel layout, as X is far from just supporting
		1386	ARGB visuals out of the box, and rxvt-unicode just fudges around.
		1387
		1388	For example, the following selects an almost completely transparent red
		1389	background, and an almost opaque pink foreground:
		1390
		1391	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"
		1392
		1393	I<Please note that transparency of any kind if completely unsupported by
		1394	the author. Don't bug him with installation questions!>
1162		1395
1163	=head1 ENVIRONMENT	1396	=head1 ENVIRONMENT
1164		1397
1165	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1398	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1166		1399
…		…
1199	C<--with-terminfo=PATH>.	1432	C<--with-terminfo=PATH>.
1200		1433
1201	=item B<DISPLAY>	1434	=item B<DISPLAY>
1202		1435
1203	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1436	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1204	display in it's child processes.	1437	display in its child processes.
1205		1438
1206	=item B<SHELL>	1439	=item B<SHELL>
1207		1440
1208	The shell to be used for command execution, defaults to C</bin/sh>.	1441	The shell to be used for command execution, defaults to C</bin/sh>.
1209
1210	=item B<RXVTPATH>
1211
1212	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1213	files.
1214
1215	=item B<PATH>
1216
1217	Used in the same way as C<RXVTPATH>.
1218		1442
1219	=item B<RXVT_SOCKET>	1443	=item B<RXVT_SOCKET>
1220		1444
1221	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1445	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1222	@@RXVT_NAME@@d(1).	1446	@@RXVT_NAME@@d(1).
1223		1447
1224	Default C<< $HOME/.rxvt-unicode-<nodename >>.	1448	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1225		1449
1226	=item B<HOME>	1450	=item B<HOME>
1227		1451
1228	Used to locate the default directory for the unix domain socket for	1452	Used to locate the default directory for the unix domain socket for
1229	daemon communications and to locate various resource files (such as	1453	daemon communications and to locate various resource files (such as
…		…
1250		1474
1251	=back	1475	=back
1252		1476
1253	=head1 SEE ALSO	1477	=head1 SEE ALSO
1254		1478
1255	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1479	@@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)
1256
1257	=head1 BUGS
1258
1259	Check the BUGS file for an up-to-date list.
1260
1261	Cursor change support is not yet implemented.
1262
1263	Click-and-drag doesn't work with X11 mouse report overriding.
1264		1480
1265	=head1 CURRENT PROJECT COORDINATOR	1481	=head1 CURRENT PROJECT COORDINATOR
1266		1482
1267	=over 4	1483	=over 4
1268		1484
1269	=item Project Coordinator	1485	=item Project Coordinator
1270		1486
1271	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1487	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1272		1488
1273	L<http://software.schmorp.de/#rxvt-unicode>	1489	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1274		1490
1275	=back	1491	=back
1276		1492
1277	=head1 AUTHORS	1493	=head1 AUTHORS
1278		1494
…		…
1300		1516
1301	Project Coordinator (changes.txt 2.21a to 2.4.5)	1517	Project Coordinator (changes.txt 2.21a to 2.4.5)
1302		1518
1303	=item Geoff Wing L<< <gcw@pobox.com> >>	1519	=item Geoff Wing L<< <gcw@pobox.com> >>
1304		1520
1305	Rewrote screen display and text selection routines. Project Coordinator	1521	Rewrote screen display and text selection routines.
		1522
1306	(changes.txt 2.4.6 - rxvt-unicode)	1523	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1307		1524
1308	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1525	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1309		1526
1310	Forked rxvt-unicode, rewrote most of the display code and internal	1527	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1311	character handling to store text in unicode, improve xterm	1528	extension, random hacks, numerous bugfixes and extensions.
1312	compatibility and apply numerous other bugfixes and extensions.
1313		1529
1314	Project Coordinator (Changes 1.0 -)	1530	Project Coordinator (Changes 1.0 -)
1315		1531
		1532	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1533
		1534	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
		1535
1316	=back	1536	=back
1317		1537

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.59 by root, Thu Feb 17 15:07:48 2005 UTC vs. Revision 1.116 by root, Mon Jul 10 04:03:09 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.59 by root, Thu Feb 17 15:07:48 2005 UTC vs.
Revision 1.116 by root, Mon Jul 10 04:03:09 2006 UTC