scripts/dpkg-depcheck.1

   1 .TH DPKG-DEPCHECK "1" "March 2002" "dpkg-depcheck" DEBIAN
   2 .SH NAME
   3 dpkg-depcheck \- determine packages used to execute a command
   4 .SH SYNOPSIS
   5 \fBdpkg-depcheck\fR [\fIoptions\fR] \fIcommand\fR
   6 .SH DESCRIPTION
   7 This program runs the specified command under \fBstrace\fR and then
   8 determines and outputs the packages used in the process.  The list can
   9 be trimmed in various ways as described in the options below.  A good
  10 example of this program would be the command \fBdpkg-depcheck \-b
  11 debian/rules build\fR, which would give a good first approximation to
  12 the Build-Depends line needed by a Debian package.  Note, however,
  13 that this does \fInot\fR give any direct information on versions
  14 required or architecture-specific packages.
  15 .SH OPTIONS
  16 .TP
  17 .BR \-a ", " \-\-all
  18 Report all packages used to run \fIcommand\fR.  This is the default
  19 behaviour.  If used in conjunction with \fB\-b\fR, \fB\-d\fR or
  20 \fB\-m\fR, gives additional information on those packages skipped by
  21 these options.
  22 .TP
  23 .BR \-b ", " \-\-build-depends
  24 Do not report any build-essential or essential packages used, or any
  25 of their (direct or indirect) dependencies.
  26 .TP
  27 .BR \-d ", " \-\-ignore-dev-deps
  28 Do not show packages used which are direct dependencies of \fI\-dev\fR
  29 packages used.  This implies \fB\-b\fR.
  30 .TP
  31 .BR \-m ", " \-\-min-deps
  32 Output a minimal set of packages needed, taking into account direct
  33 dependencies.  Using \fB\-m\fR implies \fB\-d\fR and also \fB\-b\fR.
  34 .TP
  35 .BR \-C ", " \-\-C-locale
  36 Run \fIcommand\fR with the C locale.
  37 .TP
  38 .BR \-\-no-C-locale
  39 Don't change locale when running \fIcommand\fR.
  40 .TP
  41 .BR \-l ", " \-\-list-files
  42 Also report the list of files used in each package.
  43 .TP
  44 .BR \-\-no-list-files
  45 Do not report the files used in each package.  Cancels a \fB\-l\fR
  46 option.
  47 .TP
  48 \fB\-o\fR, \fB\-\-output=\fIFILE\fR
  49 Output the package diagnostics to \fIFILE\fR instead of stdout.
  50 .TP
  51 \fB\-O\fR, \fB\-\-strace-output=\fIFILE\fR
  52 Write the \fBstrace\fR output to \fIFILE\fR when tracing \fIcommand\fR
  53 instead of using a temporary file.
  54 .TP
  55 \fB\-I\fR, \fB\-\-strace-input=\fIFILE\fR
  56 Get \fBstrace\fR output from \fIFILE\fR instead of tracing
  57 \fIcommand\fR; \fBstrace\fR must have be run with the \fB\-f \-q\fR
  58 options for this to work.
  59 .TP
  60 \fB\-f\fR, \fB\-\-features=\fILIST\fR
  61 Enable or disabled features given in the comma-separated \fILIST\fR as
  62 follows.  A feature is enabled with \fI+feature\fR or just
  63 \fIfeature\fR and disabled with \fI\-feature\fR.  The currently
  64 recognised features are:
  65 .PD 0
  66 .RS
  67 .TP
  68 .B warn\-local
  69 Warn if files in \fI/usr/local\fR or \fI/var/local\fR are used.
  70 Enabled by default.
  71 .TP
  72 .B discard-check-version
  73 Discards \fIexecve\fR when only a \fI\-\-version\fR argument is given
  74 to the program; this works around some configure scripts that check
  75 for binaries they don't actually use.  Enabled by default.
  76 .TP
  77 .B trace-local
  78 Also try to identify files which are accessed in \fI/usr/local\fR and
  79 \fI/var/local\fR.  Not usually very useful, as Debian does not place
  80 files in these directories.  Disabled by default.
  81 .TP
  82 .B catch-alternatives
  83 Warn about access to files controlled by the Debian \fIalternatives\fR
  84 mechanism.  Enabled by default.
  85 .TP
  86 .B discard-sgml-catalogs
  87 Discards access to SGML catalogs; some SGML tools read all the registered
  88 catalogs at startup.  Files matching the regexp /usr/share/sgml/.*\\.cat are
  89 recognised  as catalogs.  Enabled by default.
  90 .PD
  91 .RE
  92 .TP
  93 \fB\-\-no-conf\fR, \fB\-\-noconf\fR
  94 Do not read any configuration files.  This can only be used as the
  95 first option given on the command-line.
  96 .TP
  97 .BR \-h ", " \-\-help
  98 Display usage information and exit.
  99 .TP
 100 .BR \-v ", " \-\-version
 101 Display version and copyright information and exit.
 102 .SH "CONFIGURATION VARIABLES"
 103 The two configuration files \fI/etc/devscripts.conf\fR and
 104 \fI~/.devscripts\fR are sourced in that order to set configuration
 105 variables.  Command line options can be used to override configuration
 106 file settings.  Environment variable settings are ignored for this
 107 purpose.  The currently recognised variable is:
 108 .TP
 109 .B DPKG_DEPCHECK_OPTIONS
 110 These are options which are parsed before the command-line options.
 111 For example,
 112 .IP
 113 DPKG_DEPCHECK_OPTIONS="\-b \-f-catch-alternatives"
 114 .IP
 115 which passes these options to \fBdpkg-depcheck\fR before any
 116 command-line options are processed.  You are advised not to try tricky
 117 quoting, because of the vagaries of shell quoting!
 118 .SH "SEE ALSO"
 119 .BR dpkg (1),
 120 .BR strace (1),
 121 .BR update-alternatives (8)
 122 and
 123 .BR devscripts.conf (5).
 124 .SH "COPYING"
 125 Copyright 2001 Bill Allombert <ballombe@debian.org>.
 126 Modifications copyright 2002,2003 Julian Gilbey <jdg@debian.org>.
 127 \fBdpkg-depcheck\fR is free software, covered by the GNU General
 128 Public License, version 2 or (at your option) any later version,
 129 and you are welcome to change it and/or distribute copies of it under
 130 certain conditions.  There is absolutely no warranty for
 131 \fBdpkg-depcheck\fR.