ikiwiki - Dalam Talian di Awan

JADUAL:

NAMA

ikiwiki - penyusun wiki

SINOPSIS

ikiwiki [pilihan] destinasi sumber

ikiwiki --setup setupfile [pilihan]

DESCRIPTION

ikiwiki ialah penyusun wiki. Ia membina halaman HTML statik untuk wiki, daripada sumber dalam
ikiwiki/Bahasa Markdown (atau yang lain), dan menuliskannya ke destinasi.

Ambil perhatian bahawa kebanyakan pilihan boleh dipendekkan kepada huruf tunggal, bendera boolean seperti --verbose
boleh dinafikan dengan --no-verbose, dan pilihan seperti --verbose juga boleh dieja seperti
-berkata-kata.

MODE PILIHAN

Pilihan ini mengawal mod di mana ikiwiki beroperasi.

--segarkan
Muat semula wiki, mengemas kini mana-mana halaman yang diubah. Ini ialah tingkah laku lalai jika tidak
tindakan mod lain ditentukan (tetapi ambil perhatian bahawa --setup ialah tindakan mod, dan mempunyai
tingkah laku lalai yang berbeza).

--bina semula
Paksa bina semula semua halaman.

--setup setupfile
Muatkan pilihan daripada fail persediaan yang diberikan. Jika tiada tindakan mod lain dinyatakan,
jana pembalut dan bina semula wiki, seolah-olah --rebuild --wrappers telah digunakan. Jika
anda hanya mahu membina mana-mana halaman yang diubah, anda boleh menggunakan --refresh dengan --setup.

--changesetup setupfile
Membaca fail persediaan, menambah sebarang perubahan konfigurasi yang ditentukan oleh pilihan lain,
dan menulis konfigurasi baharu kembali ke fail persediaan. Juga mengemas kini mana-mana
pembungkus yang dikonfigurasikan. Dalam mod ini, wiki tidak dibina semula sepenuhnya, melainkan anda juga
tambah --bina semula.

Contoh, untuk mendayakan beberapa pemalam:

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

--dumpsetup setupfile
Menyebabkan ikiwiki menulis ke fail persediaan yang ditentukan, membuang arusnya
konfigurasi.

--pembungkus
Jika digunakan dengan --setup --refresh, ini menjadikannya turut mengemas kini sebarang pembalut yang dikonfigurasikan.

--bersih
Ini menjadikan ikiwiki membersihkan dengan mengalih keluar sebarang fail yang dijana di destinasi
direktori, serta sebarang pembungkus yang dikonfigurasikan, dan direktori keadaan .ikiwiki.
Ini kebanyakannya berguna jika anda menjalankan ikiwiki dalam Makefile untuk dibina
dokumentasi dan mahukan sasaran bersih yang sepadan.

--cgi Dayakan mod CGI. Dalam mod cgi ikiwiki berjalan sebagai skrip cgi, dan menyokong penyuntingan
halaman, log masuk dan pendaftaran.

Untuk menggunakan ikiwiki sebagai program CGI anda perlu menggunakan --wrapper atau --setup untuk menjana a
pembalut. Pembalut biasanya perlu menjalankan suid 6755 kepada pengguna yang memiliki
direktori sumber dan destinasi.

--pembungkus [fail]
Hasilkan binari pembalut yang dikodkan keras untuk melakukan tindakan yang ditentukan oleh yang lain
pilihan, menggunakan fail input dan direktori destinasi yang ditentukan. Nama fail ke
penggunaan untuk pembalut adalah pilihan.

Pembalut direka bentuk untuk dibuat suid dengan selamat dan dijalankan oleh pengguna yang tidak dipercayai, sebagai a
cangkuk pascakomit, atau sebagai CGI.

Ambil perhatian bahawa pembalut yang dijana akan mengabaikan semua parameter baris arahan.

--agregat
Jika pemalam/pemalam agregat didayakan, ini menjadikan tinjauan pendapat ikiwiki dikonfigurasikan
suapan dan simpan siaran baharu ke srcdir.

