releasing version 1.1.1
[auf-refer.git] / auf-refer.8
1 .TH AUF-REFER 8 "25 juin 2009"
2 .\"
3 .\" Some roff macros, for reference:
4 .\" .nh        disable hyphenation
5 .\" .hy        enable hyphenation
6 .\" .ad l      left justify
7 .\" .ad b      justify to both left and right margins
8 .\" .nf        disable filling
9 .\" .fi        enable filling
10 .\" .br        insert line break
11 .\" .sp <n>    insert n+1 empty lines
12 .\" for manpage-specific macros, see man(7)
13 .SH NAME
14 auf-refer \- outil de copie et mise à jour des réferentiels AuF
15 .SH SYNOPSIS
16 \fBauf-refer\fP [\fB-f\fP] \fB-a\fP \fIreferentiel\fP
17 .br
18 \fBauf-refer\fP \fB-r\fP | \fB-p\fP | \fB-c\fP \fIreferentiel\fP
19 .br
20 \fBauf-refer\fP \fB-h\fP | \fB-l\fP
21 .br
22 \fBauf-refer\fP [\fB-f\fP] \fB-u\fP | \fB-L\fP | \fB-A\fP
23 .SH DESCRIPTION
24 Cette page de manuel documente brièvement la commande \fBauf-refer\fP.
25 .PP
26 .SH OPTIONS
27 Ce programme suit la syntaxe habituelle d'une ligne de commande GNU,
28 avec des options longues commençant par deux tirets (`-').
29 .TP
30 .B \-h, \-\-help
31 Montre un résumé des options.
32 .TP
33 .B \-L, \-\-list-available
34 Liste les référentiels disponibles. Cette liste est obtenue depuis un référentiel spécial (par défaut \fBauf-refer.json\fP, voir plus bas). L'option \fB-f\fP permet de forcer le chargement à travers un proxy/cache.
35 .TP
36 .B \-A, \-\-add-available
37 Copie tous les référentiels disponibles. Il seront ensuite mis à jour, soit automatiquement à 7h et 13h (en heure locale), soit manuellement avec l'option \fB-u\fP. L'option \fB-f\fP permet de forcer le chargement à travers un proxy/cache.
38 .TP
39 .B \-a, \-\-add
40 Copie un nouveau référentiel. Il sera ensuite mis à jour, soit automatiquement à 7h et 13h (en heure locale), soit manuellement avec l'option \fB-u\fP. L'option \fB-f\fP permet de forcer le chargement à travers un proxy/cache.
41 .TP
42 .B \-l, \-\-list
43 Liste les référentiel copiés.
44 .TP
45 .B \-u, \-\-update
46 Met à jour les référentiels immédiatement. L'option \fB-f\fP permet de forcer le chargement à travers un proxy/cache.
47 .TP
48 .B \-r, \-\-remove
49 Supprime un référentiel.
50 .TP
51 .B \-p, \-\-path
52 Affiche le chemin d'accès au fichier d'un référentiel.
53 .TP
54 .B \-c, \-\-content
55 Affiche le contenu d'un référentiel.
56 .SH FILES
57 .TP
58 .B /etc/auf-refer/auf-refer.conf
59 Fichier de configuration de cet outil.
60 .br
61 On y trouve en particulier les options suivantes :
62 .TP
63 .B DIR_BASE
64 Répertoire de base pour l'enregistrement des copies des référentiels. Par défaut cette option est positionnée sur \fB/var/lib/auf-refer\fP.
65 .TP
66 .B URL_BASE
67 URL de base pour la source des copies des référentiels. Par défaut cette option est positionnée sur \fBhttp://intranet.auf/auf-refer\fP.
68 .TP
69 .B AVAILABLE_LIST
70 Nom du référentiel contenant la liste des référentiels disponibles. Par défaut cette option est positionnée sur \fBauf-refer.json\fP.
71 .SH AUTHOR
72 L'outil auf-refer a été écrit par Progfou <jean-christophe.andre@auf.org> pour l'Agence universitaire de la Francophonie.
73 .PP
74 Cette page de manuel a été écrite par Progfou <jean-christophe.andre@auf.org>,
75 pour le projet Debian (mais peut être utilisée par d'autres).