2018-03-30 12:13:31 -04:00
|
|
|
# Manpage update tool
|
|
|
|
|
|
|
|
|
|
Utility to update dotnet-cli documentation from https://github.com/dotnet/docs.
|
|
|
|
|
|
|
|
|
|
## Prerequisites
|
|
|
|
|
|
|
|
|
|
* Unix OS
|
|
|
|
|
* `python` in PATH
|
|
|
|
|
* `pandoc` installed
|
|
|
|
|
* `pandocfilters` package installed
|
|
|
|
|
* `unzip`
|
|
|
|
|
* `wget` or `curl`
|
|
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
./update-man-pages.sh
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Ubuntu example (from scratch)
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
sudo apt install -y pandoc python python-pip wget unzip < /dev/null
|
|
|
|
|
sudo pip install pandocfilters
|
|
|
|
|
|
|
|
|
|
git clone https://github.com/dotnet/cli
|
2018-03-30 12:18:22 -04:00
|
|
|
./cli/Documentation/manpage/tool/update-man-pages.sh
|
2018-03-30 12:13:31 -04:00
|
|
|
```
|
2018-03-30 12:57:29 -04:00
|
|
|
|
|
|
|
|
The version of pandoc is printed in first line as code comment in `.1` (manpage) files.
|
|
|
|
|
If your version of pandoc is older than (or even equal to) the last modifed version,
|
|
|
|
|
please install the latest stable version of pandoc from https://github.com/jgm/pandoc/releases (deb file for Ubuntu):
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
wget -q https://github.com/jgm/pandoc/releases/download/$pandocVersion/$pandocVersionedName.deb > /dev/null
|
|
|
|
|
# or
|
|
|
|
|
# curl -sSLO https://github.com/jgm/pandoc/releases/download/$pandocVersion/$pandocVersionedName.deb > /dev/null
|
|
|
|
|
sudo dpkg -i $pandocVersionedName.deb
|
|
|
|
|
rm $pandocVersionedName.deb*
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
after that update manpages by calling `update-man-pages.sh` script.
|
