Content-type: text/html Manpage of CYRADM

CYRADM

Section: Contribution à la Documentation Perl Utilisateur (1p)
Updated: 2007-02-13
Index Return to Main Contents

NOM

cyradm - Shell d'administration de cyrus, équivalent à Cyrus::IMAP::Shell

SYNOPSIS

  $ cyradm [--user utilisateur] [--[no]rc] [--systemrc fichier] [--userrc fichier] \
  > [--port n] [--auth mecanisme] [--server] serveur

également possible

  $ perl -MCyrus::IMAP::Shell -e 'run("monscript")'

ou même (mais pas recommandé)

  use IMAP::Admin::Shell;

  run('nomdemonscript');

DESCRIPTION

Ce module implémente cyradm en Perl. C'est un shell autour de Cyrus::IMAP::Admin. Les commandes sont fournies sous 2 formes, Tcl-compatible et GNU-style options longues.

COMMANDES

authenticate [--minssf N] [--maxssf N] [--mechanisms liste] [utilisateur]

auth [--minssf N] [--maxssf N] [--mechanisms liste] [utilisateur]

login [--minssf N] [--maxssf N] [--mechanisms liste] [utilisateur]

Authentification vers le serveur. Vous devez déjà être connecté à un serveur et le démon imapd Cyrus refusera de vous ré-authentifier dès lors que vous aurez été authentifié une première fois.

chdir répertoire

cd répertoire

Change de répertoire. Un "pwd" incorporé n'est pas fourni, mais par défaut la commande exécute un "pwd" dans un shell lorsqu'elle est appelée.

createmailbox [--partition partition] boiteauxlettres

createmailbox boiteauxlettres partition

create [--partition partition] boiteauxlettres

create boiteauxlettres partition

cm [--partition partition] boiteauxlettres

cm boiteauxlettres partition

Crée une boîte aux lettres à partir de l'emplacement par défaut ou à partir de la partition spécifiée. L'utilisation de old-style et getopt-style est acceptée (Le fait de les utiliser ensemble produira une erreur).

deleteaclmailbox boiteauxlettres id [...]

deleteacl boiteauxlettres id [...]

dam boiteauxlettres id [...]

Supprime les droits d'accès ou ACLs de la boîte aux lettres spécifiée en argument.

deletemailbox boiteauxlettres

delete boiteauxlettres

dm boiteauxlettres

Supprime la boîte aux lettres passée en argument.

Les administrateurs n'ont pas de droits de suppression implicites sur les boîtes aux lettres. Utilisez la commande setaclmailbox pour obtenir le droit "c" (ou n'importe quel autre droit de suppression précisé dans la configuration du fichier in imapd.conf), ce qui vous permettra de supprimer une boîte aux lettres qui ne vous appartient pas.

Notez que l'aide en ligne fait état d'un argument optionel nommé hôte. Cet argument n'est pas couramment utilisé, et génèrera une erreur si vous l'utilisez ; il est réservé pour IMSP.

disconnect

disc

Déconnexion du serveur courant. L'invite de commande reviendra à "cyradm>".

exit [nombre]

quit [nombre]

Quitte cyradm, il est possible de passer un statut de sortie spécifique en option ; le statut de sortie de la dernière commande sera utilisée si aucun autre n'est précisé.

help [commande]

? [commande]

Affiche l'aide pour la "commande" ou pour toutes les commandes.

info [boiteauxlettres]

Affiche les méta-données de la boîte aux lettres/du serveur.

listaclmailbox boiteauxlettres

listacl boiteauxlettres

lam boiteauxlettres

Affiche les listes d'accès ou ACL de la boîte aux lettres passée en argument.

listmailbox [--subscribed] [modèle [référence]]

list [--subscribed] [modèle [référence]]

lm [--subscribed] [modèle [référence]]

Liste toutes les boîtes aux lettres, ou toutes les boîtes aux lettres souscrites, correspondant au modèle spécifié. Le modèle peut contenir les caractères '*' or '%', qui correspondent respectivement à n'importe quels caractères et à n'importe quels caractères excepté le caractère de séparation.

Le résultat correspondra à un affichage relatif par rapport à la référence passée en argument, si celle-ci est précisée. Ceci fait qu'une liste de boîtes à lettres est limitée à une certaine hierarchie.

Dans certains cas, lorsque le caractère '%' est utilisé à la fin d'un modèle, il peut correspondre à une entrée qui n'est pas une boîte aux lettres mais qui contient d'autres boîtes aux lettres. Dans ce cas, l'entrée sera mise entre parenthèses afin d'indiquer qu'elle est l'entrée pour d'autres boîtes aux lettres, en opposition à une boîte aux lettres elle-même.

listquota racine

lq racine

Affiche les quotas d'une racine spécifique. Si la boîte aux lettres spécifiée n'a pas de quota assigné, une erreur sera renvoyée ; voir listquotaroot pour déterminer le quota racine d'une boîte aux lettres.

