man page

Makefile

@@ -40,11 +40,22 @@ dist: clean
 	rm -fr ${BIN}-${VERSION}
 
 install: ${BIN}
+	# bin
 	mkdir -p ${DESTDIR}${PREFIX}/bin
 	cp -f ${BIN} ${DESTDIR}${PREFIX}/bin
 	chmod 755 ${DESTDIR}${PREFIX}/bin/${BIN}
+	# doc
+	mkdir -p ${DESTDIR}${PREFIX}/share/doc/${BIN}
+	cp -f README ${DESTDIR}${PREFIX}/share/doc/${BIN}
+	chmod 644 ${DESTDIR}${PREFIX}/share/doc/${BIN}/README
+	# manual page
+	mkdir -p ${DESTDIR}${PREFIX}/share/man/man1
+	sed 's/VERSION/${VERSION}/' < ${BIN}.1 > ${DESTDIR}${PREFIX}/share/man/man1/${BIN}.1
+	chmod 644 ${DESTDIR}${PREFIX}/share/man/man1/${BIN}.1
 
 uninstall:
 	rm -f ${DESTDIR}${PREFIX}/bin/${BIN}
+	rm -fr ${DESTDIR}${PREFIX}/share/doc/${BIN}
+	rm -f ${DESTDIR}${PREFIX}/share/man/man1/${BIN}.1
 
 .PHONY: all options clean dist install uninstall

README

@@ -1,16 +1,16 @@
-bluraybackup is a command-line program inspired by dvdbackup [1],
-developed in C99 following the suckless philosophy [2].
+bluraybackup is a command-line program to backup Blu-ray Disc Movies
+(BDMV), inspired by dvdbackup [1], developed in C99 following the
+suckless philosophy [2].
 
-I wrote it because I wanted to have a 1:1 copy of my Blu-ray discs or
-the ability to save an unencrypted version of a BDMV stream. Since
-Blu-ray is an especially nasty format [3], this software does not work
-with all Blu-ray discs. It both depends on your KEYDB.cfg file and on
-the disc BD+ generation. I don't know what the hell BD+ is!
+It makes a 1:1 unencrypted copy of a BDMV or it saves an unencrypted
+version of a BDMV stream. Since Blu-ray is an especially nasty format
+[3], this software may not work with all discs. It both depends on your
+KEYDB.cfg file and on the BD+ generation.
 
-Don't count on your copies being perfect, if you see libbluray errors
-during the operation. You have been warned.
+If you encounter libbluray errors during the operation, the copy might
+not be exact.
 
-This software is based on libbluray [4]. To build it you need libbluray
+bluraybackup is based on libbluray [4]. To build it you need libbluray
 and its headers.
 
 

bluraybackup.1

@@ -0,0 +1,56 @@
+.TH bluraybackup 1 "VERSION"
+.SH NANE
+bluraybackup \- Tool to backup Blu-ray Disc Movies (BDMV)
+.SH SYNOPSIS
+.B bluraybackup
+<DEVICE> <KEYFILE> [\fIFILE\fR] [\fIDEST\fR]
+
+.B bluraybackup
+[\fIOPTION\fR]
+.SH DESCRIPTION
+\fBbluraybackup\fP backups Blu-ray Disc Movies (BDMV),
+inspired by dvdbackup,
+developed in C99 following the suckless philosophy.
+
+It makes a 1:1 unencrypted copy of a BDMV
+or it saves an unencrypted version of a BDMV stream.
+
+This program may not work with all Blu-rays.
+It both depends on your KEYDB.cfg file
+and on the BD+ generation.
+
+If you encounter libbluray errors during the operation,
+the copy might not be exact.
+.SH OPTIONS
+.TP
+.B \-h, \-\-help
+print usage message
+.TP
+.B \-v, \-\-version
+print version and license information
+.SH USAGE
+.B bluraybackup
+<DEVICE> <KEYFILE> [\fIFILE\fR] [\fIDEST\fR]
+.P
+Without \fIFILE\fR,
+the whole disc will be copied to the current directory.
+\fIFILE\fR must be a file path relative to the disc root.
+
+Without \fIDEST\fR,
+the base \fIFILE\fR will be saved to the current directory.
+\fIDEST\fR path must include file name.
+.SH EXIT VALUES
+.TP
+\fB0\fP \- The whole disc or \fIFILE\fR has been copied
+.TP
+\fB1\fP \- Everything else
+.SH SEE ALSO
+.P
+\fBdvdbackup\fP(1)
+
+.B https://www.videolan.org/developers/libbluray.html
+
+.B https://suckless.org/philosophy/
+.SH AUTHOR
+bluraybackup was written by Matteo Bini <matteobin@tiepi.it>.
+