1gramps(1) 2.2.6 gramps(1)
2
6 gramps - Genealogical Research and Analysis Management Programming Sys‐
7 tem.
8
11 gramps [-?|--help] [--usage] [--version] [-O|--open= FILE [-f|--format=
12 FORMAT]] [-i|--import= FILE [-f|--format= FORMAT]] [-i|--import= ...]
13 [-o|--output= FILE [-f|--format= FORMAT]] [-a|--action= ACTION]
14 [-p|--options= OPTIONSTRING]] [ FILE ]
15
18 Gramps is a Free/OpenSource genealogy program. It is written in Python,
19 using the GTK+/GNOME interface. Gramps should seem familiar to anyone
20 who has used other genealogy programs before such as Family Tree Maker
21 (TM), Personal Ancestral Files (TM), or the GNU Geneweb. It supports
22 importing of the ever popular GEDCOM format which is used world wide by
23 almost all other genealogy software.
24
27 gramps FILE
28 When FILE is given (without any flags) then it is opened and an
29 interactive session is started. The rest of the options is
30 ignored. This way of launching is suitable for using gramps as a
31 handler for genealogical data in e.g. web browsers. This invoca‐
32 tion can accept any data format native to gramps, see below.
33 -f,--format= FORMAT
36 Explicitly specify format of FILE given by preceding -O, -i, or
37 -o option. If the -f option is not given for any FILE, the for‐
38 mat of that file is guessed according to its extension.
39 Formats available for opening are grdb (guessed if FILE ends
41 with .grdb), gramps-xml (guessed if FILE ends with .gramps), and
42 gedcom (guessed if FILE ends with .ged).
43 Formats available for import are grdb, gramps-xml, gedcom,
45 gramps-pkg (guessed if FILE ends with .gpkg), and geneweb
46 (guessed if FILE ends with .gw).
47 Formats available for export are grdb, gramps-xml, gedcom,
49 gramps-pkg, wft (guessed if FILE ends with .wft), geneweb, and
50 iso (never guessed, always specify with -f option).
51 -O,--open= FILE
54 Open FILE. Only grdb, gramps-xml, and gedcom formats can be
55 opened directly. For other formats, you will need to use the
56 import option which will set up the empty database and then
57 import data into it.
58 Only a single file can be opened. If you need to combine data
60 from several sources, you will need to use the import option.
61 -i,--import= FILE
64 Import data from FILE.
65 When more than one input file is given, each has to be preceded
67 by -i flag. The files are imported in the specified order, i.e.
68 -i FILE1 -i FILE2 and -i FILE2 -i FILE1 might produce different
69 gramps IDs in the resulting database.
70 -o,--output= FILE
73 Export data into FILE. For iso format, the FILE is actually the
74 name of directory the gramps database will be written into. For
75 grdb, gramps-xml, gedcom, wft, gramps-pkg, and geneweb, the FILE
76 is the name of the resulting file.
77 When more than one output file is given, each has to be preceded
79 by -o flag. The files are written one by one, in the specified
80 order.
81 -a,--action= ACTION
84 Perform ACTION on the imported data. This is done after all
85 imports are successfully completed. Currently available actions
86 are summary (same as Reports->View->Summary), check (same as
87 Tools->Database Processing->Check and Repair), and report (gen‐
88 erates report, needs the OPTIONSTRING supplied by the -p flag).
89 The report option string should satisfy the following condi‐
91 tions:
92 It must not contain any spaces. If some arguments need to
93 include spaces, the string should be enclosed with quotation
94 marks. Option string must list pairs of option names and val‐
95 ues. Withing a pair, option name and value must be separated by
96 the equality sign. Different pairs must be separated by commas.
97 Most of the report options are specific for every report. How‐
99 ever, there some common options.
100 name=reportname
102 This mandatory option determines which report will be generated.
103 If the supplied report_name does not correspond to any available
104 report, the error message will be printed followed by the list
105 of available reports.
106 show=all
108 This will produce the list of names for all options available
109 for a given report.
110 show=optionname
112 This will print the description of the functionality supplied by
113 optionname, as well as what are the acceptable types and values
114 for this option.
115 Use the above options to find out everything about a given
117 report.
118 When more than one output action is given, each has to be preceded by
121 -a flag. The actions are performed one by one, in the specified order.
122 Operation
124 If the first argument on the command line does not start with dash
125 (i.e. no flag), gramps will attempt to open the file with the name
126 given by the first argument and start interactive session, ignoring the
127 rest of the command line arguments.
128 If the -O flag is given, then gramps will try opening the supplied file
131 name and then work with that data, as instructed by the further command
132 line parameters.
133 With or without the -O flag, there could be multiple imports, exports,
136 and actions specified further on the command line by using -i, -o, and
137 -a flags.
138 The order of -i, -o, or -a options does not matter. The actual order
141 always is: all imports (if any) -> all actions (if any) -> all exports
142 (if any). But opening must always be first!
143 If no -O or -i option is given, gramps will launch its main window and
146 start the usual interactive session with the empty database, since
147 there is no data to process, anyway.
148 If no -o or -a options are given, gramps will launch its main window
151 and start the usual interactive session with the database resulted from
152 all imports. This database resides in the import_db.grdb under
153 ~/.gramps/import directory.
154 The error encountered during import, export, or action, will be either
157 dumped to stdout (if these are exceptions handled by gramps) or or to
158 stderr (if these are not handled). Use usual shell redirections of std‐
159 out and stderr to save messages and errors in files.
160
163 To import four databases (whose formats can be determined from their
164 names) and then check the resulting database for errors, one may type:
165 gramps -i file1.ged -i file2.tgz -i ~/db3.gramps -i file4.wft -a
166 check
167 To explicitly specify the formats in the above example, append file‐
169 names with appropriate -f options:
170 gramps -i file1.ged -f gedcom -i file2.tgz -f gramps-pkg -i
171 ~/db3.gramps -f gramps-xml -i file4.wft -f wft -a check
172 To record the database resulting from all imports, supply -o flag (use
174 -f if the filename does not allow gramps to guess the format):
175 gramps -i file1.ged -i file2.tgz -o ~/new-package -f gramps-pkg
176 To import three databases and start interactive gramps session with the
178 result:
179 gramps -i file1.ged -i file2.tgz -i ~/db3.gramps
180 Finally, to start normal interactive session type:
182 gramps
183
186 Supports a python-based plugin system, allowing import and export writ‐
187 ers, report generators, tools, and display filters to be added without
188 modification of the main program.
189 In addition to generating direct printer output, report generators also
191 target other systems, such as OpenOffice.org, AbiWord, HTML, or LaTeX
192 to allow the users to modify the format to suit their needs.
193
197 ${PREFIX}/bin/gramps
198 ${PREFIX}/share/gramps
199 ${HOME}/.gramps
200
203 Donald Allingham <don@gramps-project.org>
204 http://gramps.sourceforge.net
205 This man page was originally written by:
207 Brandon L. Griffith <brandon@debian.org>
208 for inclusion in the Debian GNU/Linux system.
209 This man page is currently maintained by:
211 Alex Roitman <shura@gramps-project.org>
212
215 The user documentation is available through standard GNOME Help browser
216 in the form of Gramps Manual. The manual is also available in XML for‐
217 mat as gramps-manual.xml under doc/gramps-manual/$LANG in the official
218 source distribution.
219 The developer documentation can be found on the http://develop‐
221 ers.gramps-project.org site.
222August 2005 2.2.6 gramps(1)