From 31175616c12a6e3a8ea576d26a243ba9fb3762a1 Mon Sep 17 00:00:00 2001 From: "Anthony J. Bentley" Date: Fri, 3 Apr 2020 01:29:28 -0600 Subject: [PATCH 1/5] Improve syntax of English manpage --- data/man/en.rst | 510 ++++++++++++++++++++++++------------------------ 1 file changed, 258 insertions(+), 252 deletions(-) diff --git a/data/man/en.rst b/data/man/en.rst index 20cc804dd..b9f462806 100644 --- a/data/man/en.rst +++ b/data/man/en.rst @@ -1,299 +1,305 @@ -English -======= +gramps +====== + +----------------------------------------------------------------- +Genealogical Research and Analysis Management Programming System. +----------------------------------------------------------------- + +:Manual section: 1 +:Manual group: @VERSION@ + +######## +SYNOPSIS +######## + +**gramps** +\ [\ **-?** | **--help**] +\ [\ **--usage**] +\ [\ **--version**] +\ [\ **-l**] +\ [\ **-L**] +\ [\ **-u** | **--force-unlock**] +\ [\ **-O** | **--open**\ =\ *DATABASE* [\ **-f** | **--format**\ =\ *FORMAT*]] +\ [\ **-i** | **--import**\ =\ *FILE* [\ **-f** | **--format**\ =\ *FORMAT*]] +\ [\ **--remove**\ =\ *FAMILY_TREE_PATTERN*] +\ [\ **-e** | **--export**\ =\ *FILE* [**-f** | **--format**\ =\ *FORMAT*]] +\ [\ **-a** | **--action**\ =\ *ACTION*] +\ [\ **-p** | **--options**\ =\ *OPTION-STRING*]] +\ [\ *FILE*] +\ [\ **--version**] + +########### +DESCRIPTION +########### + +Gramps 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 genealogy programs +before such as Family Tree Maker (TM), Personal Ancestral Files (TM), +or the GNU Geneweb. +It supports importing of the ever popular GEDCOM format which is used world wide +by almost all other genealogy software. + +####### +OPTIONS +####### + +**gramps** *FILE* + When *FILE* is given (without any flags) as a family tree name or as a + family tree database directory, then it is opened and an interactive + session is started. + If *FILE* is a file format understood by Gramps, an empty family tree is + created whose name is based on the *FILE* name and the data is imported + into it. + 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 invocation can accept any data format native to gramps, see below. + +**-f**, **--format**\ =\ *FORMAT* + Explicitly specify format of *FILE* given by preceding **-i**, or **-e** + option. + If the **-f** option is not given for any *FILE*, the format of that file + is guessed according to its extension or MIME-type. + + Formats available for export are **gramps-xml** (guessed if *FILE* ends + with `.gramps`), **gedcom** (guessed if *FILE* ends with `.ged`), or any + file export available through the Gramps plugin system. + + Formats available for import are **gramps-xml**, **gedcom**, **gramps-pkg** + (guessed if *FILE* ends with `.gpkg`), and **geneweb** (guessed if *FILE* + ends with `.gw`). + + Formats available for export are **gramps-xml**, **gedcom**, + **gramps-pkg**, **wft** (guessed if *FILE* ends with `.wft`), + **geneweb**. + +**-l** + Print a list of known family trees. + +**-L** + Print a detailed list of known family trees. + +**-u**, **--force-unlock** + Unlock a locked database. + +**-O**, **--open**\ =\ *DATABASE* + Open *DATABASE* which must be an existing database directory or existing + family tree name. + If no action, import or export options are given on the command line then + an interactive session is started using that database. + +**-i**, **--import**\ =\ *FILE* + Import data from *FILE*. + If you haven't specified a database, then an empty database is created for + you called Family Tree *x* (where *x* is an incrementing number). + + 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* + might produce different gramps IDs in the resulting database. + +**-e**, **--export**\ =\ *FILE* + Export data into *FILE*. + For **gramps-xml**, **gedcom**, **wft**, **gramps-pkg**, and **geneweb**, + the *FILE* is the name of the resulting file. + + When more than one output file is given, + each has to be preceded by **-e** flag. + The files are written one by one, in the specified order. + +**-a**, **--action**\ =\ *ACTION* + Perform *ACTION* on the imported data. + This is done after all imports are successfully completed. + Currently available actions are **summary** (same as + Reports->View->Summary), **check** (same as Tools->Database + Processing->Check and Repair), **report** (generates report), and tool + (runs a plugin tool). + Both **report** and **tool** need the *OPTION-STRING* supplied by the + **-p** flag). + + The *OPTION-STRING* should satisfy the following conditions: + It must not contain any spaces. + If some arguments need to include spaces, the string should be enclosed + with quotation marks, i.e., follow the shell syntax. + Option string is a list of pairs with name and value (separated by the + equality sign). + The name and value pairs must be separated by commas. + + Most of the report or tools options are specific for each report or tool. + However, there are some common options. + + **name**\ =\ *name* + This mandatory option determines which report or tool will be run. + If the supplied *name* does not correspond to any available report or + tool, an error message will be printed followed by the list of + available reports or tools (depending on the *ACTION*). + + **show**\ =\ **all** + This will produce the list of names for all options available for a + given report or tool. + + **show**\ =\ *optionname* + This will print the description of the functionality supplied by + *optionname*, as well as what are the acceptable types and values for + this option. -gramps(1) @VERSION@ gramps(1) + Use the above options to find out everything about a given report. + When more than one output action is given, each has to be preceded by + **-a** flag. + The actions are performed one by one, in the specified order. +**-d**, **--debug**\ =\ *LOGGER_NAME* + Enables debug logs for development and testing. + Look at the source code for details. -**NAME** - gramps - Genealogical Research and Analysis Management Programming Sys‐ - tem. +**--version** + Prints the version number of gramps and then exits. +######### +OPERATION +######### -**SYNOPSIS** - **gramps** [**-?** | **--help**] [**--usage**] [**--version**] - [**-l**] [**-L**] [**-u** | **--force-unlock**] [**-O** | **--open=** *DATABASE* - [**-f** | **--format=** *FORMAT*] [**-i** | **--import=** *FILE* - [**-f** | **--format=** *FORMAT*]] [**--remove=** *FAMILY_TREE_PATTERN*] - [**-e** | **--export=** *FILE* [**-f** | **--format=** *FORMAT*]] - [**-a** | **--action=** *ACTION*] [*-p* | **--options=** *OPTION‐ - STRING*]] [*FILE*] [**--version**] +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. +If the **-O** flag is given, then gramps will try opening the supplied database +and then work with that data, as instructed by the further command line +parameters. -**DESCRIPTION** - Gramps 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 genealogy programs before such as Family Tree Maker - (TM), Personal Ancestral Files (TM), or the GNU Geneweb. It supports - importing of the ever popular GEDCOM format which is used world wide by - almost all other genealogy software. +With or without the **-O** flag, there could be multiple imports, exports, and +actions specified further on the command line by using **-i**, **-e**, and +**-a** flags. +The order of **-i**, **-e**, or **-a** options does not matter. +The actual order always is: +all imports (if any) -> all actions (if any) -> all exports (if any). +But opening must always be first! -**OPTIONS** - **gramps** *FILE* - When *FILE* is given (without any flags) as a family tree name or - as a family tree database directory, then it is opened and an - interactive session is started. If *FILE* is a file format under‐ - stood by Gramps, an empty family tree is created whose name is - based on the *FILE* name and the data is imported into it. The - rest of the options is ignored. This way of launching is suit‐ - able for using gramps as a handler for genealogical data in e.g. - web browsers. This invocation can accept any data format native - to gramps, see below. +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. +If no **-e** 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 in the *import_db.grdb* under *~/.gramps/import* +directory. - **-f** , **--format=** *FORMAT* - Explicitly specify format of *FILE* given by preceding **-i** , - or **-e** option. If the **-f** option is not given for any - *FILE* , the format of that file is guessed according to its extension - or MIME-type. +The error encountered during import, export, or action, +will be either dumped to *stdout* (if these are exceptions handled by gramps) +or to *stderr* (if these are not handled). +Use usual shell redirections of *stdout* and *stderr* to save messages and +errors in files. - Formats available for export are **gramps-xml** (guessed if *FILE* - ends with **.gramps** ), **gedcom** (guessed if *FILE* ends with - **.ged** ), or any file export available through the Gramps plugin - system. +######## +EXAMPLES +######## - Formats available for import are **gramps-xml** , **gedcom** , - **gramps-pkg** (guessed if *FILE* ends with **.gpkg** ), - and **geneweb** (guessed if *FILE* ends with **.gw** ). +To open an existing family tree and import an xml file into it, one may type:: - Formats available for export are **gramps-xml** , **gedcom** , - **gramps-pkg** , **wft** (guessed if *FILE* ends with **.wft** ), - **geneweb**. + gramps -O 'My Family Tree' -i ~/db3.gramps +The above changes the opened family tree, to do the same, but import both in a +temporary family tree and start an interactive session, one may type:: - **-l** - Print a list of known family trees. + gramps -i 'My Family Tree' -i ~/db3.gramps +To import four databases (whose formats can be determined from their names) and +then check the resulting database for errors, one may type:: - **-L** - Print a detailed list of known family trees. + gramps -i file1.ged -i file2.tgz -i ~/db3.gramps -i file4.wft -a check +To explicitly specify the formats in the above example, append filenames with +appropriate **-f** options:: - **-u** , **--force-unlock** - Unlock a locked database. + gramps -i file1.ged -f gedcom -i file2.tgz -f gramps-pkg \ + -i ~/db3.gramps -f gramps-xml -i file4.wft -f wft -a check +To record the database resulting from all imports, supply **-e** flag (use +**-f** if the filename does not allow gramps to guess the format):: - **-O** , **--open=** *DATABASE* - Open *DATABASE* which must be an existing database directory or - existing family tree name. If no action, import or export - options are given on the command line then an interactive ses‐ - sion is started using that database. + gramps -i file1.ged -i file2.tgz -e ~/new-package -f gramps-pkg +To import three databases and start interactive gramps session with the result:: - **-i** , **--import=** *FILE* - Import data from *FILE* . If you haven't specified a database, then - an empty database is created for you called Family Tree x - (where x is an incrementing number). + gramps -i file1.ged -i file2.tgz -i ~/db3.gramps - 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* - might produce different gramps IDs in the resulting database. +To run the Verify tool from the commandline and output the result to +**stdout**:: + gramps -O 'My Family Tree' -a tool -p name= verify - **-e** , **--export=** *FILE* - Export data into *FILE* . For **gramps-xml** , **gedcom** - , **wft** , **gramps-pkg** , and **geneweb** , the *FILE* is the - name of the resulting file. +Finally, to start normal interactive session type:: - When more than one output file is given, each has to be preceded - by **-e** flag. The files are written one by one, in the specified order. + gramps +##################### +ENVIRONMENT VARIABLES +##################### - **-a** , **--action=** *ACTION* - Perform *ACTION* on the imported data. This is done after all - imports are successfully completed. Currently available actions - are **summary** (same as Reports->View->Summary), **check** (same as - Tools->Database Processing->Check and Repair), **report** (generates - report), and tool (runs a plugin tool). Both **report** and **tool** - need the *OPTIONSTRING* supplied by the **-p** flag). +The program checks whether these environment variables are set: - The *OPTIONSTRING* should satisfy the following conditions: - It must not contain any spaces. If some arguments need to - include spaces, the string should be enclosed with quotation - marks, i.e., follow the shell syntax. Option string is a list - of pairs with name and value (separated by the equality sign). - The name and value pairs must be separated by commas. +``LANG`` + describe, which language to use: + Ex.: for polish language this variable has to be set to `pl_PL.UTF-8`. - Most of the report or tools options are specific for each report - or tool. However, there are some common options. +``GRAMPSHOME`` + if set, force Gramps to use the specified directory to keep program + settings and databases there. + By default, this variable is not set and gramps assumes that the folder + with all databases and profile settings should be created within the user + profile folder (described by environment variable *HOME* for Linux or + *USERPROFILE* for Windows 2000/XP). - **name=name** - This mandatory option determines which report or tool will be - run. If the supplied name does not correspond to any available - report or tool, an error message will be printed followed by the - list of available reports or tools (depending on the *ACTION* ). +``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. - **show=all** - This will produce the list of names for all options available - for a given report or tool. + In addition to generating direct printer output, report generators also + target other systems, such as *LibreOffice.org*, *AbiWord*, *HTML*, or + *LaTeX* to allow the users to modify the format to suit their needs. - **show=optionname** - This will print the description of the functionality supplied by - *optionname*, as well as what are the acceptable types and values - for this option. +##### +FILES +##### - Use the above options to find out everything about a given - report. + *${PREFIX}/bin/gramps* + *${PREFIX}/lib/python3/dist-packages/gramps/* - When more than one output action is given, each has to be preceded by - **-a** flag. The actions are performed one by one, in the specified order. + *${PREFIX}/share/* + *${HOME}/.gramps* - **-d** , **--debug=** *LOGGER_NAME* - Enables debug logs for development and testing. Look at the - source code for details +####### +AUTHORS +####### - **--version** - Prints the version number of gramps and then exits +Donald Allingham +http://gramps-project.org/ +This man page was originally written by: +Brandon L. Griffith +for inclusion in the Debian GNU/Linux system. +This man page is currently maintained by: +Gramps project +############# +DOCUMENTATION +############# -**Operation** - 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. +The user documentation is available through standard web browser in the form of +Gramps Manual. - - If the **-O** flag is given, then gramps will try opening the supplied - database and then work with that data, as instructed by the further - command line parameters. - - - With or without the **-O** flag, there could be multiple imports, exports, - and actions specified further on the command line by using **-i** , - **-e** , and **-a** flags. - - - The order of **-i** , **-e** , or **-a** options does not matter. The actual order - always is: all imports (if any) -> all actions (if any) -> all exports - (if any). 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. - - - If no **-e** 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 in the **import_db.grdb** under - **~/.gramps/import** directory. - - - The error encountered during import, export, or action, will be either - dumped to stdout (if these are exceptions handled by gramps) or to - *stderr* (if these are not handled). Use usual shell redirections of - *stdout* and *stderr* to save messages and errors in files. - - -**EXAMPLES** - To open an existing family tree and import an xml file into it, one - may type: - - **gramps -O** *'My Family Tree'* **-i** *~/db3.gramps* - - The above changes the opened family tree, to do the same, but import - both in a temporary family tree and start an interactive session, one - may type: - - **gramps -i** *'My Family Tree'* **-i** *~/db3.gramps* - - 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.gramps* - **-i** *file4.wft* **-a** *check* - - To explicitly specify the formats in the above example, append file‐ - names with appropriate **-f** options: - - **gramps -i** *file1.ged* **-f** *gedcom* **-i** *file2.tgz* **-f** - *gramps-pkg* **-i** *~/db3.gramps* **-f** *gramps-xml* **-i** *file4.wft* - **-f** *wft* **-a** *check* - - To record the database resulting from all imports, supply **-e** flag (use - **-f** if the filename does not allow gramps to guess the format): - - **gramps -i** *file1.ged* **-i** *file2.tgz* **-e** *~/new-package* - **-f** *gramps-pkg* - - To import three databases and start interactive gramps session with the - result: - - **gramps -i** *file1.ged* **-i** *file2.tgz* **-i** *~/db3.gramps* - - To run the Verify tool from the commandline and output the result to - stdout: - - **gramps -O** *'My Family Tree'* **-a** *tool* **-p name=** *verify* - - Finally, to start normal interactive session type: - - **gramps** - - -**ENVIRONMENT VARIABLES** - The program checks whether these environment variables are set: - - **LANG** - describe, which language to use: Ex.: for polish language this - variable has to be set to pl_PL.UTF-8. - - **GRAMPSHOME** - if set, force Gramps to use the specified directory to - keep program settings and databases there. By default, this variable is - not set and gramps assumes that the folder with all databases and pro‐ - file settings should be created within the user profile folder - (described by environment variable HOME for Linux or USERPROFILE for - Windows 2000/XP). - - -**CONCEPTS** - Supports a python-based plugin system, allowing import and export writ‐ - ers, report generators, tools, and display filters to be added without - modification of the main program. - - In addition to generating direct printer output, report generators also - target other systems, such as *LibreOffice.org* , *AbiWord* , *HTML*, - or *LaTeX* to allow the users to modify the format to suit their needs. - - -**KNOWN BUGS AND LIMITATIONS** - -**FILES** - - *${PREFIX}/bin/gramps* - - *${PREFIX}/lib/python3/dist-packages/gramps/* - - *${PREFIX}/share/* - - *${HOME}/.gramps* - - -**AUTHORS** - Donald Allingham - http://gramps-project.org/ - - This man page was originally written by: - Brandon L. Griffith - for inclusion in the Debian GNU/Linux system. - - This man page is currently maintained by: - Gramps project - - -**DOCUMENTATION** - The user documentation is available through standard web browser - in the form of Gramps Manual. - - The developer documentation can be found on the - http://www.gramps-project.org/wiki/index.php?title=Portal:Developers - portal. - - - -gramps(1) @VERSION@ gramps(1) +The developer documentation can be found on the +http://www.gramps-project.org/wiki/index.php?title=Portal:Developers +portal. From b6c9d1d96577e49e7b0d24fc7f05319eda4eb07e Mon Sep 17 00:00:00 2001 From: "Anthony J. Bentley" Date: Fri, 3 Apr 2020 01:30:37 -0600 Subject: [PATCH 2/5] Sprinkle Unicode trademarks and arrows within the English manpage --- data/man/en.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/data/man/en.rst b/data/man/en.rst index b9f462806..dfc671f67 100644 --- a/data/man/en.rst +++ b/data/man/en.rst @@ -35,7 +35,7 @@ DESCRIPTION Gramps 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 genealogy programs -before such as Family Tree Maker (TM), Personal Ancestral Files (TM), +before such as Family Tree Maker™, Personal Ancestral Files™, or the GNU Geneweb. It supports importing of the ever popular GEDCOM format which is used world wide by almost all other genealogy software. @@ -115,8 +115,8 @@ OPTIONS Perform *ACTION* on the imported data. This is done after all imports are successfully completed. Currently available actions are **summary** (same as - Reports->View->Summary), **check** (same as Tools->Database - Processing->Check and Repair), **report** (generates report), and tool + Reports→View→Summary), **check** (same as Tools→Database + Processing→Check and Repair), **report** (generates report), and tool (runs a plugin tool). Both **report** and **tool** need the *OPTION-STRING* supplied by the **-p** flag). @@ -179,7 +179,7 @@ actions specified further on the command line by using **-i**, **-e**, and The order of **-i**, **-e**, or **-a** options does not matter. The actual order always is: -all imports (if any) -> all actions (if any) -> all exports (if any). +all imports (if any) → all actions (if any) → all exports (if any). But opening must always be first! If no **-O** or **-i** option is given, From 20ea5a12540cee1edd9e5e4f184cecd95f2a8a78 Mon Sep 17 00:00:00 2001 From: "Anthony J. Bentley" Date: Fri, 3 Apr 2020 01:32:31 -0600 Subject: [PATCH 3/5] Use HTTPS URLs in the English manpage --- data/man/en.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/data/man/en.rst b/data/man/en.rst index dfc671f67..c2555d4ef 100644 --- a/data/man/en.rst +++ b/data/man/en.rst @@ -284,7 +284,7 @@ AUTHORS ####### Donald Allingham -http://gramps-project.org/ +https://www.gramps-project.org/ This man page was originally written by: Brandon L. Griffith @@ -301,5 +301,5 @@ The user documentation is available through standard web browser in the form of Gramps Manual. The developer documentation can be found on the -http://www.gramps-project.org/wiki/index.php?title=Portal:Developers +https://www.gramps-project.org/wiki/index.php/Portal:Developers portal. From ec64335eeff080d9ef17bb13c0fdf3d11fc2c4b2 Mon Sep 17 00:00:00 2001 From: "Anthony J. Bentley" Date: Fri, 3 Apr 2020 01:54:10 -0600 Subject: [PATCH 4/5] Various grammar improvements in the English manpage --- data/man/en.rst | 92 +++++++++++++++++++++++++------------------------ 1 file changed, 47 insertions(+), 45 deletions(-) diff --git a/data/man/en.rst b/data/man/en.rst index c2555d4ef..810ca59a0 100644 --- a/data/man/en.rst +++ b/data/man/en.rst @@ -32,12 +32,12 @@ SYNOPSIS DESCRIPTION ########### -Gramps is a Free/OpenSource genealogy program. +Gramps is a Free, Open Source genealogy program. It is written in Python, using the GTK+/GNOME interface. Gramps should seem familiar to anyone who has used other genealogy programs before such as Family Tree Maker™, Personal Ancestral Files™, or the GNU Geneweb. -It supports importing of the ever popular GEDCOM format which is used world wide +It supports importing of the ever-popular GEDCOM format which is used worldwide by almost all other genealogy software. ####### @@ -49,18 +49,18 @@ OPTIONS family tree database directory, then it is opened and an interactive session is started. If *FILE* is a file format understood by Gramps, an empty family tree is - created whose name is based on the *FILE* name and the data is imported + created whose name is based on the *FILE* name, and the data is imported into it. - The rest of the options is ignored. + Any other options are ignored. This way of launching is suitable for using gramps as a handler for genealogical data in e.g. web browsers. - This invocation can accept any data format native to gramps, see below. + This invocation can accept any data format native to gramps; see below. **-f**, **--format**\ =\ *FORMAT* - Explicitly specify format of *FILE* given by preceding **-i**, or **-e** + Explicitly specify format of *FILE* given by preceding **-i** or **-e** option. If the **-f** option is not given for any *FILE*, the format of that file - is guessed according to its extension or MIME-type. + is guessed according to its extension or MIME type. Formats available for export are **gramps-xml** (guessed if *FILE* ends with `.gramps`), **gedcom** (guessed if *FILE* ends with `.ged`), or any @@ -86,17 +86,17 @@ OPTIONS **-O**, **--open**\ =\ *DATABASE* Open *DATABASE* which must be an existing database directory or existing family tree name. - If no action, import or export options are given on the command line then + If no action, import, or export options are given on the command line, then an interactive session is started using that database. **-i**, **--import**\ =\ *FILE* Import data from *FILE*. - If you haven't specified a database, then an empty database is created for - you called Family Tree *x* (where *x* is an incrementing number). + If no database was specified, then an empty database is created + called Family Tree *x* (where *x* is an incrementing number). 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. + each has to be preceded by a **-i** flag. + The files are imported in the specified order, e.g., **-i** *FILE1* **-i** *FILE2* and **-i** *FILE2* **-i** *FILE1* @@ -108,7 +108,7 @@ OPTIONS the *FILE* is the name of the resulting file. When more than one output file is given, - each has to be preceded by **-e** flag. + each has to be preceded by a **-e** flag. The files are written one by one, in the specified order. **-a**, **--action**\ =\ *ACTION* @@ -122,12 +122,13 @@ OPTIONS **-p** flag). The *OPTION-STRING* should satisfy the following conditions: - It must not contain any spaces. - If some arguments need to include spaces, the string should be enclosed - with quotation marks, i.e., follow the shell syntax. - Option string is a list of pairs with name and value (separated by the - equality sign). - The name and value pairs must be separated by commas. + + - It should not contain any spaces. + - If some arguments need to include spaces, the string should be enclosed + with quotation marks, following shell syntax. + - The option string is a list of pairs with name and value (separated by an + equals sign). + - The name and value pairs must be separated by commas. Most of the report or tools options are specific for each report or tool. However, there are some common options. @@ -147,56 +148,56 @@ OPTIONS *optionname*, as well as what are the acceptable types and values for this option. - Use the above options to find out everything about a given report. + Use the above options to find out everything about a given report. - When more than one output action is given, each has to be preceded by + When more than one output action is given, each has to be preceded by a **-a** flag. The actions are performed one by one, in the specified order. **-d**, **--debug**\ =\ *LOGGER_NAME* - Enables debug logs for development and testing. + Enable debug logs for development and testing. Look at the source code for details. **--version** - Prints the version number of gramps and then exits. + Print the version number of gramps and then exits. ######### OPERATION ######### -If the first argument on the command line does not start with dash (i.e. no +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 +argument and start an interactive session, ignoring the rest of the command line arguments. If the **-O** flag is given, then gramps will try opening the supplied database and then work with that data, as instructed by the further command line parameters. -With or without the **-O** flag, there could be multiple imports, exports, and -actions specified further on the command line by using **-i**, **-e**, and +With or without the **-O** flag, further imports, exports, and actions may be +specified on the command line by using **-i**, **-e**, and **-a** flags. The order of **-i**, **-e**, or **-a** options does not matter. -The actual order always is: +The actual order they are processed always is: all imports (if any) → all actions (if any) → all exports (if any). 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. +an empty database, since there is no data to process anyway. If no **-e** 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 in the *import_db.grdb* under *~/.gramps/import* +the database resulting from all imports. +This database resides in the *import_db.grdb* under the *~/.gramps/import* directory. -The error encountered during import, export, or action, -will be either dumped to *stdout* (if these are exceptions handled by gramps) +Any errors encountered during import, export, or action +will be dumped either to *stdout* (if these are exceptions handled by gramps) or to *stderr* (if these are not handled). Use usual shell redirections of *stdout* and *stderr* to save messages and -errors in files. +errors to files. ######## EXAMPLES @@ -206,7 +207,7 @@ To open an existing family tree and import an xml file into it, one may type:: gramps -O 'My Family Tree' -i ~/db3.gramps -The above changes the opened family tree, to do the same, but import both in a +The above changes the opened family tree. To do the same, but import both in a temporary family tree and start an interactive session, one may type:: gramps -i 'My Family Tree' -i ~/db3.gramps @@ -222,21 +223,22 @@ appropriate **-f** options:: gramps -i file1.ged -f gedcom -i file2.tgz -f gramps-pkg \ -i ~/db3.gramps -f gramps-xml -i file4.wft -f wft -a check -To record the database resulting from all imports, supply **-e** flag (use +To record the database resulting from all imports, supply a **-e** flag (use **-f** if the filename does not allow gramps to guess the format):: gramps -i file1.ged -i file2.tgz -e ~/new-package -f gramps-pkg -To import three databases and start interactive gramps session with the result:: +To import three databases and start an interactive gramps session with the +result:: gramps -i file1.ged -i file2.tgz -i ~/db3.gramps To run the Verify tool from the commandline and output the result to -**stdout**:: +*stdout*:: gramps -O 'My Family Tree' -a tool -p name= verify -Finally, to start normal interactive session type:: +Finally, to start a normal interactive session type:: gramps @@ -247,12 +249,12 @@ ENVIRONMENT VARIABLES The program checks whether these environment variables are set: ``LANG`` - describe, which language to use: - Ex.: for polish language this variable has to be set to `pl_PL.UTF-8`. + Describe which language to use. + E.g., for the Polish language this variable has to be set to `pl_PL.UTF-8`. ``GRAMPSHOME`` - if set, force Gramps to use the specified directory to keep program - settings and databases there. + Force Gramps to use the specified directory to keep program + settings and databases in. By default, this variable is not set and gramps assumes that the folder with all databases and profile settings should be created within the user profile folder (described by environment variable *HOME* for Linux or @@ -264,7 +266,7 @@ The program checks whether these environment variables are set: modification of the main program. In addition to generating direct printer output, report generators also - target other systems, such as *LibreOffice.org*, *AbiWord*, *HTML*, or + target other output formats, such as *LibreOffice*, *AbiWord*, *HTML*, or *LaTeX* to allow the users to modify the format to suit their needs. ##### @@ -297,7 +299,7 @@ Gramps project DOCUMENTATION ############# -The user documentation is available through standard web browser in the form of +The user documentation is available through a web browser in the form of the Gramps Manual. The developer documentation can be found on the From 8159aca9b49a8c1604377bd4f2adf2736dcbbd57 Mon Sep 17 00:00:00 2001 From: Nick Hall Date: Wed, 9 Feb 2022 22:52:24 +0000 Subject: [PATCH 5/5] Generate gramps.1.in file --- data/man/gramps.1.in | 450 ++++++++++++++++++++++++------------------- 1 file changed, 249 insertions(+), 201 deletions(-) diff --git a/data/man/gramps.1.in b/data/man/gramps.1.in index 5478ed310..02ede0853 100644 --- a/data/man/gramps.1.in +++ b/data/man/gramps.1.in @@ -1,8 +1,8 @@ .\" Man page generated from reStructuredText. . -.TH ENGLISH "" "" "" +.TH GRAMPS 1 "" "" "@VERSION@" .SH NAME -English \- +gramps \- Genealogical Research and Analysis Management Programming System. . .nr rst2man-indent-level 0 . @@ -30,62 +30,63 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. +.SH SYNOPSIS .sp -gramps(1) @VERSION@ gramps(1) +\fBgramps\fP +[\fB\-?\fP | \fB\-\-help\fP] +[\fB\-\-usage\fP] +[\fB\-\-version\fP] +[\fB\-l\fP] +[\fB\-L\fP] +[\fB\-u\fP | \fB\-\-force\-unlock\fP] +[\fB\-O\fP | \fB\-\-open\fP=\fIDATABASE\fP [\fB\-f\fP | \fB\-\-format\fP=\fIFORMAT\fP]] +[\fB\-i\fP | \fB\-\-import\fP=\fIFILE\fP [\fB\-f\fP | \fB\-\-format\fP=\fIFORMAT\fP]] +[\fB\-\-remove\fP=\fIFAMILY_TREE_PATTERN\fP] +[\fB\-e\fP | \fB\-\-export\fP=\fIFILE\fP [\fB\-f\fP | \fB\-\-format\fP=\fIFORMAT\fP]] +[\fB\-a\fP | \fB\-\-action\fP=\fIACTION\fP] +[\fB\-p\fP | \fB\-\-options\fP=\fIOPTION\-STRING\fP]] +[\fIFILE\fP] +[\fB\-\-version\fP] +.SH DESCRIPTION +.sp +Gramps is a Free, Open Source genealogy program. +It is written in Python, using the GTK+/GNOME interface. +Gramps should seem familiar to anyone who has used other genealogy programs +before such as Family Tree Maker™, Personal Ancestral Files™, +or the GNU Geneweb. +It supports importing of the ever\-popular GEDCOM format which is used worldwide +by almost all other genealogy software. +.SH OPTIONS .INDENT 0.0 .TP -.B \fBNAME\fP -gramps \- Genealogical Research and Analysis Management Programming Sys‐ -tem. -.TP -.B \fBSYNOPSIS\fP -\fBgramps\fP [\fB\-?\fP | \fB\-\-help\fP] [\fB\-\-usage\fP] [\fB\-\-version\fP] -[\fB\-l\fP] [\fB\-L\fP] [\fB\-u\fP | \fB\-\-force\-unlock\fP] [\fB\-O\fP | \fB\-\-open=\fP \fIDATABASE\fP -[\fB\-f\fP | \fB\-\-format=\fP \fIFORMAT\fP] [\fB\-i\fP | \fB\-\-import=\fP \fIFILE\fP -[\fB\-f\fP | \fB\-\-format=\fP \fIFORMAT\fP]] [\fB\-\-remove=\fP \fIFAMILY_TREE_PATTERN\fP] -[\fB\-e\fP | \fB\-\-export=\fP \fIFILE\fP [\fB\-f\fP | \fB\-\-format=\fP \fIFORMAT\fP]] -[\fB\-a\fP | \fB\-\-action=\fP \fIACTION\fP] [\fI\-p\fP | \fB\-\-options=\fP \fIOPTION‐ -STRING\fP]] [\fIFILE\fP] [\fB\-\-version\fP] -.TP -.B \fBDESCRIPTION\fP -Gramps 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 genealogy programs before such as Family Tree Maker -(TM), Personal Ancestral Files (TM), or the GNU Geneweb. It supports -importing of the ever popular GEDCOM format which is used world wide by -almost all other genealogy software. -.TP -.B \fBOPTIONS\fP -.INDENT 7.0 -.TP .B \fBgramps\fP \fIFILE\fP -When \fIFILE\fP is given (without any flags) as a family tree name or -as a family tree database directory, then it is opened and an -interactive session is started. If \fIFILE\fP is a file format under‐ -stood by Gramps, an empty family tree is created whose name is -based on the \fIFILE\fP name and the data is imported into it. The -rest of the options is ignored. This way of launching is suit‐ -able for using gramps as a handler for genealogical data in e.g. -web browsers. This invocation can accept any data format native -to gramps, see below. +When \fIFILE\fP is given (without any flags) as a family tree name or as a +family tree database directory, then it is opened and an interactive +session is started. +If \fIFILE\fP is a file format understood by Gramps, an empty family tree is +created whose name is based on the \fIFILE\fP name, and the data is imported +into it. +Any other options are ignored. +This way of launching is suitable for using gramps as a handler for +genealogical data in e.g. web browsers. +This invocation can accept any data format native to gramps; see below. .TP -.B \fB\-f\fP , \fB\-\-format=\fP \fIFORMAT\fP -Explicitly specify format of \fIFILE\fP given by preceding \fB\-i\fP , -or \fB\-e\fP option. If the \fB\-f\fP option is not given for any -\fIFILE\fP , the format of that file is guessed according to its extension -or MIME\-type. +.B \fB\-f\fP, \fB\-\-format\fP=\fIFORMAT\fP +Explicitly specify format of \fIFILE\fP given by preceding \fB\-i\fP or \fB\-e\fP +option. +If the \fB\-f\fP option is not given for any \fIFILE\fP, the format of that file +is guessed according to its extension or MIME type. .sp -Formats available for export are \fBgramps\-xml\fP (guessed if \fIFILE\fP -ends with \fB\&.gramps\fP ), \fBgedcom\fP (guessed if \fIFILE\fP ends with -\fB\&.ged\fP ), or any file export available through the Gramps plugin -system. +Formats available for export are \fBgramps\-xml\fP (guessed if \fIFILE\fP ends +with \fI\&.gramps\fP), \fBgedcom\fP (guessed if \fIFILE\fP ends with \fI\&.ged\fP), or any +file export available through the Gramps plugin system. .sp -Formats available for import are \fBgramps\-xml\fP , \fBgedcom\fP , -\fBgramps\-pkg\fP (guessed if \fIFILE\fP ends with \fB\&.gpkg\fP ), -and \fBgeneweb\fP (guessed if \fIFILE\fP ends with \fB\&.gw\fP ). +Formats available for import are \fBgramps\-xml\fP, \fBgedcom\fP, \fBgramps\-pkg\fP +(guessed if \fIFILE\fP ends with \fI\&.gpkg\fP), and \fBgeneweb\fP (guessed if \fIFILE\fP +ends with \fI\&.gw\fP). .sp -Formats available for export are \fBgramps\-xml\fP , \fBgedcom\fP , -\fBgramps\-pkg\fP , \fBwft\fP (guessed if \fIFILE\fP ends with \fB\&.wft\fP ), +Formats available for export are \fBgramps\-xml\fP, \fBgedcom\fP, +\fBgramps\-pkg\fP, \fBwft\fP (guessed if \fIFILE\fP ends with \fI\&.wft\fP), \fBgeneweb\fP\&. .TP .B \fB\-l\fP @@ -94,209 +95,260 @@ Print a list of known family trees. .B \fB\-L\fP Print a detailed list of known family trees. .TP -.B \fB\-u\fP , \fB\-\-force\-unlock\fP +.B \fB\-u\fP, \fB\-\-force\-unlock\fP Unlock a locked database. .TP -.B \fB\-O\fP , \fB\-\-open=\fP \fIDATABASE\fP -Open \fIDATABASE\fP which must be an existing database directory or -existing family tree name. If no action, import or export -options are given on the command line then an interactive ses‐ -sion is started using that database. +.B \fB\-O\fP, \fB\-\-open\fP=\fIDATABASE\fP +Open \fIDATABASE\fP which must be an existing database directory or existing +family tree name. +If no action, import, or export options are given on the command line, then +an interactive session is started using that database. .TP -.B \fB\-i\fP , \fB\-\-import=\fP \fIFILE\fP -Import data from \fIFILE\fP . If you haven\(aqt specified a database, then -an empty database is created for you called Family Tree x -(where x is an incrementing number). +.B \fB\-i\fP, \fB\-\-import\fP=\fIFILE\fP +Import data from \fIFILE\fP\&. +If no database was specified, then an empty database is created +called Family Tree \fIx\fP (where \fIx\fP is an incrementing number). .sp -When more than one input file is given, each has to be preceded -by \fB\-i\fP flag. The files are imported in the specified order, i.e. -\fB\-i\fP \fIFILE1\fP \fB\-i\fP \fIFILE2\fP and \fB\-i\fP \fIFILE2\fP \fB\-i\fP \fIFILE1\fP +When more than one input file is given, +each has to be preceded by a \fB\-i\fP flag. +The files are imported in the specified order, e.g., +\fB\-i\fP \fIFILE1\fP \fB\-i\fP \fIFILE2\fP +and +\fB\-i\fP \fIFILE2\fP \fB\-i\fP \fIFILE1\fP might produce different gramps IDs in the resulting database. .TP -.B \fB\-e\fP , \fB\-\-export=\fP \fIFILE\fP -Export data into \fIFILE\fP . For \fBgramps\-xml\fP , \fBgedcom\fP -, \fBwft\fP , \fBgramps\-pkg\fP , and \fBgeneweb\fP , the \fIFILE\fP is the -name of the resulting file. +.B \fB\-e\fP, \fB\-\-export\fP=\fIFILE\fP +Export data into \fIFILE\fP\&. +For \fBgramps\-xml\fP, \fBgedcom\fP, \fBwft\fP, \fBgramps\-pkg\fP, and \fBgeneweb\fP, +the \fIFILE\fP is the name of the resulting file. .sp -When more than one output file is given, each has to be preceded -by \fB\-e\fP flag. The files are written one by one, in the specified order. +When more than one output file is given, +each has to be preceded by a \fB\-e\fP flag. +The files are written one by one, in the specified order. .TP -.B \fB\-a\fP , \fB\-\-action=\fP \fIACTION\fP -Perform \fIACTION\fP on the imported data. This is done after all -imports are successfully completed. Currently available actions -are \fBsummary\fP (same as Reports\->View\->Summary), \fBcheck\fP (same as -Tools\->Database Processing\->Check and Repair), \fBreport\fP (generates -report), and tool (runs a plugin tool). Both \fBreport\fP and \fBtool\fP -need the \fIOPTIONSTRING\fP supplied by the \fB\-p\fP flag). +.B \fB\-a\fP, \fB\-\-action\fP=\fIACTION\fP +Perform \fIACTION\fP on the imported data. +This is done after all imports are successfully completed. +Currently available actions are \fBsummary\fP (same as +Reports→View→Summary), \fBcheck\fP (same as Tools→Database +Processing→Check and Repair), \fBreport\fP (generates report), and tool +(runs a plugin tool). +Both \fBreport\fP and \fBtool\fP need the \fIOPTION\-STRING\fP supplied by the +\fB\-p\fP flag). .sp -The \fIOPTIONSTRING\fP should satisfy the following conditions: -It must not contain any spaces. If some arguments need to -include spaces, the string should be enclosed with quotation -marks, i.e., follow the shell syntax. Option string is a list -of pairs with name and value (separated by the equality sign). +The \fIOPTION\-STRING\fP should satisfy the following conditions: +.INDENT 7.0 +.IP \(bu 2 +It should not contain any spaces. +.IP \(bu 2 +If some arguments need to include spaces, the string should be enclosed +with quotation marks, following shell syntax. +.IP \(bu 2 +The option string is a list of pairs with name and value (separated by an +equals sign). +.IP \(bu 2 The name and value pairs must be separated by commas. -.sp -Most of the report or tools options are specific for each report -or tool. However, there are some common options. -.sp -\fBname=name\fP -This mandatory option determines which report or tool will be -run. If the supplied name does not correspond to any available -report or tool, an error message will be printed followed by the -list of available reports or tools (depending on the \fIACTION\fP ). -.sp -\fBshow=all\fP -This will produce the list of names for all options available -for a given report or tool. -.sp -\fBshow=optionname\fP -This will print the description of the functionality supplied by -\fIoptionname\fP, as well as what are the acceptable types and values -for this option. -.sp -Use the above options to find out everything about a given -report. .UNINDENT .sp -When more than one output action is given, each has to be preceded by -\fB\-a\fP flag. The actions are performed one by one, in the specified order. +Most of the report or tools options are specific for each report or tool. +However, there are some common options. .INDENT 7.0 .TP -.B \fB\-d\fP , \fB\-\-debug=\fP \fILOGGER_NAME\fP -Enables debug logs for development and testing. Look at the -source code for details +.B \fBname\fP=\fIname\fP +This mandatory option determines which report or tool will be run. +If the supplied \fIname\fP does not correspond to any available report or +tool, an error message will be printed followed by the list of +available reports or tools (depending on the \fIACTION\fP). +.TP +.B \fBshow\fP=\fBall\fP +This will produce the list of names for all options available for a +given report or tool. +.TP +.B \fBshow\fP=\fIoptionname\fP +This will print the description of the functionality supplied by +\fIoptionname\fP, as well as what are the acceptable types and values for +this option. +.UNINDENT +.sp +Use the above options to find out everything about a given report. +.sp +When more than one output action is given, each has to be preceded by a +\fB\-a\fP flag. +The actions are performed one by one, in the specified order. +.TP +.B \fB\-d\fP, \fB\-\-debug\fP=\fILOGGER_NAME\fP +Enable debug logs for development and testing. +Look at the source code for details. .TP .B \fB\-\-version\fP -Prints the version number of gramps and then exits +Print the version number of gramps and then exits. .UNINDENT -.TP -.B \fBOperation\fP -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. +.SH OPERATION .sp -If the \fB\-O\fP flag is given, then gramps will try opening the supplied -database and then work with that data, as instructed by the further -command line parameters. +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 an interactive session, ignoring the rest of the command line +arguments. .sp -With or without the \fB\-O\fP flag, there could be multiple imports, exports, -and actions specified further on the command line by using \fB\-i\fP , -\fB\-e\fP , and \fB\-a\fP flags. +If the \fB\-O\fP flag is given, then gramps will try opening the supplied database +and then work with that data, as instructed by the further command line +parameters. .sp -The order of \fB\-i\fP , \fB\-e\fP , or \fB\-a\fP options does not matter. The actual order -always is: all imports (if any) \-> all actions (if any) \-> all exports -(if any). But opening must always be first! +With or without the \fB\-O\fP flag, further imports, exports, and actions may be +specified on the command line by using \fB\-i\fP, \fB\-e\fP, and +\fB\-a\fP flags. .sp -If no \fB\-O\fP or \fB\-i\fP 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. +The order of \fB\-i\fP, \fB\-e\fP, or \fB\-a\fP options does not matter. +The actual order they are processed always is: +all imports (if any) → all actions (if any) → all exports (if any). +But opening must always be first! .sp -If no \fB\-e\fP or \fB\-a\fP 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 in the \fBimport_db.grdb\fP under -\fB~/.gramps/import\fP directory. +If no \fB\-O\fP or \fB\-i\fP option is given, +gramps will launch its main window and start the usual interactive session with +an empty database, since there is no data to process anyway. .sp -The error encountered during import, export, or action, will be either -dumped to stdout (if these are exceptions handled by gramps) or to -\fIstderr\fP (if these are not handled). Use usual shell redirections of -\fIstdout\fP and \fIstderr\fP to save messages and errors in files. -.TP -.B \fBEXAMPLES\fP -To open an existing family tree and import an xml file into it, one -may type: -.INDENT 7.0 +If no \fB\-e\fP or \fB\-a\fP options are given, +gramps will launch its main window and start the usual interactive session with +the database resulting from all imports. +This database resides in the \fIimport_db.grdb\fP under the \fI~/.gramps/import\fP +directory. +.sp +Any errors encountered during import, export, or action +will be dumped either to \fIstdout\fP (if these are exceptions handled by gramps) +or to \fIstderr\fP (if these are not handled). +Use usual shell redirections of \fIstdout\fP and \fIstderr\fP to save messages and +errors to files. +.SH EXAMPLES +.sp +To open an existing family tree and import an xml file into it, one may type: +.INDENT 0.0 .INDENT 3.5 -\fBgramps \-O\fP \fI\(aqMy Family Tree\(aq\fP \fB\-i\fP \fI~/db3.gramps\fP +.sp +.nf +.ft C +gramps \-O \(aqMy Family Tree\(aq \-i ~/db3.gramps +.ft P +.fi .UNINDENT .UNINDENT .sp -The above changes the opened family tree, to do the same, but import -both in a temporary family tree and start an interactive session, one -may type: -.INDENT 7.0 +The above changes the opened family tree. To do the same, but import both in a +temporary family tree and start an interactive session, one may type: +.INDENT 0.0 .INDENT 3.5 -\fBgramps \-i\fP \fI\(aqMy Family Tree\(aq\fP \fB\-i\fP \fI~/db3.gramps\fP +.sp +.nf +.ft C +gramps \-i \(aqMy Family Tree\(aq \-i ~/db3.gramps +.ft P +.fi .UNINDENT .UNINDENT .sp -To import four databases (whose formats can be determined from their -names) and then check the resulting database for errors, one may type: -.INDENT 7.0 +To import four databases (whose formats can be determined from their names) and +then check the resulting database for errors, one may type: +.INDENT 0.0 .INDENT 3.5 -\fBgramps \-i\fP \fIfile1.ged\fP \fB\-i\fP \fIfile2.tgz\fP \fB\-i\fP \fI~/db3.gramps\fP -\fB\-i\fP \fIfile4.wft\fP \fB\-a\fP \fIcheck\fP +.sp +.nf +.ft C +gramps \-i file1.ged \-i file2.tgz \-i ~/db3.gramps \-i file4.wft \-a check +.ft P +.fi .UNINDENT .UNINDENT .sp -To explicitly specify the formats in the above example, append file‐ -names with appropriate \fB\-f\fP options: -.INDENT 7.0 +To explicitly specify the formats in the above example, append filenames with +appropriate \fB\-f\fP options: +.INDENT 0.0 .INDENT 3.5 -\fBgramps \-i\fP \fIfile1.ged\fP \fB\-f\fP \fIgedcom\fP \fB\-i\fP \fIfile2.tgz\fP \fB\-f\fP -\fIgramps\-pkg\fP \fB\-i\fP \fI~/db3.gramps\fP \fB\-f\fP \fIgramps\-xml\fP \fB\-i\fP \fIfile4.wft\fP -\fB\-f\fP \fIwft\fP \fB\-a\fP \fIcheck\fP +.sp +.nf +.ft C +gramps \-i file1.ged \-f gedcom \-i file2.tgz \-f gramps\-pkg \e +\-i ~/db3.gramps \-f gramps\-xml \-i file4.wft \-f wft \-a check +.ft P +.fi .UNINDENT .UNINDENT .sp -To record the database resulting from all imports, supply \fB\-e\fP flag (use +To record the database resulting from all imports, supply a \fB\-e\fP flag (use \fB\-f\fP if the filename does not allow gramps to guess the format): -.INDENT 7.0 +.INDENT 0.0 .INDENT 3.5 -\fBgramps \-i\fP \fIfile1.ged\fP \fB\-i\fP \fIfile2.tgz\fP \fB\-e\fP \fI~/new\-package\fP -\fB\-f\fP \fIgramps\-pkg\fP +.sp +.nf +.ft C +gramps \-i file1.ged \-i file2.tgz \-e ~/new\-package \-f gramps\-pkg +.ft P +.fi .UNINDENT .UNINDENT .sp -To import three databases and start interactive gramps session with the +To import three databases and start an interactive gramps session with the result: -.INDENT 7.0 +.INDENT 0.0 .INDENT 3.5 -\fBgramps \-i\fP \fIfile1.ged\fP \fB\-i\fP \fIfile2.tgz\fP \fB\-i\fP \fI~/db3.gramps\fP +.sp +.nf +.ft C +gramps \-i file1.ged \-i file2.tgz \-i ~/db3.gramps +.ft P +.fi .UNINDENT .UNINDENT .sp To run the Verify tool from the commandline and output the result to -stdout: -.INDENT 7.0 +\fIstdout\fP: +.INDENT 0.0 .INDENT 3.5 -\fBgramps \-O\fP \fI\(aqMy Family Tree\(aq\fP \fB\-a\fP \fItool\fP \fB\-p name=\fP \fIverify\fP +.sp +.nf +.ft C +gramps \-O \(aqMy Family Tree\(aq \-a tool \-p name= verify +.ft P +.fi .UNINDENT .UNINDENT .sp -Finally, to start normal interactive session type: -.INDENT 7.0 +Finally, to start a normal interactive session type: +.INDENT 0.0 .INDENT 3.5 -\fBgramps\fP +.sp +.nf +.ft C +gramps +.ft P +.fi .UNINDENT .UNINDENT -.TP -.B \fBENVIRONMENT VARIABLES\fP +.SH ENVIRONMENT VARIABLES +.sp The program checks whether these environment variables are set: -.sp -\fBLANG\fP \- describe, which language to use: Ex.: for polish language this -variable has to be set to pl_PL.UTF\-8. -.sp -\fBGRAMPSHOME\fP \- if set, force Gramps to use the specified directory to -keep program settings and databases there. By default, this variable is -not set and gramps assumes that the folder with all databases and pro‐ -file settings should be created within the user profile folder -(described by environment variable HOME for Linux or USERPROFILE for -Windows 2000/XP). +.INDENT 0.0 +.TP +.B \fBLANG\fP +Describe which language to use. +E.g., for the Polish language this variable has to be set to \fIpl_PL.UTF\-8\fP\&. +.TP +.B \fBGRAMPSHOME\fP +Force Gramps to use the specified directory to keep program +settings and databases in. +By default, this variable is not set and gramps assumes that the folder +with all databases and profile settings should be created within the user +profile folder (described by environment variable \fIHOME\fP for Linux or +\fIUSERPROFILE\fP for Windows 2000/XP). .TP .B \fBCONCEPTS\fP -Supports a python\-based plugin system, allowing import and export writ‐ -ers, report generators, tools, and display filters to be added without +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. .sp In addition to generating direct printer output, report generators also -target other systems, such as \fILibreOffice.org\fP , \fIAbiWord\fP , \fIHTML\fP, -or \fILaTeX\fP to allow the users to modify the format to suit their needs. +target other output formats, such as \fILibreOffice\fP, \fIAbiWord\fP, \fIHTML\fP, or +\fILaTeX\fP to allow the users to modify the format to suit their needs. .UNINDENT -.sp -\fBKNOWN BUGS AND LIMITATIONS\fP -.sp -\fBFILES\fP +.SH FILES .INDENT 0.0 .INDENT 3.5 \fI${PREFIX}/bin/gramps\fP @@ -308,11 +360,10 @@ or \fILaTeX\fP to allow the users to modify the format to suit their needs. \fI${HOME}/.gramps\fP .UNINDENT .UNINDENT -.INDENT 0.0 -.TP -.B \fBAUTHORS\fP +.SH AUTHORS +.sp Donald Allingham <\fI\%don@gramps\-project.org\fP> -\fI\%http://gramps\-project.org/\fP +\fI\%https://www.gramps\-project.org/\fP .sp This man page was originally written by: Brandon L. Griffith <\fI\%brandon@debian.org\fP> @@ -320,16 +371,13 @@ for inclusion in the Debian GNU/Linux system. .sp This man page is currently maintained by: Gramps project <\fI\%xxx@gramps\-project.org\fP> -.TP -.B \fBDOCUMENTATION\fP -The user documentation is available through standard web browser -in the form of Gramps Manual. +.SH DOCUMENTATION +.sp +The user documentation is available through a web browser in the form of the +Gramps Manual. .sp The developer documentation can be found on the -\fI\%http://www.gramps\-project.org/wiki/index.php?title=Portal:Developers\fP +\fI\%https://www.gramps\-project.org/wiki/index.php/Portal:Developers\fP portal. -.UNINDENT -.sp -gramps(1) @VERSION@ gramps(1) .\" Generated by docutils manpage writer. .