doc/yodl/rxvt-options.yo

COMMENT(-- $Id: rxvt-options.yo,v 1.10 2004/04/02 18:00:00 pcg Exp $ --)
COMMENT(----------------------------------------------------------------------)
manpageoptions()

The bf(RXVTNAME()) options (mostly a subset of em(xterm)'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 em(Options) line.
Option descriptions may be prefixed with which compile option each is
dependent upon.  e.g. `Compile em(XIM):' requires em(XIM) on the em(Options)
line.  Note: `rxvt -help' gives a list of all command-line options compiled
into your version.

Note that bf(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:

startdit()
    dit(bf(-help), bf(--help))
        Print out a message describing available options.
    dit(bf(-display) em(displayname))
        Attempt to open a window on the named X display (bf(-d) still
        respected).  In the absence of this option, the display specified
        by the bf(DISPLAY) environment variable is used.
    dit(bf(-geometry) em(geom))
        Window geometry (bf(-g) still respected);
        resource bf(geometry).
    dit(bf(-rv)|bf(+rv))
        Turn on/off simulated reverse video;
        resource bf(reverseVideo).
    dit(bf(-j)|bf(+j))
        Turn on/off jump scrolling;
        resource bf(jumpScroll).
    dit(bf(-ip)|bf(+ip))
        Turn on/off inheriting parent window's pixmap.  Alternative form
        is bf(-tr);
        resource bf(inheritPixmap).
    dit(bf(-tint) em(colour))
        Tint the transparent background pixmap with the given colour.
    dit(bf(-bg) em(colour))
        Window background colour;
        resource bf(background).
    dit(bf(-fg) em(colour))
        Window foreground colour;
        resource bf(foreground).
    dit(bf(-pixmap:) em(file[;geom]))
        Compile em(XPM): 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 bf(backgroundPixmap).
    dit(bf(-cr) em(colour))
        The cursor colour;
        resource bf(cursorColor).
    dit(bf(-pr) em(colour))
        The mouse pointer foreground colour;
        resource bf(pointerColor).
    dit(bf(-pr2) em(colour))
        The mouse pointer background colour;
        resource bf(pointerColor2).
    dit(bf(-bd) em(colour))
        The colour of the border between the xterm scrollbar and the text;
        resource bf(borderColor).
    dit(bf(-fn) em(fontname))
        Select the fonts to be used 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 bf(font).
    dit(bf(-name) em(name))
        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.
    dit(bf(-ls)|bf(+ls))
        Start as a login-shell/sub-shell;
        resource bf(loginShell).
    dit(bf(-ut)|bf(+ut))
        Compile em(utmp): Inhibit/enable writing a utmp entry;
        resource bf(utmpInhibit).
    dit(bf(-vb)|bf(+vb))
        Turn on/off visual bell on receipt of a bell character;
        resource bf(visualBell).
    dit(bf(-sb)|bf(+sb))
        Turn on/off scrollbar;
        resource bf(scrollBar).
    dit(bf(-si)|bf(+si))
        Turn on/off scroll-to-bottom on TTY output inhibit;
        resource bf(scrollTtyOutput) has opposite effect.
    dit(bf(-sk)|bf(+sk))
        Turn on/off scroll-to-bottom on keypress;
        resource bf(scrollTtyKeypress).
    dit(bf(-sw)|bf(+sw))
        Turn on/off scrolling with the scrollback buffer as new
        lines appear.  This only takes effect if bf(-si) is also given;
        resource bf(scrollWithBuffer).
    dit(bf(-sr)|bf(+sr)) 
        Put scrollbar on right/left;
        resource bf(scrollBar_right).
    dit(bf(-st)|bf(+st)) 
        Display normal (non XTerm/NeXT) scrollbar without/with a trough;
        resource bf(scrollBar_floating).
    dit(bf(-bc)|bf(+bc))
        Blink the cursor; resource bf(cursorBlink).
    dit(bf(-iconic)) 
        Start iconified, if the window manager supports that option.
        Alternative form is bf(-ic).
    dit(bf(-sl) em(number))
        Save em(number) lines in the scrollback buffer.  See resource entry
        for limits; 
        resource bf(saveLines).
    dit(bf(-b) em(number))
        Compile em(frills): Internal border of em(number) pixels.  See
        resource entry for limits;
        resource bf(internalBorder).
    dit(bf(-w) em(number))
        Compile em(frills): External border of em(number) pixels. 
        Also, bf(-bw) and bf(-borderwidth).  See resource entry for limits;
        resource bf(externalBorder).
    dit(bf(-lsp) em(number))
        Compile em(linespace): Lines (pixel height) to insert between each
        row of the display;
        resource bf(linespace).
    dit(bf(-tn) em(termname)) 
        This option specifies the name of the terminal type to be set in the
        bf(TERM) environment variable. This terminal type must exist in the
        em(termcap(5)) database and should have em(li#) and em(co#) entries;
        resource bf(termName).
    dit(bf(-e) em(command [arguments]))
        Run the command with its command-line arguments in the bf(RXVTNAME())
        window; also sets the window title and icon name to be the basename
        of the program being executed if neither em(-title) (em(-T)) nor
        em(-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 bf(-e) option
        then the default is to run the program specified by the bf(SHELL)
        environment variable or, failing that, em(sh(1)).
    dit(bf(-title) em(text))
        Window title (bf(-T) still respected); the default title is the
        basename of the program specified after the bf(-e) option, if
        any, otherwise the application name;
        resource bf(title).
    dit(bf(-n) em(text))
        Icon name; the default name is the basename of the program specified
        after the bf(-e) option, if any, otherwise the application name;
        resource bf(iconName).
    dit(bf(-C))
        Capture system console messages.
    dit(bf(-pt) em(style))
        Compile em(XIM): input style for input method;
        bf(OverTheSpot), bf(OffTheSpot), bf(Root);
        resource bf(preeditType).
    dit(bf(-im) em(text))
        Compile em(XIM): input method name.
        resource bf(inputMethod).
    dit(bf(-imlocale) em(string))
        The locale to use for opening the IM. You can use an LC_CTYPE
        of e.g. de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP
        for the input extension to be able to input japanese characters
        while staying in another locale.
    dit(bf(-insecure))
        Enable "insecure" mode, which currently enables most of the escape
        sequences that echo strings. See the resource bf(insecure) for
        more info.
    dit(bf(-mod) em(modifier))
        Override detection of Meta modifier with specified key:
        bf(alt), bf(meta), bf(hyper), bf(super), bf(mod1), bf(mod2), bf(mod3),
        bf(mod4), bf(mod5);
        resource em(modifier).
    dit(bf(-ssc)|bf(+ssc))
        Turn on/off secondary screen (default enabled);
        resource bf(secondaryScreen).
    dit(bf(-ssr)|bf(+ssr))
        Turn on/off secondary screen scroll (default enabled);
        resource bf(secondaryScroll).
    dit(bf(-xrm) em(resourcestring))
        No effect on rxvt.  Simply passes through an argument to be made
        available in the instance's argument list.  Appears in em(WM_COMMAND)
        in some window managers.
enddit()
Revision:	1.11
Committed:	Fri Apr 2 19:15:57 2004 UTC (20 years, 3 months ago) by pcg
Branch:	MAIN
CVS Tags:	rel-2_8, rel-3_0, rel-2_7
Changes since 1.10:	+5 -2 lines
Log Message:	* empty log message *
#	User	Rev	Content
1	pcg	1.11	COMMENT(-- $Id: rxvt-options.yo,v 1.10 2004/04/02 18:00:00 pcg Exp $ --)
2	pcg	1.1	COMMENT(----------------------------------------------------------------------)
3			manpageoptions()
4
5	pcg	1.6	The bf(RXVTNAME()) options (mostly a subset of em(xterm)'s) are listed below.
6	pcg	1.1	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	pcg	1.6	Note that bf(RXVTNAME()) permits the resource name to be used as a long-option
16	pcg	1.1	(--/++ 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	pcg	1.9	dit(bf(-tint) em(colour))
43			Tint the transparent background pixmap with the given colour.
44	pcg	1.1	dit(bf(-bg) em(colour))
45			Window background colour;
46			resource bf(background).
47			dit(bf(-fg) em(colour))
48			Window foreground colour;
49			resource bf(foreground).
50			dit(bf(-pixmap:) em(file[;geom]))
51			Compile em(XPM): Specify XPM file for the background and also
52			optionally specify its scaling with a geometry string. Note you
53			may need to add quotes to avoid special shell interpretation of
54			the `;' in the command-line;
55			resource bf(backgroundPixmap).
56			dit(bf(-cr) em(colour))
57			The cursor colour;
58			resource bf(cursorColor).
59			dit(bf(-pr) em(colour))
60	pcg	1.11	The mouse pointer foreground colour;
61	pcg	1.1	resource bf(pointerColor).
62	pcg	1.11	dit(bf(-pr2) em(colour))
63			The mouse pointer background colour;
64			resource bf(pointerColor2).
65	pcg	1.1	dit(bf(-bd) em(colour))
66			The colour of the border between the xterm scrollbar and the text;
67			resource bf(borderColor).
68			dit(bf(-fn) em(fontname))
69	pcg	1.3	Select the fonts to be used used. This is a comma seperated
70			list of font names that are used in turn when trying to display
71			unicode characters. The first font defines the cell size for characters,
72	pcg	1.7	other fonts might be smaller, but not larger. A reasonable default font list
73			is always appended to it.
74	pcg	1.1	resource bf(font).
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(-bc)\|bf(+bc))
109			Blink the cursor; resource bf(cursorBlink).
110			dit(bf(-iconic))
111			Start iconified, if the window manager supports that option.
112			Alternative form is bf(-ic).
113			dit(bf(-sl) em(number))
114			Save em(number) lines in the scrollback buffer. See resource entry
115			for limits;
116			resource bf(saveLines).
117			dit(bf(-b) em(number))
118			Compile em(frills): Internal border of em(number) pixels. See
119			resource entry for limits;
120			resource bf(internalBorder).
121			dit(bf(-w) em(number))
122			Compile em(frills): External border of em(number) pixels.
123			Also, bf(-bw) and bf(-borderwidth). See resource entry for limits;
124			resource bf(externalBorder).
125			dit(bf(-lsp) em(number))
126			Compile em(linespace): Lines (pixel height) to insert between each
127			row of the display;
128			resource bf(linespace).
129			dit(bf(-tn) em(termname))
130			This option specifies the name of the terminal type to be set in the
131			bf(TERM) environment variable. This terminal type must exist in the
132			em(termcap(5)) database and should have em(li#) and em(co#) entries;
133			resource bf(termName).
134			dit(bf(-e) em(command [arguments]))
135	pcg	1.6	Run the command with its command-line arguments in the bf(RXVTNAME())
136	pcg	1.1	window; also sets the window title and icon name to be the basename
137			of the program being executed if neither em(-title) (em(-T)) nor
138			em(-n) are given on the command line. If this option is used, it
139			must be the last on the command-line. If there is no bf(-e) option
140			then the default is to run the program specified by the bf(SHELL)
141			environment variable or, failing that, em(sh(1)).
142			dit(bf(-title) em(text))
143			Window title (bf(-T) still respected); the default title is the
144			basename of the program specified after the bf(-e) option, if
145			any, otherwise the application name;
146			resource bf(title).
147			dit(bf(-n) em(text))
148			Icon name; the default name is the basename of the program specified
149			after the bf(-e) option, if any, otherwise the application name;
150			resource bf(iconName).
151			dit(bf(-C))
152			Capture system console messages.
153			dit(bf(-pt) em(style))
154			Compile em(XIM): input style for input method;
155			bf(OverTheSpot), bf(OffTheSpot), bf(Root);
156			resource bf(preeditType).
157			dit(bf(-im) em(text))
158			Compile em(XIM): input method name.
159			resource bf(inputMethod).
160	pcg	1.3	dit(bf(-imlocale) em(string))
161			The locale to use for opening the IM. You can use an LC_CTYPE
162			of e.g. de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP
163			for the input extension to be able to input japanese characters
164			while staying in another locale.
165	pcg	1.8	dit(bf(-insecure))
166			Enable "insecure" mode, which currently enables most of the escape
167			sequences that echo strings. See the resource bf(insecure) for
168			more info.
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	pcg	1.10	dit(bf(-ssc)\|bf(+ssc))
175			Turn on/off secondary screen (default enabled);
176			resource bf(secondaryScreen).
177			dit(bf(-ssr)\|bf(+ssr))
178			Turn on/off secondary screen scroll (default enabled);
179			resource bf(secondaryScroll).
180	pcg	1.1	dit(bf(-xrm) em(resourcestring))
181			No effect on rxvt. Simply passes through an argument to be made
182			available in the instance's argument list. Appears in em(WM_COMMAND)
183			in some window managers.
184			enddit()