ikiwiki - Daring di Awan

PROGRAM:

NAMA

ikiwiki - kompiler wiki

RINGKASAN

ikiwiki [opsi] tujuan sumber

ikiwiki --setup setupfile [opsi]

DESKRIPSI

ikiwiki adalah kompiler wiki. Itu membangun halaman HTML statis untuk wiki, dari sumber di
bahasa ikiwiki/Markdown (atau lainnya), dan menuliskannya ke tujuan.

Perhatikan bahwa sebagian besar opsi dapat disingkat menjadi satu huruf, tanda boolean seperti --verbose
dapat dinegasikan dengan --no-verbose, dan opsi seperti --verbose juga bisa dieja seperti
-verbose.

MODE PILIHAN

Opsi ini mengontrol mode operasi ikiwiki.

--menyegarkan
Segarkan wiki, perbarui halaman yang diubah. Ini adalah perilaku default jika tidak
tindakan mode lainnya ditentukan (tetapi perhatikan bahwa --setup adalah tindakan mode, dan memiliki
perilaku default yang berbeda).

--membangun kembali
Paksa pembangunan kembali semua halaman.

--setup file setup
Muat opsi dari file pengaturan yang diberikan. Jika tidak ada aksi mode lain yang ditentukan,
menghasilkan pembungkus dan membangun kembali wiki, seolah-olah --rebuild --wrappers digunakan. Jika
Anda hanya ingin membuat halaman yang diubah, Anda dapat menggunakan --refresh dengan --setup.

--changesetup file pengaturan
Membaca file setup, menambahkan perubahan konfigurasi yang ditentukan oleh opsi lain,
dan menulis konfigurasi baru kembali ke file setup. Juga perbarui apa saja
pembungkus yang dikonfigurasi. Dalam mode ini, wiki tidak sepenuhnya dibangun kembali, kecuali Anda juga
tambahkan --rebuild.

Contoh, untuk mengaktifkan beberapa plugin:

ikiwiki --perubahan pengaturan ~/ikiwiki.setup --plugin barang-barang --plugin kalender

--file pengaturan dumpsetup
Menyebabkan ikiwiki menulis ke file pengaturan yang ditentukan, membuang arusnya
konfigurasi.

--pembungkus
Jika digunakan dengan --setup --refresh, ini membuatnya juga memperbarui pembungkus yang dikonfigurasi.

--membersihkan
Ini membuat ikiwiki bersih dengan menghapus semua file yang dihasilkan di tujuan
direktori, serta pembungkus yang dikonfigurasi, dan direktori status .ikiwiki.
Ini sangat berguna jika Anda menjalankan ikiwiki di Makefile untuk membangun
dokumentasi dan menginginkan target bersih yang sesuai.

--cgi Mengaktifkan mode CGI. Dalam mode cgi, ikiwiki berjalan sebagai skrip cgi, dan mendukung pengeditan
halaman, masuk, dan pendaftaran.

Untuk menggunakan ikiwiki sebagai program CGI, Anda perlu menggunakan --wrapper atau --setup untuk menghasilkan a
pembungkus. Pembungkus umumnya perlu menjalankan suid 6755 ke pengguna yang memiliki
direktori sumber dan tujuan.

--pembungkus [berkas]
Hasilkan biner pembungkus yang di-hardcode untuk melakukan tindakan yang ditentukan oleh yang lain
pilihan, menggunakan file input dan direktori tujuan yang ditentukan. Nama file menjadi
gunakan untuk pembungkus adalah opsional.

Pembungkus dirancang untuk dibuat suid dengan aman dan dijalankan oleh pengguna yang tidak tepercaya, sebagai
kait pasca-komit, atau sebagai CGI.

Perhatikan bahwa pembungkus yang dihasilkan akan mengabaikan semua parameter baris perintah.

--agregat
Jika plugins/plugin agregat diaktifkan, ini membuat polling ikiwiki terkonfigurasi
feed dan menyimpan posting baru ke srcdir.

