device-mapper-utils/blk-stash

Create man page for blk-archive

Open

#2 aperta il 23 lug 2025

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Rust (1 fork)auto 404
documentationgood first issuehelp wanted

Metriche repository

Star
 (0 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

Create man page for blk-archive

There is currently no man page available for blk-archive, which makes it harder for users to discover and understand its functionality and usage conventions through standard Unix documentation practices.

This issue is to track the creation of a proper man page (blk-archive.1) that can be installed alongside the binary and accessed via man blk-archive.

Expected contents of the man page

  • NAME – short description of what blk-archive does
  • SYNOPSIS – CLI usage and flags
  • DESCRIPTION – high-level overview of what the tool is for, key features
  • OPTIONS – detailed list of all CLI flags and subcommands
  • EXAMPLES – sample commands with common usage patterns
  • EXIT STATUS – description of exit codes
  • FILES – any configuration or output file formats, if applicable
  • AUTHOR – credit and maintainer info
  • SEE ALSO – references to related tools, e.g., tar(1), rsync(1), etc.

Guida contributor