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)

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

NAME

       Dpkg::Index - generic index of control information

DESCRIPTION

       This object represent a set of Dpkg::Control objects.

FUNCTIONS

       my $index = Dpkg::Index->new(%opts)
	   Creates a new empty index. See set_options() for more details.

       $index->set_options(%opts)
	   The "type" option is checked first to define default values for other options. Here are the relevant options: "get_key_func" is a
	   function returning a key for the item passed in parameters. The index can only contain one item with a given key. The function used
	   depend on the type: for CTRL_INFO_PKG, CTRL_INDEX_SRC, CTRL_INDEX_PKG and CTRL_PKG_DEB it's simply the Package field; for CTRL_PKG_SRC
	   and CTRL_INFO_SRC, it's the Source field; for CTRL_CHANGELOG it's the Source and the Version fields (concatenated with an intermediary
	   "_"); for CTRL_FILE_CHANGES it's the Source, Version and Architecture fields (concatenated with "_"); for CTRL_FILE_VENDOR it's the
	   Vendor field; for CTRL_FILE_STATUS it's the Package and Architecture fields (concatenated with "_"). Otherwise it's the Package field
	   by default.

       $index->get_type()
	   Returns the type of control information stored. See the type parameter set during new().

       $index->add($item, [$key])
	   Add a new item in the index. If the $key parameter is omitted, the key will be generated with the get_key_func function (see
	   set_options() for details).

       $index->load($file)
	   Reads the file and creates all items parsed. Returns the number of items parsed. Handles compressed files transparently based on their
	   extensions.

       $index->parse($fh, $desc)
	   Reads the filehandle and creates all items parsed. Returns the number of items parsed.

       $index->save($file)
	   Writes the content of the index in a file. Auto-compresses files based on their extensions.

       my $item = $index->new_item()
	   Creates a new item. Mainly useful for derived objects that would want to override this method to return something else than a
	   Dpkg::Control object.

       my $item = $index->get_by_key($key)
	   Returns the item identified by $key or undef.

       my @keys = $index->get_keys(%criteria)
	   Returns the keys of items that matches all the criteria. The key of the %criteria hash is a field name and the value is either a regexp
	   that needs to match the field value, or a reference to a function that must return true and that receives the field value as single
	   parameter, or a scalar that must be equal to the field value.

       my @items = $index->get(%criteria)
	   Returns all the items that matches all the criteria.

       $index->remove_by_key($key)
	   Remove the item identified by the given key.

       my @items = $index->remove(%criteria)
	   Returns and removes all the items that matches all the criteria.

       $index->merge($other_index, %opts)
	   Merge the entries of the other index. While merging, the keys of the merged index are used, they are not re-computed (unless you have
	   set the options "keep_keys" to "0"). It's your responsibility to ensure that they have been computed with the same function.

       $index->sort(&sortfunc)
	   Sort the index with the given sort function. If no function is given, an alphabetic sort is done based on the keys. The sort function
	   receives the items themselves as parameters and not the keys.

       my $str = $index->output()
       "$index"
	   Get a string representation of the index. The Dpkg::Control objects are output in the order which they have been read or added except
	   if the order hae been changed with sort().

       $index->output($fh)
	   Print the string representation of the index to a filehandle.

AUTHOR

       Raphael Hertzog <hertzog@debian.org>.

1.16.15 							    2014-06-05							    Dpkg::Index(3)