summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGrégoire Duchêne <gduchene@fastmail.net>2011-10-10 13:16:57 +0200
committerGrégoire Duchêne <gduchene@fastmail.net>2012-01-27 16:56:51 +0100
commit8f06358951515e779a444523ddfe3dc9ab30154f (patch)
treedbf2491827cafded965f853c197d906eafb68e2c
parent3205c382b9f896266fa8df90fe63c35228da91ba (diff)
Added a manual page.
-rw-r--r--Jamroot5
-rw-r--r--mppdown.132
2 files changed, 36 insertions, 1 deletions
diff --git a/Jamroot b/Jamroot
index 4c7508e..5323dcd 100644
--- a/Jamroot
+++ b/Jamroot
@@ -4,4 +4,7 @@ local DIST = [ os.environ DIST ] ;
exe mppdown : [ glob-tree *.cpp ] : <linkflags>-lboost_program_options ;
-install dist : mppdown : <location>$(DIST)/usr/bin : <variant>release ;
+alias dist : bin man ;
+
+install bin : mppdown : <location>$(DIST)/usr/bin : <variant>release ;
+install man : mppdown.1 : <location>$(DIST)/usr/share/man/man1 ;
diff --git a/mppdown.1 b/mppdown.1
new file mode 100644
index 0000000..8dbfdb6
--- /dev/null
+++ b/mppdown.1
@@ -0,0 +1,32 @@
+.Dd Oct 22, 2011
+.Dt MPPDOWN 1 1
+.Sh NAME
+.Nm mppdown
+.Nd C++ implementation of the mdown2 specification
+.Sh SYNOPSIS
+.Nm
+.Op Fl h
+.Op Fl o Ar output
+.Op Ar input
+.Sh DESCRIPTION
+.Nm mppdown
+is a C++ program that reads an
+.Ar input
+file written in the mdown2 format and that returns a LaTeX-formatted
+output file on the standard output or
+.Ar output
+if specified.
+.Pp
+Its arguments are:
+.Bl -tag -width Ds
+.It Fl h
+Displays a help message.
+.It Fl o Ar output
+Writes to
+.Ar output
+instead of standard output.
+.It Ar input
+The input file to read.
+.El
+.Sh EXIT STATUS
+.Ex -std