Как создать справочную страницу для моего сценария оболочки?
Я не смог найти способ для начинающих о том, как создавать справочные страницы в Google.
Как проще всего создать собственную справочную страницу на основе шаблона и установить ее с помощью моего сценария?
Я бы порекомендовал вам использовать Grapse, онлайн-редактор справочных страниц, так как вы можете увидеть результаты в реальном времени. время. Я считаю, что это действительно полезно для начинающих.
Как насчет использования pandoc. Вы можете написать документ в markdown (или даже html, латекс) и можете конвертировать в html, pdf, word ,справочные страницы, epub, .... Таким образом, вы можете писать документацию в одном формате и конвертировать/распространять в любом удобном для вас формате.
Пример справочной страницы по ссылке:
.\" Manpage for nuseradd.
.\" Contact [email protected] 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 ([email protected])
Установка с помощью вашего скрипта:
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
C1sc0 в вашем ответе ошибка.
чтобы создать собственную справочную страницу, выполните следующие действия:
1- стать суперпользователем:
$ sudo -i
2- перейдите в этот каталог:
$ cd /usr/bin
$ nano your_function
3- скопируйте и вставьте этот шаблон справочной (мауальной) страницы, а затем персонализируйте его в зависимости от вашего проекта:
./" 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- вам нужно выбрать, в каком каталоге должен находиться ваш файл, посмотрите:
$ 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 ваша_функция.1
$ gzip your_function.1
8- отправить его в хороший каталог, например, здесь man1:
$ cp your_function.1.gz /usr/share/man/man1/
это сделано, вы можете проверить свою прекрасную справочную страницу!
$ man your_function
help2man использует вывод вашего скрипта, если ему задан флаг --help, для создания достойной справочной страницы.
Это требует очень мало усилий и обеспечивает разумный результат. Поскольку он зависит от вывода вашего скрипта при передаче --help и --version, он также заставляет вас написать приличный --help :-)
