นี่คือคำสั่ง update-yorickdoc ที่สามารถเรียกใช้ในผู้ให้บริการโฮสต์ฟรีของ OnWorks โดยใช้หนึ่งในเวิร์กสเตชันออนไลน์ฟรีของเรา เช่น Ubuntu Online, Fedora Online, โปรแกรมจำลองออนไลน์ของ Windows หรือโปรแกรมจำลองออนไลน์ของ MAC OS
โครงการ:
ชื่อ
update-yorickdoc - สร้างเอกสาร HTML สำหรับ Yorick
เรื่องย่อ
อัพเดท-yorickdoc [--conf=ไฟล์] [--อัตโนมัติ] [--auto-ตอนนี้] [--จาก=ไดเรกทอรี] [--ถึง=ไดเรกทอรี]
[--xref-dir=ไดเรกทอรี] [--src-dir=ไดเรกทอรี] [--แม่แบบ=ไฟล์]
DESCRIPTION
update-yorickdoc เป็น wrapper รอบ htmldoc.i ซึ่งเป็นสคริปต์ Yorick ที่แยก DOCUMENT
ความคิดเห็นจากไฟล์ต้นทาง Yorick และเปลี่ยนเป็นชุดของไฟล์ HTML
update-yorickdoc รวมไฟล์จาก "ไดเรกทอรีต้นทาง" (ค่าเริ่มต้น: /usr/share/yorick-doc,
ตัวเลือกบรรทัดคำสั่ง: --src-dir) ลบไดเรกทอรีเป้าหมาย (ค่าเริ่มต้น:
/usr/share/doc/yorick-doc/html_xref) และหากติดตั้ง Yorick ไว้ ให้เรียก "yorick -batch
htmldoc.i" เพื่อรวบรวมเอกสาร HTML สำหรับฟังก์ชันทั้งหมดที่ติดตั้งอยู่ในปัจจุบัน (
จากแพ็คเกจ Yorick หลักหรือจากแพ็คเกจเสริม)
update-yorickdoc มีไว้เพื่อให้เรียกโดยอัตโนมัติเมื่อใดก็ตามที่แพ็คเกจ Yorick เป็น
ติดตั้งหรือถอดออก เป็นไปได้ที่จะป้องกันการอัปเดตอัตโนมัติโดยการตั้งค่า "ENABLE_AUTO"
เป็น 0 ใน /etc/yorick-doc. นอกจากนี้ยังสามารถใช้ update-yorickdoc ด้วยตนเองเพื่อสร้าง
เอกสารจากไดเร็กทอรีที่กำหนดเอง (เช่น ของผู้ใช้เอง ~/ยอร์ค/ ไดเร็กทอรี) หรือไปที่a
สถานที่ที่กำหนดเองเช่น
update-yorickdoc มีชุดของพารามิเตอร์เริ่มต้นที่จะใช้งานได้ พารามิเตอร์เหล่านี้คือ
เขียนทับตามลำดับเวลาโดยเนื้อหา /etc/yorick-doc, $HOME/.yorick-doc และ
บรรทัดคำสั่ง
สคริปต์นี้จำเป็นต้องใช้ไฟล์สองสามไฟล์ ไฟล์เริ่มต้นมีอยู่ในไฟล์
ไดเร็กทอรีต้นทางเริ่มต้นและแพ็คเกจเสริมควรให้ข้อมูลเพิ่มเติมใน
ที่เดียวกัน ดู ไฟล์ ด้านล่างเช่นเดียวกับ /usr/share/doc/yorick-dev/yorick-policy.gz
OPTIONS
--อัตโนมัติ | -a
แฟล็กนี้กำลังเลิกใช้เมื่อทริกเกอร์ใน dpkg มาถึง บนระบบที่dpkg
รองรับทริกเกอร์ -a เปลี่ยน update-yorickdoc เป็น no-op ในระบบเก่ามัน
มีลักษณะเหมือน -A ด้านล่าง
--auto-ตอนนี้ | -A
แฟล็กนี้มีขึ้นเพื่อใช้ในสคริปต์ postinst ของแพ็คเกจ yorick-doc เท่านั้น
ซึ่งควรจะทริกเกอร์ทุกครั้งที่มีแพ็คเกจเสริม yorick เป็น
ติดตั้ง อัปเกรด หรือลบออก เป็นไปได้ที่จะเปลี่ยน update-yorickdoc เป็น no-op
เมื่อตั้งค่าสถานะนี้โดยการตั้งค่า ENABLE_AUTO เป็น 0 ใน /etc/yorick-doc
--conf=ไฟล์
อ่านการกำหนดค่าจากไฟล์นี้ ไฟล์นี้แยกวิเคราะห์เมื่อพบตัวเลือกใน
บรรทัดคำสั่ง เขียนทับตัวเลือกที่มาก่อน
--จาก=ไดเร็กทอรี1:ไดเร็กทอรี2...
รายการไดเร็กทอรีที่คั่นด้วยเครื่องหมายโคลอนเพื่อสแกนหาไฟล์ Yorick ค่าเริ่มต้น:
/usr/share/yorick/i:/usr/share/yorick/i0.
--ล้าง | -p
ลบเฉพาะ /usr/share/doc/yorick-doc/html_xref (หรือไดเร็กทอรีที่ตั้งค่าโดยใช้ --to และ
--xref-dir หรือตัวแปรที่เทียบเท่าใน /etc/yorick-doc) อย่าสร้าง .ขึ้นใหม่
เอกสารในภายหลัง
--เงียบ | -q
เงียบไว้ เพียงบอกสั้นๆ ว่า update-yorickdoc ทำอะไรได้บ้าง นี่คือตัวใน
ค่าเริ่มต้น แต่อาจถูกแทนที่ในไฟล์การกำหนดค่า
--src-dir=ไดเรกทอรี
ไดเร็กทอรีที่มีไฟล์ .packinfo, .keywords และ .aliases เมื่อสร้างไฟล์
เอกสาร ไฟล์ทั้งสามประเภทนี้จะถูกต่อเข้าด้วยกันใน
ลำดับศัพท์และป้อน htmldoc.i โดยใช้ --packinfo, --keywords และ
--aliases ตัวเลือก (ดู htmldoc.i) ค่าเริ่มต้น: /usr/share/yorick-doc.
--แม่แบบ=ไฟล์
ไฟล์เทมเพลตสำหรับ htmldoc.i รูปแบบที่ถูกต้องมีรายละเอียด htmldoc.i ค่าเริ่มต้น:
/usr/share/yorick-doc/template.html
--ถึง=ไดเรกทอรี
ไดเร็กทอรีระดับบนสุดของลำดับชั้น Yorick HTML ที่จะอัปเดต นี่คือระดับที่สูงกว่า
ไดเร็กทอรีที่จะถูกลบและ/หรือ (สร้างใหม่) ค่าเริ่มต้นเป็น
/usr/share/doc/yorick-doc
--รายละเอียด | -v
ละเอียด แสดงข้อมูลการดีบักจำนวนมาก ค่าดีฟอลต์ในตัวคือเป็น
เงียบ แค่บอกสั้นๆ ว่า update-yorickdoc ทำอะไร
--xref-dir=word
ไดเร็กทอรีย่อยของไดเร็กทอรี "TO" ที่จะรวบรวมเอกสารประกอบ แน่ใจ
ไฮเปอร์ลิงก์ในเอกสารประกอบจะใช้ค่านี้ ไม่ควรตั้งค่านี้เป็น
ไดเร็กทอรีที่มีเนื้อหาที่คุณให้ความสำคัญ เนื่องจากไดเร็กทอรีนี้จะถูกลบก่อน ค่าเริ่มต้น:
html_xref.
ใช้ update-yorickdoc ออนไลน์โดยใช้บริการ onworks.net
