当前位置: 技术问答>linux和unix
关于man命令的SYNOPSIS
来源: 互联网 发布时间:2016-06-19
本文导语: 大家应该都用过man命令吧 man运行下来有下面内容 NAME 程序或者命令的名称、手册节号及发布日期 SYNOPSIS 怎样调用命令,带有所有选项和参数的完整列表 DESCRIPTl0N 命令及其用法的简短小结 RETURN VALUES 程...
大家应该都用过man命令吧
man运行下来有下面内容
NAME
程序或者命令的名称、手册节号及发布日期
SYNOPSIS
怎样调用命令,带有所有选项和参数的完整列表
DESCRIPTl0N
命令及其用法的简短小结
RETURN VALUES
程序或者库函数返回值,以及产生特定返回值的环境
...
我主要想知道 SYNOPSIS 这项内容的语法。
像[]代表可以省略,|代表或者等等
高手能否提供官方的标准语法。以及网址。英文也可以的。
man运行下来有下面内容
NAME
程序或者命令的名称、手册节号及发布日期
SYNOPSIS
怎样调用命令,带有所有选项和参数的完整列表
DESCRIPTl0N
命令及其用法的简短小结
RETURN VALUES
程序或者库函数返回值,以及产生特定返回值的环境
...
我主要想知道 SYNOPSIS 这项内容的语法。
像[]代表可以省略,|代表或者等等
高手能否提供官方的标准语法。以及网址。英文也可以的。
|
这个好像随便找个哪种unix系统的命令操作手册,最前面就有这种说明:
比如在AIX的命令大全(可从http://www.itpub.net/761677.html下载)里面看到的:
语法语句是一种表示命令语法的方法,它由诸如中括号([ ])、花括号({ })和竖线(|)等符号构成。以下是关于 unget 命令的一个语法语句的示例:
unget [ -rSID ] [ -s ] [ -n ] File ...
在命令语法语句中,使用以下约定:
命令行中必须照字面原意输入的项用粗体字显示。这些项包含命令名称、标志和文字字符。
表示必须用名称替换的变量的项用斜体字显示。这些项包含带有标志的参数和命令所要读取的参数,例如 Files 和 Directories。
用括号所包含的参数为可选的。
用花括号所包含的参数为必要的。
括号、花括号都未包含的参数为必要的。
竖线表示您只要选择一个参数。例如,[ a | b ] 表示您可以选择 a、b 或者什么都不选。同样的, { a| b } 表示您必须选择 a 或者 b。
省略号(...)表示命令行中的参数可以重复。
破折号(—)代表标准输入。
比如在AIX的命令大全(可从http://www.itpub.net/761677.html下载)里面看到的:
语法语句是一种表示命令语法的方法,它由诸如中括号([ ])、花括号({ })和竖线(|)等符号构成。以下是关于 unget 命令的一个语法语句的示例:
unget [ -rSID ] [ -s ] [ -n ] File ...
在命令语法语句中,使用以下约定:
命令行中必须照字面原意输入的项用粗体字显示。这些项包含命令名称、标志和文字字符。
表示必须用名称替换的变量的项用斜体字显示。这些项包含带有标志的参数和命令所要读取的参数,例如 Files 和 Directories。
用括号所包含的参数为可选的。
用花括号所包含的参数为必要的。
括号、花括号都未包含的参数为必要的。
竖线表示您只要选择一个参数。例如,[ a | b ] 表示您可以选择 a、b 或者什么都不选。同样的, { a| b } 表示您必须选择 a 或者 b。
省略号(...)表示命令行中的参数可以重复。
破折号(—)代表标准输入。