Config...Binary(3pm)

๐Ÿ’– Config...Binary(3pm) ๐Ÿ’–

okay bestie, sit DOWN ๐Ÿซถ this is a User Contributed Perl Documentation page for Config...Binary(3pm), and it is a LOT. Grab your boba, we're going through every single field together, no skipping, no cap ๐Ÿ’…โœจ


๐ŸŽ€ NAME ๐ŸŽ€

Config::Model::models::Dpkg::Control::Binary โ€” the Configuration class. That's it, that's the name, periodt ๐Ÿ‘‘

๐Ÿงš DESCRIPTION ๐Ÿงš

These are the Configuration classes used by Config::Model. Cute, right? That's the summary. Everything below is the elements, and girl there are a LOT of them ๐ŸŒˆ

๐Ÿฆ‹ Elements ๐Ÿฆ‹

๐Ÿ—๏ธ Architecture

So if a program needs to drop an architecture specification string somewhere, it should pick one of the strings that dpkg-architecture -L hands out. Those strings are formatted os-arch, though ngl the OS part is sometimes elided โ€” like when the OS is Linux. A package may also specify an architecture wildcard, and those come in the format any (which matches literally every architecture, she's versatile ๐Ÿ’…), os-any, or any-cpu. For more details, see Debian policy at http://www.debian.org/doc/debian-policy/ch-customized-programs.html#s-arch-spec ๐Ÿ“–

Mandatory. Type: string.

๐ŸŒ Multi-Arch

This field tells the world how this package should behave on multi-arch installations. Real talk though: this field should not be present in packages that have the Architecture: all field. Like, don't even try it. She said no ๐Ÿšซ

Optional. Type: enum. Choice: 'no', 'same', 'foreign', 'allowed'.

Here's the tea on all the possible values:

  • 'allowed' โ€” lets reverse-dependencies say in their Depends field that they need a package from a foreign architecture, but otherwise? No effect at all. Support system only ๐Ÿซถ
  • 'foreign' โ€” the package is not co-installable with itself, but it should be allowed to satisfy the dependency of a package of a different arch from itself.
  • 'no' โ€” the package is not co-installable AND it must not be used to satisfy the dependency of any package of another architecture than its own. Hard no ๐Ÿ’€
  • 'same' โ€” the package is co-installable with itself, but it must not be used to satisfy the dependency of any package of a different architecture from itself.

๐Ÿ“ Section

Optional. Type: uniline.

Note: Section is computed with '$source' and with:
  • $source => "- - source Section"

๐Ÿฅ‡ Priority

Optional. Type: enum. Choice: 'required', 'important', 'standard', 'optional', 'extra'.

Note: Priority is computed with '$source' and with:
  • $source => "- - source Priority"

๐Ÿ’Ž Essential โ€” The package is essential as defined by Debian Policy

The package is an essential package as defined by Debian Policy. The following rules apply to it, and these are not vibes, these are LAW:

  • Essential packages are considered essential for the system to work. The packaging system (APT and dpkg) will warn you and refuse to uninstall them without some very insistent force options. She will NOT go quietly ๐Ÿ˜ค
  • Other packages are not required to declare explicit dependencies on essential packages as a side-effect of the above โ€” except as needed to ensure that the given essential package is upgraded to a given minimum version.
  • Once installed, essential packages must function at all times, no matter where dpkg is in its installation or upgrade process. During bootstrapping or installation, this requirement is relaxed. Okay that one's a little chill at least ๐Ÿ˜ฎโ€๐Ÿ’จ
Note: if you're looking for a way to prevent accidental uninstallation, please consider using "Protected: yes" instead.

Optional. Type: boolean.

๐Ÿšง XB-Important โ€” Obsolete and incomplete variant of the Protected field

This is the prototype field that led to Protected โ€” which should be used instead. It makes apt (but not dpkg, she said what she said) require extra confirmation before removing the package. Deprecated. Optional. Type: boolean.

upstream_default value:

no

๐Ÿ”’ Protected โ€” Mark as Protected (uninstall protection)

Declare this package as a system critical package. When the field is set to "yes", both apt and dpkg will assume that removing the package may break the system. As a consequence, they'll require extra confirmation (or "force" options) before removing the package. This field basically provides "uninstall" protection similar to that of "Essential" packages โ€” without the other benefits and requirements that come with "Essential" packages. In a Debian context, this field is generally applicable to packages like bootloaders, kernels, and other packages that might be necessary for booting the system. She's the bodyguard ๐Ÿซก

Optional. Type: boolean.

upstream_default value:

no

Here's the breakdown of the possible values:

  • 'no' โ€” The package is a regular package. This is the default and recommended. โœจ
  • 'yes' โ€” The package is protected and attempts to uninstall it will cause strong warnings to the user that they might be breaking the system. ๐Ÿ˜ญ
Note: Protected is migrated with '$xbi' and with:
  • $xbi => "- XB-Important"

๐Ÿงฒ Depends โ€” declares an absolute dependency.

The Depends field should be used if the depended-on package is required for the depending package to provide a significant amount of functionality. See also debian policy at https://www.debian.org/doc/debian-policy/ch-relationships.html ๐Ÿ“–

Optional. Type: list of uniline.

๐Ÿ’ž Recommends โ€” declares a strong, but not absolute, dependency.

This field should list packages that would be found together with this one in all but unusual installations. See also debian policy at https://www.debian.org/doc/debian-policy/ch-relationships.html ๐Ÿ“–

Optional. Type: list of uniline.

๐Ÿ’… Suggests โ€” declare that one package may be more useful with one or more others.

Using this field tells the packaging system and the user that the listed packages are related to this one and can perhaps enhance its usefulness โ€” but that installing this one without them is perfectly reasonable. No pressure, no drama ๐Ÿ’… See also debian policy at https://www.debian.org/doc/debian-policy/ch-relationships.html ๐Ÿ“–

Optional. Type: list of uniline.

โœจ Enhances โ€” declare that a package can enhance the functionality of another package

This field is similar to Suggests but it works in the opposite direction. It's used to declare that a package can enhance the functionality of another package. See also debian policy at https://www.debian.org/doc/debian-policy/ch-relationships.html ๐Ÿ“–

Optional. Type: list of uniline.

โฐ Pre-Depends

This field is like Depends, except it also forces dpkg to complete installation of the packages named before even starting the installation of the package which declares the pre-dependency. She does not do things by halves. See also debian policy at https://www.debian.org/doc/debian-policy/ch-relationships.html ๐Ÿ“–

Optional. Type: list of uniline.

๐Ÿ’” Breaks

When one binary package declares that it breaks another, dpkg will refuse to allow the package which declares Breaks to be unpacked unless the broken package is deconfigured first, and it will refuse to allow the broken package to be reconfigured. See also debian policy at https://www.debian.org/doc/debian-policy/ch-relationships.html ๐Ÿ“–

Optional. Type: list of uniline.

โš”๏ธ Conflicts

When one binary package declares a conflict with another using a Conflicts field, dpkg will refuse to allow them to be unpacked on the system at the same time. This is a stronger restriction than Breaks, which prevents the broken package from being configured while the breaking package is in the "Unpacked" state but allows both packages to be unpacked at the same time. Conflicts says no to even that. See also debian policy at https://www.debian.org/doc/debian-policy/ch-relationships.html ๐Ÿ“–

Optional. Type: list of uniline.

๐ŸŽ Provides

Declare the functionality brought by this package. Bestie, please โ€” be SURE to read the chapter about virtual package in debian policy at https://www.debian.org/doc/debian-policy/ch-relationships.html before using this parameter, don't just wing it ๐Ÿซถ

Optional. Type: list of uniline.

โ™ป๏ธ Replaces

Declare that this package should overwrite files in certain other packages, or completely replace other packages. Be sure to read the section 7.6 of debian policy at https://www.debian.org/doc/debian-policy/ch-relationships.html before using this parameter.

Optional. Type: list of uniline.

๐Ÿงฑ Built-Using โ€” Additional source packages used to build the binary

Some binary packages incorporate parts of other packages when built but do not have to depend on those packages. Examples include linking with static libraries or incorporating source code from another package during the build. In this case, the source packages of those other packages are a required part of the complete source โ€” like, the binary package is not reproducible without them.

A Built-Using field must list the corresponding source package for any such binary package incorporated during the build, including an "exactly equal" ("=") version relation on the version that was used to build that binary package.

A package using the source code from the gcc-4.6-source binary package built from the gcc-4.6 source package would have this field in its control file:

Built-Using: gcc-4.6 (= 4.6.0-11)

A package including binaries from grub2 and loadlin would have this field in its control file:

Built-Using: grub2 (= 1.99-9), loadlin (= 1.6e-1)
I< Optional. Type list of uniline.  >

๐Ÿ“ฆ Package-Type โ€” The type of the package, if not a regular Debian one

If this field is present, the package is not a regular Debian package โ€” it's either a udeb generated for the Debian installer or a tdeb containing translated debconf strings. Optional. Type: enum. Choice: 'tdeb', 'udeb'.

Note: Package-Type is migrated with '$xc' and with:
  • $xc => "- XC-Package-Type"

๐Ÿท๏ธ XC-Package-Type โ€” The type of the package, if not a regular Debian one

If this field is present, the package is not a regular Debian package โ€” it's either a udeb generated for the Debian installer or a tdeb containing translated debconf strings. Deprecated. Optional. Type: enum. Choice: 'tdeb', 'udeb'.

๐Ÿ“ Synopsis

In a source template control file or binary control file, the Description field contains a description of the binary package, consisting of two parts: the synopsis, aka the short description, and the long description.

Im cme, the 2 parts have their own entry: Synopsis and Description.

This is the Synopsis, i.e. the first part. Mandatory. Type: uniline.

๐Ÿ“– Description

In a source template control file or binary control file, the Description field contains a description of the binary package, consisting of two parts: the synopsis or the short description, and the long description.

Im cme, the 2 parts have their own entry: Synopsis and Description.

This is the long description, i.e. the 2nd part. Mandatory. Type: string.

๐Ÿ  Homepage

Optional. Type: uniline.

๐Ÿ XB-Python-Version

Deprecated. Optional. Type: uniline.

๐Ÿ’— XB-Ruby-Versions

Indicate the versions of the interpreter supported by the library. Deprecated. Optional. Type: uniline.

๐Ÿ’  X-DhRuby-Root โ€” For multi-binary layout with the dh_ruby tool

Used by "dh_ruby" to request "multi-binary" layout and where the root for the given package is.

Please refer to dh_ruby documentation at https://manpages.debian.org/dh_ruby for more details. Optional. Type: uniline.


...and bestie, we are NOT done yet ๐Ÿซข part 2 is coming, don't you dare close the tab ๐Ÿ’–๐ŸŒ€

๐ŸŒˆ Build-Profiles ๐ŸŒˆ

okay so Build-Profiles says the condition for which a binary package does or does not build โ€” like, build or don't build, that's the whole vibe.

It's written as a list of lists of (optionally negated) profile names, which forms a conjunctive normal form expression, using the exact same syntax as the Build-Depends field. fancy, i know ๐Ÿ’…

for instance:

Build-Profiles: <!cross> <!nocheck>

peep <https://wiki.debian.org/BuildProfileSpec#The_Build-Profiles_field> for more details. Optional. Type uniline.


๐ŸŽ€ XB-Installer-Menu-Item - Package's order in the debian-installer menu (udeb-only) ๐ŸŽ€

so this field is only relevant for udeb packages (debian-installer). not your regular packages, bestie.

It's used to declare where in the installer menu this package's menu item should be placed (assuming it has any menu item at all). And heads up: for packages targeting the Debian archive, any new package should have its menu item number aligned with the debian-installer team before upload โ€” like, talk to them first, no cap.

A menu item is 4-5 digits (in the range 1000 <= X <= 99999). In rare cases, the menu item can be architecture dependent. For architecture dependent menu item values, use a custom substvar. โœจ

See <https://d-i.debian.org/doc/internals/apa.html> for the full list of menu item ranges and for how to request a number. Optional. Type uniline.


๐Ÿ’€ X-DH-Build-For-Type - For cross-compiling cross-compilers ๐Ÿ’€

Special-purpose only. This field is a special purpose field and is rarely needed. Leave it out unless you know you need it or someone told you to use it. fr fr, do not just vibe-add this one.

This field is used when building a cross-compiling C-compiler (or similar cases). Some packages need to be built for the target (DEB_TARGET_ARCH) rather than the host (DEB_HOST_ARCH) architecture. Optional. Type enum. choice: 'host', 'target'.

upstream_default value:

host

Here are some explanations on the possible values:

  • 'host' โ€” The package should be compiled for DEB_HOST_ARCH, which is the default behavior. (the chill, normal one ๐Ÿซถ)
  • 'target' โ€” The package should be compiled for DEB_TARGET_ARCH.

For steps that look at the values from dpkg-architecture and that are specific to this package, the DEB_TARGET_ variants are used instead of the DEB_HOST_ variants. In debhelper, this usually affects dh_makeshlibs and dh_shlibdeps. In debputy, it affects the parts of the manifest that are run in a package specific context, such as the parts beneath the packages root-level keyword.

This value is exceedingly rare to the point where if you do not know you need it, then you are not looking for this value (or the field in general). ๐Ÿ˜ญ like literally, if you gotta ask...


โญ X-Time64-Compat - (Special purpose) Compat name for time64_t transition โญ

Special purpose field related to the 64-bit time transition. ๐Ÿ‘‘

It is used to inform packaging helpers what the original (non-transitioned) package name was when the auto-detection is inadequate. The non-transitioned package name is then conditionally provided in the ${{t64:Provides}} substitution variable.

The field only works for architecture dependent packages. Optional. Type uniline.


๐Ÿ‘‘ SEE ALSO ๐Ÿ‘‘

  • cme

๐Ÿ’– AUTHOR ๐Ÿ’–

Dominique Dumont


2010,2011 Dominique Dumont


๐ŸŽ€ LICENSE ๐ŸŽ€

LGPL2


and that's a wrap, bestie!! ๐Ÿฆ‹โœจ this whole thing lives in perl v5.42.3, dated 2026-08-30, from the Config...Binary(3pm) era โ€” go forth and configure your binaries, you absolute main character ๐Ÿ’…๐ŸŒˆ

๐Ÿ“ฆ where this page comes from