summaryrefslogtreecommitdiff
path: root/doc/mate-doc-common.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/mate-doc-common.1')
-rw-r--r--doc/mate-doc-common.141
1 files changed, 41 insertions, 0 deletions
diff --git a/doc/mate-doc-common.1 b/doc/mate-doc-common.1
new file mode 100644
index 0000000..018792c
--- /dev/null
+++ b/doc/mate-doc-common.1
@@ -0,0 +1,41 @@
+.\"Text automatically generated by txt2man
+.TH mate-doc-common 1 "Fri, 18 May 2012 10:52:03 +0200" "" ""
+.SH NAME
+\fBmate-doc-common \fP- include the standard user documentation build files
+.SH SYNOPSIS
+.nf
+.fam C
+\fBmate-doc-common\fP
+.fam T
+.fi
+.fam T
+.fi
+.SH DESCRIPTION
+This script is used by mate-autogen to include the standard user
+documentation build files in a MATE package.
+.PP
+To automatically include the standard user documentation build files (omf.make
+and xmldocs.make) in you package, set USE_COMMON_DOC_BUILD=yes in autogen.sh
+before calling the macros/autogen.sh script.
+.PP
+When porting applications across to use this feature, ensure that all of the
+references to xmldocs.make are to $(top_srcdir)/xmldocs.make in the appropriate
+Makefile.am files. Some modules assume that xmldocs.make is in another
+directory (like docs/ or something).
+.SH OPTIONS
+.TP
+.B
+\fB--help\fP
+Display the help of the script.
+.TP
+.B
+\fB--version\fP
+Show the script version.
+.TP
+.B
+\fB--copy\fP
+Copy files instead of make symlinks.
+.SH SEE ALSO
+\fBmate-autogen\fP(1)
+.SH AUTHOR
+Perberos <[email protected]>