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

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

…		…
2		2
3	rxvt-unicode (ouR XVT, unicode) - (a VT102 emulator for the X window system)	3	rxvt-unicode (ouR XVT, unicode) - (a VT102 emulator for the X window system)
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	B<@@RXVTNAME@@> [options] [-e command [ args ]]	7	B<@@RXVT_NAME@@> [options] [-e command [ args ]]
8		8
9	=head1 DESCRIPTION	9	=head1 DESCRIPTION
10		10
11	B<rxvt-unicode>, version B<@@RXVTVERSION@@>, is a colour vt102 terminal	11	B<rxvt-unicode>, version B<@@RXVT_VERSION@@>, is a colour vt102 terminal
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	=head1 FREQUENTLY ASKED QUESTIONS
		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.).
		64
17	=head1 OPTIONS	65	=head1 OPTIONS
18		66
19	The B<@@RXVTNAME@@> 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
20	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
21	eliminated or default values chosen at compile-time, so options and	69	eliminated or default values chosen at compile-time, so options and
22	defaults listed may not accurately reflect the version installed on	70	defaults listed may not accurately reflect the version installed on
23	your system. `rxvt -h' gives a list of major compile-time options on	71	your system. `@@RXVT_NAME@@ -h' gives a list of major compile-time options on
24	the I<Options> line. Option descriptions may be prefixed with which	72	the I<Options> line. Option descriptions may be prefixed with which
25	compile option each is dependent upon. e.g. `Compile I<XIM>:' requires	73	compile option each is dependent upon. e.g. `Compile I<XIM>:' requires
26	I<XIM> on the I<Options> line. Note: `rxvt -help' gives a list of all	74	I<XIM> on the I<Options> line. Note: `@@RXVT_NAME@@ -help' gives a list of all
27	command-line options compiled into your version.	75	command-line options compiled into your version.
28		76
29	Note that B<@@RXVTNAME@@> permits the resource name to be used as a	77	Note that B<@@RXVT_NAME@@> permits the resource name to be used as a
30	long-option (--/++ option) so the potential command-line options are	78	long-option (--/++ option) so the potential command-line options are
31	far greater than those listed. For example: `rxvt --loginShell --color1	79	far greater than those listed. For example: `@@RXVT_NAME@@ --loginShell --color1
32	Orange'.	80	Orange'.
33		81
34	The following options are available:	82	The following options are available:
35		83
36	=over 4	84	=over 4
…		…
106		154
107	The mouse pointer background colour; resource B<pointerColor2>.	155	The mouse pointer background colour; resource B<pointerColor2>.
108		156
109	=item B<-bd> I<colour>	157	=item B<-bd> I<colour>
110		158
111	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;
112	resource B<borderColor>.	160	resource B<borderColor>.
113		161
114	=item B<-fn> I<fontname>	162	=item B<-fn> I<fontlist>
115		163
116	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
117	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
118	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
119	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
120	appended to it. resource B<font>.	168	always appended to it. See resource B<font> for details.
121		169
122	=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).
123		172
124	Enable "real bold" support. When this option is on, bold text will be	173	=item B<-fb> I<fontlist>
125	displayed using the first available bold font in the font list. Bold	174
126	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
127	corresponding regular fonts. If no bold font can be found, a regular	176	be printed. See resource B<boldFont> for details.
128	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.
129		187
130	=item B<-name> I<name>	188	=item B<-name> I<name>
131		189
132	Specify the application name under which resources are to be obtained,	190	Specify the application name under which resources are to be obtained,
133	rather than the default executable file name. Name should not contain	191	rather than the default executable file name. Name should not contain
…		…
202	B<externalBorder>.	260	B<externalBorder>.
203		261
204	=item B<-bl>	262	=item B<-bl>
205		263
206	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	264	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
207	if honoured by the WM, the rxvt window will not have window	265	if honoured by the WM, the rxvt-unicode window will not have window
208	decorations; resource B<borderLess>.	266	decorations; resource B<borderLess>.
209		267
210	=item B<-lsp> I<number>	268	=item B<-lsp> I<number>
211		269
212	Compile I<linespace>: Lines (pixel height) to insert between each row	270	Compile I<linespace>: Lines (pixel height) to insert between each row
…		…
219	I<termcap(5)> database and should have I<li#> and I<co#> entries;	277	I<termcap(5)> database and should have I<li#> and I<co#> entries;
220	resource B<termName>.	278	resource B<termName>.
221		279
222	=item B<-e> I<command [arguments]>	280	=item B<-e> I<command [arguments]>
223		281
224	Run the command with its command-line arguments in the B<@@RXVTNAME@@>	282	Run the command with its command-line arguments in the B<@@RXVT_NAME@@>
225	window; also sets the window title and icon name to be the basename of	283	window; also sets the window title and icon name to be the basename of
226	the program being executed if neither I<-title> (I<-T>) nor I<-n> are	284	the program being executed if neither I<-title> (I<-T>) nor I<-n> are
227	given on the command line. If this option is used, it must be the last	285	given on the command line. If this option is used, it must be the last
228	on the command-line. If there is no B<-e> option then the default is to	286	on the command-line. If there is no B<-e> option then the default is to
229	run the program specified by the B<SHELL> environment variable or,	287	run the program specified by the B<SHELL> environment variable or,
…		…
283	Turn on/off secondary screen scroll (default enabled); resource	341	Turn on/off secondary screen scroll (default enabled); resource
284	B<secondaryScroll>.	342	B<secondaryScroll>.
285		343
286	=item B<-xrm> I<resourcestring>	344	=item B<-xrm> I<resourcestring>
287		345
288	No effect on rxvt. Simply passes through an argument to be made	346	No effect on rxvt-unicode. Simply passes through an argument to be made
289	available in the instance's argument list. Appears in I<WM_COMMAND> in	347	available in the instance's argument list. Appears in I<WM_COMMAND> in
290	some window managers.	348	some window managers.
291		349
292	=back	350	=back
293		351
294	=head1 RESOURCES (available also as long-options)	352	=head1 RESOURCES (available also as long-options)
295		353
296	Note: `@@RXVTNAME@@ --help' gives a list of all resources (long	354	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
297	options) compiled into your version.	355	options) compiled into your version.
298		356
299	There are two different methods that @@RXVTNAME@@ can use to get the	357	There are two different methods that @@RXVT_NAME@@ can use to get the
300	Xresource data: using the X libraries (Xrm*-functions) or internal	358	Xresource data: using the X libraries (Xrm*-functions) or internal
301	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	359	Xresources reader (B<~/.Xdefaults>). For the first method (ie.
302	B<@@RXVTNAME@@ -h> lists B<XGetDefaults>), you can set and change the	360	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the
303	resources using X11 tools like B<xset>. Many distribution do also load	361	resources using X11 tools like B<xset>. Many distribution do also load
304	settings from the B<~/.Xresources> file when X starts.	362	settings from the B<~/.Xresources> file when X starts.
305		363
306	If compiled with internal Xresources support (i.e. B<@@RXVTNAME@@ -h>	364	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
307	lists B<.Xdefaults>) then B<@@RXVTNAME@@> accepts application defaults	365	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
308	set in XAPPLOADDIR/URxvt (compile-time defined: usually	366	set in XAPPLOADDIR/URxvt (compile-time defined: usually
309	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	367	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
310	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.	368	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
311	Note that when reading X resources, B<@@RXVTNAME@@> recognizes two	369	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two
312	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows	370	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows
313	resources common to both B<@@RXVTNAME@@> and the original I<rxvt> to be	371	resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be
314	easily configured, while the class name B<URxvt> allows resources	372	easily configured, while the class name B<URxvt> allows resources
315	unique to B<@@RXVTNAME@@>, notably colours and key-handling, to be	373	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be
316	shared between different B<@@RXVTNAME@@> configurations. If no	374	shared between different B<@@RXVT_NAME@@> configurations. If no
317	resources are specified, suitable defaults will be used. Command-line	375	resources are specified, suitable defaults will be used. Command-line
318	arguments can be used to override resource settings. The following	376	arguments can be used to override resource settings. The following
319	resources are allowed:	377	resources are allowed:
320		378
321	=over 4	379	=over 4
…		…
342	high-intensity (bold = bright foreground, blink = bright background)	400	high-intensity (bold = bright foreground, blink = bright background)
343	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,
344	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
345	names used are listed in the B<COLORS AND GRAPHICS> section.	403	names used are listed in the B<COLORS AND GRAPHICS> section.
346		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
347	=item B<colorBD:> I<colour>	411	=item B<colorBD:> I<colour>
348		412
		413	=item B<colorIT:> I<colour>
		414
349	Use the specified colour to display bold characters when the foreground	415	Use the specified colour to display bold or italic characters when the
350	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
351	enabled.	417	(Compile styles) and this option is unset, reverse video is used instead.
352		418
353	=item B<colorUL:> I<colour>	419	=item B<colorUL:> I<colour>
354		420
355	Use the specified colour to display underlined characters when the	421	Use the specified colour to display underlined characters when the
356	foreground colour is the default.	422	foreground colour is the default.
…		…
412		478
413	=item B<troughColor:> I<colour>	479	=item B<troughColor:> I<colour>
414		480
415	Use the specified colour for the scrollbar's trough area [default	481	Use the specified colour for the scrollbar's trough area [default
416	#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.
417		488
418	=item B<backgroundPixmap:> I<file[;geom]>	489	=item B<backgroundPixmap:> I<file[;geom]>
419		490
420	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
421	the background and also optionally specify its scaling with a geometry	492	the background and also optionally specify its scaling with a geometry
…		…
437		508
438	Specify the colon-delimited search path for finding files (XPM and	509	Specify the colon-delimited search path for finding files (XPM and
439	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
440	B<PATH> environment variables.	511	B<PATH> environment variables.
441		512
442	=item B<font:> I<fontname>	513	=item B<font:> I<fontlist>
443		514
444	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
445	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.
446	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
447	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
448	appended to it. option B<-fn>.	519	appended to it. option B<-fn>.
449		520
450	=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:>.
451		523
452	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
453	will be displayed using the first available bold font in the font list.	525	specifications enclosed in square brackets (C<[]>). The only available
454	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
455	corresponding regular fonts. If no bold font can be found, a regular	527	fonts.
456	font will be used. option B<-rb>. B<False>: Display bold text in a	528
457	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.
458		574
459	=item B<selectstyle:> I<mode>	575	=item B<selectstyle:> I<mode>
460		576
461	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
462	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
463	xterm style selection.	579	xterm style selection.
464		580
465	=item B<scrollstyle:> I<mode>	581	=item B<scrollstyle:> I<mode>
466		582
467	Set scrollbar style to B<@@RXVTNAME@@>, B<rxvt>, B<plain>, B<next> or	583	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
468	B<xterm>	584	the author's favourite..
469		585
470	=item B<title:> I<string>	586	=item B<title:> I<string>
471		587
472	Set window title string, the default title is the command-line	588	Set window title string, the default title is the command-line
473	specified after the B<-e> option, if any, otherwise the application	589	specified after the B<-e> option, if any, otherwise the application
…		…
527	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
528	thumb with the pointer on middle button press/drag.	644	thumb with the pointer on middle button press/drag.
529		645
530	=item B<scrollTtyOutput:> I<boolean>	646	=item B<scrollTtyOutput:> I<boolean>
531		647
532	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>.
533	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
534	B<-si>.	650	B<+si>.
535		651
536	=item B<scrollWithBuffer:> I<boolean>	652	=item B<scrollWithBuffer:> I<boolean>
537		653
538	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
539	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
540	with scrollback buffer when tty recieves new lines; option B<-sw>.	656	with scrollback buffer when tty recieves new lines; option B<-sw>.
541		657
542	=item B<scrollTtyKeypress:> I<boolean>	658	=item B<scrollTtyKeypress:> I<boolean>
543		659
544	B<True>: scroll to bottom when a non-special key is pressed. Special	660	B<True>: scroll to bottom when a non-special key is pressed. Special keys
545	keys are those which are intercepted by rxvt for special handling and	661	are those which are intercepted by rxvt-unicode for special handling and
546	are not passed onto the shell; option B<-sk>. B<False>: do not scroll	662	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
547	to bottom when a non-special key is pressed; option B<+sk>.	663	bottom when a non-special key is pressed; option B<+sk>.
548
549	=item B<smallfont_key:> I<keysym>
550
551	If enabled, use B<@@HOTKEY@@->I<keysym> to toggle to a smaller font
552	[default B<@@HOTKEY@@-@@SMALLFONT@@>]
553
554	=item B<bigfont_key:> I<keysym>
555
556	If enabled, use B<@@HOTKEY@@->I<keysym> to toggle to a bigger font
557	[default B<@@HOTKEY@@-@@BIGFONT@@>]
558		664
559	=item B<saveLines:> I<number>	665	=item B<saveLines:> I<number>
560		666
561	Save I<number> lines in the scrollback buffer [default 64]. This	667	Save I<number> lines in the scrollback buffer [default 64]. This
562	resource is limited on most machines to 65535; option B<-sl>.	668	resource is limited on most machines to 65535; option B<-sl>.
…		…
572	option B<-w>, B<-bw>, B<-borderwidth>.	678	option B<-w>, B<-bw>, B<-borderwidth>.
573		679
574	=item B<borderLess:> I<boolean>	680	=item B<borderLess:> I<boolean>
575		681
576	Set MWM hints to request a borderless window, i.e. if honoured by the	682	Set MWM hints to request a borderless window, i.e. if honoured by the
577	WM, the rxvt window will not have window decorations; option B<-bl>.	683	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
578		684
579	=item B<termName:> I<termname>	685	=item B<termName:> I<termname>
580		686
581	Specifies the terminal type name to be set in the B<TERM> environment	687	Specifies the terminal type name to be set in the B<TERM> environment
582	variable; option B<-tn>.	688	variable; option B<-tn>.
…		…
652	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.
653	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
654	extension to be able to input japanese characters while staying in	760	extension to be able to input japanese characters while staying in
655	another locale. option B<-imlocale>.	761	another locale. option B<-imlocale>.
656		762
657	=item B<insecure>	763	=item B<insecure:> I<boolean>
658		764
659	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	765	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
660	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
661	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
662	throuh a mail client displaying mail bodies unfiltered or though	768	throuh a mail client displaying mail bodies unfiltered or though
663	write(1). Therefore, these sequences are disabled by default. (Note	769	write(1). Therefore, these sequences are disabled by default. (Note
664	that other terminals, including xterm, have these sequences	770	that other terminals, including xterm, have these sequences
665	enabled by default). You can enable them by setting this boolean	771	enabled by default). You can enable them by setting this boolean
666	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
…		…
673	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	779	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
674	B<-mod>.	780	B<-mod>.
675		781
676	=item B<answerbackString:> I<string>	782	=item B<answerbackString:> I<string>
677		783
678	Specify the reply rxvt sends to the shell when an ENQ (control-E)	784	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
679	character is passed through. It may contain escape values as described	785	character is passed through. It may contain escape values as described
680	in the entry on B<keysym> following.	786	in the entry on B<keysym> following.
681		787
682	=item B<secondaryScreen:> I<bool>	788	=item B<secondaryScreen:> I<bool>
683		789
…		…
703		809
704	=back	810	=back
705		811
706	=head1 THE SCROLLBAR	812	=head1 THE SCROLLBAR
707		813
708	Lines of text that scroll off the top of the B<@@RXVTNAME@@> window	814	Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
709	(resource: B<saveLines>) and can be scrolled back using the scrollbar	815	(resource: B<saveLines>) and can be scrolled back using the scrollbar
710	or by keystrokes. The normal B<@@RXVTNAME@@> scrollbar has arrows and	816	or by keystrokes. The normal B<@@RXVT_NAME@@> scrollbar has arrows and
711	its behaviour is fairly intuitive. The B<xterm-scrollbar> is without	817	its behaviour is fairly intuitive. The B<xterm-scrollbar> is without
712	arrows and its behaviour mimics that of I<xterm>	818	arrows and its behaviour mimics that of I<xterm>
713		819
714	Scroll down with B<Button1> (B<xterm-scrollbar>) or B<Shift-Next>.	820	Scroll down with B<Button1> (B<xterm-scrollbar>) or B<Shift-Next>.
715	Scroll up with B<Button3> (B<xterm-scrollbar>) or B<Shift-Prior>.	821	Scroll up with B<Button3> (B<xterm-scrollbar>) or B<Shift-Prior>.
…		…
740	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
741	region and release; Right click to extend the marked region; Left	847	region and release; Right click to extend the marked region; Left
742	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
743	line.	849	line.
744		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
745	=item B<Insertion>:	855	=item B<Insertion>:
746		856
747	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
748	an B<@@RXVTNAME@@> window causes the current text selection to be	858	an B<@@RXVT_NAME@@> window causes the current text selection to be
749	inserted as if it had been typed on the keyboard.	859	inserted as if it had been typed on the keyboard.
750		860
751	=back	861	=back
752		862
753	=head1 CHANGING FONTS	863	=head1 CHANGING FONTS
754		864
755	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
756	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.
757	B<Shift-KP_Subtract>. Or, alternatively (if enabled) with	867
758	B<@@HOTKEY@@-@@BIGFONT@@> and B<@@HOTKEY@@-@@SMALLFONT@@>, where the	868	You can, however, switch fonts at runtime using escape sequences (and
759	actual key can be selected using resources	869	therefore using the menubar), e.g.:
760	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.
		874
		875	=head1 ISO 14755 SUPPORT
		876
		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>.
		882
		883	=over 4
		884
		885	=item 5.1: Basic method
		886
		887	This allows you to enter unicode characters using their hexcode.
		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.
761		939
762	=head1 LOGIN STAMP	940	=head1 LOGIN STAMP
763		941
764	B<@@RXVTNAME@@> 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
765	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.
766	To allow this feature, B<@@RXVTNAME@@> must be installed setuid root on	944	To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on
767	some systems.	945	some systems.
768		946
769	=head1 COLORS AND GRAPHICS	947	=head1 COLORS AND GRAPHICS
770		948
771	In addition to the default foreground and background colours,	949	In addition to the default foreground and background colours,
772	B<@@RXVTNAME@@> can display up to 16 colours (8 ANSI colours plus	950	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
773	high-intensity bold/blink versions of the same). Here is a list of the	951	high-intensity bold/blink versions of the same). Here is a list of the
774	colours with their B<rgb.txt> names.	952	colours with their B<rgb.txt> names.
775		953
776	=begin table	954	=begin table
777		955
…		…
806	I<xterm>(1) where the colours are only swapped if they have not otherwise	984	I<xterm>(1) where the colours are only swapped if they have not otherwise
807	been specified. For example,	985	been specified. For example,
808		986
809	=over 4	987	=over 4
810		988
811	=item B<rxvt -fg Black -bg White -rv>	989	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
812		990
813	would yield White on Black, while on I<xterm>(1) it would yield Black	991	would yield White on Black, while on I<xterm>(1) it would yield Black
814	on White.	992	on White.
815		993
816	=back	994	=back
817		995
818	=head1 ENVIRONMENT	996	=head1 ENVIRONMENT
819		997
820	B<@@RXVTNAME@@> sets the environment variables B<TERM>, B<COLORTERM>	998	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>
821	and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X	999	and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X
822	window id number of the B<@@RXVTNAME@@> window and it also uses and	1000	window id number of the B<@@RXVT_NAME@@> window and it also uses and
823	sets the environment variable B<DISPLAY> to specify which display	1001	sets the environment variable B<DISPLAY> to specify which display
824	terminal to use. B<@@RXVTNAME@@> uses the environment variables	1002	terminal to use. B<@@RXVT_NAME@@> uses the environment variables
825	B<RXVTPATH> and B<PATH> to find XPM files.	1003	B<RXVTPATH> and B<PATH> to find XPM files.
826		1004
827	=head1 FILES	1005	=head1 FILES
828		1006
829	=over 4	1007	=over 4
…		…
836		1014
837	Color names.	1015	Color names.
838		1016
839	=back	1017	=back
840		1018
841	=head1 SEEALSO	1019	=head1 SEE ALSO
842		1020
843	I<xterm>(1), I<sh>(1), I<resize>(1), I<X>(1), I<pty>(4), I<tty>(4), I<utmp>(5)	1021	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
844
845	See rxvtRef.html rxvtRef.txt for detailed information on recognized escape sequences and menuBar syntax, etc.
846		1022
847	=head1 BUGS	1023	=head1 BUGS
848		1024
849	Check the BUGS file for an up-to-date list.	1025	Check the BUGS file for an up-to-date list.
850		1026
851	Cursor change support is not yet implemented.	1027	Cursor change support is not yet implemented.
852		1028
853	Click-and-drag doesn't work with X11 mouse report overriding.	1029	Click-and-drag doesn't work with X11 mouse report overriding.
854		1030
855	=head1 FTP LOCATION
856
857	rxvt-+@@RXVTVERSION@@.tar.gz can be found at the following ftp sites L<@@RXVTFTPSITE@@>(@@RXVTFTPSITE@@)
858
859	=head1 CURRENT PROJECT COORDINATOR	1031	=head1 CURRENT PROJECT COORDINATOR
860		1032
861	=over 4	1033	=over 4
862		1034
863	=item Project Coordinator	1035	=item Project Coordinator
864		1036
865	@@RXVTMAINT@@ L<@@RXVTMAINTEMAIL@@>	1037	@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@>
866		1038
867	=item Web page maintainter	1039	=item Web page maintainter
868		1040
869	@@RXVTWEBMAINT@@ L<@@RXVTWEBMAINTEMAIL@@>	1041	@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
870		1042
871	L<@@RXVTWEBPAGE@@>(@@RXVTWEBPAGE@@)	1043	L<@@RXVT_WEBPAGE@@>
872		1044
873	=back	1045	=back
874		1046
875	=head1 AUTHORS	1047	=head1 AUTHORS
876		1048

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.1 by root, Thu Aug 12 20:42:12 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.1 by root, Thu Aug 12 20:42:12 2004 UTC vs.
Revision 1.30 by root, Wed Sep 8 17:10:23 2004 UTC