ikiwiki - Online in de cloud

PROGRAMMA:

NAAM

ikiwiki - een wiki-compiler

KORTE INHOUD

ikiwiki [opties] bronbestemming

ikiwiki --setup setupfile [opties]

PRODUCTBESCHRIJVING

ikiwiki is een wiki-compiler. Het bouwt statische HTML-pagina's voor een wiki, vanaf de bron in de
ikiwiki/Markdown-taal (of andere), en schrijft het naar de bestemming.

Merk op dat de meeste opties kunnen worden ingekort tot enkele letters, booleaanse vlaggen zoals --verbose
kan worden ontkend met --no-verbose, en opties zoals --verbose kunnen ook worden gespeld als
- uitgebreid.

MODE OPTIES

Deze opties regelen de modus waarin ikiwiki werkt.

--vernieuwen
Vernieuw de wiki en werk alle gewijzigde pagina's bij. Dit is het standaardgedrag als nee
andere modusactie is gespecificeerd (maar merk op dat --setup een modusactie is, en heeft
ander standaardgedrag).

--herbouwen
Forceer een herbouw van alle pagina's.

--setup setupbestand
Laad opties uit het opgegeven installatiebestand. Als er geen andere modusactie is opgegeven,
genereer wrappers en herbouw de wiki, alsof --rebuild --wrappers werden gebruikt. Als
u alleen gewijzigde pagina's wilt bouwen, kunt u --refresh gebruiken met --setup.

--changesetup installatiebestand
Leest het installatiebestand, voegt eventuele configuratiewijzigingen toe die door andere opties zijn gespecificeerd,
en schrijft de nieuwe configuratie terug naar het installatiebestand. Werkt ook eventuele bij
geconfigureerde wikkels. In deze modus wordt de wiki niet volledig herbouwd, tenzij u ook
toevoegen --herbouwen.

Voorbeeld, om sommige plug-ins in te schakelen:

ikiwiki --changesetup ~/ikiwiki.setup --plugin goederen --plugin kalender

--dumpsetup installatiebestand
Zorgt ervoor dat ikiwiki naar het gespecificeerde setup-bestand schrijft, waarbij de huidige wordt gedumpt
configuratie.

--wikkels
Indien gebruikt met --setup --refresh, zorgt dit ervoor dat alle geconfigureerde wrappers worden bijgewerkt.

--schoon
Dit zorgt ervoor dat ikiwiki wordt opgeschoond door alle bestanden te verwijderen die het op de bestemming heeft gegenereerd
directory, evenals alle geconfigureerde wrappers en de .ikiwiki-statusdirectory.
Dit is vooral handig als je ikiwiki draait in een Makefile om te bouwen
documentatie en een bijbehorend schoon doel willen.

--cgi CGI-modus inschakelen. In cgi-modus draait ikiwiki als een cgi-script en ondersteunt bewerking
pagina's, inloggen en registratie.

Om ikiwiki als een CGI-programma te gebruiken, moet je --wrapper of --setup gebruiken om een
wikkel. De wrapper zal over het algemeen suid 6755 moeten uitvoeren naar de gebruiker die eigenaar is van het
bron- en bestemmingsdirectories.

--wrapper [bestand]
Genereer een wrapper-binair bestand dat hard is gecodeerd om de door de ander gespecificeerde actie uit te voeren
opties, met behulp van de opgegeven invoerbestanden en doelmap. De bestandsnaam naar
gebruik voor de wikkel is optioneel.

De wrapper is ontworpen om veilig suid te worden gemaakt en te worden beheerd door niet-vertrouwde gebruikers, zoals een
post-commit hook, of als een CGI.

Merk op dat de gegenereerde wrapper alle opdrachtregelparameters zal negeren.

--aggregaat
Als de plug-ins/aggregate-plug-in is ingeschakeld, wordt de ikiwiki-poll geconfigureerd
feeds en sla nieuwe berichten op in de srcdir.

