man 命令：查看命令的帮助信息

一、命令简介

​man​ 命令是 Linux 和 Unix 系统中非常重要的命令，用于查看各种命令、函数、系统调用、配置文件等的手册页面（manual pages）。

‍

通常不看 man 文档，因为有更好用的，比如：

• 命令的帮助文档：command --help
• 在线拉取命令的用法示例：curl cheat.sh/command
• AI 提问：国内可用 智普清言​

‍

二、命令参数

man [选项] [命令/主题]

选项

• ​-k <关键词>​：搜索包含指定关键词的手册页。
• ​-f <关键词>​：显示包含指定关键词的命令简短描述。
• ​-a​：显示所有匹配的手册页，如果有多个匹配。
• ​-C <配置文件>​：指定用于格式化手册页的配置文件。
• ​-S <节号>​：指定要查看的手册页所在的节号。
• ​-M <路径>​：指定手册页的搜索路径。
• ​-l​：显示手册页的简短版本。
• ​-w​：显示手册页的路径。

‍

进入手册

man man

输出

MAN(1)                                           手册分页显示工具                                           MAN(1)

名称
       man - 系统参考手册的接口

概述
       man [man 选项] [[章节] 页 ...] ...
       man -k [apropos 选项] 正则表达式 ...
       man -K [man 选项] [章节] 关键词 ...
       man -f [whatis 选项] 页 ...
       man -l [man 选项] 文件 ...
       man -w|-W [man 选项] page ...