Perhatikan bahwa untuk membangun kembali posting yang dikumpulkan sebelumnya, gunakan opsi --rebuild bersama
dengan yang satu ini. --rebuild juga akan memaksa feed untuk disurvei meskipun itu
disurvei baru-baru ini.

--membuat berkas
Merender satu file, mengeluarkan html yang dihasilkan. Tidak menyimpan status, jadi ini
tidak dapat digunakan untuk membangun seluruh wiki, tetapi berguna untuk melihat pratinjau yang telah diedit
file di baris perintah. Umumnya digunakan bersama dengan --setup untuk memuat dalam a
pengaturan wiki:

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

--pasca-komit
Jalankan dalam mode pasca-komit, sama seperti jika dipanggil oleh kait pasca-komit. Ini adalah
mungkin hanya berguna saat menggunakan ikiwiki dengan server web di satu host dan a
repositori di tempat lain, untuk memungkinkan kait pasca-komit repositori yang sebenarnya ke ssh to
host server web dan jalankan ikiwiki secara manual untuk memperbarui situs web.

--Versi: kapan
Cetak nomor versi ikiwiki.

KONFIG PILIHAN

Opsi ini mengonfigurasi wiki. Perhatikan bahwa plugin dapat menambahkan konfigurasi tambahan
pilihan mereka sendiri. Semua opsi ini dan lainnya selain itu juga dapat dikonfigurasi menggunakan a
berkas pengaturan.

--nama wikiname
Nama wiki, defaultnya adalah "wiki".

--templateir dir
Tentukan direktori tempat template disimpan. Standarnya adalah
/usr/share/ikiwiki/templates, atau lokasi lain yang dikonfigurasi pada waktu pembuatan. Jika
templatedir diubah, template yang hilang akan tetap dicari di
lokasi default sebagai fallback. Template juga dapat ditempatkan di "templates/"
subdirektori dari srcdir.

Perhatikan bahwa jika Anda memilih untuk menyalin dan memodifikasi template ikiwiki, Anda harus
berhati-hatilah untuk selalu memperbaruinya saat memutakhirkan ikiwiki ke versi baru. Tua
versi templat tidak selalu berfungsi dengan versi ikiwiki baru.

--underlaydir dir
Tentukan direktori yang digunakan untuk mendasari direktori sumber. File sumber
akan diambil dari sini kecuali ditimpa oleh file di direktori sumber.
Defaultnya adalah /usr/share/ikiwiki/basewiki atau lokasi lain seperti yang dikonfigurasi di build
waktu.

--mode mode pembungkus
Tentukan mode untuk chmod pembungkus setelah membuatnya.

--wrappergroup grup
Tentukan grup unix apa yang harus dimiliki oleh pembungkus. Ini dapat berguna jika
wrapper harus dimiliki oleh grup selain default. Misalnya, jika
proyek memiliki repositori dengan banyak commiter dengan akses yang dikendalikan oleh a
grup, masuk akal jika pembungkus ikiwiki menjalankan setgid ke grup itu.

--rcs=svn|git|.., --no-rcs
Mengaktifkan atau menonaktifkan penggunaan revision_control_system.

Direktori sumber akan dianggap sebagai copy pekerjaan, atau kloning, atau apa pun
sistem kontrol revisi yang Anda pilih digunakan.

Dalam mode CGI, dengan sistem kontrol revisi yang diaktifkan, halaman yang diedit melalui web akan
berkomitmen.

Tidak ada kontrol revisi yang diaktifkan secara default.

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

--svnpath batang
Tentukan jalur di dalam repositori svn Anda di mana wiki berada. Ini
default ke bagasi; ubah jika wiki Anda berada di jalur lain di dalam
gudang. Jika wiki Anda di-root di bagian atas repositori, setel svnpath ke "".

--rss, --norss
Jika rss disetel, ikiwiki akan secara default menghasilkan umpan RSS untuk halaman yang sebaris
blog.

