Fr:Manuel wiki pour Gramps 3.1 - Les lignes de commande

From Gramps
Revision as of 18:20, 24 June 2009 by Romjerome (talk | contribs) (Exemples)
Jump to: navigation, search

Cette annexe décrit les possibilités offertes par GRAMPS en ligne de commande, depuis un terminal.

Gramps-notes.png
Note

GRAMPS est écrit pour être piloté à travers son interface graphique. Il ne peut pas être utilisé dans un mode strictement limité au texte. Les modifications pour le faire seraient très importantes. C'est pourquoi les options de la ligne de commande ne visent pas l'indépendance par rapport au mode graphique. En fait, elles rendent seulement certaines tâches fréquentes plus commodes et exécutables depuis des scripts. L'affichage graphique doit cependant toujours être accessible !

Tango-Dialog-information.png
Astuce

En résumé, les options de la ligne de commande fournissent un mode non-interactif mais n'affranchissent pas d'un affichage graphique. C'est comme ça !


Gnome-important.png Special copyright notice: All edits to this page need to be under two different copyright licenses:

These licenses allow the Gramps project to maximally use this wiki manual as free content in future Gramps versions. If you do not agree with this dual license, then do not edit this page. You may only link to other pages within the wiki which fall only under the GFDL license via external links (using the syntax: [https://www.gramps-project.org/...]), not via internal links.
Also, only use the known Typographical conventions


Précédent [[Fr:Manuel_wiki_pour_Gramps_{{{3}}}| Index]] Suivant


Options disponibles

Voici la liste des options de lancement de GRAMPS. Si vous voulez connaître plus d'options, voir Opération et Exemples.

Options de format

Le format des fichiers de lecture ou d'écriture est donné par l'option

-f format

Les valeurs acceptables format sont énumérées ci-dessous.

  • Base de données de GRAMPS. Ce format est prêt à l'ouverture, à l'importation, et à l'exportation. Une fois indiqué, il peut deviner si le fichier porte l'extension .grdb
  • Base de données de GRAMPS. Ce format est prêt à l'ouverture, à l'importation, et à l'exportation. Une fois indiqué, il peut deviner si le fichier représente un nom de fichier .gramps
  • Fichier GEDCOM. Ce format est prêt à l'ouverture, à l'importation, et à l'exportation. Une fois indiqué, il peut deviner si le fichier porte l'extension .ged
  • Paquet de GRAMPS. Ce format est prêt à l'importation et à l'exportation. Une fois indiqué, il peut deviner si le fichier porte l'extension .gpkg
  • Le fichier GeneWeb. Ce format est prêt à l'importation et à l'exportation. Une fois indiqué, il peut deviner si le fichier porte l'extension .gw
  • Web Family Tree. Ce format est prêt à l'exportation seulement. Une fois indiqué, il peut deviner si le fichier porte l'extension .wft
  • Image de CD. Ce format est prêt à l'exportation seulement. Il doit toujours être indiquer explicitement.

Options d'ouverture

Il y a deux manières de donner à GRAMPS le nom du fichier à ouvrir :

  • chemin du fichier* utilisez l'option :
    -O nom_du_fichier
    ou
    --open=nom_du_fichier

-O, ouvre un arbre familial. Ceci est également possible en saisissant le nom (nom ou répertoire de la base de données)

Exemples :

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

Si le nom du fichier est donné sans options, GRAMPS ouvrira sa fenêtre principale et commencera une session.

Tango-Dialog-information.png
Astuce

Si aucune option n'est donnée, juste le nom de fichier, GRAMPS ignorera le reste des arguments de ligne de commande. Utilisez l'option -O pour et pour faire quelque chose avec les données.


Le format peut être spécifié avec

-f format

ou l'option

--format=format

, suivi immédiatement par le nom_du_fichier . Si non spécifié, GRAMPS devinera d'après le nom_du_fichier. Format possible: 'gedcom','gramps-xml','gramps-pkg', 'grdb','geneweb'.

Tango-Dialog-information.png
Astuce

Seulement grdb, gramps-xml, et les formats gedcom peuvent être ouverts directement. Pour d'autres formats, vous devrez employer l'option d'importation qui créera une base de données vide puis importera des données.


Tango-Dialog-information.png
Tip

Seulement, un fichier peut être ouvert par GRAMPS. Si vous avez besoin d'ouvrir depuis plusieurs sources, utilisez l'option d'importation
-i
.


Options d'importation

Les dossiers destinés à l'importation peuvent être indiqués avec

-i ''nom du fichier''

ou

--import=''nom du fichier''

Le format peut être indiqué avec l'option

-f format

ou

--format=format

juste aprèsnom de fichier. Pour le format gramps-xml,le nom du fichier est réellement le nom du répertoire sous lequel la base de données de gramps réside. Pour grdb, gedcom, gramps-pkg, et geneweb, le nom du fichier est le nom du fichier correspondant.

Exemple:

  python gramps.py -i 'Arbre familial 1' -i 'Arbre familial 2'
  python gramps.py -i test.grdb -i données.gramps
Tango-Dialog-information.png
Tip

Plus d'un fichier peut être exporté dans une commande. Si c'est le cas, GRAMPS essayera d'écrire plusieurs fichiers en utilisant les données de la base de données disponible à l'heure actuelle.


Quand plus d'un dossier d'entrée est donné, chacun doit être par précédé de

-i

Les dossiers sont importés dans l'ordre indiqué, c.-à-d..

 -i ''fichier1'' -i ''fichier2''

and

 -i ''fichier2'' -i ''fichier1''

pourraient produire différentes versions dans la base de données résultant.

Options d'exportation

Les dossiers destinés à l'exportation peuvent être indiqués avec

-e ''nom du fichier''

ou

--export=''nom du fichier''

Le format peut être indiqué avec l'option

-f

juste après le nom du fichier. Pour gramps-xml et les formats iso, nom du fichier est réellement le nom du répertoire la base de données de gramps. Pour grdb, gedcom, wft, geneweb, et gramps-pkg,le nom du fichier est le nom du dossier résultant.

-e, exporte l'arbre familial dans le format requis. Ce n'est pas possible d'exporter vers un arbre familial.

Exemple:

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

Notez qu'on ne modifie pas 'Arbre familial 1' puisque l'on utilise une base temporaire, et:

 python gramps.py -O 'Arbre familial 1' -i test.grdb -f grdb -e mergdeDB.gramps

qui importera test.grdb dans Arbre familial 1, puis l'exporte dans un fichier !

Tango-Dialog-information.png
Exporter plusieurs fichiers

Plus d'un fichier peut être exporté dans une commande. Si c'est le cas, GRAMPS écrira les données à partir de la base de données disponible.


Quand plus d'un fichier est donné, chacun doit être par précédé par

-e

Les dossiers sont écrits dans l'ordre indiqué.

Options d'action

L'action à exécuter sur les données importées peut être indiquée avec

-a action

ou

--action=action

Ceci est fait après que toutes les importations soient accomplies avec succès.

Les actions actuellement disponibles sont :

  • summary : cette action est identique à Rapports ->Vue ->Sommaire
  • check : cette action est identique à Outils ->Traitement de la Base de données ->contrôle et réparation.
  • tool : cette annexe décrit les possibilités offertes par GRAMPS en ligne de commande, depuis un terminal.
  • rapport : cette action laisse produire des rapports à partir de la ligne de commande. Car les rapports ont généralement beaucoup d'options propres, cette action devrait être suivie de la chaîne d'option du rapport. La chaîne est donnée en utilisant
    -p option_string
    ou
    --options=option_string
    .
Tango-Dialog-information.png
L'option rapport

La chaîne d'option de rapport devrait satisfaire les conditions suivantes : elle ne doit contenir aucun espaces. Si quelques arguments doivent inclure les espaces, la chaîne devrait être enfermée avec des guillemets. La chaîne d'option doit lister des paires de nom et valeur. La chaîne d'option doit énumérer une paire de nom et de valeur séparée par le signe égal. Différentes paires doivent être séparées par des virgules.


La plupart des options de rapport sont spécifiques pour chaque rapport. Cependant, il y a quelques options communes.

  • Cette option obligatoire détermine quel rapport sera produit. Si le report_name ne correspond à aucun rapport disponible, le message d'erreur sera affiché à la suite de la liste de rapports disponibles.
  • show=all : ceci affichera la liste de noms pour toutes les options disponibles pour un rapport présenté.
  • show=option_name : ceci affichera la description de la fonctionnalité assurée par l'option_name, pour les types et les valeurs acceptables pour cette option.

Employez les options ci-dessus pour découvrir tout au sujet d'un rapport présenté.

Tango-Dialog-information.png
Astuce

Si une option n'est pas assurée, la dernière valeur utilisée sera employée. Si ce rapport n'a jamais été produit avant, alors la valeur du dernier rapport produit sera employée comme applicable. Autrement, la valeur par défaut sera employée.


Quand plus d'une action à produire est donnée, chacunes doivent être par précédé

-a

. Les actions sont effectuées dans l'ordre indiqué.

Liste des options

-l

, rapporte une liste des arbres familiaux

Opération

Si le premier argument sur la ligne de commande ne commence pas par le tiret, GRAMPS essayera d'ouvrir le dossier avec le nom donné par le premier argument et de commencer la session interactive, ignorant le reste des arguments de ligne de commande.

Si

-O

est donné, alors GRAMPS essayera d'ouvrir le nom de fichier fourni et fonctionnera alors avec ces données.

Gramps-notes.png
Note

Seulement, un fichier peut être ouvert par GRAMPS. Si vous avez besoin d'ouvrir depuis plusieurs sources, utilisez l'option d'importation
-i
.

Avec ou sans l'argument

-O

, il peut y avoir de multiples importations , exportations, et actions spécifiées par la ligne de commande par les arguments

-i

,

-e

, et

-a

. L'ordre des options

-i

,

-e

, ou

-a

entre elles n'a pas de signification. L'ordre réel d'exécution est toujours : les lectures (s'il y en a) puis les écritures (s'il y en a) et enfin les actions (s'il y en a).

'

Gramps-notes.png
Note

Mais ouvrir doit toujours être en premier !

Si aucune option

-O

ou

-i

n'est donnée, gramps ouvrira sa fenêtre principale et commencera une session interactive avec un ensemble vide de données puisqu'il n'y a pas de données à traiter. Si aucune option

-e

ou

-a

n'est donnée, gramps ouvrira sa fenêtre principale et commencera une session interactive avec les données lues. import_db.grdb se situera dans le répertoire ~/.gramps/import/.

Les erreurs trouvées pendant les phases de lecture, d'écriture et d'action sont rapportées soit sur la sortie standard quand elles sont gérées par gramps, soit sur la sortie d'erreur dans le cas contraire. Utilisez les redirections du shell pour les conserver dans des fichiers.

Exemples

  • Lecture de quatre bases de données dont les formats peuvent être devinés d'après les noms, puis vérification des données :
gramps -i fichier1.ged -i fichier2.gpkg -i ~/db3.gramps -i fichier4.wft -a check
  • Si vous voulez préciser les formats de fichiers dans l'exemple ci-dessus, complétez les noms de fichiers par les options
    -f
    appropriées :
gramps -i fichier1.ged -f gedcom -i fichier2.gpkg -f gramps-pkg -i ~/db3.gramps -f gramps-xml -i fichier4.wft -f wft -a check
  • Pour enregistrer le résultat des lectures, donnez l'option
    -o
    (utiliser
    -f
    si le nom de fichier ne permet pas à gramps de deviner le format) :
gramps -i fichier1.ged -i fichier2.gpkg -e ~/nouveau-paquet -f gramps-pkg
  • Pour sauver les erreurs de l'exemple précédent dans les fichiers outfile et errfile, lancez :
gramps -i fichier1.ged -i fichier2.dpkg -e ~/nouveau-paquet -f gramps-pkg >outfile 2>errfile 
  • Pour lire trois ensembles de données puis lancer une session interactive de gramps sur le tout:
gramps -i fichier1.ged -i fichier2.gpkg -i ~/db3.gramps 
  • Pour ouvrir une base de données, produisant un rapport temporel dans le format pdf et l'enregistrant sous le fichier my_timeline.pdf  :
gramps -O 'Arbre Familial 1' -a report -p name=timeline,off=pdf,of=my_timeline.pdf 
Tango-Dialog-information.png
Options du rapport temporel

Utilisez name=timeline,show=all pour trouver toutes les options disponibles pour le rapport temporel. Pour obtenir plus de détails, utilisez show=option_name , par exemple la chaîne name=timeline,show=off. Pour découvrir les noms de rapport, utilisez la chaîne name=show.


  • Pour convertir une base de données vers un fichier gramps xml :
gramps -O 'Arbre Familial 1' -e sortie.gramps -f gramps-xml
  • Pour générer un site web dans une autre langue (par exemple en allemand)
LANGUAGE=de_DE; LANG=de_DE.UTF-8 gramps -O 'Arbre familial 1' -a report -p name=navwebpage archive=/../.. 
  • Enfin, pour lancer une session interactive normale, entrez :
gramps 

Variables d'environnement

GRAMPS peut tenir compte de ces variables d'environnement (mais ne les changez pas si vous ne savez pas pourquoi):

  • GRAMPSHOME - si définit, écrase le chemin par défaut du profile permettant d'utiliser un disque réseau pour sauvegarder ses données et préférences.
  • LANG - est utilisé par GRAMPS pour déterminer quelle langue doit être chargée.
Précédent [[Fr:Manuel_wiki_pour_Gramps_{{{3}}}| Index]] Suivant