5.15. Установка файлов

5.15.1. Макросы INSTALL_*

Используйте макросы, которые есть в файле bsd.port.mk для обеспечения правильных прав доступа файлов в целях *-install порта. Устанавливайте права владения напрямую в pkg-plist через соответствующие записи @owner owner и @group group. Эти операторы работают до момента их переопределения или до конца pkg-plist, поэтому не забывайте их сбрасывать, когда они больше не нужны. По умолчанию владение устанавливается для root:wheel.

  • INSTALL_PROGRAM - это команда для установки бинарных выполнимых файлов.

  • INSTALL_SCRIPT - это команда для установки выполнимых скриптов.

  • INSTALL_LIB - это команда для установки динамических библиотек.

  • INSTALL_KLD - это команда для установки загружаемых модулей ядра. Некоторые архитектуры предпочитают, чтобы для модулей сохранялись отладочные сведения, по этой причине используйте эту команду вместо INSTALL_PROGRAM.

  • INSTALL_DATA - это команда для установки совместно используемых файлов данных.

  • INSTALL_MAN - это команда для установки страниц Справочника и другой документации (никаких файлов она не сжимает).

В основе работы этих макросов лежит команда install со всеми соответствующими флагами. Смотрите пример их использования ниже.

5.15.2. Удаление отладочной информации в бинарных файлах и динамических библиотеках

Не удаляйте отладочную информацию из бинарных файлов вручную, если вы это делали. Во всех двоичных файлах отладочная информация должна быть удалена, и макрос INSTALL_PROGRAM выполнит установку и удаление отладочной информации одновременно (обратитесь к следующему разделу). Макрос INSTALL_LIB делает то же самое для динамических библиотек.

Если вам нужно удалить отладочную информацию из файла без использования макросов INSTALL_PROGRAM и INSTALL_LIB, то это можно сделать при помощи ${STRIP_CMD}. Обычно это делается внутри цели post-install. К примеру:

post-install:
	${STRIP_CMD} ${STAGEDIR}${PREFIX}/bin/xdl

Удаление отладочной информации из нескольких файлов:

post-install:
	.for l in geometry media body track world
	${STRIP_CMD} ${STAGEDIR}${PREFIX}/lib/lib${PORTNAME}-${l}.so.0
	.endfor

Для проверки того, удалена ли отладочная информация из файла, используйте file(1). Для двоичных файлов file(1) печатает stripped или not stripped. Кроме того, strip(1) определяет, была ли уже удалена из программы отладочная информация, и в этом случае просто завершает свою работу.

5.15.3. Установка целого дерева файлов

Иногда должно быть установлено большое количество файлов с сохранением их иерархической организации. Например, копирование дерева каталогов целиком из WRKSRC в целевой каталог внутри PREFIX. Обратите внимание, что PREFIX, EXAMPLESDIR, DATADIR и другие переменные пути всегда должны предваряться STAGEDIR, чтобы не ломать staging (смотрите Раздел 6.1, <>).

Для этой ситуации существует два макроса. Преимущество от использования этих макросов вместо команды cp в том, что они гарантируют установку правильного владельца и прав на конечные файлы. Первый макрос, COPYTREE_BIN, делает все устанавливаемые файлы исполняемыми, что подходит для установки в PREFIX/bin. Второй макрос, COPYTREE_SHARE, не устанавливает на файлы права исполнения, и, таким образом, подходит для установки файлов внутри каталога PREFIX/share.

post-install:
	${MKDIR} ${STAGEDIR}${EXAMPLESDIR}
	(cd ${WRKSRC}/examples && ${COPYTREE_SHARE} . ${STAGEDIR}${EXAMPLESDIR})

В этом примере устанавливается содержимое каталога examples из установочных файлов производителя в надлежащее место для примеров вашего порта.

post-install:
	${MKDIR} ${STAGEDIR}${DATADIR}/summer
	(cd ${WRKSRC}/temperatures && ${COPYTREE_SHARE} "June July August" ${STAGEDIR}${DATADIR}/summer)

А в этом примере будут установлены данные летних месяцев в подкаталог summer каталога DATADIR.

В качестве третьего параметра в макросе COPYTREE_* можно передать дополнительные параметры find. Например, чтобы в первом примере установить все файлы кроме файлов Makefile, можно использовать следующую команду.

post-install:
	${MKDIR} ${STAGEDIR}${EXAMPLESDIR}
	(cd ${WRKSRC}/examples && \
	${COPYTREE_SHARE} . ${STAGEDIR}${EXAMPLESDIR} "! -name Makefile")

Эти макросы не производят добавление устанавливаемых файлов в pkg-plist. Они должны быть добавлены туда вручную. Необязательные файлы документации (PORTDOCS, смотрите Раздел 5.15.4, <<Установка дополнительной документации>>) и примеров (PORTEXAMPLES) всегда должны предваряться в pkg-plist префиксами %%PORTDOCS%% или %%PORTEXAMPLES%%.

5.15.4. Установка дополнительной документации