--izinkan
Jika allowrss disetel, dan rss tidak disetel, ikiwiki tidak akan menghasilkan RSS secara default
feed, tetapi pengaturan rss=yes di direktif sebaris dapat menimpa default ini dan
menghasilkan umpan.

--atom, --noatom
Jika atom disetel, ikiwiki akan secara default menghasilkan umpan Atom untuk halaman yang sebaris
sebuah blog.

--mengizinkan atom
Jika allowatom disetel, dan rss tidak disetel, ikiwiki tidak akan menghasilkan secara default
Umpan atom, tetapi pengaturan atom=yes dalam arahan sebaris dapat mengesampingkan default ini
dan menghasilkan umpan.

--pingurl URL
Setel ini ke URL layanan XML-RPC untuk melakukan ping saat umpan RSS diperbarui. Untuk
contoh, untuk melakukan ping ke Technorati, gunakan URL http://rpc.technorati.com/rpc/ping

Parameter ini dapat ditentukan beberapa kali untuk menentukan lebih dari satu URL untuk
ping

--URL URL
Menentukan URL ke wiki. Ini adalah parameter yang diperlukan dalam mode CGI.

--cgiurl http://example.org/ikiwiki.cgi
Menentukan URL ke pembungkus skrip CGI ikiwiki. Diperlukan saat membangun
wiki untuk tautan ke skrip cgi yang akan dibuat.

URL --historyurl
Menentukan URL yang akan ditautkan untuk penjelajahan riwayat halaman. Di URL, "[[file]]" adalah
diganti dengan file untuk browsing. Sudah umum menggunakan ViewVC untuk ini.

--adminmail [email dilindungi]
Menentukan alamat email yang harus digunakan ikiwiki untuk mengirim email.

--URL yang berbeda
Menentukan URL yang akan ditautkan untuk perbedaan perubahan pada halaman. Di URL-nya,
"[[file]]" diganti dengan file untuk dijelajahi, "[[r1]]" adalah revisi lama dari
halaman, dan "[[r2]]" adalah revisi baru. Sudah umum menggunakan ViewVC untuk ini.

--kecualikan regexp
Menentukan rexexp file sumber untuk dikecualikan dari pemrosesan. Dapat ditentukan
beberapa kali untuk ditambahkan ke daftar pengecualian.

--termasuk regexp
Menentukan rexexp file sumber, yang biasanya dikecualikan, tetapi Anda
ingin disertakan dalam pemrosesan. Dapat ditentukan beberapa kali untuk ditambahkan untuk disertakan
daftar.

--nama pengguna admin
Menentukan nama pengguna pengguna (atau, jika openid diaktifkan, openid) yang memiliki
kekuatan admin wiki. Saat ini memungkinkan penguncian halaman apa pun, dan melarang pengguna, sebagai
serta kekuatan yang diberikan oleh plugin yang diaktifkan (seperti [[memoderasi .]
comments|plugins/moderatedcomments]] dan plugins/websetup. Dapat ditentukan
beberapa kali untuk beberapa admin.

Untuk pengguna openid tentukan URL lengkap login, termasuk "http://".

--nama plugin
Mengaktifkan penggunaan plugin yang ditentukan di wiki. Perhatikan bahwa nama plugin adalah
hal - hal sensitif.

--nonaktifkan-nama plugin
Menonaktifkan penggunaan plugin. Misalnya "--disable-plugin htmlscrubber" untuk menghapus
dengan sanitasi HTML.

--libdir direktori
Membuat ikiwiki terlihat di direktori yang ditentukan terlebih dahulu, sebelum lokasi reguler
saat memuat file perpustakaan dan plugin. Misalnya, jika Anda mengatur libdir ke
"/home/you/.ikiwiki/", Anda dapat menginstal plugin foo.pm sebagai
"/home/you/.ikiwiki/IkiWiki/Plugin/foo.pm".

--diskusi, --tidak ada diskusi
Mengaktifkan atau menonaktifkan tautan "Diskusi" agar tidak ditambahkan ke header setiap
halaman. Tautan diaktifkan secara default.

