.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Gedcom::Family 3pm"
.TH Gedcom::Family 3pm "2022-10-16" "perl v5.34.0" "User Contributed Perl Documentation"
.\" 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"
Gedcom::Family \- a module to manipulate GEDCOM families
.PP
Version 1.22 \- 15th November 2019
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Gedcom::Family;
\&
\&  my @rel = $f\->husband;
\&  my @rel = $f\->wife;
\&  my @rel = $f\->parents;
\&  my $nch = $f\->number_of_children;
\&  my @rel = $f\->children;
\&  my @rel = $f\->boys;
\&  my @rel = $f\->girls;
\&  $f\->add_husband($i);
\&  $f\->add_wife($i);
\&  $f\->add_child($i);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
A selection of subroutines to handle families in a \s-1GEDCOM\s0 file.
.PP
Derived from Gedcom::Record.
.SH "HASH MEMBERS"
.IX Header "HASH MEMBERS"
None.
.SH "METHODS"
.IX Header "METHODS"
None yet.
.SS "Individual functions"
.IX Subsection "Individual functions"
.Vb 6
\&  my @rel = $f\->husband;
\&  my @rel = $f\->wife;
\&  my @rel = $f\->parents;
\&  my @rel = $f\->children;
\&  my @rel = $f\->boys;
\&  my @rel = $f\->girls;
.Ve
.PP
Return a list of individuals from family \f(CW$f\fR.
.PP
Each function, even those with a singular name such as \fBhusband()\fR,
returns a list of individuals holding that relation in \f(CW$f\fR.
.SS "number_of_children"
.IX Subsection "number_of_children"
.Vb 1
\&  my $nch = $f\->number_of_children;
.Ve
.PP
Return the number of children in the family, as specified or from
counting.
.SS "Add functions"
.IX Subsection "Add functions"
.Vb 3
\&  $f\->add_husband($i);
\&  $f\->add_wife($i);
\&  $f\->add_child($i);
.Ve
.PP
Add the specified individual to the family in the appropriate position.
.PP
These functions also take care of the references from the individual
back to the family, and are to be preferred to the low level addition
functions which do not do this.