ikiwiki - Online sa Cloud

PROGRAMA:

NAME

ikiwiki - isang wiki compiler

SINOPSIS

ikiwiki [mga opsyon] pinagmulang destinasyon

ikiwiki --setup setupfile [mga opsyon]

DESCRIPTION

Ang ikiwiki ay isang wiki compiler. Bumubuo ito ng mga static na HTML na pahina para sa isang wiki, mula sa pinagmulan sa
ikiwiki/Markdown na wika (o iba pa), at isinusulat ito sa destinasyon.

Tandaan na ang karamihan sa mga opsyon ay maaaring paikliin sa mga solong titik, mga boolean na flag gaya ng --verbose
maaaring balewalain ng --no-verbose, at ang mga opsyon tulad ng --verbose ay maaari ding baybayin tulad ng
-salita.

MODE Opsyon

Kinokontrol ng mga opsyong ito ang mode na pinapatakbo ng ikiwiki.

--refresh
I-refresh ang wiki, ina-update ang anumang binagong pahina. Ito ang default na pag-uugali kung hindi
iba pang pagkilos ng mode ay tinukoy (ngunit tandaan na ang --setup ay isang pagkilos ng mode, at mayroong
ibang default na pag-uugali).

--muling itayo
Pilitin ang muling pagbuo ng lahat ng pahina.

--setup setupfile
Mag-load ng mga opsyon mula sa ibinigay na setup file. Kung walang ibang mode na aksyon ang tinukoy,
bumuo ng mga wrapper at muling buuin ang wiki, na parang ginamit --rebuild --wrappers. Kung
gusto mo lang bumuo ng anumang binagong pahina, maaari mong gamitin ang --refresh gamit ang --setup.

--changesetup setupfile
Binabasa ang setup file, nagdaragdag ng anumang mga pagbabago sa configuration na tinukoy ng iba pang mga opsyon,
at isusulat ang bagong configuration pabalik sa setup file. Nag-a-update din ng anuman
naka-configure na mga wrapper. Sa mode na ito, ang wiki ay hindi ganap na itinayong muli, maliban kung ikaw din
idagdag --rebuild.

Halimbawa, upang paganahin ang ilang mga plugin:

ikiwiki --changesetup ~/ikiwiki.setup --plugin goodstuff --plugin na kalendaryo

--dumpsetup setupfile
Nagiging sanhi ng pagsulat ng ikiwiki sa tinukoy na file ng pag-setup, na itinatapon ang kasalukuyan nito
pagsasaayos.

--mga balot
Kung ginamit sa --setup --refresh, ginagawa rin nitong i-update ang anumang mga naka-configure na wrapper.

--malinis
Ginagawa nitong linisin ang ikiwiki sa pamamagitan ng pag-alis ng anumang mga file na nabuo nito sa destinasyon
direktoryo, pati na rin ang anumang naka-configure na mga wrapper, at ang direktoryo ng estado ng .ikiwiki.
Ito ay kadalasang kapaki-pakinabang kung nagpapatakbo ka ng ikiwiki sa isang Makefile na gagawin
dokumentasyon at nais ng kaukulang malinis na target.

--cgi Paganahin ang CGI mode. Sa cgi mode, ang ikiwiki ay tumatakbo bilang cgi script, at sumusuporta sa pag-edit
mga pahina, pag-sign in, at pagpaparehistro.

Upang magamit ang ikiwiki bilang isang CGI program kailangan mong gumamit ng --wrapper o --setup upang makabuo ng a
pambalot. Ang wrapper ay karaniwang kailangang magpatakbo ng suid 6755 sa user na nagmamay-ari ng
mga direktoryo ng pinagmulan at patutunguhan.

--wrapper [file]
Bumuo ng binary ng wrapper na naka-hardcode para gawin ang pagkilos na tinukoy ng isa pa
mga opsyon, gamit ang tinukoy na mga file ng input at direktoryo ng patutunguhan. Ang filename sa
ang paggamit para sa wrapper ay opsyonal.

Ang wrapper ay idinisenyo upang ligtas na gawing suid at patakbuhin ng mga hindi pinagkakatiwalaang user, bilang a
post-commit hook, o bilang isang CGI.

Tandaan na babalewalain ng nabuong wrapper ang lahat ng parameter ng command line.

--pagsasama-sama
Kung pinagana ang plugins/aggregate plugin, ginagawa nitong na-configure ang poll ng ikiwiki
feed at i-save ang mga bagong post sa srcdir.

