aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2010-07-10 11:02:12 +0100
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2010-07-10 11:02:12 +0100
commita50d628f551959225b92202b3035cfcd9c8c033e (patch)
tree435a5c31c79857c06042ea8ccdf0713188118d9c
parent90ae2cf11103d9acfc302897747404ec6c5f9005 (diff)
downloadpaludis-a50d628f551959225b92202b3035cfcd9c8c033e.tar.gz
paludis-a50d628f551959225b92202b3035cfcd9c8c033e.tar.xz
Add html pages for cave commands
-rw-r--r--.gitignore35
-rw-r--r--doc/clients/Makefile.am58
-rw-r--r--src/clients/cave/Makefile.am2
3 files changed, 92 insertions, 3 deletions
diff --git a/.gitignore b/.gitignore
index 07360f7..0f45b64 100644
--- a/.gitignore
+++ b/.gitignore
@@ -81,6 +81,41 @@ paludis-*.*.*.tar.bz2
/doc/clients/adjutrix.html
/doc/clients/appareo.html
/doc/clients/cave.html
+/doc/clients/cave-config.html
+/doc/clients/cave-contents.html
+/doc/clients/cave-display-resolution.html
+/doc/clients/cave-executables.html
+/doc/clients/cave-execute-resolution.html
+/doc/clients/cave-find-candidates.html
+/doc/clients/cave-fix-cache.html
+/doc/clients/cave-fix-linkage.html
+/doc/clients/cave-help.html
+/doc/clients/cave-import.html
+/doc/clients/cave-info.html
+/doc/clients/cave-match.html
+/doc/clients/cave-owner.html
+/doc/clients/cave-perform.html
+/doc/clients/cave-print-categories.html
+/doc/clients/cave-print-commands.html
+/doc/clients/cave-print-environment-metadata.html
+/doc/clients/cave-print-id-contents.html
+/doc/clients/cave-print-id-executables.html
+/doc/clients/cave-print-id-metadata.html
+/doc/clients/cave-print-ids.html
+/doc/clients/cave-print-owners.html
+/doc/clients/cave-print-packages.html
+/doc/clients/cave-print-repositories.html
+/doc/clients/cave-print-repository-formats.html
+/doc/clients/cave-print-sets.html
+/doc/clients/cave-print-sync-protocols.html
+/doc/clients/cave-purge.html
+/doc/clients/cave-resolve.html
+/doc/clients/cave-resume.html
+/doc/clients/cave-search.html
+/doc/clients/cave-show.html
+/doc/clients/cave-sync.html
+/doc/clients/cave-uninstall.html
+/doc/clients/cave-update-world.html
/doc/clients/contrarius.html
/doc/clients/footer.html.part
/doc/clients/header.html.part
diff --git a/doc/clients/Makefile.am b/doc/clients/Makefile.am
index a73f3ff..66951ba 100644
--- a/doc/clients/Makefile.am
+++ b/doc/clients/Makefile.am
@@ -9,10 +9,12 @@ CLEANFILES += \
index.html
DISTCLEANFILES = \
- $(ALL_CLIENTS_HTML)
+ $(ALL_CLIENTS_HTML) \
+ $(CAVE_COMMANDS_HTML)
EXTRA_DIST = \
$(ALL_CLIENTS_HTML) \
+ $(CAVE_COMMANDS_HTML) \
toplinks.html.part.in \
index.html.part
@@ -20,7 +22,45 @@ paludisclientshtmldir = $(htmldir)/clients
paludisclientshtml_DATA = \
index.html \
- $(ALL_CLIENTS_HTML)
+ $(ALL_CLIENTS_HTML) \
+ $(CAVE_COMMANDS_HTML)
+
+CAVE_COMMANDS_HTML = \
+ cave-config.html \
+ cave-contents.html \
+ cave-display-resolution.html \
+ cave-executables.html \
+ cave-execute-resolution.html \
+ cave-find-candidates.html \
+ cave-fix-cache.html \
+ cave-fix-linkage.html \
+ cave-help.html \
+ cave-import.html \
+ cave-info.html \
+ cave-match.html \
+ cave-owner.html \
+ cave-perform.html \
+ cave-print-categories.html \
+ cave-print-commands.html \
+ cave-print-environment-metadata.html \
+ cave-print-id-contents.html \
+ cave-print-id-executables.html \
+ cave-print-id-metadata.html \
+ cave-print-ids.html \
+ cave-print-owners.html \
+ cave-print-packages.html \
+ cave-print-repositories.html \
+ cave-print-repository-formats.html \
+ cave-print-sets.html \
+ cave-print-sync-protocols.html \
+ cave-purge.html \
+ cave-resolve.html \
+ cave-resume.html \
+ cave-search.html \
+ cave-show.html \
+ cave-sync.html \
+ cave-uninstall.html \
+ cave-update-world.html
if HAVE_HTMLTIDY
@@ -79,7 +119,19 @@ appareo.html : header.html.part footer.html.part
cave.html : header.html.part footer.html.part
{ cat header.html.part && { \
if test -x $(top_builddir)/src/clients/cave/man-cave ; then \
- env CAVE_COMMANDS_PATH="" $(top_builddir)/src/clients/cave/man-cave --html ; \
+ env CAVE_COMMANDS_PATH="" $(top_builddir)/src/clients/cave/man-cave --html | \
+ sed -e '/<h2>See Also<.h2>/,/<.ul>/s#<strong>\(.*\)</strong> (1)#<a href="\1.html">\1</a>#'; \
+ else \
+ echo "<h1>cave</h1>"; \
+ echo "<p>Sorry, documentation was generated without support for the cave client.</p>" ; \
+ fi ; } && \
+ cat footer.html.part ; } > $@
+
+$(CAVE_COMMANDS_HTML) : header.html.part footer.html.part
+ { cat header.html.part && { \
+ if test -x $(top_builddir)/src/clients/cave/man-cave ; then \
+ basename $@ .html | sed -e 's,^cave-,,' | xargs env CAVE_COMMANDS_PATH="" $(top_builddir)/src/clients/cave/man-cave --html | \
+ sed -e '/<h2>See Also<.h2>/,/<.ul>/s#<strong>\(.*\)</strong> (1)#<a href="\1.html">\1</a>#'; \
else \
echo "<h1>cave</h1>"; \
echo "<p>Sorry, documentation was generated without support for the cave client.</p>" ; \
diff --git a/src/clients/cave/Makefile.am b/src/clients/cave/Makefile.am
index 73b9519..37d7dcb 100644
--- a/src/clients/cave/Makefile.am
+++ b/src/clients/cave/Makefile.am
@@ -17,6 +17,7 @@ bin_PROGRAMS = cave
noinst_PROGRAMS = man-cave
+# Also update doc/clients/Makefile.am when adding here:
command_MANS = \
cave-config.1 \
cave-contents.1 \
@@ -89,6 +90,7 @@ man_cave_LDADD = \
noinst_LIBRARIES = libcave.a
+# Also update command_MANS above when adding new commands here:
libcave_a_SOURCES = \
colour_formatter.cc colour_formatter.hh \
command.cc command.hh \