.\" Automatically generated by Pandoc 2.9.2.1
.\"
.TH "s1kd-newcom" "1" "2021-04-16" "" "s1kd-tools"
.hy
.SH NAME
.PP
s1kd-newcom - Create a new S1000D comment.
.SH SYNOPSIS
.IP
.nf
\f[C]
s1kd-newcom [options]
\f[R]
.fi
.SH DESCRIPTION
.PP
The \f[I]s1kd-newcom\f[R] tool creates a new S1000D comment with the
code and metadata specified.
.SH OPTIONS
.TP
-#, --code <code>
The code of the comment, in the form of
MODELIDENTCODE-SENDERIDENT-YEAR-SEQ-TYPE.
.TP
-$, --issue <issue>
Specify which issue of S1000D to use.
Currently supported issues are:
.RS
.IP \[bu] 2
5.0 (default)
.IP \[bu] 2
4.2
.IP \[bu] 2
4.1
.IP \[bu] 2
4.0
.IP \[bu] 2
3.0
.IP \[bu] 2
2.3
.IP \[bu] 2
2.2
.IP \[bu] 2
2.1
.IP \[bu] 2
2.0
.RE
.TP
-\[at], --out <path>
Save the new comment to <path>.
If <path> is an existing directory, the comment will be created in it
instead of the current directory.
Otherwise, the comment will be saved as the filename <path> instead of
being automatically named.
.TP
-%, --templates <dir>
Use the XML template in the specified directory instead of the built-in
template.
The template must be named \f[C]comment.xml\f[R] inside <dir> and must
conform to the default S1000D issue (5.0).
.TP
-\[ti], --dump-templates <dir>
Dump the built-in XML template to the specified directory.
.TP
-b, --brex <BREX>
BREX data module code.
.TP
-C, --country <country>
The country ISO code of the new comment.
.TP
-c, --security <sec>
The security classification of the new comment.
.TP
-d, --defaults <file>
Specify the \f[C].defaults\f[R] file name.
.TP
-f, --overwrite
Overwrite existing file.
.TP
-h, -?, --help
Show help/usage message.
.TP
-I, --date <date>
The issue date of the new comment in the form of YYYY-MM-DD.
.TP
-L, --language <lang>
The language ISO code of the new comment.
.TP
-m, --remarks <remarks>
Set the remarks for the new comment.
.TP
-o, --origname <orig>
The enterprise name of the originator of the comment.
.TP
-P, --priority <code>
The priority code of the new comment.
.TP
-p, --prompt
Prompt the user for values left unspecified.
.TP
-q, --quiet
Do not report an error when the file already exists.
.TP
-r, --response <type>
The response type of the new comment.
.TP
-t, --title <title>
The title of the new comment.
.TP
-v, --verbose
Print the file name of the newly created comment.
.TP
-z, --issue-type <type>
The issue type of the new comment.
.TP
--version
Show version information.
.PP
In addition, the following options allow configuration of the XML
parser:
.TP
--dtdload
Load the external DTD.
.TP
--huge
Remove any internal arbitrary parser limits.
.TP
--net
Allow network access to load external DTD and entities.
.TP
--noent
Resolve entities.
.TP
--parser-errors
Emit errors from parser.
.TP
--parser-warnings
Emit warnings from parser.
.TP
--xinclude
Do XInclude processing.
.TP
--xml-catalog <file>
Use an XML catalog when resolving entities.
Multiple catalogs may be loaded by specifying this option multiple
times.
.SS \f[C].defaults\f[R] file
.PP
Refer to s1kd-newdm(1) for information on the \f[C].defaults\f[R] file
which is used by all the s1kd-new* commands.
.SH EXAMPLE
.IP
.nf
\f[C]
$ s1kd-newcom -# EX-12345-2018-00001-Q
\f[R]
.fi
.SH AUTHORS
khzae.net.