ทำความเข้าใจเรื่องย่อใน manpage


27

ฉันไม่สามารถเข้าใจส่วน SYNOPSIS ใน manpage ของคำสั่ง ตัวอย่างเช่นลองดู manpage ของmanตัวเอง โดยman man:

SYNOPSIS
       man  [-C  file]  [-d]  [-D]  [--warnings[=warnings]]  [-R encoding] [-L
       locale] [-m system[,...]] [-M path] [-S list]  [-e  extension]  [-i|-I]
       [--regex|--wildcard]   [--names-only]  [-a]  [-u]  [--no-subpages]  [-P
       pager] [-r prompt] [-7] [-E encoding] [--no-hyphenation] [--no-justifi‐
       cation]  [-p  string]  [-t]  [-T[device]]  [-H[browser]] [-X[dpi]] [-Z]
       [[section] page ...] ...
       man -k [apropos options] regexp ...
       man -K [-w|-W] [-S list] [-i|-I] [--regex] [section] term ...
       man -f [whatis options] page ...
       man -l [-C file] [-d] [-D] [--warnings[=warnings]]  [-R  encoding]  [-L
       locale]  [-P  pager]  [-r  prompt]  [-7] [-E encoding] [-p string] [-t]
       [-T[device]] [-H[browser]] [-X[dpi]] [-Z] file ...
       man -w|-W [-C file] [-d] [-D] page ...
       man -c [-C file] [-d] [-D] page ...
       man [-hV]
  1. ส่วน SYNOPSIS อธิบายไวยากรณ์ของคำสั่งหรือไม่
  2. พวกนั้นทำอะไร[...]และ[...]ภายใน[...] หมายถึงอะไร พวกเขาหมายถึงสิ่งที่เป็นตัวเลือกหรือไม่?
  3. ทำ |ได้หมายความว่าหรือ?
  4. ,หมายความว่าอะไรค่ะ[-m system[,...]] ?
  5. ส่วนเรื่องย่อทำตามกฎที่ใช้สำหรับนิพจน์ปกติหรือไม่

ที่เกี่ยวข้อง: "ยูทิลิตี้การประชุม" ในมาตรฐาน POSIX: pubs.opengroup.org/onlinepubs/9699919799/basedefs/ …
Kusalananda

คำตอบ:


25
  1. ส่วนเรื่องย่อมักจะให้ตัวอย่างการใช้งาน บางครั้งคำสั่งย่อยมีตัวเลือกต่าง ๆ ดังนั้นอาจมีตัวอย่างหลายตัวอย่าง
  2. วงเล็บ[]แสดงถึงสวิตช์ตัวเลือกอาร์กิวเมนต์ตัวเลือกและอื่น ๆ เสมอ
  3. ใช่ท่อ|หมายถึงหรือโดยเฉพาะอย่างยิ่งเมื่ออยู่ในวงเล็บเหลี่ยมหรือวงเล็บ
  4. วงเล็บในวงเล็บหมายความว่าส่วนที่สองขึ้นอยู่กับส่วนแรกและยังเป็นตัวเลือก สวิตช์บางตัวที่คุณสามารถใช้ได้ด้วยตัวเองหรือเพิ่มมูลค่าให้กับสวิตช์เหล่านั้น เครื่องหมายจุลภาคที่จุดเริ่มต้นของวงเล็บจะระบุว่าอาจมีหลายค่าที่คั่นด้วยเครื่องหมายจุลภาค
  5. พวกเขาพึ่งพาแนวคิดของ Regex แต่มีวัตถุประสงค์เพื่อให้มนุษย์อ่านได้ดังนั้นอย่าปฏิบัติตามกฎการหลบหนีทั้งหมดเป็นต้น

ขอบคุณ! มีการอ้างอิงบางอย่างอธิบายเกี่ยวกับไวยากรณ์ของการสรุปหรือไม่
ทิม

@Tim: นั่นเป็นหนึ่งในสิ่งที่บ้าที่สุดที่ฉันเคยเห็นฉันคิดว่าถ้าคุณอ่านอีกสองสามครั้งคุณจะได้รับมัน มันเป็นเพียงแค่การประชุมไม่ใช่เวทมนตร์
Caleb


3

จากmanหน้าคน:


อนุสัญญาต่อไปนี้มีผลใช้กับส่วนสรุปและสามารถใช้เป็นแนวทางในส่วนอื่น ๆ คำอธิบายเรื่องย่อชาย

การแสดงผลที่แน่นอนอาจแตกต่างกันไปขึ้นอยู่กับอุปกรณ์ส่งออก ตัวอย่างเช่นผู้ชายมักจะไม่สามารถแสดงตัวเอียงเมื่อทำงานในเครื่องเทอร์มินัลและโดยทั่วไปจะใช้ข้อความที่ขีดเส้นใต้หรือสีแทน

ภาพประกอบคำสั่งหรือฟังก์ชั่นเป็นรูปแบบที่ควรตรงกับการเรียกใช้ที่เป็นไปได้ทั้งหมด ในบางกรณีขอแนะนำให้แสดงตัวอย่างการเรียกใช้แบบเอกสิทธิ์เฉพาะบุคคลหลายรายการตามที่แสดงในส่วนสรุปของหน้าคู่มือนี้


3

แหล่งข้อมูลอื่นสำหรับการทำความเข้าใจความหมายของไวยากรณ์อาร์กิวเมนต์ของยูทิลิตี้บรรทัดคำสั่งจะเป็นระเบียบแบบแผนของอาร์กิวเมนต์ของยูทิลิตี้ที่จัดทำเป็นเอกสารไว้ในบทที่ 12และนิพจน์ทั่วไปที่บันทึกไว้ในบทที่ 9ของมาตรฐาน POSIX.1-2008 (2013 Edition)

โดยการใช้ไซต์ของเรา หมายความว่าคุณได้อ่านและทำความเข้าใจนโยบายคุกกี้และนโยบายความเป็นส่วนตัวของเราแล้ว
Licensed under cc by-sa 3.0 with attribution required.