[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.34 by root, Wed Dec 1 02:29:14 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 (hopefully) reasonable default
120	appended to it. resource B<font>.	168	font list is always appended to it. See resource B<font> for more details.
121		169
122	=item B<-rb>\|B<+rb>	170	In short, to specify an X11 core font, just specify it's name or prefix it
		171	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
		172	e.g.:
123		173
124	Enable "real bold" support. When this option is on, bold text will be	174	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
125	displayed using the first available bold font in the font list. Bold	175	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
126	fonts should thus be specified in the font list after their	176
127	corresponding regular fonts. If no bold font can be found, a regular	177	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
128	font will be used. resource B<realBold>.	178	section of @@RXVT_NAME@@(7).
		179
		180	=item B<-fb> I<fontlist>
		181
		182	Compile font-styles: The bold font list to use when bold characters are to
		183	be printed. See resource B<boldFont> for details.
		184
		185	=item B<-fi> I<fontlist>
		186
		187	Compile font-styles: The italic font list to use when bold characters are to
		188	be printed. See resource B<italicFont> for details.
		189
		190	=item B<-fbi> I<fontlist>
		191
		192	Compile font-styles: The bold italic font list to use when bold characters are to
		193	be printed. See resource B<boldItalicFont> for details.
129		194
130	=item B<-name> I<name>	195	=item B<-name> I<name>
131		196
132	Specify the application name under which resources are to be obtained,	197	Specify the application name under which resources are to be obtained,
133	rather than the default executable file name. Name should not contain	198	rather than the default executable file name. Name should not contain
…		…
174	=item B<-st>\|B<+st>	239	=item B<-st>\|B<+st>
175		240
176	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	241	Display normal (non XTerm/NeXT) scrollbar without/with a trough;
177	resource B<scrollBar_floating>.	242	resource B<scrollBar_floating>.
178		243
		244	=item B<-ptab>\|B<+ptab>
		245
		246	If enabled (default), "Horizontal Tab" characters are being stored as
		247	actual wide characters in the screen buffer, which makes it possible to
		248	select and paste them. Since a horizontal tab is a cursor movement and
		249	not an actual glyph, this can sometimes be visually annoying as the cursor
		250	on a tab character is displayed as a wide cursor; resource B<pastableTabs>.
		251
179	=item B<-bc>\|B<+bc>	252	=item B<-bc>\|B<+bc>
180		253
181	Blink the cursor; resource B<cursorBlink>.	254	Blink the cursor; resource B<cursorBlink>.
182		255
183	=item B<-iconic>	256	=item B<-iconic>
…		…
202	B<externalBorder>.	275	B<externalBorder>.
203		276
204	=item B<-bl>	277	=item B<-bl>
205		278
206	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	279	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	280	if honoured by the WM, the rxvt-unicode window will not have window
208	decorations; resource B<borderLess>.	281	decorations; resource B<borderLess>.
209		282
210	=item B<-lsp> I<number>	283	=item B<-lsp> I<number>
211		284
212	Compile I<linespace>: Lines (pixel height) to insert between each row	285	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;	292	I<termcap(5)> database and should have I<li#> and I<co#> entries;
220	resource B<termName>.	293	resource B<termName>.
221		294
222	=item B<-e> I<command [arguments]>	295	=item B<-e> I<command [arguments]>
223		296
224	Run the command with its command-line arguments in the B<@@RXVTNAME@@>	297	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	298	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	299	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	300	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	301	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,	302	run the program specified by the B<SHELL> environment variable or,
…		…
283	Turn on/off secondary screen scroll (default enabled); resource	356	Turn on/off secondary screen scroll (default enabled); resource
284	B<secondaryScroll>.	357	B<secondaryScroll>.
285		358
286	=item B<-xrm> I<resourcestring>	359	=item B<-xrm> I<resourcestring>
287		360
288	No effect on rxvt. Simply passes through an argument to be made	361	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	362	available in the instance's argument list. Appears in I<WM_COMMAND> in
290	some window managers.	363	some window managers.
291		364
292	=back	365	=back
293		366
294	=head1 RESOURCES (available also as long-options)	367	=head1 RESOURCES (available also as long-options)
295		368
296	Note: `@@RXVTNAME@@ --help' gives a list of all resources (long	369	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
297	options) compiled into your version.	370	options) compiled into your version.
298		371
299	There are two different methods that @@RXVTNAME@@ can use to get the	372	There are two different methods that @@RXVT_NAME@@ can use to get the
300	Xresource data: using the X libraries (Xrm*-functions) or internal	373	Xresource data: using the X libraries (Xrm*-functions) or internal
301	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	374	Xresources reader (B<~/.Xdefaults>). For the first method (ie.
302	B<@@RXVTNAME@@ -h> lists B<XGetDefaults>), you can set and change the	375	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	376	resources using X11 tools like B<xset>. Many distribution do also load
304	settings from the B<~/.Xresources> file when X starts.	377	settings from the B<~/.Xresources> file when X starts.
305		378
306	If compiled with internal Xresources support (i.e. B<@@RXVTNAME@@ -h>	379	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
307	lists B<.Xdefaults>) then B<@@RXVTNAME@@> accepts application defaults	380	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
308	set in XAPPLOADDIR/URxvt (compile-time defined: usually	381	set in XAPPLOADDIR/URxvt (compile-time defined: usually
309	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	382	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
310	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.	383	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
311	Note that when reading X resources, B<@@RXVTNAME@@> recognizes two	384	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	385	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	386	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	387	easily configured, while the class name B<URxvt> allows resources
315	unique to B<@@RXVTNAME@@>, notably colours and key-handling, to be	388	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be
316	shared between different B<@@RXVTNAME@@> configurations. If no	389	shared between different B<@@RXVT_NAME@@> configurations. If no
317	resources are specified, suitable defaults will be used. Command-line	390	resources are specified, suitable defaults will be used. Command-line
318	arguments can be used to override resource settings. The following	391	arguments can be used to override resource settings. The following
319	resources are allowed:	392	resources are allowed:
320		393
321	=over 4	394	=over 4
…		…
342	high-intensity (bold = bright foreground, blink = bright background)	415	high-intensity (bold = bright foreground, blink = bright background)
343	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	416	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	417	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.	418	names used are listed in the B<COLORS AND GRAPHICS> section.
346		419
		420	Colours higher than 15 cannot be set using resources (yet), but can be
		421	changed using an escape command (see @@RXVT_NAME@@(7)).
		422
		423	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
		424	88 colour support). Colours 80-87 are evenly spaces grey steps.
		425
347	=item B<colorBD:> I<colour>	426	=item B<colorBD:> I<colour>
348		427
		428	=item B<colorIT:> I<colour>
		429
349	Use the specified colour to display bold characters when the foreground	430	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	431	foreground colour is the default. If font styles are not available
351	enabled.	432	(Compile styles) and this option is unset, reverse video is used instead.
352		433
353	=item B<colorUL:> I<colour>	434	=item B<colorUL:> I<colour>
354		435
355	Use the specified colour to display underlined characters when the	436	Use the specified colour to display underlined characters when the
356	foreground colour is the default.	437	foreground colour is the default.
…		…
400	=item B<shading:> I<number>	481	=item B<shading:> I<number>
401		482
402	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	483	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
403	image in addition to tinting it.	484	image in addition to tinting it.
404		485
405	=item B<fading:> I<number>
406
407	Scale the tint colour by the given percentage.
408
409	=item B<scrollColor:> I<colour>	486	=item B<scrollColor:> I<colour>
410		487
411	Use the specified colour for the scrollbar [default #B2B2B2].	488	Use the specified colour for the scrollbar [default #B2B2B2].
412		489
413	=item B<troughColor:> I<colour>	490	=item B<troughColor:> I<colour>
414		491
415	Use the specified colour for the scrollbar's trough area [default	492	Use the specified colour for the scrollbar's trough area [default
416	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	493	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.
		494
		495	=item B<borderColor:> I<colour>
		496
		497	The colour of the border around the text area and between the scrollbar
		498	and the text.
417		499
418	=item B<backgroundPixmap:> I<file[;geom]>	500	=item B<backgroundPixmap:> I<file[;geom]>
419		501
420	Use the specified XPM file (note the `.xpm' extension is optional) for	502	Use the specified XPM file (note the `.xpm' extension is optional) for
421	the background and also optionally specify its scaling with a geometry	503	the background and also optionally specify its scaling with a geometry
…		…
437		519
438	Specify the colon-delimited search path for finding files (XPM and	520	Specify the colon-delimited search path for finding files (XPM and
439	menus), in addition to the paths specified by the B<RXVTPATH> and	521	menus), in addition to the paths specified by the B<RXVTPATH> and
440	B<PATH> environment variables.	522	B<PATH> environment variables.
441		523
442	=item B<font:> I<fontname>	524	=item B<font:> I<fontlist>
443		525
444	Select the fonts to be used. This is a comma seperated list of font	526	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.	527	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	528	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	529	be smaller, but not larger. A reasonable default font list is always
448	appended to it. option B<-fn>.	530	appended to it. option B<-fn>.
449		531
450	=item B<realBold:> I<boolean>	532	Each font can either be a standard X11 core font (XLFD) name, with
		533	optional prefix C<x:> or a Xft font (Compile xft), prefixed with C<xft:>.
