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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.36 by root, Wed Dec 15 05:10:57 2004 UTC vs.
Revision 1.73 by root, Thu Dec 15 18:14:08 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.	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
…		…
136	Window foreground colour; resource B<foreground>.	148	Window foreground colour; resource B<foreground>.
137		149
138	=item B<-pixmap> I<file[;geom]>	150	=item B<-pixmap> I<file[;geom]>
139		151
140	Compile I<XPM>: Specify XPM file for the background and also optionally	152	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	153	specify its scaling with a geometry string. Note you may need to
142	quotes to avoid special shell interpretation of the `;' in the	154	add quotes to avoid special shell interpretation of the C<;> in the
143	command-line; resource B<backgroundPixmap>.	155	command-line; resource B<backgroundPixmap>.
144		156
145	=item B<-cr> I<colour>	157	=item B<-cr> I<colour>
146		158
147	The cursor colour; resource B<cursorColor>.	159	The cursor colour; resource B<cursorColor>.
…		…
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
…		…
280	if honoured by the WM, the rxvt-unicode window will not have window	292	if honoured by the WM, the rxvt-unicode window will not have window
281	decorations; resource B<borderLess>.	293	decorations; resource B<borderLess>.
282		294
283	=item B<-lsp> I<number>	295	=item B<-lsp> I<number>
284		296
285	Compile I<linespace>: Lines (pixel height) to insert between each row	297	Compile I<frills>: Lines (pixel height) to insert between each row of
286	of the display; resource B<linespace>.	298	the display. Useful to work around font rendering problems; resource
		299	B<linespace>.
287		300
288	=item B<-tn> I<termname>	301	=item B<-tn> I<termname>
289		302
290	This option specifies the name of the terminal type to be set in the	303	This option specifies the name of the terminal type to be set in the
291	B<TERM> environment variable. This terminal type must exist in the	304	B<TERM> environment variable. This terminal type must exist in the
…		…
327		340
328	Compile I<XIM>: input method name. resource B<inputMethod>.	341	Compile I<XIM>: input method name. resource B<inputMethod>.
329		342
330	=item B<-imlocale> I<string>	343	=item B<-imlocale> I<string>
331		344
332	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	345	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
333	de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input	346	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
334	extension to be able to input japanese characters while staying in	347	input extension to be able to input japanese characters while staying in
335	another locale.	348	another locale. resource B<imLocale>.
		349
		350	=item B<-imfont> I<fontset>
		351
		352	Set the font set to use for the X Input Method, see resource B<imFont>
		353	for more info.
		354
		355	=item B<-tcw>
		356
		357	Change the meaning of triple-click selection with the left mouse
		358	button. Instead of selecting a full line it will extend the selection the
		359	end of the logical line only. resource B<tripleclickwords>.
336		360
337	=item B<-insecure>	361	=item B<-insecure>
338		362
339	Enable "insecure" mode, which currently enables most of the escape	363	Enable "insecure" mode, which currently enables most of the escape
340	sequences that echo strings. See the resource B<insecure> for more	364	sequences that echo strings. See the resource B<insecure> for more
…		…
354	=item B<-ssr>\|B<+ssr>	378	=item B<-ssr>\|B<+ssr>
355		379
356	Turn on/off secondary screen scroll (default enabled); resource	380	Turn on/off secondary screen scroll (default enabled); resource
357	B<secondaryScroll>.	381	B<secondaryScroll>.
358		382
359	=item B<-xrm> I<resourcestring>	383	=item B<-keysym.>I<sym> I<string>
360		384
361	No effect on rxvt-unicode. Simply passes through an argument to be made	385	Remap a key symbol. See resource B<keysym>.
362	available in the instance's argument list. Appears in I<WM_COMMAND> in	386
363	some window managers.	387	=item B<-embed> I<windowid>
		388
		389	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
		390	which enables applications to easily embed a terminal.
		391
		392	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
		393	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
		394	quite a bit, so don't expect it to keep some specific state. It's best to
		395	create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
		396
		397	The window will not be destroyed when @@RXVT_NAME@@ exits.
		398
		399	It might be useful to know that @@RXVT_NAME@@ will not close file
		400	descriptors passed to it (except for stdin/out/err, of course), so you
		401	can use file descriptors to communicate with the programs within the
		402	terminal. This works regardless of wether the C<-embed> option was used or
		403	not.
		404
		405	Here is a short Gtk2-perl snippet that illustrates how this option can be
		406	used (a longer example is in F<doc/embed>):
		407
		408	my $rxvt = new Gtk2::Socket;
		409	$rxvt->signal_connect_after (realize => sub {
		410	my $xid = $_[0]->window->get_xid;
		411	system "@@RXVT_NAME@@ -embed $xid &";
		412	});
		413
		414	=item B<-pty-fd> I<fileno>
		415
		416	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
		417	pair but instead use the given filehandle as the tty master. This is
		418	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
		419	without having to run a program within it.
		420
		421	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
		422	entries and will not tinker with pty/tty permissions - you have to do that
		423	yourself if you want that.
		424
		425	Here is a example in perl that illustrates how this option can be used (a
		426	longer example is in F<doc/pty-fd>):
		427
		428	use IO::Pty;
		429	use Fcntl;
		430
		431	my $pty = new IO::Pty;
		432	fcntl $pty, F_SETFD, 0; # clear close-on-exec
		433	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		434	close $pty;
		435
		436	# now communicate with rxvt
		437	my $slave = $pty->slave;
		438	while (<$slave>) { print $slave "got <$_>\n" }
364		439
365	=back	440	=back
366		441
367	=head1 RESOURCES (available also as long-options)	442	=head1 RESOURCES (available also as long-options)
368		443
…		…
371		446
372	There are two different methods that @@RXVT_NAME@@ can use to get the	447	There are two different methods that @@RXVT_NAME@@ can use to get the
373	Xresource data: using the X libraries (Xrm*-functions) or internal	448	Xresource data: using the X libraries (Xrm*-functions) or internal
374	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	449	Xresources reader (B<~/.Xdefaults>). For the first method (ie.
375	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	450	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the
376	resources using X11 tools like B<xset>. Many distribution do also load	451	resources using X11 tools like B<xrdb>. Many distribution do also load
377	settings from the B<~/.Xresources> file when X starts.	452	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
		453	will consult the following files/resources in order, with later settings
		454	overwriting earlier ones:
		455
		456	1. system-wide app-defaults file, either locale-dependent OR global
		457	2. app-defaults file in $XAPPLRESDIR
		458	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
		459	4. SCREEN_RESOURCES for the current screen
		460	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
378		461
379	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>	462	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
380	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults	463	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
381	set in XAPPLOADDIR/URxvt (compile-time defined: usually	464	set in XAPPLOADDIR/URxvt (compile-time defined: usually
382	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	465	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
…		…
427		510
428	=item B<colorIT:> I<colour>	511	=item B<colorIT:> I<colour>
429		512
430	Use the specified colour to display bold or italic characters when the	513	Use the specified colour to display bold or italic characters when the
431	foreground colour is the default. If font styles are not available	514	foreground colour is the default. If font styles are not available
432	(Compile styles) and this option is unset, reverse video is used instead.	515	(Compile I<styles>) and this option is unset, reverse video is used instead.
433		516
434	=item B<colorUL:> I<colour>	517	=item B<colorUL:> I<colour>
435		518
436	Use the specified colour to display underlined characters when the	519	Use the specified colour to display underlined characters when the
437	foreground colour is the default.	520	foreground colour is the default.
…		…
475	artificial transparency. B<False>: do not inherit the parent windows'	558	artificial transparency. B<False>: do not inherit the parent windows'
476	pixmap.	559	pixmap.
477		560
478	=item B<fading:> I<number>	561	=item B<fading:> I<number>
479		562
480	Fade the text by the given percentage when focus is lost.	563	Fade the text by the given percentage when focus is lost; option B<-fade>.
		564
		565	=item B<fadeColor:> I<colour>
		566
		567	Fade to this colour, when fading is used (see B<fading:>). The default
		568	colour is black; option B<-fadecolor>.
481		569
482	=item B<tintColor:> I<colour>	570	=item B<tintColor:> I<colour>
483		571
484	Tint the transparent background pixmap with the given colour.	572	Tint the transparent background pixmap with the given colour; option
		573	B<-tint>.
485		574
486	=item B<shading:> I<number>	575	=item B<shading:> I<number>
487		576
488	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	577	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
489	image in addition to tinting it.	578	image in addition to tinting it.
…		…
493	Use the specified colour for the scrollbar [default #B2B2B2].	582	Use the specified colour for the scrollbar [default #B2B2B2].
494		583
495	=item B<troughColor:> I<colour>	584	=item B<troughColor:> I<colour>
496		585
497	Use the specified colour for the scrollbar's trough area [default	586	Use the specified colour for the scrollbar's trough area [default
498	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	587	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
499		588
500	=item B<borderColor:> I<colour>	589	=item B<borderColor:> I<colour>
501		590
502	The colour of the border around the text area and between the scrollbar	591	The colour of the border around the text area and between the scrollbar
503	and the text.	592	and the text.
…		…
533	The first font defines the cell size for characters; other fonts might	622	The first font defines the cell size for characters; other fonts might
534	be smaller, but not larger. A reasonable default font list is always	623	be smaller, but not larger. A reasonable default font list is always
535	appended to it. option B<-fn>.	624	appended to it. option B<-fn>.
536		625
537	Each font can either be a standard X11 core font (XLFD) name, with	626	Each font can either be a standard X11 core font (XLFD) name, with
538	optional prefix C<x:> or a Xft font (Compile xft), prefixed with C<xft:>.	627	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
539		628
540	In addition, each font can be prefixed with additional hints and	629	In addition, each font can be prefixed with additional hints and
541	specifications enclosed in square brackets (C<[]>). The only available	630	specifications enclosed in square brackets (C<[]>). The only available
542	hint currently is C<codeset=codeset-name>, and this is only used for Xft	631	hint currently is C<codeset=codeset-name>, and this is only used for Xft
543	fonts.	632	fonts.
…		…
595	xterm style selection.	684	xterm style selection.
596		685
597	=item B<scrollstyle:> I<mode>	686	=item B<scrollstyle:> I<mode>
598		687
599	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	688	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
600	the author's favourite..	689	the author's favourite.
601		690
602	=item B<title:> I<string>	691	=item B<title:> I<string>
603		692
604	Set window title string, the default title is the command-line	693	Set window title string, the default title is the command-line
605	specified after the B<-e> option, if any, otherwise the application	694	specified after the B<-e> option, if any, otherwise the application
…		…
637		726
638	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	727	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
639	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or	728	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
640	B<Shift-Print> to include the scrollback as well.	729	B<Shift-Print> to include the scrollback as well.
641		730
		731	The string will be interpreted as if typed into the shell as-is.
		732
		733	Example:
		734
		735	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		736
		737	This creates a new file in your home directory with the screen contents
		738	everytime you hit C<Print>.
		739
642	=item B<scrollBar:> I<boolean>	740	=item B<scrollBar:> I<boolean>
643		741
644	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	742	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
645	disable the scrollbar; option B<+sb>.	743	disable the scrollbar; option B<+sb>.
646		744
…		…
666	B<+si>.	764	B<+si>.
667		765
668	=item B<scrollWithBuffer:> I<boolean>	766	=item B<scrollWithBuffer:> I<boolean>
669		767
670	B<True>: scroll with scrollback buffer when tty receives new lines (and	768	B<True>: scroll with scrollback buffer when tty receives new lines (and
671	B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll	769	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
672	with scrollback buffer when tty recieves new lines; option B<-sw>.	770	with scrollback buffer when tty recieves new lines; option B<+sw>.
673		771
674	=item B<scrollTtyKeypress:> I<boolean>	772	=item B<scrollTtyKeypress:> I<boolean>
675		773
676	B<True>: scroll to bottom when a non-special key is pressed. Special keys	774	B<True>: scroll to bottom when a non-special key is pressed. Special keys
677	are those which are intercepted by rxvt-unicode for special handling and	775	are those which are intercepted by rxvt-unicode for special handling and
…		…
742		840
743	Mouse pointer background colour.	841	Mouse pointer background colour.
744		842
745	=item B<pointerBlankDelay:> I<number>	843	=item B<pointerBlankDelay:> I<number>
746		844
747	Specifies number of seconds before blanking the pointer [default 2].	845	Specifies number of seconds before blanking the pointer [default 2]. Use a
		846	large number (e.g. C<987654321>) to effectively disable the timeout.
748		847
749	=item B<backspacekey:> I<string>	848	=item B<backspacekey:> I<string>
750		849
751	The string to send when the backspace key is pressed. If set to B<DEC>	850	The string to send when the backspace key is pressed. If set to B<DEC>
752	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	851	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
…		…
774		873
775	I<name> of inputMethod to use; option B<-im>.	874	I<name> of inputMethod to use; option B<-im>.
776		875
777	=item B<imLocale:> I<name>	876	=item B<imLocale:> I<name>
778		877
779	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	878	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
780	de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input	879	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
781	extension to be able to input japanese characters while staying in	880	input extension to be able to input japanese characters while staying in
782	another locale. option B<-imlocale>.	881	another locale. option B<-imlocale>.
		882
		883	=item B<imFont:> I<fontset>
		884
		885	Specify the font-set used for XIM styles C<OverTheSpot> or
		886	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
		887	by commas), i.e. it's not in the same format as the other font lists used
		888	in @@RXVT_NAME@@. The default will be set-up to chose any suitable found
		889	found, preferably one or two pixels differing in size to the base font.
		890	option B<-imfont>.
		891
		892	=item B<tripleclickwords:> I<boolean>
		893
		894	Change the meaning of triple-click selection with the left mouse
		895	button. Instead of selecting a full line it will extend the selection to
		896	the end of the logical line only. option B<-tcw>.
783		897
784	=item B<insecure:> I<boolean>	898	=item B<insecure:> I<boolean>
785		899
786	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	900	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
787	echo arbitrary strings like the icon name or the locale. This could be	901	echo arbitrary strings like the icon name or the locale. This could be
788	abused if somebody gets 8-bit-clean access to your display, whether	902	abused if somebody gets 8-bit-clean access to your display, whether
789	throuh a mail client displaying mail bodies unfiltered or though	903	through a mail client displaying mail bodies unfiltered or through
790	write(1). Therefore, these sequences are disabled by default. (Note	904	write(1) or any other means. Therefore, these sequences are disabled by
791	that other terminals, including xterm, have these sequences	905	default. (Note that many other terminals, including xterm, have these
792	enabled by default). You can enable them by setting this boolean	906	sequences enabled by default, which doesn't make it safer, though).
793	resource or specifying B<-insecure> as an option. At the moment, this	907
794	enabled display-answer, locale, findfont, icon label and window title	908	You can enable them by setting this boolean resource or specifying
795	requests as well as dynamic menubar dispatch.	909	B<-insecure> as an option. At the moment, this enables display-answer,
		910	locale, findfont, icon label and window title requests as well as dynamic
		911	menubar dispatch.
796		912
797	=item B<modifier:> I<modifier>	913	=item B<modifier:> I<modifier>
798		914
799	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	915	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
800	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	916	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
817	scrollback buffer and switching to/from the secondary screen will	933	scrollback buffer and switching to/from the secondary screen will
818	instead scroll the screen up.	934	instead scroll the screen up.
819		935
820	=item B<keysym.>I<sym>: I<string>	936	=item B<keysym.>I<sym>: I<string>
821		937
822	Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may	938	Compile I<frills>: Associate I<string> with keysym I<sym>. The
823	contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:	939	intervening resource name B<keysym.> cannot be omitted.
824	newline, \r: return, \t:	940
		941	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
		942	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
		943	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
		944	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
		945	B<2>, B<3>, B<4>, B<5>.
		946
		947	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
		948	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
		949	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
		950	current application keymap mode state.
		951
		952	The spellings of I<key> can be obtained by using B<xev>(1) command or
		953	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
		954	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
		955	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
		956	performed in an exact manner; however, the closest match is assured.
		957
		958	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
		959	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
825	tab, \000: octal number) or control characters (^?: delete, ^@: null,	960	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
826	^A ...) and may enclosed with double quotes so that it can start or end	961	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
827	with whitespace. The intervening resource name B<keysym.> cannot be	962	can start or end with whitespace.
828	omitted. This resource is only available when compiled with	963
829	KEYSYM_RESOURCE.	964	Please note that you need to double the C<\> when using
		965	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
		966	use C<\033> instead of C<\e> (and so on), which will work with both Xt and
		967	@@RXVT_NAME@@'s own processing).
		968
		969	You can define a range of keysyms in one shot by providing a I<string>
		970	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
		971	should be a character not used by the strings.
		972
		973	Its usage can be demonstrated by an example:
		974
		975	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
		976
		977	The above line is equivalent to the following three lines:
		978
		979	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
		980	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
		981	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
		982
		983	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
		984	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
		985	example the following means "change the current locale to C<zh_CN.GBK>
		986	when Control-Meta-c is being pressed":
		987
		988	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		989
		990	Due the the large number of modifier combinations, a defined key mapping
		991	will match if at I<at least> the specified identifiers are being set, and
		992	no other key mappings with those and more bits are being defined. That
		993	means that defining a key map for C<a> will automatically provide
		994	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		995	mappings themselves.
		996
		997	Unfortunately, this will override built-in key mappings. For example
		998	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		999	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		1000	user-defined keymap using the C<builtin:> replacement:
		1001
		1002	URxvt.keysym.Insert: <my insert key sequence>
		1003	URxvt.keysym.S-Insert: builtin:
		1004
		1005	The first line defines a mapping for C<Insert> and I<any> combination
		1006	of modifiers. The second line re-establishes the default mapping for
		1007	C<Shift-Insert>.
		1008
		1009	The following example will map Control-Meta-1 and Control-Meta-2 to
		1010	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
		1011	font-switching at runtime:
		1012
		1013	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1014	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
		1015
		1016	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
		1017	info):
		1018
		1019	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1020	URxvt.keysym.M-C-4: command:\033[8;48;110t
830		1021
831	=back	1022	=back
832		1023
833	=head1 THE SCROLLBAR	1024	=head1 THE SCROLLBAR
834		1025
…		…
848	the normal text selection/insertion, hold either the Shift or the Meta	1039	the normal text selection/insertion, hold either the Shift or the Meta
849	(Alt) key while performing the desired mouse action.	1040	(Alt) key while performing the desired mouse action.
850		1041
851	If mouse reporting mode is active, the normal scrollbar actions are	1042	If mouse reporting mode is active, the normal scrollbar actions are
852	disabled -- on the assumption that we are using a fullscreen	1043	disabled -- on the assumption that we are using a fullscreen
853	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	1044	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
854	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	1045	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
855	up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down),	1046	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
856	respectively.	1047	respectively.
857		1048
858	=head1 TEXT SELECTION AND INSERTION	1049	=head1 TEXT SELECTION AND INSERTION
859		1050
860	The behaviour of text selection and insertion mechanism is similar to	1051	The behaviour of text selection and insertion mechanism is similar to
…		…
862		1053
863	=over 4	1054	=over 4
864		1055
865	=item B<Selection>:	1056	=item B<Selection>:
866		1057
867	Left click at the beginning of the region, drag to the end of the	1058	Left click at the beginning of the region, drag to the end of the region
868	region and release; Right click to extend the marked region; Left	1059	and release; Right click to extend the marked region; Left double-click
869	double-click to select a word; Left triple-click to select the entire	1060	to select a word; Left triple-click to select the entire logical line
870	line.	1061	(which can span multiple screen lines), unless modified by resource
		1062	B<tripleclickwords>.
871		1063
872	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1064	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
873	(Compile: frills) will create a rectangular selection instead of a normal	1065	(Compile: I<frills>) will create a rectangular selection instead of a normal
874	one.	1066	one.
875		1067
876	=item B<Insertion>:	1068	=item B<Insertion>:
877		1069
878	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1070	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
…		…
887	supported in rxvt-unicode. Bug me if you need this.	1079	supported in rxvt-unicode. Bug me if you need this.
888		1080
889	You can, however, switch fonts at runtime using escape sequences (and	1081	You can, however, switch fonts at runtime using escape sequences (and
890	therefore using the menubar), e.g.:	1082	therefore using the menubar), e.g.:
891		1083
892	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1084	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
893		1085
894	rxvt-unicode will automatically re-apply these fonts to the output so far.	1086	rxvt-unicode will automatically re-apply these fonts to the output so far.
895		1087
896	=head1 ISO 14755 SUPPORT	1088	=head1 ISO 14755 SUPPORT
897		1089
…		…
901	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1093	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
902	with C<--enable-iso14755>.	1094	with C<--enable-iso14755>.
903		1095
904	=over 4	1096	=over 4
905		1097
906	=item 5.1: Basic method	1098	=item * 5.1: Basic method
907		1099
908	This allows you to enter unicode characters using their hexcode.	1100	This allows you to enter unicode characters using their hexcode.
909		1101
910	Start by pressing and holding both C<Control> and C<Shift>, then enter	1102	Start by pressing and holding both C<Control> and C<Shift>, then enter
911	hex-digits (between one and six). Releasing C<Control> and C<Shift> will	1103	hex-digits (between one and six). Releasing C<Control> and C<Shift> will
…		…
918	address, which you cannot type. Fortunately, the card has the e-mail	1110	address, which you cannot type. Fortunately, the card has the e-mail
919	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily	1111	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
920	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,	1112	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
921	followed by releasing the modifier keys.	1113	followed by releasing the modifier keys.
922		1114
923	=item 5.2: Keyboard symbols entry method	1115	=item * 5.2: Keyboard symbols entry method
924		1116
925	This mode lets you input characters representing the keycap symbols of	1117	This mode lets you input characters representing the keycap symbols of
926	your keyboard, if representable in the current locale encoding.	1118	your keyboard, if representable in the current locale encoding.
927		1119
928	Start by pressing C<Control> and C<Shift> together, then releasing	1120	Start by pressing C<Control> and C<Shift> together, then releasing
…		…
931	keycap symbol. The symbol will only be entered when the key has been	1123	keycap symbol. The symbol will only be entered when the key has been
932	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1124	released, otherwise pressing e.g. C<Shift> would enter the symbol for
933	C<ISO Level 2 Switch>, although your intention might have been to enter a	1125	C<ISO Level 2 Switch>, although your intention might have been to enter a
934	reverse tab (Shift-Tab).	1126	reverse tab (Shift-Tab).
935		1127
936	=item 5.3: Screen-selection entry method	1128	=item * 5.3: Screen-selection entry method
937		1129
938	While this is implemented already (it's basically the selection	1130	While this is implemented already (it's basically the selection
939	mechanism), it could be extended by displaying a unicode character map.	1131	mechanism), it could be extended by displaying a unicode character map.
940		1132
941	=item 5.4: Feedback method for identifying displayed characters for later input	1133	=item * 5.4: Feedback method for identifying displayed characters for later input
942		1134
943	This method lets you display the unicode character code associated with	1135	This method lets you display the unicode character code associated with
944	characters already displayed.	1136	characters already displayed.
945		1137
946	You enter this mode by holding down C<Control> and C<Shift> together, then	1138	You enter this mode by holding down C<Control> and C<Shift> together, then
…		…
958	With respect to conformance, rxvt-unicode is supposed to be compliant to	1150	With respect to conformance, rxvt-unicode is supposed to be compliant to
959	both scenario A and B of ISO 14755, including part 5.2.	1151	both scenario A and B of ISO 14755, including part 5.2.
960		1152
961	=head1 LOGIN STAMP	1153	=head1 LOGIN STAMP
962		1154
963	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so	1155	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
964	that it can be seen via the I<who(1)> command, and can accept messages.	1156	it can be seen via the I<who(1)> command, and can accept messages. To
965	To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on	1157	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
966	some systems.	1158	on some systems or setgid to root or to some other group on others.
967		1159
968	=head1 COLORS AND GRAPHICS	1160	=head1 COLORS AND GRAPHICS
969		1161
970	In addition to the default foreground and background colours,	1162	In addition to the default foreground and background colours,
971	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1163	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
…		…
1014		1206
1015	=back	1207	=back
1016		1208
1017	=head1 ENVIRONMENT	1209	=head1 ENVIRONMENT
1018		1210
1019	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>	1211	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1020	and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X	1212
1021	window id number of the B<@@RXVT_NAME@@> window and it also uses and	1213	=over 4
1022	sets the environment variable B<DISPLAY> to specify which display	1214
1023	terminal to use. B<@@RXVT_NAME@@> uses the environment variables	1215	=item B<TERM>
1024	B<RXVTPATH> and B<PATH> to find XPM files.	1216
		1217	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
		1218	resources or on the commandline.
		1219
		1220	=item B<COLORTERM>
		1221
		1222	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
		1223	compiled with XPM support, and optionally with the added extension
		1224	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
		1225
		1226	=item B<COLORFGBG>
		1227
		1228	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
		1229	the colour code used as default foreground/text colour (or the string
		1230	C<default> to indicate that the default-colour escape sequence is to be
		1231	used), C<bg> is the colour code used as default background colour (or the
		1232	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1233	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
		1234	(and do) use this information to optimize screen output.
		1235
		1236	=item B<WINDOWID>
		1237
		1238	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
		1239	window, which usually has subwindows for the scrollbar, the terminal
		1240	window and so on).
		1241
		1242	=item B<TERMINFO>
		1243
		1244	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1245	C<--with-terminfo=PATH>.
		1246
		1247	=item B<DISPLAY>
		1248
		1249	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
		1250	display in it's child processes.
		1251
		1252	=item B<SHELL>
		1253
		1254	The shell to be used for command execution, defaults to C</bin/sh>.
		1255
		1256	=item B<RXVTPATH>
		1257
		1258	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
		1259	files.
		1260
		1261	=item B<PATH>
		1262
		1263	Used in the same way as C<RXVTPATH>.
		1264
		1265	=item B<RXVT_SOCKET>
		1266
		1267	The unix domain socket path used by @@RXVT_NAME@@c(1) and
		1268	@@RXVT_NAME@@d(1).
		1269
		1270	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
		1271
		1272	=item B<HOME>
		1273
		1274	Used to locate the default directory for the unix domain socket for
		1275	daemon communications and to locate various resource files (such as
		1276	C<.Xdefaults>)
		1277
		1278	=item B<XAPPLRESDIR>
		1279
		1280	Directory where various X resource files are being located.
		1281
		1282	=item B<XENVIRONMENT>
		1283
		1284	If set and accessible, gives the name of a X resource file to be loaded by
		1285	@@RXVT_NAME@@.
		1286
		1287	=back
1025		1288
1026	=head1 FILES	1289	=head1 FILES
1027		1290
1028	=over 4	1291	=over 4
1029		1292
1030	=item B</etc/utmp>
1031
1032	System file for login records.
1033
1034	=item B</usr/lib/X11/rgb.txt>	1293	=item B</usr/lib/X11/rgb.txt>
1035		1294
1036	Color names.	1295	Color names.
1037		1296
1038	=back	1297	=back
1039		1298
1040	=head1 SEE ALSO	1299	=head1 SEE ALSO
1041		1300
1042	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1301	@@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)
1043
1044	=head1 BUGS
1045
1046	Check the BUGS file for an up-to-date list.
1047
1048	Cursor change support is not yet implemented.
1049
1050	Click-and-drag doesn't work with X11 mouse report overriding.
1051		1302
1052	=head1 CURRENT PROJECT COORDINATOR	1303	=head1 CURRENT PROJECT COORDINATOR
1053		1304
1054	=over 4	1305	=over 4
1055		1306
1056	=item Project Coordinator	1307	=item Project Coordinator
1057		1308
1058	@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@>	1309	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1059		1310
1060	=item Web page maintainter	1311	L<http://software.schmorp.de/#rxvt-unicode>
1061
1062	@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1063
1064	L<@@RXVT_WEBPAGE@@>
1065		1312
1066	=back	1313	=back
1067		1314
1068	=head1 AUTHORS	1315	=head1 AUTHORS
1069		1316
…		…
1094	=item Geoff Wing L<< <gcw@pobox.com> >>	1341	=item Geoff Wing L<< <gcw@pobox.com> >>
1095		1342
1096	Rewrote screen display and text selection routines. Project Coordinator	1343	Rewrote screen display and text selection routines. Project Coordinator
1097	(changes.txt 2.4.6 - rxvt-unicode)	1344	(changes.txt 2.4.6 - rxvt-unicode)
1098		1345
1099	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>	1346	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1100		1347
1101	Forked rxvt-unicode, rewrote most of the display code and internal	1348	Forked rxvt-unicode, rewrote most of the display code and internal
1102	character handling to store text in unicode, improve xterm	1349	character handling to store text in unicode, improve xterm
1103	compatibility and apply numerous other bugfixes and extensions.	1350	compatibility and apply numerous other bugfixes and extensions.
1104		1351

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.36 by root, Wed Dec 15 05:10:57 2004 UTC vs. Revision 1.73 by root, Thu Dec 15 18:14:08 2005 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.36 by root, Wed Dec 15 05:10:57 2004 UTC vs.
Revision 1.73 by root, Thu Dec 15 18:14:08 2005 UTC