DockerCLI/man
Arnaud Rebillout 376b99c6d6
Rename bin/md2man to bin/go-md2man
In the recent PR !2877, some code was added to check if md2man is
already installed in the build environment. This is to cater to the
needs of Linux distributions.

However it turns out that Linux distributions install md2man as
bin/go-md2man instead of bin/md2man, hence the PR !2877 doesn't help
much.

This commit fixes it by settling on using the binary name go-md2man.

For reference, here the file list of the package go-md2man in several
distributions:

- Debian: <https://packages.debian.org/sid/amd64/go-md2man/filelist>
- Ubuntu: <https://packages.ubuntu.com/hirsute/amd64/go-md2man/filelist>
- Fedora: <https://fedora.pkgs.org/31/fedora-x86_64/golang-github-cpuguy83-md2man-2.0.0-0.4.20190624gitf79a8a8.fc31.x86_64.rpm.html>
- ArchLinux: <https://www.archlinux.org/packages/community/x86_64/go-md2man/>

Signed-off-by: Arnaud Rebillout <elboulangero@gmail.com>
(cherry picked from commit 6e2607c6a6)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-02-04 14:50:45 +01:00
..
src Replace deprecated instruction 2020-10-23 19:49:51 +02:00
Dockerfile.5.md Update man-page source MarkDown to work with go-md2man v2 2020-10-20 12:21:15 +02:00
README.md Make README less scabious 2017-06-02 00:10:02 +00:00
docker-build.1.md Update man-page source MarkDown to work with go-md2man v2 2020-10-20 12:21:15 +02:00
docker-config-json.5.md Update man-page source MarkDown to work with go-md2man v2 2020-10-20 12:21:15 +02:00
docker-run.1.md Update man-page source MarkDown to work with go-md2man v2 2020-10-20 12:21:15 +02:00
docker.1.md Update man-page source MarkDown to work with go-md2man v2 2020-10-20 12:21:15 +02:00
dockerd.8.md Update man-page source MarkDown to work with go-md2man v2 2020-10-20 12:21:15 +02:00
generate.go man-pages: fix missing manual title in heading 2020-10-20 12:54:57 +02:00
import.go vendor: spf13/cobra v1.0.0, go-md2man v2.0.0, blackfriday v2.0.1 2020-05-04 17:00:46 +02:00
md2man-all.sh Rename bin/md2man to bin/go-md2man 2021-02-04 14:50:45 +01:00

README.md

Docker Documentation

This directory contains scripts for generating the man pages. Many of the man pages are generated directly from the spf13/cobra Command definition. Some legacy pages are still generated from the markdown files in this directory. Do not edit the man pages in the man1 directory. Instead, update the Cobra command or amend the Markdown files for legacy pages.

Generate the man pages

From within the project root directory run:

make manpages