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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.34 by root, Wed Dec 1 02:29:14 2004 UTC vs.
Revision 1.94 by root, Thu Jan 12 05:37:34 2006 UTC

…		…
14	configurability. As a result, B<rxvt-unicode> uses much less swap space --	14	configurability. As a result, B<rxvt-unicode> uses much less swap space --
15	a significant advantage on a machine serving many X sessions.	15	a significant advantage on a machine serving many X sessions.
16		16
17	=head1 FREQUENTLY ASKED QUESTIONS	17	=head1 FREQUENTLY ASKED QUESTIONS
18		18
19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of frequently	19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20	asked questions and answer to them and some common problems.	20	frequently asked questions and answer to them and some common
		21	problems. That document is also accessible on the World-Wide-Web at
		22	L<http://cvs.schmorp.de/browse/checkout/rxvt-unicode/doc/rxvt.7.html>.
21		23
22	=head1 RXVT-UNICODE VS. RXVT	24	=head1 RXVT-UNICODE VS. RXVT
23		25
24	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode	26	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
25	internally. That means it can store and display most scripts in the	27	internally. That means it can store and display most scripts in the
…		…
103		105
104	=item B<-j>\|B<+j>	106	=item B<-j>\|B<+j>
105		107
106	Turn on/off jump scrolling; resource B<jumpScroll>.	108	Turn on/off jump scrolling; resource B<jumpScroll>.
107		109
108	=item B<-ip>\|B<+ip>	110	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>
109		111
110	Turn on/off inheriting parent window's pixmap. Alternative form is	112	Turn on/off inheriting parent window's pixmap. Alternative form is
111	B<-tr>; resource B<inheritPixmap>.	113	B<-tr>; resource B<inheritPixmap>.
112		114
113	=item B<-fade> I<number>	115	=item B<-fade> I<number>
114		116
115	Fade the text by the given percentage when focus is lost.	117	Fade the text by the given percentage when focus is lost. Small values
		118	fade a little only, 100 completely replaces all colours by the fade
		119	colour; resource B<fading>.
		120
		121	=item B<-fadecolor> I<colour>
		122
		123	Fade to this colour when fading is used (see B<-fade>). The default colour
		124	is black. resource B<fadeColor>.
116		125
117	=item B<-tint> I<colour>	126	=item B<-tint> I<colour>
118		127
119	Tint the transparent background pixmap with the given colour when	128	Tint the transparent background pixmap with the given colour when
120	transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>	129	transparency is enabled with B<-tr> or B<-ip>. This only works for
121	option that can be used to brighten or darken the image in addition to	130	non-tiled backgrounds, currently. See also the B<-sh> option that can be
122	tinting it.	131	used to brighten or darken the image in addition to tinting it; resource
		132	I<tintColor>. Example:
		133
		134	@@RXVT_NAME@@ -tr -tint blue -sh 40
