.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "DEBARCHIVER 1" .TH DEBARCHIVER 1 "Tue, 10 Nov 2020 22:47:54 +0000" "Debarchiver " "Debarchiver" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" debarchiver \- Tool to sort debian packages into a package archive. .SH "SYNOPSIS" .IX Header "SYNOPSIS" debarchiver [options] .SH "DESCRIPTION" .IX Header "DESCRIPTION" The debian archiver is a tool that installs debian packages into a file structure suitable for apt-get, aptitude, dselect and similar tools. This can be used for updating the Debian system. It is meant to be used by local administrators that need special packages, or tweaked versions to ease administration. .PP The file structure is based on the potato file structure and does not support package pools. .SH "OPTIONS" .IX Header "OPTIONS" .IP "\fB\-a | \-\-autoscan\fR" 4 .IX Item "-a | --autoscan" Does both \-\-autoscanpackages and \-\-autoscansources. .IP "\fB\-\-autoscanall\fR" 4 .IX Item "--autoscanall" Same as \-\-scanall \-\-autoscan. .IP "\fB\-\-autoscanpackages\fR" 4 .IX Item "--autoscanpackages" Automatically run dpkg-scanpackages after all new packages are installed. .IP "\fB\-\-autoscansources\fR" 4 .IX Item "--autoscansources" Automatically run dpkg-scansources after all new packages are installed. .IP "\fB\-b | \-\-bzip\fR" 4 .IX Item "-b | --bzip" Create bzip2 compressed Packages.bz2 and Sources.bz2 files. .IP "\fB\-\-cachedir\fR dir" 4 .IX Item "--cachedir dir" The apt-ftparchive package cache directory, if \-\-index is used. The default is \f(CW$cachedir\fR. .IP "\fB\-\-cinstall\fR dir" 4 .IX Item "--cinstall dir" Where the .changes file will be installed to. Use the empty string to remove the .changes file instead. The default is \f(CW$cinstall\fR. .IP "\fB\-\-configfile\fR file" 4 .IX Item "--configfile file" Specifies an extra configuration file to read. Will be read after etc configuration and after user configuration files. .IP "\fB\-\-copycmd\fR" 4 .IX Item "--copycmd" The install command to use where the default is \f(CW$copycmd\fR. Both packages and .changes files are installed using this command. .IP "\fB\-d | \-\-dest | \-\-destdir\fR dir" 4 .IX Item "-d | --dest | --destdir dir" Destination directory. The base directory where all the distribution packages will reside and where the \f(CW$distrib\fR/$major/$arch/$section directory structure will be created. The default is \f(CW$destdir\fR, relative to the input directory. .IP "\fB\-\-debug\-level | \-\-dl\fR level" 4 .IX Item "--debug-level | --dl level" What information that should be printed. 1=critical, 2=error, 3=normal, 4=message, 5=debug, 6=verbose debug (modules). .IP "\fB\-\-distinputcriteria\fR" 4 .IX Item "--distinputcriteria" The criteria for what binary packages should be installed even if they do not have a .changes file. The default is \f(CW$distinputcriteria\fR. .IP "\fB\-\-gpgkey\fR" 4 .IX Item "--gpgkey" The GnuPG key to use to sign the archive. .IP "\fB\-\-gpgpassfile\fR" 4 .IX Item "--gpgpassfile" The file that provides the password to GnuPG. .IP "\fB\-\-help\fR" 4 .IX Item "--help" Prints this information. .IP "\fB\-i | \-\-input | \-\-indir | \-\-inputdir\fR dir" 4 .IX Item "-i | --input | --indir | --inputdir dir" This is the directory where debarchiver will look for new package versions and corresponding *.changes files that should be installed to the \-\-dest directory. The default is \f(CW$instdir\fR. .IP "\fB\-\-ignoredestcheck\fR" 4 .IX Item "--ignoredestcheck" Force install of .changes file even if some files specified in the .changes file already exists with wrong size or md5 hash. .IP "\fB\-\-incompletetime\fR" 4 .IX Item "--incompletetime" The time to allow .changes file to be incomplete in seconds. The default is 24 hours. .IP "\fB\-\-index | \-x\fR" 4 .IX Item "--index | -x" Automatically run apt-ftparchive after all new packages are installed. Use this *or* \-\-autoscan, not both. .IP "\fB\-\-instcmd\fR" 4 .IX Item "--instcmd" \&\s-1DEPRECATED\s0! .IP "\fB\-\-lockfile\fR file" 4 .IX Item "--lockfile file" The lockfile to use. The default is \f(CW$lockfile\fR. .IP "\fB\-\-mailcmd\fR" 4 .IX Item "--mailcmd" The command to use to send emails. The default behavior is to use the sendmail command. You can disable email sending by specifying the /bin/true command. .IP "\fB\-\-mailformat\fR" 4 .IX Item "--mailformat" Defines the format to be used to send emails with, by the command specified by \-\-mailfrom. Only 'sendmail' and 'mail' formats are supported. By default debarchiver assumes 'sendmail' format. The argument can be one of the following: sendmail = use of the sendmail format mail = use of the mail format .IP "\fB\-\-mailfrom\fR" 4 .IX Item "--mailfrom" Specify mail sender. .IP "\fB\-\-majordefault\fR" 4 .IX Item "--majordefault" Default major section to use. The default is 'main'. .IP "\fB\-\-movecmd\fR" 4 .IX Item "--movecmd" Command to move files (currently not used at all). .IP "\fB\-\-nosort\fR" 4 .IX Item "--nosort" Do not sort packages. .IP "\fB\-\-nostructurefix\fR" 4 .IX Item "--nostructurefix" Do not create directories and touch Package files. .IP "\fB\-o | \-\-addoverride\fR" 4 .IX Item "-o | --addoverride" Automatically add new packages to the override file. .IP "\fB\-\-quit\-level\fR level" 4 .IX Item "--quit-level level" On what level to quit the application, see debug level. .IP "\fB\-\-rmcmd\fR" 4 .IX Item "--rmcmd" The remove command to use. The default is \f(CW$rmcmd\fR. This can be used to move away the old packages to some other place. .IP "\fB\-\-scanall\fR" 4 .IX Item "--scanall" Scan all distributions, sections, etc. .IP "\fB\-\-scandetect | \-s\fR" 4 .IX Item "--scandetect | -s" Scan using 'apt\-ftparchive' or 'dpkg\-scan*' (dpkg-scanpackages and dpkg-scansources) depending on what is installed on the system. This is the recommended way. Only use \-\-index or \-\-autoscan if you know what you are doing. .IP "\fB\-\-scanonly\fR" 4 .IX Item "--scanonly" Same as \-\-nosort \-\-nostructurefix. .IP "\fB\-v | \-\-version\fR" 4 .IX Item "-v | --version" Prints the version string. .SH "CONFIGURATION FILES" .IX Header "CONFIGURATION FILES" You can also place configuration files with the following names (in the following order) /etc/debarchiver.conf, ~/.debarchiver.conf and input.conf (relative to input directory) that will be read before the arguments to this program will be parsed. In the above files you can change the following variables: .PP The configuration files are read as perl modules they should end with a true value. Therefore they should always end with a line that states '1;'. .IP "\fB\f(CB$bzip\fB\fR" 4 .IX Item "$bzip" If set to 0 no bzip2 files will be generated. If set to 1 bzip2 files will be generated. .IP "\fB\f(CB$cachedir\fB\fR" 4 .IX Item "$cachedir" The cache directory for apt-ftparchive used if \-\-index is used. .IP "\fB\f(CB$cinstall\fB\fR" 4 .IX Item "$cinstall" Where the .changes files are installed (see \-\-cinstall above). .IP "\fB\f(CB$copycmd\fB\fR" 4 .IX Item "$copycmd" The install command (see \-\-copycmd). .IP "\fB\f(CB$destdir\fB\fR" 4 .IX Item "$destdir" The destination directory (see \-\-destdir above). .IP "\fB\f(CB$distinputcriteria\fB\fR" 4 .IX Item "$distinputcriteria" The criteria for which packages that should be installed even if it does not have a .changes file. The default is \f(CW$distinputcriteria\fR. .IP "\fB\f(CB%distinputdirs\fB\fR" 4 .IX Item "%distinputdirs" Directories (distribution => dir) to be searched for extra binary packages that does not need a .changes file to be installed but match \f(CW$distinputcriteria\fR. The default is to accept kernel packages generated by make-kpkg (which does not generate a .changes file). Additionally binary packages with a valid .changes file will have the default distribution overridden to be the current queue directory. This cause uploads to a specific queue to place the package into that distribution directly. .IP "\fB\f(CB$gpgkey\fB\fR" 4 .IX Item "$gpgkey" The GnuPG key to use to sign the archive. If this variable is set, the Release file for each changed section of the archive will be signed with GnuPG using \f(CW$gpgkey\fR as the key \s-1ID.\s0 Unless you use a key that has no passphrase or use \f(CW$gpgpassfile\fR, you will need to run \fBdebarchiver\fR interactively when using this option so that you can supply the passphrase. .IP "\fB\f(CB$gpgpassfile\fB\fR" 4 .IX Item "$gpgpassfile" The file that contains the passphrase for the GnuPG key. See \f(CW$gpgkey\fR for more information. .IP "\fB\f(CB$ignoredestcheck\fB\fR" 4 .IX Item "$ignoredestcheck" Force install of .changes file even if some files specified in the .changes file already exist with wrong size or md5 hash. Default to 0 (do not ignore). .IP "\fB\f(CB$incompletetime\fB\fR" 4 .IX Item "$incompletetime" Time to allow .changes files to be incomplete in seconds. Useful for slow uploads. The default is 24 hours. .IP "\fB\f(CB$inputdir\fB\fR" 4 .IX Item "$inputdir" The input directory (no effect in \f(CW$inputconfigfile\fR). .IP "\fB\f(CB$lockfile\fB\fR" 4 .IX Item "$lockfile" The lockfile to use. The default is \f(CW$lockfile\fR. .IP "\fB\f(CB@mailtos\fB\fR" 4 .IX Item "@mailtos" An array of strings that will receive emails. If the string contains an email address that one is used. If it contains an incomplete email address, i.e. \f(CW@hostname\fR, the username owning the file is used @ the hostname specified. If no '@' character is found in the string, it is considered as a field in the .changes file. Such a field can for example be Maintainer or Uploaders. .IP "\fB\f(CB$mailformat\fB\fR" 4 .IX Item "$mailformat" The format to use to send emails (see \-\-mailformat above). .IP "\fB\f(CB$mailfrom\fB\fR" 4 .IX Item "$mailfrom" Specifies the sender of emails. The default is none ("") .IP "\fB\f(CB$majordefault\fB\fR" 4 .IX Item "$majordefault" Default major section (see \-\-majordefault above). .IP "\fB\f(CB$movecmd\fB\fR" 4 .IX Item "$movecmd" The move command (see \-\-movecmd). .IP "\fB\f(CB%release\fB\fR" 4 .IX Item "%release" Additional information to add to generated Release files. Supported keys are 'origin', 'label', and 'description'. .IP "\fB\f(CB$rmcmd\fB\fR" 4 .IX Item "$rmcmd" The remove command (see \-\-rmcmd above). .IP "\fB\f(CB$vrfycmd\fB\fR" 4 .IX Item "$vrfycmd" The verify command. Deprecated. Still functional but you are adviced to set \&\f(CW@vrfycmd\fR instead as the \f(CW$vrfycmd\fR may be removed in future releases. .IP "\fB\f(CB@vrfycmd\fB\fR" 4 .IX Item "@vrfycmd" The verify command. If the \f(CW@vrfycmd\fR list is empty is set to the list ($vrfycmd) just before the verify command is executed. It was made like this for backwards compatibility reasons. .IP "\fB\f(CB$verifysignatures\fB\fR" 4 .IX Item "$verifysignatures" Choose to enable (1) or disable (0) signature verification for packages uploaded into \f(CW$inputdir\fR (not \f(CW%distinputdirs\fR). .IP "\fB\f(CB$verifysignaturesdistinput\fB\fR" 4 .IX Item "$verifysignaturesdistinput" Choose to enable (1) or disable (2) signature verification for packages uploaded into \f(CW%distinputdirs\fR. This works independently from \f(CW$verifysignatures\fR. .IP "\fB\f(CB$usermailcmd\fB\fR" 4 .IX Item "$usermailcmd" It allows the user to tell debarchiver to use a specific command to send emails. You may also want to specify the mailformat your mail command handles by setting the value of the \f(CW$mailformat\fR variable. Using the \-\-mailcmd option on the command line will superseed this variable. You can disable email sending by specifying the /bin/true command. .SH "PACKAGE INDEXING" .IX Header "PACKAGE INDEXING" There are two ways to generate the indexes that \fBapt-get\fR relies on. .PP Using \fB\-\-autoscanpackages\fR, \fB\-\-autoscansources\fR, or \fB\-\-autoscan\fR will use \fBdpkg-scanpackages\fR and \fBdpkg-scansources\fR. This will generate the Packages and Sources files, but will not generate Contents files and can be slow with a large repository. .PP Alternatively, the \fB\-\-index\fR \fIconfig\fR option will call \fBapt-ftparchive\fR to index the package tree. \fBapt-ftparchive\fR can also generate Contents files (for use with \fBapt-file\fR), and can optionally use a cache of package information to speed up multiple runs. The \fBapt-ftparchive\fR configuration file will be generated automatically. This is however not fully tested. .PP You should use either \fB\-\-autoscanpackages\fR and \fB\-\-autoscansources\fR or \fB\-\-index\fR, not both, as they do basically the same thing. .PP The default action (and the recommended) is \fB\-\-scandetect\fR that probe for installed software and use the best choice depending on what software you have installed (chooses between \-\-index and \-\-autoscan right now). .SH "REJECT" .IX Header "REJECT" Changes files are rejected in the following conditions: * A file that is about to be installed already exist in the archive and is not identical to the one that is about to be installed. * Changes file is incomplete and has been there for \f(CW$incompletetime\fR time. * A file that is part of the Changes file is not yet big enough and the changes file has been there for \f(CW$incompletetime\fR time. * A file that is part of the Changes file is bigger than specified. * Verify signatures is enabled and signature do not match. .PP head \s-1EXAMPLES\s0 .PP Suppose you have just uploaded package to repository e.g. with \fBdput\fR\|(1), and you don't want to wait for the cron process to pick them up. You can force immediate handling of incoming queue with this command. The second option allows overwriting existing archive files. .PP .Vb 1 \& # debarchiver \-\-scandetect \-\-addoverride .Ve .SH "FILES" .IX Header "FILES" \&\fB/etc/debarchiver.conf\fR .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBapt-ftparchive\fR(1) .SH "AUTHOR" .IX Header "AUTHOR" Ola Lundqvist