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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.3 by root, Thu Aug 12 22:22:30 2004 UTC vs.
Revision 1.30 by root, Wed Sep 8 17:10:23 2004 UTC

…		…
12	emulator intended as an I<xterm>(1) replacement for users who do not	12	emulator intended as an I<xterm>(1) replacement for users who do not
13	require features such as Tektronix 4014 emulation and toolkit-style	13	require features such as Tektronix 4014 emulation and toolkit-style
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	See also @@RXVT_NAME@@(7) for technical reference documentation (escape	17	=head1 FREQUENTLY ASKED QUESTIONS
18	sequences etc.) and the FAQ section at the end of this document.	18
		19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of frequently
		20	asked questions and answer to them and some common problems.
		21
		22	=head1 RXVT-UNICODE VS. RXVT
		23
		24	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
		26	world. Being a terminal emulator, however, some things are very difficult,
		27	especially cursive scripts such as arabic, vertically written scripts
		28	like mongolian or scripts requiring extremely complex combining rules,
		29	like tibetan or devenagari. Don't expect pretty output when using these
		30	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
		31	fine, though. A somewhat difficult case are left-to-right scripts, such
		32	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
		33	belong into the application, not the terminal emulator (too many things --
		34	such as cursor-movement while editing -- break otherwise), but that might
		35	change.
		36
		37	If you are looking for a terminal that supports more exotic scripts, let
		38	me recommend C<mlterm>, which is a very userfriendly, lean and clean
		39	terminal emulator. In fact, the reason rxvt-unicode was born was solely
		40	because the author couldn't get C<mlterm> to use one font for latin1 and
		41	another for japanese.
		42
		43	Therefore another design rationale was the use of multiple fonts to
		44	display characters: The idea of a single unicode font which many other
		45	programs force onto it's users never made sense to me: You should be able
		46	to choose any font for any script freely.
		47
		48	Apart from that, rxvt-unicode is also much better internationalised than
		49	it's predecessor, supports things such as XFT and ISO 14755 that are handy
		50	in i18n-environments, is faster, and has a lot less bugs than the original
		51	rxvt. This all in addition to dozens of other small improvements.
		52
		53	It is still faithfully following the original rxvt idea of being lean
		54	and nice on resources: for example, you can still configure rxvt-unicode
		55	without most of it's features to get a lean binary. It also comes with
		56	a client/daemon pair that lets you open any number of terminal windows
		57	from within a single process, which makes startup time very fast and
		58	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
		59	@@RXVT_NAME@@c(1) (client).
		60
		61	It also makes technical information about escape sequences (which have
		62	been extended) easier accessible: see @@RXVT_NAME@@(7) for technical
		63	reference documentation (escape sequences etc.).
19		64
20	=head1 OPTIONS	65	=head1 OPTIONS
21		66
22	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed	67	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
23	below. In keeping with the smaller-is-better philosophy, options may be	68	below. In keeping with the smaller-is-better philosophy, options may be
…		…
109		154
110	The mouse pointer background colour; resource B<pointerColor2>.	155	The mouse pointer background colour; resource B<pointerColor2>.
111		156
112	=item B<-bd> I<colour>	157	=item B<-bd> I<colour>
113		158
114	The colour of the border between the xterm scrollbar and the text;	159	The colour of the border around the text area and between the scrollbar and the text;
115	resource B<borderColor>.	160	resource B<borderColor>.
116		161
117	=item B<-fn> I<fontname>	162	=item B<-fn> I<fontlist>
118		163
119	Select the fonts to be used. This is a comma seperated list of font	164	Select the fonts to be used. This is a comma separated list of font names
120	names that are used in turn when trying to display Unicode characters.	165	that are used in turn when trying to display Unicode characters. The
121	The first font defines the cell size for characters; other fonts might	166	first font defines the cell size for characters; other fonts might be
122	be smaller, but not larger. A reasonable default font list is always	167	smaller, but not (in general) larger. A reasonable default font list is
123	appended to it. resource B<font>.	168	always appended to it. See resource B<font> for details.
124		169
125	=item B<-rb>\|B<+rb>	170	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
		171	section of @@RXVT_NAME@@(7).