Merk op dat om eerder geaggregeerde berichten opnieuw te bouwen, gebruik de --rebuild optie mee
met deze. --rebuild zal ook feeds dwingen om te pollen, zelfs als dat zo was
onlangs ondervraagd.

--render bestand
Rendert een enkel bestand en voert de resulterende html uit. Slaat de staat niet op, dus dit
kan niet worden gebruikt voor het bouwen van hele wiki's, maar het is handig voor het bekijken van een bewerkt
bestand op de opdrachtregel. Over het algemeen gebruikt in combinatie met --setup om te laden in een
wiki-instellingen:

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

--post-commit
Draai in post-commit mode, hetzelfde als aangeroepen door een post-commit hook. Dit is
waarschijnlijk alleen nuttig bij gebruik van ikiwiki met een webserver op één host en een
repository op een andere, zodat de echte post-commit hook van de repository naar ssh kan
de webserver host en voert ikiwiki handmatig uit om de website bij te werken.

--versie
Druk het versienummer van ikiwiki af.

CONFIG OPTIES

Deze opties configureren de wiki. Merk op dat plug-ins extra configuratie kunnen toevoegen
eigen opties. Al deze opties en meer kunnen ook worden geconfigureerd met behulp van een
setup-bestand.

--wikinaam naam
De naam van de wiki, standaard is "wiki".

--templateir dir
Specificeer de map waarin sjablonen worden opgeslagen. Standaard is
/usr/share/ikiwiki/templates, of een andere locatie zoals geconfigureerd tijdens het bouwen. Als
de templatedir is gewijzigd, er wordt nog steeds gezocht naar ontbrekende templates in de
standaardlocatie als terugval. Sjablonen kunnen ook in de "templates/" worden geplaatst
submap van de srcdir.

Merk op dat als u ervoor kiest om de sjablonen van ikiwiki te kopiëren en aan te passen, u dit moet doen
zorg ervoor dat u ze up-to-date houdt bij het upgraden naar nieuwe versies van ikiwiki. Oud
versies van sjablonen werken niet altijd met nieuwe ikiwiki-versies.

--underlaydir richt
Geef de map op die wordt gebruikt om de bronmap te ondersteunen. Bronbestanden
wordt vanaf hier overgenomen, tenzij overschreven door een bestand in de bronmap.
Standaard is /usr/share/ikiwiki/basewiki of een andere locatie zoals geconfigureerd bij het bouwen
tijd.

--wrappermode-modus
Geef een modus op waarnaar de wrapper moet worden gechmod nadat deze is gemaakt.

--wrappergroep groep
Geef op van welke Unix-groep de wrapper het eigendom moet zijn. Dit kan handig zijn als de
wrapper moet eigendom zijn van een andere groep dan de standaardgroep. Als bijvoorbeeld een
project heeft een repository met meerdere committers met toegang gecontroleerd door een
groep, is het logisch dat de ikiwiki-wrappers setgid naar die groep uitvoeren.

--rcs=svn|git|.., --no-rcs
Schakel het gebruik van een revision_control_system in of uit.

Er wordt aangenomen dat de bronmap een werkkopie is, of een kloon, of wat dan ook
het door u geselecteerde revisiecontrolesysteem gebruikt.

In CGI-modus, met ingeschakeld revisiecontrolesysteem, zullen pagina's die via het web zijn bewerkt, dat ook doen
toegewijd zijn.

Er is standaard geen revisiebeheer ingeschakeld.

--svnrepo /svn/wiki
Specificeer de locatie van de svn-repository voor de wiki.

--svnpath-stam
Specificeer het pad binnen uw svn-repository waar de wiki zich bevindt. Dit
standaard naar kofferbak; verander het als je wiki op een ander pad in het
opslagplaats. Als uw wiki bovenaan de repository is geroot, stelt u svnpath in op "".

--rss, --norss
Als rss is ingesteld, zal ikiwiki standaard RSS-feeds genereren voor pagina's die inline een
blog.

