util/mm-common-prepare.1.in


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

.TH MM-COMMON-PREPARE 1 2014-08-13 GNOME "@PACKAGE_STRING@"
.SH NAME
mm-common-prepare \- Prepare a C++ binding module to use mm-common and Autotools
.SH SYNOPSIS
.B mm-common-prepare
.RI [ OPTION "]... [" SOURCE-DIR ]
.SH DESCRIPTION
Run
.B mm-common-prepare
to copy the
.I mm-common
build support files into the source tree of a C++ binding module.
The exact location these files will be copied to 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 called with an explicit
.I DOCTOOL-DIR
argument, the common utilities required for generating and installing
the reference documentation of a C++ binding module will be copied
to 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 copy the documentation utility files into the module's source tree.
Instead, it is assumed that the module depends on
.I mm-common
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
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 copied by
.B mm-common-prepare
are listed below.
.TP
.BI "Automake include files copied to " 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 copied to " DOCTOOL-DIR :
.PD 0
.IP
.I doc-install.pl
.IP
.I doc-postprocess.pl
.IP
.I doxygen.css
.IP
.I doxygen-extra.css
.IP
.I tagfile-to-devhelp2.xsl
.PD
.SH "SEE ALSO"
.PD 0
.BR autoreconf (1),
.BR mm-common-get (1)
.PP
.I @docdir@/README
.PP
.I @docdir@/skeletonmm.tar.xz or
.PP
.I @docdir@/skeletonmm.tar.gz
.PD