..
/
download
# NAME
s1kd-newdml - Create a new S1000D data management list
# SYNOPSIS
s1kd-newdml [options] [<object>...]
# DESCRIPTION
The *s1kd-newdml* tool creates a new S1000D data management list with
the code and other metadata specified.
# OPTIONS
- \-\#, --code \<code\>
The data management list code of the new DML.
- \-$, --issue \<issue\>
Specify which issue of S1000D to use. Currently supported issues
are:
- 5.0 (default)
- 4.2
- 4.1
- 4.0
- 3.0
- 2.3
- 2.2
- 2.1
- 2.0
- \-@, --out \<path\>
Save the new DML to \<path\>. If \<path\> is an existing directory,
the DML will be created in it instead of the current directory.
Otherwise, the DML will be saved as the filename \<path\> instead of
being automatically named.
- \-%, --templates \<dir\>
Use the XML template in the specified directory instead of the
built-in template. The template must be named `dml.xml` inside
\<dir\> and must conform to the default S1000D issue (5.0).
- \-\~, --dump-templates \<dir\>
Dump the built-in XML template to the specified directory.
- \-b, --brex \<BREX\>
BREX data module code.
- \-c, --security \<sec\>
The security classification of the new DML.
- \-d, --defaults \<file\>
Specify the `.defaults` file name.
- \-f, --overwrite
Overwrite existing file.
- \-h, -?, --help
Show usage message.
- \-I, --date \<date\>
The issue date of the new DML in the form of YYYY-MM-DD.
- \-i, --info-code \<info code\>
When creating a DMRL from SNS rules (-S), use the specified info
code for each entry. Specify this option multiple times to create
multiple data modules for each part of the SNS. \<info code\> can
specify:
- the base info code (e.g., 520)
- the info code variant (e.g., 520B)
- the item location code (e.g., 520B-C)
- \-l, --list
Treat input (stdin or arguments) as lists of CSDB objects to add to
the new list.
- \-m, --remarks \<remarks\>
Set the remarks for the new data management list.
- \-N, --omit-issue
Omit the issue/inwork numbers from filename.
- \-n, --issno \<issue\>
The issue number of the new DML.
- \-p, --prompt
Prompts the user for any values left unspecified.
- \-q, --quiet
Do not report an error when the file already exists.
- \-R, --rpccode \<NCAGE\>
Specifies a default responsible partner company enterprise code for
entries which do not carry this in their ID STATUS section (ICN,
COM, DML).
- \-r, --rpcname \<name\>
Specifies a default responsible partner company enterprise name for
entries which do not carry this in their IDSTATUS section (ICN, COM,
DML).
- \-S, --sns \<SNS\>
Create a DMRL using the specified SNS rules.
- \-v, --verbose
Print the file name of the newly created DML.
- \-w, --inwork \<inwork\>
The inwork number of the new DML.
- \-z, --issue-type \<type\>
The issue type of the new DML.
- \--version
Show version information.
- \<object\>...
Any number of CSDB object file names to automatically add to the
list.
In addition, the following options allow configuration of the XML
parser:
- \--dtdload
Load the external DTD.
- \--huge
Remove any internal arbitrary parser limits.
- \--net
Allow network access to load external DTD and entities.
- \--noent
Resolve entities.
- \--parser-errors
Emit errors from parser.
- \--parser-warnings
Emit warnings from parser.
- \--xinclude
Do XInclude processing.
- \--xml-catalog \<file\>
Use an XML catalog when resolving entities. Multiple catalogs may be
loaded by specifying this option multiple times.
## `.defaults` file
Refer to s1kd-newdm(1) for information on the `.defaults` file which is
used by all the s1kd-new\* commands.
# EXAMPLE
$ s1kd-newdml -# EX-12345-C-2018-00001
gopher://khzae.net/0/s1000d/s1kd-tools/src/tools/s1kd-newdml/README.md