--toestaan
Als allowrss is ingesteld en rss niet, zal ikiwiki niet standaard RSS genereren
feeds, maar het instellen van rss=yes in de inline-richtlijn kan deze standaard en
een voer genereren.

--atoom, --noatoom
Als atom is ingesteld, genereert ikiwiki standaard Atom-feeds voor pagina's die inline zijn
een blog.

--allowatoom
Als allowatom is ingesteld en rss niet is ingesteld, zal ikiwiki niet standaard genereren
Atom-feeds, maar het instellen van atom=yes in de inline-richtlijn kan deze standaard overschrijven
en genereer een feed.

--pingurl-URL
Stel dit in op de URL van een XML-RPC-service die moet worden gepingd wanneer een RSS-feed wordt bijgewerkt. Voor
Gebruik bijvoorbeeld de URL om Technorati te pingen http://rpc.technorati.com/rpc/ping

Deze parameter kan meerdere keren worden opgegeven om meer dan één URL op te geven
ping.

--url-URL
Specificeert de URL naar de wiki. Dit is een vereiste parameter in de CGI-modus.

--cgiurl http://example.org/ikiwiki.cgi
Specificeert de URL naar de ikiwiki CGI-scriptwrapper. Vereist bij het bouwen van de
wiki voor links naar het te genereren cgi-script.

--historyurl-URL
Specificeert de URL waarnaar moet worden gelinkt om door de paginageschiedenis te bladeren. In de URL staat "[[bestand]]".
vervangen door het bestand om te bladeren. Het is gebruikelijk om hiervoor ViewVC te gebruiken.

--beheerdersmail [e-mail beveiligd]
Specificeert het e-mailadres dat ikiwiki moet gebruiken voor het verzenden van e-mail.

--diffurl-URL
Specificeert de URL waarnaar moet worden gelinkt voor verschillende wijzigingen aan een pagina. In de URL,
"[[file]]" is vervangen door het bestand om te bladeren, "[[r1]]" is de oude revisie van de
pagina, en "[[r2]]" is de nieuwe revisie. Het is gebruikelijk om hiervoor ViewVC te gebruiken.

--exclusief regexp
Specificeert een rexexp van bronbestanden die moeten worden uitgesloten van verwerking. Kan gespecificeerd worden
meerdere keren om toe te voegen aan de uitsluitingslijst.

--inclusief regexp
Specificeert een rexexp van bronbestanden, die normaal gesproken zouden worden uitgesloten, maar die u
willen opnemen in de verwerking. Kan meerdere keren worden opgegeven om toe te voegen aan op te nemen
lijst.

