search

darkhz / invidtui

A TUI based Invidious client
MIT License
191 stars 6 forks source link

Man page #23

Closed robert-groensfeld closed 9 months ago

robert-groensfeld commented 1 year ago

Add a man page with detailed description of every option from the wiki.

Btw: when I piped the --help output to less the search and scrolling were broken.

nnzv commented 10 months ago

Unix man pages are not strongly recommended in Golang, but they can still provide valuable documentation. In addition to having a GitHub page and a man page, a package should also provide parseable documentation for pkgsite. This enables Go users to access it through https://pkg.go.dev/github.com/darkhz/invidtui.

CC: @darkhz

darkhz commented 10 months ago

Documentation has already been implemented and hosted as a GitHub Pages website. Adding a man page will require a lot of effort, since the contents of the hosted documentation cannot be easily converted to roff/groff, and creating one from scratch is tedious work. I will consider this, however.