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

Comparing rxvt-unicode/doc/rxvt.tbl (file contents):
Revision 1.1 by pcg, Mon Nov 24 17:28:08 2003 UTC vs.
Revision 1.7 by pcg, Mon Mar 29 16:52:06 2004 UTC

…		…
1	.TH "RXVT" "1" "RXVTDATE()" "X Version 11" "X Tools"	1	.TH "RXVT" "1" "2004-03-28" "X Version 11" "X Tools"
2	.SH "NAME"	2	.SH "NAME"
3	rxvt (ouR XVT) \- a VT102 emulator for the X window system	3	rxvt-unicode (ouR XVT, unicode) \- a VT102 emulator for the X window system
4	.PP	4	.PP
5	.SH "SYNOPSIS"	5	.SH "SYNOPSIS"
6	.PP	6	.PP
7	\fBrxvt\fP [options] [-e command [ args ]]	7	\fBrxvt\fP [options] [-e command [ args ]]
8	.PP	8	.PP
9	.SH "DESCRIPTION"	9	.SH "DESCRIPTION"
10	.PP	10	.PP
11	\fBrxvt\fP, version \fBRXVTVERSION()\fP, is a colour vt102 terminal emulator	11	\fBrxvt-unicode\fP, version \fB2\&.5\fP, is a colour vt102 terminal emulator
12	intended as an \fIxterm\fP(1) replacement for users who do not require	12	intended as an \fIxterm\fP(1) replacement for users who do not require
13	features such as Tektronix 4014 emulation and toolkit-style configurability\&.	13	features such as Tektronix 4014 emulation and toolkit-style configurability\&.
14	As a result, \fBrxvt\fP uses much less swap space -- a significant	14	As a result, \fBrxvt-unicode\fP uses much less swap space -- a significant
15	advantage on a machine serving many X sessions\&.	15	advantage on a machine serving many X sessions\&.
16	.PP	16	.PP
17	.PP	17	.PP
18	.SH "OPTIONS"	18	.SH "OPTIONS"
19	.PP	19	.PP
29	.PP	29	.PP
30	Note that \fBrxvt\fP permits the resource name to be used as a long-option	30	Note that \fBrxvt\fP permits the resource name to be used as a long-option
31	(--/++ option) so the potential command-line options are far greater than	31	(--/++ option) so the potential command-line options are far greater than
32	those listed\&.	32	those listed\&.
33	For example: `rxvt --loginShell --color1 Orange\&'\&.	33	For example: `rxvt --loginShell --color1 Orange\&'\&.
34	.PP
35	Also note that if you do not explictly specify a font (\fB-fn\fP and \fB-fm\fP)
36	or a multichar encoding method (\fB-km\fP), rxvt will select a font for the
37	preferable encoding according to your locale\&. Supported encodings are:
38	\fBISO-8859-\fPn (n=\fB1\fP\&.\&.\&.\fB15\fP), \fBKOI8-R\fP, \fBKOI8-U\fP, \fBEUC-JP\fP,
39	\fBShift_JIS\fP, \fBEUC-KR\fP, \fBEUC-CN\fP (aka \fBGB\fP), and \fBBig5\fP\&.
40	.PP	34	.PP
41	The following options are available:	35	The following options are available:
42	.PP	36	.PP
43	.IP "\fB-help\fP, \fB--help\fP"	37	.IP "\fB-help\fP, \fB--help\fP"
44	Print out a message describing available options\&.	38	Print out a message describing available options\&.
…		…
79	resource \fBpointerColor\fP\&.	73	resource \fBpointerColor\fP\&.
80	.IP "\fB-bd\fP \fIcolour\fP"	74	.IP "\fB-bd\fP \fIcolour\fP"
81	The colour of the border between the xterm scrollbar and the text;	75	The colour of the border between the xterm scrollbar and the text;
82	resource \fBborderColor\fP\&.	76	resource \fBborderColor\fP\&.
83	.IP "\fB-fn\fP \fIfontname\fP"	77	.IP "\fB-fn\fP \fIfontname\fP"
84	Main normal text font;	78	Select the fonts to be used used\&. This is a comma seperated
		79	list of font names that are used in turn when trying to display
		80	unicode characters\&. The first font defines the cell size for characters,
		81	other fonts might be smaller, but not larger\&. A reasonable default font list
		82	is always appended to it\&.
