From 168b795f9eb12c08d70d05f2ee313165004564e3 Mon Sep 17 00:00:00 2001 From: Dan McGee Date: Sun, 1 Jul 2007 17:55:44 -0400 Subject: Start addition of asciidoc stuff Add some asciidoc generation stuff to the doc/ Makefile.am so we can get some manpages up and working. Add necessary stuff to gitignore, and check in the asciidoc.conf file along with the footer for all of the manpages. Signed-off-by: Dan McGee --- doc/.gitignore | 8 +++++++- doc/Makefile.am | 17 +++++++++++++--- doc/asciidoc.conf | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ doc/footer.txt | 8 ++++++++ 4 files changed, 90 insertions(+), 4 deletions(-) create mode 100644 doc/asciidoc.conf create mode 100644 doc/footer.txt diff --git a/doc/.gitignore b/doc/.gitignore index b6ab6ec3..c7de9a64 100644 --- a/doc/.gitignore +++ b/doc/.gitignore @@ -1,4 +1,10 @@ Makefile Makefile.in -*.html +PKGBUILD.5 +libalpm.3 +makepkg.8 +makepkg.conf.5 +pacman.8 +pacman.conf.5 +*.xml man3 diff --git a/doc/Makefile.am b/doc/Makefile.am index 14caa0da..fd6fff45 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -10,7 +10,18 @@ if HAS_DOXYGEN man_MANS += $(wildcard man3/*.3) endif -EXTRA_DIST = $(man_MANS) Doxyfile +EXTRA_DIST = \ + pacman.8.txt \ + makepkg.8.txt \ + PKGBUILD.5.txt \ + makepkg.conf.5.txt \ + pacman.conf.5.txt \ + libalpm.3.txt \ + footer.txt \ + Doxyfile + +# Files that should be removed, but which Automake does not know. +MOSTLYCLEANFILES = $(man_MANS) man3/*.3 *.xml if HAS_DOXYGEN all: doxygen.in @@ -19,7 +30,7 @@ doxygen.in: doxygen $(srcdir)/Doxyfile endif -clean-local: - $(RM) man3/*.3 +$(man_MANS): + a2x -d manpage -f manpage --asciidoc-opts="-f asciidoc.conf" $@.txt # vim:set ts=2 sw=2 noet: diff --git a/doc/asciidoc.conf b/doc/asciidoc.conf new file mode 100644 index 00000000..cb75ad75 --- /dev/null +++ b/doc/asciidoc.conf @@ -0,0 +1,61 @@ +# +# Inspired by/borrowed from the GIT source tree at Documentation/asciidoc.conf +# + +## manlink: macro +# +# Usage: manlink:command[manpage-section] +# +# Note, {0} is the manpage section, while {target} is the command. +# +# Show man link as: (
); if section is defined, else just show +# the command. + +[attributes] +plus=+ +caret=^ +startsb=[ +endsb=] +tilde=~ + +ifdef::backend-docbook[] +[manlink-inlinemacro] +{0%{target}} +{0#} +{0#{target}{0}} +{0#} +endif::backend-docbook[] + +ifdef::backend-docbook[] +# "unbreak" docbook-xsl v1.68 for manpages. v1.69 works with or without this. +[listingblock] +{title} + +| + +{title#} +endif::backend-docbook[] + +ifdef::doctype-manpage[] +ifdef::backend-docbook[] +[header] +template::[header-declarations] + + +{mantitle} +{manvolnum} +Pacman +{pacman_version} +Pacman Manual + + + {manname} + {manpurpose} + +endif::backend-docbook[] +endif::doctype-manpage[] + +ifdef::backend-xhtml11[] +[manlink-inlinemacro] +{target}{0?({0})} +endif::backend-xhtml11[] diff --git a/doc/footer.txt b/doc/footer.txt new file mode 100644 index 00000000..e67a6e7b --- /dev/null +++ b/doc/footer.txt @@ -0,0 +1,8 @@ +Authors +------- +* Judd Vinet +* Aurelien Foret +* Aaron Griffin +* Dan McGee + +See the 'AUTHORS' file for additional contributors. -- cgit v1.2.3-24-g4f1b