sigmf-python icon indicating copy to clipboard operation
sigmf-python copied to clipboard

Please provide man pages

Open maitbot opened this issue 2 years ago • 3 comments

While preparing packages for Debian, the lintian tool reports: W: python3-sigmf: no-manual-page [usr/bin/sigmf_gui] W: python3-sigmf: no-manual-page [usr/bin/sigmf_validate] N: N: Each binary in /usr/bin, /usr/sbin, /bin, /sbin or /usr/games should have N: a manual page N:
N: Note that though the man program has the capability to check for several N: program names in the NAMES section, each of these programs should have its N: own manual page (a symbolic link to the appropriate manual page is N: sufficient) because other manual page viewers such as xman or tkman don't N: support this. N:
N: If the name of the manual page differs from the binary by case, man may be N: able to find it anyway; however, it is still best practice to match the N: exact capitalization of the executable in the manual page. N:
...

A sigmf_gui.1 and a sigmf_validate.1 man page in the top level directory would suffice.

Also - webapp: perhaps too generic a name? It could use some documentation too.

Once that is done, a tag and a release would help define a version for a Debian package to use. Thanks, -Maitland

maitbot avatar Jan 27 '23 02:01 maitbot