Bash / 帮助手册 / alias
Bash / 帮助手册 / arch

约 8845 字

约 44 分钟

#Bash 的 apropos 命令

apropos [OPTION] KEYWORD...

功能

搜索帮助手册（man）的名字和描述。

类型

可执行文件（/usr/bin/apropos），属于 man-db。

参数

  • OPTION 选项：
    • -d, --debug - 打印调试信息
    • -v, --verbose - 打印详细信息
    • -r, --regex - 搜索关键词 KEYWORD 支持正则表达式
    • -w, --wildcard - 搜索关键词 KEYWORD 支持 SHELL 风格通配符
    • -e, --exact - 搜索关键词 KEYWORD 必须精确匹配
    • -a, --and - 必须同时匹配所有搜索关键词 KEYWORD
    • -l, --long - 不要将输出截断至终端宽度
    • -s list, --sections=list, --section=list - 只在 list 指定的章节中搜索；多个章节可用逗号（,）或冒号（:）分隔
    • -m system[,...], --systems=system[,...] - 指定操作系统；用于可以访问其它系统手册的情形
    • -M path, --manpath=path - 指定搜测的顶层搜索路径；多个路径使用冒号（:）分割，默认为 $MANPATH 或 $PATH
    • -L locale, --locale=locale - 设置地区
    • -C file, --config-file=file - 使用指定的用户配置文件；默认为 ~/.manpath
    • -?, --help - 打印帮助信息
    • --usage - 打印简单的使用方法
    • -V, --version - 打印版本
  • KEYWORD - 要搜索的关键词

#帮助手册的章节

  1. 可执行程序和 SHELL 命令
  2. 系统调用（内核提高的函数）
  3. 库函数
  4. 特殊文件
  5. 文件格式约定（例如 /etc/passwd）
  6. 游戏
  7. 杂项
  8. 系统管理员命令
  9. 内核例程（非标准）

#示例

