scripts/debrelease.1

   1 .TH DEBRELEASE 1 "Debian Utilities" "DEBIAN" \" -*- nroff -*-
   2 .SH NAME
   3 debrelease \- a wrapper around dupload or dput
   4 .SH SYNOPSIS
   5 \fBdebrelease\fR [\fIdebrelease options\fR] [\fIdupload/dput options\fR]
   6 .SH DESCRIPTION
   7 \fBdebrelease\fR is a simple wrapper around \fBdupload\fR or
   8 \fBdput\fR.  It is called from within the source code tree of a
   9 package, and figures out the current version of a package.  It then
  10 looks for the corresponding \fI.changes\fR file (which lists the files
  11 needed to upload in order to release the package) in the parent
  12 directory of the source code tree and calls \fBdupload\fR or
  13 \fBdput\fR with the \fI.changes\fR file as parameter in order to
  14 perform the actual uploading.
  15 .PP
  16 Options may be given to \fBdebrelease\fR; except for the ones listed
  17 below, they are passed on unchanged to \fBdupload\fR or \fBdput\fR.
  18 The \fBdevscripts\fR configuration files are also read by
  19 \fBdebrelease\fR as described below.
  20 .SH "Directory name checking"
  21 In common with several other scripts in the \fBdevscripts\fR package,
  22 \fBdebrelease\fR will climb the directory tree until it finds a
  23 \fIdebian/changelog\fR file.  As a safeguard against stray files
  24 causing potential problems, it will examine the name of the parent
  25 directory once it finds the \fIdebian/changelog\fR file, and check
  26 that the directory name corresponds to the package name.  Precisely
  27 how it does this is controlled by two configuration file variables
  28 DEVSCRIPTS_CHECK_DIRNAME_LEVEL and DEVSCRIPTS_CHECK_DIRNAME_REGEX, and
  29 their corresponding command-line options \fB\-\-check-dirname-level\fR
  30 and \fB\-\-check-dirname-regex\fR.
  31 .PP
  32 DEVSCRIPTS_CHECK_DIRNAME_LEVEL can take the following values:
  33 .TP
  34 .B 0
  35 Never check the directory name.
  36 .TP
  37 .B 1
  38 Only check the directory name if we have had to change directory in
  39 our search for \fIdebian/changelog\fR.  This is the default behaviour.
  40 .TP
  41 .B 2
  42 Always check the directory name.
  43 .PP
  44 The directory name is checked by testing whether the current directory
  45 name (as determined by \fBpwd\fR(1)) matches the regex given by the
  46 configuration file option DEVSCRIPTS_CHECK_DIRNAME_REGEX or by the
  47 command line option \fB\-\-check-dirname-regex\fR \fIregex\fR.  Here
  48 \fIregex\fR is a Perl regex (see \fBperlre\fR(3perl)), which will be
  49 anchored at the beginning and the end.  If \fIregex\fR contains a '/',
  50 then it must match the full directory path.  If not, then it must
  51 match the full directory name.  If \fIregex\fR contains the string
  52 \'PACKAGE', this will be replaced by the source package name, as
  53 determined from the changelog.  The default value for the regex is:
  54 \'PACKAGE(-.+)?', thus matching directory names such as PACKAGE and
  55 PACKAGE-version.
  56 .SH OPTIONS
  57 .TP
  58 \fB\-\-dupload\fR, \fB\-\-dput\fR
  59 This specifies which uploader program to use; the default is
  60 \fBdupload\fR.
  61 .TP
  62 \fB\-S\fR
  63 If this option is used, or the default \fI.changes\fR file is
  64 not found but a source-only \fI.changes\fR file is present, then this
  65 source-only \fI.changes\fR file will be uploaded instead of an
  66 arch-specific one.
  67 .TP
  68 \fB\-a\fIdebian-architecture\fR, \fB\-t\fIGNU-system-type\fR
  69 See \fBdpkg-architecture\fR(1) for a description of these options.
  70 They affect the search for the \fI.changes\fR file.  They are provided
  71 to mimic the behaviour of \fBdpkg-buildpackage\fR when determining the
  72 name of the \fI.changes\fR file.  If a plain \fB\-t\fR is given, it is
  73 taken to be the \fBdupload\fR host-specifying option, and therefore
  74 signifies the end of the \fBdebrelease\fR-specific options.
  75 .TP
  76 \fB\-\-multi\fR
  77 Multiarch changes mode: This signifies that \fBdebrelease\fR should
  78 use the most recent file with the name pattern
  79 \fIpackage_version_*+*.changes\fR as the changes file, allowing for the
  80 changes files produced by \fBdpkg-cross\fR.
  81 .TP
  82 \fB\-\-debs\-dir\fR \fIDIR\fR
  83 Look for the \fI.changes\fR and \fI.deb\fR files in directory
  84 \fIDIR\fR instead of the parent of the source directory.  This should
  85 either be an absolute path or relative to the top of the source
  86 directory.
  87 .TP
  88 \fB\-\-check-dirname-level\fR \fIN\fR
  89 See the above section "Directory name checking" for an explanation of
  90 this option.
  91 .TP
  92 \fB\-\-check-dirname-regex\fR \fIregex\fR
  93 See the above section "Directory name checking" for an explanation of
  94 this option.
  95 .TP
  96 \fB\-\-no-conf\fR, \fB\-\-noconf\fR
  97 Do not read any configuration files.  This can only be used as the
  98 first option given on the command-line.
  99 .TP
 100 .BR \-\-help ", " \-h
 101 Display a help message and exit successfully.
 102 .TP
 103 .B \-\-version
 104 Display version and copyright information and exit successfully.
 105 .SH "CONFIGURATION VARIABLES"
 106 The two configuration files \fI/etc/devscripts.conf\fR and
 107 \fI~/.devscripts\fR are sourced in that order to set configuration
 108 variables.  Command line options can be used to override configuration
 109 file settings.  Environment variable settings are ignored for this
 110 purpose.  The currently recognised variables are:
 111 .TP
 112 .B DEBRELEASE_UPLOADER
 113 The currently recognised values are \fIdupload\fR and \fIdput\fR, and
 114 it specifies which uploader program should be used.  It corresponds to
 115 the \fB\-\-dupload\fR and \fB\-\-dput\fR command line options.
 116 .TP
 117 .B DEBRELEASE_DEBS_DIR
 118 This specifies the directory in which to look for the \fI.changes\fR
 119 and \fI.deb\fR files, and is either an absolute path or relative to
 120 the top of the source tree.  This corresponds to the
 121 \fB\-\-debs\-dir\fR command line option.  This directive could be
 122 used, for example, if you always use \fBpbuilder\fR or
 123 \fBsvn-buildpackage\fR to build your packages.  Note that it also
 124 affects \fBdebc\fR(1) and \fBdebi\fR(1).
 125 .TP
 126 .BR DEVSCRIPTS_CHECK_DIRNAME_LEVEL ", " DEVSCRIPTS_CHECK_DIRNAME_REGEX
 127 See the above section "Directory name checking" for an explanation of
 128 these variables.  Note that these are package-wide configuration
 129 variables, and will therefore affect all \fBdevscripts\fR scripts
 130 which check their value, as described in their respective manpages and
 131 in \fBdevscripts.conf\fR(5).
 132 .SH "SEE ALSO"
 133 .BR dupload (1),
 134 .BR dput (1)
 135 and
 136 .BR devscripts.conf (5).
 137 .SH AUTHOR
 138 Julian Gilbey <jdg@debian.org>, based on the original \fBrelease\fR
 139 script by Christoph Lameter <clameter@debian.org>.