描述
       man  是系统的手册分页程序。指定给  man  的 页 选项通常是程序、工具或函数名。程序将显示每一个找到的相关 手册
       页。如果指定了 章节，man 将只在手册的指定 章节 搜索。默认将按预定的顺序查找所有可用的 章节（参见 默认值  一
       节），并只显示找到的第一个 页，即使多个 章节 中都有这个 页面。

       下表显示了手册的 章节 号及其包含的手册页类型。

       1   可执行程序或 shell 命令
       2   系统调用(内核提供的函数)
       3   库调用(程序库中的函数)
       4   特殊文件(通常位于 /dev)
       5   文件格式和规范，如  /etc/passwd
       6   游戏
       7   杂项（包括宏包和规范）， 如 man(7)，groff(7), man-pages(7)
       8   系统管理命令(通常只针对 root 用户)
       9   内核例程 [非标准

       一个手册 页面 包含若干个小节。

       小节名称通常包括   NAME,  概述(SYNOPSIS),  配置(CONFIGURATION),  描述(DESCRIPTION),  选项(OPTIONS),  退出状
       态(EXIT STATUS), 返回值(RETURN VALUE), 错误(ERRORS), 环境(ENVIRONMENT), 文件(FILES), 版本(VERSIONS), 符合标
       准(CONFORMING TO), 注(NOTES), 缺陷(BUGS), 示例(EXAMPLE), 作者(AUTHORS), 和 亦见(SEE ALSO).

       以下规范适用于 概述(SYNOPSIS) 小节，也可作为其他小节的指南。

       加粗文本       按原样显示。
       倾斜文本       用相应的参数进行替换。
       [-abc]         “[ ]” 内的任意/全部参数都是可选的。
       -a|-b          以“|”分隔的选项不可以一起使用。
       参数 ...       参数 可以重复。
       [表达式] ...   “[ ]”内的整个 表达式 可以重复。

       实际渲染的效果可能因输出设备而异。例如，在终端中 man 程序通常无法渲染出斜体，这时一般会以下划线或彩色文字代
       替。

       程序和函数说明应该是一个可以匹配所有可能用法的模式(pattern)。有些情况下，建议按此手册页 概述(SYNOPSIS) 小节
       所显示的分别陈述几种互斥的用法。

示例
       man ls
           显示 项目 (程序)  ls 对应的手册页。

       man man.7
           显示章节 7 中宏包 man 对应的手册页。（这是“man 7 man”的另一种拼写方法。）

‍

手册页按照节号进行分类，常见的节号包括：

• 1：用户命令
• 2：系统调用
• 3：库函数
• 4：特殊文件（通常是/dev 中的设备文件）
• 5：配置文件和文件格式
• 6：游戏和屏保
• 7：杂项
• 8：系统管理命令

退出手册页查看：

• 按下 q​ 键：退出手册页查看。
• 使用箭头键、Page Up、Page Down：浏览手册页内容。

‍

三、命令示例

1. 查看命令的手册页：比如 grep ​命令

   man grep
   

   
   

   输出：简单接受命令的用途，每个选项的作用。

   GREP(1)                                            User Commands                                           GREP(1)
   
   NAME
          grep, egrep, fgrep, rgrep - print lines that match patterns
   
   SYNOPSIS
          grep [OPTION...] PATTERNS [FILE...]
          grep [OPTION...] -e PATTERNS ... [FILE...]
          grep [OPTION...] -f PATTERN_FILE ... [FILE...]
   
   DESCRIPTION
          grep searches for PATTERNS in each FILE.  PATTERNS is one or more patterns separated by newline characters,
          and grep prints each line that matches a pattern.  Typically PATTERNS should be quoted when grep is used in
          a shell command.
   
          A  FILE  of  “-”  stands  for  standard input.  If no FILE is given, recursive searches examine the working
          directory, and nonrecursive searches read standard input.
   
          In addition, the variant programs egrep, fgrep and rgrep are the same as  grep -E,  grep -F,  and  grep -r,
          respectively.  These variants are deprecated, but are provided for backward compatibility.
   
   OPTIONS
      Generic Program Information
          --help Output a usage message and exit.
   
          -V, --version
                 Output the version number of grep and exit.
   
      Pattern Syntax
          -E, --extended-regexp
                 Interpret PATTERNS as extended regular expressions (EREs, see below).
   
          -F, --fixed-strings
                 Interpret PATTERNS as fixed strings, not regular expressions.
   
          -G, --basic-regexp
                 Interpret PATTERNS as basic regular expressions (BREs, see below).  This is the default.
   
          -P, --perl-regexp
                 Interpret  I<PATTERNS>  as Perl-compatible regular expressions (PCREs).  This option is experimental
                 when combined with the -z (--null-data) option, and grep -P may warn of unimplemented features.
   
      Matching Control
          -e PATTERNS, --regexp=PATTERNS
                 Use PATTERNS as the patterns.  If this option is used multiple times or  is  combined  with  the  -f
                 (--file)  option,  search  for  all  patterns  given.   This option can be used to protect a pattern
                 beginning with “-”.
   
          -f FILE, --file=FILE
                 Obtain patterns from FILE, one per line.  If this option is used multiple times or is combined  with
                 the -e (--regexp) option, search for all patterns given.  The empty file contains zero patterns, and
                 therefore matches nothing.
   
          -i, --ignore-case
                 Ignore case distinctions in patterns and input data, so that characters that  differ  only  in  case
                 match each other.
   
   

2. 搜索包含关键词的手册页：

   man -k keyword 	#格式
   man -k grep		#命令：搜索包含 grep 的 man文档
   egrep (1)            - print lines that match patterns
   fgrep (1)            - print lines that match patterns
   git-bugreport (1)    - Collect information for user to file a bug report
   git-grep (1)         - Print lines matching a pattern
   grep (1)             - print lines that match patterns
   lzegrep (1)          - search compressed files for a regular expression
   lzfgrep (1)          - search compressed files for a regular expression
   lzgrep (1)           - search compressed files for a regular expression
   pgrep (1)            - look up, signal, or wait for processes based on name and other attributes
   ptargrep (1)         - Apply pattern matching to the contents of files in a tar archive
   rgrep (1)            - print lines that match patterns
   xzegrep (1)          - search compressed files for a regular expression
   xzfgrep (1)          - search compressed files for a regular expression
   xzgrep (1)           - search compressed files for a regular expression
   zegrep (1)           - search possibly compressed files for a regular expression
   zfgrep (1)           - search possibly compressed files for a regular expression
   zgrep (1)            - search possibly compressed files for a regular expression
   zstdgrep (1)         - print lines matching a pattern in zstandard-compressed files
   

3. 显示命令的简短描述：

   man -f command 	#格式
   man -f grep		#命令：输出 man 文档中对于 grep 命令的简介
   grep (1)             - print lines that match patterns
   

‍

推荐使用 curl cheat.sh/command​ 在线拉相关 命令示例​

curl cheat.sh/ls #命令
 cheat:ls 

ls <dir>

# To display everything in <dir>, including hidden files:
ls -a <dir>

# To display all files, along with the size (with unit suffixes) and timestamp:
ls -lh <dir>

# To display files, sorted by size:
ls -S <dir>

# To display directories only:
ls -d */ <dir>

# To display directories only, include hidden:
ls -d .*/ */ <dir>

# To display all files sorted by changed date, most recent first:
ls -ltc 

# To display files sorted by create time:
ls -lt

# To display files in a single column:
ls -1

# To show ACLs (MacOS):
# see also `cheat chmod` for `/bin/chmod` options for ACLs
/bin/ls -le

# To show all the subtree files (Recursive Mode):
ls -R

 tldr:ls 
# ls
# List directory contents.
# More information: <https://www.gnu.org/software/coreutils/ls>.

# List files one per line:
ls -1

# List all files, including hidden files:
ls -a

# List all files, with trailing `/` added to directory names:
ls -F

# Long format list (permissions, ownership, size, and modification date) of all files:
ls -la

# Long format list with size displayed using human-readable units (KiB, MiB, GiB):
ls -lh

# Long format list sorted by size (descending):
ls -lS

# Long format list of all files, sorted by modification date (oldest first):
ls -ltr

# Only list directories:
ls -d */