summaryrefslogtreecommitdiff
path: root/README.md
blob: a403ce99c97ea872b5c2f7b7c25ce092990869d9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# mandocset

This is python script (mandocset.py) that generates Dash docset from man pages. It takes folders with man pages as it's arguments. Then in each folder it finds all folders, containing digit in their name, runs `man2html -r` for each file inside them.

---

This is a loose fork of [Yanpas' repository](https://github.com/Yanpas/mandocset), forked to help package additional man page collections. Currently, this fork only supports Debian and Debian-based systems.

### Prerequisites

- `apt-file`
- `coreutils`
- `make`
- `man2html`
- `python3`

```
# apt install apt-file coreutils make man2html python3
```

### Usage

Available docsets to build are listed under `getters/`. To build a docset, run `make DOCSET=[DOCSET]`, where `[DOCSET]` is the docset you wish to generate (the name of the script in `getters/` minus the extension). 

An alternative executable to `man2html` for conversion can also be specified using `EXECUTABLE=[EXECUTABLE]`, for example, `EXECUTABLE="pandoc -f man -t html"`.

Additional make targets include:

- `make clean` - remove the directories created when building the docset
- `make tgz` - Create a .tgz archive for easily submitting to [Dash-User-Contributions](https://github.com/Kapeli/Dash-User-Contributions)