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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.36 by root, Wed Dec 15 05:10:57 2004 UTC vs.
Revision 1.56 by root, Mon Feb 14 18:47:54 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>
…		…
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	It might be useful to know that @@RXVT_NAME@@ will not close file
		388	descriptors passed to it (except for stdin/out/err, of course), so you
		389	can use file descriptors to communicate with the programs within the
		390	terminal. This works regardless of wether the C<-embed> option was used or
		391	not.
364		392
365	=back	393	=back
366		394
367	=head1 RESOURCES (available also as long-options)	395	=head1 RESOURCES (available also as long-options)
368		396
…		…
371		399
372	There are two different methods that @@RXVT_NAME@@ can use to get the	400	There are two different methods that @@RXVT_NAME@@ can use to get the
373	Xresource data: using the X libraries (Xrm*-functions) or internal	401	Xresource data: using the X libraries (Xrm*-functions) or internal
374	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	402	Xresources reader (B<~/.Xdefaults>). For the first method (ie.
375	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	403	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	404	resources using X11 tools like B<xrdb>. Many distribution do also load
377	settings from the B<~/.Xresources> file when X starts.	405	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
		406	will consult the following files/resources in order, with later settings
		407	overwriting earlier ones:
		408
		409	1. system-wide app-defaults file, either locale-dependent OR global
		410	2. app-defaults file in $XAPPLRESDIR
		411	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
		412	4. SCREEN_RESOURCES for the current screen
		413	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
378		414
379	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>	415	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
380	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults	416	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
381	set in XAPPLOADDIR/URxvt (compile-time defined: usually	417	set in XAPPLOADDIR/URxvt (compile-time defined: usually
382	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	418	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
…		…
427		463
428	=item B<colorIT:> I<colour>	464	=item B<colorIT:> I<colour>
429		465
430	Use the specified colour to display bold or italic characters when the	466	Use the specified colour to display bold or italic characters when the
431	foreground colour is the default. If font styles are not available	467	foreground colour is the default. If font styles are not available
432	(Compile styles) and this option is unset, reverse video is used instead.	468	(Compile I<styles>) and this option is unset, reverse video is used instead.
433		469
434	=item B<colorUL:> I<colour>	470	=item B<colorUL:> I<colour>
435		471
436	Use the specified colour to display underlined characters when the	472	Use the specified colour to display underlined characters when the
437	foreground colour is the default.	473	foreground colour is the default.
…		…
533	The first font defines the cell size for characters; other fonts might	569	The first font defines the cell size for characters; other fonts might
534	be smaller, but not larger. A reasonable default font list is always	570	be smaller, but not larger. A reasonable default font list is always
535	appended to it. option B<-fn>.	571	appended to it. option B<-fn>.
536		572
537	Each font can either be a standard X11 core font (XLFD) name, with	573	Each font can either be a standard X11 core font (XLFD) name, with
538	optional prefix C<x:> or a Xft font (Compile xft), prefixed with C<xft:>.	574	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
539		575
540	In addition, each font can be prefixed with additional hints and	576	In addition, each font can be prefixed with additional hints and
541	specifications enclosed in square brackets (C<[]>). The only available	577	specifications enclosed in square brackets (C<[]>). The only available
542	hint currently is C<codeset=codeset-name>, and this is only used for Xft	578	hint currently is C<codeset=codeset-name>, and this is only used for Xft
543	fonts.	579	fonts.
…		…
774		810
775	I<name> of inputMethod to use; option B<-im>.	811	I<name> of inputMethod to use; option B<-im>.
776		812
777	=item B<imLocale:> I<name>	813	=item B<imLocale:> I<name>
778		814
779	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	815	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
780	de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input	816	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
781	extension to be able to input japanese characters while staying in	817	input extension to be able to input japanese characters while staying in
782	another locale. option B<-imlocale>.	818	another locale. option B<-imlocale>.
		819
		820	=item B<imFont:> I<fontset>
		821
		822	Specify the font-set used for XIM styles C<OverTheSpot> or
		823	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
		824	by commas), i.e. it's not in the same format as the other font lists used
		825	in @@RXVT_NAME@@. The default will be set-up to chose any suitable found
		826	found, preferably one or two pixels differing in size to the base font.
		827	option B<-imfont>.
		828
		829	=item B<tripleclickwords:> I<boolean>
		830
		831	Change the meaning of triple-click selection with the left mouse
		832	button. Instead of selecting a full line it will extend the selection to
		833	the end of the logical line only. option B<-tcw>.
783		834
784	=item B<insecure:> I<boolean>	835	=item B<insecure:> I<boolean>
785		836
786	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	837	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
787	echo arbitrary strings like the icon name or the locale. This could be	838	echo arbitrary strings like the icon name or the locale. This could be
…		…
817	scrollback buffer and switching to/from the secondary screen will	868	scrollback buffer and switching to/from the secondary screen will
818	instead scroll the screen up.	869	instead scroll the screen up.
819		870
820	=item B<keysym.>I<sym>: I<string>	871	=item B<keysym.>I<sym>: I<string>
821		872
822	Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may	873	Compile I<frills>: Associate I<string> with keysym I<sym>. The
823	contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:	874	intervening resource name B<keysym.> cannot be omitted.
824	newline, \r: return, \t:	875
		876	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
		877	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
		878	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
		879	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
		880	B<2>, B<3>, B<4>, B<5>.
		881
		882	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
		883	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
		884	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
		885	current application keymap mode state.
		886
		887	The spellings of I<key> can be obtained by using B<xev>(1) command or
		888	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
		889	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
		890	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
		891	performed in an exact manner; however, the closest match is assured.
		892
		893	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
		894	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
825	tab, \000: octal number) or control characters (^?: delete, ^@: null,	895	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
826	^A ...) and may enclosed with double quotes so that it can start or end	896	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
827	with whitespace. The intervening resource name B<keysym.> cannot be	897	can start or end with whitespace.
828	omitted. This resource is only available when compiled with	898
829	KEYSYM_RESOURCE.	899	Please note that you need to double the C<\> when using
		900	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
		901	use C<\033> instead of C<\e> (and so on), which will work with both Xt and
		902	@@RXVT_NAME@@'s own processing).
		903
		904	You can define a range of keysyms in one shot by providing a I<string>
		905	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
		906	should be a character not used by the strings.
		907
		908	Its usage can be demonstrated by an example:
		909
		910	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
		911
		912	The above line is equivalent to the following three lines:
		913
		914	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
		915	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
		916	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
		917
		918	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
		919	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
		920	example the following means "change the current locale to C<zh_CN.GBK>
		921	when Control-Meta-c is being pressed":
		922
		923	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		924
		925	The following example will map Control-Meta-1 and Control-Meta-2 to
		926	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
		927	font-switching at runtime:
		928
		929	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		930	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
		931
		932	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
		933	info):
		934
		935	URxvt.keysym.M-C-3: command:\033[8;25;80t
		936	URxvt.keysym.M-C-4: command:\033[8;48;110t
830		937
831	=back	938	=back
832		939
833	=head1 THE SCROLLBAR	940	=head1 THE SCROLLBAR
834		941
…		…
848	the normal text selection/insertion, hold either the Shift or the Meta	955	the normal text selection/insertion, hold either the Shift or the Meta
849	(Alt) key while performing the desired mouse action.	956	(Alt) key while performing the desired mouse action.
850		957
851	If mouse reporting mode is active, the normal scrollbar actions are	958	If mouse reporting mode is active, the normal scrollbar actions are
852	disabled -- on the assumption that we are using a fullscreen	959	disabled -- on the assumption that we are using a fullscreen
853	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	960	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
854	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	961	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
855	up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down),	962	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
856	respectively.	963	respectively.
857		964
858	=head1 TEXT SELECTION AND INSERTION	965	=head1 TEXT SELECTION AND INSERTION
859		966
860	The behaviour of text selection and insertion mechanism is similar to	967	The behaviour of text selection and insertion mechanism is similar to
…		…
862		969
863	=over 4	970	=over 4
864		971
865	=item B<Selection>:	972	=item B<Selection>:
866		973
867	Left click at the beginning of the region, drag to the end of the	974	Left click at the beginning of the region, drag to the end of the region
868	region and release; Right click to extend the marked region; Left	975	and release; Right click to extend the marked region; Left double-click
869	double-click to select a word; Left triple-click to select the entire	976	to select a word; Left triple-click to select the entire logical line
870	line.	977	(which can span multiple screen lines), unless modified by resource
		978	B<tripleclickwords>.
871		979
872	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	980	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
873	(Compile: frills) will create a rectangular selection instead of a normal	981	(Compile: I<frills>) will create a rectangular selection instead of a normal
874	one.	982	one.
875		983
876	=item B<Insertion>:	984	=item B<Insertion>:
877		985
878	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	986	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
…		…
901	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1009	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
902	with C<--enable-iso14755>.	1010	with C<--enable-iso14755>.
903		1011
904	=over 4	1012	=over 4
905		1013
906	=item 5.1: Basic method	1014	=item * 5.1: Basic method
907		1015
908	This allows you to enter unicode characters using their hexcode.	1016	This allows you to enter unicode characters using their hexcode.
909		1017
910	Start by pressing and holding both C<Control> and C<Shift>, then enter	1018	Start by pressing and holding both C<Control> and C<Shift>, then enter
911	hex-digits (between one and six). Releasing C<Control> and C<Shift> will	1019	hex-digits (between one and six). Releasing C<Control> and C<Shift> will
…		…
918	address, which you cannot type. Fortunately, the card has the e-mail	1026	address, which you cannot type. Fortunately, the card has the e-mail
919	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily	1027	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
920	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,	1028	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
921	followed by releasing the modifier keys.	1029	followed by releasing the modifier keys.
922		1030
923	=item 5.2: Keyboard symbols entry method	1031	=item * 5.2: Keyboard symbols entry method
924		1032
925	This mode lets you input characters representing the keycap symbols of	1033	This mode lets you input characters representing the keycap symbols of
926	your keyboard, if representable in the current locale encoding.	1034	your keyboard, if representable in the current locale encoding.
927		1035
928	Start by pressing C<Control> and C<Shift> together, then releasing	1036	Start by pressing C<Control> and C<Shift> together, then releasing
…		…
931	keycap symbol. The symbol will only be entered when the key has been	1039	keycap symbol. The symbol will only be entered when the key has been
932	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1040	released, otherwise pressing e.g. C<Shift> would enter the symbol for
933	C<ISO Level 2 Switch>, although your intention might have been to enter a	1041	C<ISO Level 2 Switch>, although your intention might have been to enter a
934	reverse tab (Shift-Tab).	1042	reverse tab (Shift-Tab).
935		1043
936	=item 5.3: Screen-selection entry method	1044	=item * 5.3: Screen-selection entry method
937		1045
938	While this is implemented already (it's basically the selection	1046	While this is implemented already (it's basically the selection
939	mechanism), it could be extended by displaying a unicode character map.	1047	mechanism), it could be extended by displaying a unicode character map.
940		1048
941	=item 5.4: Feedback method for identifying displayed characters for later input	1049	=item * 5.4: Feedback method for identifying displayed characters for later input
942		1050
943	This method lets you display the unicode character code associated with	1051	This method lets you display the unicode character code associated with
944	characters already displayed.	1052	characters already displayed.
945		1053
946	You enter this mode by holding down C<Control> and C<Shift> together, then	1054	You enter this mode by holding down C<Control> and C<Shift> together, then
…		…
958	With respect to conformance, rxvt-unicode is supposed to be compliant to	1066	With respect to conformance, rxvt-unicode is supposed to be compliant to
959	both scenario A and B of ISO 14755, including part 5.2.	1067	both scenario A and B of ISO 14755, including part 5.2.
960		1068
961	=head1 LOGIN STAMP	1069	=head1 LOGIN STAMP
962		1070
963	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so	1071	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
964	that it can be seen via the I<who(1)> command, and can accept messages.	1072	it can be seen via the I<who(1)> command, and can accept messages. To
965	To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on	1073	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
966	some systems.	1074	on some systems or setgid to root or to some other group on others.
967		1075
968	=head1 COLORS AND GRAPHICS	1076	=head1 COLORS AND GRAPHICS
969		1077
970	In addition to the default foreground and background colours,	1078	In addition to the default foreground and background colours,
971	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1079	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
…		…
1014		1122
1015	=back	1123	=back
1016		1124
1017	=head1 ENVIRONMENT	1125	=head1 ENVIRONMENT
1018		1126
1019	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>	1127	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1020	and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X	1128
1021	window id number of the B<@@RXVT_NAME@@> window and it also uses and	1129	=over 4
1022	sets the environment variable B<DISPLAY> to specify which display	1130
1023	terminal to use. B<@@RXVT_NAME@@> uses the environment variables	1131	=item B<TERM>
1024	B<RXVTPATH> and B<PATH> to find XPM files.	1132
		1133	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
		1134	resources or on the commandline.
		1135
		1136	=item B<COLORTERM>
		1137
		1138	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
		1139	compiled with XPM support, and optionally with the added extension
		1140	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
		1141
		1142	=item B<COLORFGBG>
		1143
		1144	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
		1145	the colour code used as default foreground/text colour (or the string
		1146	C<default> to indicate that the default-colour escape sequence is to be
		1147	used), C<bg> is the colour code used as default background colour (or the
		1148	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1149	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
		1150	(and do) use this information to optimize screen output.
		1151
		1152	=item B<WINDOWID>
		1153
		1154	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
		1155	window, which usually has subwindows for the scrollbar, the terminal
		1156	window and so on).
		1157
		1158	=item B<TERMINFO>
		1159
		1160	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1161	C<--with-terminfo=PATH>.
		1162
		1163	=item B<DISPLAY>
		1164
		1165	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
		1166	display in it's child processes.
		1167
		1168	=item B<SHELL>
		1169
		1170	The shell to be used for command execution, defaults to C</bin/sh>.
		1171
		1172	=item B<RXVTPATH>
		1173
		1174	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
		1175	files.
		1176
		1177	=item B<PATH>
		1178
		1179	Used in the same way as C<RXVTPATH>.
		1180
		1181	=item B<RXVT_SOCKET>
		1182
		1183	The unix domain socket path used by @@RXVT_NAME@@c(1) and
		1184	@@RXVT_NAME@@d(1).
		1185
		1186	Default C<< $HOME/.rxvt-unicode-<nodename >>.
		1187
		1188	=item B<HOME>
		1189
		1190	Used to locate the default directory for the unix domain socket for
		1191	daemon communications and to locate various resource files (such as
		1192	C<.Xdefaults>)
		1193
		1194	=item B<XAPPLRESDIR>
		1195
		1196	Directory where various X resource files are being located.
		1197
		1198	=item B<XENVIRONMENT>
		1199
		1200	If set and accessible, gives the name of a X resource file to be loaded by
		1201	@@RXVT_NAME@@.
		1202
		1203	=back
