repo: rxvt-unicode-sixel
action: commit
revision:
path_from:
revision_from: dddf2b69f28580ec07b900df3a15c9d1ca2c8737:
path_to:
revision_to:
commit dddf2b69f28580ec07b900df3a15c9d1ca2c8737
Author: Marc Lehmann
Date: Thu Aug 12 20:42:13 2004 +0000
*** empty log message ***
diff --git a/doc/rxvt.1.pod b/doc/rxvt.1.pod
new file mode 100644
index 0000000000000000000000000000000000000000..d75bbb0d45dd89bd55e776aed4e149dc501f8e1d
--- /dev/null
+++ b/doc/rxvt.1.pod
@@ -0,0 +1,915 @@
+=head1 NAME
+
+rxvt-unicode (ouR XVT, unicode) - (a VT102 emulator for the X window system)
+
+=head1 SYNOPSIS
+
+B<@@RXVTNAME@@> [options] [-e command [ args ]]
+
+=head1 DESCRIPTION
+
+B, version B<@@RXVTVERSION@@>, is a colour vt102 terminal
+emulator intended as an I(1) replacement for users who do not
+require features such as Tektronix 4014 emulation and toolkit-style
+configurability. As a result, B uses much less swap space --
+a significant advantage on a machine serving many X sessions.
+
+=head1 OPTIONS
+
+The B<@@RXVTNAME@@> options (mostly a subset of I's) are listed
+below. In keeping with the smaller-is-better philosophy, options may be
+eliminated or default values chosen at compile-time, so options and
+defaults listed may not accurately reflect the version installed on
+your system. `rxvt -h' gives a list of major compile-time options on
+the I line. Option descriptions may be prefixed with which
+compile option each is dependent upon. e.g. `Compile I:' requires
+I on the I line. Note: `rxvt -help' gives a list of all
+command-line options compiled into your version.
+
+Note that B<@@RXVTNAME@@> permits the resource name to be used as a
+long-option (--/++ option) so the potential command-line options are
+far greater than those listed. For example: `rxvt --loginShell --color1
+Orange'.
+
+The following options are available:
+
+=over 4
+
+=item B<-help>, B<--help>
+
+Print out a message describing available options.
+
+=item B<-display> I
+
+Attempt to open a window on the named X display (B<-d> still
+respected). In the absence of this option, the display specified by the
+B environment variable is used.
+
+=item B<-geometry> I
+
+Window geometry (B<-g> still respected); resource B.
+
+=item B<-rv>|B<+rv>
+
+Turn on/off simulated reverse video; resource B.
+
+=item B<-j>|B<+j>
+
+Turn on/off jump scrolling; resource B.
+
+=item B<-ip>|B<+ip>
+
+Turn on/off inheriting parent window's pixmap. Alternative form is
+B<-tr>; resource B.
+
+=item B<-fade> I
+
+Fade the text by the given percentage when focus is lost.
+
+=item B<-tint> I
+
+Tint the transparent background pixmap with the given colour when
+transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>
+option that can be used to brighten or darken the image in addition to
+tinting it.
+
+=item B<-sh>
+
+I Darken (0 .. 100) or lighten (-1 .. -100) the transparent
+background image in addition to tinting it (i.e. B<-tint> must be
+specified, too).
+
+=item B<-bg> I
+
+Window background colour; resource B.
+
+=item B<-fg> I
+
+Window foreground colour; resource B.
+
+=item B<-pixmap> I
+
+Compile I: Specify XPM file for the background and also optionally
+specify its scaling with a geometry string. Note you may need to add
+quotes to avoid special shell interpretation of the `;' in the
+command-line; resource B.
+
+=item B<-cr> I
+
+The cursor colour; resource B.
+
+=item B<-pr> I
+
+The mouse pointer foreground colour; resource B.
+
+=item B<-pr2> I
+
+The mouse pointer background colour; resource B.
+
+=item B<-bd> I
+
+The colour of the border between the xterm scrollbar and the text;
+resource B.
+
+=item B<-fn> I
+
+Select the fonts to be used. This is a comma seperated list of font
+names that are used in turn when trying to display Unicode characters.
+The first font defines the cell size for characters; other fonts might
+be smaller, but not larger. A reasonable default font list is always
+appended to it. resource B.
+
+=item B<-rb>|B<+rb>
+
+Enable "real bold" support. When this option is on, bold text will be
+displayed using the first available bold font in the font list. Bold
+fonts should thus be specified in the font list after their
+corresponding regular fonts. If no bold font can be found, a regular
+font will be used. resource B.
+
+=item B<-name> I
+
+Specify the application name under which resources are to be obtained,
+rather than the default executable file name. Name should not contain
+`.' or `*' characters. Also sets the icon and title name.
+
+=item B<-ls>|B<+ls>
+
+Start as a login-shell/sub-shell; resource B.
+
+=item B<-ut>|B<+ut>
+
+Compile I: Inhibit/enable writing a utmp entry; resource
+B.
+
+=item B<-vb>|B<+vb>
+
+Turn on/off visual bell on receipt of a bell character; resource
+B.
+
+=item B<-sb>|B<+sb>
+
+Turn on/off scrollbar; resource B.
+
+=item B<-si>|B<+si>
+
+Turn on/off scroll-to-bottom on TTY output inhibit; resource
+B has opposite effect.
+
+=item B<-sk>|B<+sk>
+
+Turn on/off scroll-to-bottom on keypress; resource
+B.
+
+=item B<-sw>|B<+sw>
+
+Turn on/off scrolling with the scrollback buffer as new lines appear.
+This only takes effect if B<-si> is also given; resource
+B.
+
+=item B<-sr>|B<+sr>
+
+Put scrollbar on right/left; resource B.
+
+=item B<-st>|B<+st>
+
+Display normal (non XTerm/NeXT) scrollbar without/with a trough;
+resource B.
+
+=item B<-bc>|B<+bc>
+
+Blink the cursor; resource B.
+
+=item B<-iconic>
+
+Start iconified, if the window manager supports that option.
+Alternative form is B<-ic>.
+
+=item B<-sl> I
+
+Save I lines in the scrollback buffer. See resource entry for
+limits; resource B.
+
+=item B<-b> I
+
+Compile I: Internal border of I pixels. See resource
+entry for limits; resource B.
+
+=item B<-w> I
+
+Compile I: External border of I pixels. Also, B<-bw>
+and B<-borderwidth>. See resource entry for limits; resource
+B.
+
+=item B<-bl>
+
+Compile I: Set MWM hints to request a borderless window, i.e.
+if honoured by the WM, the rxvt window will not have window
+decorations; resource B.
+
+=item B<-lsp> I
+
+Compile I: Lines (pixel height) to insert between each row
+of the display; resource B.
+
+=item B<-tn> I
+
+This option specifies the name of the terminal type to be set in the
+B environment variable. This terminal type must exist in the
+I database and should have I and I entries;
+resource B.
+
+=item B<-e> I
+
+Run the command with its command-line arguments in the B<@@RXVTNAME@@>
+window; also sets the window title and icon name to be the basename of
+the program being executed if neither I<-title> (I<-T>) nor I<-n> are
+given on the command line. If this option is used, it must be the last
+on the command-line. If there is no B<-e> option then the default is to
+run the program specified by the B environment variable or,
+failing that, I.
+
+=item B<-title> I
+
+Window title (B<-T> still respected); the default title is the basename
+of the program specified after the B<-e> option, if any, otherwise the
+application name; resource B.
+
+=item B<-n> I
+
+Icon name; the default name is the basename of the program specified
+after the B<-e> option, if any, otherwise the application name;
+resource B.
+
+=item B<-C>
+
+Capture system console messages.
+
+=item B<-pt> I