หน้าคู่มือ (Man page)ย่อมาจากmanual pageคือรูปแบบหนึ่งของเอกสารประกอบซอฟต์แวร์ที่พบใน ระบบปฏิบัติการ Unixและระบบปฏิบัติการที่คล้าย Unix หัวข้อที่ครอบคลุม ได้แก่ โปรแกรมไลบรารีระบบการเรียกใช้ระบบและบางครั้งรายละเอียดของระบบในเครื่องนั้นๆ ผู้ดูแลระบบในเครื่องนั้นๆ สามารถสร้างและติดตั้งหน้าคู่มือที่เกี่ยวข้องกับเครื่องนั้นๆ ได้ ผู้ใช้ทั่วไปสามารถเรียกใช้หน้าเอกสารได้โดยการพิมพ์คำสั่งตามด้วยชื่อของรายการที่ต้องการดูเอกสาร หน้าคู่มือเหล่านี้มักถูกร้องขอโดยผู้ใช้ทั่วไป โปรแกรมเมอร์ และผู้ดูแลระบบที่ทำงานแบบเรียลไทม์ แต่ก็สามารถจัดรูปแบบเพื่อการพิมพ์ได้เช่นกัน man

โดยปกติแล้วmanจะใช้โปรแกรมจัดรูปแบบ เช่นnroffแพ็กเกจมาโคร หรือmandocและยังใช้ โปรแกรม แสดงผลเทอร์มินัลเช่นmoreหรือlessเพื่อแสดงผลลัพธ์บนหน้าจอของผู้ใช้ด้วย

หน้าคู่มือมักถูกอ้างถึงว่าเป็นเอกสารซอฟต์แวร์รูปแบบออนไลน์^{[ 1 ]}แม้ว่าmanคำสั่งจะไม่ต้องการการเข้าถึงอินเทอร์เน็ตก็ตาม เนื่องจากหน้าคู่มือสามารถเข้าถึงได้จากอินเทอร์เฟซบรรทัดคำสั่งด้วยmanคำสั่งหรือจากอินเทอร์เฟซผู้ใช้แบบกราฟิกด้วยโปรแกรมดูหน้าคู่มือ แทนที่จะอ่านได้เฉพาะในรูปแบบสิ่งพิมพ์เท่านั้น ตัวแปรสภาพแวดล้อม MANPATH มักระบุรายการเส้นทางไดเร็กทอรีเพื่อค้นหาหน้าเอกสารต่างๆ หน้าคู่มือมีมาตั้งแต่สมัยที่เอกสารสิ่งพิมพ์เป็นเรื่องปกติ

ในปี 1987 ซอฟต์แวร์บางตัวมีเอกสารพิมพ์เป็นหน้าๆ ซึ่งผู้ใช้สามารถเข้าถึงได้ในสถานที่^{[ 2 ]}ในบางสถานที่ เอกสารเหล่านี้ถูกจัดเรียงไว้ในแฟ้มเหล็กที่ล็อกเข้าด้วยกันในชั้นวางหนังสือเหล็กขนาดใหญ่ที่ยึดติดกับโต๊ะหรือเคาน์เตอร์ โดยจัดเรียงหน้าต่างๆ สำหรับการอัปเดตข้อมูลแบบโมดูลาร์ การทดแทน ข้อผิดพลาด และส่วนเพิ่มเติม คู่มือยอดนิยมเกี่ยวกับไมโครคอมพิวเตอร์มีการโฆษณาขายในรูปแบบแฟ้มแบบแผ่นแยกพร้อมการอัปเดตเป็นประจำ^{[ 3 ]}

