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

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.30 by root, Wed Sep 8 17:10:23 2004 UTC vs. Revision 1.68 by root, Thu Aug 11 02:05:07 2005 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.30 by root, Wed Sep 8 17:10:23 2004 UTC vs.
Revision 1.68 by root, Thu Aug 11 02:05:07 2005 UTC