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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.32 by root, Sat Oct 9 11:18:12 2004 UTC vs.
Revision 1.66 by root, Thu Jun 30 14:02:17 2005 UTC

…		…
14	configurability. As a result, B<rxvt-unicode> uses much less swap space --	14	configurability. As a result, B<rxvt-unicode> uses much less swap space --
15	a significant advantage on a machine serving many X sessions.	15	a significant advantage on a machine serving many X sessions.
16		16
17	=head1 FREQUENTLY ASKED QUESTIONS	17	=head1 FREQUENTLY ASKED QUESTIONS
18		18
19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of frequently	19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20	asked questions and answer to them and some common problems.	20	frequently asked questions and answer to them and some common
		21	problems. That document is also accessible on the World-Wide-Web at
		22	L<http://cvs.schmorp.de/browse/checkout/rxvt-unicode/doc/rxvt.7.html>.
21		23
22	=head1 RXVT-UNICODE VS. RXVT	24	=head1 RXVT-UNICODE VS. RXVT
23		25
24	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode	26	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
25	internally. That means it can store and display most scripts in the	27	internally. That means it can store and display most scripts in the
…		…
110	Turn on/off inheriting parent window's pixmap. Alternative form is	112	Turn on/off inheriting parent window's pixmap. Alternative form is
111	B<-tr>; resource B<inheritPixmap>.	113	B<-tr>; resource B<inheritPixmap>.
112		114
113	=item B<-fade> I<number>	115	=item B<-fade> I<number>
114		116
115	Fade the text by the given percentage when focus is lost.	117	Fade the text by the given percentage when focus is lost. resource B<fading>.
116		118
117	=item B<-tint> I<colour>	119	=item B<-tint> I<colour>
118		120
119	Tint the transparent background pixmap with the given colour when	121	Tint the transparent background pixmap with the given colour when
120	transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>	122	transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>
…		…
123		125
124	=item B<-sh>	126	=item B<-sh>
125		127
126	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	128	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
127	background image in addition to tinting it (i.e. B<-tint> must be	129	background image in addition to tinting it (i.e. B<-tint> must be
128	specified, too).	130	specified, too, e.g. C<-tint white>).
129		131
130	=item B<-bg> I<colour>	132	=item B<-bg> I<colour>
131		133
132	Window background colour; resource B<background>.	134	Window background colour; resource B<background>.
133		135
…		…
136	Window foreground colour; resource B<foreground>.	138	Window foreground colour; resource B<foreground>.
137		139
138	=item B<-pixmap> I<file[;geom]>	140	=item B<-pixmap> I<file[;geom]>
139		141
140	Compile I<XPM>: Specify XPM file for the background and also optionally	142	Compile I<XPM>: Specify XPM file for the background and also optionally
141	specify its scaling with a geometry string. Note you may need to add	143	specify its scaling with a geometry string. Note you may need to
142	quotes to avoid special shell interpretation of the `;' in the	144	add quotes to avoid special shell interpretation of the C<;> in the
143	command-line; resource B<backgroundPixmap>.	145	command-line; resource B<backgroundPixmap>.
144		146
145	=item B<-cr> I<colour>	147	=item B<-cr> I<colour>
146		148
147	The cursor colour; resource B<cursorColor>.	149	The cursor colour; resource B<cursorColor>.
…		…
162	=item B<-fn> I<fontlist>	164	=item B<-fn> I<fontlist>
163		165
164	Select the fonts to be used. This is a comma separated list of font names	166	Select the fonts to be used. This is a comma separated list of font names
165	that are used in turn when trying to display Unicode characters. The	167	that are used in turn when trying to display Unicode characters. The
166	first font defines the cell size for characters; other fonts might be	168	first font defines the cell size for characters; other fonts might be
167	smaller, but not (in general) larger. A reasonable default font list is	169	smaller, but not (in general) larger. A (hopefully) reasonable default
168	always appended to it. See resource B<font> for details.	170	font list is always appended to it. See resource B<font> for more details.
		171
		172	In short, to specify an X11 core font, just specify it's name or prefix it
		173	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
		174	e.g.:
		175
		176	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
		177	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
169		178
170	See also the question "How does rxvt-unicode choose fonts?" in the FAQ	179	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
171	section of @@RXVT_NAME@@(7).	180	section of @@RXVT_NAME@@(7).
172		181
173	=item B<-fb> I<fontlist>	182	=item B<-fb> I<fontlist>
…		…
229		238
230	Put scrollbar on right/left; resource B<scrollBar_right>.	239	Put scrollbar on right/left; resource B<scrollBar_right>.
231		240
232	=item B<-st>\|B<+st>	241	=item B<-st>\|B<+st>
233		242
234	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	243	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
235	resource B<scrollBar_floating>.	244	resource B<scrollBar_floating>.
		245
		246	=item B<-ptab>\|B<+ptab>
		247
		248	If enabled (default), "Horizontal Tab" characters are being stored as
		249	actual wide characters in the screen buffer, which makes it possible to
		250	select and paste them. Since a horizontal tab is a cursor movement and
		251	not an actual glyph, this can sometimes be visually annoying as the cursor
		252	on a tab character is displayed as a wide cursor; resource B<pastableTabs>.
236		253
237	=item B<-bc>\|B<+bc>	254	=item B<-bc>\|B<+bc>
238		255
239	Blink the cursor; resource B<cursorBlink>.	256	Blink the cursor; resource B<cursorBlink>.
240		257
…		…
265	if honoured by the WM, the rxvt-unicode window will not have window	282	if honoured by the WM, the rxvt-unicode window will not have window
266	decorations; resource B<borderLess>.	283	decorations; resource B<borderLess>.
267		284
268	=item B<-lsp> I<number>	285	=item B<-lsp> I<number>
269		286
270	Compile I<linespace>: Lines (pixel height) to insert between each row	287	Compile I<frills>: Lines (pixel height) to insert between each row of
271	of the display; resource B<linespace>.	288	the display. Useful to work around font rendering problems; resource
		289	B<linespace>.
272		290
273	=item B<-tn> I<termname>	291	=item B<-tn> I<termname>
274		292
275	This option specifies the name of the terminal type to be set in the	293	This option specifies the name of the terminal type to be set in the
276	B<TERM> environment variable. This terminal type must exist in the	294	B<TERM> environment variable. This terminal type must exist in the
…		…
312		330
313	Compile I<XIM>: input method name. resource B<inputMethod>.	331	Compile I<XIM>: input method name. resource B<inputMethod>.
314		332
315	=item B<-imlocale> I<string>	333	=item B<-imlocale> I<string>
316		334
317	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	335	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
318	de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input	336	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
319	extension to be able to input japanese characters while staying in	337	input extension to be able to input japanese characters while staying in
320	another locale.	338	another locale. resource B<imLocale>.
		339
		340	=item B<-imfont> I<fontset>
		341
		342	Set the font set to use for the X Input Method, see resource B<imFont>
		343	for more info.
		344
		345	=item B<-tcw>
		346
		347	Change the meaning of triple-click selection with the left mouse
		348	button. Instead of selecting a full line it will extend the selection the
		349	end of the logical line only. resource B<tripleclickwords>.
321		350
322	=item B<-insecure>	351	=item B<-insecure>
323		352
324	Enable "insecure" mode, which currently enables most of the escape	353	Enable "insecure" mode, which currently enables most of the escape
325	sequences that echo strings. See the resource B<insecure> for more	354	sequences that echo strings. See the resource B<insecure> for more
…		…
339	=item B<-ssr>\|B<+ssr>	368	=item B<-ssr>\|B<+ssr>
340		369
341	Turn on/off secondary screen scroll (default enabled); resource	370	Turn on/off secondary screen scroll (default enabled); resource
342	B<secondaryScroll>.	371	B<secondaryScroll>.
343		372
344	=item B<-xrm> I<resourcestring>	373	=item B<-keysym.>I<sym> I<string>
345		374
346	No effect on rxvt-unicode. Simply passes through an argument to be made	375	Remap a key symbol. See resource B<keysym>.
347	available in the instance's argument list. Appears in I<WM_COMMAND> in	376
348	some window managers.	377	=item B<-embed> I<windowid>
		378
		379	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
		380	which enables applications to easily embed a terminal.
		381
		382	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
		383	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
		384	quite a bit, so don't expect it to keep some specific state. It's best to
		385	create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
		386
		387	The window will not be destroyed when @@RXVT_NAME@@ exits.
		388
		389	It might be useful to know that @@RXVT_NAME@@ will not close file
		390	descriptors passed to it (except for stdin/out/err, of course), so you
		391	can use file descriptors to communicate with the programs within the
		392	terminal. This works regardless of wether the C<-embed> option was used or
		393	not.
		394
		395	Here is a short Gtk2-perl snippet that illustrates how this option can be
		396	used (a longer example is in F<doc/embed>):
		397
		398	my $rxvt = new Gtk2::Socket;
		399	$rxvt->signal_connect_after (realize => sub {
		400	my $xid = $_[0]->window->get_xid;
		401	system "@@RXVT_NAME@@ -embed $xid &";
		402	});
		403
		404	=item B<-pty-fd> I<fileno>
		405
		406	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
		407	pair but instead use the given filehandle as the tty master. This is
		408	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
		409	without having to run a program within it.
		410
		411	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
		412	entries and will not tinker with pty/tty permissions - you have to do that
		413	yourself if you want that.
		414
		415	Here is a example in perl that illustrates how this option can be used (a
		416	longer example is in F<doc/pty-fd>):
		417
		418	use IO::Pty;
		419	use Fcntl;
		420
		421	my $pty = new IO::Pty;
		422	fcntl $pty, F_SETFD, 0; # clear close-on-exec
		423	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		424	close $pty;
		425
		426	# now communicate with rxvt
		427	my $slave = $pty->slave;
		428	while (<$slave>) { print $slave "got <$_>\n" }
349		429
350	=back	430	=back
351		431
352	=head1 RESOURCES (available also as long-options)	432	=head1 RESOURCES (available also as long-options)
353		433
…		…
356		436
357	There are two different methods that @@RXVT_NAME@@ can use to get the	437	There are two different methods that @@RXVT_NAME@@ can use to get the
358	Xresource data: using the X libraries (Xrm*-functions) or internal	438	Xresource data: using the X libraries (Xrm*-functions) or internal
359	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	439	Xresources reader (B<~/.Xdefaults>). For the first method (ie.
360	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	440	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the
361	resources using X11 tools like B<xset>. Many distribution do also load	441	resources using X11 tools like B<xrdb>. Many distribution do also load
362	settings from the B<~/.Xresources> file when X starts.	442	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
		443	will consult the following files/resources in order, with later settings
		444	overwriting earlier ones:
		445
		446	1. system-wide app-defaults file, either locale-dependent OR global
		447	2. app-defaults file in $XAPPLRESDIR
		448	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
		449	4. SCREEN_RESOURCES for the current screen
		450	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
363		451
364	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>	452	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
365	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults	453	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
366	set in XAPPLOADDIR/URxvt (compile-time defined: usually	454	set in XAPPLOADDIR/URxvt (compile-time defined: usually
367	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	455	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
…		…
412		500
413	=item B<colorIT:> I<colour>	501	=item B<colorIT:> I<colour>
414		502
415	Use the specified colour to display bold or italic characters when the	503	Use the specified colour to display bold or italic characters when the
416	foreground colour is the default. If font styles are not available	504	foreground colour is the default. If font styles are not available
417	(Compile styles) and this option is unset, reverse video is used instead.	505	(Compile I<styles>) and this option is unset, reverse video is used instead.
418		506
419	=item B<colorUL:> I<colour>	507	=item B<colorUL:> I<colour>
420		508
421	Use the specified colour to display underlined characters when the	509	Use the specified colour to display underlined characters when the
422	foreground colour is the default.	510	foreground colour is the default.
423		511
424	=item B<colorRV:> I<colour>	512	=item B<colorRV:> I<colour>
425		513
426	Use the specified colour as the background for reverse video	514	Use the specified colour as the background for reverse video
427	characters.	515	characters.
		516
		517	=item B<underlineColor:> I<colour>
		518
		519	If set, use the specified colour as the colour for the underline
		520	itself. If unset, use the foreground colour.
428		521
429	=item B<cursorColor:> I<colour>	522	=item B<cursorColor:> I<colour>
430		523
431	Use the specified colour for the cursor. The default is to use the	524	Use the specified colour for the cursor. The default is to use the
432	foreground colour; option B<-cr>.	525	foreground colour; option B<-cr>.
…		…
473	Use the specified colour for the scrollbar [default #B2B2B2].	566	Use the specified colour for the scrollbar [default #B2B2B2].
474		567
475	=item B<troughColor:> I<colour>	568	=item B<troughColor:> I<colour>
476		569
477	Use the specified colour for the scrollbar's trough area [default	570	Use the specified colour for the scrollbar's trough area [default
478	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	571	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
479		572
480	=item B<borderColor:> I<colour>	573	=item B<borderColor:> I<colour>
481		574
482	The colour of the border around the text area and between the scrollbar	575	The colour of the border around the text area and between the scrollbar
483	and the text.	576	and the text.
…		…
513	The first font defines the cell size for characters; other fonts might	606	The first font defines the cell size for characters; other fonts might
514	be smaller, but not larger. A reasonable default font list is always	607	be smaller, but not larger. A reasonable default font list is always
515	appended to it. option B<-fn>.	608	appended to it. option B<-fn>.
516		609
517	Each font can either be a standard X11 core font (XLFD) name, with	610	Each font can either be a standard X11 core font (XLFD) name, with
518	optional prefix C<x:> or a Xft font (Compile xft), prefixed with C<xft:>.	611	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
519		612
520	In addition, each font can be prefixed with additional hints and	613	In addition, each font can be prefixed with additional hints and
521	specifications enclosed in square brackets (C<[]>). The only available	614	specifications enclosed in square brackets (C<[]>). The only available
522	hint currently is C<codeset=codeset-name>, and this is only used for Xft	615	hint currently is C<codeset=codeset-name>, and this is only used for Xft
523	fonts.	616	fonts.
…		…
533	specifies five fonts to be used. The first one is C<9x15bold> (actually	626	specifies five fonts to be used. The first one is C<9x15bold> (actually
534	the iso8859-1 version of the second font), which is the base font (because	627	the iso8859-1 version of the second font), which is the base font (because
535	it is named first) and thus defines the character cell grid to be 9 pixels	628	it is named first) and thus defines the character cell grid to be 9 pixels
536	wide and 15 pixels high.	629	wide and 15 pixels high.
537		630
538	the second font is just used to add additional unicode characters not in	631	The second font is just used to add additional unicode characters not in
539	the base font, likewise the third, which is unfortunately non-bold, but	632	the base font, likewise the third, which is unfortunately non-bold, but
540	the bold version of the font does contain less characters, so this is a	633	the bold version of the font does contain less characters, so this is a
541	useful supplement.	634	useful supplement.
542		635
543	The third font is an Xft font with aliasing turned off, and the characters	636	The third font is an Xft font with aliasing turned off, and the characters
…		…
575	xterm style selection.	668	xterm style selection.
576		669
577	=item B<scrollstyle:> I<mode>	670	=item B<scrollstyle:> I<mode>
578		671
579	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	672	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
580	the author's favourite..	673	the author's favourite.
581		674
582	=item B<title:> I<string>	675	=item B<title:> I<string>
583		676
584	Set window title string, the default title is the command-line	677	Set window title string, the default title is the command-line
585	specified after the B<-e> option, if any, otherwise the application	678	specified after the B<-e> option, if any, otherwise the application
…		…
617		710
618	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	711	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
619	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or	712	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
620	B<Shift-Print> to include the scrollback as well.	713	B<Shift-Print> to include the scrollback as well.
621		714
		715	The string will be interpreted as if typed into the shell as-is.
		716
		717	Example:
		718
		719	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		720
		721	This creates a new file in your home directory with the screen contents
		722	everytime you hit C<Print>.
		723
622	=item B<scrollBar:> I<boolean>	724	=item B<scrollBar:> I<boolean>
623		725
624	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	726	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
625	disable the scrollbar; option B<+sb>.	727	disable the scrollbar; option B<+sb>.
626		728
…		…
646	B<+si>.	748	B<+si>.
647		749
648	=item B<scrollWithBuffer:> I<boolean>	750	=item B<scrollWithBuffer:> I<boolean>
649		751
650	B<True>: scroll with scrollback buffer when tty receives new lines (and	752	B<True>: scroll with scrollback buffer when tty receives new lines (and
651	B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll	753	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
652	with scrollback buffer when tty recieves new lines; option B<-sw>.	754	with scrollback buffer when tty recieves new lines; option B<+sw>.
653		755
654	=item B<scrollTtyKeypress:> I<boolean>	756	=item B<scrollTtyKeypress:> I<boolean>
655		757
656	B<True>: scroll to bottom when a non-special key is pressed. Special keys	758	B<True>: scroll to bottom when a non-special key is pressed. Special keys
657	are those which are intercepted by rxvt-unicode for special handling and	759	are those which are intercepted by rxvt-unicode for special handling and
…		…
696	=item B<mouseWheelScrollPage:> I<boolean>	798	=item B<mouseWheelScrollPage:> I<boolean>
697		799
698	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel	800	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
699	scrolls five lines [default].	801	scrolls five lines [default].
700		802
		803	=item B<pastableTabs:> I<boolean>
		804
		805	B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
		806	movement only; option C<-ptab>.
		807
701	=item B<cursorBlink:> I<boolean>	808	=item B<cursorBlink:> I<boolean>
702		809
703	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	810	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
704	option B<-bc>.	811	option B<-bc>.
705		812
…		…
717		824
718	Mouse pointer background colour.	825	Mouse pointer background colour.
719		826
720	=item B<pointerBlankDelay:> I<number>	827	=item B<pointerBlankDelay:> I<number>
721		828
722	Specifies number of seconds before blanking the pointer [default 2].	829	Specifies number of seconds before blanking the pointer [default 2]. Use a
		830	large number (e.g. C<987654321>) to effectively disable the timeout.
723		831
724	=item B<backspacekey:> I<string>	832	=item B<backspacekey:> I<string>
725		833
726	The string to send when the backspace key is pressed. If set to B<DEC>	834	The string to send when the backspace key is pressed. If set to B<DEC>
727	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	835	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
…		…
749		857
750	I<name> of inputMethod to use; option B<-im>.	858	I<name> of inputMethod to use; option B<-im>.
751		859
752	=item B<imLocale:> I<name>	860	=item B<imLocale:> I<name>
753		861
754	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	862	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
755	de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input	863	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
756	extension to be able to input japanese characters while staying in	864	input extension to be able to input japanese characters while staying in
757	another locale. option B<-imlocale>.	865	another locale. option B<-imlocale>.
		866
		867	=item B<imFont:> I<fontset>
		868
		869	Specify the font-set used for XIM styles C<OverTheSpot> or
		870	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
		871	by commas), i.e. it's not in the same format as the other font lists used
		872	in @@RXVT_NAME@@. The default will be set-up to chose any suitable found
		873	found, preferably one or two pixels differing in size to the base font.
		874	option B<-imfont>.
		875
		876	=item B<tripleclickwords:> I<boolean>
		877
		878	Change the meaning of triple-click selection with the left mouse
		879	button. Instead of selecting a full line it will extend the selection to
		880	the end of the logical line only. option B<-tcw>.
758		881
759	=item B<insecure:> I<boolean>	882	=item B<insecure:> I<boolean>
760		883
761	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	884	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
762	echo arbitrary strings like the icon name or the locale. This could be	885	echo arbitrary strings like the icon name or the locale. This could be
…		…
792	scrollback buffer and switching to/from the secondary screen will	915	scrollback buffer and switching to/from the secondary screen will
793	instead scroll the screen up.	916	instead scroll the screen up.
794		917
795	=item B<keysym.>I<sym>: I<string>	918	=item B<keysym.>I<sym>: I<string>
796		919
797	Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may	920	Compile I<frills>: Associate I<string> with keysym I<sym>. The
798	contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:	921	intervening resource name B<keysym.> cannot be omitted.
799	newline, \r: return, \t:	922
		923	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
		924	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
		925	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
		926	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
		927	B<2>, B<3>, B<4>, B<5>.
		928
		929	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
		930	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
		931	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
		932	current application keymap mode state.
		933
		934	The spellings of I<key> can be obtained by using B<xev>(1) command or
		935	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
		936	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
		937	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
		938	performed in an exact manner; however, the closest match is assured.
		939
		940	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
		941	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
800	tab, \000: octal number) or control characters (^?: delete, ^@: null,	942	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
801	^A ...) and may enclosed with double quotes so that it can start or end	943	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
802	with whitespace. The intervening resource name B<keysym.> cannot be	944	can start or end with whitespace.
803	omitted. This resource is only available when compiled with	945
804	KEYSYM_RESOURCE.	946	Please note that you need to double the C<\> when using
		947	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
		948	use C<\033> instead of C<\e> (and so on), which will work with both Xt and
		949	@@RXVT_NAME@@'s own processing).
		950
		951	You can define a range of keysyms in one shot by providing a I<string>
		952	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
		953	should be a character not used by the strings.
		954
		955	Its usage can be demonstrated by an example:
		956
		957	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
		958
		959	The above line is equivalent to the following three lines:
		960
		961	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
		962	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
		963	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
		964
		965	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
		966	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
		967	example the following means "change the current locale to C<zh_CN.GBK>
		968	when Control-Meta-c is being pressed":
		969
		970	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		971
		972	Due the the large number of modifier combinations, a defined key mapping
		973	will match if at I<at least> the specified identifiers are being set, and
		974	no other key mappings with those and more bits are being defined. That
		975	means that defining a key map for C<a> will automatically provide
		976	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		977	mappings themselves.
		978
		979	Unfortunately, this will override built-in key mappings. For example
		980	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		981	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		982	user-defined keymap using the C<builtin:> replacement:
		983
		984	URxvt.keysym.Insert: <my insert key sequence>
		985	URxvt.keysym.S-Insert: builtin:
		986
		987	The first line defines a mapping for C<Insert> and I<any> combination
		988	of modifiers. The second line re-establishes the default mapping for
		989	C<Shift-Insert>.
		990
		991	The following example will map Control-Meta-1 and Control-Meta-2 to
		992	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
		993	font-switching at runtime:
		994
		995	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		996	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
		997
		998	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
		999	info):
		1000
		1001	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1002	URxvt.keysym.M-C-4: command:\033[8;48;110t
805		1003
806	=back	1004	=back
807		1005
808	=head1 THE SCROLLBAR	1006	=head1 THE SCROLLBAR
809		1007
…		…
823	the normal text selection/insertion, hold either the Shift or the Meta	1021	the normal text selection/insertion, hold either the Shift or the Meta
824	(Alt) key while performing the desired mouse action.	1022	(Alt) key while performing the desired mouse action.
825		1023
826	If mouse reporting mode is active, the normal scrollbar actions are	1024	If mouse reporting mode is active, the normal scrollbar actions are
827	disabled -- on the assumption that we are using a fullscreen	1025	disabled -- on the assumption that we are using a fullscreen
828	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	1026	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
829	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	1027	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
830	up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down),	1028	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
831	respectively.	1029	respectively.
832		1030
833	=head1 TEXT SELECTION AND INSERTION	1031	=head1 TEXT SELECTION AND INSERTION
834		1032
835	The behaviour of text selection and insertion mechanism is similar to	1033	The behaviour of text selection and insertion mechanism is similar to
…		…
837		1035
838	=over 4	1036	=over 4
839		1037
840	=item B<Selection>:	1038	=item B<Selection>:
841		1039
842	Left click at the beginning of the region, drag to the end of the	1040	Left click at the beginning of the region, drag to the end of the region
843	region and release; Right click to extend the marked region; Left	1041	and release; Right click to extend the marked region; Left double-click
844	double-click to select a word; Left triple-click to select the entire	1042	to select a word; Left triple-click to select the entire logical line
845	line.	1043	(which can span multiple screen lines), unless modified by resource
		1044	B<tripleclickwords>.
846		1045
847	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1046	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
848	(Compile: frills) will create a rectangular selection instead of a normal	1047	(Compile: I<frills>) will create a rectangular selection instead of a normal
849	one.	1048	one.
850		1049
851	=item B<Insertion>:	1050	=item B<Insertion>:
852		1051
853	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1052	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
…		…
876	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1075	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
877	with C<--enable-iso14755>.	1076	with C<--enable-iso14755>.
878		1077
879	=over 4	1078	=over 4
880		1079
881	=item 5.1: Basic method	1080	=item * 5.1: Basic method
882		1081
883	This allows you to enter unicode characters using their hexcode.	1082	This allows you to enter unicode characters using their hexcode.
884		1083
885	Start by pressing and holding both C<Control> and C<Shift>, then enter	1084	Start by pressing and holding both C<Control> and C<Shift>, then enter
886	hex-digits (between one and six). Releasing C<Control> and C<Shift> will	1085	hex-digits (between one and six). Releasing C<Control> and C<Shift> will
…		…
893	address, which you cannot type. Fortunately, the card has the e-mail	1092	address, which you cannot type. Fortunately, the card has the e-mail
894	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily	1093	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
895	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,	1094	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
896	followed by releasing the modifier keys.	1095	followed by releasing the modifier keys.
897		1096
898	=item 5.2: Keyboard symbols entry method	1097	=item * 5.2: Keyboard symbols entry method
899		1098
900	This mode lets you input characters representing the keycap symbols of	1099	This mode lets you input characters representing the keycap symbols of
901	your keyboard, if representable in the current locale encoding.	1100	your keyboard, if representable in the current locale encoding.
902		1101
903	Start by pressing C<Control> and C<Shift> together, then releasing	1102	Start by pressing C<Control> and C<Shift> together, then releasing
…		…
906	keycap symbol. The symbol will only be entered when the key has been	1105	keycap symbol. The symbol will only be entered when the key has been
907	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1106	released, otherwise pressing e.g. C<Shift> would enter the symbol for
908	C<ISO Level 2 Switch>, although your intention might have been to enter a	1107	C<ISO Level 2 Switch>, although your intention might have been to enter a
909	reverse tab (Shift-Tab).	1108	reverse tab (Shift-Tab).
910		1109
911	=item 5.3: Screen-selection entry method	1110	=item * 5.3: Screen-selection entry method
912		1111
913	While this is implemented already (it's basically the selection	1112	While this is implemented already (it's basically the selection
914	mechanism), it could be extended by displaying a unicode character map.	1113	mechanism), it could be extended by displaying a unicode character map.
915		1114
916	=item 5.4: Feedback method for identifying displayed characters for later input	1115	=item * 5.4: Feedback method for identifying displayed characters for later input
917		1116
918	This method lets you display the unicode character code associated with	1117	This method lets you display the unicode character code associated with
919	characters already displayed.	1118	characters already displayed.
920		1119
921	You enter this mode by holding down C<Control> and C<Shift> together, then	1120	You enter this mode by holding down C<Control> and C<Shift> together, then
…		…
933	With respect to conformance, rxvt-unicode is supposed to be compliant to	1132	With respect to conformance, rxvt-unicode is supposed to be compliant to
934	both scenario A and B of ISO 14755, including part 5.2.	1133	both scenario A and B of ISO 14755, including part 5.2.
935		1134
936	=head1 LOGIN STAMP	1135	=head1 LOGIN STAMP
937		1136
938	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so	1137	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
939	that it can be seen via the I<who(1)> command, and can accept messages.	1138	it can be seen via the I<who(1)> command, and can accept messages. To
940	To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on	1139	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
941	some systems.	1140	on some systems or setgid to root or to some other group on others.
942		1141
943	=head1 COLORS AND GRAPHICS	1142	=head1 COLORS AND GRAPHICS
944		1143
945	In addition to the default foreground and background colours,	1144	In addition to the default foreground and background colours,
946	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1145	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
…		…
989		1188
990	=back	1189	=back
991		1190
992	=head1 ENVIRONMENT	1191	=head1 ENVIRONMENT
993		1192
994	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>	1193	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
995	and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X	1194
996	window id number of the B<@@RXVT_NAME@@> window and it also uses and	1195	=over 4
997	sets the environment variable B<DISPLAY> to specify which display	1196
998	terminal to use. B<@@RXVT_NAME@@> uses the environment variables	1197	=item B<TERM>
999	B<RXVTPATH> and B<PATH> to find XPM files.	1198
		1199	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
		1200	resources or on the commandline.
		1201
		1202	=item B<COLORTERM>
		1203
		1204	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
		1205	compiled with XPM support, and optionally with the added extension
		1206	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
		1207
		1208	=item B<COLORFGBG>
		1209
		1210	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
		1211	the colour code used as default foreground/text colour (or the string
		1212	C<default> to indicate that the default-colour escape sequence is to be
		1213	used), C<bg> is the colour code used as default background colour (or the
		1214	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1215	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
		1216	(and do) use this information to optimize screen output.
		1217
		1218	=item B<WINDOWID>
		1219
		1220	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
		1221	window, which usually has subwindows for the scrollbar, the terminal
		1222	window and so on).
		1223
		1224	=item B<TERMINFO>
		1225
		1226	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1227	C<--with-terminfo=PATH>.
		1228
		1229	=item B<DISPLAY>
		1230
		1231	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
		1232	display in it's child processes.
		1233
		1234	=item B<SHELL>
		1235
		1236	The shell to be used for command execution, defaults to C</bin/sh>.
		1237
		1238	=item B<RXVTPATH>
		1239
		1240	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
		1241	files.
		1242
		1243	=item B<PATH>
		1244
		1245	Used in the same way as C<RXVTPATH>.
		1246
		1247	=item B<RXVT_SOCKET>
		1248
		1249	The unix domain socket path used by @@RXVT_NAME@@c(1) and
		1250	@@RXVT_NAME@@d(1).
		1251
		1252	Default C<< $HOME/.rxvt-unicode-<nodename >>.
		1253
		1254	=item B<HOME>
		1255
		1256	Used to locate the default directory for the unix domain socket for
		1257	daemon communications and to locate various resource files (such as
		1258	C<.Xdefaults>)
		1259
		1260	=item B<XAPPLRESDIR>
		1261
		1262	Directory where various X resource files are being located.
		1263
		1264	=item B<XENVIRONMENT>
		1265
		1266	If set and accessible, gives the name of a X resource file to be loaded by
		1267	@@RXVT_NAME@@.
		1268
		1269	=back
1000		1270
1001	=head1 FILES	1271	=head1 FILES
1002		1272
1003	=over 4	1273	=over 4
1004		1274
1005	=item B</etc/utmp>
1006
1007	System file for login records.
1008
1009	=item B</usr/lib/X11/rgb.txt>	1275	=item B</usr/lib/X11/rgb.txt>
1010		1276
1011	Color names.	1277	Color names.
1012		1278
1013	=back	1279	=back
…		…
1028		1294
1029	=over 4	1295	=over 4
1030		1296
1031	=item Project Coordinator	1297	=item Project Coordinator
1032		1298
1033	@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@>	1299	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1034		1300
1035	=item Web page maintainter	1301	L<http://software.schmorp.de/#rxvt-unicode>
1036
1037	@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1038
1039	L<@@RXVT_WEBPAGE@@>
1040		1302
1041	=back	1303	=back
1042		1304
1043	=head1 AUTHORS	1305	=head1 AUTHORS
1044		1306
…		…
1069	=item Geoff Wing L<< <gcw@pobox.com> >>	1331	=item Geoff Wing L<< <gcw@pobox.com> >>
1070		1332
1071	Rewrote screen display and text selection routines. Project Coordinator	1333	Rewrote screen display and text selection routines. Project Coordinator
1072	(changes.txt 2.4.6 - rxvt-unicode)	1334	(changes.txt 2.4.6 - rxvt-unicode)
1073		1335
1074	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>	1336	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1075		1337
1076	Forked rxvt-unicode, rewrote most of the display code and internal	1338	Forked rxvt-unicode, rewrote most of the display code and internal
1077	character handling to store text in unicode, improve xterm	1339	character handling to store text in unicode, improve xterm
1078	compatibility and apply numerous other bugfixes and extensions.	1340	compatibility and apply numerous other bugfixes and extensions.
1079		1341

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.32 by root, Sat Oct 9 11:18:12 2004 UTC vs. Revision 1.66 by root, Thu Jun 30 14:02:17 2005 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.32 by root, Sat Oct 9 11:18:12 2004 UTC vs.
Revision 1.66 by root, Thu Jun 30 14:02:17 2005 UTC