--numbacklink n
Mengontrol berapa banyak backlink yang harus ditampilkan di bagian bawah halaman. Kelebihan
backlink akan disembunyikan dalam popup. Defaultnya adalah 10. Atur ke 0 untuk menonaktifkan ini
fitur.

--userdir subdirektori
Secara opsional, izinkan tautan ke pengguna wiki untuk menautkan ke halaman di dalam a
subdirektori wiki. Standarnya adalah menautkan ke halaman di direktori tingkat atas
dari wiki.

--htmlekst html
Mengonfigurasi ekstensi yang digunakan untuk file html yang dihasilkan. Standarnya adalah "html".

--format format waktu
Tentukan cara menampilkan waktu atau tanggal. String format diteruskan ke
waktu luang(3) fungsi.

--verbose, --tidak bertele-tele
Jadilah verbose tentang apa yang sedang dilakukan.

--syslog, --tidak-syslog
Masuk ke syslog(3).

--digunakan, --tidak-digunakan
Alihkan pembuatan file keluaran bernama page/index.html (default) alih-alih page.html.

--arahan-awalan, --arahan-tanpa-awalan
Alihkan sintaks awalan '!' baru untuk arahan praprosesor. ikiwiki saat ini
default ke --prefix-directives.

--w3mmode, --tidak-w3mmode
Aktifkan w3mmode, yang memungkinkan w3m menggunakan ikiwiki sebagai skrip CGI lokal, tanpa
server web.

--sslcookie
Hanya kirim cookie melalui koneksi SSL. Ini harus mencegah mereka menjadi
dicegat. Jika Anda mengaktifkan opsi ini maka Anda harus menjalankan setidaknya bagian CGI
ikiwiki melalui SSL.

--dapatkan waktu, --tidak-dapatkan waktu
Ekstrak waktu pembuatan dan modifikasi untuk setiap halaman baru dari revisi
log kontrol. Ini dilakukan secara otomatis saat membangun wiki untuk pertama kalinya,
jadi Anda biasanya tidak perlu menggunakan opsi ini.

--set var=nilai
Ini memungkinkan pengaturan variabel konfigurasi arbitrer, sama seperti jika disetel
melalui file pengaturan. Karena opsi yang paling umum digunakan dapat dikonfigurasi menggunakan
switch baris perintah, Anda jarang perlu menggunakan ini.

--set-yaml var=nilai
Ini seperti --set, tetapi memungkinkan pengaturan variabel konfigurasi yang menggunakan kompleks
struktur data, dengan mengirimkan dokumen YAML.

CONTOH

ikiwiki --setup my.setup

Sepenuhnya (kembali) bangun wiki menggunakan file pengaturan yang ditentukan.

ikiwiki --setup my.setup --segarkan
Segarkan wiki, menggunakan pengaturan dari my.setup, dan hindari membangun kembali halaman apa pun yang
belum berubah. Ini lebih cepat.

ikiwiki --setup my.setup --refresh --wrappers
Segarkan wiki, termasuk membuat ulang semua program pembungkus, tetapi jangan membangun kembali
semua halaman. Berguna jika Anda telah mengubah sesuatu di file pengaturan yang tidak
perlu pembangunan kembali wiki lengkap untuk memperbarui semua halaman, tetapi Anda ingin segera mengambilnya
efek.

ikiwiki --rebuild srcdir tujuan
Gunakan srcdir sebagai sumber dan buat HTML di destdir, tanpa menggunakan file setup.

ikiwiki srcdir tujuan
Gunakan srcdir sebagai sumber untuk memperbarui HTML halaman yang diubah di destdir, tanpa menggunakan a
berkas pengaturan.

LINGKUNGAN

CC

Ini mengontrol apa yang C compiler digunakan untuk membangun pembungkus. Standarnya adalah 'cc'.

CFLAGS Ini dapat digunakan untuk meneruskan opsi ke kompiler C saat membuat pembungkus.

Gunakan ikiwiki online menggunakan layanan onworks.net