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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.43 by root, Sun Jan 16 19:22:16 2005 UTC vs.
Revision 1.76 by root, Sat Dec 31 16:06:48 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
…		…
103		105
104	=item B<-j>\|B<+j>	106	=item B<-j>\|B<+j>
105		107
106	Turn on/off jump scrolling; resource B<jumpScroll>.	108	Turn on/off jump scrolling; resource B<jumpScroll>.
107		109
108	=item B<-ip>\|B<+ip>	110	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>
109		111
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. resource B<fading>.	117	Fade the text by the given percentage when focus is lost. Small values
		118	fade a little only, 100 completely replaces all colours by the fade
		119	colour; resource B<fading>.
		120
		121	=item B<-fadecolor> I<colour>
		122
		123	Fade to this colour when fading is used (see B<-fade>). The default colour
		124	is black. resource B<fadeColor>.
116		125
117	=item B<-tint> I<colour>	126	=item B<-tint> I<colour>
118		127
119	Tint the transparent background pixmap with the given colour when	128	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>	129	transparency is enabled with B<-tr> or B<-ip>. This only works for
121	option that can be used to brighten or darken the image in addition to	130	non-tiled backgrounds, currently. See also the B<-sh> option that can be
122	tinting it.	131	used to brighten or darken the image in addition to tinting it; resource
		132	I<tintColor>. Example:
		133
		134	@@RXVT_NAME@@ -tr -tint blue -sh 40
