blocks|key|590573|text|我建议您使用在线手册编辑器葡萄，因为您可以实时看到结果。我相信它对初学者真的很有用。|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|590574|entityMap|0|LINK|mutability|MUTABLE|url|http://roperzh.com/grapse^0|D|2|0|0^^$0|@$1|2|3|4|5|6|7|L|8|@]|9|@$A|M|B|N|1|O]]|C|$]]|$1|D|3|-4|5|6|7|P|8|@]|9|@]|C|$]]]|E|$F|$5|G|H|I|C|$J|K]]]]

I'd recommend you to use <a href="http://roperzh.com/grapse" rel="nofollow noreferrer">Grapse</a>, an online man page editor, since you can see the results in real-time. I believe it's really useful for beginners.

blocks|key|590514|text|那么使用潘多克呢？您可以用标价+(甚至html，latex)编写文档，并且可以隐藏到html、pdf、word、手册页、epub、.这样，您就可以用一种格式编写文档，并以任何您喜欢的格式转换/分发文档。|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|590515|entityMap|0|LINK|mutability|MUTABLE|url|http://pandoc.org/|1|https://daringfireball.net/projects/markdown/^0|4|3|0|D|2|1|0^^$0|@$1|2|3|4|5|6|7|N|8|@]|9|@$A|O|B|P|1|Q]|$A|R|B|S|1|T]]|C|$]]|$1|D|3|-4|5|6|7|U|8|@]|9|@]|C|$]]]|E|$F|$5|G|H|I|C|$J|K]]|L|$5|G|H|I|C|$J|M]]]]

What about using <a href="http://pandoc.org/" rel="noreferrer">pandoc</a>. You can write document in <a href="https://daringfireball.net/projects/markdown/" rel="noreferrer">markdown</a> (or even html, latex) and can covert to html, pdf, word,man pages, epub, .... This way you can write documentation in one format and convert/distribute in any format you like

blocks|key|1201111|text|示例手册页，来自链接|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|1201112|.\"+Manpage+for+nuseradd.
.\"+Contact+vivek@nixcraft.net.in+to+correct+errors+or+typos.
.TH+man+8+"06+May+2010"+"1.0"+"nuseradd+man+page"
.SH+NAME
nuseradd+\-+create+a+new+LDAP+user
.SH+SYNOPSIS
nuseradd+[USERNAME]
.SH+DESCRIPTION
nuseradd+is+high+level+shell+program+for+adding+users+to+LDAP+server.++On+Debian,+administrators+should+usually+use+nuseradd.debian(8)+instead.
.SH+OPTIONS
The+nuseradd+does+not+take+any+options.+However,+you+can+supply+username.
.SH+SEE+ALSO
useradd(8),+passwd(5),+nuseradd.debian(8)
.SH+BUGS
No+known+bugs.
.SH+AUTHOR
Vivek+Gite+(vivek@nixcraft.net.in)|code-block|syntax|javascript|1201113|用脚本安装：|1201114|install+-g+0+-o+0+-m+0644+nuseradd.1+/usr/local/man/man8/
gzip+/usr/local/man/man8/nuseradd.1|1201115|手动安装：|1201116|cp+nuseradd+/usr/local/man/man8/nuseradd.1
gzip+/usr/local/man/man8/nuseradd.1|1201117|entityMap|0|LINK|mutability|MUTABLE|url|http://www.cyberciti.biz/faq/linux-unix-creating-a-manpage/^0|8|2|0|0|0|0|0|0|0^^$0|@$1|2|3|4|5|6|7|Y|8|@]|9|@$A|Z|B|10|1|11]]|C|$]]|$1|D|3|E|5|F|7|12|8|@]|9|@]|C|$G|H]]|$1|I|3|J|5|6|7|13|8|@]|9|@]|C|$]]|$1|K|3|L|5|F|7|14|8|@]|9|@]|C|$G|H]]|$1|M|3|N|5|6|7|15|8|@]|9|@]|C|$]]|$1|O|3|P|5|F|7|16|8|@]|9|@]|C|$G|H]]|$1|Q|3|-4|5|6|7|17|8|@]|9|@]|C|$]]]|R|$S|$5|T|U|V|C|$W|X]]]]