Если с вашим программным обеспечением поставляется некоторая документация, отличающаяся от стандартных страниц Справочника и файлов info, которая, как вы думаете, будет полезна пользователям, установите ее в каталог PREFIX/share/doc. Это может быть сделано, как и в предыдущем разделе, в цели post-install.

Создайте для вашего порта новый каталог. Имя каталога должно соответствовать тому, что представляет из себя порт. Обычно это означает PORTNAME. Однако, если вы думаете, что пользователь захочет иметь разные версии порта, установленные одновременно, то вы можете использовать полное имя PKGNAME.

Поскольку устанавливаются только файлы, перечисленные в pkg-plist, безопасным способом будет устанавливать документацию в STAGEDIR всегда (смотрите Раздел 6.1, <>). Следовательно, блоки .if нужны только для файлов достаточно большого размера, установка которых влечёт значительные накладные расходы на операции ввода/вывода.

post-install:
	${MKDIR} ${STAGEDIR}${DOCSDIR}
	${INSTALL_MAN} ${WRKSRC}/docs/xvdocs.ps ${STAGEDIR}${DOCSDIR}

Вот несколько полезных переменных и то, как они преобразуются по умолчанию при использовании в Makefile:

  • DATADIR преобразуется в PREFIX/share/PORTNAME.

  • DATADIR_REL преобразуется в share/PORTNAME.

  • DOCSDIR преобразуется в PREFIX/share/doc/PORTNAME.

  • DOCSDIR_REL преобразуется в share/doc/PORTNAME.

  • EXAMPLESDIR преобразуется в PREFIX/share/examples/PORTNAME.

  • EXAMPLESDIR_REL преобразуется в share/examples/PORTNAME.

Примечание:

Параметр DOCS управляет установкой дополнительной документации в DOCSDIR. Это не относится к стандартным страницам справочника и страницам info. Все, что устанавливается в DATADIR и EXAMPLESDIR, соответственно управляется через параметры DATA и EXAMPLES.

Эти переменные экспортируются в PLIST_SUB. Их значения появятся там в виде имён путей относительно PREFIX, если это возможно. То есть share/doc/PORTNAME в списке сборки по умолчанию будет заменен на %%DOCSDIR%%, и так далее. (Дополнительную информацию о подстановке в pkg-plist можно найти здесь.)

Все условно устанавливаемые файлы и каталоги с документацией должны быть перечислены в файле pkg-plist с префиксом %%PORTDOCS%%, например:

%%PORTDOCS%%%%DOCSDIR%%/AUTHORS
%%PORTDOCS%%%%DOCSDIR%%/CONTACT
%%PORTDOCS%%@dirrm %%DOCSDIR%%

В качестве альтернативы перечислению файлов документации в файле pkg-plist, порт может указать в переменной PORTDOCS список имён файлов и глобальных шаблонов командного процессора для добавления в окончательный список сборки. Имена будут задаваться относительно DOCSDIR. Таким образом, порт, использующий PORTDOCS и нестандартное местоположение документации, должен задавать соответствующим образом и DOCSDIR. Если каталог указан в PORTDOCS или соответствует шаблону для этой переменной, то полное поддерево с входящими в него файлами и каталогами будет регистрироваться в окончательном списке сборки. Если параметр DOCS не задан, то файлы и каталоги, перечисленные в PORTDOCS, не будут установлены и добавлены в список сборки порта. Установка документации в PORTDOCS, как это показано выше, остаётся за самим портом. Типичный пример использования PORTDOCS выглядит следующим образом:

PORTDOCS=	README.* ChangeLog docs/*

Примечание:

Эквивалентами PORTDOCS для файлов, устанавливаемых в DATADIR и EXAMPLESDIR являются PORTDATA и PORTEXAMPLES соответственно.

Во время установки выводится содержимое pkg-message. За подробной информацией обратитесь к разделу об использовании pkg-message. Файл pkg-message не нужно добавлять в pkg-plist.

5.15.5. Подкаталоги внутри PREFIX

Попробуйте поместить все файлы порта в правильных подкаталогах каталога PREFIX. Некоторые порты игнорируют все установки и помещают все в подкаталог с именем порта, что неправильно. Также многие порты помещают все, кроме бинарных файлов, файлов заголовков и страниц Справочника, в подкаталог каталога lib, что не очень хорошо работает с подходом BSD. Многие файлы должны быть перемещены в одно из следующих местоположений: etc (настроечные/конфигурационные файлы), libexec (выполнимые файлы, запускаемые из других программ), sbin (исполнимые файлы для администраторов/менеджеров системы), info (документация в формате info для просмотрщика info) или share (независимые от архитектуры файлы). Обратитесь к hier(7) для прояснения деталей; правила, покрывающие /usr, достаточно хорошо подходят также и к /usr/local. Исключением являются порты, имеющие дело с <<новостями>> USENET. Они могут использовать каталог PREFIX/news для установки своих файлов.

Этот, и другие документы, могут быть скачаны с http://ftp.FreeBSD.org/pub/FreeBSD/doc/.

По вопросам, связанным с FreeBSD, прочитайте документацию прежде чем писать в <questions@FreeBSD.org>.

По вопросам, связанным с этой документацией, пишите в рассылку <doc@FreeBSD.org>.