1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115
|
////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 1993-2026 The Octave Project Developers
//
// See the file COPYRIGHT.md in the top-level directory of this
// distribution or <https://octave.org/copyright/>.
//
// This file is part of Octave.
//
// Octave is free software: you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Octave is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Octave; see the file COPYING. If not, see
// <https://www.gnu.org/licenses/>.
//
////////////////////////////////////////////////////////////////////////
#if ! defined (octave_usage_h)
#define octave_usage_h 1
#include "octave-config.h"
#include <cstdlib>
#include <iosfwd>
#include "version.h"
// Usage message for terse output.
static const char *usage_string =
"octave [-GHVWefghiqvx] [--echo-commands] [--eval CODE]\n\
[--experimental-terminal-widget] [--gui] [--help] [--interactive]\n\
[--line-editing] [--no-gui] [--no-history] [--no-init-all]\n\
[--no-init-path] [--no-init-site] [--no-init-user]\n\
[--no-line-editing] [--no-startup-tests] [--no-window-system]\n\
[--path path] [--persist] [--quiet] [--server] [--traditional]\n\
[--version] [file]";
// Usage message for --help argument.
static void
octave_print_verbose_usage_and_exit ()
{
std::cout << octave_name_version_copyright_license_copying_warranty () << "\n\
\n\
Usage: octave [options] [FILE]\n\
\n\
Options:\n\
\n"
// FIXME: Disabled debug option for parser 2023-12-29.
// Uncomment and restore code if Octave adds capability to
// immediately enter debug mode for a script.
//--debug, -d Enter debugging mode.\n\ //
"\
--echo-commands, -x Echo commands as they are executed.\n\
--eval, -e CODE Evaluate CODE. Exit when done unless --persist.\n\
--experimental-terminal-widget\n\
Use new experimental terminal widget in the GUI.\n\
--gui, -g Start the graphical user interface.\n\
--help, -h, Print short help message and exit.\n\
--interactive, -i Force interactive behavior.\n\
--line-editing Force readline use for command-line editing.\n\
--no-gui, -G Disable the graphical user interface.\n\
--no-history, -H Don't save commands to the history list\n\
--no-init-all, --norc, -f\n\
Don't read any initialization files.\n\
--no-init-path Don't initialize function search path.\n\
--no-init-site Don't read the site-wide octaverc files.\n\
--no-init-user Don't read the ~/.octaverc or .octaverc files.\n\
--no-line-editing Don't use readline for command-line editing.\n\
--no-startup-tests Don't run compatibility tests on startup.\n\
--no-window-system, -W Disable window system, including graphics.\n\
--path PATH, -p PATH Add PATH to head of function search path.\n\
--persist Go interactive after --eval or reading from FILE.\n\
--server Enter server mode at startup.\n\
--quiet, --silent, -q Don't print message at startup.\n\
--traditional Set variables for closer MATLAB compatibility.\n\
--version, -v Print version information and exit.\n\
\n\
FILE Execute commands from FILE. Exit when done\n\
unless --persist is also specified.\n\
\n"
<< octave_www_statement () << "\n"
<< octave_bugs_statement () << "\n"
<< octave_contrib_statement () << "\n";
std::exit (EXIT_SUCCESS);
}
// Terse usage message when argument is not recognized.
static void
octave_print_terse_usage_and_exit ()
{
std::cerr << "\nusage: " << usage_string << "\n\n";
std::exit (EXIT_FAILURE);
}
// Version message for --version argument.
static void
octave_print_version_and_exit ()
{
std::cout << octave_name_version_copyright_license_copying_warranty_bugs ()
<< "\n";
std::exit (EXIT_SUCCESS);
}
#endif
|