ในช่วงสองปีแรกของประวัติศาสตร์ Unixไม่มีเอกสารใดๆ อยู่เลย^{[ 4 ​​]}คู่มือโปรแกรมเมอร์ Unixได้รับการตีพิมพ์ครั้งแรกเมื่อวันที่ 3 พฤศจิกายน พ.ศ. 2514 man pages ฉบับแรกเขียนโดยDennis RitchieและKen Thompsonตามคำเรียกร้องของDoug McIlroy ผู้จัดการของพวกเขา ในปี พ.ศ. 2514 นอกจาก man pages แล้วคู่มือโปรแกรมเมอร์ยังรวบรวมเอกสารสั้นๆ อีกหลายฉบับ ซึ่งบางส่วนเป็นบทช่วยสอน (เช่น การใช้งาน Unix ทั่วไป ภาษาโปรแกรม Cและเครื่องมือต่างๆ เช่นYacc ) และบางส่วนเป็นคำอธิบายโดยละเอียดเกี่ยวกับคุณสมบัติของระบบปฏิบัติการ ฉบับพิมพ์ของคู่มือในตอนแรกนั้นบรรจุอยู่ในแฟ้มเดียว แต่ในPWB/UNIXและResearch Unix ฉบับที่ 7ได้ถูกแบ่งออกเป็นสองเล่ม โดย man pages ที่พิมพ์แล้วอยู่ในเล่มที่ 1 ^{[ 5 ]}

เอกสารรุ่นต่อมาเลียนแบบความกระชับของหน้าคู่มือฉบับแรก ริชชีได้เพิ่มส่วน "วิธีเริ่มต้นใช้งาน" ลงใน บทนำของ ฉบับที่สามและลอรินดา เชอร์รีได้จัดทำเอกสารอ้างอิงขนาดพกพา "บัตรสีม่วง" สำหรับฉบับที่หกและเจ็ด^{[ 4 ]} เวอร์ชันของซอฟต์แวร์ได้รับการตั้งชื่อตามการแก้ไขคู่มือ ตัวอย่างเช่น คู่มือโปรแกรมเมอร์ Unixฉบับที่เจ็ดมาพร้อมกับ Unix ฉบับที่ 7 หรือเวอร์ชัน 7 ^{[ 6 ]}

สำหรับ ฉบับ ที่สี่หน้าคู่มือได้รับการจัดรูปแบบโดยใช้แพ็คเกจการจัดพิมพ์troff ^{[ 4 ]}และชุด มาโคร (ซึ่งได้รับการแก้ไขอย่างสมบูรณ์ระหว่าง คู่มือฉบับที่-manหกและเจ็ด^{[ 5 ]}แต่หลังจากนั้นก็ไม่ได้เปลี่ยนแปลงอย่างมาก) ในขณะนั้น การมีเอกสารออนไลน์ผ่านระบบหน้าคู่มือถือเป็นความก้าวหน้าอย่างมาก จนถึงทุกวันนี้ แอปพลิเคชันบรรทัดคำสั่ง Unix แทบทุกตัวมาพร้อมกับหน้าคู่มือ และผู้ใช้ Unix จำนวนมากมองว่าการที่โปรแกรมไม่มีหน้าคู่มือเป็นสัญญาณของคุณภาพต่ำหรือความไม่สมบูรณ์ อันที่จริง บางโครงการ เช่นDebianพยายามอย่างเต็มที่ที่จะเขียนหน้าคู่มือสำหรับโปรแกรมที่ไม่มีหน้าคู่มือ ระบบปฏิบัติการรุ่นใหม่ที่สืบทอดมาจาก4.4BSDก็แจกจ่ายหน้าคู่มือเป็นหนึ่งในรูปแบบหลักของเอกสารระบบ (โดยได้แทนที่มาโครแบบเก่าด้วยมาโครแบบใหม่กว่า) -man-mdoc

มีอีสเตอร์เอ็ก ที่ซ่อนอยู่ ในเวอร์ชัน man-db ของคำสั่ง man ซึ่งจะทำให้คำสั่งส่งคืน "gimme gimme gimme" เมื่อรันที่ 00:30 (อ้างอิงถึงเพลงGimme! Gimme! Gimme! (A Man After Midnight) ของ ABBA ) มีการแนะนำในปี 2011 ^{[ 7 ]}แต่ถูกจำกัดไว้ก่อน^{[ 8 ]}และถูกลบออกในปี 2017 ^{[ 9 ]}หลังจากที่ถูกค้นพบในที่สุด^{[ 10 ]}

