rxvt-unicode: doc/rxvt.1.pod - 9.26 vs. 9.29 changes

"Fossies" - the Fresh Open Source Software Archive

Source code changes of the file "doc/rxvt.1.pod" between
rxvt-unicode-9.26.tar.bz2 and rxvt-unicode-9.29.tar.bz2

About: rxvt-unicode is a clone of the terminal emulator rxvt.

[ To the main rxvt-unicode source changes report ]

rxvt.1.pod (rxvt-unicode-9.26.tar.bz2)	:	rxvt.1.pod (rxvt-unicode-9.29.tar.bz2)

skipping to change at line 89		skipping to change at line 89
I<XIM> on the I<Options> line. Note: `@@RXVT_NAME@@ -help' gives a list of all		I<XIM> on the I<Options> line. Note: `@@RXVT_NAME@@ -help' gives a list of all
command-line options compiled into your version.		command-line options compiled into your version.

Note that B<@@RXVT_NAME@@> permits the resource name to be used as a		Note that B<@@RXVT_NAME@@> permits the resource name to be used as a
long-option (--/++ option) so the potential command-line options are		long-option (--/++ option) so the potential command-line options are
far greater than those listed. For example: `@@RXVT_NAME@@ --loginShell --color1		far greater than those listed. For example: `@@RXVT_NAME@@ --loginShell --color1
Orange'.		Orange'.

The following options are available:		The following options are available:


=over 4		=over

=item B<-help>, B<--help>		=item B<-help>, B<--help>

Print out a message describing available options.		Print out a message describing available options.

=item B<-display> I<displayname>		=item B<-display> I<displayname>

Attempt to open a window on the named X display (the older form B<-d>		Attempt to open a window on the named X display (the older form B<-d>
is still respected. but deprecated). In the absence of this option, the		is still respected. but deprecated). In the absence of this option, the
display specified by the B<DISPLAY> environment variable is used.		display specified by the B<DISPLAY> environment variable is used.

skipping to change at line 411		skipping to change at line 411
Set the font set to use for the X Input Method, see resource B<imFont>		Set the font set to use for the X Input Method, see resource B<imFont>
for more info.		for more info.

=item B<-tcw>		=item B<-tcw>

Change the meaning of triple-click selection with the left mouse		Change the meaning of triple-click selection with the left mouse
button. Only effective when the original (non-perl) selection code is		button. Only effective when the original (non-perl) selection code is
in-use. Instead of selecting a full line it will extend the selection to		in-use. Instead of selecting a full line it will extend the selection to
the end of the logical line only. resource B<tripleclickwords>.		the end of the logical line only. resource B<tripleclickwords>.


		=item B<-dpb>\|B<+dpb>

		Compile frills: Disable (or enable) emitting bracketed paste mode
		sequences (default enabled). Bracketed paste mode allows programs
		to detect when something is pasted. Since more and more programs
		abuse this, these sequences can be disabled. The command sequences to
		enable and query paste mode will still work, but the actual bracket
		sequences will no longer be emitted. You can also toggle this from the
		ctrl-middle-mouse-button menu; resource B<disablePasteBrackets>.

=item B<-insecure>		=item B<-insecure>

Enable "insecure" mode, which currently enables most of the escape		Enable "insecure" mode, which currently enables most of the escape
sequences that echo strings. See the resource B<insecure> for more		sequences that echo strings. See the resource B<insecure> for more
info.		info.

=item B<-mod> I<modifier>		=item B<-mod> I<modifier>

Override detection of Meta modifier with specified key: B<alt>,		Override detection of Meta modifier with specified key: B<alt>,
B<meta>, B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>,		B<meta>, B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>,

skipping to change at line 433		skipping to change at line 443
=item B<-ssc>\|B<+ssc>		=item B<-ssc>\|B<+ssc>

Turn on/off secondary screen (default enabled); resource		Turn on/off secondary screen (default enabled); resource
B<secondaryScreen>.		B<secondaryScreen>.

=item B<-ssr>\|B<+ssr>		=item B<-ssr>\|B<+ssr>

