Skip to content

Man page (man 1 sql-pipe) #22

@vmvarela

Description

@vmvarela

Description

Write a Unix manual page for sql-pipe using scdoc format and include it in release archives and package distributions.

Acceptance Criteria

  • docs/sql-pipe.1.scd written in scdoc format covering: NAME, SYNOPSIS, DESCRIPTION, OPTIONS, EXAMPLES, AUTHORS, SEE ALSO
  • build.zig generates sql-pipe.1.gz when scdoc is available (optional dependency)
  • Man page is included in the release workflow (added to release artifacts)
  • man sql-pipe works after installation via Homebrew or AUR
  • --help output and man page are consistent

Notes

  • scdoc is a lightweight man page authoring format: https://git.sr.ht/~sircmpwn/scdoc
  • The .1.gz artifact can be distributed standalone alongside binaries
  • Homebrew and AUR packages should install it to the correct man1/ path

Metadata

Metadata

Assignees

No one assigned

    Labels

    priority:highMust be in the next sprintsize:sSmall — 1 to 4 hoursstatus:readyRefined and ready for sprint selectiontype:docsDocumentation only

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions