diff options
| author | Daniel Elstner <danielk@openismus.com> | 2009-09-08 12:28:17 +0200 |
|---|---|---|
| committer | Daniel Elstner <danielk@openismus.com> | 2009-09-08 12:28:17 +0200 |
| commit | 7d80a00ea2525a5c4f6a83c0aaf6c192b39088b6 (patch) | |
| tree | d7156f067d391ff383b7b76364283b24f326bd64 /util | |
| parent | f7553805eec5394945b95fdd598fb147e342425e (diff) | |
| download | mm-common-7d80a00ea2525a5c4f6a83c0aaf6c192b39088b6.tar.gz | |
Document source directory argument in manpage
* util/mm-common-prepare.1.in: Substitute SOURCE-DIR for DIRECTORY.
Document the purpose of the SOURCE-DIR argument. Insert line breaks
after sentences as recommended by a manual page style guide.
Diffstat (limited to 'util')
| -rw-r--r-- | util/mm-common-prepare.1.in | 27 |
1 files changed, 17 insertions, 10 deletions
diff --git a/util/mm-common-prepare.1.in b/util/mm-common-prepare.1.in index 766c44c..2542d5f 100644 --- a/util/mm-common-prepare.1.in +++ b/util/mm-common-prepare.1.in @@ -3,7 +3,7 @@ mm-common-prepare \- Prepare a C++ binding module to use mm-common .SH SYNOPSIS .B mm-common-prepare -.RI [ OPTION "]... [" DIRECTORY ] +.RI [ OPTION "]... [" SOURCE-DIR ] .SH DESCRIPTION Run .B mm-common-prepare @@ -18,28 +18,35 @@ file. .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 +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. +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 +macro is called 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 +the reference documentation of 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 +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. +.PP +If no +.I SOURCE-DIR +argument has been specified on the command line, the current working +directory will be used. .SH OPTIONS .TP .BR \-c ", " \-\-copy @@ -84,8 +91,8 @@ are listed below. .I tagfile-to-devhelp2.xsl .PD .SH "SEE ALSO" -.BR autoreconf (1) .PD 0 +.BR autoreconf (1) .PP .I @docdir@/README .PP |