mirror of
https://blitiri.com.ar/repos/chasquid
synced 2026-01-05 17:37:03 +00:00
docs: Add man pages
This patch adds man pages for chasquid's main commands and configuration. They are generated using pod2man (commonly used for this, and included with perl in most distributions). The generated man pages are included to avoid introducing a dependency for such simple task, similar to how we handle protocol buffer generated files.
This commit is contained in:
19
docs/man/generate.sh
Executable file
19
docs/man/generate.sh
Executable file
@@ -0,0 +1,19 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
# Convert pod files to manual pages, using pod2man.
|
||||
#
|
||||
# Assumes files are named like:
|
||||
# <name>.<section>.pod
|
||||
|
||||
set -e
|
||||
|
||||
for IN in *.pod; do
|
||||
OUT=$( basename $IN .pod )
|
||||
SECTION=${OUT##*.}
|
||||
NAME=${OUT%.*}
|
||||
|
||||
podchecker $IN
|
||||
pod2man --section=$SECTION --name=$NAME \
|
||||
--release "" --center "" \
|
||||
$IN $OUT
|
||||
done
|
||||
Reference in New Issue
Block a user