https://github.com/pearl-hub/kobol
man wrapper for creating and reading user manuals from markdown files
https://github.com/pearl-hub/kobol
Last synced: about 2 months ago
JSON representation
man wrapper for creating and reading user manuals from markdown files
- Host: GitHub
- URL: https://github.com/pearl-hub/kobol
- Owner: pearl-hub
- License: gpl-2.0
- Created: 2016-04-02T10:18:24.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2020-01-31T19:14:18.000Z (over 5 years ago)
- Last Synced: 2025-03-25T11:11:31.994Z (2 months ago)
- Language: Shell
- Homepage:
- Size: 730 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Kobol
=====
|Project Status|Communication|
|:-----------:|:-----------:|
|[](https://travis-ci.org/pearl-hub/kobol) | [](https://gitter.im/pearl-core/pearl?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |
**Table of Contents**
- [Description](#description)
- [Quickstart](#quickstart)
- [Installation](#installation)
- [Troubleshooting](#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):
```sh
$ kobol mymanual
```
Every `man` options can be used in `kobol` as well.
For instance for searching according to the keyword *banana* :
```sh
$ 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:
```sh
mandb $KOBOL_MANPATH
kobol -k .
```
For more information on how to search for manuals go
[here](https://wiki.archlinux.org/index.php/Man_page#Searching_manuals).
Installation
============
This package needs to be installed via [Pearl](https://github.com/pearl-core/pearl) system.
```sh
pearl install kobol
```
`kobol` requires the [ronn](https://github.com/rtomayko/ronn)
command to be installed:
```sh
gem install ronn
```
Dependencies
------------
The main dependencies are the following:
- [Pearl](https://github.com/pearl-core/pearl)
- [ronn](https://github.com/rtomayko/ronn)
Troubleshooting
===============
This section has been left blank intentionally.
It will be filled up as soon as troubles come in!