man/deb-origin.pod

   1 # dpkg manual page - deb-origin(5)
   2 #
   3 # Copyright © 2011 Matt Kraai <kraai@ftbfs.org>
   4 # Copyright © 2011 Guillem Jover <guillem@debian.org>
   5 #
   6 # This is free software; you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation; either version 2 of the License, or
   9 # (at your option) any later version.
  10 #
  11 # This is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 # GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
  18
  19 =encoding utf8
  20
  21 =head1 NAME
  22
  23 deb-origin - Vendor-specific information files
  24
  25 =head1 SYNOPSIS
  26
  27 B<%PKGCONFDIR%/origins/>I<filename>
  28
  29 =head1 DESCRIPTION
  30
  31 The files in B<%PKGCONFDIR%/origins> can provide information about
  32 various vendors who are providing Debian packages.
  33
  34 They contain a number of fields, or comments when the line starts with
  35 ‘B<#>’.
  36 Each field begins with a tag, such as B<Vendor> or B<Parent>,
  37 followed by a colon and the body of the field. Fields are delimited
  38 only by field tags. In other words, field text may be multiple lines
  39 in length, but the tools will join lines when processing the body of
  40 the field.
  41
  42 The file should be named according to the vendor name.
  43 The usual convention is to name the vendor file using the vendor name
  44 in all lowercase, but some variation is permitted.
  45
  46 Namely (since dpkg 1.21.10), first, non-alphanumeric characters
  47 (‘B<[^A-Za-z0-9]>’) are mapped to dashes (‘B<->’), then the resulting
  48 name will be tried in sequence by lower-casing it, keeping it as is,
  49 lower-casing then capitalizing it (that is upper-casing the first character),
  50 and only capitalizing it.
  51
  52 In addition, for historical and backwards compatibility, the name will
  53 be tried keeping it as is without non-alphanumeric characters remapping,
  54 then the resulting name will be tried in sequence by lower-casing it,
  55 keeping it as is, lower-casing then capitalizing it, and only capitalizing it.
  56 And finally the name will be tried by remapping spaces to dashes (‘B<->’),
  57 then the resulting name will be tried in sequence by lower-casing it,
  58 keeping it as is, lower-casing then capitalizing it, and only capitalizing it.
  59
  60 But these backwards compatible module lookups will be removed during the
  61 dpkg 1.22.x release cycle.
  62
  63 =head1 FIELDS
  64
  65 =over
  66
  67 =item B<Vendor:> I<vendor-name> (required)
  68
  69 The value of this field determines the vendor name.
  70
  71 =item B<Vendor-URL:> I<vendor-url>
  72
  73 The value of this field determines the vendor URL.
  74
  75 =item B<Bugs:> I<bug-url>
  76
  77 The value of this field determines the type and address of the bug
  78 tracking system used by this vendor. It can be a mailto URL or a
  79 debbugs URL (e.g., debbugs://bugs.debian.org/).
  80
  81 =item B<Parent:> I<vendor-name>
  82
  83 The value of this field determines the vendor name of the vendor that
  84 this vendor derives from.
  85
  86 =back
  87
  88 =head1 EXAMPLE
  89
  90  Vendor: Debian
  91  Vendor-URL: https://www.debian.org/
  92  Bugs: debbugs://bugs.debian.org
  93
  94 =head1 SEE ALSO
  95
  96 B<dpkg-vendor>(1)