Turn on/off secondary screen scroll (default enabled); resource		Turn on/off secondary screen scroll (default enabled); resource
B<secondaryScroll>.		B<secondaryScroll>.


		=item B<-rm> I<mode>

		Compile I<frills>: Sets long line rewrapping behaviour on window resizes
		to one of B<auto> (the default), B<always> or B<never>. The latter two
		modes do the obvious, B<auto> rewraps (acts like B<always>) if scrollback
		is non-empty, and wings lines (acts like B<never>) otherwise; resource
		B<rewrapMode>.

=item B<-hold>\|B<+hold>		=item B<-hold>\|B<+hold>

Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@		Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
will not immediately destroy its window when the program executed within		will not immediately destroy its window when the program executed within
it exits. Instead, it will wait till it is being killed or closed by the		it exits. Instead, it will wait till it is being killed or closed by the
user; resource B<hold>.		user; resource B<hold>.

=item B<-cd> I<path>		=item B<-cd> I<path>

Sets the working directory for the shell (or the command specified via		Sets the working directory for the shell (or the command specified via

skipping to change at line 520		skipping to change at line 538

my $pty = new IO::Pty;		my $pty = new IO::Pty;
fcntl $pty, F_SETFD, 0; # clear close-on-exec		fcntl $pty, F_SETFD, 0; # clear close-on-exec
system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";		system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
close $pty;		close $pty;

# now communicate with rxvt		# now communicate with rxvt
my $slave = $pty->slave;		my $slave = $pty->slave;
while (<$slave>) { print $slave "got <$_>\n" }		while (<$slave>) { print $slave "got <$_>\n" }


		Note that, despite what the name might imply, the file descriptor does not
		need to be a pty, it can be a bi-directional pipe as well (e.g. a unix
		domain or tcp socket). While tty operations cannot be done in this case,
		B<@@RXVT_NAME@@> can still be remote controlled with it:

		use Socket;
		use Fcntl;

		socketpair my $URXVT, my $slave, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket
		::PF_UNSPEC;
		fcntl $slave, Fcntl::F_SETFD, 0;
		system "exec @@RXVT_NAME@@ -pty-fd " . (fileno $slave) . " &";
		close $slave;

		syswrite $URXVT, "Type a secret password: ";
		my $secret = do { local $/ = "\r"; <$URXVT> };
		print "Not so secret anymore: $secret\n";

=item B<-pe> I<string>		=item B<-pe> I<string>

Comma-separated list of perl extension scripts to use (or not to use) in		Comma-separated list of perl extension scripts to use (or not to use) in
this terminal instance. See resource B<perl-ext> for details.		this terminal instance. See resource B<perl-ext> for details.

=back		=back

=head1 RESOURCES		=head1 RESOURCES

Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long		Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long

skipping to change at line 556		skipping to change at line 591
names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources		names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily		common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
configured, while the class name B<URxvt> allows resources unique to		configured, while the class name B<URxvt> allows resources unique to
B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>		B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
configurations. If no resources are specified, suitable defaults will		configurations. If no resources are specified, suitable defaults will
be used. Command-line arguments can be used to override resource		be used. Command-line arguments can be used to override resource
settings. The following resources are supported (you might want to		settings. The following resources are supported (you might want to
check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl		check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
extensions not documented here):		extensions not documented here):


=over 4		=over

=item B<depth:> I<bitdepth>		=item B<depth:> I<bitdepth>

Compile I<xft>: Attempt to find a visual with the given bit depth;		Compile I<xft>: Attempt to find a visual with the given bit depth;
option B<-depth>.		option B<-depth>.

=item B<buffered:> I<boolean>		=item B<buffered:> I<boolean>

Compile I<xft>: Turn on/off double-buffering for xft (default enabled).		Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
On some card/driver combination enabling it slightly decreases		On some card/driver combination enabling it slightly decreases

skipping to change at line 1018		skipping to change at line 1053
in @@RXVT_NAME@@. The default will be set-up to chose any suitable found		in @@RXVT_NAME@@. The default will be set-up to chose any suitable found
found, preferably one or two pixels differing in size to the base font.		found, preferably one or two pixels differing in size to the base font.
option B<-imfont>.		option B<-imfont>.

=item B<tripleclickwords:> I<boolean>		=item B<tripleclickwords:> I<boolean>

Change the meaning of triple-click selection with the left mouse		Change the meaning of triple-click selection with the left mouse
button. Instead of selecting a full line it will extend the selection to		button. Instead of selecting a full line it will extend the selection to
the end of the logical line only; option B<-tcw>.		the end of the logical line only; option B<-tcw>.


		=item B<disablePasteBrackets:> I<boolean>

		Prevent emission of paste bracket sequences; option B<-dpb>.

=item B<insecure:> I<boolean>		=item B<insecure:> I<boolean>


Enables "insecure" mode. Rxvt-unicode offers some escape sequences that		Enable "insecure" mode. Rxvt-unicode offers some escape sequences that
echo arbitrary strings like the icon name or the locale. This could be		echo arbitrary strings like the icon name or the locale. This could be
abused if somebody gets 8-bit-clean access to your display, whether		abused if somebody gets 8-bit-clean access to your display, whether
through a mail client displaying mail bodies unfiltered or through		through a mail client displaying mail bodies unfiltered or through
write(1) or any other means. Therefore, these sequences are disabled by		write(1) or any other means. Therefore, these sequences are disabled by
default. (Note that many other terminals, including xterm, have these		default. (Note that many other terminals, including xterm, have these
sequences enabled by default, which doesn't make it safer, though).		sequences enabled by default, which doesn't make it safer, though).

You can enable them by setting this boolean resource or specifying		You can enable them by setting this boolean resource or specifying
B<-insecure> as an option. At the moment, this enables display-answer,		B<-insecure> as an option. At the moment, this enables display-answer,
locale, findfont, icon label and window title requests.		locale, findfont, icon label and window title requests.

skipping to change at line 1048		skipping to change at line 1087
=item B<answerbackString:> I<string>		=item B<answerbackString:> I<string>

Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)		Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
character is passed through. It may contain escape values as described		character is passed through. It may contain escape values as described
in the entry on B<keysym> following.		in the entry on B<keysym> following.

=item B<secondaryScreen:> I<boolean>		=item B<secondaryScreen:> I<boolean>

Turn on/off secondary screen (default enabled).		Turn on/off secondary screen (default enabled).


		=item B<rewrapMode:> I<mode>

		Sets long line rewrap behaviour on window resize to one of B<auto>
		(default), B<always> or B<never>.

=item B<secondaryScroll:> I<boolean>		=item B<secondaryScroll:> I<boolean>

Turn on/off secondary screen scroll (default enabled). If this		Turn on/off secondary screen scroll (default enabled). If this
option is enabled, scrolls on the secondary screen will change the		option is enabled, scrolls on the secondary screen will change the
scrollback buffer and, when secondaryScreen is off, switching		scrollback buffer and, when secondaryScreen is off, switching
to/from the secondary screen will instead scroll the screen up.		to/from the secondary screen will instead scroll the screen up.

=item B<hold>: I<boolean>		=item B<hold>: I<boolean>

Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@		Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@

skipping to change at line 1135		skipping to change at line 1179
number), see RESOURCES in C<man 7 X> for further details.		number), see RESOURCES in C<man 7 X> for further details.

