| 1 |
COMMENT(-- $Id: rxvt-options.yo,v 1.18 2004/08/01 15:06:02 root Exp $ --) |
| 2 |
COMMENT(----------------------------------------------------------------------) |
| 3 |
manpageoptions() |
| 4 |
|
| 5 |
The bf(RXVTNAME()) 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(RXVTNAME()) 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 |
The following options are available: |
| 21 |
|
| 22 |
startdit() |
| 23 |
dit(bf(-help), bf(--help)) |
| 24 |
Print out a message describing available options. |
| 25 |
dit(bf(-display) em(displayname)) |
| 26 |
Attempt to open a window on the named X display (bf(-d) still |
| 27 |
respected). In the absence of this option, the display specified |
| 28 |
by the bf(DISPLAY) environment variable is used. |
| 29 |
dit(bf(-geometry) em(geom)) |
| 30 |
Window geometry (bf(-g) still respected); |
| 31 |
resource bf(geometry). |
| 32 |
dit(bf(-rv)|bf(+rv)) |
| 33 |
Turn on/off simulated reverse video; |
| 34 |
resource bf(reverseVideo). |
| 35 |
dit(bf(-j)|bf(+j)) |
| 36 |
Turn on/off jump scrolling; |
| 37 |
resource bf(jumpScroll). |
| 38 |
dit(bf(-ip)|bf(+ip)) |
| 39 |
Turn on/off inheriting parent window's pixmap. Alternative form |
| 40 |
is bf(-tr); |
| 41 |
resource bf(inheritPixmap). |
| 42 |
dit(bf(-fade) em(number)) |
| 43 |
Fade the text by the given percentage when focus is lost. |
| 44 |
dit(bf(-tint) em(colour)) |
| 45 |
Tint the transparent background pixmap with the given colour when |
| 46 |
transparency is enabled with bf(-tr) or bf(-ip). See also |
| 47 |
the bf(-sh) option that can be used to brighten or darken |
| 48 |
the image in addition to tinting it. |
| 49 |
dit(bf(-sh)) em(number) |
| 50 |
Darken (0 .. 100) or lighten (-1 .. -100) the transparent background |
| 51 |
image in addition to tinting it (i.e. bf(-tint) must be specified, too). |
| 52 |
dit(bf(-bg) em(colour)) |
| 53 |
Window background colour; |
| 54 |
resource bf(background). |
| 55 |
dit(bf(-fg) em(colour)) |
| 56 |
Window foreground colour; |
| 57 |
resource bf(foreground). |
| 58 |
dit(bf(-pixmap) em(file[;geom])) |
| 59 |
Compile em(XPM): Specify XPM file for the background and also |
| 60 |
optionally specify its scaling with a geometry string. Note you |
| 61 |
may need to add quotes to avoid special shell interpretation of |
| 62 |
the `;' in the command-line; |
| 63 |
resource bf(backgroundPixmap). |
| 64 |
dit(bf(-cr) em(colour)) |
| 65 |
The cursor colour; |
| 66 |
resource bf(cursorColor). |
| 67 |
dit(bf(-pr) em(colour)) |
| 68 |
The mouse pointer foreground colour; |
| 69 |
resource bf(pointerColor). |
| 70 |
dit(bf(-pr2) em(colour)) |
| 71 |
The mouse pointer background colour; |
| 72 |
resource bf(pointerColor2). |
| 73 |
dit(bf(-bd) em(colour)) |
| 74 |
The colour of the border between the xterm scrollbar and the text; |
| 75 |
resource bf(borderColor). |
| 76 |
dit(bf(-fn) em(fontname)) |
| 77 |
Select the fonts to be used. |
| 78 |
This is a comma seperated list of font names that are used in turn when |
| 79 |
trying to display Unicode characters. |
| 80 |
The first font defines the cell size for characters; other fonts might |
| 81 |
be smaller, but not larger. |
| 82 |
A reasonable default font list is always appended to it. |
| 83 |
resource bf(font). |
| 84 |
dit(bf(-rb)|bf(+rb)) |
| 85 |
Enable "real bold" support. |
| 86 |
When this option is on, bold text will be displayed using the first |
| 87 |
available bold font in the font list. |
| 88 |
Bold fonts should thus be specified in the font list after their |
| 89 |
corresponding regular fonts. |
| 90 |
If no bold font can be found, a regular font will be used. |
| 91 |
resource bf(realBold). |
| 92 |
dit(bf(-name) em(name)) |
| 93 |
Specify the application name under which resources |
| 94 |
are to be obtained, rather than the default executable file name. |
| 95 |
Name should not contain `.' or `*' characters. |
| 96 |
Also sets the icon and title name. |
| 97 |
dit(bf(-ls)|bf(+ls)) |
| 98 |
Start as a login-shell/sub-shell; |
| 99 |
resource bf(loginShell). |
| 100 |
dit(bf(-ut)|bf(+ut)) |
| 101 |
Compile em(utmp): Inhibit/enable writing a utmp entry; |
| 102 |
resource bf(utmpInhibit). |
| 103 |
dit(bf(-vb)|bf(+vb)) |
| 104 |
Turn on/off visual bell on receipt of a bell character; |
| 105 |
resource bf(visualBell). |
| 106 |
dit(bf(-sb)|bf(+sb)) |
| 107 |
Turn on/off scrollbar; |
| 108 |
resource bf(scrollBar). |
| 109 |
dit(bf(-si)|bf(+si)) |
| 110 |
Turn on/off scroll-to-bottom on TTY output inhibit; |
| 111 |
resource bf(scrollTtyOutput) has opposite effect. |
| 112 |
dit(bf(-sk)|bf(+sk)) |
| 113 |
Turn on/off scroll-to-bottom on keypress; |
| 114 |
resource bf(scrollTtyKeypress). |
| 115 |
dit(bf(-sw)|bf(+sw)) |
| 116 |
Turn on/off scrolling with the scrollback buffer as new |
| 117 |
lines appear. This only takes effect if bf(-si) is also given; |
| 118 |
resource bf(scrollWithBuffer). |
| 119 |
dit(bf(-sr)|bf(+sr)) |
| 120 |
Put scrollbar on right/left; |
| 121 |
resource bf(scrollBar_right). |
| 122 |
dit(bf(-st)|bf(+st)) |
| 123 |
Display normal (non XTerm/NeXT) scrollbar without/with a trough; |
| 124 |
resource bf(scrollBar_floating). |
| 125 |
dit(bf(-bc)|bf(+bc)) |
| 126 |
Blink the cursor; resource bf(cursorBlink). |
| 127 |
dit(bf(-iconic)) |
| 128 |
Start iconified, if the window manager supports that option. |
| 129 |
Alternative form is bf(-ic). |
| 130 |
dit(bf(-sl) em(number)) |
| 131 |
Save em(number) lines in the scrollback buffer. See resource entry |
| 132 |
for limits; |
| 133 |
resource bf(saveLines). |
| 134 |
dit(bf(-b) em(number)) |
| 135 |
Compile em(frills): Internal border of em(number) pixels. See |
| 136 |
resource entry for limits; |
| 137 |
resource bf(internalBorder). |
| 138 |
dit(bf(-w) em(number)) |
| 139 |
Compile em(frills): External border of em(number) pixels. |
| 140 |
Also, bf(-bw) and bf(-borderwidth). See resource entry for limits; |
| 141 |
resource bf(externalBorder). |
| 142 |
dit(bf(-bl)) |
| 143 |
Compile em(frills): Set MWM hints to request a borderless window, |
| 144 |
i.e. if honoured by the WM, the rxvt window will not have window |
| 145 |
decorations; resource bf(borderLess). |
| 146 |
dit(bf(-lsp) em(number)) |
| 147 |
Compile em(linespace): Lines (pixel height) to insert between each |
| 148 |
row of the display; |
| 149 |
resource bf(linespace). |
| 150 |
dit(bf(-tn) em(termname)) |
| 151 |
This option specifies the name of the terminal type to be set in the |
| 152 |
bf(TERM) environment variable. This terminal type must exist in the |
| 153 |
em(termcap(5)) database and should have em(li#) and em(co#) entries; |
| 154 |
resource bf(termName). |
| 155 |
dit(bf(-e) em(command [arguments])) |
| 156 |
Run the command with its command-line arguments in the bf(RXVTNAME()) |
| 157 |
window; also sets the window title and icon name to be the basename |
| 158 |
of the program being executed if neither em(-title) (em(-T)) nor |
| 159 |
em(-n) are given on the command line. If this option is used, it |
| 160 |
must be the last on the command-line. If there is no bf(-e) option |
| 161 |
then the default is to run the program specified by the bf(SHELL) |
| 162 |
environment variable or, failing that, em(sh(1)). |
| 163 |
dit(bf(-title) em(text)) |
| 164 |
Window title (bf(-T) still respected); the default title is the |
| 165 |
basename of the program specified after the bf(-e) option, if |
| 166 |
any, otherwise the application name; |
| 167 |
resource bf(title). |
| 168 |
dit(bf(-n) em(text)) |
| 169 |
Icon name; the default name is the basename of the program specified |
| 170 |
after the bf(-e) option, if any, otherwise the application name; |
| 171 |
resource bf(iconName). |
| 172 |
dit(bf(-C)) |
| 173 |
Capture system console messages. |
| 174 |
dit(bf(-pt) em(style)) |
| 175 |
Compile em(XIM): input style for input method; |
| 176 |
bf(OverTheSpot), bf(OffTheSpot), bf(Root); |
| 177 |
resource bf(preeditType). |
| 178 |
dit(bf(-im) em(text)) |
| 179 |
Compile em(XIM): input method name. |
| 180 |
resource bf(inputMethod). |
| 181 |
dit(bf(-imlocale) em(string)) |
| 182 |
The locale to use for opening the IM. You can use an LC_CTYPE |
| 183 |
of e.g. de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP |
| 184 |
for the input extension to be able to input japanese characters |
| 185 |
while staying in another locale. |
| 186 |
dit(bf(-insecure)) |
| 187 |
Enable "insecure" mode, which currently enables most of the escape |
| 188 |
sequences that echo strings. See the resource bf(insecure) for |
| 189 |
more info. |
| 190 |
dit(bf(-mod) em(modifier)) |
| 191 |
Override detection of Meta modifier with specified key: |
| 192 |
bf(alt), bf(meta), bf(hyper), bf(super), bf(mod1), bf(mod2), bf(mod3), |
| 193 |
bf(mod4), bf(mod5); |
| 194 |
resource em(modifier). |
| 195 |
dit(bf(-ssc)|bf(+ssc)) |
| 196 |
Turn on/off secondary screen (default enabled); |
| 197 |
resource bf(secondaryScreen). |
| 198 |
dit(bf(-ssr)|bf(+ssr)) |
| 199 |
Turn on/off secondary screen scroll (default enabled); |
| 200 |
resource bf(secondaryScroll). |
| 201 |
dit(bf(-xrm) em(resourcestring)) |
| 202 |
No effect on rxvt. Simply passes through an argument to be made |
| 203 |
available in the instance's argument list. Appears in em(WM_COMMAND) |
| 204 |
in some window managers. |
| 205 |
enddit() |