รูปแบบเริ่มต้นของหน้าคู่มือ (man page) คือtroffโดยใช้แพ็กเกจมาโคร man (เน้นรูปลักษณ์) หรือ mdoc (เน้นความหมาย) ซึ่งทำให้สามารถจัดพิมพ์หน้าคู่มือเป็นPostScript , PDFและรูปแบบอื่นๆ สำหรับการดูหรือพิมพ์ได้

ระบบ Unixบางระบบมีแพ็กเกจสำหรับ คำสั่ง man2htmlซึ่งช่วยให้ผู้ใช้สามารถเรียกดูหน้า man ได้โดยใช้เบราว์เซอร์ HTML ระบบที่มี groff และ man-db ควรใช้เอาต์พุต HTML ดั้งเดิมที่มีคุณภาพสูงกว่า ( man --html ) แทนโปรแกรมWoMan ของ GNU Emacs (จาก "WithOut man") อนุญาตให้เรียกดูหน้า man จากตัวแก้ไขได้^{[ 11 ]}

ในปี 2010 OpenBSDได้ยกเลิกการใช้งาน troff สำหรับการจัดรูปแบบหน้าคู่มือ (man page) และหันมาใช้ mandocแทน ซึ่งเป็นคอมไพเลอร์/ตัวจัดรูปแบบเฉพาะสำหรับหน้าคู่มือที่มีการรองรับการส่งออกในรูปแบบ PostScript , HTML , XHTMLและเทอร์มินัลโดยตรง โดยมีจุดประสงค์เพื่อรองรับเฉพาะส่วนย่อยของ troff ที่ใช้ในหน้าคู่มือ โดยเฉพาะอย่างยิ่งหน้าคู่มือที่ใช้มาโคร mdoc

มีเว็บไซต์จำนวนไม่น้อยที่ให้บริการเข้าถึงหน้าคู่มือการใช้งานจากระบบปฏิบัติการที่คล้าย Unix ต่างๆ ทางออนไลน์

ในเดือนกุมภาพันธ์ พ.ศ. 2556 ชุมชน BSD ได้เห็นการเปิดตัวบริการ mdoc.suแบบโอเพนซอร์สใหม่ซึ่งรวมและย่อการเข้าถึงสคริปต์ man.cgi ของโครงการ BSD สมัยใหม่หลักๆ ผ่าน บริการ ย่อ URLที่กำหนดได้โดยใช้nginxสำหรับหน้า man ของ *BSD ^{[ 12 ] [ 13 ] [ 14 ]}

สำหรับ Linux มีการตั้งค่าบริการ man7.org เพื่อให้บริการคู่มือเฉพาะสำหรับระบบ^{[ 15 ]}บริการ ManKier มีตัวเลือกที่หลากหลายกว่า และยังรวมหน้า TLDR ไว้ด้วย^{[ 16 ]}

หากต้องการอ่านคู่มือการใช้งานคำสั่ง Unix ผู้ใช้สามารถพิมพ์ได้ดังนี้:

man <command_name> 

โดยทั่วไปแล้ว การอ้างอิงหน้าเว็บจะใช้รูปแบบ "ชื่อ(ส่วน)": ตัวอย่างเช่นftp(1)<pages>.<section> ส่วนนี้หมายถึงวิธีการต่างๆ ที่อาจใช้อ้างอิงหัวข้อนั้นๆ ได้ เช่น การเรียกใช้ระบบ คำสั่งเชลล์ (บรรทัดคำสั่ง) หรือแพ็กเกจ ไฟล์การกำหนดค่าของแพ็กเกจ หรือโครงสร้างการเขียนโค้ด/ส่วนหัว