An action starts with an action prefix that selects a certain type		An action starts with an action prefix that selects a certain type
of action, followed by a colon. An action string without colons is		of action, followed by a colon. An action string without colons is
interpreted as a literal string to pass to the tty (as if it was		interpreted as a literal string to pass to the tty (as if it was
prefixed with C<string:>).		prefixed with C<string:>).

The following action prefixes are known - extensions can provide		The following action prefixes are known - extensions can provide
additional prefixes:		additional prefixes:


=over 4		=over

=item string:STRING		=item string:STRING

If the I<action> starts with C<string:> (or otherwise contains no colons),		If the I<action> starts with C<string:> (or otherwise contains no colons),
then the remaining C<STRING> will be passed to the program running in the		then the remaining C<STRING> will be passed to the program running in the
terminal. For example, you could replace whatever Shift-Tab outputs by the		terminal. For example, you could replace whatever Shift-Tab outputs by the
string C<echo rm -rf /> followed by a newline:		string C<echo rm -rf /> followed by a newline:

URxvt.keysym.Shift-Tab: string:echo rm -rf /\n		URxvt.keysym.Shift-Tab: string:echo rm -rf /\n


skipping to change at line 1265		skipping to change at line 1309

=back		=back

=item B<perl-ext-common>: I<string>		=item B<perl-ext-common>: I<string>

