[Pkg-ocaml-maint-commits] r5941 - /trunk/packages/edos-debcheck/trunk/debian/edos-builddebcheck.1

Tue Aug 12 21:21:51 UTC 2008

Author: treinen
Date: Tue Aug 12 21:21:51 2008
New Revision: 5941

URL: http://svn.debian.org/wsvn/pkg-ocaml-maint/?sc=1&rev=5941
Log:
first version of man page

Added:
    trunk/packages/edos-debcheck/trunk/debian/edos-builddebcheck.1

Added: trunk/packages/edos-debcheck/trunk/debian/edos-builddebcheck.1
URL: http://svn.debian.org/wsvn/pkg-ocaml-maint/trunk/packages/edos-debcheck/trunk/debian/edos-builddebcheck.1?rev=5941&op=file
==============================================================================

--- trunk/packages/edos-debcheck/trunk/debian/edos-builddebcheck.1 (added)
+++ trunk/packages/edos-debcheck/trunk/debian/edos-builddebcheck.1 Tue Aug 12 21:21:51 2008
@@ -1,0 +1,72 @@
+.TH EDOS-BUILDDEBCHECK 1 2008-08-12 EDOS
+
+.SH NAME
+Edos-debcheck \- Check satisfiability of debian package build-dependencies
+
+.SH SYNOPSIS
+\fBedos-builddebcheck\fR [option] ... Packagefile Sourcepackagefile
+
+.SH DESCRIPTION
+.B edos-builddebcheck
+reads a set of debian package descriptions from the file \fIPackagefile\fR,
+each of which is in the format of deb-control(5), and a set of source package
+descriptions from the file \fISourcepackagefile\fR. All packages described in
+the file \fIPackagefile\fR must have the same value of their \fIArcitecture\fR
+(if it is different from all).
+
+For instance, the Packages and Sources files as found on a debian mirror
+server, or in the directory \fI/var/lib/apt/lists/\fR of a debian system, are
+suitable as input files.
+
+.B edos-builddebcheck
+verifies for every of the source packages (from \fISourcepackagefile\fR)
+whether its build-dependencies can be satisfied from the binary packages (from
+\fIPackagefile\fR).
+
+Note that this is not the same thing as rebuilding a distribution from
+scratch, for at least two reasons:
+
+.TP 1
+The binary packages in \fIPackages\fR are not necessarily those that are
+the result of the compilation of the source packages in
+\fISourcepackagefile\fR
+
+.TP 2
+We do not check for cycles. For instance, imagine we have source packages a
+and b both generating one binary package of the same name as their source
+package, a build-depends on b and b build-depends on a. Then we can obviously
+not rebuild the set of packages from scratch. However, if we already have
+binary packages for a and for b then we can recompile both for them.
+
+
+.SH OPTIONS
+.TP
+.B -check
+Double-check the results
+.TP
+.B -explain
+Explain the results
+.TP
+.B -rules
+Print generated rules
+.TP
+.B -failures
+Only show failures
+.TP
+.B -successes
+Only show successes
+.TP
+.B -help, --help
+Display this list of options
+
+.SH AUTHOR
+Edos-builddebcheck has been written by Stefano Zacchirolli and Ralf Treinen.
+It heavily relies on edos-debcheck which has been written by Jerome Vouillon
+for the EDOS project.
+
+
+.SH SEE ALSO
+.BR deb-control (5), edos-debcheck (1)
+
+<http://www.edos-project.org> is the home page of the EDOS project.
+


