diff options
Diffstat (limited to '')
| -rw-r--r-- | man/dpkg-split.pod | 294 |
1 files changed, 294 insertions, 0 deletions
diff --git a/man/dpkg-split.pod b/man/dpkg-split.pod new file mode 100644 index 0000000..ba2b505 --- /dev/null +++ b/man/dpkg-split.pod @@ -0,0 +1,294 @@ +# dpkg manual page - dpkg-split(1) +# +# Copyright © 1995-1996 Ian Jackson <ijackson@chiark.greenend.org.uk> +# Copyright © 2011 Guillem Jover <guillem@debian.org> +# +# This is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2 of the License, or +# (at your option) any later version. +# +# This is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see <https://www.gnu.org/licenses/>. + +=encoding utf8 + +=head1 NAME + +dpkg-split - Debian package archive split/join tool + +=head1 SYNOPSIS + +B<dpkg-split> +[I<option>...] I<command> + +=head1 DESCRIPTION + +B<dpkg-split> +splits Debian binary package files into smaller parts and reassembles +them again, to support the storage of large package files on small +media such as floppy disks. + +It can be operated manually using the +B<--split>, B<--join> and B<--info> +options. + +It also has an automatic mode, invoked using the +B<--auto> +option, where it maintains a queue of parts seen but not yet +reassembled and reassembles a package file when it has seen all of its +parts. The +B<--listq> and B<--discard> +options allow the management of the queue. + +All splitting, joining and queueing operations produce informative +messages on standard output; these may safely be ignored. + +=head1 COMMANDS + +=over + +=item B<-s>, B<--split> I<complete-archive> [I<prefix>] + +Splits a single Debian binary package into several parts. + +The parts are named +I<prefix>B<.>I<N>B<of>I<M>B<.deb> +where +I<N> +is the part number, starting at 1, and +I<M> +is the total number of parts (both in decimal). + +If no +I<prefix> +is supplied then the +I<complete-archive> +filename is taken, including directory, with any trailing +B<.deb> +removed. + +=item B<-j>, B<--join> I<part>... + +Joins the parts of a package file together, reassembling the original +file as it was before it was split. + +The part files given as arguments must be all the parts of exactly the +same original binary file. Each part must occur exactly once in the +argument list, though the parts to not need to be listed in order. + +The parts must of course all have been generated with the same part +size specified at split time, which means that they must usually have +been generated by the same invocation of +B<dpkg-split --split>. + +The parts' filenames are not significant for the reassembly process. + +By default the output file is called +I<package>B<_>I<version>B<_>I<arch>B<.deb>. + +=item B<-I>, B<--info> I<part>... + +Prints information, in a human-readable format, about the part file(s) +specified. Arguments which are not binary package parts produce a +message saying so instead (but still on standard output). + +=item B<-a>, B<--auto -o> I<complete-output part> + +Automatically queue parts and reassemble a package if possible. + +The +I<part> +specified is examined, and compared with other parts of the same +package (if any) in the queue of packages file parts. + +If all parts of the package file of which +I<part> +is a part are available then the package is reassembled and written to +I<complete-output> +(which should not usually already exist, though this is not an +error). + +If not then the +I<part> +is copied into the queue and +I<complete-output> +is not created. + +If +I<part> +is not a split binary package part then +B<dpkg-split> +will exit with status B<1>; if some other trouble occurs then it will +exit with status B<2>. + +The +B<--output> or B<-o> +option must be supplied when using +B<--auto>. +(If this were not mandatory the calling program would not know what +output file to expect.) + +=item B<-l>, B<--listq> + +Lists the contents of the queue of packages to be reassembled. + +For each package file of which parts are in the queue the output gives +the name of the package, the parts in the queue, and the total number +of bytes stored in the queue. + +=item B<-d>, B<--discard> [I<package>...] + +This discards parts from the queue of those waiting for the remaining +parts of their packages. + +If no +I<package> +is specified then the queue is cleared completely; if any are +specified then only parts of the relevant package(s) are deleted. + +=item B<-?>, B<--help> + +Show the usage message and exit. + +=item B<--version> + +Show the version and exit. + +=back + +=head1 OPTIONS + +=over + +=item B<--depotdir> I<directory> + +Specifies an alternative directory for the queue of parts awaiting +automatic reassembly. The default is +B<%ADMINDIR%>. + +=item B<-S>, B<--partsize> I<kibibytes> + +Specifies the maximum part size when splitting, in kibibytes (1024 +bytes). The default is 450 KiB. + +=item B<-o>, B<--output> I<complete-output> + +Specifies the output file name for a reassembly. + +This overrides the default for a manual reassembly +(B<--join>) +and is mandatory for an automatic queue-or-reassemble +(B<--auto>). + +=item B<-Q>, B<--npquiet> + +When doing automatic queue-or-reassembly +B<dpkg-split> +usually prints a message if it is given a +I<part> +that is not a binary package part. This option suppresses this +message, to allow programs such as +B<dpkg> +to cope with both split and unsplit packages without producing +spurious messages. + +=item B<--msdos> + +Forces the output filenames generated by +B<--split> +to be MSDOS-compatible. + +This mangles the prefix - either the default derived from the input +filename or the one supplied as an argument: alphanumerics are +lowercased, plus signs are replaced by +B<x>'s +and all other characters are discarded. + +The result is then truncated as much as is necessary, and filenames of +the form +I<prefixN>B<of>I<M>B<.deb> +are generated. + +=back + +=head1 EXIT STATUS + +=over + +=item B<0> + +The requested split, merge, or other command succeeded. +B<--info> +commands count as successful even if the files are not binary package +parts. + +=item B<1> + +Only occurs with +B<--auto> +and indicates that the +I<part> +file was not a binary package part. + +=item B<2> + +Fatal or unrecoverable error due to invalid command-line usage, +a file that looked like a package part file but was corrupted, or +interactions with the system, such as accesses to the database, +memory allocations, etc. + +=back + +=head1 ENVIRONMENT + +=over + +=item B<DPKG_COLORS> + +Sets the color mode (since dpkg 1.18.5). +The currently accepted values are: B<auto> (default), B<always> and +B<never>. + +=item B<SOURCE_DATE_EPOCH> + +If set, it will be used as the timestamp (as seconds since the epoch) in +the B<deb-split>(5)'s B<ar>(5) container. + +=back + +=head1 FILES + +=over + +=item I<%ADMINDIR%/parts> + +The default queue directory for part files awaiting automatic +reassembly. + +The filenames used in this directory are in a format internal to +B<dpkg-split> +and are unlikely to be useful to other programs, and in any case the +filename format should not be relied upon. + +=back + +=head1 BUGS + +Full details of the packages in the queue are impossible to get +without digging into the queue directory yourself. + +There is no easy way to test whether a file that may be a binary +package part is one. + +=head1 SEE ALSO + +B<deb>(5), +B<deb-control>(5), +B<dpkg-deb>(1), +B<dpkg>(1). |