Страницы руководства для библиотеки должны быть в разделе 3.
Для хороших примеров страниц руководства имейте в виду, что некоторые из них написаны с использованием специфических деталей groff и/или используют специфические макросы, которые не совсем переносимы.
В переносимости man-страниц всегда есть некоторые подводные камни, поскольку некоторые системы могут (или не могут) использовать специальные возможности. Например, при документировании dialog
мне пришлось учитывать (и обходить) различия в различных системах для отображения примеров (что не оправдано).
Начните с чтения соответствующих разделов man man
, где упоминаются стандартные макросы, и сравните эти описания для FreeBSD и Linux.
Решите ли вы написать одну страницу руководства для библиотеки или отдельные страницы руководства для функций (или групп функций), зависит от того, насколько сложными будут описания функций:
Дальнейшее чтение:
Не используйте PPA в Debian 9, используйте соответствующие репозитории, как описано в Ondrej’sREADME.txt
:
sudo apt-get -y install apt-transport-https lsb-release ca-certificates
sudo wget -O /etc/apt/trusted.gpg.d/php.gpg https://packages.sury.org/php/apt.gpg
sudo sh -c 'echo "deb https://packages.sury.org/php/ $(lsb_release -sc) main" > /etc/apt/sources.list.d/php.list'
sudo apt-get update
Это позволит вам установить php7.1-gd
с зависимостями, которые могут быть удовлетворены в Debian 9.