85	resource \fBfont\fP\&.	83	resource \fBfont\fP\&.
86	.IP "\fB-fb\fP \fIfontname\fP"
87	Main bold text font;
88	resource \fBboldFont\fP\&.
89	.IP "\fB-fm\fP \fIfontname\fP"
90	Main multicharacter font;
91	resource \fBmfont\fP\&.
92	.IP "\fB-km\fP \fImode\fP"
93	Compile \fImultichar_languages\fP:
94	Multiple-character font-set encoding mode;
95	\fBeucj\fP: EUC Japanese encoding\&.
96	\fBsjis\fP: Shift JIS encoding\&.
97	\fBbig5\fP: BIG5 encoding\&.
98	\fBgb\fP: GB encoding\&.
99	\fBkr\fP: EUC Korean encoding\&.
100	\fBnoenc\fP: no encoding;
101	resource \fBmultichar_encoding\fP\&.
102	.IP "\fB-grk\fP \fImode\fP"
103	Compile \fIGreek\fP: Greek keyboard translation;
104	\fBiso\fP: ISO-8859 mapping\&.
105	\fBibm\fP: IBM-437 mapping;
106	resource \fBgreek_keyboard\fP\&.
107	.IP "\fB-name\fP \fIname\fP"	84	.IP "\fB-name\fP \fIname\fP"
108	Specify the application name under which resources	85	Specify the application name under which resources
109	are to be obtained, rather than the default executable file name\&.	86	are to be obtained, rather than the default executable file name\&.
110	Name should not contain `\&.\&' or `*\&' characters\&.	87	Name should not contain `\&.\&' or `*\&' characters\&.
111	Also sets the icon and title name\&.	88	Also sets the icon and title name\&.
…		…
135	Put scrollbar on right/left;	112	Put scrollbar on right/left;
136	resource \fBscrollBar_right\fP\&.	113	resource \fBscrollBar_right\fP\&.
137	.IP "\fB-st\fP\|\fB+st\fP"	114	.IP "\fB-st\fP\|\fB+st\fP"
138	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	115	Display normal (non XTerm/NeXT) scrollbar without/with a trough;
139	resource \fBscrollBar_floating\fP\&.	116	resource \fBscrollBar_floating\fP\&.
140	.IP "\fB-mcc\fP\|\fB+mcc\fP"
141	Compile \fImultichar_languages\fP: treat multibyte glyphs as single
142	character for backspace, delete and cursor movement keys;
143	resource \fBmultibyte_cursor\fP\&.
144	.IP "\fB-bc\fP\|\fB+bc\fP"	117	.IP "\fB-bc\fP\|\fB+bc\fP"
145	Blink the cursor; resource \fBcursorBlink\fP\&.	118	Blink the cursor; resource \fBcursorBlink\fP\&.
146	.IP "\fB-iconic\fP"	119	.IP "\fB-iconic\fP"
147	Start iconified, if the window manager supports that option\&.	120	Start iconified, if the window manager supports that option\&.
148	Alternative form is \fB-ic\fP\&.	121	Alternative form is \fB-ic\fP\&.
…		…
191	\fBOverTheSpot\fP, \fBOffTheSpot\fP, \fBRoot\fP;	164	\fBOverTheSpot\fP, \fBOffTheSpot\fP, \fBRoot\fP;
192	resource \fBpreeditType\fP\&.	165	resource \fBpreeditType\fP\&.
193	.IP "\fB-im\fP \fItext\fP"	166	.IP "\fB-im\fP \fItext\fP"
194	Compile \fIXIM\fP: input method name\&.	167	Compile \fIXIM\fP: input method name\&.
195	resource \fBinputMethod\fP\&.	168	resource \fBinputMethod\fP\&.
		169	.IP "\fB-imlocale\fP \fIstring\fP"
		170	The locale to use for opening the IM\&. You can use an LC_CTYPE
		171	of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP
		172	for the input extension to be able to input japanese characters
		173	while staying in another locale\&.
		174	.IP "\fB-insecure\fP"
		175	Enable "insecure" mode, which currently enables most of the escape
		176	sequences that echo strings\&. See the resource \fBinsecure\fP for
		177	more info\&.
196	.IP "\fB-mod\fP \fImodifier\fP"	178	.IP "\fB-mod\fP \fImodifier\fP"
197	Override detection of Meta modifier with specified key:	179	Override detection of Meta modifier with specified key:
198	\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP,	180	\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP,
199	\fBmod4\fP, \fBmod5\fP;	181	\fBmod4\fP, \fBmod5\fP;
200	resource \fImodifier\fP\&.	182	resource \fImodifier\fP\&.
…		…
295	.IP "\fBpath:\fP \fIpath\fP"	277	.IP "\fBpath:\fP \fIpath\fP"
296	Specify the colon-delimited search path for finding files (XPM and	278	Specify the colon-delimited search path for finding files (XPM and
297	menus), in addition to the paths specified by the \fBRXVTPATH\fP and	279	menus), in addition to the paths specified by the \fBRXVTPATH\fP and
298	\fBPATH\fP environment variables\&.	280	\fBPATH\fP environment variables\&.
299	.IP "\fBfont:\fP \fIfontname\fP"	281	.IP "\fBfont:\fP \fIfontname\fP"
300	Select the main text font used [default 7x14];	282	Select the fonts to be used used\&. This is a comma seperated
		283	list of font names that are used in turn when trying to display
		284	unicode characters\&. The first font defines the cell size for characters,
		285	other fonts might be smaller, but not larger\&. A reasonable default font list
		286	is always appended to this list\&.
301	option \fB-fn\fP\&.	287	option \fB-fn\fP\&.
302	.IP "\fBfont\fP\fIn\fP\fB:\fP \fIfontname\fP"
303	Specify the alternative font \fIn\fP\&. The default font values:
304	.br
305	.RS
306	.HP
307	.TS
308	tab(`);
309	l l .
310	\fBfont\fP: `\ 7x14
311	\fBfont1\fP: `\ 6x10
312	\fBfont2\fP: `\ 6x13
313	\fBfont3\fP: `\ 8x13
314	\fBfont4\fP: `\ 9x15
315	.TE
316	.RE
317	.IP "\fBboldFont:\fP \fIfontname\fP"
318	Specify the name of the bold font to use if \fBcolorBD\fP has not been
319	specified and it is not possible to map the default foreground colour
320	to colour 8-15 [default NONE]\&. This font must be the same height and
321	width as the normal font;
322	option \fB-fb\fP\&.
323	.IP "\fBmfont:\fP \fIfontname\fP"
324	Select the main multiple-character text font used [default k14];
325	option \fB-fk\fP\&.
326	.IP "\fBmfont\fP\fIn\fP\fB:\fP \fIfontname\fP"
327	Specify the alternative multiple-character font \fIn\fP\&. If compiled
328	for multiple-character fonts, the Roman and multiple-character font
329	sizes should match\&.
330	.IP "\fBmultichar_encoding:\fP \fImode\fP"
331	Set the encoding mode to be used when multicharacter encoding is
332	received;
333	\fBeucj\fP: EUC Japanese encoding [default for Kanji]\&.
334	\fBsjis\fP: Shift JIS encoding\&.
335	\fBbig5\fP: BIG5 encoding\&.
336	\fBgb\fP: GB encoding\&.
337	\fBkr\fP: EUC Korean encoding\&.
338	\fBnoenc\fP: no encoding;
339	option \fB-km\fP\&.
340	.IP "\fBgreek_keyboard:\fP \fImode\fP"
341	Set the Greek keyboard translation mode to be used;
342	\fBiso\fP: ISO-8859 mapping (elot-928) [default]\&.
343	\fBibm\fP: IBM-437 mapping (DOS codepage 737);
344	option \fB-grk\fP\&.
345	.IP "\fBgreektoggle_key:\fP \fIkeysym\fP"
346	Set the key to toggle keyboard input between no translation and
347	Greek translation [default \fBMode_switch\fP]\&.
348	For more details, see the distributed file \fBREADME\&.greek\fP\&.
349	.IP "\fBselectstyle:\fP \fImode\fP"	288	.IP "\fBselectstyle:\fP \fImode\fP"
350	Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which	289	Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which
351	is xterm style with 2\&.20 old word selection, or anything else which	290	is xterm style with 2\&.20 old word selection, or anything else which
352	gives xterm style selection\&.	291	gives xterm style selection\&.
353	.IP "\fBscrollstyle:\fP \fImode\fP"	292	.IP "\fBscrollstyle:\fP \fImode\fP"
…		…
462	\fBTrue\fP: blank the pointer when a key is pressed or after a set number	401	\fBTrue\fP: blank the pointer when a key is pressed or after a set number
463	of seconds of inactivity\&.	402	of seconds of inactivity\&.
464	\fBFalse\fP: the pointer is always visible [default]\&.	403	\fBFalse\fP: the pointer is always visible [default]\&.
465	.IP "\fBpointerBlankDelay:\fP \fInumber\fP"	404	.IP "\fBpointerBlankDelay:\fP \fInumber\fP"
466	Specifies number of seconds before blanking the pointer [default 2]\&.	405	Specifies number of seconds before blanking the pointer [default 2]\&.
467	.IP "\fBmultibyte_cursor:\fP \fIboolean\fP"
468	\fBTrue\fP: consider multibyte glyphs as single character for backspace,
469	delete and cursor movement keys;
470	option \fB-mcc\fP\&.
471	\fBFalse\fP: move through all components of all glyphs;
472	option \fB+mcc\fP\&.
473	.IP "\fBbackspacekey:\fP \fIstring\fP"	406	.IP "\fBbackspacekey:\fP \fIstring\fP"
474	The string to send when the backspace key is pressed\&. If set to	407	The string to send when the backspace key is pressed\&. If set to
475	\fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted,	408	\fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted,
476	\fBBackspace\fP (code 8) - which can be reversed with the appropriate	409	\fBBackspace\fP (code 8) - which can be reversed with the appropriate
477	DEC private mode escape sequence\&.	410	DEC private mode escape sequence\&.
…		…
488	\fBOverTheSpot\fP, \fBOffTheSpot\fP, \fBRoot\fP;	421	\fBOverTheSpot\fP, \fBOffTheSpot\fP, \fBRoot\fP;
489	option \fB-pt\fP\&.	422	option \fB-pt\fP\&.
490	.IP "\fBinputMethod:\fP \fIname\fP"	423	.IP "\fBinputMethod:\fP \fIname\fP"
491	\fIname\fP of inputMethod to use;	424	\fIname\fP of inputMethod to use;
492	option \fB-im\fP\&.	425	option \fB-im\fP\&.
		426	.IP "\fBimLocale:\fP \fIname\fP"
		427	The locale to use for opening the IM\&. You can use an LC_CTYPE
		428	of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP
		429	for the input extension to be able to input japanese characters
		430	while staying in another locale\&.
		431	option \fB-imlocale\fP\&.
		432	.IP "\fBinsecure\fP"
		433	Enables "insecure" mode\&. Rxvt-unicode offers some escape sequences
		434	that echo arbitrary strings like the icon name or the locale\&. This
		435	could be abused if somebody gets 8-bit-clean access to your display,
		436	wether throuh a mail client displaying mail bodies unfiltered or
		437	though write(1)\&. Therefore, these sequences are disabled by default\&.
		438	You can enable them by setting this boolean resource or specifying
		439	\fB-insecure\fP as an option\&. At the moment, this enabled display-answer,
		440	locale, findfont, icon label and window title requests as well as
		441	dynamic menubar dispatch\&.
493	.IP "\fBmodifier:\fP \fImodifier\fP"	442	.IP "\fBmodifier:\fP \fImodifier\fP"
494	Set the key to be interpreted as the Meta key to:	443	Set the key to be interpreted as the Meta key to:
495	\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP,	444	\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP,
496	\fBmod4\fP, \fBmod5\fP;	445	\fBmod4\fP, \fBmod5\fP;
497	option \fB-mod\fP\&.	446	option \fB-mod\fP\&.
…		…
555	.PP	504	.PP
556	\fBrxvt\fP tries to write an entry into the \fIutmp\fP(5) file so that it can be	505	\fBrxvt\fP tries to write an entry into the \fIutmp\fP(5) file so that it can be
557	seen via the \fIwho(1)\fP command, and can accept messages\&. To allow this	506	seen via the \fIwho(1)\fP command, and can accept messages\&. To allow this
558	feature, \fBrxvt\fP must be installed setuid root on some systems\&.	507	feature, \fBrxvt\fP must be installed setuid root on some systems\&.
559	.SH "COLORS AND GRAPHICS"	508	.SH "COLORS AND GRAPHICS"
560	.PP
561	If graphics support was enabled at compile-time, \fBrxvt\fP can be queried
562	with ANSI escape sequences and can address individual pixels instead of
563	text characters\&. Note the graphics support is still considered beta code\&.
564	.PP	509	.PP
565	In addition to the default foreground and background colours, \fBrxvt\fP	510	In addition to the default foreground and background colours, \fBrxvt\fP
566	can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink	511	can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
567	versions of the same)\&.	512	versions of the same)\&.
568	Here is a list of the colours with their \fBrgb\&.txt\fP names\&.	513	Here is a list of the colours with their \fBrgb\&.txt\fP names\&.
…		…
632	.PP	577	.PP
633	Cursor change support is not yet implemented\&.	578	Cursor change support is not yet implemented\&.
634	.PP	579	.PP
635	Click-and-drag doesn\&'t work with X11 mouse report overriding\&.	580	Click-and-drag doesn\&'t work with X11 mouse report overriding\&.
636	.PP	581	.PP
637	Graphics support is fairly crude\&.
638	.PP
639	.SH "FTP LOCATION"	582	.SH "FTP LOCATION"
640	.PP	583	.PP
641	rxvt-+RXVTVERSION()\&.tar\&.gz can be found at the following ftp sites	584	rxvt-2\&.5\&.tar\&.gz can be found at the following ftp sites
642	RXVTFTPSITE()	585	ftp://ftp\&.rxvt\&.org/pub/rxvt
643	.PP	586	.PP
644	.SH "CURRENT PROJECT COORDINATOR"	587	.SH "CURRENT PROJECT COORDINATOR"
645	.PP	588	.PP
646	.IP "Project Coordinator"	589	.IP "Project Coordinator"
647	RXVTMAINT() RXVTMAINTEMAIL()	590	Marc A\&. Lehmann <rxvt@schmorp\&.de>
648	.br	591	.br
649	.IP "Web page maintainter"	592	.IP "Web page maintainter"
650	RXVTWEBMAINT() RXVTWEBMAINTEMAIL()	593	Marc A\&. Lehmann <rxvt@schmorp\&.de>
651	.br	594	.br
652	RXVTWEBPAGE()	595	<http://www\&.sourceforge\&.net/projects/rxvt-unicode/>
653	.br	596	.br
654	.IP "Mailing list"
655	The Rxvt Workers <rxvt-workers@rxvt\&.org>
656	mailing list has also been established for rxvt development, to
657	subscribe, email to
658	<rxvt-workers-subscribe@rxvt\&.org>\&.
659	There is also a mailing list for announcements of new releases of
660	rxvt\&. To subscribe, email to
661	<rxvt-announce-subscribe@rxvt\&.org>\&.
662	.PP	597	.PP
663	.SH "AUTHORS"	598	.SH "AUTHORS"
664	.PP	599	.PP
665	.IP "John Bovey"	600	.IP "John Bovey"
666	University of Kent, 1992, wrote the original Xvt\&.	601	University of Kent, 1992, wrote the original Xvt\&.
667	.IP "Rob Nation <nation@rocket\&.sanders\&.lockheed\&.com>"	602	.IP "Rob Nation <nation@rocket\&.sanders\&.lockheed\&.com>"
668	very heavily modified Xvt and came up with Rxvt	603	very heavily modified Xvt and came up with Rxvt
669	.IP "Angelo Haritsis <ah@doc\&.ic\&.ac\&.uk>"	604	.IP "Angelo Haritsis <ah@doc\&.ic\&.ac\&.uk>"
670	wrote the Greek Keyboard Input	605	wrote the Greek Keyboard Input (no longer in code)
671	.IP "mj olesen <olesen@me\&.QueensU\&.CA>"	606	.IP "mj olesen <olesen@me\&.QueensU\&.CA>"
672	Wrote the menu system\&.	607	Wrote the menu system\&.
673	.br	608	.br
674	Project Coordinator (changes\&.txt 2\&.11 to 2\&.21)	609	Project Coordinator (changes\&.txt 2\&.11 to 2\&.21)
675	.IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>"	610	.IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>"
676	Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5)	611	Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5)
677	.IP "Geoff Wing <gcw@pobox\&.com>"	612	.IP "Geoff Wing <gcw@pobox\&.com>"
678	Rewrote screen display and text selection routines\&.	613	Rewrote screen display and text selection routines\&.
		614	Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode)
		615	.IP "Marc Alexander Lehman <rxvt@schmorp\&.de>"
		616	Rewrote most of the display code and internal character handling
		617	to store text in unicode\&. Numerous other fixes and extensions\&.
679	.br	618	.br
680	Project Coordinator (changes\&.txt 2\&.4\&.6 - )	619	Project Coordinator (Changes 1\&.0 - )
		620	.PP

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.tbl (file contents): Revision 1.1 by pcg, Mon Nov 24 17:28:08 2003 UTC vs. Revision 1.7 by pcg, Mon Mar 29 16:52:06 2004 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.tbl (file contents):
Revision 1.1 by pcg, Mon Nov 24 17:28:08 2003 UTC vs.
Revision 1.7 by pcg, Mon Mar 29 16:52:06 2004 UTC