Tandaan na para muling buuin ang mga dating pinagsama-samang post, gamitin ang --rebuild na opsyon kasama
kasama ang isang ito. --rebuild ay pipilitin din ang mga feed na i-poll kahit na sila
poll kamakailan.

--render file
Nagre-render ng isang file, na naglalabas ng resultang html. Hindi nagse-save ng estado, kaya ito
hindi maaaring gamitin para sa pagbuo ng buong wiki, ngunit ito ay kapaki-pakinabang para sa pag-preview ng isang na-edit
file sa command line. Karaniwang ginagamit kasabay ng --setup upang i-load sa a
setup ng wiki:

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

--post-commit
Patakbuhin sa post-commit mode, katulad ng kung tinatawag ng isang post-commit hook. Ito ay
marahil ay kapaki-pakinabang lamang kapag gumagamit ng ikiwiki sa isang web server sa isang host at a
repository sa isa pa, upang payagan ang totoong post-commit hook ng repository na mag-ssh sa
ang host ng web server at manu-manong patakbuhin ang ikiwiki upang i-update ang web site.

--bersyon
I-print ang numero ng bersyon ng ikiwiki.

KONFIG Opsyon

Kino-configure ng mga opsyong ito ang wiki. Tandaan na ang mga plugin ay maaaring magdagdag ng karagdagang configuration
kanilang sariling mga pagpipilian. Ang lahat ng mga opsyong ito at higit pa bukod sa ay maaari ding i-configure gamit ang a
setup ng file.

--pangalan ng wikiname
Ang pangalan ng wiki, ang default ay "wiki".

--templatedir dir
Tukuyin ang direktoryo kung saan naka-imbak ang mga template. Default ay
/usr/share/ikiwiki/templates, o ibang lokasyon na naka-configure sa oras ng pagbuo. Kung
ang templatedir ay binago, ang mga nawawalang template ay hahanapin pa rin sa
default na lokasyon bilang isang fallback. Maaari ding ilagay ang mga template sa "templates/"
subdirectory ng srcdir.

Tandaan na kung pipiliin mong kopyahin at baguhin ang mga template ng ikiwiki, kakailanganin mong maging
maingat na panatilihing napapanahon ang mga ito kapag nag-a-upgrade sa mga bagong bersyon ng ikiwiki. Luma
ang mga bersyon ng mga template ay hindi palaging gumagana sa mga bagong bersyon ng ikiwiki.

--underlaydir dir
Tukuyin ang direktoryo na ginagamit upang i-underlay ang pinagmulang direktoryo. Pinagmulan ng mga file
kukunin mula rito maliban kung ma-override ng isang file sa source na direktoryo.
Ang default ay /usr/share/ikiwiki/basewiki o ibang lokasyon gaya ng na-configure sa build
time.

--wrappermode mode
Tukuyin ang isang mode upang chmod ang wrapper pagkatapos gawin ito.

--wrappergroup na pangkat
Tukuyin kung anong pangkat ng unix ang dapat na pag-aari ng wrapper. Ito ay maaaring maging kapaki-pakinabang kung ang
ang wrapper ay kailangang pagmamay-ari ng isang pangkat maliban sa default. Halimbawa, kung a
ang proyekto ay may repositoryo na may maraming committer na may access na kinokontrol ng a
grupo, makatuwiran para sa mga wrapper ng ikiwiki na tumakbo setgid sa pangkat na iyon.

--rcs=svn|git|.., --no-rcs
Paganahin o huwag paganahin ang paggamit ng isang revision_control_system.

Ang direktoryo ng pinagmulan ay ipapalagay na isang gumaganang kopya, o clone, o anuman
ginagamit ang sistema ng kontrol ng rebisyon na iyong pinili.

Sa CGI mode, na may pinaganang revision control system, gagawin ng mga page na na-edit sa pamamagitan ng web
maging nakatuon.

Walang kontrol sa rebisyon ang pinagana bilang default.

--svnrepo /svn/wiki
Tukuyin ang lokasyon ng svn repository para sa wiki.

--svnpath trunk
Tukuyin ang landas sa loob ng iyong svn repository kung saan matatagpuan ang wiki. Ito
default sa puno ng kahoy; baguhin ito kung ang iyong wiki ay nasa ibang landas sa loob ng
imbakan. Kung ang iyong wiki ay na-root sa tuktok ng repository, itakda ang svnpath sa "".