$ apropos -s 1 .    # 打印所有命令
as (1)               - the portable GNU assembler.
wget (1)             - The non-interactive network downloader.
[ (1)                - Check file types and compare values.
aa-enabled (1)       - test whether AppArmor is enabled
aa-exec (1)          - confine a program with the specified AppArmor profile
aa-features-abi (1)  - Extract, validate and manipulate AppArmor feature abis
...

#推荐阅读

#手册

APROPOS(1)                     Manual pager utils                    APROPOS(1)

NAME
       apropos - search the manual page names and descriptions

SYNOPSIS
       apropos  [-dalv?V]  [-e|-w|-r] [-s list] [-m system[,...]] [-M path] [-L
       locale] [-C file] keyword ...

DESCRIPTION
       Each manual page has a short description available within  it.   apropos
       searches the descriptions for instances of keyword.

       keyword  is  usually  a  regular expression, as if (-r) was used, or may
       contain wildcards (-w), or match the exact keyword  (-e).   Using  these
       options, it may be necessary to quote the keyword or escape (\) the spe‐
       cial characters to stop the shell from interpreting them.

       The  standard  matching  rules allow matches to be made against the page
       name and word boundaries in the description.

       The database searched by apropos is updated by the mandb  program.   De‐
       pending on your installation, this may be run by a periodic cron job, or
       may need to be run manually after new manual pages have been installed.

OPTIONS
       -d, --debug
              Print debugging information.

       -v, --verbose
              Print verbose warning messages.

       -r, --regex
              Interpret  each keyword as a regular expression.  This is the de‐
              fault behaviour.  Each keyword will be matched against  the  page
              names  and the descriptions independently.  It can match any part
              of either.  The match is not limited to word boundaries.

       -w, --wildcard
              Interpret each keyword as a pattern containing shell style  wild‐
              cards.   Each  keyword will be matched against the page names and
              the descriptions independently.  If --exact is also used, a match
              will only be found if an expanded keyword matches an  entire  de‐
              scription or page name.  Otherwise the keyword is also allowed to
              match on word boundaries in the description.

       -e, --exact
              Each  keyword  will be exactly matched against the page names and
              the descriptions.

       -a, --and
              Only display items that match all the supplied keywords.  The de‐
              fault is to display items that match any keyword.

       -l, --long
              Do not trim output to the terminal width.  Normally, output  will
              be  truncated  to  the  terminal width to avoid ugly results from
              poorly-written NAME sections.

       -s list, --sections=list, --section=list
              Search only the given manual  sections.   list  is  a  colon-  or
              comma-separated  list of sections.  If an entry in list is a sim‐
              ple section, for example "3", then the displayed list of descrip‐
              tions will include pages in sections "3", "3perl", "3x",  and  so
              on;  while  if  an  entry  in  list has an extension, for example
              "3perl", then the list will only include pages in that exact part
              of the manual section.

       -m system[,...], --systems=system[,...]
              If this system has access to other operating systems' manual page
              descriptions, they can be searched using this option.  To  search
              NewOS's manual page descriptions, use the option -m NewOS.

              The  system specified can be a combination of comma-delimited op‐
              erating system names.  To include a search of the native  operat‐
              ing  system's whatis descriptions, include the system name man in
              the argument string.  This option will override the $SYSTEM envi‐
              ronment variable.

       -M path, --manpath=path
              Specify an alternate set of colon-delimited manual  page  hierar‐
              chies  to search.  By default, apropos uses the $MANPATH environ‐
              ment variable, unless it is empty or unset, in which case it will
              determine an appropriate manpath based on your $PATH  environment
              variable.  This option overrides the contents of $MANPATH.

       -L locale, --locale=locale
              apropos  will normally determine your current locale by a call to
              the C function setlocale(3) which interrogates  various  environ‐
              ment  variables,  possibly  including $LC_MESSAGES and $LANG.  To
              temporarily override the determined value,  use  this  option  to
              supply  a  locale  string directly to apropos.  Note that it will
              not take effect until the search for pages actually begins.  Out‐
              put such as the help message will always be displayed in the ini‐
              tially determined locale.

       -C file, --config-file=file
              Use this user configuration  file  rather  than  the  default  of
              ~/.manpath.

       -?, --help
              Print a help message and exit.

       --usage
              Print a short usage message and exit.

       -V, --version
              Display version information.

EXIT STATUS
       0      Successful program execution.

       1      Usage, syntax or configuration file error.

       2      Operational error.

       16     Nothing was found that matched the criteria specified.

ENVIRONMENT
       SYSTEM If $SYSTEM is set, it will have the same effect as if it had been
              specified as the argument to the -m option.

       MANPATH
              If  $MANPATH is set, its value is interpreted as the colon-delim‐
              ited manual page hierarchy search path to use.

              See the SEARCH PATH section of manpath(5) for the default  behav‐
              iour and details of how this environment variable is handled.

       MANWIDTH
              If $MANWIDTH is set, its value is used as the terminal width (see
              the --long option).  If it is not set, the terminal width will be
              calculated  using  the  value of $COLUMNS, and ioctl(2) if avail‐
              able, or falling back to 80 characters if all else fails.

       POSIXLY_CORRECT
              If $POSIXLY_CORRECT is set, even to a  null  value,  the  default
              apropos search will be as an extended regex (-r).  Nowadays, this
              is the default behaviour anyway.

FILES
       /usr/share/man/index.(bt|db|dir|pag)
              A traditional global index database cache.

       /var/cache/man/index.(bt|db|dir|pag)
              An FHS compliant global index database cache.

       /usr/share/man/.../whatis
              A traditional whatis text database.

SEE ALSO
       man(1), whatis(1), mandb(8)

AUTHOR
       Wilf. ([email protected]).
       Fabrizio Polacco ([email protected]).
       Colin Watson ([email protected]).

BUGS
       https://gitlab.com/man-db/man-db/-/issues
       https://savannah.nongnu.org/bugs/?group=man-db

2.13.1                             2025-05-02                        APROPOS(1)

更新: 2026/10/20

作者: planc

创建: 2026/10/20

Bash / 帮助手册 / alias
Bash / 帮助手册 / arch