[Debtags-commits] [svn] r1642 - in debtags/trunk: . doc tools

[Enrico Zini]

Author: enrico
Date: Sun Mar  5 19:46:17 2006
New Revision: 1642

Added:
   debtags/trunk/doc/debtags-man-hooks
   debtags/trunk/tools/manpage.cc
Removed:
   debtags/trunk/debtags.1
Modified:
   debtags/trunk/Makefile.am
   debtags/trunk/tools/DebtagsOptions.h
   debtags/trunk/tools/Makefile.am
Log:
Generate debtags manpage using the new commandline parser

Modified: debtags/trunk/Makefile.am
==============================================================================
--- debtags/trunk/Makefile.am	(original)
+++ debtags/trunk/Makefile.am	Sun Mar  5 19:46:17 2006
@@ -10,6 +10,9 @@
 
 man_MANS = debtags.1
 
+debtags.1: tools/manpage doc/debtags-man-hooks
+	tools/manpage debtags doc/debtags-man-hooks > $@ || rm $@
+
 install-data-local: bash-completion
 	install -d -o root -g root -m 0755 $(DESTDIR)$(bashcompdir)
 	$(INSTALL_DATA) $< $(DESTDIR)$(bashcompdir)/debtags

Modified: debtags/trunk/tools/DebtagsOptions.h
==============================================================================
--- debtags/trunk/tools/DebtagsOptions.h	(original)
+++ debtags/trunk/tools/DebtagsOptions.h	Sun Mar  5 19:46:17 2006
@@ -124,7 +124,11 @@
 			local->description = "do not download files when performing an update";
 			usage = "";
 			description = "updates the package tag database (requires root)";
-			longDescription = "TODO";
+			longDescription =
+				"Collect package tag data from the sources listed in "
+				"/etc/debtags/sources.list, then regenerate the debtags "
+				"tag database and main index.\n"
+				"It needs to be run as root";
 			add(&cp->helpGroup);
 		}
 	} update;
@@ -134,7 +138,6 @@
 		{
 			usage = "";
 			description = "perform a series of internal self checks using the current tag data";
-			longDescription = "TODO";
 			add(&cp->helpGroup);
 		}
 	} selfcheck;
@@ -147,7 +150,6 @@
 				"check that all the tags in the given tagged collection are present "
 				"in the tag vocabulary.  Checks the main database if no file is "
 				"specified";
-			longDescription = "TODO";
 			add(&cp->helpGroup);
 		}
 	} check;
@@ -157,7 +159,6 @@
 		{
 			usage = "";
 			description = "output the tag vocabulary";
-			longDescription = "TODO";
 			add(&cp->helpGroup);
 		}
 	} tagcat;
@@ -167,7 +168,6 @@
 		{
 			usage = "<tag>";
 			description = "show the vocabulary informations about a tag";
-			longDescription = "TODO";
 			add(&cp->helpGroup);
 		}
 	} tagshow;
@@ -177,7 +177,6 @@
 		{
 			usage = "<string [string [string ...]]>";
 			description = "show a summary of all tags whose data contains the given strings";
-			longDescription = "TODO";
 			add(&cp->helpGroup);
 		}
 	} tagsearch;
@@ -188,7 +187,6 @@
 			usage = "<pkg>";
 			description = "show informations about a package, like apt-cache show does, but "
 						  "adding the tag informations from the debtags index";
-			longDescription = "TODO";
 			add(&cp->helpGroup);
 		}
 	} show;
@@ -223,7 +221,6 @@
 		{
 			usage = "";
 			description = "output the full package tag database";
-			longDescription = "TODO";
 			add(&cp->outputGroup);
 			add(&cp->helpGroup);
 		}
@@ -260,6 +257,17 @@
 			usage = "<tag expression>";
 			description =
 				"apt-get install the packages that match the given tag expression";
+			longDescription =
+				"Invokes apt-get install with the names of the packages matched "
+				"by the given tag expression.  If you want to see what packages "
+				"would be installed you can use debtags search, as "
+				"debtags install just calls apt-get install on all "
+				"the results of an equivalent debtags search.  Please note "
+				"that debtags install is just a prototype feature useful "
+				"for experimenting in some environments like Custom Debian "
+				"Distributions.  For this reason it is suggested that you "
+				"use debtags just as a way to find packages, and "
+				"proper package managers as the way to install them";
 			add(&cp->matchGroup);
 			add(&cp->helpGroup);
 		}
@@ -342,7 +350,7 @@
 			usage = "";
 			description =
 				"print the tagged collection where each package is tagged with"
-				"its facets only";
+				"its facets only.  Useful for further processing via tagcoll";
 			add(&cp->outputGroup);
 			add(&cp->helpGroup);
 		}

Modified: debtags/trunk/tools/Makefile.am
==============================================================================
--- debtags/trunk/tools/Makefile.am	(original)
+++ debtags/trunk/tools/Makefile.am	Sun Mar  5 19:46:17 2006
@@ -1,6 +1,7 @@
 ## Process this file with automake to produce Makefile.in
 
 bin_PROGRAMS = debtags
+noinst_PROGRAMS = manpage
 
 debtags_SOURCES = \
 	Exec.cc \
@@ -11,6 +12,9 @@
 	debtags.cc
 debtags_LDADD = $(LIBAPT_FRONT_LIBS) $(LIBTAGCOLL_LIBS) -lapt-pkg
 
+manpage_SOURCES = manpage.cc
+manpage_LDADD = $(LIBAPT_FRONT_LIBS) $(LIBTAGCOLL_LIBS) -lapt-pkg
+
 INCLUDES = -I.. $(LIBTAGCOLL_CFLAGS) $(LIBABT_FRONT_CFLAGS)
 
 EXTRA_DIST = acqprogress.h ChildProcess.h DebtagsOptions.h Environment.h Exec.h Printer.h