Merge pull request #154 from cgwalters/initial-manpages

Add initial manpage infrastructure

Makefile.am

@@ -6,3 +6,9 @@ EXTRA_DIST=\
 	composefs.spec
 
 pkgconfig_DATA = composefs.pc
+
+man/%.1: man/%.md
+	pandoc $+ -s -t man > $@
+
+install-man: man/mount.composefs.1 man/mkcomposefs.1
+	install -m 644 -D --target-directory=$(DESTDIR)$(mandir)/man1 $^

man/.gitignore

@@ -0,0 +1 @@
+*.1

man/mkcomposefs.md

@@ -0,0 +1,36 @@
+% mkcomposefs(1) composefs | User Commands
+
+# NAME
+
+mkcomposefs - create a composefs filesystem image
+
+# SYNOPSIS
+**mkcomposefs** *SOURCEDIR* *IMAGE*
+
+# DESCRIPTION
+
+The composefs project uses EROFS to store metadata, and a distinct
+underlying backing store for regular files.
+
+**mkcomposefs** constructs the mountable "composefs image" using the
+source directory as input.
+
+# OPTIONS
+
+The provided *SOURCEDIR* argument must be a directory and its entire
+contents will be read recursively.  The provided *IMAGE* argument
+will be a mountable composefs image.
+
+**mkcomposefs** accepts the following options:
+
+**\-\-digest-store**=*PATH*
+:   This path will become a composefs "object store".  Non-empty regular files
+    in the *SOURCEDIR* will be copied (reflinked if possible) into this target
+    directory, named after their fsverity digest.
+
+**\-\-print-digest**
+:   Print the fsverity digest of the composefs metadata file.
+
+# SEE ALSO
+
+- [composefs upstream](https://github.com/containers/composefs)

man/mount.composefs.md

@@ -0,0 +1,32 @@
+% mount.composefs(1) composefs | User Commands
+
+# NAME
+
+mount.composefs - mount a composefs filesystem image
+
+# SYNOPSIS
+**mount.composefs** *IMAGE* *TARGETDIR*
+
+# DESCRIPTION
+
+The composefs project uses EROFS to store metadata, and a distinct
+underlying backing store for regular files.  At runtime, composefs
+uses `overlayfs` on top of a loopback mount.
+
+**mount.composefs** 
+
+# OPTIONS
+
+The provided *IMAGE* argument must be a valid composefs (EROFS)
+metadata image.  The *TARGETDIR* will be used as a mount target.
+
+**mount.composefs** accepts the following options:
+
+**\-\-basedir**=*PATH*
+:   This path will be used to resolve non-empty file references
+    stored in the composefs metadata image.  A primary use case is to have
+    this be the same path provided to `mkcomposefs --digest-store`.
+
+# SEE ALSO
+
+- [composefs upstream](https://github.com/containers/composefs)