ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/yodl/rxvt-options.yo
Revision: 1.3
Committed: Thu Dec 18 00:38:07 2003 UTC (20 years, 7 months ago) by pcg
Branch: MAIN
CVS Tags: stable, rel-1-3, rel-1-2
Changes since 1.2: +11 -24 lines
Log Message:
*** empty log message ***

File Contents

# User Rev Content
1 pcg 1.3 COMMENT(-- $Id: rxvt-options.yo,v 1.2 2003/11/24 17:31:27 pcg Exp $ --)
2 pcg 1.1 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     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(-bg) em(colour))
43     Window background colour;
44     resource bf(background).
45     dit(bf(-fg) em(colour))
46     Window foreground colour;
47     resource bf(foreground).
48     dit(bf(-pixmap:) em(file[;geom]))
49     Compile em(XPM): Specify XPM file for the background and also
50     optionally specify its scaling with a geometry string. Note you
51     may need to add quotes to avoid special shell interpretation of
52     the `;' in the command-line;
53     resource bf(backgroundPixmap).
54     dit(bf(-cr) em(colour))
55     The cursor colour;
56     resource bf(cursorColor).
57     dit(bf(-pr) em(colour))
58     The mouse pointer colour;
59     resource bf(pointerColor).
60     dit(bf(-bd) em(colour))
61     The colour of the border between the xterm scrollbar and the text;
62     resource bf(borderColor).
63     dit(bf(-fn) em(fontname))
64 pcg 1.3 Select the fonts to be used used. This is a comma seperated
65     list of font names that are used in turn when trying to display
66     unicode characters. The first font defines the cell size for characters,
67     pther fonts might be smaller, but not larger. A reasonable default list
68     is appended.
69 pcg 1.1 resource bf(font).
70     dit(bf(-grk) em(mode))
71     Compile em(Greek): Greek keyboard translation;
72     bf(iso): ISO-8859 mapping.
73     bf(ibm): IBM-437 mapping;
74     resource bf(greek_keyboard).
75     dit(bf(-name) em(name))
76     Specify the application name under which resources
77     are to be obtained, rather than the default executable file name.
78     Name should not contain `.' or `*' characters.
79     Also sets the icon and title name.
80     dit(bf(-ls)|bf(+ls))
81     Start as a login-shell/sub-shell;
82     resource bf(loginShell).
83     dit(bf(-ut)|bf(+ut))
84     Compile em(utmp): Inhibit/enable writing a utmp entry;
85     resource bf(utmpInhibit).
86     dit(bf(-vb)|bf(+vb))
87     Turn on/off visual bell on receipt of a bell character;
88     resource bf(visualBell).
89     dit(bf(-sb)|bf(+sb))
90     Turn on/off scrollbar;
91     resource bf(scrollBar).
92     dit(bf(-si)|bf(+si))
93     Turn on/off scroll-to-bottom on TTY output inhibit;
94     resource bf(scrollTtyOutput) has opposite effect.
95     dit(bf(-sk)|bf(+sk))
96     Turn on/off scroll-to-bottom on keypress;
97     resource bf(scrollTtyKeypress).
98     dit(bf(-sw)|bf(+sw))
99     Turn on/off scrolling with the scrollback buffer as new
100     lines appear. This only takes effect if bf(-si) is also given;
101     resource bf(scrollWithBuffer).
102     dit(bf(-sr)|bf(+sr))
103     Put scrollbar on right/left;
104     resource bf(scrollBar_right).
105     dit(bf(-st)|bf(+st))
106     Display normal (non XTerm/NeXT) scrollbar without/with a trough;
107     resource bf(scrollBar_floating).
108     dit(bf(-mcc)|bf(+mcc))
109     Compile em(multichar_languages): treat multibyte glyphs as single
110     character for backspace, delete and cursor movement keys;
111     resource bf(multibyte_cursor).
112     dit(bf(-bc)|bf(+bc))
113     Blink the cursor; resource bf(cursorBlink).
114     dit(bf(-iconic))
115     Start iconified, if the window manager supports that option.
116     Alternative form is bf(-ic).
117     dit(bf(-sl) em(number))
118     Save em(number) lines in the scrollback buffer. See resource entry
119     for limits;
120     resource bf(saveLines).
121     dit(bf(-b) em(number))
122     Compile em(frills): Internal border of em(number) pixels. See
123     resource entry for limits;
124     resource bf(internalBorder).
125     dit(bf(-w) em(number))
126     Compile em(frills): External border of em(number) pixels.
127     Also, bf(-bw) and bf(-borderwidth). See resource entry for limits;
128     resource bf(externalBorder).
129     dit(bf(-lsp) em(number))
130     Compile em(linespace): Lines (pixel height) to insert between each
131     row of the display;
132     resource bf(linespace).
133     dit(bf(-tn) em(termname))
134     This option specifies the name of the terminal type to be set in the
135     bf(TERM) environment variable. This terminal type must exist in the
136     em(termcap(5)) database and should have em(li#) and em(co#) entries;
137     resource bf(termName).
138     dit(bf(-e) em(command [arguments]))
139     Run the command with its command-line arguments in the bf(rxvt)
140     window; also sets the window title and icon name to be the basename
141     of the program being executed if neither em(-title) (em(-T)) nor
142     em(-n) are given on the command line. If this option is used, it
143     must be the last on the command-line. If there is no bf(-e) option
144     then the default is to run the program specified by the bf(SHELL)
145     environment variable or, failing that, em(sh(1)).
146     dit(bf(-title) em(text))
147     Window title (bf(-T) still respected); the default title is the
148     basename of the program specified after the bf(-e) option, if
149     any, otherwise the application name;
150     resource bf(title).
151     dit(bf(-n) em(text))
152     Icon name; the default name is the basename of the program specified
153     after the bf(-e) option, if any, otherwise the application name;
154     resource bf(iconName).
155     dit(bf(-C))
156     Capture system console messages.
157     dit(bf(-pt) em(style))
158     Compile em(XIM): input style for input method;
159     bf(OverTheSpot), bf(OffTheSpot), bf(Root);
160     resource bf(preeditType).
161     dit(bf(-im) em(text))
162     Compile em(XIM): input method name.
163     resource bf(inputMethod).
164 pcg 1.3 dit(bf(-imlocale) em(string))
165     The locale to use for opening the IM. You can use an LC_CTYPE
166     of e.g. de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP
167     for the input extension to be able to input japanese characters
168     while staying in another locale.
169 pcg 1.1 dit(bf(-mod) em(modifier))
170     Override detection of Meta modifier with specified key:
171     bf(alt), bf(meta), bf(hyper), bf(super), bf(mod1), bf(mod2), bf(mod3),
172     bf(mod4), bf(mod5);
173     resource em(modifier).
174     dit(bf(-xrm) em(resourcestring))
175     No effect on rxvt. Simply passes through an argument to be made
176     available in the instance's argument list. Appears in em(WM_COMMAND)
177     in some window managers.
178     enddit()