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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.30 by root, Wed Sep 8 17:10:23 2004 UTC vs.
Revision 1.85 by root, Wed Jan 4 20:43:37 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>.
…		…
162	=item B<-fn> I<fontlist>	174	=item B<-fn> I<fontlist>
163		175
164	Select the fonts to be used. This is a comma separated list of font names	176	Select the fonts to be used. This is a comma separated list of font names
165	that are used in turn when trying to display Unicode characters. The	177	that are used in turn when trying to display Unicode characters. The
166	first font defines the cell size for characters; other fonts might be	178	first font defines the cell size for characters; other fonts might be
167	smaller, but not (in general) larger. A reasonable default font list is	179	smaller, but not (in general) larger. A (hopefully) reasonable default
168	always appended to it. See resource B<font> for details.	180	font list is always appended to it. See resource B<font> for more details.
		181
		182	In short, to specify an X11 core font, just specify it's name or prefix it
		183	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
		184	e.g.:
		185
		186	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
		187	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
169		188
170	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
171	section of @@RXVT_NAME@@(7).	190	section of @@RXVT_NAME@@(7).
172		191
173	=item B<-fb> I<fontlist>	192	=item B<-fb> I<fontlist>
174		193
175	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
176	be printed. See resource B<boldFont> for details.	195	are to be printed. See resource B<boldFont> for details.
177		196
178	=item B<-fi> I<fontlist>	197	=item B<-fi> I<fontlist>
179		198
180	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>
181	be printed. See resource B<italicFont> for details.	200	characters are to be printed. See resource B<italicFont> for details.
182		201
183	=item B<-fbi> I<fontlist>	202	=item B<-fbi> I<fontlist>
184		203
185	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
186	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.
187		213
188	=item B<-name> I<name>	214	=item B<-name> I<name>
189		215
190	Specify the application name under which resources are to be obtained,	216	Specify the application name under which resources are to be obtained,
191	rather than the default executable file name. Name should not contain	217	rather than the default executable file name. Name should not contain
…		…
229		255
230	Put scrollbar on right/left; resource B<scrollBar_right>.	256	Put scrollbar on right/left; resource B<scrollBar_right>.
231		257
232	=item B<-st>\|B<+st>	258	=item B<-st>\|B<+st>
233		259
234	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	260	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
235	resource B<scrollBar_floating>.	261	resource B<scrollBar_floating>.
		262
		263	=item B<-ptab>\|B<+ptab>
		264
		265	If enabled (default), "Horizontal Tab" characters are being stored as
		266	actual wide characters in the screen buffer, which makes it possible to
		267	select and paste them. Since a horizontal tab is a cursor movement and
		268	not an actual glyph, this can sometimes be visually annoying as the cursor
		269	on a tab character is displayed as a wide cursor; resource B<pastableTabs>.
236		270
237	=item B<-bc>\|B<+bc>	271	=item B<-bc>\|B<+bc>
238		272
239	Blink the cursor; resource B<cursorBlink>.	273	Blink the cursor; resource B<cursorBlink>.
240		274
…		…
263		297
264	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.
265	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
266	decorations; resource B<borderLess>.	300	decorations; resource B<borderLess>.
267		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
268	=item B<-lsp> I<number>	309	=item B<-lsp> I<number>
269		310
270	Compile I<linespace>: Lines (pixel height) to insert between each row	311	Compile I<frills>: Lines (pixel height) to insert between each row of
271	of the display; resource B<linespace>.	312	the display. Useful to work around font rendering problems; resource
		313	B<linespace>.
272		314
273	=item B<-tn> I<termname>	315	=item B<-tn> I<termname>
274		316
275	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
276	B<TERM> environment variable. This terminal type must exist in the	318	B<TERM> environment variable. This terminal type must exist in the
…		…
285	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
286	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
287	run the program specified by the B<SHELL> environment variable or,	329	run the program specified by the B<SHELL> environment variable or,
288	failing that, I<sh(1)>.	330	failing that, I<sh(1)>.
289		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
290	=item B<-title> I<text>	337	=item B<-title> I<text>
291		338
292	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
293	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
294	application name; resource B<title>.	341	application name; resource B<title>.
…		…
312		359
313	Compile I<XIM>: input method name. resource B<inputMethod>.	360	Compile I<XIM>: input method name. resource B<inputMethod>.
314		361
315	=item B<-imlocale> I<string>	362	=item B<-imlocale> I<string>
316		363
317	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.
318	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
319	extension to be able to input japanese characters while staying in	366	input extension to be able to input japanese characters while staying in
320	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>.
321		379
322	=item B<-insecure>	380	=item B<-insecure>
323		381
324	Enable "insecure" mode, which currently enables most of the escape	382	Enable "insecure" mode, which currently enables most of the escape
325	sequences that echo strings. See the resource B<insecure> for more	383	sequences that echo strings. See the resource B<insecure> for more
…		…
339	=item B<-ssr>\|B<+ssr>	397	=item B<-ssr>\|B<+ssr>
340		398
341	Turn on/off secondary screen scroll (default enabled); resource	399	Turn on/off secondary screen scroll (default enabled); resource
342	B<secondaryScroll>.	400	B<secondaryScroll>.
343		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<fileno>
		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	Here is a example in perl that illustrates how this option can be used (a
		452	longer example is in F<doc/pty-fd>):
		453
		454	use IO::Pty;
		455	use Fcntl;
		456
		457	my $pty = new IO::Pty;
		458	fcntl $pty, F_SETFD, 0; # clear close-on-exec
		459	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		460	close $pty;
		461
		462	# now communicate with rxvt
		463	my $slave = $pty->slave;
		464	while (<$slave>) { print $slave "got <$_>\n" }
		465
