[PATCH] Use POD for debpool manpage
Hilko Bengen
bengen at debian.org
Sun Jun 1 13:52:22 UTC 2008
---
bin/debpool | 87 ++++++++++++++++++++++++++++++++++++++++++++++++++
man/man1/debpool.1 | 89 ----------------------------------------------------
2 files changed, 87 insertions(+), 89 deletions(-)
delete mode 100644 man/man1/debpool.1
diff --git a/bin/debpool b/bin/debpool
index 2d2488a..310fa34 100755
--- a/bin/debpool
+++ b/bin/debpool
@@ -708,6 +708,93 @@ Log_Message("Exiting.", LOG_GENERAL, LOG_DEBUG);
exit(0);
+=head1 NAME
+
+debpool - pool-based Debian package archive manager
+
+=head1 SYNOPSIS
+
+B<debpool> [ I<options> ]
+
+=head1 DESCRIPTION
+
+B<debpool> 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.
+
+=head1 OVERVIEW
+
+This manual page describes how to specify options for debpool when
+running debpool through the command line.
+
+=head1 USAGE
+
+For an option that enables/disables a feature for debpool (boolean
+type), simply use the option. For example, to enable daemon mode, run:
+
+B<debpool --daemon>
+
+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:
+
+B<debpool --archive_dir> I</path/to/dir>
+
+For an option that accepts multiple values (array type), 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:
+
+B<debpool --archs i386 amd64 ...>
+
+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:
+
+B<debpool --archs i386 --archs amd64 ...>
+
+For an option that uses hash values (hash types), 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:
+
+B<debpool --dists unstable=sid --dists experimental=experimental ...>
+
+=head1 OPTIONS
+
+See the L<DebPool::Config> manpage for details on all configuration
+options and their defaults.
+
+=head1 FILES
+
+=over 4
+
+=item F</etc/debpool/Config.pm>
+
+System defaults file.
+
+=item F<$HOME/.debpool/Config.pm>
+
+User-specific defaults file.
+
+=back
+
+=head1 BUGS
+
+Please submit any bugs relating to debpool to the Debian Bug Tracking
+System.
+
+=head1 SEE ALSO
+
+L<DebPool::Config>
+
+=head1 AUTHORS
+
+Copyright (c) Andres Mejia
+
+This manual page was written for the Debian project, but may be used
+by others.
+
+=cut
+
__END__
# vim:set tabstop=4 expandtab:
diff --git a/man/man1/debpool.1 b/man/man1/debpool.1
deleted file mode 100644
index ebd04ff..0000000
--- a/man/man1/debpool.1
+++ /dev/null
@@ -1,89 +0,0 @@
-'\" t
-.\" ** The above line should force tbl to be a preprocessor **
-.\" 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 "10 January 2008" "debpool v0.2.4" "Debian Pool Archive Manager"
-.SH NAME
-debpool \- pool-based Debian package archive manager
-.SH SYNOPSIS
-.\" The general command line
-.B debpool
-[\|
-.I options
-\|]
-.SH DESCRIPTION
-.B debpool
-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 OVERVIEW
-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 (boolean type),
-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 (array type), 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 (hash types), 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 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
-Program (internal) defaults file.
-.TP
-.I /etc/debpool/Config.pm
-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)
-.br
-.BR Getopt::Long(3perl)
-.SH AUTHORS
-Copyright (c) Andres Mejia
-.br
-This manual page was written for the Debian project, but may be used by
-others.
--
1.5.5.3
More information about the Debpool-devel
mailing list