Ambil perhatian bahawa untuk membina semula siaran teragregat sebelum ini, gunakan pilihan --rebuild bersama
dengan yang ini. --rebuild juga akan memaksa suapan untuk ditinjau walaupun ia
ditinjau baru-baru ini.

--render fail
Memaparkan satu fail, mengeluarkan html yang terhasil. Tidak menyimpan keadaan, jadi ini
tidak boleh digunakan untuk membina keseluruhan wiki, tetapi ia berguna untuk melihat pratonton yang disunting
fail pada baris arahan. Biasanya digunakan bersama dengan --setup untuk memuatkan dalam a
persediaan wiki:

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

--pasca-komit
Jalankan dalam mod pascakomit, sama seperti dipanggil oleh cangkuk pascakomit. Ini adalah
mungkin hanya berguna apabila menggunakan ikiwiki dengan pelayan web pada satu hos dan a
repositori pada yang lain, untuk membenarkan cangkuk pasca komit sebenar repositori untuk ssh ke
hos pelayan web dan jalankan ikiwiki secara manual untuk mengemas kini tapak web.

--versi
Cetak nombor versi ikiwiki.

KONFIG PILIHAN

Pilihan ini mengkonfigurasi wiki. Ambil perhatian bahawa pemalam boleh menambah konfigurasi tambahan
pilihan mereka sendiri. Semua pilihan ini dan banyak lagi selain boleh dikonfigurasikan menggunakan a
fail persediaan.

--nama wiki
Nama wiki, lalai ialah "wiki".

--templatedir dir
Tentukan direktori tempat templat disimpan. Lalai ialah
/usr/share/ikiwiki/templates, atau lokasi lain seperti yang dikonfigurasikan pada masa binaan. Jika
templatedir diubah, templat yang hilang masih akan dicari dalam
lokasi lalai sebagai sandaran. Templat juga boleh diletakkan dalam "templates/"
subdirektori srcdir.

Ambil perhatian bahawa jika anda memilih untuk menyalin dan mengubah suai templat ikiwiki, anda perlu
berhati-hati untuk memastikan mereka dikemas kini apabila menaik taraf kepada versi baharu ikiwiki. Tua
versi templat tidak selalu berfungsi dengan versi ikiwiki baharu.

--underlaydir dir
Tentukan direktori yang digunakan untuk mendasari direktori sumber. Fail sumber
akan diambil dari sini melainkan ditindih oleh fail dalam direktori sumber.
Lalai ialah /usr/share/ikiwiki/basewiki atau lokasi lain seperti yang dikonfigurasikan pada build
pada bila-bila masa.

--mod wrappermode
Tentukan mod untuk chmod pembungkus selepas menciptanya.

--kumpulan pembungkus
Nyatakan kumpulan unix yang sepatutnya dimiliki oleh pembungkus itu. Ini boleh berguna jika
wrapper perlu dimiliki oleh kumpulan selain daripada lalai. Contohnya, jika a
projek mempunyai repositori dengan berbilang komitter dengan akses dikawal oleh a
kumpulan, adalah masuk akal untuk pembungkus ikiwiki menjalankan setgid kepada kumpulan itu.

--rcs=svn|git|.., --no-rcs
Dayakan atau lumpuhkan penggunaan revision_control_system.

Direktori sumber akan diandaikan sebagai salinan berfungsi, atau klon, atau apa sahaja
sistem kawalan semakan yang anda pilih digunakan.

Dalam mod CGI, dengan sistem kawalan semakan didayakan, halaman yang disunting melalui web akan
komited.

Tiada kawalan semakan didayakan secara lalai.

--svnrepo /svn/wiki
Nyatakan lokasi repositori svn untuk wiki.

--svnpath batang
Tentukan laluan di dalam repositori svn anda di mana wiki berada. ini
lalai kepada batang; ubahnya jika wiki anda berada di laluan lain di dalam
repositori. Jika wiki anda berakar di bahagian atas repositori, tetapkan svnpath kepada "".

--rss, --norss
Jika rss ditetapkan, ikiwiki akan lalai menjana suapan RSS untuk halaman yang sebaris a
blog.

