GNU Octave  6.2.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
options-usage.h File Reference
#include "octave-config.h"
#include <iosfwd>
#include "version.h"
Include dependency graph for options-usage.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define BUILT_IN_DOCSTRINGS_FILE_OPTION   1
 
#define DEBUG_JIT_OPTION   9
 
#define DOC_CACHE_FILE_OPTION   2
 
#define EVAL_OPTION   3
 
#define EXEC_PATH_OPTION   4
 
#define GUI_OPTION   5
 
#define IMAGE_PATH_OPTION   6
 
#define INFO_FILE_OPTION   7
 
#define INFO_PROG_OPTION   8
 
#define JIT_COMPILER_OPTION   10
 
#define LINE_EDITING_OPTION   11
 
#define NO_GUI_OPTION   12
 
#define NO_INIT_FILE_OPTION   13
 
#define NO_INIT_PATH_OPTION   14
 
#define NO_LINE_EDITING_OPTION   15
 
#define NO_SITE_FILE_OPTION   16
 
#define PERSIST_OPTION   17
 
#define TEXI_MACROS_FILE_OPTION   18
 
#define TRADITIONAL_OPTION   19
 

Functions

static void octave_print_terse_usage_and_exit (void)
 
static void octave_print_verbose_usage_and_exit (void)
 
static void octave_print_version_and_exit (void)
 

Variables

struct octave_getopt_options long_opts []
 
static const char * short_opts = "+HWVdfhip:qvx"
 
static const char * usage_string
 

Macro Definition Documentation

◆ BUILT_IN_DOCSTRINGS_FILE_OPTION

#define BUILT_IN_DOCSTRINGS_FILE_OPTION   1

Definition at line 61 of file options-usage.h.

◆ DEBUG_JIT_OPTION

#define DEBUG_JIT_OPTION   9

Definition at line 69 of file options-usage.h.

◆ DOC_CACHE_FILE_OPTION

#define DOC_CACHE_FILE_OPTION   2

Definition at line 62 of file options-usage.h.

◆ EVAL_OPTION

#define EVAL_OPTION   3

Definition at line 63 of file options-usage.h.

◆ EXEC_PATH_OPTION

#define EXEC_PATH_OPTION   4

Definition at line 64 of file options-usage.h.

◆ GUI_OPTION

#define GUI_OPTION   5

Definition at line 65 of file options-usage.h.

◆ IMAGE_PATH_OPTION

#define IMAGE_PATH_OPTION   6

Definition at line 66 of file options-usage.h.

◆ INFO_FILE_OPTION

#define INFO_FILE_OPTION   7

Definition at line 67 of file options-usage.h.

◆ INFO_PROG_OPTION

#define INFO_PROG_OPTION   8

Definition at line 68 of file options-usage.h.

◆ JIT_COMPILER_OPTION

#define JIT_COMPILER_OPTION   10

Definition at line 70 of file options-usage.h.

◆ LINE_EDITING_OPTION

#define LINE_EDITING_OPTION   11

Definition at line 71 of file options-usage.h.

◆ NO_GUI_OPTION

#define NO_GUI_OPTION   12

Definition at line 72 of file options-usage.h.

◆ NO_INIT_FILE_OPTION

#define NO_INIT_FILE_OPTION   13

Definition at line 73 of file options-usage.h.

◆ NO_INIT_PATH_OPTION

#define NO_INIT_PATH_OPTION   14

Definition at line 74 of file options-usage.h.

◆ NO_LINE_EDITING_OPTION

#define NO_LINE_EDITING_OPTION   15

Definition at line 75 of file options-usage.h.

◆ NO_SITE_FILE_OPTION

#define NO_SITE_FILE_OPTION   16

Definition at line 76 of file options-usage.h.

◆ PERSIST_OPTION

#define PERSIST_OPTION   17

Definition at line 77 of file options-usage.h.

◆ TEXI_MACROS_FILE_OPTION

#define TEXI_MACROS_FILE_OPTION   18

Definition at line 78 of file options-usage.h.

◆ TRADITIONAL_OPTION

#define TRADITIONAL_OPTION   19

Definition at line 79 of file options-usage.h.

Function Documentation

◆ octave_print_terse_usage_and_exit()

static void octave_print_terse_usage_and_exit ( void  )
static

Definition at line 181 of file options-usage.h.

References usage_string.

Referenced by octave::cmdline_options::cmdline_options(), and octave::application::init().

◆ octave_print_verbose_usage_and_exit()

static void octave_print_verbose_usage_and_exit ( void  )
static

◆ octave_print_version_and_exit()

static void octave_print_version_and_exit ( void  )
static

Variable Documentation

◆ long_opts

struct octave_getopt_options long_opts[]

Definition at line 50 of file options-usage.h.

Referenced by octave::cmdline_options::cmdline_options().

◆ short_opts

const char* short_opts = "+HWVdfhip:qvx"
static

Definition at line 50 of file options-usage.h.

Referenced by octave::cmdline_options::cmdline_options().

◆ usage_string

const char* usage_string
static
Initial value:
=
"octave [-HVWdfhiqvx] [--debug] [--debug-jit] [--doc-cache-file file]\n\
[--echo-commands] [--eval CODE] [--exec-path path]\n\
[--gui] [--help] [--image-path path]\n\
[--info-file file] [--info-program prog] [--interactive]\n\
[--jit-compiler] [--line-editing] [--no-gui] [--no-history]\n\
[--no-init-file] [--no-init-path] [--no-line-editing]\n\
[--no-site-file] [--no-window-system] [--norc] [-p path]\n\
[--path path] [--persist] [--silent] [--traditional]\n\
[--verbose] [--version] [file]"

Definition at line 36 of file options-usage.h.

Referenced by octave_print_terse_usage_and_exit().