--rss, --norss
Kung nakatakda ang rss, ang ikiwiki ay magiging default sa pagbuo ng mga RSS feed para sa mga pahinang inline a
blog.

--allowrss
Kung ang allowrss ay nakatakda, at ang rss ay hindi nakatakda, ang ikiwiki ay hindi magiging default sa pagbuo ng RSS
feed, ngunit ang pagtatakda ng rss=yes sa inline na direktiba ay maaaring ma-override ang default na ito at
bumuo ng feed.

--atom, --noatom
Kung nakatakda ang atom, ang ikiwiki ay magiging default sa pagbuo ng mga Atom feed para sa mga page na inline
isang blog.

--allowatom
Kung ang allowatom ay nakatakda, at ang rss ay hindi nakatakda, ang ikiwiki ay hindi magiging default sa pagbuo
Mga feed ng Atom, ngunit ang pagtatakda ng atom=yes sa inline na direktiba ay maaaring ma-override ang default na ito
at bumuo ng feed.

--pingurl URL
Itakda ito sa URL ng isang XML-RPC na serbisyo upang mag-ping kapag na-update ang isang RSS feed. Para sa
halimbawa, para i-ping ang Technorati, gamitin ang URL http://rpc.technorati.com/rpc/ping

Maaaring tukuyin ang parameter na ito nang maraming beses upang tumukoy ng higit sa isang URL
ping

--url URL
Tinutukoy ang URL sa wiki. Ito ay isang kinakailangang parameter sa CGI mode.

--cgiurl http://example.org/ikiwiki.cgi
Tinutukoy ang URL sa ikiwiki CGI script wrapper. Kinakailangan kapag nagtatayo ng
wiki para sa mga link sa cgi script na mabubuo.

--historyurl URL
Tinutukoy ang URL na ili-link para sa pag-browse sa history ng page. Sa URL, ang "[[file]]" ay
pinalitan ng file na i-browse. Karaniwang gumamit ng ViewVC para dito.

--adminemail [protektado ng email]
Tinutukoy ang email address na dapat gamitin ng ikiwiki para sa pagpapadala ng email.

--diffurl URL
Tinutukoy ang URL kung saan mali-link para sa pagkakaiba ng mga pagbabago sa isang page. Sa URL,
Ang "[[file]]" ay pinalitan ng file upang i-browse, "[[r1]]" ay ang lumang rebisyon ng
pahina, at ang "[[r2]]" ay ang bagong rebisyon. Karaniwang gumamit ng ViewVC para dito.

--ibukod ang regexp
Tumutukoy ng rexexp ng mga source file na ibubukod sa pagproseso. Maaaring tukuyin
maraming beses upang idagdag upang ibukod ang listahan.

--isama ang regexp
Tinutukoy ang isang rexexp ng mga source file, na karaniwang hindi isasama, ngunit ikaw
gustong isama sa pagproseso. Maaaring tukuyin ng maraming beses upang idagdag upang isama
listahan.

