Ini ialah perintah kemas kini-yorickdoc yang boleh dijalankan dalam penyedia pengehosan percuma OnWorks menggunakan salah satu daripada berbilang stesen kerja dalam talian percuma kami seperti Ubuntu Online, Fedora Online, emulator dalam talian Windows atau emulator dalam talian MAC OS.
JADUAL:
NAMA
update-yorickdoc - Bina dokumentasi HTML untuk Yorick
SINOPSIS
kemas kini-yorickdoc [--conf=fail] [--auto] [--auto-sekarang] [--dari=direktori] [--ke=direktori]
[--xref-dir=direktori] [--src-dir=direktori] [--template=fail]
DESCRIPTION
update-yorickdoc ialah pembalut di sekeliling htmldoc.i, skrip Yorick yang mengekstrak DOKUMEN
komen daripada fail sumber Yorick dan mengubahnya menjadi satu set fail HTML.
update-yorickdoc menggabungkan fail daripada "direktori sumber" (lalai: /usr/share/yorick-doc,
pilihan baris arahan: --src-dir), memadam direktori sasaran (lalai:
/usr/share/doc/yorick-doc/html_xref), dan, jika Yorick dipasang, panggil "yorick -batch
htmldoc.i" untuk menyusun dokumentasi HTML untuk semua fungsi yang sedang dipasang (sama ada
daripada pakej Yorick utama atau daripada pakej tambahan).
update-yorickdoc dimaksudkan untuk dipanggil secara automatik setiap kali pakej Yorick ada
dipasang atau dikeluarkan. Anda boleh menghalang kemas kini automatik dengan menetapkan "ENABLE_AUTO"
kepada 0 dalam /etc/yorick-doc. Ia juga mungkin untuk menggunakan update-yorickdoc secara manual untuk mencipta
dokumentasi daripada direktori tersuai (cth. milik pengguna sendiri ~/Yorick/ direktori) atau ke a
tempat adat, contohnya.
update-yorickdoc mempunyai set parameter lalai untuk berfungsi. Parameter ini adalah
ditulis ganti dalam susunan kronologi oleh kandungan /etc/yorick-doc, $HOME/.yorick-doc dan
baris arahan.
Beberapa fail diperlukan untuk skrip ini berfungsi. Fail lalai disediakan dalam
direktori sumber lalai, dan pakej tambahan harus menyediakan maklumat tambahan dalam
tempat yang sama. Lihat FILES di bawah serta /usr/share/doc/yorick-dev/yorick-policy.gz.
PILIHAN
--auto | -a
Bendera ini ditamatkan oleh kemunculan pencetus dalam dpkg. Pada sistem di mana dpkg
menyokong pencetus, -a menukar kemas kini-yorickdoc menjadi no-op. Pada sistem yang lebih lama, ia
berkelakuan seperti -A di bawah.
--auto-sekarang | -A
Bendera ini dimaksudkan untuk digunakan hanya dalam skrip postinst bagi pakej yorick-doc,
giliran yang sepatutnya dicetuskan setiap kali pakej tambahan yorick
dipasang, dinaik taraf atau dialih keluar. Ia adalah mungkin untuk menukar update-yorickdoc menjadi no-op
apabila bendera ini ditetapkan dengan menetapkan ENABLE_AUTO kepada 0 dalam /etc/yorick-doc.
--conf=fail
Baca konfigurasi daripada fail ini. Fail ini dihuraikan kerana pilihan ditemui pada
baris arahan, menimpa pilihan yang datang sebelum ini.
--dari=direktori1:direktori2...
Senarai direktori yang dipisahkan kolon untuk mengimbas fail Yorick. Lalai:
/usr/share/yorick/i:/usr/share/yorick/i0.
--bersihkan | -p
Hanya padam /usr/share/doc/yorick-doc/html_xref (atau set direktori menggunakan --to dan
--xref-dir, atau pembolehubah yang setara dalam /etc/yorick-doc), jangan bina semula
dokumentasi selepas itu.
--senyap | -q
Senyap, hanya beritahu sebentar lagi perkara yang dilakukan oleh update-yorickdoc. Ini adalah terbina dalam
lalai tetapi mungkin telah diganti dalam fail konfigurasi.
--src-dir=direktori
Direktori yang mengandungi fail .packinfo, .keywords dan .aliases semasa membina fail
dokumentasi. Setiap satu daripada tiga jenis fail ini akan digabungkan
susunan leksikografik dan disuap ke htmldoc.i menggunakan --packinfo, --keywords, dan
--aliases pilihan (lihat htmldoc.i). Lalai: /usr/share/yorick-doc.
--template=fail
Fail templat untuk htmldoc.i. Format yang betul ialah htmldoc.i terperinci. Lalai:
/usr/share/yorick-doc/template.html.
--ke=direktori
Direktori peringkat atas hierarki HTML Yorick untuk dikemas kini. Ini adalah satu tahap di atas
direktori yang akan dipadamkan dan/atau (dibina semula). Lalai kepada
/usr/share/doc/yorick-doc.
--verbose | -v
Bersikap kasar, mengeluarkan banyak maklumat penyahpepijatan. Lalai terbina dalam adalah menjadi
senyap, hanya memberitahu sebentar apa yang dilakukan oleh update-yorickdoc.
--xref-dir=perkataan
Subdirektori bagi direktori "TO" untuk menyusun dokumentasi. pasti
hiperpautan dalam dokumentasi akan menggunakan nilai ini. Ini tidak sepatutnya ditetapkan kepada a
direktori yang kandungannya anda hargai, kerana direktori ini akan dipadamkan dahulu. Lalai:
html_xref.
Gunakan kemas kini-yorickdoc dalam talian menggunakan perkhidmatan onworks.net
