/usr/share/doc/lifelines-doc/ll-userguide.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>&#13;
LifeLines Documentation
</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"></HEAD
><BODY
CLASS="book"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="BOOK"
><A
NAME="docbook"
></A
><DIV
CLASS="TITLEPAGE"
><H1
CLASS="title"
><A
NAME="AEN2"
><SPAN
CLASS="application"
>LifeLines</SPAN
> Documentation</A
></H1
><H2
CLASS="subtitle"
><SPAN
CLASS="application"
>LifeLines</SPAN
> Version 3.0.61</H2
>
      <H3
CLASS="author"
><A
NAME="AEN6"
></A
>Thomas T.  Wetmore , IV</H3
>
    <HR></DIV
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
>1. <A
HREF="#AEN12"
>Users' Manual</A
></DT
><DD
><DL
><DT
>1.1. <A
HREF="#AEN14"
>INTRODUCTION</A
></DT
><DT
>1.2. <A
HREF="#AEN52"
>INSTALLATION</A
></DT
><DT
>1.3. <A
HREF="#AEN86"
>STARTING <SPAN
CLASS="application"
>LIFELINES</SPAN
> AND CREATING DATABASES</A
></DT
><DT
>1.4. <A
HREF="#AEN190"
></A
></DT
></DL
></DD
></DL
></DIV
>

  

  <DIV
CLASS="chapter"
><HR><H1
><A
NAME="AEN12"
></A
>Chapter 1. 

Users' Manual

</H1
>

    

    <DIV
CLASS="sect1"
><HR><H2
CLASS="sect1"
><A
NAME="AEN14"
>1.1. INTRODUCTION</A
></H2
>


      



<P
>&#13;
     <SPAN
CLASS="application"
>LifeLines</SPAN
> is a genealogy program
     that runs on <ACRONYM
CLASS="acronym"
>UNIX</ACRONYM
> systems. It maintains
     genealogical records (persons, families, sources, events and
     others) in a database, and generates reports from those
     records. There are no practical limits on the number of
     records that can be stored in a
     <SPAN
CLASS="application"
>LifeLines</SPAN
> database, nor on the
     amounts or kinds of data that can be kept in the
     records. <SPAN
CLASS="application"
>LifeLines</SPAN
> does not contain
     built-in reports.  Instead it provides a programming subsystem
     that you use to program your own reports and charts. The
     programming subsystem also lets you query your databases and
     process your data in any
     way. <SPAN
CLASS="application"
>LifeLines</SPAN
> uses the terminal
     independent features of <ACRONYM
CLASS="acronym"
>UNIX</ACRONYM
> to provide a
     screen and menu based user interface.

</P
>



<P
>&#13;
     <SPAN
CLASS="application"
>LifeLines</SPAN
> is a non-commercial,
     experimental system that is use at your own risk software. I
     developed <SPAN
CLASS="application"
>LifeLines</SPAN
> for personal
     use and shared it with friends. Enough of a demand arose
     through word of mouth and internet, that I have made the
     <SPAN
CLASS="application"
>LifeLines</SPAN
> source code and other
     information freely available under an MIT-style license
     reproduced below:

</P
>

<P
>&#13;     <SPAN
CLASS="QUOTE"
>"
Copyright (c) 1991-1999 Thomas T. Wetmore IV

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

     "</SPAN
>

</P
>

<P
>&#13;
     The source code, documentation and a collection of report
     scripts are located at <A
HREF="http://lifelines.sourceforge.net/"
TARGET="_top"
>&#13;     http://lifelines.sourceforge.net/</A
>.  You can also find
     binary kits for some platforms.  If you are a developer and
     wish to contribute enhancements, please sign up on sourceforge
     and contact <A
HREF="mailto:marc@nozell.com"
TARGET="_top"
> Marc
     Nozell</A
> who is currently managing the project.
     </P
>

     <DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>&#13;     <P
>&#13;     Prior to 1999, Lifelines was available on the ftp sites,
     <A
HREF="ftp://ftp.cac.psu.edu"
TARGET="_top"
>ftp.cac.psu.edu</A
> and
     <A
HREF="ftp://hoth.stsci.edu"
TARGET="_top"
>hoth.stsci.edu</A
>.
     Please use sourceforge instead.
     </P
>
     </TD
