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::Control::Hash(3)						   libdpkg-perl 					    Dpkg::Control::Hash(3)

NAME

       Dpkg::Control::Hash - parse and manipulate a block of RFC822-like fields

DESCRIPTION

       The Dpkg::Control::Hash object is a hash-like representation of a set of RFC822-like fields. The fields names are case insensitive and are
       always capitalized the same when output (see field_capitalize function in Dpkg::Control::Fields).  The order in which fields have been set
       is remembered and is used to be able to dump back the same content. The output order can also be overridden if needed.

       You can store arbitrary values in the hash, they will always be properly escaped in the output to conform to the syntax of control files.
       This is relevant mainly for multilines values: while the first line is always output unchanged directly after the field name, supplementary
       lines are modified. Empty lines and lines containing only dots are prefixed with " ." (space + dot) while other lines are prefixed with a
       single space.

       During parsing, trailing spaces are stripped on all lines while leading spaces are stripped only on the first line of each field.

FUNCTIONS

       my $c = Dpkg::Control::Hash->new(%opts)
	   Creates a new object with the indicated options. Supported options are:

	   allow_pgp
		   Configures the parser to accept PGP signatures around the control information. Value can be 0 (default) or 1.

	   allow_duplicate
		   Configures the parser to allow duplicate fields in the control information. Value can be 0 (default) or 1.

	   drop_empty
		   Defines if empty fields are dropped during the output. Value can be 0 (default) or 1.

	   name    The user friendly name of the information stored in the object. It might be used in some error messages or warnings. A default
		   name might be set depending on the type.

       $c->set_options($option, %opts)
	   Changes the value of one or more options.

       my $value = $c->get_option($option)
	   Returns the value of the corresponding option.

       $c->load($file)
	   Parse the content of $file. Exits in case of errors. Returns true if some fields have been parsed.

       $c->parse($fh, $description)
	   Parse a control file from the given filehandle. Exits in case of errors.  $description is used to describe the filehandle, ideally it's
	   a filename or a description of where the data comes from. It's used in error messages. Returns true if some fields have been parsed.

       $c->find_custom_field($name)
	   Scan the fields and look for a user specific field whose name matches the following regex: /X[SBC]*-$name/i. Return the name of the
	   field found or undef if nothing has been found.

       $c->get_custom_field($name)
	   Identify a user field and retrieve its value.

       $c->save($filename)
	   Write the string representation of the control information to a file.

       my $str = $c->output()
       "$c"
	   Get a string representation of the control information. The fields are sorted in the order in which they have been read or set except
	   if the order has been overridden with set_output_order().

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

       $c->set_output_order(@fields)
	   Define the order in which fields will be displayed in the output() method.

       $c->apply_substvars($substvars)
	   Update all fields by replacing the variables references with the corresponding value stored in the Dpkg::Substvars object.

AUTHOR

       Raphael Hertzog <hertzog@debian.org>.

1.16.0.3							    2012-04-17						    Dpkg::Control::Hash(3)