lorid

commit c0ebbd17e2853e35a53179c4fef76e483266fbd6
parent 5a6cd3087a38aad1e01c42fd429a00827ef024ac
Author: nibo <nibo@relim.de>
Date:   Sun, 29 Sep 2024 12:23:29 +0200

WIP: Write man page

Diffstat:
M
Makefile
 | 
4
++++
A
lorid.1
 | 
18
++++++++++++++++++

2 files changed, 22 insertions(+), 0 deletions(-)
diff --git a/Makefile b/Makefile
@@ -1,5 +1,6 @@
 VERSION = 0.1.0
 PREFIX = /usr/local
+MANPREFIX = ${PREFIX}/share/man
 CFLAGS = -pedantic -Wall -Wextra -DVERSION=\"${VERSION}\"
 LDFLAGS = -lpdfio -ltoml -lfontconfig
 SRC = util.c fontconfig.c config.c chordpro.c out_pdf.c lorid.c
@@ -27,8 +28,11 @@ install: all lib
 	ln -f -s ${PREFIX}/lib/liblorid.so.${VERSION} ${PREFIX}/lib/liblorid.so
 	mkdir -p ${PREFIX}/include
 	cp lorid.h ${PREFIX}/include
+	mkdir -p ${MANPREFIX}/man1
+	cp lorid.1 ${MANPREFIX}/man1/lorid.1
 uninstall:
 	rm ${PREFIX}/bin/lorid
 	rm ${PREFIX}/lib/liblorid.so*
 	rm ${PREFIX}/include/lorid.h
+	rm ${MANPREFIX}/man1/lorid.1
 .PHONY: all debug clean fontconfig parser lib install uninstall
diff --git a/lorid.1 b/lorid.1
@@ -0,0 +1,18 @@
+.TH LORID "1" "September 2024" "User Commands"
+.SH NAME
+lorid \- convert chordpro to pdf
+.SH SYNOPSIS
+.B lorid
+[-p] [-c] [-v] [-h] [-o \fI\,path\/\fR] [\fI\,filepath\/\fR]
+.SH DESCRIPTION
+.PP
+.B lorid
+reads text from
+.I filepath
+and if it wasn't provided than from stdin.
+The text will be parsed according to the chordpro specification
+and then converted to pdf. These two steps can be altered by
+changing the configuration file.
+.SH CHORDPRO
+.PP
+You can find the chordpro specification at https://www.chordpro.org/chordpro/.