debian man page for gedcom::family

Gedcom::Family(3pm)					User Contributed Perl Documentation				       Gedcom::Family(3pm)

NAME
       Gedcom::Family - a module to manipulate Gedcom families

       Version 1.16 - 24th April 2009

SYNOPSIS
	 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);

DESCRIPTION
       A selection of subroutines to handle families in a gedcom file.

       Derived from Gedcom::Record.

HASH MEMBERS
       None.

METHODS
       None yet.

   Individual functions
	 my @rel = $f->husband;
	 my @rel = $f->wife;
	 my @rel = $f->parents;
	 my @rel = $f->children;
	 my @rel = $f->boys;
	 my @rel = $f->girls;

       Return a list of individuals from family $f.

       Each function, even those with a singular name such as husband(), returns a list of individuals holding that releation in $f.

   number_of_children
	 my $nch = $f->number_of_children;

       Return the number of children in the family, as specified or from counting.

   Add functions
	 $f->add_husband($i);
	 $f->add_wife($i);
	 $f->add_child($i);

       Add the specified individual to the family in the appropriate position.

       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.

perl v5.14.2							    2012-04-12						       Gedcom::Family(3pm)