diff --git a/README.md b/README.md index 0c11fcf..accf1dc 100644 --- a/README.md +++ b/README.md @@ -162,40 +162,38 @@ usage: rocky-man [-h] [--versions VERSIONS [VERSIONS ...]] Generate HTML documentation for Rocky Linux man pages -Options: - -h, --help Show this help message and exit - +optional arguments: + -h, --help show this help message and exit --versions VERSIONS [VERSIONS ...] Rocky Linux versions to process (default: 8.10 9.6 10.0) - --repo-types REPO_TYPES [REPO_TYPES ...] Repository types to process (default: BaseOS AppStream) - --output-dir OUTPUT_DIR - HTML output directory (default: ./html) - + Output directory for HTML files (default: ./html) --download-dir DOWNLOAD_DIR - Package download directory (default: ./tmp/downloads) - + Directory for downloading packages (default: ./tmp/downloads) --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-extracts Keep extracted man files after processing - - --parallel-downloads N + --parallel-downloads PARALLEL_DOWNLOADS Number of parallel downloads (default: 5) - - --parallel-conversions N + --parallel-conversions PARALLEL_CONVERSIONS Number of parallel HTML conversions (default: 10) - - --mirror URL Rocky Linux mirror URL - (default: http://dl.rockylinux.org/) - - --template-dir DIR Custom template directory - + --mirror MIRROR Rocky Linux mirror URL (default: http://dl.rockylinux.org/) + --vault Use vault directory instead of pub (vault/rocky instead of pub/rocky) + --existing-versions [VERSION ...] + List of existing versions to include in root index (e.g., 8.10 9.7) + --template-dir TEMPLATE_DIR + Template directory (default: ./templates) -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