.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Dpkg::Control::FieldsCore 3"
.TH Dpkg::Control::FieldsCore 3 "2017-05-17" "1.18.24" "libdpkg-perl"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Dpkg::Control::FieldsCore \- manage (list of official) control fields
.SH "DESCRIPTION"
.IX Header "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.
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.ie n .IP "$f = field_capitalize($field_name)" 4
.el .IP "\f(CW$f\fR = field_capitalize($field_name)" 4
.IX Item "$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 hyphen in field names).
.IP "field_is_official($fname)" 4
.IX Item "field_is_official($fname)"
Returns true if the field is official and known.
.ie n .IP "field_is_allowed_in($fname, @types)" 4
.el .IP "field_is_allowed_in($fname, \f(CW@types\fR)" 4
.IX Item "field_is_allowed_in($fname, @types)"
Returns true (1) if the field \f(CW$fname\fR is allowed in all the types listed in
the list. Note that you can use type sets instead of individual types (ex:
\&\s-1CTRL_FILE_CHANGES\s0 | \s-1CTRL_CHANGELOG\s0).
.Sp
field_allowed_in(A|B, C) returns true only if the field is allowed in C
and either A or B.
.Sp
Undef is returned for non-official fields.
.ie n .IP "field_transfer_single($from, $to, $field)" 4
.el .IP "field_transfer_single($from, \f(CW$to\fR, \f(CW$field\fR)" 4
.IX Item "field_transfer_single($from, $to, $field)"
If appropriate, copy the value of the field named \f(CW$field\fR taken from the
\&\f(CW$from\fR Dpkg::Control object to the \f(CW$to\fR Dpkg::Control object.
.Sp
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 \s-1CTRL_PKG_SRC, CTRL_PKG_DEB\s0 or \s-1CTRL_FILE_CHANGES,\s0 then they
are always 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 \*(L"S\*(R" (Source: corresponds to \s-1CTRL_PKG_SRC\s0), \*(L"B\*(R"
(Binary: corresponds to \s-1CTRL_PKG_DEB\s0) or \*(L"C\*(R" (Changes: corresponds to
\&\s-1CTRL_FILE_CHANGES\s0).
.Sp
Returns undef if nothing has been copied or the name of the new field
added to \f(CW$to\fR otherwise.
.ie n .IP "field_transfer_all($from, $to)" 4
.el .IP "field_transfer_all($from, \f(CW$to\fR)" 4
.IX Item "field_transfer_all($from, $to)"
Transfer all appropriate fields from \f(CW$from\fR to \f(CW$to\fR. Calls
\&\fIfield_transfer_single()\fR on all fields available in \f(CW$from\fR.
.Sp
Returns the list of fields that have been added to \f(CW$to\fR.
.IP "field_ordered_list($type)" 4
.IX Item "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.
.IP "\fIfield_list_src_dep()\fR" 4
.IX Item "field_list_src_dep()"
List of fields that contains dependencies-like information in a source
Debian package.
.IP "\fIfield_list_pkg_dep()\fR" 4
.IX Item "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.
.IP "field_get_dep_type($field)" 4
.IX Item "field_get_dep_type($field)"
Return the type of the dependency expressed by the given field. Can
either be \*(L"normal\*(R" for a real dependency field (Pre-Depends, Depends, ...)
or \*(L"union\*(R" for other relation fields sharing the same syntax (Conflicts,
Breaks, ...). Returns undef for fields which are not dependencies.
.IP "field_get_sep_type($field)" 4
.IX Item "field_get_sep_type($field)"
Return the type of the field value separator. Can be one of \s-1FIELD_SEP_UNKNOWN,
FIELD_SEP_SPACE, FIELD_SEP_COMMA\s0 or \s-1FIELD_SEP_LINE.\s0
.ie n .IP "field_register($field, $allowed_types, %opts)" 4
.el .IP "field_register($field, \f(CW$allowed_types\fR, \f(CW%opts\fR)" 4
.IX Item "field_register($field, $allowed_types, %opts)"
Register a new field as being allowed in control information of specified
types. \f(CW%opts\fR is optional
.ie n .IP "field_insert_after($type, $ref, @fields)" 4
.el .IP "field_insert_after($type, \f(CW$ref\fR, \f(CW@fields\fR)" 4
.IX Item "field_insert_after($type, $ref, @fields)"
Place field after another one ($ref) in output of control information of
type \f(CW$type\fR.
.ie n .IP "field_insert_before($type, $ref, @fields)" 4
.el .IP "field_insert_before($type, \f(CW$ref\fR, \f(CW@fields\fR)" 4
.IX Item "field_insert_before($type, $ref, @fields)"
Place field before another one ($ref) in output of control information of
type \f(CW$type\fR.
.SH "CHANGES"
.IX Header "CHANGES"
.SS "Version 1.00 (dpkg 1.17.0)"
.IX Subsection "Version 1.00 (dpkg 1.17.0)"
Mark the module as public.