1gramps(1) 3.2.6 gramps(1)
2
6 gramps - Genealogical Research and Analysis Management Programming Sys‐
7 tem.
8
11 gramps [-?|--help] [--usage] [--version] [-l] [-u|--force-unlock]
12 [-O|--open= DATABASE [-f|--format= FORMAT]] [-i|--import= FILE
13 [-f|--format= FORMAT]] [-i|--import= ...] [-e|--export= FILE
14 [-f|--format= FORMAT]] [-a|--action= ACTION] [-p|--options= OPTION‐
15 STRING]] [ FILE ] [--version]
16
19 Gramps is a Free/OpenSource genealogy program. It is written in Python,
20 using the GTK+/GNOME interface. Gramps should seem familiar to anyone
21 who has used other genealogy programs before such as Family Tree Maker
22 (TM), Personal Ancestral Files (TM), or the GNU Geneweb. It supports
23 importing of the ever popular GEDCOM format which is used world wide by
24 almost all other genealogy software.
25
28 gramps FILE
29 When FILE is given (without any flags) as a family tree name or
30 as a family tree database directory, then it is opened and an
31 interactive session is started. If FILE is a file format under‐
32 stood by Gramps, an empty family tree is created whose name is
33 based on the FILE name and the data is imported into it. The
34 rest of the options is ignored. This way of launching is suit‐
35 able for using gramps as a handler for genealogical data in e.g.
36 web browsers. This invocation can accept any data format native
37 to gramps, see below.
38 -f,--format= FORMAT
41 Explicitly specify format of FILE given by preceding -i, or -e
42 option. If the -f option is not given for any FILE, the format
43 of that file is guessed according to its extension or MIME-type.
44 Formats available for export are gramps-xml (guessed if FILE
46 ends with .gramps), gedcom (guessed if FILE ends with .ged), or
47 any file export available through the Gramps plugin system.
48 Formats available for import are grdb, gramps-xml, gedcom,
50 gramps-pkg (guessed if FILE ends with .gpkg), and geneweb
51 (guessed if FILE ends with .gw).
52 Formats available for export are gramps-xml, gedcom, gramps-pkg,
54 wft (guessed if FILE ends with .wft), geneweb, and iso (never
55 guessed, always specify with -f option).
56 -l Print a list of known family trees.
59 -u,--force-unlock
62 Unlock a locked database.
63 -O,--open= DATABASE
66 Open DATABASE which must be an existing database directory or
67 existing family tree name. If no action, import or export
68 options are given on the command line then an interactive ses‐
69 sion is started using that database.
70 -i,--import= FILE
73 Import data from FILE. If you haven't specified a database then
74 a temporary database is used; this is deleted when you exit
75 gramps.
76 When more than one input file is given, each has to be preceded
78 by -i flag. The files are imported in the specified order, i.e.
79 -i FILE1 -i FILE2 and -i FILE2 -i FILE1 might produce different
80 gramps IDs in the resulting database.
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), report (generates
88 report), and tool (runs a plugin tool). Both report and tool
89 need the OPTIONSTRING supplied by the -p flag).
90 The OPTIONSTRING should satisfy the following conditions:
92 It must not contain any spaces. If some arguments need to
93 include spaces, the string should be enclosed with quotation
94 marks, i.e., follow the shell syntax. Option string is a list
95 of pairs with name and value (separated by the equality sign).
96 The name and value pairs must be separated by commas.
97 Most of the report or tools options are specific for each report
99 or tool. However, there are some common options.
100 name=name
102 This mandatory option determines which report or tool will be
103 run. If the supplied name does not correspond to any available
104 report or tool, an error message will be printed followed by the
105 list of available reports or tools (depending on the ACTION).
106 show=all
108 This will produce the list of names for all options available
109 for a given report or tool.
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 -d,--debug= LOGGER_NAME
125 Enables debug logs for development and testing. Look at the
126 source code for details
127 --version
129 Prints the version number of gramps and then exits
130
135 If the first argument on the command line does not start with dash
136 (i.e. no flag), gramps will attempt to open the file with the name
137 given by the first argument and start interactive session, ignoring the
138 rest of the command line arguments.
139 If the -O flag is given, then gramps will try opening the supplied
142 database and then work with that data, as instructed by the further
143 command line parameters.
144 With or without the -O flag, there could be multiple imports, exports,
147 and actions specified further on the command line by using -i, -e, and
148 -a flags.
149 The order of -i, -e, or -a options does not matter. The actual order
152 always is: all imports (if any) -> all actions (if any) -> all exports
153 (if any). But opening must always be first!
154 If no -O or -i option is given, gramps will launch its main window and
157 start the usual interactive session with the empty database, since
158 there is no data to process, anyway.
159 If no -e or -a options are given, gramps will launch its main window
162 and start the usual interactive session with the database resulted from
163 all imports. This database resides in the import_db.grdb under
164 ~/.gramps/import directory.
165 The error encountered during import, export, or action, will be either
168 dumped to stdout (if these are exceptions handled by gramps) or to
169 stderr (if these are not handled). Use usual shell redirections of std‐
170 out and stderr to save messages and errors in files.
171
174 To open an existing family tree and import an xml file into it, one
175 may type:
176 gramps -O 'My Family Tree' -i ~/db3.gramps
177 The above changes the opened family tree, to do the same, but import
179 both in a temporary family tree and start an interactive session, one
180 may type:
181 gramps -i 'My Family Tree' -i ~/db3.gramps
182 To import four databases (whose formats can be determined from their
184 names) and then check the resulting database for errors, one may type:
185 gramps -i file1.ged -i file2.tgz -i ~/db3.gramps -i file4.wft -a
186 check
187 To explicitly specify the formats in the above example, append file‐
189 names with appropriate -f options:
190 gramps -i file1.ged -f gedcom -i file2.tgz -f gramps-pkg -i
191 ~/db3.gramps -f gramps-xml -i file4.wft -f wft -a check
192 To record the database resulting from all imports, supply -e flag (use
194 -f if the filename does not allow gramps to guess the format):
195 gramps -i file1.ged -i file2.tgz -e ~/new-package -f gramps-pkg
196 To import three databases and start interactive gramps session with the
198 result:
199 gramps -i file1.ged -i file2.tgz -i ~/db3.gramps
200 To run the Verify tool from the commandline and output the result to
202 stdout:
203 gramps -O 'My Family Tree' -a tool -p name=verify
204 Finally, to start normal interactive session type:
206 gramps
207
210 The program checks whether these environment variables are set:
211 LANG - describe, which language to use: Ex.: for polish language this
213 variable has to be set to pl_PL.UTF-8.
214 GRAMPSHOME - if set, force Gramps to use the specified directory to
216 keep program settings and databases there. By default, this variable is
217 not set and gramps assumes that the folder with all databases and pro‐
218 file settings should be created within the user profile folder
219 (described by environment variable HOME for Linux or USERPROFILE for
220 Windows 2000/XP).
221
224 Supports a python-based plugin system, allowing import and export writ‐
225 ers, report generators, tools, and display filters to be added without
226 modification of the main program.
227 In addition to generating direct printer output, report generators also
229 target other systems, such as OpenOffice.org, AbiWord, HTML, or LaTeX
230 to allow the users to modify the format to suit their needs.
231
235 ${PREFIX}/bin/gramps
236 ${PREFIX}/share/gramps
237 ${HOME}/.gramps
238
241 Donald Allingham <don@gramps-project.org>
242 http://gramps.sourceforge.net
243 This man page was originally written by:
245 Brandon L. Griffith <brandon@debian.org>
246 for inclusion in the Debian GNU/Linux system.
247 This man page is currently maintained by:
249 Gramps project <xxx@gramps-project.org>
250
253 The user documentation is available through standard GNOME Help browser
254 in the form of Gramps Manual. The manual is also available in XML for‐
255 mat as gramps-manual.xml under doc/gramps-manual/$LANG in the official
256 source distribution.
257 The developer documentation can be found on the http://develop‐
259 ers.gramps-project.org site.
260January 2008 3.2.6 gramps(1)