1025		1204
1026	=head1 FILES	1205	=head1 FILES
1027		1206
1028	=over 4	1207	=over 4
1029		1208
1030	=item B</etc/utmp>
1031
1032	System file for login records.
1033
1034	=item B</usr/lib/X11/rgb.txt>	1209	=item B</usr/lib/X11/rgb.txt>
1035		1210
1036	Color names.	1211	Color names.
1037		1212
1038	=back	1213	=back
…		…
1053		1228
1054	=over 4	1229	=over 4
1055		1230
1056	=item Project Coordinator	1231	=item Project Coordinator
1057		1232
1058	@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@>	1233	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1059		1234
1060	=item Web page maintainter	1235	L<http://software.schmorp.de/#rxvt-unicode>
1061
1062	@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1063
1064	L<@@RXVT_WEBPAGE@@>
1065		1236
1066	=back	1237	=back
1067		1238
1068	=head1 AUTHORS	1239	=head1 AUTHORS
1069		1240
…		…
1094	=item Geoff Wing L<< <gcw@pobox.com> >>	1265	=item Geoff Wing L<< <gcw@pobox.com> >>
1095		1266
1096	Rewrote screen display and text selection routines. Project Coordinator	1267	Rewrote screen display and text selection routines. Project Coordinator
1097	(changes.txt 2.4.6 - rxvt-unicode)	1268	(changes.txt 2.4.6 - rxvt-unicode)
1098		1269
1099	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>	1270	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1100		1271
1101	Forked rxvt-unicode, rewrote most of the display code and internal	1272	Forked rxvt-unicode, rewrote most of the display code and internal
1102	character handling to store text in unicode, improve xterm	1273	character handling to store text in unicode, improve xterm
1103	compatibility and apply numerous other bugfixes and extensions.	1274	compatibility and apply numerous other bugfixes and extensions.
1104		1275

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.36 by root, Wed Dec 15 05:10:57 2004 UTC vs. Revision 1.56 by root, Mon Feb 14 18:47:54 2005 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.36 by root, Wed Dec 15 05:10:57 2004 UTC vs.
Revision 1.56 by root, Mon Feb 14 18:47:54 2005 UTC