diff --git a/gramps2/ChangeLog b/gramps2/ChangeLog index 9d026222d..8448250ad 100644 --- a/gramps2/ChangeLog +++ b/gramps2/ChangeLog @@ -1,3 +1,11 @@ +2005-05-05 Alex Roitman + * 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 * src/plugins/PatchNames.py: handle multiple titles (bug 1196056) * src/plugins/ReorderIDs.py: bring up to speed with new handle/id methodology, diff --git a/gramps2/doc/gramps-manual/C/bugs.xml b/gramps2/doc/gramps-manual/C/bugs.xml index c642772c1..2f4dbff42 100644 --- a/gramps2/doc/gramps-manual/C/bugs.xml +++ b/gramps2/doc/gramps-manual/C/bugs.xml @@ -24,4 +24,18 @@ Known Bugs and Limitations +The bugs are tracked through the + + sourceforge.net tracking system. + + +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. + + diff --git a/gramps2/doc/gramps-manual/C/cmdline.xml b/gramps2/doc/gramps-manual/C/cmdline.xml index a9f24f2ab..23a5d3779 100644 --- a/gramps2/doc/gramps-manual/C/cmdline.xml +++ b/gramps2/doc/gramps-manual/C/cmdline.xml @@ -55,7 +55,7 @@ Format options The format of any file destined for opening, importing, or exporting can be specified with the - -f format + -f format option. The acceptable format values are listed below. @@ -113,8 +113,8 @@ supply bare file name use the - -O filename or - -open=filename option + -O filename or + -open=filename option @@ -132,18 +132,18 @@ The format can be specified with the -f format or --format=format - option, immediately following the filename. + option, immediately following the filename. If not specified, the guess will be attempted based on - the filename. For gramps-xml - format, the filename is actually the + the filename. For gramps-xml + format, the filename is actually the name of directory under which the gramps database resides. For - grdb and gedcom, - the filename is the name of the + grdb and gedcom, + the filename is the name of the corresponding file. - Only grdb, gramps-xml, - and gedcom formats can be opened directly. + Only grdb, gramps-xml, + and gedcom 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. @@ -156,19 +156,18 @@ Import options The files destined for import can be specified with the - -i filename - or --import=filename + -i filename + or --import=filename option. The format can be specified with the -f format or --format=format - option, immediately following the filename. + option, immediately following the filename. If not specified, the guess will be attempted based on - the filename. For gramps-xml - format, the filename is actually the + the filename. For gramps-xml + format, the filename is actually the name of directory under which the gramps database resides. For - grdb, gedcom, gramps-pkg, - and geneweb, - the filename is the name of the + grdb, gedcom, gramps-pkg, and geneweb, + the filename is the name of the corresponding file. @@ -179,28 +178,28 @@ When more than one input file is given, each has to be preceded by -i flag. The files are imported in the - specified order, i.e. - -i file1 - -i file2 - and - -i file2 - -i file1 + specified order, i.e. + -i file1 + -i file2 + and + -i file2 + -i file1 + might produce different gramps IDs in the resulting database. Export options The files destined for export can be specified with the - -o filename or - --output=filename + -o filename or + --output=filename option. The format can be specified with the -f - option immediately following the filename. + option immediately following the filename. If not specified, the guess will be attempted based on - the filename. For gramps-xml - and iso formats, the filename + the filename. For gramps-xml + and iso formats, the filename is actually the name of directory the gramps database will be written - into. For grdb, gedcom, - wft, geneweb, - and gramps-pkg, the filename + into. For grdb, gedcom, wft, geneweb, + and gramps-pkg, the filename is the name of the resulting file. @@ -334,83 +333,181 @@ Operation + + + + 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. + + + + If the -O 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. + + + 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 -i flag. + + + + + With or without the -O flag, there could + be multiple imports, exports, and actions specified further on + the command line by using -i, + -o, and -a flags. + + + The order of -i, -o, or -a options with respect to each does not matter. The actual execution order always is: all imports (if any) -> all exports (if any) -> all actions (if any). - - If no -i option is given, gramps will launch + + But opening must always be first! + + + + If no -O or -i + option is given, gramps will launch its main window and start the usual interactive session with the empty - database (since there is no data to process, anyway). + database, since there is no data to process, anyway. + + If no -o or -a 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 - ~/.gramps/import directory. - + interactive session with the database resulted from opening + and all imports (if any). This database resides in the + import_db.grdb file under the + ~/.gramps/import/ directory. + + + Any errors encountered during import, export, or action, will 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 - of stdout and stderr to save messages and errors in files. + of stdout and stderr to save messages and errors in files. + + + Examples - To import four databases (whose formats can be determined from + + + + + To import four databases (whose formats can be determined from their names) and then check the resulting database for errors, one may - type: - gramps -i file1.ged - -i file2.tgz - -i ~/db3 - -i file4.wft - -a check + type: + + + gramps + -ifile1.ged + -i file2.tgz + -i ~/db3 + -i file4.wft + -a check + + + + To explicitly specify the formats in the above example, append + filenames with appropriate -f options: + + gramps + -i file1.ged + -f gedcom + -i file2.tgz + -f gramps-pkg + -i ~/db3 + -f gramps + -i file4.wft + -f wft + -a check + + + + + To record the database resulting from all imports, supply + -o flag (use -f + if the filename does not allow gramps to guess the format): + + gramps + -i file1.ged + -i file2.tgz + -o ~/new-package + -f gramps-pkg + + + + + To save any error messages of the above example into files + outfile and + errfile, run: + + gramps + -i file1.ged + -i file2.tgz + -o ~/new-package + -f gramps-pkg + >outfile + 2>errfile + + + + + To import three databases and start interactive gramps + session with the result: + + gramps + -i file1.ged + -i file2.tgz + -i ~/db3 + + + + + + To open a database and, based on that data, generate timeline + report in PDF format putting the output into the + my_timeline.pdf file: + + gramps + -O file.grdb + -a report + -p name=timeline,off=pdf,of=my_timeline.pdf + - To explicitly specify the formats in the above example, append - filenames with appropriate -f options: - gramps -i file1.ged - -f gedcom - -i file2.tgz - -f gramps-pkg - -i ~/db3 - -f gramps - -i file4.wft - -f wft - -a check + Use the name=timeline,show=all + to find out about all available options for the timeline report. To + find out details of a particular option, use + show=option_name, + e.g. name=timeline,show=off + string. + + To learn about available report names, use + name=show string. + - To record the database resulting from all imports, supply - -o flag (use -f - if the filename does not allow gramps to guess the format): - gramps -i file1.ged - -i file2.tgz - -o ~/new-package - -f gramps-pkg - - - To save any error messages of the above example into files - outfile and - errfile, run: - gramps -i file1.ged - -i file2.tgz - -o ~/new-package - -f gramps-pkg - >outfile - 2>errfile - + + + + + Finally, to start normal interactive session type: + gramps + + + - To import three databases and start interactive gramps - session with the result: - gramps -i file1.ged - -i file2.tgz - -i ~/db3 - - - Finally, to start normal interactive session type: - gramps - diff --git a/gramps2/doc/gramps-manual/C/faq.xml b/gramps2/doc/gramps-manual/C/faq.xml index f4d71dd63..b1b99995f 100644 --- a/gramps2/doc/gramps-manual/C/faq.xml +++ b/gramps2/doc/gramps-manual/C/faq.xml @@ -61,13 +61,15 @@ This, however, may change in the future. Does it work with the Mac? -The Fink project (http://fink.sf.net) has ported an old version of -&app; (0.8.0) to OSX. The Mac OSX port is not directly supported by +The Fink project has ported +some older versions of +&app; to OSX. The Mac OSX port is not directly supported by the &app; project, primarily because none of the &app; developers -have access to Mac OSX. +have access to Mac OSX and because OSX is not Free Software. -The GNOME 2 version of &app; (0.9.x) does not appear to have been +This version of &app; (&appversion;) does not appear to have been ported by the Fink project. Please contact the Fink project for more information. @@ -86,8 +88,8 @@ Yes, as long as the required GNOME libraries are installed. What version of GNOME do I need? -The latest versions of gramps (0.9.0 and higher) require GNOME 2.0 or higher. -Previous versions required GNOME 1.X. +This version of gramps requires GNOME 2.8.0 or higher. +Previous versions in 1.0.x series required GNOME 2.0. @@ -137,7 +139,7 @@ their own plugins which could be new reports, charts, or research tools. Text reports are available in HTML, PDF, AbiWord, KWord, LaTeX, RTF, and OpenOffice formats. Graphical reports (charts and diagrams) are available in -PostScript, PDF, SVG, OpenOffice and GraphViz formats. +PostScript, PDF, SVG, OpenOffice, and GraphViz formats. @@ -181,43 +183,34 @@ Visual Genealogie. size (bytes) &app; 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 -data into memory, so the limiting factor tends to be the available memory -on the system. +Starting with this release, &app; no longer loads all data into memory, +which allows it to work with much larger database than before. +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. How many people can &app; database handle? 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. Why is &app; running so slowly? - -If &app; seems too slow to you, it is most likely that you have a large -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. - -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 gramps-devel@lists.sf.net + It does not anymore! Just try out the current + version, &appversion;. My database is really big. Is there a way around loading all the data into memory? -Currently, there is no way around it. However, this is our biggest priority -after releasing version 1.0. The real database backend will be incorporated -in the next stable release (1.2) which will dramatically improve performance -in both speed and memory usage. +Starting with this release, &app; no longer loads all data into memory, +which allows it to work with much larger database than before. @@ -229,34 +222,30 @@ in both speed and memory usage. the flag needs to be reset. This can be done with the following command: - gconftool-2 -u /apps/gramps/startup + gconftool-2 -u /apps/gramps/behavior/startup Why are non-latin characters displayed as garbage in PDF/PS reports? - -This is a known problem -- PS (and PDF) have builtin fonts which pretty much -reflect the latin-1 charset. Any font in principle could be used with PS/PDF -but then it would have to be embedded in the file. This is problematic since -every system has different idea about fonts and their setup. - - -This should be resolved as we move to gnome-print. In the meantime, a useable -workaround is to generate reports in OpenOffice.org format and then export -to PDF from the OpenOffice.org application. - + This is a limitation of the builtin fonts of PS + and PDF formats. To print non-latin text, use the Print... + in the format selection menu of the report dialog. This will use + the gnome-print backend, which supports PS and PDF creation, + as well as direct printing. + + If you only have latin text, the PDF option will produce + a smalled PDF compared to that created by gnome-print, simply because + no font information will be embedded. + + + Why can I not add/remove/edit columns to the lists in People View and Family View? - -This will be addressed after the TreeModelSort bug is fixed in pygtk, -see http://bugzilla.gnome.org/show_bug.cgi?id=125172 - for the details. -Once the patch is committed and incorporated into pygtk, we will add the -ability to add/remove/edit sortable columns. + Now you can! Just try out the current + version, &appversion;. @@ -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 for &app; and superior to the present development strategy. - -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 rather than with a company of retards who can't fully realize the potential of your great idea :-) - + diff --git a/gramps2/doc/gramps-manual/C/getstart.xml b/gramps2/doc/gramps-manual/C/getstart.xml index bdaabea62..15dfe2e6e 100644 --- a/gramps2/doc/gramps-manual/C/getstart.xml +++ b/gramps2/doc/gramps-manual/C/getstart.xml @@ -25,8 +25,9 @@ Getting Started - This chapter provides the most basic information on starting &app; and - obtaining help. Please procede to the following chapters for more information. + This chapter provides the most basic information on starting &app; + and obtaining help. Please procede to the following chapters for more + information. @@ -35,13 +36,15 @@ Applications menu - Choose Other + The method of starting &app; from the menus may vary from + distribution to distribution. On default GNOME desktop, + choose Other Gramps. Command line To start &app; from a command line, type - gramps, then press Return. + gramps, then press Enter. If you would like &app; to open a specific database or to import a specific file on startup, you can supply the filename diff --git a/gramps2/doc/gramps-manual/C/gramps-manual.xml b/gramps2/doc/gramps-manual/C/gramps-manual.xml index fe9b2ec9f..fa61b2a84 100644 --- a/gramps2/doc/gramps-manual/C/gramps-manual.xml +++ b/gramps2/doc/gramps-manual/C/gramps-manual.xml @@ -34,9 +34,9 @@ - + - + @@ -93,7 +93,7 @@ Roitman GRAMPS Project -
shura@alex.neuro.umn.edu
+
shura@gramps-project.org
@@ -101,7 +101,7 @@ Allingham GRAMPS Project -
dallingham@users.sourceforge.net
+
don@gramps-project.org
@@ -139,7 +139,7 @@ &date; Alex Roitman - shura@alex.neuro.umn.edu + shura@gramps-project.org GRAMPS Project @@ -148,7 +148,7 @@ February 2004 Alex Roitman - shura@alex.neuro.umn.edu + shura@gramps-project.org GRAMPS Project @@ -157,7 +157,7 @@ December 2003 Alex Roitman - shura@alex.neuro.umn.edu + shura@gramps-project.org GRAMPS Project @@ -166,7 +166,7 @@ September 2003 Alex Roitman - shura@alex.neuro.umn.edu + shura@gramps-project.org GRAMPS Project @@ -175,7 +175,7 @@ July 2003 Alex Roitman - shura@alex.neuro.umn.edu + shura@gramps-project.org Donald A. Peterson dpeterson@sigmaxi.org GRAMPS Project @@ -186,7 +186,7 @@ May 2003 Alex Roitman - shura@alex.neuro.umn.edu + shura@gramps-project.org GRAMPS Project @@ -196,7 +196,7 @@ April 2003 Alex Roitman - shura@alex.neuro.umn.edu + shura@gramps-project.org GRAMPS Project @@ -206,7 +206,7 @@ 2001 Donald N. Allingham - dallingham@users.sourceforge.net + don@gramps-project.org GRAMPS Project @@ -216,7 +216,7 @@ 2001 Donald N. Allingham - dallingham@users.sourceforge.net + don@gramps-project.org GRAMPS Project @@ -231,7 +231,8 @@ To report a bug or make a suggestion regarding this application or this manual, use the help menu in &app;, or follow the directions - on this site. + found on this site. diff --git a/gramps2/doc/gramps-manual/C/mainwin.xml b/gramps2/doc/gramps-manual/C/mainwin.xml index d36cc6bb0..82811a4b7 100644 --- a/gramps2/doc/gramps-manual/C/mainwin.xml +++ b/gramps2/doc/gramps-manual/C/mainwin.xml @@ -123,7 +123,7 @@ - To switch the View while in a Notebook mode, + To switch the View while in a Tabbed mode, click on the desired notebook tab. @@ -138,7 +138,7 @@ - To switch between sidebar and notebook viewing modes, + To switch between sidebar and tabbed viewing modes, choose View Sidebar from the &app; menu. @@ -546,8 +546,10 @@ Media Objects are any files that relate somehow to the stored genealogical data. Technically, any file can be stored as a Media Object. Most frequently, these are images, audio files, animation - files, etc. The list box on the bottom lists the Name, ID, Type, and - Path to the Media Object. Column Editor Dialog + files, etc. The list box on the bottom lists the Name, + ID, Type, and + Path of the Media Object. + Column Editor Dialog may be used to rearrange the displayed columns, which obey usual sorting rules. The top part of the GRAMPS window shows a preview (if available) and information about the Media diff --git a/gramps2/doc/gramps-manual/C/preface.xml b/gramps2/doc/gramps-manual/C/preface.xml index 715c1e8d8..aec0ffa02 100644 --- a/gramps2/doc/gramps-manual/C/preface.xml +++ b/gramps2/doc/gramps-manual/C/preface.xml @@ -67,10 +67,11 @@ - Berkely database backend - The default format for &app; is now the BSDDB database. This change - allowed us to overcome performance issues and memory requirements of the 1.0.X branch. - With the database backend, the database sizes of several hunder thousand people do not + Berkeley database backend + The default format for &app; is now the BSDDB database. + This change allowed us to overcome performance issues and memory + 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. @@ -161,14 +162,15 @@ Internationalization - The approach for entering and displaying dates has been completely re-worked. In - particular, the new framework allows for a deeper localization of displayed dates than - was ever possible using the translatable strings. + The approach for entering and displaying dates has been completely + re-worked. In particular, the new framework allows for a deeper + localization of displayed dates than was ever possible using the + translatable strings. - The internationalization of names have also been improved. Names can be - grouped under a non-default string. Patronymic names are supported, and it is easy - to program new ways on displaying names, as may be required by other cultures - and languages. + The internationalization of names have also been improved. + Names can be grouped under a non-default string. Patronymic names are + supported, and it is easy to program new ways on displaying names, as + may be required by various cultures and languages. @@ -191,27 +193,27 @@ Typographical conventions In this book, we some words are marked with special typography: - - Applications - Commands you type at the command - line - Filenames - Replaceable text - Labels for buttons and other - portions of the graphical interface + + Applications + Commands you type at the command + line + Filenames + Replaceable text + Labels for buttons and other + portions of the graphical interface - Menu selections look like this: + Menu selections look like this: Menu Submenu Menu Item - - Buttons you can - click - Anything you type - in - + + Buttons you can + click + Anything you type + in + diff --git a/gramps2/doc/gramps.1.in b/gramps2/doc/gramps.1.in index 437766222..29f06467a 100644 --- a/gramps2/doc/gramps.1.in +++ b/gramps2/doc/gramps.1.in @@ -1,4 +1,4 @@ -.TH gramps 1 "@VERSION@" "June 2004" "@VERSION@" +.TH gramps 1 "@VERSION@" "May 2005" "@VERSION@" .SH NAME gramps \- Genealogical Research and Analysis Management Programming System. @@ -7,6 +7,10 @@ gramps \- Genealogical Research and Analysis Management Programming System. .RB [ \-?|\-\^\-help ] .RB [ \-\^\-usage ] .RB [ \-\^\-version ] +.RB [ \-O|\-\^\-open= +.IR FILE +.RB [ \-f|\-\^\-format= +.IR FORMAT ]] .RB [ \-i|\-\^\-import= .IR FILE .RB [ \-f|\-\^\-format= @@ -19,18 +23,19 @@ gramps \- Genealogical Research and Analysis Management Programming System. .IR FORMAT ]] .RB [ \-a|\-\^\-action= .IR ACTION ] +.RB [ \-p|\-\^\-options= +.IR OPTIONSTRING ]] .RB [ .IR FILE .RB ] .SH DESCRIPTION .PP -\fIGramps\fP is an open source genealogy program. It is written in Python, -using the GTK/GNOME interface. -.br +\fIGramps\fP is a Free/OpenSource genealogy program. It is written in Python, +using the GTK+/GNOME interface. 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 +before such as \fIFamily Tree Maker (TM)\fR, \fIPersonal Ancestral +Files (TM)\fR, or the GNU Geneweb. It supports importing of the ever popular GEDCOM format which is used world 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 is ignored. This way of launching is suitable for using gramps 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 .TP .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, the format of that file is guessed according to its extension. .br Formats -available for import are \fBgramps\-xml\fR (guessed if \fIFILE\fR is a -directory), \fBgedcom\fR (guessed if \fIFILE\fR ends with \fB.ged\fR), and -\fBgramps\-pkg\fR (guessed if \fIFILE\fR ends with \fB.gpkg\fR). +available for opening are \fBgrdb\fR (guessed if \fIFILE\fR ends with +\fB.grdb\fR), \fBgramps\-xml\fR (guessed if \fIFILE\fR is a +directory), and \fBgedcom\fR (guessed if \fIFILE\fR ends with \fB.ged\fR). .br -Formats available for export are \fBgramps\-xml\fR, \fBgedcom\fR, \fBgramps\-pkg\fR, -\fBwft\fR (guessed if \fIFILE\fR ends with \fB.wft\fR), and \fBiso\fR -(never guessed, always specify with \fB\-f\fR option). +Formats +available for import are \fBgrdb\fR, \fBgramps\-xml\fR, \fBgedcom\fR, +\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 .BI \-i,\-\^\-import= " FILE" 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. -For \fBgedcom\fR and \fBgramps\-pkg\fR, the \fIFILE\fR is the name of -the corresponding file. +For \fBgrdb\fR, \fBgedcom\fR, \fBgramps\-pkg\fR, and \fBgeneweb\fR, +the \fIFILE\fR is +the name of the corresponding file. .br 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" 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 -written into. For \fBgedcom\fR, \fBwft\fR, and \fBgramps\-pkg\fR, -the \fIFILE\fR is the name of the resulting file. +written into. For \fBgrdb\fR, \fBgedcom\fR, \fBwft\fR, \fBgramps\-pkg\fR, +and \fBgeneweb\fR, the \fIFILE\fR is the name of the resulting file. .br 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" Perform \fIACTION\fR on the imported data. This is done after all imports are succesfully completed. Currently available actions are \fBsummary\fR -(same as Reports->View->Summary) and \fBcheck\fR (same as Tools->Database -Processing->Check and Repair). +(same as Reports->View->Summary), \fBcheck\fR (same as Tools->Database +Processing->Check and Repair), and \fBreport\fR (generates report, needs +the \fIOPTIONSTRING\fR supplied by the \fB\-p\fR flag). .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 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 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) -> -all actions (if any). +all actions (if any). But opening must always be first! .LP -If no \fB\-i\fR option is given, gramps will launch its main -window and start the usual interactive session with the empty database -(since there is no data to process, anyway). +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, +since there is no data to process, anyway. .LP 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. +from all imports. This database resides in the \fBimport_db.grdb\fR +under \fB~/.gramps/import\fR directory. .LP 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. .LP 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. .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 .SH AUTHORS -Donald Allingham \fI\fR +Donald Allingham \fI\fR .br \fIhttp://gramps.sourceforge.net\fR .LP @@ -167,7 +251,7 @@ for inclusion in the Debian GNU/Linux system. .LP This manpage is currently maintained by: .br -Alex Roitman \fI\fR +Alex Roitman \fI\fR .br .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 source distribution. .LP -The developer documentation can be found in the \fBDocs\fR section -of \fIhttp://sourceforge.net/project/gramps\fR site. +The developer documentation can be found on the +\fIhttp://developers.gramps-project.org\fR site.