--admingebruikersnaam
Specificeert een gebruikersnaam van een gebruiker (of, als openid is ingeschakeld, een openid) die het
bevoegdheden van een wiki-admin. Staat momenteel het vergrendelen van elke pagina toe en het verbannen van gebruikers, zoals
evenals bevoegdheden verleend door ingeschakelde plug-ins (zoals [[moderating
comments|plugins/moderatedcomments]] en plugins/websetup. Kan gespecificeerd worden
meerdere keren voor meerdere beheerders.

Geef voor een openid-gebruiker de volledige URL van de login op, inclusief "http://".

--naam plug-in
Maakt het gebruik van de opgegeven plug-in in de wiki mogelijk. Merk op dat de namen van plug-ins
hoofdlettergevoelig.

--disable-plug-in naam
Schakelt het gebruik van een plug-in uit. Bijvoorbeeld "--disable-plugin htmlscrubber" om weg te doen
met HTML-opschoning.

--libdir-map
Laat ikiwiki eerst in de gespecificeerde directory kijken, vóór de reguliere locaties
bij het laden van bibliotheekbestanden en plug-ins. Als u bijvoorbeeld libdir instelt op
"/home/you/.ikiwiki/", je kunt een foo.pm-plug-in installeren als
"/home/you/.ikiwiki/IkiWiki/Plugin/foo.pm".

--discussie, --geen-discussie
Schakelt in of uit dat "Discussie"-links worden toegevoegd aan de kop van elke
bladzijde. De koppelingen zijn standaard ingeschakeld.

--nummerbacklinks zn
Bepaalt hoeveel backlinks onderaan een pagina moeten worden weergegeven. Overmaat
backlinks worden verborgen in een pop-up. Standaard is 10. Stel in op 0 om dit uit te schakelen
kenmerk.

--userdir submap
Staat optioneel toe dat links naar gebruikers van de wiki linken naar pagina's binnen een
subdirectory van de wiki. De standaard is om te linken naar pagina's in de directory op het hoogste niveau
van de wiki.

--htmlext html
Configureert de extensie die wordt gebruikt voor gegenereerde html-bestanden. Standaard is "html".

--timeformat formaat
Geef op hoe de tijd of datum moet worden weergegeven. De opmaaktekenreeks wordt doorgegeven aan het
tijd(3) functie.

--uitgebreid, --niet-uitgebreid
Wees uitgebreid over wat er wordt gedaan.

--syslog, --no-syslog
Log in op syslog(3).

--usedirs, --no-usedirs
Schakel tussen het maken van uitvoerbestanden met de naam pagina/index.html (standaard) in plaats van pagina.html.

--prefix-richtlijnen, --no-prefix-richtlijnen
Toggle nieuwe '!'-prefixed syntaxis voor preprocessor-richtlijnen. ikiwiki momenteel
standaard ingesteld op --prefix-directives.

--w3mmode, --no-w3mmode
Schakel w3mmode in, waarmee w3m ikiwiki kan gebruiken als een lokaal CGI-script, zonder een
web Server.

--sslcookie
Verstuur cookies alleen via een SSL-verbinding. Dit zou moeten voorkomen dat ze dat zijn
onderschept. Als u deze optie inschakelt, moet u ten minste het CGI-gedeelte uitvoeren
van ikiwiki via SSL.

--gettime, --geen-gettime
Haal de aanmaak- en wijzigingstijden voor elke nieuwe pagina uit de revisie
logboek van de controle. Dit gebeurt automatisch wanneer je voor het eerst een wiki bouwt,
dus normaal gesproken hoeft u deze optie niet te gebruiken.

--set var=waarde
Hierdoor kan een willekeurige configuratievariabele worden ingesteld, net alsof deze is ingesteld
via een installatiebestand. Aangezien de meest gebruikte opties kunnen worden geconfigureerd met behulp van
opdrachtregelopties, zult u deze zelden nodig hebben.

--set-yaml var=waarde
Dit is als --set, maar het staat het instellen van configuratievariabelen toe die complex gebruiken
datastructuren, door een YAML-document door te geven.

Voorbeelden

ikiwiki --setup mijn.setup

Bouw de wiki volledig (opnieuw) op met behulp van het opgegeven installatiebestand.

ikiwiki --setup mijn.setup --refresh
Vernieuw de wiki, gebruik instellingen van my.setup, en vermijd het herbouwen van pagina's die
zijn niet veranderd. Dit is sneller.

ikiwiki --setup mijn.setup --refresh --wrappers
Ververs de wiki, inclusief het regenereren van alle wrapper-programma's, maar bouw niet opnieuw op
alle pagina's. Handig als u iets in het installatiebestand hebt gewijzigd dat niet verandert
een volledige wiki-herbouw nodig hebben om alle pagina's bij te werken, maar die u meteen wilt gebruiken
effect.

ikiwiki --rebuild srcdir doelmap
Gebruik srcdir als bron en bouw HTML in destdir, zonder een setup-bestand te gebruiken.

ikiwiki srcdir doelmap
Gebruik srcdir als bron om de HTML van gewijzigde pagina's in destdir bij te werken, zonder een
setup-bestand.

MILIEU

CC

Dit bepaalt welke C-compiler wordt gebruikt om wrappers te bouwen. Standaard is 'cc'.

CFLAGS Dit kan worden gebruikt om opties door te geven aan de C-compiler bij het bouwen van wrappers.

Gebruik ikiwiki online met behulp van onworks.net-services