--pangalan ng administrator
Tinutukoy ang isang username ng isang user (o, kung naka-enable ang openid, isang openid) na mayroong
kapangyarihan ng isang wiki admin. Kasalukuyang pinapayagan ang pag-lock ng anumang pahina, at pagbabawal ng mga user, bilang
pati na rin ang mga kapangyarihang ipinagkaloob ng mga naka-enable na plugin (tulad ng [[moderating
mga komento|plugin/moderate na mga komento]] at mga plugin/websetup. Maaaring tukuyin
maraming beses para sa maraming admin.

Para sa isang openid user, tukuyin ang buong URL ng login, kasama ang "http://".

--pangalan ng plugin
Pinapagana ang paggamit ng tinukoy na plugin sa wiki. Tandaan na ang mga pangalan ng plugin ay
case sensitive.

--disable-plugin name
Hindi pinapagana ang paggamit ng isang plugin. Halimbawa "--disable-plugin htmlscrubber" upang alisin
gamit ang HTML sanitization.

--libdir na direktoryo
Ginagawang tingnan muna ang ikiwiki sa tinukoy na direktoryo, bago ang mga regular na lokasyon
kapag naglo-load ng mga file at plugin ng library. Halimbawa, kung itinakda mo ang libdir sa
"/home/you/.ikiwiki/", maaari kang mag-install ng foo.pm plugin bilang
"/home/you/.ikiwiki/IkiWiki/Plugin/foo.pm".

--talakayan, --walang-talakayan
Pinapagana o hindi pinapagana ang mga link na "Discussion" mula sa pagdaragdag sa header ng bawat isa
pahina. Ang mga link ay pinagana bilang default.

--numbacklinks n
Kinokontrol kung gaano karaming mga backlink ang dapat ipakita sa ibaba ng isang pahina. Sobra
ang mga backlink ay itatago sa isang popup. Default ay 10. Itakda sa 0 para i-disable ito
tampok.

--userdir subdir
Opsyonal, pinapayagan ang mga link sa mga gumagamit ng wiki na mag-link sa mga pahina sa loob ng a
subdirectory ng wiki. Ang default ay mag-link sa mga page sa toplevel na direktoryo
ng wiki.

--htmlext html
Kino-configure ang extension na ginamit para sa mga nabuong html file. Default ay "html".

--timeformat na format
Tukuyin kung paano ipapakita ang oras o petsa. Ang format na string ay ipinapasa sa
strftime(3) function.

--verbose, --no-verbose
Maging verbose tungkol sa kung ano ang ginagawa.

--syslog, --no-syslog
Mag-log in syslogNa (3).

--usedirs, --no-usedirs
I-toggle ang paggawa ng mga output file na pinangalanang page/index.html (default) sa halip na page.html.

--prefix-directives, --no-prefix-directives
I-toggle ang bagong '!'-prefixed syntax para sa mga preprocessor na direktiba. ikiwiki sa kasalukuyan
default sa --prefix-directives.

--w3mmode, --no-w3mmode
Paganahin ang w3mmode, na nagpapahintulot sa w3m na gamitin ang ikiwiki bilang isang lokal na CGI script, nang walang
web server.

--sslcookie
Magpadala lamang ng cookies sa isang koneksyon sa SSL. Ito ay dapat na maiwasan ang kanilang pagiging
naharang. Kung pinagana mo ang opsyong ito, dapat mong patakbuhin ang hindi bababa sa bahagi ng CGI
ng ikiwiki sa SSL.

--gettime, --no-gettime
I-extract ang mga oras ng paglikha at pagbabago para sa bawat bagong pahina mula sa rebisyon
log ng kontrol. Awtomatiko itong ginagawa kapag gumagawa ng wiki sa unang pagkakataon,
kaya karaniwang hindi mo kailangang gamitin ang opsyong ito.

--set var=value
Nagbibigay-daan ito sa pagtatakda ng arbitrary na variable ng pagsasaayos, katulad ng kung ito ay itinakda
sa pamamagitan ng isang setup file. Dahil ang pinakakaraniwang ginagamit na mga opsyon ay maaaring i-configure gamit
command-line switch, bihira mong kakailanganing gamitin ito.

--set-yaml var=value
Ito ay tulad ng --set, ngunit pinapayagan nito ang pagtatakda ng mga variable ng pagsasaayos na gumagamit ng kumplikado
mga istruktura ng data, sa pamamagitan ng pagpasa sa isang YAML na dokumento.

HALIMBAWA

ikiwiki --setup my.setup

Ganap na (muling) buuin ang wiki gamit ang tinukoy na setup file.

ikiwiki --setup my.setup --refresh
I-refresh ang wiki, gamit ang mga setting mula sa my.setup, at iwasang muling buuin ang anumang mga pahina na iyon
hindi nagbago. Mas mabilis ito.

ikiwiki --setup my.setup --refresh --wrappers
I-refresh ang wiki, kabilang ang muling pagbuo ng lahat ng mga programa ng wrapper, ngunit huwag muling buuin
lahat ng Pahina. Kapaki-pakinabang kung may binago ka sa setup file na hindi
kailangan ng isang buong wiki rebuild upang i-update ang lahat ng mga pahina, ngunit na nais mong agad na kunin
epekto.

ikiwiki --muling itayo ang srcdir destdir
Gamitin ang srcdir bilang source at bumuo ng HTML sa destdir, nang hindi gumagamit ng setup file.

ikiwiki srcdir destdir
Gamitin ang srcdir bilang source para i-update ang HTML ng mga binagong page sa destdir, nang hindi gumagamit ng a
setup ng file.

Kapaligiran

CC

Kinokontrol nito kung ano ang ginagamit ng C compiler para bumuo ng mga wrapper. Default ay 'cc'.

CFLAGS Magagamit ito para ipasa ang mga opsyon sa C compiler kapag gumagawa ng mga wrapper.

Gamitin ang ikiwiki online gamit ang mga serbisyo ng onworks.net