Debian package structure/ru: what changed
Revision 2 to 3. Removed lines have a minus sign; added lines have a plus sign.
| Old | New | Line | |
|---|---|---|---|
| 1 | 1 | Установки в Debian выполняются файлами с расширением .deb. В этой статье рассматривается, как создать их вручную. | |
| 2 | 2 | ||
| 3 | 3 | Если вы хотите разместить свою программу в дистрибутивы Debian, см. раздел как создать исходный код для [[Debian upstream]]. | |
| 4 | 4 | ||
| 5 | 5 | ## Основной раздел | |
| 6 | 6 | ||
| 7 | 7 | ### Два типа пакетов | |
| 8 | 8 | ||
| 9 | 9 | Существует два типа пакетов: пакеты исходных кодов и бинарный пакет. В этой статье будет вестись речь о бинарных пакетах. Бинарные пакеты представляют удобный способ консолидации предварительно скомпилированных бинарных файлов, готовых для предоставлению непосредственно конечному пользователю. Однако дистрибутивы наподобии Debian или Ubuntu не смогут принять бинарные пакеты в свои репозитарии, они требуют Debian-пакеты исходных кодов ([[Debian package source|source package]]), которые могут использоваться для сборки бинарных версий в случае необходимости. Пакеты исходных кодов Debian ([[Debian package source|source package]]) несколько сложнее собрать и подчиняется ряду технических и юридических правил, прежде чем могут быть приняты в большинстве дистрибутивов Linux. | |
| 10 | 10 | ||
| 11 | 11 | ### Подготовка пакетов | |
| 12 | 12 | ||
| 13 | 13 | В бинарном пакете Debian файлы установки сжимаются с использованием команды **dpkg-deb**. Вы можете увидеть содержимое сформированных .deb файлов также как и любых других упакованных архивов, нажав правую кнопку мыши на них и открывая их в менеджере архивов (т.е. в обычном архиваторе). | |
| 14 | 14 | ||
| 15 | 15 | Чтобы сделать .deb файл, Вам следует подготовить структуру папок с соответствующими файлами. Это будет называться промежуточной папкой и выражено в этой статье переменной `${STAGING_DIR}`. Вы можете заменить его подходящей папкой или определить эту переменную в скрипте. | |
| 16 | 16 | ||
| 17 | 17 | Вы можете для примера создать эту промежуточную папку как поддиректорию текущей папки. Простейший скрипт будет таким: | |
| 18 | 18 | ||
| 19 | - | ||
| 20 | - | ||
| 19 | + | ```text | |
| 20 | + | STAGING_DIR=./staging | |
| 21 | + | mkdir ${STAGING_DIR} | |
| 22 | + | ``` | |
| 21 | 23 | ||
| 22 | 24 | Однако, если Вы напишите скрипт, то он может запускаться из другой папки. Поэтому вместо этого Вы можете убедиться в том, что эта переменная содержит подпапку относительно скрипта с помощью нижеследующим кодом: | |
| 23 | 25 | ||
| 24 | - | ||
| 25 | - | ||
| 26 | - | ||
| 26 | + | ```text | |
| 27 | + | cd `dirname $0` | |
| 28 | + | STAGING_RELATIVEDIR="./staging" | |
| 29 | + | STAGING_DIR=$(readlink --canonicalize "${STAGING_RELATIVEDIR}") | |
| 30 | + | ``` | |
| 27 | 31 | ||
| 28 | 32 | Также вам может потребоваться удалить существующий промежуточный каталог, чтобы убедиться, что он пуст: | |
| 29 | 33 | ||
| 30 | - | ||
| 31 | - | ||
| 34 | + | ```text | |
| 35 | + | rm -rf "${STAGING_DIR}" | |
| 36 | + | mkdir "${STAGING_DIR}" | |
| 37 | + | ``` | |
| 32 | 38 | ||
| 33 | 39 | Содержимое этой папки раскрывается далее в этой статье | |
| 34 | 40 | ||
| 35 | 41 | ### Промежуточная папка. Завершение | |
| 36 | 42 | ||
| 37 | 43 | Прочитайте раздел *Структура папок*, чтобы добавить необходимые файлы. После чего Вы можете завершить работу с этой папкой. | |
| 38 | 44 | ||
| 39 | 45 | Папки и файлы в этом архиве предполагаются только для чтения (ReadOnly). Чтобы убедиться в этом Вы можете перед вызовом **dpkg-deb** сделать нижеследующее: | |
| 40 | 46 | ||
| 41 | - | ||
| 42 | - | ||
| 43 | - | ||
| 47 | + | ``` pascal | |
| 48 | + | find "${STAGING_DIR}" -type d -exec chmod 0755 {} \; #установить атрибуты папок | |
| 49 | + | find "${STAGING_DIR}" -type f -exec chmod 0644 {} \; #установить атрибуты файлов | |
| 50 | + | find "${STAGING_DIR}/usr/bin" -type f -exec chmod 0755 {} \; #установить атрибуты для исполняемых файлов | |
| 51 | + | ``` | |
| 44 | 52 | ||
| 45 | 53 | Когда у Вас будут собраны все нужные файлы в промежуточной папке, Вы можете определить установочный размер и добавить его в файл **control**: | |
| 46 | 54 | ||
| 47 | - | ||
| 48 | - | ||
| 55 | + | ```text | |
| 56 | + | SIZE_IN_KB="$(du -s ${STAGING_DIR} | awk '{print $1;}')" | |
| 57 | + | echo "Installed-Size: ${SIZE_IN_KB}" >> "${STAGING_DIR}/DEBIAN/control" | |
| 58 | + | ``` | |
| 49 | 59 | ||
| 50 | 60 | ### Создание Deb архива | |
| 51 | 61 | ||
| 52 | 62 | Как только структура папок будет готова Вы можете создать архив с помощью: | |
| 53 | 63 | ||
| 54 | - | ||
| 64 | + | ```text | |
| 65 | + | dpkg-deb --root-owner-group --build "${STAGING_DIR}" "${PACKAGE_NAME}.deb" | |
| 66 | + | ``` | |
| 55 | 67 | ||
| 56 | 68 | Или для более старых версий dpkg-deb: | |
| 57 | 69 | ||
| 58 | - | ||
| 70 | + | ```text | |
| 71 | + | fakeroot dpkg-deb --build "${STAGING_DIR}" "${PACKAGE_NAME}.deb" | |
| 72 | + | ``` | |
| 59 | 73 | ||
| 60 | 74 | `${STAGING_DIR}` это путь к структуре папок для сжатия. `${PACKAGE_NAME}` это имя файла, которое будет использоваться для архива. | |
| 61 | 75 | ||
| 62 | 76 | Как правило Вы создаете архив под обычным пользователем, а не с *root* аккаунта. Но установочные файлы должны принадлежать определенному пользователю. Используя флаг `--root-owner-group` или префикс **fakeroot** Вы сохраните в архиве информацию о принадлежности файлов *root* пользователю. | |
| 63 | 77 | ||
| 64 | 78 | После этого вам, вероятно, больше не понадобится промежуточная папка, поэтому вы можете удалить его: | |
| 65 | 79 | ||
| 66 | - | ||
| 80 | + | ```text | |
| 81 | + | rm -rf "${STAGING_DIR}" | |
| 82 | + | ``` | |
| 67 | 83 | ||
| 68 | 84 | ### Проверка архива | |
| 69 | 85 | ||
| 70 | 86 | После того, как вы создали пакет, вы можете проверить, что он соответствует рекомендациям с помощью команды **lintian**: | |
| 71 | 87 | ||
| 72 | - | ||
| 88 | + | ```text | |
| 89 | + | lintian "${PACKAGE_NAME}.deb" --info | |
| 90 | + | ``` | |
| 73 | 91 | ||
| 74 | 92 | Здесь приведен список возможных проблем: <https://lintian.debian.org/tags.html> | |
| 75 | 93 | ||
| 76 | 94 | В Lazarus Вы по умолчанию получите предупреждения `hardening-no-pie` (и `hardening-no-windnow`). Чтобы избежать такие предупреждений добавьте следующие параметры компилятора в параметры проекта: | |
| 77 | 95 | ||
| 78 | - | ||
| 79 | - | ||
| 80 | - | ||
| 96 | + | ```text | |
| 97 | + | -Cg | |
| 98 | + | -k-pie | |
| 99 | + | -k-znow | |
| 100 | + | ``` | |
| 81 | 101 | ||
| 82 | 102 | ## Структура папок | |
| 83 | 103 | ||
| 84 | 104 | Ниже приведена структура промежуточного каталога, который вам необходимо подготовить. | |
| 85 | 105 | ||
| 86 | - | ||
| 87 | - | ||
| 88 | - | ||
| 89 | - | ||
| 90 | - | ||
| 91 | - | ||
| 92 | - | ||
| 93 | - | ||
| 94 | - | ||
| 95 | - | ||
| 96 | - | ||
| 97 | - | ||
| 98 | - | ||
| 99 | - | ||
| 106 | + | ```text | |
| 107 | + | staging (промежуточный каталог) | |
| 108 | + | ├─ DEBIAN | |
| 109 | + | └─ usr | |
| 110 | + | ├─ bin | |
| 111 | + | └─ share | |
| 112 | + | ├─ project1 #ресурсы для Вашего пакета | |
| 113 | + | ├─ applications #ярлыки | |
| 114 | + | ├─ pixmaps #значок по умолчанию | |
| 115 | + | ├─ icons | |
| 116 | + | │ └─ hicolor #значки различных размеров | |
| 117 | + | ├─ doc | |
| 118 | + | │ └─ project1 #информация о Вашем пакете | |
| 119 | + | └─ man #руководство пользователя | |
| 120 | + | └─ man1 #оглавление | |
| 121 | + | ``` | |
| 100 | 122 | ||
| 101 | 123 | ### Папка DEBIAN | |
| 102 | 124 | ||
| 103 | 125 | Имя этого каталога указано в верхнем регистре. Он должен содержать один файл под названием **control**. Ниже пример пакета под названием **project1** в версии 2.0. | |
| 104 | 126 | ||
| 105 | - | ||
| 106 | - | ||
| 107 | - | ||
| 108 | - | ||
| 109 | - | ||
| 110 | - | ||
| 111 | - | ||
| 112 | - | ||
| 113 | - | ||
| 114 | - | ||
| 127 | + | ```text | |
| 128 | + | Section: graphics | |
| 129 | + | Priority: optional | |
| 130 | + | Maintainer: myname <myname@webserver.com> | |
| 131 | + | Homepage: https://www.project1.com | |
| 132 | + | Package: project1 | |
| 133 | + | Architecture: amd64 | |
| 134 | + | Version: 2.0 | |
| 135 | + | Depends: libatk1.0-0 (>= 1.12.4), libc6 (>= 2.2.5), libcairo2 (>= 1.2.4), libgdk-pixbuf2.0-0 (>= 2.22.0), libglib2.0-0 (>= 2.12.0), libgtk2.0-0 (>= 2.24.0), libpango-1.0-0 (>= 1.18.0), libx11-6 | |
| 136 | + | Description: Это тестовый проект. | |
| 137 | + | Длинное описание бла-бла-бла. | |
| 138 | + | ``` | |
| 115 | 139 | ||
| 116 | 140 | Примеры значений для поля **Section**: comm, database, devel, editors, electronics, fonts, games, graphics, math, web, net, news, science, sound, utils, video. | |
| 117 | 141 | ||
| 118 | 142 | Поле **Architecture** используется для компиляции программы. Чтобы узнать текущую архитектуру, используйте следующую команду: | |
| 119 | 143 | ||
| 120 | - | ||
| 144 | + | ```text | |
| 145 | + | dpkg --print-architecture | |
| 146 | + | ``` | |
| 121 | 147 | ||
| 122 | 148 | Поле **Depends** содержит список используемых Linux библиотек. Вы можете получить этот список с помощью следующих команд, выполняемых в папке вашего бинарного файла: | |
| 123 | 149 | ||
| 124 | - | ||
| 125 | - | ||
| 126 | - | ||
| 150 | + | ```text | |
| 151 | + | mkdir debian #требуется папка debian | |
| 152 | + | touch debian/control #с одним файлом control в нем | |
| 153 | + | dpkg-shlibdeps -O project1 #предполагается, что ваш бинарный файл называется project1 | |
| 154 | + | ``` | |
| 127 | 155 | ||
| 128 | 156 | Затем вы можете удалить почти пустую папку *debian*, если вы ее не используете. | |
| 129 | 157 | ||
| 130 | 158 | Все это выведет зависимости (после знака равенства): | |
| 131 | 159 | ||
| 132 | - | ||
| 160 | + | ```text | |
| 161 | + | shlibs:Depends=libatk1.0-0 (>= 1.12.4), libc6 (>= 2.2.5), libcairo2 (>= 1.2.4), libgdk-pixbuf2.0-0 (>= 2.22.0), libglib2.0-0 (>= 2.12.0), libgtk2.0-0 (>= 2.24.0), libpango-1.0-0 (>= 1.18.0), libx11-6 | |
| 162 | + | ``` | |
| 133 | 163 | ||
| 134 | 164 | Для полноты следует отметить, что все эти пакеты не являются абсолютно необходимыми, поскольку несколько пакетов в этом списке уже могут быть частью зависимостей - и, следовательно, частью установки - другого пакета, указанного в этом же списке (см. [1](https://wiki.freepascal.org/Deploying_Your_Application#Tip%3A) для перекрестной проверки и устранения лишних зависимостей). | |
| 135 | 165 | ||
| 136 | 166 | ### Папка usr/bin | |
| 137 | 167 | ||
| 138 | 168 | Эта папка содержит бинарный файл и только его (*для информации: избегайте символа подчеркивания в имени Вашего проекта - для примера, dpkg-deb избегает этого - потому что имя пакета должно удовлетворять регулярному выражению: \${PackageName}_\${Version}_\${Arch}.deb, e.g. dpkg-dev_1.19.0.5ubuntu2_all.deb*). Все ресурсные файлы должны быть помещены в *usr/share/project1*. Для доступа к ресурсам Ваша программа может использовать относительный путь наподобии *../share/project1*. | |
| 139 | 169 | ||
| 140 | 170 | Папка *usr/local/bin* недопустима в пакете [2](https://lintian.debian.org/tags/file-in-usr-local.html) потому что *local* используется проектами, компилируемыми локально и установленные с помощью их Makefile. | |
| 141 | 171 | ||
| 142 | 172 | ### Папка ресурсов | |
| 143 | 173 | ||
| 144 | 174 | Она будет называться *usr/share/project1*, если имя пакета "project1".\ | |
| 145 | 175 | Вы можете разместить там все файлы данных, нужные Вашей программе. Обращаем внимание, что они будут "только для чтения". | |
| 146 | 176 | ||
| 147 | 177 | ### Папка конфигурации | |
| 148 | 178 | ||
| 149 | 179 | Существуют разные места для размещения [[Multiplatform Programming Guide/ru|конфигурационных файлов]]. Конфигурационные файлы (или файлы настроек) должны быть изначально созданы самим приложением (значениями по умолчанию), если их не существует в момент старта приложения. | |
| 150 | 180 | ||
| 151 | 181 | ### Папка usr/share/applications | |
| 152 | 182 | ||
| 153 | 183 | Чтобы добавить Ваше приложение в меню Linux, Вы должны добавить файл **project1.desktop**, содержащий: | |
| 154 | 184 | ||
| 155 | - | ||
| 156 | - | ||
| 157 | - | ||
| 158 | - | ||
| 159 | - | ||
| 160 | - | ||
| 161 | - | ||
| 162 | - | ||
| 163 | - | ||
| 164 | - | ||
| 185 | + | ``` pascal | |
| 186 | + | [Desktop Entry] | |
| 187 | + | Name=Project1 | |
| 188 | + | Comment=Cool project | |
| 189 | + | Icon=project1 | |
| 190 | + | Exec=project1 | |
| 191 | + | Terminal=false | |
| 192 | + | Type=Application | |
| 193 | + | Categories=Graphics | |
| 194 | + | GenericName=Project1 | |
| 195 | + | Keywords=feature1; feature2; feature3 | |
| 196 | + | ``` | |
| 165 | 197 | ||
| 166 | 198 | Этот файл напоминает "ярлык" для Вашей программы. | |
| 167 | 199 | ||
| 168 | 200 | Поле **Categories** как такое же в файле **control**. Это может быть для примера: Communication, Database, Development, Editors, Electronics, Fonts, Games, Graphics, Math, Internet, Networking, News, Science, Sound, Utility, Video. | |
| 169 | 201 | ||
| 170 | 202 | Поле keywords помогает в поиске в приложениях. | |
| 171 | 203 | ||
| 172 | 204 | Обратите внимание, что вам необходимо предоставить значок в виде файла PNG либо в каталоге *usr/share/pixmaps* либо в *usr/share/icons/hicolor*. | |
| 173 | 205 | ||
| 174 | 206 | #### Папка usr/share/pixmaps | |
| 175 | 207 | ||
| 176 | 208 | Будет содержать значок одного размера для ярлыка вашего меню в формате PNG под названием **project1.png**. Среднего размера, такого как 48x48, будет вполне достаточно. | |
| 177 | 209 | ||
| 178 | 210 | #### Папка usr/share/icons/hicolor | |
| 179 | 211 | ||
| 180 | 212 | Будет содержать значок нескольких размеров. Вот структура каталогов: | |
| 181 | 213 | ||
| 182 | - | ||
| 183 | - | ||
| 184 | - | ||
| 185 | - | ||
| 186 | - | ||
| 187 | - | ||
| 188 | - | ||
| 214 | + | ```text | |
| 215 | + | icons | |
| 216 | + | └─ hicolor | |
| 217 | + | ├─ 8x8 | |
| 218 | + | │ └─ apps | |
| 219 | + | ├─ 16x16 | |
| 220 | + | │ └─ apps | |
| 221 | + | ... | |
| 222 | + | ``` | |
| 189 | 223 | ||
| 190 | 224 | Существует подкаталог для каждого возможного размера. Вы можете отобразить все размеры, определенные в настоящее время в вашей системе, написав: | |
| 191 | 225 | ||
| 192 | - | ||
| 226 | + | ```text | |
| 227 | + | ls /usr/share/icons/hicolor | |
| 228 | + | ``` | |
| 193 | 229 | ||
| 194 | 230 | В каждую папку приложений поместите изображение со всегда одним и тем же именем. Если ваш проект называется project1, то для большинства папок он будет называться "project1.png". В масштабируемые и символические папки вы можете поместить SVG-файл. | |
| 195 | 231 | ||
| 196 | 232 | ### Папка документации | |
| 197 | 233 | ||
| 198 | 234 | Она будет называться *usr/share/doc/project1*, если имя пакета будет "project1". | |
| 199 | 235 | ||
| 200 | 236 | Папка содержит файлы **changelog.Debian.gz** и **copyright** и (необязательно) файл **README**. | |
| 201 | 237 | ||
| 202 | 238 | #### Файл журнала изменений | |
| 203 | 239 | ||
| 204 | 240 | Минимальный файл журнала изменений (changelog): | |
| 205 | 241 | ||
| 206 | - | ||
| 242 | + | ```text | |
| 243 | + | project1 (1.0) unstable; urgency=low | |
| 207 | 244 | ||
| 208 | - | ||
| 245 | + | * Первый релиз | |
| 209 | 246 | ||
| 210 | - | ||
| 247 | + | -- myname <myname@webserver.com> Tue, 19 May 2020 11:06:00 +0100 | |
| 248 | + | ``` | |
| 211 | 249 | ||
| 212 | 250 | Вы можете добавить множество строк, начинающихся с *, чтобы указать список изменений в версии. Пробелы в начале строки необходимы. Только строка, указывающая версию, начинается непосредственно в начале строки. | |
| 213 | 251 | ||
| 214 | 252 | Последняя версия должна быть в верхней части файла. | |
| 215 | 253 | ||
| 216 | 254 | Список изменений должен быть сжат с максимальной степенью. Для этого, предполагая что у вас уже есть несжатый файл **changelog**, сожмите его с помощью следующей команды: | |
| 217 | 255 | ||
| 218 | - | ||
| 256 | + | ```text | |
| 257 | + | gzip -9 -n usr/share/doc/project1/changelog.Debian | |
| 258 | + | ``` | |
| 219 | 259 | ||
| 220 | 260 | Флаги -9 -n необходимы, чтобы пакета соответствовал инструкциям. | |
| 221 | 261 | ||
| 222 | 262 | #### Файл copyright | |
| 223 | 263 | ||
| 224 | 264 | Если вы предоставляете пакет Deb самостоятельно, необязательно использовать машиночитаемый формат, однако это подготовит вас к публикации пакета в дистрибутивах Debian. См.: [[Debian package source|copyright in Debian package structure]]. | |
| 225 | 265 | ||
| 226 | 266 | ### Папка usr/share/man | |
| 227 | 267 | ||
| 228 | 268 | Содержит руководство пользователя, которое вы можете просмотреть с помощью команды **man**. Он должен содержать по крайней мере **project1.1.gz** в подкаталоге *man1*, который будет индексной страницей вашего руководства. | |
| 229 | 269 | ||
| 230 | 270 | Синтаксис немного своеобразен. Есть некоторые инструменты, которые могут помочь, но вам все равно нужно знать синтаксис. | |
| 231 | 271 | ||
| 232 | 272 | - описание синтаксиса: <https://liw.fi/manpages/> | |
| 233 | 273 | - редактор с мастером и режимом предварительного просмотра WYSIWYG: **gmanedit** | |
| 234 | 274 | - онлайн редактор с предварительным просмотром (переключитесь в режим AN): <https://roperzh.github.io/grapse/> | |
| 235 | 275 | ||
| 236 | 276 | Вот пример файла: | |
| 237 | 277 | ||
| 238 | - | ||
| 239 | - | ||
| 240 | - | ||
| 241 | - | ||
| 242 | - | ||
| 243 | - | ||
| 244 | - | ||
| 245 | - | ||
| 246 | - | ||
| 247 | - | ||
| 278 | + | ``` pascal | |
| 279 | + | .TH Project1 1 "19 May 2020" "" Project1 | |
| 280 | + | .SH NAME | |
| 281 | + | Project1 - My cool project | |
| 282 | + | .SH SYNOPSIS | |
| 283 | + | .B project1 | |
| 284 | + | [PARAMETER] | |
| 285 | + | .SH DESCRIPTION | |
| 286 | + | What my program does. | |
| 287 | + | .PP | |
| 288 | + | More description. | |
| 289 | + | ``` | |
| 248 | 290 | ||
| 249 | 291 | Это руководство как и файл журнала изменений, должен быть сжат командой: | |
| 250 | 292 | ||
| 251 | - | ||
| 293 | + | ```text | |
| 294 | + | gzip -9 -n usr/share/man/man1/project1.1 | |
| 295 | + | ``` | |
| 252 | 296 | ||
| 253 | 297 | Флаги -9 -n необходимы, чтобы пакет соответствовал инструкциям. | |
| 254 | 298 | ||
| 255 | 299 | --- | |
| 256 | 300 | *From the Free Pascal wiki, page "Debian package structure/ru", as it stood on 2022-01-02 after a change by FTurtle, out of the wiki's dump of 2024-05-26. Copyright stays with the author who wrote it, according to the old wiki's [[Licensing]] page. If you have concerns about this material, [message the admin](/wiki-contact).* |
