ikiwiki - Online în cloud

PROGRAM:

NUME

ikiwiki - un compilator wiki

REZUMAT

ikiwiki [opțiuni] destinație sursă

ikiwiki --setup setupfile [opțiuni]

DESCRIERE

ikiwiki este un compilator wiki. Construiește pagini HTML statice pentru un wiki, din sursă în
ikiwiki/Markdown language (sau altele) și îl scrie la destinație.

Rețineți că majoritatea opțiunilor pot fi scurtate la litere simple, steaguri booleene, cum ar fi --verbose
poate fi negat cu --no-verbose, iar opțiuni precum --verbose pot fi, de asemenea, scrise ca
-verbos.

MODE OPŢIUNI

Aceste opțiuni controlează modul în care funcționează ikiwiki.

--reîmprospăta
Reîmprospătați wiki, actualizând toate paginile modificate. Acesta este comportamentul implicit dacă nu
este specificată altă acțiune de mod (dar rețineți că --setup este o acțiune de mod și are
comportament implicit diferit).

--reconstrui
Forțați o reconstruire a tuturor paginilor.

--setup setupfile
Încărcați opțiunile din fișierul de configurare dat. Dacă nu este specificată nicio altă acțiune în mod,
generați wrapper-uri și reconstruiți wiki-ul, ca și cum ar fi folosit --rebuild --wrappers. Dacă
vrei doar să construiești pagini modificate, poți folosi --refresh cu --setup.

--changesetup setupfile
Citește fișierul de configurare, adaugă orice modificări de configurare specificate de alte opțiuni,
și scrie noua configurație înapoi în fișierul de configurare. De asemenea, actualizează orice
ambalaje configurate. În acest mod, wiki-ul nu este complet reconstruit, cu excepția cazului în care și dvs
add --rebuild.

De exemplu, pentru a activa unele pluginuri:

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

--dumpsetup setupfile
Determină ikiwiki să scrie în fișierul de configurare specificat, eliminând curentul acestuia
configurare.

--învelișuri
Dacă este utilizat cu --setup --refresh, acest lucru îl face să actualizeze și toate wrapper-urile configurate.

--curat
Acest lucru face ca ikiwiki să curețe prin eliminarea oricăror fișiere pe care le-a generat în destinație
directorul, precum și orice wrapper configurat și directorul de stat .ikiwiki.
Acest lucru este util mai ales dacă rulați ikiwiki într-un Makefile pentru a construi
documentație și doriți o țintă curată corespunzătoare.

--cgi Activați modul CGI. În modul cgi, ikiwiki rulează ca un script cgi și acceptă editarea
pagini, conectare și înregistrare.

Pentru a utiliza ikiwiki ca program CGI, trebuie să utilizați --wrapper sau --setup pentru a genera un
învelitoare. În general, wrapper-ul va trebui să ruleze suid 6755 către utilizatorul care deține
directoarele sursă și destinație.

--wrapper [fișier]
Generați un wrapper binar care este codificat pentru a face acțiunea specificată de celălalt
opțiuni, folosind fișierele de intrare specificate și directorul de destinație. Numele fișierului către
utilizarea pentru ambalaj este opțională.

Învelișul este proiectat pentru a fi realizat în siguranță și rulat de utilizatori neîncrezători, ca a
post-commit hook sau ca CGI.

Rețineți că wrapper-ul generat va ignora toți parametrii liniei de comandă.

--agregat
Dacă pluginurile/pluginul agregat este activat, acest lucru face ca sondajul ikiwiki să fie configurat
fluxuri și salvați postări noi în srcdir.

Rețineți că pentru a reconstrui postările agregate anterior, utilizați opțiunea --rebuild
Cu acesta. --rebuild va forța, de asemenea, ca fluxurile să fie interogate chiar dacă ar fi
sondat recent.

--fișier de randare
Redă un singur fișier, rezultând html-ul rezultat. Nu salvează starea, deci aceasta
nu poate fi folosit pentru a construi wiki-uri întregi, dar este util pentru previzualizarea unui wiki editat
fișier la linia de comandă. Utilizat în general împreună cu --setup pentru a încărca într-un
configurarea wiki:

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

--post-comitare
Rulați în modul post-commit, la fel ca și cum ar fi apelat de un hook post-commit. Aceasta este
probabil util doar atunci când utilizați ikiwiki cu un server web pe o gazdă și a
depozit pe altul, pentru a permite ca hook-ul real post-commit al depozitului să facă ssh la
găzduiește serverul web și rulează manual ikiwiki pentru a actualiza site-ul web.

--versiune
Tipăriți numărul versiunii ikiwiki.

ÎNFIINȚAT OPŢIUNI

Aceste opțiuni configurează wiki-ul. Rețineți că pluginurile pot adăuga configurații suplimentare
opțiuni proprii. Toate aceste opțiuni și multe altele în afară de aceasta pot fi, de asemenea, configurate folosind a
fișier de configurare.

--wikiname nume
Numele wiki-ului, implicit este „wiki”.

