admin/rocky-man
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Improve README.md: Update command-line options for clarity and add new arguments

Browse Source 
Signed-off-by: Stephen Simpson <ssimpson89@users.noreply.github.com>
This commit is contained in:
Stephen Simpson
2025-12-05 09:28:41 -06:00
parent c494e55e35
commit 4d7c526b0e
1 changed files with 20 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
README.md
View File

@@ -162,40 +162,38 @@ usage: rocky-man [-h] [--versions VERSIONS [VERSIONS ...]]
Generate HTML documentation for Rocky Linux man pages Generate HTML documentation for Rocky Linux man pages
Options: optional arguments:
-h, --help Show this help message and exit -h, --help show this help message and exit
--versions VERSIONS [VERSIONS ...] --versions VERSIONS [VERSIONS ...]
Rocky Linux versions to process (default: 8.10 9.6 10.0) Rocky Linux versions to process (default: 8.10 9.6 10.0)
--repo-types REPO_TYPES [REPO_TYPES ...] --repo-types REPO_TYPES [REPO_TYPES ...]
Repository types to process (default: BaseOS AppStream) Repository types to process (default: BaseOS AppStream)
--output-dir OUTPUT_DIR --output-dir OUTPUT_DIR
HTML output directory (default: ./html) Output directory for HTML files (default: ./html)
--download-dir DOWNLOAD_DIR --download-dir DOWNLOAD_DIR
Package download directory (default: ./tmp/downloads) Directory for downloading packages (default: ./tmp/downloads)
--extract-dir EXTRACT_DIR --extract-dir EXTRACT_DIR
Extraction directory (default: ./tmp/extracts) Directory for extracting man pages (default: ./tmp/extracts)
--keep-rpms Keep downloaded RPM files after processing --keep-rpms Keep downloaded RPM files after processing
--keep-extracts Keep extracted man files after processing --keep-extracts Keep extracted man files after processing
--parallel-downloads PARALLEL_DOWNLOADS
--parallel-downloads N
Number of parallel downloads (default: 5) Number of parallel downloads (default: 5)
--parallel-conversions PARALLEL_CONVERSIONS
--parallel-conversions N
Number of parallel HTML conversions (default: 10) Number of parallel HTML conversions (default: 10)
--mirror MIRROR Rocky Linux mirror URL (default: http://dl.rockylinux.org/)
--mirror URL Rocky Linux mirror URL --vault Use vault directory instead of pub (vault/rocky instead of pub/rocky)
(default: http://dl.rockylinux.org/) --existing-versions [VERSION ...]
List of existing versions to include in root index (e.g., 8.10 9.7)
--template-dir DIR Custom template directory --template-dir TEMPLATE_DIR
Template directory (default: ./templates)
-v, --verbose Enable verbose logging -v, --verbose Enable verbose logging
--skip-sections [SKIP_SECTIONS ...]
Man sections to skip (default: 3 3p 3pm). Use empty list to skip none.
--skip-packages [SKIP_PACKAGES ...]
Package names to skip (default: lapack dpdk-devel gl-manpages). Use empty list to skip none.
--skip-languages Skip non-English man pages (default: enabled)
--keep-languages Keep all languages (disables --skip-languages)
--allow-all-sections Include all man sections (overrides --skip-sections)
``` ```
## Troubleshooting ## Troubleshooting