Documentation Wcal 2.1

Configurer Wcal

wcal.conf contient les données de configuration pour wcald, le démon de Wcal. Quelques paramètres ne sont configurables qu'en éditant des variables au début du code de wcald lui-même, mais la plupart des utilisateurs n'ont pas à y toucher. Wcal est livré avec un exemple de fichier de configuration qui liste tous les paramètres possibles et leurs valeurs par défaut avec un bref commentaire.

Si vous changez wcal.conf, il sera rechargé à la prochaine requête faite à wcald. Il est inutile de relancer ou d'envoyer un signal à wcald.

Si vous voulez placer wcal.conf ailleurs, vous devez changer la variable correspondante au début des fichiers index.c et wcald.

Format du fichier

Les lignes ne contenant rien ou seulement des espaces et les lignes commençant pas # sont ignorées. Toutes les autres lignes contiennent une définition de paramètre. Les espaces sont autorisés (mais non nécessaires) au début de la ligne et entre les mots-clés (mais pas au sein de mots-clés comportant plusieurs mots comme access file).

La plupart des définitions utilisent un format sur une seule ligne. Elle commence avec le nom du paramètre (qui peut être constitué de plusieurs mots), suivi du signe égal (=), le reste de la ligne constituant la valeur du paramètre. Les commentaires ne sont pas autorisé en fin de ligne.

Le fichier de configuration est implicitement disivé en deux sections : la section globale et la section de définition des utilisateurs. La section globale commence au début du fichier de configuration et se termine à la définition du premier utilisateur. La section globale contient aussi bien les paramètres généraux non liés aux utilisateurs que les paramètres par défaut pour les utilisateurs. Les paramètres spécifiés à l'intérieur de la définition d'un utilisateur n'affecte que l'utilisateur seul. Les paramètres qui peuvent être définis dans la section globale sont suivis d'un Global ci-dessous. Les paramètres qui peuvent être définis dans la section utilisateur sont suivis d'un Utilisateur ci-dessous.

La définition des utilisateurs et du fichier d'accès se fait sur plusieurs lignes. La définition d'un fichier d'accès definit le texte qui sera écrit par Wcal dans chaque répertoire utilisateur de Wcal (qui n'ont rien à voir avec les utilisateurs Unix) dans un fichier .htaccess. Ce mécanisme est défini par Apache. Apache lit le fichier .htaccess dans chaque répertoire qu'il accède, et le fichier doit contenir les directives définissant qui est autorisé à accéder au répertoire. La définition du fichier d'accès peut se faire dans la section globale ou dans la définition de l'utilisateur (voir le paragraphe suivant). La définition du fichier d'accès dans la section globale est la définition par défaut pour les utilisateurs qui ne possède pas de fichier d'accès spécifique. La définition du fichier d'accès débute avec une ligne contenant la chaine access file et se termine par la ligne end access file. Entre les deux, se trouvent les lignes formant le contenu du fichier d'accès. Un exemple de définition du fichier d'accès est donné dans le fichier d'exemple de configuration livré avec la distribution de Wcal.

La définition d'utilisateurs commence avec une ligne user = value, où value est un nom d'utilisateur alphanuméerique. Les espaces ne sont pas autorisés dans le nom de l'utilisateur. La définition d'utilisateurs se termine avec une ligne contenant seulement end user. Entre les deux, se trouvent les lignes contenant des définitions de paramètres sur une ligne et également une définition de fichier d'accès. Tous les paramètres dans la définition d'utilisateurs s'appliquent seulement à l'utilisateur courant. Si certains paramètres ne sont pas définis dans la définition d'utilisateurs (ce qui est le cas général), la valeur par défaut est utilisé.

Parametres configurables

access file name Global
Si vous utilisez Apache, vous pouvez conserver la valeur par défaut .htaccess. La valeur de ce paramètre est le nom du fichier d'accès qui sera écrit dans chaque répertoire utilisateur. Le contenu du fichier est donné dans la définition du fichier d'accès sur plusieurs lignes.

address Global

Adresse (adresse IP ou nom de domain) de la machine sur laquelle wcald tourne. La valeur par défaut est 127.0.0.1 c'est à dire localhost (la même machine où se trouve index.cgi). Généralement vous n'avez pas à changer ce paramètre.