--templatedir dir
Specificați directorul în care sunt stocate șabloanele. Implicit este
/usr/share/ikiwiki/templates sau o altă locație configurată în momentul construirii. Dacă
templatedir-ul este schimbat, șabloanele lipsă vor fi căutate în continuare în
locație implicită ca alternativă. Șabloanele pot fi plasate și în „șabloane/”
subdirectorul srcdir.

Rețineți că dacă alegeți să copiați și să modificați șabloanele ikiwiki, va trebui să faceți acest lucru
aveți grijă să le țineți la zi atunci când faceți upgrade la versiuni noi de ikiwiki. Vechi
versiunile de șabloane nu funcționează întotdeauna cu noile versiuni ikiwiki.

--underlaydir dir
Specificați directorul care este utilizat pentru a acoperi directorul sursă. Fișiere sursă
va fi preluat de aici, dacă nu este suprascris de un fișier din directorul sursă.
Implicit este /usr/share/ikiwiki/basewiki sau o altă locație așa cum a fost configurată la compilare
timp.

--modul wrappermode
Specificați un mod în care să modificați wrapper-ul după crearea acestuia.

--grup de grup de înveliș
Specificați ce grup Unix ar trebui să dețină wrapper-ul. Acest lucru poate fi util dacă
wrapper-ul trebuie să fie deținut de un alt grup decât cel implicit. De exemplu, dacă a
proiectul are un depozit cu mai mulți committers cu acces controlat de a
grup, are sens ca wrapper-urile ikiwiki să ruleze setgid la acel grup.

--rcs=svn|git|.., --no-rcs
Activați sau dezactivați utilizarea unui sistem de control_reviziune.

Directorul sursă va fi considerat a fi o copie de lucru, sau o clonă, sau orice altceva
sistemul de control al reviziilor pe care îl selectați folosește.

În modul CGI, cu un sistem de control al reviziilor activat, paginile editate prin web vor fi
fi angajat.

Niciun control al revizuirii nu este activat în mod implicit.

--svnrepo /svn/wiki
Specificați locația depozitului svn pentru wiki.

--svnpath trunchi
Specificați calea din interiorul depozitului dvs. svn unde se află wiki-ul. Acest
implicit la trunchi; schimbați-l dacă wiki-ul dvs. se află pe altă cale în interiorul
repertoriu. Dacă wiki-ul dvs. este înrădăcinat în partea de sus a depozitului, setați svnpath la „”.

--rss, --norss
Dacă rss este setat, ikiwiki va genera implicit fluxuri RSS pentru paginile care inline a
blog.

--permite
Dacă allowrss este setat și rss nu este setat, ikiwiki nu va genera implicit RSS
fluxuri, dar setarea rss=yes în directiva inline poate suprascrie această implicită și
genera un flux.

--atom, --noatom
Dacă atom este setat, ikiwiki va genera în mod implicit fluxuri Atom pentru paginile care sunt în linie
un blog.

--allowatom
Dacă allowatom este setat și rss nu este setat, ikiwiki nu va genera implicit
Fluxuri Atom, dar setarea atom=yes în directiva inline poate suprascrie această implicită
și generează un flux.

--pingurl URL
Setați aceasta la adresa URL a unui serviciu XML-RPC pentru a face ping atunci când un flux RSS este actualizat. Pentru
de exemplu, pentru a trimite ping la Technorati, utilizați adresa URL http://rpc.technorati.com/rpc/ping

Acest parametru poate fi specificat de mai multe ori pentru a specifica mai multe adrese URL
ping

--URL URL
Specifică adresa URL a wiki-ului. Acesta este un parametru obligatoriu în modul CGI.

--cgiurl http://example.org/ikiwiki.cgi
Specifică adresa URL la pachetul de script CGI ikiwiki. Necesar la construirea
wiki pentru legături către scriptul cgi care urmează să fie generat.

--historyurl URL
Specifică adresa URL către care se face legătura pentru navigarea în istoricul paginii. În adresa URL, „[[fișier]]” este
înlocuit cu fișierul pentru a căuta. Este obișnuit să utilizați ViewVC pentru asta.

--adminemail [e-mail protejat]
Specifică adresa de e-mail pe care ikiwiki ar trebui să o utilizeze pentru a trimite e-mailuri.

--diffurl URL
Specifică adresa URL către care se face legătura pentru o diferență de modificări la o pagină. În adresa URL,
„[[fișier]]” este înlocuit cu fișierul de parcurs, „[[r1]]” este versiunea veche a
pagina, iar „[[r2]]” este noua revizuire. Este obișnuit să utilizați ViewVC pentru asta.

--exclude expresia regulată
Specifică un rexexp al fișierelor sursă de exclus de la procesare. Poate fi specificat
de mai multe ori pentru a adăuga pentru a exclude lista.

--include regexp
Specifică o rexexp a fișierelor sursă, care ar fi în mod normal excluse, dar pe care tu
doresc să includă în procesare. Poate fi specificat de mai multe ori pentru a adăuga și a include
listă.

