Cách tạo trang người dùng Linux

Lệnh Đàn ông trên Linux được nhúng vào bộ nhớ cơ bản của mọi nhà phát triển và người dùng Linux. Nó được mọi người sử dụng theo nghĩa đen; từ các nhà phát triển nghiệp dư và mới làm quen với các chuyên gia và chuyên gia Linux.

Nó được sử dụng để đọc trang hướng dẫn dòng lệnh cho lệnh Linux, tệp cấu hình hoặc bất kỳ tính năng nào khác. Các trang thủ công thường được cài đặt cùng với cài đặt phần mềm trong Linux. Có một cú pháp xác định cho các trang thủ công, được phân tích cú pháp bằng lệnh.

Hãy để chúng tôi tạo một trang người đàn ông cho tập lệnh bash mà tôi đã viết sau đây:

#! / bin / bash if ["$ 1" == "h"]; then echo "Xin chào" fi if ["$ 1" = "b"]; sau đó echo "Bye" fi

Tập lệnh này chỉ thực hiện hai việc: Nó in “Hello” nếu tùy chọn ‘h’ được chỉ định làm đối số và nó in “Bye” nếu tùy chọn ‘b’ được chỉ định làm đối số.

Hãy để chúng tôi tạo một trang người đàn ông cho chương trình này. Sử dụng khí lực hoặc bất kỳ trình soạn thảo nào bạn chọn để tạo tệp văn bản.

kiểm tra vim.1

Phần mở rộng ‘.1’ biểu thị rằng trang người này dành cho một lệnh thực thi. Nó không phải là một sự ép buộc mà là một quy ước được tuân thủ rộng rãi trong khi viết các trang nam. Trang hướng dẫn sử dụng cho người đàn ông (người đàn ông !) liệt kê các danh mục:

 1 Các chương trình thực thi hoặc các lệnh shell 2 Các lệnh gọi hệ thống (các chức năng được cung cấp bởi hạt nhân) 3 Các lệnh gọi thư viện (các hàm trong thư viện chương trình) 4 Các tệp đặc biệt (thường được tìm thấy trong / dev) 5 Các định dạng và quy ước tệp, ví dụ / etc / passwd 6 Trò chơi 7 Khác ( bao gồm các gói và quy ước macro), ví dụ: man (7), groff (7) 8 Các lệnh quản trị hệ thống (thường chỉ dành cho root) 9 Quy trình hạt nhân [Không chuẩn]

Trang người đàn ông được tạo bằng cách sử dụng ngôn ngữ đánh dấu roff rất cũ. Nó có các lệnh (đánh dấu đọc) cho các tiêu đề và phần khác nhau.

  • .THỨ TỰ - Đây phải là lệnh đầu tiên trong tệp man. Nó được sử dụng để chỉ định tiêu đề tiêu đề của trang người đàn ông.
  • .SH - Phần Tiêu đề.
  • .B - Nó được sử dụng để hiển thị văn bản bên cạnh nó được in đậm.
  • .TP - Nó được sử dụng để hiển thị thông tin về một đối số (cờ) cho lệnh.
  • .BR - Nó được sử dụng để hiển thị văn bản in đậm và bằng phông chữ La Mã bình thường.

Sau đây là trang man cho chương trình của tôi được tạo chỉ bằng các lệnh roff (đơn giản) ở trên.

.TH test.sh 1 .SH NAME test.sh \ - Print Hello or Bye .SH SYNOPSIS .B test.sh [h] [b] .SH DESCRIPTION .B test.sh Đây là tập lệnh mẫu chỉ thực hiện 2 việc . Nó sẽ in "Xin chào" nếu đối số là 'h' hoặc in "Tạm biệt" nếu đối số là 'b' .SH TÙY CHỌN .TP .BR h In Xin chào .TP .BR b In Tạm biệt

Lưu các tập tin bằng cách nhấn đầu tiên thoát phím, và sau đó nhập : wq để lưu tệp và thoát khỏi bảng điều khiển vim.

Kiểm tra trang người đàn ông mà chúng tôi vừa tạo bằng lệnh dưới đây:

người đàn ông ./test.1

Để biết thêm thông tin về Đàn ông sử dụng, chạy man-trang lệnh trong thiết bị đầu cuối của bạn.

? Mẹo

Đây là cú pháp cơ bản để viết trang người. Để làm cho mọi thứ dễ dàng hơn, bạn có thể sử dụng các công cụ như txt2man để chuyển đổi một tệp ở một số định dạng ngôn ngữ đánh dấu sang định dạng roff.