=item B<perl-ext>: I<string>		=item B<perl-ext>: I<string>

Comma-separated list(s) of perl extension scripts (default: C<default>) to		Comma-separated list(s) of perl extension scripts (default: C<default>) to
use in this terminal instance; option B<-pe>.		use in this terminal instance; option B<-pe>.


Extension names can be prefixed with a C<-> sign to prohibit using		Extension names can be prefixed with a C<-> sign to remove them again, in
them. This can be useful to selectively disable some extensions loaded		case they had been specified earlier. This can be useful to selectively
by default, or specified via the C<perl-ext-common> resource. For		disable some extensions loaded by default, or specified via the
example, C<default,-selection> will use all the default extensions except		C<perl-ext-common> resource. For example, C<default,-selection> will use
C<selection>.		all the default extensions except C<selection>.

		To prohibit autoloading of extensions, you can prefix them with C</>,
		which will make urxvt refuse to automatically load them (this can be
		overriden, however, by specifying the extension name again without a
		prefix, though). This does not prohibit extensions themselves loading
		other extensions. For example, C<default,/background> will keep the
		C<background> extension from being loaded when a background OSC sequence
		is received.

The default set includes the C<selection>, C<option-popup>,		The default set includes the C<selection>, C<option-popup>,

C<selection-popup>, C<readline> and C<searchable-scrollback>		C<selection-popup>, C<readline>, C<searchable-scrollback> and
extensions, and extensions which are mentioned in B<keysym> resources.		C<confirm-paste> extensions, as well as any extensions which are mentioned
		in B<keysym> resources.

Any extension such that a corresponding resource is given on the		Any extension such that a corresponding resource is given on the
command line is automatically appended to B<perl-ext>.		command line is automatically appended to B<perl-ext>.

Each extension is looked up in the library directories, loaded if		Each extension is looked up in the library directories, loaded if
necessary, and bound to the current terminal instance. When the library		necessary, and bound to the current terminal instance. When the library
search path contains multiple extension files of the same name, then the		search path contains multiple extension files of the same name, then the
first one found will be used.		first one found will be used.

If both of these resources are the empty string, then the perl interpreter		If both of these resources are the empty string, then the perl interpreter

skipping to change at line 1373		skipping to change at line 1426
application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>		application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the		(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),		up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
respectively.		respectively.

=head1 THE SELECTION: SELECTING AND PASTING TEXT		=head1 THE SELECTION: SELECTING AND PASTING TEXT

The behaviour of text selection and insertion/pasting mechanism is similar		The behaviour of text selection and insertion/pasting mechanism is similar
to I<xterm>(1).		to I<xterm>(1).


=over 4		=over

=item B<Selecting>:		=item B<Selecting>:

Left click at the beginning of the region, drag to the end of the region		Left click at the beginning of the region, drag to the end of the region
and release; Right click to extend the marked region; Left double-click		and release; Right click to extend the marked region; Left double-click
to select a word; Left triple-click to select the entire logical line		to select a word; Left triple-click to select the entire logical line
(which can span multiple screen lines), unless modified by resource		(which can span multiple screen lines), unless modified by resource
B<tripleclickwords>.		B<tripleclickwords>.

Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)		Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)

skipping to change at line 1430		skipping to change at line 1483
rxvt-unicode will automatically re-apply these fonts to the output so far.		rxvt-unicode will automatically re-apply these fonts to the output so far.

=head1 ISO 14755 SUPPORT		=head1 ISO 14755 SUPPORT

ISO 14755 is a standard for entering and viewing unicode characters		ISO 14755 is a standard for entering and viewing unicode characters
and character codes using the keyboard. It consists of 4 parts. The		and character codes using the keyboard. It consists of 4 parts. The
first part is available if rxvt-unicode has been compiled with		first part is available if rxvt-unicode has been compiled with
C<--enable-frills>, the rest is available when rxvt-unicode was compiled		C<--enable-frills>, the rest is available when rxvt-unicode was compiled
with C<--enable-iso14755>.		with C<--enable-iso14755>.