ชื่อหน้าเดียวกันอาจปรากฏในหลายส่วนของคู่มือ เช่น เมื่อชื่อของการเรียกใช้ระบบคำสั่งผู้ใช้หรือแพ็กเกจมาโครตรงกัน ตัวอย่างเช่นman(1)และman(7)หรือexit(2)และexit(3)ไวยากรณ์สำหรับการเข้าถึงส่วนคู่มือที่ไม่ใช่ค่าเริ่มต้นจะแตกต่างกันไปในแต่ละการใช้งานคู่มือ (man)

ตัวอย่างเช่น ในระบบปฏิบัติการ Solaris และ illumos รูปแบบการอ่านข้อมูลprintf(3C)จะเป็นดังนี้:

man -s 3c printf

ในระบบปฏิบัติการ Linux และ BSD การเรียกใช้งานจะเป็นดังนี้:

man 3 printf

ซึ่งเป็นการค้นหาคำสั่งprintfในส่วนที่ 3 ของหน้าคู่มือ (man pages) ชื่อไฟล์จริงน่าจะรวมส่วนนั้นไว้ด้วย ยกตัวอย่างเช่น printf.3.gz จะเป็นไฟล์หน้าคู่มือแบบบีบอัดในส่วนที่ 3 สำหรับคำสั่ง printf

โดยทั่วไปคู่มือจะแบ่งออกเป็นแปดส่วนที่มีหมายเลข ระบบส่วนใหญ่ในปัจจุบัน (เช่น^{BSD [} 17 ] ^{macOS ,} Linux [ 18 ] ^{และSolaris} 11.4 )สืบทอดรูปแบบการกำหนดหมายเลขที่ใช้โดยResearch Unix [ ^{19 ] [ 20 ]}ในขณะที่System Vใช้ลำดับที่แตกต่าง^{กัน : [ 21 ]}

API ของ POSIXมีอยู่ในทั้งส่วนที่ 2 และ 3 โดยส่วนที่ 2 ประกอบด้วย API ที่ถูกนำไปใช้ในรูปแบบของการเรียกใช้ระบบ (system calls) และส่วนที่ 3 ประกอบด้วย API ที่ถูกนำไปใช้ในรูปแบบของรูทีนไลบรารี (library routines)

ในบางระบบ อาจมีการเพิ่มส่วนเพิ่มเติม เช่น:

บางส่วนจะถูกแบ่งย่อยออกไปอีกโดยใช้คำต่อท้าย ตัวอย่างเช่น ในบางระบบ ส่วนที่ 3C ใช้สำหรับเรียกใช้ไลบรารี C ส่วนที่ 3M ใช้สำหรับไลบรารีคณิตศาสตร์ และอื่นๆ ผลที่ตามมาคือ ส่วนที่ 8 (คำสั่งการบริหารระบบ) บางครั้งถูกจัดให้อยู่ในส่วนย่อย 1M ของส่วนคำสั่งหลัก คำต่อท้ายของส่วนย่อยบางคำมีความหมายทั่วไปเหมือนกันในทุกส่วน:

(ส่วนที่ 3 มักจะเป็นข้อยกเว้น โดยมีคำต่อท้ายมากมายสำหรับภาษาต่างๆ)

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

หน้าคู่มือทั้งหมดใช้รูปแบบทั่วไปที่ปรับให้เหมาะสมสำหรับการแสดงผลบนจอ แสดงผลข้อความ ASCII แบบง่าย โดยอาจไม่มีการเน้นข้อความหรือการควบคุมแบบอักษรใดๆ ส่วนต่างๆ ที่ปรากฏอาจรวมถึง: ^{[ 23 ] : โครงสร้างคู่มือ}

ชื่อ

ชื่อของคำสั่งหรือฟังก์ชัน ตามด้วยคำอธิบายสั้นๆ หนึ่งบรรทัดว่าคำสั่งหรือฟังก์ชันนั้นทำอะไร

เรื่องย่อ

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

คำอธิบาย

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

ตัวอย่าง

