Table des matières
Outils en ligne de commande
DokuWiki fournit quelques scripts PHP pouvant être exécutés depuis une ligne de commance (UNIX). Tous ces scripts sont situés dans le répertoire <VotreDokuWiki>/bin/
.
Note : Pour pouvoir lancer ces scripts, l'interpréteur PHP en ligne de commande (CLI) doit être installé sur votre système.
Attention : si on a déplacé les répertoires hors de docroot ces scripts ne fonctionneront sans doute pas tels quels.
Il y a deux manières de lancer les scripts :
- Vous pouvez les rendre exécutables :
$> chmod +x <script>.php $> ./<script>.php
- ou les lancer comme ci-dessous (recommandé) :
$> /path/to/php <script>.php
dwpage.php
Note : Il y a eu des problèmes rapportés avec certains plugins qui s'appuient sur les ACL et l'authentification ou le système d'événements de DokuWiki.
Usage: dwpage.php [opts] <action> Utility to help command line DokuWiki page editing, allow pages to be checked out for editing then committed after changes Normal operation would be; ACTIONS checkout: see $ dwpage.php --help=checkout commit: see $ dwpage.php --help=commit lock: see $ dwpage.php --help=lock OPTIONS -h, --help=<action>: get help e.g. $ ./dwpage.php -hcommit e.g. $ ./dwpage.php --help=commit
indexer.php
Permet de mettre à jour l'index de recherche.
Usage: indexer.php <options> Updates the searchindex by indexing all new or changed pages when the -c option is given the index is cleared first. OPTIONS -h, --help show this help and exit -c, --clear clear the index before updating -q, --quiet don't produce any output
LE script doit être lancé avec l'utilisateur approprié et éventuellement le bon répertoire pour fonctionner, comme www-data dans ~www-data sous debian. Par exemple, si votre wiki est dans /var/www/wiki :
sudo -u www-data /var/www/wiki/bin/indexer.php
Si vous constatez des erreurs, veuillez d'abord vérifier que vous appelez le script avec le chemin /bin et non avec /lib/exe.
Lorsque vous travaillez avec une ferme de wikis, vous pouvez définir la variable animal à l'appel du script. Veuillez noter qu'il s'agit d'une ligne de commande unique.
wantedpages.php
Liste les pages demandées.
Usage: wantedpages.php [wiki:namespace] Outputs a list of wanted pages (pages which have internal links but do not yet exist). If the optional [wiki:namespace] is not provided, defaults to the root wiki namespace OPTIONS -h, --help get help
striplangs.php
Permet de supprimer toutes les fichiers de langue non désirés d'une installation.
Usage: striplangs.php [-h [-x]] [-e] [-k lang1[,lang2]..[,langN]] Removes all languages from the installation, except the ones after the -k option. English language is never removed! OPTIONS -h, --help get this help -x, --examples get also usage examples -k, --keep comma separated list of languages, -e is always implied -e, --english keeps english, dummy to use without -k
gittool.php
Permet de maintenir DokuWiki et les extensions installés via le dépôt Github de DokuWiki.
Usage: gittool.php <command> [parameters] Manage git repositories for DokuWiki and its plugins and templates. EXAMPLE $> ./bin/gittool.php clone gallery template:ach $> ./bin/gittool.php repos $> ./bin/gittool.php origin -v COMMANDS help This help screen clone <extensions> Tries to install a known plugin or template (prefix with template:) via git. Uses the DokuWiki.org plugin repository to find the proper git repository. Multiple extensions can be given as parameters install <extensions> The same as clone, but when no git source repository can be found, the extension is installed via download repos Lists all git repositories found in this DokuWiki installation <any> Any unknown commands are assumed to be arguments to git and will be executed in all repositories found within this DokuWiki installation
plugin.php
Cet outil donne accès à toutes les extensions CLI. Appeler le sans arguments pour obtenir une liste des extensions installées :
./bin/plugin.php
Appeler l'aide en ligne de l'outil pour en savoir plus :
./bin/plugin.php <pluginname> -h