[Koha-cvs] CVS: koha-doc/fr/sysadmin/maintien scripts_ligne_de_commande.xml,NONE,1.1

[skemotah]

Update of /cvsroot/koha/koha-doc/fr/sysadmin/maintien
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv3504/fr/sysadmin/maintien

Added Files:
	scripts_ligne_de_commande.xml 
Log Message:
copying document to new directory

--- NEW FILE ---
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<article>
  <title>Scripts ligne de commande</title>

  <articleinfo>
    <pubdate>2005-02-25</pubdate>

    <author>
      <firstname>Paul</firstname>

      <surname>POULAIN</surname>

      <email>paul AT koha-fr.org</email>
    </author>

    <authorblurb>
      <para>Consultant indépendant en logiciels libres, Koha "Release Manager"
      pour la version 2.0 puis 2.2, membre du comité de pilotage
      international</para>
    </authorblurb>

    <copyright>
      <year>2004</year>

      <year>2005</year>

      <holder>Paul Poulain</holder>
    </copyright>

    <legalnotice>
      <para>This document is related to Koha and is licensed to you under the
      GNU General Public License version 2 or later (<ulink
      url="http://www.gnu.org/licenses/gpl.html">http://www.gnu.org/licenses/gpl.html</ulink>).</para>

      <para>Koha-related documents may be reproduced and distributed in whole
      or in part, in any medium physical or electronic, as long as this
      copyright notice is retained on all copies.</para>

      <para>You may create a derivative work and distribute it provided that
      you:</para>

      <orderedlist>
        <listitem>
          <para>License the derivative work with this same license, or the
          Linux Documentation Project License (<ulink
          url="http://www.tldp.org/COPYRIGHT.html">http://www.tldp.org/COPYRIGHT.html</ulink>).
          Include a copyright notice and at least a pointer to the license
          used.</para>
        </listitem>

        <listitem>
          <para>Give due credit to previous authors and major
          contributors.</para>
        </listitem>
      </orderedlist>

      <para>Commercial redistribution is allowed and encouraged; however, the
      author would like to be notified of any such distributions.</para>

      <para>No liability for the contents of this document can be accepted.
      Use the concepts, examples and information at your own risk. There may
      be errors and inaccuracies, that could be damaging to your system.
      Proceed with caution, and although this is highly unlikely, the
      author(s) do not take any responsibility.</para>

      <para>All copyrights are held by their by their respective owners,
      unless specifically noted otherwise. Use of a term in this document
      should not be regarded as affecting the validity of any trademark or
      service mark. Naming of particular products or brands should not be seen
      as endorsements.</para>
    </legalnotice>

    <revhistory>
      <revision>
        <revnumber>2.2.0</revnumber>

        <date>2005-02-25</date>

        <authorinitials>pp</authorinitials>

        <revdescription>
          <para>Version initiale</para>
        </revdescription>
      </revision>
    </revhistory>
  </articleinfo>

  <section>
    <title>Introduction</title>

    <section>
      <title>Généralités</title>

      <para>Ce document présente les différents scripts d'exploitation fournis
      avec Koha. Il ne présente pas les scripts utilisables pour la migration
      des données, mais ceux qu'une bibliothèque peut mettre en place pour son
      fonctionnement quotidien.</para>

      <para>Par exemple, les scripts de relance pour les retards.</para>
    </section>

    <section>
      <title>Pré-requis</title>

      <para>Pré-requis techniques :</para>

      <itemizedlist>
        <listitem>
          <para>Installation de Koha : on suppose que Koha est installé. $KOHA
          est le répertoire dans lequel se trouve l'interface
          bibliothécaire.</para>

          <programlisting>ls -l
    $KOHA</programlisting>

          <para>doit renvoyer : cgi-bin htdocs modules scripts</para>
        </listitem>

        <listitem>
          <para>Le fichier de configuration de Koha se trouve dans
          /etc/koha.conf. Si ce n'est pas le cas, vous devez préciser sa
          localisation :</para>

          <programlisting>export
    KOHA_CONF=/etc/mykoha.configfile</programlisting>
        </listitem>

        <listitem>
          <para>Toutes les manipulations décrites ci-après sont effectuées sur
          une console (shell) sur le serveur.</para>
        </listitem>

        <listitem>
          <para>se placer dans un shell (ligne de commande) et vérifier que
          Perl peut trouver vos modules :</para>

          <programlisting>export
    PERL5LIB=$KOHA/modules</programlisting>
        </listitem>

        <listitem>
          <para>Les scripts se trouvent dans le répertoire script/misc. Vous
          pouvez les déplacer en dehors de l'arboresence de Koha si vous les
          modifiez. En effet, chaque mise à jour de l'application va les
          écraser (en fait ils sont sauvegardés dans le répertoire de backup,
          mais il ne seront plus utilisés par la crontab.</para>
        </listitem>

        <listitem>
          <para>Tous ces scripts ont vocation à être mis dans une table de
          tâches périodiques (crontab). En conséquence, on n'abordera pas ici
          la question de la méthode à suivre pour les exécuter périodiquement.
          Reportez vous à la doc de la crontab :</para>

          <programlisting>man
    crontab</programlisting>

          <para>et</para>

          <programlisting>man 5
    crontab</programlisting>
        </listitem>

        <listitem>
          <para>Tous les scripts décrits ci-après ont fonctionné à un moment
          donné. Cela ne signifie pas qu'ils fonctionnent encore, ni qu'ils
          fonctionneront pour la version que vous avez téléchargé. Vous êtes
          prévenus !</para>
        </listitem>
      </itemizedlist>
    </section>
  </section>

  <section>
    <title>Les scripts</title>

    <section>
      <title>overduenotice.pl</title>

      <para>Ce script recherche les lecteurs ayant un ouvrage en retard et
      envoie les rappels.</para>

      <para>Il ne fait appel à aucun paramètre de l'application, tout ce qui
      est personnalisable est au début du script.</para>

      <para>Il fonctionne de la manière suivante :</para>

      <itemizedlist>
        <listitem>
          <para>Seuls les lecteurs dont la catégorie a "overduenoticerequired"
          d'activé sont traités. Les autres sont ignorés.</para>
        </listitem>

        <listitem>
          <para>Le script envoie un mail à tous les lecteurs ayant une adresse
          mail renseignée.</para>
        </listitem>

        <listitem>
          <para>Le script envoie à une adresse interne à la bibliothèque un
          mail avec tous les retards, pour gestion manuelle.</para>
        </listitem>
      </itemizedlist>

      <para>Les paramètres qui sont modifiables sont les suivants :</para>

      <itemizedlist>
        <listitem>
          <para>le délai de grâce avant les notifications (7 jours dans la
          version officielle)</para>
        </listitem>

        <listitem>
          <para>le nombre de jours au delà duquel on n'envoie plus de rappel
          (30 jours dans la version officielle). Habituellement, au delà de ce
          nombre de jours le lecteur est suspendu, mais cette suspension n'est
          <emphasis role="bold">pas gérée</emphasis> par ce script.</para>
        </listitem>

        <listitem>
          <para>L'adresse apparaissant en "From" sur les mails que les
          lecteurs recoivent.</para>
        </listitem>

        <listitem>
          <para>Le sujet du message.</para>
        </listitem>

        <listitem>
          <para>Le corps du message. Celui-ci est présenté sous la forme de
          texte, avec 2 éléments spécifiques :</para>

          <itemizedlist>
            <listitem>
              <para>les caractères spéciaux comme \n (saut de ligne) ou \t
              (tabulation)</para>
            </listitem>

            <listitem>
              <para>les zones qui seront remplacées par leur valeur lors de
              l'exécution du script. Ces zones sont entre crochets :
              &lt;date&gt; (la date du jour) &lt;itemcount&gt; (le nombre de
              documents en retard) &lt;firstname&gt; (le prénom)
              &lt;lastname&gt; (le nom) &lt;address1&gt; &lt;address2&gt;
              &lt;address3&gt; &lt;city&gt; (l'adresse) &lt;postcode&gt; (le
              code postal)</para>
            </listitem>
          </itemizedlist>
        </listitem>
      </itemizedlist>
    </section>

    <section>
      <title>fines2.pl</title>

      <para>Ce script calcule les amendes.</para>

      <para>Il ne fonctionne probablement plus avec la version 2.2</para>
    </section>

    <section>
      <title>notifys/fines.pl</title>

      <para>Ce script calcule les amendes.</para>

      <para>Il ne fonctionne probablement plus avec la version 2.2</para>
    </section>

    <section>
      <title>misc/merge_authorities.pl</title>

      <para>Ce script fusionne 2 autorités passées en paramètre.</para>

      <para>Il se lance avec les options suivantes :</para>

      <itemizedlist>
        <listitem>
          <para>-h (ou aucune option) : affiche les paramètres
          d'exécution</para>
        </listitem>

        <listitem>
          <para>-f X (pour "from"), ou X est un numéro d'autorité. Va
          fusionner l'autorité X</para>
        </listitem>

        <listitem>
          <para>-t Y (pour "to"), ou Y est un numéro d'autorité. Va fusionner
          dans l'autorité Y</para>
        </listitem>
      </itemizedlist>

      <para>Toutes les notices bibliographiques pointant sur l'autorité X
      pointent après l'exécution de ce script sur l'autorité Y.</para>

      <para>Avant de s'exécuter, ce script va :</para>

      <itemizedlist>
        <listitem>
          <para>Vérifier que les 2 autorités sont du même genre.</para>
        </listitem>

        <listitem>
          <para>Afficher les autorités pour validation (l'autorité X et
          l'autorité Y)</para>
        </listitem>

        <listitem>
          <para>Effectuer la fusion si l'utilisateur la confirme.</para>
        </listitem>
      </itemizedlist>

      <para>A l'issue de la confirmation, l'autorité X devient donc
      inutilisée. Elle peut être supprimée depuis l'interface graphique de
      Koha.</para>

      <para>Ce script dispose de deux paramètres supplémentaires :</para>

      <itemizedlist>
        <listitem>
          <para>-b (pour "batch", fusion en série). En mode batch, le script
          recherche toutes les autorités qui ont été modifiées, et modifie
          toutes les notices bibliographiques en conséquence. Les numéros des
          autorités qui ont été modifiées sont stockées dans un répertoire
          spécifique.</para>
        </listitem>

        <listitem>
          <para>-n (pour "no", pas de confirmation, mode silencieux). Lorsque
          cette option est spécifiée, le script n'affiche rien et effectue la
          fusion sans demande de confirmation.</para>
        </listitem>
      </itemizedlist>

      <para>Classiquement, les modes -b et -q sont utiles lorsque l'on met le
      script dans les tâches périodiques (crontab), pour mettre à jour les
      notices bibliographiques qui utilisent une notice d'autorité qui vient
      d'être modifiées.</para>

      <para>Voici un exemple de ce que j'ai dans ma crontab :</para>

      <programlisting>SHELL=/bin/bash

*/5 * * * * export PERL5LIB=/home/httpd/koha;export KOHA_CONF=/etc/koha.conf;/home/httpd/koha/scripts/misc/merge_authorities.pl -b -n</programlisting>
    </section>

    <section>
      <title>misc/migration_tools/build_marc_word.pl</title>

      <para>Script qui ne concerne que les installations en MARC21.
      Reconstruit la table marc_word avec certains mots seulement, pour de
      meilleurs temps de réponse.</para>
    </section>

    <section>
      <title>misc/migration_tools/bulkauthimport.pl</title>

      <para>script qui devrait migrer des notices d'autorités iso2709, sur le
      même modèle que bulkmarcimport.pl Ne fonctionne pas dans la version
      2.2.2.</para>
    </section>

    <section>
      <title>misc/migration_tools/cleanmarcdb.pl</title>

      <para>Ne fonctionne pas au moment de la rédaction du document (2.2.2),
      mais devrait être simple à corriger.</para>
    </section>

    <section>
      <title>misc/migration_tools/compare_iso_and_marc_parameters.pl</title>

      <para>Affiche la liste des sous-champs MARC qui sont utilisés dans un
      fichier iso2709, mais pas déclarés dans le paramétrage des grilles de
      catalogage.</para>

      <para>Affiche la liste des sous-champs déclarés dans le paramétrage des
      grilles de catalogage mais inutilisés dans un fichier iso2709.</para>

      <para>Ce script aide à détecter les erreurs de paramétrage.</para>

      <para>Il se lance avec les options suivantes :</para>

      <itemizedlist>
        <listitem>
          <para>-v ou aucune option : affiche les paramètres
          d'exécution.</para>
        </listitem>

        <listitem>
          <para>-file fichier.iso : le fichier iso à comparer à la structure
          du catalogue.</para>
        </listitem>

        <listitem>
          <para>-w élimine des avertissements si le fichier iso2709 présente
          des irrégularités de format.</para>
        </listitem>

        <listitem>
          <para>-c codegrille : la grille de catalogage d'ou récupérer les
          paramètres MARC. Si ce paramètre est omis, ce script utilise la
          grille de catalogage par défaut.</para>
        </listitem>
      </itemizedlist>
    </section>

    <section>
      <title>misc/migration_tools/dumpmarc.pl</title>

      <para>Ce script affiche un fichier iso2709 sous une forme
      lisible.</para>

      <para>Il se lance avec les options suivantes :</para>

      <itemizedlist>
        <listitem>
          <para>-v ou aucune option : affiche les paramètres
          d'exécution.</para>
        </listitem>

        <listitem>
          <para>-file fichier.iso : le fichier à afficher</para>
        </listitem>

        <listitem>
          <para>-n numero : le numéro de la notice à afficher (numéro d'ordre
          dans le fichier)</para>
        </listitem>

        <listitem>
          <para>-w : active ou désactive les averstissements si le fichier
          n'est pas strictement iso2709. Si le script échoue sans le -w,
          essayez de le relancer avec, mais sachez que votre fichier n'est pas
          iso2709 ! Si cela fonctionne avec l'option -w, c'est que le défaut
          n'est pas énorme. Sinon, même le -w aboutira à un échec.</para>
        </listitem>
      </itemizedlist>
    </section>

    <section>
      <title>misc/koha2marc.pl</title>

      <para>Utile seulement pour les bibliothèques avec une ancienne version
      de Koha (1.2) ou un paramétrage MARC=OFF, ce qui n'est le cas d'aucune
      bibliothèque francophone.</para>

      <para>Ce script reconstruit la base MARC Ã  partir de la base
      non-MARC.</para>

      <para>Attention, il ne faut JAMAIS le lancer si vous avez MARC=ON, sinon
      vous allez supprimer une bonne partie de vos données !!!</para>
    </section>

    <section>
      <title>misc/rebuildnonmarc.pl</title>

      <para>Ce script est le contraire du précédent. Il n'est utile que pour
      les bibliothèques ayant MARC=ON.</para>

      <para>Il reconstruit la base non-MARC de Koha à partir du paramétrage et
      des données MARC.</para>

      <para>Il doit être lancé lorsque quelque chose est modifié dans le
      paramétrage des grilles de catalogage (notamment un lien koha &lt;=&gt;
      MARC). Ce devrait être assez rare.</para>

      <para>Si vous vous interrogez sur la nécessité de relancer le script,
      expliquez sur la liste de discussion ce que vous avez fait, et nous vous
      répondrons bien volontiers.</para>
    </section>

    <section>
      <title>misc/rebuildthesaurus.pl</title>

      <para>script inutile, à oublier, il sera supprimé.</para>
    </section>

    <section>
      <title>update_marcsubjects.pl</title>

      <para>Script mettant à jour les mots-clefs dans la base MARC. Utile
      seulement pour les bibliothèques avec MARC=OFF, ce qui n'est le cas
      d'aucune bibliothèque francophone.</para>
    </section>

    <section>
      <title>misc/migration_tools/buildLANG.pl</title>

      <para>Petit script pour reconstruire la liste des codes de langue (liste
      de valeurs autorisées nommées LANG) à partir du contenu de la base de
      données.</para>

      <para>Il se lance avec les paramètres suivants :</para>

      <itemizedlist>
        <listitem>
          <para>-h ou aucun paramètre : affiche les options d'exécution</para>
        </listitem>

        <listitem>
          <para>-s le ou les champ/sous-champ contenant les codes langues (par
          exemple : "('101a','101b')" pour l'UNIMARC</para>
        </listitem>

        <listitem>
          <para>-d supprime la table existante avant de la reconstruire</para>
        </listitem>

        <listitem>
          <para>-l LANGUE (la langue dans laquelle les libellés de langue
          doivent être générés. seuls fr et en sont disponibles)</para>
        </listitem>
      </itemizedlist>

      <para>Notez que dans tous les cas la liste des codes sera la liste iso,
      que le libellé soit en français ou en anglais.</para>

      <para>Vous pouvez compléter la liste après qu'elle ait été construite
      automatiquement, mais si vous migrez une base, une valeur qui n'est pas
      présente après l'exécution de ce script est une valeur qui n'est pas
      utilisée dans votre base, donc elle devrait être inutile (sauf en cas de
      nouvelle notice, bien entendu)</para>
    </section>

    <section>
      <title>misc/migration_tools/buildEDITORS.pl</title>

      <para>Script qui construit automatiquement la liste d'autorités
      "EDITORS", utilisée par les plugins 210$c et 225$a pour "deviner"
      l'auteur et la liste des collections possibles à partir de
      l'ISBN.</para>

      <para>Pour que ce script fonctionne, il faut que la catégorie d'autorité
      ait été définie comme indiqué dans le document "migrer ses
      données".</para>

      <para>Il se lance avec les paramètres suivants :</para>

      <itemizedlist>
        <listitem>
          <para>-c (pour "confirmation"). Ce script n'a pas besoin de
          paramètre. Pour éviter qu'il ne s'exécute un peu trop rapidement,
          s'il est lancé sans le -c, il s'arrètera sans rien faire. Il faut le
          lancer avec le -c pour qu'il reconstruise les "autorités"
          EDITORS.</para>
        </listitem>

        <listitem>
          <para>-d efface la liste existant avant de la reconstruire. Devrait
          logiquement être appelé avec cette option.</para>
        </listitem>
      </itemizedlist>
    </section>

    <section>
      <title>misc/migration_tools/build6xx.pl</title>

      <para>Ce script reconstruit les fichiers d'autorité à partir des notices
      migrées dans Koha. Il ne fonctionne pas directement en l'état. Il faut
      le modifier pour l'adapter aux besoins de la bibliothèques, selon la
      manière de gérer les autorités (la structure des autorités : $a, $a et
      $b, $a et $x répétés, ...)</para>

      <para>Le présent script est juste une aide au démarrage et doit être
      adapté.</para>
    </section>

    <section>
      <title>misc/migration_tools/bulkmarcimport.pl</title>

      <para>Ce script importe un fichier iso2709 dans la base active de Koha.
      c'est le principal script de migration. Il fonctionne, mais profitez de
      la migration de vos données pour les nettoyer, c'est généralement une
      bonne idée. Dans ce cas, vous devrez modifier ce script pour l'adapter à 
      votre comportement. Ce script fonctionne assez simplement : il lit
      notice par notice, met à part la ou les notices d'exemplaire, importe la
      notice bibliographique, puis la ou les notices d'exemplaires.</para>

      <para>Le détail du fonctionnement de ce script est dans le document
      "migrer ses données"</para>
    </section>

    <section>
      <title>misc/migration_tools/check_marc_definition.pl</title>

      <para>Ce script compare les données dans la base et la structure du
      catalogue. Il affiche la liste des champs dans la base (probablement
      importés par bulkmarcimport), mais inactifs dans la grille de
      catalogage, et la liste des champs activés dans la grille de catalogage
      mais jamais remplis.</para>

      <para>Dans le premier cas, c'est surement une erreur de paramétrage de
      vos grilles. Si ce n'est pas une erreur de paramétrage, vous devriez
      supprimer le champ au moment de l'import (bulkmarcimport).</para>

      <para>Dans le second cas, c'est peut être une erreur, ou alors le champ
      est inutilisé jusqu'à ce jour et vous souhaitez commencer à 
      l'utiliser.</para>
    </section>
  </section>
</article>