diff --git a/README.md b/README.md index c030358..8bdf869 100644 --- a/README.md +++ b/README.md @@ -43,50 +43,61 @@ The command line options are aligned to the standard Conan options. ```shellSession $ cyclonedx-conan --help -usage: command.py [-h] [-if INSTALL_FOLDER] [-db [DRY_BUILD]] [--exclude-dev] [-b [BUILD]] [-r REMOTE] [-u] [-l LOCKFILE] [--lockfile-out LOCKFILE_OUT] - [-e ENV_HOST] [-e:b ENV_BUILD] [-e:h ENV_HOST] [-o OPTIONS_HOST] [-o:b OPTIONS_BUILD] [-o:h OPTIONS_HOST] - [-pr PROFILE_HOST] [-pr:b PROFILE_BUILD] [-pr:h PROFILE_HOST] [-s SETTINGS_HOST] [-s:b SETTINGS_BUILD] - [-s:h SETTINGS_HOST] [-c CONF_HOST] [-c:b CONF_BUILD] [-c:h CONF_HOST] - path_or_reference +usage: cyclonedx-conan [-h] [-if INSTALL_FOLDER] [-db [DRY_BUILD]] + [--exclude-dev] [-b [BUILD]] [-r REMOTE] [-u] + [-l LOCKFILE] [--lockfile-out LOCKFILE_OUT] + [-e ENV_HOST] [-e:b ENV_BUILD] [-e:h ENV_HOST] + [-o OPTIONS_HOST] [-o:b OPTIONS_BUILD] + [-o:h OPTIONS_HOST] [-pr PROFILE_HOST] + [-pr:b PROFILE_BUILD] [-pr:h PROFILE_HOST] + [-s SETTINGS_HOST] [-s:b SETTINGS_BUILD] + [-s:h SETTINGS_HOST] [-c CONF_HOST] [-c:b CONF_BUILD] + [-c:h CONF_HOST] + path_or_reference CycloneDX SBOM Generator positional arguments: - path_or_reference Path to a folder containing a recipe (conanfile.py or conanfile.txt) or to a recipe file. e.g., - ./my_project/conanfile.txt. It could also be a reference + path_or_reference Path to a folder containing a recipe (conanfile.py or conanfile.txt) or to a recipe file. + e.g., ./my_project/conanfile.txt. It could also be a reference -optional arguments: +options: -h, --help show this help message and exit -if INSTALL_FOLDER, --install-folder INSTALL_FOLDER local folder containing the conaninfo.txt and conanbuildinfo.txt files (from a previous conan install execution). - Defaulted to current folder, unless --profile, -s or -o is specified. If you specify both install-folder and any - setting/option it will raise an error. + Defaulted to current folder, unless --profile, -s or -o is specified. + If you specify both install-folder and any setting/option it will raise an error. -db [DRY_BUILD], --dry-build [DRY_BUILD] Apply the --build argument to output the information, as it would be done by the install command --exclude-dev Exclude development dependencies from the BOM -b [BUILD], --build [BUILD] - Given a build policy, return an ordered list of packages that would be built from sources during the install - command + Given a build policy, return an ordered list of packages that would be built from sources during the install command -r REMOTE, --remote REMOTE Look in the specified remote server - -u, --update Will check if updates of the dependencies exist in the remotes (a new version that satisfies a version range, a - new revision or a newer recipe if not using revisions). + -u, --update Will check if updates of the dependencies exist in the remotes + (a new version that satisfies a version range, a new revision or a newer recipe if not using revisions). -l LOCKFILE, --lockfile LOCKFILE Path to a lockfile --lockfile-out LOCKFILE_OUT Filename of the updated lockfile -e ENV_HOST, --env ENV_HOST - Environment variables that will be set during the package build (host machine). e.g.: -e CXX=/usr/bin/clang++ + Environment variables that will be set during the package build (host machine). + e.g.: -e CXX=/usr/bin/clang++ -e:b ENV_BUILD, --env:build ENV_BUILD - Environment variables that will be set during the package build (build machine). e.g.: -e:b CXX=/usr/bin/clang++ + Environment variables that will be set during the package build (build machine). + e.g.: -e:b CXX=/usr/bin/clang++ -e:h ENV_HOST, --env:host ENV_HOST - Environment variables that will be set during the package build (host machine). e.g.: -e:h CXX=/usr/bin/clang++ + Environment variables that will be set during the package build (host machine). + e.g.: -e:h CXX=/usr/bin/clang++ -o OPTIONS_HOST, --options OPTIONS_HOST - Define options values (host machine), e.g.: -o Pkg:with_qt=true + Define options values (host machine), + e.g.: -o Pkg:with_qt=true -o:b OPTIONS_BUILD, --options:build OPTIONS_BUILD - Define options values (build machine), e.g.: -o:b Pkg:with_qt=true + Define options values (build machine), + e.g.: -o:b Pkg:with_qt=true -o:h OPTIONS_HOST, --options:host OPTIONS_HOST - Define options values (host machine), e.g.: -o:h Pkg:with_qt=true + Define options values (host machine), + e.g.: -o:h Pkg:with_qt=true -pr PROFILE_HOST, --profile PROFILE_HOST Apply the specified profile to the host machine -pr:b PROFILE_BUILD, --profile:build PROFILE_BUILD @@ -94,20 +105,23 @@ optional arguments: -pr:h PROFILE_HOST, --profile:host PROFILE_HOST Apply the specified profile to the host machine -s SETTINGS_HOST, --settings SETTINGS_HOST - Settings to build the package, overwriting the defaults (host machine). e.g.: -s compiler=gcc + Settings to build the package, overwriting the defaults (host machine). + e.g.: -s compiler=gcc -s:b SETTINGS_BUILD, --settings:build SETTINGS_BUILD - Settings to build the package, overwriting the defaults (build machine). e.g.: -s:b compiler=gcc + Settings to build the package, overwriting the defaults (build machine). + e.g.: -s:b compiler=gcc -s:h SETTINGS_HOST, --settings:host SETTINGS_HOST - Settings to build the package, overwriting the defaults (host machine). e.g.: -s:h compiler=gcc + Settings to build the package, overwriting the defaults (host machine). + e.g.: -s:h compiler=gcc -c CONF_HOST, --conf CONF_HOST - Configuration to build the package, overwriting the defaults (host machine). e.g.: -c - tools.cmake.cmaketoolchain:generator=Xcode + Configuration to build the package, overwriting the defaults (host machine). + e.g.: -c tools.cmake.cmaketoolchain:generator=Xcode -c:b CONF_BUILD, --conf:build CONF_BUILD - Configuration to build the package, overwriting the defaults (build machine). e.g.: -c:b - tools.cmake.cmaketoolchain:generator=Xcode + Configuration to build the package, overwriting the defaults (build machine). + e.g.: -c:b tools.cmake.cmaketoolchain:generator=Xcode -c:h CONF_HOST, --conf:host CONF_HOST - Configuration to build the package, overwriting the defaults (host machine). e.g.: -c:h - tools.cmake.cmaketoolchain:generator=Xcode + Configuration to build the package, overwriting the defaults (host machine). + e.g.: -c:h tools.cmake.cmaketoolchain:generator=Xcode ``` ## Python Support