126		172
127	Enable "real bold" support. When this option is on, bold text will be	173	=item B<-fb> I<fontlist>
128	displayed using the first available bold font in the font list. Bold	174
129	fonts should thus be specified in the font list after their	175	Compile font-styles: The bold font list to use when bold characters are to
130	corresponding regular fonts. If no bold font can be found, a regular	176	be printed. See resource B<boldFont> for details.
131	font will be used. resource B<realBold>.	177
		178	=item B<-fi> I<fontlist>
		179
		180	Compile font-styles: The italic font list to use when bold characters are to
		181	be printed. See resource B<italicFont> for details.
		182
		183	=item B<-fbi> I<fontlist>
		184
		185	Compile font-styles: The bold italic font list to use when bold characters are to
		186	be printed. See resource B<boldItalicFont> for details.
132		187
133	=item B<-name> I<name>	188	=item B<-name> I<name>
134		189
135	Specify the application name under which resources are to be obtained,	190	Specify the application name under which resources are to be obtained,
136	rather than the default executable file name. Name should not contain	191	rather than the default executable file name. Name should not contain
…		…
345	high-intensity (bold = bright foreground, blink = bright background)	400	high-intensity (bold = bright foreground, blink = bright background)
346	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	401	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
347	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	402	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
348	names used are listed in the B<COLORS AND GRAPHICS> section.	403	names used are listed in the B<COLORS AND GRAPHICS> section.
349		404
		405	Colours higher than 15 cannot be set using resources (yet), but can be
		406	changed using an escape command (see @@RXVT_NAME@@(7)).
		407
		408	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
		409	88 colour support). Colours 80-87 are evenly spaces grey steps.
		410
350	=item B<colorBD:> I<colour>	411	=item B<colorBD:> I<colour>
351		412
		413	=item B<colorIT:> I<colour>
		414
