Browse Source

man: Add new deb-split.5 manual page

Guillem Jover 16 years ago
parent
commit
a8755804fd
4 changed files with 45 additions and 0 deletions
  1. 1 0
      debian/changelog
  2. 1 0
      man/Makefile.am
  3. 38 0
      man/deb-split.5
  4. 5 0
      man/po/po4a.cfg

+ 1 - 0
debian/changelog

@@ -33,6 +33,7 @@ dpkg (1.15.6) UNRELEASED; urgency=low
     which now makes it fatal, as was intended originally. This should not
     cause problems for anything using dpkg-dev to build packages as those
     are already fatal on that case.
+  * Add new deb-split(5) man page.
 
   [ Updated dpkg translations ]
   * French (Christian PERRIER).

+ 1 - 0
man/Makefile.am

@@ -85,6 +85,7 @@ dist_man_MANS = \
 	deb-control.5 \
 	deb-version.5 \
 	deb-shlibs.5 \
+	deb-split.5 \
 	deb-substvars.5 \
 	deb-symbols.5 \
 	deb-triggers.5 \

+ 38 - 0
man/deb-split.5

@@ -0,0 +1,38 @@
+.TH deb\-split 5 "2009-12-31" "Debian Project" "Debian"
+.SH NAME
+deb\-split \- Debian multi-part binary package format
+.SH SYNOPSIS
+.IB filename .deb
+.SH DESCRIPTION
+The multi-part \fB.deb\fP format is used to split big packages into smaller
+pieces to ease transport in small media.
+.SH FORMAT
+The file is an \fBar\fP archive with a magic value of \fB!<arch>\fP.
+.PP
+The first member is named \fBdebian\-split\fP and contains a series
+of lines, separated by newlines. Currently seven lines are present.
+The first is the format version number, \fB2.1\fP at the time this
+manual page was written. The second is the package name. The third
+is the package version. The fourth is the md5sum of the package.
+The fifth is the total size of the package. The sixth is the maximum
+part size. The seventh is the current part number, followed by a slash
+and the total amount of parts (as in \(oq1/10\(cq).
+.PP
+Programs which read multi-part archives should be prepared for additional
+lines to be present, and should ignore these if this is the case.
+.PP
+If the version number has changed, an incompatible change has been made
+and the program should stop. If it has not, then the program should
+be able to safely continue, unless it encounters an unexpected member
+in the archive (except at the end), as described below.
+.PP
+The second, last required member is named \fBdata.\fPN, where N denotes
+the part number. It contains the raw part data.
+.PP
+These members must occur in this exact order. Current implementations
+should ignore any additional members after \fBdata.\fPN.
+Further members may be defined in the future, and (if possible) will be
+placed after these two.
+.SH SEE ALSO
+.BR deb (5),
+.BR dpkg\-split (1).

+ 5 - 0
man/po/po4a.cfg

@@ -23,6 +23,11 @@
            add_$lang:po/$lang.add
 
 
+[type:man] deb-split.5                                      \
+           $lang:$(builddir)/$lang/deb-split.5              \
+           add_$lang:po/$lang.add
+
+
 [type:man] deb-version.5              \
            $lang:$(builddir)/$lang/deb-version.5            \
            add_$lang:po/$lang.add