Docs/packaging-howto

   1 $Id$
   2
   3 The gnokii Packaging HOWTO
   4
   5
   6 PURPOSE
   7
   8 Read this document if you want to build gnokii binary packages for your
   9 system or repackage gnokii for a system that is not yet supported.
  10
  11
  12 GENERAL POLICY
  13
  14 For more install/compilation information see the INSTALL file.
  15
  16 Makefiles support 'make install prefix=<your_directory>' for package
  17 building.  For example, in .spec:
  18
  19         ./configure --prefix=/usr
  20
  21         make install prefix=$RPM_BUILD_ROOT/usr
  22
  23 (You do not need to create any directories - just 'make && make install'.)
  24
  25 For installation procedures use 'make install' or 'make install prefix=',
  26 and verify that all outputs from the procedure are correct.
  27
  28 Please, DO NOT make any corrections using your package-specific build
  29 system (for example, using 'cp' in packaging scripts like .spec).
  30 Installation is a job for Makefiles.  Writing different installation
  31 procedures for different packaging systems is the road to hell...
  32
  33 The only exception to the above rule is documentation.  'make install'
  34 does not install documentation - one should use each distributions'
  35 packaging routines for this job.  If you want to install docs via a
  36 Makefile use 'make install-docs'.
  37
  38
  39 SYSTEM-SPECIFIC INFORMATION
  40
  41 Debian:
  42
  43 1) Add new lines to Debian/changelog and set the correct version number
  44 in this file.
  45
  46 2) Check the following files:
  47
  48         rules, menu, docs, *.manpages
  49
  50 3) Since gnokii's debian directory is in the subdirectory 'packaging'
  51 which is totally non-standard for the Debian package building system,
  52 you must first 'cd' to the top gnokii directory and type:
  53
  54         ln -s packaging/Debian debian
  55
  56 4) In the top gnokii directory type:
  57
  58         fakeroot debian/rules binary
  59
  60 5) And then clean up:
  61
  62         fakeroot debian/rules clean
  63
  64         rm debian
  65
  66 The .deb packages will appear in the directory ABOVE the top gnokii
  67 directory.
  68
  69 Alternatively, if you want to build everything including sources (.tar.gz,
  70 .dsc, and .changes files), go to the top gnokii directory and type:
  71
  72         dpkg-buildpackage -rfakeroot
  73
  74 instead of invoking "debian/rules binary" directly.  Note that you will
  75 need the fakeroot package installed, but are there any Debian developers
  76 that don't have that one installed?  Nope.  If you want to sign the
  77 packages with your own PGP key, you will need to make a new first entry
  78 in the Debian changelog.
  79
  80
  81 RedHat:
  82
  83 Just type:
  84
  85         rpm -ta gnokii-$VERSION.tar.gz
  86
  87 where $VERSION is the version of the gnokii distribution that you are
  88 packaging.
  89
  90
  91 Slackware:
  92
  93 1) Create a gnokii directory and put the gnokii tarball there:
  94
  95         mkdir gnokii
  96
  97         cp gnokii-X.Y.Z.tar.gz gnokii
  98
  99 2) Extract SlackBuild from the tarball and copy it into the gnokii
 100 directory, eg.:
 101
 102         tar xzf gnokii-X.Y.Z.tar.gz
 103
 104         cp gnokii-X.Y.Z/packaging/Slackware/SlackBuild gnokii
 105
 106 3) Run SlackBuild:
 107
 108         cd gnokii
 109
 110         chmod 755 ./SlackBuild ; ./SlackBuild
 111
 112 4) A Slackware package is now located in /tmp/gnokii.tgz.
 113
 114
 115 FreeBSD:
 116
 117
 118 Win32:
 119
 120
 121 DOCUMENT HISTORY
 122
 123 2001-06-18
 124
 125 Erik Rossen <rossen@freesurf.ch>
 126
 127 * fixing Debian notes to mention 'fakeroot' and 'dpkg-buildpackage'
 128
 129 2001-04-20
 130
 131 Erik Rossen <rossen@freesurf.ch>
 132
 133 * fixing English grammar and spelling errors, but no change of information
 134
 135 * changing to a flatter format for easier editing: sections separated
 136 by double spacing and only system commands indented with a tab
 137
 138 * file is always treated with GNU 'fmt' with no options
 139
 140 Pawel Kot <pkot@linuxnews.pl>
 141
 142 * Slackware build instructions added