[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.74 by root, Thu Dec 22 16:44:10 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
128	specified, too).	140	specified, too, e.g. C<-tint white>).
129		141
130	=item B<-bg> I<colour>	142	=item B<-bg> I<colour>
131		143
132	Window background colour; resource B<background>.	144	Window background colour; resource B<background>.
133		145
…		…
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
…		…
300	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
301	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
302	run the program specified by the B<SHELL> environment variable or,	315	run the program specified by the B<SHELL> environment variable or,
303	failing that, I<sh(1)>.	316	failing that, I<sh(1)>.
304		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
305	=item B<-title> I<text>	323	=item B<-title> I<text>
306		324
307	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
308	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
309	application name; resource B<title>.	327	application name; resource B<title>.
…		…
327		345
328	Compile I<XIM>: input method name. resource B<inputMethod>.	346	Compile I<XIM>: input method name. resource B<inputMethod>.
329		347
330	=item B<-imlocale> I<string>	348	=item B<-imlocale> I<string>
331		349
332	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.
333	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
334	extension to be able to input japanese characters while staying in	352	input extension to be able to input japanese characters while staying in
335	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>.
336		365
337	=item B<-insecure>	366	=item B<-insecure>
338		367
339	Enable "insecure" mode, which currently enables most of the escape	368	Enable "insecure" mode, which currently enables most of the escape
340	sequences that echo strings. See the resource B<insecure> for more	369	sequences that echo strings. See the resource B<insecure> for more
…		…
354	=item B<-ssr>\|B<+ssr>	383	=item B<-ssr>\|B<+ssr>
355		384
356	Turn on/off secondary screen scroll (default enabled); resource	385	Turn on/off secondary screen scroll (default enabled); resource
357	B<secondaryScroll>.	386	B<secondaryScroll>.
358		387
359	=item B<-xrm> I<resourcestring>	388	=item B<-hold>\|B<+hold>
360		389
361	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@@
362	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
363	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" }
364		451
365	=back	452	=back
366		453
367	=head1 RESOURCES (available also as long-options)	454	=head1 RESOURCES (available also as long-options)
368		455
…		…
371		458
372	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
373	Xresource data: using the X libraries (Xrm*-functions) or internal	460	Xresource data: using the X libraries (Xrm*-functions) or internal
374	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	461	Xresources reader (B<~/.Xdefaults>). For the first method (ie.
375	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
376	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
377	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>
378		473
379	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>
380	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults	475	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
381	set in XAPPLOADDIR/URxvt (compile-time defined: usually	476	set in XAPPLOADDIR/URxvt (compile-time defined: usually
382	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	477	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
…		…
427		522
428	=item B<colorIT:> I<colour>	523	=item B<colorIT:> I<colour>
429		524
430	Use the specified colour to display bold or italic characters when the	525	Use the specified colour to display bold or italic characters when the
431	foreground colour is the default. If font styles are not available	526	foreground colour is the default. If font styles are not available
432	(Compile styles) and this option is unset, reverse video is used instead.	527	(Compile I<styles>) and this option is unset, reverse video is used instead.
433		528
434	=item B<colorUL:> I<colour>	529	=item B<colorUL:> I<colour>
435		530
436	Use the specified colour to display underlined characters when the	531	Use the specified colour to display underlined characters when the
437	foreground colour is the default.	532	foreground colour is the default.
438		533
439	=item B<colorRV:> I<colour>	534	=item B<colorRV:> I<colour>
440		535
441	Use the specified colour as the background for reverse video	536	Use the specified colour as the background for reverse video
442	characters.	537	characters.
		538
		539	=item B<underlineColor:> I<colour>
		540
		541	If set, use the specified colour as the colour for the underline
		542	itself. If unset, use the foreground colour.
443		543
444	=item B<cursorColor:> I<colour>	544	=item B<cursorColor:> I<colour>
445		545
446	Use the specified colour for the cursor. The default is to use the	546	Use the specified colour for the cursor. The default is to use the
447	foreground colour; option B<-cr>.	547	foreground colour; option B<-cr>.
…		…
470	artificial transparency. B<False>: do not inherit the parent windows'	570	artificial transparency. B<False>: do not inherit the parent windows'
471	pixmap.	571	pixmap.
472		572
473	=item B<fading:> I<number>	573	=item B<fading:> I<number>
474		574
475	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>.
476		581
477	=item B<tintColor:> I<colour>	582	=item B<tintColor:> I<colour>
478		583
479	Tint the transparent background pixmap with the given colour.	584	Tint the transparent background pixmap with the given colour; option
		585	B<-tint>.
480		586
481	=item B<shading:> I<number>	587	=item B<shading:> I<number>
482		588
483	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	589	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
484	image in addition to tinting it.	590	image in addition to tinting it.
…		…
488	Use the specified colour for the scrollbar [default #B2B2B2].	594	Use the specified colour for the scrollbar [default #B2B2B2].
489		595
490	=item B<troughColor:> I<colour>	596	=item B<troughColor:> I<colour>
491		597
492	Use the specified colour for the scrollbar's trough area [default	598	Use the specified colour for the scrollbar's trough area [default
493	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	599	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
494		600
495	=item B<borderColor:> I<colour>	601	=item B<borderColor:> I<colour>
496		602
497	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
498	and the text.	604	and the text.
…		…
528	The first font defines the cell size for characters; other fonts might	634	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	635	be smaller, but not larger. A reasonable default font list is always
530	appended to it. option B<-fn>.	636	appended to it. option B<-fn>.
531		637
532	Each font can either be a standard X11 core font (XLFD) name, with	638	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:>.	639	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
534		640
535	In addition, each font can be prefixed with additional hints and	641	In addition, each font can be prefixed with additional hints and
536	specifications enclosed in square brackets (C<[]>). The only available	642	specifications enclosed in square brackets (C<[]>). The only available
537	hint currently is C<codeset=codeset-name>, and this is only used for Xft	643	hint currently is C<codeset=codeset-name>, and this is only used for Xft
538	fonts.	644	fonts.
…		…
590	xterm style selection.	696	xterm style selection.
591		697
592	=item B<scrollstyle:> I<mode>	698	=item B<scrollstyle:> I<mode>
593		699
594	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
595	the author's favourite..	701	the author's favourite.
596		702
597	=item B<title:> I<string>	703	=item B<title:> I<string>
598		704
599	Set window title string, the default title is the command-line	705	Set window title string, the default title is the command-line
600	specified after the B<-e> option, if any, otherwise the application	706	specified after the B<-e> option, if any, otherwise the application
…		…
632		738
633	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
634	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
635	B<Shift-Print> to include the scrollback as well.	741	B<Shift-Print> to include the scrollback as well.
636		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
637	=item B<scrollBar:> I<boolean>	752	=item B<scrollBar:> I<boolean>
638		753
639	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	754	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
640	disable the scrollbar; option B<+sb>.	755	disable the scrollbar; option B<+sb>.
641		756
…		…
661	B<+si>.	776	B<+si>.
662		777
663	=item B<scrollWithBuffer:> I<boolean>	778	=item B<scrollWithBuffer:> I<boolean>
664		779
665	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
666	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
667	with scrollback buffer when tty recieves new lines; option B<-sw>.	782	with scrollback buffer when tty recieves new lines; option B<+sw>.
668		783
669	=item B<scrollTtyKeypress:> I<boolean>	784	=item B<scrollTtyKeypress:> I<boolean>
670		785
671	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
672	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
…		…
737		852
738	Mouse pointer background colour.	853	Mouse pointer background colour.
739		854
740	=item B<pointerBlankDelay:> I<number>	855	=item B<pointerBlankDelay:> I<number>
741		856
742	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.
743		859
744	=item B<backspacekey:> I<string>	860	=item B<backspacekey:> I<string>
745		861
746	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>
747	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>
…		…
769		885
770	I<name> of inputMethod to use; option B<-im>.	886	I<name> of inputMethod to use; option B<-im>.
771		887
772	=item B<imLocale:> I<name>	888	=item B<imLocale:> I<name>
773		889
774	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.
775	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
776	extension to be able to input japanese characters while staying in	892	input extension to be able to input japanese characters while staying in
777	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>.
778		909
779	=item B<insecure:> I<boolean>	910	=item B<insecure:> I<boolean>
780		911
781	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	912	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
782	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
783	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
784	throuh a mail client displaying mail bodies unfiltered or though	915	through a mail client displaying mail bodies unfiltered or through
785	write(1). Therefore, these sequences are disabled by default. (Note	916	write(1) or any other means. Therefore, these sequences are disabled by
786	that other terminals, including xterm, have these sequences	917	default. (Note that many other terminals, including xterm, have these
787	enabled by default). You can enable them by setting this boolean	918	sequences enabled by default, which doesn't make it safer, though).
788	resource or specifying B<-insecure> as an option. At the moment, this	919
789	enabled display-answer, locale, findfont, icon label and window title	920	You can enable them by setting this boolean resource or specifying
790	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.
791		924
792	=item B<modifier:> I<modifier>	925	=item B<modifier:> I<modifier>
793		926
794	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>,
795	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
…		…
810	Turn on/off secondary screen scroll (default enabled). If the this	943	Turn on/off secondary screen scroll (default enabled). If the this
811	option is enabled, scrolls on the secondary screen will change the	944	option is enabled, scrolls on the secondary screen will change the
812	scrollback buffer and switching to/from the secondary screen will	945	scrollback buffer and switching to/from the secondary screen will
813	instead scroll the screen up.	946	instead scroll the screen up.
814		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.
		954
815	=item B<keysym.>I<sym>: I<string>	955	=item B<keysym.>I<sym>: I<string>
816		956
817	Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may	957	Compile I<frills>: Associate I<string> with keysym I<sym>. The
818	contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:	958	intervening resource name B<keysym.> cannot be omitted.
819	newline, \r: return, \t:	959
		960	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
		961	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
		962	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
		963	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
		964	B<2>, B<3>, B<4>, B<5>.
		965
		966	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
		967	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
		968	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
		969	current application keymap mode state.
		970
		971	The spellings of I<key> can be obtained by using B<xev>(1) command or
		972	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
		973	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
		974	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
		975	performed in an exact manner; however, the closest match is assured.
		976
		977	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
		978	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,	979	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	980	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	981	can start or end with whitespace.
823	omitted. This resource is only available when compiled with	982
824	KEYSYM_RESOURCE.	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
		988	You can define a range of keysyms in one shot by providing a I<string>
		989	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
		990	should be a character not used by the strings.
		991
		992	Its usage can be demonstrated by an example:
		993
		994	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
		995
		996	The above line is equivalent to the following three lines:
		997
		998	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
		999	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
		1000	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
		1001
		1002	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
		1003	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
		1004	example the following means "change the current locale to 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
825		1040
826	=back	1041	=back
827		1042
828	=head1 THE SCROLLBAR	1043	=head1 THE SCROLLBAR
829		1044
…		…
843	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
844	(Alt) key while performing the desired mouse action.	1059	(Alt) key while performing the desired mouse action.
845		1060
846	If mouse reporting mode is active, the normal scrollbar actions are	1061	If mouse reporting mode is active, the normal scrollbar actions are
847	disabled -- on the assumption that we are using a fullscreen	1062	disabled -- on the assumption that we are using a fullscreen
848	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	1063	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
849	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	1064	(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),	1065	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
851	respectively.	1066	respectively.
852		1067
853	=head1 TEXT SELECTION AND INSERTION	1068	=head1 TEXT SELECTION AND INSERTION
854		1069
855	The behaviour of text selection and insertion mechanism is similar to	1070	The behaviour of text selection and insertion mechanism is similar to
…		…
857		1072
858	=over 4	1073	=over 4
859		1074
860	=item B<Selection>:	1075	=item B<Selection>:
861		1076
862	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
863	region and release; Right click to extend the marked region; Left	1078	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	1079	to select a word; Left triple-click to select the entire logical line
865	line.	1080	(which can span multiple screen lines), unless modified by resource
		1081	B<tripleclickwords>.
866		1082
867	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)
868	(Compile: frills) will create a rectangular selection instead of a normal	1084	(Compile: I<frills>) will create a rectangular selection instead of a normal
869	one.	1085	one.
870		1086
871	=item B<Insertion>:	1087	=item B<Insertion>:
872		1088
873	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1089	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
…		…
882	supported in rxvt-unicode. Bug me if you need this.	1098	supported in rxvt-unicode. Bug me if you need this.
883		1099
884	You can, however, switch fonts at runtime using escape sequences (and	1100	You can, however, switch fonts at runtime using escape sequences (and
885	therefore using the menubar), e.g.:	1101	therefore using the menubar), e.g.:
886		1102
887	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1103	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
888		1104
889	rxvt-unicode will automatically re-apply these fonts to the output so far.	1105	rxvt-unicode will automatically re-apply these fonts to the output so far.
890		1106
891	=head1 ISO 14755 SUPPORT	1107	=head1 ISO 14755 SUPPORT
892		1108
…		…
896	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1112	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
897	with C<--enable-iso14755>.	1113	with C<--enable-iso14755>.
898		1114
899	=over 4	1115	=over 4
900		1116
901	=item 5.1: Basic method	1117	=item * 5.1: Basic method
902		1118
903	This allows you to enter unicode characters using their hexcode.	1119	This allows you to enter unicode characters using their hexcode.
904		1120
905	Start by pressing and holding both C<Control> and C<Shift>, then enter	1121	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	1122	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	1129	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	1130	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>,	1131	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.	1132	followed by releasing the modifier keys.
917		1133
918	=item 5.2: Keyboard symbols entry method	1134	=item * 5.2: Keyboard symbols entry method
919		1135
920	This mode lets you input characters representing the keycap symbols of	1136	This mode lets you input characters representing the keycap symbols of
921	your keyboard, if representable in the current locale encoding.	1137	your keyboard, if representable in the current locale encoding.
922		1138
923	Start by pressing C<Control> and C<Shift> together, then releasing	1139	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	1142	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	1143	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	1144	C<ISO Level 2 Switch>, although your intention might have been to enter a
929	reverse tab (Shift-Tab).	1145	reverse tab (Shift-Tab).
930		1146
931	=item 5.3: Screen-selection entry method	1147	=item * 5.3: Screen-selection entry method
932		1148
933	While this is implemented already (it's basically the selection	1149	While this is implemented already (it's basically the selection
934	mechanism), it could be extended by displaying a unicode character map.	1150	mechanism), it could be extended by displaying a unicode character map.
935		1151
936	=item 5.4: Feedback method for identifying displayed characters for later input	1152	=item * 5.4: Feedback method for identifying displayed characters for later input
937		1153
938	This method lets you display the unicode character code associated with	1154	This method lets you display the unicode character code associated with
939	characters already displayed.	1155	characters already displayed.
940		1156
941	You enter this mode by holding down C<Control> and C<Shift> together, then	1157	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	1169	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.	1170	both scenario A and B of ISO 14755, including part 5.2.
955		1171
956	=head1 LOGIN STAMP	1172	=head1 LOGIN STAMP
957		1173
958	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so	1174	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.	1175	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	1176	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
961	some systems.	1177	on some systems or setgid to root or to some other group on others.
962		1178
963	=head1 COLORS AND GRAPHICS	1179	=head1 COLORS AND GRAPHICS
964		1180
965	In addition to the default foreground and background colours,	1181	In addition to the default foreground and background colours,
966	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1182	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
…		…
1009		1225
1010	=back	1226	=back
1011		1227
1012	=head1 ENVIRONMENT	1228	=head1 ENVIRONMENT
1013		1229
1014	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>	1230	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	1231
1016	window id number of the B<@@RXVT_NAME@@> window and it also uses and	1232	=over 4
1017	sets the environment variable B<DISPLAY> to specify which display	1233
1018	terminal to use. B<@@RXVT_NAME@@> uses the environment variables	1234	=item B<TERM>
1019	B<RXVTPATH> and B<PATH> to find XPM files.	1235
		1236	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
		1237	resources or on the commandline.
		1238
		1239	=item B<COLORTERM>
		1240
		1241	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
		1242	compiled with XPM support, and optionally with the added extension
		1243	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
		1244
		1245	=item B<COLORFGBG>
		1246
		1247	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
		1248	the colour code used as default foreground/text colour (or the string
		1249	C<default> to indicate that the default-colour escape sequence is to be
		1250	used), C<bg> is the colour code used as default background colour (or the
		1251	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1252	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
		1253	(and do) use this information to optimize screen output.
		1254
		1255	=item B<WINDOWID>
		1256
		1257	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
		1258	window, which usually has subwindows for the scrollbar, the terminal
		1259	window and so on).
		1260
		1261	=item B<TERMINFO>
		1262
		1263	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1264	C<--with-terminfo=PATH>.
		1265
		1266	=item B<DISPLAY>
		1267
		1268	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
		1269	display in it's child processes.
		1270
		1271	=item B<SHELL>
		1272
		1273	The shell to be used for command execution, defaults to C</bin/sh>.
		1274
		1275	=item B<RXVTPATH>
		1276
		1277	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
		1278	files.
		1279
		1280	=item B<PATH>
		1281
		1282	Used in the same way as C<RXVTPATH>.
		1283
		1284	=item B<RXVT_SOCKET>
		1285
		1286	The unix domain socket path used by @@RXVT_NAME@@c(1) and
		1287	@@RXVT_NAME@@d(1).
		1288
		1289	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
		1290
		1291	=item B<HOME>
		1292
		1293	Used to locate the default directory for the unix domain socket for
		1294	daemon communications and to locate various resource files (such as
		1295	C<.Xdefaults>)
		1296
		1297	=item B<XAPPLRESDIR>
		1298
		1299	Directory where various X resource files are being located.
		1300
		1301	=item B<XENVIRONMENT>
		1302
		1303	If set and accessible, gives the name of a X resource file to be loaded by
		1304	@@RXVT_NAME@@.
		1305
		1306	=back
1020		1307
1021	=head1 FILES	1308	=head1 FILES
1022		1309
1023	=over 4	1310	=over 4
1024		1311
1025	=item B</etc/utmp>
1026
1027	System file for login records.
1028
1029	=item B</usr/lib/X11/rgb.txt>	1312	=item B</usr/lib/X11/rgb.txt>
1030		1313
1031	Color names.	1314	Color names.
1032		1315
1033	=back	1316	=back
1034		1317
1035	=head1 SEE ALSO	1318	=head1 SEE ALSO
1036		1319
1037	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1320	@@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
1039	=head1 BUGS
1040
1041	Check the BUGS file for an up-to-date list.
1042
1043	Cursor change support is not yet implemented.
1044
1045	Click-and-drag doesn't work with X11 mouse report overriding.
1046		1321
1047	=head1 CURRENT PROJECT COORDINATOR	1322	=head1 CURRENT PROJECT COORDINATOR
1048		1323
1049	=over 4	1324	=over 4
1050		1325
1051	=item Project Coordinator	1326	=item Project Coordinator
1052		1327
1053	@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@>	1328	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1054		1329
1055	=item Web page maintainter	1330	L<http://software.schmorp.de/#rxvt-unicode>
1056
1057	@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1058
1059	L<@@RXVT_WEBPAGE@@>
1060		1331
1061	=back	1332	=back
1062		1333
1063	=head1 AUTHORS	1334	=head1 AUTHORS
1064		1335
…		…
1089	=item Geoff Wing L<< <gcw@pobox.com> >>	1360	=item Geoff Wing L<< <gcw@pobox.com> >>
1090		1361
1091	Rewrote screen display and text selection routines. Project Coordinator	1362	Rewrote screen display and text selection routines. Project Coordinator
1092	(changes.txt 2.4.6 - rxvt-unicode)	1363	(changes.txt 2.4.6 - rxvt-unicode)
1093		1364
1094	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>	1365	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1095		1366
1096	Forked rxvt-unicode, rewrote most of the display code and internal	1367	Forked rxvt-unicode, rewrote most of the display code and internal
1097	character handling to store text in unicode, improve xterm	1368	character handling to store text in unicode, improve xterm
1098	compatibility and apply numerous other bugfixes and extensions.	1369	compatibility and apply numerous other bugfixes and extensions.
1099		1370

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.74 by root, Thu Dec 22 16:44:10 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.74 by root, Thu Dec 22 16:44:10 2005 UTC