[Debpool-commits] [SCM] Debpool Project Repository branch, master, updated. 0.2.3-63-g38a32aa

[ceros-guest]

The following commit has been merged in the master branch:
commit 2a53316090d02f069efc47d1b84b4eb33c7077c8
Author: ceros-guest <ceros-guest>
Date:   Thu Jan 10 05:11:24 2008 +0000

    Wrote a better manpage for debpool. Minor edit in description for DebPool::Config.

diff --git a/debian/changelog b/debian/changelog
index 94202c0..fc5dd3e 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -55,6 +55,8 @@ debpool (0.2.4~unreleased0) experimental; urgency=low
   * Use $ENV{'HOME'} instead of '/home/user' for specifying home directory
     through environment variable in Config.pm.
   * Autogenerate man page for DebPool::Config during build.
+  * Wrote a proper manpage for debpool.
+  * Minor edit in description for DebPool::Config.
 
  -- Andres Mejia <mcitadel at gmail.com>  Tue, 08 Jan 2008 02:06:32 -0500
 
diff --git a/man/man1/debpool.1 b/man/man1/debpool.1
index 51a95be..cd318c7 100644
--- a/man/man1/debpool.1
+++ b/man/man1/debpool.1
@@ -3,10 +3,11 @@
 .\" Man page for debpool
 .\"
 .\" Copyright 2003-2004 Joel Aelwyn
+.\" Copyright 2007-2008 Andres Mejia
 .\"
 .\" $Id: debpool.1 27 2004-11-07 03:06:59Z joel $
 .\"
-.TH debpool 1 "07 October 2003" "0.1.5" "Debian Pool Archive Manager"
+.TH debpool 1 "09 January 2008" "0.2.4" "Debian Pool Archive Manager"
 .SH NAME
 debpool \- pool-based Debian package archive manager
 .SH SYNOPSIS
@@ -20,27 +21,51 @@ debpool \- pool-based Debian package archive manager
 is a utility for managing pool-based archives of Debian packages. It
 can be run by individual users, and/or under a dedicated system user
 configuration.
-.SH EXAMPLES
-None
 .SH OVERVIEW
-None
-.SH DEFAULTS
-See the
-.BR DebPool::Config(5)
-manpage for details on configuration option defaults.
+This manual page describes how to specify options
+for debpool when running debpool through the command line.
+.SH USAGE
+For an option that enables/disables a feature for debpool (type boolean),
+simply use the option. For example, to enable daemon mode, run:
+.P
+.I debpool
+.B --daemon
+.P
+For an option used to assign a value, use the option and specify the
+value to be used. For example, to specify an archive directory to use, run:
+.P
+.I debpool
+.B --archive_dir /path/to/dir
+.P
+For an option that accepts multiple values, use the option and specify the
+list of values to be used. For example, to specify the architectures
+debpool will create a layout for, run:
+.P
+.I debpool
+.B --archs i386 amd64 . . .
+.P
+Assigning multiple values for an option may also be done by using the option
+with a different value multiple times. For example, using the
+example with architectures, run:
+.P
+.I debpool
+.B --archs i386 --archs amd64 . . .
+.P
+For an option that uses hash values, use the option with a different hash
+value as many times as necessary. For example, to specify the distributions
+debpool should create a layout for, run:
+.P
+.I debpool
+.B --dists unstable=sid --dists experimental=experimental . . .
+.P
 .SH OPTIONS
 See the
 .BR DebPool::Config(5)
 manpage for details on all configuration options.
-.SH "EXIT STATUS"
-.TP
-.B 0
-Successful program execution
-.TP
-.B 1
-Failure of any kind
-.SH ENVIRONMENT
-Nothing useful
+.SH DEFAULTS
+See the
+.BR DebPool::Config(5)
+manpage for details on configuration option defaults.
 .SH FILES
 .TP
 .I /usr/share/debpool/perl5/DebPool/Config.pm
@@ -51,10 +76,14 @@ System defaults file.
 .TP
 .I $HOME/.debpool/Config.pm
 User defaults file.
+.SH BUGS
+Please submit any bugs relating to debpool to the Debian Bug Tracking System.
 .SH SEE ALSO
 .BR DebPool::Config(5)
-.SH BUGS
-The entire manpage sucks, because the author hasn't taken the time
-to make it look nicer, and most of the important information really
-lives in the pod2man output for the configuration file (also known as
-DebPool::Config(5)).
+.br
+.BR Getopt::Long(3perl)
+.SH AUTHORS
+Copyright (c) Andres Mejia
+.br
+This manual page was writting for the Debian project, but may be used by
+others.
diff --git a/share/DebPool/Config.pm b/share/DebPool/Config.pm
index 540b35f..ca81725 100644
--- a/share/DebPool/Config.pm
+++ b/share/DebPool/Config.pm
@@ -66,8 +66,8 @@ option, which prevents any attempt at loading the default (system and user)
 config files.
 
 The config files in /etc/debpool and $HOME/.debpool are not required to be
-full Perl modules, though they must still declare a package namespace of
-'DebPool::Config' and return a true value.
+full Perl modules or to even exist. If they are used, they must still
+declare a package namespace of 'DebPool::Config' and return a true value.
 
 =cut
 

-- 
Debpool Project Repository