gen_man

gen_man is shell tool for generating man pages.

Developed in bash code: 100%.

GitHub shell checker

The README is used to introduce the tool and provide instructions on how to install the tool, any machine dependencies it may have and any other information that should be provided before the tool is installed.

GitHub issues Documentation Status GitHub contributors

Installation

Navigate to release page download and extract release archive.

To install gen_man type the following:

tar xvzf gen_man-x.y.tar.gz
cd gen_man-x.y
cp -R ~/sh_tool/bin/   /root/scripts/gen_man/ver.x.y/
cp -R ~/sh_tool/conf/  /root/scripts/gen_man/ver.x.y/
cp -R ~/sh_tool/log/   /root/scripts/gen_man/ver.x.y/

Or You can use Docker to create image/container.

Dependencies

gen_man requires next modules and libraries:

Shell tool structure

gen_man is based on MOP.

Code structure:

sh_tool/
├── bin/
│   ├── create_man.sh
│   ├── gen_man.sh
│   └── install_man.sh
├── conf/
│   ├── gen_man.cfg
│   ├── gen_man_util.cfg
│   └── template/
│       └── man.template
└── log/
    └── gen_man.log

Indices and tables