451		534
452	B<True>: Enable "real bold" support. When this option is on, bold text	535	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.	536	specifications enclosed in square brackets (C<[]>). The only available
454	Bold fonts should thus be specified in the font list after their	537	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	538	fonts.
456	font will be used. option B<-rb>. B<False>: Display bold text in a	539
457	regular font, using the color specified with B<colorBD>; option B<+rb>.	540	For example, this font resource
		541
		542	URxvt*font: 9x15bold,\
		543	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
		544	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
		545	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
		546	xft:Code2000:antialias=false
		547
		548	specifies five fonts to be used. The first one is C<9x15bold> (actually
		549	the iso8859-1 version of the second font), which is the base font (because
		550	it is named first) and thus defines the character cell grid to be 9 pixels
		551	wide and 15 pixels high.
		552
		553	The second font is just used to add additional unicode characters not in
		554	the base font, likewise the third, which is unfortunately non-bold, but
		555	the bold version of the font does contain less characters, so this is a
		556	useful supplement.
		557
		558	The third font is an Xft font with aliasing turned off, and the characters
		559	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
		560	contains other characters, but we are not interested in them.
		561
		562	The last font is a useful catch-all font that supplies most of the
		563	remaining unicode characters.
		564
		565	=item B<boldFont:> I<fontlist>
		566
		567	=item B<italicFont:> I<fontlist>
		568
		569	=item B<boldItalicFont:> I<fontlist>
		570
		571	The font list to use for displaying B<bold>, I<italic> or B<< I<bold
		572	italic> >> characters, respectively.
		573
		574	If specified and non-empty, then the syntax is the same as for the
		575	B<font>-resource, and the given font list will be used as is, which makes
		576	it possible to substitute completely different font styles for bold and
		577	italic.
		578
		579	If unset (the default), a suitable font list will be synthesized by
		580	"morphing" the normal text font list into the desired shape. If that is
		581	not possible, replacement fonts of the desired shape will be tried.
		582
		583	If set, but empty, then this specific style is disabled and the normal
		584	text font will being used for the given style.