listquotaroot boiteauxlettres

lqm boiteauxlettres

lqr boiteauxlettres?

Montre le quota des racines et les quotas des boîtes aux lettres.

renamemailbox [--partition partition] anciennom nouveaunom

rename [--partition partition] anciennom nouveaunom

renm [--partition partition] anciennom nouveaunom

renamemailbox anciennom nouveaunom [partition]

rename anciennom nouveaunom [partition]

renm anciennom nouveaunom [partition]

Renomme la boîte aux lettres spécifiée. Peut optionnellement la déplacer vers une partition différente. L'utilisation des styles old-style ou getopt-style est acceptée ; mais la combinaison des deux produira une erreur.

server [--noauthenticate] [serveur]

connect [--noauthenticate] [serveur]

servername [--noauthenticate] [serveur]

Sans argument, montre le serveur courant. Avec argument, se connecte au serveur. Cela entraînera une demande d'authentification à moins que l'option "--noauthenticate" ne soit précisée. (Cela peut être modifié ; en particulier si l'authentification automatique est enlevée ou si toutes les options "authenticate" sont ajoutées.)

À la connexion à un serveur, l'invite de commande cyradm passe de "cyradm>" à "nomduserveur>", où nomduserveur est le nom de domaine qualifié du serveur connecté.

setaclmailbox boiteauxlettres id droits [id droits ...]

setacl boiteauxlettres id droits [id droits ...]

sam boiteauxlettres id droits [id droits ...]

Positionne les ACL d'une boîte aux lettres. Les ACLs peuvent prendre une des valeurs suivantes "none", "read" ("lrs"), "post" ("lrsp"), "append" ("lrsip"), "write" ("lrswipcd"), ou "all" ("lrswipcda"), ou n'importe quelle combinaison faite à partir des codes ACL suivants :

l: Liste les messages (donne accès à LIST/LSUB/UNSEEN)
r: Lit les messages (SELECT, CHECK, FETCH, PARTIAL, SEARCH, COPY source)
s: Marque les messages comme lus (STORE \SEEN)
w: Écrit, correspond aux drapeaux autres que \SEEN et \DELETED
i: Insère (APPEND, COPY destination)
p: Envoie (envoie un mail vers une boîte aux lettres)
c: Création et suppression de boîte aux lettres (CREATE nouvelles sous-boîtes, RENAME ou DELETE boîte aux lettres)
d: Supprime (STORE \DELETED, EXPUNGE)
a: Administre (SETACL)

setquota chemin ressource valeur [ressource valeur ...]

sq chemin ressource valeur [ressource valeur ...]

Positionne un quota pour un chemin spécifique, qui peut ou non être une boîte aux lettres. La seule ressource comprise par Cyrus est "STORAGE". La valeur peut être la chaîne spécifique "none" qui supprime le quota.

version

ver

Affiche la version du serveur courant.

NOTES

Les options longues GNU-style doivent être données dans leur totalité ; les options Tcl-style peuvent être abrégées.

Les options Tcl-style sont fournies dans un souci de compatibilité. Elles disparaîtront probablement prochainement.

Plusieurs commandes peuvent être mises sur une même ligne, séparées par le caractère ';'.

Toutes les commandes renvoient un statut de fin d'exécution qui n'est actuellement pas utilisé.

Les commandes inconnues sont passées à un sous-shell pour exécution.

La version Tcl de cyradm est utilisée pourl'interactivité dans les scripts. Tant qu'il est possible de limiter son étendue par l'utilisation de la méthode "run", le script sera normalement fait avec "Cyrus::IMAP::Admin", qui est plus rapide et plus flexible que "cyradm" ou le mécanisme de script Tcl pour Cyrus.

cyradm comprend les redirections du style /bin/sh: chaque commande peut avoir son propre standard ou rediriger son erreur de sortie, avec toutes les redirections de type sh (exception faite de "<>") supportées. Il ne comprend pas les pipes ni les mises en tâche de fond.

Si les modules "Term::Readline::Perl" ou "Term::Readline::GNU" sont accessibles, cyradm les utilisera.

Une fonction alias est implémentée de façon interne, mais aucun accès ne lui est fourni. Cela va changer, des alias prédéfinis pourront être supprimés s'ils entrent en conflit avec des commandes shell utilisées.

AUTEUR

Brandon S. Allbery, allbery@ece.cmu.edu

VOIR AUSSI

Cyrus::IMAP::Admin Term::ReadLine sh(1), perl(1), imapd(8).

TRADUCTION

Jérôme Perzyna (décembre 2007)

AVERTISSEMENT SUR LA TRADUCTION

Il est possible que cette traduction soit imparfaite ou périmée. En cas de doute, veuillez vous reporter au document original en langue anglaise fourni avec le programme.

This document was created by man2html, using the manual pages.
Time: 09:16:57 GMT, December 07, 2007