=over 4		=over

=item * 5.1: Basic method		=item * 5.1: Basic method

This allows you to enter unicode characters using their hexcode.		This allows you to enter unicode characters using their hexcode.

Start by pressing and holding both C<Control> and C<Shift>, then enter		Start by pressing and holding both C<Control> and C<Shift>, then enter
hex-digits (between one and six). Releasing C<Control> and C<Shift> will		hex-digits (between one and six). Releasing C<Control> and C<Shift> will
commit the character as if it were typed directly. While holding down		commit the character as if it were typed directly. While holding down
C<Control> and C<Shift> you can also enter multiple characters by pressing		C<Control> and C<Shift> you can also enter multiple characters by pressing
C<Space>, which will commit the current character and lets you start a new		C<Space>, which will commit the current character and lets you start a new

skipping to change at line 1620		skipping to change at line 1673
fully opaque on servers not supporting the RENDER EXTENSION.		fully opaque on servers not supporting the RENDER EXTENSION.

Please note that due to bugs in Xft, specifying alpha values might result		Please note that due to bugs in Xft, specifying alpha values might result
in garbage being displayed when the X-server does not support the RENDER		in garbage being displayed when the X-server does not support the RENDER
extension.		extension.

=head1 ENVIRONMENT		=head1 ENVIRONMENT

B<@@RXVT_NAME@@> sets and/or uses the following environment variables:		B<@@RXVT_NAME@@> sets and/or uses the following environment variables:


=over 4		=over

=item B<TERM>		=item B<TERM>

Normally set to C<rxvt-unicode>, unless overwritten at configure time, via		Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
resources or on the command line.		resources or on the command line.

=item B<COLORTERM>		=item B<COLORTERM>

Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was		Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
compiled with background image support, and optionally with the added		compiled with background image support, and optionally with the added

skipping to change at line 1701		skipping to change at line 1754

=item B<XENVIRONMENT>		=item B<XENVIRONMENT>

If set and accessible, gives the name of a X resource file to be loaded by		If set and accessible, gives the name of a X resource file to be loaded by
@@RXVT_NAME@@.		@@RXVT_NAME@@.

=back		=back

=head1 FILES		=head1 FILES


=over 4		=over

=item B</usr/lib/X11/rgb.txt>		=item B</usr/lib/X11/rgb.txt>

Colour names.		Colour names.

=back		=back

=head1 SEE ALSO		=head1 SEE ALSO

@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions (1),		@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions (1),
@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)		@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)

=head1 CURRENT PROJECT COORDINATOR		=head1 CURRENT PROJECT COORDINATOR


=over 4		=over

=item Project Coordinator		=item Project Coordinator

Marc A. Lehmann <rxvt-unicode@schmorp.de>.		Marc A. Lehmann <rxvt-unicode@schmorp.de>.

L<http://software.schmorp.de/pkg/rxvt-unicode.html>		L<http://software.schmorp.de/pkg/rxvt-unicode.html>

=back		=back

=head1 AUTHORS		=head1 AUTHORS


=over 4		=over

=item John Bovey		=item John Bovey

University of Kent, 1992, wrote the original Xvt.		University of Kent, 1992, wrote the original Xvt.

=item Rob Nation <nation@rocket.sanders.lockheed.com>		=item Rob Nation <nation@rocket.sanders.lockheed.com>

very heavily modified Xvt and came up with Rxvt		very heavily modified Xvt and came up with Rxvt

=item Angelo Haritsis <ah@doc.ic.ac.uk>		=item Angelo Haritsis <ah@doc.ic.ac.uk>

End of changes. 17 change blocks.
17 lines changed or deleted		71 lines changed or added

"Fossies" - the Fresh Open Source Software Archive

Source code changes of the file "doc/rxvt.1.pod" betweenrxvt-unicode-9.26.tar.bz2 and rxvt-unicode-9.29.tar.bz2

Source code changes of the file "doc/rxvt.1.pod" between
rxvt-unicode-9.26.tar.bz2 and rxvt-unicode-9.29.tar.bz2