วิธีสร้าง Linux Man Page

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

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

ให้เราสร้าง man page สำหรับ bash script ต่อไปนี้ที่ฉันเขียน:

#!/bin/bash if [ "$1" == "h" ]; จากนั้น echo "สวัสดี" fi if [ "$1" = "b" ]; แล้วก้อก้อง "บาย" fi

สคริปต์นี้ทำงานเพียงสองอย่างเท่านั้น: จะพิมพ์ "สวัสดี" หากระบุตัวเลือก 'h' เป็นอาร์กิวเมนต์ และพิมพ์ "บาย" หากระบุตัวเลือก 'b' เป็นอาร์กิวเมนต์

ให้เราสร้าง man page สำหรับโปรแกรมนี้ ใช้ เป็นกลุ่ม หรือตัวแก้ไขที่คุณเลือกเพื่อสร้างไฟล์ข้อความ

เป็นกลุ่ม test.1

ส่วนขยาย '.1' แสดงว่า man page นี้มีไว้สำหรับคำสั่งปฏิบัติการ มันไม่ใช่การบังคับ แต่เป็นอนุสัญญาที่มีคนติดตามกันอย่างแพร่หลายในขณะที่เขียนหน้าคน หน้าคู่มือสำหรับผู้ชาย (ผู้ชาย ผู้ชาย !) แสดงรายการหมวดหมู่:

 1 โปรแกรมปฏิบัติการหรือคำสั่งเชลล์ 2 การเรียกระบบ (ฟังก์ชันที่เคอร์เนลให้มา) 3 การเรียกไลบรารี (ฟังก์ชันภายในไลบรารีโปรแกรม) 4 ไฟล์พิเศษ (มักพบใน /dev) 5 รูปแบบไฟล์และข้อตกลง เช่น /etc/passwd 6 เกม 7 เบ็ดเตล็ด ( รวมถึงแพ็คเกจมาโครและข้อตกลง) เช่น man(7), groff(7) 8 คำสั่งการดูแลระบบ (โดยปกติสำหรับรูทเท่านั้น) 9 รูทีนของเคอร์เนล [ไม่ใช่มาตรฐาน]

หน้าคนถูกสร้างขึ้นโดยใช้ภาษามาร์กอัป roff ที่เก่ามาก มีคำสั่ง (อ่านเครื่องหมาย) สำหรับชื่อเรื่องและส่วนต่างๆ

  • .ไทย – นี่ควรเป็นคำสั่งแรกในไฟล์ man ใช้เพื่อระบุส่วนหัวของหน้าคน
  • .SH – หัวเรื่องส่วน.
  • .B - ใช้เพื่อแสดงข้อความข้างๆ เป็นตัวหนา
  • .TP – ใช้เพื่อแสดงข้อมูลเกี่ยวกับอาร์กิวเมนต์ (แฟล็ก) ของคำสั่ง
  • .BR – ใช้เพื่อแสดงข้อความที่เป็นตัวหนาและเป็นแบบอักษรโรมันปกติ

ต่อไปนี้เป็น man page สำหรับโปรแกรมของฉันที่สร้างขึ้นโดยใช้คำสั่ง roff (แบบง่าย) ด้านบนเท่านั้น

.TH test.sh 1 .SH NAME test.sh \- พิมพ์ สวัสดี หรือ ลาก่อน .SH SYNOPSIS .B test.sh [ h ] [ b ] .SH DESCRIPTION .B test.sh นี่คือสคริปต์ตัวอย่างที่ทำเพียง 2 สิ่งเท่านั้น . มันพิมพ์ "สวัสดี" ถ้าอาร์กิวเมนต์คือ 'h' หรือพิมพ์ "บาย" ถ้าอาร์กิวเมนต์คือ 'b' .SH OPTIONS .TP .BR h พิมพ์ สวัสดี .TP .BR b พิมพ์ลาก่อน

บันทึกไฟล์ โดยกด .ก่อน ESC คีย์แล้วพิมพ์ :wq เพื่อบันทึกไฟล์และออกจากคอนโซล vim

ทดสอบ man page ที่เราเพิ่งสร้างขึ้นโดยใช้คำสั่งด้านล่าง:

ผู้ชาย ./test.1

สำหรับข้อมูลเพิ่มเติมเกี่ยวกับ ชาย การใช้งาน, เรียกใช้ man-pages คำสั่งในเทอร์มินัลของคุณ

? เคล็ดลับ

นี่คือไวยากรณ์พื้นฐานสำหรับการเขียนหน้าคน เพื่อให้ง่ายขึ้น คุณสามารถใช้เครื่องมือเช่น txt2man แปลงไฟล์ในรูปแบบภาษามาร์กอัปเป็นรูปแบบ roff