458		585
459	=item B<selectstyle:> I<mode>	586	=item B<selectstyle:> I<mode>
460		587
461	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	588	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	589	xterm style with 2.20 old word selection, or anything else which gives
463	xterm style selection.	590	xterm style selection.
464		591
465	=item B<scrollstyle:> I<mode>	592	=item B<scrollstyle:> I<mode>
466		593
467	Set scrollbar style to B<@@RXVTNAME@@>, B<rxvt>, B<plain>, B<next> or	594	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
468	B<xterm>	595	the author's favourite..
469		596
470	=item B<title:> I<string>	597	=item B<title:> I<string>
471		598
472	Set window title string, the default title is the command-line	599	Set window title string, the default title is the command-line
473	specified after the B<-e> option, if any, otherwise the application	600	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	654	Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar
528	thumb with the pointer on middle button press/drag.	655	thumb with the pointer on middle button press/drag.
529		656
530	=item B<scrollTtyOutput:> I<boolean>	657	=item B<scrollTtyOutput:> I<boolean>
531		658
532	B<True>: scroll to bottom when tty receives output; option B<+si>.	659	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	660	B<False>: do not scroll to bottom when tty receives output; option
534	B<-si>.	661	B<+si>.
535		662
536	=item B<scrollWithBuffer:> I<boolean>	663	=item B<scrollWithBuffer:> I<boolean>
537		664
538	B<True>: scroll with scrollback buffer when tty recieves new lines (and	665	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	666	B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll
540	with scrollback buffer when tty recieves new lines; option B<-sw>.	667	with scrollback buffer when tty recieves new lines; option B<-sw>.
541		668
542	=item B<scrollTtyKeypress:> I<boolean>	669	=item B<scrollTtyKeypress:> I<boolean>
543		670
544	B<True>: scroll to bottom when a non-special key is pressed. Special	671	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	672	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	673	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>.	674	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		675
559	=item B<saveLines:> I<number>	676	=item B<saveLines:> I<number>
560		677
561	Save I<number> lines in the scrollback buffer [default 64]. This	678	Save I<number> lines in the scrollback buffer [default 64]. This
562	resource is limited on most machines to 65535; option B<-sl>.	679	resource is limited on most machines to 65535; option B<-sl>.
…		…
572	option B<-w>, B<-bw>, B<-borderwidth>.	689	option B<-w>, B<-bw>, B<-borderwidth>.
573		690
574	=item B<borderLess:> I<boolean>	691	=item B<borderLess:> I<boolean>
575		692
576	Set MWM hints to request a borderless window, i.e. if honoured by the	693	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>.	694	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
578		695
579	=item B<termName:> I<termname>	696	=item B<termName:> I<termname>
580		697
581	Specifies the terminal type name to be set in the B<TERM> environment	698	Specifies the terminal type name to be set in the B<TERM> environment
582	variable; option B<-tn>.	699	variable; option B<-tn>.
…		…
593		710
594	=item B<mouseWheelScrollPage:> I<boolean>	711	=item B<mouseWheelScrollPage:> I<boolean>
595		712
596	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel	713	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
597	scrolls five lines [default].	714	scrolls five lines [default].
		715
		716	=item B<pastableTabs:> I<boolean>
		717
		718	B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
		719	movement only; option C<-ptab>.
598		720
599	=item B<cursorBlink:> I<boolean>	721	=item B<cursorBlink:> I<boolean>
600		722
601	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	723	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
602	option B<-bc>.	724	option B<-bc>.
…		…
652	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	774	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	775	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	776	extension to be able to input japanese characters while staying in
655	another locale. option B<-imlocale>.	777	another locale. option B<-imlocale>.
656		778
657	=item B<insecure>	779	=item B<insecure:> I<boolean>
658		780
659	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	781	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
660	echo arbitrary strings like the icon name or the locale. This could be	782	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	783	abused if somebody gets 8-bit-clean access to your display, whether
662	throuh a mail client displaying mail bodies unfiltered or though	784	throuh a mail client displaying mail bodies unfiltered or though
663	write(1). Therefore, these sequences are disabled by default. (Note	785	write(1). Therefore, these sequences are disabled by default. (Note
664	that other terminals, including xterm, have these sequences	786	that other terminals, including xterm, have these sequences
665	enabled by default). You can enable them by setting this boolean	787	enabled by default). You can enable them by setting this boolean
666	resource or specifying B<-insecure> as an option. At the moment, this	788	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	795	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
674	B<-mod>.	796	B<-mod>.
675		797
676	=item B<answerbackString:> I<string>	798	=item B<answerbackString:> I<string>
677		799
678	Specify the reply rxvt sends to the shell when an ENQ (control-E)	800	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	801	character is passed through. It may contain escape values as described
680	in the entry on B<keysym> following.	802	in the entry on B<keysym> following.
681		803
682	=item B<secondaryScreen:> I<bool>	804	=item B<secondaryScreen:> I<bool>
683		805
…		…
703		825
704	=back	826	=back
705		827
706	=head1 THE SCROLLBAR	828	=head1 THE SCROLLBAR
707		829
708	Lines of text that scroll off the top of the B<@@RXVTNAME@@> window	830	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	831	(resource: B<saveLines>) and can be scrolled back using the scrollbar
710	or by keystrokes. The normal B<@@RXVTNAME@@> scrollbar has arrows and	832	or by keystrokes. The normal B<@@RXVT_NAME@@> scrollbar has arrows and
711	its behaviour is fairly intuitive. The B<xterm-scrollbar> is without	833	its behaviour is fairly intuitive. The B<xterm-scrollbar> is without
712	arrows and its behaviour mimics that of I<xterm>	834	arrows and its behaviour mimics that of I<xterm>
713		835
714	Scroll down with B<Button1> (B<xterm-scrollbar>) or B<Shift-Next>.	836	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>.	837	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	862	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	863	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	864	double-click to select a word; Left triple-click to select the entire
743	line.	865	line.
744		866
		867	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
		868	(Compile: frills) will create a rectangular selection instead of a normal
		869	one.
		870
745	=item B<Insertion>:	871	=item B<Insertion>:
746		872
747	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	873	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
748	an B<@@RXVTNAME@@> window causes the current text selection to be	874	an B<@@RXVT_NAME@@> window causes the current text selection to be
749	inserted as if it had been typed on the keyboard.	875	inserted as if it had been typed on the keyboard.
750		876
751	=back	877	=back
752		878
753	=head1 CHANGING FONTS	879	=head1 CHANGING FONTS
754		880
755	You can change fonts on-the-fly, which is to say cycle through the	881	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	882	supported in rxvt-unicode. Bug me if you need this.
757	B<Shift-KP_Subtract>. Or, alternatively (if enabled) with	883
758	B<@@HOTKEY@@-@@BIGFONT@@> and B<@@HOTKEY@@-@@SMALLFONT@@>, where the	884	You can, however, switch fonts at runtime using escape sequences (and
759	actual key can be selected using resources	885	therefore using the menubar), e.g.:
760	B<smallfont_key>/B<bigfont_key>.	886
		887	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"
		888
		889	rxvt-unicode will automatically re-apply these fonts to the output so far.
		890
		891	=head1 ISO 14755 SUPPORT
		892
		893	ISO 14755 is a standard for entering and viewing unicode characters
		894	and character codes using the keyboard. It consists of 4 parts. The
		895	first part is available rxvt-unicode has been compiled with
		896	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
		897	with C<--enable-iso14755>.
		898
		899	=over 4
		900
		901	=item 5.1: Basic method
		902
		903	This allows you to enter unicode characters using their hexcode.
		904
		905	Start by pressing and holding both C<Control> and C<Shift>, then enter
		906	hex-digits (between one and six). Releasing C<Control> and C<Shift> will
		907	commit the character as if it were typed directly. While holding down
		908	C<Control> and C<Shift> you can also enter multiple characters by pressing
		909	C<Space>, which will commit the current character and lets you start a new
		910	one.
		911
		912	As an example of use, imagine a business card with a japanese e-mail
		913	address, which you cannot type. Fortunately, the card has the e-mail
		914	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
		915	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
		916	followed by releasing the modifier keys.
		917
		918	=item 5.2: Keyboard symbols entry method
		919
		920	This mode lets you input characters representing the keycap symbols of
		921	your keyboard, if representable in the current locale encoding.
		922
		923	Start by pressing C<Control> and C<Shift> together, then releasing
		924	them. The next special key (cursor keys, home etc.) you enter will not
		925	invoke it's usual function but instead will insert the corresponding
		926	keycap symbol. The symbol will only be entered when the key has been
		927	released, otherwise pressing e.g. C<Shift> would enter the symbol for
		928	C<ISO Level 2 Switch>, although your intention might have been to enter a
		929	reverse tab (Shift-Tab).
		930
		931	=item 5.3: Screen-selection entry method
		932
		933	While this is implemented already (it's basically the selection
		934	mechanism), it could be extended by displaying a unicode character map.
		935
		936	=item 5.4: Feedback method for identifying displayed characters for later input
		937
		938	This method lets you display the unicode character code associated with
		939	characters already displayed.
		940
		941	You enter this mode by holding down C<Control> and C<Shift> together, then
		942	pressing and holding the left mouse button and moving around. The unicode
		943	hex code(s) (it might be a combining character) of the character under the
		944	pointer is displayed until you release C<Control> and C<Shift>.
		945
		946	In addition to the hex codes it will display the font used to draw this
		947	character - due to implementation reasons, characters combined with
		948	combining characters, line drawing characters and unknown characters will
		949	always be drawn using the built-in support font.
		950
		951	=back
		952
		953	With respect to conformance, rxvt-unicode is supposed to be compliant to
		954	both scenario A and B of ISO 14755, including part 5.2.
761		955
762	=head1 LOGIN STAMP	956	=head1 LOGIN STAMP
763		957
764	B<@@RXVTNAME@@> tries to write an entry into the I<utmp>(5) file so	958	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.	959	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	960	To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on
767	some systems.	961	some systems.
768		962
769	=head1 COLORS AND GRAPHICS	963	=head1 COLORS AND GRAPHICS
770		964
771	In addition to the default foreground and background colours,	965	In addition to the default foreground and background colours,
772	B<@@RXVTNAME@@> can display up to 16 colours (8 ANSI colours plus	966	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	967	high-intensity bold/blink versions of the same). Here is a list of the
774	colours with their B<rgb.txt> names.	968	colours with their B<rgb.txt> names.
775		969
776	=begin table	970	=begin table
777		971
…		…
806	I<xterm>(1) where the colours are only swapped if they have not otherwise	1000	I<xterm>(1) where the colours are only swapped if they have not otherwise
807	been specified. For example,	1001	been specified. For example,
808		1002
809	=over 4	1003	=over 4
810		1004
811	=item B<rxvt -fg Black -bg White -rv>	1005	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
812		1006
813	would yield White on Black, while on I<xterm>(1) it would yield Black	1007	would yield White on Black, while on I<xterm>(1) it would yield Black
814	on White.	1008	on White.
815		1009
816	=back	1010	=back
817		1011
818	=head1 ENVIRONMENT	1012	=head1 ENVIRONMENT
819		1013
820	B<@@RXVTNAME@@> sets the environment variables B<TERM>, B<COLORTERM>	1014	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	1015	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	1016	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	1017	sets the environment variable B<DISPLAY> to specify which display
824	terminal to use. B<@@RXVTNAME@@> uses the environment variables	1018	terminal to use. B<@@RXVT_NAME@@> uses the environment variables
825	B<RXVTPATH> and B<PATH> to find XPM files.	1019	B<RXVTPATH> and B<PATH> to find XPM files.
826		1020
827	=head1 FILES	1021	=head1 FILES
828		1022
829	=over 4	1023	=over 4
…		…
836		1030
837	Color names.	1031	Color names.
838		1032
839	=back	1033	=back
840		1034
841	=head1 SEEALSO	1035	=head1 SEE ALSO
842		1036
843	I<xterm>(1), I<sh>(1), I<resize>(1), I<X>(1), I<pty>(4), I<tty>(4), I<utmp>(5)	1037	@@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		1038
847	=head1 BUGS	1039	=head1 BUGS
848		1040
849	Check the BUGS file for an up-to-date list.	1041	Check the BUGS file for an up-to-date list.
850		1042
851	Cursor change support is not yet implemented.	1043	Cursor change support is not yet implemented.
852		1044
853	Click-and-drag doesn't work with X11 mouse report overriding.	1045	Click-and-drag doesn't work with X11 mouse report overriding.
854		1046
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	1047	=head1 CURRENT PROJECT COORDINATOR
860		1048
861	=over 4	1049	=over 4
862		1050
863	=item Project Coordinator	1051	=item Project Coordinator
864		1052
865	@@RXVTMAINT@@ L<@@RXVTMAINTEMAIL@@>	1053	@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@>
866		1054
867	=item Web page maintainter	1055	=item Web page maintainter
868		1056
869	@@RXVTWEBMAINT@@ L<@@RXVTWEBMAINTEMAIL@@>	1057	@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
870		1058
871	L<@@RXVTWEBPAGE@@>(@@RXVTWEBPAGE@@)	1059	L<@@RXVT_WEBPAGE@@>
872		1060
873	=back	1061	=back
874		1062
875	=head1 AUTHORS	1063	=head1 AUTHORS
876		1064

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.34 by root, Wed Dec 1 02:29:14 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.34 by root, Wed Dec 1 02:29:14 2004 UTC