docs: Generate and update manpages

diff --git a/configure.ac b/configure.ac
index 2c90ba41f83e29e593ed9fed5ab0b242670e1967..67d649ce9ee9df461df5d0f0cd0c4ef2857def95 100644 (file)
--- a/configure.ac
+++ b/configure.ac
@@ -97,6 +97,9 @@ AC_SUBST(GMODULE_LIBS)
 AC_PATH_PROG([XSLTPROC], [xsltproc], :)
 AM_CONDITIONAL(HAVE_XSLTPROC, test "$XSLTPROC" != :)
 
+AC_CHECK_PROG([HELP2MAN], [help2man], [help2man])
+AM_CONDITIONAL([HAVE_HELP2MAN], [test x$HELP2MAN = xhelp2man])
+
 m4_ifdef([AM_SILENT_RULES],[AM_SILENT_RULES([yes])])
 
 AC_CONFIG_FILES([Makefile

diff --git a/doc/Makefile.am b/doc/Makefile.am
index 2ba2ef645e9b0d342680c46a61ef282a7abf8570..b6ca6aacc99434a170eb21f8adbb5b3d1f50a537 100644 (file)
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -10,6 +10,35 @@ dist_man_MANS = \
        vapigen.1 \
        $(NULL)
 
+EXTRA_DIST = \
+       valac.h2m \
+       vala-gen-introspect.h2m \
+       vapigen.h2m \
+       $(NULL)
+
+if HAVE_HELP2MAN
+manpages: valac.1 vala-gen-introspect.1 vapigen.1
+       @rm $^
+       $(MAKE) $(AM_MAKEFLAGS) $^
+
+valac.1:
+       $(HELP2MAN) $(top_builddir)/compiler/valac \
+               --include $(srcdir)/valac.h2m \
+               --libtool --no-info \
+               --output=$@
+vala-gen-introspect.1:
+       $(HELP2MAN) $(top_builddir)/gobject-introspection/gen-introspect \
+               --include $(srcdir)/vala-gen-introspect.h2m \
+               --version-string=$(PACKAGE_VERSION) \
+               --libtool --no-info \
+               --output=$@
+vapigen.1:
+       $(HELP2MAN) $(top_builddir)/vapigen/vapigen \
+               --include $(srcdir)/vapigen.h2m \
+               --libtool --no-info \
+               --output=$@
+endif
+
 if ENABLE_UNVERSIONED
 install-data-hook:
        cd $(DESTDIR)$(man1dir) && $(LN_S) -f valac@PACKAGE_SUFFIX@.1 valac.1

diff --git a/doc/vala-gen-introspect.1 b/doc/vala-gen-introspect.1
index 68052d96acd6170d6be05ddb6643580a3283a9b9..6520c32ac4f4c2352a5869457a0ebc32625bf532 100644 (file)
--- a/doc/vala-gen-introspect.1
+++ b/doc/vala-gen-introspect.1
@@ -1,10 +1,9 @@
-.TH vala-gen-introspect 1 "26 October 2007" "vala-0.1.5" "Vala"
-.IX vala-gen-introspect
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.4.
+.TH VALA-GEN-INTROSPECT "1" "March 2017" "vala-gen-introspect 0.35.6" "User Commands"
 .SH NAME
 vala-gen-introspect \- generate a GI file for GObject and glib based packages
 .SH SYNOPSIS
 .B vala-gen-introspect \fIPKGNAME\fP \fIPKGBASE\fP
-
 .SH DESCRIPTION
 .B vala-gen-introspect
 is a utility which generates GI files from GObject and glib
@@ -12,21 +11,40 @@ based packages. It can be used in combination with vapigen(1) to
 generate an API for Vala, and allow it's usage in Vala for compiling
 to native code. \fIPKGNAME\fP is the pkg-config name of the library
 and \fIPKGBASE\fP specifies the base directory for that package.
-
-.SH EXAMPLES
+.SS "Usage:"
+.IP
+gen\-introspect [OPTION?]
+.SS "Help Options:"
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Show help options
+.SS "Application Options:"
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+Be verbose
+.TP
+\fB\-o\fR, \fB\-\-output\fR=\fI\,FILE\/\fR
+write output here instead of stdout
 .TP
+\fB\-n\fR, \fB\-\-namespace\fR=\fI\,NAMESPACE\/\fR
+Namespace of the module, like 'Gtk'
+.TP
+\fB\-\-shared\-library\fR=\fI\,FILE\/\fR
+Shared library which contains the symbols
+.TP
+\fB\-\-include\-idl\fR=\fI\,IDL\/\fR
+Other gidls to include
+.SH BUGS
+https://bugzilla.gnome.org/page.cgi?id=browse.html&product=vala
+.SH "HOMEPAGE OR CONTACT"
+https://wiki.gnome.org/Projects/Vala
+.SH AUTHORS
+J??rg Billeter <j@bitron.ch>, Raffaele Sandrini <rasa@gmx.ch>
+.SH EXAMPLES
 After compilation, the following command generates a GI for pango:
 .B vala-gen-introspect pango packages/pango
-
-.SH OPTIONS
 .TP
-This command currently takes no command line options.
-.SH SEE ALSO
-.BR vapigen (1)
-
-.SH AUTHOR
-vala-gen-introspect for Vala was written by Juerg Billeter <j@bitron.ch> and
-Raffaele Sandrini <rasa@gmx.ch>.
-.PP
-This manual page was written by Kumar Appaiah <akumar@ee.iitm.ac.in>,
-for the Debian project (but may be used by others).
+This can then be converted to a Vala API as follows:
+.B vapigen --pkg cairo --vapidir . --library pango packages/pango/pango.gi
+.SH "SEE ALSO"
+vapigen (1)

diff --git a/doc/vala-gen-introspect.h2m b/doc/vala-gen-introspect.h2m
new file mode 100644 (file)
index 0000000..b409e4e
--- /dev/null
+++ b/doc/vala-gen-introspect.h2m
@@ -0,0 +1,32 @@
+[NAME]
+vala-gen-introspect \- generate a GI file for GObject and glib based packages
+
+[SYNOPSIS]
+.B vala-gen-introspect \fIPKGNAME\fP \fIPKGBASE\fP
+
+[DESCRIPTION]
+.B vala-gen-introspect
+is a utility which generates GI files from GObject and glib
+based packages. It can be used in combination with vapigen(1) to
+generate an API for Vala, and allow it's usage in Vala for compiling
+to native code. \fIPKGNAME\fP is the pkg-config name of the library
+and \fIPKGBASE\fP specifies the base directory for that package.
+
+[EXAMPLES]
+After compilation, the following command generates a GI for pango:
+.B vala-gen-introspect pango packages/pango
+.TP
+This can then be converted to a Vala API as follows:
+.B vapigen --pkg cairo --vapidir . --library pango packages/pango/pango.gi
+
+[BUGS]
+https://bugzilla.gnome.org/page.cgi?id=browse.html&product=vala
+
+[HOMEPAGE or CONTACT]
+https://wiki.gnome.org/Projects/Vala
+
+[SEE ALSO]
+vapigen (1)
+
+[AUTHORS]
+Jürg Billeter <j@bitron.ch>, Raffaele Sandrini <rasa@gmx.ch>

diff --git a/doc/valac.1 b/doc/valac.1
index d92368abe729e5ce02e785ba8064b59b28e13074..43aaf14929f3fcaea47c2fd65d4a00d004f83b67 100644 (file)
--- a/doc/valac.1
+++ b/doc/valac.1
@@ -1,168 +1,197 @@
-.TH valac 1 "13 April 2010" "vala-0.8.0" "Vala"
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.4.
+.TH VALAC "1" "March 2017" "valac 0.35.6" "User Commands"
 .SH NAME
 valac \- compiler that translates Vala source code into C source and header files
 .SH SYNOPSIS
 .B valac
 [\fIOPTION\fR]... [\fIFILE\fR]...
 .SH DESCRIPTION
-Vala  is  a  new  programming  language  that  aims  to  bring  modern
+Vala  is  a  programming  language  that  aims  to  bring  modern
 programming language features to GNOME developers without imposing any
 additional  runtime requirements  and  without using  a different  ABI
 compared to applications and libraries written in C.
-
+.TP
 valac, the Vala compiler, is a self-hosting compiler that translates
 Vala source code into C source and header files. It uses the GObject
 type system to create classes and interfaces declared in the Vala
 source code.
-.SH OPTIONS
+.SS "Usage:"
+.IP
+valac [OPTION?] FILE... \- Vala Compiler
+.SS "Help Options:"
 .TP
-.B \--help
+\-?, \fB\-\-help\fR
+Show help options
+.SS "Application Options:"
 .TP
-.B \--vapidir=\fIDIRECTORY\fR...
-Look for package bindings in \fIDIRECTORY\fR
+\fB\-\-vapidir\fR=\fI\,DIRECTORY\/\fR...
+Look for package bindings in DIRECTORY
 .TP
-.B \--girdir=\fIDIRECTORY\fR...
-Look for .gir files in \fIDIRECTORY\fR
+\fB\-\-girdir\fR=\fI\,DIRECTORY\/\fR...
+Look for .gir files in DIRECTORY
 .TP
-.B \--metadatadir=\fIDIRECTORY\fR...
-Look for GIR .metadata files in \fIDIRECTORY\fR
+\fB\-\-metadatadir\fR=\fI\,DIRECTORY\/\fR...
+Look for GIR .metadata files in DIRECTORY
 .TP
-.B \--pkg=\fIPACKAGE\fR...
-Include binding for \fIPACKAGE\fR
+\fB\-\-pkg\fR=\fI\,PACKAGE\/\fR...
+Include binding for PACKAGE
 .TP
-.B \--vapi=\fIFILE\fR
+\fB\-\-vapi\fR=\fI\,FILE\/\fR
 Output VAPI file name
 .TP
-.B \--library=\fINAME\fR
+\fB\-\-library\fR=\fI\,NAME\/\fR
 Library name
 .TP
-.B \--shared-library=\fINAME\fR
-Shared library name used in generated .gir
-.TP
-.B \--gir=\fINAME\fR-\fIVERSION\fR.gir
-GObject-Introspection repository file name
+\fB\-\-shared\-library\fR=\fI\,NAME\/\fR
+Shared library name used in generated gir
 .TP
-.B \--gresources=\fIFILE\fR...
-GResources XML file name
+\fB\-\-gir\fR=\fI\,NAME\-VERSION\/\fR.gir
+GObject\-Introspection repository file name
 .TP
-.B \-b, --basedir=\fIDIRECTORY\fR
+\fB\-b\fR, \fB\-\-basedir\fR=\fI\,DIRECTORY\/\fR
 Base source directory
 .TP
-.B \-d, --directory=\fIDIRECTORY\fR
+\fB\-d\fR, \fB\-\-directory\fR=\fI\,DIRECTORY\/\fR
 Output directory
 .TP
-.B \--version
+\fB\-\-version\fR
 Display version number
 .TP
-.B \--api-version
+\fB\-\-api\-version\fR
 Display API version number
 .TP
-.B \-C, --ccode
+\fB\-C\fR, \fB\-\-ccode\fR
 Output C code
 .TP
-.B \-H, --header=\fIFILE\fR
+\fB\-H\fR, \fB\-\-header\fR=\fI\,FILE\/\fR
 Output C header file
 .TP
-.B \--use-header
+\fB\-\-use\-header\fR
 Use C header file
 .TP
-.B \--includedir=\fIDIRECTORY\fR
+\fB\-\-includedir\fR=\fI\,DIRECTORY\/\fR
 Directory used to include the C header file
 .TP
-.B \-h, --internal-header=\fIFILE\fR
+\fB\-h\fR, \fB\-\-internal\-header\fR=\fI\,FILE\/\fR
 Output internal C header file
 .TP
-.B \--internal-vapi=\fIFILE\fR
+\fB\-\-internal\-vapi\fR=\fI\,FILE\/\fR
 Output vapi with internal api
 .TP
-.B \--symbols=\fIFILE\fR
+\fB\-\-fast\-vapi\fR
+Output vapi without performing symbol resolution
+.TP
+\fB\-\-use\-fast\-vapi\fR
+Use \fB\-\-fast\-vapi\fR output during this compile
+.TP
+\fB\-\-vapi\-comments\fR
+Include comments in generated vapi
+.TP
+\fB\-\-deps\fR
+Write make\-style dependency information to this file
+.TP
+\fB\-\-symbols\fR=\fI\,FILE\/\fR
 Output symbols file
 .TP
-.B \-c, --compile
+\fB\-c\fR, \fB\-\-compile\fR
 Compile but do not link
 .TP
-.B \-o, --output=\fIFILE\fR
-Place output in file \fIFILE\fR
+\fB\-o\fR, \fB\-\-output\fR=\fI\,FILE\/\fR
+Place output in file FILE
 .TP
-.B \-g, --debug
+\fB\-g\fR, \fB\-\-debug\fR
 Produce debug information
 .TP
-.B \--thread
+\fB\-\-thread\fR
 Enable multithreading support (DEPRECATED AND IGNORED)
 .TP
-.B \--enable-mem-profiler
+\fB\-\-enable\-mem\-profiler\fR
 Enable GLib memory profiler
 .TP
-.B \-D, --define=SYMBOL...
+\fB\-D\fR, \fB\-\-define\fR=\fI\,SYMBOL\/\fR...
 Define SYMBOL
 .TP
-.B \--main=SYMBOL...
+\fB\-\-main\fR=\fI\,SYMBOL\/\fR...
 Use SYMBOL as entry point
 .TP
-.B \--nostdpkg
+\fB\-\-nostdpkg\fR
 Do not include standard packages
 .TP
-.B \--disable-assert
+\fB\-\-disable\-assert\fR
 Disable assertions
 .TP
-.B \--enable-checking
-Enable additional run-time checks
+\fB\-\-enable\-checking\fR
+Enable additional run\-time checks
 .TP
-.B \--enable-deprecated
+\fB\-\-enable\-deprecated\fR
 Enable deprecated features
 .TP
-.B \--enable-experimental
+\fB\-\-hide\-internal\fR
+Hide symbols marked as internal
+.TP
+\fB\-\-enable\-experimental\fR
 Enable experimental features
 .TP
-.B \--disable-warnings
+\fB\-\-disable\-warnings\fR
 Disable warnings
 .TP
-.B \--fatal-warnings
+\fB\-\-fatal\-warnings\fR
 Treat warnings as fatal
 .TP
-.B \--enable-experimental-non-null
-Enable experimental enhancements for non-null types
+\fB\-\-disable\-since\-check\fR
+Do not check whether used symbols exist in local packages
+.TP
+\fB\-\-enable\-experimental\-non\-null\fR
+Enable experimental enhancements for non\-null types
 .TP
-.B \--cc=\fICOMMAND\fR
-Use \fICOMMAND\fR as C compiler command
+\fB\-\-enable\-gobject\-tracing\fR
+Enable GObject creation tracing
 .TP
-.B \-X, --Xcc=\fIOPTION\fR...
-Pass \fIOPTION\fR. to the C compiler
+\fB\-\-cc\fR=\fI\,COMMAND\/\fR
+Use COMMAND as C compiler command
 .TP
-.B \--dump-tree=\fIFILE\fR
-Write code tree to \fIFILE\fR
+\fB\-X\fR, \fB\-\-Xcc\fR=\fI\,OPTION\/\fR...
+Pass OPTION to the C compiler
 .TP
-.B \--save-temps
+\fB\-\-pkg\-config\fR=\fI\,COMMAND\/\fR
+Use COMMAND as pkg\-config command
+.TP
+\fB\-\-dump\-tree\fR=\fI\,FILE\/\fR
+Write code tree to FILE
+.TP
+\fB\-\-save\-temps\fR
 Keep temporary files
 .TP
-.B \--profile=\fIPROFILE\fR
+\fB\-\-profile\fR=\fI\,PROFILE\/\fR
 Use the given profile instead of the default
 .TP
-.B \--no-color
-Disable colored output
-.TP
-.B \-q, --quiet
+\fB\-q\fR, \fB\-\-quiet\fR
 Do not print messages to the console
 .TP
-.B \-v, --verbose
+\fB\-v\fR, \fB\-\-verbose\fR
 Print additional messages to the console
 .TP
-.B \--target-glib=\fIMAJOR\fR.\fIMINOR\fR
+\fB\-\-no\-color\fR
+Disable colored output
+.TP
+\fB\-\-target\-glib\fR=\fI\,MAJOR\/\fR.MINOR
 Target version of glib for code generation
 .TP
-.B \--enable-version-header
+\fB\-\-gresources\fR=\fI\,FILE\/\fR...
+XML of gresources
+.TP
+\fB\-\-enable\-version\-header\fR
 Write vala build version in generated files
 .TP
-.B \--disable-version-header
+\fB\-\-disable\-version\-header\fR
 Do not write vala build version in generated files
+.SH BUGS
+https://bugzilla.gnome.org/page.cgi?id=browse.html&product=vala
+.SH "HOMEPAGE OR CONTACT"
+https://wiki.gnome.org/Projects/Vala
 .SH FEATURES
 Interfaces, properties, signals, foreach, lambda expressions, type
 inference for local variables, generics, non-null types, assisted memory
 management, exception handling
-.SH HOMEPAGE AND BUG REPORT
-http://www.vala-project.org/
 .SH AUTHORS
-Jürg Billeter, Raffaele Sandrini.
-
-Man page written to conform with Debian by Marc-Andre Lureau.
-
+J??rg Billeter, Raffaele Sandrini.

diff --git a/doc/valac.h2m b/doc/valac.h2m
new file mode 100644 (file)
index 0000000..ce9bc23
--- /dev/null
+++ b/doc/valac.h2m
@@ -0,0 +1,31 @@
+[NAME]
+valac \- compiler that translates Vala source code into C source and header files
+
+[SYNOPSIS]
+.B valac
+[\fIOPTION\fR]... [\fIFILE\fR]...
+
+[DESCRIPTION]
+Vala  is  a  programming  language  that  aims  to  bring  modern
+programming language features to GNOME developers without imposing any
+additional  runtime requirements  and  without using  a different  ABI
+compared to applications and libraries written in C.
+.TP
+valac, the Vala compiler, is a self-hosting compiler that translates
+Vala source code into C source and header files. It uses the GObject
+type system to create classes and interfaces declared in the Vala
+source code.
+
+[BUGS]
+https://bugzilla.gnome.org/page.cgi?id=browse.html&product=vala
+
+[HOMEPAGE or CONTACT]
+https://wiki.gnome.org/Projects/Vala
+
+[FEATURES]
+Interfaces, properties, signals, foreach, lambda expressions, type
+inference for local variables, generics, non-null types, assisted memory
+management, exception handling
+
+[AUTHORS]
+Jürg Billeter, Raffaele Sandrini.

diff --git a/doc/vapigen.1 b/doc/vapigen.1
index 993bd43785d61526bb3a372c9fbe738ca67a90f7..e6dd64f7edf3f63ed93946ec31aca806fc2189e5 100644 (file)
--- a/doc/vapigen.1
+++ b/doc/vapigen.1
@@ -1,5 +1,5 @@
-.TH vapigen 1 "13 April 2010" "vala-0.8.0" "Vala"
-.IX vapigen
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.4.
+.TH VAPIGEN "1" "March 2017" "vapigen API Generator 0.35.6" "User Commands"
 .SH NAME
 vapigen \- generate a Vala API
 .SH SYNOPSIS
@@ -9,53 +9,52 @@ vapigen \- generate a Vala API
 .B vapigen
 is a utility which generates Vala API (VAPI) files from GI files,
 which may be generated using the vala-gen-introspect(1) utility.
-
-.SH EXAMPLES
-.TP
-After compilation, the following command generates a GI for pango:
-.B vala-gen-introspect pango packages/pango
+.SS "Usage:"
+.IP
+vapigen [OPTION?] FILE... \- Vala API Generator
+.SS "Help Options:"
 .TP
-This can then be converted to a Vala API as follows:
-.B vapigen --pkg cairo --vapidir . --library pango packages/pango/pango.gi
-
-.SH OPTIONS
+\fB\-h\fR, \fB\-\-help\fR
+Show help options
+.SS "Application Options:"
 .TP
-.B \-?, --help
-Show help option
+\fB\-\-vapidir\fR=\fI\,DIRECTORY\/\fR...
+Look for package bindings in DIRECTORY
 .TP
-.B \--vapidir=\fIDIRECTORY\fP
-Look for package bindings in \fIDIRECTORY\fP.
+\fB\-\-girdir\fR=\fI\,DIRECTORY\/\fR...
+Look for GIR bindings in DIRECTORY
 .TP
-.B \--girdir=\fIDIRECTORY\fP
-Look for GIR bindings in \fIDIRECTORY\fP.
+\fB\-\-metadatadir\fR=\fI\,DIRECTORY\/\fR...
+Look for GIR .metadata files in DIRECTORY
 .TP
-.B \--metadatadir=\fIDIRECTORY\fP
-Look for GIR .metadata files in \fIDIRECTORY\fP.
+\fB\-\-pkg\fR=\fI\,PACKAGE\/\fR...
+Include binding for PACKAGE
 .TP
-.B \--pkg=\fIPACKAGE\fP
-Include binding for \fIPACKAGE\fP
+\fB\-\-library\fR=\fI\,NAME\/\fR
+Library name
 .TP
-.B \--library=\fINAME\fP
-Specify library name as \fINAME\fP
+\fB\-d\fR, \fB\-\-directory\fR=\fI\,DIRECTORY\/\fR
+Output directory
 .TP
-.B \-d, --directory=\fIDIRECTORY\fP
-Specify output directory as \fIDIRECTORY\fP
+\fB\-\-disable\-warnings\fR
+Disable warnings
 .TP
-.B \--version
-Display version number and exit.
+\fB\-\-version\fR
+Display version number
 .TP
-.B \-q, --quiet
+\fB\-q\fR, \fB\-\-quiet\fR
 Do not print messages to the console
-
-.SH SEE ALSO
-.BR vala-gen-introspect (1)
-
-.SH HOMEPAGE AND BUG REPORT
-http://www.vala-project.org/
-
-.SH AUTHOR
-vapigen for Vala was written by Jürg Billeter <j@bitron.ch> and
-Raffaele Sandrini <rasa@gmx.ch>.
-.PP
-This manual page was written by Kumar Appaiah <akumar@ee.iitm.ac.in>,
-for the Debian project (but may be used by others).
+.SH BUGS
+https://bugzilla.gnome.org/page.cgi?id=browse.html&product=vala
+.SH "HOMEPAGE OR CONTACT"
+https://wiki.gnome.org/Projects/Vala
+.SH AUTHORS
+J??rg Billeter, Raffaele Sandrini.
+.SH EXAMPLES
+After compilation, the following command generates a GI for pango:
+.B vala-gen-introspect pango packages/pango
+.TP
+This can then be converted to a Vala API as follows:
+.B vapigen --pkg cairo --vapidir . --library pango packages/pango/pango.gi
+.SH "SEE ALSO"
+vala-gen-introspect (1)

diff --git a/doc/vapigen.h2m b/doc/vapigen.h2m
new file mode 100644 (file)
index 0000000..1f6ca8f
--- /dev/null
+++ b/doc/vapigen.h2m
@@ -0,0 +1,30 @@
+[NAME]
+vapigen \- generate a Vala API
+
+[SYNOPSIS]
+.B vapigen \fISOURCE\fP \fIPKGBASE\fP
+[\fIOPTION\fR]... [\fIFILE\fR]...
+
+[DESCRIPTION]
+.B vapigen
+is a utility which generates Vala API (VAPI) files from GI files,
+which may be generated using the vala-gen-introspect(1) utility.
+
+[EXAMPLES]
+After compilation, the following command generates a GI for pango:
+.B vala-gen-introspect pango packages/pango
+.TP
+This can then be converted to a Vala API as follows:
+.B vapigen --pkg cairo --vapidir . --library pango packages/pango/pango.gi
+
+[BUGS]
+https://bugzilla.gnome.org/page.cgi?id=browse.html&product=vala
+
+[HOMEPAGE or CONTACT]
+https://wiki.gnome.org/Projects/Vala
+
+[SEE ALSO]
+vala-gen-introspect (1)
+
+[AUTHORS]
+Jürg Billeter, Raffaele Sandrini.