bryson/pacman
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Start addition of asciidoc stuff

Browse source 
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 <dan@archlinux.org>
This commit is contained in:
Dan McGee 2007-07-01 17:55:44 -04:00
parent 91f1752701
commit 168b795f9e
4 changed files with 90 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
doc/.gitignore vendored
View file

@ -1,4 +1,10 @@
Makefile
Makefile.in
*.html
PKGBUILD.5
libalpm.3
makepkg.8
makepkg.conf.5
pacman.8
pacman.conf.5
*.xml
man3

17
doc/Makefile.am
View file

@ -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:

61
doc/asciidoc.conf Normal file
View file

@ -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: <command>(<section>); if section is defined, else just show
# the command.
[attributes]
plus=&#43;
caret=&#94;
startsb=&#91;
endsb=&#93;
tilde=&#126;
ifdef::backend-docbook[]
[manlink-inlinemacro]
{0%{target}}
{0#<citerefentry>}
{0#<refentrytitle>{target}</refentrytitle><manvolnum>{0}</manvolnum>}
{0#</citerefentry>}
endif::backend-docbook[]
ifdef::backend-docbook[]
# "unbreak" docbook-xsl v1.68 for manpages. v1.69 works with or without this.
[listingblock]
<example><title>{title}</title>
<literallayout>
|
</literallayout>
{title#}</example>
endif::backend-docbook[]
ifdef::doctype-manpage[]
ifdef::backend-docbook[]
[header]
template::[header-declarations]
<refentry>
<refmeta>
<refentrytitle>{mantitle}</refentrytitle>
<manvolnum>{manvolnum}</manvolnum>
<refmiscinfo class="source">Pacman</refmiscinfo>
<refmiscinfo class="version">{pacman_version}</refmiscinfo>
<refmiscinfo class="manual">Pacman Manual</refmiscinfo>
</refmeta>
<refnamediv>
<refname>{manname}</refname>
<refpurpose>{manpurpose}</refpurpose>
</refnamediv>
endif::backend-docbook[]
endif::doctype-manpage[]
ifdef::backend-xhtml11[]
[manlink-inlinemacro]
<a href="{target}.html">{target}{0?({0})}</a>
endif::backend-xhtml11[]

8
doc/footer.txt Normal file
View file

@ -0,0 +1,8 @@
Authors
-------
* Judd Vinet <jvinet@zeroflux.org>
* Aurelien Foret <aurelien@archlinux.org>
* Aaron Griffin <aaron@archlinux.org>
* Dan McGee <dan@archlinux.org>
See the 'AUTHORS' file for additional contributors.