Generate Man Page

gen_man is shell tool for generating man pages.

Developed in bash code: 100%.

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.

Table of Contents

• Installation
• Usage
• Dependencies
• Shell tool structure
• Docs
• Copyright and licence

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.

Usage

# Create symlink for shell tool
ln -s /root/scripts/gen_man/ver.x.y/bin/gen_man.sh /root/bin/gen_man

# Setting PATH
export PATH=${PATH}:/root/bin/

# Generating man
gen_man SimpleTest

Dependencies

gen_man requires next modules and libraries:

• sh_util https://github.com/vroncevic/sh_util

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

Docs

More documentation and info at:

• https://gen_man.readthedocs.io/en/latest/
• https://www.gnu.org/software/bash/manual/
• https://www.man7.org/linux

Copyright and licence

Copyright (C) 2017 - 2024 by vroncevic.github.io/gen_man

gen_man is free software; you can redistribute it and/or modify it under the same terms as Bash itself, either Bash version 4.2.47 or, at your option, any later version of Bash 4 you may have available.

Lets help and support FSF.