From Fedora Project Wiki
(Replace with a deprecation notice and a link to docs.fp.o)
Tag: Replaced
 
(18 intermediate revisions by 11 users not shown)
Line 1: Line 1:
{{autolang|base=yes}}
{{autolang|base=yes}}
{{DISPLAYTITLE:Creating RPM Packages with Fedora}}


{{admon/note|This document is under construction to better conform to the packaging guidelines and to use {{package|fedpkg}} instead of rpmbuild throughout.  We apologize for any conflicting or confusing information while these changes are underway.}}
{{admon/important|deprecated|As part of documentation move to docs.fp.o, this page has moved to https://docs.fedoraproject.org/en-US/quick-docs/creating-rpm-packages}}
 
<div style="float: right; margin-left: 0.5em;" class="toclimit-2">__TOC__</div>
 
== Introduction ==
 
This page describes in detail how to create an RPM package, and in particular how to create a specfile. Unlike other RPM guides, this page explains the specifics for Fedora with links to Fedora-specific guidelines and usage of Fedora-specific utilities. Despite the focus on Fedora, much of this document does apply to other RPM-based distributions.
 
Currently Fedora Documentation has released a draft guide for packagers, see [http://docs.fedoraproject.org/en-US/Fedora_Draft_Documentation/0.1/html/Packagers_Guide Packagers Guide].
 
Please note that this document is merely a gentle introduction and will leave out many of the details which you may need in order to package more complicated software.  It also assumes that you have familiarity with the shell and are familiar with the process of building and installing (outside of RPM) the software you wish to package.  Finally, this document is '''NOT''' an official Fedora packaging guideline.  This page is open for editing by the general Fedora packaging community, while the actual packaging guidelines are managed by the [[Packaging:Committee|Packaging Committee]]. For reference, here are some of the most referenced guideline pages:
 
* [[Packaging:Guidelines|Packaging Guidelines]]
* [[Packaging:LicensingGuidelines |Licensing Guidelines]]
* [[Packaging:Naming| Package Naming Guidelines]]
* [[Packaging:DistTag| Dist Tag Guidelines]]
* [[Packaging:ReviewGuidelines| Package Review Guidelines]]
* [[Packaging:Scriptlets| Recipes for RPM scriptlets]]
 
[[Packaging:Guidelines]] and [[Packaging:Naming]] contain the main guidelines.  Having said that, this page should be compatible with them, though the guidelines do change over time and this page may diverge from them on occasion.
 
If you plan to submit a package to the official Fedora repository, you will also want to follow the procedure depicted in [[Join the package collection maintainers]].
 
=== Some terminology ===
 
; RPM
: The package manager used by Fedora, Red Hat Enterprise Linux, Mageia, OpenSUSE and others.  Originally RPM stood for "Red Hat Package Manager" but now it's just the recursive acronym "RPM Package Manager".
 
; specfile
: A plain text file containing information about a package and instructions used by RPM for actually compiling the included software.  It is named by appending <code>.spec</code> to the name of the package.
 
; tag
: A string, generally capitalized and followed by a colon, which appears at the top of the specfile to provide some important data about the RPM, such as <code>Name:</code>, <code>Version:</code> or <code>Summary:</code>.
 
; section
: A segment of the specfile which tells RPM how to perform some portion of the package construction process.  Many, but not all, sections contain code that is simply passed to the shell, though RPM has significant flexibility around this which will not be covered at all in this document.
 
; section header
: A short string, starting with <code>%</code> at the beginning of a line, which introduces a section.  Examples include <code>%description</code>, <code>%prep</code> and <code>%files</code>.
 
; macro
: A short string, always prefixed by <code>%</code> and generally surrounded by curly brackets (<code>{}</code>) which RPM will convert to a different and usually longer string.  Some macros can take arguments and some can be quite complex.  Some macros are provided by RPM, some are part of {{package|redhat-rpm-config}} and {{package|fedora-rpm-macros}}, but many other packages also provide them.  If you're curious, running <code>rpm --showrc</code> will show you all of the macros currently available on your system, but note that you really don't want to use most of the ones you see there.  Note that some macros have named prefixed by underscores; the reasons for this are mostly lost to time.
: The packaging guidelines have various [[Packaging:Guidelines#Macros|suggestions and restrictions]] regarding the use of various sets of macros.  This document will use what the guidelines recommend, but won't necessarily explain the reasons in detail.
: You may, in looking at other packages, see macros used without curly brackets.  There are situations where this isn't strictly necessary, but these guidelines will use them wherever possible to make it more obvious when macros are being used and to avoid going into the rules about when the brackets are needed and when they aren't.
 
; mock
: A system for building RPMs within their own separate small Fedora installation.  This avoids the need to have a full set of build dependencies installed into your regular operating system installation, allows you to build packages for different Fedora releases, and in general is a good thing.
 
; koji
: The main Fedora build system: [https://koji.fedoraproject.org].
 
== Editors for editing RPM spec files ==
Many editors (like text editors and IDEs) that are in the official repositories of Fedora have out-of-the-box syntax-highlighting support for RPM spec files, these include:
 
* [[CodeEditor]]. It does not syntax-highlight the shell script code found in RPM spec files.
* [[gedit]]. It does not syntax-highlight the shell script code found in RPM spec files.
* [[GNU nano]]. It does not syntax-highlight the shell script code found in RPM spec files.
* [[Joe]]. It does not syntax-highlight the shell script code found in RPM spec files.
* [[Kate]]. It does not syntax-highlight the shell script code found in RPM spec files.
* [[KWrite]]. It does not syntax-highlight the shell script code found in RPM spec files.
* [[Pluma]]. It does not syntax-highlight the shell script code found in RPM spec files.
* [[Vim]] (and, of course, its graphical counterpart, gVim). It also syntax-highlights the shell script code found in RPM spec files.
 
while the following are present in the official Fedora repositories but do not come with out-of-the-box syntax-highlighting for RPM Spec files, but do gain said support when optional packages/plugins are installed:
 
* [[Eclipse]] can develop RPM spec file editing support when the [https://apps.fedoraproject.org/packages/eclipse-rpm-editor RPM Spec file editor] package is also installed. This package also provides code linting (checking for RPM packaging errors) and make it easier to navigate the spec file.
* [[GNU Emacs]] has editing support for RPM spec files when the [https://apps.fedoraproject.org/packages/emacs-rpm-spec-mode RPM spec mode] package is installed.
 
Editors that are not in the official repositories of Fedora but are available for Fedora and, with the appropriate plugins, can syntax-highlight RPM spec files include:
 
* [[Atom]], with the [https://atom.io/packages/language-rpm-spec language-rpm-spec] package.
* [[Visual Studio Code]], with the [https://marketplace.visualstudio.com/items?itemName=1dot75cm.RPMSpec RPM Spec] extension.
 
== Preparing your system ==
 
Before you create RPM packages on Fedora, you need to install some packaging tools and set up the account(s) you will use.  Run this as root:
dnf install fedora-packager fedora-review
 
This will install the {{package|fedora-packager}} utilities needed to work with and build packages in the same manner used to maintain official Fedora packages, including the {{package|fedora-review}} tool used by package reviewers to check package quality.
 
{{admon/caution|You should never create your packages as the <code>root</code> user. Indeed, you should never perform anything other than specific administration tasks as root.  Building RPMs as root is dangerous because it is possible for situations to exist (due to mistakes or typos in the spec file) for some package building operations to attempt to write files to system locations.  You must always build as a normal user to avoid corrupting parts of your system.  This document will generally use the {{package|mock}} system to build more complicated packages in a very safe manner.}}
 
As root, add yourself to the mock group:
usermod -a -G mock yourusername
This should be the last time you need root unless you wish to install packages you have developed.
 
You may afterwards need to run <code>newgrp</code> or log out and back in for this change to take effect.  Run the <code>id</code> command to see if the "mock" group appears in your group list.
 
If you have already obtained a Fedora account and accepted the contributor agreement, you can also set up your fedora certificates and such.  Just run (as your user, not as root):
fedora-packager-setup
 
If you wish, you can also create a separate user and use it for doing RPM development.  You should make sure that user is part of the "mock" group and has run <code>fedora-packager-setup</code>.
 
== First steps ==
 
To create an RPM package, you will need to create a directory to hold the package and, within that directory, the specfile.  This file provides information about the software being packaged, instructions for unpacking it, building it and installing it, as well as a list of files which will be included in the package.  You then run the <code>fedpkg</code> command with appropriate options, which will go through a series of steps to produce your package.
 
The construction of the specfile is often done iteratively (one relevant piece at a time), and that's what we'll do here.  But first we'll need someplace to make our package as well as something to package.  Run the following to create a directory to hold packaging work (called <code>packaging-work</code>), within it a place to hold our package (called "<code>howdy</code>), and within that a simple program to package (also called "<code>howdy</code>).  You can use any location you like but the directory name for the package should match the name of the package.
 
mkdir -p ~/packaging-work/howdy
cd ~/packaging-work/howdy
cat << EOF > howdy
#!/bin/bash
echo "Howdy, pardner!"
EOF
chmod 644 howdy
 
You should be able to run <code>bash howdy</code> and receive the expected output.  Now we have something we can package, so let's start making a specfile.  We'll start with a very minimal template (which will have to be expanded for anything more complicated than this example).  Just start your editor on a new file called <code>howdy.spec</code>" and paste this in.  Please use spaces and not tabs.  It's not necessary to have everything like up but it does make it look nice.
 
<pre>
Name:    howdy
Version: 1
Release: 1%{?dist}
Summary: Say hello, Texas style
 
License: Public Domain
Source0: howdy
 
%description
A simple program to greet the user, Texas style.
 
%install
 
%files
 
%changelog
</pre>
 
So we've described the package, indicated a version and listed the one source file we have.  We have an <code>%install</code> and a <code>%files</code> section, both of which are empty.  Save your edits and run
fedpkg --dist f{{FedoraVersionNumber|current}} local
This is called a "local build".  Assuming no typos or other issues, you should get some output and two RPM files.  One should be the source package, which contains everything necessary for someone else (or the Fedora build system) to build their own copy of your package.  The other is a binary package.  It doesn't actually have anything in it at this point, though, because we didn't tell RPM to actually include any files.  (It would not even have been created if we hadn't included the empty <code>%files</code> section.)
 
If you like, you can look at either package using <code>rpm -qip</code>, or just <code>less</code>.
 
== A useful package ==
So now we have a minimally functional specfile which builds and produces a rather useless binary package.
 
In order to actually make a package which does something, we must tell RPM how to install the program.  Edit the specfile and add this to the <code>%install</code> section (immediately after the line containing <code>%install</code>):
mkdir -p %{buildroot}/%{_bindir}
install -p -m 755 %{SOURCE0} %{buildroot}/%{_bindir}
The contents of the <code>%install</code> section is just a shell script!  Note that we've used three macros:
* <code>%{buildroot}</code> is set to a temporary directory called "the buildroot" that's set up by RPM to hold the complete tree of files we'll install.
* <code>%{_bindir}</code> is just /usr/bin.
* <code>%{SOURCE0}</code> refers to the file listed earlier in the spec with the <code>Source0:</code> tag.
 
This saves us from having to care about exactly where those files and directories are located on the filesystem while the package is built; instead we only care about where those files are ending up.  And without <code>%{buildroot}</code> we'd end up installing those files directly onto our development machine, which would be bad, especially if running as root.
 
Now do a local build.  It failed!  But why?  Well, because of this:
error: Installed (but unpackaged) file(s) found:
    /usr/bin/howdy
We installed a file but didn't tell RPM about it.  RPM maybe could just include everything we install, but there are plenty of good reasons why it doesn't just do that.  So tell RPM about that file, by adding this to the <code>%files</code> section:
%{_bindir}/howdy
Note that <code>%files</code> is generally about files we've actually installed into the buildroot.  You do not use the <code>%{buildroot}</code> macro when listing files there.
 
Now do another local build.  If all goes well, you should have two updated RPMs, and the binary one should contain a file.  But there's one more thing we should add to the spec to make this a complete package.  Since all we're packaging is a shell script, there is no reason at all for this to be built separately on each architecture Fedora supports.  So edit the spec once more and add the following immediately after the <code>Source0:</code> line:
BuildArch: noarch
This tells RPM that there's nothing architecture-specific about a particular package.  You can reindent the spec if you like to make things line up, but please use spaces and not tabs.  Delete the existing <code>.rpm</code> files in this directory and do another local build.  Now you should have a pair of rpms: one with the updated source, and one ending in <code>.noarch.rpm</code> indicating an architecture-independent package.  You should now have your first complete package that you built yourself!  If you like, install it and try it out.  You'll probably want to remove it once you're done, unless you just like Texas-style greetings.
 
== Further things to do with our package ==
Have a glance at our current spec if you like.
<pre class="mw-collapsible mw-collapsed">
Name:      howdy
Version:  1
Release:  1%{?dist}
Summary:  Say hello, Texas style
 
License:  Public Domain
Source0:  howdy
BuildArch: noarch
 
%description
A simple program to greet the user, Texas style.
 
%install
mkdir -p %{buildroot}/%{_bindir}
install -p -m 755 %{SOURCE0} %{buildroot}/%{_bindir}
 
%files
%{_bindir}/howdy
 
%changelog
</pre>
 
You may recall that RPM handles dependencies, but we didn't indicate anything about that in the specfile.  Let's look.
  rpm -qp --requires howdy-1-1.fc{{FedoraVersionNumber|current}}.noarch.rpm
You'll see that RPM added some internal <code>rpmlib</code> dependencies, plus one on <code>/bin/bash</code> which matches up with the first line of the howdy program.  Often RPM will handle dependencies for your binary packages automatically.  Often times it won't, and we'll look into that later.
 
You can also replace <code>--requires</code> by <code>--provides</code> to see the other side of the dependency equation.  There's not much of interest there, but if something did depend on <code>howdy</code> then this package would provide it.
 
Next thing to do is run some checks on our package:
  fedpkg --dist f{{FedoraVersionNumber|current}} lint
This will spit out a few complaints.  Four total about the lack of <code>%prep</code> and <code>%build</code> sections, one about the lack of a <code>URL:</code> tag, and one about the lack of a proper changelog.  You may also see other complaints, perhaps about permissions.  The full set of complaints may change over time as the checking program, {{package|rpmlint}} itself changes.  You may even have noticed these complaints earlier if your editor was configured to automatically check specfiles as you edit them.
 
We will ignore the complaints about the lack of the two sections and a URL.  We could make the complaints go away by adding empty sections and a dummy URL, but that's not productive and our next experiment will have them.
 
It would indeed be nice to have a changelog section, though.  Your editor may have the capability to add one automatically; in {{package|vim}} it's {{key press|\}}{{key press|c}} (unless you've changed the leader key) and in {{package|emacs}} it's {{key press|Ctrl|c}} {{key press|Ctrl|e}}.  If you want to do it manually, have a look at the relevant [[Packaging:Guidelines#Changelogs|guidelines]].  I'll add mine here:
* Mon Sep 19 2016 Jason L Tibbitts III <tibbs@math.uh.edu> - 1-1
- Initial packaging.
 
=== Building in mock ===
The next interesting thing to do would be to see if our package will build in the way that the Fedora build system would do it.  To do this, just run:
fedpkg --dist f{{FedoraVersionNumber|current}} mockbuild
This will build your package in {{package|mock}}.  Running mock will set up a complete minimal Fedora installation inside a directory and then build the package within that.
 
{{admon/note|Please note that this can take a while.  It has to download a number of packages and can take quite some time if you do not have a fast link.  It will also take a nontrivial amount of disk space.  Fortunately the data it downloads will be cached so subsequent runs will be quicker, but if the disk usage (by default in <code>/var</code>), the time or the bandwidth usage are an issue for you, you can skip this step.  However, from this point on in the document, we will do mock builds rather than local builds, and later steps will require that mock builds be carried out.  You can continue to perform local builds where possible if you prefer, but eventually you will run into dependency issues that mockbuilds do not have.}}
 
The end result should be a significant amount of output, a results_howdy directory, and a couple of levels deep a three log files and two packages.  Feel free to look at those.
 
You can also build for other releases in this manner, by changing what you pass to the <code>--dist</code> option.  This can be useful for testing, but it takes another big download so we'll skip that now.
 
=== Building in koji ===
If you had your Fedora account set up at the time you started following this document, you can build your package in the central Fedora build system, though the syntax can be a bit odd:
fedpkg --release f{{FedoraVersionNumber|current}} scratch-build --target f{{FedoraVersionNumber|current}} --srpm
This will create a source package, upload it to the build servers, and give you some output including a URL you can visit to watch the process and download the built packages afterwards.  This can be useful to test that your package builds on the various different architectures that Fedora supports, although your current test package doesn't need such testing.
 
=== Running fedora-review ===
Package reviewers use {{package|fedora-review}} as part of the process of accepting new packages into the distribution.  You can run this tool yourself as a useful set of informative checks.  First, clean up your package directory:
rm -rf *rpm results*
Then create a source package and run the utility:
fedpkg --release f{{FedoraVersionNumber|current}} srpm
fedora-review -n howdy
This will use mock to build your package and run a number of checks on it.  It will be silent while mock runs, so it may appear as if it has hung when in reality it is doing a large amount of downloading.  You can add <code>-v</code> to make it somewhat more verbose.
 
When done, you should have a <code>review-howdy</code> directory with various files and directories.  <code>rpmlint.txt</code> should have some additional rpmlint output for you.  <code>review.txt</code> is the template that a reviewer would fill in (in addition to checking the functionality of the software in your package, etc.)  Most of that is probably not of interest to you, but it doesn't hurt to have a look.
 
== On to a more complex program ==
Now that we've covered the absolute basics, we can move on to packaging something more complicated, which comes from a real upstream and has to be unpacked and built.  A good package to use as an example is [https://www.gnu.org/software/hello/ GNU Hello].  Have a look there, note the current version of Hello (2.10 as this document is being written) and the download URL, licensing information and such.  It's helpful to keep that page open for referenceLet's create a directory and work in it:
  mkdir -p ~/packaging-work/hello
  cd ~/packaging-work/hello
And create the following specfile named <code>hello.spec</code>:
<pre>
Name:    hello
Version: 2.10
Release: 1%{?dist}
Summary: GNU Hello
URL:    https://www.gnu.org/software/hello/
License: GPLv3+
 
Source0: https://ftp.gnu.org/gnu/hello/hello-%{version}.tar.gz
 
%description
The GNU hello program produces a familiar, friendly greeting. It allows
nonprogrammers to use a classic computer science tool which would otherwise be
unavailable to them. Because it is protected by the GNU General Public License,
users are free (in perpetuity) to share and change it.
 
%prep
 
%build
 
%install
 
%files
 
%changelog
</pre>
 
We've filled in a few things here.  There's now a <code>URL:</code> tag, pointing to the Hello homepage.  The <code>%description</code> was cribbed from the homepage.  The <code>License:</code> tag has changed, since the bottom of the homepage says that the license is "under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.".  Licensing is a difficult subject, and we'll cover it in more depth later, but for now it's sufficient to note that Fedora indicates this type of license with "GPLv3+".
 
Perhaps the most interesting change is to the <code>Source0:</code> tag.  It now has a URL instead of a filename: using a URL tells everyone, including the relevant Fedora utilities, where to actually get the source.  And there's a macro in there: <code>%{version}</code> is automatically set to whatever you used for the <code>Version:</code> tag.  Combining the two lets things automatically get an updated copy of the source whenever the version changes.  But how do we actually get that source, since now we can't cut and paste that URL?  Try <code>spectool</code>:
spectool -g *spec
This quickly grabs all of the sources mentioned in the spec, and will leave us with <code>hello-2.10.tar.gz</code> in our package directory.  Have a look with that file:
less *tar.gz
and we see that everything in there unpacks unto a single directory named <code>hello-2.10</code>.  We'll need to tell RPM how to unpack that archive and how to find the files within.  Add this to the <code>%prep</code> section:
%autosetup
This is a rather complicated macro which RPM will replace with plain old shell code to unpack the archive, change into a directory and fix up some permissions.  It by default expects the directory to be named <code>%{name}-%{version}</code> (where <code>%{name}</code> is, you guessed it, what you gave for the <code>Name:</code> tag).  This can be changed by passing the <code>-n</code> option, but in our case the default is just what we need.  You can see exactly what it does by executing the <code>%prep</code> section with:
fedpkg --release f{{FedoraVersionNumber|current}} prep
This will call just the <code>%prep</code> section of your specfile, and should leave you with a directory named <code>hello-2.10</code> in your package directory. Have a look around in there.  You'll see this is a standard GNU pacakage with a <code>configure</code> file, and that tells us most of what we need to know in order to build it.  Add this to the <code>%build</code> section:
%configure
%make_build
This just calls the <code>configure</code> file with all of the arguments necessary to build in Fedora, and then calls <code>make</code> with the necessary options.  And while we're at it, let's add this to <code>%install</code>:
%make_install
This calls the usual <code>make install</code> with Fedora's special macros to get everything into the buildroot. If you do a mockbuild at this point, you'll see that the build fails, just like with the previous package, there are installed but unpackaged files.  The of files in the error tells us what we need to do next, but because some there's an info page, a manpage and some some locale files, we have a few different rules to follow.
 
== Old document below ==
{{admon/note|Beyond this point are remnants of the old document.  These will all be incorporated or removed as the reorganization and cleanup continues.}}
 
If there are special programs that are required to build or run the program you are packaging, install those other programs and write down what they are.
 
To package a program for the Fedora repository, you must package pristine (original) sources, along with the patches and build instructions;
it's '''not''' okay to start with pre-compiled code. Install the file with the original source (usually a <code>.tar.gz</code> file) in the
<code>~/rpmbuild/SOURCES</code> directory (of the RPM building user account).
 
Read through the manual installation instructions for your program. It's often a good idea to do a "dry run" by manually building the program before attempting to do so via RPM. With a few exceptions, all binaries and libraries included in Fedora packages must be built from the source code that is included in the source package.
 
== Creating a SPEC file ==
 
You now need to create a SPEC file in the <code>~/rpmbuild/SPECS</code> directory. You should name it after the program name (e.g. "<code>program.spec</code>").  Use the archive name or the name advocated by the software author where you can, but be sure to follow the [[Packaging/NamingGuidelines|Package Naming Guidelines]].
 
=== SPEC templates and examples ===
==== Templates ====
 
You may use the <code>rpmdev-newspec</code> command to create a SPEC file for you.  <code>rpmdev-newspec &lt;package-name&gt;</code> can create an initial SPEC file for a new package, tailored to various types of packages.  It will guess what kind of template to use based on the package name, or you can specify a particular template. See <code>/etc/rpmdevtools/spectemplate-*.spec</code> for available templates, and see <code>rpmdev-newspec --help</code> for more information. For example, to create a new SPEC file for a python module:
 
cd ~/rpmbuild/SPECS
rpmdev-newspec python-antigravity
vim python-antigravity.spec
 
According to the [[Packaging:Guidelines#Writing_a_package_from_scratch|packaging guidelines]], new spec files should be created this way. Vim and emacs can automatically create simple templates, but these are different than those made with <code>rpmdev-newspec</code>. This is especially true for templates with names beginning with <code>python-</code> or <code>-perl</code>.
 
Here is an example auto-generated <code>.spec</code> template:
 
Name:          testprogram
Version:       
Release:        1%{?dist}
Summary:       
License:       
URL:           
Source0:       
BuildRequires: 
Requires:     
%description
%prep
%setup -q
%build
%configure
make %{?_smp_mflags}
%install
rm -rf $RPM_BUILD_ROOT
%make_install
%files
%doc
%changelog
* Sun Apr  3 2016 makerpm
-
 
You can use <code>%{buildroot}</code> instead of <code>$RPM_BUILD_ROOT</code>. Both are acceptable, but be consistent.
 
==== Examples ====
===== eject =====
Here's a simple example showing a Fedora specfile for the <code>eject</code> program:
 
<pre>
Summary:            A program that ejects removable media using software control
Name:              eject
Version:            2.1.5
Release:            21%{?dist}
License:            GPLv2+
Source:            %{name}-%{version}.tar.gz
Patch1:            eject-2.1.1-verbose.patch
Patch2:            eject-timeout.patch
Patch3:            eject-2.1.5-opendevice.patch
Patch4:            eject-2.1.5-spaces.patch
Patch5:            eject-2.1.5-lock.patch
Patch6:            eject-2.1.5-umount.patch
URL:                http://www.pobox.com/~tranter
ExcludeArch:        s390 s390x
BuildRequires:      gettext
BuildRequires:      libtool
 
%description
The eject program allows the user to eject removable media (typically
CD-ROMs, floppy disks or Iomega Jaz or Zip disks) using software
control. Eject can also control some multi-disk CD changers and even
some devices' auto-eject features.
 
Install eject if you'd like to eject removable media using software
control.
 
%prep
%autosetup -n %{name}
 
%build
%configure
%make_build
 
%install
%make_install
 
install -m 755 -d %{buildroot}/%{_sbindir}
ln -s ../bin/eject %{buildroot}/%{_sbindir}
 
%find_lang %{name}
 
%files -f %{name}.lang
%license COPYING
%doc README TODO ChangeLog
%{_bindir}/*
%{_sbindir}/*
%{_mandir}/man1/*
 
%changelog
* Tue Feb 08 2011 Fedora Release Engineering <rel-eng@lists.fedoraproject.org> - 2.1.5-21
- Rebuilt for https://fedoraproject.org/wiki/Fedora_15_Mass_Rebuild
 
* Fri Jul 02 2010 Kamil Dudka <kdudka@redhat.com> 2.1.5-20
- handle multi-partition devices with spaces in mount points properly (#608502)
</pre>
 
===== =====
{{Anchor|Spec_file_pieces_explained}}
 
== SPEC file overview ==
 
Other useful guides:
* [http://docs.fedoraproject.org/en-US/Fedora_Draft_Documentation/0.1/html/RPM_Guide/ch-creating-rpms.html RPM Guide] describes how to write a SPEC file.
* The IBM series "Packaging software with RPM" [http://www.ibm.com/developerworks/library/l-rpm1/ Part 1], [http://www.ibm.com/developerworks/library/l-rpm2/ Part 2], and [http://www.ibm.com/developerworks/library/l-rpm3/ Part 3].
* [http://rpm.org/max-rpm-snapshot/ Maximum RPM] has the most complete information, but is dated.
 
You will need to follow the Fedora guidelines: [[Packaging/NamingGuidelines|Package Naming Guidelines]], [[Packaging/Guidelines|Packaging guidelines]], and [[Packaging/ReviewGuidelines|Package review guidelines]].
 
Insert comments with a leading "<code>#</code>" character, and beware of macros (beginning with <code>%</code>) that are potentially multi-line, as they are expanded first. When commenting out a line, double the percent signs (<code>%%</code>) of the macros appearing after the "<code>#</code>". Also avoid inline comments on the same line as script commands.
 
The major tags are listed below. Note that the macros <code>%{name}</code>, <code>%{version}</code> and <code>%{release}</code> can be used to refer to the Name, Version and Release tags respectively. When you change the tag, the macros automatically update to use the new value.
* '''Name''': The (base) name of the package, which should match the SPEC file name.  It must follow the [[Packaging/NamingGuidelines|Package Naming Guidelines]] and generally be lowercase.
* '''Version''': The upstream version number. See [[Packaging/NamingGuidelines#Version_Tag|Version tag section]] of the packaging guidelines. If the version contains tags that are non-numeric (contains tags that are not numbers), you may need to include the additional non-numeric characters in the Release tag. If upstream uses full dates to distinguish versions, consider using version numbers of the form <code>yy.mm[dd]</code> (e.g. <code>2008-05-01</code> becomes <code>8.05</code>).
* '''Release''': The initial value should normally be <code>1%{?dist}</code>. Increment the number every time you release a new package for the same version of software. When a new upstream version is released, change the Version tag to match and reset the Release number to <code>1</code>. See [[Packaging/NamingGuidelines#Release_Tag|Release tag section]] of the packaging guidelines. The optional [[Packaging/DistTag|Dist tag]] might be useful.
* '''Summary''': A brief, one-line summary of the package. Use American English. '''Do NOT end in a period.'''
* '''Group''': This needs to be a pre-existing group, like "Applications/Engineering"; run "<code>less /usr/share/doc/rpm/GROUPS</code>" to see the complete list. Use the group "Documentation" for any sub-packages (e.g. <code>kernel-doc</code>) containing documentation.  '''''Note: This tag is deprecated since Fedora 17. See [https://docs.fedoraproject.org/en-US/Fedora_Draft_Documentation/0.1/html/Packagers_Guide/chap-Packagers_Guide-Spec_File_Reference-Preamble.html Spec File Reference Preamble] '''''
* '''License''': The license, which must be an open source software license. Do ''not'' use the old Copyright tag. Use a standard abbreviation (e.g. "<code>GPLv2+</code>") and be specific (e.g. use "<code>GPLv2+</code>" for GPL version 2 or greater instead of just "<code>GPL</code>" or "<code>GPLv2</code>" where it's true).  See [[Licensing]] and the [[Packaging/LicensingGuidelines|Licensing Guidelines]]. You can list multiple licenses by combining them with "<code>and</code>" and "<code>or</code>" (e.g. "<code>GPLv2 and BSD</code>").
* '''URL''': The full URL for more information about the program (e.g. the project website).  '''''Note: This is not where the original source code came from which is meant for the Source0 tag below'''''.
* '''Source0''': The full URL for the compressed archive containing the (original) pristine source code, as upstream released it. "<code>Source</code>" is synonymous with "<code>Source0</code>".  If you give a full URL (and you should), its basename will be used when looking in the <code>SOURCES</code> directory. If possible, embed <code>%{name}</code> and <code>%{version}</code>, so that changes to either will go to the right place. [[Packaging:Guidelines#Timestamps|Preserve timestamps]] when downloading source files. If there is more than one source, name them <code>Source1</code>, <code>Source2</code> and so on. If you're adding whole new files in addition to the pristine sources, list them as sources ''after'' the pristine sources. A copy of each of these sources will be included in any SRPM you create, unless you specifically direct otherwise.  See [[Packaging/SourceURL|Source URL]] for more information on special cases (e.g. revision control).
* '''Patch0''': The name of the first patch to apply to the source code.  If you need to patch the files after they've been uncompressed, you should edit the files and save their differences as a "patch" file in your <code>~/rpmbuild/SOURCES</code> directory. Patches should make only one logical change each, so it's quite possible to have multiple patch files.
* '''BuildArch''': If you're packaging files that are architecture-independent (e.g. shell scripts, data files), then add "<code>BuildArch: noarch</code>". The architecture for the binary RPM will then be "<code>noarch</code>".
* '''BuildRoot''': This is where files will be "installed" during the %install process (after the %build process). This is now redundant in Fedora and is only needed for EPEL5. By default, the build root is placed in "<code>%{_topdir}/BUILDROOT/</code>".
* '''BuildRequires''': A comma-separated list of packages required for building (compiling) the program. This field can be (and is commonly) repeated on multiple lines. These dependencies are ''not'' automatically determined, so you need to include ''everything'' needed to build the program. It is possible to ensure you have specified all necessary build requires by [[Using_Mock_to_test_package_builds|performing a "mock build"]] of your package. You can specify a minimum version if necessary (e.g. "<code>ocaml >= 3.08</code>"). If you need the file <code>/EGGS</code>, determine the package that owns it by running "<code>rpm -qf /EGGS</code>". If you need the program <code>EGGS</code>, determine the package that owns it by running "<code>rpm -qf `which EGGS`</code>". Keep dependencies to a minimum (e.g. use <code>sed</code> instead of <code>perl</code> if you don't really need perl's abilities), but beware that some applications permanently disable functions if the associated dependency is not present; in those cases you may need to include the additional packages. The {{package|auto-buildrequires}} package may be helpful.
* '''Requires''': A comma-separate list of packages that are required when the program is installed. Note that the BuildRequires tag lists what is required to build the binary RPM, while the Requires tag lists what is required when installing/running the program; a package may be in one list or in both. In many cases, <code>rpmbuild</code> automatically detects dependencies so the Requires tag is not always necessary. However, you may wish to highlight some specific packages as being required, or they may not be automatically detected.
* '''%description''': A longer, multi-line description of the program.  Use American English. All lines must be 80 characters or less. Blank lines indicate a new paragraph. Some graphical user interface installation programs will reformat paragraphs; lines that start with whitespace will be treated as preformatted text and displayed as is, normally with a fixed-width font. See [http://docs.fedoraproject.org/drafts/rpm-guide-en/ch09s03.html RPM Guide].
* '''%prep''': Script commands to "prepare" the program (e.g. to uncompress it) so that it will be ready for building.  Typically this is just "<code>%autosetup</code>"; a common variation is "<code>%autosetup -n NAME</code>" if the source file unpacks into <code>NAME</code>. See the %prep section below for more.
* '''%build''': Script commands to "build" the program (e.g. to compile it) and get it ready for installing. The program should come with instructions on how to do this.  See the %build section below for more.
* '''%install''': Script commands to "install" the program.  The commands should copy the files from the <code>BUILD</code> directory <code>%{_builddir}</code> into the buildroot directory, <code>%{buildroot}</code>. See the %install section below for more.
* '''%check''': Script commands to "test" the program. This is run after the %install procedure, so place it there if you have this section. Often it simply contains "<code>make test</code>" or "<code>make check</code>". This is separated from %build so that people can skip the self-test if they desire.
* '''%clean''': Instructions to clean out the build root. Note that this section is now redundant in Fedora and is only necessary for EPEL. Typically this contains only:
rm -rf %{buildroot}
* '''%files''': The list of files that will be installed. See the %files section below for more.
* '''%changelog''': Changes in the package.  Use the format example above. '''Do NOT put software's changelog at here.This changelog is for RPM itself.'''
* '''ExcludeArch''': If the package does not successfully compile, build or work on a particular architecture, list those architectures under this tag.
* You can add sections so that code will run when packages are installed or removed on the real system (as opposed to just running the %install script, which only does a pseudo-install to the build root).  These are called "scriptlets", and they are usually used to update the running system with information from the package.  See the "Scriptlets" section below for more.
 
RPM also supports the creation of several packages (called [[How_to_create_an_RPM_package#Subpackages|subpackages]]) from a single SPEC file, such as <code>name-libs</code> and <code>name-devel</code> packages.
 
{{admon/caution|Do '''NOT''' use these tags|
* Packager
* Vendor
* Copyright}}
 
Do '''not''' create a "relocatable" package; they don't add value in Fedora and make things more complicated.
 
== SPEC file sections explained ==
 
=== %prep section ===
 
The %prep section describes how to unpack the compressed packages so that they can be built. Typically, this includes the "<code>%autosetup</code>" command.  Alternatively, you can use "<code>%setup</code>" and "<code>%patch</code>" commands with reference to the Source0 (and Source1 etc.) lines. See the [http://rpm.org/max-rpm-snapshot/s1-rpm-inside-macros.html Maximum RPM section on %setup and %patch] for more details.
 
The %{patches} and %{sources} macros are available since RPM 4.4.2 and are useful if you have a large list of patches or sources and %autosetup is not what you want, then you can do:
for p in %{patches}; do
    ...
done
 
However, keep in mind that using these will make your SPEC incompatible with RPMS used in RHEL and other RPM-based dirstributions.
 
==== %prep section: %autosetup command ====
 
The "<code>%autosetup</code>" command unpacks a source package. Switches include:
* '''<code>-n</code> ''name''''' : If the Source tarball unpacks into a directory whose name is not the RPM name, this switch can be used to specify the correct directory name. For example, if the tarball unpacks into the directory FOO, use "<code>%autosetup -n FOO</code>".
* '''<code>-c</code> ''name''''' : If the Source tarball unpacks into multiple directories instead of a single directory, this switch can be used to create a directory named ''name'' and then unpack into it.
 
If you use "<code>%setup</code>" command instead, then ''<code>-q</code>''' is commonly used to suppress unecessary output.
 
There are [http://rpm.org/max-rpm-snapshot/s1-rpm-inside-macros.html more %setup options if you are unpacking multiple files], which is primarily useful if you
are creating subpackages (see below).  The key ones are:
 
{|
|-
| <code>-a number</code> || Only unpack the Source directive of the given number after changing directory (e.g. "<code>–a 0</code>" for Source0).
|-
| <code>-b number</code> ||  Only unpack the Source directive of the given number before changing directory (e.g. "<code>–b 0</code>" for Source0).
|-
| <code>-D</code> || Do not delete the directory before unpacking.
|-
| <code>-T</code> || Disable the automatic unpacking of the archives.
|}
 
==== %prep section: %patch commands ====
 
If you have used "<code>%autosetup</code>" command, the following manual patch management is not necessary.  If you have complex requirements or need compatibility with EPEL, you may still need this. The "<code>%patch0</code>" command applies Patch0 (and %patch1 applies Patch1 etc.). Patches are the normal method of making necessary changes to the source code for packaging. The usual "<code>-pNUMBER</code>" option applies, which passes that argument onto the program <code>patch</code>.
 
Patch file names often look like "<code>telnet-0.17-env.patch</code>", which is the format <code>%{name} - %{version} - REASON.patch</code>" (though sometimes version is omitted). Patch files are typically the result of "<code>diff -u</code>"; if you do this from the subdirectory of <code>~/rpmbuild/BUILD</code> then you won't have to specify a <code>-p</code> level later.
 
This is a typical procedure for creating a patch for a single file:
cp foo/bar foo/bar.orig
vim foo/bar
diff -u foo/bar.orig foo/bar > ~/rpmbuild/SOURCES/PKGNAME.REASON.patch
 
If editing many files, one easy method is to copy the whole subdirectory underneath <code>BUILD</code> and then do subdirectory diffs.  After you have changed directory to "<code>~rpmbuild/BUILD/NAME</code>", do the following:
cp -pr ./ ../PACKAGENAME.orig/
... many edits ...
diff -ur ../PACKAGENAME.orig . > ~/rpmbuild/SOURCES/''NAME''.''REASON''.patch
 
If you edit many files in one patch, you can also copy the original files using some consistent ending such as "<code>.orig</code>" before editing them. Then, you can use "<code>gendiff</code>" (in the <code>rpm-build</code> package) to create a patch with the differences.
 
Try to ensure that your patch match the context exactly. The default "fuzz" value is "<code>0</code>", requiring matches to be exact. You can work around this by adding "<code>%global _default_patch_fuzz 2</code>" to revert to the value found in older versions of RPM in Fedora, but it is generally recommended to avoid doing this.
 
As explained in [[Packaging/PatchUpstreamStatus]], all patches should have a comment above them in the SPEC file about their upstream status. This should document the upstream bug/email that includes it (including the date). If it is unique to Fedora, you should mention why it is unique. The Fedora Project tries not to deviate from upstream; see [[PackageMaintainers/WhyUpstream]] for the importance of this.
 
==== %prep section: Unmodified files ====
 
Sometimes, one or more of the Source files do not need to be uncompressed. You can "prep" those into the build directory like this (where <code>SOURCE1</code> refers to the relevant Source file):
cp -p %SOURCE1 .
 
=== %build section ===
 
The "%build" section is sometimes complicated; here you configure and compile/build the files to be installed.
 
Many programs follow the GNU <code>configure</code> approach (or some variation). By default, they will install to a prefix of "<code>/usr/local</code>", which is reasonable for unpackaged files. However, since you are packaging it, change the prefix to "<code>/usr</code>". Libraries should be installed to either <code>/usr/lib</code> or <code>/usr/lib64</code> depending on the architecture.
 
Since GNU <code>configure</code> is so common, the macro "<code>%configure</code>" can be used to automatically invoke the correct options (e.g. change the prefix to <code>/usr</code>). Some variation of this often works:
  %configure
  %make_build
 
To override makefile variables, pass them as parameters to <code>make</code>:
  %make_build CFLAGS="%{optflags}" BINDIR=%{_bindir}
 
More more information, see [http://sourceware.org/autobook/ "GNU autoconf, automake, and libtool"] and [http://web.archive.org/web/20090411003817/http://www.suse.de/~sh/automake/automake.pdf "Open Source Development Tools: An Introduction to Make, Configure, Automake, Autoconf" by Stefan Hundhammer].
 
Some programs use <code>cmake</code>.  See [[Packaging/cmake]].
 
=== %install section ===
 
This section involves script commands to "install" the program, copying the relevant files from <code>%{_builddir}</code> to <code>%{buildroot}</code> (which usually means from <code>~/rpmbuild/BUILD</code> to <code>~/rpmbuild/BUILDROOT</code>) and creating directories inside <code>%{buildroot}</code> as necessary.
 
Some of the terminology can be misleading:
* The "build directory", also known as <code>%{_builddir}</code> is not the same as the "build root", also known as <code>%{buildroot}</code>. Compilation occurs in the former directory, while files to be packaged are copied from the former to the latter.
* During the %build section, the current directory will start at <code>%{buildsubdir}</code>, which is the subdirectory within <code>%{_builddir}</code> that was created during %prep stage. This is usually something like <code>~/rpmbuild/BUILD/%{name}-%{version}</code>.
* The %install section is '''not''' run when the binary RPM package is installed by the end-user, but is only run when creating a package.
 
Normally, some variation of "<code>make install</code>" is performed here:
%install
%make_install
 
Ideally you should use %make_install which is equivalent to [http://www.gnu.org/prep/standards/html_node/DESTDIR.html <code>DESTDIR=%{buildroot}</code>] if the program supports it, as it redirects file installations to the specified directory and is exactly what we want to happen during the %install section.
 
If the program does not support <code>DESTDIR</code> (and only if), you can workaround it in one of several (inferior) ways:
* Patch the makefile so that is supports <code>DESTDIR</code>. Create directories inside <code>DESTDIR</code> where necessary and submit the patch upstream.
* Use the "<code>%makeinstall</code>" macro. This method might work, but can lead to subtle failures. It expands to something like "<code>make prefix=%{buildroot}%{_prefix} bindir=%{buildroot}%{_bindir} ... install</code>", which can result in some programs failing to work properly. Create directories inside <code>%{buildroot}</code> where necessary.
* Consider using the <code>auto-destdir</code> package. This requires "<code>BuildRequires: auto-destdir</code>", and changing "<code>make install</code>" to "<code>make-redir DESTDIR=%{buildroot} install</code>". This only works well if the installation uses only certain common commands to install files, like <code>cp</code> and <code>install</code>.
* Perform the installation by hand. This would involve creating the necessary directories under <code>%{buildroot}</code> and copying files from <code>%{_builddir}</code> to <code>%{buildroot}</code>. Be especially careful with updates, which often contain new or changed filenames. An example of this procedure:
%install
mkdir -p %{buildroot}%{_bindir}/
cp -p mycommand %{buildroot}%{_bindir}/
 
=== %check section ===
 
If self-tests are available, it is generally a good idea to include them. They should be placed in the %check section (which immediately follows the %install section, since files in %buildroot may be tested) instead of within the %build section itself, so that they can be easily skipped when necessary.
 
Often, this section contains:
make test
 
Sometimes it can be:
make check
 
Please explore the Makefile and choose the appropriate way.
 
=== %files section ===
This section declares which files and directories are owned by the package, and thus which files and directories will be placed into the binary RPM.
 
==== %files basics ====
 
The <code>%defattr</code> sets the default file permissions, and is often found at the start of the <code>%files</code> section. Note that this is no longer necessary unless the permissions need to be altered. The format of this is:
%defattr(<file permissions>, <user>, <group>, <directory permissions>)
The fourth parameter is often omitted. Usually one uses <code>%defattr(-,root,root,-)</code>, where "<code>-</code>" uses the default permissions.
 
You should then list all the files and directories to be owned by the package. Use macros for directory names where possible, which can be viewed at [[Packaging:RPMMacros]] (e.g. use <code>%{_bindir}/mycommand</code> instead of <code>/usr/bin/mycommand</code>). If the pattern begins with a "<code>/</code>" (or when expanded from the macro) then it is taken from the <code>%{buildroot}</code> directory. Otherwise, the file is presumed to be in the current directory (e.g. inside <code>%{_builddir}</code>, such as documentation files that you wish to include). If your package only installs a single file <code>/usr/sbin/mycommand</code>, then the <code>%files</code> section can simply be:
%files
%{_sbindir}/mycommand
 
To make your package less sensitive to upstream changes, declare all files within a directory to be owned by the package with a pattern match:
%{_bindir}/*
 
To include a single directory:
%{_datadir}/%{name}/
 
Note that <code>%{_bindir}/*</code> does not claim that this package owns the <code>/usr/bin</code> directory, but only the files contained within. If you list a directory, then you are claiming that the package owns that directory and all files and subdirectories contained within. Thus, do '''not''' list <code>%{_bindir}</code> and be careful of directories that may be shared with other packages.
 
An error will occur if:
* a pattern match does not match any file or directory
* a file or directory is listed or matched more than once
* a file or directory in the <code>%{buildroot}</code> has not been listed
 
It is also possible to exclude files from a previous match by using the <code>%exclude</code> glob. This can be useful for including almost all of the files included by a different pattern match, but note that it will also fail if it does not match anything.
 
==== %files prefixes ====
You may need to add one or more prefixes to lines in the <code>%files</code> section; seperate them with a space. See [http://www.rpm.org/max-rpm/s1-rpm-inside-files-list-directives.html Max RPM section on %files directives].
 
Usually, "<code>%doc</code>" is used to list documentation files within <code>%{_builddir}</code> that were not copied to <code>%{buildroot}</code>. A <code>README</code> and <code>INSTALL</code> file is usually included. They will be placed in an appropriate directory under <code>/usr/share/doc</code>, whose ownership does not need to be declared.
 
'''Note:''' If specifying a <code>%doc</code> entry, rpmbuild < 4.9.1 removes the doc directory it installs files into before installing them. This means that files already in it, for example installed in the <code>%install</code> section, are removed and do not end up in the package. If you want to install some files in the <code>%install</code> section, install them into a temporary staging directory inside the build dir (not build root), for example <code>_docs_staging</code>, and include them in the in the <code>%files</code> list like <code>%doc _docs_staging/*</code>.
 
Configuration files should be placed in <code>/etc</code> and are normally specified like this (which makes sure user changes aren't overwritten on update):
%config(noreplace) %{_sysconfdir}/foo.conf
If the update uses a non-backwards-compatible configuration format, then specify them like this:
%config %{_sysconfdir}/foo.conf
 
"<code>%attr(mode, user, group)</code>" can be used for finer control over permissions, where a "<code>-</code>" means use the default:
%attr(0600, root, root) FOO.BAR
 
If a file is in particular natural language, use <code>%lang</code> to note that:
%lang(de) %{_datadir}/locale/de/LC_MESSAGES/tcsh*
 
Programs using Locale files should follow the [[Packaging:Guidelines#Handling_Locale_Files|recommended method of handling i18n files]]:
* find the filenames in the <code>%install</code> step: <code> %find_lang ${name}</code>
* add the required build dependencies: <code>BuildRequires: gettext</code>
* use the found filenames: <code>%files -f ${name}.lang</code>
 
The <code>%readme</code> prefix is '''not''' valid in Fedora.
 
==== %files and Filesystem Hierarchy Standard (FHS) ====
 
You should follow the [http://www.pathname.com/fhs/ Filesystem Hierarchy Standard (FHS)]. Executables go in <code>/usr/bin</code>, global configuration files go in <code>/etc</code>, libraries go into <code>/usr/lib</code> (or <code>/usr/lib64</code>) and so on.  Executables that should not normally be executed directly by users or administrators should (but are executed by other parts of your package) go in a subdirectory of <code>/usr/libexec</code>, which is referred to as <code>%{_libexecdir}/%{name}</code>.
 
Do '''not''' install files into <code>/opt</code> or <code>/usr/local</code>.  ([[Packaging:Guidelines#Limited_usage_of_.2Fopt.2C_.2Fetc.2Fopt.2C_and_.2Fvar.2Fopt|reference]])
 
Unfortunately, many programs do not follow the FHS by default. In particular, architecture-independent libraries get placed in <code>/usr/lib</code> instead of <code>/usr/share</code>. The former is for architecture-dependent libraries, while the latter is for architecture-independent libraries, which means that systems with different CPU architectures can share <code>/usr/share</code>. There are many exceptions in Fedora (such as Python, Perl and Systemd), but Fedora applies this rule more strictly than some distributions. <code>rpmlint</code> will generally complain if you put anything other than ELF files into <code>/usr/lib</code>.
 
==== %files example ====
 
Here's a simple example of a %files section:
%files
%doc README
%license LICENSE COPYING
%{_bindir}/*
%{_sbindir}/*
%{_datadir}/%{name}/
%config(noreplace) %{_sysconfdir}/*.conf
 
==== Finding duplicates ====
 
You can list any duplicates of two binary packages by doing:
cd ~/rpmbuild/RPMS/ARCH # Substitute "ARCH" for your architecture
rpm -qlp PACKAGE1.*.rpm | sort > ,1
rpm -qlp PACKAGE2.*.rpm | sort > ,2
comm -12 ,1 ,2
 
=== Scriptlets ===
 
When an end-user installs the RPM, you may want some commands to be run. This can be achieved through scriptlets. See [[Packaging:Scriptlets]].
 
Scriptlets can be run:
* before ('''<code>%pre</code>''') or after ('''<code>%post</code>''') a package is installed
* before ('''<code>%preun</code>''') or after ('''<code>%postun</code>''') a package is uninstalled
* at the start ('''<code>%pretrans</code>''') or end ('''<code>%posttrans</code>''') of a transaction
 
For example, every binary RPM package that stores shared library files in any of the dynamic linker's default paths, must call <code>ldconfig</code> in <code>%post</code> and <code>%postun</code>. If the package has multiple subpackages with libraries, each subpackage should also perform the same actions.
%post -p /sbin/ldconfig
%postun -p /sbin/ldconfig
 
If only running a single command, then the "<code>-p</code>" option runs the adjacent command without invoking the shell. However, for several commands, omit this option and include the shell commands beneath.
 
If you run any programs within the scriptlets, then you must specify any requirements in the form "<code>Requires(CONTEXT)</code>" (e.g. <code>Requires(post)</code>).
 
<code>%pre</code>, <code>%post</code>, <code>%preun</code>, and <code>%postun</code> provide the argument <code>$1</code>, which is the number of packages of this name which will be left on the system when the action completes. Don't compare for equality with <code>2</code>, but instead check if they are greater than or equal to <code>2</code>. For <code>%pretrans</code> and <code>%posttrans</code>, <code>$1</code> is always <code>0</code>.
 
For example, if the package installs an info manual, then the info manual index must be updated with <code>install-info</code> from the <code>info</code> package. Firstly, there is no guarantee that the <code>info</code> package will be available unless we explicitly declare it as required, and secondly, we don't want to fail completely if <code>install-info</code> fails:
Requires(post): info
Requires(preun): info
...
%post
/sbin/install-info %{_infodir}/%{name}.info %{_infodir}/dir || :
%preun
if [ $1 = 0 ] ; then
/sbin/install-info --delete %{_infodir}/%{name}.info %{_infodir}/dir || :
fi
 
There is one other glitch related to installing info manuals. The <code>install-info</code> command will update the info directory, so we should delete the useless empty directory from the %{buildroot} during the <code>%install</code> section:
rm -f %{buildroot}%{_infodir}/dir
 
Another scriptlet-like ability are "triggers", which can be run for your package when other packages are installed or uninstalled. See [http://rpm.org/api/4.4.2.2/triggers.html RPM Triggers].
 
=== Macros ===
 
Macros are text in the format <code>%{string}</code>. Typical macros:
 
{|
! Macro !! Typical Expansion !! Meaning
|-
| <code>%{_bindir}</code> || <code>/usr/bin</code> || Binary directory: where executables are usually stored.
|-
| <code>%{_builddir}</code> || <code>~/rpmbuild/BUILD</code> || Build directory: files are compiled within a subdirectory of the build directory. See <code>%buildsubdir</code>.
|-
| <code>%{buildroot}</code> || <code>~/rpmbuild/BUILDROOT/%{name}...</code> || Build root: where files are "installed" during the <code>%install</code> stage, which copies files from a subdirectory of <code>%{_builddir}</code> to a subdirectory of <code>%{buildroot}</code>. (Historically, <code>%{buildroot}</code> was in "/var/tmp/".)
|-
| <code>%{buildsubdir}</code> || <code>%{_builddir}/%{name}</code> || Build subdirectory: a subdirectory within <code>%{_builddir}</code> where files are compiled during the <code>%build</code> stage. It is set after <code>%autosetup</code>.
|-
| <code>%{_datadir}</code> || <code>/usr/share</code> || Share directory.
|-
| <code>%{_defaultdocdir}</code> || <code>/usr/share/doc</code> || Default documentation directory.
|-
| <code>%{dist}</code> || <code>.fc''NUMBER''</code> || Distribution+version short name (e.g. "<code>.fc{{FedoraVersion}}</code>")
|-
| <code>%{fedora}</code> || <code>''NUMBER''</code> || Number of fedora release (e.g. "<code>{{FedoraVersion}}</code>")
|-
| <code>%{_includedir}</code> || <code>/usr/include</code>
|-
| <code>%{_infodir}</code> || <code>/usr/share/info</code>
|-
| <code>%{_initrddir}</code> || <code>/etc/rc.d/init.d</code>
|-
| <code>%{_libdir}</code> || <code>/usr/lib</code>
|-
| <code>%{_libexecdir}</code> || <code>/usr/libexec</code>
|-
| <code>%{_localstatedir}</code> || <code>/var</code>
|-
| <code>%{_mandir}</code> || <code>/usr/share/man</code>
|-
| <code>%{name}</code> || || Name of package, set by Name: tag
|-
| <code>%{_sbindir}</code> || <code>/usr/sbin</code>
|-
| <code>%{_sharedstatedir}</code> || <code>/var/lib</code>
|-
| <code>%{_sysconfdir}</code> || <code>/etc</code>
|-
| <code>%{version}</code> || || Version of package, set by Version: tag
|}
 
Learn more about macros by looking in <code>/etc/rpm/*</code> and <code>/usr/lib/rpm</code>, especially <code>/usr/lib/rpm/macros</code>. Also use <code>rpm --showrc</code> to show values that RPM will use for macros (altered by <code>rpmrc</code> and macro configuration files).
 
You can set your own macro values using %global, but be sure to define them before you use them. (Macro definitions can also refer to other macros.)  For example:
%global date 2012-02-08
 
Use the "<code>-E</code>" option of <code>rpmbuild</code> to find the value of a macro in a SPEC file:
rpmbuild -E '%{_bindir}' myfile.spec
 
Also see [[Packaging/RPMMacros]] and [https://docs.fedoraproject.org/en-US/Fedora_Draft_Documentation/0.1/html/RPM_Guide/ch09s07.html RPM Guide chapter 9].
 
=== Other tags ===
 
In addition to Requires and BuildRequires tags, you can also use these for controlling dependencies:
* '''Provides''': list virtual package names that this package provides. For example, there might be a package "<code>foo</code>" that demands a particular functionality "bar" from another program. If there are several packages that can satisfy that demand, those packages can specify "<code>Provides: bar</code>" and the "<code>foo</code>" package can specify "<code>Requires: bar</code>". You could also use the [http://dailypackage.fedorabook.com/index.php?/archives/6-Wednesday-Why-The-Alternatives-System.html "alternatives" system], but avoid if multiple users on the same system might want different default, as these settings are system-wide. Use "<code>rpm -q --provides PACKAGENAME</code>" to see what a given package provides. Some examples of virtual packages in Fedora:
** MTA: Used for mail transport agents, such as sendmail.
** tex(latex): Used for latex
* '''Obsoletes''': remove another named package(s) when this package is installed. Use when the package name changes or when it totally replaces a different package.
* '''Conflicts''': state what other packages cannot be installed simultaneously to this one. Avoid this if you can. See [[Packaging/Conflicts]].
* '''BuildConflicts''': state what packages cannot be installed when building this package. Avoid this if you can.
 
To manage different architectures, there are two tags:
* '''ExcludeArch''': to exclude an architecture on which the package doesn't build. For example:
ExcludeArch: ppc
* '''ExclusiveArch''': to include only the specified architecture. Avoid this unless absolutely correct.
Valid architectures are listed at [[Architectures]].
 
=== Subpackages ===
 
A SPEC file can define several binary package. In other words, one SRPM with one SPEC file can result in several RPMS. Note that there is still only one creation (%prep, %build, %install etc.) process. <code>name-doc</code> and <code>name-devel</code> subpackages are common for documentation and development files respectively.
 
Use the <code>%package</code> directive to start defining a subpackage:
%package subpackage_name
 
After each <code>%package</code> directive, list the tags for the subpackage. This should at least include the Summary and Group tags, as well as the <code>%description subpackage_name</code> and <code>%files subpackage_name</code> directives:
 
Anything not specified by the subpackage will be inherited from its parent.
 
By default, if the package name is "<code>foo</code>" and the subpackage name is "<code>bar</code>", then the resulting subpackage will be "<code>foo-bar</code>". You can override it with the "<code>-n</code>" option (but you'll need to use it in all other directives too if you specify it here):
%package -n new_subpackage_name
 
[http://docs.fedoraproject.org/en-US/Fedora_Draft_Documentation/0.1/html/RPM_Guide/ch10s04.html See the RPM Guide section on subpackages] for more information.
 
=== Conditionals ===
 
You can insert conditional statements, for example to test if you are creating a binary for a certain architecture:
%ifarch ARCHITECTURE_NAME
the negated version with:
%ifnarch ARCHITECTURE_NAME
or the more general conditional:
%if TRUE_OR_FALSE
 
There is an optional "<code>%else</code>" section; all of these are closed with "<code>%endif</code>".
 
=== Application Specific Guidelines ===
 
There are many application-specific guidelines that can help you (e.g., for specific programming languages, applications, libraries, and build systems).  Many of them are listed as part of the
[[Packaging/Guidelines#Application_Specific_Guidelines|Application Specific Guidelines of Packaging/Guidelines]].  Examples of application-specific guidelines are those for:
* [[Packaging:Cmake|Cmake]]
* [[Packaging:Emacs|Emacs]]
 
Failing that, some other ways of finding application-specific help are:
* The 'SEARCH' command on Fedoraproject.org.
* [[PackagingDrafts]]
* A [[SIGs|Special Interest Group (SIG)]]
* [[Special:PrefixIndex/Packaging|Wiki pages prefixed with 'Packaging']]
 
=== Miscellaneous hints ===
 
[[Packaging/FrequentlyMadeMistakes]] has information on frequently-made mistakes. There are also some recommendations and controversial tricks on
[[PackageMaintainers/Packaging Tricks]].
 
Try to write your SPEC files so that it is likely to work when a new release is made upstream, without any changes aside from bumping the version number and refreshing the source files. For example, if it contains *.txt files with execute bits, instead of doing
  chmod a-x Filename1.txt Filename2.txt Filename3.txt
consider doing this, which will handle new filenames that use the same file naming convention:
  chmod a-x *.txt
 
If you want to see lots of examples of scriptlets, you can show all the scriptlets on installed programs using:
  rpm -qa --queryformat "\n\nPACKAGE: %{name}\n" --scripts | less
 
Don't try to interact with the user; RPM is designed to support batch installs.  If an application needs to show a EULA, that needs to be part of its initial execution, not its installation.
 
You might not want to start services, because in a big install that could slow things down. If you install an init or systemd script, consider using <code>chkconfig</code> or <code>systemctl</code> to arrange for the service to be started/stopped on the next reboot.  Before uninstalling, you should normally try to stop its services if they are running.
 
Uninstalling should reverse most changes made during installation, but don't remove any user-created files.
 
Normally, if there are binary executables, then debugging symbols are stripped from the normal binary packages and placed into a <code>name-debug</code> subpackage. If this shouldn't happen, you can disable the stripping and creation of this subpackage by putting this at the top of your SPEC:
%global _enable_debug_package 0
%global debug_package %{nil}
%global __os_install_post /usr/lib/rpm/brp-compress %{nil}
 
To prevent stripping you may also need to do this in the <code>%install</code> section:
export DONT_STRIP=1
 
A way to check for the version of Fedora in a SPEC file for conditional builds is:
%if 0%{?fedora} <= <version>
The <code>?</code> causes the macro to evaluate to evaluate to blank if <code>%fedora</code> is not defined. This causes the end result to be the <code>0</code> (which is a number and thus fine), while not interfering with the result if there is actually a value for <code>%fedora</code>. (Note that this trick does not work in Koji "scratch" builds, where <code>%fedora</code> is set during the creation of a SRPM.)
 
GUI programs must have a desktop entry so that people can invoke it from the graphical desktop menu. For <code>.desktop</code> files, see [[Packaging/Guidelines#Desktop_files|Fedora packaging guidelines for desktop files]] and [http://standards.freedesktop.org/desktop-entry-spec/latest/ desktop entry spec]. For icons within <code>/usr/share/icons</code>, see [http://standards.freedesktop.org/icon-theme-spec/icon-theme-spec-latest.html icon theme spec].
 
== Building the binary package ==
 
=== Test with rpmlint ===
 
To catch many common errors early, run <code>rpmlint</code> on your SPEC file before trying to build anything from it:
$ rpmlint program.spec
If the reported error doesn't make sense, run it again with the "<code>-i</code>" option for longer messages.
 
Aim to have no errors, but sometimes <code>rpmlint</code> reports false positives. The [[Packaging/Guidelines#Use_rpmlint|Fedora packaging guidelines]]
explains which ones to ignore.
 
=== Create binary RPMS from the SPEC file ===
 
Once you've created your SPEC file, build the SRPM and binary RPMS by running this:
$ rpmbuild -ba program.spec
 
If successful, RPMS will be created within <code>~/rpmbuild/RPMS</code> and SRPMS will be created within <code>~/rpmbuild/SRPMS</code>.
 
If it fails, go to the appropriate directory and see what is left over. To help debug, you can skip earlier stages that succeeded with the "<code>--short-circuit</code>" option. For example, to restart at the <code>%install</code> stage (skipping earlier stages), do this:
$ rpmbuild -bi --short-circuit program.spec
 
If you just want to create an SRPM (which does not run the <code>%prep</code> or <code>%build</code> or other stages), run this:
rpmbuild -bs program.spec
 
=== Testing binary RPMS with rpmlint ===
 
<code>rpmlint</code> can be run on SPEC files, RPMS and SRPMS to check for errors. You need to eliminate or justify warnings before posting a package. [[Common_Rpmlint_issues|This page]] offers explanations for some of the common issues that come up. If you are in the SPECS directory, do this:
$ rpmlint ''NAME''.spec ../RPMS/*/''NAME''*.rpm ../SRPMS/''NAME''*.rpm
 
Enter the <code>~/rpmbuild/RPMS</code> directory and into the architecture subdirectory. You will find some binary RPMS. Quickly see their files and permissions (to check whether they are correct) by doing:
$ rpmls *.rpm
 
If they look fine, install them as root:
# rpm -ivp package1.rpm package2.rpm package3.rpm ...
 
Test the programs in a few different ways to see if everything works correctly. If it is a GUI tool, make sure it shows up in the desktop menu, otherwise the <code>.desktop</code> entry is wrong.
 
Uninstall packages later by doing:
# rpm -e package1 package2 package3
 
== Mock and Koji ==
 
[[Projects/Mock|Mock]] is a powerful tool that uses the SRPM you have created to build binary packages within a nearly empty environment. This can reveal if you have accurate build dependencies. If it fails, then you forgot to list something in BuildRequires. See [[Using Mock to test package builds]]. Once your account is a member of the "<code>mock</code>" group, you can run commands like this to do local testing:
$ mock -r fedora-23-i386 rebuild path_to_source_RPM
 
You can use Koji (which uses <code>mock</code>) to do builds on many different systems, some of which you may not have. [[PackageMaintainers/Join]] and [[PackageMaintainers/UsingKoji]] have more information about Koji. Once it's set up, you can test your SRPM on a variety of platforms by running commands like:
$ koji build --scratch f23 path_to_source_RPM
 
Replace <code>f23</code> with any later release of Fedora, or <code>rawhide</code>.
 
Your Koji builds can only depend on packages that are actually in the TARGET distribution repository.  Thus, you can't use Koji to build for released distributions if your package depends on other new packages that Bodhi hasn't released yet. If you need to build against a package that is not yet a stable released update, submit a Koji buildroot override request via Bodhi. If it's not your own package you depend on, contact its maintainer(s). [Before Bodhi could handle Koji buildroot override requests, the old method has been to file a ticket with rel-eng at: https://fedorahosted.org/rel-eng/newticket and request that that package be added as a buildroot override.]
 
== Helpful tools ==
 
The <code>rpmdevtools</code> package has a number of helpful tools; "<code>rpm -qil rpmdevtools</code>" will show you what it installs.
* <code>rpmdev-bumpspec</code> : bump the release tag in the spec file and add a changelog comment with the right date and version format:
rpmdev-bumpspec --comment=COMMENT --userstring=NAME+EMAIL_STRING SPECFILES
 
DNF download plugin (from core DNF plugins) is also useful:
* <code>dnf download</code> : download the SRPM of the package by running:
dnf download --source PACKAGENAME
 
The <code>auto-buildrequires</code> package has a pair of nice tools for helping to figure out the proper BuildRequires entries.  After installing this package, replace "<code>rpmbuild</code>" with "<code>auto-br-rpmbuild</code>" and you'll see an automatically generated BuildRequires list.
 
You might find [http://rust.sourceforge.net/ RUST] useful (GPL), though it does not create SPEC files of suitable quality for Fedora packages. [http://kitenet.net/~joey/code/alien/ Alien] converts between package formats. It won't produce clean SRPMS, but converting an existing package might provide helpful information.
 
If you are thinking about packing your rpm for Fedora, be sure you run your packages through [https://fedorahosted.org/FedoraReview/ Fedora Review], which helps ensure that you comply to the [[Packaging:Guidelines?rd=Packaging/Guidelines|Packaging Guideline]].
 
Finally, [https://github.com/alanfranz/docker-rpm-builder docker-rpm-builder] (APL 2.0) uses [http://www.docker.com Docker] to build RPM packages; while using rpmbuild requires building on the same host distro as the target, and mock works fine on Fedora/Centos/RHEL distributions for any target, '''this last tool works fine whenever Docker can run'''.
 
If you want to build your package for diferent distribution and architectures and to have publicly accesible dnf repository, you can submit your src.rpm to [https://copr.fedoraproject.org Copr].
 
If you need to sign your new package, use <code>rpmsign</code> tool from
<code>rpm-sign</code> package.
 
== Guidelines and rules ==
 
When you create your packages, you'll need to follow the following rules and guidelines:
* [[Join the package collection maintainers|How to join the Fedora Package Collection Maintainers]]
* [[Packaging:Guidelines|Packaging Guidelines]]
* [[Packaging:NamingGuidelines|Package Naming Guidelines]]
* [[Packaging:LicensingGuidelines|Package Licensing Guidelines]]
* [[Packaging:DistTag|Dist Tag Guidelines]]
* [[Packaging:ReviewGuidelines|Package Review Guidelines]]
 
There are many official guidelines that will help you with specific circumstances (e.g. Java programs, OCaml programs, GNOME programs). You can also learn more from the [[SIGs]] and [[:Category:Package Maintainers|Package Maintainers]] sections.
 
[[Special:Prefixindex/Packaging|You can also see the list of all Wiki pages about Packaging]] to see if any apply.
 
Failing that, you might find some useful recommendations in the unofficial [[Special:Search?ns0=1&search=PackagingDrafts%2F&searchx=Search|Packaging Drafts]] and [[PackagingDrafts|Packaging Drafts To Do]].
 
You might find ideas from [http://en.opensuse.org/Packaging SuSE],
[http://www.debian.org/doc/debian-policy/ Debian], but
[http://www.mail-archive.com/distributions@lists.freedesktop.org/msg00156.html distributions differ in their rules], so do not presume they can be used directly.
 
'''The .spec files that you create must be open source software, as noted in the [[Legal:Fedora_Project_Contributor_Agreement|FPCA]].'''
 
== Maintaining the package ==
 
Once your package has been accepted, you and your co-maintainers will need to maintain it. See [[Package update HOWTO]] and [[Package update guidelines]]. If you update the version in multiple releases of Fedora, do it backwards in time (e.g. release for Fedora N, then once that's accepted, Fedora N-1). The system presumes that later versions of Fedora have the same or later versions of programs.
 
Encourage the upstream developers to use standard source code release conventions. Using standard conventions makes packaging much easier. For more information, see:
* [http://www.dwheeler.com/essays/releasing-floss-software.html Releasing Free/Libre/Open Source Software (FLOSS) for Source Installation] (a quick summary)
* [http://www.gnu.org/prep/standards/html_node/Managing-Releases.html GNU Coding Standards release process]
* [http://en.tldp.org/HOWTO/Software-Release-Practice-HOWTO/ Software Release Practice HOWTO]
* [http://www.pathname.com/fhs/ Filesystem Hierarchy Standard (FHS)]
* [http://offog.org/articles/packaging/ Packaging Unix software]
 
== For more information ==
 
The [[:Category:Package Maintainers|Package Maintainers]] page links to many other useful pages, and the
[[Package update HOWTO]] describes how to update an existing package you already maintain in Fedora.
 
For more information, outside of the Fedora Wiki, see:
* [http://www.g-loaded.eu/2006/04/05/how-to-build-rpm-packages-on-fedora/ How to build RPM packages on Fedora] - very brief run-through
* Packaging software with RPM (developerWorks) [http://www.ibm.com/developerworks/library/l-rpm1/ Part 1], [http://www.ibm.com/developerworks/library/l-rpm2/ Part 2], and [http://www.ibm.com/developerworks/library/l-rpm3.html Part 3]
* Fedora Classroom had a IRC session on packaging and you can refer to the logs at https://fedoraproject.org/wiki/Building_RPM_packages_%2820090405%29
<!-- Server not found: * [http://koti.welho.com/vskytta/packagers-handbook/packagers-handbook.html Fedora Packager's Handbook] -->
<!-- Redirect to opensource.com: * [http://www.redhatmagazine.com/2008/02/28/when-sally-met-eddie-the-fedora-package-story/ When Sally met Eddie] - a simple tale, but little detail -->
* [http://rpm.org/max-rpm-snapshot/ Maximum RPM Book] - most complete information, but in some cases old/obsolete
* [http://docs.fedoraproject.org/en-US/Fedora_Draft_Documentation/0.1/html/RPM_Guide/ch-creating-rpms.html RPM Guide, section on creating RPMs] - this has lots of good information, and is slightly more up-to-date, but is a draft
* [http://docs.fedoraproject.org/developers-guide/ch-rpm-building.html Developer's guide, section on building RPMs]
<!-- URL not found: * [http://www.gurulabs.com/GURULABS-RPM-LAB/GURULABS-RPM-GUIDE-v1.0.PDF Creating RPMS slides] from Guru Labs -->
* [http://freshrpms.net/docs/fight/ The fight, my first attempt to make a readable rpm package building introduction.]
<!-- Page not found: * [http://www-uxsup.csx.cam.ac.uk/talks/rpmbuild/rpmbuild.pdf Cambridge RPM tutorial] is a presentation on creating basic RPMs -->
* [http://en.tldp.org/HOWTO/RPM-HOWTO/index.html RPM HOWTO: RPM at Idle by Donnie Barnes]
<!-- Page not found: * [http://home.fnal.gov/~dawson/rpms/howto/index.html RPM HowTo by Dawson] -->
* [http://en.opensuse.org/Build_Service/cross_distribution_package_how_to Cross-distribution package HOWTO] has hints if you're building one RPM for many distributions.
<!-- Server not found: * [http://wiki.mandriva.com/en/Development/Howto/RPM Mandriva Rpm HowTo (en)] is an RPM tutorial, though for Mandriva (nee Mandrake).  Note: In Fedora, do ''not'' recompress original tarballs, as Mandriva suggests, because that would change their cryptographic hashes. -->
* [http://linuxshellaccount.blogspot.com/2008/03/creating-your-own-linux-rpms-initial.html Creating Your Own Linux RPM's - The Initial Software Build] is another brief intro, but it makes the point that "The process of building RPM's is much simpler than creating packages for Solaris... Fewer steps, and the ability to add all of your software information into one specification file, makes for a much tighter (and easier to modify or reproduce) software packaging system."
* [http://fedoranews.org/alex/tutorial/rpm/ All you need to know about RPM] (more about installing packages than creating them)
* The [http://wiki.rpm.org/ rpm.org Wiki] has some useful information, such as the [http://wiki.rpm.org/Problems list of known RPM problems]
 
Note: The [http://rpm5.org/ rpm5.org] site has some documentation, but do not depend on it; that is the home of a ''fork'' of RPM maintained by Jeff Johnson.  The RPM used by Fedora (and Novell/SuSE) is instead based at [http://www.rpm.org rpm.org].
[http://lwn.net/Articles/236029/ lwn.net has a brief article] about this.
 
[[Category:Package Maintainers]]
[[Category:How to]]

Latest revision as of 20:57, 26 May 2021

deprecated
As part of documentation move to docs.fp.o, this page has moved to https://docs.fedoraproject.org/en-US/quick-docs/creating-rpm-packages
Retrieved from "https://fedoraproject.org/w/index.php?title=How_to_create_an_RPM_package&oldid=616046"