Added manpages for all wolfclu commands#239
Open
stenslae wants to merge 1 commit into
Open
Conversation
stenslae
commented
Jun 1, 2026
stenslae
commented
Member
- Added manpages covering all major wolfssl CLI utilities
- Renamed manpage files to match wolfssl-* convention
- Removed pre-gzipped manpage files. Gzip compression is now handled by the build
- Makefile.am and configure.ac now install and package manpages, with a --disable-manpages flag option in builds.
wolfSSL-Fenrir-bot
left a comment
wolfSSL-Fenrir-bot
left a comment
There was a problem hiding this comment.
Fenrir Automated Review — PR #239
No scan targets match the changed files in this PR. Review skipped.
stenslae
force-pushed
the
manpage-updates
branch
2 times, most recently
from
5e2298c to
edbc45b
Compare
wolfSSL-Fenrir-bot
left a comment
wolfSSL-Fenrir-bot
left a comment
There was a problem hiding this comment.
Fenrir Automated Review — PR #239
No scan targets match the changed files in this PR. Review skipped.
stenslae
force-pushed
the
manpage-updates
branch
2 times, most recently
from
5624224 to
0333d05
Compare
wolfSSL-Fenrir-bot
left a comment
wolfSSL-Fenrir-bot
left a comment
There was a problem hiding this comment.
Fenrir Automated Review — PR #239
No scan targets match the changed files in this PR. Review skipped.
stenslae
force-pushed
the
manpage-updates
branch
3 times, most recently
from
ab1f8ed to
cd95e63
Compare
wolfSSL-Fenrir-bot
left a comment
wolfSSL-Fenrir-bot
left a comment
There was a problem hiding this comment.
Fenrir Automated Review — PR #239
No scan targets match the changed files in this PR. Review skipped.
wolfSSL-Fenrir-bot
left a comment
wolfSSL-Fenrir-bot
left a comment
There was a problem hiding this comment.
Fenrir Automated Review — PR #239
No scan targets match the changed files in this PR. Review skipped.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR expands wolfCLU’s end-user documentation by adding manpages for the major wolfssl CLI commands, aligning manpage filenames with the wolfssl-* convention, and updating the autotools build to install/package these manpages with an opt-out --disable-manpages configure flag.
Changes:
- Added/updated manpages for
wolfssland most subcommands, plus alias.sopages for sign/verify keytypes. - Updated autotools packaging to install
.1sources and generate.1.gzduringmake dist(and via an on-demandmake manpages-gztarget), and gitignored generated.1.gz. - Updated README with build/documentation guidance and example
manusage.
Reviewed changes
Copilot reviewed 43 out of 49 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Documents configure flags and manpage usage/building. |
| manpages/wolfssl.1 | Expanded top-level CLI manpage and command summary. |
| manpages/wolfssl-base64.1 | New manpage for base64. |
| manpages/wolfssl-bench.1 | New manpage for bench. |
| manpages/wolfssl-ca.1 | New manpage for ca. |
| manpages/wolfssl-crl.1 | New manpage for crl. |
| manpages/wolfssl-decrypt.1 | Updated manpage for decrypt. |
| manpages/wolfssl-dgst.1 | New manpage for dgst. |
| manpages/wolfssl-dhparam.1 | New manpage for dhparam. |
| manpages/wolfssl-dilithium.1 | Alias manpage to wolfssl-sign_verify(1). |
| manpages/wolfssl-dsaparam.1 | New manpage for dsaparam. |
| manpages/wolfssl-ecc.1 | Alias manpage to wolfssl-sign_verify(1). |
| manpages/wolfssl-ecparam.1 | New manpage for ecparam. |
| manpages/wolfssl-enc.1 | New manpage for generic enc. |
| manpages/wolfssl-ed25519.1 | Alias manpage to wolfssl-sign_verify(1). |
| manpages/wolfssl-encrypt.1 | Updated manpage for encrypt. |
| manpages/wolfssl-genkey.1 | New manpage for genkey. |
| manpages/wolfssl-hash.1 | New manpage for hash and hashing shortcuts. |
| manpages/wolfssl-md5.1 | New manpage for md5 shortcut. |
| manpages/wolfssl-ocsp.1 | New manpage for ocsp. |
| manpages/wolfssl-pkcs12.1 | New manpage for pkcs12. |
| manpages/wolfssl-pkcs7.1 | New manpage for pkcs7. |
| manpages/wolfssl-pkcs8.1 | New manpage for pkcs8. |
| manpages/wolfssl-pkey.1 | New manpage for pkey. |
| manpages/wolfssl-rand.1 | New manpage for rand. |
| manpages/wolfssl-req.1 | New manpage for req. |
| manpages/wolfssl-rsa.1 | New manpage for rsa (key processing). |
| manpages/wolfssl-s_client.1 | New manpage for s_client. |
| manpages/wolfssl-s_server.1 | New manpage for s_server. |
| manpages/wolfssl-sha256.1 | New manpage for sha256 shortcut. |
| manpages/wolfssl-sha384.1 | New manpage for sha384 shortcut. |
| manpages/wolfssl-sha512.1 | New manpage for sha512 shortcut. |
| manpages/wolfssl-sign_verify.1 | New manpage for raw sign/verify modes. |
| manpages/wolfssl-version.1 | New manpage for version. |
| manpages/wolfssl-verify.1 | New manpage for verify. |
| manpages/wolfssl-x509.1 | New manpage for x509. |
| manpages/wolfssl-xmss.1 | Alias manpage to wolfssl-sign_verify(1). |
| manpages/wolfssl-xmssmt.1 | Alias manpage to wolfssl-sign_verify(1). |
| manpages/wolfCLU_hash.1 | Removes legacy manpage name in favor of wolfssl-hash.1. |
| manpages/wolfCLU_benchmark.1 | Removes legacy manpage name in favor of wolfssl-bench.1. |
| manpages/gzip_all.sh | Removes manual gzipping script (now handled by build). |
| Makefile.am | Installs manpages conditionally; adds dist-hook gzip + manpages-gz target. |
| configure.ac | Adds --disable-manpages and ENABLE_MANPAGES conditional. |
| .gitignore | Ignores generated manpages/*.1.gz. |
Comments suppressed due to low confidence (2)
manpages/wolfssl-encrypt.1:78
- The “Encrypt from standard input” example uses
-in -, but the encrypt path treats-inas a filename and does not special-case-as stdin. On POSIX systems/dev/stdinworks; otherwise this example will not do what it claims.
manpages/wolfssl-decrypt.1:82 - The “Decrypt from standard input” example uses
-in -, but decrypt treats-inas a filename and does not special-case-as stdin. On POSIX systems/dev/stdinworks; otherwise this example will not do what it claims.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.