Sample man page, from the <a href="http://www.cyberciti.biz/faq/linux-unix-creating-a-manpage/" rel="nofollow">link</a>:

<pre><code>.\" Manpage for nuseradd.
.\" Contact vivek@nixcraft.net.in to correct errors or typos.
.TH man 8 "06 May 2010" "1.0" "nuseradd man page"
.SH NAME
nuseradd \- create a new LDAP user
.SH SYNOPSIS
nuseradd [USERNAME]
.SH DESCRIPTION
nuseradd is high level shell program for adding users to LDAP server. On Debian, administrators should usually use nuseradd.debian(8) instead.
.SH OPTIONS
The nuseradd does not take any options. However, you can supply username.
.SH SEE ALSO
useradd(8), passwd(5), nuseradd.debian(8)
.SH BUGS
No known bugs.
.SH AUTHOR
Vivek Gite (vivek@nixcraft.net.in)
</code></pre>

Installing with your script:

<pre><code>install -g 0 -o 0 -m 0644 nuseradd.1 /usr/local/man/man8/
gzip /usr/local/man/man8/nuseradd.1
</code></pre>

Installing it manually:

<pre><code>cp nuseradd /usr/local/man/man8/nuseradd.1
gzip /usr/local/man/man8/nuseradd.1
</code></pre>

