jesseduffield
Manual page (manpage) for Man-db
Is your feature request related to a problem? Please describe.
lazygit is a terminal-based user interface. Users of Linux distributions often rely on offline manual pages (man), but no official manpage currently exists for lazygit.
Describe the solution you'd like
Add and maintain an official manpage within the lazygit project.
Describe alternatives you've considered
lazygit already provides well-written and well-maintained web documentation:
- https://github.com/jesseduffield/lazygit/blob/master/README.md
- https://github.com/jesseduffield/lazygit/blob/master/docs/README.md
These documents are also included in the Debian package:
- https://packages.debian.org/sid/amd64/lazygit/filelist
However, they are not formatted for traditional command-line manual page interfaces.
Additional context
Related discussion: https://github.com/jesseduffield/lazygit/pull/4792#issuecomment-3630467206
Currently,
- Debian package includes a manpage written by the package maintainer (me, see below)
- Fedora package provides a manpage exported from the
README.md - Arch package does not provide a manpage
It would be great if the manpage were unified across distributions.
I have drafted a manpage for Debian in mdoc format, available here:
- https://salsa.debian.org/go-team/packages/lazygit/-/blob/debian/sid/debian/manpages/lazygit.1.in
It is rendered as follows:
- https://manpages.debian.org/unstable/lazygit/lazygit.1.en.html
If you would like to use this mdoc-formatted manpage, I would be happy to submit a PR.