home » dokk/manpages.git
Author zPlus <zplus@peers.community> 2023-07-08 10:54:32
Committer zPlus <zplus@peers.community> 2023-07-08 10:54:32
Commit c886358 (patch)
Tree 9e6781f
Parent(s)

Update broken instructions.


commits diff: 66e0802..c886358
2 files changed, 17 insertions, 11 deletionsdownload


Diffstat
-rw-r--r-- README 18
-rwxr-xr-x scripts/Makefile 10

Diff options
View
Side
Whitespace
Context lines
Inter-hunk lines
+10/-8 M   README
index f52f445..b9e9121
old size: 638B - new size: 695B
@@ -5,18 +5,20 @@ listening on port 3142.
5 5 debiman by default will download from http://localhost:3142/deb.debian.org/
6 6 This setting can be changed with -local_mirror or -remote_mirror
7 7
8 - Download manpages from Debian:
8 + How to use the scripts:
9 9
10 - $ DEBIMAN_SERVING_DIR=/absolue/path make download
10 + 1. Download manpages from Debian:
11 11
12 - Extract all the pages from .gz:
12 + $ DEBIMAN_SERVING_DIR=/absolue/path make download
13 13
14 - $ DEBIMAN_SERVING_DIR=/absolue/path make download
14 + 2. Extract all the pages from .gz:
15 15
16 - Convert manpages to plaintext:
16 + $ DEBIMAN_SERVING_DIR=/absolue/path make extract
17 17
18 - $ DEBIMAN_SERVING_DIR=/absolue/path make convert
18 + 3. Convert manpages to plaintext and html:
19 19
20 - Create RDF graph:
20 + $ DEBIMAN_SERVING_DIR=/absolue/path make convert
21 21
22 - $ DEBIMAN_SERVING_DIR=/absolue/path ./rdf.py
22 + 4. Create RDF graph:
23 +
24 + $ DEBIMAN_SERVING_DIR=/absolue/path ./rdf.py

+7/-3 M   scripts/Makefile
index 12f02b2..1d81877
old size: 1K - new size: 2K
@@ -1,18 +1,22 @@
1 1 SHELL = /bin/bash
2 +
3 + # THIS PATH MUST BE ABSOLUTE.
4 + # The path where debiman will save files.
5 + # There is a bug in debiman, it won't accept a relative path
2 6 DEBIMAN_SERVING_DIR ?= ./
3 7
4 8
5 9 # This just prints out variables for displaying
6 10 vars:
7 11 @echo "Using envvar DEBIMAN_SERVING_DIR = ${DEBIMAN_SERVING_DIR}"
8 -
12 + @echo "If you get errors, this path MUST be absolute."
9 13
10 14 # Note: the behaviour of debiman is to download all the manpages, then render them all.
11 15 # This cannot be changed. Since we're only interested in the raw manpages and not
12 16 # the HTML output, -only_render_pkgs is a hack that will make debiman render only one
13 17 # page (0ad) and quit.
14 18 download: vars
15 - debiman -sync_codenames="bookworm" -serving_dir="${DEBIMAN_SERVING_DIR}" -only_render_pkgs="0ad"
19 + debiman -sync_codenames="bookworm" -sync_suites= -serving_dir="${DEBIMAN_SERVING_DIR}" -only_render_pkgs="0ad"
16 20
17 21 # Extract downloaded pages since they're compressed by default
18 22 extract: vars
@@ -32,4 +36,4 @@ convert: vars
32 36 mandoc -T html -O fragment "$${file}" > "$${file}.roff.html"; \
33 37 done < <( find "${DEBIMAN_SERVING_DIR}" -type f -name "*.*.*" ! -name "*.gz" ! -name "*.roff" ! -name "*.txt" ! -name "*.html" ! -name "stress-ng.1.en" ! -name "md.4.en" )
34 38
35 - .PHONY: vars download extract
39 + .PHONY: vars download extract convert