首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >问答首页 >是否有手册页使用的格式规范?

是否有手册页使用的格式规范?
EN

Unix & Linux用户
提问于 2018-11-10 23:59:48
回答 1查看 1.3K关注 0票数 2

我希望将手册页解析成更结构化的表单,但我无法找到手册页使用的数据格式的适当规范。我应该找的是粗呢,还是罗夫,还是别的什么?格罗夫(7)说

groff系统具有经典roff的所有特性,但增加了许多扩展。

这些扩展是像tbl之类的各种预处理程序吗?

到目前为止,我发现了以下资源:

  • troff.org -这有历史记录,一些教程,和一些死链接。
  • roff(7) (OpenBSDLinux) -没有真正的规范,只是一个简单的概述和一堆历史。
  • 手册页(7) (Linux) -这提供了关于手册页中各部分的指导原则(这是有用的),但它没有讨论数据格式。
  • 排字机独立的TROFF木马用户手册 --这些都是相当古老的,所以我不能真正判断那些论文和实践中的吹毛求疵之间的区别。

对于手册页正在使用的确切格式,是否有明确的规范?

EN

回答 1

Unix & Linux用户

发布于 2018-11-11 00:16:40

是啊。像HTML一样思考..。但前HTML。基本上是一堆排版宏用于groff .

首先,有一些共同商定的章节-当然,你可以添加更多.

代码语言:javascript
运行
复制
NAME
SYNOPSIS
DESCRIPTION
OPTIONS
BUGS
AUTHOR
SEE ALSO

对于每个(以及其他任何地方),您都使用groff排版宏语法。

例如,一个TITLE HEADER可以这样做-

代码语言:javascript
运行
复制
.TH [name of program] [section number] [center footer] [left footer] [center header]

或者是SECTION HEADER -

代码语言:javascript
运行
复制
.SH [section name]

当然,你也可以用粗体、斜体、下划线等等-

代码语言:javascript
运行
复制
.B = bold
.BI = bold alternating italic
.BR = bold alternating Roman
.I = italic
.IB = italic alternating bold
.IR = italic alternating Roman
.RB = Roman alternating bold
.RI = Roman alternating italic 

你甚至可以在你的文本文件中发表评论-

代码语言:javascript
运行
复制
." This is a comment

然后是分段(比如<p></p> html标记集)和.PP

不要忘记将文件命名为适当的名称,然后在完成时对其进行gzip

此信息(及更多信息)来自http://www.linuxhowtos.org/System/creatingman.htm

票数 0
EN
页面原文内容由Unix & Linux提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://unix.stackexchange.com/questions/481025

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档