Kobol

Project Status	Communication

Table of Contents

• Description
• Quickstart
• Installation
• Troubleshooting

Description

• name: kobol
• description: man wrapper for creating and reading user manuals from markdown files.
• author: Filippo Squillace
• username: fsquillace
• OS compatibility: linux, osx

Quickstart

• Create the markdown file mymanual.md in $KOBOL_VARDIR/markdown.

• To view the content of it as a manual (the manual will be generated just before viewing it):

$ kobol mymanual

Every man options can be used in kobol as well. For instance for searching according to the keyword banana :

$ kobol -K banana mymanual

kobol creates the corresponding manual in $KOBOL_VARDIR/mans directory.

Similarly to man command, to list all available mans you need to run mandb first to generate the cache:

mandb $KOBOL_MANPATH
kobol -k .

For more information on how to search for manuals go here.

Installation

This package needs to be installed via Pearl system.

pearl install kobol

kobol requires the ronn command to be installed:

gem install ronn

Dependencies

The main dependencies are the following:

• Pearl
• ronn

Troubleshooting

This section has been left blank intentionally. It will be filled up as soon as troubles come in!