scripts/dpkg-source.8

   1 .\" Hey, Emacs!  This is an -*- nroff -*- source file.
   2 .\" Authors: Ian Jackson
   3 .TH DPKG\-SOURCE 8 "7th Auguest" "Debian Project" "Debian GNU/Linux manual"
   4 .SH NAME
   5 dpkg\-source, dpkg\-genchanges, dpkg\-gencontrol,
   6 dpkg\-buildpackage, dpkg\-distaddfile, dpkg\-parsechangelog
   7 \- Debian source packaging tools
   8 .SH SYNOPSIS
   9 .B dpkg-deb
  10 .BR -b | --build
  11 .IR directory " [" archive | directory ]
  12 .br
  13 .B dpkg-deb
  14 .BR -I | --info
  15 .IR archive " [" control\-file\-name " ..]"
  16 .br
  17 .B dpkg-deb
  18 .BR -f | --field
  19 .IR archive " [" control\-field\-name " ...]"
  20 .br
  21 .B dpkg-deb
  22 .BR -c | --contents
  23 .I archive
  24 .br
  25 .B dpkg-deb
  26 .BR -x | --extract | -X | --vextract
  27 .I archive directory
  28 .br
  29 .B dpkg-deb --fsys-tarfile
  30 .I archive
  31 .br
  32 .B dpkg-deb --control
  33 .I archive directory
  34 .SH DESCRIPTION
  35 .B dpkg-deb
  36 packs, unpacks and provides information about Debian archives.
  37
  38 Use
  39 .B dpkg
  40 to install and remove packages from your system.
  41
  42 You can also invoke
  43 .B dpkg\-deb
  44 by calling
  45 .B dpkg
  46 with whatever options you want to pass to
  47 .BR dpkg\-deb ".  " dpkg
  48 will spot that you wanted
  49 .B dpkg\-deb
  50 and run it for you.
  51 .SH ACTION OPTIONS
  52 .TP
  53 .BR --build ", " -b
  54 Creates a debian archive from the filesystem tree stored in
  55 .IR directory ".  " directory
  56 must have a
  57 .B DEBIAN
  58 subdirectory, which contains the control information files such
  59 as the control file itself.  This directory will
  60 .I not
  61 appear in the binary package's filesystem archive, but instead
  62 the files in it will be put in the binary package's control
  63 information area.
  64
  65 Unless you specify
  66 .BR \-\-no\-check ", " dpkg\-deb "
  67 will read
  68 .B DEBIAN/control
  69 and parse it.  It will check it for syntax errors and other problems,
  70 and display the name of the binary package being built.
  71 .B dpkg\-deb
  72 will also check the permissions of the maintainer scripts and other
  73 files found in the
  74 .B DEBIAN
  75 control information directory.
  76
  77 If no
  78 .I archive
  79 is specified then
  80 .B dpkg\-deb
  81 will write the package into the file
  82 .IR directory \fB.deb\fR.
  83
  84 If the archive to be created already exists it will be overwritten.
  85
  86 If the second argument is a directory then
  87 .B dpkg\-deb
  88 will write to the file
  89 .IB package _ version _ arch .deb\fR,
  90 or
  91 .IB package _ version .deb
  92 if no
  93 .B Architecture
  94 field is present in the package control file.  When a target directory
  95 is specified, rather than a file, the
  96 .B \-\-no\-check
  97 option may not be used (since
  98 .B dpkg\-deb
  99 needs to read and parse the package control file to determine which
 100 filename to use).
 101 .TP
 102 .BR \-\-info ", " -I
 103 Provides information about a binary package archive.
 104
 105 If no
 106 .IR control\-file\-name s
 107 are specified then it will print a summary of the contents of the
 108 package as well as its control file.
 109
 110 If any
 111 .IR control\-file\-name s
 112 are specified then
 113 .B dpkg\-deb
 114 will print them in the order they were specified; if any of the
 115 components weren't present it will print an error message to stderr
 116 about each one and exit with status 2.
 117 .TP
 118 .BR \-\-field ", " -f
 119 Extracts control file information from a binary package archive.
 120
 121 If no
 122 .BR control\-file\-field s
 123 are specified then it will print the whole control file.
 124
 125 If any are specified then
 126 .B dpkg\-deb
 127 will print their contents, in the order in which they appear in the
 128 control file.  If more than one
 129 .BR control\-file\-field
 130 is specified then
 131 .B dpkg\-deb
 132 will precede each with its field name (and a colon and space).
 133
 134 No errors are reported for fields requested but not found.
 135 .TP
 136 .BR --contents ", " -c
 137 Lists the contents of the filesystem tree archive portion of the
 138 package archive.  It is currently produced in the format generated by
 139 .BR tar 's
 140 verbose listing.
 141 .TP
 142 .BR --extract ", " -x ", " \-\-vextract ", " -X
 143 Extracts the filesystem tree from a package archive into the specified
 144 directory.
 145
 146 .BR \-\-vextract " (" -X ")"
 147 prints a listing of the files extracted as it goes, while
 148 .BR \-\-extract " (" -x ")"
 149 is silent unless an error occurs.
 150
 151 Note that extracting a package to the root directory will
 152 .I not
 153 result in a correct installation !  Use
 154 .B dpkg
 155 to install packages.
 156
 157 .I directory
 158 (but not its parents) will be created if necessary.
 159 .TP
 160 .BR --fsys-tarfile
 161 Extracts the filesystem tree data from a binary package and sends it
 162 to standard output in
 163 .B tar
 164 format.  Together with
 165 .B tar
 166 this can be used to extract a particular file from a package archive.
 167 .TP
 168 .BR --control ", " -e
 169 Extracs the control information files from a package archive into the
 170 specified directory.
 171
 172 If no directory is specified then a subdirectory
 173 .B DEBIAN
 174 in the current directory is used.
 175
 176 The target directory (but not its parents) will be created if
 177 necessary.
 178 .TP
 179 .BR --help ", " -h
 180 Prints
 181 .BR dpkg\-deb 's
 182 usage message, giving a summary of its options and their uses.
 183 .TP
 184 .BR --version
 185 Prints
 186 .BR dpkg\-deb 's
 187 version number.
 188 .TP
 189 .BR --licence
 190 Prints information about
 191 .BR dpkg\-deb 's
 192 copyright licensing and lack of warranty.  (The American spelling
 193 .B \-\-license
 194 is also supported.)
 195 .SH OTHER OPTIONS
 196 .TP
 197 .BR --new
 198 Ensures that
 199 .B dpkg\-deb
 200 builds a `new' format archive.  This is the default.
 201 .TP
 202 .BR --old
 203 Forces
 204 .B dpkg\-deb
 205 to build an `old' format archive.  This old archive format is less
 206 easily parsed by non-Debian tools and is now obsolete; its only use is
 207 when building packages to be parsed by versions of dpkg older than
 208 0.93.76 (September 1995), which was released as i386 a.out only.
 209 .TP
 210 .BR --no-check
 211 Inhibit's
 212 .BR "dpkg\-deb \-\-build" 's
 213 usual checks on the proposed contents of an archive.  You can build
 214 any archive you want, no matter how broken, this way.
 215 .TP
 216 .BR --debug ", " -D
 217 Enables debugging output.  This is not very interesting.
 218 .SH BUGS
 219 .B dpkg-deb -I
 220 .IB package1 .deb
 221 .IB package2 .deb
 222 does the wrong thing.
 223
 224 There is no authentication on
 225 .B .deb
 226 files; in fact, there isn't even a straightforward checksum.
 227
 228 Do not attempt to use just
 229 .B dpkg\-deb
 230 to install software !  You must use
 231 .B dpkg
 232 proper to ensure that all the files are correctly placed and the
 233 package's scripts run and its status and contents recorded.
 234 .SH SEE ALSO
 235 .BR deb (5),
 236 .BR deb-control (5),
 237 .BR dpkg (5),
 238 .BR dpkg (8),
 239 .BR dselect (8).
 240 .SH AUTHOR
 241 .B dpkg\-deb
 242 and this manpage were written by Ian Jackson.  They are
 243 Copyright (C)1995-1996
 244 by him and released under the GNU General Public Licence; there is NO
 245 WARRANTY.  See
 246 .B /usr/doc/copyright/dpkg
 247 and
 248 .B /usr/doc/copyright/GPL
 249 for details.