352	Use the specified colour to display bold characters when the foreground	415	Use the specified colour to display bold or italic characters when the
353	colour is the default. This option will be ignored if B<realBold> is	416	foreground colour is the default. If font styles are not available
354	enabled.	417	(Compile styles) and this option is unset, reverse video is used instead.
355		418
356	=item B<colorUL:> I<colour>	419	=item B<colorUL:> I<colour>
357		420
358	Use the specified colour to display underlined characters when the	421	Use the specified colour to display underlined characters when the
359	foreground colour is the default.	422	foreground colour is the default.
…		…
415		478
416	=item B<troughColor:> I<colour>	479	=item B<troughColor:> I<colour>
417		480
418	Use the specified colour for the scrollbar's trough area [default	481	Use the specified colour for the scrollbar's trough area [default
419	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	482	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.
		483
		484	=item B<borderColor:> I<colour>
		485
		486	The colour of the border around the text area and between the scrollbar
		487	and the text.
420		488
421	=item B<backgroundPixmap:> I<file[;geom]>	489	=item B<backgroundPixmap:> I<file[;geom]>
422		490
423	Use the specified XPM file (note the `.xpm' extension is optional) for	491	Use the specified XPM file (note the `.xpm' extension is optional) for
424	the background and also optionally specify its scaling with a geometry	492	the background and also optionally specify its scaling with a geometry
…		…
440		508
441	Specify the colon-delimited search path for finding files (XPM and	509	Specify the colon-delimited search path for finding files (XPM and
442	menus), in addition to the paths specified by the B<RXVTPATH> and	510	menus), in addition to the paths specified by the B<RXVTPATH> and
443	B<PATH> environment variables.	511	B<PATH> environment variables.
444		512
445	=item B<font:> I<fontname>	513	=item B<font:> I<fontlist>
446		514
447	Select the fonts to be used. This is a comma seperated list of font	515	Select the fonts to be used. This is a comma separated list of font
448	names that are used in turn when trying to display Unicode characters.	516	names that are used in turn when trying to display Unicode characters.
449	The first font defines the cell size for characters; other fonts might	517	The first font defines the cell size for characters; other fonts might
450	be smaller, but not larger. A reasonable default font list is always	518	be smaller, but not larger. A reasonable default font list is always
451	appended to it. option B<-fn>.	519	appended to it. option B<-fn>.
452		520
453	=item B<realBold:> I<boolean>	521	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:>.
454		523
455	B<True>: Enable "real bold" support. When this option is on, bold text	524	In addition, each font can be prefixed with additional hints and
456	will be displayed using the first available bold font in the font list.	525	specifications enclosed in square brackets (C<[]>). The only available
457	Bold fonts should thus be specified in the font list after their	526	hint currently is C<codeset=codeset-name>, and this is only used for Xft
458	corresponding regular fonts. If no bold font can be found, a regular	527	fonts.
459	font will be used. option B<-rb>. B<False>: Display bold text in a	528
460	regular font, using the color specified with B<colorBD>; option B<+rb>.	529	For example, this font resource
		530
		531	URxvt*font: 9x15bold,\
		532	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
		533	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
		534	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
		535	xft:Code2000:antialias=false
		536
		537	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
		539	it is named first) and thus defines the character cell grid to be 9 pixels
		540	wide and 15 pixels high.
		541
		542	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
		544	the bold version of the font does contain less characters, so this is a
		545	useful supplement.
		546
		547	The third font is an Xft font with aliasing turned off, and the characters
		548	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
		549	contains other characters, but we are not interested in them.
		550
		551	The last font is a useful catch-all font that supplies most of the
		552	remaining unicode characters.
		553
		554	=item B<boldFont:> I<fontlist>
		555
		556	=item B<italicFont:> I<fontlist>
		557
		558	=item B<boldItalicFont:> I<fontlist>
		559
		560	The font list to use for displaying B<bold>, I<italic> or B<< I<bold
		561	italic> >> characters, respectively.
		562
		563	If specified and non-empty, then the syntax is the same as for the
		564	B<font>-resource, and the given font list will be used as is, which makes
		565	it possible to substitute completely different font styles for bold and
		566	italic.
		567
		568	If unset (the default), a suitable font list will be synthesized by
		569	"morphing" the normal text font list into the desired shape. If that is
		570	not possible, replacement fonts of the desired shape will be tried.
		571
		572	If set, but empty, then this specific style is disabled and the normal
		573	text font will being used for the given style.
461		574
462	=item B<selectstyle:> I<mode>	575	=item B<selectstyle:> I<mode>
463		576
464	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	577	Set mouse selection style to B<old> which is 2.20, B<oldword> which is
465	xterm style with 2.20 old word selection, or anything else which gives	578	xterm style with 2.20 old word selection, or anything else which gives
…		…
530	Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar	643	Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar
531	thumb with the pointer on middle button press/drag.	644	thumb with the pointer on middle button press/drag.
532		645
533	=item B<scrollTtyOutput:> I<boolean>	646	=item B<scrollTtyOutput:> I<boolean>
534		647
535	B<True>: scroll to bottom when tty receives output; option B<+si>.	648	B<True>: scroll to bottom when tty receives output; option B<-si>.
536	B<False>: do not scroll to bottom when tty receives output; option	649	B<False>: do not scroll to bottom when tty receives output; option
537	B<-si>.	650	B<+si>.
538		651
539	=item B<scrollWithBuffer:> I<boolean>	652	=item B<scrollWithBuffer:> I<boolean>
540		653
541	B<True>: scroll with scrollback buffer when tty recieves new lines (and	654	B<True>: scroll with scrollback buffer when tty receives new lines (and
542	B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll	655	B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll
543	with scrollback buffer when tty recieves new lines; option B<-sw>.	656	with scrollback buffer when tty recieves new lines; option B<-sw>.
544		657
545	=item B<scrollTtyKeypress:> I<boolean>	658	=item B<scrollTtyKeypress:> I<boolean>
546		659
547	B<True>: scroll to bottom when a non-special key is pressed. Special keys	660	B<True>: scroll to bottom when a non-special key is pressed. Special keys
548	are those which are intercepted by rxvt-unicode for special handling and	661	are those which are intercepted by rxvt-unicode for special handling and
549	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to	662	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
550	bottom when a non-special key is pressed; option B<+sk>.	663	bottom when a non-special key is pressed; option B<+sk>.
551		664
552	=item B<smallfont_key:> I<keysym>
553
554	If enabled, use B<@@HOTKEY@@->I<keysym> to toggle to a smaller font
555	[default B<@@HOTKEY@@-@@SMALLFONT@@>]
556
557	=item B<bigfont_key:> I<keysym>
558
559	If enabled, use B<@@HOTKEY@@->I<keysym> to toggle to a bigger font
560	[default B<@@HOTKEY@@-@@BIGFONT@@>]
561
562	=item B<saveLines:> I<number>	665	=item B<saveLines:> I<number>
563		666
564	Save I<number> lines in the scrollback buffer [default 64]. This	667	Save I<number> lines in the scrollback buffer [default 64]. This
565	resource is limited on most machines to 65535; option B<-sl>.	668	resource is limited on most machines to 65535; option B<-sl>.
566		669
…		…
655	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	758	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.
656	de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input	759	de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input
657	extension to be able to input japanese characters while staying in	760	extension to be able to input japanese characters while staying in
658	another locale. option B<-imlocale>.	761	another locale. option B<-imlocale>.
659		762
660	=item B<insecure>	763	=item B<insecure:> I<boolean>
661		764
662	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	765	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
663	echo arbitrary strings like the icon name or the locale. This could be	766	echo arbitrary strings like the icon name or the locale. This could be
664	abused if somebody gets 8-bit-clean access to your display, wether	767	abused if somebody gets 8-bit-clean access to your display, whether
665	throuh a mail client displaying mail bodies unfiltered or though	768	throuh a mail client displaying mail bodies unfiltered or though
666	write(1). Therefore, these sequences are disabled by default. (Note	769	write(1). Therefore, these sequences are disabled by default. (Note
667	that other terminals, including xterm, have these sequences	770	that other terminals, including xterm, have these sequences
668	enabled by default). You can enable them by setting this boolean	771	enabled by default). You can enable them by setting this boolean
669	resource or specifying B<-insecure> as an option. At the moment, this	772	resource or specifying B<-insecure> as an option. At the moment, this
…		…
743	Left click at the beginning of the region, drag to the end of the	846	Left click at the beginning of the region, drag to the end of the
744	region and release; Right click to extend the marked region; Left	847	region and release; Right click to extend the marked region; Left
745	double-click to select a word; Left triple-click to select the entire	848	double-click to select a word; Left triple-click to select the entire
746	line.	849	line.
747		850
		851	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
		853	one.
		854
748	=item B<Insertion>:	855	=item B<Insertion>:
749		856
750	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	857	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
751	an B<@@RXVT_NAME@@> window causes the current text selection to be	858	an B<@@RXVT_NAME@@> window causes the current text selection to be
752	inserted as if it had been typed on the keyboard.	859	inserted as if it had been typed on the keyboard.
753		860
754	=back	861	=back
755		862
756	=head1 CHANGING FONTS	863	=head1 CHANGING FONTS
757		864
758	You can change fonts on-the-fly, which is to say cycle through the	865	Changing fonts (or font sizes, respectively) via the keypad is not yet
759	default font and others of various sizes, by using B<Shift-KP_Add> and	866	supported in rxvt-unicode. Bug me if you need this.
760	B<Shift-KP_Subtract>. Or, alternatively (if enabled) with	867
761	B<@@HOTKEY@@-@@BIGFONT@@> and B<@@HOTKEY@@-@@SMALLFONT@@>, where the	868	You can, however, switch fonts at runtime using escape sequences (and
762	actual key can be selected using resources	869	therefore using the menubar), e.g.:
763	B<smallfont_key>/B<bigfont_key>.	870
		871	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"
		872
		873	rxvt-unicode will automatically re-apply these fonts to the output so far.
764		874
765	=head1 ISO 14755 SUPPORT	875	=head1 ISO 14755 SUPPORT
766		876
767	Partial ISO 14755-support is implemented. that means that pressing	877	ISO 14755 is a standard for entering and viewing unicode characters
		878	and character codes using the keyboard. It consists of 4 parts. The
		879	first part is available rxvt-unicode has been compiled with
		880	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
		881	with C<--enable-iso14755>.
768		882
769	Section 5.1: Control and Shift together enters unicode input	883	=over 4
770	mode. Entering hex digits composes a Unicode character, pressing space or
771	releasing the modifiers commits the keycode and every other key cancels
772	the current input character.
773		884
774	Section 5.2: Pressing and immediately releasing Control and Shift together	885	=item 5.1: Basic method
775	enters keycap entry mode for the next key: pressing a function key (tab,	886
776	return etc..) will enter the unicode character corresponding to the given	887	This allows you to enter unicode characters using their hexcode.
777	key.	888
		889	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
		891	commit the character as if it were typed directly. While holding down
		892	C<Control> and C<Shift> you can also enter multiple characters by pressing
		893	C<Space>, which will commit the current character and lets you start a new
		894	one.
		895
		896	As an example of use, imagine a business card with a japanese e-mail
		897	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
		899	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.
		901
		902	=item 5.2: Keyboard symbols entry method
		903
		904	This mode lets you input characters representing the keycap symbols of
		905	your keyboard, if representable in the current locale encoding.
		906
		907	Start by pressing C<Control> and C<Shift> together, then releasing
		908	them. The next special key (cursor keys, home etc.) you enter will not
		909	invoke it's usual function but instead will insert the corresponding
		910	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
		912	C<ISO Level 2 Switch>, although your intention might have been to enter a
		913	reverse tab (Shift-Tab).
		914
		915	=item 5.3: Screen-selection entry method
		916
		917	While this is implemented already (it's basically the selection
		918	mechanism), it could be extended by displaying a unicode character map.
		919
		920	=item 5.4: Feedback method for identifying displayed characters for later input
		921
		922	This method lets you display the unicode character code associated with
		923	characters already displayed.
		924
		925	You enter this mode by holding down C<Control> and C<Shift> together, then
		926	pressing and holding the left mouse button and moving around. The unicode
		927	hex code(s) (it might be a combining character) of the character under the
		928	pointer is displayed until you release C<Control> and C<Shift>.
		929
		930	In addition to the hex codes it will display the font used to draw this
		931	character - due to implementation reasons, characters combined with
		932	combining characters, line drawing characters and unknown characters will
		933	always be drawn using the built-in support font.
		934
		935	=back
		936
		937	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.
778		939
779	=head1 LOGIN STAMP	940	=head1 LOGIN STAMP
780		941
781	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so	942	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so
782	that it can be seen via the I<who(1)> command, and can accept messages.	943	that it can be seen via the I<who(1)> command, and can accept messages.
…		…
853		1014
854	Color names.	1015	Color names.
855		1016
856	=back	1017	=back
857		1018
858	=head1 FREQUENTLY ASKED QUESTIONS (FAQ)	1019	=head1 SEE ALSO
		1020
		1021	@@RXVT_NAME@@(7), 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
		1031	=head1 CURRENT PROJECT COORDINATOR
859		1032
860	=over 4	1033	=over 4
861		1034
862	=item How do I know which rxvt-unicode version I'm using?
863
864	The version number is displayed with the usage (-h). For rxvt-unicode
865	version 2.14 and later, the escape sequence C<ESC[8n> sets the window
866	title to the version number.
867
868	=item Mouse cut/paste suddenly no longer works.
869
870	Make sure that mouse reporting is actually turned off since killing
871	some editors prematurely may leave the mouse in mouse report mode. I've
872	heard that tcsh may use mouse reporting unless it otherwise specified. A
873	quick check is to see if cut/paste works when the Alt or Shift keys are
874	depressed. See @@RXVT_NAME@@(7)
875
876	=item What's with this bold/blink stuff?
877
878	If no bold colour is set via C<colorBD:>, bold will invert text using the
879	standard foreground colour.
880
881	For the standard background colour, blinking will actually make the
882	text blink when compiled with C<--enable-blinking>. with standard
883	colours. Without C<--enable-blinking>, the blink attribute will be
884	ignored.
885
886	On ANSI colours, bold/blink attributes are used to set high-intensity
887	foreground/background colors.
888
889	color0-7 are the low-intensity colors.
890
891	color8-15 are the corresponding high-intensity colors.
892
893	=item I don't like the screen colors. How do I change them?
894
895	You can change the screen colors at run-time using F<~/.Xdefaults>
896	resources (or as long-options).
897
898	Here are values that are supposed to resemble a VGA screen,
899	including the murky brown that passes for low-intensity yellow:
900
901	Rxvt*color0: #000000
902	Rxvt*color1: #A80000
903	Rxvt*color2: #00A800
904	Rxvt*color3: #A8A800
905	Rxvt*color4: #0000A8
906	Rxvt*color5: #A800A8
907	Rxvt*color6: #00A8A8
908	Rxvt*color7: #A8A8A8
909
910	Rxvt*color8: #000054
911	Rxvt*color9: #FF0054
912	Rxvt*color10: #00FF54
913	Rxvt*color11: #FFFF54
914	Rxvt*color12: #0000FF
915	Rxvt*color13: #FF00FF
916	Rxvt*color14: #00FFFF
917	Rxvt*color15: #FFFFFF
918
919	=item What's with the strange Backspace/Delete key behaviour?
920
921	Assuming that the physical Backspace key corresponds to the
922	BackSpace keysym (not likely for Linux ... see the following
923	question) there are two standard values that can be used for
924	Backspace: C<^H> and C<^?>.
925
926	Historically, either value is correct, but rxvt-unicode adopts the debian
927	policy of using C<^?> when unsure, because it's the one only only correct
928	choice :).
929
930	Rxvt-unicode tries to inherit the current stty settings and uses the value
931	of `erase' to guess the value for backspace. If rxvt-unicode wasn't
932	started from a terminal (say, from a menu or by remote shell), then the
933	system value of `erase', which corresponds to CERASE in <termios.h>, will
934	be used (which may not be the same as your stty setting).
935
936	For starting a new rxvt-unicode:
937
938	# use Backspace = ^H
939	$ stty erase ^H
940	$ @@RXVT_NAME@@
941
942	# use Backspace = ^?
943	$ stty erase ^?
944	$ @@RXVT_NAME@@
945
946	Toggle with "ESC[36h" / "ESC[36l" as documented in @@RXVT_NAME@@(7).
947
948	For an existing rxvt-unicode:
949
950	# use Backspace = ^H
951	$ stty erase ^H
952	$ echo -n "^[[36h"
953
954	# use Backspace = ^?
955	$ stty erase ^?
956	$ echo -n "^[[36l"
957
958	This helps satisfy some of the Backspace discrepancies that occur, but
959	if you use Backspace = C<^H>, make sure that the termcap/terminfo value
960	properly reflects that.
961
962	The Delete key is a another casualty of the ill-defined Backspace problem.
963	To avoid confusion between the Backspace and Delete keys, the Delete
964	key has been assigned an escape sequence to match the vt100 for Execute
965	(ESC[3~) and is in the supplied termcap/terminfo.
966
967	Some other Backspace problems:
968
969	some editors use termcap/terminfo,
970	some editors (vim I'm told) expect Backspace = ^H,
971	GNU Emacs (and Emacs-like editors) use ^H for help.
972
973	Perhaps someday this will all be resolved in a consistent manner.
974
975	=item I don't like the key-bindings. How do I change them?
976
977	There are some compile-time selections available via configure. Unless
978	you have run "configure" with the C<--disable-resources> option you can
979	use the `keysym' resource to alter the keystrings associated with keysym
980	0xFF00 - 0xFFFF (function, cursor keys, etc).
981
982	Here's an example for a tn3270 session started using `@@RXVT_NAME@@ -name tn3270'
983
984	!# ----- special uses ------:
985	! tn3270 login, remap function and arrow keys.
986	tn3270font: clean-bold----15-*
987
988	! keysym - used by rxvt only
989	! Delete - ^D
990	tn3270*keysym.0xFFFF: \004
991
992	! Home - ^A
993	tn3270*keysym.0xFF50: \001
994	! Left - ^B
995	tn3270*keysym.0xFF51: \002
996	! Up - ^P
997	tn3270*keysym.0xFF52: \020
998	! Right - ^F
999	tn3270*keysym.0xFF53: \006
1000	! Down - ^N
1001	tn3270*keysym.0xFF54: \016
1002	! End - ^E
1003	tn3270*keysym.0xFF57: \005
1004
1005	! F1 - F12
1006	tn3270*keysym.0xFFBE: \e1
1007	tn3270*keysym.0xFFBF: \e2
1008	tn3270*keysym.0xFFC0: \e3
1009	tn3270*keysym.0xFFC1: \e4
1010	tn3270*keysym.0xFFC2: \e5
1011	tn3270*keysym.0xFFC3: \e6
1012	tn3270*keysym.0xFFC4: \e7
1013	tn3270*keysym.0xFFC5: \e8
1014	tn3270*keysym.0xFFC6: \e9
1015	tn3270*keysym.0xFFC7: \e0
1016	tn3270*keysym.0xFFC8: \e-
1017	tn3270*keysym.0xFFC9: \e=
1018
1019	! map Prior/Next to F7/F8
1020	tn3270*keysym.0xFF55: \e7
1021	tn3270*keysym.0xFF56: \e8
1022
1023	=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
1024	How do I make use of them? For example, the Sun Keyboard type 4
1025	has the following mappings that rxvt-unicode doesn't recognize.
1026
1027	KP_Insert == Insert
1028	F22 == Print
1029	F27 == Home
1030	F29 == Prior
1031	F33 == End
1032	F35 == Next
1033
1034	Rather than have rxvt-unicode try to accomodate all the various possible keyboard
1035	mappings, it is better to use `xmodmap' to remap the keys as required for
1036	your particular machine.
1037
1038	=item How do I distinguish if I'm running rxvt-unicode or a regular xterm?
1039	I need this to decide about setting colors etc.
1040
1041	rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
1042	check and see if that is set. Note that several programs, JED, slrn,
1043	Midnight Commander automatically check this variable to decide whether or
1044	not to use color.
1045
1046	=item How do I set the correct, full IP address for the DISPLAY variable?
1047
1048	If you've compiled rxvt-unicode with DISPLAY_IS_IP and ahve enabled
1049	insecure mode then it is possible to use the following shell script
1050	snippets to correctly set the display. If your version of rxvt-unicode
1051	wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
1052	the COLORTERM variable can be used to distinguish rxvt-unicode from a
1053	regular xterm.
1054
1055	Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
1056	snippets:
1057
1058	# Bourne/Korn/POSIX family of shells:
1059	[ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
1060	if [ ${TERM:-foo} = xterm ]; then
1061	stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
1062	echo -n '^[Z'
1063	read term_id
1064	stty icanon echo
1065	if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
1066	echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
1067	read DISPLAY # set it in our local shell
1068	fi
1069	fi
1070
1071	=item How do I compile the manual pages for myself?
1072
1073	You need to have a recent version of perl installed as F</usr/bin/perl>,
1074	one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
1075	the doc subdirectory and enter C<make alldoc>.
1076
1077	=back
1078
1079	=head1 SEE ALSO
1080
1081	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1082
1083	=head1 BUGS
1084
1085	Check the BUGS file for an up-to-date list.
1086
1087	Cursor change support is not yet implemented.
1088
1089	Click-and-drag doesn't work with X11 mouse report overriding.
1090
1091	=head1 CURRENT PROJECT COORDINATOR
1092
1093	=over 4
1094
1095	=item Project Coordinator	1035	=item Project Coordinator
1096		1036
1097	@@RXVTMAINT@@ L<@@RXVT_MAINTEMAIL@@>	1037	@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@>
1098		1038
1099	=item Web page maintainter	1039	=item Web page maintainter
1100		1040
1101	@@RXVTWEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>	1041	@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1102		1042
1103	L<@@RXVT_WEBPAGE@@>	1043	L<@@RXVT_WEBPAGE@@>
1104		1044
1105	=back	1045	=back
1106		1046

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.3 by root, Thu Aug 12 22:22:30 2004 UTC vs. Revision 1.30 by root, Wed Sep 8 17:10:23 2004 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.3 by root, Thu Aug 12 22:22:30 2004 UTC vs.
Revision 1.30 by root, Wed Sep 8 17:10:23 2004 UTC