ikiwiki - En ligne dans le Cloud

PROGRAMME:

Nom

ikiwiki - un compilateur de wiki

SYNOPSIS

ikiwiki [options] source destination

ikiwiki --setup fichier d'installation [options]

DESCRIPTION

ikiwiki est un compilateur de wiki. Il construit des pages HTML statiques pour un wiki, à partir de la source dans le
langage ikiwiki/Markdown (ou autres), et l'écrit vers la destination.

Notez que la plupart des options peuvent être raccourcies en lettres simples, des drapeaux booléens tels que --verbose
peut être annulé avec --no-verbose, et des options telles que --verbose peuvent également être orthographiées comme
-verbeux.

MODE OPTIONS

Ces options contrôlent le mode dans lequel ikiwiki fonctionne.

--rafraîchir
Actualisez le wiki, en mettant à jour toutes les pages modifiées. C'est le comportement par défaut si non
une autre action de mode est spécifiée (mais notez que --setup est une action de mode et a
comportement par défaut différent).

--reconstruire
Forcer une reconstruction de toutes les pages.

--setup fichier d'installation
Charge les options à partir du fichier d'installation donné. Si aucune autre action de mode n'est spécifiée,
générer des wrappers et reconstruire le wiki, comme si --rebuild --wrappers était utilisé. Si
vous voulez seulement créer des pages modifiées, vous pouvez utiliser --refresh avec --setup.

--changesetup fichier d'installation
Lit le fichier d'installation, ajoute les modifications de configuration spécifiées par d'autres options,
et réécrit la nouvelle configuration dans le fichier de configuration. Met également à jour tout
wrappers configurés. Dans ce mode, le wiki n'est pas entièrement reconstruit, à moins que vous ne
ajouter --rebuild.

Exemple, pour activer certains plugins :

ikiwiki --changesetup ~/ikiwiki.setup --plugin goodstuff --plugin calendrier

--dumpsetup fichier d'installation
Oblige ikiwiki à écrire dans le fichier de configuration spécifié, en vidant son
configuration.

--emballages
S'il est utilisé avec --setup --refresh, cela permet également de mettre à jour tous les wrappers configurés.

--nettoyer
Cela permet à ikiwiki de nettoyer en supprimant tous les fichiers qu'il a générés dans la destination
répertoire, ainsi que tous les wrappers configurés, et le répertoire d'état .ikiwiki.
Ceci est surtout utile si vous exécutez ikiwiki dans un Makefile pour construire
documentation et voulez une cible propre correspondante.

--cgi Active le mode CGI. En mode cgi, ikiwiki s'exécute comme un script cgi et prend en charge l'édition
pages, la connexion et l'enregistrement.

Pour utiliser ikiwiki en tant que programme CGI, vous devez utiliser --wrapper ou --setup pour générer un
emballage. Le wrapper devra généralement exécuter le suid 6755 à l'utilisateur qui possède le
répertoires source et destination.

--wrapper [fichier]
Générer un binaire wrapper codé en dur pour effectuer l'action spécifiée par l'autre
options, en utilisant les fichiers d'entrée et le répertoire de destination spécifiés. Le nom de fichier à
l'utilisation pour le wrapper est facultative.

L'emballage est conçu pour être sécurisé en toute sécurité et être exécuté par des utilisateurs non fiables, en tant que
hook post-commit, ou en tant que CGI.

Notez que le wrapper généré ignorera tous les paramètres de ligne de commande.

--agrégat
Si le plugin plugins/aggregate est activé, cela rend le sondage ikiwiki configuré
flux et enregistrer les nouveaux messages dans le srcdir.

Notez que pour reconstruire les publications précédemment agrégées, utilisez l'option --rebuild avec
avec celui-ci. --rebuild forcera également les flux à être interrogés même s'ils étaient
interrogé récemment.

--render fichier
Restitue un seul fichier, produisant le code HTML résultant. N'enregistre pas l'état, donc ceci
ne peut pas être utilisé pour construire des wikis entiers, mais il est utile pour prévisualiser un
fichier sur la ligne de commande. Généralement utilisé en conjonction avec --setup pour charger dans un
configuration du wiki :

ikiwiki --configuration ~/ikiwiki.setup --render foo.mdwn

--post-commit
Exécuter en mode post-commit, le même que s'il était appelé par un hook post-commit. C'est
probablement uniquement utile lors de l'utilisation d'ikiwiki avec un serveur Web sur un hôte et un
référentiel sur un autre, pour permettre au véritable hook post-commit du référentiel de ssh vers
l'hôte du serveur Web et exécutez manuellement ikiwiki pour mettre à jour le site Web.

--version
Imprimer le numéro de version d'ikiwiki.

CONFIG OPTIONS

Ces options configurent le wiki. Notez que les plugins peuvent ajouter une configuration supplémentaire
options qui leur sont propres. Toutes ces options et bien d'autres peuvent également être configurées à l'aide d'un
fichier d'installation.

--nom du wiki
Le nom du wiki, la valeur par défaut est "wiki".

