Как сделать man-страницу для моего сценария оболочки?

Как сделать man-страницу для моего сценария оболочки?

10.10.2015 04:07:31 Просмотров 31 Источник

Как создать страницу в мой скрипт?
Я не мог найти подход Новичка о том, как сделать man-страницы в Google.

Какой самый простой способ сделать свою собственную Man-страницу, основанную на шаблоне, и установить ее вместе с моим скриптом?

У вопроса есть решение - Посмотреть?

https://stackoverflow.com/questions/33049205/how-to-make-a-man-page-for-my-shell-script#comment53919493_33049205
Да, но is говорит, что мне нужен специально отформатированный файл, и он не говорит мне, как его отформатировать :/ . Также я не понимаю, как его установить.

Ответы - Как сделать man-страницу для моего сценария оболочки? / How to make a man page for my shell script?

C1sc0

10.10.2015 04:40:12

Пример man-страницы, по ссылке:

.\" 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)

Установка с помощью вашего скрипта:

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

Установка вручную:

cp nuseradd /usr/local/man/man8/nuseradd.1
gzip /usr/local/man/man8/nuseradd.1
Luka Rahne

10.10.2015 10:58:04

А как насчет использования пандока ? Вы можете написать документ в markdown (или даже html, latex) и можете скрыться в html, pdf, word, man pages , epub, .... Таким образом, вы можете писать документацию в одном формате и конвертировать/распространять в любом формате, который вам нравится.

serge-sans-paille

10.10.2015 08:38:18

help2man использует выходные данные вашего скрипта, когда задан флаг --help, чтобы создать приличную manpage.

Это требует очень мало усилий и обеспечивает разумную отдачу. Поскольку он зависит от вывода вашего скрипта при передаче --helpи --version, он также заставляет вас написать приличную --help :-)

Является ответом!
roperzh

27.01.2016 03:01:44

Я бы рекомендовал вам использовать Grapse, онлайн-редактор man-страниц, так как вы можете видеть результаты в режиме реального времени. Я считаю, что это действительно полезно для начинающих.

https://stackoverflow.com/questions/33049205/how-to-make-a-man-page-for-my-shell-script/35026369#comment77015321_35026369
Спасибо, Дэвид, я займусь этим. :)
marcdahan

11.09.2017 12:46:17

C1sc0 в вашем ответе есть ошибка.

чтобы создать собственную справочную страницу, выполните следующие действия:

1-стать суперпользователем:

$ sudo -i 

2-Перейдите в этот каталог:

$ cd /usr/bin
$ nano your_function

3-скопируйте и вставьте этот шаблон страницы man (maual), а затем персонализируйте его в зависимости от вашего проекта:

./" 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

4-Вы должны выбрать, в каком каталоге man должен быть ваш файл, посмотрите на :

$ cd/usr/share/man/ && ls

вы видите man1, man2,.... Вот эти категории::

(man1) 1-команды, доступные пользователям
(man2) 2-системные вызовы Unix и C
(man3) 3-C библиотечные процедуры для C-программ
(man4) 4-специальные имена файлов
(man5) 5-форматы файлов и соглашения для файлов, используемых Unix
(man6) 6-Игры
(man7) 7-пакеты обработки текстов
(man8) 8-команды и процедуры системного администрирования

здесь для примера пунктом назначения будет man1, так что:

5-назад к usr / bin

$ cd /usr/bin

6-Сделайте копию с хорошим суффиксом:

$ cp your_function your_function.1

7-gzip your_function.Один

$ gzip your_function.1

8-отправьте его в хороший каталог, вот для примера man1:

$ cp your_function.1.gz /usr/share/man/man1/

вот и все, можете проверить свою красивую мужскую страницу !

 $ man your_function
https://stackoverflow.com/questions/33049205/how-to-make-a-man-page-for-my-shell-script/46145872#comment101389713_46145872
Действительно ли корень необходим для всех шагов??
Закрыть X