doc/yodl/rxvt-options.yo

COMMENT(-- $Id: rxvt-options.yo,v 1.6 2004/03/14 21:59:58 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(-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 colour;
        resource bf(pointerColor).
    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(-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(-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.7
Committed:	Sun Mar 28 14:42:14 2004 UTC (20 years, 3 months ago) by pcg
Branch:	MAIN
Changes since 1.6:	+3 -3 lines
Log Message:	* empty log message *
#	User	Rev	Content
1	pcg	1.7	COMMENT(-- $Id: rxvt-options.yo,v 1.6 2004/03/14 21:59:58 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			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	pcg	1.7	other fonts might be smaller, but not larger. A reasonable default font list
68			is always appended to it.
69	pcg	1.1	resource bf(font).
70			dit(bf(-name) em(name))
71			Specify the application name under which resources
72			are to be obtained, rather than the default executable file name.
73			Name should not contain `.' or `*' characters.
74			Also sets the icon and title name.
75			dit(bf(-ls)\|bf(+ls))
76			Start as a login-shell/sub-shell;
77			resource bf(loginShell).
78			dit(bf(-ut)\|bf(+ut))
79			Compile em(utmp): Inhibit/enable writing a utmp entry;
80			resource bf(utmpInhibit).
81			dit(bf(-vb)\|bf(+vb))
82			Turn on/off visual bell on receipt of a bell character;
83			resource bf(visualBell).
84			dit(bf(-sb)\|bf(+sb))
85			Turn on/off scrollbar;
86			resource bf(scrollBar).
87			dit(bf(-si)\|bf(+si))
88			Turn on/off scroll-to-bottom on TTY output inhibit;
89			resource bf(scrollTtyOutput) has opposite effect.
90			dit(bf(-sk)\|bf(+sk))
91			Turn on/off scroll-to-bottom on keypress;
92			resource bf(scrollTtyKeypress).
93			dit(bf(-sw)\|bf(+sw))
94			Turn on/off scrolling with the scrollback buffer as new
95			lines appear. This only takes effect if bf(-si) is also given;
96			resource bf(scrollWithBuffer).
97			dit(bf(-sr)\|bf(+sr))
98			Put scrollbar on right/left;
99			resource bf(scrollBar_right).
100			dit(bf(-st)\|bf(+st))
101			Display normal (non XTerm/NeXT) scrollbar without/with a trough;
102			resource bf(scrollBar_floating).
103			dit(bf(-bc)\|bf(+bc))
104			Blink the cursor; resource bf(cursorBlink).
105			dit(bf(-iconic))
106			Start iconified, if the window manager supports that option.
107			Alternative form is bf(-ic).
108			dit(bf(-sl) em(number))
109			Save em(number) lines in the scrollback buffer. See resource entry
110			for limits;
111			resource bf(saveLines).
112			dit(bf(-b) em(number))
113			Compile em(frills): Internal border of em(number) pixels. See
114			resource entry for limits;
115			resource bf(internalBorder).
116			dit(bf(-w) em(number))
117			Compile em(frills): External border of em(number) pixels.
118			Also, bf(-bw) and bf(-borderwidth). See resource entry for limits;
119			resource bf(externalBorder).
120			dit(bf(-lsp) em(number))
121			Compile em(linespace): Lines (pixel height) to insert between each
122			row of the display;
123			resource bf(linespace).
124			dit(bf(-tn) em(termname))
125			This option specifies the name of the terminal type to be set in the
126			bf(TERM) environment variable. This terminal type must exist in the
127			em(termcap(5)) database and should have em(li#) and em(co#) entries;
128			resource bf(termName).
129			dit(bf(-e) em(command [arguments]))
130	pcg	1.6	Run the command with its command-line arguments in the bf(RXVTNAME())
131	pcg	1.1	window; also sets the window title and icon name to be the basename
132			of the program being executed if neither em(-title) (em(-T)) nor
133			em(-n) are given on the command line. If this option is used, it
134			must be the last on the command-line. If there is no bf(-e) option
135			then the default is to run the program specified by the bf(SHELL)
136			environment variable or, failing that, em(sh(1)).
137			dit(bf(-title) em(text))
138			Window title (bf(-T) still respected); the default title is the
139			basename of the program specified after the bf(-e) option, if
140			any, otherwise the application name;
141			resource bf(title).
142			dit(bf(-n) em(text))
143			Icon name; the default name is the basename of the program specified
144			after the bf(-e) option, if any, otherwise the application name;
145			resource bf(iconName).
146			dit(bf(-C))
147			Capture system console messages.
148			dit(bf(-pt) em(style))
149			Compile em(XIM): input style for input method;
150			bf(OverTheSpot), bf(OffTheSpot), bf(Root);
151			resource bf(preeditType).
152			dit(bf(-im) em(text))
153			Compile em(XIM): input method name.
154			resource bf(inputMethod).
155	pcg	1.3	dit(bf(-imlocale) em(string))
156			The locale to use for opening the IM. You can use an LC_CTYPE
157			of e.g. de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP
158			for the input extension to be able to input japanese characters
159			while staying in another locale.
160	pcg	1.1	dit(bf(-mod) em(modifier))
161			Override detection of Meta modifier with specified key:
162			bf(alt), bf(meta), bf(hyper), bf(super), bf(mod1), bf(mod2), bf(mod3),
163			bf(mod4), bf(mod5);
164			resource em(modifier).
165			dit(bf(-xrm) em(resourcestring))
166			No effect on rxvt. Simply passes through an argument to be made
167			available in the instance's argument list. Appears in em(WM_COMMAND)
168			in some window managers.
169			enddit()