.\" Automatically generated by Pandoc 2.9.2.1 .\" .TH "s1kd-metadata" "1" "2021-04-16" "" "s1kd-tools" .hy .SH NAME .PP s1kd-metadata - View and edit S1000D CSDB object metadata .SH SYNOPSIS .IP .nf \f[C] s1kd-metadata [options] [...] \f[R] .fi .SH DESCRIPTION .PP The \f[I]s1kd-metadata\f[R] tool provides a simple way to fetch and change metadata on S1000D CSDB objects. .SH OPTIONS .TP -0, --null Print a null-delimited list of values of the pieces of metadata specified with -n, or all available metadata if -n is not specified. .TP -c, --set Use to edit metadata files. consists of lines starting with a metadata name, followed by whitespace, followed by the new value for the metadata (the program uses this same format when outputting all metadata if no is specified). .TP -d, --date-format The format to use when printing dates, such as the \[dq]issueDate\[dq] or \[dq]modified\[dq] metadata. should conform to the format used by strftime. The default is \[dq]%Y-%m-%d\[dq]. .TP -E, --editable When showing all metadata, only list editable items. This is useful when creating a file for use with the -c option. .TP -e, --exec Execute a command for each CSDB object. The string \[dq]{}\[dq] is replaced by the current CSDB object file name everywhere it occurs in the arguments to the command. .TP -F, --format Print a formatted line for each CSDB object. Metadata names surrounded with % (e.g. %issueDate%) will be substituted by the value read from the object. .TP -f, --overwrite When editing metadata, overwrite the object. The default is to output the modified object to stdout. .TP -H, --info Lists all available metadata with a short description of each. Specify specific metadata to describe with the -n option. .TP -h, -?, --help Show help/usage message. .TP -l, --list Treat input as a list of object filenames to read or edit metadata on, rather than an object itself. .TP -m, --matches Used after a -w or -W option, this specifies a regular expression to match the value of the given metadata against, instead of a literal value (-v). .TP -n, --name The name of the piece of metadata to fetch. This option can be specified multiple times to fetch multiple pieces of metadata. If -n is not specified, all available metadata names are printed with their values. This output can be sent to a text file, edited, and then specified with the -c option as a means of editing metadata in any text editor. .TP -q, --quiet Quiet mode. Non-fatal errors such as a missing piece of optional metadata in an object will not be printed to stderr. .TP -T, --raw Do not format columns in output. .TP -t, --tab Print a tab-delimited list of values of the pieces of metadata specified with -n, or all available metadata if -n is not specified. .TP -v, --value When following a -n option, this specifies the new value for that piece of metadata. .RS .PP When following a -w or -W option, this specifies the value to compare that piece of metadata to. .PP Each -n, -w, or -W can be followed by -v to edit or define conditions on multiple pieces of metadata. .RE .TP -W, --where-not Show or edit metadata only on objects where the value of is not equal to the value specified in the following -v option. If no -v option follows, this will show objects which do not have metadata of any value. .TP -w, --where Show or edit metadata only on objects where the value of is equal to the value specified in the following -v option. If no -v option follows, this will show objects which have metadata with any value. .TP --version Show version information. .TP ... The object(s) to show/edit metadata on. The default is to read from stdin. .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 Use an XML catalog when resolving entities. Multiple catalogs may be loaded by specifying this option multiple times. .SH EXAMPLE .IP .nf \f[C] $ ls DMC-S1KDTOOLS-A-09-00-00-00A-040A-D_EN-CA.XML DMC-S1KDTOOLS-A-0Q-00-00-00A-040A-D_EN-CA.XML $ DMOD=DMC-S1KDTOOLS-A-09-00-00-00A-040A-D_EN-CA.XML $ s1kd-metadata $DMOD issueDate 2017-08-14 techName s1kd-metadata(1) | s1kd-tools responsiblePartnerCompany khzae.net originator khzae.net securityClassification 01 schema descript schemaUrl http://www.s1000d.org/S1000D_5-0/xml_ schema_flat/descript.xsd type dmodule applic All brex S1000D-F-04-10-0301-00A-022A-D issueType new languageIsoCode en countryIsoCode CA issueNumber 001 inWork 00 dmCode S1KDTOOLS-A-09-00-00-00A-040A-D $ s1kd-metadata -n techName -v \[dq]New title\[dq] $DMOD $ s1kd-metadata -n techName $DMOD New title $ s1kd-metadata -n techName DMC-*.XML New title s1kd-aspp(1) | s1kd-tools $ s1kd-metadata -F \[dq]%techName% (%issueDate%) %issueType%\[dq] DMC-*.XML New title (2017-08-14) new s1kd-aspp(1) | s1kd-tools (2018-03-28) changed $ s1kd-metadata -F \[dq]%techName%\[dq] -w subSubSystemCode -v Q DMC-*.XML s1kd-aspp(1) | s1kd-tools $ s1kd-metadata -n path -w subSystemCode -v Q DMC-S1KDTOOLS-A-0Q-00-00-00A-040A-D_EN-CA.XML $ s1kd-metadata -n path -W subSystemCode -v Q DMC-S1KDTOOLS-A-09-00-00-00A-040A-D_EN-CA.XML $ s1kd-metadata -n path -w subSystemCode -m [0-9] DMC-S1KDTOOLS-A-09-00-00-00A-040A-D_EN-CA.XML \f[R] .fi .SH AUTHORS khzae.net.