></TR
></TABLE
></DIV
>

<P
>&#13;Other sources of information include:

<DIV
CLASS="informaltable"
><P
></P
><A
NAME="AEN37"
></A
>
<TABLE
BORDER="0"
FRAME="void"
CLASS="CALSTABLE"
><COL><COL>

</TABLE
>
<P
></P
></DIV
>

</P
>


</DIV
>



<DIV
CLASS="sect1"
><HR><H2
CLASS="sect1"
><A
NAME="AEN52"
>1.2. INSTALLATION</A
></H2
>



<P
>&#13;You may be installing <SPAN
CLASS="application"
>LifeLines</SPAN
>
from a source distribution package or as an executable program
already prepared for your <ACRONYM
CLASS="acronym"
>UNIX</ACRONYM
>
(or <ACRONYM
CLASS="acronym"
>MS-Windows</ACRONYM
>) system. The
source distribution comes with the readme, build script and
make files necessary to build
<SPAN
CLASS="application"
>LifeLines</SPAN
>. Follow the instructions
in the readme file.  A number of executables are built
which can be put it in a
directory in your execution path. If you get the program in
executable form, follow whatever instructions came with it.
The following executables are included:
</P
>
<DIV
CLASS="glosslist"
><DL
>&#13;
<DT
><B
><B
CLASS="command"
>btedit</B
></B
></DT
><DD
>&#13;<P
>&#13;a low-level editor for advanced debugging of broken <SPAN
CLASS="application"
>LifeLines</SPAN
> databases.
</P
>
</DD
>

<DT
><B
><B
CLASS="command"
>dbverify</B
></B
></DT
><DD
>&#13;<P
>&#13;a utility program to verify <SPAN
CLASS="application"
>LifeLines</SPAN
> databases.
</P
>
</DD
>

<DT
><B
><B
CLASS="command"
>llexec</B
></B
></DT
><DD
>&#13;<P
>&#13;a stripped down version of the
<SPAN
CLASS="application"
>LifeLines</SPAN
> program, without the user interface
for non-interactive processing of report programs
</P
>
</DD
>

<DT
><B
><B
CLASS="command"
>llines</B
></B
></DT
><DD
>&#13;<P
>&#13;the <SPAN
CLASS="application"
>LifeLines</SPAN
> program with full user interface
</P
>
</DD
>


</DL
></DIV
>

<P
>&#13;The source distribution package also contains documentation
and some <SPAN
CLASS="application"
>LifeLines</SPAN
> programs to demonstrate
the capabilities of the report language.
Included with these in the reports directory is a brief overview
of the reports in the file index.html.
</P
>


</DIV
>



<DIV
CLASS="sect1"
><HR><H2
CLASS="sect1"
><A
NAME="AEN86"
>1.3. STARTING <SPAN
CLASS="application"
>LIFELINES</SPAN
> AND CREATING DATABASES</A
></H2
>







<P
>&#13;
     You normally start <SPAN
CLASS="application"
>LifeLines</SPAN
> with
     the command: <KBD
CLASS="userinput"
><B
CLASS="command"
>llines</B
> <TT
CLASS="replaceable"
><I
>database</I
></TT
></KBD
> where
     database is the name of a <SPAN
CLASS="application"
>LifeLines</SPAN
>
     database. If <SPAN
CLASS="application"
>LifeLines</SPAN
> finds the
     database, <SPAN
CLASS="application"
>LifeLines</SPAN
> opens the
     database and takes you to the program's main menu. If the
     database doesn't exist, <SPAN
CLASS="application"
>LifeLines</SPAN
>
     asks whether it should create it, and if you answer yes, does
     so. You may create any number of databases, but only one can
     be accessed by <SPAN
CLASS="application"
>LifeLines</SPAN
> at a
     time. 

</P
>



<P
>&#13;
     The full command line interface to
     <SPAN
CLASS="application"
>LifeLines</SPAN
> is:

     <PRE
CLASS="synopsis"
>&#13;        <B
CLASS="command"
>llines</B
> <CODE
CLASS="option"
>[-acdfiklnortuwxzCFI]</CODE
><TT
CLASS="replaceable"
><I
>[database]</I
></TT
>
     </PRE
>

</P
>



<P
>&#13;
     The following options are supported:

</P
>

