มีมาตรฐานในการเขียนคำสั่งสรุปหรือไม่?

ปรากฏว่าฉันทุกคนมีความคิดของตัวเองเกี่ยวกับวิธีการเขียนเรื่องย่อที่อธิบายการใช้คำสั่งสำหรับผู้ใช้

ตัวอย่างเช่นนี่คือรูปแบบจากman grep:

grep [OPTIONS] PATTERN [FILE...]
grep [OPTIONS] [-e PATTERN | -f FILE] [FILE...]

ตอนนี้มีไวยากรณ์ที่ปรากฏใน manpages อื่น ๆ []ได้รับการยอมรับว่าเป็นทางเลือกและมี...ความหมายเหมือนกับอินพุตหลายตัว

แต่คนใช้|หรือ/เพื่อหรือและมีคนอื่น ๆ ที่จะกลับสิ่งที่[]หมายถึง หรือพวกเขาไม่ให้ข้อบ่งชี้ใด ๆ ที่เป็นที่[OPTIONS]ไป

ฉันต้องการทำตามมาตรฐานสำหรับสิ่งที่ฉันเขียน แต่ทุกเว็บไซต์ที่ฉันดูจะบอกสิ่งที่แตกต่าง

มีวิธีมาตรฐานที่เป็นจริงในการเขียนบทสรุปหรือเป็นแบบแผนเพียงแค่สิ่งที่ผู้คนได้ทำเมื่อเวลาผ่านไป?

command-line man

— Tormyst
แหล่งที่มา

เลือกอย่างใดอย่างหนึ่งและติดกับมัน

— Kevin

ด้วยเหตุผลบางอย่างฉันไม่คิดว่าจะช่วยอะไร ทุกคนจะมีมาตรฐานของตัวเองแล้วไม่มีอะไรทำเลย

— Tormyst

นี่คือมาตรฐานที่คุณหมายถึงใช่ไหม pubs.opengroup.org/onlinepubs/009695399/basedefs/…

— Mark Plotnick

ใช่นี่คือสิ่งที่ฉันกำลังมองหา ขอขอบคุณ.

— Tormyst

@ MarkPlotnick - ฉันต้องการให้ A เพื่อให้ OP ยอมรับได้ นั่นเป็นมาตรฐานหากเคยมีหนึ่ง อ้างอิงลิงค์ที่อ้างอิงÉ

— slm

มาตรฐานแบบคลาสสิกสำหรับสิ่งนี้คือจาก POSIX, ไวยากรณ์อาร์กิวเมนต์ของอรรถประโยชน์ (ขอบคุณ @ illuminÉสำหรับลิงก์ที่อัปเดต) มันอธิบายไวยากรณ์ที่จะใช้ในหน้าคนเช่น

utility_name[-a][-b][-c option_argument]
    [-d|-e][-f[option_argument]][operand...]

เป็นแบบคลาสสิกแนะนำให้ใช้ตัวเลือกอักขระเดียวพร้อมกับ-Wแนะนำให้ใช้โดยผู้ขายและนั่นคือวิธีที่ตัวเลือกหลายตัวรองรับ (ดูตัวอย่างgcc Option Summary )

ซอฟแวร์ GNU --แนะนำตัวเลือกหลายตัวละครที่เริ่มต้นด้วย หลักเกณฑ์บางประการจาก GNU การจัดรูปแบบหน้าคนที่มีตัวเลือกที่สามารถพบได้ในการอ้างอิง help2man

— มาร์ค Plotnick
แหล่งที่มา