--templateir dir
Spécifiez le répertoire dans lequel les modèles sont stockés. La valeur par défaut est
/usr/share/ikiwiki/templates, ou un autre emplacement tel que configuré au moment de la construction. Si
le templatedir est modifié, les modèles manquants seront toujours recherchés dans le
emplacement par défaut comme solution de secours. Les modèles peuvent également être placés dans les "modèles/"
sous-répertoire du srcdir.

Notez que si vous choisissez de copier et de modifier les modèles d'ikiwiki, vous devrez être
veillez à les tenir à jour lors de la mise à niveau vers de nouvelles versions d'ikiwiki. Vieille
les versions des modèles ne fonctionnent pas toujours avec les nouvelles versions d'ikiwiki.

--underlaydir répertoire
Spécifiez le répertoire utilisé pour sous-tendre le répertoire source. Fichiers source
sera extrait d'ici à moins qu'il ne soit remplacé par un fichier dans le répertoire source.
La valeur par défaut est /usr/share/ikiwiki/basewiki ou un autre emplacement tel que configuré lors de la construction
le temps.

--mode wrapper
Spécifiez un mode pour modifier le wrapper après l'avoir créé.

--groupe d'emballage
Spécifiez à quel groupe Unix le wrapper doit appartenir. Cela peut être utile si le
wrapper doit appartenir à un groupe autre que celui par défaut. Par exemple, si un
le projet a un référentiel avec plusieurs commiters avec un accès contrôlé par un
groupe, il est logique que les enveloppes ikiwiki exécutent setgid pour ce groupe.

--rcs=svn|git|.., --no-rcs
Activer ou désactiver l'utilisation d'un revision_control_system.

Le répertoire source sera supposé être une copie de travail, ou un clone, ou autre
le système de contrôle de révision que vous sélectionnez utilise.

En mode CGI, avec un système de contrôle de révision activé, les pages éditées via le Web seront
être engagé.

Aucun contrôle de révision n'est activé par défaut.

--svnrepo /svn/wiki
Spécifiez l'emplacement du référentiel svn pour le wiki.

--svnpath tronc
Spécifiez le chemin à l'intérieur de votre référentiel svn où se trouve le wiki. Cette
par défaut le tronc ; changez-le si votre wiki est sur un autre chemin à l'intérieur du
dépôt. Si votre wiki est enraciné en haut du référentiel, définissez svnpath sur "".

--rss, --norss
Si rss est défini, ikiwiki générera par défaut des flux RSS pour les pages qui inline un
blog.

--allowrss
Si allowrss est défini et que rss n'est pas défini, ikiwiki ne générera pas par défaut de RSS
feeds, mais la définition de rss=yes dans la directive inline peut remplacer cette valeur par défaut et
générer un flux.

--atome, --noatome
Si atom est défini, ikiwiki générera par défaut des flux Atom pour les pages en ligne
un blog.

--allowatome
Si allowatom est défini et que rss n'est pas défini, ikiwiki ne générera pas par défaut
Atom feeds, mais la définition de atom=yes dans la directive inline peut remplacer cette valeur par défaut
et générer un flux.

--URL de pingurl
Définissez-le sur l'URL d'un service XML-RPC pour envoyer un ping lorsqu'un flux RSS est mis à jour. Pour
exemple, pour envoyer un ping à Technorati, utilisez l'URL http://rpc.technorati.com/rpc/ping

Ce paramètre peut être spécifié plusieurs fois pour spécifier plus d'une URL à
ping.

--urlURL
Spécifie l'URL du wiki. Il s'agit d'un paramètre obligatoire en mode CGI.

--cgiurl http://example.org/ikiwiki.cgi
Spécifie l'URL du wrapper de script CGI ikiwiki. Obligatoire lors de la construction du
wiki pour les liens vers le script cgi à générer.

--URL de l'historique
Spécifie l'URL vers laquelle établir un lien pour la navigation dans l'historique des pages. Dans l'URL, "[[fichier]]" est
remplacé par le fichier à parcourir. Il est courant d'utiliser ViewVC pour cela.

--adminemail [email protected]
Spécifie l'adresse e-mail qu'ikiwiki doit utiliser pour envoyer des e-mails.

--diffurl URL
Spécifie l'URL vers laquelle établir un lien pour un diff des modifications apportées à une page. Dans l'URL,
"[[fichier]]" est remplacé par le fichier à parcourir, "[[r1]]" est l'ancienne révision du
page, et "[[r2]]" est la nouvelle révision. Il est courant d'utiliser ViewVC pour cela.

--exclure l'expression régulière
Spécifie une expression explicative des fichiers source à exclure du traitement. Peut être précisé
plusieurs fois à ajouter à la liste d'exclusion.

--include l'expression régulière
Spécifie une expression explicative des fichiers source, qui serait normalement exclue, mais que vous
souhaitez inclure dans le traitement. Peut être spécifié plusieurs fois à ajouter pour inclure
liste.