base url Global

Il s'agit de l'URL sous laquelle vous avez installé Wcal. Par exemple si la racine HTML de votre serveur web est /home/httpd/html, et que vous avez installé Wcal sous le répertoire home/httpd/html/wcal, positionnez le paramètre à /wcal. La valeur par défaut est /wcal.

clock Global Utilisateur

You pouvez choisir d'afficher les heures au format 24 heures ou 12 heures. Les valeurs possibles sont:

data id Utilisateur

Ce paramètre permet de donner plusieurs noms pour un "utilisateur". Ceci est utile combiné avec le paramètre read only, puisqu'il vous permet de définir deux (ou plus) vues pour un agenda, une en lecture écriture et une autre en lecture seule. Voir Créer des agendas pour plus de détail.

database directory Global

Entrez le chemin absolu du répertoire où vous voulez que Wcal créé sa base de données. Wcal doit avoir le droit de créer ce répertoire (ou il doit déjà exister). La valeur par défaut est /var/wcal.

date format Global Utilisateur

La date est affiché dans différents formats suivant le pays. Wcal permet 5 formats différent pour afficher les dates. Ils sont numérotés de 1 à 5. La valeur par défaut est 1 qui est jour.mois.année. Les valeurs possibles sont :

  1. jour.mois.année
  2. mois/jour/année
  3. jour/mois/année
  4. année/mois/jour
  5. année-mois-jour
  6. YYYYMMDD where Y = année, M = mois and D = jour of mois

Si vous avez besoin d'autres formats, faites-en par à l'auteur.

first day Global

Ceci définit quel jour commence la semaine. Les valeurs permises sont monday (lundi) ou sunday (dimanche). La valeur par défaut est monday.

ATTENTION : Vous ne pouvez fixer ce paramètre qu'avant d'accéder aux agendas pour la première fois. Ce paramètre conditionne la structure de la base de données Wcal. C'est pour cela que vous ne pouvez pas changer sa valeur après avoir créé la base. J'écrivrai peut-être un script de conservion d'une base monday vers une base sunday et vice-versa.

long name Utilisateur

Si vous voulez une version plus détaillée du nom d'utilisateur, vous pouvez utiliser ce paramètre. La valeur de ce paramètre n'est utilisé que pour l'affichage.

organization Global

Tapez ici le nom de votre organisation ou toute autre chaine qui décrit l'instance de Wcal. Cette chaine apparait dans la page principale de Wcal.

password Global

Il s'agit d'une chaine pseudo-aléatoire. Vous devez la changer pour empêcher des accès non autorisés. index.cgi et wcald lisent tous les deux ce paramètre pour s'assurer que la requête ne provient pas d'un pirate. La valeur par défaut n'est pas pertinente.

port Global

Le port sur lequel wcald est en attente de requêtes et sur lequel se connecte index.cgi. Vous n'avez probablement pas besoin de changer ce paramètre.

read only Utilisateur

Les valeurs valides sont true et false. Si la valeur est true, l'utilisateur ne sera pas autorisé à modifier les données de l'agenda. Ce paramètre est utilisé en conjonction avec le paramètre data id. Voir Créer des agendas pour plus de détail.

remote cal Global

Agenda vérifié par checkalarm quand il est lancé sans argument. all signifie que checkalarm vérifiera tous les agendas. Voir Utiliser checkalarm pour plus de détail.

remote lang Global

Langue utilisé par Wcal. Seuls l'anglais (en), le français (fr) et l'allemand (de) sont disponibles pour l'instant. Les bonnes volontés sont les bienvenues pour les traductions. Voir /etc/wcald.msg.

remote mail Global Utilisateur

Adresse mail avertie par checkalarm quand il est lancé sans argument. Voir Utiliser checkalarm pour plus de détail.
show weekend Global
Permet d'afficher ou non les jours du weekend. Les valeurs possibles sont yes ou no. La valeur par défaut est yes.

ATTENTION : Quand ce paramètre est positionné à no, vous ne devez pas positionner le paramètre first day à sunday.


Retour à la page principale de Wcal