blocks|key|590620|text|C1sc0你的答案有一个错误。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|590621|要创建自己的手册页，请执行以下步骤：|590622|1-成为超级用户：|590623|$+sudo+-i+|code-block|syntax|javascript|590624|2-转到以下目录：|590625|$+cd+/usr/bin
$+nano+your_function|590626|3-复制粘贴这个man+(maual)页面模板，然后根据您的项目个性化它：|590627|./"+Manpage+for+your_fonction
.TH+man+1+"10+September+2017"+"1.0"+"your_fonction+man+page"
.SH+NAME
your_fonction+-+do....+
.SH+SYNOPSIS
your_fonction+[optionnal+argument]+[optionnal+argument]
.SH+DESCRIPTION
your_fonction+is+a+function+which+.....
.SH+OPTIONS
your_fonction+does+not+take+any+options
.SH+BUGS
No+known+bugs.
.SH+AUTHOR
written+by+your_name+(your_website+or+your_github+or+whatever)
.SH+REPORTING+BUGS
you_github_repository/isssues+for+example|590628|4-您必须选择您的文件必须放在哪个目录中，请查看：|590629|$+cd/usr/share/man/+&&+ls|590630|你看man1，man2，..。这些类别如下：|590631|(man1)+1-用户可用的命令|590632|(man2)+2-Unix和C系统调用|590633|(man3)+C程序的3-C库例程|590634|(man4)+4-特殊文件名|590635|(man5)+5-+Unix使用的文件格式和约定|590636|(man6)+6-运动会|590637|(man7)+7字处理包|590638|(man8)+8-系统管理命令和过程|590639|在这里，目标将是man1，因此：|590640|5-返回usr/bin|590641|$+cd+/usr/bin|590642|6-复制一份带有好后缀的副本：|590643|$+cp+your_function+your_function.1|590644|7-+gzip+your_function.1|590645|$+gzip+your_function.1|590646|8-将其发送到好目录，下面是示例man1：|590647|$+cp+your_function.1.gz+/usr/share/man/man1/|590648|完成了，你可以测试你漂亮的男人页面了！|590649|+$+man+your_function|590650|entityMap^0|0|0|0|0|0|0|0|0|0|0|0|0|0|0|0|0|0|0|0|0|0|0|0|0|0|0|0|0|0|0^^$0|@$1|2|3|4|5|6|7|22|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|23|8|@]|9|@]|A|$]]|$1|D|3|E|5|6|7|24|8|@]|9|@]|A|$]]|$1|F|3|G|5|H|7|25|8|@]|9|@]|A|$I|J]]|$1|K|3|L|5|6|7|26|8|@]|9|@]|A|$]]|$1|M|3|N|5|H|7|27|8|@]|9|@]|A|$I|J]]|$1|O|3|P|5|6|7|28|8|@]|9|@]|A|$]]|$1|Q|3|R|5|H|7|29|8|@]|9|@]|A|$I|J]]|$1|S|3|T|5|6|7|2A|8|@]|9|@]|A|$]]|$1|U|3|V|5|H|7|2B|8|@]|9|@]|A|$I|J]]|$1|W|3|X|5|6|7|2C|8|@]|9|@]|A|$]]|$1|Y|3|Z|5|6|7|2D|8|@]|9|@]|A|$]]|$1|10|3|11|5|6|7|2E|8|@]|9|@]|A|$]]|$1|12|3|13|5|6|7|2F|8|@]|9|@]|A|$]]|$1|14|3|15|5|6|7|2G|8|@]|9|@]|A|$]]|$1|16|3|17|5|6|7|2H|8|@]|9|@]|A|$]]|$1|18|3|19|5|6|7|2I|8|@]|9|@]|A|$]]|$1|1A|3|1B|5|6|7|2J|8|@]|9|@]|A|$]]|$1|1C|3|1D|5|6|7|2K|8|@]|9|@]|A|$]]|$1|1E|3|1F|5|6|7|2L|8|@]|9|@]|A|$]]|$1|1G|3|1H|5|6|7|2M|8|@]|9|@]|A|$]]|$1|1I|3|1J|5|H|7|2N|8|@]|9|@]|A|$I|J]]|$1|1K|3|1L|5|6|7|2O|8|@]|9|@]|A|$]]|$1|1M|3|1N|5|H|7|2P|8|@]|9|@]|A|$I|J]]|$1|1O|3|1P|5|6|7|2Q|8|@]|9|@]|A|$]]|$1|1Q|3|1R|5|H|7|2R|8|@]|9|@]|A|$I|J]]|$1|1S|3|1T|5|6|7|2S|8|@]|9|@]|A|$]]|$1|1U|3|1V|5|H|7|2T|8|@]|9|@]|A|$I|J]]|$1|1W|3|1X|5|6|7|2U|8|@]|9|@]|A|$]]|$1|1Y|3|1Z|5|H|7|2V|8|@]|9|@]|A|$I|J]]|$1|20|3|-4|5|6|7|2W|8|@]|9|@]|A|$]]]|21|$]]

C1sc0 there is an error in your answer. 

to make your own man page, follow the steps below: 

1- become superuser: 

<pre><code>$ sudo -i 
</code></pre>

2- go to this directory:

<pre><code>$ cd /usr/bin
$ nano your_function
</code></pre>

3- copy paste this template of man (maual) page and then personalize it depending on your project:

<pre><code>./" Manpage for your_fonction
.TH man 1 "10 September 2017" "1.0" "your_fonction man page"
.SH NAME
your_fonction - do.... 
.SH SYNOPSIS
your_fonction [optionnal argument] [optionnal argument]
.SH DESCRIPTION
your_fonction is a function which .....
.SH OPTIONS
your_fonction does not take any options
.SH BUGS
No known bugs.
.SH AUTHOR
written by your_name (your_website or your_github or whatever)
.SH REPORTING BUGS
you_github_repository/isssues for example
</code></pre>

4- you have to choose in which directory man your file has to be, look at : 

<pre><code>$ cd/usr/share/man/ &amp;&amp; ls
</code></pre>

you see man1, man2,.... 
These are the categories:

(man1) 1 - Commands available to users 
(man2) 2 - Unix and C system calls 
(man3) 3 - C library routines for C programs 
(man4) 4 - Special file names 
(man5) 5 - File formats and conventions for files used by Unix 
(man6) 6 - Games 
(man7) 7 - Word processing packages 
(man8) 8 - System administration commands and procedures 

