aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: b1c66115ae94db66aee0c0eda968b9f01fd089fd (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
31
32
33
34
35
36
37
# Man plugin for Dillo

Shows local manual pages as HTML in Dillo with clickable links to other
manual pages. It uses the [man(1)](man:man) program to generate the HTML
from the manual pages (with the -T html extension) and [sed(1)](man:sed)
to manipulate the HTML.

It comes with a CSS style file that improves the display of manual
pages and can be modified to change the appearance.

<p align="center"><img src="screenshot.png" width="45%" />
<img src="screenshot2.png" width="45%" /></p>

## Installation

To install the plugin use:

```
$ make install
```

The two files `man.filter.dpi` and `style.css` will be copied into 
`~/.dillo/dpi/man/`. Edit `style.css` as needed.

## Usage

The manual pages are accessed by the name of the manual page alone, 
`man:bash`, or with the section number in parenthesis to specify the
manual section, `man:read(3)`.

Here are some examples to test it from the command line:

```
$ dillo man:git
$ dillo man:namespaces
$ dillo "man:groff(7)"
```