Create manual page for mm-common-prepare

* util/mm-common-prepare.1: New manual page for the mm-common-prepare
utility.
* Makefile.am (dist_man1_MANS): Install mm-common-prepare manual page.

1 files changed, 87 insertions, 0 deletions

diff --git a/util/mm-common-prepare.1 b/util/mm-common-prepare.1
new file mode 100644
index 0000000..605b92f
--- /dev/null
+++ b/util/mm-common-prepare.1
@@ -0,0 +1,87 @@
+.TH MM-COMMON-PREPARE 1 2009-09-08 GNOME mm-common
+.SH NAME
+mm-common-prepare \- Prepare a C++ binding module to use mm-common
+.SH SYNOPSIS
+.B mm-common-prepare
+.RI [ OPTION "]... [" DIRECTORY ]
+.SH DESCRIPTION
+Run
+.B mm-common-prepare
+to install the
+.I mm-common
+build support files into the source tree of a C++ binding module.
+The exact location where these files will be installed can be influenced
+through special macros in the
+.I configure.ac
+file.
+.TP
+.BI AC_CONFIG_AUX_DIR( [AUX-DIR] )
+The Automake include files are placed into the
+.I AUX-DIR
+subdirectory of the top-level source directory.  If
+.B AC_CONFIG_AUX_DIR
+is not specified, the files are placed at the top-level of the
+module's source tree.
+.TP
+.BI MM_CONFIG_DOCTOOL_DIR( [DOCTOOL-DIR] )
+If the
+.B MM_CONFIG_DOCTOOL_DIR
+macro is used with an explicit
+.I DOCTOOL-DIR
+argument, the common utilities required for generating and installing
+the reference documentation for a C++ binding module will be installed
+into the named subdirectory.  If
+.B MM_CONFIG_DOCTOOL_DIR
+is not used or does not specify a
+.I DOCTOOL-DIR
+argument,
+.B mm-common-prepare
+will not install the documentation utility files into the module's
+source tree. Instead, it is assumed that the module depends on
+.I glibmm
+and can use the installed documentation utilities that come with it.
+.SH OPTIONS
+.TP
+.BR \-c ", " \-\-copy
+copy files instead of creating symbolic links to them
+.TP
+.BR \-f ", " \-\-force
+forcefully replace existing files or symbolic links
+.TP
+.B \-\-help
+display a help message and exit
+.TP
+.B \-\-version
+show version information and exit
+.SH "EXIT STATUS"
+The exit status is 0 if OK, or 1 if an error occurred.
+.SH FILES
+The build support files currently installed by
+.B mm-common-prepare
+are listed below.
+.TP
+.BI "Automake include files installed into " AUX-DIR :
+.PD 0
+.IP
+.I compile-binding.am
+.IP
+.I dist-changelog.am
+.IP
+.I doc-reference.am
+.IP
+.I generate-binding.am
+.PD
+.TP
+.BI "Documentation utilities installed into " DOCTOOL-DIR :
+.PD 0
+.IP
+.I doc-install.pl
+.IP
+.I doc-postprocess.pl
+.IP
+.I doxygen.css
+.IP
+.I tagfile-to-devhelp2.xsl
+.PD
+.SH "SEE ALSO"
+.BR autoreconf (1)