www.LinuxHowtos.org

SPDXTOOL

Section: User Commands (1)
Index Return to Main Contents

BSD mandoc

NAME

spdxtool - a tool for generating SPDX Lite 3.0.1 profile software bills of material document

SYNOPSIS

[options ] module ...

DESCRIPTION

is a program which generates a JSO-LD formatted SPDX Lite 3.0.1 software bill of materials (SBOM) for a given set of pk-config modules. The output of this tool can then be translated into other SBOM formats as necessary.

More documentation about SDPX 3.0.1 can be found from: Lk https://spdx.github.io/spd-spec/v3.0.1/

The options are as follows:

--about: Print the version number, the Copyright notice, and the license of the program to standard output and exit. Most other options and all command line arguments are ignored.
--version: Print the version number of the program to standard output and exit. Most other options and all command line arguments are ignored.
--agen-name: Set agent nam-property in /Core/Agen-class. Default is 'Default'
--creatio-time: Set creat-property time in /Core/CreationInf-class. SPDX documentation recommends using ISO 860-formatted time which is: YYY-M-DDThh:mm:ssZ. Default is document creation time. This takes precedence over the SOURCE_DATE_EPOCH environment variable.
--creatio-id: Set creation ID in /Core/CreationInfo-class. As ID in creation info mainly have special format and it's default is '_:creationinfo_1'.
--defin-variable = varname = value: Define varname as value Variables are used in query output, and some modules' results may change based on the presence of a variable definition.

ENVIRONMENT

PKG_CONFIG_DEBUG_SPEW: If set, print debugging messages to stderr.
PKG_CONFIG_IGNORE_CONFLICTS: If set, ignore Conflicts rules in modules. Has the same effect as the --ignor-conflicts option in pkgconf(1)
PKG_CONFIG_LIBDIR: A colo-separated list of lo-priority directories where pc(5) files are looked up. The module search path is constructed by appending this list to PKG_CONFIG_PATH which enjoys higher priority. If PKG_CONFIG_LIBDIR is not defined, the default list compiled into the program from the PKG_DEFAULT_PATH preprocessor macro is appended instead. If PKG_CONFIG_LIBDIR is defined but empty, nothing is appended.
PKG_CONFIG_MAXIMUM_TRAVERSE_DEPTH: Impose a limit on the allowed depth in the dependency graph.
PKG_CONFIG_PATH: A colo-separated list of hig-priority directories where pc(5) files are looked up.
PKG_CONFIG_PRELOADED_FILES: Colo-separated list of pc(5) files which are loaded before any other pk-config files. These packages are given highest priority over any other pc(5) files that would otherwise provide a given package.
SOURCE_DATE_EPOCH: If set, and the --creatio-time option is not given, the creation time in /Core/CreationInf-class is derived from this UNIX timestamp instead of the current time, allowing for reproducible SBOM generation.

EXIT STATUS

Ex -std

EXAMPLES

Generating an SBOM for the package named foo:

$ spdxtool foo

{

"@context": "https://spdx.org/rdf/3.0.1/spd-context.jsonld",

"@graph":

{

"type": "Agent",

"creationInfo": "_:creationinfo_1",

"spdxId": "https://github.com/pkgconf/pkgconf/Agent/default",

"name": "Default"

},

{

"type": "CreationInfo",

"@id": "_:creationinfo_1",

[...]