# Manuel de &kbackup;

## Introduction

&kbackup; est un programme qui vous permet de sauvegarder des fichiers ou des répertoires que vous pouvez sélectionner dans une arborescence. Il vous permet également de sauvegarder votre configuration dans un fichier appelé « profil » qui est simplement un fichier texte contenant les fichiers et répertoires à inclure ou exclure du processus de sauvegarde. Vous pouvez définir l'endroit où se fera la sauvegarde. La cible peut être un répertoire local (par exemple, un périphérique monté localement comme un lecteur ZIP ou une clé USB), mais également une URL distante (par exemple, smb://hôte_distant/un_chemin) pour sauvegarder vos données sur un serveur central, etc.

Le programme a été conçu pour être facile à utiliser et est donc à la portée des non-initiés à l'informatique.

Le format de stockage est le très connu format TAR, où les données sont stockées compressées (bzip2 ou gzip).

L'implémentation actuelle ne propose que l'étape de sauvegarde. Pour restaurer vos données, vous devez utiliser, par exemple, konqueror pour ouvrir le fichier de sauvegarde TAR et glisser/déposer les fichiers dans votre système de fichier. C'est l'avantage de l'utilisation du format TAR.

## Utiliser &kbackup;

Tout ce que vous avez besoin de faire est de sélectionner les répertoires que vous souhaitez sauvegarder dans la vue en arborescence à gauche de la fenêtre principale.

Si vous sélectionnez un répertoire, &kbackup; enregistrera automatiquement tous les fichiers et sous-répertoires qu'il contient. Si vous souhaitez exclure certains fichiers ou sous-répertoires du répertoire sélectionné, désélectionnez tout simplement ces fichiers ou sous-répertoires à l'intérieur du répertoire sélectionné.

En général, cela signifie que le répertoire sélectionné sera sauvegardé avec tout son contenu, excepté les parties qui ont été désélectionnées. Cela signifie également que si vous réutilisez ultérieurement un profil (voir plus loin) et que de nouveaux fichiers ont été ajoutés au répertoire sélectionné pour la sauvegarde, tous les nouveaux fichiers seront également sauvegardés.

Voici une capture d'écran de &kbackup; Capture d'écran de la fenêtre principale

### Utiliser les profils

Pour conserver une sélection à des fins d'utilisation ultérieure, enregistrez-la tout simplement dans un fichier profil &kbackup;. Utilisez le menu Fichier et choisissez « Enregistrer un profil »

Pour recharger une sélection dans &kbackup;, utilisez l'entrée du menu Fichier « Charger un profil »

&kbackup; enregistre dans un fichier profil une sélection de tous les fichiers et répertoires inclus, les fichiers et répertoires exclus, le répertoire ou l'URL cible, le préfixe de l'archive et la taille maximum d'une tranche d'archive.

Si vous voulez vous faciliter la tâche pour sauvegarder tous les jours le même ensemble de fichiers, enregistrez votre configuration dans un fichier profil &kbackup; (un fichier d'extension .kbp) et passez-le sur la ligne de commande.

Par exemple :

kbackup mes_données.kbp

Astuce : vous pouvez également créer un raccourci sur votre bureau vers un fichier profil. Comme le type de fichier est enregistré, &kbackup; se lancera avec un double clic.

### Tranches d'archive

Comme la capacité d'un medium est généralement limitée (par exemple, 100 Mo pour un disque ZIP), &kbackup; créera, si nécessaire, plusieurs tranches d'archives.

Chaque tranche d'archive a son propre nom de la forme :

backup_2006.08.26-13.04.44_1.tar

Le nom contient la date et l'heure de création (qui sera le même pour toutes les tranches d'une sauvegarde) ainsi qu'un numéro de séquence à la fin (_1 dans cet exemple).

Dans le menu Fichier/Configuration du profil, vous pouvez définir un préfixe pour l'archive différent que la valeur par défaut « defaut »

Vous pouvez également définir la taille maximum d'une tranche d'archive. Cela permet donc de limiter la taille d'une tranche d'archive, même s'il reste de l'espace sur le périphérique cible. Cela permet de créer des tranches d'archive qui peuvent être ensuite gravées sur un CD ou un DVD. Si vous avez explicitement limité la taille d'une archive, la taille disponible sera marquée par une « * » dans la fenêtre principale.

### Compression de l'archive

