doc/yodl/rxvt-options.yo

   1 COMMENT(-- $Id: rxvt-options.yo,v 1.2 2003-11-24 17:31:27 pcg Exp $ --)
   2 COMMENT(----------------------------------------------------------------------)
   3 manpageoptions()
   4
   5 The bf(rxvt) options (mostly a subset of em(xterm)'s) are listed below.
   6 In keeping with the smaller-is-better philosophy, options may be eliminated
   7 or default values chosen at compile-time, so options and defaults listed
   8 may not accurately reflect the version installed on your system.
   9 `rxvt -h' gives a list of major compile-time options on the em(Options) line.
  10 Option descriptions may be prefixed with which compile option each is
  11 dependent upon.  e.g. `Compile em(XIM):' requires em(XIM) on the em(Options)
  12 line.  Note: `rxvt -help' gives a list of all command-line options compiled
  13 into your version.
  14
  15 Note that bf(rxvt) permits the resource name to be used as a long-option
  16 (--/++ option) so the potential command-line options are far greater than
  17 those listed.
  18 For example: `rxvt --loginShell --color1 Orange'.
  19
  20 Also note that if you do not explictly specify a font (bf(-fn) and bf(-fm))
  21 or a multichar encoding method (bf(-km)), rxvt will select a font for the
  22 preferable encoding according to your locale.  Supported encodings are:
  23 bf(ISO-8859-)n (n=bf(1)...bf(15)), bf(KOI8-R), bf(KOI8-U), bf(EUC-JP),
  24 bf(Shift_JIS), bf(EUC-KR), bf(EUC-CN) (aka bf(GB)), and bf(Big5).
  25
  26 The following options are available:
  27
  28 startdit()
  29     dit(bf(-help), bf(--help))
  30         Print out a message describing available options.
  31     dit(bf(-display) em(displayname))
  32         Attempt to open a window on the named X display (bf(-d) still
  33         respected).  In the absence of this option, the display specified
  34         by the bf(DISPLAY) environment variable is used.
  35     dit(bf(-geometry) em(geom))
  36         Window geometry (bf(-g) still respected);
  37         resource bf(geometry).
  38     dit(bf(-rv)|bf(+rv))
  39         Turn on/off simulated reverse video;
  40         resource bf(reverseVideo).
  41     dit(bf(-j)|bf(+j))
  42         Turn on/off jump scrolling;
  43         resource bf(jumpScroll).
  44     dit(bf(-ip)|bf(+ip))
  45         Turn on/off inheriting parent window's pixmap.  Alternative form
  46         is bf(-tr);
  47         resource bf(inheritPixmap).
  48     dit(bf(-bg) em(colour))
  49         Window background colour;
  50         resource bf(background).
  51     dit(bf(-fg) em(colour))
  52         Window foreground colour;
  53         resource bf(foreground).
  54     dit(bf(-pixmap:) em(file[;geom]))
  55         Compile em(XPM): Specify XPM file for the background and also
  56         optionally specify its scaling with a geometry string.  Note you
  57         may need to add quotes to avoid special shell interpretation of
  58         the `;' in the command-line;
  59         resource bf(backgroundPixmap).
  60     dit(bf(-cr) em(colour))
  61         The cursor colour;
  62         resource bf(cursorColor).
  63     dit(bf(-pr) em(colour))
  64         The mouse pointer colour;
  65         resource bf(pointerColor).
  66     dit(bf(-bd) em(colour))
  67         The colour of the border between the xterm scrollbar and the text;
  68         resource bf(borderColor).
  69     dit(bf(-fn) em(fontname))
  70         Main normal text font;
  71         resource bf(font).
  72     dit(bf(-fb) em(fontname))
  73         Main bold text font;
  74         resource bf(boldFont).
  75     dit(bf(-fm) em(fontname))
  76         Main multicharacter font;
  77         resource bf(mfont).
  78     dit(bf(-km) em(mode))
  79         Compile em(multichar_languages):
  80         Multiple-character font-set encoding mode;
  81         bf(eucj): EUC Japanese encoding.
  82         bf(sjis): Shift JIS encoding.
  83         bf(big5): BIG5 encoding.
  84         bf(gb): GB encoding.
  85         bf(kr): EUC Korean encoding.
  86         bf(noenc): no encoding;
  87         resource bf(multichar_encoding).
  88     dit(bf(-grk) em(mode))
  89         Compile em(Greek): Greek keyboard translation;
  90         bf(iso): ISO-8859 mapping.
  91         bf(ibm): IBM-437 mapping;
  92         resource bf(greek_keyboard).
  93     dit(bf(-name) em(name))
  94         Specify the application name under which resources
  95         are to be obtained, rather than the default executable file name.
  96         Name should not contain `.' or `*' characters.
  97         Also sets the icon and title name.
  98     dit(bf(-ls)|bf(+ls))
  99         Start as a login-shell/sub-shell;
 100         resource bf(loginShell).
 101     dit(bf(-ut)|bf(+ut))
 102         Compile em(utmp): Inhibit/enable writing a utmp entry;
 103         resource bf(utmpInhibit).
 104     dit(bf(-vb)|bf(+vb))
 105         Turn on/off visual bell on receipt of a bell character;
 106         resource bf(visualBell).
 107     dit(bf(-sb)|bf(+sb))
 108         Turn on/off scrollbar;
 109         resource bf(scrollBar).
 110     dit(bf(-si)|bf(+si))
 111         Turn on/off scroll-to-bottom on TTY output inhibit;
 112         resource bf(scrollTtyOutput) has opposite effect.
 113     dit(bf(-sk)|bf(+sk))
 114         Turn on/off scroll-to-bottom on keypress;
 115         resource bf(scrollTtyKeypress).
 116     dit(bf(-sw)|bf(+sw))
 117         Turn on/off scrolling with the scrollback buffer as new
 118         lines appear.  This only takes effect if bf(-si) is also given;
 119         resource bf(scrollWithBuffer).
 120     dit(bf(-sr)|bf(+sr))
 121         Put scrollbar on right/left;
 122         resource bf(scrollBar_right).
 123     dit(bf(-st)|bf(+st))
 124         Display normal (non XTerm/NeXT) scrollbar without/with a trough;
 125         resource bf(scrollBar_floating).
 126     dit(bf(-mcc)|bf(+mcc))
 127         Compile em(multichar_languages): treat multibyte glyphs as single
 128         character for backspace, delete and cursor movement keys;
 129         resource bf(multibyte_cursor).
 130     dit(bf(-bc)|bf(+bc))
 131         Blink the cursor; resource bf(cursorBlink).
 132     dit(bf(-iconic))
 133         Start iconified, if the window manager supports that option.
 134         Alternative form is bf(-ic).
 135     dit(bf(-sl) em(number))
 136         Save em(number) lines in the scrollback buffer.  See resource entry
 137         for limits;
 138         resource bf(saveLines).
 139     dit(bf(-b) em(number))
 140         Compile em(frills): Internal border of em(number) pixels.  See
 141         resource entry for limits;
 142         resource bf(internalBorder).
 143     dit(bf(-w) em(number))
 144         Compile em(frills): External border of em(number) pixels.
 145         Also, bf(-bw) and bf(-borderwidth).  See resource entry for limits;
 146         resource bf(externalBorder).
 147     dit(bf(-lsp) em(number))
 148         Compile em(linespace): Lines (pixel height) to insert between each
 149         row of the display;
 150         resource bf(linespace).
 151     dit(bf(-tn) em(termname))
 152         This option specifies the name of the terminal type to be set in the
 153         bf(TERM) environment variable. This terminal type must exist in the
 154         em(termcap(5)) database and should have em(li#) and em(co#) entries;
 155         resource bf(termName).
 156     dit(bf(-e) em(command [arguments]))
 157         Run the command with its command-line arguments in the bf(rxvt)
 158         window; also sets the window title and icon name to be the basename
 159         of the program being executed if neither em(-title) (em(-T)) nor
 160         em(-n) are given on the command line.  If this option is used, it
 161         must be the last on the command-line.  If there is no bf(-e) option
 162         then the default is to run the program specified by the bf(SHELL)
 163         environment variable or, failing that, em(sh(1)).
 164     dit(bf(-title) em(text))
 165         Window title (bf(-T) still respected); the default title is the
 166         basename of the program specified after the bf(-e) option, if
 167         any, otherwise the application name;
 168         resource bf(title).
 169     dit(bf(-n) em(text))
 170         Icon name; the default name is the basename of the program specified
 171         after the bf(-e) option, if any, otherwise the application name;
 172         resource bf(iconName).
 173     dit(bf(-C))
 174         Capture system console messages.
 175     dit(bf(-pt) em(style))
 176         Compile em(XIM): input style for input method;
 177         bf(OverTheSpot), bf(OffTheSpot), bf(Root);
 178         resource bf(preeditType).
 179     dit(bf(-im) em(text))
 180         Compile em(XIM): input method name.
 181         resource bf(inputMethod).
 182     dit(bf(-mod) em(modifier))
 183         Override detection of Meta modifier with specified key:
 184         bf(alt), bf(meta), bf(hyper), bf(super), bf(mod1), bf(mod2), bf(mod3),
 185         bf(mod4), bf(mod5);
 186         resource em(modifier).
 187     dit(bf(-xrm) em(resourcestring))
 188         No effect on rxvt.  Simply passes through an argument to be made
 189         available in the instance's argument list.  Appears in em(WM_COMMAND)
 190         in some window managers.
 191 enddit()