Skip to content

Generate and ship a man page #2

Description

@nullarch

Packagers (Homebrew, .deb, .rpm) expect a man page, and we ship none.

What to do

Generate attempt.1 from the existing clap definition with clap_mangen, rather than hand-writing roff.

  • A build.rs in crates/attempt or a hidden attempt man --out <dir> subcommand — either is fine, argue for one in the PR. A hidden subcommand keeps the build simple and lets docs/releasing.md call it.
  • Include the generated page in the release archive alongside the binary (.github/workflows/release.yml, the Package step), and install it from the Homebrew formula (man1.install "attempt.1").

Done when

man ./attempt.1 renders with the subcommand list, and a release archive contains it.

Good first issue: mechanical, but touches the release workflow — ask if anything there is unclear.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions