De:Gramps 3.3 Wiki Handbuch - Kommandozeilen Referenz

From Gramps
Jump to: navigation, search

Dieser Anhang liefert eine Referenz über die Möglichkeiten Gramps aus dem Terminal starten.

Gnome-important.png Spezielle Copyright Notiz: Alle Änderungen auf dieser Seite müssen unter zwei copyright Lizenzen stehen:

Diese Lizenzen ermöglichen es dem Gramps-Projekt die bestmögliche Verwendung dieses Handbuchs als freien Inhalt in zukünftigen Gramps Versionen. Wenn du mit dieser dual Lizenzierung nicht einverstanden bist, bearbeite diese Seite nicht. Du darfst zu anderen Seiten des Wiki die nur unter die GFDL Lizenz fallen nur über externe Links (verwende die Syntax: [http://www.gramps-project.org/...]), nicht über interne Links verlinken.<br\> Außerdem verwende nur die Bekannten Drucktechnische Konventionen

Zurück Index Nächste


Verfügbare Optionen

Dieser Abschnitt bietet eine Liste aller in Gramps verfügbaren Befehlszeilen Parameter. Wenn du mehr wissen willst als nur eine Liste von Parametern, schaue in die nächsten Abschnitte: Operation und Beispiele. Eine Liste ist auch auf dieser Seite verfügbar (in englisch).

Listenoptionen

-l, gibt eine Liste bekannter Stammbäume aus -L, gibt eine detaillierte Liste bekannter Stammbäume aus


Versionsoptionen

-v oder --version zeigt die Version von Gramps und Abhängigkeiten, Informationen über Umgebungseinstellungen, Python und Systempfade

Formatoptionen

Das Format jeder Datei, die geöffnet, importiert oder exportiert werden soll, kann mit der
-f format
Option festgelegt werden. Die zulässigen format Werte sind unten aufgelistet.

Volle Stammbaum Unterstützung

Diese Formate enthalten deine gesamten Daten die in einem Stammbaum enthalten sind.

  • gramps - Gramps XML Format: Dieses Format ist für Öffnen, den Import und den Export verfügbar. Falls nicht angegeben wird es gesetzt, wenn der Dateiname mit .gramps endet.
  • gpkg - Gramps Paket XML Format: Dieses Format ist für den Import und Export verfügbar. Falls nicht angegeben wird es gesetzt, wenn der Dateiname mit .gpkg endet.
  • grdb - vor Gramps 3.x Datenbank: Dieses Format ist für den Import zur Unterstützung älterer Dateiformate von Gramps verfügbar. Alles in der grdb Datei wird importiert. Falls nicht angegeben wird es angenommen wenn die Dateiendung .grdb lautet.
  • burn - GNOME ISO brennen: Export, nur unter GNOME verfügbar wenn das Brennprotokoll existiert.

Eingeschränkte Stammbaum Unterstützung

Diese Formate enthalten die meisten aber nicht alle Daten, die mit Gramps erstellt werden können

  • ged - GEDCOM Format: Dieses Format ist für den Import und den Export verfügbar. Falls nicht angegeben wird es gesetzt, wenn der Dateiname mit .ged endet.
  • gw - GeneWeb Datei: Dieses Format ist für den Import und Export verfügbar. Falls nicht angegeben wird es gesetzt, wenn der Dateiname mit .gw endet.

Teilmenge deiner Daten

Diese Formate enthalten einen bestimmten Teilbereich deiner Daten

  • csv - Komma getrennte Werte: Dieses Format ist für Import und Export verfügbar. Be careful however, import must be as values created by the export function. Nur ein Teil deiner Daten ist in dieser Ausgabe enthalten.
  • vcf - VCard Format: Import und Export
  • vcs - VCalandar Format: Export
  • def - altes Pro-Gen Format: Import
  • wft - Web Family Tree: Dieses Format ist nur für den Export verfügbar. Falls nichts angegeben wird es gesetzt, wenn der Dateiname mit .wft endet.

Öffnen Optionen

You can open a family tree, or you can open a file by importing it in an empty family tree.

Damit Gramps dies automatisch erledigt, übergebe einfach den Stammbaum oder die Datei, die du öffnen möchtest:

python gramps.py 'Mein Stammbaum'
python gramps.py Mustermann.ged

Das erste öffnet einen Stammbaum, das zweite importiert eine GEDCOM Datei in einen leeren Stammbaum.

Zusätzlich kannst du Gramps den Namen des zu öffnenden Stammbaums mitgeben:

  • verwende diese Option :
    -O filename
    or
    --open=filename 

-O, Open of a family tree. This can be done also by just typing the name (name or database dir)

Beispiele:

python gramps.py 'Stammbaum 1'
python gramps.py /home/cristina/.gramps/grampsdb/47320f3d
python gramps.py -O 'Stammbaum 1'
python gramps.py -O /home/cristina/.gramps/grampsdb/47320f3d


Gnome-important.png
Tipp

Wenn der Dateiname ohne Option angegeben wird, versucht Gramps die Datei zu öffnen und anschließend eine interaktive Arbeitssitzung gestartet.


Das Format kann festgelegt werden mit dem
-f format
oder
--format=format
parameter, direkt gefolgt vom Dateinamen. Wenn nicht angegeben, wird versucht es aus dem Dateinamen zu ermitteln.
Gnome-important.png
Tipp

Nur Stammbäume können direkt geöffnet werden. Für andere Formate benötigst du die Importoption, welche die leere Datenbank einrichtet und dann die Daten in sie importiert.


Gnome-important.png
Tipp

Es kann nur ein Stammbaum geöffnet werden. Wenn du Daten aus verschiedenen Quellen kombinieren musst, benötigst du die Importoption.


Importoptionen

Die für den Import vorgesehenen Dateien können mit dem
-i filename
oder
--import=Dateiname
Parameter angegeben werden. Das Format kann mit dem -f oder --format=Format Parameter bestimmt werden, dem sofort der Dateiname folgt. Falls es nicht angegeben wird, wird versucht das Format aus dem Dateiname zu ermitteln.

Beispiele:

  python gramps.py -i 'Stammbaum 1' -i 'Stammbaum 2'
  python gramps.py -i test.grdb -i daten.gramps
Gnome-important.png
Tipp

More than one file can be imported in one command. If this is the case, GRAMPS will incorporate the data from the next file into the database available at the moment.


Falls mehr als eine Eingabedatei angegeben wird, muss jeder einem -i folgen. Die Dateien werden in der angegebenen Reihenfolge importiert, z.B.
-i Datei1 -i Datei2
und
-i Datei2 -i Datei1
es können unterschiedliche GRAMPS-ID's in der resultierenden Datenbank entstehen..

Exportoptionen

Die für den Export vorgesehenen Dateien können mit dem Parameter
-e Dateiname
oder
--export=Dateinamean
gegeben werden. Das Format kann mit dem
-f
Parameter bestimmt werden, dem sofort der Dateinamen folgt. Falls es nicht angegeben wird, wird versucht das Format aus dem Dateinamen zu ermitteln. Für iso-Formate, ist der Dateiname der Name des Verzeichnisses, in das die Gramps-Datenbank geschrieben wird. Für gramps-xml, gpkg, gedcom, wft, geneweb und gramps-pkg ist der Dateiname der Name der resultierenden Datei.

-e, export a family tree in required format. It is not possible to export to a family tree.

Beispiele:

 python gramps.py -i 'Stammbaum 1' -i test.grdb -f grdb -e mergdeDB.gramps

Note that above does not change 'Stammbaum 1' as everything happens via a temporary database, whereas:

 python gramps.py -O 'Family Tree 1' -i test.grdb -f grdb -e mergdeDB.gramps

will import test.grdb into Stammbaum 1, and then export to a file !

Gnome-important.png
Exporting more files

More than one file can be exported in one command. If this is the case, GRAMPS will attempt to write several files using the data from the database available at the moment.


Wenn mehr als eine Ausgabedatei angeben wird, muss jede auf einem -e-Parameter folgen. Diese Dateien werden nacheinander geschrieben, in der angegebenen Reihenfolge.

Aktionsoptionen

The action to perform on the imported data can be specified with the
-a action
or
--action=action
option. This is done after all imports are successfully completed.


The following actions remain the same:

  • report: Diese Aktion erlaubt das erstellen von Berichten über die Kommandozeile.
  • tool: This action allow to run a tool from a command line.
Da Berichte und Werkzeuge eine Reihe eigener Optionen haben, sollten diese Aktionen die Berichts/Werkzeug Optionenzeichenkette folgen. Die Zeichenkette wird mit der
-p Optionszeichenkette
oder
--options=Optionszeichenkette
Option übergeben.

The actions available in older versions of Gramps which were relocated in Gramps 3.3 are:

  • summary: This action was the same as Reports ->View ->Summary . In Gramps 3.3 it was replaced by (or renamed to) -a report -p name=summary.
  • check: This action was the same as Tools ->Database Processing ->Check and Repair . In Gramps 3.3 it was replaced by (or renamed to) -a tool -p name=check.

Berichtaktionoptionen

You can generate most reports from the command line using the report action. An example:

gramps -O "Stammbaum 1" -a report -p "name=family_group,style=default,off=html,of=test.html"

In version 3.3, you can provide the css style to use here with the css option:

gramps -O "Stammbaum 1" -a report -p "name=family_group,style=default,off=html,of=test.html,css=Web_Nebraska.css"

or without css in the html output:

gramps -O "Stammbaum 1" -a report -p "name=family_group,style=default,off=html,of=test.html,css="
Gnome-important.png
Report option string

Die Berichtsoption sollte folgende Bedingungen erfüllen: Sie darf keine Leerzeichenenthalten. Wenn eine Option Leerzeichen enthält, sollte sie in Anführungszeichen eingeschlossen werden. Eine Option besteht aus dem Optionsnamen und dem Wert. In einer Option müssen der Optionsname und Optionswert durch ein Gleichheitszeichen getrennt werden. Verschiedene Paare müssen durch Komma getrennt werden. Die meiten Bericht Optionen sind speziell für jeden Bericht. Allerdings gibt es einige allgemeine Optionen.


Most of the report options are specific for every report. However, there some common options.

  • name=report_name: Diese benötigte Option bestimmt welcher Bericht erzeugt wird. Wenn der übergebene Bericht_Name nicht mit einem verfügbaren Bericht übereinstimmt, wird eine Fehlermeldung gefollgt von einer Liste verfügbarer Berichte ausgegeben.
  • of : output filename
  • off: output format. These are the extension an output format makes available, eg, pdf, html, doc, ...
  • style: for text reports, the stylesheet to use. Defaults to 'default'.
  • show=all: Dies erstellt eine Liste der Namen aller verfügbaren Optionen für den angegebenen Bericht.
  • show=option_name: Dies zeigt die Beschreibung der funktionalität die durch Option_Name bereit gestellt wird, genauso wie die akzeptierten Arten und Werte für diese Option.

So, to learn to use a report, do for example:

gramps -O "Family Tree 1" -a report -p "name=family_group,show=all"
Gnome-important.png
Tipp

Wenn ein Parameter nicht angegeben wird, wird der zuletzt verwendete Wert genommen. Wenn dieser Bericht vorher nie erstellt wurde, wird wenn möglich der Wert des zuletzt erstellten Berichts verwendet. Sonnst wird der Standardwert verwendet.


Wenn mehr als eine Ausgabeaktion angegeben wird, muss jede auf einem -a Parameter folgen. Die Aktionen werden nacheinander in der entsprechenden Reihenfolge durchgeführt.

Gnome-important.png
lists

Some reports have options or arguments which are interpreted (by the report) to be on multiple lines. For instance some reports allow you to format how the information will be shown, perhaps with a name on one line and the person's birth date on the next line. Such multiple-line options or arguments are called "lists" by GRAMPS.


On the command line such lists must always start with a left square bracket

[

and must always end with a right square bracket

]

but since such square brackets are usually "special" to the "shell" (they mean something to the command interpreter you are typing the command to), you must "escape" them so that they are ignored by your shell.

The details vary with each shell but (in linux/UNIX) usually you can precede such a square bracket with a backslash

\

or put quotation marks around the square bracket, usually either "single" or "double" ones.

The Hourglass Graph report allows you to put a "note" at the top of the report and such a "note" is an example of a "list" option. Here is an example: gramps -O "Family Tree 1" -a report -p name=hourglass_graph,note='[line one,line two]' which shows that inside such a list different lines are separated by commas, and that spaces are acceptable since the quotation marks are already there for the square brackets.

But if you want to have a comma inside your report you have to somehow tell GRAMPS that comma is not one which separates lines. You do that by enclosing the line with the comma in quotation marks (either single or double).

But if you are already using a set of quotation marks (to enclose your square brackets) you have to use the other type to enclose the line with your comma. Here is an example: gramps -O "Family Tree 1" -a report -p name=hourglass_graph,note="['line one, also line one','line two, also line two']"

It is possible to include any character in a list but the details are beyond the scope of this command-line introduction to GRAMPS. You will need to know the precise methods available in your particular command shell interpreter to include a character which is "special" to your shell or "special" to GRAMPS (like the comma in the example above) but in general you will have to "escape" it twice, once to your shell and once again to GRAMPS, since you don't want your shell to think it is some instruction it should pay attention to and you don't want GRAMPS to think that either.

Werkzeugaktionoption

You can run most tools from the command line using the 'tool' action. To see which ones, say: gramps -O "Stammbaum 1" -a tool -p show=all To see a tool's available options, for instance the "verify" tool: gramps -O "Stammbaum 1" -a tool -p name=verify,show=all To run a tool, for instance the "verify" tool: gramps -O "Stammbaum 1" -a tool -p name=verify

Force unlock option

-u, you can extend the -O flag with -u to force a locked family to be unlocked. This allows to recover from a crash that leaves the family tree (database)locked from the command line.


An example (to unlock the "Family Tree 1" database): gramps -O "Family Tree 1" -a report -u > /dev/null Note that it is not possible to open family trees that need repair from the command line

Konfiguration (config) Option

The option takes three forms: (the following examples, exept 3.2, use behavior.database-path as the configuration variable to change.)

1) See all config values

 -s or --show

2) See a value:

--config=behavior.database-path

or -c behavior.database-path

3) Set a value:

--config=behavior.database-path:'/media/mydb'

oder -c behavior.database-path:'/media/mydb'

3.1) Set a value to its default:

--config=behavior.database-path:DEFAULT

oder -c behavior.database-path:DEFAULT


3.2) Set more than one value:

--config=behavior.use-tips:False --config=behavior.autoload:True oder -c behavior.use-tips:False -c behavior.autoload:True

When all configuration variable(s) are set Gramps will start with these new values.

Operation

Wenn das erste Argument auf der Kommandozeile nicht mit einem Strich beginnt (z.B. kein Parameter), versucht Gramps die Datei mit dem Namen des ersten Arguments zu öffnen und eine interaktive Sitzung zu starten. Der rest der Kommandozeilenargumente wird ignoriert.

Wenn der
-O
Parameter gesetzt ist, versucht Gramps den gelieferten Dateinamen zu öffnen und dann mit den Daten wie in weiteren Parametern angegeben zu arbeiten.
Gramps-notes.png
Notiz

Pro Aufruf von Gramps kann nur eine Datei geöffnet werden. Wenn du Daten aus mehreren Quellen benötigst, verwende die Importoptionen über die
-i
Option.
Mit oder ohne den
-O
Parameter, können mehrere Importe, Exporte und Aktionen in der Kommandozeile weiter spezifiziert werden durch Verwendung der
-i
,
-e
, und
-a
Parameter. Die Reihenfolge der
-i
,
-e
, oder
-a
Parameter spielt keine Rolle. Die tatsächliche Ausführungsreihenfolge ist immer: alle Importe (wenn vorhanden) -> alle Exporte (wenn vorhanden) -> alle Aktionen (wenn vorhanden).

'

Gramps-notes.png
Notiz

Aber öffnen muss immer die Erste sein!

Wenn kein
-O
oder
-i
Parameter angegeben wird, startet Gramps sein Hauptfenster und startet die gewöhnliche interaktive Sitzung mit der leeren Datenbank, denn es gibt keine Daten zu verarbeiten. (Außer du hast schon eine "Präferenz" gesetzt, das es mit der letzten verwendeten Datenbank starten soll.) Wenn kein
-e
oder
-a
Parameter angegeben ist, startet Gramps sein Hauptfenster und startet die gewöhnliche interaktive Sitzung mit der, aus öffnen und allen Importen (wenn vorhanden) resultierenden Datenbank. Die Datenbank liegt dann in der Datei import_db.grdb in dem Verzeichnis ~/.gramps/import/.

Fehler, die während des Imports, Exports oder einer Aktion auftreten, werden entweder auf stdout (wenn es Fehler sind, die von Gramps behandelt werden) oder auf stderr (wenn sie nicht behandelt werden) geschrieben. Verwende die gewöhnlichen Shell-Umleitungen von stdout und stderr um diese Nachrichten und Fehler in Dateien zu speichern.

Beispiele

  • To import four databases (whose formats can be determined from their names) and then check the resulting database for errors, one may type:
gramps -i Datei1.ged -i Datei2.gpkg -i ~/DB3.gramps -i Datei4.wft -a check
  • To explicitly specify the formats in the above example, append filenames with appropriate -f Optionen:
gramps -i Datei1.ged -f gedcom -i Datei2.gpkg -f gramps-pkg -i ~/DB3.gramps -f gramps-xml -i Datei4.wft -f wft -a check
  • To record the database resulting from all imports, supply -e flag (use -f if the filename does not allow Gramps to guess the format):
gramps -i Datei1.ged -i Datei2.gpkg -e ~/new-package -f gramps-pkg
  • To save any error messages of the above example into files outfile and errfile, run:
gramps -i Datei1.ged -i file2.dpkg -e ~/new-package -f gramps-pkg >outfile 2>errfile 
  • Um drei Datenbanken zu importieren und eine interaktive Gramps Sitzung mit dem Ergebnis zu starten:
gramps -i Datei1.ged -i Datei2.gpkg -i ~/db3.gramps 
  • To open a database and, based on that data, generate timeline report in PDF format putting the output into the meine_zeitlinie.pdf file:
gramps -O 'Stammbaum 1' -a report -p name=timeline,off=pdf,of=meine_zeitlinie.pdf 
Gnome-important.png
Zeitlinienberichtoptionen

