Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

dpkg::control::fields(3) [linux man page]

Dpkg::Control::Fields(3)					   libdpkg-perl 					  Dpkg::Control::Fields(3)

NAME
Dpkg::Control::Fields - manage (list of official) control fields DESCRIPTION
The modules contains a list of fieldnames with associated meta-data explaining in which type of control information they are allowed. The types are the CTRL_* constants exported by Dpkg::Control. FUNCTIONS
my $f = field_capitalize($field_name) Returns the field name properly capitalized. All characters are lowercase, except the first of each word (words are separated by a dash in field names). field_is_official($fname) Returns true if the field is official and known. field_is_allowed_in($fname, @types) Returns true (1) if the field $fname is allowed in all the types listed in the list. Note that you can use type sets instead of individual types (ex: CTRL_FILE_CHANGES | CTRL_CHANGELOG). field_allowed_in(A|B, C) returns true only if the field is allowed in C and either A or B. Undef is returned for non-official fields. field_transfer_single($from, $to, $field) If appropriate, copy the value of the field named $field taken from the $from Dpkg::Control object to the $to Dpkg::Control object. Official fields are copied only if the field is allowed in both types of objects. Custom fields are treated in a specific manner. When the target is not among CTRL_PKG_SRC, CTRL_PKG_DEB or CTRL_FILE_CHANGES, then they are alway copied as is (the X- prefix is kept). Otherwise they are not copied except if the target object matches the target destination encoded in the field name. The initial X denoting custom fields can be followed by one or more letters among "S" (Source: corresponds to CTRL_PKG_SRC), "B" (Binary: corresponds to CTRL_PKG_DEB) or "C" (Changes: corresponds to CTRL_FILE_CHANGES). Returns undef if nothing has been copied or the name of the new field added to $to otherwise. field_transfer_all($from, $to) Transfer all appropriate fields from $from to $to. Calls field_transfer_single() on all fields available in $from. Returns the list of fields that have been added to $to. field_ordered_list($type) Returns an ordered list of fields for a given type of control information. This list can be used to output the fields in a predictable order. The list might be empty for types where the order does not matter much. field_list_src_dep() List of fields that contains dependencies-like information in a source Debian package. field_list_pkg_dep() List of fields that contains dependencies-like information in a binary Debian package. The fields that express real dependencies are sorted from the stronger to the weaker. field_get_dep_type($field) Return the type of the dependency expressed by the given field. Can either be "normal" for a real dependency field (Pre-Depends, Depends, ...) or "union" for other relation fields sharing the same syntax (Conflicts, Breaks, ...). Returns undef for fields which are not dependencies. field_register($field, $allowed_types, %opts) Register a new field as being allowed in control information of specified types. %opts is optional field_insert_after($type, $ref, @fields) Place field after another one ($ref) in output of control information of type $type. field_insert_before($type, $ref, @fields) Place field before another one ($ref) in output of control information of type $type. AUTHOR
Raphael Hertzog <hertzog@debian.org>. 1.16.0.3 2012-04-17 Dpkg::Control::Fields(3)

Check Out this Related Man Page

Dpkg::Control(3)						   libdpkg-perl 						  Dpkg::Control(3)

NAME
Dpkg::Control - parse and manipulate official control-like information DESCRIPTION
The Dpkg::Control object is a smart version of Dpkg::Control::Hash. It associates a type to the control information. That type can be used to know what fields are allowed and in what order they must be output. The types are constants that are exported by default. Here's the full list: CTRL_UNKNOWN This type is the default type, it indicates that the type of control information is not yet known. CTRL_INFO_SRC Corresponds to the first block of information in a debian/control file in a Debian source package. CTRL_INFO_PKG Corresponds to subsequent blocks of information in a debian/control file in a Debian source package. CTRL_INDEX_SRC Corresponds to an entry in a Sources file of a source package repository. CTRL_INDEX_PKG Corresponds to an entry in a Packages file of a binary package repository. CTRL_PKG_SRC Corresponds to a .dsc file of a Debian source package. CTRL_PKG_DEB Corresponds to the control file generated by dpkg-gencontrol (DEBIAN/control) and to the same file inside .deb packages. CTRL_FILE_CHANGES Corresponds to a .changes file. CTRL_FILE_VENDOR Corresponds to a vendor file in /etc/dpkg/origins/. CTRL_FILE_STATUS Corresponds to an entry in dpkg's status file (/var/lib/dpkg/status). CTRL_CHANGELOG Corresponds to the output of dpkg-parsechangelog. FUNCTIONS
All the methods of Dpkg::Control::Hash are available. Those listed below are either new or overridden with a different behaviour. my $c = Dpkg::Control->new(%opts) If the "type" option is given, it's used to setup default values for other options. See set_options() for more details. $c->set_options(%opts) Changes the value of one or more options. If the "type" option is changed, it is used first to define default values for others options. The option "allow_pgp" is set to 1 for CTRL_PKG_SRC and CTRL_FILE_CHANGES and to 0 otherwise. The option "drop_empty" is set to 0 for CTRL_INFO_PKG and CTRL_INFO_SRC and to 1 otherwise. The option "name" is set to a textual description of the type of control information. The output order is also set to match the ordered list returned by Dpkg::Control::Fields::field_ordered_list($type). $c->get_type() Returns the type of control information stored. See the type parameter set during new(). AUTHOR
Raphael Hertzog <hertzog@debian.org>. 1.16.15 2014-06-05 Dpkg::Control(3)
Man Page