--nume administrator
Specifică un nume de utilizator al unui utilizator (sau, dacă openid este activat, un openid) care are
puterile unui administrator wiki. În prezent, permite blocarea oricărei pagini și interzicerea utilizatorilor, ca
precum și puterile acordate de pluginurile activate (cum ar fi [[moderating
comments|plugins/moderatedcomments]] și pluginuri/websetup. Poate fi specificat
de mai multe ori pentru mai mulți administratori.

Pentru un utilizator openid, specificați adresa URL completă a login-ului, inclusiv „http://”.

--nume plugin
Activează utilizarea pluginului specificat în wiki. Rețineți că numele pluginurilor sunt
caz sensibil.

--disable-plugin name
Dezactivează utilizarea unui plugin. De exemplu, „--disable-plugin htmlscrubber” pentru a elimina
cu dezinfectare HTML.

directorul --libdir
Face ikiwiki să arate mai întâi în directorul specificat, înaintea locațiilor obișnuite
la încărcarea fișierelor de bibliotecă și a pluginurilor. De exemplu, dacă setați libdir la
„/home/you/.ikiwiki/”, puteți instala un plugin foo.pm ca
„/home/you/.ikiwiki/IkiWiki/Plugin/foo.pm”.

--discuție, --fără-discuție
Activează sau dezactivează adăugarea linkurilor „Discuție” în antetul fiecăruia
pagină. Legăturile sunt activate în mod implicit.

--numbacklinks n
Controlează câte backlink-uri ar trebui să fie afișate în partea de jos a unei pagini. Exces
backlink-urile vor fi ascunse într-un pop-up. Implicit este 10. Setați la 0 pentru a dezactiva acest lucru
caracteristică.

--userdir subdir
Opțional, permite link-urilor către utilizatorii wiki să facă linkuri către pagini din interiorul unui
subdirectorul wiki-ului. Valoarea implicită este să faceți legătura către pagini din directorul de nivel superior
a wiki-ului.

--htmlext html
Configurați extensia utilizată pentru fișierele html generate. Implicit este „html”.

format --timeformat
Specificați cum să afișați ora sau data. Șirul de format este transmis către
strftime(3) funcția.

--verbos, --no-verbos
Fiți cuprinzător despre ceea ce se face.

--syslog, --no-syslog
Conectați-vă la syslog(3).

--usedirs, --no-usedirs
Comutați crearea fișierelor de ieșire denumite page/index.html (implicit) în loc de page.html.

--prefix-directives, --no-prefix-directives
Comutați noua sintaxă cu prefix „!” pentru directivele preprocesorului. ikiwiki în prezent
implicit la --prefix-directives.

--w3mmode, --no-w3mmode
Activați w3mmode, care permite w3m să utilizeze ikiwiki ca script CGI local, fără un
server web.

--sslcookie
Trimiteți cookie-uri numai printr-o conexiune SSL. Acest lucru ar trebui să le împiedice să fie
interceptat. Dacă activați această opțiune, atunci trebuie să rulați cel puțin porțiunea CGI
de ikiwiki prin SSL.

--gettime, --no-gettime
Extrageți timpii de creare și modificare pentru fiecare pagină nouă din revizuire
jurnalul de control. Acest lucru se face automat la construirea unui wiki pentru prima dată,
deci, în mod normal, nu trebuie să utilizați această opțiune.

--set var=valoare
Acest lucru permite setarea unei variabile de configurare arbitrară, la fel ca și cum ar fi setat
printr-un fișier de configurare. Deoarece cele mai frecvent utilizate opțiuni pot fi configurate folosind
comutatoare din linia de comandă, rareori va trebui să utilizați acest lucru.

--set-yaml var=valoare
Acesta este ca --set, dar permite setarea variabilelor de configurare care folosesc complex
structuri de date, prin transmiterea unui document YAML.

EXEMPLE

ikiwiki --setup my.setup

(re)construiți complet wiki-ul folosind fișierul de configurare specificat.

ikiwiki --setup my.setup --refresh
Reîmprospătați wiki, folosind setările din my.setup și evitați reconstruirea oricăror pagini care
nu s-au schimbat. Acest lucru este mai rapid.

ikiwiki --setup my.setup --refresh --wrappers
Reîmprospătați wiki, inclusiv regenerarea tuturor programelor wrapper, dar nu reconstruiți
toate paginile. Util dacă ați schimbat ceva în fișierul de configurare care nu
aveți nevoie de o reconstrucție completă a wiki pentru a actualiza toate paginile, dar pe care doriți să o preluați imediat
efect.

ikiwiki --rebuild srcdir destdir
Utilizați srcdir ca sursă și construiți HTML în destdir, fără a utiliza un fișier de configurare.

ikiwiki srcdir destdir
Utilizați srcdir ca sursă pentru a actualiza HTML-ul paginilor modificate în destdir, fără a utiliza un
fișier de configurare.

MEDIUL

CC

Aceasta controlează ce compilator C este folosit pentru a construi wrapper-uri. Implicit este „cc”.

CFLAGS Acesta poate fi folosit pentru a transmite opțiuni compilatorului C atunci când construiesc wrapper-uri.

Utilizați ikiwiki online folosind serviciile onworks.net