[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.75 by root, Tue Dec 27 01:50:00 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
…		…
236		248
237	Put scrollbar on right/left; resource B<scrollBar_right>.	249	Put scrollbar on right/left; resource B<scrollBar_right>.
238		250
239	=item B<-st>\|B<+st>	251	=item B<-st>\|B<+st>
240		252
241	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	253	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
242	resource B<scrollBar_floating>.	254	resource B<scrollBar_floating>.
243		255
244	=item B<-ptab>\|B<+ptab>	256	=item B<-ptab>\|B<+ptab>
245		257
246	If enabled (default), "Horizontal Tab" characters are being stored as	258	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	313	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	314	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,	315	run the program specified by the B<SHELL> environment variable or,
304	failing that, I<sh(1)>.	316	failing that, I<sh(1)>.
305		317
		318	Please note that you must specify a program with arguments. If you want to
		319	run shell commands, you have to specify the shell, like this:
		320
		321	@@RXVT_NAME@@ -e sh -c "shell commands"
		322
306	=item B<-title> I<text>	323	=item B<-title> I<text>
307		324
308	Window title (B<-T> still respected); the default title is the basename	325	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	326	of the program specified after the B<-e> option, if any, otherwise the
310	application name; resource B<title>.	327	application name; resource B<title>.
…		…
328		345
329	Compile I<XIM>: input method name. resource B<inputMethod>.	346	Compile I<XIM>: input method name. resource B<inputMethod>.
330		347
331	=item B<-imlocale> I<string>	348	=item B<-imlocale> I<string>
332		349
333	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	350	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	351	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	352	input extension to be able to input japanese characters while staying in
336	another locale.	353	another locale. resource B<imLocale>.
		354
		355	=item B<-imfont> I<fontset>
		356
		357	Set the font set to use for the X Input Method, see resource B<imFont>
		358	for more info.
		359
		360	=item B<-tcw>
		361
		362	Change the meaning of triple-click selection with the left mouse
		363	button. Instead of selecting a full line it will extend the selection the
		364	end of the logical line only. resource B<tripleclickwords>.
337		365
338	=item B<-insecure>	366	=item B<-insecure>
339		367
340	Enable "insecure" mode, which currently enables most of the escape	368	Enable "insecure" mode, which currently enables most of the escape
341	sequences that echo strings. See the resource B<insecure> for more	369	sequences that echo strings. See the resource B<insecure> for more
…		…
355	=item B<-ssr>\|B<+ssr>	383	=item B<-ssr>\|B<+ssr>
356		384
357	Turn on/off secondary screen scroll (default enabled); resource	385	Turn on/off secondary screen scroll (default enabled); resource
358	B<secondaryScroll>.	386	B<secondaryScroll>.
359		387
360	=item B<-xrm> I<resourcestring>	388	=item B<-hold>\|B<+hold>
361		389
362	No effect on rxvt-unicode. Simply passes through an argument to be made	390	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	391	will not immediately destroy its window when the program executed within
364	some window managers.	392	it exits. Instead, it will wait till it is being killed or closed by the
		393	user; resource B<hold>.
		394
		395	=item B<-keysym.>I<sym> I<string>
		396
		397	Remap a key symbol. See resource B<keysym>.
		398
		399	=item B<-embed> I<windowid>
		400
		401	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
		402	which enables applications to easily embed a terminal.
		403
		404	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
		405	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
		406	quite a bit, so don't expect it to keep some specific state. It's best to
		407	create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
		408
		409	The window will not be destroyed when @@RXVT_NAME@@ exits.
		410
		411	It might be useful to know that @@RXVT_NAME@@ will not close file
		412	descriptors passed to it (except for stdin/out/err, of course), so you
		413	can use file descriptors to communicate with the programs within the
		414	terminal. This works regardless of wether the C<-embed> option was used or
		415	not.
		416
		417	Here is a short Gtk2-perl snippet that illustrates how this option can be
		418	used (a longer example is in F<doc/embed>):
		419
		420	my $rxvt = new Gtk2::Socket;
		421	$rxvt->signal_connect_after (realize => sub {
		422	my $xid = $_[0]->window->get_xid;
		423	system "@@RXVT_NAME@@ -embed $xid &";
		424	});
		425
		426	=item B<-pty-fd> I<fileno>
		427
		428	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
		429	pair but instead use the given filehandle as the tty master. This is
		430	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
		431	without having to run a program within it.
		432
		433	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
		434	entries and will not tinker with pty/tty permissions - you have to do that
		435	yourself if you want that.
		436
		437	Here is a example in perl that illustrates how this option can be used (a
		438	longer example is in F<doc/pty-fd>):
		439
		440	use IO::Pty;
		441	use Fcntl;
		442
		443	my $pty = new IO::Pty;
		444	fcntl $pty, F_SETFD, 0; # clear close-on-exec
		445	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		446	close $pty;
		447
		448	# now communicate with rxvt
		449	my $slave = $pty->slave;
		450	while (<$slave>) { print $slave "got <$_>\n" }
365		451
366	=back	452	=back
367		453
368	=head1 RESOURCES (available also as long-options)	454	=head1 RESOURCES (available also as long-options)
369		455
…		…
372		458
373	There are two different methods that @@RXVT_NAME@@ can use to get the	459	There are two different methods that @@RXVT_NAME@@ can use to get the
374	Xresource data: using the X libraries (Xrm*-functions) or internal	460	Xresource data: using the X libraries (Xrm*-functions) or internal
375	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	461	Xresources reader (B<~/.Xdefaults>). For the first method (ie.
376	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	462	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	463	resources using X11 tools like B<xrdb>. Many distribution do also load
378	settings from the B<~/.Xresources> file when X starts.	464	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
		465	will consult the following files/resources in order, with later settings
		466	overwriting earlier ones:
		467
		468	1. system-wide app-defaults file, either locale-dependent OR global
		469	2. app-defaults file in $XAPPLRESDIR
		470	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
		471	4. SCREEN_RESOURCES for the current screen
		472	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
379		473
380	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>	474	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
381	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults	475	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
382	set in XAPPLOADDIR/URxvt (compile-time defined: usually	476	set in XAPPLOADDIR/URxvt (compile-time defined: usually
383	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	477	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
…		…
476	artificial transparency. B<False>: do not inherit the parent windows'	570	artificial transparency. B<False>: do not inherit the parent windows'
477	pixmap.	571	pixmap.
478		572
479	=item B<fading:> I<number>	573	=item B<fading:> I<number>
480		574
481	Fade the text by the given percentage when focus is lost.	575	Fade the text by the given percentage when focus is lost; option B<-fade>.
		576
		577	=item B<fadeColor:> I<colour>
		578
		579	Fade to this colour, when fading is used (see B<fading:>). The default
		580	colour is black; option B<-fadecolor>.
482		581
483	=item B<tintColor:> I<colour>	582	=item B<tintColor:> I<colour>
484		583
485	Tint the transparent background pixmap with the given colour.	584	Tint the transparent background pixmap with the given colour; option
		585	B<-tint>.
486		586
487	=item B<shading:> I<number>	587	=item B<shading:> I<number>
488		588
489	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	589	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
490	image in addition to tinting it.	590	image in addition to tinting it.
…		…
494	Use the specified colour for the scrollbar [default #B2B2B2].	594	Use the specified colour for the scrollbar [default #B2B2B2].
495		595
496	=item B<troughColor:> I<colour>	596	=item B<troughColor:> I<colour>
497		597
498	Use the specified colour for the scrollbar's trough area [default	598	Use the specified colour for the scrollbar's trough area [default
499	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	599	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
500		600
501	=item B<borderColor:> I<colour>	601	=item B<borderColor:> I<colour>
502		602
503	The colour of the border around the text area and between the scrollbar	603	The colour of the border around the text area and between the scrollbar
504	and the text.	604	and the text.
…		…
596	xterm style selection.	696	xterm style selection.
597		697
598	=item B<scrollstyle:> I<mode>	698	=item B<scrollstyle:> I<mode>
599		699
600	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	700	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
601	the author's favourite..	701	the author's favourite.
602		702
603	=item B<title:> I<string>	703	=item B<title:> I<string>
604		704
605	Set window title string, the default title is the command-line	705	Set window title string, the default title is the command-line
606	specified after the B<-e> option, if any, otherwise the application	706	specified after the B<-e> option, if any, otherwise the application
…		…
638		738
639	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	739	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	740	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.	741	B<Shift-Print> to include the scrollback as well.
642		742
		743	The string will be interpreted as if typed into the shell as-is.
		744
		745	Example:
		746
		747	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		748
		749	This creates a new file in your home directory with the screen contents
		750	everytime you hit C<Print>.
		751
643	=item B<scrollBar:> I<boolean>	752	=item B<scrollBar:> I<boolean>
644		753
645	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	754	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
646	disable the scrollbar; option B<+sb>.	755	disable the scrollbar; option B<+sb>.
647		756
…		…
667	B<+si>.	776	B<+si>.
668		777
669	=item B<scrollWithBuffer:> I<boolean>	778	=item B<scrollWithBuffer:> I<boolean>
670		779
671	B<True>: scroll with scrollback buffer when tty receives new lines (and	780	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	781	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
673	with scrollback buffer when tty recieves new lines; option B<-sw>.	782	with scrollback buffer when tty recieves new lines; option B<+sw>.
674		783
675	=item B<scrollTtyKeypress:> I<boolean>	784	=item B<scrollTtyKeypress:> I<boolean>
676		785
677	B<True>: scroll to bottom when a non-special key is pressed. Special keys	786	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	787	are those which are intercepted by rxvt-unicode for special handling and
…		…
743		852
744	Mouse pointer background colour.	853	Mouse pointer background colour.
745		854
746	=item B<pointerBlankDelay:> I<number>	855	=item B<pointerBlankDelay:> I<number>
747		856
748	Specifies number of seconds before blanking the pointer [default 2].	857	Specifies number of seconds before blanking the pointer [default 2]. Use a
		858	large number (e.g. C<987654321>) to effectively disable the timeout.
749		859
750	=item B<backspacekey:> I<string>	860	=item B<backspacekey:> I<string>
751		861
752	The string to send when the backspace key is pressed. If set to B<DEC>	862	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>	863	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
…		…
775		885
776	I<name> of inputMethod to use; option B<-im>.	886	I<name> of inputMethod to use; option B<-im>.
777		887
778	=item B<imLocale:> I<name>	888	=item B<imLocale:> I<name>
779		889
780	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	890	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	891	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	892	input extension to be able to input japanese characters while staying in
783	another locale. option B<-imlocale>.	893	another locale. option B<-imlocale>.
		894
		895	=item B<imFont:> I<fontset>
		896
		897	Specify the font-set used for XIM styles C<OverTheSpot> or
		898	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
		899	by commas), i.e. it's not in the same format as the other font lists used
		900	in @@RXVT_NAME@@. The default will be set-up to chose any suitable found
		901	found, preferably one or two pixels differing in size to the base font.
		902	option B<-imfont>.
		903
		904	=item B<tripleclickwords:> I<boolean>
		905
		906	Change the meaning of triple-click selection with the left mouse
		907	button. Instead of selecting a full line it will extend the selection to
		908	the end of the logical line only. option B<-tcw>.
784		909
785	=item B<insecure:> I<boolean>	910	=item B<insecure:> I<boolean>
786		911
787	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	912	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
788	echo arbitrary strings like the icon name or the locale. This could be	913	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	914	abused if somebody gets 8-bit-clean access to your display, whether
790	throuh a mail client displaying mail bodies unfiltered or though	915	through a mail client displaying mail bodies unfiltered or through
791	write(1). Therefore, these sequences are disabled by default. (Note	916	write(1) or any other means. Therefore, these sequences are disabled by
792	that other terminals, including xterm, have these sequences	917	default. (Note that many other terminals, including xterm, have these
793	enabled by default). You can enable them by setting this boolean	918	sequences enabled by default, which doesn't make it safer, though).
794	resource or specifying B<-insecure> as an option. At the moment, this	919
795	enabled display-answer, locale, findfont, icon label and window title	920	You can enable them by setting this boolean resource or specifying
796	requests as well as dynamic menubar dispatch.	921	B<-insecure> as an option. At the moment, this enables display-answer,
		922	locale, findfont, icon label and window title requests as well as dynamic
		923	menubar dispatch.
797		924
798	=item B<modifier:> I<modifier>	925	=item B<modifier:> I<modifier>
799		926
800	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	927	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	928	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
815		942
816	Turn on/off secondary screen scroll (default enabled). If the this	943	Turn on/off secondary screen scroll (default enabled). If the this
817	option is enabled, scrolls on the secondary screen will change the	944	option is enabled, scrolls on the secondary screen will change the
818	scrollback buffer and switching to/from the secondary screen will	945	scrollback buffer and switching to/from the secondary screen will
819	instead scroll the screen up.	946	instead scroll the screen up.
		947
		948	=item B<hold>: I<bool>
		949
		950	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		951	will not immediately destroy its window when the program executed within
		952	it exits. Instead, it will wait till it is being killed or closed by the
		953	user.
820		954
821	=item B<keysym.>I<sym>: I<string>	955	=item B<keysym.>I<sym>: I<string>
822		956
823	Compile I<frills>: Associate I<string> with keysym I<sym>. The	957	Compile I<frills>: Associate I<string> with keysym I<sym>. The
824	intervening resource name B<keysym.> cannot be omitted.	958	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>,	963	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>.	964	B<2>, B<3>, B<4>, B<5>.
831		965
832	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to	966	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	967	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	968	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
835	current application keymap mode state.	969	current application keymap mode state.
836		970
837	The spellings of I<key> can be obtained by using B<xev>(1) command or	971	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	972	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	973	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,	978	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,	979	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	980	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
847	can start or end with whitespace.	981	can start or end with whitespace.
848		982
		983	Please note that you need to double the C<\> when using
		984	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
		985	use C<\033> instead of C<\e> (and so on), which will work with both Xt and
		986	@@RXVT_NAME@@'s own processing).
		987
849	You can define a range of keysyms in one shot by providing a I<string>	988	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 `/'	989	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
851	should be a character not used by the strings.	990	should be a character not used by the strings.
852		991
853	Its usage can be demonstrated by an example:	992	Its usage can be demonstrated by an example:
854		993
855	URxvt.keysym.M-C-0x61: list\|\e<M-C-\|abc\|>	994	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
856		995
857	The above line is equivalent to the following three lines:	996	The above line is equivalent to the following three lines:
858		997
859	URxvt.keysym.Meta-Control-0x61: \e<M-C-a>	998	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
860	URxvt.keysym.Meta-Control-0x62: \e<M-C-b>	999	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
861	URxvt.keysym.Meta-Control-0x63: \e<M-C-c>	1000	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
862		1001
863	If I<string> takes the form of C<proto:STRING>, the specified B<STRING> is	1002	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,	1003	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	1004	example the following means "change the current locale to C<zh_CN.GBK>
866	C<zh_CN.GBK>.	1005	when Control-Meta-c is being pressed":
		1006
		1007	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		1008
		1009	Due the the large number of modifier combinations, a defined key mapping
		1010	will match if at I<at least> the specified identifiers are being set, and
		1011	no other key mappings with those and more bits are being defined. That
		1012	means that defining a key map for C<a> will automatically provide
		1013	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		1014	mappings themselves.
		1015
		1016	Unfortunately, this will override built-in key mappings. For example
		1017	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		1018	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		1019	user-defined keymap using the C<builtin:> replacement:
		1020
		1021	URxvt.keysym.Insert: <my insert key sequence>
		1022	URxvt.keysym.S-Insert: builtin:
		1023
		1024	The first line defines a mapping for C<Insert> and I<any> combination
		1025	of modifiers. The second line re-establishes the default mapping for
		1026	C<Shift-Insert>.
		1027
		1028	The following example will map Control-Meta-1 and Control-Meta-2 to
		1029	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
		1030	font-switching at runtime:
		1031
		1032	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1033	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
		1034
		1035	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
		1036	info):
		1037
		1038	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1039	URxvt.keysym.M-C-4: command:\033[8;48;110t
867		1040
868	=back	1041	=back
869		1042
870	=head1 THE SCROLLBAR	1043	=head1 THE SCROLLBAR
871		1044
…		…
885	the normal text selection/insertion, hold either the Shift or the Meta	1058	the normal text selection/insertion, hold either the Shift or the Meta
886	(Alt) key while performing the desired mouse action.	1059	(Alt) key while performing the desired mouse action.
887		1060
888	If mouse reporting mode is active, the normal scrollbar actions are	1061	If mouse reporting mode is active, the normal scrollbar actions are
889	disabled -- on the assumption that we are using a fullscreen	1062	disabled -- on the assumption that we are using a fullscreen
890	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	1063	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
891	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	1064	(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),	1065	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
893	respectively.	1066	respectively.
894		1067
895	=head1 TEXT SELECTION AND INSERTION	1068	=head1 TEXT SELECTION AND INSERTION
896		1069
897	The behaviour of text selection and insertion mechanism is similar to	1070	The behaviour of text selection and insertion mechanism is similar to
…		…
899		1072
900	=over 4	1073	=over 4
901		1074
902	=item B<Selection>:	1075	=item B<Selection>:
903		1076
904	Left click at the beginning of the region, drag to the end of the	1077	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	1078	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	1079	to select a word; Left triple-click to select the entire logical line
907	line.	1080	(which can span multiple screen lines), unless modified by resource
		1081	B<tripleclickwords>.
908		1082
909	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1083	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	1084	(Compile: I<frills>) will create a rectangular selection instead of a
911	one.	1085	normal one. In this mode, every selected row becomes its own line in the
		1086	selection, and trailing whitespace is visually underlined and removed from
		1087	the selection.
912		1088
913	=item B<Insertion>:	1089	=item B<Insertion>:
914		1090
915	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1091	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	1092	an B<@@RXVT_NAME@@> window causes the current text selection to be
…		…
924	supported in rxvt-unicode. Bug me if you need this.	1100	supported in rxvt-unicode. Bug me if you need this.
925		1101
926	You can, however, switch fonts at runtime using escape sequences (and	1102	You can, however, switch fonts at runtime using escape sequences (and
927	therefore using the menubar), e.g.:	1103	therefore using the menubar), e.g.:
928		1104
929	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1105	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
930		1106
931	rxvt-unicode will automatically re-apply these fonts to the output so far.	1107	rxvt-unicode will automatically re-apply these fonts to the output so far.
932		1108
933	=head1 ISO 14755 SUPPORT	1109	=head1 ISO 14755 SUPPORT
934		1110
…		…
938	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1114	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
939	with C<--enable-iso14755>.	1115	with C<--enable-iso14755>.
940		1116
941	=over 4	1117	=over 4
942		1118
943	=item 5.1: Basic method	1119	=item * 5.1: Basic method
944		1120
945	This allows you to enter unicode characters using their hexcode.	1121	This allows you to enter unicode characters using their hexcode.
946		1122
947	Start by pressing and holding both C<Control> and C<Shift>, then enter	1123	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	1124	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	1131	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	1132	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>,	1133	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.	1134	followed by releasing the modifier keys.
959		1135
960	=item 5.2: Keyboard symbols entry method	1136	=item * 5.2: Keyboard symbols entry method
961		1137
962	This mode lets you input characters representing the keycap symbols of	1138	This mode lets you input characters representing the keycap symbols of
963	your keyboard, if representable in the current locale encoding.	1139	your keyboard, if representable in the current locale encoding.
964		1140
965	Start by pressing C<Control> and C<Shift> together, then releasing	1141	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	1144	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	1145	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	1146	C<ISO Level 2 Switch>, although your intention might have been to enter a
971	reverse tab (Shift-Tab).	1147	reverse tab (Shift-Tab).
972		1148
973	=item 5.3: Screen-selection entry method	1149	=item * 5.3: Screen-selection entry method
974		1150
975	While this is implemented already (it's basically the selection	1151	While this is implemented already (it's basically the selection
976	mechanism), it could be extended by displaying a unicode character map.	1152	mechanism), it could be extended by displaying a unicode character map.
977		1153
978	=item 5.4: Feedback method for identifying displayed characters for later input	1154	=item * 5.4: Feedback method for identifying displayed characters for later input
979		1155
980	This method lets you display the unicode character code associated with	1156	This method lets you display the unicode character code associated with
981	characters already displayed.	1157	characters already displayed.
982		1158
983	You enter this mode by holding down C<Control> and C<Shift> together, then	1159	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	1171	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.	1172	both scenario A and B of ISO 14755, including part 5.2.
997		1173
998	=head1 LOGIN STAMP	1174	=head1 LOGIN STAMP
999		1175
1000	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so	1176	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.	1177	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	1178	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1003	some systems.	1179	on some systems or setgid to root or to some other group on others.
1004		1180
1005	=head1 COLORS AND GRAPHICS	1181	=head1 COLORS AND GRAPHICS
1006		1182
1007	In addition to the default foreground and background colours,	1183	In addition to the default foreground and background colours,
1008	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1184	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
…		…
1051		1227
1052	=back	1228	=back
1053		1229
1054	=head1 ENVIRONMENT	1230	=head1 ENVIRONMENT
1055		1231
1056	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>	1232	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	1233
1058	window id number of the B<@@RXVT_NAME@@> window and it also uses and	1234	=over 4
1059	sets the environment variable B<DISPLAY> to specify which display	1235
1060	terminal to use. B<@@RXVT_NAME@@> uses the environment variables	1236	=item B<TERM>
1061	B<RXVTPATH> and B<PATH> to find XPM files.	1237
		1238	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
		1239	resources or on the commandline.
		1240
		1241	=item B<COLORTERM>
		1242
		1243	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
		1244	compiled with XPM support, and optionally with the added extension
		1245	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
		1246
		1247	=item B<COLORFGBG>
		1248
		1249	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
		1250	the colour code used as default foreground/text colour (or the string
		1251	C<default> to indicate that the default-colour escape sequence is to be
		1252	used), C<bg> is the colour code used as default background colour (or the
		1253	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1254	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
		1255	(and do) use this information to optimize screen output.
		1256
		1257	=item B<WINDOWID>
		1258
		1259	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
		1260	window, which usually has subwindows for the scrollbar, the terminal
		1261	window and so on).
		1262
		1263	=item B<TERMINFO>
		1264
		1265	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1266	C<--with-terminfo=PATH>.
		1267
		1268	=item B<DISPLAY>
		1269
		1270	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
		1271	display in it's child processes.
		1272
		1273	=item B<SHELL>
		1274
		1275	The shell to be used for command execution, defaults to C</bin/sh>.
		1276
		1277	=item B<RXVTPATH>
		1278
		1279	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
		1280	files.
		1281
		1282	=item B<PATH>
		1283
		1284	Used in the same way as C<RXVTPATH>.
		1285
		1286	=item B<RXVT_SOCKET>
		1287
		1288	The unix domain socket path used by @@RXVT_NAME@@c(1) and
		1289	@@RXVT_NAME@@d(1).
		1290
		1291	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
		1292
		1293	=item B<HOME>
		1294
		1295	Used to locate the default directory for the unix domain socket for
		1296	daemon communications and to locate various resource files (such as
		1297	C<.Xdefaults>)
		1298
		1299	=item B<XAPPLRESDIR>
		1300
		1301	Directory where various X resource files are being located.
		1302
		1303	=item B<XENVIRONMENT>
		1304
		1305	If set and accessible, gives the name of a X resource file to be loaded by
		1306	@@RXVT_NAME@@.
		1307
		1308	=back
1062		1309
1063	=head1 FILES	1310	=head1 FILES
1064		1311
1065	=over 4	1312	=over 4
1066		1313
1067	=item B</etc/utmp>
1068
1069	System file for login records.
1070
1071	=item B</usr/lib/X11/rgb.txt>	1314	=item B</usr/lib/X11/rgb.txt>
1072		1315
1073	Color names.	1316	Color names.
1074		1317
1075	=back	1318	=back
1076		1319
1077	=head1 SEE ALSO	1320	=head1 SEE ALSO
1078		1321
1079	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1322	@@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		1323
1089	=head1 CURRENT PROJECT COORDINATOR	1324	=head1 CURRENT PROJECT COORDINATOR
1090		1325
1091	=over 4	1326	=over 4
1092		1327
1093	=item Project Coordinator	1328	=item Project Coordinator
1094		1329
1095	@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@>	1330	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1096		1331
1097	=item Web page maintainter	1332	L<http://software.schmorp.de/#rxvt-unicode>
1098
1099	@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1100
1101	L<@@RXVT_WEBPAGE@@>
1102		1333
1103	=back	1334	=back
1104		1335
1105	=head1 AUTHORS	1336	=head1 AUTHORS
1106		1337
…		…
1131	=item Geoff Wing L<< <gcw@pobox.com> >>	1362	=item Geoff Wing L<< <gcw@pobox.com> >>
1132		1363
1133	Rewrote screen display and text selection routines. Project Coordinator	1364	Rewrote screen display and text selection routines. Project Coordinator
1134	(changes.txt 2.4.6 - rxvt-unicode)	1365	(changes.txt 2.4.6 - rxvt-unicode)
1135		1366
1136	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>	1367	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1137		1368
1138	Forked rxvt-unicode, rewrote most of the display code and internal	1369	Forked rxvt-unicode, rewrote most of the display code and internal
1139	character handling to store text in unicode, improve xterm	1370	character handling to store text in unicode, improve xterm
1140	compatibility and apply numerous other bugfixes and extensions.	1371	compatibility and apply numerous other bugfixes and extensions.
1141		1372

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.75 by root, Tue Dec 27 01:50:00 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.75 by root, Tue Dec 27 01:50:00 2005 UTC