From f7553805eec5394945b95fdd598fb147e342425e Mon Sep 17 00:00:00 2001 From: Daniel Elstner Date: Tue, 8 Sep 2009 11:13:32 +0200 Subject: Substitute variables in the manpage at build time * util/mm-common-prepare.1.in: Rename file from mm-common-prepare.1 and insert placeholders for the location of the documentation files. * Makefile.am (man1_MANS): Remove "dist_" prefix from variable name. (dist_noinst_DATA): Distribute util/mm-common-prepare.1.in file. (CLEANFILES): Clean generated util/mm-common-prepare.1 file. (util/mm-common-prepare.1): New rule to generate the manual page at build time. --- util/mm-common-prepare.1 | 87 ------------------------------------------ util/mm-common-prepare.1.in | 93 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 93 insertions(+), 87 deletions(-) delete mode 100644 util/mm-common-prepare.1 create mode 100644 util/mm-common-prepare.1.in (limited to 'util') diff --git a/util/mm-common-prepare.1 b/util/mm-common-prepare.1 deleted file mode 100644 index 605b92f..0000000 --- a/util/mm-common-prepare.1 +++ /dev/null @@ -1,87 +0,0 @@ -.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) diff --git a/util/mm-common-prepare.1.in b/util/mm-common-prepare.1.in new file mode 100644 index 0000000..766c44c --- /dev/null +++ b/util/mm-common-prepare.1.in @@ -0,0 +1,93 @@ +.TH MM-COMMON-PREPARE 1 2009-09-08 GNOME "@PACKAGE_STRING@" +.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) +.PD 0 +.PP +.I @docdir@/README +.PP +.I @docdir@/skeletonmm/ +.PD -- cgit v1.2.1