นี่คือคำสั่ง pod2man ที่สามารถเรียกใช้ในผู้ให้บริการโฮสต์ฟรีของ OnWorks โดยใช้หนึ่งในเวิร์กสเตชันออนไลน์ฟรีของเรา เช่น Ubuntu Online, Fedora Online, โปรแกรมจำลองออนไลน์ของ Windows หรือโปรแกรมจำลองออนไลน์ของ MAC OS
โครงการ:
ชื่อ
pod2man - แปลงข้อมูล POD เป็นฟอร์แมต *roff input
เรื่องย่อ
พ็อดทูแมน [--ศูนย์กลาง=เชือก] [--วันที่=เชือก] [--ข้อผิดพลาด=สไตล์]
[--แก้ไขแล้ว=ตัวอักษร] [--คงตัวหนา=ตัวอักษร] [--แก้ไขตัว=ตัวอักษร]
[--แก้ไขตัวหนา=ตัวอักษร] [--ชื่อ=พร้อมชื่อ] [--nourls]
[--เป็นทางการ] [--คำพูด=คำพูด] [--ปล่อย[=รุ่น]]
[--ส่วน=ถัดไป] [--สแตเดอร์] [--utf8] [--รายละเอียด]
[อินพุต [เอาท์พุต-
พ็อดทูแมน --ช่วยด้วย
DESCRIPTION
พ็อดทูแมน เป็น front-end สำหรับ Pod::Man ที่ใช้เพื่อสร้าง *roff input จากแหล่ง POD
ผลลัพธ์ที่ได้ *รหัส roff เหมาะสำหรับการแสดงผลบนเทอร์มินัลโดยใช้ ไม่(1) โดยปกติ
ผ่านทาง มนุษย์(1) หรือการพิมพ์โดยใช้ troff(1)
อินพุต เป็นไฟล์ที่จะอ่านสำหรับซอร์ส POD (สามารถฝัง POD ในโค้ดได้) ถ้า อินพุต
ไม่ได้กำหนดไว้ ค่าเริ่มต้นคือ "STDIN" เอาท์พุตถ้าให้ไว้เป็นไฟล์ที่จะเขียน
เอาต์พุตที่จัดรูปแบบ ถ้า เอาท์พุต ไม่ได้รับ เอาต์พุตที่จัดรูปแบบจะถูกเขียนไปยัง "STDOUT"
สามารถประมวลผลไฟล์ POD หลายไฟล์พร้อมกันได้ พ็อดทูแมน การร้องขอ (บันทึกโหลดโมดูลและ
เวลารวบรวม) โดยให้ .หลายคู่ อินพุต และ เอาท์พุต ไฟล์บนบรรทัดคำสั่ง
--ส่วน, --ปล่อย, --ศูนย์กลาง, --วันที่และ --เป็นทางการ สามารถใช้เพื่อตั้งค่าส่วนหัวและ
ส่วนท้ายที่จะใช้; ถ้าไม่ได้รับ Pod::Man จะถือว่าค่าเริ่มต้นต่างๆ ดูด้านล่างหรือ
Pod::ผู้ชายสำหรับรายละเอียด.
พ็อดทูแมน ถือว่า *roff ฟอร์แมตเตอร์ของคุณมีแบบอักษรความกว้างคงที่ที่ชื่อว่า "CW" ถ้าคุณ
เรียกว่าอย่างอื่น (เช่น "CR") ใช้ --แก้ไขแล้ว เพื่อระบุ นี้โดยทั่วไปเท่านั้น
เรื่องสำหรับการส่งออก troff สำหรับการพิมพ์ ในทำนองเดียวกัน คุณสามารถตั้งค่าแบบอักษรที่ใช้เป็นตัวหนา
เอาต์พุตความกว้างคงที่ตัวเอียงและตัวหนา
นอกจากการแปลงพ็อดที่ชัดเจนแล้ว Pod::Man และด้วยเหตุนี้ pod2man จึงดูแล
การจัดรูปแบบ ฟังก์ชัน (), func(n) และการอ้างอิงตัวแปรอย่างง่าย เช่น $foo หรือ @bar ดังนั้นคุณคงไม่
ต้องใช้รหัสหนีสำหรับพวกเขา นิพจน์ที่ซับซ้อนเช่น $fred{'stuff'} ยังคงต้องการ
ที่จะหลบหนีแม้ว่า นอกจากนี้ยังแปลขีดกลางที่ไม่ได้ใช้เป็นยัติภังค์เป็น en
ขีดคั่น ทำให้ขีดกลางยาว - เช่นนี้ - เป็นเครื่องหมายขีดกลางที่ถูกต้อง แก้ไข "เครื่องหมายคำพูดที่จับคู่" และ
ดูแลการปรับแต่งเฉพาะ troff อื่นๆ อีกหลายรายการ ดู Pod::Man สำหรับข้อมูลทั้งหมด
OPTIONS
-c เชือก, --ศูนย์กลาง=เชือก
ตั้งค่าส่วนหัวของหน้าตรงกลางเป็น เชือก. ค่าเริ่มต้นคือ "ผู้ใช้มีส่วนร่วม Perl
เอกสารประกอบ" แต่ยังดู --เป็นทางการ ด้านล่าง
-d เชือก, --วันที่=เชือก
ตั้งค่าสตริงส่วนท้ายด้านซ้ายเป็นค่านี้ โดยค่าเริ่มต้น วันที่แก้ไขของ
ไฟล์อินพุตจะถูกใช้หรือวันที่ปัจจุบันหากอินพุตมาจาก "STDIN" และ will
อิงตาม UTC (เพื่อให้เอาต์พุตสามารถทำซ้ำได้โดยไม่คำนึงถึงเวลาท้องถิ่น
โซน).
-ข้อผิดพลาด=สไตล์
กำหนดรูปแบบการจัดการข้อผิดพลาด "die" บอกว่าจะโยนข้อยกเว้นในการจัดรูปแบบ POD ใด ๆ
ข้อผิดพลาด. "stderr" บอกว่าจะรายงานข้อผิดพลาดเกี่ยวกับข้อผิดพลาดมาตรฐาน แต่จะไม่ส่ง an
ข้อยกเว้น "พ็อด" ระบุว่าจะรวมส่วนข้อผิดพลาดของ POD ไว้ในเอกสารผลลัพธ์
สรุปข้อผิดพลาด "ไม่มี" ละเว้นข้อผิดพลาด POD ทั้งหมด ให้มากที่สุด
ค่าเริ่มต้นคือ "ตาย"
--แก้ไขแล้ว=ตัวอักษร
แบบอักษรความกว้างคงที่ที่จะใช้สำหรับข้อความและโค้ดแบบคำต่อคำ ค่าเริ่มต้นเป็น "CW" บาง
ระบบอาจต้องการ "CR" แทน เท่านั้นที่สำคัญสำหรับ troff(1) การส่งออก
--คงตัวหนา=ตัวอักษร
แบบอักษรความกว้างคงที่เวอร์ชันตัวหนา ค่าเริ่มต้นเป็น "CB" เท่านั้นที่สำคัญสำหรับ troff(1)
เอาท์พุต
--แก้ไขตัว=ตัวอักษร
แบบอักษรความกว้างคงที่เวอร์ชันตัวเอียง (อันที่จริง เป็นการเรียกชื่อผิดเนื่องจากส่วนใหญ่
แบบอักษรความกว้างคงที่มีเฉพาะเวอร์ชันเอียง ไม่ใช่เวอร์ชันตัวเอียง) ค่าเริ่มต้นเป็น
"ซีไอ" เท่านั้นที่สำคัญสำหรับ troff(1) การส่งออก
--แก้ไขตัวหนา=ตัวอักษร
แบบอักษรความกว้างคงที่เวอร์ชันตัวเอียงหนา (อาจเอียงจริง) พ็อด::แมน
ไม่ได้ถือว่าคุณมีสิ่งนี้ และมีค่าเริ่มต้นเป็น "CB" บางระบบ (เช่น Solaris)
มีแบบอักษรนี้เป็น "CX" เท่านั้นที่สำคัญสำหรับ troff(1) การส่งออก
-h, --ช่วยด้วย
พิมพ์ข้อมูลการใช้งาน
-l, --หละหลวม
ไม่ใช้อีกต่อไป พ็อดทูแมน ใช้เพื่อตรวจสอบความถูกต้องของอินพุตเป็นหน้าคู่มือ แต่
ตอนนี้ควรทำโดย Podchecker(1) แทน ยอมรับสำหรับการย้อนกลับ
ความเข้ากันได้; ตัวเลือกนี้ไม่ได้ทำอะไรอีกต่อไป
-n พร้อมชื่อ, --ชื่อ=พร้อมชื่อ
ตั้งชื่อหน้าคู่มือเป็น พร้อมชื่อ. หากไม่มีตัวเลือกนี้ ชื่อคู่มือจะถูกตั้งค่า
เป็นชื่อฐานตัวพิมพ์ใหญ่ของไฟล์ที่กำลังแปลงเว้นแต่ส่วนคู่มือคือ
3 ซึ่งในกรณีนี้พาธจะถูกแยกวิเคราะห์เพื่อดูว่าเป็นพาธของโมดูล Perl หรือไม่ ถ้าใช่ a
เส้นทางเช่น ".../lib/Pod/Man.pm" ถูกแปลงเป็นชื่อเช่น "Pod::Man" ตัวเลือกนี้
หากได้รับ จะแทนที่การกำหนดชื่อโดยอัตโนมัติ
โปรดทราบว่าตัวเลือกนี้อาจไม่มีประโยชน์เมื่อแปลงไฟล์ POD หลายไฟล์ที่
ครั้งหนึ่ง. แบบแผนสำหรับหน้า man ของ Unix สำหรับคำสั่งคือให้ชื่อหน้า man เป็น
ตัวพิมพ์ใหญ่ทั้งหมดแม้ว่าคำสั่งจะไม่ใช่
เมื่อแปลงแหล่ง POD จากอินพุตมาตรฐาน จำเป็นต้องใช้ตัวเลือกนี้ เนื่องจากมี
มิฉะนั้นจะไม่มีทางรู้ว่าจะใช้อะไรเป็นชื่อหน้าคู่มือได้
--nourls
โดยปกติ L<> จัดรูปแบบโค้ดด้วย URL แต่ anchor text ถูกจัดรูปแบบเพื่อแสดงทั้งสอง
ข้อความจุดยึดและ URL กล่าวอีกนัยหนึ่ง:
หลี่http://example.com/>
ถูกจัดรูปแบบเป็น:
ฟูhttp://example.com/>
แฟล็กนี้ หากกำหนดไว้ จะระงับ URL เมื่อระบุ anchor text ดังนั้นตัวอย่างนี้
จะถูกจัดรูปแบบเป็นเพียงแค่ "foo" ซึ่งจะทำให้ผลผลิตที่รกน้อยลงในกรณี
โดยที่ URL ไม่ได้มีความสำคัญเป็นพิเศษ
-o, --เป็นทางการ
ตั้งค่าส่วนหัวเริ่มต้นเพื่อระบุว่าหน้านี้เป็นส่วนหนึ่งของ Perl . มาตรฐาน
ปล่อย ถ้า --ศูนย์กลาง ยังไม่ได้รับ
-q คำพูด, --คำพูด=คำพูด
ตั้งค่าเครื่องหมายคำพูดที่ใช้ล้อมรอบข้อความ C<> เป็น คำพูด. ถ้า คำพูด เป็นโสด
ตัวอักษร มันถูกใช้เป็นทั้งคำพูดซ้ายและขวา; ถ้า คำพูด เป็นสองตัวอักษร,
อักขระตัวแรกใช้เป็นเครื่องหมายคำพูดด้านซ้ายและตัวที่สองเป็นเครื่องหมายคำพูดด้านขวา และ
if คำพูด คือสี่ตัวอักษรสองตัวแรกใช้เป็นเครื่องหมายคำพูดด้านซ้ายและตัวที่สอง
สองเป็นคำพูดที่ถูกต้อง
คำพูด อาจถูกตั้งค่าพิเศษเป็น "ไม่มี" ซึ่งในกรณีนี้ไม่มีเครื่องหมายอัญประกาศ
เพิ่มรอบข้อความ C<> (แต่ฟอนต์ยังคงเปลี่ยนสำหรับเอาต์พุต troff)
-r, --ปล่อย
ตั้งส่วนท้ายไว้ตรงกลาง โดยค่าเริ่มต้น นี่คือเวอร์ชันของ Perl ที่คุณเรียกใช้ พ็อดทูแมน
ภายใต้. โปรดทราบว่าระบบบางชุดของมาโครถือว่าส่วนท้ายที่อยู่กึ่งกลางจะเป็นa
วันที่แก้ไขและจะเติมหน้าเช่น "Last modified: "; ถ้านี่คือ
กรณีคุณอาจต้องการตั้งค่า --ปล่อย จนถึงวันที่แก้ไขล่าสุดและ --วันที่ ไป
หมายเลขรุ่น
-s, --ส่วน
ตั้งค่าส่วนสำหรับมาโคร ".TH" แบบแผนการกำหนดหมายเลขมาตราฐานคือ
ใช้ 1 สำหรับคำสั่งผู้ใช้ 2 สำหรับการเรียกใช้ระบบ 3 สำหรับฟังก์ชัน 4 สำหรับอุปกรณ์ 5 สำหรับ
รูปแบบไฟล์, 6 สำหรับเกม, 7 สำหรับข้อมูลเบ็ดเตล็ด และ 8 สำหรับผู้ดูแลระบบ
คำสั่ง อย่างไรก็ตามมีความแตกต่างมากมายที่นี่ บางระบบ (เช่น Solaris) ใช้
4 สำหรับรูปแบบไฟล์ 5 สำหรับข้อมูลเบ็ดเตล็ด และ 7 สำหรับอุปกรณ์ ยังมีคนอื่น
ใช้ 1m แทน 8 หรือทั้งสองอย่างผสมกัน เกี่ยวกับหมายเลขส่วนเท่านั้นที่เป็น
ความสม่ำเสมอที่เชื่อถือได้คือ 1, 2 และ 3
ตามค่าเริ่มต้น ส่วนที่ 1 จะถูกใช้เว้นแต่ไฟล์จะลงท้ายด้วย ".pm" ซึ่งในกรณีนี้
ส่วนที่ 3 จะถูกเลือก
--สแตเดอร์
โดยค่าเริ่มต้น พ็อดทูแมน ตายหากตรวจพบข้อผิดพลาดใด ๆ ในอินพุต POD ถ้า --สแตเดอร์ is
ให้และไม่ --ข้อผิดพลาด มีแฟล็กอยู่ ข้อผิดพลาดจะถูกส่งไปยังข้อผิดพลาดมาตรฐาน แต่ พ็อดทูแมน
ไม่ยกเลิก เทียบเท่ากับ "--errors=stderr" และรองรับการย้อนกลับ
ความเข้ากันได้
-u, --utf8
โดยค่าเริ่มต้น พ็อดทูแมน สร้างผลลัพธ์ที่ระมัดระวังที่สุดเท่าที่จะเป็นไปได้ * roff เพื่อพยายาม
ตรวจสอบให้แน่ใจว่ามันจะทำงานร่วมกับ *roff การใช้งานที่แตกต่างกันมากที่สุดเท่าที่จะเป็นไปได้
การใช้งาน *roff จำนวนมากไม่สามารถจัดการอักขระที่ไม่ใช่ ASCII ได้ ดังนั้นนี่จึงหมายถึงทั้งหมดที่ไม่ใช่
อักขระ ASCII จะถูกแปลงเป็นลำดับหลีก *roff ที่พยายามสร้าง
อักขระที่เน้นเสียงอย่างเหมาะสม (อย่างน้อยสำหรับเอาต์พุต troff) หรือ "X"
ตัวเลือกนี้บอกว่าจะส่งออกอักขระ UTF-8 ตามตัวอักษรแทน ถ้า *roff . ของคุณ
การใช้งานสามารถจัดการได้ นี่คือรูปแบบผลลัพธ์ที่ดีที่สุดที่จะใช้และหลีกเลี่ยง
ความเสียหายของเอกสารที่มีอักขระที่ไม่ใช่ ASCII อย่างไรก็ตาม ขอเตือนว่า
*แหล่งที่มา roff ที่มีอักขระ UTF-8 ตามตัวอักษรไม่ได้รับการสนับสนุนโดยการใช้งานจำนวนมาก
และอาจส่งผลให้เกิดความผิดพลาดและพฤติกรรมที่ไม่ดีอื่นๆ
โปรดทราบว่าเมื่อใช้ตัวเลือกนี้ การเข้ารหัสอินพุตของแหล่ง POD ของคุณต้องเป็น
ประกาศอย่างถูกต้องเว้นแต่เป็น US-ASCII หรือ Latin-1 อินพุต POD ที่ไม่มี "=encoding"
คำสั่งจะถือว่าเป็นภาษาละติน-1 และหากเป็น UTF-8 จริง ผลลัพธ์
จะถูกเข้ารหัสสองครั้ง ดู เพิร์ลพอด(1) สำหรับข้อมูลเพิ่มเติมเกี่ยวกับ "=encoding"
คำสั่ง
-v, --รายละเอียด
พิมพ์ชื่อไฟล์เอาต์พุตแต่ละไฟล์ในขณะที่กำลังสร้าง
EXIT สถานภาพ
ตราบใดที่เอกสารทั้งหมดที่ประมวลผลส่งผลให้เกิดผลลัพธ์บางอย่าง แม้ว่าผลลัพธ์นั้นรวมถึง
errata (ส่วน "ข้อผิดพลาด POD" ที่สร้างด้วย "--errors=pod") พ็อดทูแมน จะออกด้วย
สถานะ 0 หากเอกสารใด ๆ ที่กำลังดำเนินการไม่ส่งผลให้เป็นเอกสารส่งออก
พ็อดทูแมน จะออกพร้อมสถานะ 1 หากมีข้อผิดพลาดทางไวยากรณ์ในเอกสาร POD เป็น
ประมวลผลและรูปแบบการจัดการข้อผิดพลาดถูกตั้งค่าเป็นค่าเริ่มต้นของ "ตาย" พ็อดทูแมน จะยกเลิก
ทันทีพร้อมสถานะออก 255
วินิจฉัย
If พ็อดทูแมน ล้มเหลวโดยมีข้อผิดพลาด โปรดดู Pod::Man and Pod::Simple สำหรับข้อมูลเกี่ยวกับ what
ข้อผิดพลาดเหล่านั้นอาจหมายถึง
ตัวอย่าง
โปรแกรม pod2man > program.1
pod2man SomeModule.pm /usr/perl/man/man3/SomeModule.3
pod2man --section=7 note.pod > note.7
หากคุณต้องการพิมพ์ man page จำนวนมากอย่างต่อเนื่อง คุณอาจต้องการตั้งค่า
C และ D ลงทะเบียนเพื่อกำหนดหมายเลขหน้าที่ต่อเนื่องกันและหน้าคู่/คี่ อย่างน้อยใน
. บางเวอร์ชั่น มนุษย์(7)
troff -man -rC1 -rD1 perl.1 perldata.1 perlsyn.1 ...
ในการรับรายการดัชนีใน "STDERR" ให้เปิดการลงทะเบียน F เช่นใน:
ทรอฟฟ์ -แมน -rF1 perl.1
การจัดทำดัชนีจะแสดงข้อความผ่าน ".tm" สำหรับแต่ละหน้าหลัก ส่วนย่อย
รายการ และคำสั่ง "X<>" ใดๆ ดู Pod::Man สำหรับรายละเอียดเพิ่มเติม
ใช้ pod2man ออนไลน์โดยใช้บริการ onworks.net