123		135
124	=item B<-sh>	136	=item B<-sh>
125		137
126	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	138	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
127	background image in addition to tinting it (i.e. B<-tint> must be	139	background image in addition to tinting it (i.e. B<-tint> must be
128	specified, too).	140	specified, too, e.g. C<-tint white>).
129		141
130	=item B<-bg> I<colour>	142	=item B<-bg> I<colour>
131		143
132	Window background colour; resource B<background>.	144	Window background colour; resource B<background>.
133		145
…		…
136	Window foreground colour; resource B<foreground>.	148	Window foreground colour; resource B<foreground>.
137		149
138	=item B<-pixmap> I<file[;geom]>	150	=item B<-pixmap> I<file[;geom]>
139		151
140	Compile I<XPM>: Specify XPM file for the background and also optionally	152	Compile I<XPM>: Specify XPM file for the background and also optionally
141	specify its scaling with a geometry string. Note you may need to add	153	specify its scaling with a geometry string. Note you may need to
142	quotes to avoid special shell interpretation of the `;' in the	154	add quotes to avoid special shell interpretation of the C<;> in the
143	command-line; resource B<backgroundPixmap>.	155	command-line; resource B<backgroundPixmap>.
144		156
145	=item B<-cr> I<colour>	157	=item B<-cr> I<colour>
146		158
147	The cursor colour; resource B<cursorColor>.	159	The cursor colour; resource B<cursorColor>.
…		…
177	See also the question "How does rxvt-unicode choose fonts?" in the FAQ	189	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
178	section of @@RXVT_NAME@@(7).	190	section of @@RXVT_NAME@@(7).
179		191
180	=item B<-fb> I<fontlist>	192	=item B<-fb> I<fontlist>
181		193
182	Compile font-styles: The bold font list to use when bold characters are to	194	Compile I<font-styles>: The bold font list to use when B<bold> characters
183	be printed. See resource B<boldFont> for details.	195	are to be printed. See resource B<boldFont> for details.
184		196
185	=item B<-fi> I<fontlist>	197	=item B<-fi> I<fontlist>
186		198
187	Compile font-styles: The italic font list to use when bold characters are to	199	Compile I<font-styles>: The italic font list to use when I<italic>
188	be printed. See resource B<italicFont> for details.	200	characters are to be printed. See resource B<italicFont> for details.
189		201
190	=item B<-fbi> I<fontlist>	202	=item B<-fbi> I<fontlist>
191		203
192	Compile font-styles: The bold italic font list to use when bold characters are to	204	Compile I<font-styles>: The bold italic font list to use when B<< I<bold
193	be printed. See resource B<boldItalicFont> for details.	205	italic> >> characters are to be printed. See resource B<boldItalicFont>
		206	for details.
		207
		208	=item B<-is>\|B<+is>
		209
		210	Compile I<font-styles>: Bold/Italic font styles imply high intensity
		211	foreground/background (default). See resource B<intensityStyles> for
		212	details.
194		213
195	=item B<-name> I<name>	214	=item B<-name> I<name>
196		215
197	Specify the application name under which resources are to be obtained,	216	Specify the application name under which resources are to be obtained,
198	rather than the default executable file name. Name should not contain	217	rather than the default executable file name. Name should not contain
…		…
236		255
237	Put scrollbar on right/left; resource B<scrollBar_right>.	256	Put scrollbar on right/left; resource B<scrollBar_right>.
238		257
239	=item B<-st>\|B<+st>	258	=item B<-st>\|B<+st>
240		259
241	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	260	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
242	resource B<scrollBar_floating>.	261	resource B<scrollBar_floating>.
243		262
244	=item B<-ptab>\|B<+ptab>	263	=item B<-ptab>\|B<+ptab>
245		264
246	If enabled (default), "Horizontal Tab" characters are being stored as	265	If enabled (default), "Horizontal Tab" characters are being stored as
…		…
278		297
279	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	298	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
280	if honoured by the WM, the rxvt-unicode window will not have window	299	if honoured by the WM, the rxvt-unicode window will not have window
281	decorations; resource B<borderLess>.	300	decorations; resource B<borderLess>.
282		301
		302	=item B<-sbg>
		303
		304	Compile I<frills>: Disable the usage of the built-in block graphics/line
		305	drawing characters and just rely on what the specified fonts provide. Use
		306	this if you have a good font and want to use its block graphic glyphs;
		307	resource B<skipBuiltinGlyphs>.
		308
283	=item B<-lsp> I<number>	309	=item B<-lsp> I<number>
284		310
285	Compile I<linespace>: Lines (pixel height) to insert between each row	311	Compile I<frills>: Lines (pixel height) to insert between each row of
286	of the display; resource B<linespace>.	312	the display. Useful to work around font rendering problems; resource
		313	B<linespace>.
287		314
288	=item B<-tn> I<termname>	315	=item B<-tn> I<termname>
289		316
290	This option specifies the name of the terminal type to be set in the	317	This option specifies the name of the terminal type to be set in the
291	B<TERM> environment variable. This terminal type must exist in the	318	B<TERM> environment variable. This terminal type must exist in the
…		…
300	given on the command line. If this option is used, it must be the last	327	given on the command line. If this option is used, it must be the last
301	on the command-line. If there is no B<-e> option then the default is to	328	on the command-line. If there is no B<-e> option then the default is to
302	run the program specified by the B<SHELL> environment variable or,	329	run the program specified by the B<SHELL> environment variable or,
303	failing that, I<sh(1)>.	330	failing that, I<sh(1)>.
304		331
		332	Please note that you must specify a program with arguments. If you want to
		333	run shell commands, you have to specify the shell, like this:
		334
		335	@@RXVT_NAME@@ -e sh -c "shell commands"
		336
305	=item B<-title> I<text>	337	=item B<-title> I<text>
306		338
307	Window title (B<-T> still respected); the default title is the basename	339	Window title (B<-T> still respected); the default title is the basename
308	of the program specified after the B<-e> option, if any, otherwise the	340	of the program specified after the B<-e> option, if any, otherwise the
309	application name; resource B<title>.	341	application name; resource B<title>.
…		…
327		359
328	Compile I<XIM>: input method name. resource B<inputMethod>.	360	Compile I<XIM>: input method name. resource B<inputMethod>.
329		361
330	=item B<-imlocale> I<string>	362	=item B<-imlocale> I<string>
331		363
332	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	364	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
333	de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input	365	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
334	extension to be able to input japanese characters while staying in	366	input extension to be able to input japanese characters while staying in
335	another locale.	367	another locale. resource B<imLocale>.
		368
		369	=item B<-imfont> I<fontset>
		370
		371	Set the font set to use for the X Input Method, see resource B<imFont>
		372	for more info.
		373
		374	=item B<-tcw>
		375
		376	Change the meaning of triple-click selection with the left mouse
		377	button. Instead of selecting a full line it will extend the selection the
		378	end of the logical line only. resource B<tripleclickwords>.
336		379
337	=item B<-insecure>	380	=item B<-insecure>
338		381
339	Enable "insecure" mode, which currently enables most of the escape	382	Enable "insecure" mode, which currently enables most of the escape
340	sequences that echo strings. See the resource B<insecure> for more	383	sequences that echo strings. See the resource B<insecure> for more
…		…
354	=item B<-ssr>\|B<+ssr>	397	=item B<-ssr>\|B<+ssr>
355		398
356	Turn on/off secondary screen scroll (default enabled); resource	399	Turn on/off secondary screen scroll (default enabled); resource
357	B<secondaryScroll>.	400	B<secondaryScroll>.
358		401
		402	=item B<-hold>\|B<+hold>
		403
		404	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		405	will not immediately destroy its window when the program executed within
		406	it exits. Instead, it will wait till it is being killed or closed by the
		407	user; resource B<hold>.
		408
		409	=item B<-keysym.>I<sym> I<string>
		410
		411	Remap a key symbol. See resource B<keysym>.
		412
		413	=item B<-embed> I<windowid>
		414
		415	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
		416	which enables applications to easily embed a terminal.
		417
		418	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
		419	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
		420	quite a bit, so don't expect it to keep some specific state. It's best to
		421	create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
		422
		423	The window will not be destroyed when @@RXVT_NAME@@ exits.
		424
		425	It might be useful to know that @@RXVT_NAME@@ will not close file
		426	descriptors passed to it (except for stdin/out/err, of course), so you
		427	can use file descriptors to communicate with the programs within the
		428	terminal. This works regardless of wether the C<-embed> option was used or
		429	not.
		430
		431	Here is a short Gtk2-perl snippet that illustrates how this option can be
		432	used (a longer example is in F<doc/embed>):
		433
		434	my $rxvt = new Gtk2::Socket;
		435	$rxvt->signal_connect_after (realize => sub {
		436	my $xid = $_[0]->window->get_xid;
		437	system "@@RXVT_NAME@@ -embed $xid &";
		438	});
		439
		440	=item B<-pty-fd> I<file descriptor>
		441
		442	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
		443	pair but instead use the given filehandle as the tty master. This is
		444	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
		445	without having to run a program within it.
		446
		447	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
		448	entries and will not tinker with pty/tty permissions - you have to do that
		449	yourself if you want that.
		450
		451	As an extremely special case, specifying C<-1> will completely suppress
		452	pty/tty operations.
		453
		454	Here is a example in perl that illustrates how this option can be used (a
		455	longer example is in F<doc/pty-fd>):
		456
		457	use IO::Pty;
		458	use Fcntl;
		459
		460	my $pty = new IO::Pty;
		461	fcntl $pty, F_SETFD, 0; # clear close-on-exec
		462	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		463	close $pty;
		464
		465	# now communicate with rxvt
		466	my $slave = $pty->slave;
		467	while (<$slave>) { print $slave "got <$_>\n" }
		468
359	=item B<-xrm> I<resourcestring>	469	=item B<-pe> I<string>
360		470
361	No effect on rxvt-unicode. Simply passes through an argument to be made	471	Comma-separated list of perl extension scripts to use (or not to use) in
362	available in the instance's argument list. Appears in I<WM_COMMAND> in	472	this terminal instance. See resource B<perl-ext> for details.
363	some window managers.
364		473
365	=back	474	=back
366		475
367	=head1 RESOURCES (available also as long-options)	476	=head1 RESOURCES (available also as long-options)
368		477
369	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	478	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
370	options) compiled into your version.	479	options) compiled into your version.
371		480
372	There are two different methods that @@RXVT_NAME@@ can use to get the	481	You can set and change the resources using X11 tools like B<xrdb>. Many
373	Xresource data: using the X libraries (Xrm*-functions) or internal	482	distribution do also load settings from the B<~/.Xresources> file when X
374	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	483	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
375	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	484	with later settings overwriting earlier ones:
376	resources using X11 tools like B<xset>. Many distribution do also load
377	settings from the B<~/.Xresources> file when X starts.
378		485
379	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>	486	1. system-wide app-defaults file, either locale-dependent OR global
380	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults	487	2. app-defaults file in $XAPPLRESDIR
381	set in XAPPLOADDIR/URxvt (compile-time defined: usually	488	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
382	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	489	4. SCREEN_RESOURCES for the current screen
383	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.	490	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		491
384	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	492	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
385	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows	493	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
386	resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be	494	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
387	easily configured, while the class name B<URxvt> allows resources	495	configured, while the class name B<URxvt> allows resources unique to
388	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	496	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
389	shared between different B<@@RXVT_NAME@@> configurations. If no	497	configurations. If no resources are specified, suitable defaults will
390	resources are specified, suitable defaults will be used. Command-line	498	be used. Command-line arguments can be used to override resource
391	arguments can be used to override resource settings. The following	499	settings. The following resources are supported (you might want to
392	resources are allowed:	500	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		501	extensions not documented here):
393		502
394	=over 4	503	=over 4
395		504
396	=item B<geometry:> I<geom>	505	=item B<geometry:> I<geom>
397		506
…		…
427		536
428	=item B<colorIT:> I<colour>	537	=item B<colorIT:> I<colour>
429		538
430	Use the specified colour to display bold or italic characters when the	539	Use the specified colour to display bold or italic characters when the
431	foreground colour is the default. If font styles are not available	540	foreground colour is the default. If font styles are not available
432	(Compile styles) and this option is unset, reverse video is used instead.	541	(Compile I<styles>) and this option is unset, reverse video is used instead.
433		542
434	=item B<colorUL:> I<colour>	543	=item B<colorUL:> I<colour>
435		544
436	Use the specified colour to display underlined characters when the	545	Use the specified colour to display underlined characters when the
437	foreground colour is the default.	546	foreground colour is the default.
438		547
439	=item B<colorRV:> I<colour>	548	=item B<colorRV:> I<colour>
440		549
441	Use the specified colour as the background for reverse video	550	Use the specified colour as the background for reverse video
442	characters.	551	characters.
		552
		553	=item B<underlineColor:> I<colour>
		554
		555	If set, use the specified colour as the colour for the underline
		556	itself. If unset, use the foreground colour.
443		557
444	=item B<cursorColor:> I<colour>	558	=item B<cursorColor:> I<colour>
445		559
446	Use the specified colour for the cursor. The default is to use the	560	Use the specified colour for the cursor. The default is to use the
447	foreground colour; option B<-cr>.	561	foreground colour; option B<-cr>.
…		…
470	artificial transparency. B<False>: do not inherit the parent windows'	584	artificial transparency. B<False>: do not inherit the parent windows'
471	pixmap.	585	pixmap.
472		586
473	=item B<fading:> I<number>	587	=item B<fading:> I<number>
474		588
475	Fade the text by the given percentage when focus is lost.	589	Fade the text by the given percentage when focus is lost; option B<-fade>.
		590
		591	=item B<fadeColor:> I<colour>
		592
		593	Fade to this colour, when fading is used (see B<fading:>). The default
		594	colour is black; option B<-fadecolor>.
476		595
477	=item B<tintColor:> I<colour>	596	=item B<tintColor:> I<colour>
478		597
479	Tint the transparent background pixmap with the given colour.	598	Tint the transparent background pixmap with the given colour; option
		599	B<-tint>.
480		600
481	=item B<shading:> I<number>	601	=item B<shading:> I<number>
482		602
483	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	603	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
484	image in addition to tinting it.	604	image in addition to tinting it.
…		…
488	Use the specified colour for the scrollbar [default #B2B2B2].	608	Use the specified colour for the scrollbar [default #B2B2B2].
489		609
490	=item B<troughColor:> I<colour>	610	=item B<troughColor:> I<colour>
491		611
492	Use the specified colour for the scrollbar's trough area [default	612	Use the specified colour for the scrollbar's trough area [default
493	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	613	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
494		614
495	=item B<borderColor:> I<colour>	615	=item B<borderColor:> I<colour>
496		616
497	The colour of the border around the text area and between the scrollbar	617	The colour of the border around the text area and between the scrollbar
498	and the text.	618	and the text.
…		…
525		645
526	Select the fonts to be used. This is a comma separated list of font	646	Select the fonts to be used. This is a comma separated list of font
527	names that are used in turn when trying to display Unicode characters.	647	names that are used in turn when trying to display Unicode characters.
528	The first font defines the cell size for characters; other fonts might	648	The first font defines the cell size for characters; other fonts might
529	be smaller, but not larger. A reasonable default font list is always	649	be smaller, but not larger. A reasonable default font list is always
530	appended to it. option B<-fn>.	650	appended to it; option B<-fn>.
531		651
532	Each font can either be a standard X11 core font (XLFD) name, with	652	Each font can either be a standard X11 core font (XLFD) name, with
533	optional prefix C<x:> or a Xft font (Compile xft), prefixed with C<xft:>.	653	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
534		654
535	In addition, each font can be prefixed with additional hints and	655	In addition, each font can be prefixed with additional hints and
536	specifications enclosed in square brackets (C<[]>). The only available	656	specifications enclosed in square brackets (C<[]>). The only available
537	hint currently is C<codeset=codeset-name>, and this is only used for Xft	657	hint currently is C<codeset=codeset-name>, and this is only used for Xft
538	fonts.	658	fonts.
…		…
581	not possible, replacement fonts of the desired shape will be tried.	701	not possible, replacement fonts of the desired shape will be tried.
582		702
583	If set, but empty, then this specific style is disabled and the normal	703	If set, but empty, then this specific style is disabled and the normal
584	text font will being used for the given style.	704	text font will being used for the given style.
585		705
		706	=item B<intensityStyles:> I<boolean>
		707
		708	When font styles are not enabled, or this option is enabled (B<True>,
		709	option B<-is>, the default), bold and italic font styles imply high
		710	intensity foreground/backround colours. Disabling this option (B<False>,
		711	option B<+is>) disables this behaviour, the high intensity colours are not
		712	reachable.
		713
586	=item B<selectstyle:> I<mode>	714	=item B<selectstyle:> I<mode>
587		715
588	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	716	Set mouse selection style to B<old> which is 2.20, B<oldword> which is
589	xterm style with 2.20 old word selection, or anything else which gives	717	xterm style with 2.20 old word selection, or anything else which gives
590	xterm style selection.	718	xterm style selection.
591		719
592	=item B<scrollstyle:> I<mode>	720	=item B<scrollstyle:> I<mode>
593		721
594	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	722	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
595	the author's favourite..	723	the author's favourite.
596		724
597	=item B<title:> I<string>	725	=item B<title:> I<string>
598		726
599	Set window title string, the default title is the command-line	727	Set window title string, the default title is the command-line
600	specified after the B<-e> option, if any, otherwise the application	728	specified after the B<-e> option, if any, otherwise the application
…		…
632		760
633	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	761	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
634	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or	762	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
635	B<Shift-Print> to include the scrollback as well.	763	B<Shift-Print> to include the scrollback as well.
636		764
		765	The string will be interpreted as if typed into the shell as-is.
		766
		767	Example:
		768
		769	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		770
		771	This creates a new file in your home directory with the screen contents
		772	everytime you hit C<Print>.
		773
637	=item B<scrollBar:> I<boolean>	774	=item B<scrollBar:> I<boolean>
638		775
639	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	776	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
640	disable the scrollbar; option B<+sb>.	777	disable the scrollbar; option B<+sb>.
641		778
…		…
661	B<+si>.	798	B<+si>.
662		799
663	=item B<scrollWithBuffer:> I<boolean>	800	=item B<scrollWithBuffer:> I<boolean>
664		801
665	B<True>: scroll with scrollback buffer when tty receives new lines (and	802	B<True>: scroll with scrollback buffer when tty receives new lines (and
666	B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll	803	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
667	with scrollback buffer when tty recieves new lines; option B<-sw>.	804	with scrollback buffer when tty recieves new lines; option B<+sw>.
668		805
669	=item B<scrollTtyKeypress:> I<boolean>	806	=item B<scrollTtyKeypress:> I<boolean>
670		807
671	B<True>: scroll to bottom when a non-special key is pressed. Special keys	808	B<True>: scroll to bottom when a non-special key is pressed. Special keys
672	are those which are intercepted by rxvt-unicode for special handling and	809	are those which are intercepted by rxvt-unicode for special handling and
…		…
691	=item B<borderLess:> I<boolean>	828	=item B<borderLess:> I<boolean>
692		829
693	Set MWM hints to request a borderless window, i.e. if honoured by the	830	Set MWM hints to request a borderless window, i.e. if honoured by the
694	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.	831	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
695		832
		833	=item B<skipBuiltinGlyphs:> I<boolean>
		834
		835	Compile I<frills>: Disable the usage of the built-in block graphics/line
		836	drawing characters and just rely on what the specified fonts provide. Use
		837	this if you have a good font and want to use its block graphic glyphs;
		838	option B<-sbg>.
		839
696	=item B<termName:> I<termname>	840	=item B<termName:> I<termname>
697		841
698	Specifies the terminal type name to be set in the B<TERM> environment	842	Specifies the terminal type name to be set in the B<TERM> environment
699	variable; option B<-tn>.	843	variable; option B<-tn>.
700		844
…		…
737		881
738	Mouse pointer background colour.	882	Mouse pointer background colour.
739		883
740	=item B<pointerBlankDelay:> I<number>	884	=item B<pointerBlankDelay:> I<number>
741		885
742	Specifies number of seconds before blanking the pointer [default 2].	886	Specifies number of seconds before blanking the pointer [default 2]. Use a
		887	large number (e.g. C<987654321>) to effectively disable the timeout.
743		888
744	=item B<backspacekey:> I<string>	889	=item B<backspacekey:> I<string>
745		890
746	The string to send when the backspace key is pressed. If set to B<DEC>	891	The string to send when the backspace key is pressed. If set to B<DEC>
747	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	892	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
…		…
769		914
770	I<name> of inputMethod to use; option B<-im>.	915	I<name> of inputMethod to use; option B<-im>.
771		916
772	=item B<imLocale:> I<name>	917	=item B<imLocale:> I<name>
773		918
774	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	919	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
775	de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input	920	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
776	extension to be able to input japanese characters while staying in	921	input extension to be able to input japanese characters while staying in
777	another locale. option B<-imlocale>.	922	another locale; option B<-imlocale>.
		923
		924	=item B<imFont:> I<fontset>
		925
		926	Specify the font-set used for XIM styles C<OverTheSpot> or
		927	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
		928	by commas), i.e. it's not in the same format as the other font lists used
		929	in @@RXVT_NAME@@. The default will be set-up to chose any suitable found
		930	found, preferably one or two pixels differing in size to the base font.
		931	option B<-imfont>.
		932
		933	=item B<tripleclickwords:> I<boolean>
		934
		935	Change the meaning of triple-click selection with the left mouse
		936	button. Instead of selecting a full line it will extend the selection to
		937	the end of the logical line only; option B<-tcw>.
778		938
779	=item B<insecure:> I<boolean>	939	=item B<insecure:> I<boolean>
780		940
781	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	941	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
782	echo arbitrary strings like the icon name or the locale. This could be	942	echo arbitrary strings like the icon name or the locale. This could be
783	abused if somebody gets 8-bit-clean access to your display, whether	943	abused if somebody gets 8-bit-clean access to your display, whether
784	throuh a mail client displaying mail bodies unfiltered or though	944	through a mail client displaying mail bodies unfiltered or through
785	write(1). Therefore, these sequences are disabled by default. (Note	945	write(1) or any other means. Therefore, these sequences are disabled by
786	that other terminals, including xterm, have these sequences	946	default. (Note that many other terminals, including xterm, have these
787	enabled by default). You can enable them by setting this boolean	947	sequences enabled by default, which doesn't make it safer, though).
788	resource or specifying B<-insecure> as an option. At the moment, this	948
789	enabled display-answer, locale, findfont, icon label and window title	949	You can enable them by setting this boolean resource or specifying
790	requests as well as dynamic menubar dispatch.	950	B<-insecure> as an option. At the moment, this enables display-answer,
		951	locale, findfont, icon label and window title requests as well as dynamic
		952	menubar dispatch.
791		953
792	=item B<modifier:> I<modifier>	954	=item B<modifier:> I<modifier>
793		955
794	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	956	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
795	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	957	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
810	Turn on/off secondary screen scroll (default enabled). If the this	972	Turn on/off secondary screen scroll (default enabled). If the this
811	option is enabled, scrolls on the secondary screen will change the	973	option is enabled, scrolls on the secondary screen will change the
812	scrollback buffer and switching to/from the secondary screen will	974	scrollback buffer and switching to/from the secondary screen will
813	instead scroll the screen up.	975	instead scroll the screen up.
814		976
		977	=item B<hold>: I<bool>
		978
		979	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		980	will not immediately destroy its window when the program executed within
		981	it exits. Instead, it will wait till it is being killed or closed by the
		982	user.
		983
815	=item B<keysym.>I<sym>: I<string>	984	=item B<keysym.>I<sym>: I<string>
816		985
817	Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may	986	Compile I<frills>: Associate I<string> with keysym I<sym>. The
818	contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:	987	intervening resource name B<keysym.> cannot be omitted.
819	newline, \r: return, \t:	988
		989	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
		990	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
		991	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
		992	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
		993	B<2>, B<3>, B<4>, B<5>.
		994
		995	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
		996	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
		997	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
		998	current application keymap mode state.
		999
		1000	The spellings of I<key> can be obtained by using B<xev>(1) command or
		1001	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
		1002	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
		1003	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
		1004	performed in an exact manner; however, the closest match is assured.
		1005
		1006	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
		1007	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
820	tab, \000: octal number) or control characters (^?: delete, ^@: null,	1008	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
821	^A ...) and may enclosed with double quotes so that it can start or end	1009	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
822	with whitespace. The intervening resource name B<keysym.> cannot be	1010	can start or end with whitespace.
823	omitted. This resource is only available when compiled with	1011
824	KEYSYM_RESOURCE.	1012	Please note that you need to double the C<\> in resource files, as
		1013	Xlib itself does it's own de-escaping (you can use C<\033> instead of
		1014	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
		1015	processing).
		1016
		1017	You can define a range of keysyms in one shot by providing a I<string>
		1018	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
		1019	should be a character not used by the strings.
		1020
		1021	Its usage can be demonstrated by an example:
		1022
		1023	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
		1024
		1025	The above line is equivalent to the following three lines:
		1026
		1027	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
		1028	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
		1029	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
		1030
		1031	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
		1032	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
		1033	example the following means "change the current locale to C<zh_CN.GBK>
		1034	when Control-Meta-c is being pressed":
		1035
		1036	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		1037
		1038	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1039	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1040	manpage. For example, the F<selection> extension (activated via
		1041	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1042
		1043	URxvt.keysym.M-C-c: perl:selection:rot13
		1044
		1045	Due the the large number of modifier combinations, a defined key mapping
		1046	will match if at I<at least> the specified identifiers are being set, and
		1047	no other key mappings with those and more bits are being defined. That
		1048	means that defining a key map for C<a> will automatically provide
		1049	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		1050	mappings themselves.
		1051
		1052	Unfortunately, this will override built-in key mappings. For example
		1053	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		1054	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		1055	user-defined keymap using the C<builtin:> replacement:
		1056
		1057	URxvt.keysym.Insert: <my insert key sequence>
		1058	URxvt.keysym.S-Insert: builtin:
		1059
		1060	The first line defines a mapping for C<Insert> and I<any> combination
		1061	of modifiers. The second line re-establishes the default mapping for
		1062	C<Shift-Insert>.
		1063
		1064	The following example will map Control-Meta-1 and Control-Meta-2 to
		1065	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
		1066	font-switching at runtime:
		1067
		1068	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1069	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
		1070
		1071	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
		1072	info):
		1073
		1074	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1075	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1076
		1077	=item B<perl-ext-common>: I<string>
		1078
		1079	=item B<perl-ext>: I<string>
		1080
		1081	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1082	use in this terminal instance; option B<-pe>.
		1083
		1084	Extension names can be prefixed with a C<-> sign to prohibit using
		1085	them. This can be useful to selectively disable some extensions loaded
		1086	by default, or specified via the C<perl-ext-common> resource. For
		1087	example, C<default,-selection> will use all the default extension except
		1088	C<selection>.
		1089
		1090	Extension names can also be followed by an argument in angle brackets
		1091	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1092	searchable scorllback to Alt/Meta-s). Mentioning the same extension
		1093	multiple times with different arguments will pass multiple arguments to
		1094	the extension.
		1095
		1096	Each extension is looked up in the library directories, loaded if
		1097	necessary, and bound to the current terminal instance.
		1098
		1099	If both of these resources are the empty string, then the perl
		1100	interpreter will not be initialized. The idea behind two options is that
		1101	B<perl-ext-common> will be used for extensions that should be available to
		1102	all instances, while B<perl-ext> is used for specific instances.
		1103
		1104	=item B<perl-eval>: I<string>
		1105
		1106	Perl code to be evaluated when all extensions have been registered. See
		1107	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
		1108	will be ignored when running setuid/setgid.
		1109
		1110	=item B<perl-lib>: I<path>
		1111
		1112	Colon-separated list of additional directories that hold extension
		1113	scripts. When looking for extensions specified by the C<perl> resource,
		1114	@@RXVT_NAME@@ will first look in these directories and then in
		1115	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
		1116	will be ignored when running setuid/setgid.
		1117
		1118	See the @@RXVT_NAME@@perl(3) manpage.
		1119
		1120	=item B<searchable-scrollback:> I<keysym>
		1121
		1122	Sets the hotkey that starts the incremental scrollback buffer search
		1123	(default: C<M-s>).
		1124
		1125	=item B<urlLauncher>: I<string>
		1126
		1127	Specifies the program to be started with a URL argument. Used by the
		1128	C<selection-popup> and C<mark-urls> perl extensions.
		1129
		1130	=item B<transient-for>: I<windowid>
		1131
		1132	Sets the WM_TRANSIENT_FOR property to the given window iw.
825		1133
826	=back	1134	=back
827		1135
828	=head1 THE SCROLLBAR	1136	=head1 THE SCROLLBAR
829		1137
…		…
843	the normal text selection/insertion, hold either the Shift or the Meta	1151	the normal text selection/insertion, hold either the Shift or the Meta
844	(Alt) key while performing the desired mouse action.	1152	(Alt) key while performing the desired mouse action.
845		1153
846	If mouse reporting mode is active, the normal scrollbar actions are	1154	If mouse reporting mode is active, the normal scrollbar actions are
847	disabled -- on the assumption that we are using a fullscreen	1155	disabled -- on the assumption that we are using a fullscreen
848	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	1156	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
849	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	1157	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
850	up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down),	1158	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
851	respectively.	1159	respectively.
852		1160
853	=head1 TEXT SELECTION AND INSERTION	1161	=head1 TEXT SELECTION AND INSERTION
854		1162
855	The behaviour of text selection and insertion mechanism is similar to	1163	The behaviour of text selection and insertion mechanism is similar to
…		…
857		1165
858	=over 4	1166	=over 4
859		1167
860	=item B<Selection>:	1168	=item B<Selection>:
861		1169
862	Left click at the beginning of the region, drag to the end of the	1170	Left click at the beginning of the region, drag to the end of the region
863	region and release; Right click to extend the marked region; Left	1171	and release; Right click to extend the marked region; Left double-click
864	double-click to select a word; Left triple-click to select the entire	1172	to select a word; Left triple-click to select the entire logical line
865	line.	1173	(which can span multiple screen lines), unless modified by resource
		1174	B<tripleclickwords>.
866		1175
867	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1176	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
868	(Compile: frills) will create a rectangular selection instead of a normal	1177	(Compile: I<frills>) will create a rectangular selection instead of a
869	one.	1178	normal one. In this mode, every selected row becomes its own line in the
		1179	selection, and trailing whitespace is visually underlined and removed from
		1180	the selection.
870		1181
871	=item B<Insertion>:	1182	=item B<Insertion>:
872		1183
873	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1184	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
874	an B<@@RXVT_NAME@@> window causes the current text selection to be	1185	an B<@@RXVT_NAME@@> window causes the current text selection to be
…		…
882	supported in rxvt-unicode. Bug me if you need this.	1193	supported in rxvt-unicode. Bug me if you need this.
883		1194
884	You can, however, switch fonts at runtime using escape sequences (and	1195	You can, however, switch fonts at runtime using escape sequences (and
885	therefore using the menubar), e.g.:	1196	therefore using the menubar), e.g.:
886		1197
887	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1198	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
888		1199
889	rxvt-unicode will automatically re-apply these fonts to the output so far.	1200	rxvt-unicode will automatically re-apply these fonts to the output so far.
890		1201
891	=head1 ISO 14755 SUPPORT	1202	=head1 ISO 14755 SUPPORT
892		1203
…		…
896	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1207	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
897	with C<--enable-iso14755>.	1208	with C<--enable-iso14755>.
898		1209
899	=over 4	1210	=over 4
900		1211
901	=item 5.1: Basic method	1212	=item * 5.1: Basic method
902		1213
903	This allows you to enter unicode characters using their hexcode.	1214	This allows you to enter unicode characters using their hexcode.
904		1215
905	Start by pressing and holding both C<Control> and C<Shift>, then enter	1216	Start by pressing and holding both C<Control> and C<Shift>, then enter
906	hex-digits (between one and six). Releasing C<Control> and C<Shift> will	1217	hex-digits (between one and six). Releasing C<Control> and C<Shift> will
…		…
913	address, which you cannot type. Fortunately, the card has the e-mail	1224	address, which you cannot type. Fortunately, the card has the e-mail
914	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily	1225	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
915	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,	1226	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
916	followed by releasing the modifier keys.	1227	followed by releasing the modifier keys.
917		1228
918	=item 5.2: Keyboard symbols entry method	1229	=item * 5.2: Keyboard symbols entry method
919		1230
920	This mode lets you input characters representing the keycap symbols of	1231	This mode lets you input characters representing the keycap symbols of
921	your keyboard, if representable in the current locale encoding.	1232	your keyboard, if representable in the current locale encoding.
922		1233
923	Start by pressing C<Control> and C<Shift> together, then releasing	1234	Start by pressing C<Control> and C<Shift> together, then releasing
…		…
926	keycap symbol. The symbol will only be entered when the key has been	1237	keycap symbol. The symbol will only be entered when the key has been
927	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1238	released, otherwise pressing e.g. C<Shift> would enter the symbol for
928	C<ISO Level 2 Switch>, although your intention might have been to enter a	1239	C<ISO Level 2 Switch>, although your intention might have been to enter a
929	reverse tab (Shift-Tab).	1240	reverse tab (Shift-Tab).
930		1241
931	=item 5.3: Screen-selection entry method	1242	=item * 5.3: Screen-selection entry method
932		1243
933	While this is implemented already (it's basically the selection	1244	While this is implemented already (it's basically the selection
934	mechanism), it could be extended by displaying a unicode character map.	1245	mechanism), it could be extended by displaying a unicode character map.
935		1246
936	=item 5.4: Feedback method for identifying displayed characters for later input	1247	=item * 5.4: Feedback method for identifying displayed characters for later input
937		1248
938	This method lets you display the unicode character code associated with	1249	This method lets you display the unicode character code associated with
939	characters already displayed.	1250	characters already displayed.
940		1251
941	You enter this mode by holding down C<Control> and C<Shift> together, then	1252	You enter this mode by holding down C<Control> and C<Shift> together, then
…		…
953	With respect to conformance, rxvt-unicode is supposed to be compliant to	1264	With respect to conformance, rxvt-unicode is supposed to be compliant to
954	both scenario A and B of ISO 14755, including part 5.2.	1265	both scenario A and B of ISO 14755, including part 5.2.
955		1266
956	=head1 LOGIN STAMP	1267	=head1 LOGIN STAMP
957		1268
958	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so	1269	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
959	that it can be seen via the I<who(1)> command, and can accept messages.	1270	it can be seen via the I<who(1)> command, and can accept messages. To
960	To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on	1271	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
961	some systems.	1272	on some systems or setgid to root or to some other group on others.
962		1273
963	=head1 COLORS AND GRAPHICS	1274	=head1 COLORS AND GRAPHICS
964		1275
965	In addition to the default foreground and background colours,	1276	In addition to the default foreground and background colours,
966	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1277	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
…		…
1009		1320
1010	=back	1321	=back
1011		1322
1012	=head1 ENVIRONMENT	1323	=head1 ENVIRONMENT
1013		1324
1014	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>	1325	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1015	and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X	1326
1016	window id number of the B<@@RXVT_NAME@@> window and it also uses and	1327	=over 4
1017	sets the environment variable B<DISPLAY> to specify which display	1328
1018	terminal to use. B<@@RXVT_NAME@@> uses the environment variables	1329	=item B<TERM>
1019	B<RXVTPATH> and B<PATH> to find XPM files.	1330
		1331	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
		1332	resources or on the commandline.
		1333
		1334	=item B<COLORTERM>
		1335
		1336	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
		1337	compiled with XPM support, and optionally with the added extension
		1338	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
		1339
		1340	=item B<COLORFGBG>
		1341
		1342	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
		1343	the colour code used as default foreground/text colour (or the string
		1344	C<default> to indicate that the default-colour escape sequence is to be
		1345	used), C<bg> is the colour code used as default background colour (or the
		1346	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1347	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
		1348	(and do) use this information to optimize screen output.
		1349
		1350	=item B<WINDOWID>
		1351
		1352	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
		1353	window, which usually has subwindows for the scrollbar, the terminal
		1354	window and so on).
		1355
		1356	=item B<TERMINFO>
		1357
		1358	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1359	C<--with-terminfo=PATH>.
		1360
		1361	=item B<DISPLAY>
		1362
		1363	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
		1364	display in it's child processes.
		1365
		1366	=item B<SHELL>
		1367
		1368	The shell to be used for command execution, defaults to C</bin/sh>.
		1369
		1370	=item B<RXVTPATH>
		1371
		1372	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
		1373	files.
		1374
		1375	=item B<PATH>
		1376
		1377	Used in the same way as C<RXVTPATH>.
		1378
		1379	=item B<RXVT_SOCKET>
		1380
		1381	The unix domain socket path used by @@RXVT_NAME@@c(1) and
		1382	@@RXVT_NAME@@d(1).
		1383
		1384	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
		1385
		1386	=item B<HOME>
		1387
		1388	Used to locate the default directory for the unix domain socket for
		1389	daemon communications and to locate various resource files (such as
		1390	C<.Xdefaults>)
		1391
		1392	=item B<XAPPLRESDIR>
		1393
		1394	Directory where various X resource files are being located.
		1395
		1396	=item B<XENVIRONMENT>
		1397
		1398	If set and accessible, gives the name of a X resource file to be loaded by
		1399	@@RXVT_NAME@@.
		1400
		1401	=back
1020		1402
1021	=head1 FILES	1403	=head1 FILES
1022		1404
1023	=over 4	1405	=over 4
1024		1406
1025	=item B</etc/utmp>
1026
1027	System file for login records.
1028
1029	=item B</usr/lib/X11/rgb.txt>	1407	=item B</usr/lib/X11/rgb.txt>
1030		1408
1031	Color names.	1409	Color names.
1032		1410
1033	=back	1411	=back
1034		1412
1035	=head1 SEE ALSO	1413	=head1 SEE ALSO
1036		1414
1037	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1415	@@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)
1038
1039	=head1 BUGS
1040
1041	Check the BUGS file for an up-to-date list.
1042
1043	Cursor change support is not yet implemented.
1044
1045	Click-and-drag doesn't work with X11 mouse report overriding.
1046		1416
1047	=head1 CURRENT PROJECT COORDINATOR	1417	=head1 CURRENT PROJECT COORDINATOR
1048		1418
1049	=over 4	1419	=over 4
1050		1420
1051	=item Project Coordinator	1421	=item Project Coordinator
1052		1422
1053	@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@>	1423	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1054		1424
1055	=item Web page maintainter	1425	L<http://software.schmorp.de/#rxvt-unicode>
1056
1057	@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1058
1059	L<@@RXVT_WEBPAGE@@>
1060		1426
1061	=back	1427	=back
1062		1428
1063	=head1 AUTHORS	1429	=head1 AUTHORS
1064		1430
…		…
1089	=item Geoff Wing L<< <gcw@pobox.com> >>	1455	=item Geoff Wing L<< <gcw@pobox.com> >>
1090		1456
1091	Rewrote screen display and text selection routines. Project Coordinator	1457	Rewrote screen display and text selection routines. Project Coordinator
1092	(changes.txt 2.4.6 - rxvt-unicode)	1458	(changes.txt 2.4.6 - rxvt-unicode)
1093		1459
1094	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>	1460	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1095		1461
1096	Forked rxvt-unicode, rewrote most of the display code and internal	1462	Forked rxvt-unicode, rewrote most of the display code and internal
1097	character handling to store text in unicode, improve xterm	1463	character handling to store text in unicode, improve xterm
1098	compatibility and apply numerous other bugfixes and extensions.	1464	compatibility and apply numerous other bugfixes and extensions.
1099		1465

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.34 by root, Wed Dec 1 02:29:14 2004 UTC vs. Revision 1.94 by root, Thu Jan 12 05:37:34 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.34 by root, Wed Dec 1 02:29:14 2004 UTC vs.
Revision 1.94 by root, Thu Jan 12 05:37:34 2006 UTC