From: Evan Nemerson <evan@coeus-group.com>
Date: Tue, 4 May 2010 21:11:27 +0000 (+0200)
Subject: Add man page for valadoc
X-Git-Tag: 0.37.1~3^2~461
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=168515be2c5d65f12560b56d2001bda960ac2aa6;p=thirdparty%2Fvala.git

Add man page for valadoc
---

diff --git a/Makefile.am b/Makefile.am
index e2bce7530..ccc4f3382 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -5,4 +5,5 @@ NULL =
 
 SUBDIRS = src \
           icons \
+          doc \
           $(NULL)
diff --git a/configure.in b/configure.in
index 581ec8ecb..7138e02b3 100644
--- a/configure.in
+++ b/configure.in
@@ -61,6 +61,7 @@ AC_CONFIG_FILES([Makefile
                  src/libvaladoc/valadoc-1.0.pc
                  src/Makefile
                  icons/Makefile
+                 doc/Makefile
                  src/libvaladoc/Makefile
                  src/doclets/Makefile
                  src/doclets/htm/Makefile
diff --git a/doc/Makefile.am b/doc/Makefile.am
new file mode 100644
index 000000000..bed5d930c
--- /dev/null
+++ b/doc/Makefile.am
@@ -0,0 +1,3 @@
+man_MANS = valadoc.1
+
+EXTRA_DIST = valadoc.1
diff --git a/doc/valadoc.1 b/doc/valadoc.1
new file mode 100644
index 000000000..3e7486ab4
--- /dev/null
+++ b/doc/valadoc.1
@@ -0,0 +1,88 @@
+.TH valadoc 1 "26 April 2010" "valadoc-0.2" "Valadoc"
+.SH NAME
+valadoc \- Vala Documentation Tool
+.SH SYNOPSIS
+.B valadoc
+[\fIOPTION\fR]... \fIFILE\fR...
+.SH DESCRIPTION
+Valadoc is a documentation generator for generating API documentation
+from Vala source code based on libvala.
+.SH OPTIONS
+.TP
+.B --help
+.TP
+.B -b, --basedir=\fIDIRECTORY\fR
+Base source directory
+.TP
+.B -D, --define=\fISYMBOL\fR
+Define SYMBOL
+.TP
+.B --enable-checking
+Enable additional run-time checks
+.TP
+.B --enable-deprecated
+Enable deprecated features
+.TP
+.B --enable-experimental
+Enable experimental features
+.TP
+.B --enable-experimental-non-null
+Enable experimental enhancements for non-null types
+.TP
+.B --disable-dbus-transformation
+Disable transformation of D-Bus member names
+.TP
+.B --vapidir=\fIDIRECTORY\fR
+Look for package bindings in \fIDIRECTORY\fR
+.TP
+.B --docudir=\fIDIRECTORY\fR
+Look for external documentation in \fIDIRECTORY\fR
+.TP
+.B --profile=\fIPROFILE\fR
+Use the given profile instead of the default
+.TP
+.B --pkg=\fIPACKAGE\fR
+Include binding for \fIPACKAGE\fR
+.TP
+.B -o, --directory=\fIDIRECTORY\fR
+Output directory
+.TP
+.B --wiki=\fIDIRECTORY\fR
+Wiki directory
+.TP
+.B --deps
+Adds packages to the documentation
+.TP
+.B -X, --doclet-arg=\fIARG\fR
+Pass arguments to the doclet
+.TP
+.B --doclet=\fIPLUGIN\fR
+Name of an included doclet or path to custom doclet
+.TP
+.B --no-protected
+Removes protected elements from documentation
+.TP
+.B --internal
+Adds internal elements to documentation
+.TP
+.B --private
+Adds private elements to documentation
+.TP
+.B --package-name=\fINAME\fR
+Package name
+.TP
+.B --package-version=\fIVERSION\fR
+Package version
+.TP
+.B --force
+Force
+.TP
+.B --verbose
+Show all warnings
+.SH HOMEPAGE AND BUG REPORT
+http://live.gnome.org/Valadoc
+.SH AUTHORS
+Florian Brosch
+
+Man page written to conform with Debian by Evan Nemerson.
+