Source Package Fields [fields-src]
==================================

The fields in the source package metadata are:

  * `Maintainer` (required)  

    The name and e-mail address of the package maintainer.  This field must
    follow the syntax of the `mailbox` symbol in RFC 5322 section 3.4.

  * `Build-Depends` (optional)  

    A list of packages that must be installed before the package can be built.

    Variable substitutions are performed on the value of this field.

  * `Homepage` (optional)  

    The URL of the Web site for the package.  Accessible at this site should be
    origin source code and documentation and/or information.  Though the
    information in this field is machine-usable, the URL must not be surrounded
    by angle brackets or any other characters.


Binary Package Fields [fields-bin]
==================================

The fields in the binary package metadata are:

  * `Architecture` (required)  

    A list of architectures for which this package may be built.  The value may
    be any one of the following:

    - The string `all` to specify that all of the provided files are
      architecture-independent;
    - The string `any` to specify that at least some of the provided files are
      architecture-dependent; or
    - A space-separated list of one or more real or wildcard binary architecture
      strings to specify that at least some of the provided files are only
      usable on systems of the named binary architecture(s).

    A "wildcard" binary architecture string is one in which one or two
    components (called "wildcard components") is the string `any`.  It shall be
    considered to match any real binary architecture string for which the
    non-wildcard components are equal.

  * `Platform` (required)

    A list of platforms for which this package may be built.  The value may be
    any one of the following:

    - The string `all` to specify that all of the provided files are
      platform-independent;
    - The string `any` to specify that at least some of the provided files are
      platform-dependent; or
    - A space-separated list of one or more platform strings to specify that at
      least some of the provided files are only usable on systems of the named
      platform(s).

  * `Section` (optional, may be required in a future version of this Source
    Package Format)

    The name of the section in the package archive into which this package is to
    be installed.  Packages with a `Section` field must provide only files
    related to the specified section.  The value may be any one of the
    following:

    - The string `boot` for packages containing only boot loaders, kernel
      images, and device firmware;
    - The string `dbg` for packages containing only debugging symbols;
    - The string `dev` for packages containing only utilities used to build
      other packages, such as distribution package build utilities, compilers,
      and utilities that configure compiler and linker flags;
    - The string `doc` for packages containing only manual pages and other
      upstream documentation files;
    - The string `lib` for packages containing only shared libraries and object
      files;
    - The string `libdev` for packages containing only header files, unversioned
      library symbolic links used when linking, and configuration files and
      architecture-independent utilities that configure compiler and linker
      flags;
    - The string `locale` for packages containing only locale files;
    - The string `share` for packages containing only architecture-independent
      data; and
    - The string `utils` for packages containing only executable files, such as
      utilities and binaries run by other programs.

    No packages may declare any relationships (via `Depends`, `Recommends`,
    etc.) with packages in sections `dbg`, `doc`, or `locale`.  Only binary
    packages in section `dev` and source packages (via `Build-Depends`) may
    declare relationships with packages in section `libdev`.  These restrictions
    allow feed lists for sections `dbg`, `doc`, `libdev`, and `locale` to be
    excluded from systems that don't need the packages they contain.

    All packages in sections `lib` and `libdev` must allow coinstallation of
    packages of the same name and different architectures.

  * `Essential` (optional)  

    A flag to indicate whether the package is essential for the functioning of a
    system on which it is installed.  If this field is set to `yes`, opkg will
    refuse to remove the package except when upgrading it.  If this field is set
    to any other value or is omitted, the package may be removed by a user.

  * `Depends` (optional)  

    A list of packages that must be installed and configured before the package
    may itself be configured.

    Variable substitutions are performed on the value of this field.

  * `Recommends` (optional)  

    Variable substitutions are performed on the value of this field.

  * `Suggests` (optional)  

    Variable substitutions are performed on the value of this field.

  * `Pre-Depends` (optional)  

    A list of packages that must be installed before the package may itself be
    installed.

    Variable substitutions are performed on the value of this field.

  * `Conflicts` (optional)  

    Variable substitutions are performed on the value of this field.

  * `Provides` (optional)  

    Variable substitutions are performed on the value of this field.

  * `Replaces` (optional)  

    Variable substitutions are performed on the value of this field.

  * `Description` (required)  

    A description of the binary package.  This is a multiline field.  The first
    line is a short synopsis, and all following lines are an extended
    description.

    Variable substitutions are performed on the value of this field.