.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH SCHEMA-SALAD-TOOL3 "1" "April 2024" "schema-salad-tool 8.5.20240410123758" "User Commands"
.SH NAME
schema-salad-tool \- Schema Annotations for Linked Avro Data (SALAD)
.SH DESCRIPTION
usage: schema-salad-tool [\-h] [\-\-rdf\-serializer RDF_SERIALIZER] [\-\-skip\-schemas]
.IP
[\-\-strict\-foreign\-properties] [\-\-print\-jsonld\-context]
[\-\-print\-rdfs] [\-\-print\-avro] [\-\-print\-rdf] [\-\-print\-pre]
[\-\-print\-index] [\-\-print\-metadata]
[\-\-print\-inheritance\-dot] [\-\-print\-fieldrefs\-dot]
[\-\-codegen language] [\-\-codegen\-target CODEGEN_TARGET]
[\-\-codegen\-examples directory]
[\-\-codegen\-package dotted.package]
[\-\-codegen\-copyright copyright_string]
[\-\-codegen\-spdx\-copyright\-text spdx_copyright_text [spdx_copyright_text ...]]
[\-\-codegen\-spdx\-license\-identifier spdx_license_identifier]
[\-\-codegen\-parser\-info parser_info] [\-\-print\-oneline]
[\-\-print\-doc] [\-\-strict | \fB\-\-non\-strict]\fR
[\-\-verbose | \fB\-\-quiet\fR | \fB\-\-debug]\fR [\-\-only ONLY]
[\-\-redirect REDIRECT] [\-\-brand BRAND]
[\-\-brandlink BRANDLINK] [\-\-brandstyle BRANDSTYLE]
[\-\-brandinverse] [\-\-primtype PRIMTYPE] [\-\-version]
[schema] [document ...]
.SS "positional arguments:"
.IP
schema
document
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-\-rdf\-serializer\fR RDF_SERIALIZER
Output RDF serialization format used by \fB\-\-printrdf\fR(one of turtle (default), n3, nt, xml)
.TP
\fB\-\-skip\-schemas\fR
If specified, ignore $schemas sections.
.TP
\fB\-\-strict\-foreign\-properties\fR
Strict checking of foreign properties
.TP
\fB\-\-print\-jsonld\-context\fR
Print JSON\-LD context for schema
.TP
\fB\-\-print\-rdfs\fR
Print RDF schema
.TP
\fB\-\-print\-avro\fR
Print Avro schema
.TP
\fB\-\-print\-rdf\fR
Print corresponding RDF graph for document
.TP
\fB\-\-print\-pre\fR
Print document after preprocessing
.TP
\fB\-\-print\-index\fR
Print node index
.TP
\fB\-\-print\-metadata\fR
Print document metadata
.TP
\fB\-\-print\-inheritance\-dot\fR
Print graphviz file of inheritance
.TP
\fB\-\-print\-fieldrefs\-dot\fR
Print graphviz file of field refs
.TP
\fB\-\-codegen\fR language
Generate classes in target language, currently
supported: python, java, typescript, dotnet, cpp,
dlang
.TP
\fB\-\-codegen\-target\fR CODEGEN_TARGET
Defaults to sys.stdout for Python/C++/Dlang and ./ for
Java/TypeScript/.Net
.TP
\fB\-\-codegen\-examples\fR directory
Directory of example documents for test case
generation (Java/TypeScript/.Net/Dlang only).
.TP
\fB\-\-codegen\-package\fR dotted.package
Optional override of the package name which is other
derived from the base URL (Java/TypeScript/.Net/Dlang
only).
.TP
\fB\-\-codegen\-copyright\fR copyright_string
Optional copyright of the input schema.
.TP
\fB\-\-codegen\-spdx\-copyright\-text\fR spdx_copyright_text [spdx_copyright_text ...]
List of copyright text. Each entry will show up as
\&'SPDX\-FileCopyrightText: ...' (Currently c++ only)
.TP
\fB\-\-codegen\-spdx\-license\-identifier\fR spdx_license_identifier
Optional spdx license identifier, e.g.: GPL\-3.0\-only
(Currently c++ only)
.TP
\fB\-\-codegen\-parser\-info\fR parser_info
Optional parser name which is accessible via resulted
parser API (Python and Dlang only)
.TP
\fB\-\-print\-oneline\fR
Print each error message in oneline
.TP
\fB\-\-print\-doc\fR
Print HTML schema documentation page
.TP
\fB\-\-strict\fR
Strict validation (unrecognized or out of place fields
are error)
.TP
\fB\-\-non\-strict\fR
Lenient validation (ignore unrecognized fields)
.TP
\fB\-\-verbose\fR
Default logging
.TP
\fB\-\-quiet\fR
Only print warnings and errors.
.TP
\fB\-\-debug\fR
Print even more logging
.TP
\fB\-\-only\fR ONLY
Use with \fB\-\-print\-doc\fR, document only listed types
.TP
\fB\-\-redirect\fR REDIRECT
Use with \fB\-\-print\-doc\fR, override default link for type
.TP
\fB\-\-brand\fR BRAND
Use with \fB\-\-print\-doc\fR, set the 'brand' text in nav bar
.TP
\fB\-\-brandlink\fR BRANDLINK
Use with \fB\-\-print\-doc\fR, set the link for 'brand' in nav
bar
.TP
\fB\-\-brandstyle\fR BRANDSTYLE
Use with \fB\-\-print\-doc\fR, HTML code to link to an external
style sheet
.TP
\fB\-\-brandinverse\fR
Use with \fB\-\-print\-doc\fR
.TP
\fB\-\-primtype\fR PRIMTYPE
Use with \fB\-\-print\-doc\fR, link to use for primitive types
(string, int etc)
.TP
\fB\-\-version\fR, \fB\-v\fR
Print version