344	=item B<-xrm> I<resourcestring>	466	=item B<-pe> I<string>
345		467
346	No effect on rxvt-unicode. Simply passes through an argument to be made	468	Colon-separated list of perl extension scripts to use in this terminal
347	available in the instance's argument list. Appears in I<WM_COMMAND> in	469	instance. See resource B<perl-ext>.
348	some window managers.
349		470
350	=back	471	=back
351		472
352	=head1 RESOURCES (available also as long-options)	473	=head1 RESOURCES (available also as long-options)
353		474
…		…
356		477
357	There are two different methods that @@RXVT_NAME@@ can use to get the	478	There are two different methods that @@RXVT_NAME@@ can use to get the
358	Xresource data: using the X libraries (Xrm*-functions) or internal	479	Xresource data: using the X libraries (Xrm*-functions) or internal
359	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	480	Xresources reader (B<~/.Xdefaults>). For the first method (ie.
360	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	481	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the
361	resources using X11 tools like B<xset>. Many distribution do also load	482	resources using X11 tools like B<xrdb>. Many distribution do also load
362	settings from the B<~/.Xresources> file when X starts.	483	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
		484	will consult the following files/resources in order, with later settings
		485	overwriting earlier ones:
		486
		487	1. system-wide app-defaults file, either locale-dependent OR global
		488	2. app-defaults file in $XAPPLRESDIR
		489	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
		490	4. SCREEN_RESOURCES for the current screen
		491	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
363		492
364	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>	493	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
365	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults	494	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
366	set in XAPPLOADDIR/URxvt (compile-time defined: usually	495	set in XAPPLOADDIR/URxvt (compile-time defined: usually
367	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	496	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
…		…
412		541
413	=item B<colorIT:> I<colour>	542	=item B<colorIT:> I<colour>
414		543
415	Use the specified colour to display bold or italic characters when the	544	Use the specified colour to display bold or italic characters when the
416	foreground colour is the default. If font styles are not available	545	foreground colour is the default. If font styles are not available
417	(Compile styles) and this option is unset, reverse video is used instead.	546	(Compile I<styles>) and this option is unset, reverse video is used instead.
418		547
419	=item B<colorUL:> I<colour>	548	=item B<colorUL:> I<colour>
420		549
421	Use the specified colour to display underlined characters when the	550	Use the specified colour to display underlined characters when the
422	foreground colour is the default.	551	foreground colour is the default.
423		552
424	=item B<colorRV:> I<colour>	553	=item B<colorRV:> I<colour>
425		554
426	Use the specified colour as the background for reverse video	555	Use the specified colour as the background for reverse video
427	characters.	556	characters.
		557
		558	=item B<underlineColor:> I<colour>
		559
		560	If set, use the specified colour as the colour for the underline
		561	itself. If unset, use the foreground colour.
428		562
429	=item B<cursorColor:> I<colour>	563	=item B<cursorColor:> I<colour>
430		564
431	Use the specified colour for the cursor. The default is to use the	565	Use the specified colour for the cursor. The default is to use the
432	foreground colour; option B<-cr>.	566	foreground colour; option B<-cr>.
…		…
455	artificial transparency. B<False>: do not inherit the parent windows'	589	artificial transparency. B<False>: do not inherit the parent windows'
456	pixmap.	590	pixmap.
457		591
458	=item B<fading:> I<number>	592	=item B<fading:> I<number>
459		593
460	Fade the text by the given percentage when focus is lost.	594	Fade the text by the given percentage when focus is lost; option B<-fade>.
		595
		596	=item B<fadeColor:> I<colour>
		597
		598	Fade to this colour, when fading is used (see B<fading:>). The default
		599	colour is black; option B<-fadecolor>.
461		600
462	=item B<tintColor:> I<colour>	601	=item B<tintColor:> I<colour>
463		602
464	Tint the transparent background pixmap with the given colour.	603	Tint the transparent background pixmap with the given colour; option
		604	B<-tint>.
465		605
466	=item B<shading:> I<number>	606	=item B<shading:> I<number>
467		607
468	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	608	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
469	image in addition to tinting it.	609	image in addition to tinting it.
470		610
471	=item B<fading:> I<number>
472
473	Scale the tint colour by the given percentage.
474
475	=item B<scrollColor:> I<colour>	611	=item B<scrollColor:> I<colour>
476		612
477	Use the specified colour for the scrollbar [default #B2B2B2].	613	Use the specified colour for the scrollbar [default #B2B2B2].
478		614
479	=item B<troughColor:> I<colour>	615	=item B<troughColor:> I<colour>
480		616
481	Use the specified colour for the scrollbar's trough area [default	617	Use the specified colour for the scrollbar's trough area [default
482	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	618	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
483		619
484	=item B<borderColor:> I<colour>	620	=item B<borderColor:> I<colour>
485		621
486	The colour of the border around the text area and between the scrollbar	622	The colour of the border around the text area and between the scrollbar
487	and the text.	623	and the text.
…		…
514		650
515	Select the fonts to be used. This is a comma separated list of font	651	Select the fonts to be used. This is a comma separated list of font
516	names that are used in turn when trying to display Unicode characters.	652	names that are used in turn when trying to display Unicode characters.
517	The first font defines the cell size for characters; other fonts might	653	The first font defines the cell size for characters; other fonts might
518	be smaller, but not larger. A reasonable default font list is always	654	be smaller, but not larger. A reasonable default font list is always
519	appended to it. option B<-fn>.	655	appended to it; option B<-fn>.
520		656
521	Each font can either be a standard X11 core font (XLFD) name, with	657	Each font can either be a standard X11 core font (XLFD) name, with
522	optional prefix C<x:> or a Xft font (Compile xft), prefixed with C<xft:>.	658	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
523		659
524	In addition, each font can be prefixed with additional hints and	660	In addition, each font can be prefixed with additional hints and
525	specifications enclosed in square brackets (C<[]>). The only available	661	specifications enclosed in square brackets (C<[]>). The only available
526	hint currently is C<codeset=codeset-name>, and this is only used for Xft	662	hint currently is C<codeset=codeset-name>, and this is only used for Xft
527	fonts.	663	fonts.
…		…
537	specifies five fonts to be used. The first one is C<9x15bold> (actually	673	specifies five fonts to be used. The first one is C<9x15bold> (actually
538	the iso8859-1 version of the second font), which is the base font (because	674	the iso8859-1 version of the second font), which is the base font (because
539	it is named first) and thus defines the character cell grid to be 9 pixels	675	it is named first) and thus defines the character cell grid to be 9 pixels
540	wide and 15 pixels high.	676	wide and 15 pixels high.
541		677
542	the second font is just used to add additional unicode characters not in	678	The second font is just used to add additional unicode characters not in
543	the base font, likewise the third, which is unfortunately non-bold, but	679	the base font, likewise the third, which is unfortunately non-bold, but
544	the bold version of the font does contain less characters, so this is a	680	the bold version of the font does contain less characters, so this is a
545	useful supplement.	681	useful supplement.
546		682
547	The third font is an Xft font with aliasing turned off, and the characters	683	The third font is an Xft font with aliasing turned off, and the characters
…		…
570	not possible, replacement fonts of the desired shape will be tried.	706	not possible, replacement fonts of the desired shape will be tried.
571		707
572	If set, but empty, then this specific style is disabled and the normal	708	If set, but empty, then this specific style is disabled and the normal
573	text font will being used for the given style.	709	text font will being used for the given style.
574		710
		711	=item B<intensityStyles:> I<boolean>
		712
		713	When font styles are not enabled, or this option is enabled (B<True>,
		714	option B<-is>, the default), bold and italic font styles imply high
		715	intensity foreground/backround colours. Disabling this option (B<False>,
		716	option B<+is>) disables this behaviour, the high intensity colours are not
		717	reachable.
		718
575	=item B<selectstyle:> I<mode>	719	=item B<selectstyle:> I<mode>
576		720
577	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	721	Set mouse selection style to B<old> which is 2.20, B<oldword> which is
578	xterm style with 2.20 old word selection, or anything else which gives	722	xterm style with 2.20 old word selection, or anything else which gives
579	xterm style selection.	723	xterm style selection.
580		724
581	=item B<scrollstyle:> I<mode>	725	=item B<scrollstyle:> I<mode>
582		726
583	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	727	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
584	the author's favourite..	728	the author's favourite.
585		729
586	=item B<title:> I<string>	730	=item B<title:> I<string>
587		731
588	Set window title string, the default title is the command-line	732	Set window title string, the default title is the command-line
589	specified after the B<-e> option, if any, otherwise the application	733	specified after the B<-e> option, if any, otherwise the application
…		…
621		765
622	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	766	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
623	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or	767	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
624	B<Shift-Print> to include the scrollback as well.	768	B<Shift-Print> to include the scrollback as well.
625		769
		770	The string will be interpreted as if typed into the shell as-is.
		771
		772	Example:
		773
		774	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		775
		776	This creates a new file in your home directory with the screen contents
		777	everytime you hit C<Print>.
		778
626	=item B<scrollBar:> I<boolean>	779	=item B<scrollBar:> I<boolean>
627		780
628	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	781	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
629	disable the scrollbar; option B<+sb>.	782	disable the scrollbar; option B<+sb>.
630		783
…		…
650	B<+si>.	803	B<+si>.
651		804
652	=item B<scrollWithBuffer:> I<boolean>	805	=item B<scrollWithBuffer:> I<boolean>
653		806
654	B<True>: scroll with scrollback buffer when tty receives new lines (and	807	B<True>: scroll with scrollback buffer when tty receives new lines (and
655	B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll	808	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
656	with scrollback buffer when tty recieves new lines; option B<-sw>.	809	with scrollback buffer when tty recieves new lines; option B<+sw>.
657		810
658	=item B<scrollTtyKeypress:> I<boolean>	811	=item B<scrollTtyKeypress:> I<boolean>
659		812
660	B<True>: scroll to bottom when a non-special key is pressed. Special keys	813	B<True>: scroll to bottom when a non-special key is pressed. Special keys
661	are those which are intercepted by rxvt-unicode for special handling and	814	are those which are intercepted by rxvt-unicode for special handling and
…		…
680	=item B<borderLess:> I<boolean>	833	=item B<borderLess:> I<boolean>
681		834
682	Set MWM hints to request a borderless window, i.e. if honoured by the	835	Set MWM hints to request a borderless window, i.e. if honoured by the
683	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.	836	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
684		837
		838	=item B<skipBuiltinGlyphs:> I<boolean>
		839
		840	Compile I<frills>: Disable the usage of the built-in block graphics/line
		841	drawing characters and just rely on what the specified fonts provide. Use
		842	this if you have a good font and want to use its block graphic glyphs;
		843	option B<-sbg>.
		844
685	=item B<termName:> I<termname>	845	=item B<termName:> I<termname>
686		846
687	Specifies the terminal type name to be set in the B<TERM> environment	847	Specifies the terminal type name to be set in the B<TERM> environment
688	variable; option B<-tn>.	848	variable; option B<-tn>.
689		849
…		…
699		859
700	=item B<mouseWheelScrollPage:> I<boolean>	860	=item B<mouseWheelScrollPage:> I<boolean>
701		861
702	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel	862	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
703	scrolls five lines [default].	863	scrolls five lines [default].
		864
		865	=item B<pastableTabs:> I<boolean>
		866
		867	B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
		868	movement only; option C<-ptab>.
704		869
705	=item B<cursorBlink:> I<boolean>	870	=item B<cursorBlink:> I<boolean>
706		871
707	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	872	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
708	option B<-bc>.	873	option B<-bc>.
…		…
721		886
722	Mouse pointer background colour.	887	Mouse pointer background colour.
723		888
724	=item B<pointerBlankDelay:> I<number>	889	=item B<pointerBlankDelay:> I<number>
725		890
726	Specifies number of seconds before blanking the pointer [default 2].	891	Specifies number of seconds before blanking the pointer [default 2]. Use a
		892	large number (e.g. C<987654321>) to effectively disable the timeout.
727		893
728	=item B<backspacekey:> I<string>	894	=item B<backspacekey:> I<string>
729		895
730	The string to send when the backspace key is pressed. If set to B<DEC>	896	The string to send when the backspace key is pressed. If set to B<DEC>
731	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	897	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
…		…
753		919
754	I<name> of inputMethod to use; option B<-im>.	920	I<name> of inputMethod to use; option B<-im>.
755		921
756	=item B<imLocale:> I<name>	922	=item B<imLocale:> I<name>
757		923
758	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	924	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
759	de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input	925	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
760	extension to be able to input japanese characters while staying in	926	input extension to be able to input japanese characters while staying in
761	another locale. option B<-imlocale>.	927	another locale; option B<-imlocale>.
		928
		929	=item B<imFont:> I<fontset>
		930
		931	Specify the font-set used for XIM styles C<OverTheSpot> or
		932	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
		933	by commas), i.e. it's not in the same format as the other font lists used
		934	in @@RXVT_NAME@@. The default will be set-up to chose any suitable found
		935	found, preferably one or two pixels differing in size to the base font.
		936	option B<-imfont>.
		937
		938	=item B<tripleclickwords:> I<boolean>
		939
		940	Change the meaning of triple-click selection with the left mouse
		941	button. Instead of selecting a full line it will extend the selection to
		942	the end of the logical line only; option B<-tcw>.
762		943
763	=item B<insecure:> I<boolean>	944	=item B<insecure:> I<boolean>
764		945
765	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	946	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
766	echo arbitrary strings like the icon name or the locale. This could be	947	echo arbitrary strings like the icon name or the locale. This could be
767	abused if somebody gets 8-bit-clean access to your display, whether	948	abused if somebody gets 8-bit-clean access to your display, whether
768	throuh a mail client displaying mail bodies unfiltered or though	949	through a mail client displaying mail bodies unfiltered or through
769	write(1). Therefore, these sequences are disabled by default. (Note	950	write(1) or any other means. Therefore, these sequences are disabled by
770	that other terminals, including xterm, have these sequences	951	default. (Note that many other terminals, including xterm, have these
771	enabled by default). You can enable them by setting this boolean	952	sequences enabled by default, which doesn't make it safer, though).
772	resource or specifying B<-insecure> as an option. At the moment, this	953
773	enabled display-answer, locale, findfont, icon label and window title	954	You can enable them by setting this boolean resource or specifying
774	requests as well as dynamic menubar dispatch.	955	B<-insecure> as an option. At the moment, this enables display-answer,
		956	locale, findfont, icon label and window title requests as well as dynamic
		957	menubar dispatch.
775		958
776	=item B<modifier:> I<modifier>	959	=item B<modifier:> I<modifier>
777		960
778	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	961	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
779	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	962	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
794	Turn on/off secondary screen scroll (default enabled). If the this	977	Turn on/off secondary screen scroll (default enabled). If the this
795	option is enabled, scrolls on the secondary screen will change the	978	option is enabled, scrolls on the secondary screen will change the
796	scrollback buffer and switching to/from the secondary screen will	979	scrollback buffer and switching to/from the secondary screen will
797	instead scroll the screen up.	980	instead scroll the screen up.
798		981
		982	=item B<hold>: I<bool>
		983
		984	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		985	will not immediately destroy its window when the program executed within
		986	it exits. Instead, it will wait till it is being killed or closed by the
		987	user.
		988
799	=item B<keysym.>I<sym>: I<string>	989	=item B<keysym.>I<sym>: I<string>
800		990
801	Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may	991	Compile I<frills>: Associate I<string> with keysym I<sym>. The
802	contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:	992	intervening resource name B<keysym.> cannot be omitted.
803	newline, \r: return, \t:	993
		994	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
		995	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
		996	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
		997	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
		998	B<2>, B<3>, B<4>, B<5>.
		999
		1000	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
		1001	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
		1002	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
		1003	current application keymap mode state.
		1004
		1005	The spellings of I<key> can be obtained by using B<xev>(1) command or
		1006	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
		1007	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
		1008	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
		1009	performed in an exact manner; however, the closest match is assured.
		1010
		1011	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
		1012	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
804	tab, \000: octal number) or control characters (^?: delete, ^@: null,	1013	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
805	^A ...) and may enclosed with double quotes so that it can start or end	1014	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
806	with whitespace. The intervening resource name B<keysym.> cannot be	1015	can start or end with whitespace.
807	omitted. This resource is only available when compiled with	1016
808	KEYSYM_RESOURCE.	1017	Please note that you need to double the C<\> when using
		1018	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
		1019	use C<\033> instead of C<\e> (and so on), which will work with both Xt and
		1020	@@RXVT_NAME@@'s own processing).
		1021
		1022	You can define a range of keysyms in one shot by providing a I<string>
		1023	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
		1024	should be a character not used by the strings.
		1025
		1026	Its usage can be demonstrated by an example:
		1027
		1028	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
		1029
		1030	The above line is equivalent to the following three lines:
		1031
		1032	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
		1033	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
		1034	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
		1035
		1036	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
		1037	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
		1038	example the following means "change the current locale to C<zh_CN.GBK>
		1039	when Control-Meta-c is being pressed":
		1040
		1041	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		1042
		1043	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1044	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1045	manpage. For example, the F<selection> extension (activated via
		1046	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1047
		1048	URxvt.keysym.M-C-c: perl:selection:rot13
		1049
		1050	Due the the large number of modifier combinations, a defined key mapping
		1051	will match if at I<at least> the specified identifiers are being set, and
		1052	no other key mappings with those and more bits are being defined. That
		1053	means that defining a key map for C<a> will automatically provide
		1054	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		1055	mappings themselves.
		1056
		1057	Unfortunately, this will override built-in key mappings. For example
		1058	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		1059	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		1060	user-defined keymap using the C<builtin:> replacement:
		1061
		1062	URxvt.keysym.Insert: <my insert key sequence>
		1063	URxvt.keysym.S-Insert: builtin:
		1064
		1065	The first line defines a mapping for C<Insert> and I<any> combination
		1066	of modifiers. The second line re-establishes the default mapping for
		1067	C<Shift-Insert>.
		1068
		1069	The following example will map Control-Meta-1 and Control-Meta-2 to
		1070	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
		1071	font-switching at runtime:
		1072
		1073	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1074	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
		1075
		1076	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
		1077	info):
		1078
		1079	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1080	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1081
		1082	=item B<perl-ext-common>: I<string>
		1083
		1084	=item B<perl-ext>: I<string>
		1085
		1086	Colon-separated list(s) of perl extension scripts to use in this terminal
		1087	instance. Each extension is looked up in the library directories, loaded
		1088	if necessary, and bound to the current terminal instance. If this
		1089	resource is empty or missing, then the perl interpreter will not be
		1090	initialized. The idea behind two options is that B<perl-ext-common> will
		1091	be used for extensions that should be available to all instances, while
		1092	B<perl-ext> is used for specific instances; option B<-pe>.
		1093
		1094	=item B<perl-eval>: I<string>
		1095
		1096	Perl code to be evaluated when all extensions have been registered. See the
		1097	@@RXVT_NAME@@perl(3) manpage.
		1098
		1099	=item B<perl-lib>: I<path>
		1100
		1101	Colon-separated list of additional directories that hold extension
		1102	scripts. When looking for extensions specified by the C<perl> resource,
		1103	@@RXVT_NAME@@ will first look in these directories and then in
		1104	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
		1105
		1106	See the @@RXVT_NAME@@perl(3) manpage.
809		1107
810	=back	1108	=back
811		1109
812	=head1 THE SCROLLBAR	1110	=head1 THE SCROLLBAR
813		1111
…		…
827	the normal text selection/insertion, hold either the Shift or the Meta	1125	the normal text selection/insertion, hold either the Shift or the Meta
828	(Alt) key while performing the desired mouse action.	1126	(Alt) key while performing the desired mouse action.
829		1127
830	If mouse reporting mode is active, the normal scrollbar actions are	1128	If mouse reporting mode is active, the normal scrollbar actions are
831	disabled -- on the assumption that we are using a fullscreen	1129	disabled -- on the assumption that we are using a fullscreen
832	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	1130	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
833	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	1131	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
834	up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down),	1132	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
835	respectively.	1133	respectively.
836		1134
837	=head1 TEXT SELECTION AND INSERTION	1135	=head1 TEXT SELECTION AND INSERTION
838		1136
839	The behaviour of text selection and insertion mechanism is similar to	1137	The behaviour of text selection and insertion mechanism is similar to
…		…
841		1139
842	=over 4	1140	=over 4
843		1141
844	=item B<Selection>:	1142	=item B<Selection>:
845		1143
846	Left click at the beginning of the region, drag to the end of the	1144	Left click at the beginning of the region, drag to the end of the region
847	region and release; Right click to extend the marked region; Left	1145	and release; Right click to extend the marked region; Left double-click
848	double-click to select a word; Left triple-click to select the entire	1146	to select a word; Left triple-click to select the entire logical line
849	line.	1147	(which can span multiple screen lines), unless modified by resource
		1148	B<tripleclickwords>.
850		1149
851	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1150	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
852	(Compile: frills) will create a rectangular selection instead of a normal	1151	(Compile: I<frills>) will create a rectangular selection instead of a
853	one.	1152	normal one. In this mode, every selected row becomes its own line in the
		1153	selection, and trailing whitespace is visually underlined and removed from
		1154	the selection.
854		1155
855	=item B<Insertion>:	1156	=item B<Insertion>:
856		1157
857	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1158	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
858	an B<@@RXVT_NAME@@> window causes the current text selection to be	1159	an B<@@RXVT_NAME@@> window causes the current text selection to be
…		…
866	supported in rxvt-unicode. Bug me if you need this.	1167	supported in rxvt-unicode. Bug me if you need this.
867		1168
868	You can, however, switch fonts at runtime using escape sequences (and	1169	You can, however, switch fonts at runtime using escape sequences (and
869	therefore using the menubar), e.g.:	1170	therefore using the menubar), e.g.:
870		1171
871	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1172	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
872		1173
873	rxvt-unicode will automatically re-apply these fonts to the output so far.	1174	rxvt-unicode will automatically re-apply these fonts to the output so far.
874		1175
875	=head1 ISO 14755 SUPPORT	1176	=head1 ISO 14755 SUPPORT
876		1177
…		…
880	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1181	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
881	with C<--enable-iso14755>.	1182	with C<--enable-iso14755>.
882		1183
883	=over 4	1184	=over 4
884		1185
885	=item 5.1: Basic method	1186	=item * 5.1: Basic method
886		1187
887	This allows you to enter unicode characters using their hexcode.	1188	This allows you to enter unicode characters using their hexcode.
888		1189
889	Start by pressing and holding both C<Control> and C<Shift>, then enter	1190	Start by pressing and holding both C<Control> and C<Shift>, then enter
890	hex-digits (between one and six). Releasing C<Control> and C<Shift> will	1191	hex-digits (between one and six). Releasing C<Control> and C<Shift> will
…		…
897	address, which you cannot type. Fortunately, the card has the e-mail	1198	address, which you cannot type. Fortunately, the card has the e-mail
898	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily	1199	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
899	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,	1200	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
900	followed by releasing the modifier keys.	1201	followed by releasing the modifier keys.
901		1202
902	=item 5.2: Keyboard symbols entry method	1203	=item * 5.2: Keyboard symbols entry method
903		1204
904	This mode lets you input characters representing the keycap symbols of	1205	This mode lets you input characters representing the keycap symbols of
905	your keyboard, if representable in the current locale encoding.	1206	your keyboard, if representable in the current locale encoding.
906		1207
907	Start by pressing C<Control> and C<Shift> together, then releasing	1208	Start by pressing C<Control> and C<Shift> together, then releasing
…		…
910	keycap symbol. The symbol will only be entered when the key has been	1211	keycap symbol. The symbol will only be entered when the key has been
911	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1212	released, otherwise pressing e.g. C<Shift> would enter the symbol for
912	C<ISO Level 2 Switch>, although your intention might have been to enter a	1213	C<ISO Level 2 Switch>, although your intention might have been to enter a
913	reverse tab (Shift-Tab).	1214	reverse tab (Shift-Tab).
914		1215
915	=item 5.3: Screen-selection entry method	1216	=item * 5.3: Screen-selection entry method
916		1217
917	While this is implemented already (it's basically the selection	1218	While this is implemented already (it's basically the selection
918	mechanism), it could be extended by displaying a unicode character map.	1219	mechanism), it could be extended by displaying a unicode character map.
919		1220
920	=item 5.4: Feedback method for identifying displayed characters for later input	1221	=item * 5.4: Feedback method for identifying displayed characters for later input
921		1222
922	This method lets you display the unicode character code associated with	1223	This method lets you display the unicode character code associated with
923	characters already displayed.	1224	characters already displayed.
924		1225
925	You enter this mode by holding down C<Control> and C<Shift> together, then	1226	You enter this mode by holding down C<Control> and C<Shift> together, then
…		…
937	With respect to conformance, rxvt-unicode is supposed to be compliant to	1238	With respect to conformance, rxvt-unicode is supposed to be compliant to
938	both scenario A and B of ISO 14755, including part 5.2.	1239	both scenario A and B of ISO 14755, including part 5.2.
939		1240
940	=head1 LOGIN STAMP	1241	=head1 LOGIN STAMP
941		1242
942	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so	1243	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
943	that it can be seen via the I<who(1)> command, and can accept messages.	1244	it can be seen via the I<who(1)> command, and can accept messages. To
944	To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on	1245	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
945	some systems.	1246	on some systems or setgid to root or to some other group on others.
946		1247
947	=head1 COLORS AND GRAPHICS	1248	=head1 COLORS AND GRAPHICS
948		1249
949	In addition to the default foreground and background colours,	1250	In addition to the default foreground and background colours,
950	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1251	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
…		…
993		1294
994	=back	1295	=back
995		1296
996	=head1 ENVIRONMENT	1297	=head1 ENVIRONMENT
997		1298
998	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>	1299	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
999	and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X	1300
1000	window id number of the B<@@RXVT_NAME@@> window and it also uses and	1301	=over 4
1001	sets the environment variable B<DISPLAY> to specify which display	1302
1002	terminal to use. B<@@RXVT_NAME@@> uses the environment variables	1303	=item B<TERM>
1003	B<RXVTPATH> and B<PATH> to find XPM files.	1304
		1305	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
		1306	resources or on the commandline.
		1307
		1308	=item B<COLORTERM>
		1309
		1310	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
		1311	compiled with XPM support, and optionally with the added extension
		1312	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
		1313
		1314	=item B<COLORFGBG>
		1315
		1316	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
		1317	the colour code used as default foreground/text colour (or the string
		1318	C<default> to indicate that the default-colour escape sequence is to be
		1319	used), C<bg> is the colour code used as default background colour (or the
		1320	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1321	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
		1322	(and do) use this information to optimize screen output.
		1323
		1324	=item B<WINDOWID>
		1325
		1326	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
		1327	window, which usually has subwindows for the scrollbar, the terminal
		1328	window and so on).
		1329
		1330	=item B<TERMINFO>
		1331
		1332	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1333	C<--with-terminfo=PATH>.
		1334
		1335	=item B<DISPLAY>
		1336
		1337	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
		1338	display in it's child processes.
		1339
		1340	=item B<SHELL>
		1341
		1342	The shell to be used for command execution, defaults to C</bin/sh>.
		1343
		1344	=item B<RXVTPATH>
		1345
		1346	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
		1347	files.
		1348
		1349	=item B<PATH>
		1350
		1351	Used in the same way as C<RXVTPATH>.
		1352
		1353	=item B<RXVT_SOCKET>
		1354
		1355	The unix domain socket path used by @@RXVT_NAME@@c(1) and
		1356	@@RXVT_NAME@@d(1).
		1357
		1358	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
		1359
		1360	=item B<HOME>
		1361
		1362	Used to locate the default directory for the unix domain socket for
		1363	daemon communications and to locate various resource files (such as
		1364	C<.Xdefaults>)
		1365
		1366	=item B<XAPPLRESDIR>
		1367
		1368	Directory where various X resource files are being located.
		1369
		1370	=item B<XENVIRONMENT>
		1371
		1372	If set and accessible, gives the name of a X resource file to be loaded by
		1373	@@RXVT_NAME@@.
		1374
		1375	=back
1004		1376
1005	=head1 FILES	1377	=head1 FILES
1006		1378
1007	=over 4	1379	=over 4
1008		1380
1009	=item B</etc/utmp>
1010
1011	System file for login records.
1012
1013	=item B</usr/lib/X11/rgb.txt>	1381	=item B</usr/lib/X11/rgb.txt>
1014		1382
1015	Color names.	1383	Color names.
1016		1384
1017	=back	1385	=back
1018		1386
1019	=head1 SEE ALSO	1387	=head1 SEE ALSO
1020		1388
1021	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1389	@@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)
1022
1023	=head1 BUGS
1024
1025	Check the BUGS file for an up-to-date list.
1026
1027	Cursor change support is not yet implemented.
1028
1029	Click-and-drag doesn't work with X11 mouse report overriding.
1030		1390
1031	=head1 CURRENT PROJECT COORDINATOR	1391	=head1 CURRENT PROJECT COORDINATOR
1032		1392
1033	=over 4	1393	=over 4
1034		1394
1035	=item Project Coordinator	1395	=item Project Coordinator
1036		1396
1037	@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@>	1397	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1038		1398
1039	=item Web page maintainter	1399	L<http://software.schmorp.de/#rxvt-unicode>
1040
1041	@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1042
1043	L<@@RXVT_WEBPAGE@@>
1044		1400
1045	=back	1401	=back
1046		1402
1047	=head1 AUTHORS	1403	=head1 AUTHORS
1048		1404
…		…
1073	=item Geoff Wing L<< <gcw@pobox.com> >>	1429	=item Geoff Wing L<< <gcw@pobox.com> >>
1074		1430
1075	Rewrote screen display and text selection routines. Project Coordinator	1431	Rewrote screen display and text selection routines. Project Coordinator
1076	(changes.txt 2.4.6 - rxvt-unicode)	1432	(changes.txt 2.4.6 - rxvt-unicode)
1077		1433
1078	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>	1434	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1079		1435
1080	Forked rxvt-unicode, rewrote most of the display code and internal	1436	Forked rxvt-unicode, rewrote most of the display code and internal
1081	character handling to store text in unicode, improve xterm	1437	character handling to store text in unicode, improve xterm
1082	compatibility and apply numerous other bugfixes and extensions.	1438	compatibility and apply numerous other bugfixes and extensions.
1083		1439

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.30 by root, Wed Sep 8 17:10:23 2004 UTC vs. Revision 1.85 by root, Wed Jan 4 20:43:37 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.30 by root, Wed Sep 8 17:10:23 2004 UTC vs.
Revision 1.85 by root, Wed Jan 4 20:43:37 2006 UTC