Update docs to match implementation of $build_and_dump_html_index
[maxima.git] / doc / info / commandline-options.texi
blob93aa6b2bb1607f64efa26f8aa5bd6c59755e0231
1 The following command line options are available for Maxima:
3 @need 100
4 @table @code
5 @need 150
6 @item     -b <file>, --batch=<file>
7         Process maxima file <file> in batch mode.
10 @need 150
11 @item     --batch-lisp=<file>
12         Process lisp file <file> in batch mode.
15 @need 150
16 @item     --batch-string=<string>
17         Process maxima command(s) <string> in batch mode.
20 @need 150
21 @item     -d, --directories
22         Display maxima internal directory information.
25 @need 150
26 @item     --disable-readline
27         Disable readline support.
30 @need 150
31 @item     -g, --enable-lisp-debugger
32         Enable underlying lisp debugger.
35 @need 150
36 @item     -h, --help
37         Display this usage message.
40 @need 150
41 @item     --userdir=<directory>
42         Use <directory> for user directory (default is %USERPROFILE%/maxima for
43         Windows, and $HOME/.maxima for other operating systems).
46 @need 150
47 @item     --init=<file>
48         Set the base name of the Maxima & Lisp initialization files (default is
49         "maxima-init".) The last extension and any directory parts are removed
50         to form the base name. The resulting files, <base>.mac and <base>.lisp
51         are only searched for in userdir (see --userdir option). This may be
52         specified for than once, but only the last is used.
55 @need 150
56 @item     -l <lisp>, --lisp=<lisp>
57         Use lisp implementation <lisp>.
60 @need 150
61 @item     --list-avail
62         List the installed version/lisp combinations.
65 @need 150
66 @item     -p <file>, --preload=<file>, --preload-lisp=<file>, --init-mac=<file>, --init-lisp=<file>
67         Preload <file>, which may be any file time accepted by Maxima's LOAD
68         function. The <file> is loaded before any other system initialization
69         is done. This will be searched for in the locations given by
70         file_search_maxima and file_search_lisp. This can be specified multiple
71         times to load multiple files. The equivalent options --preload-lisp,
72         --init-mac, and --init-lisp are deprecated.
75 @need 150
76 @item     -q, --quiet
77         Suppress Maxima start-up message.
80 @need 150
81 @item     -r <string>, --run-string=<string>
82         Process maxima command(s) <string> in interactive mode.
85 @need 150
86 @item     -s <port>, --server=<port>
87         Connect Maxima to server on <port>.
90 @need 150
91 @item     -u <version>, --use-version=<version>
92         Use maxima version <version>.
95 @need 150
96 @item     -v, --verbose
97         Display lisp invocation in maxima wrapper script.
100 @need 150
101 @item     --version
102         Display the default installed version.
105 @need 150
106 @item     --very-quiet
107         Suppress expression labels and Maxima start-up message.
110 @need 150
111 @item     -X <Lisp options>, --lisp-options=<Lisp options>
112         Options to be given to the underlying Lisp
115 @need 150
116 @item     --no-init, --norc
117         Do not load the init file(s) on startup
120 @need 150
121 @item     --no-verify-html-index
122         Do not verify on startup that the set of html topics is consistent with
123         text topics.
126 @end table