Create Man Page for pysemver

Situation

When creating packages for Linux distributions (RPM or DEB), it is good practice to have a man page for each executable.

However, we currently don’t have a dedicated man page for our pysemver script. Although we have rudimentary descriptions in our cli.rst, it doesn’t follow the man page style.

Proposed Solution

We should provide the man page for this project. When I’ve wrote this cli.rst file, I didn’t think of creating a man page. I better should have thought about that.

As such, I would suggest to improve the existing cli.rst page and turn it into a “real” man page. As we probably add more features in the future, we should prepare it to help users and packages.

I would propose to change the existing cli.rst file and add the usual man page structure:

NAME
    pysemver - Helper script for Semantic Versioning

SYNOPSIS
   pysemver compare version1 version2
   pysemver bump {major,minor,patch,prerelease,build} version

DESCRIPTION
   [...]
SEE ALSO
   https://python-semver.readthedocs.io/en/latest/

AUTHOR
   [...]

This can easily built with sphinx-build and choosing a man builder. After the man page was built, it can be added to the RPM or Debian package.

[tomschr]

Unfortunately, I don’t know much about Debian packaging.

Distributing python-semver as package for some Linux distros should be considered. Maybe we should only consider for now Debian and Suse.

Good idea, that inspired me to another idea: why not extend the “Installing semver” section in our documentation? We could add where to get your package for your specific distribution and how to install it (via apt-get, dnf, or zypper).

By the way, you probably mean openSUSE. 😉

[scls19fr]

Maybe we should have a look to see who is the maintainer of this Debian package. Distributing python-semver as package for some Linux distros should be considered. Maybe we should only consider for now Debian and Suse.