From 3ee3b7382917cd38e2176599a1c2cbaf975f2dc8 Mon Sep 17 00:00:00 2001 From: Thomas Gazagnaire Date: Wed, 20 Feb 2013 12:31:23 +0100 Subject: [PATCH] Add (very basic) man pages for opam-mk-repo and opam-check This should fix #432 --- doc/Makefile | 5 ++++- doc/man-ext/opam-check.md | 23 +++++++++++++++++++++++ doc/man-ext/opam-mk-repo.md | 22 ++++++++++++++++++++++ doc/man/opam-check.1 | 15 +++++++++++++++ doc/man/opam-mk-repo.1 | 15 +++++++++++++++ 5 files changed, 79 insertions(+), 1 deletion(-) create mode 100644 doc/man-ext/opam-check.md create mode 100644 doc/man-ext/opam-mk-repo.md create mode 100644 doc/man/opam-check.1 create mode 100644 doc/man/opam-mk-repo.1 diff --git a/doc/Makefile b/doc/Makefile index 01e249b57d5..16a75c9f42e 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -9,7 +9,10 @@ man: rm man/* $(OPAM) $(HELPFMT) > man/opam.1 for i in $(TOPICS); do\ - $(OPAM) $$i $(HELPFMT) > man/opam-$$i.1; \ + $(OPAM) $$i $(HELPFMT) > man/opam-$$i.1;\ + done + for i in $(shell basename -s .md $(shell ls man-ext/)); do\ + pandoc -t man man-ext/$$i.md > man/$$i.1;\ done pdf: diff --git a/doc/man-ext/opam-check.md b/doc/man-ext/opam-check.md new file mode 100644 index 00000000000..25f5e5fb4fc --- /dev/null +++ b/doc/man-ext/opam-check.md @@ -0,0 +1,23 @@ +% OPAM(1) opam 0.9.3 | OPAM Manual +% OCamlPro +% 20/02/2013 + +# NAME + +opam-check - a Tool check that OPAM repositories are consistent + +# DESCRIPTION + +See *opam-check --help* for me information. + +# SEE ALSO + +**opam**(1) + +# LINKS + +* **http://opam.ocamlpro.com** + +# OPAM + +Part of the opam(1) suite diff --git a/doc/man-ext/opam-mk-repo.md b/doc/man-ext/opam-mk-repo.md new file mode 100644 index 00000000000..cb95a0535af --- /dev/null +++ b/doc/man-ext/opam-mk-repo.md @@ -0,0 +1,22 @@ +% OPAM(1) opam 0.9.3 | OPAM Manual +% OCamlPro +% 20/02/2013 + +# NAME + +opam-mk-repo - a Tool to Build OPAM Repositories + +# DESCRIPTION + +See *opam-mk-repo --help* for me information. +# SEE ALSO + +**opam**(1) + +# LINKS + +* **http://opam.ocamlpro.com** + +# OPAM + +Part of the opam(1) suite diff --git a/doc/man/opam-check.1 b/doc/man/opam-check.1 new file mode 100644 index 00000000000..b84e6f7b8f3 --- /dev/null +++ b/doc/man/opam-check.1 @@ -0,0 +1,15 @@ +.SH NAME +.PP +opam-check - a Tool check that OPAM repositories are consistent +.SH DESCRIPTION +.PP +See \f[I]opam-check --help\f[] for me information. +.SH SEE ALSO +.PP +\f[B]opam\f[](1) +.SH LINKS +.IP \[bu] 2 +\f[B]http://opam.ocamlpro.com\f[] +.SH OPAM +.PP +Part of the opam(1) suite diff --git a/doc/man/opam-mk-repo.1 b/doc/man/opam-mk-repo.1 new file mode 100644 index 00000000000..588784237d7 --- /dev/null +++ b/doc/man/opam-mk-repo.1 @@ -0,0 +1,15 @@ +.SH NAME +.PP +opam-mk-repo - a Tool to Build OPAM Repositories +.SH DESCRIPTION +.PP +See \f[I]opam-mk-repo --help\f[] for me information. +# SEE ALSO +.PP +\f[B]opam\f[](1) +.SH LINKS +.IP \[bu] 2 +\f[B]http://opam.ocamlpro.com\f[] +.SH OPAM +.PP +Part of the opam(1) suite