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

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.34 by root, Wed Dec 1 02:29:14 2004 UTC vs. Revision 1.69 by root, Tue Oct 25 19:04:45 2005 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.34 by root, Wed Dec 1 02:29:14 2004 UTC vs.
Revision 1.69 by root, Tue Oct 25 19:04:45 2005 UTC