Man pages

Feature Request

The commands in TiUP do not currently have any man pages. Typically all commands in a Linux/Unix system have man pages, which can be browsed on the command-line e.g. man tiup or via websites such as https://dyn.manpages.debian.org/ or https://manpages.ubuntu.com/.

This feature request was motivated by Lintian nagging about https://lintian.debian.org/tags/no-manual-page.html in Debian:

W: tiup: no-manual-page [usr/bin/client]
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:   
N:   If the manual pages are provided by another package on which this package
N:   depends, Lintian may not be able to determine that manual pages are
N:   available. In this case, after confirming that all binaries do have manual
N:   pages after this package and its dependencies are installed, please add a
N:   Lintian override.
N: 
N:   Please refer to Manual pages (Section 12.1) in the Debian Policy Manual
N:   for details.
N: 
N:   Visibility: warning
N:   Show-Always: no
N:   Check: documentation/manual
N:   Renamed from: binary-without-manpage
N: 
N:
W: tiup: no-manual-page [usr/bin/cluster]
N:
W: tiup: no-manual-page [usr/bin/ctl]
N:
W: tiup: no-manual-page [usr/bin/dm]
N:
W: tiup: no-manual-page [usr/bin/package]
N:
W: tiup: no-manual-page [usr/bin/playground]
N:
W: tiup: no-manual-page [usr/bin/server]
N:
W: tiup: no-manual-page [usr/bin/tiup]

Related: #2508 #2507

Start by inventorying the TiUP commands listed in the Lintian output: client, cluster, ctl, dm, package, playground, server, and tiup; also review related issues #2508 and #2507. Done means each listed binary has an appropriate manual page and the Debian Lintian warnings are resolved.