man/dpkg-name.pod

   1 # dpkg manual page - dpkg-name(1)
   2 #
   3 # Copyright © 1995-1996 Erick Branderhorst
   4 # Copyright © 2007-2013, 2015 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 dpkg-name - rename Debian packages to full package names
  24
  25 =head1 SYNOPSIS
  26
  27 B<dpkg-name>
  28 [I<option>...]
  29 [B<-->]
  30 I<file>...
  31
  32 =head1 DESCRIPTION
  33
  34 This manual page documents the
  35 B<dpkg-name>
  36 program which provides an easy way to rename
  37 B<Debian>
  38 packages into their full package names.
  39 A full package name consists of
  40 I<package>B<_>I<version>B<_>I<architecture>B<.>I<package-type>
  41 as specified in the control file of the package.
  42 The I<version> part
  43 of the filename
  44 consists of the upstream version information optionally followed by a
  45 hyphen and the revision information.
  46 The I<package-type> part comes
  47 from that field if present or will fall back to B<deb>.
  48
  49 =head1 OPTIONS
  50
  51 =over
  52
  53 =item B<-a>, B<--no-architecture>
  54
  55 The destination filename will not have the architecture information.
  56
  57 =item B<-k>, B<--symlink>
  58
  59 Create a symlink, instead of moving.
  60
  61 =item B<-o>, B<--overwrite>
  62
  63 Existing files will be overwritten if they have the same name as the
  64 destination filename.
  65
  66 =item B<-s>, B<--subdir> [I<dir>]
  67
  68 Files will be moved into a subdirectory.
  69 If the directory given as argument exists
  70 the files will be moved into that directory otherwise the name of
  71 the target directory is extracted from the section field in the
  72 control part of the package.
  73 The target directory will be
  74 «unstable/binary-I<architecture>/I<section>».
  75 If the section is not found in the control, then B<no-section> is assumed,
  76 and in this case, as well as for sections B<non-free> and B<contrib>
  77 the target directory is «I<section>/binary-I<architecture>».
  78 The section field is not required so a lot of packages will find their way
  79 to the B<no-section> area.
  80
  81 B<Warning>: Use this option with care, it is messy.
  82
  83 =item B<-c>, B<--create-dir>
  84
  85 This option can used together with the B<-s> option.
  86 If a target
  87 directory isn't found it will be created automatically.
  88
  89 B<Warning>: Use this option with care.
  90
  91 =item B<-?>, B<--help>
  92
  93 Show the usage message and exit.
  94
  95 =item B<-v>, B<--version>
  96
  97 Show the version and exit.
  98
  99 =back
 100
 101 =head1 ENVIRONMENT
 102
 103 =over
 104
 105 =item B<DEB_HOST_ARCH>
 106
 107 Sets the host architecture.
 108 This affects the architecture name used in the package filename.
 109
 110 =item B<DPKG_COLORS>
 111
 112 Sets the color mode (since dpkg 1.18.5).
 113 The currently accepted values are: B<auto> (default), B<always> and
 114 B<never>.
 115
 116 =item B<DPKG_NLS>
 117
 118 If set, it will be used to decide whether to activate Native Language Support,
 119 also known as internationalization (or i18n) support (since dpkg 1.19.0).
 120 The accepted values are: B<0> and B<1> (default).
 121
 122 =back
 123
 124 =head1 BUGS
 125
 126 Some packages don't follow the name structure
 127 I<package>B<_>I<version>B<_>I<architecture>B<.deb>.
 128 Packages renamed by B<dpkg-name>
 129 will follow this structure.
 130 Generally this will have no impact on how
 131 packages are installed by
 132 L<dselect(1)>/L<dpkg(1)>,
 133 but other installation tools
 134 might depend on this naming structure.
 135
 136 =head1 EXAMPLES
 137
 138 =over
 139
 140 =item B<dpkg-name bar-foo.deb>
 141
 142 The file B<bar-foo.deb> will be renamed to bar-foo_1.0-2_i386.deb or
 143 something similar (depending on whatever information is in the control
 144 part of B<bar-foo.deb>).
 145
 146 =item B<find /root/debian/ -name '*.deb' | xargs -n 1 dpkg-name -a>
 147
 148 All files with the extension B<deb> in the directory /root/debian and its
 149 subdirectory's will be renamed by B<dpkg-name> if required into names
 150 with no architecture information.
 151
 152 =item B<find -name '*.deb' | xargs -n 1 dpkg-name -a -o -s -c>
 153
 154 B<Don't do this.>
 155 Your archive will be messed up completely because a lot of packages
 156 don't come with section information.
 157 B<Don't do this.>
 158
 159 =item B<dpkg-deb --build debian-tmp && dpkg-name -o -s .. debian-tmp.deb>
 160
 161 This can be used when building new packages.
 162
 163 =back
 164
 165 =head1 SEE ALSO
 166
 167 L<deb(5)>,
 168 L<deb-control(5)>,
 169 L<dpkg(1)>,
 170 L<dpkg-deb(1)>,
 171 L<find(1)>,
 172 L<xargs(1)>.