&kbackup; compressera toujours les fichiers enregistrés (Excepté si vous avez explicitement désactiver ce comportement dans la configuration du profil. Il choisira la compression bzip2 ou gzip suivant leur disponibilité sur votre système.

Lorsque vous avez choisi de créer la sauvegarde sur un système de fichier local (par exemple, un disque supplémentaire, un lecteur ZIP, etc.) - ce qui signifie que vous n'avez pas entré une URL cible) - &kbackup; peut être amené à découper la sauvegarde en plusieurs tranches d'archive à cause de la limitation de la capacité du medium. &kbackup; compressera chaque fichier et les enregistrera tous avec une extension supplémentaire (.bzip2 or .gz) dans l'archive TAR non compressée.

Par exemple : backup_2006.08.26-13.04.44_1.tar

Si vous avez choisi une URL cible, qui s'affichera comme un medium de taille illimitée, &kbackup; créera une seule archive contenant les fichiers non compressés mais en compressant l'archive TAR entière en dernière étape.

Vous obtiendrez donc un fichier archive avec l'extension .tar.bzip2 ou .tar.gz

Par exemple : backup_2006.08.26-13.04.44_1.tar.bzip2

## Les entrées de menu

### La fenêtre principale de &kbackup;

#### Le menu Fichier

Fichier Nouveau profil

- Efface la sélection et la cible pour démarrer un nouveau profil.

Fichier Charger un profil

- Charge un profil

Fichier Enregistrer un profil

- Enregistre la configuration dans un profil

Fichier Configuration du profil

- Dans la configuration, vous pouvez définir si le nom de l'archive est préfixé par la valeur par défaut « backup » ou bien fournir un autre préfixe. Vous pouvez également limiter la taille d'une tranche d'archive. Voir le chapitre « Tranches d'archive » Cette configuration est également enregistrée dans le profil.

&Ctrl;Q Fichier Quitter

- Quitte &kbackup;

#### Le menu Configuration

Configuration Ancrer dans la zone de notification

- Si cette option est cochée, une icône est présente dans la zone de notification et elle reflète l'état actuel de &kbackup;. Si une sauvegarde est en cours, vous voyez une animation, sinon vous voyez une icône statique. Lorsque cette option est active, la fermeture de la fenêtre principale n'entraine pas l'arrêt de &kbackup;. L'application doit être explicitement arrêtée par l'intermédiaire de l'action « Quitter ». En utilisant le menu contextuel de l'icône de &kbackup; dans la zone de notification, vous pouvez lancer ou annuler une sauvegarde, de la même manière que vous le feriez dans la fenêtre principale. L'infobulle de cette icône fournit également lesinformations de progression de la sauvegarde (nombre de fichiers sauvegardés, taille de la sauvegarde et dernier fichier sauvegardé).

#### Le menu Aide

&help.menu.documentation;

## Guide du développeur &kbackup;

&kbackup; peut être étendu par l'utilisation d'un script shell (ou tout autre exécutable) qui sera lancé à trois moments différents du processus de sauvegarde. L'idée est de permettre de monter, démonter et éjecter un medium de manière spécifique au système, ou de faire autre chose avec les fichiers archives produits.

Le script à exécuter doit être fourni comme paramètre de l'option --script de la ligne de commande.

Voici un exemple de script

### sliceScript.sh

    #!/bin/sh

    mode=$1
    archive=$2
    target=$3
    mountPoint=$4

    case "$mode" in
     "slice_init" )
        if [ "$mountPoint" != "" ]
        then
          mount /media/zip
          rm -f /media/zip/backup_2*.tar*
        fi
     ;;

     "slice_closed" )
     ;;

     "slice_finished" )
        if [ "$mountPoint" != "" ]
        then
          umount /media/zip
          eject /media/zip
        fi
     ;;
    esac

Ce script est toujours invoqué avec quatre arguments :

- mode d'invocation

- archive (slice) file name

- répertoire ou URL cible

- point de montage du répertoire cible si ce n'est pas un répertoire local, ou bien une chaîne vide

Les trois modes d'invocation possible sont :

- slice_init

  appelé avant qu'une nouvelle tranche d'archive ne soit créée sur le disque

- slice_closed

  appelé après qu'une tranche d'archive ait été créée, mais avant qu'elle ne soit déposée dans le répertoire cible

  Cela peut être utilisé si vous souhaitez créer une copie de la tranche d'archive dans un autre endroit, par exemple l'archive est envoyée sur le serveur principal (à travers une URL cible), mais vous souhaitez également conserver la dernière sauvegarde sur le disque local.

- slice_finished

  appelé après qu'une tranche d'archive ait été correctement transférée sur le répertoire cible

Un autre exemple pour vous montrer comment limiter le nombre de fichiers d'archive sur la cible :

### rotateScript.sh

    #!/bin/sh
    # kbackup script to do a rotating backup (keep only a defined number of backups)
    # script kbackup pour effectuer des sauvegardes circulaires
    # (conserver uniquement un nombre défini de sauvegardes)

    NUM_BACKUPS=20

    mode=$1
    archive=$2
    target=$3
    mountPoint=$4

    case "$mode" in
     "slice_init" )
     ;;

     "slice_closed" )
     ;;

     "slice_finished" )
       count=`ls -A1 $target | wc -l`
       if [ $count -ge $NUM_BACKUPS ]
       then
         removeCount=`expr $count - $NUM_BACKUPS`
         oldest=`ls -A1 ${target}/* | sort | head -n $removeCount`
         rm -f ${oldest}
       fi
     ;;
    esac

## Questions et réponses

&reporting.bugs; &updating.documentation;

## Remerciements et licence

&kbackup;

Programme protégé par copyright © 2006, 2007 par Martin Koller m.koller@surfeu.at

Documentation protégée par copyright © 2006, 2007 Martin Koller

Traduction française par Alain Portal aportal@univ-montp2.fr

&underFDL; &underGPL;

## Installation

### Comment obtenir &kbackup;

Vous pouvez télécharger &kbackup; sur http:\\www.kde-apps.org

### Compilation et installation

&install.compile.documentation;
&documentation.index;