HomeManualTopicsTypesSymbols

std::program_parameters

defines the application's options and parameters

Parameter

templates*
the accepted options and arguments

Results

None

Description

The specified information is used to parse the application's input arguments as well as to print a brief help message.

Options to print the program's version and the copyright notice are added automatically if you specify std::VERSION and std::COPYRIGHT.

The syntax is quite complicated. The example shows the complete list of options and parameters of the Funky compiler.

Example

program_parameters! list COPYRIGHT " Copyright (C) 2024 by Dipl.-Ing. Michael Niederle This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, version 2, or (at your option) version 3. This program 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. For details of the GNU General Public License see the accompanying files GPLv2.txt and GLPv3.txt or http://www.gnu.org/licenses/gpl-2.0.html http://www.gnu.org/licenses/gpl-3.0.html or write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. list MANDATORY_PARAMETER "filename" " a source code file with the extension ".fky" list "verbose" " output detailed information about the build process list "rebuild" " rebuild all source files list "print-c" " print C source code for a single module

Topic

Parameters

See also

std::COPYRIGHT adds a copyright message
std::VERSION defines the version of the application program
std::VALUED_OPTION describes an option with an associated value
std::MULTI_VALUED_OPTION describes an option with an associated list of values
std::MANDATORY_PARAMETER describes a mandatory parameter
std::OPTIONAL_PARAMETER describes an optional parameter
std::SOME_PARAMETERS describes list of zero or more parameters
std::MANY_PARAMETERS describes list of one or more parameters
std::extract_options extracts the options of a function call
(defined in basic/parameters.fky)