dput.cf.5

   1 .TH dput.cf 5 "2001-04-08"
   2 .SH NAME
   3 .B dput.cf
   4 \- Debian package upload tool configuration file
   5
   6 .SH DESCRIPTION
   7 This manpage gives a brief overview of dput's configuration file and the
   8 available options in it.
   9 \fBdput\fP is a tool to upload Debian packages to the archive.
  10 .PP
  11
  12 .SH FORMAT
  13 dput.cf consists of different groups of configuration options, one for each
  14 host where you want to be able to upload packages. Hosts are defined using an
  15 identifier header with a short name for the host, enclosed in square brackets.
  16 Note that only if multiple such headers are encountered in the
  17 configuration, only the group following the last header is considered. This
  18 is done to avoid confusion when overriding a global configuration file with
  19 a user-specific one.
  20 There's a special identifier, [DEFAULT], which holds default parameters for
  21 all the hosts. The defaults can be overridden by redefining them again in
  22 each host section. The available parameters are listed below:
  23 .TP
  24 .B fqdn
  25 This is the fully qualified domain name that will be used (can be specified
  26 as host:port for HTTP, HTTPS and FTP).
  27 .TP
  28 .B login
  29 Your login on the machine named before. A single asterisk \fB*\fR will
  30 cause the scp and rsync uploaders to not use supply a login name when
  31 calling to ssh, scp, and rsync.
  32 .TP
  33 .B incoming
  34 The directory that you should upload the files to.
  35 .TP
  36 .B method
  37 The method that you want to use for uploading the files.
  38 Currently, dput accepts the following values for \fBmethod\fR:
  39 .RS
  40 .TP
  41 .I ftp
  42 the package will be uploaded via ftp, either anonymously or using a
  43 login/password. Note that ftp is unencrypted so you should not use
  44 password authentication with this.
  45 .TP
  46 \fIhttp\fR and \fIhttps\fR
  47 the package will be uploaded via http or https using the PUT method
  48 as specified in WebDAV. The upload method will prompt for a password
  49 if necessary.
  50 .TP
  51 .I scp
  52 the package will be uploaded using ssh's scp. This transfers files using a
  53 secure ssh tunnel, and needs an account on the upload machine.
  54 .TP
  55 .I rsync
  56 the package will be uploaded using rsync over ssh. This is similar to scp,
  57 but can save some bandwidth if the destination file already exists on the
  58 upload server. It also needs a login on the remote machine as it uses ssh.
  59 .TP
  60 .I local
  61 the package will be "uploaded" locally using /usr/bin/install.  This
  62 transfers files to a local incoming directory, and needs appropriate
  63 permissions set on that directory.
  64 .RE
  65 .TP
  66 .B hash
  67 The hash algorithm that should be used in calculating the checksum of
  68 the files before uploading them. Currently, dput accepts the following values
  69 for \fBhash\fR:
  70 .RS
  71 .TP
  72 .I md5
  73 use the md5 algorithm for calculation
  74 .TP
  75 .I sha
  76 use the sha algorithm for calculation
  77 .RE
  78 .TP
  79 .B allow_unsigned_uploads
  80 This defines if you are allowed to upload files without a GnuPG
  81 signature to this host or not.
  82 .TP
  83 .B allow_dcut
  84 This defines if you are allowed to upload a dcut changes file to the
  85 queue to remove or move files.
  86 .TP
  87 .B distributions
  88 This defines a comma-separated list of distributions that this host accepts,
  89 used to guess the host to use when none is given on the command line.
  90 .TP
  91 .B allowed_distributions
  92 A regular expression (of Python \fBre\fR module syntax) that the
  93 distribution field must match or dput will refuse the upload.
  94 .TP
  95 .B delayed
  96 Set a numeric default parameter for delayed uploads (i.e. uploads to this
  97 queue will be delayed the specified number of days. Defaults to the
  98 empty string, meaning no delay. This only works with upload queues
  99 that support delayed uploads.
 100 .TP
 101 .B run_lintian
 102 This option defines if lintian should be run before the package will
 103 be uploaded or not. If the package is not lintian clean, the upload will
 104 not happen.
 105 .TP
 106 .B run_dinstall
 107 This options defines if dinstall \-n should be run after the package has
 108 been uploaded or not. This is an easy way to test if your package would be
 109 installed into the archive or not.
 110 .TP
 111 .B check_version
 112 This option defines if dput should check if the user has installed the package
 113 in his system for testing it before putting it into the archive. If the
 114 user has not installed and tested it, dput will reject the upload.
 115 .TP
 116 .B passive_ftp
 117 This option defines if dput should use passive ftp or active ftp for uploading
 118 a package to one of the upload queues. By default, dput uses passive ftp
 119 connections. If you need to use active ftp connections, set
 120 passive_ftp to 0.
 121 .TP
 122 .B progress_indicator
 123 This integer option defines if dput should display a progress indicator for
 124 the upload. (Currently implemented in ftp only.)
 125 .br
 126 Supported values: 0 (default) \- no progress, 1 \- rotating progress
 127 indicator, and 2 \- kilobyte counter.
 128 .TP
 129 .B scp_compress
 130 This option defines if the scp upload to the host will be compressed, or not.
 131 This option is only used for the 'scp' upload method, and has been found to
 132 decrease upload time for slow links, and increase upload times for faster
 133 links.
 134 .TP
 135 .B ssh_config_options
 136 The arguments of this config options should be ssh config file options in
 137 the style documented in \&\fBssh_config\fR\|(5). They will be passed to all
 138 automatic invocations of \fIssh\fR and \fIscp\fR by dput. Note that you can
 139 define multiline (dput) configuration options by indenting the second
 140 line with whitespace (i.e. similar to RFC822 header continuations).
 141 .TP
 142 .B post_upload_command
 143 This option defines a command to be run by dput after a successful upload.
 144 .TP
 145 .B pre_upload_command
 146 This option defines a command to be run by dput before a upload happens.
 147 .TP
 148 .B default_host_main
 149 This defines the default host for packages that are allowed to be uploaded
 150 to the main archive. This variable is used when guessing the host to upload to.
 151
 152 .SH BUGS
 153 .P
 154 Please send bug reports to the author.
 155
 156 .SH FILES
 157 .TP
 158 .I /etc/dput.cf
 159 global dput configuration file
 160 .TP
 161 .I ~/.dput.cf
 162 per user dput configuration file
 163
 164 .SH AUTHOR
 165 Christian Kurz. Updated by Thomas Viehmann <\fBtv@beamnet.de\fR>.
 166
 167 Many other people have contributed to this code. See the
 168 Thanks file.
 169
 170 .SH SEE ALSO
 171 .PD 0
 172 .TP
 173 \&\fBdput\fR\|(1)
 174 .TP
 175 \fI/usr/share/doc/dput\fP
 176
 177 .SH COMMENTS
 178 The author appreciates comments and suggestions from you, if any.
 179
 180 .\" Local variables:
 181 .\" mode: nroff
 182 .\" coding: utf-8
 183 .\" End:
 184 .\" vim: fileencoding=utf-8 filetype=nroff :