<DIV
CLASS="informaltable"
><P
></P
><A
NAME="AEN106"
></A
>
<TABLE
BORDER="0"
FRAME="void"
CLASS="CALSTABLE"
><COL
WIDTH="48"><COL>





































</TABLE
>
<P
></P
></DIV
>

<P
>&#13;the <CODE
CLASS="option"
>-o</CODE
> option specifies the initial filename to use for
output when running reports.  It only applies to reports run with the 
<CODE
CLASS="option"
>-x</CODE
> option.  This option has no effect on interactively run
programs.
</P
>

<P
>&#13;
     The <CODE
CLASS="option"
>-r</CODE
> option opens the database with read-only
     access. When in this mode
     <SPAN
CLASS="application"
>LifeLines</SPAN
> will not let you modify
     the database; no other operations are affected. The
     <CODE
CLASS="option"
>-w</CODE
> option opens the database with writeable
     access. If the database cannot be opened with the requested
     mode <SPAN
CLASS="application"
>LifeLines</SPAN
> quits
     immediately. When you open a database with neither the
     <CODE
CLASS="option"
>-r</CODE
> or <CODE
CLASS="option"
>-w</CODE
> options,
     <SPAN
CLASS="application"
>LifeLines</SPAN
> first tries to open the
     database with writeable access; if not possible
     <SPAN
CLASS="application"
>LifeLines</SPAN
> then tries to open the
     database with read-only access; and if this is not possible
     <SPAN
CLASS="application"
>LifeLines</SPAN
> quits. A
     <SPAN
CLASS="application"
>LifeLines</SPAN
> database may be open
     simultaneously by any number of programs with read-only
     access; however, if a database is open by a program with
     writeable access, then it cannot be opened by any other other
     program.

</P
>



<P
>&#13;
     In rare situations the read/write mode mechanism can fail;
     when this happens a database may appear unopenable. If this
     happens use the <CODE
CLASS="option"
>-f</CODE
> option to force open the
     database; this will open the database and reset the mode
     mechanism. This is a dangerous feature; you can use it to open
     the same database with writeable access more than once; the
     results are unpredictable and generally disastrous.

</P
>

<P
>&#13;
     The multiuser protection supplied by this reader/writer access
     mechanism is provided via a flag setting in the database, so both
     read-only and writeable access actually alter the database (read-only
     access only alters the value of this flag). For truly read-only
     access, e.g., for use with read-only media, the best solution is to
     lock (-ly) the      database before copying it to the read-only media. This
     annotates the database itself as being for immutable access.
     Alternatively, to use a database already on read-only media and not
     so annotated, use the immutable (-i) flag.

</P
>

<P
>&#13;By default lifelines supports a traditional family concept, that is, each
family has at most one father and one mother.  The -n flag relaxes this
restriction.  However, not all the code in lifelines supports these
relaxations.  For example, the default family browse screen will only display
two parents, however by switching to one of the gedcom modes of displaying the
family you can see all the data.
</P
>

<P
>&#13;
     If you don't give the name of a database on the command line,
     <SPAN
CLASS="application"
>LifeLines</SPAN
> will prompt you for
     it.  If the name you supply is an absolute pathname or a
     relative pathname it is used as the path to the database.
     If you provided a simple filename and you use the
     <CODE
CLASS="envar"
>LLDATABASES</CODE
> variable or user options (described later),
     <SPAN
CLASS="application"
>LifeLines</SPAN
> will search for the
     database in the directories named in the variable; this can be
     very convenient.
     If <CODE
CLASS="envar"
>LLDATABASES</CODE
> is not set
     the filename you enter is looked for in the current working directory.

</P
>

<P
>&#13;
     If you would like to choose a database from a list of existing ones,
     enter a single question mark and press return when
     <SPAN
CLASS="application"
>LifeLines</SPAN
> prompts you for the database name.
     <SPAN
CLASS="application"
>LifeLines</SPAN
> will then display a list of all
     databases that it can find, and you may select one from the list.

</P
>


</DIV
>



<DIV
CLASS="sect1"
><HR><H2
CLASS="sect1"
><A
NAME="AEN190"
>1.4. </A
></H2
>



</DIV
></DIV
></DIV
></BODY
></HTML
>
lifelines-doc 3.0.61-2 / usr / share / doc / lifelines-doc / ll-userguide.html