Verwende name=timeline,show=all um alle Optionen für den Zeitlinien Bericht zu sehen. Um Einzelheiten einer bestimmten Option zu erhalten verwende show=Optionsname<tt>, z.B. <tt>name=timeline,show=off. Um mehr über verfügbare Berichtsnamen zu erfahren, verwende die name=show Zeichenfolge.


  • Um eine grdb spontan in eine .gramps XML-Datei umzuwandeln:
gramps -O 'Family Tree 1' -e output.gramps -f gramps-xml
  • Um eine Webseite in einer anderen Sprache (Deutsch) zu erstellen:
LANGUAGE=de_DE; LANG=de_DE.UTF-8 gramps -O 'Stammbaum 1' -a report -p name=navwebpage,target=/../de 
  • Zum Abschluss um eine normale Interaktive Sitzung zu starten, tippe:
gramps 

Umgebungsvariablen

Gramps kann diese Umgebungsvariablen berücksichtigen (Aber ändere sie nur wenn du weist was du tust):

  • GRAMPSHOME - wenn gesetzt, überschreibt es den Standardpfad zum Profil, und ermöglicht Anwendern externe Netzlaufwerke zur Speicherung der Daten und aller Einstellungen zu verwenden. Für technisch erfahrene Anwender, die verschiedene Versionen von Gramps starten, ist das setzen von verschiedenen $GRAMPSHOME ein Weg, Störungen zwischen verschiedenen Versionen im Gramps Anwenderverzeichnis zu vermeiden.
  • LANG - wird von Gramps verwendet, um festzulegen welche Sprachdatei geladen wird.
Zurück Index Nächste