123		135
124	=item B<-sh>	136	=item B<-sh>
125		137
126	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	138	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	139	background image in addition to tinting it (i.e. B<-tint> must be
…		…
190	=item B<-fbi> I<fontlist>	202	=item B<-fbi> I<fontlist>
191		203
192	Compile font-styles: The bold italic font list to use when bold characters are to	204	Compile font-styles: The bold italic font list to use when bold characters are to
193	be printed. See resource B<boldItalicFont> for details.	205	be printed. See resource B<boldItalicFont> for details.
194		206
		207	=item B<-is>\|B<+is>
		208
		209	Compile font-styles: Bold/Italic font styles imply high intensity
		210	foreground/background (default). See resource B<intensityStyles> for
		211	details.
		212
195	=item B<-name> I<name>	213	=item B<-name> I<name>
196		214
197	Specify the application name under which resources are to be obtained,	215	Specify the application name under which resources are to be obtained,
198	rather than the default executable file name. Name should not contain	216	rather than the default executable file name. Name should not contain
199	`.' or `*' characters. Also sets the icon and title name.	217	`.' or `*' characters. Also sets the icon and title name.
…		…
236		254
237	Put scrollbar on right/left; resource B<scrollBar_right>.	255	Put scrollbar on right/left; resource B<scrollBar_right>.
238		256
239	=item B<-st>\|B<+st>	257	=item B<-st>\|B<+st>
240		258
241	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	259	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
242	resource B<scrollBar_floating>.	260	resource B<scrollBar_floating>.
243		261
244	=item B<-ptab>\|B<+ptab>	262	=item B<-ptab>\|B<+ptab>
245		263
246	If enabled (default), "Horizontal Tab" characters are being stored as	264	If enabled (default), "Horizontal Tab" characters are being stored as
…		…
301	given on the command line. If this option is used, it must be the last	319	given on the command line. If this option is used, it must be the last
302	on the command-line. If there is no B<-e> option then the default is to	320	on the command-line. If there is no B<-e> option then the default is to
303	run the program specified by the B<SHELL> environment variable or,	321	run the program specified by the B<SHELL> environment variable or,
304	failing that, I<sh(1)>.	322	failing that, I<sh(1)>.
305		323
		324	Please note that you must specify a program with arguments. If you want to
		325	run shell commands, you have to specify the shell, like this:
		326
		327	@@RXVT_NAME@@ -e sh -c "shell commands"
		328
306	=item B<-title> I<text>	329	=item B<-title> I<text>
307		330
308	Window title (B<-T> still respected); the default title is the basename	331	Window title (B<-T> still respected); the default title is the basename
309	of the program specified after the B<-e> option, if any, otherwise the	332	of the program specified after the B<-e> option, if any, otherwise the
310	application name; resource B<title>.	333	application name; resource B<title>.
…		…
328		351
329	Compile I<XIM>: input method name. resource B<inputMethod>.	352	Compile I<XIM>: input method name. resource B<inputMethod>.
330		353
331	=item B<-imlocale> I<string>	354	=item B<-imlocale> I<string>
332		355
333	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	356	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
334	de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input	357	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
335	extension to be able to input japanese characters while staying in	358	input extension to be able to input japanese characters while staying in
336	another locale.	359	another locale. resource B<imLocale>.
		360
		361	=item B<-imfont> I<fontset>
		362
		363	Set the font set to use for the X Input Method, see resource B<imFont>
		364	for more info.
		365
		366	=item B<-tcw>
		367
		368	Change the meaning of triple-click selection with the left mouse
		369	button. Instead of selecting a full line it will extend the selection the
		370	end of the logical line only. resource B<tripleclickwords>.
337		371
338	=item B<-insecure>	372	=item B<-insecure>
339		373
340	Enable "insecure" mode, which currently enables most of the escape	374	Enable "insecure" mode, which currently enables most of the escape
341	sequences that echo strings. See the resource B<insecure> for more	375	sequences that echo strings. See the resource B<insecure> for more
…		…
355	=item B<-ssr>\|B<+ssr>	389	=item B<-ssr>\|B<+ssr>
356		390
357	Turn on/off secondary screen scroll (default enabled); resource	391	Turn on/off secondary screen scroll (default enabled); resource
358	B<secondaryScroll>.	392	B<secondaryScroll>.
359		393
360	=item B<-xrm> I<resourcestring>	394	=item B<-hold>\|B<+hold>
361		395
362	No effect on rxvt-unicode. Simply passes through an argument to be made	396	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
363	available in the instance's argument list. Appears in I<WM_COMMAND> in	397	will not immediately destroy its window when the program executed within
364	some window managers.	398	it exits. Instead, it will wait till it is being killed or closed by the
		399	user; resource B<hold>.
		400
		401	=item B<-keysym.>I<sym> I<string>
		402
		403	Remap a key symbol. See resource B<keysym>.
		404
		405	=item B<-embed> I<windowid>
		406
		407	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
		408	which enables applications to easily embed a terminal.
		409
		410	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
		411	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
		412	quite a bit, so don't expect it to keep some specific state. It's best to
		413	create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
		414
		415	The window will not be destroyed when @@RXVT_NAME@@ exits.
		416
		417	It might be useful to know that @@RXVT_NAME@@ will not close file
		418	descriptors passed to it (except for stdin/out/err, of course), so you
		419	can use file descriptors to communicate with the programs within the
		420	terminal. This works regardless of wether the C<-embed> option was used or
		421	not.
		422
		423	Here is a short Gtk2-perl snippet that illustrates how this option can be
		424	used (a longer example is in F<doc/embed>):
		425
		426	my $rxvt = new Gtk2::Socket;
		427	$rxvt->signal_connect_after (realize => sub {
		428	my $xid = $_[0]->window->get_xid;
		429	system "@@RXVT_NAME@@ -embed $xid &";
		430	});
		431
		432	=item B<-pty-fd> I<fileno>
		433
		434	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
		435	pair but instead use the given filehandle as the tty master. This is
		436	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
		437	without having to run a program within it.
		438
		439	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
		440	entries and will not tinker with pty/tty permissions - you have to do that
		441	yourself if you want that.
		442
		443	Here is a example in perl that illustrates how this option can be used (a
		444	longer example is in F<doc/pty-fd>):
		445
		446	use IO::Pty;
		447	use Fcntl;
		448
		449	my $pty = new IO::Pty;
		450	fcntl $pty, F_SETFD, 0; # clear close-on-exec
		451	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		452	close $pty;
		453
		454	# now communicate with rxvt
		455	my $slave = $pty->slave;
		456	while (<$slave>) { print $slave "got <$_>\n" }
365		457
366	=back	458	=back
367		459
368	=head1 RESOURCES (available also as long-options)	460	=head1 RESOURCES (available also as long-options)
369		461
…		…
372		464
373	There are two different methods that @@RXVT_NAME@@ can use to get the	465	There are two different methods that @@RXVT_NAME@@ can use to get the
374	Xresource data: using the X libraries (Xrm*-functions) or internal	466	Xresource data: using the X libraries (Xrm*-functions) or internal
375	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	467	Xresources reader (B<~/.Xdefaults>). For the first method (ie.
376	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	468	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the
377	resources using X11 tools like B<xset>. Many distribution do also load	469	resources using X11 tools like B<xrdb>. Many distribution do also load
378	settings from the B<~/.Xresources> file when X starts.	470	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
		471	will consult the following files/resources in order, with later settings
		472	overwriting earlier ones:
		473
		474	1. system-wide app-defaults file, either locale-dependent OR global
		475	2. app-defaults file in $XAPPLRESDIR
		476	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
		477	4. SCREEN_RESOURCES for the current screen
		478	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
379		479
380	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>	480	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
381	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults	481	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
382	set in XAPPLOADDIR/URxvt (compile-time defined: usually	482	set in XAPPLOADDIR/URxvt (compile-time defined: usually
383	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	483	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
…		…
476	artificial transparency. B<False>: do not inherit the parent windows'	576	artificial transparency. B<False>: do not inherit the parent windows'
477	pixmap.	577	pixmap.
478		578
479	=item B<fading:> I<number>	579	=item B<fading:> I<number>
480		580
481	Fade the text by the given percentage when focus is lost.	581	Fade the text by the given percentage when focus is lost; option B<-fade>.
		582
		583	=item B<fadeColor:> I<colour>
		584
		585	Fade to this colour, when fading is used (see B<fading:>). The default
		586	colour is black; option B<-fadecolor>.
482		587
483	=item B<tintColor:> I<colour>	588	=item B<tintColor:> I<colour>
484		589
485	Tint the transparent background pixmap with the given colour.	590	Tint the transparent background pixmap with the given colour; option
		591	B<-tint>.
486		592
487	=item B<shading:> I<number>	593	=item B<shading:> I<number>
488		594
489	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	595	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
490	image in addition to tinting it.	596	image in addition to tinting it.
…		…
494	Use the specified colour for the scrollbar [default #B2B2B2].	600	Use the specified colour for the scrollbar [default #B2B2B2].
495		601
496	=item B<troughColor:> I<colour>	602	=item B<troughColor:> I<colour>
497		603
498	Use the specified colour for the scrollbar's trough area [default	604	Use the specified colour for the scrollbar's trough area [default
499	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	605	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
500		606
501	=item B<borderColor:> I<colour>	607	=item B<borderColor:> I<colour>
502		608
503	The colour of the border around the text area and between the scrollbar	609	The colour of the border around the text area and between the scrollbar
504	and the text.	610	and the text.
…		…
587	not possible, replacement fonts of the desired shape will be tried.	693	not possible, replacement fonts of the desired shape will be tried.
588		694
589	If set, but empty, then this specific style is disabled and the normal	695	If set, but empty, then this specific style is disabled and the normal
590	text font will being used for the given style.	696	text font will being used for the given style.
591		697
		698	=item B<intensityStyles:> I<boolean>
		699
		700	When font styles are not enabled, or this option is enabled (B<True>,
		701	option B<-is>, the default), bold and italic font styles imply high
		702	intensity foreground/backround colours. Disabling this option (B<False>,
		703	option B<+is>) disables this behaviour, the high intensity colours are not
		704	reachable.
		705
592	=item B<selectstyle:> I<mode>	706	=item B<selectstyle:> I<mode>
593		707
594	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	708	Set mouse selection style to B<old> which is 2.20, B<oldword> which is
595	xterm style with 2.20 old word selection, or anything else which gives	709	xterm style with 2.20 old word selection, or anything else which gives
596	xterm style selection.	710	xterm style selection.
597		711
598	=item B<scrollstyle:> I<mode>	712	=item B<scrollstyle:> I<mode>
599		713
600	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	714	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
601	the author's favourite..	715	the author's favourite.
602		716
603	=item B<title:> I<string>	717	=item B<title:> I<string>
604		718
605	Set window title string, the default title is the command-line	719	Set window title string, the default title is the command-line
606	specified after the B<-e> option, if any, otherwise the application	720	specified after the B<-e> option, if any, otherwise the application
…		…
638		752
639	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	753	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
640	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or	754	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
641	B<Shift-Print> to include the scrollback as well.	755	B<Shift-Print> to include the scrollback as well.
642		756
		757	The string will be interpreted as if typed into the shell as-is.
		758
		759	Example:
		760
		761	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		762
		763	This creates a new file in your home directory with the screen contents
		764	everytime you hit C<Print>.
		765
643	=item B<scrollBar:> I<boolean>	766	=item B<scrollBar:> I<boolean>
644		767
645	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	768	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
646	disable the scrollbar; option B<+sb>.	769	disable the scrollbar; option B<+sb>.
647		770
…		…
667	B<+si>.	790	B<+si>.
668		791
669	=item B<scrollWithBuffer:> I<boolean>	792	=item B<scrollWithBuffer:> I<boolean>
670		793
671	B<True>: scroll with scrollback buffer when tty receives new lines (and	794	B<True>: scroll with scrollback buffer when tty receives new lines (and
672	B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll	795	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
673	with scrollback buffer when tty recieves new lines; option B<-sw>.	796	with scrollback buffer when tty recieves new lines; option B<+sw>.
674		797
675	=item B<scrollTtyKeypress:> I<boolean>	798	=item B<scrollTtyKeypress:> I<boolean>
676		799
677	B<True>: scroll to bottom when a non-special key is pressed. Special keys	800	B<True>: scroll to bottom when a non-special key is pressed. Special keys
678	are those which are intercepted by rxvt-unicode for special handling and	801	are those which are intercepted by rxvt-unicode for special handling and
…		…
743		866
744	Mouse pointer background colour.	867	Mouse pointer background colour.
745		868
746	=item B<pointerBlankDelay:> I<number>	869	=item B<pointerBlankDelay:> I<number>
747		870
748	Specifies number of seconds before blanking the pointer [default 2].	871	Specifies number of seconds before blanking the pointer [default 2]. Use a
		872	large number (e.g. C<987654321>) to effectively disable the timeout.
749		873
750	=item B<backspacekey:> I<string>	874	=item B<backspacekey:> I<string>
751		875
752	The string to send when the backspace key is pressed. If set to B<DEC>	876	The string to send when the backspace key is pressed. If set to B<DEC>
753	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	877	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
…		…
775		899
776	I<name> of inputMethod to use; option B<-im>.	900	I<name> of inputMethod to use; option B<-im>.
777		901
778	=item B<imLocale:> I<name>	902	=item B<imLocale:> I<name>
779		903
780	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	904	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
781	de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input	905	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
782	extension to be able to input japanese characters while staying in	906	input extension to be able to input japanese characters while staying in
783	another locale. option B<-imlocale>.	907	another locale. option B<-imlocale>.
		908
		909	=item B<imFont:> I<fontset>
		910
		911	Specify the font-set used for XIM styles C<OverTheSpot> or
		912	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
		913	by commas), i.e. it's not in the same format as the other font lists used
		914	in @@RXVT_NAME@@. The default will be set-up to chose any suitable found
		915	found, preferably one or two pixels differing in size to the base font.
		916	option B<-imfont>.
		917
		918	=item B<tripleclickwords:> I<boolean>
		919
		920	Change the meaning of triple-click selection with the left mouse
		921	button. Instead of selecting a full line it will extend the selection to
		922	the end of the logical line only. option B<-tcw>.
784		923
785	=item B<insecure:> I<boolean>	924	=item B<insecure:> I<boolean>
786		925
787	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	926	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
788	echo arbitrary strings like the icon name or the locale. This could be	927	echo arbitrary strings like the icon name or the locale. This could be
789	abused if somebody gets 8-bit-clean access to your display, whether	928	abused if somebody gets 8-bit-clean access to your display, whether
790	throuh a mail client displaying mail bodies unfiltered or though	929	through a mail client displaying mail bodies unfiltered or through
791	write(1). Therefore, these sequences are disabled by default. (Note	930	write(1) or any other means. Therefore, these sequences are disabled by
792	that other terminals, including xterm, have these sequences	931	default. (Note that many other terminals, including xterm, have these
793	enabled by default). You can enable them by setting this boolean	932	sequences enabled by default, which doesn't make it safer, though).
794	resource or specifying B<-insecure> as an option. At the moment, this	933
795	enabled display-answer, locale, findfont, icon label and window title	934	You can enable them by setting this boolean resource or specifying
796	requests as well as dynamic menubar dispatch.	935	B<-insecure> as an option. At the moment, this enables display-answer,
		936	locale, findfont, icon label and window title requests as well as dynamic
		937	menubar dispatch.
797		938
798	=item B<modifier:> I<modifier>	939	=item B<modifier:> I<modifier>
799		940
800	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	941	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
801	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	942	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
815		956
816	Turn on/off secondary screen scroll (default enabled). If the this	957	Turn on/off secondary screen scroll (default enabled). If the this
817	option is enabled, scrolls on the secondary screen will change the	958	option is enabled, scrolls on the secondary screen will change the
818	scrollback buffer and switching to/from the secondary screen will	959	scrollback buffer and switching to/from the secondary screen will
819	instead scroll the screen up.	960	instead scroll the screen up.
		961
		962	=item B<hold>: I<bool>
		963
		964	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		965	will not immediately destroy its window when the program executed within
		966	it exits. Instead, it will wait till it is being killed or closed by the
		967	user.
820		968
821	=item B<keysym.>I<sym>: I<string>	969	=item B<keysym.>I<sym>: I<string>
822		970
823	Compile I<frills>: Associate I<string> with keysym I<sym>. The	971	Compile I<frills>: Associate I<string> with keysym I<sym>. The
824	intervening resource name B<keysym.> cannot be omitted.	972	intervening resource name B<keysym.> cannot be omitted.
…		…
829	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,	977	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
830	B<2>, B<3>, B<4>, B<5>.	978	B<2>, B<3>, B<4>, B<5>.
831		979
832	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to	980	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
833	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr	981	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
834	keys are being mapped. B<AppKeypad> is a artificial modifier mapped to the	982	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
835	current application keymap mode state.	983	current application keymap mode state.
836		984
837	The spellings of I<key> can be obtained by using B<xev>(1) command or	985	The spellings of I<key> can be obtained by using B<xev>(1) command or
838	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	986	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
839	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	987	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
…		…
844	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	992	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
845	C<\000>: octal number) or verbatim control characters (C<^?>: delete,	993	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
846	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it	994	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
847	can start or end with whitespace.	995	can start or end with whitespace.
848		996
		997	Please note that you need to double the C<\> when using
		998	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
		999	use C<\033> instead of C<\e> (and so on), which will work with both Xt and
		1000	@@RXVT_NAME@@'s own processing).
		1001
849	You can define a range of keysyms in one shot by providing a I<string>	1002	You can define a range of keysyms in one shot by providing a I<string>
850	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1003	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
851	should be a character not used by the strings.	1004	should be a character not used by the strings.
852		1005
853	Its usage can be demonstrated by an example:	1006	Its usage can be demonstrated by an example:
854		1007
855	URxvt.keysym.M-C-0x61: list\|\e<M-C-\|abc\|>	1008	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
856		1009
857	The above line is equivalent to the following three lines:	1010	The above line is equivalent to the following three lines:
858		1011
859	URxvt.keysym.Meta-Control-0x61: \e<M-C-a>	1012	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
860	URxvt.keysym.Meta-Control-0x62: \e<M-C-b>	1013	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
861	URxvt.keysym.Meta-Control-0x63: \e<M-C-c>	1014	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
862		1015
863	If I<string> takes the form of C<proto:STRING>, the specified B<STRING> is	1016	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
864	interpreted and executed as @@RXVT_NAME@@'s control sequence. For example,	1017	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
865	C<proto:\033]701;zh_CN.GBK\007> means: change the current locale to	1018	example the following means "change the current locale to C<zh_CN.GBK>
866	C<zh_CN.GBK>.	1019	when Control-Meta-c is being pressed":
		1020
		1021	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		1022
		1023	Due the the large number of modifier combinations, a defined key mapping
		1024	will match if at I<at least> the specified identifiers are being set, and
		1025	no other key mappings with those and more bits are being defined. That
		1026	means that defining a key map for C<a> will automatically provide
		1027	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		1028	mappings themselves.
		1029
		1030	Unfortunately, this will override built-in key mappings. For example
		1031	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		1032	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		1033	user-defined keymap using the C<builtin:> replacement:
		1034
		1035	URxvt.keysym.Insert: <my insert key sequence>
		1036	URxvt.keysym.S-Insert: builtin:
		1037
		1038	The first line defines a mapping for C<Insert> and I<any> combination
		1039	of modifiers. The second line re-establishes the default mapping for
		1040	C<Shift-Insert>.
		1041
		1042	The following example will map Control-Meta-1 and Control-Meta-2 to
		1043	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
		1044	font-switching at runtime:
		1045
		1046	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1047	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
		1048
		1049	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
		1050	info):
		1051
		1052	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1053	URxvt.keysym.M-C-4: command:\033[8;48;110t
867		1054
868	=back	1055	=back
869		1056
870	=head1 THE SCROLLBAR	1057	=head1 THE SCROLLBAR
871		1058
…		…
885	the normal text selection/insertion, hold either the Shift or the Meta	1072	the normal text selection/insertion, hold either the Shift or the Meta
886	(Alt) key while performing the desired mouse action.	1073	(Alt) key while performing the desired mouse action.
887		1074
888	If mouse reporting mode is active, the normal scrollbar actions are	1075	If mouse reporting mode is active, the normal scrollbar actions are
889	disabled -- on the assumption that we are using a fullscreen	1076	disabled -- on the assumption that we are using a fullscreen
890	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	1077	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
891	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	1078	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
892	up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down),	1079	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
893	respectively.	1080	respectively.
894		1081
895	=head1 TEXT SELECTION AND INSERTION	1082	=head1 TEXT SELECTION AND INSERTION
896		1083
897	The behaviour of text selection and insertion mechanism is similar to	1084	The behaviour of text selection and insertion mechanism is similar to
…		…
899		1086
900	=over 4	1087	=over 4
901		1088
902	=item B<Selection>:	1089	=item B<Selection>:
903		1090
904	Left click at the beginning of the region, drag to the end of the	1091	Left click at the beginning of the region, drag to the end of the region
905	region and release; Right click to extend the marked region; Left	1092	and release; Right click to extend the marked region; Left double-click
906	double-click to select a word; Left triple-click to select the entire	1093	to select a word; Left triple-click to select the entire logical line
907	line.	1094	(which can span multiple screen lines), unless modified by resource
		1095	B<tripleclickwords>.
908		1096
909	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1097	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
910	(Compile: I<frills>) will create a rectangular selection instead of a normal	1098	(Compile: I<frills>) will create a rectangular selection instead of a
911	one.	1099	normal one. In this mode, every selected row becomes its own line in the
		1100	selection, and trailing whitespace is visually underlined and removed from
		1101	the selection.
912		1102
913	=item B<Insertion>:	1103	=item B<Insertion>:
914		1104
915	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1105	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
916	an B<@@RXVT_NAME@@> window causes the current text selection to be	1106	an B<@@RXVT_NAME@@> window causes the current text selection to be
…		…
924	supported in rxvt-unicode. Bug me if you need this.	1114	supported in rxvt-unicode. Bug me if you need this.
925		1115
926	You can, however, switch fonts at runtime using escape sequences (and	1116	You can, however, switch fonts at runtime using escape sequences (and
927	therefore using the menubar), e.g.:	1117	therefore using the menubar), e.g.:
928		1118
929	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1119	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
930		1120
931	rxvt-unicode will automatically re-apply these fonts to the output so far.	1121	rxvt-unicode will automatically re-apply these fonts to the output so far.
932		1122
933	=head1 ISO 14755 SUPPORT	1123	=head1 ISO 14755 SUPPORT
934		1124
…		…
938	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1128	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
939	with C<--enable-iso14755>.	1129	with C<--enable-iso14755>.
940		1130
941	=over 4	1131	=over 4
942		1132
943	=item 5.1: Basic method	1133	=item * 5.1: Basic method
944		1134
945	This allows you to enter unicode characters using their hexcode.	1135	This allows you to enter unicode characters using their hexcode.
946		1136
947	Start by pressing and holding both C<Control> and C<Shift>, then enter	1137	Start by pressing and holding both C<Control> and C<Shift>, then enter
948	hex-digits (between one and six). Releasing C<Control> and C<Shift> will	1138	hex-digits (between one and six). Releasing C<Control> and C<Shift> will
…		…
955	address, which you cannot type. Fortunately, the card has the e-mail	1145	address, which you cannot type. Fortunately, the card has the e-mail
956	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily	1146	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
957	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,	1147	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
958	followed by releasing the modifier keys.	1148	followed by releasing the modifier keys.
959		1149
960	=item 5.2: Keyboard symbols entry method	1150	=item * 5.2: Keyboard symbols entry method
961		1151
962	This mode lets you input characters representing the keycap symbols of	1152	This mode lets you input characters representing the keycap symbols of
963	your keyboard, if representable in the current locale encoding.	1153	your keyboard, if representable in the current locale encoding.
964		1154
965	Start by pressing C<Control> and C<Shift> together, then releasing	1155	Start by pressing C<Control> and C<Shift> together, then releasing
…		…
968	keycap symbol. The symbol will only be entered when the key has been	1158	keycap symbol. The symbol will only be entered when the key has been
969	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1159	released, otherwise pressing e.g. C<Shift> would enter the symbol for
970	C<ISO Level 2 Switch>, although your intention might have been to enter a	1160	C<ISO Level 2 Switch>, although your intention might have been to enter a
971	reverse tab (Shift-Tab).	1161	reverse tab (Shift-Tab).
972		1162
973	=item 5.3: Screen-selection entry method	1163	=item * 5.3: Screen-selection entry method
974		1164
975	While this is implemented already (it's basically the selection	1165	While this is implemented already (it's basically the selection
976	mechanism), it could be extended by displaying a unicode character map.	1166	mechanism), it could be extended by displaying a unicode character map.
977		1167
978	=item 5.4: Feedback method for identifying displayed characters for later input	1168	=item * 5.4: Feedback method for identifying displayed characters for later input
979		1169
980	This method lets you display the unicode character code associated with	1170	This method lets you display the unicode character code associated with
981	characters already displayed.	1171	characters already displayed.
982		1172
983	You enter this mode by holding down C<Control> and C<Shift> together, then	1173	You enter this mode by holding down C<Control> and C<Shift> together, then
…		…
995	With respect to conformance, rxvt-unicode is supposed to be compliant to	1185	With respect to conformance, rxvt-unicode is supposed to be compliant to
996	both scenario A and B of ISO 14755, including part 5.2.	1186	both scenario A and B of ISO 14755, including part 5.2.
997		1187
998	=head1 LOGIN STAMP	1188	=head1 LOGIN STAMP
999		1189
1000	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so	1190	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1001	that it can be seen via the I<who(1)> command, and can accept messages.	1191	it can be seen via the I<who(1)> command, and can accept messages. To
1002	To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on	1192	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1003	some systems.	1193	on some systems or setgid to root or to some other group on others.
1004		1194
1005	=head1 COLORS AND GRAPHICS	1195	=head1 COLORS AND GRAPHICS
1006		1196
1007	In addition to the default foreground and background colours,	1197	In addition to the default foreground and background colours,
1008	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1198	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
…		…
1051		1241
1052	=back	1242	=back
1053		1243
1054	=head1 ENVIRONMENT	1244	=head1 ENVIRONMENT
1055		1245
1056	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>	1246	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1057	and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X	1247
1058	window id number of the B<@@RXVT_NAME@@> window and it also uses and	1248	=over 4
1059	sets the environment variable B<DISPLAY> to specify which display	1249
1060	terminal to use. B<@@RXVT_NAME@@> uses the environment variables	1250	=item B<TERM>
1061	B<RXVTPATH> and B<PATH> to find XPM files.	1251
		1252	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
		1253	resources or on the commandline.
		1254
		1255	=item B<COLORTERM>
		1256
		1257	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
		1258	compiled with XPM support, and optionally with the added extension
		1259	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
		1260
		1261	=item B<COLORFGBG>
		1262
		1263	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
		1264	the colour code used as default foreground/text colour (or the string
		1265	C<default> to indicate that the default-colour escape sequence is to be
		1266	used), C<bg> is the colour code used as default background colour (or the
		1267	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1268	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
		1269	(and do) use this information to optimize screen output.
		1270
		1271	=item B<WINDOWID>
		1272
		1273	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
		1274	window, which usually has subwindows for the scrollbar, the terminal
		1275	window and so on).
		1276
		1277	=item B<TERMINFO>
		1278
		1279	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1280	C<--with-terminfo=PATH>.
		1281
		1282	=item B<DISPLAY>
		1283
		1284	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
		1285	display in it's child processes.
		1286
		1287	=item B<SHELL>
		1288
		1289	The shell to be used for command execution, defaults to C</bin/sh>.
		1290
		1291	=item B<RXVTPATH>
		1292
		1293	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
		1294	files.
		1295
		1296	=item B<PATH>
		1297
		1298	Used in the same way as C<RXVTPATH>.
		1299
		1300	=item B<RXVT_SOCKET>
		1301
		1302	The unix domain socket path used by @@RXVT_NAME@@c(1) and
		1303	@@RXVT_NAME@@d(1).
		1304
		1305	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
		1306
		1307	=item B<HOME>
		1308
		1309	Used to locate the default directory for the unix domain socket for
		1310	daemon communications and to locate various resource files (such as
		1311	C<.Xdefaults>)
		1312
		1313	=item B<XAPPLRESDIR>
		1314
		1315	Directory where various X resource files are being located.
		1316
		1317	=item B<XENVIRONMENT>
		1318
		1319	If set and accessible, gives the name of a X resource file to be loaded by
		1320	@@RXVT_NAME@@.
		1321
		1322	=back
1062		1323
1063	=head1 FILES	1324	=head1 FILES
1064		1325
1065	=over 4	1326	=over 4
1066		1327
1067	=item B</etc/utmp>
1068
1069	System file for login records.
1070
1071	=item B</usr/lib/X11/rgb.txt>	1328	=item B</usr/lib/X11/rgb.txt>
1072		1329
1073	Color names.	1330	Color names.
1074		1331
1075	=back	1332	=back
1076		1333
1077	=head1 SEE ALSO	1334	=head1 SEE ALSO
1078		1335
1079	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1336	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1080
1081	=head1 BUGS
1082
1083	Check the BUGS file for an up-to-date list.
1084
1085	Cursor change support is not yet implemented.
1086
1087	Click-and-drag doesn't work with X11 mouse report overriding.
1088		1337
1089	=head1 CURRENT PROJECT COORDINATOR	1338	=head1 CURRENT PROJECT COORDINATOR
1090		1339
1091	=over 4	1340	=over 4
1092		1341
1093	=item Project Coordinator	1342	=item Project Coordinator
1094		1343
1095	@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@>	1344	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1096		1345
1097	=item Web page maintainter	1346	L<http://software.schmorp.de/#rxvt-unicode>
1098
1099	@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1100
1101	L<@@RXVT_WEBPAGE@@>
1102		1347
1103	=back	1348	=back
1104		1349
1105	=head1 AUTHORS	1350	=head1 AUTHORS
1106		1351
…		…
1131	=item Geoff Wing L<< <gcw@pobox.com> >>	1376	=item Geoff Wing L<< <gcw@pobox.com> >>
1132		1377
1133	Rewrote screen display and text selection routines. Project Coordinator	1378	Rewrote screen display and text selection routines. Project Coordinator
1134	(changes.txt 2.4.6 - rxvt-unicode)	1379	(changes.txt 2.4.6 - rxvt-unicode)
1135		1380
1136	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>	1381	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1137		1382
1138	Forked rxvt-unicode, rewrote most of the display code and internal	1383	Forked rxvt-unicode, rewrote most of the display code and internal
1139	character handling to store text in unicode, improve xterm	1384	character handling to store text in unicode, improve xterm
1140	compatibility and apply numerous other bugfixes and extensions.	1385	compatibility and apply numerous other bugfixes and extensions.
1141		1386

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.43 by root, Sun Jan 16 19:22:16 2005 UTC vs. Revision 1.76 by root, Sat Dec 31 16:06:48 2005 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.43 by root, Sun Jan 16 19:22:16 2005 UTC vs.
Revision 1.76 by root, Sat Dec 31 16:06:48 2005 UTC