1ENGLISH()                                                            ENGLISH()
2
3
4

NAME

6       English -
7
8       gramps(1)                5.1.1               gramps(1)
9
10       NAME   gramps  - Genealogical Research and Analysis Management Program‐
11              ming Sys‐ tem.
12
13       SYNOPSIS
14              gramps [-? | --help]  [--usage]  [--version]  [-l]  [-L]  [-u  |
15              --force-unlock]  [-O  | --open= DATABASE [-f | --format= FORMAT]
16              [-i | --import= FILE [-f | --format=  FORMAT]]  [--remove=  FAM‐
17              ILY_TREE_PATTERN]  [-e | --export= FILE [-f | --format= FORMAT]]
18              [-a | --action= ACTION] [-p | --options= OPTION‐ STRING]] [FILE]
19              [--version]
20
21       DESCRIPTION
22              Gramps  is a Free/OpenSource genealogy program. It is written in
23              Python, using  the GTK+/GNOME  interface.   Gramps  should  seem
24              familiar  to anyone who has used other genealogy programs before
25              such as Family Tree   Maker  (TM),    Personal  Ancestral  Files
26              (TM),  or  the  GNU  Geneweb.  It supports importing of the ever
27              popular GEDCOM format which is used world  wide  by  almost  all
28              other genealogy software.
29
30       OPTIONS
31
32              gramps FILE
33                     When  FILE  is given (without any flags) as a family tree
34                     name or as a family tree database directory, then  it  is
35                     opened and an interactive  session is started. If FILE is
36                     a file format under‐ stood by  Gramps,  an  empty  family
37                     tree  is  created  whose name is based  on  the FILE name
38                     and the data is imported into it. The rest of the options
39                     is ignored. This way of launching is suit‐ able for using
40                     gramps as a handler for genealogical data  in  e.g.   web
41                     browsers.  This  invocation  can  accept  any data format
42                     native to gramps, see below.
43
44              -f , --format= FORMAT
45                     Explicitly specify format of FILE given by preceding -i ,
46                     or  -e option. If the -f option is not given for any FILE
47                     , the format of that file is  guessed  according  to  its
48                     extension or MIME-type.
49
50                     Formats   available for export are gramps-xml (guessed if
51                     FILE ends with .gramps ), gedcom (guessed  if  FILE  ends
52                     with  .ged  ),  or  any file export available through the
53                     Gramps plugin system.
54
55                     Formats available for import are gramps-xml  ,  gedcom  ,
56                     gramps-pkg  (guessed  if  FILE  ends  with  .gpkg  ), and
57                     geneweb (guessed if FILE ends with .gw ).
58
59                     Formats available for export are gramps-xml  ,  gedcom  ,
60                     gramps-pkg  ,  wft  (guessed  if  FILE  ends with .wft ),
61                     geneweb.
62
63              -l     Print a list of known family trees.
64
65              -L     Print a detailed list of known family trees.
66
67              -u , --force-unlock
68                     Unlock a locked database.
69
70              -O , --open= DATABASE
71                     Open DATABASE which  must be an existing database  direc‐
72                     tory  or  existing family tree name. If no action, import
73                     or export options are given on the command line  then  an
74                     interactive ses‐ sion is started using that database.
75
76              -i , --import= FILE
77                     Import  data from FILE . If you haven't specified a data‐
78                     base, then an empty database is created  for  you  called
79                     Family Tree x (where x is an incrementing number).
80
81                     When  more  than  one input file is given, each has to be
82                     preceded by -i flag. The files are imported in the speci‐
83                     fied order, i.e.  -i FILE1 -i FILE2 and -i FILE2 -i FILE1
84                     might produce different gramps IDs in the resulting data‐
85                     base.
86
87              -e , --export= FILE
88                     Export  data  into FILE . For gramps-xml , gedcom , wft ,
89                     gramps-pkg , and geneweb , the FILE is the  name  of  the
90                     resulting file.
91
92                     When  more  than one output file is given, each has to be
93                     preceded by -e flag. The files are written one by one, in
94                     the specified order.
95
96              -a , --action= ACTION
97                     Perform  ACTION  on the imported data. This is done after
98                     all imports are successfully completed. Currently  avail‐
99                     able   actions are summary (same  as  Reports->View->Sum‐
100                     mary), check (same as  Tools->Database  Processing->Check
101                     and Repair), report (generates report),  and  tool  (runs
102                     a plugin tool).  Both report and tool  need  the  OPTION‐
103                     STRING supplied by the -p flag).
104
105                     The OPTIONSTRING should satisfy the following conditions:
106                     It must not contain any  spaces. If some  arguments  need
107                     to  include  spaces,  the  string should be enclosed with
108                     quotation marks, i.e., follow the  shell  syntax.  Option
109                     string  is  a  list of  pairs  with name and value (sepa‐
110                     rated by the equality sign).  The name  and  value  pairs
111                     must be separated by commas.
112
113                     Most of the report or tools options are specific for each
114                     report or tool. However, there are some common options.
115
116                     name=name This mandatory option determines  which  report
117                     or tool will be run. If the supplied name does not corre‐
118                     spond to any  available report or tool, an error  message
119                     will be printed followed by the list of available reports
120                     or tools (depending on the ACTION ).
121
122                     show=all This will produce the  list  of  names  for  all
123                     options available for a given report or tool.
124
125                     show=optionname  This  will  print the description of the
126                     functionality supplied by optionname, as well as what are
127                     the acceptable types and  values for this option.
128
129                     Use  the  above  options  to  find out everything about a
130                     given report.
131
132              When more than one output action is given, each has to  be  pre‐
133              ceded   by -a flag. The actions are performed one by one, in the
134              specified order.
135
136              -d , --debug= LOGGER_NAME
137                     Enables debug logs for development and testing.  Look  at
138                     the source code for details
139
140              --version
141                     Prints the version number of gramps and then exits
142
143       Operation
144              If  the  first  argument on the command line does not start with
145              dash (i.e. no flag), gramps will attempt to open the  file  with
146              the  name given by the first argument and start interactive ses‐
147              sion, ignoring the rest of the command line arguments.
148
149              If the  -O flag is given, then gramps will try opening the  sup‐
150              plied  database  and  then work with that data, as instructed by
151              the further command line parameters.
152
153              With or without the -O flag, there could  be  multiple  imports,
154              exports,  and  actions  specified further on the command line by
155              using -i , -e , and -a flags.
156
157              The order of -i , -e , or -a options does not matter. The actual
158              order always is: all imports (if any) -> all actions (if any) ->
159              all  exports (if any). But opening must always be first!
160
161              If no -O or -i option is given, gramps will launch its main win‐
162              dow and start the usual interactive session with the empty data‐
163              base, since there is no data to process, anyway.
164
165              If no -e  or -a options are given, gramps will launch  its  main
166              window and start the usual interactive session with the database
167              resulted  from  all  imports.  This  database  resides  in   the
168              import_db.grdb under ~/.gramps/import directory.
169
170              The  error encountered during import, export, or action, will be
171              either dumped to stdout (if  these  are  exceptions  handled  by
172              gramps) or to stderr (if these are not handled). Use usual shell
173              redirections of stdout and stderr to save messages and errors in
174              files.
175
176       EXAMPLES
177              To  open an existing family tree and import an xml file into it,
178              one may type:
179                 gramps -O 'My Family Tree' -i ~/db3.gramps
180
181              The above changes the opened family tree, to do the   same,  but
182              import  both in a temporary family tree and start an interactive
183              session, one may type:
184                 gramps -i 'My Family Tree' -i ~/db3.gramps
185
186              To import four databases (whose formats can be  determined  from
187              their  names)  and then check the resulting database for errors,
188              one may type:
189                 gramps -i file1.ged -i file2.tgz -i ~/db3.gramps -i file4.wft
190                 -a check
191
192              To explicitly specify the formats in the above  example,  append
193              file‐ names with appropriate -f options:
194                 gramps -i file1.ged -f gedcom -i file2.tgz -f  gramps-pkg  -i
195                 ~/db3.gramps -f gramps-xml -i file4.wft -f wft -a check
196
197              To  record  the  database  resulting from all imports, supply -e
198              flag  (use -f if the filename does not allow gramps to guess the
199              format):
200                 gramps   -i   file1.ged  -i  file2.tgz  -e  ~/new-package  -f
201                 gramps-pkg
202
203              To import three databases and start interactive  gramps  session
204              with the result:
205                 gramps -i file1.ged -i file2.tgz -i ~/db3.gramps
206
207              To  run  the  Verify  tool  from  the commandline and output the
208              result to stdout:
209                 gramps -O 'My Family Tree' -a tool -p name= verify
210
211              Finally, to start normal interactive session type:
212                 gramps
213
214       ENVIRONMENT VARIABLES
215              The program checks whether these environment variables are set:
216
217              LANG  -  describe, which language to use: Ex.: for  polish  lan‐
218              guage this variable has to be set to pl_PL.UTF-8.
219
220              GRAMPSHOME - if set, force Gramps to use  the  specified  direc‐
221              tory  to keep program settings and databases there. By  default,
222              this variable is not set and gramps assumes that the folder with
223              all databases and  pro‐  file   settings   should   be   created
224              within   the   user   profile   folder (described by environment
225              variable HOME for Linux  or  USERPROFILE  for Windows 2000/XP).
226
227       CONCEPTS
228              Supports a  python-based  plugin  system,  allowing  import  and
229              export  writ‐ ers, report generators, tools, and display filters
230              to be added  without modification of the main program.
231
232              In addition to generating direct printer output, report  genera‐
233              tors  also  target other systems, such as LibreOffice.org , Abi‐
234              Word , HTML, or LaTeX to allow the users to modify the format to
235              suit their needs.
236
237       KNOWN BUGS AND LIMITATIONS
238
239       FILES
240          ${PREFIX}/bin/gramps
241
242          ${PREFIX}/lib/python3/dist-packages/gramps/
243
244          ${PREFIX}/share/
245
246          ${HOME}/.gramps
247
248       AUTHORS
249              Donald             Allingham            <don@gramps-project.org>
250              http://gramps-project.org/
251
252              This man page was originally written by: Brandon L. Griffith  <‐
253              brandon@debian.org>  for  inclusion in the Debian GNU/Linux sys‐
254              tem.
255
256              This man page is currently  maintained  by:  Gramps  project  <‐
257              xxx@gramps-project.org>
258
259       DOCUMENTATION
260              The user documentation is available through standard web browser
261              in the form of Gramps Manual.
262
263              The   developer   documentation   can   be    found    on    the
264              http://www.gramps-project.org/wiki/index.php?title=Portal:Developers
265              portal.
266
267       gramps(1)                 5.1.1               gramps(1)
268
269
270
271
272                                                                     ENGLISH()
Impressum