New man page
svn: r1546
This commit is contained in:
Alex Roitman
parent
261e1ddd2e
commit
0403b71332
133
doc/gramps.1.in
133
doc/gramps.1.in
@ -1,49 +1,122 @@
|
||||
.TH gramps 1 "@VERSION@" "man page by Brandon L. Griffith" ""
|
||||
.SH "NAME"
|
||||
.LP
|
||||
gramps \- Genealogical Research and Analysis Management Programming System
|
||||
.SH "SYNTAX"
|
||||
.LP
|
||||
gramps [\fIDatabase\fP]
|
||||
.TH gramps 1 "@VERSION@" "May 2003" "@VERSION@"
|
||||
.SH NAME
|
||||
gramps \- Genealogical Research and Analysis Management Programming System.
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B gramps
|
||||
.RB [ \-\^\-help ]
|
||||
.RB [ \-\^\-version ]
|
||||
.RB [ \-i
|
||||
.IR FILENAME
|
||||
.RB [ \-f
|
||||
.IR FORMAT ]]
|
||||
.RB [ \-i
|
||||
.IR ... ]
|
||||
.RB [ \-o
|
||||
.IR FILENAME
|
||||
.RB [ \-f
|
||||
.IR FORMAT ]]
|
||||
.RB [ \-a
|
||||
.IR ACTION ]
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
\fIGramps\fP is an open source genealogy program. It is written in Python,
|
||||
using the GTK/GNOME interface.
|
||||
.br
|
||||
Currently \fBgramps\fR does not require any command line arguments.
|
||||
However, if provided, it is the path to either a gramps database or a GEDCOM
|
||||
file to be imported.
|
||||
.SH "DESCRIPTION"
|
||||
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.
|
||||
.br
|
||||
It supports importing of the ever popular GEDCOM format which is used world
|
||||
wide by almost all other geneology software.
|
||||
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
.BI \-f " FORMAT"
|
||||
Explicitly specify format of the filename. If this option is not given, the
|
||||
format of each file is guessed according to its extension. Formats available
|
||||
for import are \fBgramps\fR, \fBgedcom\fR, and \fBgramps\-pkg\fR. Formats
|
||||
available for export are \fBgramps\fR, \fBgedcom\fR, \fBgramps\-pkg\fR,
|
||||
and \fBiso\fR.
|
||||
|
||||
.TP
|
||||
.BI \-i " FILENAME"
|
||||
Import data from \fIFILENAME\fR. For \fBgramps\fR format, the \fIFILENAME\fR
|
||||
is actually the name of directory under which the gramps database resides.
|
||||
For \fBgedcom\fR and \fBgramps\-pkg\fR, the \fIFILENAME\fR is the name of
|
||||
the corresponding file.
|
||||
.br
|
||||
When more than one file is given, each has to be preceded by \fB\-i\fR flag.
|
||||
The files are imported in the specified order,
|
||||
i.e. \fB\-i\fR \fIFILE1\fR \fB\-i\fR \fIFILE2\fR
|
||||
and \fB\-i\fR \fIFILE2\fR \fB\-i\fR \fIFILE1\fR might produce different
|
||||
gramps IDs in the resulting database.
|
||||
|
||||
.TP
|
||||
.BI \-o " FILENAME"
|
||||
Export data into \fIFILENAME\fR. For \fBgramps\fR and \fBiso\fR formats, the
|
||||
\fIFILENAME\fR is actually the name of directory the gramps database will be
|
||||
written into. For \fBgedcom\fR and \fBgramps\-pkg\fR, the \fIFILENAME\fR
|
||||
is the name of the resulting file.
|
||||
|
||||
.TP
|
||||
.BI \-a " ACTION"
|
||||
Perform \fIACTION\fR on the imported data. This is done after all imports
|
||||
are succesfully completed. Available actions are \fBsummary\fR (same as
|
||||
Reports->View->Summary menu item) and \fBcheck\fR (same
|
||||
as Tools->Database Processing->Check and repair).
|
||||
|
||||
.LP
|
||||
Gramps is an open source genealogy program. It is written in Python, using the GTK/GNOME interface.
|
||||
.br
|
||||
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.
|
||||
.br
|
||||
It supports importing of the ever popular GEDCOM format which is used world wide by almost all other geneology software.
|
||||
.SH "Concepts"
|
||||
Supports a python\-based plugin system, allowing import and export writers, report generators, tools, and display filters to be added without modification of the main program.
|
||||
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
|
||||
from all imports. This database resides under \fB~/.gramps/import\fR directory.
|
||||
|
||||
.LP
|
||||
The error encountered during import, export, or action, will be either
|
||||
dumped to \fIstdout\fR (if these are exceptions handled by gramps) or or
|
||||
to \fIstderr\fR (if these are not handled). Use usual shell redirections
|
||||
of \fIstdout\fR and \fIstderr\fR to save messages and errors in files.
|
||||
|
||||
.SH CONCEPTS
|
||||
Supports a python\-based plugin system, allowing import and export writers,
|
||||
report generators, tools, and display filters to be added without modification
|
||||
of the main program.
|
||||
.LP
|
||||
Data is stored in an gzip'ed XML format
|
||||
.LP
|
||||
Instead of generating direct printer output, report generators target other systems, such as \fIOpen Office\fR, \fIAbiWord\fR, HTML or LaTeX to allow the user to modify the format to suit his or her needs.
|
||||
.SH "FILES"
|
||||
Instead of generating direct printer output, report generators target other
|
||||
systems, such as \fIOpen Office\fR, \fIAbiWord\fR, HTML or LaTeX to allow the
|
||||
user to modify the format to suit his or her needs.
|
||||
|
||||
.SH FILES
|
||||
.LP
|
||||
\fI${PREFIX}/bin/gramps\fP
|
||||
.br
|
||||
\fI${PREFIX}/share/gramps\fP
|
||||
.br
|
||||
\fI${HOME}/.gramps\fP
|
||||
.SH "Authors"
|
||||
Donald Allingham \fI<donaldallingham@home.com>\fR
|
||||
|
||||
.SH AUTHORS
|
||||
Donald Allingham \fI<dallingham@users.sourceforge.net>\fR
|
||||
.br
|
||||
\fIhttp://gramps.sourceforge.net\fR
|
||||
.LP
|
||||
This manpage was written by:
|
||||
This manpage was originally written by:
|
||||
.br
|
||||
Brandon L. Griffith \fI<brandon@debian.org>\fR
|
||||
.br
|
||||
Any ammendants or errors should be reported to him.
|
||||
for inclusion in the Debian GNU/Linux system.
|
||||
.LP
|
||||
This manpage is currently maintained by:
|
||||
.br
|
||||
It was originally written for inclusion in the Debian GNU/Linux system.
|
||||
.SH "DOCUMENTATION"
|
||||
See also the file \fBgramps.sgml\fR
|
||||
Alex Roitman \fI<shura@alex.neuro.umn.edu>\fR
|
||||
.br
|
||||
On a Debian system this can be found in \fI/usr/doc/gramps\fR
|
||||
.br
|
||||
Or in the doc directory of the official source distribution.
|
||||
|
||||
.SH DOCUMENTATION
|
||||
The user documentation is available through standard GNOME Help browser
|
||||
in the form of Gramps Manual. This manual is also available in XML format
|
||||
as \fBgramps-manual.xml\fR under \fIdoc/gramps-manual/$LANG\fR in the official
|
||||
source distribution.
|
||||
.LP
|
||||
The developer documentation can be found in the \fBDocs\fR section
|
||||
of \fIhttp://sourceforge.net/project/gramps\fR site.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user