uvg266/tools/genmanpage.sh
Ari Koivula 78a28e0338 Reformat --help message
- Reduce indentation to 6 spaces
- Word wrap everything to under 80 characters
- Remove defaults from options covered by presets
- Add a dash in front of argument descriptions
- Add --(no-) to names of parameters that accept it and remove mention
  of enabling or disabling
- Add executable and scripts as a dependancy to make docs
2016-11-04 15:40:28 +02:00

34 lines
875 B
Bash
Executable file

#!/bin/sh
LANG=C
set -e
cd "$(dirname "$0")"
date="$(date +"%B %Y")"
version="$(awk '/#define KVZ_VERSION/ { print $3 }' ../src/global.h)"
manpage_file=../doc/kvazaar.1
cat <<EOF> $manpage_file
.TH KVAZAAR "1" "$date" "kvazaar v$version" "User Commands"
.SH NAME
kvazaar \- open source HEVC encoder
.SH SYNOPSIS
\fBkvazaar \fR\-i <input> \-\-input\-res <width>x<height> \-o <output>
.SH DESCRIPTION
EOF
../src/kvazaar --help 2>&1 | tail -n+5 | head -n-4 | \
sed 's| : |\n|g;
s| :$||g;
s|^ --|.TP\n\\fB--|g;
s|^ -|.TP\n\\fB-|g;
s|^ ||g;
s|-|\\-|g;
s|, \\-\\-|\\fR, \\fB\\-\\-|g;' \
>> $manpage_file
for s in Required Presets Input Options "Video structure" "Compression tools" "Parallel processing" "Video Usability Information"; do
sed -i "s|^${s}:|.SS \"${s}:\"|g" $manpage_file
done