--adminuser nom
Spécifie un nom d'utilisateur d'un utilisateur (ou, si openid est activé, un openid) qui a le
pouvoirs d'un administrateur wiki. Permet actuellement de verrouiller n'importe quelle page et d'interdire les utilisateurs, comme
ainsi que les pouvoirs accordés par les plugins activés (tels que [[modérer
comments|plugins/moderatedcomments]] et plugins/websetup. Peut être précisé
plusieurs fois pour plusieurs administrateurs.

Pour un utilisateur openid, spécifiez l'URL complète de la connexion, y compris "http://".

--nom du plugin
Permet l'utilisation du plugin spécifié dans le wiki. Notez que les noms de plugins sont
sensible aux majuscules et minuscules.

--disable-plugin nom
Désactive l'utilisation d'un plugin. Par exemple "--disable-plugin htmlscrubber" pour supprimer
avec désinfection HTML.

--libdir répertoire
Fait en sorte qu'ikiwiki regarde d'abord dans le répertoire spécifié, avant les emplacements habituels
lors du chargement des fichiers de bibliothèque et des plugins. Par exemple, si vous définissez libdir sur
"/home/you/.ikiwiki/", vous pouvez installer un plugin foo.pm comme
"/home/vous/.ikiwiki/IkiWiki/Plugin/foo.pm".

--discussion, --pas de discussion
Active ou désactive l'ajout de liens « Discussion » à l'en-tête de chaque
page. Les liens sont activés par défaut.

--numbacklinks n
Contrôle le nombre de backlinks à afficher en bas d'une page. Excès
les backlinks seront cachés dans une fenêtre contextuelle. La valeur par défaut est 10. Réglez sur 0 pour désactiver cette
fonction.

--userdir sous-répertoire
Facultativement, permet aux liens vers les utilisateurs du wiki de créer des liens vers des pages à l'intérieur d'un
sous-répertoire du wiki. La valeur par défaut est de créer un lien vers les pages du répertoire de niveau supérieur
du wiki.

--htmlext html
Configure l'extension utilisée pour les fichiers html générés. La valeur par défaut est "html".

--format d'heure
Spécifiez comment afficher l'heure ou la date. La chaîne de format est transmise au
strftime(3) fonction.

--verbeux, --non-verbeux
Soyez prolixe sur ce qui est fait.

--syslog, --no-syslog
Se connecter à syslog (3).

--usedirs, --no-usedirs
Basculez vers la création de fichiers de sortie nommés page/index.html (par défaut) au lieu de page.html.

--prefix-directives, --no-prefix-directives
Basculez la nouvelle syntaxe avec le préfixe '!' pour les directives du préprocesseur. ikiwiki actuellement
par défaut --prefix-directives.

--w3mmode, --no-w3mmode
Activez w3mmode, qui permet à w3m d'utiliser ikiwiki en tant que script CGI local, sans
serveur Web.

--sslcookie
N'envoyez des cookies que via une connexion SSL. Cela devrait les empêcher d'être
intercepté. Si vous activez cette option, vous devez exécuter au moins la partie CGI
d'ikiwiki sur SSL.

--gettime, --no-gettime
Extraire les temps de création et de modification pour chaque nouvelle page de la révision
journal de contrôle. Cela se fait automatiquement lors de la création d'un wiki pour la première fois,
vous n'avez donc normalement pas besoin d'utiliser cette option.

--set var=valeur
Cela permet de définir une variable de configuration arbitraire, comme si elle était définie
via un fichier d'installation. Étant donné que les options les plus couramment utilisées peuvent être configurées à l'aide de
commutateurs de ligne de commande, vous aurez rarement besoin de l'utiliser.

--set-yaml var=valeur
C'est comme --set, mais cela permet de définir des variables de configuration qui utilisent des
structures de données, en passant un document YAML.

EXEMPLES

ikiwiki --setup mon.setup

Complètement (re)construisez le wiki en utilisant le fichier d'installation spécifié.

ikiwiki --setup mon.setup --refresh
Actualisez le wiki, en utilisant les paramètres de my.setup, et évitez de reconstruire les pages qui
n'ont pas changé. C'est plus rapide.

ikiwiki --setup mon.setup --refresh --wrappers
Actualiser le wiki, y compris régénérer tous les programmes wrapper, mais ne pas reconstruire
toutes les pages. Utile si vous avez modifié quelque chose dans le fichier d'installation qui ne
besoin d'une reconstruction complète du wiki pour mettre à jour toutes les pages, mais que vous voulez prendre immédiatement
effet.

ikiwiki --rebuild srcdir destdir
Utilisez srcdir comme source et construisez du HTML dans destdir, sans utiliser de fichier d'installation.

ikiwiki srcdir destdir
Utilisez srcdir comme source pour mettre à jour le code HTML des pages modifiées dans destdir, sans utiliser de
fichier d'installation.

ENVIRONNEMENT

CC

Cela contrôle quel compilateur C est utilisé pour construire des wrappers. La valeur par défaut est « cc ».

CFLAGS Ceci peut être utilisé pour passer des options au compilateur C lors de la construction de wrappers.

Utiliser ikiwiki en ligne en utilisant les services onworks.net