[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.57 by root, Mon Feb 14 18:50:57 2005 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
…		…
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. resource B<fading>.
116		118
117	=item B<-tint> I<colour>	119	=item B<-tint> I<colour>
118		120
119	Tint the transparent background pixmap with the given colour when	121	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>	122	transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>
…		…
123		125
124	=item B<-sh>	126	=item B<-sh>
125		127
126	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	128	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	129	background image in addition to tinting it (i.e. B<-tint> must be
128	specified, too).	130	specified, too, e.g. C<-tint white>).
129		131
130	=item B<-bg> I<colour>	132	=item B<-bg> I<colour>
131		133
132	Window background colour; resource B<background>.	134	Window background colour; resource B<background>.
133		135
…		…
136	Window foreground colour; resource B<foreground>.	138	Window foreground colour; resource B<foreground>.
137		139
138	=item B<-pixmap> I<file[;geom]>	140	=item B<-pixmap> I<file[;geom]>
139		141
140	Compile I<XPM>: Specify XPM file for the background and also optionally	142	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	143	specify its scaling with a geometry string. Note you may need to
142	quotes to avoid special shell interpretation of the `;' in the	144	add quotes to avoid special shell interpretation of the C<;> in the
143	command-line; resource B<backgroundPixmap>.	145	command-line; resource B<backgroundPixmap>.
144		146
145	=item B<-cr> I<colour>	147	=item B<-cr> I<colour>
146		148
147	The cursor colour; resource B<cursorColor>.	149	The cursor colour; resource B<cursorColor>.
…		…
280	if honoured by the WM, the rxvt-unicode window will not have window	282	if honoured by the WM, the rxvt-unicode window will not have window
281	decorations; resource B<borderLess>.	283	decorations; resource B<borderLess>.
282		284
283	=item B<-lsp> I<number>	285	=item B<-lsp> I<number>
284		286
285	Compile I<linespace>: Lines (pixel height) to insert between each row	287	Compile I<frills>: Lines (pixel height) to insert between each row of
286	of the display; resource B<linespace>.	288	the display. Useful to work around font rendering problems; resource
		289	B<linespace>.
287		290
288	=item B<-tn> I<termname>	291	=item B<-tn> I<termname>
289		292
290	This option specifies the name of the terminal type to be set in the	293	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	294	B<TERM> environment variable. This terminal type must exist in the
…		…
327		330
328	Compile I<XIM>: input method name. resource B<inputMethod>.	331	Compile I<XIM>: input method name. resource B<inputMethod>.
329		332
330	=item B<-imlocale> I<string>	333	=item B<-imlocale> I<string>
331		334
332	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	335	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	336	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	337	input extension to be able to input japanese characters while staying in
335	another locale.	338	another locale. resource B<imLocale>.
		339
		340	=item B<-imfont> I<fontset>
		341
		342	Set the font set to use for the X Input Method, see resource B<imFont>
		343	for more info.
		344
		345	=item B<-tcw>
		346
		347	Change the meaning of triple-click selection with the left mouse
		348	button. Instead of selecting a full line it will extend the selection the
		349	end of the logical line only. resource B<tripleclickwords>.
336		350
337	=item B<-insecure>	351	=item B<-insecure>
338		352
339	Enable "insecure" mode, which currently enables most of the escape	353	Enable "insecure" mode, which currently enables most of the escape
340	sequences that echo strings. See the resource B<insecure> for more	354	sequences that echo strings. See the resource B<insecure> for more
…		…
354	=item B<-ssr>\|B<+ssr>	368	=item B<-ssr>\|B<+ssr>
355		369
356	Turn on/off secondary screen scroll (default enabled); resource	370	Turn on/off secondary screen scroll (default enabled); resource
357	B<secondaryScroll>.	371	B<secondaryScroll>.
358		372
359	=item B<-xrm> I<resourcestring>	373	=item B<-keysym.>I<sym>: I<string>
360		374
361	No effect on rxvt-unicode. Simply passes through an argument to be made	375	Remap a key symbol. See resource B<keysym>.
362	available in the instance's argument list. Appears in I<WM_COMMAND> in	376
363	some window managers.	377	=item B<-embed>: I<windowid>
		378
		379	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
		380	which enables applications to easily embed a terminal.
		381
		382	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
		383	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
		384	quite a bit, so don't expect it to keep some specific state. It's best to
		385	create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
		386
		387	The window will not be destroyed when @@RXVT_NAME@@ exits.
		388
		389	It might be useful to know that @@RXVT_NAME@@ will not close file
		390	descriptors passed to it (except for stdin/out/err, of course), so you
		391	can use file descriptors to communicate with the programs within the
		392	terminal. This works regardless of wether the C<-embed> option was used or
		393	not.
364		394
365	=back	395	=back
366		396
367	=head1 RESOURCES (available also as long-options)	397	=head1 RESOURCES (available also as long-options)
368		398
…		…
371		401
372	There are two different methods that @@RXVT_NAME@@ can use to get the	402	There are two different methods that @@RXVT_NAME@@ can use to get the
373	Xresource data: using the X libraries (Xrm*-functions) or internal	403	Xresource data: using the X libraries (Xrm*-functions) or internal
374	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	404	Xresources reader (B<~/.Xdefaults>). For the first method (ie.
375	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	405	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the
376	resources using X11 tools like B<xset>. Many distribution do also load	406	resources using X11 tools like B<xrdb>. Many distribution do also load
377	settings from the B<~/.Xresources> file when X starts.	407	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
		408	will consult the following files/resources in order, with later settings
		409	overwriting earlier ones:
		410
		411	1. system-wide app-defaults file, either locale-dependent OR global
		412	2. app-defaults file in $XAPPLRESDIR
		413	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
		414	4. SCREEN_RESOURCES for the current screen
		415	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
378		416
379	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>	417	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
380	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults	418	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
381	set in XAPPLOADDIR/URxvt (compile-time defined: usually	419	set in XAPPLOADDIR/URxvt (compile-time defined: usually
382	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	420	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
…		…
427		465
428	=item B<colorIT:> I<colour>	466	=item B<colorIT:> I<colour>
429		467
430	Use the specified colour to display bold or italic characters when the	468	Use the specified colour to display bold or italic characters when the
431	foreground colour is the default. If font styles are not available	469	foreground colour is the default. If font styles are not available
432	(Compile styles) and this option is unset, reverse video is used instead.	470	(Compile I<styles>) and this option is unset, reverse video is used instead.
433		471
434	=item B<colorUL:> I<colour>	472	=item B<colorUL:> I<colour>
435		473
436	Use the specified colour to display underlined characters when the	474	Use the specified colour to display underlined characters when the
437	foreground colour is the default.	475	foreground colour is the default.
438		476
439	=item B<colorRV:> I<colour>	477	=item B<colorRV:> I<colour>
440		478
441	Use the specified colour as the background for reverse video	479	Use the specified colour as the background for reverse video
442	characters.	480	characters.
		481
		482	=item B<underlineColor:> I<colour>
		483
		484	If set, use the specified colour as the colour for the underline
		485	itself. If unset, use the foreground colour.
443		486
444	=item B<cursorColor:> I<colour>	487	=item B<cursorColor:> I<colour>
445		488
446	Use the specified colour for the cursor. The default is to use the	489	Use the specified colour for the cursor. The default is to use the
447	foreground colour; option B<-cr>.	490	foreground colour; option B<-cr>.
…		…
528	The first font defines the cell size for characters; other fonts might	571	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	572	be smaller, but not larger. A reasonable default font list is always
530	appended to it. option B<-fn>.	573	appended to it. option B<-fn>.
531		574
532	Each font can either be a standard X11 core font (XLFD) name, with	575	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:>.	576	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
534		577
535	In addition, each font can be prefixed with additional hints and	578	In addition, each font can be prefixed with additional hints and
536	specifications enclosed in square brackets (C<[]>). The only available	579	specifications enclosed in square brackets (C<[]>). The only available
537	hint currently is C<codeset=codeset-name>, and this is only used for Xft	580	hint currently is C<codeset=codeset-name>, and this is only used for Xft
538	fonts.	581	fonts.
…		…
769		812
770	I<name> of inputMethod to use; option B<-im>.	813	I<name> of inputMethod to use; option B<-im>.
771		814
772	=item B<imLocale:> I<name>	815	=item B<imLocale:> I<name>
773		816
774	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	817	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	818	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	819	input extension to be able to input japanese characters while staying in
777	another locale. option B<-imlocale>.	820	another locale. option B<-imlocale>.
		821
		822	=item B<imFont:> I<fontset>
		823
		824	Specify the font-set used for XIM styles C<OverTheSpot> or
		825	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
		826	by commas), i.e. it's not in the same format as the other font lists used
		827	in @@RXVT_NAME@@. The default will be set-up to chose any suitable found
		828	found, preferably one or two pixels differing in size to the base font.
		829	option B<-imfont>.
		830
		831	=item B<tripleclickwords:> I<boolean>
		832
		833	Change the meaning of triple-click selection with the left mouse
		834	button. Instead of selecting a full line it will extend the selection to
		835	the end of the logical line only. option B<-tcw>.
778		836
779	=item B<insecure:> I<boolean>	837	=item B<insecure:> I<boolean>
780		838
781	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	839	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
782	echo arbitrary strings like the icon name or the locale. This could be	840	echo arbitrary strings like the icon name or the locale. This could be
…		…
812	scrollback buffer and switching to/from the secondary screen will	870	scrollback buffer and switching to/from the secondary screen will
813	instead scroll the screen up.	871	instead scroll the screen up.
814		872
815	=item B<keysym.>I<sym>: I<string>	873	=item B<keysym.>I<sym>: I<string>
816		874
817	Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may	875	Compile I<frills>: Associate I<string> with keysym I<sym>. The
818	contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:	876	intervening resource name B<keysym.> cannot be omitted.
819	newline, \r: return, \t:	877
		878	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
		879	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
		880	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
		881	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
		882	B<2>, B<3>, B<4>, B<5>.
		883
		884	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
		885	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
		886	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
		887	current application keymap mode state.
		888
		889	The spellings of I<key> can be obtained by using B<xev>(1) command or
		890	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
		891	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
		892	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
		893	performed in an exact manner; however, the closest match is assured.
		894
		895	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
		896	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,	897	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	898	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	899	can start or end with whitespace.
823	omitted. This resource is only available when compiled with	900
824	KEYSYM_RESOURCE.	901	Please note that you need to double the C<\> when using
		902	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
		903	use C<\033> instead of C<\e> (and so on), which will work with both Xt and
		904	@@RXVT_NAME@@'s own processing).
		905
		906	You can define a range of keysyms in one shot by providing a I<string>
		907	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
		908	should be a character not used by the strings.
		909
		910	Its usage can be demonstrated by an example:
		911
		912	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
		913
		914	The above line is equivalent to the following three lines:
		915
		916	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
		917	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
		918	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
		919
		920	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
		921	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
		922	example the following means "change the current locale to C<zh_CN.GBK>
		923	when Control-Meta-c is being pressed":
		924
		925	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		926
		927	The following example will map Control-Meta-1 and Control-Meta-2 to
		928	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
		929	font-switching at runtime:
		930
		931	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		932	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
		933
		934	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
		935	info):
		936
		937	URxvt.keysym.M-C-3: command:\033[8;25;80t
		938	URxvt.keysym.M-C-4: command:\033[8;48;110t
825		939
826	=back	940	=back
827		941
828	=head1 THE SCROLLBAR	942	=head1 THE SCROLLBAR
829		943
…		…
843	the normal text selection/insertion, hold either the Shift or the Meta	957	the normal text selection/insertion, hold either the Shift or the Meta
844	(Alt) key while performing the desired mouse action.	958	(Alt) key while performing the desired mouse action.
845		959
846	If mouse reporting mode is active, the normal scrollbar actions are	960	If mouse reporting mode is active, the normal scrollbar actions are
847	disabled -- on the assumption that we are using a fullscreen	961	disabled -- on the assumption that we are using a fullscreen
848	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	962	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
849	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	963	(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),	964	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
851	respectively.	965	respectively.
852		966
853	=head1 TEXT SELECTION AND INSERTION	967	=head1 TEXT SELECTION AND INSERTION
854		968
855	The behaviour of text selection and insertion mechanism is similar to	969	The behaviour of text selection and insertion mechanism is similar to
…		…
857		971
858	=over 4	972	=over 4
859		973
860	=item B<Selection>:	974	=item B<Selection>:
861		975
862	Left click at the beginning of the region, drag to the end of the	976	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	977	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	978	to select a word; Left triple-click to select the entire logical line
865	line.	979	(which can span multiple screen lines), unless modified by resource
		980	B<tripleclickwords>.
866		981
867	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	982	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	983	(Compile: I<frills>) will create a rectangular selection instead of a normal
869	one.	984	one.
870		985
871	=item B<Insertion>:	986	=item B<Insertion>:
872		987
873	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	988	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
…		…
896	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1011	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
897	with C<--enable-iso14755>.	1012	with C<--enable-iso14755>.
898		1013
899	=over 4	1014	=over 4
900		1015
901	=item 5.1: Basic method	1016	=item * 5.1: Basic method
902		1017
903	This allows you to enter unicode characters using their hexcode.	1018	This allows you to enter unicode characters using their hexcode.
904		1019
905	Start by pressing and holding both C<Control> and C<Shift>, then enter	1020	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	1021	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	1028	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	1029	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>,	1030	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.	1031	followed by releasing the modifier keys.
917		1032
918	=item 5.2: Keyboard symbols entry method	1033	=item * 5.2: Keyboard symbols entry method
919		1034
920	This mode lets you input characters representing the keycap symbols of	1035	This mode lets you input characters representing the keycap symbols of
921	your keyboard, if representable in the current locale encoding.	1036	your keyboard, if representable in the current locale encoding.
922		1037
923	Start by pressing C<Control> and C<Shift> together, then releasing	1038	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	1041	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	1042	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	1043	C<ISO Level 2 Switch>, although your intention might have been to enter a
929	reverse tab (Shift-Tab).	1044	reverse tab (Shift-Tab).
930		1045
931	=item 5.3: Screen-selection entry method	1046	=item * 5.3: Screen-selection entry method
932		1047
933	While this is implemented already (it's basically the selection	1048	While this is implemented already (it's basically the selection
934	mechanism), it could be extended by displaying a unicode character map.	1049	mechanism), it could be extended by displaying a unicode character map.
935		1050
936	=item 5.4: Feedback method for identifying displayed characters for later input	1051	=item * 5.4: Feedback method for identifying displayed characters for later input
937		1052
938	This method lets you display the unicode character code associated with	1053	This method lets you display the unicode character code associated with
939	characters already displayed.	1054	characters already displayed.
940		1055
941	You enter this mode by holding down C<Control> and C<Shift> together, then	1056	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	1068	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.	1069	both scenario A and B of ISO 14755, including part 5.2.
955		1070
956	=head1 LOGIN STAMP	1071	=head1 LOGIN STAMP
957		1072
958	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so	1073	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.	1074	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	1075	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
961	some systems.	1076	on some systems or setgid to root or to some other group on others.
962		1077
963	=head1 COLORS AND GRAPHICS	1078	=head1 COLORS AND GRAPHICS
964		1079
965	In addition to the default foreground and background colours,	1080	In addition to the default foreground and background colours,
966	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1081	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
…		…
1009		1124
1010	=back	1125	=back
1011		1126
1012	=head1 ENVIRONMENT	1127	=head1 ENVIRONMENT
1013		1128
1014	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>	1129	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	1130
1016	window id number of the B<@@RXVT_NAME@@> window and it also uses and	1131	=over 4
1017	sets the environment variable B<DISPLAY> to specify which display	1132
1018	terminal to use. B<@@RXVT_NAME@@> uses the environment variables	1133	=item B<TERM>
1019	B<RXVTPATH> and B<PATH> to find XPM files.	1134
		1135	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
		1136	resources or on the commandline.
		1137
		1138	=item B<COLORTERM>
		1139
		1140	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
		1141	compiled with XPM support, and optionally with the added extension
		1142	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
		1143
		1144	=item B<COLORFGBG>
		1145
		1146	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
		1147	the colour code used as default foreground/text colour (or the string
		1148	C<default> to indicate that the default-colour escape sequence is to be
		1149	used), C<bg> is the colour code used as default background colour (or the
		1150	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1151	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
		1152	(and do) use this information to optimize screen output.
		1153
		1154	=item B<WINDOWID>
		1155
		1156	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
		1157	window, which usually has subwindows for the scrollbar, the terminal
		1158	window and so on).
		1159
		1160	=item B<TERMINFO>
		1161
		1162	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1163	C<--with-terminfo=PATH>.
		1164
		1165	=item B<DISPLAY>
		1166
		1167	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
		1168	display in it's child processes.
		1169
		1170	=item B<SHELL>
		1171
		1172	The shell to be used for command execution, defaults to C</bin/sh>.
		1173
		1174	=item B<RXVTPATH>
		1175
		1176	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
		1177	files.
		1178
		1179	=item B<PATH>
		1180
		1181	Used in the same way as C<RXVTPATH>.
		1182
		1183	=item B<RXVT_SOCKET>
		1184
		1185	The unix domain socket path used by @@RXVT_NAME@@c(1) and
		1186	@@RXVT_NAME@@d(1).
		1187
		1188	Default C<< $HOME/.rxvt-unicode-<nodename >>.
		1189
		1190	=item B<HOME>
		1191
		1192	Used to locate the default directory for the unix domain socket for
		1193	daemon communications and to locate various resource files (such as
		1194	C<.Xdefaults>)
		1195
		1196	=item B<XAPPLRESDIR>
		1197
		1198	Directory where various X resource files are being located.
		1199
		1200	=item B<XENVIRONMENT>
		1201
		1202	If set and accessible, gives the name of a X resource file to be loaded by
		1203	@@RXVT_NAME@@.
		1204
		1205	=back
1020		1206
1021	=head1 FILES	1207	=head1 FILES
1022		1208
1023	=over 4	1209	=over 4
1024		1210
1025	=item B</etc/utmp>
1026
1027	System file for login records.
1028
1029	=item B</usr/lib/X11/rgb.txt>	1211	=item B</usr/lib/X11/rgb.txt>
1030		1212
1031	Color names.	1213	Color names.
1032		1214
1033	=back	1215	=back
…		…
1048		1230
1049	=over 4	1231	=over 4
1050		1232
1051	=item Project Coordinator	1233	=item Project Coordinator
1052		1234
1053	@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@>	1235	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1054		1236
1055	=item Web page maintainter	1237	L<http://software.schmorp.de/#rxvt-unicode>
1056
1057	@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1058
1059	L<@@RXVT_WEBPAGE@@>
1060		1238
1061	=back	1239	=back
1062		1240
1063	=head1 AUTHORS	1241	=head1 AUTHORS
1064		1242
…		…
1089	=item Geoff Wing L<< <gcw@pobox.com> >>	1267	=item Geoff Wing L<< <gcw@pobox.com> >>
1090		1268
1091	Rewrote screen display and text selection routines. Project Coordinator	1269	Rewrote screen display and text selection routines. Project Coordinator
1092	(changes.txt 2.4.6 - rxvt-unicode)	1270	(changes.txt 2.4.6 - rxvt-unicode)
1093		1271
1094	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>	1272	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1095		1273
1096	Forked rxvt-unicode, rewrote most of the display code and internal	1274	Forked rxvt-unicode, rewrote most of the display code and internal
1097	character handling to store text in unicode, improve xterm	1275	character handling to store text in unicode, improve xterm
1098	compatibility and apply numerous other bugfixes and extensions.	1276	compatibility and apply numerous other bugfixes and extensions.
1099		1277

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.57 by root, Mon Feb 14 18:50:57 2005 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.57 by root, Mon Feb 14 18:50:57 2005 UTC