☰

如何阅读 MAN 页概要部分中的命令示例语法？

tag-icon • tag-icon command-line bash manpage
如何阅读 MAN 页概要部分中的命令示例语法？

我正在尝试更好地使用文档来理解命令语法，但我意识到我并不完全理解所使用的符号，这些符号显示了可以传递给命令的所有选项和参数。

例如man zip：

SYNOPSIS

   zip  [-aABcdDeEfFghjklLmoqrRSTuvVwXyz!@$] [--longoption ...]  [-b path]
   [-n suffixes] [-t date] [-tt date] [zipfile [file ...]]  [-xi list]

或者man bzip2：

SYNOPSIS
       bzip2 [ -cdfkqstvzVL123456789 ] [ filenames ...  ]
       bzip2 [ -h|--help ]
       bunzip2 [ -fkvsVL ] [ filenames ...  ]
       bunzip2 [ -h|--help ]
       bzcat [ -s ] [ filenames ...  ]
       bzcat [ -h|--help ]
       bzip2recover filename

是否有资源可以介绍如何读取此语法并告诉我每个符号的含义？

答案1

一个很好的资源是这（我厚颜无耻地抄袭了）

对于初学者来说，unix 最难的部分之一就是查找文档。当您听说系统附带在线手册时，通常会松一口气。您不知道的是，手册页是技术参考。虽然这听起来很糟糕——但事实并非如此！一旦您了解了手册页的基础知识，您就会欣赏它们的编写方式。如果您需要信息，并且没有时间浪费，man 命令就是您的最佳选择。

本文档旨在教您如何阅读 unix 手册（通常称为 man 页）。常用引语

在进入第一个手册页之前，让我们先了解一下其中的一些常用符号。这些符号有时被称为引号。

手册页的主要用途是查找程序的参数。由于大多数参数都是可选的，因此它们将括在方括号中。

[optional]
[-abcgln]

有些选项会有有限的选择列表。选择列表将以逗号分隔并放在括号中。

{choice1,choice2}
{yes,no}

许多帮助文档来源将强制参数括在小于/大于符号之间。

<manditory>
<program_name>

尽管上述强制引号通常不会在手册页中使用，但了解一下还是有好处的。

答案2

来自man手册页：

以下约定适用于概要部分，并可作为其他部分的指南。 人概要描述

确切的渲染可能因输出设备而异。例如，man 在终端中运行时通常无法渲染斜体，而通常会使用下划线或彩色文本。

命令或函数说明是一种应与所有可能的调用相匹配的模式。在某些情况下，建议说明几个独有的调用，如本手册页的 SYNOPSIS 部分所示。

相关内容