Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Re-generated man page ahead of next release #216

Merged
merged 2 commits into from
Jan 9, 2025
Merged

Re-generated man page ahead of next release #216

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
536f0a3
Re-generated man page file
olehermanse Jan 9, 2025
2ed0519
Improved error message for missing dependency
olehermanse Jan 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions cfbs/cfbs.1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
.TH CFBS "1" "2024\-11\-26" "cfbs" "CFEngine Build System manual"
.TH CFBS "1" "2025\-01\-09" "cfbs" "CFEngine Build System manual"
.SH NAME
cfbs \- combines multiple modules into 1 policy set to deploy on your infrastructure. Modules can be custom promise types, JSON files which enable certain functionality, or reusable CFEngine policy. The modules you use can be written by the CFEngine team, others in the community, your colleagues, or yourself.
.SH SYNOPSIS
.B cfbs
[-h] [--loglevel LOGLEVEL] [-M] [--version] [--force] [--non-interactive] [--index INDEX] [--check] [--checksum CHECKSUM] [--keep-order] [--git {yes,no}] [--git-user-name GIT_USER_NAME] [--git-user-email GIT_USER_EMAIL] [--git-commit-message GIT_COMMIT_MESSAGE] [--ignore-versions-json] [--masterfiles MASTERFILES] [cmd] [args ...]
[-h] [--loglevel LOGLEVEL] [-M] [--version] [--force] [--non-interactive] [--index INDEX] [--check] [--checksum CHECKSUM] [--keep-order] [--git {yes,no}] [--git-user-name GIT_USER_NAME] [--git-user-email GIT_USER_EMAIL] [--git-commit-message GIT_COMMIT_MESSAGE] [--ignore-versions-json] [--omit-download] [--check-against-git] [--from MINIMUM_VERSION] [--masterfiles MASTERFILES] [cmd] [args ...]
.SH DESCRIPTION
CFEngine Build System.

.TP
\fBcmd\fR
The command to perform (pretty, init, status, search, add, remove, clean, update, validate, download, build, install, help, info, show, input, set\-input, get\-input, generate\-release\-information)
The command to perform (pretty, init, status, search, add, remove, clean, update, validate, download, build, install, help, info, show, input, set\-input, get\-input, generate\-
release\-information)

.TP
\fBargs\fR
Expand Down Expand Up @@ -74,15 +75,15 @@ Ignore versions.json. Necessary in case of a custom index or testing changes to

.TP
\fB\-\-omit\-download\fR
Use existing masterfiles instead of downloading in 'cfbs generate-release-information'
Use existing masterfiles instead of downloading in 'cfbs generate\-release\-information'

.TP
\fB\-\-check\-against\-git\fR
Check whether masterfiles from cfengine.com and github.com match in 'cfbs generate-release-information'
Check whether masterfiles from cfengine.com and github.com match in 'cfbs generate\-release\-information'

.TP
\fB\-\-from\fR
Specify minimum version in 'cfbs generate-release-information'
\fB\-\-from\fR \fI\,MINIMUM_VERSION\/\fR
Specify minimum version in 'cfbs generate\-release\-information'

.TP
\fB\-\-masterfiles\fR \fI\,MASTERFILES\/\fR
Expand Down
4 changes: 3 additions & 1 deletion cfbs/man_generator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@
try:
from build_manpages.manpage import Manpage
except ImportError:
user_error("'Manpage' dependency not satisfied")
user_error(
"Missing dependency, install from PyPI: 'pip install argparse-manpage setuptools'"
)


def generate_man_page():
Expand Down
Loading