自己编写man手册

语法说明

语法

[代码] [标签]
[内容]
TIPs：
Macro语法中回车和空格的作用等同。所以上述语法的结果等同于：
[代码]
[标签]
[内容]

常用代码及其说明

字体格式

代码	意义
.B或\fB	粗体
.I或\fI	斜体
\fR	正体（罗马字体）

TIPs:
如果要加粗字体，则应该使用,B[文本]或者\fB[文本]\fR。前一个的意义是加粗当前代码行文本，后一个的意义是加粗当前内容文本，后续文本恢复正体。

标题标记格式

标题请求以点（.）开头出现在行首，注意如果标题中含有空格，则应加双引号。

代码	意义
.TH	标题
.SH	节
.SS	子节

段落标记

使用回车换行不是真的换行，只会多出一个空格。正文内容如果要想换行，必须使用段落标记。而且为了排版美观，段落中最好也不要有多余的空格。

代码	意义
.TP	下一行悬挂缩进。
.pp	开始段落
.RS	开始相对缩进
.RE	结束相对缩进

TIPs:
.TP和.PP的区别
.PP：任何情况下，[内容]文本都不会换行显示。
.TP：只有在TP标签长度>=7个字符，那么[内容]文本才会换行显示。如果标签长度<7个字符，那么[内容]文本才会换行显示。

代码示例

.TH helpme "1" "Mar.2020" "个人学习笔记" "man编写说明"
.SH "Section Head 标题"
.TP
TP标记的新段落。
.PP
PP标记的新段落。
未用段落标记的一行。
.SH 详细说明
. 被注释的段落，不会显示
.TP
.B \.B
Bold font 加粗字体，等同于 \\fB...\\fR。
.TP
.I \.I
Italics font 下划线, 等同于 \\fI...\\fR 。
.TP
.B \.TH
Title Heading 标题, 有5个参数,
.RS
如果参数1和2的内容分别是a和b，那么在屏幕的上左和上右，下右这三个位置，会显示a(b)
.RE
.RS
如果参数3的内容是c,那么在屏幕的上中会显示c
.RE
.RS
如果参数4的内容是d,那么在屏幕的下左会显示d
.RE
.RS
如果参数5的内容是e,那么在屏幕的下中会显示e
.RE
.TP
.B \.SH
Section Head标题
.SS "subheading 节"
.TP
.B \.SS
subheading 节，比如上述节的用法
.PP
.B \.PP
任何情况下不换行。
.PP
.B \.PP
标签字数小于7字的情况下不换行。
.PP
.B \.PP用法示例
标签字数大于等于的情况下还是不换行。
.TP
.B \.TP
如果TP标签内容小于7个字符，就不换行。
.TP
.B \.TP用法示例
如果TP标签内容大于等于7个字符，就换行。
.HP
.B \.HP
悬挂缩进
.HP
使用HP悬挂缩进的段落是这样的。

运行

1.将代码保存到指定目录中。我的保存文件名是/usr/share/cman/man1/helpme.1
2.建立一个alias作为新的man手册命令。

echo "alias cman='man -M /usr/share/cman'" >> ~/.bashrc

3.测试运行手册

cman helpme