add manpages (from debian package)

author: Stefano Karapetsas <[email protected]> 2012-05-18 11:28:34 +0200
committer: Stefano Karapetsas <[email protected]> 2012-05-18 11:28:34 +0200
commit: b49d86557e8b19b10b00b7ea7585fd4d8f1f79c0 (patch)
tree: 71aabd034e86686bc014b69c2ae914ff06b89013
parent: fd691b5d21aae69a79cd32124d43b1d542b69713 (diff)
download: mate-common-b49d86557e8b19b10b00b7ea7585fd4d8f1f79c0.tar.bz2
mate-common-b49d86557e8b19b10b00b7ea7585fd4d8f1f79c0.tar.xz
9 files changed, 159 insertions, 1 deletions
diff --git a/Makefile.am b/Makefile.am
index ee4791d..35ca548 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -1,4 +1,4 @@
-SUBDIRS = macros doc-build
+SUBDIRS = macros doc-build doc
 
 EXTRA_DIST = \
 autogen.sh \
diff --git a/configure.in b/configure.in
index 7951b65..6543c9a 100644
--- a/configure.in
+++ b/configure.in
@@ -19,6 +19,7 @@ mate-common.spec
 macros/Makefile
 doc-build/Makefile
 doc-build/mate-doc-common
+doc/Makefile
 ])
 
 AC_OUTPUT
diff --git a/doc/Makefile.am b/doc/Makefile.am
new file mode 100644
index 0000000..17cfbf1
--- /dev/null
+++ b/doc/Makefile.am
@@ -0,0 +1,6 @@
+man_MANS = mate-autogen.1 \
+ mate-doc-common.1
+
+EXTRA_DIST = $(man_MANS) \
+ autoten.sh.example
+
diff --git a/doc/autogen.sh.example b/doc/autogen.sh.example
new file mode 100644
index 0000000..8f50492
--- /dev/null
+++ b/doc/autogen.sh.example
@@ -0,0 +1,27 @@
+#!/bin/sh
+srcdir=`basename $0`
+[ -z "$srcdir" ] && srcdir=.
+
+PKG_NAME=mate-package
+REQUIRED_AUTOMAKE_VERSION=1.7
+
+if [ ! -f "$srcdir/somefile-that-is-only-in-mate-package" ]; then
+echo "$srcdir doesn't look like source directory for $PKG_NAME" >&2
+exit 1
+fi
+
+. mate-autogen
+
+
+# Then put the following in your configure.ac or configure.in file:
+# MATE_COMMON_INIT
+# 
+# This macro is equivalent to the following two lines (which you can use
+# instead if you don't want to depend on mate-common macros):
+# AC_SUBST([ACLOCAL_AMFLAGS], ["\${ACLOCAL_FLAGS}"])
+# 
+# Or if you are using the AC_CONFIG_MACRO_DIR macro:
+# AC_SUBST([ACLOCAL_AMFLAGS], ["-I $ac_macro_dir \${ACLOCAL_FLAGS}"])
+# 
+# This will make sure that autoconf macros will be found when you
+# rebuild the package without rerunning autogen.sh.
diff --git a/doc/mate-autogen.1 b/doc/mate-autogen.1
new file mode 100644
index 0000000..ce3221f
--- /dev/null
+++ b/doc/mate-autogen.1
@@ -0,0 +1,22 @@
+.\"Text automatically generated by txt2man
+.TH mate-autogen 1 "Fri, 18 May 2012 10:52:03 +0200" "" ""
+.SH NAME
+\fBmate-autogen \fP- generates all makefiles for MATE packages
+.SH SYNOPSIS
+.nf
+.fam C
+\fBmate-autogen\fP
+.fam T
+.fi
+.fam T
+.fi
+.SH DESCRIPTION
+\fBmate-autogen\fP generates all makefiles for MATE packages
+.PP
+To make use of the common autogen script, create a stub autogen.sh
+script in your module. Take the example in
+autogen.sh.example file in mate-common documentation folder
+.SH SEE ALSO
+\fBautoconf\fP(1), \fBautomake\fP(1), \fBautoreconf\fP(1), \fBmate-doc-common\fP(1)
+.SH AUTHOR
+Perberos <[email protected]>
diff --git a/doc/mate-autogen.txt b/doc/mate-autogen.txt
new file mode 100644
index 0000000..0af2668
--- /dev/null
+++ b/doc/mate-autogen.txt
@@ -0,0 +1,14 @@
+NAME
+ mate-autogen - generates all makefiles for MATE packages
+SYNOPSIS
+ mate-autogen
+DESCRIPTION
+ mate-autogen generates all makefiles for MATE packages
+ 
+ To make use of the common autogen script, create a stub autogen.sh
+ script in your module. Take the example in
+ autogen.sh.example file in mate-common documentation folder
+SEE ALSO
+ autoconf(1), automake(1), autoreconf(1), mate-doc-common(1)
+AUTHOR
+ Perberos <[email protected]>
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]>
diff --git a/doc/mate-doc-common.txt b/doc/mate-doc-common.txt
new file mode 100644
index 0000000..8448005
--- /dev/null
+++ b/doc/mate-doc-common.txt
@@ -0,0 +1,24 @@
+NAME
+ mate-doc-common - include the standard user documentation build files
+SYNOPSIS
+ mate-doc-common
+DESCRIPTION
+ This script is used by mate-autogen to include the standard user
+ documentation build files in a MATE package.
+ 
+ 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.
+
+ 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).
+OPTIONS
+ --help Display the help of the script.
+ --version Show the script version.
+ --copy Copy files instead of make symlinks.
+SEE ALSO
+ mate-autogen(1)
+AUTHOR
+ Perberos <[email protected]>
diff --git a/doc/update-manpages.sh b/doc/update-manpages.sh
new file mode 100755
index 0000000..14a0ece
--- /dev/null
+++ b/doc/update-manpages.sh
@@ -0,0 +1,23 @@
+#!/bin/sh
+
+if [ -x /usr/bin/txt2man ]; then
+
+ txt2man \
+ -d "`date -R`" \
+ -P mate-autogen \
+ -t mate-autogen \
+ -s 1 \
+ mate-autogen.txt > mate-autogen.1
+
+ txt2man \
+ -d "`date -R`" \
+ -P mate-doc-common \
+ -t mate-doc-common \
+ -s 1 \
+ mate-doc-common.txt > mate-doc-common.1
+
+else
+
+ echo "Install txt2man package to update manpages"
+
+fi
author	Stefano Karapetsas <[email protected]>	2012-05-18 11:28:34 +0200
committer	Stefano Karapetsas <[email protected]>	2012-05-18 11:28:34 +0200
commit	b49d86557e8b19b10b00b7ea7585fd4d8f1f79c0 (patch)
tree	71aabd034e86686bc014b69c2ae914ff06b89013
parent	fd691b5d21aae69a79cd32124d43b1d542b69713 (diff)
download	mate-common-b49d86557e8b19b10b00b7ea7585fd4d8f1f79c0.tar.bz2 mate-common-b49d86557e8b19b10b00b7ea7585fd4d8f1f79c0.tar.xz