documentation % ampersand documentation --help
Usage: ampersand documentation [--blackWhite] [--[no-]Intro] [--[no-]SharedLang]
[--[no-]Diagnosis] [--[no-]ConceptualAnalysis]
[--[no-]DataAnalysis] [--[no-]graphics]
[--[no-]text] --format FORMAT AMPERSAND_SCRIPT
[--sql-bin-tables] [--interfaces]
[--namespace NAMESPACE] [--crud-defaults CRUD]
[--[no-]trim-cellvalues] [--build-recipe RECIPE]
[--ignore-invariant-violations]
[--language OUTPUTLANGUAGE] [--[no-]legal-refs]
[--verbosity VERBOSITY | (-v|--verbose) |
--silent] [--[no-]time-in-log]
[--[no-]terminal] [--terminal-width INT]
[--output-dir DIR] [--help]
Generate a functional design document, to kick-start your functional
--blackWhite avoid coloring conventions to facilitate readable
pictures in black and white.
--[no-]Intro Do or do not include chapter Intro in the generated
--[no-]SharedLang Do or do not include chapter SharedLang in the
--[no-]Diagnosis Do or do not include chapter Diagnosis in the
--[no-]ConceptualAnalysis
Do or do not include chapter ConceptualAnalysis in
--[no-]DataAnalysis Do or do not include chapter DataAnalysis in the
--[no-]graphics Enable/disable generation of graphics before
generating the document. (default: enabled)
--[no-]text Enable/disable generation the document file.
--format FORMAT The format in which the output is written.
AMPERSAND_SCRIPT The root file of your Ampersand model.
--sql-bin-tables Generate binary tables instead of broad tables in SQL
database, for testing purposes.
--interfaces Generate interfaces, which currently does not work.
--namespace NAMESPACE Prefix database identifiers with this namespace, to
isolate namespaces within the same
--crud-defaults CRUD Temporary switch to learn about the semantics of crud
in interface expressions. (default: "CRUD")
--[no-]trim-cellvalues Enable/disable ignoring the leading and trailing
spaces in .xlsx files that are INCLUDED in the
script. (default: enabled)
--build-recipe RECIPE Build the internal FSpec with a predefined recipe.
[Standard,Grind,Prototype,RAP] (default: "Standard")
--ignore-invariant-violations
ignore invariant violations. In case of the prototype
command, the generated prototype might not behave as
you expect. Documentation is not affected. This means
that invariant violations are reported anyway. (See
https://github.com/AmpersandTarski/Ampersand/issues/728)
--language OUTPUTLANGUAGE
Pick 'NL' for Dutch or 'EN' for English, as the
language to be used in your output. Without this
option, output is written in the language of your
--[no-]legal-refs Enable/disable generation of a table of legal
references in Natural Language chapter of the output
document. (default: disabled)
--verbosity VERBOSITY Verbosity: silent, error, warn, info, debug
-v,--verbose Enable verbose mode: verbosity level "debug"
--silent Enable silent mode: verbosity level "silent"
--[no-]time-in-log Enable/disable inclusion of timings in logs, for the
purposes of using diff with logs (default: enabled)
--[no-]terminal Enable/disable overriding terminal detection in the
case of running in a false terminal
--terminal-width INT Specify the width of the terminal, used for
--output-dir DIR Specify the directory where your output will be
--help Show this help text