here for the example the destination will be man1, so:

5- back to usr/bin

<pre><code>$ cd /usr/bin
</code></pre>

6- make a copy with the good suffix:

<pre><code>$ cp your_function your_function.1
</code></pre>

7- gzip your_function.1 

<pre><code>$ gzip your_function.1
</code></pre>

8- send it to the good directory, here for the example man1:

<pre><code>$ cp your_function.1.gz /usr/share/man/man1/
</code></pre>

that's done, you can test your beautiful man page !

<pre><code> $ man your_function
</code></pre>

blocks|key|1201197|text|help2man在给定--help标志时使用脚本的输出来生成一个体面的手册页。|type|unstyled|depth|inlineStyleRanges|offset|length|style|CODE|entityRanges|data|1201198|这需要非常少的努力，并提供一个合理的输出。当传递--help和--version时，它依赖于脚本的输出，这也迫使您编写一个像样的--help+:-)|1201199|entityMap|0|LINK|mutability|MUTABLE|url|https://www.gnu.org/software/help2man/^0|B|6|0|8|0|0|O|6|V|9|1S|6|0^^$0|@$1|2|3|4|5|6|7|P|8|@$9|Q|A|R|B|C]]|D|@$9|S|A|T|1|U]]|E|$]]|$1|F|3|G|5|6|7|V|8|@$9|W|A|X|B|C]|$9|Y|A|Z|B|C]|$9|10|A|11|B|C]]|D|@]|E|$]]|$1|H|3|-4|5|6|7|12|8|@]|D|@]|E|$]]]|I|$J|$5|K|L|M|E|$N|O]]]]

<a href="https://www.gnu.org/software/help2man/" rel="nofollow">help2man</a> uses the output of your script when given the <code>--help</code> flag to generate a decent manpage.

This requires very little effort and provides a reasonable output. As it relies on the output of your script when passed <code>--help</code> and <code>--version</code> it also forces you to write a decent <code>--help</code> :-)

How do I create a man page for my shell script? 
I couldn't find a beginner approach on how to make man pages on Google. 

What is the easiest way to make my own Man page, based of a template, and install it with my script?

How to make a man page for my shell script?

翻译质量差，导致语言生硬或混乱。

没有提供实际的解决方法或示例。

解答不清晰，无法理解或解决问题。

页面排版不美观，阅读体验差。

文章

问答

视频

学习中心

腾讯云实验室

直播

竞赛

腾讯云代码分析专区

腾讯iOA零信任安全管理系统专区

腾讯云架构师技术同盟交流圈

腾讯云数据库专区

腾讯云顾问专区

腾讯云原生专区

腾讯混元专区

腾讯云TCE专区

腾讯云Lighthouse专区

腾讯云HAI专区

腾讯云Edgeone专区

腾讯云存储专区

腾讯云智能专区

腾讯轻联专区 

腾讯云开发专区

TAPD专区

腾讯轻量云游戏服专区

腾讯云最具价值专家

腾讯云架构师技术同盟

腾讯云创作之星

腾讯云开发者先锋

腾讯云代码助手

云原生构建

TAPD 敏捷项目管理

Cloud Studio

SDK中心

API中心

命令行工具

涵盖代码开发、场景应用、自动测试全流程，助你从零构建专属AI助手

一站式MCP教程库，解锁AI应用新玩法

如何为shell脚本创建手册页？我找不到一个初学者的方法，如何在谷歌上制作手册页。用模板制作我自己的Man页面，并用我的脚本安装它，最简单的方法是什么？

问如何为我的shell脚本制作手册页？
EN

回答 5

Stack Overflow用户

Stack Overflow用户

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问如何为我的shell脚本制作手册页？EN

回答 5

Stack Overflow用户

Stack Overflow用户

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问如何为我的shell脚本制作手册页？
EN