--allowrss
Jika allowrss ditetapkan, dan rss tidak ditetapkan, ikiwiki tidak akan lalai untuk menjana RSS
suapan, tetapi tetapan rss=yes dalam arahan sebaris boleh mengatasi lalai ini dan
menjana suapan.

--atom, --noatom
Jika atom ditetapkan, ikiwiki akan lalai menjana suapan Atom untuk halaman yang sebaris
sebuah blog.

--allowatom
Jika allowatom ditetapkan, dan rss tidak ditetapkan, ikiwiki tidak akan lalai untuk menjana
Suapan Atom, tetapi menetapkan atom=ya dalam arahan sebaris boleh mengatasi lalai ini
dan menjana suapan.

--URL pingurl
Tetapkan ini kepada URL perkhidmatan XML-RPC untuk ping apabila suapan RSS dikemas kini. Untuk
contoh, untuk ping Technorati, gunakan URL http://rpc.technorati.com/rpc/ping

Parameter ini boleh ditentukan beberapa kali untuk menentukan lebih daripada satu URL
ping

--url URL
Menentukan URL ke wiki. Ini ialah parameter yang diperlukan dalam mod CGI.

--cgiurl http://example.org/ikiwiki.cgi
Menentukan URL kepada pembalut skrip CGI ikiwiki. Diperlukan semasa membina
wiki untuk pautan ke skrip cgi yang akan dijana.

--URL sejarah
Menentukan URL untuk dipautkan untuk menyemak imbas sejarah halaman. Dalam URL, "[[fail]]" ialah
digantikan dengan fail untuk menyemak imbas. Ia adalah perkara biasa untuk menggunakan ViewVC untuk ini.

--adminemail [e-mel dilindungi]
Menentukan alamat e-mel yang harus digunakan oleh ikiwiki untuk menghantar e-mel.

--URL diffurl
Menentukan URL untuk dipautkan untuk perbezaan perubahan pada halaman. Dalam URL,
"[[fail]]" digantikan dengan fail untuk menyemak imbas, "[[r1]]" ialah semakan lama bagi
halaman, dan "[[r2]]" ialah semakan baharu. Ia adalah perkara biasa untuk menggunakan ViewVC untuk ini.

--kecualikan regexp
Menentukan rexexp fail sumber untuk dikecualikan daripada pemprosesan. Boleh dinyatakan
beberapa kali untuk ditambah untuk mengecualikan senarai.

--termasuk regexp
Menentukan rexexp fail sumber, yang biasanya akan dikecualikan, tetapi anda
ingin dimasukkan dalam pemprosesan. Boleh dinyatakan beberapa kali untuk ditambah untuk disertakan
senarai.

