annotate libinterp/options-usage.h @ 25054:6652d3823428 stable

maint: Update copyright dates in all source files.
author John W. Eaton <jwe@octave.org>
date Fri, 30 Mar 2018 09:19:05 -0400
parents 4fdb160b47fb
children 7b1b504c2f12
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
17777
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
1 /*
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
2
25054
6652d3823428 maint: Update copyright dates in all source files.
John W. Eaton <jwe@octave.org>
parents: 24878
diff changeset
3 Copyright (C) 1993-2018 John W. Eaton
17777
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
4
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
5 This file is part of Octave.
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
6
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 24444
diff changeset
7 Octave is free software: you can redistribute it and/or modify it
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22407
diff changeset
8 under the terms of the GNU General Public License as published by
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 24444
diff changeset
9 the Free Software Foundation, either version 3 of the License, or
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22407
diff changeset
10 (at your option) any later version.
17777
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
11
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22407
diff changeset
12 Octave is distributed in the hope that it will be useful, but
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22407
diff changeset
13 WITHOUT ANY WARRANTY; without even the implied warranty of
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22407
diff changeset
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22407
diff changeset
15 GNU General Public License for more details.
17777
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
16
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
18 along with Octave; see the file COPYING. If not, see
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 24444
diff changeset
19 <https://www.gnu.org/licenses/>.
17777
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
20
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
21 */
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
22
20791
f7084eae3318 maint: Use Octave coding conventions for #if statements.
Rik <rik@octave.org>
parents: 19861
diff changeset
23 #if ! defined (octave_options_usage_h)
17777
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
24 #define octave_options_usage_h 1
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
25
21244
1473547f50f5 include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents: 20791
diff changeset
26 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents: 20791
diff changeset
27
17777
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
28 #include <iosfwd>
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
29
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
30 #include "version.h"
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
31
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
32 // Usage message
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
33 static const char *usage_string =
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
34 "octave [-HVWdfhiqvx] [--debug] [--debug-jit] [--doc-cache-file file]\n\
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
35 [--echo-commands] [--eval CODE] [--exec-path path]\n\
24874
a4dc2ef8741c Don't start GUI by default, require new '--gui' option
Carnë Draug <carandraug@octave.org>
parents: 24534
diff changeset
36 [--gui] [--help] [--image-path path]\n\
17777
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
37 [--info-file file] [--info-program prog] [--interactive]\n\
24878
4fdb160b47fb Keep the '--no-gui' option as the inverse of '--gui'
Mike Miller <mtmiller@octave.org>
parents: 24874
diff changeset
38 [--jit-compiler] [--line-editing] [--no-gui] [--no-history]\n\
17792
26e9312e6928 Build JIT compiler by default, but do not enable it by default.
Rik <rik@octave.org>
parents: 17778
diff changeset
39 [--no-init-file] [--no-init-path] [--no-line-editing]\n\
17778
b5d58667d32d new main program wrapper to handle giving up controlling tty
John W. Eaton <jwe@octave.org>
parents: 17777
diff changeset
40 [--no-site-file] [--no-window-system] [--norc] [-p path]\n\
b5d58667d32d new main program wrapper to handle giving up controlling tty
John W. Eaton <jwe@octave.org>
parents: 17777
diff changeset
41 [--path path] [--persist] [--silent] [--traditional]\n\
b5d58667d32d new main program wrapper to handle giving up controlling tty
John W. Eaton <jwe@octave.org>
parents: 17777
diff changeset
42 [--verbose] [--version] [file]";
17777
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
43
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
44 // This is here so that it's more likely that the usage message and
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
45 // the real set of options will agree. Note: the '+' must come first
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
46 // to prevent getopt from permuting arguments!
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
47 static const char *short_opts = "+HWVdfhip:qvx";
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
48
23796
4f12819a634f Use C++11 nullptr rather than 0 in code (bug #51565).
Rik <rik@octave.org>
parents: 23220
diff changeset
49
4f12819a634f Use C++11 nullptr rather than 0 in code (bug #51565).
Rik <rik@octave.org>
parents: 23220
diff changeset
50 #if defined (HAVE_PRAGMA_GCC_DIAGNOSTIC)
24444
53ca76c5cc8d maint: Indent pragmas as other preprocessor directives.
John W. Eaton <jwe@octave.org>
parents: 23796
diff changeset
51 // Disable warning temporarily.
53ca76c5cc8d maint: Indent pragmas as other preprocessor directives.
John W. Eaton <jwe@octave.org>
parents: 23796
diff changeset
52 # pragma GCC diagnostic push
53ca76c5cc8d maint: Indent pragmas as other preprocessor directives.
John W. Eaton <jwe@octave.org>
parents: 23796
diff changeset
53 # pragma GCC diagnostic ignored "-Wzero-as-null-pointer-constant"
23796
4f12819a634f Use C++11 nullptr rather than 0 in code (bug #51565).
Rik <rik@octave.org>
parents: 23220
diff changeset
54 #endif
4f12819a634f Use C++11 nullptr rather than 0 in code (bug #51565).
Rik <rik@octave.org>
parents: 23220
diff changeset
55
17777
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
56 // Long options. See the comments in getopt.h for the meanings of the
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
57 // fields in this structure.
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
58 #define BUILT_IN_DOCSTRINGS_FILE_OPTION 1
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
59 #define DOC_CACHE_FILE_OPTION 2
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
60 #define EVAL_OPTION 3
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
61 #define EXEC_PATH_OPTION 4
24874
a4dc2ef8741c Don't start GUI by default, require new '--gui' option
Carnë Draug <carandraug@octave.org>
parents: 24534
diff changeset
62 #define FORCE_GUI_OPTION 5 // ignored since Octave 4.4, remove for 4.8
a4dc2ef8741c Don't start GUI by default, require new '--gui' option
Carnë Draug <carandraug@octave.org>
parents: 24534
diff changeset
63 #define GUI_OPTION 5
17777
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
64 #define IMAGE_PATH_OPTION 6
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
65 #define INFO_FILE_OPTION 7
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
66 #define INFO_PROG_OPTION 8
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
67 #define DEBUG_JIT_OPTION 9
17792
26e9312e6928 Build JIT compiler by default, but do not enable it by default.
Rik <rik@octave.org>
parents: 17778
diff changeset
68 #define JIT_COMPILER_OPTION 10
26e9312e6928 Build JIT compiler by default, but do not enable it by default.
Rik <rik@octave.org>
parents: 17778
diff changeset
69 #define LINE_EDITING_OPTION 11
24878
4fdb160b47fb Keep the '--no-gui' option as the inverse of '--gui'
Mike Miller <mtmiller@octave.org>
parents: 24874
diff changeset
70 #define NO_GUI_OPTION 12
17792
26e9312e6928 Build JIT compiler by default, but do not enable it by default.
Rik <rik@octave.org>
parents: 17778
diff changeset
71 #define NO_INIT_FILE_OPTION 13
26e9312e6928 Build JIT compiler by default, but do not enable it by default.
Rik <rik@octave.org>
parents: 17778
diff changeset
72 #define NO_INIT_PATH_OPTION 14
17778
b5d58667d32d new main program wrapper to handle giving up controlling tty
John W. Eaton <jwe@octave.org>
parents: 17777
diff changeset
73 #define NO_LINE_EDITING_OPTION 15
b5d58667d32d new main program wrapper to handle giving up controlling tty
John W. Eaton <jwe@octave.org>
parents: 17777
diff changeset
74 #define NO_SITE_FILE_OPTION 16
b5d58667d32d new main program wrapper to handle giving up controlling tty
John W. Eaton <jwe@octave.org>
parents: 17777
diff changeset
75 #define PERSIST_OPTION 17
b5d58667d32d new main program wrapper to handle giving up controlling tty
John W. Eaton <jwe@octave.org>
parents: 17777
diff changeset
76 #define TEXI_MACROS_FILE_OPTION 18
b5d58667d32d new main program wrapper to handle giving up controlling tty
John W. Eaton <jwe@octave.org>
parents: 17777
diff changeset
77 #define TRADITIONAL_OPTION 19
22064
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
78 struct octave_getopt_options long_opts[] =
19861
19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19697
diff changeset
79 {
22064
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
80 { "braindead", octave_no_arg, 0, TRADITIONAL_OPTION },
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
81 { "built-in-docstrings-file", octave_required_arg, 0, BUILT_IN_DOCSTRINGS_FILE_OPTION },
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
82 { "debug", octave_no_arg, 0, 'd' },
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
83 { "debug-jit", octave_no_arg, 0, DEBUG_JIT_OPTION },
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
84 { "doc-cache-file", octave_required_arg, 0, DOC_CACHE_FILE_OPTION },
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
85 { "echo-commands", octave_no_arg, 0, 'x' },
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
86 { "eval", octave_required_arg, 0, EVAL_OPTION },
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
87 { "exec-path", octave_required_arg, 0, EXEC_PATH_OPTION },
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
88 { "force-gui", octave_no_arg, 0, FORCE_GUI_OPTION },
24874
a4dc2ef8741c Don't start GUI by default, require new '--gui' option
Carnë Draug <carandraug@octave.org>
parents: 24534
diff changeset
89 { "gui", octave_no_arg, 0, GUI_OPTION },
22064
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
90 { "help", octave_no_arg, 0, 'h' },
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
91 { "image-path", octave_required_arg, 0, IMAGE_PATH_OPTION },
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
92 { "info-file", octave_required_arg, 0, INFO_FILE_OPTION },
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
93 { "info-program", octave_required_arg, 0, INFO_PROG_OPTION },
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
94 { "interactive", octave_no_arg, 0, 'i' },
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
95 { "jit-compiler", octave_no_arg, 0, JIT_COMPILER_OPTION },
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
96 { "line-editing", octave_no_arg, 0, LINE_EDITING_OPTION },
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
97 { "no-gui", octave_no_arg, 0, NO_GUI_OPTION },
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
98 { "no-history", octave_no_arg, 0, 'H' },
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
99 { "no-init-file", octave_no_arg, 0, NO_INIT_FILE_OPTION },
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
100 { "no-init-path", octave_no_arg, 0, NO_INIT_PATH_OPTION },
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
101 { "no-line-editing", octave_no_arg, 0, NO_LINE_EDITING_OPTION },
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
102 { "no-site-file", octave_no_arg, 0, NO_SITE_FILE_OPTION },
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
103 { "no-window-system", octave_no_arg, 0, 'W' },
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
104 { "norc", octave_no_arg, 0, 'f' },
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
105 { "path", octave_required_arg, 0, 'p' },
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
106 { "persist", octave_no_arg, 0, PERSIST_OPTION },
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
107 { "quiet", octave_no_arg, 0, 'q' },
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
108 { "silent", octave_no_arg, 0, 'q' },
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
109 { "texi-macros-file", octave_required_arg, 0, TEXI_MACROS_FILE_OPTION },
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
110 { "traditional", octave_no_arg, 0, TRADITIONAL_OPTION },
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
111 { "verbose", octave_no_arg, 0, 'V' },
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
112 { "version", octave_no_arg, 0, 'v' },
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
113 { 0, 0, 0, 0 }
17777
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
114 };
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
115
23796
4f12819a634f Use C++11 nullptr rather than 0 in code (bug #51565).
Rik <rik@octave.org>
parents: 23220
diff changeset
116 #if defined (HAVE_PRAGMA_GCC_DIAGNOSTIC)
24444
53ca76c5cc8d maint: Indent pragmas as other preprocessor directives.
John W. Eaton <jwe@octave.org>
parents: 23796
diff changeset
117 // Restore prevailing warning state for remainder of the file.
53ca76c5cc8d maint: Indent pragmas as other preprocessor directives.
John W. Eaton <jwe@octave.org>
parents: 23796
diff changeset
118 # pragma GCC diagnostic pop
23796
4f12819a634f Use C++11 nullptr rather than 0 in code (bug #51565).
Rik <rik@octave.org>
parents: 23220
diff changeset
119 #endif
4f12819a634f Use C++11 nullptr rather than 0 in code (bug #51565).
Rik <rik@octave.org>
parents: 23220
diff changeset
120
17777
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
121 // Usage message with extra help.
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
122
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
123 static void
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
124 octave_print_verbose_usage_and_exit (void)
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
125 {
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
126 std::cout << octave_name_version_copyright_copying_and_warranty ()
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
127 << "\n\
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
128 \n\
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
129 Usage: octave [options] [FILE]\n\
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
130 \n\
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
131 Options:\n\
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
132 \n\
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
133 --built-in-docstrings-file FILE Use docs for built-ins from FILE.\n\
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
134 --debug, -d Enter parser debugging mode.\n\
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
135 --debug-jit Enable JIT compiler debugging/tracing.\n\
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
136 --doc-cache-file FILE Use doc cache file FILE.\n\
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
137 --echo-commands, -x Echo commands as they are executed.\n\
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
138 --eval CODE Evaluate CODE. Exit when done unless --persist.\n\
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
139 --exec-path PATH Set path for executing subprograms.\n\
24874
a4dc2ef8741c Don't start GUI by default, require new '--gui' option
Carnë Draug <carandraug@octave.org>
parents: 24534
diff changeset
140 --gui Start the graphical user interface.\n\
17777
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
141 --help, -h, Print short help message and exit.\n\
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
142 --image-path PATH Add PATH to head of image search path.\n\
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
143 --info-file FILE Use top-level info file FILE.\n\
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
144 --info-program PROGRAM Use PROGRAM for reading info files.\n\
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
145 --interactive, -i Force interactive behavior.\n\
17792
26e9312e6928 Build JIT compiler by default, but do not enable it by default.
Rik <rik@octave.org>
parents: 17778
diff changeset
146 --jit-compiler Enable the JIT compiler.\n\
17777
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
147 --line-editing Force readline use for command-line editing.\n\
24878
4fdb160b47fb Keep the '--no-gui' option as the inverse of '--gui'
Mike Miller <mtmiller@octave.org>
parents: 24874
diff changeset
148 --no-gui Disable the graphical user interface.\n\
17777
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
149 --no-history, -H Don't save commands to the history list\n\
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
150 --no-init-file Don't read the ~/.octaverc or .octaverc files.\n\
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
151 --no-init-path Don't initialize function search path.\n\
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
152 --no-line-editing Don't use readline for command-line editing.\n\
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
153 --no-site-file Don't read the site-wide octaverc file.\n\
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
154 --no-window-system, -W Disable window system, including graphics.\n\
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
155 --norc, -f Don't read any initialization files.\n\
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
156 --path PATH, -p PATH Add PATH to head of function search path.\n\
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
157 --persist Go interactive after --eval or reading from FILE.\n\
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
158 --silent, --quiet, -q Don't print message at startup.\n\
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
159 --texi-macros-file FILE Use Texinfo macros in FILE for makeinfo command.\n\
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
160 --traditional Set variables for closer MATLAB compatibility.\n\
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
161 --verbose, -V Enable verbose output in some cases.\n\
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
162 --version, -v Print version number and exit.\n\
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
163 \n\
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
164 FILE Execute commands from FILE. Exit when done\n\
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
165 unless --persist is also specified.\n\
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
166 \n"
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
167 << octave_www_statement ()
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
168 << "\n\n"
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
169 << octave_contrib_statement ()
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
170 << "\n\n"
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
171 << octave_bugs_statement ()
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
172 << "\n";
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
173
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
174 exit (0);
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
175 }
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
176
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
177 // Terse usage messsage.
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
178
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
179 static void
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
180 octave_print_terse_usage_and_exit (void)
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
181 {
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
182 std::cerr << "\nusage: " << usage_string << "\n\n";
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
183
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
184 exit (1);
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
185 }
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
186
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
187 static void
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
188 octave_print_version_and_exit (void)
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
189 {
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
190 std::cout << octave_name_version_copyright_copying_warranty_and_bugs ()
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
191 << "\n";
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
192 exit (0);
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
193 }
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
194
ae8905fbf1f8 move usage and options strings and funtions to separate file
John W. Eaton <jwe@octave.org>
parents:
diff changeset
195 #endif