From c902e834a7dd4cdaae708ac55d5c56b0f7fa8dc0 Mon Sep 17 00:00:00 2001 From: Rico Tzschichholz Date: Tue, 21 Mar 2017 16:25:08 +0100 Subject: doc: Generate and update manpages --- doc/Makefile.am | 17 +++++++- doc/valadoc.1 | 118 ++++++++++++++++++++++++++++++++++---------------------- doc/valadoc.h2m | 19 +++++++++ 3 files changed, 106 insertions(+), 48 deletions(-) create mode 100644 doc/valadoc.h2m (limited to 'doc') diff --git a/doc/Makefile.am b/doc/Makefile.am index bed5d930c..2ae874a5a 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,3 +1,16 @@ -man_MANS = valadoc.1 +dist_man_MANS = valadoc.1 + +EXTRA_DIST = valadoc.h2m + +if HAVE_HELP2MAN +manpages: valadoc.1 + @rm $^ + $(MAKE) $(AM_MAKEFLAGS) $^ + +valadoc.1: + $(HELP2MAN) $(top_builddir)/src/valadoc/valadoc \ + --include $(srcdir)/valadoc.h2m \ + --libtool --no-info \ + --output=$@ +endif -EXTRA_DIST = valadoc.1 diff --git a/doc/valadoc.1 b/doc/valadoc.1 index 3e7486ab4..3b450ff7d 100644 --- a/doc/valadoc.1 +++ b/doc/valadoc.1 @@ -1,4 +1,5 @@ -.TH valadoc 1 "26 April 2010" "valadoc-0.2" "Valadoc" +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4. +.TH VALADOC "1" "March 2017" "valadoc 0.35.0" "User Commands" .SH NAME valadoc \- Vala Documentation Tool .SH SYNOPSIS @@ -7,82 +8,107 @@ valadoc \- Vala Documentation Tool .SH DESCRIPTION Valadoc is a documentation generator for generating API documentation from Vala source code based on libvala. -.SH OPTIONS +.SS "Usage:" +.IP +valadoc [OPTION?] FILE... \- Vala Documentation Tool +.SS "Help Options:" .TP -.B --help +\fB\-h\fR, \fB\-\-help\fR +Show help options +.SS "Application Options:" .TP -.B -b, --basedir=\fIDIRECTORY\fR +\fB\-o\fR, \fB\-\-directory\fR=\fI\,DIRECTORY\/\fR +Output directory +.TP +\fB\-b\fR, \fB\-\-basedir\fR=\fI\,DIRECTORY\/\fR Base source directory .TP -.B -D, --define=\fISYMBOL\fR +\fB\-D\fR, \fB\-\-define\fR=\fI\,SYMBOL\/\fR... Define SYMBOL .TP -.B --enable-checking -Enable additional run-time checks -.TP -.B --enable-deprecated -Enable deprecated features +\fB\-\-profile\fR=\fI\,PROFILE\/\fR +Use the given profile instead of the default .TP -.B --enable-experimental +\fB\-\-enable\-experimental\fR Enable experimental features .TP -.B --enable-experimental-non-null -Enable experimental enhancements for non-null types +\fB\-\-enable\-experimental\-non\-null\fR +Enable experimental enhancements for non\-null types .TP -.B --disable-dbus-transformation -Disable transformation of D-Bus member names +\fB\-\-metadatadir\fR=\fI\,DIRECTORY\/\fR... +Look for GIR .metadata files in DIRECTORY .TP -.B --vapidir=\fIDIRECTORY\fR -Look for package bindings in \fIDIRECTORY\fR +\fB\-\-girdir\fR=\fI\,DIRECTORY\/\fR... +Look for .gir files in DIRECTORY .TP -.B --docudir=\fIDIRECTORY\fR -Look for external documentation in \fIDIRECTORY\fR +\fB\-\-vapidir\fR=\fI\,DIRECTORY\/\fR... +Look for package bindings in DIRECTORY .TP -.B --profile=\fIPROFILE\fR -Use the given profile instead of the default +\fB\-\-pkg\fR=\fI\,PACKAGE\/\fR... +Include binding for PACKAGE .TP -.B --pkg=\fIPACKAGE\fR -Include binding for \fIPACKAGE\fR +\fB\-\-driver\fR +Name of an driver or path to a custom driver .TP -.B -o, --directory=\fIDIRECTORY\fR -Output directory +\fB\-\-importdir\fR=\fI\,DIRECTORY\/\fR... +Look for external documentation in DIRECTORY +.TP +\fB\-\-import\fR=\fI\,PACKAGE\/\fR... +Include binding for PACKAGE .TP -.B --wiki=\fIDIRECTORY\fR +\fB\-\-alternative\-resource\-dir\fR=\fI\,DIRECTORY\/\fR... +Alternative resource directories +.TP +\fB\-\-wiki\fR=\fI\,DIRECTORY\/\fR Wiki directory .TP -.B --deps +\fB\-\-deps\fR Adds packages to the documentation .TP -.B -X, --doclet-arg=\fIARG\fR -Pass arguments to the doclet -.TP -.B --doclet=\fIPLUGIN\fR +\fB\-\-doclet\fR=\fI\,PLUGIN\/\fR Name of an included doclet or path to custom doclet .TP -.B --no-protected +\fB\-X\fR, \fB\-\-doclet\-arg\fR=\fI\,ARG\/\fR +Pass arguments to the doclet +.TP +\fB\-\-no\-protected\fR Removes protected elements from documentation .TP -.B --internal +\fB\-\-internal\fR Adds internal elements to documentation .TP -.B --private +\fB\-\-private\fR Adds private elements to documentation .TP -.B --package-name=\fINAME\fR -Package name +\fB\-\-use\-svg\-images\fR +Generate SVG image charts instead of PNG +.TP +\fB\-\-package\-name\fR=\fI\,NAME\/\fR +package name .TP -.B --package-version=\fIVERSION\fR -Package version +\fB\-\-package\-version\fR=\fI\,VERSION\/\fR +package version .TP -.B --force -Force +\fB\-\-gir\fR=\fI\,NAME\-VERSION\/\fR.gir +GObject\-Introspection repository file name .TP -.B --verbose +\fB\-\-version\fR +Display version number +.TP +\fB\-\-force\fR +force +.TP +\fB\-\-verbose\fR Show all warnings -.SH HOMEPAGE AND BUG REPORT -http://live.gnome.org/Valadoc +.TP +\fB\-\-no\-color\fR +Disable colored output +.TP +\fB\-\-target\-glib\fR=\fI\,MAJOR\/\fR.MINOR +Target version of glib for code generation +.SH BUGS +https://bugzilla.gnome.org/page.cgi?id=browse.html&product=valadoc +.SH "HOMEPAGE OR CONTACT" +https://wiki.gnome.org/Projects/Valadoc .SH AUTHORS Florian Brosch - -Man page written to conform with Debian by Evan Nemerson. - diff --git a/doc/valadoc.h2m b/doc/valadoc.h2m new file mode 100644 index 000000000..69c7c3e8d --- /dev/null +++ b/doc/valadoc.h2m @@ -0,0 +1,19 @@ +[NAME] +valadoc \- Vala Documentation Tool + +[SYNOPSIS] +.B valadoc +[\fIOPTION\fR]... \fIFILE\fR... + +[DESCRIPTION] +Valadoc is a documentation generator for generating API documentation +from Vala source code based on libvala. + +[BUGS] +https://bugzilla.gnome.org/page.cgi?id=browse.html&product=valadoc + +[HOMEPAGE or CONTACT] +https://wiki.gnome.org/Projects/Valadoc + +[AUTHORS] +Florian Brosch -- cgit v1.2.1