--nama pentadbir
Menentukan nama pengguna pengguna (atau, jika openid didayakan, openid) yang mempunyai
kuasa pentadbir wiki. Pada masa ini membenarkan penguncian mana-mana halaman, dan melarang pengguna, sebagai
serta kuasa yang diberikan oleh pemalam yang didayakan (seperti [[moderating
komen|plugin/komen sederhana]] dan pemalam/persediaan web. Boleh dinyatakan
beberapa kali untuk beberapa pentadbir.

Untuk pengguna openid tentukan URL penuh log masuk, termasuk "http://".

--nama pemalam
Membolehkan penggunaan pemalam yang ditentukan dalam wiki. Ambil perhatian bahawa nama pemalam ialah
kes sensitif.

--disable-plugin nama
Melumpuhkan penggunaan pemalam. Contohnya "--disable-plugin htmlscrubber" untuk dihapuskan
dengan sanitasi HTML.

--direktori libdir
Membuat ikiwiki melihat dalam direktori yang ditentukan terlebih dahulu, sebelum lokasi biasa
apabila memuatkan fail perpustakaan dan pemalam. Sebagai contoh, jika anda menetapkan libdir kepada
"/home/you/.ikiwiki/", anda boleh memasang pemalam foo.pm sebagai
"/home/you/.ikiwiki/IkiWiki/Plugin/foo.pm".

--perbincangan, --tiada-perbincangan
Mendayakan atau melumpuhkan pautan "Perbincangan" daripada ditambahkan pada pengepala setiap
muka surat. Pautan didayakan secara lalai.

--numbacklinks n
Mengawal bilangan pautan balik yang perlu dipaparkan di bahagian bawah halaman. Berlebihan
pautan balik akan disembunyikan dalam pop timbul. Lalai ialah 10. Tetapkan kepada 0 untuk melumpuhkan ini
ciri.

--userdir subdir
Secara pilihan, membenarkan pautan kepada pengguna wiki untuk memaut ke halaman di dalam a
subdirektori wiki. Lalai adalah untuk memaut ke halaman dalam direktori peringkat atas
daripada wiki.

--htmlext html
Mengkonfigurasikan sambungan yang digunakan untuk fail html yang dijana. Lalai ialah "html".

--format format masa
Nyatakan cara untuk memaparkan masa atau tarikh. Rentetan format dihantar ke
masa strft(3) fungsi.

--verbose, --no-verbose
Berkata-kata tentang apa yang sedang dilakukan.

--syslog, --no-syslog
Log masuk ke syslog(3).

--userirs, --no-usedirs
Togol mencipta fail output bernama page/index.html (lalai) dan bukannya page.html.

--arahan-awalan, --tanpa-arahan-awalan
Togol sintaks awalan '!' baharu untuk arahan prapemproses. ikiwiki pada masa ini
lalai kepada --prefix-directives.

--w3mmode, --no-w3mmode
Dayakan w3mmode, yang membolehkan w3m menggunakan ikiwiki sebagai skrip CGI tempatan, tanpa
pelayan web.

--sslcookie
Hanya hantar kuki melalui sambungan SSL. Ini sepatutnya menghalang mereka
tercegat. Jika anda mendayakan pilihan ini maka anda mesti menjalankan sekurang-kurangnya bahagian CGI
daripada ikiwiki melalui SSL.

--gettime, --no-gettime
Ekstrak masa penciptaan dan pengubahsuaian untuk setiap halaman baharu daripada semakan
log kawalan. Ini dilakukan secara automatik apabila membina wiki buat kali pertama,
jadi anda biasanya tidak perlu menggunakan pilihan ini.

--set var=value
Ini membenarkan menetapkan pembolehubah konfigurasi sewenang-wenangnya, sama seperti ia ditetapkan
melalui fail persediaan. Oleh kerana pilihan yang paling biasa digunakan boleh dikonfigurasikan menggunakan
suis baris arahan, anda jarang perlu menggunakan ini.

--set-yaml var=nilai
Ini seperti --set, tetapi ia membenarkan tetapan pembolehubah konfigurasi yang menggunakan kompleks
struktur data, dengan menghantar dokumen YAML.

CONTOH

ikiwiki --setup my.setup

Bina wiki sepenuhnya (semula) menggunakan fail persediaan yang ditentukan.

ikiwiki --setup my.setup --refresh
Muat semula wiki, menggunakan tetapan daripada my.setup, dan elakkan membina semula mana-mana halaman yang
belum berubah. Ini lebih cepat.

ikiwiki --setup my.setup --refresh --wrappers
Muat semula wiki, termasuk menjana semula semua program pembalut, tetapi jangan bina semula
semua halaman. Berguna jika anda telah menukar sesuatu dalam fail persediaan yang tidak
memerlukan bina semula wiki penuh untuk mengemas kini semua halaman, tetapi yang anda mahu ambil dengan segera
kesan.

ikiwiki --bina semula srcdir destdir
Gunakan srcdir sebagai sumber dan bina HTML dalam destdir, tanpa menggunakan fail persediaan.

ikiwiki srcdir destdir
Gunakan srcdir sebagai sumber untuk mengemas kini HTML halaman yang diubah dalam destdir, tanpa menggunakan a
fail persediaan.

PERSEKITARAN

CC

Ini mengawal apa yang pengkompil C digunakan untuk membina pembalut. Lalai ialah 'cc'.

CFLAGS Ini boleh digunakan untuk menghantar pilihan kepada pengkompil C semasa membina pembalut.

Gunakan ikiwiki dalam talian menggunakan perkhidmatan onworks.net