summaryrefslogtreecommitdiff
path: root/README.md
blob: 99d316486db1eebc8f2430868402c728529257f1 (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
# The Manned.org Source Code

This repository holds the source code of Manned.org. For a description of the
site, check out [https://manned.org/info/about](https://manned.org/info/about).
  
Ironically, documentation about how things work is completely lacking.

## Requirements

- perl: A somewhat recent version (no idea which, due to my XS usage)
- postgresql: Also a somewhat recent version
- rust + cargo (1.13+)

### Web front-end

- DBI
- DBD::Pg
- TUWF
- JSON::XS
- AnyEvent

### Man page indexer

- curl
- psql

## File structure

- **indexer/** -> The Rust program that scans package repositories for updates, fetches new packages and extracts the man pages.
- **lib/ManUtils/** -> Perl/XS helper module to format man pages into HTML (uses **web/**).
- **sql/** -> Database schema & updates.
- **util/** -> Cron job and scripts to run **indexer/** on the right repositories.
- **web/** -> Badly named Rust library to convert man pages into HTML.
- **www/** -> The web front-end.