Simple man help file in Linux

Source: Internet
Author: User
Me
Are
I
Straight
In
Nu
Force
!

Writing a Help file for a function is quite simple if it is just for your convenience (you don't need a strict format, you can understand it yourself, don't take it out to make it hard for others to understand, let's take a look at the man file.
In/usr/share/man/Manx/

'X' indicates a number, that is, the man type.

***************************************

the most common fields in Linux and their names and descriptions are as follows:
Domain Name Description
1. USER commands can be started by anyone.
2. A system call is a function provided by the kernel.
3 routines: library functions.
4 devices, that is, special files under the/dev directory.
5. file format description, for example,/etc/passwd.
6 games, no need to explain!
7 Miscellaneous, such as macro command packages and conventions.
8. The system administrator tool can only be started by the root user.
9 others (Linux-specific) used to store the Program documentation of the kernel routine.
N new documents may need to be moved to more appropriate fields.
O old documents may be retained for a period of time.
L local documents related to the specific system.
************************************* * ***
A common function is in the man3 directory.
create a file named "your function name. "Category", such as "hello.3", and then write content in it. It is best to look at the format and syntax of other man files.

Example:
# Echo abcd1234>/usr/share/man/man3/hello.3
# Man Hello

Run the following command to package:
# Gzip/usr/share/man/man3/hello.3
# Man Hello

Contact Us

The content source of this page is from Internet, which doesn't represent Alibaba Cloud's opinion; products and services mentioned on that page don't have any relationship with Alibaba Cloud. If the content of the page makes you feel confusing, please write us an email, we will handle the problem within 5 days after receiving your email.

If you find any instances of plagiarism from the community, please send an email to: info-contact@alibabacloud.com and provide relevant evidence. A staff member will contact you within 5 working days.

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.