* doc/gramps.1.in, doc/gramps-manual/C/bugs.xml,
doc/gramps-manual/C/cmdline.xml, doc/gramps-manual/C/faq.xml, doc/gramps-manual/C/getstart.xml, doc/gramps-manual/C/gramps-manual.xml, doc/gramps-manual/C/mainwin.xml, doc/gramps-manual/C/preface.xml: Update. svn: r4491
This commit is contained in:
parent
8f8a0bb642
commit
f844356203
@ -1,3 +1,11 @@
|
|||||||
|
2005-05-05 Alex Roitman <shura@gramps-project.org>
|
||||||
|
* doc/gramps.1.in, doc/gramps-manual/C/bugs.xml,
|
||||||
|
doc/gramps-manual/C/cmdline.xml, doc/gramps-manual/C/faq.xml,
|
||||||
|
doc/gramps-manual/C/getstart.xml,
|
||||||
|
doc/gramps-manual/C/gramps-manual.xml,
|
||||||
|
doc/gramps-manual/C/mainwin.xml,
|
||||||
|
doc/gramps-manual/C/preface.xml: Update.
|
||||||
|
|
||||||
2005-05-05 Don Allingham <don@gramps-project.org>
|
2005-05-05 Don Allingham <don@gramps-project.org>
|
||||||
* src/plugins/PatchNames.py: handle multiple titles (bug 1196056)
|
* src/plugins/PatchNames.py: handle multiple titles (bug 1196056)
|
||||||
* src/plugins/ReorderIDs.py: bring up to speed with new handle/id methodology,
|
* src/plugins/ReorderIDs.py: bring up to speed with new handle/id methodology,
|
||||||
|
@ -24,4 +24,18 @@
|
|||||||
|
|
||||||
<title>Known Bugs and Limitations</title>
|
<title>Known Bugs and Limitations</title>
|
||||||
|
|
||||||
|
<para>The bugs are tracked through the
|
||||||
|
<ulink url="http://sourceforge.net/tracker/?group_id=25770&atid=385137" type="http">
|
||||||
|
sourceforge.net tracking system</ulink>.
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<para>The known limitations include the BSDDB performance issues related
|
||||||
|
to caching and the memory size. As long as the BSDDB cache fits completely
|
||||||
|
into the available memory on the system, the performance should be
|
||||||
|
adequate. When the cache size exceeds that of the free memory and
|
||||||
|
portions of database cache start to be swapped onto the disk, the performance
|
||||||
|
degrades appreciably. This can be solved by adjusting the BSDDB cache
|
||||||
|
size for the large databases.
|
||||||
|
</para>
|
||||||
|
|
||||||
</appendix >
|
</appendix >
|
||||||
|
@ -55,7 +55,7 @@
|
|||||||
<sect2 id="cmdline-opt-format"><title>Format options</title>
|
<sect2 id="cmdline-opt-format"><title>Format options</title>
|
||||||
<para> The format of any file destined for opening, importing,
|
<para> The format of any file destined for opening, importing,
|
||||||
or exporting can be specified with the
|
or exporting can be specified with the
|
||||||
<command>-f</command> <replaceable>format</replaceable>
|
<command>-f <replaceable>format</replaceable></command>
|
||||||
option. The acceptable <replaceable>format</replaceable> values
|
option. The acceptable <replaceable>format</replaceable> values
|
||||||
are listed below.</para>
|
are listed below.</para>
|
||||||
|
|
||||||
@ -113,8 +113,8 @@
|
|||||||
<listitem><para>supply bare file name</para></listitem>
|
<listitem><para>supply bare file name</para></listitem>
|
||||||
|
|
||||||
<listitem><para>use the
|
<listitem><para>use the
|
||||||
<command>-O <replaceable>filename</replaceable></command> or
|
<command>-O <filename>filename</filename></command> or
|
||||||
<command>-open=<replaceable>filename</replaceable></command> option
|
<command>-open=<filename>filename</filename></command> option
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
|
|
||||||
</itemizedlist>
|
</itemizedlist>
|
||||||
@ -132,18 +132,18 @@
|
|||||||
<para>The format can be specified with the
|
<para>The format can be specified with the
|
||||||
<command>-f <replaceable>format</replaceable></command> or
|
<command>-f <replaceable>format</replaceable></command> or
|
||||||
<command>--format=<replaceable>format</replaceable></command>
|
<command>--format=<replaceable>format</replaceable></command>
|
||||||
option, immediately following the <replaceable>filename</replaceable>.
|
option, immediately following the <filename>filename</filename>.
|
||||||
If not specified, the guess will be attempted based on
|
If not specified, the guess will be attempted based on
|
||||||
the <replaceable>filename</replaceable>. For <term>gramps-xml</term>
|
the <filename>filename</filename>. For gramps-xml
|
||||||
format, the <replaceable>filename</replaceable> is actually the
|
format, the <filename>filename</filename> is actually the
|
||||||
name of directory under which the gramps database resides. For
|
name of directory under which the gramps database resides. For
|
||||||
<term>grdb</term> and <term>gedcom</term>,
|
grdb and gedcom,
|
||||||
the <replaceable>filename</replaceable> is the name of the
|
the <filename>filename</filename> is the name of the
|
||||||
corresponding file.
|
corresponding file.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<tip><para>Only <term>grdb</term>, <term>gramps-xml</term>,
|
<tip><para>Only grdb, gramps-xml,
|
||||||
and <term>gedcom</term> formats can be opened directly.
|
and gedcom formats can be opened directly.
|
||||||
For other formats, you will need to use the import option
|
For other formats, you will need to use the import option
|
||||||
which will set up the empty database and then import data into it.
|
which will set up the empty database and then import data into it.
|
||||||
</para></tip>
|
</para></tip>
|
||||||
@ -156,19 +156,18 @@
|
|||||||
|
|
||||||
<sect2 id="cmdline-opt-import"><title>Import options</title>
|
<sect2 id="cmdline-opt-import"><title>Import options</title>
|
||||||
<para> The files destined for import can be specified with the
|
<para> The files destined for import can be specified with the
|
||||||
<command>-i <replaceable>filename</replaceable></command>
|
<command>-i <filename>filename</filename></command>
|
||||||
or <command>--import=<replaceable>filename</replaceable></command>
|
or <command>--import=<filename>filename</filename></command>
|
||||||
option. The format can be specified with the
|
option. The format can be specified with the
|
||||||
<command>-f <replaceable>format</replaceable></command> or
|
<command>-f <replaceable>format</replaceable></command> or
|
||||||
<command>--format=<replaceable>format</replaceable></command>
|
<command>--format=<replaceable>format</replaceable></command>
|
||||||
option, immediately following the <replaceable>filename</replaceable>.
|
option, immediately following the <filename>filename</filename>.
|
||||||
If not specified, the guess will be attempted based on
|
If not specified, the guess will be attempted based on
|
||||||
the <replaceable>filename</replaceable>. For <term>gramps-xml</term>
|
the <filename>filename</filename>. For gramps-xml
|
||||||
format, the <replaceable>filename</replaceable> is actually the
|
format, the <filename>filename</filename> is actually the
|
||||||
name of directory under which the gramps database resides. For
|
name of directory under which the gramps database resides. For
|
||||||
<term>grdb</term>, <term>gedcom</term>, <term>gramps-pkg</term>,
|
grdb, gedcom, gramps-pkg, and geneweb,
|
||||||
and <term>geneweb</term>,
|
the <filename>filename</filename> is the name of the
|
||||||
the <replaceable>filename</replaceable> is the name of the
|
|
||||||
corresponding file.
|
corresponding file.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
@ -179,28 +178,28 @@
|
|||||||
|
|
||||||
<para>When more than one input file is given, each has to be preceded
|
<para>When more than one input file is given, each has to be preceded
|
||||||
by <command>-i</command> flag. The files are imported in the
|
by <command>-i</command> flag. The files are imported in the
|
||||||
specified order, i.e.
|
specified order, i.e. <command>
|
||||||
<command>-i</command> <replaceable>file1</replaceable>
|
-i <filename>file1</filename>
|
||||||
<command>-i</command> <replaceable>file2</replaceable>
|
-i <filename>file2</filename>
|
||||||
and
|
</command> and <command>
|
||||||
<command>-i</command> <replaceable>file2</replaceable>
|
-i <filename>file2</filename>
|
||||||
<command>-i</command> <replaceable>file1</replaceable>
|
-i <filename>file1</filename>
|
||||||
|
</command>
|
||||||
might produce different gramps IDs in the resulting database.
|
might produce different gramps IDs in the resulting database.
|
||||||
</para></sect2>
|
</para></sect2>
|
||||||
|
|
||||||
<sect2 id="cmdline-opt-export"><title>Export options</title>
|
<sect2 id="cmdline-opt-export"><title>Export options</title>
|
||||||
<para> The files destined for export can be specified with the
|
<para> The files destined for export can be specified with the
|
||||||
<command>-o <replaceable>filename</replaceable></command> or
|
<command>-o <filename>filename</filename></command> or
|
||||||
<command>--output=<replaceable>filename</replaceable></command>
|
<command>--output=<filename>filename</filename></command>
|
||||||
option. The format can be specified with the <command>-f</command>
|
option. The format can be specified with the <command>-f</command>
|
||||||
option immediately following the <replaceable>filename</replaceable>.
|
option immediately following the <filename>filename</filename>.
|
||||||
If not specified, the guess will be attempted based on
|
If not specified, the guess will be attempted based on
|
||||||
the <replaceable>filename</replaceable>. For <term>gramps-xml</term>
|
the <filename>filename</filename>. For gramps-xml
|
||||||
and <term>iso</term> formats, the <replaceable>filename</replaceable>
|
and iso formats, the <filename>filename</filename>
|
||||||
is actually the name of directory the gramps database will be written
|
is actually the name of directory the gramps database will be written
|
||||||
into. For <term>grdb</term>, <term>gedcom</term>,
|
into. For grdb, gedcom, wft, geneweb,
|
||||||
<term>wft</term>, <term>geneweb</term>,
|
and gramps-pkg, the <filename>filename</filename>
|
||||||
and <term>gramps-pkg</term>, the <replaceable>filename</replaceable>
|
|
||||||
is the name of the resulting file.
|
is the name of the resulting file.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
@ -334,83 +333,181 @@
|
|||||||
<sect1 id="cmdline-operation">
|
<sect1 id="cmdline-operation">
|
||||||
<title>Operation</title>
|
<title>Operation</title>
|
||||||
|
|
||||||
|
<itemizedlist>
|
||||||
|
|
||||||
|
<listitem>
|
||||||
|
<para>If the first argument on the command line does not start
|
||||||
|
with dash (i.e. no flag), &app; will attempt to open the file
|
||||||
|
with the name given by the first argument and start interactive
|
||||||
|
session, ignoring the rest of the command line arguments.
|
||||||
|
</para></listitem>
|
||||||
|
|
||||||
|
<listitem>
|
||||||
|
<para>If the <command>-O</command> flag is given, then &app; will
|
||||||
|
try opening the
|
||||||
|
supplied file name and then work with that data, as instructed by
|
||||||
|
the further command line parameters.
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<note><para>Only one file can be opened in a single invokation
|
||||||
|
of &app;. If you need to get data from multiple sources, use
|
||||||
|
the importing options by using <command>-i</command> flag.
|
||||||
|
</para></note>
|
||||||
|
</listitem>
|
||||||
|
|
||||||
|
<listitem>
|
||||||
|
<para>With or without the <command>-O</command> flag, there could
|
||||||
|
be multiple imports, exports, and actions specified further on
|
||||||
|
the command line by using <command>-i</command>,
|
||||||
|
<command>-o</command>, and <command>-a</command> flags.
|
||||||
|
</para></listitem>
|
||||||
|
|
||||||
|
<listitem>
|
||||||
<para>The order of <command>-i</command>, <command>-o</command>,
|
<para>The order of <command>-i</command>, <command>-o</command>,
|
||||||
or <command>-a</command> options with respect to each does not matter.
|
or <command>-a</command> options with respect to each does not matter.
|
||||||
The actual execution order always is: all imports (if any) -> all
|
The actual execution order always is: all imports (if any) -> all
|
||||||
exports (if any) -> all actions (if any).</para>
|
exports (if any) -> all actions (if any).</para>
|
||||||
|
|
||||||
<para>If no <command>-i</command> option is given, gramps will launch
|
<note><para>But opening must always be first!</para></note>
|
||||||
|
</listitem>
|
||||||
|
|
||||||
|
<listitem>
|
||||||
|
<para>If no <command>-O</command> or <command>-i</command>
|
||||||
|
option is given, gramps will launch
|
||||||
its main window and start the usual interactive session with the empty
|
its main window and start the usual interactive session with the empty
|
||||||
database (since there is no data to process, anyway).</para>
|
database, since there is no data to process, anyway.
|
||||||
|
</para></listitem>
|
||||||
|
|
||||||
|
<listitem>
|
||||||
<para>If no <command>-o</command> or <command>-a</command> options
|
<para>If no <command>-o</command> or <command>-a</command> options
|
||||||
are given, gramps will launch its main window and start the usual
|
are given, gramps will launch its main window and start the usual
|
||||||
interactive session with the database resulted from all imports.
|
interactive session with the database resulted from opening
|
||||||
This database resides under
|
and all imports (if any). This database resides in the
|
||||||
<replaceable>~/.gramps/import</replaceable> directory.</para>
|
<filename>import_db.grdb</filename> file under the
|
||||||
|
<filename>~/.gramps/import/</filename> directory.
|
||||||
|
</para></listitem>
|
||||||
|
|
||||||
|
<listitem>
|
||||||
<para>Any errors encountered during import, export, or action, will
|
<para>Any errors encountered during import, export, or action, will
|
||||||
be either dumped to stdout (if these are exceptions handled by gramps)
|
be either dumped to stdout (if these are exceptions handled by gramps)
|
||||||
or or to stderr (if these are not handled). Use usual shell redirections
|
or or to stderr (if these are not handled). Use usual shell redirections
|
||||||
of stdout and stderr to save messages and errors in files.</para>
|
of stdout and stderr to save messages and errors in files.
|
||||||
|
</para></listitem>
|
||||||
|
|
||||||
|
</itemizedlist>
|
||||||
|
|
||||||
</sect1>
|
</sect1>
|
||||||
|
|
||||||
<sect1 id="cmdline-examples">
|
<sect1 id="cmdline-examples">
|
||||||
<title>Examples</title>
|
<title>Examples</title>
|
||||||
<para>To import four databases (whose formats can be determined from
|
|
||||||
|
<variablelist>
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<term>To import four databases (whose formats can be determined from
|
||||||
their names) and then check the resulting database for errors, one may
|
their names) and then check the resulting database for errors, one may
|
||||||
type:</para>
|
type:</term>
|
||||||
<para><command>gramps -i</command> <replaceable>file1.ged</replaceable>
|
|
||||||
<command>-i</command> <replaceable>file2.tgz</replaceable>
|
<listitem>
|
||||||
<command>-i</command> <replaceable>~/db3</replaceable>
|
<para><command>gramps
|
||||||
<command>-i</command> <replaceable>file4.wft</replaceable>
|
-i<filename>file1.ged</filename>
|
||||||
<command>-a</command> <replaceable>check</replaceable>
|
-i <filename>file2.tgz</filename>
|
||||||
|
-i <filename>~/db3</filename>
|
||||||
|
-i <filename>file4.wft</filename>
|
||||||
|
-a <filename>check</filename></command>
|
||||||
|
</para> </listitem></varlistentry>
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<term>To explicitly specify the formats in the above example, append
|
||||||
|
filenames with appropriate <command>-f</command> options:</term>
|
||||||
|
<listitem>
|
||||||
|
<para><command>gramps
|
||||||
|
-i <filename>file1.ged</filename>
|
||||||
|
-f <replaceable>gedcom</replaceable>
|
||||||
|
-i <filename>file2.tgz</filename>
|
||||||
|
-f <replaceable>gramps-pkg</replaceable>
|
||||||
|
-i <filename>~/db3</filename>
|
||||||
|
-f <replaceable>gramps</replaceable>
|
||||||
|
-i <filename>file4.wft</filename>
|
||||||
|
-f <replaceable>wft</replaceable>
|
||||||
|
-a <replaceable>check</replaceable></command>
|
||||||
|
</para></listitem>
|
||||||
|
</varlistentry>
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<term>To record the database resulting from all imports, supply
|
||||||
|
<command>-o</command> flag (use <command>-f</command>
|
||||||
|
if the filename does not allow gramps to guess the format):</term>
|
||||||
|
<listitem>
|
||||||
|
<para><command>gramps
|
||||||
|
-i <filename>file1.ged</filename>
|
||||||
|
-i <filename>file2.tgz</filename>
|
||||||
|
-o <filename>~/new-package</filename>
|
||||||
|
-f <replaceable>gramps-pkg</replaceable></command>
|
||||||
|
</para></listitem>
|
||||||
|
</varlistentry>
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<term>To save any error messages of the above example into files
|
||||||
|
<filename>outfile</filename> and
|
||||||
|
<filename>errfile</filename>, run:</term>
|
||||||
|
<listitem>
|
||||||
|
<para><command>gramps
|
||||||
|
-i <filename>file1.ged</filename>
|
||||||
|
-i <filename>file2.tgz</filename>
|
||||||
|
-o <filename>~/new-package</filename>
|
||||||
|
-f <replaceable>gramps-pkg</replaceable>
|
||||||
|
><filename>outfile</filename>
|
||||||
|
2><filename>errfile</filename> </command>
|
||||||
|
</para></listitem>
|
||||||
|
</varlistentry>
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<term>To import three databases and start interactive gramps
|
||||||
|
session with the result:</term>
|
||||||
|
<listitem>
|
||||||
|
<para><command>gramps
|
||||||
|
-i <filename>file1.ged</filename>
|
||||||
|
-i <filename>file2.tgz</filename>
|
||||||
|
-i <filename>~/db3</filename>
|
||||||
|
</command>
|
||||||
|
</para> </listitem>
|
||||||
|
</varlistentry>
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<term>To open a database and, based on that data, generate timeline
|
||||||
|
report in PDF format putting the output into the
|
||||||
|
<filename>my_timeline.pdf</filename> file:</term>
|
||||||
|
<listitem>
|
||||||
|
<para><command>gramps
|
||||||
|
-O <filename>file.grdb</filename>
|
||||||
|
-a <replaceable>report</replaceable>
|
||||||
|
-p <replaceable>name=timeline,off=pdf,of=my_timeline.pdf</replaceable>
|
||||||
|
</command>
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>To explicitly specify the formats in the above example, append
|
<tip><para>Use the <replaceable>name=timeline,show=all</replaceable>
|
||||||
filenames with appropriate <command>-f</command> options:</para>
|
to find out about all available options for the timeline report. To
|
||||||
<para><command>gramps -i</command> <replaceable>file1.ged</replaceable>
|
find out details of a particular option, use
|
||||||
<command>-f</command> <replaceable>gedcom</replaceable>
|
<replaceable>show=option_name</replaceable>,
|
||||||
<command>-i</command> <replaceable>file2.tgz</replaceable>
|
e.g. <replaceable>name=timeline,show=off</replaceable>
|
||||||
<command>-f</command> <replaceable>gramps-pkg</replaceable>
|
string.</para>
|
||||||
<command>-i</command> <replaceable>~/db3</replaceable>
|
|
||||||
<command>-f</command> <replaceable>gramps</replaceable>
|
<para>To learn about available report names, use
|
||||||
<command>-i</command> <replaceable>file4.wft</replaceable>
|
<replaceable>name=show</replaceable> string.
|
||||||
<command>-f</command> <replaceable>wft</replaceable>
|
|
||||||
<command>-a</command> <replaceable>check</replaceable>
|
|
||||||
</para>
|
</para>
|
||||||
|
</tip>
|
||||||
|
|
||||||
<para>To record the database resulting from all imports, supply
|
</listitem>
|
||||||
<command>-o</command> flag (use <command>-f</command>
|
</varlistentry>
|
||||||
if the filename does not allow gramps to guess the format):</para>
|
|
||||||
<para><command>gramps -i</command> <replaceable>file1.ged</replaceable>
|
<varlistentry>
|
||||||
<command>-i</command> <replaceable>file2.tgz</replaceable>
|
<term>Finally, to start normal interactive session type:</term>
|
||||||
<command>-o</command> <replaceable>~/new-package</replaceable>
|
<listitem><para> <command>gramps </command></para></listitem>
|
||||||
<command>-f</command> <replaceable>gramps-pkg</replaceable>
|
</varlistentry>
|
||||||
</para>
|
|
||||||
|
</variablelist>
|
||||||
<para>To save any error messages of the above example into files
|
|
||||||
<replaceable>outfile</replaceable> and
|
|
||||||
<replaceable>errfile</replaceable>, run:</para>
|
|
||||||
<para><command>gramps -i</command> <replaceable>file1.ged</replaceable>
|
|
||||||
<command>-i</command> <replaceable>file2.tgz</replaceable>
|
|
||||||
<command>-o</command> <replaceable>~/new-package</replaceable>
|
|
||||||
<command>-f</command> <replaceable>gramps-pkg</replaceable>
|
|
||||||
><replaceable>outfile</replaceable>
|
|
||||||
2><replaceable>errfile</replaceable>
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<para>To import three databases and start interactive gramps
|
|
||||||
session with the result:</para>
|
|
||||||
<para><command>gramps -i</command> <replaceable>file1.ged</replaceable>
|
|
||||||
<command>-i</command> <replaceable>file2.tgz</replaceable>
|
|
||||||
<command>-i</command> <replaceable>~/db3</replaceable>
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<para>Finally, to start normal interactive session type:</para>
|
|
||||||
<para> <command>gramps </command></para>
|
|
||||||
|
|
||||||
</sect1>
|
</sect1>
|
||||||
|
|
||||||
</appendix>
|
</appendix>
|
||||||
|
@ -61,13 +61,15 @@ This, however, may change in the future.
|
|||||||
|
|
||||||
<varlistentry><term>Does it work with the Mac?</term>
|
<varlistentry><term>Does it work with the Mac?</term>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
The Fink project (<ulink url="http://fink.sf.net"
|
<ulink url="http://fink.sourceforge.net"
|
||||||
type="http">http://fink.sf.net</ulink>) has ported an old version of
|
type="http">The Fink project</ulink> has ported
|
||||||
&app; (0.8.0) to OSX. The Mac OSX port is not directly supported by
|
<ulink url="http://fink.sourceforge.net/pdb/package.php/gramps"
|
||||||
|
type="http">some older versions</ulink> of
|
||||||
|
&app; to OSX. The Mac OSX port is not directly supported by
|
||||||
the &app; project, primarily because none of the &app; developers
|
the &app; project, primarily because none of the &app; developers
|
||||||
have access to Mac OSX.</para>
|
have access to Mac OSX and because OSX is not Free Software.</para>
|
||||||
|
|
||||||
<para>The GNOME 2 version of &app; (0.9.x) does not appear to have been
|
<para>This version of &app; (&appversion;) does not appear to have been
|
||||||
ported by the Fink project. Please contact the Fink project for more
|
ported by the Fink project. Please contact the Fink project for more
|
||||||
information.
|
information.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
@ -86,8 +88,8 @@ Yes, as long as the required GNOME libraries are installed.
|
|||||||
|
|
||||||
<varlistentry><term>What version of GNOME do I need?</term>
|
<varlistentry><term>What version of GNOME do I need?</term>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
The latest versions of gramps (0.9.0 and higher) require GNOME 2.0 or higher.
|
This version of gramps requires GNOME 2.8.0 or higher.
|
||||||
Previous versions required GNOME 1.X.
|
Previous versions in 1.0.x series required GNOME 2.0.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
|
||||||
@ -137,7 +139,7 @@ their own plugins which could be new reports, charts, or research tools.
|
|||||||
<listitem><para>
|
<listitem><para>
|
||||||
Text reports are available in HTML, PDF, AbiWord, KWord, LaTeX, RTF, and
|
Text reports are available in HTML, PDF, AbiWord, KWord, LaTeX, RTF, and
|
||||||
OpenOffice formats. Graphical reports (charts and diagrams) are available in
|
OpenOffice formats. Graphical reports (charts and diagrams) are available in
|
||||||
PostScript, PDF, SVG, OpenOffice and GraphViz formats.
|
PostScript, PDF, SVG, OpenOffice, and GraphViz formats.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
|
||||||
@ -181,43 +183,34 @@ Visual Genealogie.
|
|||||||
size (bytes) &app; can handle?</term>
|
size (bytes) &app; can handle?</term>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
&app; has no hard limits on the size of a database that it can handle.
|
&app; has no hard limits on the size of a database that it can handle.
|
||||||
In reality, however, there are practical limits. Currently &app; loads all
|
Starting with this release, &app; no longer loads all data into memory,
|
||||||
data into memory, so the limiting factor tends to be the available memory
|
which allows it to work with much larger database than before.
|
||||||
on the system.
|
In reality, however, there are practical limits. The main limiting factors
|
||||||
|
are the available memory on the system and the cache size used for BSDDB
|
||||||
|
database access. With common memory sizes these days, &app; should have
|
||||||
|
no problem using databases with tens of thousands of people.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
|
||||||
<varlistentry><term>How many people can &app; database handle?</term>
|
<varlistentry><term>How many people can &app; database handle?</term>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
We have found that on a typical system, &app; tends to bog down after the
|
We have found that on a typical system, &app; tends to bog down after the
|
||||||
database has around 15,000 people. Again, this is dependant on how much
|
database has around 150,000 people. Again, this is dependant on how much
|
||||||
memory you have.
|
memory you have.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
|
||||||
<varlistentry><term>Why is &app; running so slowly?</term>
|
<varlistentry><term>Why is &app; running so slowly?</term>
|
||||||
<listitem><para>
|
<listitem><para> It does not anymore! Just try out the current
|
||||||
If &app; seems too slow to you, it is most likely that you have a large
|
version, &appversion;.
|
||||||
database. Currently, &app; loads all the database into memory, therefore
|
|
||||||
large databases tend to be less than responsive. Specifically, the system
|
|
||||||
can be virtually brought to its knees if swapping is needed for &app;' data.
|
|
||||||
</para> <para>
|
|
||||||
This will be addressed in the next stable release following version 1.0.
|
|
||||||
Temporarily, adding more memory could make a huge difference, but we realize
|
|
||||||
that this is a poor way of treating the problem. If you would like to help
|
|
||||||
with the implementation of the real database backend, please don't hesitate
|
|
||||||
to email us at <ulink url="mailto:gramps-devel@lists.sf.net"
|
|
||||||
type="mailto">gramps-devel@lists.sf.net</ulink>
|
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
|
||||||
<varlistentry><term>My database is really big.
|
<varlistentry><term>My database is really big.
|
||||||
Is there a way around loading all the data into memory?</term>
|
Is there a way around loading all the data into memory?</term>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
Currently, there is no way around it. However, this is our biggest priority
|
Starting with this release, &app; no longer loads all data into memory,
|
||||||
after releasing version 1.0. The real database backend will be incorporated
|
which allows it to work with much larger database than before.
|
||||||
in the next stable release (1.2) which will dramatically improve performance
|
|
||||||
in both speed and memory usage.
|
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
|
||||||
@ -229,34 +222,30 @@ in both speed and memory usage.
|
|||||||
the flag needs to be reset. This can be done with the following
|
the flag needs to be reset. This can be done with the following
|
||||||
command: </para>
|
command: </para>
|
||||||
|
|
||||||
<para><command>gconftool-2 -u /apps/gramps/startup</command>
|
<para><command>gconftool-2 -u /apps/gramps/behavior/startup</command>
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
|
||||||
<varlistentry><term>Why are non-latin characters displayed
|
<varlistentry><term>Why are non-latin characters displayed
|
||||||
as garbage in PDF/PS reports?</term>
|
as garbage in PDF/PS reports?</term>
|
||||||
<listitem><para>
|
<listitem><para> This is a limitation of the builtin fonts of PS
|
||||||
This is a known problem -- PS (and PDF) have builtin fonts which pretty much
|
and PDF formats. To print non-latin text, use the Print...
|
||||||
reflect the latin-1 charset. Any font in principle could be used with PS/PDF
|
in the format selection menu of the report dialog. This will use
|
||||||
but then it would have to be embedded in the file. This is problematic since
|
the gnome-print backend, which supports PS and PDF creation,
|
||||||
every system has different idea about fonts and their setup.</para>
|
as well as direct printing.</para>
|
||||||
|
|
||||||
<para>
|
<para>If you only have latin text, the PDF option will produce
|
||||||
This should be resolved as we move to gnome-print. In the meantime, a useable
|
a smalled PDF compared to that created by gnome-print, simply because
|
||||||
workaround is to generate reports in OpenOffice.org format and then export
|
no font information will be embedded.
|
||||||
to PDF from the OpenOffice.org application.
|
</para>
|
||||||
</para></listitem>
|
|
||||||
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
|
||||||
<varlistentry><term>Why can I not add/remove/edit columns to the lists
|
<varlistentry><term>Why can I not add/remove/edit columns to the lists
|
||||||
in People View and Family View?</term>
|
in People View and Family View?</term>
|
||||||
<listitem><para>
|
<listitem><para> Now you can! Just try out the current
|
||||||
This will be addressed after the TreeModelSort bug is fixed in pygtk,
|
version, &appversion;.
|
||||||
see <ulink url="http://bugzilla.gnome.org/show_bug.cgi?id=125172"
|
|
||||||
type="http">http://bugzilla.gnome.org/show_bug.cgi?id=125172</ulink>
|
|
||||||
for the details.
|
|
||||||
Once the patch is committed and incorporated into pygtk, we will add the
|
|
||||||
ability to add/remove/edit sortable columns.
|
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
|
||||||
@ -374,13 +363,13 @@ If, however, you would like the &app; project to to adopt your strategy,
|
|||||||
you would need to convince &app; developers that your strategy is good
|
you would need to convince &app; developers that your strategy is good
|
||||||
for &app; and superior to the present development strategy.</para>
|
for &app; and superior to the present development strategy.</para>
|
||||||
|
|
||||||
<para>
|
<tip><para>
|
||||||
HINT: if &app; developers are still not convinced after about three
|
If &app; developers are still not convinced after about three
|
||||||
messages sent to gramps-devel, maybe you are better off on your own
|
messages sent to gramps-devel, maybe you are better off on your own
|
||||||
rather than with a company of retards who can't fully realize the
|
rather than with a company of retards who can't fully realize the
|
||||||
potential of your great idea :-)
|
potential of your great idea :-)
|
||||||
|
|
||||||
</para></listitem>
|
</para></tip></listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
|
||||||
</variablelist>
|
</variablelist>
|
||||||
|
@ -25,8 +25,9 @@
|
|||||||
|
|
||||||
<title>Getting Started</title>
|
<title>Getting Started</title>
|
||||||
|
|
||||||
<para>This chapter provides the most basic information on starting &app; and
|
<para>This chapter provides the most basic information on starting &app;
|
||||||
obtaining help. Please procede to the following chapters for more information.</para>
|
and obtaining help. Please procede to the following chapters for more
|
||||||
|
information.</para>
|
||||||
|
|
||||||
<!-- ================ Getting Started Subsection ====== -->
|
<!-- ================ Getting Started Subsection ====== -->
|
||||||
<sect1 id="gramps-start">
|
<sect1 id="gramps-start">
|
||||||
@ -35,13 +36,15 @@
|
|||||||
<variablelist>
|
<variablelist>
|
||||||
<varlistentry>
|
<varlistentry>
|
||||||
<term><guimenu>Applications</guimenu> menu</term>
|
<term><guimenu>Applications</guimenu> menu</term>
|
||||||
<listitem><para>Choose <menuchoice><guisubmenu>Other</guisubmenu>
|
<listitem><para>The method of starting &app; from the menus may vary from
|
||||||
|
distribution to distribution. On default GNOME desktop,
|
||||||
|
choose <menuchoice><guisubmenu>Other</guisubmenu>
|
||||||
<guimenuitem>Gramps</guimenuitem></menuchoice>. </para></listitem>
|
<guimenuitem>Gramps</guimenuitem></menuchoice>. </para></listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
<varlistentry>
|
<varlistentry>
|
||||||
<term>Command line</term>
|
<term>Command line</term>
|
||||||
<listitem><para>To start &app; from a command line, type
|
<listitem><para>To start &app; from a command line, type
|
||||||
<command>gramps</command>, then press <keycap>Return</keycap>.</para>
|
<command>gramps</command>, then press <keycap>Enter</keycap>.</para>
|
||||||
|
|
||||||
<para>If you would like &app; to open a specific database or to
|
<para>If you would like &app; to open a specific database or to
|
||||||
import a specific file on startup, you can supply the filename
|
import a specific file on startup, you can supply the filename
|
||||||
|
@ -34,9 +34,9 @@
|
|||||||
|
|
||||||
<!ENTITY legal SYSTEM "legal.xml">
|
<!ENTITY legal SYSTEM "legal.xml">
|
||||||
|
|
||||||
<!ENTITY appversion "1.2.0">
|
<!ENTITY appversion "2.0.0">
|
||||||
<!ENTITY manrevision "2.6">
|
<!ENTITY manrevision "2.6">
|
||||||
<!ENTITY date "February 2005">
|
<!ENTITY date "May 2005">
|
||||||
<!ENTITY app "GRAMPS">
|
<!ENTITY app "GRAMPS">
|
||||||
|
|
||||||
<!-- The rest of the entities is simply the chapters of the manual.. -->
|
<!-- The rest of the entities is simply the chapters of the manual.. -->
|
||||||
@ -93,7 +93,7 @@
|
|||||||
<surname>Roitman</surname>
|
<surname>Roitman</surname>
|
||||||
<affiliation>
|
<affiliation>
|
||||||
<orgname>GRAMPS Project</orgname>
|
<orgname>GRAMPS Project</orgname>
|
||||||
<address> <email>shura@alex.neuro.umn.edu</email> </address>
|
<address> <email>shura@gramps-project.org</email> </address>
|
||||||
</affiliation>
|
</affiliation>
|
||||||
</author>
|
</author>
|
||||||
<author>
|
<author>
|
||||||
@ -101,7 +101,7 @@
|
|||||||
<surname>Allingham</surname>
|
<surname>Allingham</surname>
|
||||||
<affiliation>
|
<affiliation>
|
||||||
<orgname>GRAMPS Project</orgname>
|
<orgname>GRAMPS Project</orgname>
|
||||||
<address> <email>dallingham@users.sourceforge.net</email> </address>
|
<address> <email>don@gramps-project.org</email> </address>
|
||||||
</affiliation>
|
</affiliation>
|
||||||
</author>
|
</author>
|
||||||
|
|
||||||
@ -139,7 +139,7 @@
|
|||||||
<date>&date;</date>
|
<date>&date;</date>
|
||||||
<revdescription>
|
<revdescription>
|
||||||
<para role="author">Alex Roitman
|
<para role="author">Alex Roitman
|
||||||
<email>shura@alex.neuro.umn.edu</email></para>
|
<email>shura@gramps-project.org</email></para>
|
||||||
<para role="publisher">GRAMPS Project</para>
|
<para role="publisher">GRAMPS Project</para>
|
||||||
</revdescription>
|
</revdescription>
|
||||||
</revision>
|
</revision>
|
||||||
@ -148,7 +148,7 @@
|
|||||||
<date>February 2004</date>
|
<date>February 2004</date>
|
||||||
<revdescription>
|
<revdescription>
|
||||||
<para role="author">Alex Roitman
|
<para role="author">Alex Roitman
|
||||||
<email>shura@alex.neuro.umn.edu</email></para>
|
<email>shura@gramps-project.org</email></para>
|
||||||
<para role="publisher">GRAMPS Project</para>
|
<para role="publisher">GRAMPS Project</para>
|
||||||
</revdescription>
|
</revdescription>
|
||||||
</revision>
|
</revision>
|
||||||
@ -157,7 +157,7 @@
|
|||||||
<date>December 2003</date>
|
<date>December 2003</date>
|
||||||
<revdescription>
|
<revdescription>
|
||||||
<para role="author">Alex Roitman
|
<para role="author">Alex Roitman
|
||||||
<email>shura@alex.neuro.umn.edu</email></para>
|
<email>shura@gramps-project.org</email></para>
|
||||||
<para role="publisher">GRAMPS Project</para>
|
<para role="publisher">GRAMPS Project</para>
|
||||||
</revdescription>
|
</revdescription>
|
||||||
</revision>
|
</revision>
|
||||||
@ -166,7 +166,7 @@
|
|||||||
<date>September 2003</date>
|
<date>September 2003</date>
|
||||||
<revdescription>
|
<revdescription>
|
||||||
<para role="author">Alex Roitman
|
<para role="author">Alex Roitman
|
||||||
<email>shura@alex.neuro.umn.edu</email></para>
|
<email>shura@gramps-project.org</email></para>
|
||||||
<para role="publisher">GRAMPS Project</para>
|
<para role="publisher">GRAMPS Project</para>
|
||||||
</revdescription>
|
</revdescription>
|
||||||
</revision>
|
</revision>
|
||||||
@ -175,7 +175,7 @@
|
|||||||
<date>July 2003</date>
|
<date>July 2003</date>
|
||||||
<revdescription>
|
<revdescription>
|
||||||
<para role="author">Alex Roitman
|
<para role="author">Alex Roitman
|
||||||
<email>shura@alex.neuro.umn.edu</email></para>
|
<email>shura@gramps-project.org</email></para>
|
||||||
<para role="author">Donald A. Peterson
|
<para role="author">Donald A. Peterson
|
||||||
<email>dpeterson@sigmaxi.org</email></para>
|
<email>dpeterson@sigmaxi.org</email></para>
|
||||||
<para role="publisher">GRAMPS Project</para>
|
<para role="publisher">GRAMPS Project</para>
|
||||||
@ -186,7 +186,7 @@
|
|||||||
<date>May 2003</date>
|
<date>May 2003</date>
|
||||||
<revdescription>
|
<revdescription>
|
||||||
<para role="author">Alex Roitman
|
<para role="author">Alex Roitman
|
||||||
<email>shura@alex.neuro.umn.edu</email>
|
<email>shura@gramps-project.org</email>
|
||||||
</para>
|
</para>
|
||||||
<para role="publisher">GRAMPS Project</para>
|
<para role="publisher">GRAMPS Project</para>
|
||||||
</revdescription>
|
</revdescription>
|
||||||
@ -196,7 +196,7 @@
|
|||||||
<date>April 2003</date>
|
<date>April 2003</date>
|
||||||
<revdescription>
|
<revdescription>
|
||||||
<para role="author">Alex Roitman
|
<para role="author">Alex Roitman
|
||||||
<email>shura@alex.neuro.umn.edu</email>
|
<email>shura@gramps-project.org</email>
|
||||||
</para>
|
</para>
|
||||||
<para role="publisher">GRAMPS Project</para>
|
<para role="publisher">GRAMPS Project</para>
|
||||||
</revdescription>
|
</revdescription>
|
||||||
@ -206,7 +206,7 @@
|
|||||||
<date>2001</date>
|
<date>2001</date>
|
||||||
<revdescription>
|
<revdescription>
|
||||||
<para role="author">Donald N. Allingham
|
<para role="author">Donald N. Allingham
|
||||||
<email>dallingham@users.sourceforge.net</email>
|
<email>don@gramps-project.org</email>
|
||||||
</para>
|
</para>
|
||||||
<para role="publisher">GRAMPS Project</para>
|
<para role="publisher">GRAMPS Project</para>
|
||||||
</revdescription>
|
</revdescription>
|
||||||
@ -216,7 +216,7 @@
|
|||||||
<date>2001</date>
|
<date>2001</date>
|
||||||
<revdescription>
|
<revdescription>
|
||||||
<para role="author">Donald N. Allingham
|
<para role="author">Donald N. Allingham
|
||||||
<email>dallingham@users.sourceforge.net</email>
|
<email>don@gramps-project.org</email>
|
||||||
</para>
|
</para>
|
||||||
<para role="publisher">GRAMPS Project</para>
|
<para role="publisher">GRAMPS Project</para>
|
||||||
</revdescription>
|
</revdescription>
|
||||||
@ -231,7 +231,8 @@
|
|||||||
<para>
|
<para>
|
||||||
To report a bug or make a suggestion regarding this application or
|
To report a bug or make a suggestion regarding this application or
|
||||||
this manual, use the help menu in &app;, or follow the directions
|
this manual, use the help menu in &app;, or follow the directions
|
||||||
on <ulink url="http://gramps.sourceforce.net/contact.html" type="http">this site.</ulink>
|
found on <ulink url="http://gramps-project.org/index.php?module=pagemaster&PAGE_user_op=view_page&PAGE_id=3"
|
||||||
|
type="http">this site</ulink>.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<!-- Translators may also add here feedback address for translations -->
|
<!-- Translators may also add here feedback address for translations -->
|
||||||
|
@ -123,7 +123,7 @@
|
|||||||
<!-- ==== End of Figure ==== -->
|
<!-- ==== End of Figure ==== -->
|
||||||
</listitem></varlistentry>
|
</listitem></varlistentry>
|
||||||
|
|
||||||
<varlistentry><term>To switch the View while in a Notebook mode,
|
<varlistentry><term>To switch the View while in a Tabbed mode,
|
||||||
click on the desired notebook tab.</term>
|
click on the desired notebook tab.</term>
|
||||||
<listitem>
|
<listitem>
|
||||||
<!-- ==== Figure: Tabbed Notebook Mode ==== -->
|
<!-- ==== Figure: Tabbed Notebook Mode ==== -->
|
||||||
@ -138,7 +138,7 @@
|
|||||||
</listitem></varlistentry>
|
</listitem></varlistentry>
|
||||||
</variablelist>
|
</variablelist>
|
||||||
|
|
||||||
<para>To switch between sidebar and notebook viewing modes,
|
<para>To switch between sidebar and tabbed viewing modes,
|
||||||
choose <menuchoice> <guimenu>View</guimenu>
|
choose <menuchoice> <guimenu>View</guimenu>
|
||||||
<guimenuitem>Sidebar</guimenuitem>
|
<guimenuitem>Sidebar</guimenuitem>
|
||||||
</menuchoice> from the &app; menu.</para>
|
</menuchoice> from the &app; menu.</para>
|
||||||
@ -546,8 +546,10 @@
|
|||||||
Media Objects are any files that relate somehow to the stored
|
Media Objects are any files that relate somehow to the stored
|
||||||
genealogical data. Technically, any file can be stored as a Media
|
genealogical data. Technically, any file can be stored as a Media
|
||||||
Object. Most frequently, these are images, audio files, animation
|
Object. Most frequently, these are images, audio files, animation
|
||||||
files, etc. The list box on the bottom lists the Name, ID, Type, and
|
files, etc. The list box on the bottom lists the <guilabel>Name</guilabel>,
|
||||||
Path to the Media Object. <guilabel>Column Editor Dialog</guilabel>
|
<guilabel>ID</guilabel>, <guilabel>Type</guilabel>, and
|
||||||
|
<guilabel>Path</guilabel> of the Media Object.
|
||||||
|
<guilabel>Column Editor Dialog</guilabel>
|
||||||
may be used to rearrange the displayed columns, which obey usual
|
may be used to rearrange the displayed columns, which obey usual
|
||||||
sorting rules. The top part of the GRAMPS window shows
|
sorting rules. The top part of the GRAMPS window shows
|
||||||
a preview (if available) and information about the Media
|
a preview (if available) and information about the Media
|
||||||
|
@ -67,10 +67,11 @@
|
|||||||
|
|
||||||
<variablelist>
|
<variablelist>
|
||||||
|
|
||||||
<varlistentry><term>Berkely database backend</term>
|
<varlistentry><term>Berkeley database backend</term>
|
||||||
<listitem><para>The default format for &app; is now the BSDDB database. This change
|
<listitem><para>The default format for &app; is now the BSDDB database.
|
||||||
allowed us to overcome performance issues and memory requirements of the 1.0.X branch.
|
This change allowed us to overcome performance issues and memory
|
||||||
With the database backend, the database sizes of several hunder thousand people do not
|
requirements of the 1.0.X branch. With the database backend, the database
|
||||||
|
sizes of up to a hundred thousand people do not
|
||||||
present a major obstacle any longer.</para>
|
present a major obstacle any longer.</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
@ -161,14 +162,15 @@
|
|||||||
|
|
||||||
<varlistentry><term>Internationalization</term>
|
<varlistentry><term>Internationalization</term>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
The approach for entering and displaying dates has been completely re-worked. In
|
The approach for entering and displaying dates has been completely
|
||||||
particular, the new framework allows for a deeper localization of displayed dates than
|
re-worked. In particular, the new framework allows for a deeper
|
||||||
was ever possible using the translatable strings.</para>
|
localization of displayed dates than was ever possible using the
|
||||||
|
translatable strings.</para>
|
||||||
|
|
||||||
<para>The internationalization of names have also been improved. Names can be
|
<para>The internationalization of names have also been improved.
|
||||||
grouped under a non-default string. Patronymic names are supported, and it is easy
|
Names can be grouped under a non-default string. Patronymic names are
|
||||||
to program new ways on displaying names, as may be required by other cultures
|
supported, and it is easy to program new ways on displaying names, as
|
||||||
and languages.
|
may be required by various cultures and languages.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
|
||||||
@ -191,27 +193,27 @@
|
|||||||
<title>Typographical conventions</title>
|
<title>Typographical conventions</title>
|
||||||
<para>
|
<para>
|
||||||
In this book, we some words are marked with special typography:
|
In this book, we some words are marked with special typography:
|
||||||
<simplelist>
|
<itemizedlist>
|
||||||
<member><application>Applications</application></member>
|
<listitem><application>Applications</application></listitem>
|
||||||
<member><command>Commands</command> you type at the command
|
<listitem><command>Commands</command> you type at the command
|
||||||
line</member>
|
line</listitem>
|
||||||
<member><filename>Filenames</filename></member>
|
<listitem><filename>Filenames</filename></listitem>
|
||||||
<member><replaceable>Replaceable text</replaceable></member>
|
<listitem><replaceable>Replaceable text</replaceable></listitem>
|
||||||
<member><guilabel>Labels</guilabel> for buttons and other
|
<listitem><guilabel>Labels</guilabel> for buttons and other
|
||||||
portions of the graphical interface</member>
|
portions of the graphical interface</listitem>
|
||||||
|
|
||||||
<member> Menu selections look like this:
|
<listitem> Menu selections look like this:
|
||||||
<menuchoice>
|
<menuchoice>
|
||||||
<guimenu>Menu</guimenu>
|
<guimenu>Menu</guimenu>
|
||||||
<guisubmenu>Submenu</guisubmenu>
|
<guisubmenu>Submenu</guisubmenu>
|
||||||
<guimenuitem>Menu Item</guimenuitem>
|
<guimenuitem>Menu Item</guimenuitem>
|
||||||
</menuchoice>
|
</menuchoice>
|
||||||
</member>
|
</listitem>
|
||||||
<member><guibutton>Buttons</guibutton> you can
|
<listitem><guibutton>Buttons</guibutton> you can
|
||||||
click</member>
|
click</listitem>
|
||||||
<member><userinput>Anything you type
|
<listitem><userinput>Anything you type
|
||||||
in</userinput></member>
|
in</userinput></listitem>
|
||||||
</simplelist>
|
</itemizedlist>
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
.TH gramps 1 "@VERSION@" "June 2004" "@VERSION@"
|
.TH gramps 1 "@VERSION@" "May 2005" "@VERSION@"
|
||||||
.SH NAME
|
.SH NAME
|
||||||
gramps \- Genealogical Research and Analysis Management Programming System.
|
gramps \- Genealogical Research and Analysis Management Programming System.
|
||||||
|
|
||||||
@ -7,6 +7,10 @@ gramps \- Genealogical Research and Analysis Management Programming System.
|
|||||||
.RB [ \-?|\-\^\-help ]
|
.RB [ \-?|\-\^\-help ]
|
||||||
.RB [ \-\^\-usage ]
|
.RB [ \-\^\-usage ]
|
||||||
.RB [ \-\^\-version ]
|
.RB [ \-\^\-version ]
|
||||||
|
.RB [ \-O|\-\^\-open=
|
||||||
|
.IR FILE
|
||||||
|
.RB [ \-f|\-\^\-format=
|
||||||
|
.IR FORMAT ]]
|
||||||
.RB [ \-i|\-\^\-import=
|
.RB [ \-i|\-\^\-import=
|
||||||
.IR FILE
|
.IR FILE
|
||||||
.RB [ \-f|\-\^\-format=
|
.RB [ \-f|\-\^\-format=
|
||||||
@ -19,18 +23,19 @@ gramps \- Genealogical Research and Analysis Management Programming System.
|
|||||||
.IR FORMAT ]]
|
.IR FORMAT ]]
|
||||||
.RB [ \-a|\-\^\-action=
|
.RB [ \-a|\-\^\-action=
|
||||||
.IR ACTION ]
|
.IR ACTION ]
|
||||||
|
.RB [ \-p|\-\^\-options=
|
||||||
|
.IR OPTIONSTRING ]]
|
||||||
.RB [
|
.RB [
|
||||||
.IR FILE
|
.IR FILE
|
||||||
.RB ]
|
.RB ]
|
||||||
|
|
||||||
.SH DESCRIPTION
|
.SH DESCRIPTION
|
||||||
.PP
|
.PP
|
||||||
\fIGramps\fP is an open source genealogy program. It is written in Python,
|
\fIGramps\fP is a Free/OpenSource genealogy program. It is written in Python,
|
||||||
using the GTK/GNOME interface.
|
using the GTK+/GNOME interface.
|
||||||
.br
|
|
||||||
Gramps should seem familiar to anyone who has used other geneology programs
|
Gramps should seem familiar to anyone who has used other geneology programs
|
||||||
before such as \fIFamily Tree Maker for Windows(TM)\fR or the GNU Geneweb.
|
before such as \fIFamily Tree Maker (TM)\fR, \fIPersonal Ancestral
|
||||||
.br
|
Files (TM)\fR, or the GNU Geneweb.
|
||||||
It supports importing of the ever popular GEDCOM format which is used world
|
It supports importing of the ever popular GEDCOM format which is used world
|
||||||
wide by almost all other genealogy software.
|
wide by almost all other genealogy software.
|
||||||
|
|
||||||
@ -41,32 +46,56 @@ When \fIFILE\fR is given (without any flags) then it is
|
|||||||
opened and an interactive session is started. The rest of the options
|
opened and an interactive session is started. The rest of the options
|
||||||
is ignored. This way of launching is suitable for using gramps
|
is ignored. This way of launching is suitable for using gramps
|
||||||
as a handler for genealogical data in e.g. web browsers. This invokation
|
as a handler for genealogical data in e.g. web browsers. This invokation
|
||||||
can accept any data format known to gramps, see below.
|
can accept any data format native to gramps, see below.
|
||||||
.br
|
.br
|
||||||
|
|
||||||
.TP
|
.TP
|
||||||
.BI \-f,\-\^\-format= " FORMAT"
|
.BI \-f,\-\^\-format= " FORMAT"
|
||||||
Explicitly specify format of \fIFILE\fR given by preceding \fB\-i\fR or
|
Explicitly specify format of \fIFILE\fR given by preceding \fB\-O\fR,
|
||||||
|
\fB\-i\fR, or
|
||||||
\fB\-o\fR option. If the \fB\-f\fR option is not given for any \fIFILE\fR,
|
\fB\-o\fR option. If the \fB\-f\fR option is not given for any \fIFILE\fR,
|
||||||
the format of that file is guessed according to its extension.
|
the format of that file is guessed according to its extension.
|
||||||
.br
|
.br
|
||||||
|
|
||||||
Formats
|
Formats
|
||||||
available for import are \fBgramps\-xml\fR (guessed if \fIFILE\fR is a
|
available for opening are \fBgrdb\fR (guessed if \fIFILE\fR ends with
|
||||||
directory), \fBgedcom\fR (guessed if \fIFILE\fR ends with \fB.ged\fR), and
|
\fB.grdb\fR), \fBgramps\-xml\fR (guessed if \fIFILE\fR is a
|
||||||
\fBgramps\-pkg\fR (guessed if \fIFILE\fR ends with \fB.gpkg\fR).
|
directory), and \fBgedcom\fR (guessed if \fIFILE\fR ends with \fB.ged\fR).
|
||||||
.br
|
.br
|
||||||
|
|
||||||
Formats available for export are \fBgramps\-xml\fR, \fBgedcom\fR, \fBgramps\-pkg\fR,
|
Formats
|
||||||
\fBwft\fR (guessed if \fIFILE\fR ends with \fB.wft\fR), and \fBiso\fR
|
available for import are \fBgrdb\fR, \fBgramps\-xml\fR, \fBgedcom\fR,
|
||||||
(never guessed, always specify with \fB\-f\fR option).
|
\fBgramps\-pkg\fR (guessed if \fIFILE\fR ends with \fB.gpkg\fR), and
|
||||||
|
\fBgeneweb\fR (guessed if \fIFILE\fR ends with \fB.gw\fR).
|
||||||
|
.br
|
||||||
|
|
||||||
|
Formats available for export are \fBgrdb\fR, \fBgramps\-xml\fR, \fBgedcom\fR,
|
||||||
|
\fBgramps\-pkg\fR, \fBwft\fR (guessed if \fIFILE\fR ends with \fB.wft\fR),
|
||||||
|
\fBgeneweb\fR, and \fBiso\fR (never guessed, always specify with
|
||||||
|
\fB\-f\fR option).
|
||||||
|
|
||||||
|
.TP
|
||||||
|
.BI \-O,\-\^\-open= " FILE"
|
||||||
|
Open \fIFILE\fR.
|
||||||
|
Only \fBgrdb\fR, \fBgramps\-xml\fR, and \fBgedcom\fR formats can be
|
||||||
|
opened directly. For other formats, you will need to use the import option
|
||||||
|
which will set up the empty database and then import data into it.
|
||||||
|
For \fBgramps\-xml\fR format, the \fIFILE\fR
|
||||||
|
is actually the name of directory under which the gramps database resides.
|
||||||
|
For \fBgrdb\fR and \fBgedcom\fR, the \fIFILE\fR is the name of
|
||||||
|
the corresponding file.
|
||||||
|
.br
|
||||||
|
|
||||||
|
Only a single file can be opened. If you need to combine data from several
|
||||||
|
sources, you will need to use the import option.
|
||||||
|
|
||||||
.TP
|
.TP
|
||||||
.BI \-i,\-\^\-import= " FILE"
|
.BI \-i,\-\^\-import= " FILE"
|
||||||
Import data from \fIFILE\fR. For \fBgramps\-xml\fR format, the \fIFILE\fR
|
Import data from \fIFILE\fR. For \fBgramps\-xml\fR format, the \fIFILE\fR
|
||||||
is actually the name of directory under which the gramps database resides.
|
is actually the name of directory under which the gramps database resides.
|
||||||
For \fBgedcom\fR and \fBgramps\-pkg\fR, the \fIFILE\fR is the name of
|
For \fBgrdb\fR, \fBgedcom\fR, \fBgramps\-pkg\fR, and \fBgeneweb\fR,
|
||||||
the corresponding file.
|
the \fIFILE\fR is
|
||||||
|
the name of the corresponding file.
|
||||||
.br
|
.br
|
||||||
|
|
||||||
When more than one input file is given, each has to be preceded by \fB\-i\fR
|
When more than one input file is given, each has to be preceded by \fB\-i\fR
|
||||||
@ -79,8 +108,8 @@ gramps IDs in the resulting database.
|
|||||||
.BI \-o,\-\^\-output= " FILE"
|
.BI \-o,\-\^\-output= " FILE"
|
||||||
Export data into \fIFILE\fR. For \fBgramps\-xml\fR and \fBiso\fR formats, the
|
Export data into \fIFILE\fR. For \fBgramps\-xml\fR and \fBiso\fR formats, the
|
||||||
\fIFILE\fR is actually the name of directory the gramps database will be
|
\fIFILE\fR is actually the name of directory the gramps database will be
|
||||||
written into. For \fBgedcom\fR, \fBwft\fR, and \fBgramps\-pkg\fR,
|
written into. For \fBgrdb\fR, \fBgedcom\fR, \fBwft\fR, \fBgramps\-pkg\fR,
|
||||||
the \fIFILE\fR is the name of the resulting file.
|
and \fBgeneweb\fR, the \fIFILE\fR is the name of the resulting file.
|
||||||
.br
|
.br
|
||||||
|
|
||||||
When more than one output file is given, each has to be preceded
|
When more than one output file is given, each has to be preceded
|
||||||
@ -90,27 +119,82 @@ by \fB\-o\fR flag. The files are written one by one, in the specified order.
|
|||||||
.BI \-a,\-\^\-action= " ACTION"
|
.BI \-a,\-\^\-action= " ACTION"
|
||||||
Perform \fIACTION\fR on the imported data. This is done after all imports
|
Perform \fIACTION\fR on the imported data. This is done after all imports
|
||||||
are succesfully completed. Currently available actions are \fBsummary\fR
|
are succesfully completed. Currently available actions are \fBsummary\fR
|
||||||
(same as Reports->View->Summary) and \fBcheck\fR (same as Tools->Database
|
(same as Reports->View->Summary), \fBcheck\fR (same as Tools->Database
|
||||||
Processing->Check and Repair).
|
Processing->Check and Repair), and \fBreport\fR (generates report, needs
|
||||||
|
the \fIOPTIONSTRING\fR supplied by the \fB\-p\fR flag).
|
||||||
.br
|
.br
|
||||||
|
|
||||||
|
The report option string should satisfy the following conditions:
|
||||||
|
.br
|
||||||
|
It must not contain any spaces.
|
||||||
|
If some arguments need to include spaces, the string should
|
||||||
|
be enclosed with quotation marks.
|
||||||
|
Option string must list pairs of option names and values.
|
||||||
|
Withing a pair, option name and value must be separated by the equality sign.
|
||||||
|
Different pairs must be separated by commas.
|
||||||
|
.br
|
||||||
|
|
||||||
|
Most of the report options are specific for every report. However, there some
|
||||||
|
common options.
|
||||||
|
|
||||||
|
.BI "name=reportname"
|
||||||
|
.br
|
||||||
|
This mandatory option determines which report
|
||||||
|
will be generated. If the supplied report_name does not correspond to any
|
||||||
|
available report, the error message will be printed followed by the list of
|
||||||
|
available reports.
|
||||||
|
|
||||||
|
.BI "show=all"
|
||||||
|
.br
|
||||||
|
This will produce the list of names for all options
|
||||||
|
available for a given report.
|
||||||
|
|
||||||
|
.BI "show=optionname"
|
||||||
|
.br
|
||||||
|
This will print the description of
|
||||||
|
the functionality supplied by the optionname, as well as what are the
|
||||||
|
acceptable types and values for this option.
|
||||||
|
|
||||||
|
.br
|
||||||
|
Use the above options to find out
|
||||||
|
everything about a given report.
|
||||||
|
|
||||||
|
.LP
|
||||||
When more than one output action is given, each has to be preceded
|
When more than one output action is given, each has to be preceded
|
||||||
by \fB\-a\fR flag. The actions are performed one by one, in the specified order.
|
by \fB\-a\fR flag. The actions are performed one by one, in the specified order.
|
||||||
|
|
||||||
|
.BI "Operation"
|
||||||
|
.br
|
||||||
|
If the first argument on the command line does not start with dash (i.e. no
|
||||||
|
flag), gramps will attempt to open the file with the name given by the first
|
||||||
|
argument and start interactive session, ignoring the rest of the command line
|
||||||
|
arguments.
|
||||||
|
|
||||||
|
.LP
|
||||||
|
If the \fB\-O\fR flag is given, then gramps will try opening
|
||||||
|
the supplied file name and then work with that data, as instructed by the
|
||||||
|
further command line parameters.
|
||||||
|
|
||||||
|
.LP
|
||||||
|
With or without the \fB\-O\fR flag, there could be multiple imports,
|
||||||
|
exports, and actions specified further on the command line by using \fB\-i\fR,
|
||||||
|
\fB\-o\fR, and \fB\-a\fR flags.
|
||||||
|
|
||||||
.LP
|
.LP
|
||||||
The order of \fB\-i\fR, \fB\-o\fR, or \fB\-a\fR options does not matter. The
|
The order of \fB\-i\fR, \fB\-o\fR, or \fB\-a\fR options does not matter. The
|
||||||
actual order always is: all imports (if any) -> all exports (if any) ->
|
actual order always is: all imports (if any) -> all exports (if any) ->
|
||||||
all actions (if any).
|
all actions (if any). But opening must always be first!
|
||||||
|
|
||||||
.LP
|
.LP
|
||||||
If no \fB\-i\fR option is given, gramps will launch its main
|
If no \fB\-O\fR or \fB\-i\fR option is given, gramps will launch its main
|
||||||
window and start the usual interactive session with the empty database
|
window and start the usual interactive session with the empty database,
|
||||||
(since there is no data to process, anyway).
|
since there is no data to process, anyway.
|
||||||
|
|
||||||
.LP
|
.LP
|
||||||
If no \fB\-o\fR or \fB\-a\fR options are given, gramps will launch its main
|
If no \fB\-o\fR or \fB\-a\fR options are given, gramps will launch its main
|
||||||
window and start the usual interactive session with the database resulted
|
window and start the usual interactive session with the database resulted
|
||||||
from all imports. This database resides under \fB~/.gramps/import\fR directory.
|
from all imports. This database resides in the \fBimport_db.grdb\fR
|
||||||
|
under \fB~/.gramps/import\fR directory.
|
||||||
|
|
||||||
.LP
|
.LP
|
||||||
The error encountered during import, export, or action, will be either
|
The error encountered during import, export, or action, will be either
|
||||||
@ -141,7 +225,7 @@ report generators, tools, and display filters to be added without modification
|
|||||||
of the main program.
|
of the main program.
|
||||||
.LP
|
.LP
|
||||||
In addition to generating direct printer output, report generators also
|
In addition to generating direct printer output, report generators also
|
||||||
target other systems, such as \fIOpenOffice.org\fR, \fIAbiWord\fR, HTML
|
target other systems, such as \fIOpenOffice.org\fR, \fIAbiWord\fR, HTML,
|
||||||
or LaTeX to allow the users to modify the format to suit their needs.
|
or LaTeX to allow the users to modify the format to suit their needs.
|
||||||
|
|
||||||
.SH KNOWN BUGS AND LIMITATIONS
|
.SH KNOWN BUGS AND LIMITATIONS
|
||||||
@ -155,7 +239,7 @@ or LaTeX to allow the users to modify the format to suit their needs.
|
|||||||
\fI${HOME}/.gramps\fP
|
\fI${HOME}/.gramps\fP
|
||||||
|
|
||||||
.SH AUTHORS
|
.SH AUTHORS
|
||||||
Donald Allingham \fI<dallingham@users.sourceforge.net>\fR
|
Donald Allingham \fI<don@gramps-project.org>\fR
|
||||||
.br
|
.br
|
||||||
\fIhttp://gramps.sourceforge.net\fR
|
\fIhttp://gramps.sourceforge.net\fR
|
||||||
.LP
|
.LP
|
||||||
@ -167,7 +251,7 @@ for inclusion in the Debian GNU/Linux system.
|
|||||||
.LP
|
.LP
|
||||||
This manpage is currently maintained by:
|
This manpage is currently maintained by:
|
||||||
.br
|
.br
|
||||||
Alex Roitman \fI<shura@alex.neuro.umn.edu>\fR
|
Alex Roitman \fI<shura@gramps-project.org>\fR
|
||||||
.br
|
.br
|
||||||
|
|
||||||
.SH DOCUMENTATION
|
.SH DOCUMENTATION
|
||||||
@ -176,5 +260,5 @@ in the form of Gramps Manual. The manual is also available in XML format
|
|||||||
as \fBgramps-manual.xml\fR under \fIdoc/gramps-manual/$LANG\fR in the official
|
as \fBgramps-manual.xml\fR under \fIdoc/gramps-manual/$LANG\fR in the official
|
||||||
source distribution.
|
source distribution.
|
||||||
.LP
|
.LP
|
||||||
The developer documentation can be found in the \fBDocs\fR section
|
The developer documentation can be found on the
|
||||||
of \fIhttp://sourceforge.net/project/gramps\fR site.
|
\fIhttp://developers.gramps-project.org\fR site.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user