.\" 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::Individual 3pm"
.TH Gedcom::Individual 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::Individual \- a module to manipulate GEDCOM individuals
.PP
Version 1.22 \- 15th November 2019
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Gedcom::Individual;
\&
\&  my $name = $i\->name;
\&  my $cased_name = $i\->cased_name;
\&  my $surname = $i\->surname;
\&  my $given_names = $i\->given_names;
\&  my $soundex = $i\->soundex;
\&  my $sex = $i\->sex;
\&  my @rel = $i\->father;
\&  my @rel = $i\->mother;
\&  my @rel = $i\->parents;
\&  my @rel = $i\->husband;
\&  my @rel = $i\->wife;
\&  my @rel = $i\->spouse;
\&  my @rel = $i\->siblings;
\&  my @rel = $i\->half_siblings;
\&  my @rel = $i\->brothers;
\&  my @rel = $i\->half_brothers;
\&  my @rel = $i\->sisters;
\&  my @rel = $i\->half_sisters;
\&  my @rel = $i\->children;
\&  my @rel = $i\->sons;
\&  my @rel = $i\->daughters;
\&  my @rel = $i\->descendents;
\&  my @rel = $i\->ancestors;
\&  my $ok  = $i\->delete;
\&
\&  my @fam = $i\->famc;
\&  my @fam = $i\->fams;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
A selection of subroutines to handle individuals in a \s-1GEDCOM\s0 file.
.PP
Derived from Gedcom::Record.
.SH "HASH MEMBERS"
.IX Header "HASH MEMBERS"
None.
.SH "METHODS"
.IX Header "METHODS"
.SS "name"
.IX Subsection "name"
.Vb 1
\&  my $name = $i\->name;
.Ve
.PP
Return the name of the individual, with spaces normalised.
.SS "cased_name"
.IX Subsection "cased_name"
.Vb 1
\&  my $cased_name = $i\->cased_name;
.Ve
.PP
Return the name of the individual, with spaces normalised, and surname
in upper case.
.SS "surname"
.IX Subsection "surname"
.Vb 1
\&  my $surname = $i\->surname;
.Ve
.PP
Return the surname of the individual.
.SS "given_names"
.IX Subsection "given_names"
.Vb 1
\&  my $given_names = $i\->given_names;
.Ve
.PP
Return the given names of the individual, with spaces normalised.
.SS "soundex"
.IX Subsection "soundex"
.Vb 1
\&  my $soundex = $i\->soundex;
.Ve
.PP
Return the soundex code of the individual.  This function is only
available if \fIText::Soundex.pm\fR is available.
.SS "sex"
.IX Subsection "sex"
.Vb 1
\&  my $sex = $i\->sex;
.Ve
.PP
Return the sex of the individual, \*(L"M\*(R", \*(L"F\*(R" or \*(L"U\*(R".
.SS "Individual functions"
.IX Subsection "Individual functions"
.Vb 10
\&  my @rel = $i\->father;
\&  my @rel = $i\->mother;
\&  my @rel = $i\->parents;
\&  my @rel = $i\->husband;
\&  my @rel = $i\->wife;
\&  my @rel = $i\->spouse;
\&  my @rel = $i\->siblings;
\&  my @rel = $i\->half_siblings;
\&  my @rel = $i\->older_siblings;
\&  my @rel = $i\->younger_siblings;
\&  my @rel = $i\->brothers;
\&  my @rel = $i\->half_brothers;
\&  my @rel = $i\->sisters;
\&  my @rel = $i\->half_sisters;
\&  my @rel = $i\->children;
\&  my @rel = $i\->sons;
\&  my @rel = $i\->daughters;
\&  my @rel = $i\->descendents;
\&  my @rel = $i\->ancestors;
.Ve
.PP
Return a list of individuals related to \f(CW$i\fR.
.PP
Each function, even those with a singular name such as \fBfather()\fR, returns
a list of individuals holding that relation to \f(CW$i\fR.
.PP
More complex relationships can easily be found using the map function.
eg:
.PP
.Vb 1
\&  my @grandparents = map { $_\->parents } $i\->parents;
.Ve
.SS "delete"
.IX Subsection "delete"
.Vb 1
\&  my $ok  = $i\->delete;
.Ve
.PP
Delete \f(CW$i\fR from the data structure.
.PP
This function will also set \f(CW$i\fR to undef.  This is to remind you that the
individual cannot be used again.
.PP
Returns true if \f(CW$i\fR was successfully deleted.
.SS "Family functions"
.IX Subsection "Family functions"
.Vb 2
\&  my @fam = $i\->famc;
\&  my @fam = $i\->fams;
.Ve
.PP
Return a list of families to which \f(CW$i\fR belongs.
.PP
\&\fBfamc()\fR returns those families in which \f(CW$i\fR is a child.
\&\fBfams()\fR returns those families in which \f(CW$i\fR is a spouse.