制作自己的man手册。

mq110

一直以来没有发现制作man手册的文章。写了一篇供大家参考补充。
不是很完善，大家可以继续完善它。

关键命令:

groff   groff_man  gzip

其中大部分宏标签可以通过 man groff_man来查看。

主要宏标签

1. 
   
2. .\"
   
3. 在行首的注释
   

复制代码

1. 
   
2. \"
   
3. 在行中的注释
   

复制代码

1. 
   
2. .TH title section [extra1] [extra2] [extra3]
   
3. 
   
4. 其中section 为1-8之前的数字. extra1 在下中. extra2 在左下  extra3在上中
   
5. TH在文件的开始
   

复制代码

1. 
   
2. .SH 从行首开始,靠左边,宽体
   

复制代码

1. 
   
2. .SS 和.SS不同之处加了一个"边界" ,宽体
   

复制代码

1. 
   
2. .TP n
   
3. TP标签下的第2行开始缩进n个字符　(在第1行超过n字符的前提下)　n默认值为7
   

复制代码

1. 
   
2. .sp
   
3. 
   
4. 空行
   

复制代码

设置字体的宏:

1. 
   
2. .B
   
3. 
   
4. 宽体,如果本行没有文字,则.B标签的下一行为宽体
   

复制代码

1. 
   
2. .I
   
3. 
   
4. 加下划线
   

复制代码

1. 
   
2. \fB文字\fR
   
3. 
   
4. 将该文字设置成宽体
   

复制代码

1. 
   
2. \fI文字\fR
   
3. 
   
4. 将文字加下划线
   

复制代码

其他转译字符：

1. 
   
2. .为\&.
   
3. 
   
4. -为\-
   

复制代码

mq110

以下为一个例子 用到上面所说的标签:

新建文件:
touch hello.1

编辑该文件

1. 
   
2. .\" author : mq110
   
3. 
   
4. .TH Hello 1 "2006-9-26" "GNU" "GNU tools"         \"  hello(1)  GNU tools  hello(1)
   
5.                                                   \"  GNU       2006-9-26  hello(1)
   
6. .SH Name                                          \"  left
   
7. hello \- GNU hello                                 \" - must be \-
   
8. .SH SYNOPSIS
   
9. .B hello
   
10. .RB [\fB\-help\fR]
    
11. .RB [\-a]
    
12. .sp
    
13. .SH DESCRIPTION
    
14. this is a test\&.
    
15. .TP
    
16. \fIitalic\fR
    
17. .sp
    
18. .sp
    
19. .TP 3
    
20. 123456789
    
21. 890
    
22. 
    

复制代码

groff -Tascii -man hello.1
看到显示的结果

cp hello.1 hello.1.bak
备份一下

gzip hello.1
生成hello.1.gz

mv hello.1.gz /usr/share/man/man1

man hello

mq110

groff -Tascii -man hello.1

显示的结果

[root@Firewall man]# groff -Tascii -man hello.1

1. 
   
2. Hello(1)                           GNU tools                          Hello(1)
   
3. 
   
4. 
   
5. 
   
6. Name
   
7.        hello - GNU hello
   
8. 
   
9. SYNOPSIS
   
10.        hello [-help] [-a]
    
11. 
    
12. 
    
13. DESCRIPTION
    
14.        this is a test.
    
15. 
    
16.        italic
    
17. 
    
18. 
    
19. 
    
20.        123456789
    
21.           890
    
22. 
    
23. 
    
24. 
    
25. 
    
26. GNU                                2006-9-26                          Hello(1)
    

复制代码

可以看着这个显示做修改。


man hello的效果

1. 
   
2. Hello(1)                                                 GNU tools                                                Hello(1)
   
3. 
   
4. Name
   
5.        hello - GNU hello
   
6. 
   
7. SYNOPSIS
   
8.        hello [-help] [-a]
   
9. 
   
10. DESCRIPTION
    
11.        this is a test.
    
12. 
    
13.        italic
    
14. 
    
15.        123456789
    
16.           890
    
17. 
    
18. GNU                                                      2006-9-26                                                Hello(1)
    

复制代码

[ 本帖最后由 mq110 于 2006-9-26 18:11 编辑 ]

wwy

有意思，可以写一些说明文档了

流氓无产者

应该有更简单的方法
最好WYSWYG

flw

牛人啊！
我只会用 pod2man，也凑个热闹吧！

1. flw@Sleeper:~$ cat ttt.pod
   
2. =head1 Name
   
3. 
   
4. hello - GNU hello
   
5. 
   
6. =head1 SYNOPSIS
   
7. 
   
8. hello [-help] [-a]
   
9. 
   
10. =head1 DESCRIPTION
    
11. 
    
12. this is a test.
    
13. 
    
14. italic
    
15. 
    
16. 
    
17. 
    
18. 123456789
    
19. 890
    
20. 
    
21. =head1 Author
    
22. 
    
23. flw <flw@cpan.org>
    
24. flw@Sleeper:~$ pod2man ttt.pod | groff -Tascii -man
    
25. TTT(1)                User Contributed Perl Documentation               TTT(1)
    
26. 
    
27. 
    
28. 
    
29. Name
    
30.        hello - GNU hello
    
31. 
    
32. SYNOPSIS
    
33.        hello [-help] [-a]
    
34. 
    
35. DESCRIPTION
    
36.        this is a test.
    
37. 
    
38.        italic
    
39. 
    
40.        123456789 890
    
41. 
    
42. Author
    
43.        flw <flw@cpan.org>
    
44. 
    
45. 
    
46. 
    
47. perl v5.8.8                       2006-09-26                            TTT(1)
    
48. flw@Sleeper:~$

复制代码

mq110

原帖由 flw 于 2006-9-26 18:23 发表
牛人啊！
我只会用 pod2man，也凑个热闹吧！

[code]flw@Sleeper:~$ cat ttt.pod
=head1 Name

hello - GNU hello

=head1 SYNOPSIS

hello [-help] [-a]

=head1 DESCRIPTION

this is a test.

...

看似很简单啊。也可以设置粗体 和 斜体吧？

mq110

原帖由 流氓无产者 于 2006-9-26 18:17 发表
应该有更简单的方法
最好WYSWYG

这个是？？

flw

原帖由 mq110 于 2006-9-26 18:28 发表

看似很简单啊。也可以设置粗体 和 斜体吧？

对呀。

flw

原帖由 mq110 于 2006-9-26 18:29 发表

这个是？？

What You See, What You Get?
翻译成中文就是：
我要声（于是便有了声），
我要光（于是又有了光）

[ 本帖最后由 flw 于 2006-9-26 18:32 编辑 ]