Jump to: navigation, search

Gramps 5.1 Wiki Manual - Command Line

2,532 bytes added, 01:22, 7 July 2019
email update for safe mode from prculley I've updated it for the new Safe Mode and Defaults CLI options. / Thank you
-q, --quiet Suppress progress indication output (non-GUI mode only)
-v, --version Show versions
-S, --safe Start Gramps in 'Safe mode'
(temporarily use default settings)
-D, --default=[APXFE] Reset settings to default;
A - addons are cleared
P - Preferences to default
X - Books are cleared, reports and tool settings to default
F - filters are cleared
E - Everything is set to default or cleared
python : 3.5.2
gramps : 5.10.0
gtk++ : 3.18.9
pygobject : 3.20.0
gramps -O "Family Tree 1" -a report -p "name=family_group,style=default,off=html,of=test.html,css="
{{man tip| Report option string |The report option string should satisfy the following conditions:<br />* It must not contain any spaces (due to the general nature of the command line interface). If some arguments need to include spaces, the string should be enclosed with quotation marks.<br />* Option string must list pairs of option names and values. Within a pair, option name and value must be separated by the equal sign.<br />* Different pairs must be separated by commas.}}
Most of the report options are specific for every report. However, there are some common options.
==== book action option ====
{{man note|New feature|Added in Gramps 5.10}}
You can run books from the command line using the 'book' action.
To see which ones, say:
3.2) Set more than one value: <code>--config=behavior.use-tips:False --config=behavior.autoload:True</code> or <code>-c behavior.use-tips:False -c behavior.autoload:True</code>
<br>For example:
=== Safe mode ===
<code>gramps -S</code> or <code>gramps --safe</code>
This CLI command starts Gramps as if it had never been installed before. In this mode, any previous family trees can still be loaded, as long as they were stored in the default folder. All other settings, filters, books, addons etc. are either cleared or returned to their default values. Other CLI commands can be used, or, if none, Gramps will start the GUI. Nothing except the actual family tree data is saved.
Note that this is typically used to see if Gramps behaves better when it is running as if with a totally 'clean' install. It is NOT permanent (if you want that see [[#Defaults|Defaults]] below), if you start Gramps normally after using this command all of your previous settings etc. are still there.
This actually works by setting the folder that Gramps uses to store its user data (except for family trees) to a temporary directory, which is deleted when Gramps closes.
=== Defaults ===
<code>gramps -D E</code> or <code>gramps --default=E</code>
This CLI command causes Gramps to clear out or return to defaults the desired settings.
The family tree databases are NOT cleared out or removed.
The sub-commands (replace the 'E' from the example command line above with one or more of
the subcommand characters) are:
*<code>A</code> Addons are cleared. Any installed addons are removed, along with their settings.
*<code>F</code> Filters are cleared. Any custom filters are removed.
*<code>P</code> Preferences are returned to their default values.
*<code>X</code> Books are cleared, Reports and Tools settings are returned to their default values.
*<code>Z</code> Old '.zip' files from family tree version upgrades are deleted.
*<code>E</code> Everything except the actual family tree data is returned to default settings. This does all of the above as well as a few more items; deletes thumbnails, maps, and the user CSS (used in web reports).
For example:
gramps -D AP
will cause Gramps to remove all the Addons and to reset Preferences to their default values.
== Operation ==

Navigation menu