ตัวอย่างการใช้งานทั่วไปบางส่วน

ดูเพิ่มเติม

รายการคำสั่งหรือฟังก์ชันที่เกี่ยวข้อง

อาจมีส่วนอื่นๆ อีก แต่ส่วนเหล่านี้ไม่ได้มีการกำหนดมาตรฐานไว้อย่างชัดเจนในหน้าคู่มือ (man page) ตัวอย่างที่พบได้ทั่วไป ได้แก่: ตัวเลือก (OPTIONS), สถานะการออก (EXIT STATUS), ค่าที่ส่งคืน (RETURN VALUE), สภาพแวดล้อม (ENVIRONMENT), ข้อบกพร่อง (BUGS), ไฟล์ (FILES), ผู้เขียน (AUTHOR), การรายงานข้อบกพร่อง (REPORTING BUGS), ประวัติ (HISTORY) และลิขสิทธิ์ (COPYRIGHT)

หน้าคู่มือสามารถเขียนได้ทั้งในmanมาโครแบบเก่าหรือdocมาโครแบบ ใหม่ ^{[ 24 ]}ชุดmanมาโครมี ฟังก์ชัน ข้อความที่ซับซ้อน ขั้นต่ำ พร้อมคำสั่งสำหรับบรรทัดชื่อเรื่อง หัวข้อส่วน (ตัวหนา ตัวเล็ก หรือตัวเอียง) แบบอักษร ย่อหน้า และการเพิ่ม/ลดการเยื้อง^{[ 25 ]} ภาษา ใหม่mdocมีลักษณะเชิงความหมายมากกว่า และมีมาโครเฉพาะสำหรับส่วนมาตรฐานส่วนใหญ่ เช่น ชื่อโปรแกรม บทสรุป ชื่อฟังก์ชัน และชื่อผู้เขียน ข้อมูลนี้สามารถนำไปใช้ในการค้นหา คู่มือ เชิงความหมายโดยโปรแกรมต่างๆ เช่นmandocแม้ว่าจะรวมถึงคำสั่งเพื่อควบคุมรูปแบบโดยตรงด้วย แต่คาดว่ามาโครเฉพาะจะครอบคลุมกรณีการใช้งานส่วนใหญ่^{[ 23 ]}ทั้งโครงการ mandoc และ groff พิจารณาmdocรูปแบบที่ต้องการสำหรับเอกสารใหม่^{[ 26 ]}

แม้ว่าหน้าคู่มือ (man pages) จะเป็นข้อความที่จัดวางโดยใช้ แบบอักษรโรมันขนาด 10 พอยต์แต่ความแตกต่างนี้มักไม่สำคัญ เนื่องจากหน้าคู่มือจะถูกดูในเทอร์มินัล (TTY) แทนที่จะจัดวางบนกระดาษ ส่งผลให้มาโคร "แบบอักษรขนาดเล็ก" แทบจะไม่ถูกใช้^{[ 27 ]}ในทางกลับกัน เทอร์มินัลรองรับข้อความตัวหนาและตัวเอียงผ่านECMA-48และ groff grottyจะแสดงข้อความเหล่านั้นตามที่ร้องขอเมื่อตรวจพบเทอร์มินัลที่รองรับ อย่างไรก็ตาม mandoc ของ BSD รองรับเฉพาะข้อความตัวหนาและขีดเส้นใต้ (แทนตัวเอียง) ผ่านลำดับการกดปุ่มลบแล้วขีดทับของเครื่องพิมพ์ดีด ซึ่งจำเป็นต้องแปลงเป็น ECMA-48 lessโดย^{[ 28 ] [ 29 ]}

