Các trang man Linux là một tài nguyên cần thiết cho bất kỳ ai sử dụng Linux. Chúng cung cấp thông tin chi tiết về các lệnh, tiện ích và lệnh gọi hệ thống khác nhau, cho phép người dùng dễ dàng tìm thấy câu trả lời cho câu hỏi của họ. Trong bài viết này, chúng tôi sẽ hướng dẫn bạn cách tạo trang man Linux của riêng bạn bằng cách sử dụngtrò lố bịchcông cụ sắp chữ và cách chuyển nó sang HTML bằng cách sử dụngman2html.
Để tạo trang man, bạn có thể sử dụng bất kỳ trình soạn thảo văn bản nào bạn thích, chẳng hạn nhưemachoặcvim. Điều quan trọng là phải tuân theo cú pháp và cấu trúc cụ thể vì các trang man có định dạng nhất định mà chúng phải tuân thủ. Các trang man thường nằm ở/usr/local/man/man1thư mục và tên tệp của chúng ở dạnglệnh_name. 1.
Khi tạo một trang man, có một số điều đáng chú ý cần xem xét. Đầu tiên, dòng đầu tiên của trang phải luôn chứa tên lệnh, theo sau là mô tả ngắn gọn về chức năng của lệnh. Dòng này sẽ xuất hiện khi bạn sử dụngngười đàn ôngyêu cầu. Ngoài ra, trang phải có tiêu đề mô tả các phần khác nhau của trang man, chẳng hạn như "TÊN", "TỔNG HỢP", "MÔ TẢ", v. v.
Cú pháp được sử dụng trong các trang man được gọi là "roff" và đó là ngôn ngữ định dạng được thiết kế đặc biệt để sắp chữ tài liệu. Nó sử dụng macro để xác định bố cục và giao diện của trang. Ví dụ,. QUẦN QUÈmacro được sử dụng để xác định tiêu đề của trang, trong khi. SHmacro được sử dụng để xác định tiêu đề phần. Văn bản trong một đoạn văn được phân tách bằng dòng trống và bạn có thể sử dụng.Bmacro để in đậm văn bản hoặc.Imacro để làm cho nó in nghiêng.
Trong khi viết trang man của bạn, bạn có thể sử dụngngười đàn ônglệnh để xem trước nó sẽ trông như thế nào. Đơn giản chỉ cần chạyngười đàn ôn g-l tên tập tinđể xem trang man trong thiết bị đầu cuối của bạn. Ngoài ra, bạn có thể sử dụngman2htmllệnh chuyển đổi trang man sang định dạng HTML, sau đó có thể mở được trang này trong trình duyệt web. Điều này hữu ích nếu bạn muốn chia sẻ trang man của mình trực tuyến hoặc phân phối nó như một phần của gói phần mềm.
Để cài đặt các gói cần thiết nhằm tạo trang man và chuyển đổi chúng sang HTML, bạn có thể sử dụng trình quản lý gói của bản phân phối. Ví dụ: trên các hệ thống dựa trên Debian/Ubuntu, bạn có thể chạysudo apt cài đặt man-db groff man2html. Sau khi quá trình cài đặt hoàn tất, bạn có thể bắt đầu tạo trang man của mình trong/usr/local/man/man1danh mục.
Trong bài viết này, chúng tôi đã cung cấp các ví dụ và giải thích về cách tạo trang Linux Man từ đầu. Chúng tôi đã đề cập đến cú pháp và cấu trúc của các trang người đàn ông, cũng như các công cụ và gói cần thiết để tạo và chuyển đổi chúng. Bằng cách làm theo hướng dẫn từng bước này, bạn sẽ có thể tạo các trang người đàn ông chuyên nghiệp của riêng mình cung cấp tất cả thông tin mà người dùng của bạn cần.
Tạo trang Linux Man: Hướng dẫn từng bước
Nếu bạn là người dùng Linux, bạn có thể bắt gặp các tình huống mà bạn cần tạo trang người đàn ông cho một lệnh hoặc công cụ cụ thể. Các trang người đàn ông là tài liệu tích hợp trong các hệ điều hành giống UNIX cung cấp thông tin chi tiết về các lệnh và tiện ích khác nhau.
Tuy nhiên, việc tạo một trang người đàn ông có vẻ như là một nhiệm vụ phức tạp nếu bạn không quen với quy trình. Trong hướng dẫn từng bước này, chúng tôi sẽ hướng dẫn bạn các bước cần thiết để tạo trang Linux Man từ đầu.
Bước 1: Kiểm tra cài đặt trang người đàn ông của bạn
Trước khi bạn bắt đầu tạo trang người đàn ông của mình, hãy đảm bảo rằng các công cụ và tệp cần thiết được cài đặt trên hệ thống của bạn. Trong hầu hết các phân phối Linux, các trang người đàn ông được lưu trữ trong/usr/share/người đàn ôngdanh mục. Bạn có thể kiểm tra cài đặt bằng cách chạy lệnh sau trong thiết bị đầu cuối của bạn:
Người đàn ôngNếu trang người đàn ông được hiển thị, điều đó có nghĩa là cài đặt là chính xác và bạn có thể tiến hành bước tiếp theo.
Bước 2: Viết trang người đàn ông
Bây giờ bạn đã xác minh cài đặt, đã đến lúc bắt đầu viết trang người đàn ông. Các trang người đàn ông được viết bằng ngôn ngữ đánh dấu Troff, đây là một hệ thống sắp chữ mạnh mẽ được thiết kế cho các hệ thống giống như Unix.
Bạn có thể tạo một trang người đàn ông mới bằng cách tạo một tệp văn bản với tiện ích mở rộng. người đàn ônghoặc.1bên trong/usr/local/man/man1/danh mục. Ví dụ: bạn có thể sử dụng lệnh sau để tạo trang người đàn ông cho một lệnh gọi là "mycommand":
sudo nano /usr/local/man/man1/mycommand. 1Trong tệp mới được tạo, bạn có thể viết nội dung của trang người đàn ông của mình. Trang người đàn ông tuân theo một cú pháp và cấu trúc cụ thể, với các phần khác nhau chứa thông tin về lệnh hoặc công cụ.
Bước 3: Định dạng trang người đàn ông
Khi bạn đã viết nội dung của trang người đàn ông, đã đến lúc định dạng nó bằng cách sử dụngtrò lố bịchdụng cụ. Công cụ này được sử dụng để chuyển đổi tệp nguồn Troff thành định dạng có thể được hiển thị bởingười đàn ôngyêu cầu.
Để định dạng trang người đàn ông, hãy chạy lệnh sau:
sudo gzi p-k /usr/local/man/man1/mycommand. 1Lệnh này sẽ tạo phiên bản nén của tệp trang Man với phần mở rộng. gz.
Bước 4: Kiểm tra trang người đàn ông
Sau khi định dạng trang người đàn ông, bạn nên kiểm tra nó để đảm bảo rằng mọi thứ hoạt động như mong đợi. Bạn có thể làm điều này bằng cách sử dụngngười đàn ônglệnh để hiển thị trang người đàn ông:
người đàn ông mycommandNếu trang người đàn ông được hiển thị chính xác, bạn đã tạo thành công một trang Linux Man.
Bước 5: Cài đặt trang người đàn ông
Để làm cho trang người đàn ông có thể truy cập toàn bộ hệ thống, bạn cần cài đặt nó trong thư mục thích hợp. Bạn có thể làm điều này bằng cách chạy lệnh sau dưới dạng gốc:
sudo mandbLệnh này sẽ cập nhật cơ sở dữ liệu trang người đàn ông và làm cho trang người đàn ông có sẵn để tìm kiếm.
Bước 6: Cập nhật cơ sở dữ liệu Whatis
Ngoài việc cập nhật cơ sở dữ liệu trang người đàn ông, bạn cũng nên cập nhật cơ sở dữ liệu Whatis. Cơ sở dữ liệu Whatis được sử dụng bởilà gìlệnh để hiển thị các mô tả ngắn về các lệnh và công cụ.
Để cập nhật cơ sở dữ liệu Whatis, hãy chạy lệnh sau:
sudo/usr/libexec/makewhatisVới các bước này, bạn đã tạo thành công một trang Linux Man cho lệnh hoặc công cụ của bạn. Hãy nhớ giữ cho trang người đàn ông được cập nhật với bất kỳ thay đổi hoặc bổ sung nào để đảm bảo rằng người dùng có thể tìm thấy thông tin cần thiết một cách dễ dàng.
Hiểu mục đích của trang người đàn ông Linux
Trang Linux Man là một tệp tài liệu toàn diện cung cấp thông tin và hướng dẫn về cách sử dụng lệnh hoặc chương trình cụ thể trên hệ điều hành giống UNIX. Các trang này rất cần thiết cho người dùng Linux, vì chúng đóng vai trò là hướng dẫn sử dụng cho hầu hết mọi thực thi và tiện ích trong hệ thống.
Tên "Trang người đàn ông" có nguồn gốc từ thuật ngữ "Trang thủ công" và phản ánh mục đích của các tệp này - để cung cấp cho người dùng một hướng dẫn tham khảo chi tiết. Chúng thường được cài đặt trong/usr/local/man/man1/Thư mục, trong đó số "1" chỉ ra phần của hướng dẫn sử dụng trang. Có nhiều phần, mỗi phần được liên kết với một loại lệnh khác nhau.
Các trang Linux Man được tạo ra như là sự kế thừa cho lệnh "Whatis" đầu tiên, đây là một công cụ tìm kiếm cơ bản được sử dụng để tìm các lệnh và mô tả của chúng. Mặt khác, các trang người đàn ông cung cấp một định dạng tài liệu toàn diện và chi tiết hơn.
Để xem trang người đàn ông, bạn có thể sử dụng thiết bị đầu cuối và nhập "người đàn ông_name"Hoặc truy cập cơ sở dữ liệu trang người đàn ông trực tuyến cung cấp biểu diễn HTML của các trang. Hầu hết các bản phân phối Linux đều đi kèm với Trình xem trang Man được cài đặt theo mặc định và nó cho phép bạn điều hướng qua các phần khác nhau và tìm kiếm các lệnh cụ thể.
Trang Man được viết bằng Troff, một ngôn ngữ định dạng văn bản sử dụng macro để chỉ định bố cục và hình thức của tài liệu. Tệp Troff là các tệp văn bản đơn giản có.3tiện ích mở rộng và chúng có thể được biên dịch thành các định dạng đầu ra khác nhau, chẳng hạn như PDF hoặc HTML.
Một trong những công cụ phổ biến nhất để chuyển đổi Trang Man sang HTML là "man2html". Công cụ này phân tích cú pháp các tệp Troff và tạo phiên bản HTML của trang, giúp xem và điều hướng qua tài liệu trực tuyến dễ dàng hơn. Các trang HTML được tạo bao gồm mọi thứ từ Trang Man, bao gồm mô tả lệnh, ví dụ sử dụng và các tài liệu tham khảo có liên quan.
Khi sử dụng trình xem Trang Man trực tuyến như "man2html", bạn cũng có thể sử dụng các tính năng bổ sung như đánh dấu cú pháp, giúp phân biệt giữa các phần khác nhau của trang dễ dàng hơn. Những tính năng này nâng cao khả năng đọc và hiểu cách sử dụng lệnh.
Điều đáng chú ý là Trang Man cũng có thể được hiển thị trong chính thiết bị đầu cuối, ở định dạng dựa trên văn bản. Điều này đặc biệt hữu ích khi bạn không có quyền truy cập vào trình xem trực tuyến hoặc muốn ở trong môi trường dòng lệnh. Phiên bản đầu cuối của Trang Man giữ lại thông tin giống như phiên bản HTML nhưng có thể thiếu định dạng trực quan và đánh dấu.
Tóm lại, Linux Man Pages là tài nguyên cơ bản cho người dùng Linux, cung cấp tài liệu toàn diện và chi tiết cho mọi lệnh và chương trình. Cho dù bạn truy cập chúng thông qua trình xem HTML trực tuyến hay xem chúng trong thiết bị đầu cuối, Man Pages là một công cụ có giá trị để hiểu và sử dụng các khả năng to lớn của Linux.
Định dạng trang Man
Khi tạo trang man Linux, định dạng phù hợp là rất quan trọng để đảm bảo thông tin được hiển thị chính xác và dễ đọc. Việc định dạng trang man được thực hiện bằng cách sử dụng kết hợp đánh dấu dựa trên văn bản và các lệnh đặc biệt gọi là macro.
Đoạn văn và tiêu đề
Trang man phải có cấu trúc tốt với các tiêu đề và đoạn văn rõ ràng. Tiêu đề được xác định bằng cách sử dụng các macro cụ thể như . SH và . SS, tương ứng với "tiêu đề phần" và "tiêu đề phụ". Những tiêu đề này giúp người dùng dễ dàng điều hướng và tìm kiếm hơn trong trang man.
Định dạng văn bản
Để làm nổi bật các khía cạnh quan trọng của trang người đàn ông của bạn, bạn có thể sử dụng các tùy chọn định dạng như in đậm, in nghiêng, gạch chân hoặc các phông chữ khác nhau. Các tùy chọn định dạng này có thể được áp dụng bằng cách sử dụng các macro và cú pháp thích hợp trong trang Man. Ví dụ: văn bản táo bạo đạt được bằng cách sử dụng macro . b và văn bản in nghiêng bằng cách sử dụng macro . i.
Sắp chữ và phá vỡ đường dây
Trong một trang người đàn ông, văn bản được sắp xếp bằng cách sử dụng một chương trình có tên là Groff. Groff cho phép bạn kiểm soát khoảng cách, biện minh, thụt lề và ngắt dòng trong văn bản. Bạn có thể sử dụng các macro như . p để bắt đầu một đoạn mới và . BR để chèn một đường ngắt trong một đoạn.
Tạo liên kết
Các trang người đàn ông thường chứa các tài liệu tham khảo cho các trang người đàn ông liên quan khác hoặc tài nguyên bên ngoài. Bạn có thể tạo các siêu liên kết trong trang Man để tạo điều kiện cho điều hướng và dễ dàng truy cập vào thông tin bổ sung. Macro . i có thể được sử dụng để tạo liên kết đến các phần khác hoặc các trang web bên ngoài.
Cú pháp dòng lệnh
Khi giải thích một lệnh hoặc chương trình trong trang người đàn ông của bạn, điều quan trọng là hiển thị rõ ràng cú pháp và các tùy chọn có sẵn. Bạn có thể sử dụng macro . TP theo sau là lệnh và các tùy chọn của nó để tạo phần Cú pháp dòng lệnh được định dạng độc đáo.
Trang người mẫu
Đây là một ví dụ về cách trang người đàn ông có định dạng:
. Th ls 1 "tháng 6 năm 2022" "lệnh người dùng" Tên . sh LS - Danh sách nội dung thư mục Tóm tắt . Sh . B ls [\ -A] [\-\-tất cả] [\-\-gần như tất cả] [\-\-tác giả] [\ -b] [\-\-Escape] [\-\-block-size = value] \ fifile \ fr ... Mô tả . sh . Pp Lệnh \ fbls \ fr liệt kê nội dung của một thư mục. Theo mặc định, nó hiển thị các tệp và thư mục trong thư mục hiện tại. . Pp . Pp
- [-a, -tất cả] -Đừng bỏ qua các mục bắt đầu với.
- [-b, -escape] -In thoát hiểm cho các ký tự nongraphic
- [-\-Block-size = value]-Kích thước tỷ lệ theo giá trị
Bằng cách làm theo các hướng dẫn định dạng này, bạn có thể tạo các trang người đàn ông chuyên nghiệp và thân thiện với người dùng cho các ứng dụng hoặc lệnh Linux của bạn.
Truy cập các trang người đàn ông
Các trang Man đóng một vai trò quan trọng trong các hệ thống giống như UNIX như Linux, cung cấp một tài liệu chi tiết và toàn diện về các lệnh, chức năng và các cuộc gọi hệ thống có sẵn. Các trang này là một nguồn tài nguyên có giá trị cho bất kỳ người dùng nào, cho dù chúng là người mới lập trình hoặc có kinh nghiệm trong các hệ thống giống như Unix.
Để truy cập các trang người đàn ông, bạn có thể sử dụng công cụ dòng lệnh Man. Cú pháp để truy cập các trang người đàn ông là:
người đàn ông [phần] [lệnh]
Tham số [phần] đại diện cho phần của hướng dẫn sử dụng có thể tìm thấy lệnh hoặc hàm. Phần này khác nhau giữa các hệ thống giống như Unix khác nhau, nhưng một quy ước chung là sử dụng Phần 1 cho các lệnh của người dùng, Phần 2 cho các cuộc gọi hệ thống, Phần 3 cho các chức năng thư viện, v. v.
Tham số [Lệnh] là lệnh hoặc hàm cụ thể bạn muốn tìm hiểu thêm. Bằng cách chỉ định lệnh hoặc chức năng, bạn có thể điều hướng trực tiếp đến trang người đàn ông của nó.
Ví dụ, để truy cập trang người đàn ông cholsLệnh, bạn sẽ sử dụng lệnh sau:
người đàn ông 1 ls
Lệnh này sẽ hiển thị trang người đàn ông cholsLệnh, cung cấp thông tin về các tùy chọn và cách sử dụng khác nhau của lệnh.
Nếu bạn không chắc chắn về phần có lệnh hoặc chức năng, bạn có thể sử dụng lệnh apropos. Lệnh này tìm kiếm các trang người đàn ông và hiển thị danh sách các lệnh hoặc chức năng phù hợp với từ khóa đã cho.
Đây là một ví dụ:
apropos [từ khóa]
Lệnh này sẽ hiển thị một danh sách các lệnh hoặc chức năng có tài liệu có liên quan đến [từ khóa] được chỉ định.
Ngoài ra, bạn cũng có thể tìm kiếm các trang người đàn ông trực tuyến. Nhiều trang web cung cấp các phiên bản trực tuyến của các trang người đàn ông mà bạn có thể dễ dàng tìm kiếm và truy cập từ bất kỳ thiết bị nào. Tuy nhiên, hãy nhớ rằng các phiên bản trực tuyến có thể khác nhau về cú pháp hoặc sử dụng từ phiên bản được cài đặt trên hệ thống Linux của bạn.
Điều đáng chú ý là bạn có thể tạo các trang người đàn ông của riêng mình nếu bạn có lệnh hoặc chức năng tùy chỉnh để ghi lại. Bằng cách sử dụng ngôn ngữ định dạng Groff, bạn có thể tạo một trang người đàn ông trong một tệp văn bản và sau đó chuyển đổi nó thành định dạng thích hợp.
Tạo trang người đàn ông
Để tạo một trang người đàn ông, bạn có thể làm theo một mẫu, bao gồm các tiêu đề và cú pháp định dạng cần thiết. Đây là một mẫu mẫu cho lệnh bash:
. Th Command_name Phần_Number "Ngày" "Phiên bản" "Mô tả" Tên . sh Command_name \- Một dòng mô tả của lệnh. Tóm tắt . Sh Command_name Tùy chọn đối số Mô tả . sh Một mô tả chi tiết về những gì lệnh làm. Tùy chọn . sh Một danh sách các tùy chọn có sẵn và cách sử dụng của họ. Ví dụ . sh Các trường hợp sử dụng mẫu của lệnh. . Sh xem thêm Các trang người đàn ông liên quan khác.
Bạn có thể điều chỉnh mẫu này để đáp ứng nhu cầu của bạn, thêm hoặc xóa các phần khi cần thiết.
Khi bạn đã tạo trang người đàn ông bằng trình soạn thảo văn bản, hãy lưu nó dưới dạng tệp riêng với. Phần mở rộng Phần_Number. Ví dụ: nếu trang người đàn ông của bạn dành cho một lệnh trong Phần 1, hãy lưu nó dưới dạnglệnh_name. 1.
Để xem trang người đàn ông, bạn có thể sử dụng lệnh người đàn ông với tham số [phần] được đặt thành phần thích hợp:
người đàn ông 1 lệnh_name
Điều này sẽ hiển thị nội dung của trang người đàn ông với định dạng phù hợp, giúp dễ hiểu và làm theo hơn.
Bằng cách truy cập các trang người đàn ông, bạn có thể nhanh chóng tìm thấy thông tin về các chức năng và lệnh của UNIX khác nhau, cải thiện kiến thức của bạn về các hệ thống Linux và lập trình. Cho dù bạn là người mới bắt đầu hay nhà phát triển có kinh nghiệm, MAN PAGES là một nguồn tài nguyên vô giá để giữ trong hộp công cụ lập trình của bạn.< pan> Để xem trang người đàn ông, bạn có thể sử dụng lệnh người đàn ông với tham số [phần] được đặt thành phần thích hợp:
