yangdump-pro

Organization:

YumaWorks, Inc.

Module:

yangdump-pro

Version:

2024-02-25

File:

yangdump-pro.yang

Abstract:

yangdump-pro provides validation and translation of YANG data models. Information about a module or submodule can be generated a...

Contact:

Support <support at yumaworks.com>

Check for an additional details:

YANG Catalog

Description:

yangdump-pro provides validation and translation of YANG data
models. Information about a module or submodule can be
generated as well.

INPUT FILES

Operations can be performed on one or more files with
the 'module' parameter, or an entire directory tree
with the 'subtree' parameter. Unless the 'help' or
'version' parameters is entered, one of these input
parameters must be present.

SEARCH PATH

When a module name is entered as input, or when a
module or submodule name is specified in an import or
include statement within the file, the following search
algorithm is used to find the file:

1) file is in the current directory
2) YUMAPRO_MODPATH environment var (or set by modpath parm)
3) $HOME/modules directory
4) $YUMAPRO_HOME/modules directory
5) $YUMAPRO_INSTALL/modules directory OR
default install module location,
'/usr/share/yumapro/modules'

By default, the entire directory tree for all locations
(except step 1) will be searched, not just the specified
directory. The 'subdirs' parameter can be used to
prevent sub-directories from being searched.

Any directory name beginning with a dot character '.'
will be skipped. Also, any directory named 'CVS' will
be skipped in directory searches.

TRANSLATION MODES

The 'format' parameter is used to select a translation output mode.
If it is missing, then no translation will be done.
This parameter can be used with the module reports parameters,
but the translation output should be directed to a file
instead of STDOUT to keep them separated.

For XSD 1.0 translation, use the 'format=xsd' parameter.

For XHTML 1.0 translation, use the 'format=html' parameter.

For YIN translation, use the 'format=yin' parameter.

MODULE REPORTS

For a 1 line output of the module name and version,
use the 'modversion' parameter.

For a listing of all the symbols that the file exports
to other files, use the 'exports' parameter.

For a listing of all the files that the file depends on,
to compile, use the 'dependencies' parameter.

For a listing of all the accessible object identifiers that
the file contains, use the 'identifiers' parameter.

For a tree listing of all the accessible object identifiers that
the file contains, use the 'tree-identifiers' parameter.

OUTPUT MODES

By default, any translation output will be sent to STDOUT.

The 'output' parameter can be used to specify the
full filespec of the output file, or a
partial directory specification to be combined
with a default filename.

The 'defnames' parameter can be used to generate a default
filename in the current directory for the output, or
in the 'output' directory, if one is specified.

By default, an output filename will have the form:

<module-name>.<module-revision>.<ext>

If the 'versionnames=false' parameter is used, then the
default filename will have the form:

<module-name>.<ext>

This parameter will also affect URL generation during
HTML translation.

When the 'subtree' input parameter is used for XSD or HTML
translation, the 'defnames' parameter will be automatically
set to 'true', to maintain well-formed XML documents when
multiple translations are possible.

If the 'unified' parameter is set to 'true', then all
submodules will be processed when the input is a main
module that includes any submodules. For XSD and HTML
translation, the submodule content will be generated
instead of an 'include' statement. Submodule files
will be skipped in 'subtree' mode.

ERROR LOGGING

By default, warnings and errors are sent to STDOUT.

A log file can be specified instead with the 'log' parameter.
Existing log files can be reused with the 'logappend'
parameter, otherwise log files are overwritten.

The logging level can be controlled with the 'log-level'
parameter. The default log level is 'info'. The
log-levels are additive:

off: suppress all errors (not recommended!)
A program return code of '1' indicates some error.
error: print errors
warn: print warnings
info: print generally interesting trace info
debug: print general debugging trace info
debug2: print verbose debugging trace info

Copyright (c) 2010 - 2023 YumaWorks, Inc. All rights reserved.

Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject
to the license terms contained in, the BSD 3-Clause License
http://opensource.org/licenses/BSD-3-Clause