มีการใช้เครื่องมือบางอย่างเพื่อแปลงเอกสารในรูปแบบที่ไม่ซับซ้อนมากนักให้เป็นหน้าคู่มือ ตัวอย่างเช่น GNU help2manซึ่งรับเอา--helpเอาต์พุตและเนื้อหาเพิ่มเติมบางส่วนเพื่อสร้างหน้าคู่มือ^{[ 30 ]}คู่มือจะมีประโยชน์มากกว่าเอาต์พุตดังกล่าวเพียงเล็กน้อย แต่สำหรับโปรแกรม GNU นี่ไม่ใช่ปัญหาเนื่องจาก texinfo เป็นระบบเอกสารหลัก^{[ 31 ]}เครื่องมือจำนวนหนึ่ง รวมถึงpandoc , ronn และ md2man รองรับการแปลงจากMarkdownเป็นหน้าคู่มือ เครื่องมือเหล่านี้ทั้งหมดส่งออกmanรูปแบบ เนื่องจาก Markdown ไม่สามารถแสดงออกได้เพียงพอที่จะตรงกับเนื้อหาเชิงความหมายของmdocDocBook มีตัวแปลง man(7) ในตัว – ซึ่งมีคุณภาพแย่มาก ตามที่ผู้เขียน mandoc ^{[ 32 ]}ได้เขียนตัวแปลง mdoc(7) แยกต่างหาก

หน้าคู่มือมักเขียนเป็นภาษาอังกฤษ แต่อาจมีการแปลเป็นภาษาอื่น ๆ บนระบบ GNU man-dbและ mandoc manเป็นที่ทราบกันดีว่าค้นหาหน้าคู่มือที่แปลเป็นภาษาท้องถิ่นภายใต้ไดเร็กทอรีย่อย^{[ 33 ] [ 18 ] : ภาพรวม [ 17 ]}

มีทางเลือกอื่นน้อยมากที่manได้รับความนิยมมากนัก ยกเว้นระบบ" " ของโครงการ GNU ซึ่งเป็นระบบ ไฮเปอร์เท็กซ์แบบ ง่ายๆ ในยุคแรกๆ นอกจากนี้ยังมีความพยายามจากบุคคลที่สามที่เรียกว่าหน้า TLDR ( ) ที่ให้ตัวอย่างง่ายๆ สำหรับกรณีการใช้งานทั่วไป คล้ายกับเอกสารสรุป^{[ 34 ]}infotldr

นอกจากนี้ แอปพลิเคชัน GUI ของ Unix บางตัว (โดยเฉพาะอย่างยิ่งแอปพลิเคชันที่สร้างโดยใช้ สภาพแวดล้อมการพัฒนา GNOMEและKDE ) ในปัจจุบันได้จัดเตรียมเอกสารสำหรับผู้ใช้ในรูปแบบ HTMLและมีโปรแกรมดู HTML แบบฝังตัว เช่นyelpสำหรับอ่านความช่วยเหลือภายในแอปพลิเคชัน

• รายการคำสั่ง Unix
• รายชื่อใบสมัครโครงการ Plan 9
• info
• apropos
• อ่านไฟล์
• อ่านคู่มือให้ละเอียด
• ManOpen – โปรแกรมยูทิลิตี้แบบกราฟิก สำหรับ NeXT / iOS

คู่มือ Wikibook เกี่ยวกับ Unixมีหน้าหนึ่งที่กล่าวถึงหัวข้อ: คำสั่ง

• ประวัติความเป็นมาของหน้าคู่มือ UNIX (UNIX Manpages)สำหรับแหล่งข้อมูลหลักเกี่ยวกับประวัติของหน้าคู่มือ UNIX
• คลังคู่มือ Man Page สำหรับ UNIX และ Linuxที่มีคู่มือ Man Page จัดรูปแบบอย่างดีเกือบ 300,000 รายการ
• ตัวเลขในหน้าคู่มือการใช้งาน (man page) หมายถึงอะไร?
• เว็บไซต์ FreeBSD Manual Pages , freebsd.org – ยังมีหน้าคู่มือสำหรับ Darwin, Debian, HP-UX, IRIS, NetBSD, OpenBSD, NextSTEP, SunOS และอื่นๆ อีกมากมาย
• โครงการคู่มือแมนนวลลินุกซ์