Roy的个人站

樵夫的小站

马上订阅 Roy的个人站 RSS 更新: https://geofftools.cn/blog/atom.xml

用markdown编写man文档

2019年9月9日 21:09

晚上有些碎片时间可以用，想着接一接CMPP的man翻译。一直很好奇man文档都是怎么编写出来的，背后是什么格式的文本，于是就接触到了roff格式。这篇文章介绍了三种文件格式，md、roff、富文本，就scpp作为例子展示了从md如何生成man文档并安装。如果你想要生成自己的man文档，或者想要了解这几个文档格式，不妨看一下这篇文章。

准备内容

本文中介绍三种文件格式的区别的时候，转换roff语言与富文本使用到了groff命令，可能需要安装。

在md转化为富文本的时候除了groff命令，还使用到了pandoc命令，可以进行一个安装。

三种文档

以scpp的文档展示一下三种格式的区别。

富文本

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
SCPP(1)                                                                SCPP(1)



NNAAMMEE
       scpp - scp plus

SSYYNNOOPPSSIISS
       ssccpppp [ push | pull ] [ scp options ] source target

DDEESSCCRRIIPPTTIIOONN
       ssccpppp  simplifys  file...
剩余内容已隐藏
查看完整文章以阅读更多
查看完整文章