Jump to: navigation, search

Gramps 5.1 Wiki Manual - Command Line

996 bytes added, 15:49, 18 January 2022
Locating path to gramps executable on Windows
=== MS Windows ===
{{stub}}{{man warnMS Windows is a [[Download|Outdated community supported]] platform. If you install the [[All_In_One_Gramps_Software_Bundle_for_Windows|Windows AIO bundle]], then this will place an icon on the desktop as well as a menu item in the 'Start' menu. However, the Gramps installation directory is not added to the system path and to run gramps via CLI, we need to add info for new AIO installer CLI usage|See example usage https://githubknow the path to that directory. There are several ways to find the path, including by examining the program's shortcut in the start menu, taskbar or the start menu, or by locating the running executable's path in Task Manager. In most cases the path will be the default as described}}
MS Windows is a [[Download|community supported]] platformAs an example, using GrampsAOI-{{template:Version windows AIO64}}_win64. If you install exe installer and accepting the standard destination folder during installation, <code>C:\Program&nbsp;Files\GrampsAOI64-{{template:Version windows AIO64}}</code> would be the location for the [[All_In_One_Gramps_Software_Bundle_for_Windows|Windows AIO]] GrampsAIO32 or GrampsAIO64 Gramps executable. While not common, then this will place an icon if you installed the 32-bit version of Gramps on a 64-bit OS, the desktop as well as path would be <code>C:\Program&nbsp;Files&nbsp;(x86)\GrampsAIO32-{{template:Version windows AIO32}}</code>. Finally, if you chose to install Gramps in a menu iten in non-standard directory, use that folder path instead instead. Use Windows File Explorer to confirm that the 'Start' menupath is correct before continuing on.
What is To find the best way of knowing what command to type? Starting Gramps from the command line (cmd.exe) depends on where you have chosen to install Gramps.path using a shortcut icon,
* Right-click on the <code>GrampsAIO64&nbsp;{{template:Version windows AIO64}}-console</code> application, or the corresponding item in the Start menu.
* Note down the file location (its "Start in' directory).
* Select the whole of the command full path and copy ({{man key press|Ctrl|c}}) it. To run Gramps from the command line, you'll need to start a console window:
* From the Start menu, start cmd.exe.
* Change directory to the starting installation directory you noted downlocated.* Right-click and select PasteType in or paste the path, surrounding it in quotes if there are spaces.
* Press {{man key press|Enter}}.
For example, this might be:
cd "C:\Program &nbsp;Files\GrampsAIO64GrampsAOI64-{{template:Version windows AIO64}}"
When You may use any of the instructions below tell you command-line options along with this. For example, to type something after get a detailed listing of all of the start commandFamily Tree databases in your default Family Tree folder, you just type this after the last line, for example:would append <code>-L</code> cd "C:\Program &nbsp;Files\GrampsAIO64GrampsAOI64-{{template:Version windows AIO64}}"
gramps -L
There are other ways to install Gramps for MS Windows, but these are much more complicated and are not covered hereSee example usage
=== MacOS ===
gramps -O 'Family Tree 1' -e output.gramps -f gramps-xml
10. To generate a web site into an other locale (in germanGerman):
LANGUAGE=de_DE; LANG=de_DE.UTF-8 gramps -O 'Family Tree 1' -a report -p name=navwebpage,target=/../de
* '''csv''' - Comma Separated Value: This format is available for import and export. Be careful however, import must be as values created by the export function. Only a part of your data is contained in the output.
* '''vcf''' - VCard format: import and export
* '''vcs''' - VCalandar VCalendar format: export
* '''def''' - old Pro-Gen format: import
* '''wft''' - Web Family Tree: This format is available for export only. When not specified, it can be guessed if the filename ends with .wft
You can open a family tree, or you can ''open'' a file by importing it in an empty family tree.
To let Gramps handle this automatically, just supply the familytree family tree or filename you want to open:
python 'My Fam Tree'
:<code>gramps -O 'Family Tree 1' -e output.gramps -f gramps-xml</code>
* To generate a web site into an other locale (in germanGerman):
:<code>LANGUAGE=de_DE; LANG=de_DE.UTF-8 gramps -O 'Family Tree 1' -a report -p name=navwebpage,target=/../de </code>
* The environment variable GRAMPS_RESOURCES is the path to Gramps builtin built-in resources files. You should only change this if you are using Gramps from source code or a custom environment. An indicator that you need to set this variable is if you receive one of the following errors:
** ''Encoding error while parsing resource path''
** ''Failed to open resource file''

Navigation menu