mirror of
https://github.com/arcan1s/arcanis.me.git
synced 2025-07-16 06:19:55 +00:00
more pretty md files
This commit is contained in:
@ -7,7 +7,11 @@ tags: zshrc, настройка, linux
|
||||
title: О zshrc
|
||||
short: about-zshrc
|
||||
---
|
||||
Это моя первая статья в блоге (я думаю, мне нужно что-нибудь для тестов =)). Существует множество похожих статей и, я думаю, не буду отличаться от большинства. Я просто хочу показать мой `.zshrc` и объяснить, что в нем есть и зачем оно нужно. Также, любые комментарии или дополнения приветствуются. [Оригинал](//archlinux.org.ru/forum/topic/12752/ "Тема на форуме") статьи.
|
||||
Это моя первая статья в блоге (я думаю, мне нужно что-нибудь для тестов =)).
|
||||
Существует множество похожих статей и, я думаю, не буду отличаться от большинства.
|
||||
Я просто хочу показать мой `.zshrc` и объяснить, что в нем есть и зачем оно нужно.
|
||||
Также, любые комментарии или дополнения приветствуются. [Оригинал]
|
||||
(//archlinux.org.ru/forum/topic/12752/ "Тема на форуме") статьи.
|
||||
|
||||
<!--more-->
|
||||
|
||||
@ -19,13 +23,17 @@ short: about-zshrc
|
||||
pacman -Sy pkgfile zsh zsh-completions zsh-syntax-highlighting
|
||||
```
|
||||
|
||||
[pkgfile](//www.archlinux.org/packages/pkgfile/ "Пакет Archlinux") очень полезная утилита. Данная команда также установит шелл, дополнения к нему и подсветку синтаксиса.
|
||||
[pkgfile](//www.archlinux.org/packages/pkgfile/ "Пакет Archlinux") очень полезная
|
||||
утилита. Данная команда также установит шелл, дополнения к нему и подсветку
|
||||
синтаксиса.
|
||||
|
||||
## <a href="#configuration" class="anchor" id="configuration"><span class="octicon octicon-link"></span></a>Настройка шелла
|
||||
|
||||
Все доступные опции приведены [здесь](//zsh.sourceforge.net/Doc/Release/Options.html "Документация zsh").
|
||||
Все доступные опции приведены [здесь](//zsh.sourceforge.net/Doc/Release/Options.html
|
||||
"Документация zsh").
|
||||
|
||||
Указываем файл с историей, число команд хранящихся в кэше текущего сеанса и число команд, хранящихся в файле:
|
||||
Указываем файл с историей, число команд хранящихся в кэше текущего сеанса и
|
||||
число команд, хранящихся в файле:
|
||||
|
||||
```bash
|
||||
# history
|
||||
@ -34,7 +42,8 @@ HISTSIZE=500000
|
||||
SAVEHIST=500000
|
||||
```
|
||||
|
||||
Я не могу запомнить все комбинации `Ctrl+`, поэтому я назначаю клавиши на их стандартное использование:
|
||||
Я не могу запомнить все комбинации `Ctrl+`, поэтому я назначаю клавиши на их
|
||||
стандартное использование:
|
||||
|
||||
```bash
|
||||
# bindkeys
|
||||
@ -48,7 +57,9 @@ bindkey '\e[5~' up-line-or-history # page-up
|
||||
bindkey '\e[6~' down-line-or-history # page-down
|
||||
```
|
||||
|
||||
Но здесь важно, что стрелки `вверх`/`вниз` служат для навигации по истории с учетом **уже введенной части** команды. А `PgUp`/`PgDown` **проигнорируют** уже введенную часть команды.
|
||||
Но здесь важно, что стрелки `вверх`/`вниз` служат для навигации по истории с
|
||||
учетом **уже введенной части** команды. А `PgUp`/`PgDown` **проигнорируют** уже
|
||||
введенную часть команды.
|
||||
|
||||
Автодополнение команд:
|
||||
|
||||
@ -60,7 +71,9 @@ zstyle ':completion:*' insert-tab false
|
||||
zstyle ':completion:*' max-errors 2
|
||||
```
|
||||
|
||||
Подключается полное автодополнение команд. `insert-tab false` включит автодополнение для **невведенной** команды (не знаю, зачем). `max-errors` устанавливает максимальное число опечаток, которые могут быть исправлены.
|
||||
Подключается полное автодополнение команд. `insert-tab false` включит
|
||||
автодополнение для **невведенной** команды (не знаю, зачем). `max-errors`
|
||||
устанавливает максимальное число опечаток, которые могут быть исправлены.
|
||||
|
||||
Приглашение:
|
||||
|
||||
@ -192,7 +205,10 @@ ZSH_HIGHLIGHT_STYLES[double-quoted-argument]='fg=yellow' # конс
|
||||
#ZSH_HIGHLIGHT_STYLES[root]='bg=red'
|
||||
```
|
||||
|
||||
В первой строке включаем подсветку. Затем включаем основную подсветку, а также подсветку скобок и шаблонов. Шаблоны указываются ниже (`rm -rf *` в примере). Также может быть включена подсветка команд от `root` и курсора `cursor`. Синтаксис настроек понятен, `fg` цвет шрифта, `bg` цвет фона.
|
||||
В первой строке включаем подсветку. Затем включаем основную подсветку, а также
|
||||
подсветку скобок и шаблонов. Шаблоны указываются ниже (`rm -rf *` в примере).
|
||||
Также может быть включена подсветка команд от `root` и курсора `cursor`.
|
||||
Синтаксис настроек понятен, `fg` цвет шрифта, `bg` цвет фона.
|
||||
|
||||
## <a href="#prompt" class="anchor" id="prompt"><span class="octicon octicon-link"></span></a>$PROMPT и $RPROMPT
|
||||
|
||||
@ -219,7 +235,9 @@ else
|
||||
fi
|
||||
```
|
||||
|
||||
`fg` цвет шрифта, `bg` цвет фона. `_bold` и `_no_bold` регулируют оттенок. Команды должны быть обрамлены в `%{ ... %}`, чтобы не показывались. Доступные цвета:
|
||||
`fg` цвет шрифта, `bg` цвет фона. `_bold` и `_no_bold` регулируют оттенок.
|
||||
Команды должны быть обрамлены в `%{ ... %}`, чтобы не показывались. Доступные
|
||||
цвета:
|
||||
|
||||
```bash
|
||||
black
|
||||
@ -276,11 +294,15 @@ $returncode\
|
||||
"%{$fg_bold[white]%}]%{$reset_color%}"
|
||||
```
|
||||
|
||||
Мой RPROMPT показывает текущее время, заряд батареи и код возврата последнего приложения. `precmd()` необходимо для автоматического обновления. Конструкция `$(if.true.false)` является условным оператором в `zsh`.
|
||||
Мой RPROMPT показывает текущее время, заряд батареи и код возврата последнего
|
||||
приложения. `precmd()` необходимо для автоматического обновления. Конструкция
|
||||
`$(if.true.false)` является условным оператором в `zsh`.
|
||||
|
||||
## <a href="#aliases" class="anchor" id="aliases"><span class="octicon octicon-link"></span></a>Аллиасы
|
||||
|
||||
**Копируйте только те аллиасы, которые Вам необходимы.** Если какой-либо аллиас использует приложение, которое не установлено, это приведет к сбою загрузки конфигурационного файла.
|
||||
**Копируйте только те аллиасы, которые Вам необходимы.** Если какой-либо аллиас
|
||||
использует приложение, которое не установлено, это приведет к сбою загрузки
|
||||
конфигурационного файла.
|
||||
|
||||
Полезная (или не очень) функция:
|
||||
|
||||
@ -360,7 +382,8 @@ else
|
||||
fi
|
||||
```
|
||||
|
||||
Некоторые глобальные аллиасы. Если они включены, команда `cat foo g bar` будет эквивалентна `cat foo | grep bar`:
|
||||
Некоторые глобальные аллиасы. Если они включены, команда `cat foo g bar` будет
|
||||
эквивалентна `cat foo | grep bar`:
|
||||
|
||||
```bash
|
||||
# global alias
|
||||
@ -398,7 +421,8 @@ projctl () {
|
||||
}
|
||||
```
|
||||
|
||||
К сожалению, я не могу запомнить флаги `tar`, поэтому я использую специальные функции:
|
||||
К сожалению, я не могу запомнить флаги `tar`, поэтому я использую специальные
|
||||
функции:
|
||||
|
||||
```bash
|
||||
# function to extract archives
|
||||
@ -471,7 +495,9 @@ su () {
|
||||
}
|
||||
```
|
||||
|
||||
Функция, которая заменяет оригиналькую команду `rm`. Если Вы наберете `rm`, это будет эквивалентно перемещению в корзину, также, Вы можете легко восстановить удаленный файл:
|
||||
Функция, которая заменяет оригиналькую команду `rm`. Если Вы наберете `rm`, это
|
||||
будет эквивалентно перемещению в корзину, также, Вы можете легко восстановить
|
||||
удаленный файл:
|
||||
|
||||
```bash
|
||||
rm () {
|
||||
|
||||
@ -7,17 +7,29 @@ tags: archlinux, linux, сборка, qutim
|
||||
title: Сборка Qutim с Qt5
|
||||
short: building-qutim-using-qt5
|
||||
---
|
||||
Если кто-то не знает, [Qutim](//qutim.org "Домашняя страница Qutim") - мультипротокольный кросс-платформенный месседжер. Написан он на `CPP` с использованием библиотек Qt. Проект активно развивается. В этой статье речь пойдет о реализации сборки данного пакета в Archlinux с использованием библиотек Qt5 (а не Qt4, как это делают текущие пакеты в AUR).
|
||||
Если кто-то не знает, [Qutim](//qutim.org "Домашняя страница Qutim") -
|
||||
мультипротокольный кросс-платформенный месседжер. Написан он на `CPP` с
|
||||
использованием библиотек Qt. Проект активно развивается. В этой статье речь
|
||||
пойдет о реализации сборки данного пакета в Archlinux с использованием библиотек
|
||||
Qt5 (а не Qt4, как это делают текущие пакеты в AUR).
|
||||
|
||||
<!--more-->
|
||||
|
||||
## <a href="#problems" class="anchor" id="problems"><span class="octicon octicon-link"></span></a>Что не так?
|
||||
|
||||
Да все так. Просто пакет использует для сборки систему [qbs](//qt-project.org/wiki/qbs "Wiki"), которая, на мой взгляд, немного странная. Пакет, необходимый для сборки, [находится в AUR](//aur.archlinux.org/packages/qbs-git/ "AUR") (рекомендую git-версию). Когда я спросил у Andrea Scarpino (который сопровождает все KDE и Qt пакеты в официальные репозитории) по поводу переноса этого пакета в репозитории, он ответил, что всему свое время. В принципе, я с ним согласен, так как проект, судя по всему, еще немного сыроват.
|
||||
Да все так. Просто пакет использует для сборки систему [qbs]
|
||||
(//qt-project.org/wiki/qbs "Wiki"), которая, на мой взгляд, немного странная.
|
||||
Пакет, необходимый для сборки, [находится в AUR]
|
||||
(//aur.archlinux.org/packages/qbs-git/ "AUR") (рекомендую git-версию). Когда я
|
||||
спросил у Andrea Scarpino (который сопровождает все KDE и Qt пакеты в
|
||||
официальные репозитории) по поводу переноса этого пакета в репозитории, он
|
||||
ответил, что всему свое время. В принципе, я с ним согласен, так как проект,
|
||||
судя по всему, еще немного сыроват.
|
||||
|
||||
## <a href="#prepare" class="anchor" id="prepare"><span class="octicon octicon-link"></span></a>Подготовка
|
||||
|
||||
Установим зависимости. Что-то может быть пропустил, зависимости сканировал с использованием `namcap`:
|
||||
Установим зависимости. Что-то может быть пропустил, зависимости сканировал с
|
||||
использованием `namcap`:
|
||||
|
||||
```bash
|
||||
pacman -Sy --asdeps clang git libc++abi qt5-quick1 qt5-x11extras
|
||||
@ -26,21 +38,28 @@ yaourt -S --asdeps jreen-git qbs-git
|
||||
|
||||
### <a href="#qbs" class="anchor" id="qbs"><span class="octicon octicon-link"></span></a>Настройка qbs
|
||||
|
||||
Желающие могут почитать документацию [по ссылке](//qt-project.org/wiki/qbs "Wiki") или посмотреть примеры (включены в пакет). Загвоздка в том, что эта штука использует файл настроек, который, во-первых, нужно сначала сгенерировать, во-вторых, хранится в домашней директории (и только там). В теории, генерация файла настроек (`~/.config/QtProject/qbs.conf`) происходит следующим образом:
|
||||
Желающие могут почитать документацию [по ссылке](//qt-project.org/wiki/qbs "Wiki")
|
||||
или посмотреть примеры (включены в пакет). Загвоздка в том, что эта штука
|
||||
использует файл настроек, который, во-первых, нужно сначала сгенерировать,
|
||||
во-вторых, хранится в домашней директории (и только там). В теории, генерация
|
||||
файла настроек (`~/.config/QtProject/qbs.conf`) происходит следующим образом:
|
||||
|
||||
```bash
|
||||
qbs-setup-qt --detect
|
||||
qbs-detect-toolchains
|
||||
```
|
||||
|
||||
Сначала находим Qt для сборки, потом находим инструментарий (компиляторы, например). Дальше вставляем инструментарий (например, нам для Qutim нужен `clang`) в Qt, например, так:
|
||||
Сначала находим Qt для сборки, потом находим инструментарий (компиляторы,
|
||||
например). Дальше вставляем инструментарий (например, нам для Qutim нужен
|
||||
`clang`) в Qt, например, так:
|
||||
|
||||
```bash
|
||||
sed 's/clang\\/qt-5-2-0\\/g' -i ~/.config/QtProject/qbs.conf
|
||||
```
|
||||
|
||||
Альтернативные варианты - править файл вручную или воспользоваться `qbs-config-ui` или `qbs-config` на Ваш выбор.
|
||||
Так или иначе, нужный файл мы сгенерировали, сохраним его в будущей директории сборки:
|
||||
Альтернативные варианты - править файл вручную или воспользоваться `qbs-config-ui`
|
||||
или `qbs-config` на Ваш выбор. Так или иначе, нужный файл мы сгенерировали,
|
||||
сохраним его в будущей директории сборки:
|
||||
|
||||
```ini
|
||||
[General]
|
||||
@ -142,7 +161,10 @@ cd qutim
|
||||
HOME=$(pwd) qbs -j $(nproc) -d ../build release profile:qutim
|
||||
```
|
||||
|
||||
Я пытался сделать универсальный способ сборки пакета, поэтому такое странное переназначение домашней директории. Флаг `-j` указывает число потоков сборки, флаг `-d` директорию сборки, `release` тип сборки (debug, release), `profile` используемый профиль, описанный в файле настроек.
|
||||
Я пытался сделать универсальный способ сборки пакета, поэтому такое странное
|
||||
переназначение домашней директории. Флаг `-j` указывает число потоков сборки,
|
||||
флаг `-d` директорию сборки, `release` тип сборки (debug, release), `profile`
|
||||
используемый профиль, описанный в файле настроек.
|
||||
|
||||
## <a href="#install" class="anchor" id="install"><span class="octicon octicon-link"></span></a>Установка
|
||||
|
||||
@ -150,7 +172,8 @@ HOME=$(pwd) qbs -j $(nproc) -d ../build release profile:qutim
|
||||
HOME=$(pwd) sudo qbs install -d ../build --install-root "/usr" profile:qutim
|
||||
```
|
||||
|
||||
Из нового - указание корневого каталога (`--install-root`). Без этого пакет будет установлен в `/` (`/bin` и `/lib`).
|
||||
Из нового - указание корневого каталога (`--install-root`). Без этого пакет будет
|
||||
установлен в `/` (`/bin` и `/lib`).
|
||||
|
||||
## <a href="#pkgbuild" class="anchor" id="pkgbuild"><span class="octicon octicon-link"></span></a>PKGBUILD
|
||||
|
||||
|
||||
@ -13,7 +13,13 @@ short: site-changes
|
||||
|
||||
## <a href="#list" class="anchor" id="list"><span class="octicon octicon-link"></span></a>Cписок изменений:
|
||||
|
||||
* Арендовал домен `arcanis.me`. Теперь, как и все белые люди, имею нормальный адрес. Небольшое описание (мне, как человеку далекому от интернет-технологий, пришлось немного попариться на эту тему). Арендуем домен, подключаем услугу редактирования DNS (для Ru-center [DNS-master](//www.nic.ru/dns/service/dns_hosting/ "Сервис")) - суммарно мне обошлось около 1100 рублей/год. Кладем в наш репозиторий с сайтом файл CNAME, содержащий имя желаемого домена. Идем и добавляем две записи в DNS для нашего домена:
|
||||
* Арендовал домен `arcanis.me`. Теперь, как и все белые люди, имею нормальный
|
||||
адрес. Небольшое описание (мне, как человеку далекому от интернет-технологий,
|
||||
пришлось немного попариться на эту тему). Арендуем домен, подключаем услугу
|
||||
редактирования DNS (для Ru-center [DNS-master]
|
||||
(//www.nic.ru/dns/service/dns_hosting/ "Сервис")) - суммарно мне обошлось около
|
||||
1100 рублей/год. Кладем в наш репозиторий с сайтом файл CNAME, содержащий имя
|
||||
желаемого домена. Идем и добавляем две записи в DNS для нашего домена:
|
||||
|
||||
```bash
|
||||
@ A 192.30.252.153
|
||||
@ -22,7 +28,8 @@ short: site-changes
|
||||
www CNAME @
|
||||
```
|
||||
|
||||
(`@` значит наш корневой домен.) Ждем пару часов. Результат можно узнать примерно так:
|
||||
(`@` значит наш корневой домен.) Ждем пару часов. Результат можно узнать
|
||||
примерно так:
|
||||
|
||||
```bash
|
||||
$ dig domain.name +nostats +nocomments +nocmd
|
||||
@ -34,8 +41,11 @@ short: site-changes
|
||||
...
|
||||
```
|
||||
|
||||
* На радостях создал [собственный репозиторий](ftp://repo.arcanis.me/repo "Репозиторий"), в котором будут лежать некоторые пакеты из AUR, которые я использую. Планируется поддержка обеих архитектур.
|
||||
* Поскольку репозиторий требует ftp, то перевел samba на ftp. Проблему доступа решил опциями монтирования:
|
||||
* На радостях создал [собственный репозиторий](ftp://repo.arcanis.me/repo
|
||||
"Репозиторий"), в котором будут лежать некоторые пакеты из AUR, которые я
|
||||
использую. Планируется поддержка обеих архитектур.
|
||||
* Поскольку репозиторий требует ftp, то перевел samba на ftp. Проблему доступа
|
||||
решил опциями монтирования:
|
||||
|
||||
```bash
|
||||
# только чтение
|
||||
@ -45,7 +55,9 @@ short: site-changes
|
||||
/home/arcanis/share.fs /srv/ftp/share ext4 defaults,rw 0 0
|
||||
```
|
||||
|
||||
Для отсутствия доступа извне к директории с музыкой, используется логин под специальным пользователем и ограничение `anon_world_readable_only=YES`. Также привожу свой файл настроек `/etc/vsftpd.conf`:
|
||||
Для отсутствия доступа извне к директории с музыкой, используется логин под
|
||||
специальным пользователем и ограничение `anon_world_readable_only=YES`.
|
||||
Также привожу свой файл настроек `/etc/vsftpd.conf`:
|
||||
|
||||
```bash
|
||||
anonymous_enable=YES
|
||||
@ -68,10 +80,13 @@ short: site-changes
|
||||
listen=YES
|
||||
```
|
||||
|
||||
Теперь добавим переадресацию с `repo.arcanis.me` на нужный IP адрес. Для этого внесем следующие записи в DNS:
|
||||
Теперь добавим переадресацию с `repo.arcanis.me` на нужный IP адрес. Для э
|
||||
того внесем следующие записи в DNS:
|
||||
|
||||
```bash
|
||||
repo A 89.249.170.38
|
||||
```
|
||||
|
||||
* В ближайшее время (как дойду до магазина с деньгами) планируется приобретение небольшого сервера для работы на постоянной основе (компиляция пакетов, репозиторий, файлообмен, бэкапы).
|
||||
* В ближайшее время (как дойду до магазина с деньгами) планируется приобретение
|
||||
небольшого сервера для работы на постоянной основе (компиляция пакетов, репозиторий,
|
||||
файлообмен, бэкапы).
|
||||
|
||||
@ -13,13 +13,19 @@ short: creating-custom-repo
|
||||
|
||||
## <a href="#prepare" class="anchor" id="prepare"><span class="octicon octicon-link"></span></a>Подготовка
|
||||
|
||||
Для начала находим сервер и желание с ним заниматься сексом. Для простоты, лучше, чтобы там стоял Archlinux, хотя, это и не совсем обязательно (можно создать отдельный корень под Arch). Из пакетов, пожалуй, нам понадобится только два, `devtools` и сам `pacman`:
|
||||
Для начала находим сервер и желание с ним заниматься сексом. Для простоты, лучше,
|
||||
чтобы там стоял Archlinux, хотя, это и не совсем обязательно (можно создать
|
||||
отдельный корень под Arch). Из пакетов, пожалуй, нам понадобится только два,
|
||||
`devtools` и сам `pacman`:
|
||||
|
||||
```bash
|
||||
pacman -Sy devtools
|
||||
```
|
||||
|
||||
[devtools](//www.archlinux.org/packages/devtools/ "Пакет Archlinux") - набор скриптов, предназначенный для автоматизации сборки пакетов в чистом чруте. Думаю, большинство мейнтейнеров Arch'а пользуются им.
|
||||
[devtools](//www.archlinux.org/packages/devtools/ "Пакет Archlinux") - набор
|
||||
скриптов, предназначенный для автоматизации сборки пакетов в чистом чруте. Думаю,
|
||||
большинство мейнтейнеров Arch'а пользуются им.
|
||||
|
||||
Создадим рабочие директории и установим цвета:
|
||||
|
||||
```bash
|
||||
@ -58,11 +64,16 @@ if [ ! -d "${STAGINGDIR}" ]; then
|
||||
fi
|
||||
```
|
||||
|
||||
Директории `${REPODIR}/{i686,x86_64}` для самого репозитория, `${PREPAREDIR}` - директория, где будут лежать собранные пакеты, `${STAGINGDIR}` - директория, откуда будут собираться пакеты.
|
||||
Директории `${REPODIR}/{i686,x86_64}` для самого репозитория, `${PREPAREDIR}` -
|
||||
директория, где будут лежать собранные пакеты, `${STAGINGDIR}` - директория,
|
||||
откуда будут собираться пакеты.
|
||||
|
||||
## <a href="#theory" class="anchor" id="theory"><span class="octicon octicon-link"></span></a>Немного теории
|
||||
|
||||
Создаем директорию, расшариваем ее (например, по [ftp](/ru/2014/03/06/site-changes/ "Статья про изменения сайта")). В ней две субдиректории - `i686` и `x86_64`, для каждого типа архитектур соответственно. И наполняем их набором пакетов по Вашему усмотрению.
|
||||
Создаем директорию, расшариваем ее (например, по [ftp](/ru/2014/03/06/site-changes/
|
||||
"Статья про изменения сайта")). В ней две субдиректории - `i686` и `x86_64`, для
|
||||
каждого типа архитектур соответственно. И наполняем их набором пакетов по Вашему
|
||||
усмотрению.
|
||||
|
||||
Процесс обновления репозитория можно разбить на следующие части:
|
||||
|
||||
@ -150,7 +161,8 @@ if [ ${USEGPG} == "yes" ]; then
|
||||
fi
|
||||
```
|
||||
|
||||
Для удобства рекомендую настроить [gpg-agent](//wiki.archlinux.org/index.php/GPG#gpg-agent "ArchWiki").
|
||||
Для удобства рекомендую настроить [gpg-agent]
|
||||
(//wiki.archlinux.org/index.php/GPG#gpg-agent "ArchWiki").
|
||||
|
||||
### <a href="#list" class="anchor" id="list"><span class="octicon octicon-link"></span></a>Создание списка пакетов
|
||||
|
||||
@ -224,7 +236,8 @@ cd "${STAGINGDIR}"
|
||||
|
||||
### <a href="#symlinks" class="anchor" id="symlinks"><span class="octicon octicon-link"></span></a>Создание симлинков
|
||||
|
||||
Вы можете захотеть создать директорию, которая будет содержать симлинки на актуальные версии пакетов с именами, не содержащими версии:
|
||||
Вы можете захотеть создать директорию, которая будет содержать симлинки на
|
||||
актуальные версии пакетов с именами, не содержащими версии:
|
||||
|
||||
```bash
|
||||
# создание симлинков
|
||||
@ -249,7 +262,9 @@ fi
|
||||
|
||||
### <a href="#file" class="anchor" id="file"><span class="octicon octicon-link"></span></a>Файл
|
||||
|
||||
[Скрипты](//github.com/arcan1s/repo-scripts "GitHub") целиком. Скачиваем исходники для пакетов, запускаем скрипт (при необходимости, редактируем переменные) и радуемся жизни.
|
||||
[Скрипты](//github.com/arcan1s/repo-scripts "GitHub") целиком. Скачиваем и
|
||||
сходники для пакетов, запускаем скрипт (при необходимости, редактируем переменные)
|
||||
и радуемся жизни.
|
||||
|
||||
## <a href="#using" class="anchor" id="using"><span class="octicon octicon-link"></span></a>Использование репозитория
|
||||
|
||||
|
||||
@ -7,28 +7,94 @@ tags: настройка, linux, archlinux
|
||||
title: Приложения, которые я использую
|
||||
short: my-desktop
|
||||
---
|
||||
Небольшая статья, посвященная набору приложений и расширений, которые я использую в повседневной жизни на моем домашнем компьютере.
|
||||
Небольшая статья, посвященная набору приложений и расширений, которые я
|
||||
использую в повседневной жизни на моем домашнем компьютере.
|
||||
|
||||
<!--more-->
|
||||
|
||||
## <a href="#apps" class="anchor" id="apps"><span class="octicon octicon-link"></span></a>Приложения
|
||||
|
||||
* **Shell** - zshrc без вариантов. Некоторое описание моих настроек шелла могут быть найдены [тут](/ru/2014/01/14/about-zshrc/ "Статья о zshrc"). Сами настройки хранятся [тут](//raw.githubusercontent.com/arcan1s/dotfiles/master/zshrc "Файл") или [тут](//raw.githubusercontent.com/arcan1s/dotfiles/master/zshrc_server "Файл").
|
||||
* **DE** - KDE со всеми вытекающими (поэтому набор приложений, преимущественно, Qt-based). Некоторые подробности приготовления KDE будут даны ниже.
|
||||
* **Работа с изображениями** - [gwenview](//kde.org/applications/graphics/gwenview/ "Домашняя страница Gwenview") для просмотра и быстрого редактирования, [kolourpaint](//kde.org/applications/graphics/kolourpaint/ "Домашняя страница Kolourpaint") для простого редактирования стандартных форматов пиксельной графики, [gimp](//www.gimp.org/ "Домашняя страница Gimp") (без плагинов, ибо не было необходимости) для более сурового редактирования и [inkskape](//www.inkscape.org/ "Домашняя страница Inkskape") для работы с векторной графикой.
|
||||
* **Браузер** - Firefox, ранее Qupzilla, еще ранее Opera. Некоторый набор настроек Firefox будет дан ниже. Дополнительный браузер - Chromium. Консольный - elinks.
|
||||
* **IM клиент** - [qutIM](//qutim.org "Домашняя страница Qutim"). Кроссплатформенный, мультипротокольный, с необходимым набором фич. [Kopete](//kde.org/applications/internet/kopete/ "Домашняя страница Kopete"), который использовался ранее, часто падал, работал как хотел и вообще не дружил с кодировкой. Раньше еще был какой то консольный, но сейчас его нет. Для таких случаев предпочитаю использовать клиент с планшета. Skype для скайпа, очевидно.
|
||||
* **Почтовый клиент** - [kmail](//kde.org/applications/internet/kmail/ "Домашняя страница Kmail"). Много фич, большая часть из которых мною используется, симпатично выглядит и удобный. Еще бы был DE-независимый, цены бы ему не было.
|
||||
* **IRC клиент** - [konversation](//konversation.kde.org/ "Домашняя страница Konversation"). Самый обычный IRC-клиент. Хотя, если мне не изменяет память, qutIM тоже поддерживает IRC протокол, лично мне удобнее использовать отдельный клиент для этого.
|
||||
* **Torrent клиент** - [transmission](//www.transmissionbt.com/ "Домашняя страница Transmission") с Qt5 интерфейсом (gtk тоже имеется). Для сервера он же, но без GUI.
|
||||
* **Видео плеер** - [mpv](//mpv.io/ "Домашняя страница mpv"). Mplayer умер, а mplayer2 родился мертворожденным. Ах да, графические надстройки сверху ненужны.
|
||||
* **Аудио плеер** - [qmmp](//qmmp.ylsoftware.com/ "Домашняя страница Qmmp"). Хороший, годный плеер с закосом под winamp. Легким движением руки делаем ему человеческий интерфейс aka simpleui.
|
||||
* **Работа с аудио/видео** - [kdenlive](//kde-apps.org/content/show.php?content=29024 "Домашняя страница kdenlive") для работы с видео, [soundkonverter](//kde-apps.org/content/show.php?content=29024 "Домашняя страница Soundkonverter") для работы с аудио, [easytag](//wiki.gnome.org/Apps/EasyTAG "Домашняя страница Easytag") для работы с аудио тегами (gtk, но зато единственный, чья функциональность меня устроила). Ну и командная строка и небольшие скрипты на bash.
|
||||
* **Офис** - [Kingsoft Office](//wps-community.org/ "Домашняя страница KO") в качестве замены Microsoft Office; в общем то ничем не примечательный, разве что не так ущербно смотрится, как стандартные офисы, Qt-based и, говорят, с хорошей поддержкой стандартных форматов. Версия под линукс находится в состоянии альфы. [Kile](//kile.sourceforge.net/ "Домашняя страница Kile") в качестве фронтенда к LaTeX. [Okular](//kde.org/applications/graphics/okular/ "Домашняя страница Okular"), как просмотрщик всего. [GoldenDict](//goldendict.org/ "Домашняя страница GoldenDict") в качестве словаря.
|
||||
* **Редакторы** - [kwrite](//www.kde.org/applications/utilities/kwrite/ "Домашняя страница Kwrite") в качестве легковесного редактора, [kate](//www.kde.org/applications/utilities/kate/ "Домашняя страница Kate") (с плагином [cpp-helper](//zaufi.github.io/kate-cpp-helper-plugin.html "Домашняя страница плагина")) для более суровых вещей. Ну и, конечно, vim для консоли.
|
||||
* **Научный софт**. Визуализаторы химические - [vmd](//www.ks.uiuc.edu/Research/vmd/ "Домашняя страница VMD"), [chimera](//www.cgl.ucsf.edu/chimera/ "Домашняя страница Chimera") и [pymol](//pymol.org/ "Домашняя страница Pymol"). Физический симулятор [step](//kde.org/applications/education/step/ "Домашняя страница Step"). Калькулятор [kalgebra](//kde.org/applications/education/kalgebra/ "Домашняя страница Kalgebra") и консольный [ipython](//ipython.org/ "Домашняя страница ipython"). Рисовалка графиков и анализ [qtiplot](//qtiplot.com/ "Домашняя страница Qtiplot") (его форк scidavis, к сожалению, полумертв), только рисовалка - [grace](//plasma-gate.weizmann.ac.il/Grace/ "Домашняя страница Grace"). [Chemtool](//ruby.chemie.uni-freiburg.de/~martin/chemtool/chemtool.html "Домашняя страница Chemtool") в качестве замены ChemDraw.
|
||||
* **Системное**. Файловый менеджер [dolphin](//kde.org/applications/system/dolphin/ "Домашняя страница Dolphin"), [doublecmd](//doublecmd.sourceforge.net/ "Домашняя страница Doublecmd") как двухпанельный менеджер. Эмуляторы терминала - [yakuake](//yakuake.kde.org/ "Домашняя страница Yakuake") и [urxvt](//software.schmorp.de/pkg/rxvt-unicode.html "Домашняя страница urxvt") в качестве оконного. Графический интерфейс для архиваторов [ark](//kde.org/applications/utilities/ark/ "Домашняя страница Ark").
|
||||
|
||||
* **Shell** - zshrc без вариантов. Некоторое описание моих настроек шелла могут
|
||||
быть найдены [тут](/ru/2014/01/14/about-zshrc/ "Статья о zshrc"). Сами настройки
|
||||
хранятся [тут](//raw.githubusercontent.com/arcan1s/dotfiles/master/zshrc "Файл")
|
||||
или [тут](//raw.githubusercontent.com/arcan1s/dotfiles/master/zshrc_server
|
||||
"Файл").
|
||||
* **DE** - KDE со всеми вытекающими (поэтому набор приложений, преимущественно,
|
||||
Qt-based). Некоторые подробности приготовления KDE будут даны ниже.
|
||||
* **Работа с изображениями** -
|
||||
[gwenview](//kde.org/applications/graphics/gwenview/ "Домашняя страница
|
||||
Gwenview") для просмотра и быстрого редактирования,
|
||||
[kolourpaint](//kde.org/applications/graphics/kolourpaint/ "Домашняя страница
|
||||
Kolourpaint") для простого редактирования стандартных форматов пиксельной
|
||||
графики, [gimp](//www.gimp.org/ "Домашняя страница Gimp") (без плагинов, ибо не
|
||||
было необходимости) для более сурового редактирования и
|
||||
[inkskape](//www.inkscape.org/ "Домашняя страница Inkskape") для работы с
|
||||
векторной графикой.
|
||||
* **Браузер** - Firefox, ранее Qupzilla, еще ранее Opera. Некоторый набор
|
||||
настроек Firefox будет дан ниже. Дополнительный браузер - Chromium. Консольный -
|
||||
elinks.
|
||||
* **IM клиент** - [qutIM](//qutim.org "Домашняя страница Qutim").
|
||||
Кроссплатформенный, мультипротокольный, с необходимым набором фич.
|
||||
[Kopete](//kde.org/applications/internet/kopete/ "Домашняя страница Kopete"),
|
||||
который использовался ранее, часто падал, работал как хотел и вообще не дружил с
|
||||
кодировкой. Раньше еще был какой то консольный, но сейчас его нет. Для таких
|
||||
случаев предпочитаю использовать клиент с планшета. Skype для скайпа, очевидно.
|
||||
* **Почтовый клиент** - [kmail](//kde.org/applications/internet/kmail/ "Домашняя
|
||||
страница Kmail"). Много фич, большая часть из которых мною используется,
|
||||
симпатично выглядит и удобный. Еще бы был DE-независимый, цены бы ему не было.
|
||||
* **IRC клиент** - [konversation](//konversation.kde.org/ "Домашняя страница
|
||||
Konversation"). Самый обычный IRC-клиент. Хотя, если мне не изменяет память,
|
||||
qutIM тоже поддерживает IRC протокол, лично мне удобнее использовать отдельный
|
||||
клиент для этого.
|
||||
* **Torrent клиент** - [transmission](//www.transmissionbt.com/ "Домашняя
|
||||
страница Transmission") с Qt5 интерфейсом (gtk тоже имеется). Для сервера он же,
|
||||
но без GUI.
|
||||
* **Видео плеер** - [mpv](//mpv.io/ "Домашняя страница mpv"). Mplayer умер, а
|
||||
mplayer2 родился мертворожденным. Ах да, графические надстройки сверху ненужны.
|
||||
* **Аудио плеер** - [qmmp](//qmmp.ylsoftware.com/ "Домашняя страница Qmmp").
|
||||
Хороший, годный плеер с закосом под winamp. Легким движением руки делаем ему
|
||||
человеческий интерфейс aka simpleui.
|
||||
* **Работа с аудио/видео** -
|
||||
[kdenlive](//kde-apps.org/content/show.php?content=29024 "Домашняя страница
|
||||
kdenlive") для работы с видео,
|
||||
[soundkonverter](//kde-apps.org/content/show.php?content=29024 "Домашняя
|
||||
страница Soundkonverter") для работы с аудио,
|
||||
[easytag](//wiki.gnome.org/Apps/EasyTAG "Домашняя страница Easytag") для работы
|
||||
с аудио тегами (gtk, но зато единственный, чья функциональность меня устроила).
|
||||
Ну и командная строка и небольшие скрипты на bash.
|
||||
* **Офис** - [Kingsoft Office](//wps-community.org/ "Домашняя страница KO") в
|
||||
качестве замены Microsoft Office; в общем то ничем не примечательный, разве что
|
||||
не так ущербно смотрится, как стандартные офисы, Qt-based и, говорят, с хорошей
|
||||
поддержкой стандартных форматов. Версия под линукс находится в состоянии альфы.
|
||||
[Kile](//kile.sourceforge.net/ "Домашняя страница Kile") в качестве фронтенда к
|
||||
LaTeX. [Okular](//kde.org/applications/graphics/okular/ "Домашняя страница
|
||||
Okular"), как просмотрщик всего. [GoldenDict](//goldendict.org/ "Домашняя
|
||||
страница GoldenDict") в качестве словаря.
|
||||
* **Редакторы** - [kwrite](//www.kde.org/applications/utilities/kwrite/
|
||||
"Домашняя страница Kwrite") в качестве легковесного редактора,
|
||||
[kate](//www.kde.org/applications/utilities/kate/ "Домашняя страница Kate") (с
|
||||
плагином [cpp-helper](//zaufi.github.io/kate-cpp-helper-plugin.html "Домашняя
|
||||
страница плагина")) для более суровых вещей. Ну и, конечно, vim для консоли.
|
||||
* **Научный софт**. Визуализаторы химические -
|
||||
[vmd](//www.ks.uiuc.edu/Research/vmd/ "Домашняя страница VMD"),
|
||||
[chimera](//www.cgl.ucsf.edu/chimera/ "Домашняя страница Chimera") и
|
||||
[pymol](//pymol.org/ "Домашняя страница Pymol"). Физический симулятор
|
||||
[step](//kde.org/applications/education/step/ "Домашняя страница Step").
|
||||
Калькулятор [kalgebra](//kde.org/applications/education/kalgebra/ "Домашняя
|
||||
страница Kalgebra") и консольный [ipython](//ipython.org/ "Домашняя страница
|
||||
ipython"). Рисовалка графиков и анализ [qtiplot](//qtiplot.com/ "Домашняя
|
||||
страница Qtiplot") (его форк scidavis, к сожалению, полумертв), только рисовалка -
|
||||
[grace](//plasma-gate.weizmann.ac.il/Grace/ "Домашняя страница Grace").
|
||||
[Chemtool](//ruby.chemie.uni-freiburg.de/~martin/chemtool/chemtool.html
|
||||
"Домашняя страница Chemtool") в качестве замены ChemDraw.
|
||||
* **Системное**. Файловый менеджер
|
||||
[dolphin](//kde.org/applications/system/dolphin/ "Домашняя страница Dolphin"),
|
||||
[doublecmd](//doublecmd.sourceforge.net/ "Домашняя страница Doublecmd") как
|
||||
двухпанельный менеджер. Эмуляторы терминала - [yakuake](//yakuake.kde.org/
|
||||
"Домашняя страница Yakuake") и
|
||||
[urxvt](//software.schmorp.de/pkg/rxvt-unicode.html "Домашняя страница urxvt") в
|
||||
качестве оконного. Графический интерфейс для архиваторов
|
||||
[ark](//kde.org/applications/utilities/ark/ "Домашняя страница Ark").
|
||||
|
||||
## <a href="#kde" class="anchor" id="kde"><span class="octicon octicon-link"></span></a>Настройка KDE
|
||||
|
||||
@ -38,11 +104,27 @@ short: my-desktop
|
||||
{% include prj_scr.html %}
|
||||
</div>
|
||||
|
||||
В качестве стиля Qt используется QtCurve, настройки могут быть найдены [здесь](//github.com/arcan1s/dotfiles/tree/master/qtcurve "GitHub"), оформление окон оттуда же. Курсор [ecliz-small](//kde-look.org/content/show.php/Ecliz?content=110340 "Домашняя страница курсоров"). Тема плазмы [volatile](//kde-look.org/content/show.php/Volatile?content=128110 "Домашняя страница темы"). Значки [compass](//nitrux.in/ "Домашняя страница Nitrux"). Шрифты на базе Liberation.
|
||||
В качестве стиля Qt используется QtCurve, настройки могут быть найдены
|
||||
[здесь](//github.com/arcan1s/dotfiles/tree/master/qtcurve "GitHub"), оформление
|
||||
окон оттуда же. Курсор
|
||||
[ecliz-small](//kde-look.org/content/show.php/Ecliz?content=110340 "Домашняя
|
||||
страница курсоров"). Тема плазмы
|
||||
[volatile](//kde-look.org/content/show.php/Volatile?content=128110 "Домашняя
|
||||
страница темы"). Значки [compass](//nitrux.in/ "Домашняя страница Nitrux").
|
||||
Шрифты на базе Liberation.
|
||||
|
||||
**Используемые виджеты** (слева направо, сверху вниз): [menubar](//launchpad.net/plasma-widget-menubar "Домашняя страница виджета"), [homerun](//userbase.kde.org/Homerun "Домашняя страница виджета") с прозрачной иконкой, [icontask](//kde-apps.org/content/show.php?content=144808 "Домашняя страница виджета"), [netctl](/ru/projects/netctl-gui/ "Домашняя страница виджета"), стандартный трей от KDE, [colibri](//agateau.com/projects/colibri/ "Домашняя страница виджета") в качестве уведомлений, [Awesome Widgets](/ru/projects/awesome-widgets "Домашняя страница виджета").
|
||||
**Используемые виджеты** (слева направо, сверху вниз):
|
||||
[menubar](//launchpad.net/plasma-widget-menubar "Домашняя страница виджета"),
|
||||
[homerun](//userbase.kde.org/Homerun "Домашняя страница виджета") с прозрачной
|
||||
иконкой, [icontask](//kde-apps.org/content/show.php?content=144808 "Домашняя
|
||||
страница виджета"), [netctl](/ru/projects/netctl-gui/ "Домашняя страница
|
||||
виджета"), стандартный трей от KDE, [colibri](//agateau.com/projects/colibri/
|
||||
"Домашняя страница виджета") в качестве уведомлений, [Awesome
|
||||
Widgets](/ru/projects/awesome-widgets "Домашняя страница виджета").
|
||||
|
||||
В качестве бонусного материала - яркие цвета в консоли (для [konsole](//github.com/arcan1s/dotfiles/blob/master/themes/yakuake/My%20color.colorscheme "GitHub")):
|
||||
В качестве бонусного материала - яркие цвета в консоли (для
|
||||
[konsole](//github.com/arcan1s/dotfiles/blob/master/themes/yakuake/My%20color.colorscheme
|
||||
"GitHub")):
|
||||
|
||||
<div class="thumbnails">
|
||||
{% assign scrdesc = "Как оно выглядит" %}
|
||||
@ -50,27 +132,32 @@ short: my-desktop
|
||||
{% include prj_scr.html %}
|
||||
</div>
|
||||
|
||||
|
||||
## <a href="#firefox" class="anchor" id="firefox"><span class="octicon octicon-link"></span></a>Настройка Firefox
|
||||
|
||||
В самих настройках ничего интересного нет, я просто напишу список аддонов. Дико радует, что для того, чтобы интерфейс был минималистичным (и удобным), нужно поставить кучу плагинов.
|
||||
В самих настройках ничего интересного нет, я просто напишу список аддонов. Дико
|
||||
радует, что для того, чтобы интерфейс был минималистичным (и удобным), нужно
|
||||
поставить кучу плагинов.
|
||||
|
||||
* **Adblock plus** - куда же без него.
|
||||
* **Add to search bar** - для кастомных поисков.
|
||||
* **Auto Refresh** - автоматическое обновление страниц.
|
||||
* **Clone tab** - добавляет функцию "Дублировать вкладку".
|
||||
* **Close tab by double click** - понятно, короче.
|
||||
* **New scrollbars** используется для кастомизации скроллбаров, потому что оригинальные смотрятся ущербно в Qt окружении.
|
||||
* **New scrollbars** используется для кастомизации скроллбаров, потому что
|
||||
оригинальные смотрятся ущербно в Qt окружении.
|
||||
* **NoScript** используется, например, для I2P и Tor.
|
||||
* **PrivateTab** - добавляет приватную вкладку (а не окно).
|
||||
* **Proxy Selector** добавляет возможность использовать несколько прокси-серверов.
|
||||
* **Proxy Selector** добавляет возможность использовать несколько
|
||||
прокси-серверов.
|
||||
* **QuickJava** используется примерно с той же целью, что и NoScript.
|
||||
* **RSS иконка в строке адреса** - очевидно.
|
||||
* **Словари для проверки орфографии** (eng/rus).
|
||||
* **Space Next** - на нажатие на пробел внизу страницы реагирует, как на нажатие кнопки "Далее".
|
||||
* **Space Next** - на нажатие на пробел внизу страницы реагирует, как на нажатие
|
||||
кнопки "Далее".
|
||||
* **Speed Dial** - простая экспресс-панель.
|
||||
* **Status-4-Evar** - нормальная строка состояния.
|
||||
* **tab delabelifier** - сворачивает неиспользуемые вкладки.
|
||||
* **Tab Scope + Tab Scope Tweaker** - всплывающая подсказка у вкладок.
|
||||
* **accessKey** - пока не работает. Вообще служит для удобной навигации (opera-like) с клавиатуры.
|
||||
* **accessKey** - пока не работает. Вообще служит для удобной навигации
|
||||
(opera-like) с клавиатуры.
|
||||
* **FXOpera** - нормальный минималистичный вид.
|
||||
|
||||
@ -7,23 +7,35 @@ tags: linux, archlinux, сборка
|
||||
title: Отключение baloo, gentoo-way
|
||||
short: disabling-baloo
|
||||
---
|
||||
Пока ононимные онолитеги ЛОР'а ноют на тему baloo, я предпочел потратить 15 минут на то, чтобы отвязать приложения от этого чуда человеческой мысли.
|
||||
Пока ононимные онолитеги ЛОР'а ноют на тему baloo, я предпочел потратить 15 минут
|
||||
на то, чтобы отвязать приложения от этого чуда человеческой мысли.
|
||||
|
||||
<!--more-->
|
||||
|
||||
## <a href="#disclaimer" class="anchor" id="disclaimer"><span class="octicon octicon-link"></span></a>Дисклеймер
|
||||
|
||||
Сам этим я не пользуюсь, поскольку предпочитаю менее деструктивные методы. Однако, судя по всему, все работает без проблем, поскольку жалоб нет. Так как патч делался действительно за несколько минут, то он просто выкорчевывает все вызовы baloo из исходников (возможно, когда-нибудь я сделаю нормальный патч).
|
||||
Сам этим я не пользуюсь, поскольку предпочитаю менее деструктивные методы. Однако,
|
||||
судя по всему, все работает без проблем, поскольку жалоб нет. Так как патч
|
||||
делался действительно за несколько минут, то он просто выкорчевывает все вызовы
|
||||
baloo из исходников (возможно, когда-нибудь я сделаю нормальный патч).
|
||||
|
||||
С другой стороны, я настоятельно рекомендую людям, которым по каким-либо причинам baloo не нужен, отключить его из меню настроек (добавили пункт в 4.13.1), либо воспользоваться этой [статьей](//blog.andreascarpino.it/disabling-baloo-the-arch-way/ "Блог Скарпино").
|
||||
С другой стороны, я настоятельно рекомендую людям, которым по каким-либо причинам
|
||||
baloo не нужен, отключить его из меню настроек (добавили пункт в 4.13.1), либо
|
||||
воспользоваться этой [статьей](//blog.andreascarpino.it/disabling-baloo-the-arch-way/
|
||||
"Блог Скарпино").
|
||||
|
||||
## <a href="#intro" class="anchor" id="intro"><span class="octicon octicon-link"></span></a>Введение
|
||||
|
||||
В Archlinux, на текущий момент (2014-05-18) от baloo, помимо **baloo-widgets**, зависит **gwenview** и **kdepim**. В версии 4.13.0, почему то, **kactivities** тоже зависел от baloo, однако, эта зависимость не требовалась явно (таким образом, достаточно было просто пересобрать его, удалив baloo из списка зависимостей).
|
||||
В Archlinux, на текущий момент (2014-05-18) от baloo, помимо **baloo-widgets**,
|
||||
зависит **gwenview** и **kdepim**. В версии 4.13.0, почему то, **kactivities**
|
||||
тоже зависел от baloo, однако, эта зависимость не требовалась явно (таким
|
||||
образом, достаточно было просто пересобрать его, удалив baloo из списка
|
||||
зависимостей).
|
||||
|
||||
## <a href="#gwenview" class="anchor" id="gwenview"><span class="octicon octicon-link"></span></a>gwenview
|
||||
|
||||
Тут все довольно просто. Разработчики сами позаботились за нас о возможных пожеланиях простых пользователей и добавили специальный флаг:
|
||||
Тут все довольно просто. Разработчики сами позаботились за нас о возможных
|
||||
пожеланиях простых пользователей и добавили специальный флаг:
|
||||
|
||||
```cmake
|
||||
//Semantic info backend for Gwenview (Baloo/Fake/None)
|
||||
@ -41,8 +53,17 @@ cmake ../gwenview-${pkgver} \
|
||||
|
||||
## <a href="#kdepim" class="anchor" id="kdepim"><span class="octicon octicon-link"></span></a>kdepim
|
||||
|
||||
Так как делалось все на скорую руку, то я предпочел пробежаться по исходникам с помощью grep и найти все упоминания baloo. Нужные строки (а это указания на baloo в файлах CMakeLists.txt, вызовы функций из его библиотек, объявления заголовочных файлов) просто закомментировал (в исходном коде местами пришлось добавить фейковые вызовы). Патч полностью здесь приводить не буду (он, к тому же, немного большой), а дам [ссылку на него](//gist.github.com/arcan1s/b698bb586faef627b3bb "Gist") (4.13.3). Далее просто требуется применить этот патч к исходникам и пересобрать kdepim.
|
||||
Так как делалось все на скорую руку, то я предпочел пробежаться по исходникам с
|
||||
помощью grep и найти все упоминания baloo. Нужные строки (а это указания на
|
||||
baloo в файлах CMakeLists.txt, вызовы функций из его библиотек, объявления
|
||||
заголовочных файлов) просто закомментировал (в исходном коде местами пришлось
|
||||
добавить фейковые вызовы). Патч полностью здесь приводить не буду (он, к тому же,
|
||||
немного большой), а дам [ссылку на него](//gist.github.com/arcan1s/b698bb586faef627b3bb
|
||||
"Gist") (4.13.3). Далее просто требуется применить этот патч к исходникам и
|
||||
пересобрать kdepim.
|
||||
|
||||
## <a href="#packages" class="anchor" id="packages"><span class="octicon octicon-link"></span></a>Пакеты
|
||||
|
||||
Все пакеты для Archlinux для обеих архитектур доступны [в моем репозитории](//wiki.archlinux.org/index.php/Unofficial_user_repositories#arcanisrepo "ArchWiki").
|
||||
Все пакеты для Archlinux для обеих архитектур доступны [в моем репозитории]
|
||||
(//wiki.archlinux.org/index.php/Unofficial_user_repositories#arcanisrepo
|
||||
"ArchWiki").
|
||||
|
||||
@ -7,30 +7,69 @@ tags: archlinux
|
||||
title: Немного об Arch User Repository
|
||||
short: about-aur
|
||||
---
|
||||
Статья посвященная работе с пользовательским репозиторием Archlinux. Постарался сделать акцент на сопровождении пакетов. Данная статья, в большей степени, представляет собой компиляцию нескольких англоязычных статей Wiki и немного личного опыта. Поэтому не уверен, что в данной статье на английском языке будет толк.
|
||||
Статья посвященная работе с пользовательским репозиторием Archlinux. Постарался
|
||||
сделать акцент на сопровождении пакетов. Данная статья, в большей степени,
|
||||
представляет собой компиляцию нескольких англоязычных статей Wiki и немного
|
||||
личного опыта. Поэтому не уверен, что в данной статье на английском языке будет
|
||||
толк.
|
||||
|
||||
<!--more-->
|
||||
|
||||
## <a href="#aur" class="anchor" id="aur"><span class="octicon octicon-link"></span></a>AUR
|
||||
|
||||
Итак, [Arch User Repository](//aur.archlinux.org/ "AUR") (AUR или АУР) - это репозиторий, поддерживаемый и развиваемый практически исключительно сообществом Archlinux. Есть еще отдельные люди, называемые [доверенными пользователями](//www.archlinux.org/trustedusers/ "Доверенные пользователи") (TU), на плечах которых лежит своеобразная "модерация" этого репозитория. На мой скромный взгляд, едва ли не единственное отличие Archlinux от других дистрибутивов - это наличие AUR'а. Отличие этого репозитория от обычных прежде всего в том, что он **не содержит** архивов с исходниками или собранных пакетов - только скрипт сборки (PKGBUILD) и, возможно, дополнительные текстовые файлы.
|
||||
Итак, [Arch User Repository](//aur.archlinux.org/ "AUR") (AUR или АУР) - это
|
||||
репозиторий, поддерживаемый и развиваемый практически исключительно сообществом
|
||||
Archlinux. Есть еще отдельные люди, называемые [доверенными
|
||||
пользователями](//www.archlinux.org/trustedusers/ "Доверенные пользователи")
|
||||
(TU), на плечах которых лежит своеобразная "модерация" этого репозитория. На мой
|
||||
скромный взгляд, едва ли не единственное отличие Archlinux от других
|
||||
дистрибутивов - это наличие AUR'а. Отличие этого репозитория от обычных прежде
|
||||
всего в том, что он **не содержит** архивов с исходниками или собранных пакетов
|
||||
- только скрипт сборки (PKGBUILD) и, возможно, дополнительные текстовые файлы.
|
||||
|
||||
Конечно, вручную скачивать архив с сайта AUR'а, а также проверять обновления, не совсем удобно, поэтому существует [набор хелперов](//wiki.archlinux.org/index.php/AUR_Helpers "ArchWiki"). Большинство хелперов представляет собой обертку над pacman. Я выделю только два - [packer](//aur.archlinux.org/packages/packer/ "AUR") - минималистичный, удобный, быстрый - и [yaourt](//aur.archlinux.org/packages/yaourt/ "AUR") - на шелле, но зато более функциональный. По не особо понятным мне причинам, в русскоязычном сегменте большее распространение получил yaourt, зарубежом - packer.
|
||||
Конечно, вручную скачивать архив с сайта AUR'а, а также проверять обновления, не
|
||||
совсем удобно, поэтому существует [набор
|
||||
хелперов](//wiki.archlinux.org/index.php/AUR_Helpers "ArchWiki"). Большинство
|
||||
хелперов представляет собой обертку над pacman. Я выделю только два -
|
||||
[packer](//aur.archlinux.org/packages/packer/ "AUR") - минималистичный, удобный,
|
||||
быстрый - и [yaourt](//aur.archlinux.org/packages/yaourt/ "AUR") - на шелле, но
|
||||
зато более функциональный. По не особо понятным мне причинам, в русскоязычном
|
||||
сегменте большее распространение получил yaourt, зарубежом - packer.
|
||||
|
||||
Помимо хелперов, существуют также консольные клиенты для работы с AUR. Я выделю, пожалуй, только один - [python-aur](//aur.archlinux.org/packages/python3-aur/ "AUR"). Иногда удобная альтернатива веб-интерфейсу.
|
||||
Помимо хелперов, существуют также консольные клиенты для работы с AUR. Я выделю,
|
||||
пожалуй, только один - [python-aur](//aur.archlinux.org/packages/python3-aur/
|
||||
"AUR"). Иногда удобная альтернатива веб-интерфейсу.
|
||||
|
||||
Другая особенность данного репозитория - и не менее важная - **все действия с ним осуществляются на свой страх и риск**. Опасные и некорректные пакеты, конечно же, удаляются, но вполне могут быть и ошибки при сборке и еще все, что сможете придумать. Дык вот - работа с ним на вашей совести, и никто вам ничем не обязан, если что-то сломается. По этой же причине, ни один хелпер в обозримом будущем не будет перенесен в официальные репозитории.
|
||||
Другая особенность данного репозитория - и не менее важная - **все действия с
|
||||
ним осуществляются на свой страх и риск**. Опасные и некорректные пакеты,
|
||||
конечно же, удаляются, но вполне могут быть и ошибки при сборке и еще все, что
|
||||
сможете придумать. Дык вот - работа с ним на вашей совести, и никто вам ничем не
|
||||
обязан, если что-то сломается. По этой же причине, ни один хелпер в обозримом
|
||||
будущем не будет перенесен в официальные репозитории.
|
||||
|
||||
У пакетов в AUR есть несколько характеристик, которых нет у пакетов в официальных репозиториях:
|
||||
У пакетов в AUR есть несколько характеристик, которых нет у пакетов в
|
||||
официальных репозиториях:
|
||||
|
||||
* группа - скорее для удобства поиска, сортировки. Немного помогает доверенным пользователям.
|
||||
* автор, мейнтейнер, последний приславший - люди, кто, соответственно, первый раз прислал данный пакет, сопровождает его в настоящий момент, и последний прислал.
|
||||
* голоса - когда кому-либо понравился этот пакет или он находит его полезным, он голосует. Теоретически, пакеты, имеющие больше 10 голосов могут попасть в официальные репозитории (если найдется желающий среди доверенных пользователей). Другой путь в официальные репозитории - попасть в [список часто используемых](//www.archlinux.de/?page=PackageStatistics "Статистика"), но вы же не пользуетесь [pkgstats](//www.archlinux.org/packages/pkgstats "Пакет Archlinux").
|
||||
* группа - скорее для удобства поиска, сортировки. Немного помогает доверенным
|
||||
пользователям.
|
||||
* автор, мейнтейнер, последний приславший - люди, кто, соответственно, первый
|
||||
раз прислал данный пакет, сопровождает его в настоящий момент, и последний
|
||||
прислал.
|
||||
* голоса - когда кому-либо понравился этот пакет или он находит его полезным, он
|
||||
голосует. Теоретически, пакеты, имеющие больше 10 голосов могут попасть в
|
||||
официальные репозитории (если найдется желающий среди доверенных пользователей).
|
||||
Другой путь в официальные репозитории - попасть в [список часто
|
||||
используемых](//www.archlinux.de/?page=PackageStatistics "Статистика"), но вы же
|
||||
не пользуетесь [pkgstats](//www.archlinux.org/packages/pkgstats "Пакет
|
||||
Archlinux").
|
||||
|
||||
|
||||
## <a href="#install-from-aur" class="anchor" id="install-from-aur"><span class="octicon octicon-link"></span></a>Установка с AUR
|
||||
|
||||
Для работы с AUR требуется установить группу пакетов [base-devel](//www.archlinux.org/groups/x86_64/base-devel/ "Группа пакетов Archlinux"). Пакеты с этой группы, как правило, **не включены** в зависимости. Рекомендуемая установка пакетов с AUR выглядит примерно так:
|
||||
Для работы с AUR требуется установить группу пакетов
|
||||
[base-devel](//www.archlinux.org/groups/x86_64/base-devel/ "Группа пакетов
|
||||
Archlinux"). Пакеты с этой группы, как правило, **не включены** в зависимости.
|
||||
Рекомендуемая установка пакетов с AUR выглядит примерно так:
|
||||
|
||||
```bash
|
||||
# скачать архив с PKGBUILD'ом c AUR
|
||||
@ -49,80 +88,193 @@ pacman -U foo-0.1-1-i686.pkg.tar.xz
|
||||
|
||||
## <a href="#upload-to-aur" class="anchor" id="upload-to-aur"><span class="octicon octicon-link"></span></a>Загрузка пакета в AUR
|
||||
|
||||
**Никаких** `makepkg -S`. С недавних пор данный метод считается устаревшим. Но обо всем по-порядку
|
||||
**Никаких** `makepkg -S`. С недавних пор данный метод считается устаревшим. Но
|
||||
обо всем по-порядку
|
||||
|
||||
Нам нужно загрузить архив на сайт. В этом архиве **должны быть** PKGBUILD и .AURINFO. По поводу первого я расскажу еще чуть ниже, второй генерируется автоматически. Также, там могут быть установочные скрипты (*.install), патчи, файлы лицензии (если не предоставляются апстримом с исходниками), сервисы systemd, скрипты запуска - это то, что обычно включено. **Никаких исходников**. И тем более **никаких бинарников**. (Шутки-шутками, а я помню пакет, в котором исходный код записывался с помощью `cat << EOF` прямо в тексте PKGBUILD'а.)
|
||||
Нам нужно загрузить архив на сайт. В этом архиве **должны быть** PKGBUILD и
|
||||
.AURINFO. По поводу первого я расскажу еще чуть ниже, второй генерируется
|
||||
автоматически. Также, там могут быть установочные скрипты (\*.install), патчи,
|
||||
файлы лицензии (если не предоставляются апстримом с исходниками), сервисы
|
||||
systemd, скрипты запуска - это то, что обычно включено. **Никаких исходников**.
|
||||
И тем более **никаких бинарников**. (Шутки-шутками, а я помню пакет, в котором
|
||||
исходный код записывался с помощью `cat << EOF` прямо в тексте PKGBUILD'а.)
|
||||
|
||||
Все файлы кладем в одну директорию. Убедились, что install файл, если он есть, указан в переменной install, все другие исходные файлы указаны в массиве source, а хэш-суммы правильные (их легко можно сгенерировать, набрав `makepkg -g`). Далее из этой директории запустить команду `mkaurball` (пакет [pkgbuild-introspection](//www.archlinux.org/packages/pkgbuild-introspection "Пакет Archlinux")) - и архив готов.
|
||||
Все файлы кладем в одну директорию. Убедились, что install файл, если он есть,
|
||||
указан в переменной install, все другие исходные файлы указаны в массиве source,
|
||||
а хэш-суммы правильные (их легко можно сгенерировать, набрав `makepkg -g`).
|
||||
Далее из этой директории запустить команду `mkaurball` (пакет
|
||||
[pkgbuild-introspection](//www.archlinux.org/packages/pkgbuild-introspection
|
||||
"Пакет Archlinux")) - и архив готов.
|
||||
|
||||
Несколько правил загрузки пакета в AUR:
|
||||
|
||||
* Если такой пакет существует в официальном репозитории (любой версии), то **не нужно** заливать новый пакет. Если репозиторный пакет устарел, просто пометьте его, как устаревший. Исключение из этого правила составляют пакеты из системы контрля версий (VCS), о них чуть ниже.
|
||||
* Проверьте AUR. Если такой пакет уже существует и у него есть мейнтейнер, вы **не сможете залить** свой пакет. Если у него нет мейнтейнера, то вы автоматически будете его сопровождающим после обновления. Еще может быть такой же пакет, но с другим названием, будьте внимательны.
|
||||
* PKGBUILD должен следовать (более-менее) стандартам и должен быть более-менее аккуратным. В противном случае, пакет может быть удален без предупреждения.
|
||||
* Если такой пакет существует в официальном репозитории (любой версии), то **не
|
||||
нужно** заливать новый пакет. Если репозиторный пакет устарел, просто пометьте
|
||||
его, как устаревший. Исключение из этого правила составляют пакеты из системы
|
||||
контрля версий (VCS), о них чуть ниже.
|
||||
* Проверьте AUR. Если такой пакет уже существует и у него есть мейнтейнер, вы
|
||||
**не сможете залить** свой пакет. Если у него нет мейнтейнера, то вы
|
||||
автоматически будете его сопровождающим после обновления. Еще может быть такой
|
||||
же пакет, но с другим названием, будьте внимательны.
|
||||
* PKGBUILD должен следовать (более-менее) стандартам и должен быть более-менее
|
||||
аккуратным. В противном случае, пакет может быть удален без предупреждения.
|
||||
* Пакет должен быть полезен еще кому-либо кроме Вас =)
|
||||
* Рекомендуется проверить **собранный пакет и PKGBUILD** с помощью [namcap](//www.archlinux.org/packages/namcap "Пакет Archlinux"). Это не даст 100% гарантии, но на основные ошибки укажет.
|
||||
* Рекомендуется проверить **собранный пакет и PKGBUILD** с помощью
|
||||
[namcap](//www.archlinux.org/packages/namcap "Пакет Archlinux"). Это не даст
|
||||
100% гарантии, но на основные ошибки укажет.
|
||||
|
||||
|
||||
## <a href="#maintaining" class="anchor" id="maintaining"><span class="octicon octicon-link"></span></a>Сопровождение пакетов
|
||||
|
||||
Если вы сопровождаете пакет и хотите его обновить, просто загрузите обновленный пакет еще раз. Читайте - и, по возможности, отвечайте - комментарии к вашему пакету, там иногда могут быть очень полезные замечания или дельные предложения. Если вы не хотите сопровождать больше ваш пакет (или нет времени), то, пожалуйста, нажмите на кнопку справа (бросить/disown), чтобы те, кто в нем заинтересован, смогли поддерживать его. Если есть пакет, который не имеет сопровождающего, и вы хотели бы им стать, вы также можете нажать на соответствующую кнопку справа в веб-интерфейсе =)
|
||||
Если вы сопровождаете пакет и хотите его обновить, просто загрузите обновленный
|
||||
пакет еще раз. Читайте - и, по возможности, отвечайте - комментарии к вашему
|
||||
пакету, там иногда могут быть очень полезные замечания или дельные предложения.
|
||||
Если вы не хотите сопровождать больше ваш пакет (или нет времени), то,
|
||||
пожалуйста, нажмите на кнопку справа (бросить/disown), чтобы те, кто в нем
|
||||
заинтересован, смогли поддерживать его. Если есть пакет, который не имеет
|
||||
сопровождающего, и вы хотели бы им стать, вы также можете нажать на
|
||||
соответствующую кнопку справа в веб-интерфейсе =)
|
||||
|
||||
## <a href="#aur-list" class="anchor" id="aur-list"><span class="octicon octicon-link"></span></a>Список рассылки AUR
|
||||
|
||||
По любому вопросу, связанному с работой AUR вы всегда можете обратиться в [список рассылки](//mailman.archlinux.org/mailman/listinfo/aur-general "Список рассылки") [aur-general (at) archlinux (dot) org](mailto:aur-general@archlinux.org "email"). На ваш вопрос ответят, вероятно, достаточно быстро; причем, ответить могут не только обычные пользователи, но и доверенные пользователи. Также, если вы вдруг неуверены в своем PKGBUILD'е, вы тоже можете всегда обратиться в список рассылки и показать свой PKGBUILD.
|
||||
По любому вопросу, связанному с работой AUR вы всегда можете обратиться в
|
||||
[список рассылки](//mailman.archlinux.org/mailman/listinfo/aur-general "Список
|
||||
рассылки") [aur-general (at) archlinux (dot)
|
||||
org](mailto:aur-general@archlinux.org "email"). На ваш вопрос ответят, вероятно,
|
||||
достаточно быстро; причем, ответить могут не только обычные пользователи, но и
|
||||
доверенные пользователи. Также, если вы вдруг неуверены в своем PKGBUILD'е, вы
|
||||
тоже можете всегда обратиться в список рассылки и показать свой PKGBUILD.
|
||||
|
||||
Существует также отдельный список [рассылки для запросов](//mailman.archlinux.org/mailman/listinfo/aur-requests "Список рассылки") [aur-requests (at) archlinux (dot) org](mailto:aur-requests@archlinux.org "email"). На текущий момент (AUR 3.2.0) общение через данный список рассылки напрямую не рекомендуется - все обычные запросы должны отсылаться с использованием веб-интерфейса ([подробности](//mailman.archlinux.org/pipermail/aur-general/2014-July/029045.html "Тред")). Запросы, которые вы можете послать:
|
||||
Существует также отдельный список [рассылки для
|
||||
запросов](//mailman.archlinux.org/mailman/listinfo/aur-requests "Список
|
||||
рассылки") [aur-requests (at) archlinux (dot)
|
||||
org](mailto:aur-requests@archlinux.org "email"). На текущий момент (AUR 3.2.0)
|
||||
общение через данный список рассылки напрямую не рекомендуется - все обычные
|
||||
запросы должны отсылаться с использованием веб-интерфейса
|
||||
([подробности](//mailman.archlinux.org/pipermail/aur-general/2014-July/029045.html
|
||||
"Тред")). Запросы, которые вы можете послать:
|
||||
|
||||
* **Удаление пакета**. Запрос должен включать **краткое описание причины**, почему вы его хотите удалить. Обычные причины - специальный патч, который больше не нужен; пакет уныл и более не поддерживается апстримом; переименование; функциональность предоставляется другим пакетом.
|
||||
* **"Бросить пакет"**. Лишить текущего мейнтейнера права сопровождать данный пакет. Официальное требование - вы должны связаться до этого с мейнтейнером по e-mail и **ожидать от него ответа в течение двух недель** (теперь это делается автоматически при отправке запроса через веб-интерфейс). Однако, если мейнтейнер неактивен в течение длительного времени, или пакет помечен, как устаревший, в течение длительного времени, то можно сделать исключение из этого правила. (Например, если пакет отмечен устаревшим более шести месяцев, то запрос удовлетворяется автоматически.)
|
||||
* **Объединение пакетов**. Если пакет подлежит удалению, но имеет голоса (или важные комментарии), то его можно объединить с другим, который предоставляет то же самое. Частный случай - это аналогично переименованию пакета из одного в другой.
|
||||
* **Удаление пакета**. Запрос должен включать **краткое описание причины**,
|
||||
почему вы его хотите удалить. Обычные причины - специальный патч, который больше
|
||||
не нужен; пакет уныл и более не поддерживается апстримом; переименование;
|
||||
функциональность предоставляется другим пакетом.
|
||||
* **"Бросить пакет"**. Лишить текущего мейнтейнера права сопровождать данный
|
||||
пакет. Официальное требование - вы должны связаться до этого с мейнтейнером по
|
||||
e-mail и **ожидать от него ответа в течение двух недель** (теперь это делается
|
||||
автоматически при отправке запроса через веб-интерфейс). Однако, если мейнтейнер
|
||||
неактивен в течение длительного времени, или пакет помечен, как устаревший, в
|
||||
течение длительного времени, то можно сделать исключение из этого правила.
|
||||
(Например, если пакет отмечен устаревшим более шести месяцев, то запрос
|
||||
удовлетворяется автоматически.)
|
||||
* **Объединение пакетов**. Если пакет подлежит удалению, но имеет голоса (или
|
||||
важные комментарии), то его можно объединить с другим, который предоставляет то
|
||||
же самое. Частный случай - это аналогично переименованию пакета из одного в
|
||||
другой.
|
||||
|
||||
|
||||
Пожалуйста, пишите письма в список рассылки аккуратно. И, желательно, вежливо (а то потом будете генерировать что-то вроде [такого](//linux.sytes.net/post/2014/05/aur-driven-by-idiots/ "Блог")) (мы все знаем, что мы арче-школьники, не надо нас еще раз этим тыкать, мы обидимся). Также старайтесь избегать избыточного цитирования. И - это практически требование - предоставляйте ссылки на пакеты. Хороший вариант - составление списка ссылок в конце письма, а в теле ссылаться на них таким образом `[1]`. Если не уверены в корректности запроса - посмотрите [архив списка рассылки](//mailman.archlinux.org/pipermail/aur-requests/ "Список рассылки").
|
||||
Пожалуйста, пишите письма в список рассылки аккуратно. И, желательно, вежливо (а
|
||||
то потом будете генерировать что-то вроде
|
||||
[такого](//linux.sytes.net/post/2014/05/aur-driven-by-idiots/ "Блог")) (мы все
|
||||
знаем, что мы арче-школьники, не надо нас еще раз этим тыкать, мы обидимся).
|
||||
Также старайтесь избегать избыточного цитирования. И - это практически
|
||||
требование - предоставляйте ссылки на пакеты. Хороший вариант - составление
|
||||
списка ссылок в конце письма, а в теле ссылаться на них таким образом `[1]`.
|
||||
Если не уверены в корректности запроса - посмотрите [архив списка
|
||||
рассылки](//mailman.archlinux.org/pipermail/aur-requests/ "Список рассылки").
|
||||
|
||||
|
||||
## <a href="#pkgbuild" class="anchor" id="pkgbuild"><span class="octicon octicon-link"></span></a>PKGBUILD
|
||||
|
||||
PKGBUILD - это, де-факто, сценарий шелла, указывающий как и почему (в смысле, зачем) собираться пакету. Он имеет 4 части:
|
||||
PKGBUILD - это, де-факто, сценарий шелла, указывающий как и почему (в смысле,
|
||||
зачем) собираться пакету. Он имеет 4 части:
|
||||
|
||||
* **Объявление основных переменных**. Об этом я расскажу чуть ниже.
|
||||
* **Подготовка исходников**. Этот пункт необязательный. Включает в себя копирование (если вдруг нужно), применение патчей, sed и прочие мелочи. Функция обозначается, как **prepare()**.
|
||||
* **Сборка**. Также необязательный пункт. Здесь - и только здесь - должна проводиться компиляция. Функция обозначается, как **build()**.
|
||||
* **Установка**. Обязательный пункт. Здесь происходит копирование нужных файлов в указанный корень (`$pkgdir`). Функция обозначается, как **package()** (для совмещенных пакетов таких функций несколько и они называются примерно так: **package_$pkgname()**).
|
||||
* **Подготовка исходников**. Этот пункт необязательный. Включает в себя
|
||||
копирование (если вдруг нужно), применение патчей, sed и прочие мелочи. Функция
|
||||
обозначается, как **prepare()**.
|
||||
* **Сборка**. Также необязательный пункт. Здесь - и только здесь - должна
|
||||
проводиться компиляция. Функция обозначается, как **build()**.
|
||||
* **Установка**. Обязательный пункт. Здесь происходит копирование нужных файлов
|
||||
в указанный корень (`$pkgdir`). Функция обозначается, как **package()** (для
|
||||
совмещенных пакетов таких функций несколько и они называются примерно так:
|
||||
**package_$pkgname()**).
|
||||
|
||||
### <a href="#pkgbuild-vars" class="anchor" id="pkgbuild-vars"><span class="octicon octicon-link"></span></a>Переменные PKGBUILD
|
||||
|
||||
Основные переменные следующие:
|
||||
|
||||
* **pkgbase** - группа пакетов. Например, пакеты `python-pyqt4` и `python2-pyqt4` имеют одну группу `pyqt4`.
|
||||
* **pkgname** - имя (или массив имен для совмещенных пакетов) пакета; обязательная переменная.
|
||||
* **pkgver** - версия пакета, указанная в апстриме, **pkgrel** - арче-специфичный релиз пакета.
|
||||
* **pkgbase** - группа пакетов. Например, пакеты `python-pyqt4` и
|
||||
`python2-pyqt4` имеют одну группу `pyqt4`.
|
||||
* **pkgname** - имя (или массив имен для совмещенных пакетов) пакета;
|
||||
обязательная переменная.
|
||||
* **pkgver** - версия пакета, указанная в апстриме, **pkgrel** -
|
||||
арче-специфичный релиз пакета.
|
||||
* **pkgdesc** - краткое описание пакета.
|
||||
* **arch** - массив архитектур. Как правило, `arch=('i686' 'x86_64')` для бинарных пакетов (очень-очень редко бывают пакеты, которые предоставляются только для одной архитектуры) и `arch=('any')` для пакетов, не содержащих бинарные файлы.
|
||||
* **arch** - массив архитектур. Как правило, `arch=('i686' 'x86_64')` для
|
||||
бинарных пакетов (очень-очень редко бывают пакеты, которые предоставляются
|
||||
только для одной архитектуры) и `arch=('any')` для пакетов, не содержащих
|
||||
бинарные файлы.
|
||||
* **url** - адрес апстрима.
|
||||
* **license** - лицензия. Если лицензия отлична от обычных (распространенные типы MIT, BSD и custom) - смотри пакет [core/licenses](//www.archlinux.org/packages/core/any/licenses/ "Пакет Archlinux") - то ее надо установить вместе с пакетом по пути `/usr/share/licenses/$pkgname/LICENSE`).
|
||||
* **depends** - массив зависимостей, **необходимых для работы** пакета. **optdepends** - это **дополнительные зависимости**, которые не необходимы для работы, но предоставляют дополнительную функциональность. **makedepends** - это зависимости, которые не включены в **depends**, но **необходимы при сборке** пакета. Лучший способ проверить, правильно ли указаны зависимости сборки (зачастую, это самое важное) - попробуйте собрать пакет в чистом окружении (то есть совсем совсем чистом). И да, зависимости из группы [base-devel](//www.archlinux.org/groups/x86_64/base-devel/ "Группа пакетов Archlinux") указывать не надо.
|
||||
* Следующие три переменные необязательны. **provides** - список пакетов, функциональность которых предоставляет данный пакет. **replaces** - список пакетов, которые данный пакет замещает (обычно используется для решения проблем с переименованием пакетов при обновлении). **conflicts** - список пакетов, с которым конфликтует данный пакет (имеет такие же файлы). Пример различия **provides** и **replaces** - [gvim](//www.archlinux.org/packages/gvim/ "Пакет Archlinux") предоставляет [vim](//www.archlinux.org/packages/vim/ "Пакет Archlinux"), а [wireshark-gtk](//www.archlinux.org/packages/wireshark-gtk/ "Пакет Archlinux") замещает wireshark.
|
||||
* **install** - файл, содержащий сценарии, запускающиеся после установки/удаления/обновления (смотрите файл `/usr/share/pacman/proto.install`).
|
||||
* **source** - где брать исходники, файлы предоставляемые вместе с пакетом указываются только по имени, к данному массиму также прилагается массив хэш сумм (md5sums/sha1sums/sha256sums/sha384sums/sha512sums).
|
||||
* **license** - лицензия. Если лицензия отлична от обычных (распространенные
|
||||
типы MIT, BSD и custom) - смотри пакет
|
||||
[core/licenses](//www.archlinux.org/packages/core/any/licenses/ "Пакет
|
||||
Archlinux") - то ее надо установить вместе с пакетом по пути
|
||||
`/usr/share/licenses/$pkgname/LICENSE`).
|
||||
* **depends** - массив зависимостей, **необходимых для работы** пакета.
|
||||
**optdepends** - это **дополнительные зависимости**, которые не необходимы для
|
||||
работы, но предоставляют дополнительную функциональность. **makedepends** - это
|
||||
зависимости, которые не включены в **depends**, но **необходимы при сборке**
|
||||
пакета. Лучший способ проверить, правильно ли указаны зависимости сборки
|
||||
(зачастую, это самое важное) - попробуйте собрать пакет в чистом окружении (то
|
||||
есть совсем совсем чистом). И да, зависимости из группы
|
||||
[base-devel](//www.archlinux.org/groups/x86_64/base-devel/ "Группа пакетов
|
||||
Archlinux") указывать не надо.
|
||||
* Следующие три переменные необязательны. **provides** - список пакетов,
|
||||
функциональность которых предоставляет данный пакет. **replaces** - список
|
||||
пакетов, которые данный пакет замещает (обычно используется для решения проблем
|
||||
с переименованием пакетов при обновлении). **conflicts** - список пакетов, с
|
||||
которым конфликтует данный пакет (имеет такие же файлы). Пример различия
|
||||
**provides** и **replaces** - [gvim](//www.archlinux.org/packages/gvim/ "Пакет
|
||||
Archlinux") предоставляет [vim](//www.archlinux.org/packages/vim/ "Пакет
|
||||
Archlinux"), а [wireshark-gtk](//www.archlinux.org/packages/wireshark-gtk/
|
||||
"Пакет Archlinux") замещает wireshark.
|
||||
* **install** - файл, содержащий сценарии, запускающиеся после
|
||||
установки/удаления/обновления (смотрите файл `/usr/share/pacman/proto.install`).
|
||||
* **source** - где брать исходники, файлы предоставляемые вместе с пакетом
|
||||
указываются только по имени, к данному массиму также прилагается массив хэш сумм
|
||||
(md5sums/sha1sums/sha256sums/sha384sums/sha512sums).
|
||||
|
||||
Все перечисленные выше переменные указываются в заголовке PKGBUILD. К ним также можно обращаться внутри PKGBUILD'а. Дополнительно стоит упомянуть переменные **startdir** - директория, откуда запускается makepkg, **srcdir** - директория с исходниками (`$startdir/src` по умолчанию), **pkgdir** - директория с собранным пакетом (`$startdir/pkg/$pkgname` по умолчанию). **Не используйте** переменную **startdir** без крайней необходимости.
|
||||
Все перечисленные выше переменные указываются в заголовке PKGBUILD. К ним также
|
||||
можно обращаться внутри PKGBUILD'а. Дополнительно стоит упомянуть переменные
|
||||
**startdir** - директория, откуда запускается makepkg, **srcdir** - директория с
|
||||
исходниками (`$startdir/src` по умолчанию), **pkgdir** - директория с собранным
|
||||
пакетом (`$startdir/pkg/$pkgname` по умолчанию). **Не используйте** переменную
|
||||
**startdir** без крайней необходимости.
|
||||
|
||||
### <a href="#pkgbuild-features" class="anchor" id="pkgbuild-features"><span class="octicon octicon-link"></span></a>Некоторые особенности PKGBUILD'ов
|
||||
|
||||
К PKGBUILD применимы все правила программирования на шелле. Например, "смешная шутка":
|
||||
К PKGBUILD применимы все правила программирования на шелле. Например, "смешная
|
||||
шутка":
|
||||
|
||||
```bash
|
||||
pkgdir="/usr pkg"
|
||||
rm -rf $pkgdir
|
||||
```
|
||||
|
||||
кому-то может показаться не очень смешной, увы. Поэтому все пути (да и вообще переменные - там где надо, конечно) лучше обрамлять в двойные кавычки (исключение - условия в двойных квадратных скобках `[[ ... ]]`). Если вы вводите какие-либо свои переменные, то настоятельно рекоммендуется добавить в начале подчеркивание `_` во избежание перекрытия переменными makepkg.
|
||||
кому-то может показаться не очень смешной, увы. Поэтому все пути (да и вообще
|
||||
переменные - там где надо, конечно) лучше обрамлять в двойные кавычки
|
||||
(исключение - условия в двойных квадратных скобках `[[ ... ]]`). Если вы вводите
|
||||
какие-либо свои переменные, то настоятельно рекоммендуется добавить в начале
|
||||
подчеркивание `_` во избежание перекрытия переменными makepkg.
|
||||
|
||||
В русскоязычном сегменте до сих пор зачастую встречаются строки типа `make || return 1`. Дык вот, `return 1` теперь уже давно как не нужен.
|
||||
В русскоязычном сегменте до сих пор зачастую встречаются строки типа `make ||
|
||||
return 1`. Дык вот, `return 1` теперь уже давно как не нужен.
|
||||
|
||||
Еще можно работать с рядом других переменных, определенных makepkg. Их список можно глянуть в `/etc/makepkg.conf`. Самые ходовые - флаги компиляции и `CARCH`. Так, например, если вы собираете пакет, исходники к которому предоставляются в бинарном виде (проприетарный драйвер, например), то кусок PKGBUILD может выглядеть так:
|
||||
Еще можно работать с рядом других переменных, определенных makepkg. Их список
|
||||
можно глянуть в `/etc/makepkg.conf`. Самые ходовые - флаги компиляции и `CARCH`.
|
||||
Так, например, если вы собираете пакет, исходники к которому предоставляются в
|
||||
бинарном виде (проприетарный драйвер, например), то кусок PKGBUILD может
|
||||
выглядеть так:
|
||||
|
||||
```bash
|
||||
if [ "${CARCH}" == "x86_64" ]; then
|
||||
@ -135,9 +287,19 @@ fi
|
||||
source=(${pkgname}-${pkgver}.tar.gz:://istodo.ru/distribs/${pkgname}-linux-${pkgver}-${_filearch}.tar.gz)
|
||||
```
|
||||
|
||||
**pkgbase** вообще удобная штука. Например, для создания пакетов одновременно для двух версий Python PKGBUILD может выглядеть [примерно так](//projects.archlinux.org/svntogit/community.git/tree/trunk/PKGBUILD?h=packages/python-biopython "Archlinux svn"). Или, в общем случае, [как-то так](//aur.archlinux.org/packages/ne/netctl-gui/PKGBUILD "AUR").
|
||||
**pkgbase** вообще удобная штука. Например, для создания пакетов одновременно
|
||||
для двух версий Python PKGBUILD может выглядеть [примерно так]
|
||||
(//projects.archlinux.org/svntogit/community.git/tree/trunk/PKGBUILD?h=packages/python-biopython
|
||||
"Archlinux svn"). Или, в общем случае, [как-то так]
|
||||
(//aur.archlinux.org/packages/ne/netctl-gui/PKGBUILD "AUR").
|
||||
|
||||
Вообще говоря, для стандартных случаев существуют прототипы PKGBUILD'ов. Их можно найти в `/usr/share/pacman/`, хотя местами они могли немного устареть (больше года как). Так, прототипы для пакетов из системы контроля версий (git/svn/hg/bzr) однозначно устарели - сейчас используется другой, куда более аккуратный, формат. Настоятельно рекомендую ознакомиться на эту тему [с данной статьей](//wiki.archlinux.org/index.php/VCS_PKGBUILD_Guidelines "ArchWiki"). Например, для пакета **qmmp-qsmmp-git** кусок PKGBUILD'а выглядит так:
|
||||
Вообще говоря, для стандартных случаев существуют прототипы PKGBUILD'ов. Их
|
||||
можно найти в `/usr/share/pacman/`, хотя местами они могли немного устареть
|
||||
(больше года как). Так, прототипы для пакетов из системы контроля версий
|
||||
(git/svn/hg/bzr) однозначно устарели - сейчас используется другой, куда более
|
||||
аккуратный, формат. Настоятельно рекомендую ознакомиться на эту тему [с данной
|
||||
статьей](//wiki.archlinux.org/index.php/VCS_PKGBUILD_Guidelines "ArchWiki").
|
||||
Например, для пакета **qmmp-qsmmp-git** кусок PKGBUILD'а выглядит так:
|
||||
|
||||
```bash
|
||||
pkgname=qmmp-qsmmp-git
|
||||
@ -173,7 +335,9 @@ pkgver() {
|
||||
}
|
||||
```
|
||||
|
||||
Также, я отмечу, что некоторые пакеты имеют свой устоявшийся формат, поэтому, зачастую, полезно поискать что-то похожее в AUR и сделать свой PKGBUILD по образу и подобию.
|
||||
Также, я отмечу, что некоторые пакеты имеют свой устоявшийся формат, поэтому,
|
||||
зачастую, полезно поискать что-то похожее в AUR и сделать свой PKGBUILD по
|
||||
образу и подобию.
|
||||
|
||||
|
||||
## <a href="#links" class="anchor" id="links"><span class="octicon octicon-link"></span></a>Дополнительные ссылки
|
||||
@ -182,4 +346,6 @@ pkgver() {
|
||||
* [ArchWiki про AUR](//wiki.archlinux.org/index.php/AUR "ArchWiki")
|
||||
* [ArchWiki про PKGBUILD](//wiki.archlinux.org/index.php/PKGBUILD "ArchWiki")
|
||||
* [ArchWiki про makepkg](//wiki.archlinux.org/index.php/Makepkg "ArchWiki")
|
||||
* [ArchWiki немного про стандарты](//wiki.archlinux.org/index.php/Arch_packaging_standards "ArchWiki") (внизу есть весьма полезные ссылки на гайды для конкретных типов пакетов)
|
||||
* [ArchWiki немного про
|
||||
стандарты](//wiki.archlinux.org/index.php/Arch_packaging_standards "ArchWiki")
|
||||
(внизу есть весьма полезные ссылки на гайды для конкретных типов пакетов)
|
||||
|
||||
@ -7,19 +7,28 @@ tags: linux, разработка
|
||||
title: Написание своих дополнений для Shell. Zsh
|
||||
short: writting-own-completions-p1
|
||||
---
|
||||
<figure class="img"></figure> В данных статьях описываются некоторые основы создания файлов дополнений для собственной программы.
|
||||
<figure class="img"></figure> В
|
||||
данных статьях описываются некоторые основы создания файлов дополнений для
|
||||
собственной программы.
|
||||
|
||||
<!--more-->
|
||||
|
||||
## <a href="#preamble" class="anchor" id="preamble"><span class="octicon octicon-link"></span></a>Преамбула
|
||||
|
||||
В процессе разработки [одного своего проекта](/ru/projects/netctl-gui "Страница netctl-gui") возникло желание добавить также файлы дополнений (только не спрашивайте зачем). Благо я как-то уже брался за написание подобных вещей, но читать что-либо тогда мне было лень, и так и не осилил.
|
||||
В процессе разработки [одного своего проекта](/ru/projects/netctl-gui
|
||||
"Страница netctl-gui") возникло желание добавить также файлы дополнений (только
|
||||
не спрашивайте зачем). Благо я как-то уже брался за написание подобных вещей, но
|
||||
читать что-либо тогда мне было лень, и так и не осилил.
|
||||
|
||||
## <a href="#introduction" class="anchor" id="introduction"><span class="octicon octicon-link"></span></a>Введение
|
||||
|
||||
Существует несколько возможных вариантов написания файла автодополнения для zsh. В случае данной статьи я остановлюсь только на одном из них, который предоставляет большие возможности и не требует больших затрат (например, работы с регулярными выражениями).
|
||||
Существует несколько возможных вариантов написания файла автодополнения для zsh.
|
||||
В случае данной статьи я остановлюсь только на одном из них, который
|
||||
предоставляет большие возможности и не требует больших затрат (например, работы
|
||||
с регулярными выражениями).
|
||||
|
||||
Рассмотрим на примере моего же приложения, часть справки к которому выглядит таким образом:
|
||||
Рассмотрим на примере моего же приложения, часть справки к которому выглядит
|
||||
таким образом:
|
||||
|
||||
```bash
|
||||
netctl-gui [ -h | --help ] [ -e ESSID | --essid ESSID ] [ -с FILE | --config FILE ]
|
||||
@ -30,20 +39,29 @@ netctl-gui [ -h | --help ] [ -e ESSID | --essid ESSID ] [ -с FILE | --config FI
|
||||
|
||||
* флаги `-h` и `--help` не требуют аргументов;
|
||||
* флаги `-e` и `--essid` требуют аргумента в виде строки, без дополнения;
|
||||
* флаги `-c` и `--config` требуют аргумента в виде строки, файл с произвольной локацией;
|
||||
* флаги `-o` и `--open` требуют аргумента в виде строки, дополнение по файлам из определенной директории;
|
||||
* флаги `-t` и `--tab` требуют аргумента в виде строки, дополнение из указанного массива;
|
||||
* флаг `--set-opts` требует аргумента в виде строки, дополнение из указанного массива, разделены запятыми;
|
||||
* флаги `-c` и `--config` требуют аргумента в виде строки, файл с произвольной
|
||||
локацией;
|
||||
* флаги `-o` и `--open` требуют аргумента в виде строки, дополнение по файлам из
|
||||
определенной директории;
|
||||
* флаги `-t` и `--tab` требуют аргумента в виде строки, дополнение из указанного
|
||||
массива;
|
||||
* флаг `--set-opts` требует аргумента в виде строки, дополнение из указанного
|
||||
массива, разделены запятыми;
|
||||
|
||||
## <a href="#file" class="anchor" id="file"><span class="octicon octicon-link"></span></a>Структура файла
|
||||
|
||||
В заголовке должно быть обязательно указано, что это файл дополнений и для каких приложений он служит (можно строкой, если в файле будет содержаться дополнение для нескольких команд):
|
||||
В заголовке должно быть обязательно указано, что это файл дополнений и для каких
|
||||
приложений он служит (можно строкой, если в файле будет содержаться дополнение
|
||||
для нескольких команд):
|
||||
|
||||
```bash
|
||||
#compdef netctl-gui
|
||||
```
|
||||
|
||||
Дальше идет описание флагов, вспомогательные функции и переменные. Замечу, что функции и переменные, которые будут использоваться для дополнения **должны возвращать массивы**, а не строки. В моем случае схема выглядит примерно так (все функции и переменные в этой главе умышленно оставлены пустыми):
|
||||
Дальше идет описание флагов, вспомогательные функции и переменные. Замечу, что
|
||||
функции и переменные, которые будут использоваться для дополнения **должны
|
||||
возвращать массивы**, а не строки. В моем случае схема выглядит примерно так
|
||||
(все функции и переменные в этой главе умышленно оставлены пустыми):
|
||||
|
||||
```bash
|
||||
# variables
|
||||
@ -53,14 +71,17 @@ _netctl_gui_tabs=()
|
||||
_netctl_profiles() {}
|
||||
```
|
||||
|
||||
Затем идут основные функции, которые будут вызываться для дополнения для определенной команды. В моем случае команда одна, и функция одна:
|
||||
Затем идут основные функции, которые будут вызываться для дополнения для
|
||||
определенной команды. В моем случае команда одна, и функция одна:
|
||||
|
||||
```bash
|
||||
# work block
|
||||
_netctl-gui() {}
|
||||
```
|
||||
|
||||
Далее **без выделения в отдельную функцию** идет небольшое шаманство, связанное с соотнесением приложения, которое было декларировано в первой строке, с функцией в теле скрипта:
|
||||
Далее **без выделения в отдельную функцию** идет небольшое шаманство, связанное
|
||||
с соотнесением приложения, которое было декларировано в первой строке, с
|
||||
функцией в теле скрипта:
|
||||
|
||||
```bash
|
||||
case "$service" in
|
||||
@ -72,7 +93,19 @@ esac
|
||||
|
||||
## <a href="#flags" class="anchor" id="flags"><span class="octicon octicon-link"></span></a>Флаги
|
||||
|
||||
Как я и говорил во введении, существует несколько способов создания подобных файлов. В частности, они различаются декларацией флагов и их дальнейшей обработкой. В данном случае я буду использовать команду `_arguments`, которая требует специфичный формат переменных. Выглядит он таким образом `ФЛАГ[описание]:СООБЩЕНИЕ:ДЕЙСТВИЕ`. Последние два поля не обязательны и, как Вы увидите чуть ниже, вовсе и не нужны в некоторых местах. Если Вы предусматриваете два флага (короткий и длинный формат) на одно действие, то формат чуть-чуть усложняется: `{(ФЛАГ_2)ФЛАГ_1,(ФЛАГ_1)ФЛАГ_2}[описание]:СООБЩЕНИЕ:ДЕЙСТВИЕ`. Замечу, что, если Вы хотите сделать дополнения для двух типов флагов, но некоторые флаги не имеют второй записи, то Вам необходимо продублировать его таким образом: `{ФЛАГ,ФЛАГ}[описание]:СООБЩЕНИЕ:ДЕЙСТВИЕ`. `СООБЩЕНИЕ` - сообщение, которое будет показано, `ДЕЙСТВИЕ` - действие, которое будет выполнено после этого флага. В случае данного туториала, `ДЕЙСТВИЕ` будет иметь вид `->СОСТОЯНИЕ`.
|
||||
Как я и говорил во введении, существует несколько способов создания подобных
|
||||
файлов. В частности, они различаются декларацией флагов и их дальнейшей
|
||||
обработкой. В данном случае я буду использовать команду `_arguments`, которая
|
||||
требует специфичный формат переменных. Выглядит он таким образом `ФЛАГ[описание]:
|
||||
СООБЩЕНИЕ:ДЕЙСТВИЕ`. Последние два поля не обязательны и, как Вы увидите чуть
|
||||
ниже, вовсе и не нужны в некоторых местах. Если Вы предусматриваете два флага
|
||||
(короткий и длинный формат) на одно действие, то формат чуть-чуть усложняется:
|
||||
`{(ФЛАГ_2)ФЛАГ_1,(ФЛАГ_1)ФЛАГ_2}[описание]:СООБЩЕНИЕ:ДЕЙСТВИЕ`. Замечу, что,
|
||||
если Вы хотите сделать дополнения для двух типов флагов, но некоторые флаги не
|
||||
имеют второй записи, то Вам необходимо продублировать его таким образом:
|
||||
`{ФЛАГ,ФЛАГ}[описание]:СООБЩЕНИЕ:ДЕЙСТВИЕ`. `СООБЩЕНИЕ` - сообщение, которое
|
||||
будет показано, `ДЕЙСТВИЕ` - действие, которое будет выполнено после этого флага.
|
||||
В случае данного туториала, `ДЕЙСТВИЕ` будет иметь вид `->СОСТОЯНИЕ`.
|
||||
|
||||
Итак, согласно нашим требованиям, получается такое объявление аргументов:
|
||||
|
||||
@ -89,7 +122,8 @@ _netctl_gui_arglist=(
|
||||
|
||||
## <a href="#variables" class="anchor" id="variables"><span class="octicon octicon-link"></span></a>Массивы переменных
|
||||
|
||||
В нашем случае есть два статических массива (не изменятся ни сейчас, ни через пять минут) (массивы умышленно уменьшены):
|
||||
В нашем случае есть два статических массива (не изменятся ни сейчас, ни через
|
||||
пять минут) (массивы умышленно уменьшены):
|
||||
|
||||
```bash
|
||||
_netctl_gui_settings=(
|
||||
@ -103,7 +137,9 @@ _netctl_gui_tabs=(
|
||||
)
|
||||
```
|
||||
|
||||
И есть динамический массив, который должен каждый раз генерироваться. Он содержит, в данном случае, файлы в указанной директории (это можно сделать и средствами zsh, кстати):
|
||||
И есть динамический массив, который должен каждый раз генерироваться. Он содержит,
|
||||
в данном случае, файлы в указанной директории (это можно сделать и средствами
|
||||
zsh, кстати):
|
||||
|
||||
```bash
|
||||
_netctl_profiles() {
|
||||
@ -113,7 +149,10 @@ _netctl_profiles() {
|
||||
|
||||
## <a href="#body" class="anchor" id="body"><span class="octicon octicon-link"></span></a>Тело функции
|
||||
|
||||
Помните, там выше было что-то про состояние? Оно хранится в переменной `$state`, и в теле функции делается проверка на то, чему оно равно, чтобы подобрать соответствующие действия. В начале также нужно не забыть вызвать `_arguments` с нашими флагами.
|
||||
Помните, там выше было что-то про состояние? Оно хранится в переменной `$state`,
|
||||
и в теле функции делается проверка на то, чему оно равно, чтобы подобрать
|
||||
соответствующие действия. В начале также нужно не забыть вызвать `_arguments` с
|
||||
нашими флагами.
|
||||
|
||||
```bash
|
||||
_netctl-gui() {
|
||||
@ -147,6 +186,12 @@ _netctl-gui() {
|
||||
|
||||
## <a href="#conclusion" class="anchor" id="conclusion"><span class="octicon octicon-link"></span></a>Заключение
|
||||
|
||||
Файл хранится в директории `/usr/share/zsh/site-functions/` с произвольным, в общем-то, именем с префиксом `_`. Файл примера полностью может быть найден [в моем репозитории](//raw.githubusercontent.com/arcan1s/netctl-gui/master/sources/gui/zsh-completions "Файл").
|
||||
Файл хранится в директории `/usr/share/zsh/site-functions/` с произвольным, в
|
||||
общем-то, именем с префиксом `_`. Файл примера полностью может быть найден
|
||||
[в моем репозитории](//raw.githubusercontent.com/arcan1s/netctl-gui/master/sources/gui/zsh-completions
|
||||
"Файл").
|
||||
|
||||
Дополнительная информация может быть найдена в репозитории [zsh-completions](//github.com/zsh-users/zsh-completions "GitHub"). Например, там есть такой [How-To](//github.com/zsh-users/zsh-completions/blob/master/zsh-completions-howto.org "Туториал"). А еще там есть много примеров.
|
||||
Дополнительная информация может быть найдена в репозитории [zsh-completions]
|
||||
(//github.com/zsh-users/zsh-completions "GitHub"). Например, там есть такой
|
||||
[How-To](//github.com/zsh-users/zsh-completions/blob/master/zsh-completions-howto.org
|
||||
"Туториал"). А еще там есть много примеров.
|
||||
|
||||
@ -7,19 +7,29 @@ tags: linux, разработка
|
||||
title: Написание своих дополнений для Shell. Bash
|
||||
short: writting-own-completions-p2
|
||||
---
|
||||
<figure class="img"></figure> В данных статьях описываются некоторые основы создания файлов дополнений для собственной программы.
|
||||
<figure class="img"></figure> В
|
||||
данных статьях описываются некоторые основы создания файлов дополнений для
|
||||
собственной программы.
|
||||
|
||||
<!--more-->
|
||||
|
||||
## <a href="#preamble" class="anchor" id="preamble"><span class="octicon octicon-link"></span></a>Преамбула
|
||||
|
||||
В процессе разработки [одного своего проекта](/ru/projects/netctl-gui "Страница netctl-gui") возникло желание добавить также файлы дополнений (только не спрашивайте зачем). Благо я как-то уже брался за написание подобных вещей, но читать что-либо тогда мне было лень, и так и не осилил.
|
||||
В процессе разработки [одного своего проекта](/ru/projects/netctl-gui
|
||||
"Страница netctl-gui") возникло желание добавить также файлы дополнений (только
|
||||
не спрашивайте зачем). Благо я как-то уже брался за написание подобных вещей, но
|
||||
читать что-либо тогда мне было лень, и так и не осилил.
|
||||
|
||||
## <a href="#introduction" class="anchor" id="introduction"><span class="octicon octicon-link"></span></a>Введение
|
||||
|
||||
Bash, в [отличие от zsh](/ru/2014/07/17/writting-own-completions-p1 "Статья о дополнениях zsh"), требует к себе некоторого велосипедостроения в отношении дополнений. Бегло погуглив, я не нашел более-менее нормальных туториалов, потому за основу были взяты имеющиеся в системе файлы дополнений для `pacman`.
|
||||
Bash, в [отличие от zsh](/ru/2014/07/17/writting-own-completions-p1
|
||||
"Статья о дополнениях zsh"), требует к себе некоторого велосипедостроения в
|
||||
отношении дополнений. Бегло погуглив, я не нашел более-менее нормальных
|
||||
туториалов, потому за основу были взяты имеющиеся в системе файлы дополнений для
|
||||
`pacman`.
|
||||
|
||||
Рассмотрим на примере все того же моего приложения. Я напомню, что часть справки к которому выглядит таким образом:
|
||||
Рассмотрим на примере все того же моего приложения. Я напомню, что часть справки
|
||||
к которому выглядит таким образом:
|
||||
|
||||
```bash
|
||||
netctl-gui [ -h | --help ] [ -e ESSID | --essid ESSID ] [ -с FILE | --config FILE ]
|
||||
@ -30,14 +40,22 @@ netctl-gui [ -h | --help ] [ -e ESSID | --essid ESSID ] [ -с FILE | --config FI
|
||||
|
||||
* флаги `-h` и `--help` не требуют аргументов;
|
||||
* флаги `-e` и `--essid` требуют аргумента в виде строки, без дополнения;
|
||||
* флаги `-c` и `--config` требуют аргумента в виде строки, файл с произвольной локацией;
|
||||
* флаги `-o` и `--open` требуют аргумента в виде строки, дополнение по файлам из определенной директории;
|
||||
* флаги `-t` и `--tab` требуют аргумента в виде строки, дополнение из указанного массива;
|
||||
* флаг `--set-opts` требует аргумента в виде строки, дополнение из указанного массива, разделены запятыми;
|
||||
* флаги `-c` и `--config` требуют аргумента в виде строки, файл с произвольной
|
||||
локацией;
|
||||
* флаги `-o` и `--open` требуют аргумента в виде строки, дополнение по файлам из
|
||||
определенной директории;
|
||||
* флаги `-t` и `--tab` требуют аргумента в виде строки, дополнение из указанного
|
||||
массива;
|
||||
* флаг `--set-opts` требует аргумента в виде строки, дополнение из указанного
|
||||
массива, разделены запятыми;
|
||||
|
||||
## <a href="#file" class="anchor" id="file"><span class="octicon octicon-link"></span></a>Структура файла
|
||||
|
||||
Здесь **все** переменные должны возвращать массив. Каких-либо особых форматов тут уже нет. Сначала опишем флаги, потом уже все остальные переменные. Я напомню (так как ниже я уже не буду приводить функции более подробно), что `_netctl_profiles()`, в отличие от других переменных, должна возвращать актуальный на данный момент массив:
|
||||
Здесь **все** переменные должны возвращать массив. Каких-либо особых форматов тут
|
||||
уже нет. Сначала опишем флаги, потом уже все остальные переменные. Я напомню
|
||||
(так как ниже я уже не буду приводить функции более подробно), что
|
||||
`_netctl_profiles()`, в отличие от других переменных, должна возвращать
|
||||
актуальный на данный момент массив:
|
||||
|
||||
```bash
|
||||
# variables
|
||||
@ -47,14 +65,16 @@ _netctl_gui_tabs=()
|
||||
_netctl_profiles() {}
|
||||
```
|
||||
|
||||
Затем идут основные функции, которые будут вызываться для дополнения для определенной команды. В моем случае команда одна, и функция одна:
|
||||
Затем идут основные функции, которые будут вызываться для дополнения для
|
||||
определенной команды. В моем случае команда одна, и функция одна:
|
||||
|
||||
```bash
|
||||
# work block
|
||||
_netctl-gui() {}
|
||||
```
|
||||
|
||||
Далее, опять, **без выделения в отдельную функцию** делаем соответствие "функция-команда":
|
||||
Далее, опять, **без выделения в отдельную функцию** делаем соответствие
|
||||
"функция-команда":
|
||||
|
||||
```bash
|
||||
complete -F _netctl_gui netctl-gui
|
||||
@ -62,7 +82,8 @@ complete -F _netctl_gui netctl-gui
|
||||
|
||||
## <a href="#flags" class="anchor" id="flags"><span class="octicon octicon-link"></span></a>Флаги
|
||||
|
||||
Как было сказано выше, особого формата тут нет, доступные флаги располагаются просто массивом:
|
||||
Как было сказано выше, особого формата тут нет, доступные флаги располагаются
|
||||
просто массивом:
|
||||
|
||||
```bash
|
||||
_netctl_gui_arglist=(
|
||||
@ -100,7 +121,14 @@ _netctl_profiles() {
|
||||
|
||||
## <a href="#body" class="anchor" id="body"><span class="octicon octicon-link"></span></a>Тело функции
|
||||
|
||||
За дополнение в bash отвечает переменная `COMPREPLY`. Для отслеживания текущего состояния нужно вызвать функцию `_get_comp_words_by_ref` с параметрами `cur` (текущая опция) и `prev` (предыдущая, собственно состояние). Ну и нужно несколько точек, на которых сворачивать в определенную часть case (переменные `want*`). Для генерации дополнения используется `compgen`. После флага `-W` ему подается список слов. (Есть еще флаг `-F`, который вызывает функцию, но у меня он помимо этого еще и ворнинг выдает.) Последним аргументом идет текущая строка, к которой и нужно генерировать дополнение.
|
||||
За дополнение в bash отвечает переменная `COMPREPLY`. Для отслеживания текущего
|
||||
состояния нужно вызвать функцию `_get_comp_words_by_ref` с параметрами `cur`
|
||||
(текущая опция) и `prev` (предыдущая, собственно состояние). Ну и нужно
|
||||
несколько точек, на которых сворачивать в определенную часть case (переменные
|
||||
`want*`). Для генерации дополнения используется `compgen`. После флага `-W` ему
|
||||
подается список слов. (Есть еще флаг `-F`, который вызывает функцию, но у меня
|
||||
он помимо этого еще и ворнинг выдает.) Последним аргументом идет текущая строка,
|
||||
к которой и нужно генерировать дополнение.
|
||||
|
||||
Таким образом, наша функция выглядит так:
|
||||
|
||||
@ -141,4 +169,6 @@ _netctl_gui() {
|
||||
|
||||
## <a href="#conclusion" class="anchor" id="conclusion"><span class="octicon octicon-link"></span></a>Заключение
|
||||
|
||||
Файл хранится в директории `/usr/share/bash-completion/completions/` с произвольным именем. Файл примера полностью может быть найден [в моем репозитории](//raw.githubusercontent.com/arcan1s/netctl-gui/master/sources/gui/bash-completions "Файл").
|
||||
Файл хранится в директории `/usr/share/bash-completion/completions/` с
|
||||
произвольным именем. Файл примера полностью может быть найден [в моем репозитории]
|
||||
(//raw.githubusercontent.com/arcan1s/netctl-gui/master/sources/gui/bash-completions "Файл").
|
||||
|
||||
@ -7,7 +7,11 @@ tags: awesome-widgets, pytextmonitor
|
||||
title: Миграция Awesome Widgets (ex-PyTextMonitor) на версию 2.0
|
||||
short: migration-to-v2
|
||||
---
|
||||
<figure class="img"></figure> В версии 2.0 произошел ряд значительных изменений (совершенно случайно, само по себе, я тут не при чем) и было полностью переписано пользовательское API. Данная статья призвана облегчить миграцию со старых версий PyTextMonitor (<1.11.0) на новую (>2.0).
|
||||
<figure class="img"></figure> В
|
||||
версии 2.0 произошел ряд значительных изменений (совершенно случайно, само по
|
||||
себе, я тут не при чем) и было полностью переписано пользовательское API. Данная
|
||||
статья призвана облегчить миграцию со старых версий PyTextMonitor (<1.11.0) на
|
||||
новую (>2.0).
|
||||
|
||||
<!--more-->
|
||||
|
||||
@ -15,22 +19,32 @@ short: migration-to-v2
|
||||
|
||||
Во-первых, это ряд нововведений, среди которых:
|
||||
|
||||
* Новый виджет - **Desktop panel**. Показывает список рабочих столов, выделяя активный. Умеет переключаться между ними по клику. Также умеет скрывать выбранные панели по хоткею.
|
||||
* Новые теги - `hddfreemb`, `hddfreegb`, `memusedmb`, `memusedgb`, `memfreemb`, `memfreegb`, `swapfreemb`, `swapfreegb`. А также новые теги, связанные с новыми возможностями - `desktop`, `ndesktop`, `tdesktops`.
|
||||
* Новый графический тултип - батарея. Двухцветный, в зависимости от статуса адаптора питания.
|
||||
* Новый виджет - **Desktop panel**. Показывает список рабочих столов, выделяя
|
||||
активный. Умеет переключаться между ними по клику. Также умеет скрывать выбранные
|
||||
панели по хоткею.
|
||||
* Новые теги - `hddfreemb`, `hddfreegb`, `memusedmb`, `memusedgb`, `memfreemb`,
|
||||
`memfreegb`, `swapfreemb`, `swapfreegb`. А также новые теги, связанные с новыми
|
||||
возможностями - `desktop`, `ndesktop`, `tdesktops`.
|
||||
* Новый графический тултип - батарея. Двухцветный, в зависимости от статуса
|
||||
адаптора питания.
|
||||
|
||||
## <a href="#changes" class="anchor" id="changes"><span class="octicon octicon-link"></span></a>Значительные изменения
|
||||
|
||||
Во-вторых, и это главное - произошел ряд изменений, из-за которых старые настройки **не будут** более работать. Среди пользовательских следует выделить:
|
||||
Во-вторых, и это главное - произошел ряд изменений, из-за которых старые настройки
|
||||
**не будут** более работать. Среди пользовательских следует выделить:
|
||||
|
||||
* Переписка основного виджета на `С++`, что вызвало переименование проекта в **Awesome Widgets**, а главного виджета в **Awesome Widget**
|
||||
* Переписка основного виджета на `С++`, что вызвало переименование проекта в
|
||||
**Awesome Widgets**, а главного виджета в **Awesome Widget**
|
||||
* Настройки файлов батареи и адаптора питания **вынесены в DataEngine**.
|
||||
* **Убраны поля**. Теперь виджет представляет собой монолитное поле. Текст настраивается в специальном браузере.
|
||||
* **Убраны поля**. Теперь виджет представляет собой монолитное поле. Текст
|
||||
настраивается в специальном браузере.
|
||||
* В связи с удалением отдельных полей, тултип теперь **настраивается отдельно**.
|
||||
* Настройка выравнивания текста теперь может быть осуществлена только с использованием HTML тегов.
|
||||
* Настройка выравнивания текста теперь может быть осуществлена только с
|
||||
использованием HTML тегов.
|
||||
* В связи с объединением полей, несколько тегов были переименованы:
|
||||
* `custom` (время) -> `ctime`
|
||||
* `custom` (время работы) -> `cuptime`
|
||||
* `time` (плеер) -> `duration`
|
||||
|
||||
По любым проблемам, связанным с миграцией, не стесняйтесь оставлять здесь комментарий.
|
||||
По любым проблемам, связанным с миграцией, не стесняйтесь оставлять здесь
|
||||
комментарий.
|
||||
|
||||
@ -7,7 +7,9 @@ tags: linux, systemd, ecryptfs
|
||||
title: Как зашифровать хомяк и не об%$#аться. For dummies
|
||||
short: ecnryption-home-directory
|
||||
---
|
||||
<figure class="img"></figure> Статья посвящена шифрованию домашнего каталога с использованием ecryptfs и настройке автомонтирования посредством systemd с использованием ключа на флешке.
|
||||
<figure class="img"></figure> Статья
|
||||
посвящена шифрованию домашнего каталога с использованием ecryptfs и настройке
|
||||
автомонтирования посредством systemd с использованием ключа на флешке.
|
||||
|
||||
<!--more-->
|
||||
|
||||
@ -26,7 +28,10 @@ short: ecnryption-home-directory
|
||||
|
||||
## <a href="#step1" class="anchor" id="step1"><span class="octicon octicon-link"></span></a>Шаг 1: Шифрование
|
||||
|
||||
Самое распространенное решение в интернетах - воспользоваться автоматическими тулзами. Однако в нашем случае они не подходят, так как нам необходимо импортировать сигнатуру ключа / пароля, что при данном решении невозможно (или у автора руки кривые).
|
||||
Самое распространенное решение в интернетах - воспользоваться автоматическими
|
||||
тулзами. Однако в нашем случае они не подходят, так как нам необходимо
|
||||
импортировать сигнатуру ключа / пароля, что при данном решении невозможно (или
|
||||
у автора руки кривые).
|
||||
|
||||
Делается шифрование следующим образом (lol):
|
||||
|
||||
@ -34,7 +39,10 @@ short: ecnryption-home-directory
|
||||
mount -t ecryptfs /home/$USER /home/$USER
|
||||
```
|
||||
|
||||
В процессе он у нас задаст несколько вопросов (я предлагаю первое монтирование делать в интерактивном режиме). Ответы можно взять примерно такие (в комментариях показано, что эти опции делают), обратите внимание, что если вы что то измените, то изменится и некоторые строчки далее:
|
||||
В процессе он у нас задаст несколько вопросов (я предлагаю первое монтирование
|
||||
делать в интерактивном режиме). Ответы можно взять примерно такие (в
|
||||
комментариях показано, что эти опции делают), обратите внимание, что если вы что
|
||||
то измените, то изменится и некоторые строчки далее:
|
||||
|
||||
```bash
|
||||
# ключ или сертификат. Второе надежнее, но до тех пор пока не потеряете %)
|
||||
@ -93,25 +101,31 @@ cp -a /home/$USER-org/. /home/$USER
|
||||
|
||||
## <a href="#step2" class="anchor" id="step2"><span class="octicon octicon-link"></span></a>Шаг 2: Автомонтирование с systemd
|
||||
|
||||
Создадим файл на флешке (я использовал microSD) со следующим содержанием (пароль только поставьте свой):
|
||||
Создадим файл на флешке (я использовал microSD) со следующим содержанием (пароль
|
||||
только поставьте свой):
|
||||
|
||||
```bash
|
||||
passphrase_passwd=someverystronguniqpassword
|
||||
```
|
||||
|
||||
Добавим автомонтирование флешки (направление `/mnt/key`) в `fstab` с опцией `ro`, например так:
|
||||
Добавим автомонтирование флешки (направление `/mnt/key`) в `fstab` с опцией `ro`,
|
||||
например так:
|
||||
|
||||
```bash
|
||||
UUID=dc3ecb41-bc40-400a-b6bf-65c5beeb01d7 /mnt/key ext2 ro,defaults 0 0
|
||||
```
|
||||
|
||||
Теперь настроим монтирование хомяка. Опции монтирования можно подглядеть как то так:
|
||||
Теперь настроим монтирование хомяка. Опции монтирования можно подглядеть как то
|
||||
так:
|
||||
|
||||
```bash
|
||||
mount | grep ecryptfs
|
||||
```
|
||||
|
||||
Однако замечу, что там указаны не все опции, необходимо добавить также `key`, `no_sig_cache`, `ecryptfs_passthrough`. Таким образом, для systemd mount-юнит выглядит примерно так (любители shell-простыней смогут написать свой демон, потому что через `fstab` не сработает просто так (см. ниже)).
|
||||
Однако замечу, что там указаны не все опции, необходимо добавить также `key`,
|
||||
`no_sig_cache`, `ecryptfs_passthrough`. Таким образом, для systemd mount-юнит
|
||||
выглядит примерно так (любители shell-простыней смогут написать свой демон,
|
||||
потому что через `fstab` не сработает просто так (см. ниже)).
|
||||
|
||||
```bash
|
||||
# cat /etc/systemd/system/home-$USER.mount
|
||||
@ -129,7 +143,9 @@ Options=rw,nosuid,nodev,relatime,key=passphrase:passphrase_passwd_file=/mnt/key/
|
||||
WantedBy=local-fs.target
|
||||
```
|
||||
|
||||
`XXXXX` нужно заменить на сигнатуру из опций, с которыми сейчас смонтирована директория. Также нужно вставить имя пользователя и отредактировать путь к файлу с паролем (и имя mount-юнита), если это необходимо. Автозагрука:
|
||||
`XXXXX` нужно заменить на сигнатуру из опций, с которыми сейчас смонтирована
|
||||
директория. Также нужно вставить имя пользователя и отредактировать путь к файлу
|
||||
с паролем (и имя mount-юнита), если это необходимо. Автозагрука:
|
||||
|
||||
```bash
|
||||
systemctl enable home-$USER.mount
|
||||
@ -158,17 +174,25 @@ WantedBy=local-fs.target
|
||||
systemctl enable umount-key.service
|
||||
```
|
||||
|
||||
Перезагружаемся, если все ок, удаляем бекап. Если нет - значит что то где то неправильно сделали, восстанавливаем из режима восстановления.
|
||||
Перезагружаемся, если все ок, удаляем бекап. Если нет - значит что то где то
|
||||
неправильно сделали, восстанавливаем из режима восстановления.
|
||||
|
||||
## <a href="#whynotfstab" class="anchor" id="whynotfstab"><span class="octicon octicon-link"></span></a>Почему не fstab?
|
||||
|
||||
В моем случае, мне не получилось заставить флешку монтироваться раньше. Таким образом на загрузке я попадал в консоль восстановления из которой нужно было просто продолжить загрузку. Существующие в интернете методы предлагают два возможных варианта:
|
||||
В моем случае, мне не получилось заставить флешку монтироваться раньше. Таким
|
||||
образом на загрузке я попадал в консоль восстановления из которой нужно было
|
||||
просто продолжить загрузку. Существующие в интернете методы предлагают два
|
||||
возможных варианта:
|
||||
|
||||
* Создать запись с опцией noauto, потом монтировать через специальную запись в `rc.local`.
|
||||
* Создать запись с опцией nofail, потом перемонтировать все разделы через `rc.local`.
|
||||
* Создать запись с опцией noauto, потом монтировать через специальную запись в
|
||||
`rc.local`.
|
||||
* Создать запись с опцией nofail, потом перемонтировать все разделы через
|
||||
`rc.local`.
|
||||
|
||||
Оба варианта меня не устроили в виду их костыльности.
|
||||
|
||||
## <a href="#whynotpam" class="anchor" id="whynotpam"><span class="octicon octicon-link"></span></a>Почему не pam?
|
||||
|
||||
Другое распространенное предложение - монтировать через запись в настройках pam. Мне этот вариант не подходит, так как у меня авторизация беспарольная по отпечатку пальца.
|
||||
Другое распространенное предложение - монтировать через запись в настройках pam.
|
||||
Мне этот вариант не подходит, так как у меня авторизация беспарольная по
|
||||
отпечатку пальца.
|
||||
|
||||
@ -7,17 +7,25 @@ tags: awesome-widgets, pytextmonitor
|
||||
title: Awesome Widgets - свистелки и перделки
|
||||
short: aw-v21-bells-and-whistles
|
||||
---
|
||||
Данная статья посвящена обсуждению настройки своих скриптов и графических баров в новой версии Awesome Widgets (2.1).
|
||||
Данная статья посвящена обсуждению настройки своих скриптов и графических баров
|
||||
в новой версии Awesome Widgets (2.1).
|
||||
|
||||
<!--more-->
|
||||
|
||||
## <a href="#intro" class="anchor" id="intro"><span class="octicon octicon-link"></span></a>Введение
|
||||
|
||||
Для начала, я настоятельно рекомендую для после обновления **не открывая настроек виджета** скопировать в безопасное место файл `$HOME/.kde4/share/config/extsysmon.conf`, так как старые настройки кастомных скриптов теперь несовместимы. Вообще, следует заметить, что все фичи можно настраивать и из графического интерфейса, однако я опишу, как это делается простым редактированием desktop файлов.
|
||||
Для начала, я настоятельно рекомендую для после обновления **не открывая настроек
|
||||
виджета** скопировать в безопасное место файл `$HOME/.kde4/share/config/extsysmon.conf`,
|
||||
так как старые настройки кастомных скриптов теперь несовместимы. Вообще, следует
|
||||
заметить, что все фичи можно настраивать и из графического интерфейса, однако я
|
||||
опишу, как это делается простым редактированием desktop файлов.
|
||||
|
||||
## <a href="#general" class="anchor" id="general"><span class="octicon octicon-link"></span></a>Общее
|
||||
|
||||
Все элементы хранятся в двух директориях: `/usr/share/awesomewidgets/%TYPE%/` и `$HOME/.local/share/awesomewidgets/%TYPE%/` (пути могут немного отличаться в зависимости от используемого дистрибутива). Настройки в домашней директории перезаписывают глобальные настройки.
|
||||
Все элементы хранятся в двух директориях: `/usr/share/awesomewidgets/%TYPE%/` и
|
||||
`$HOME/.local/share/awesomewidgets/%TYPE%/` (пути могут немного отличаться в
|
||||
зависимости от используемого дистрибутива). Настройки в домашней директории
|
||||
перезаписывают глобальные настройки.
|
||||
|
||||
## <a href="#bars" class="anchor" id="bars"><span class="octicon octicon-link"></span></a>Бары
|
||||
|
||||
@ -82,7 +90,9 @@ short: aw-v21-bells-and-whistles
|
||||
|
||||
## <a href="#weather" class="anchor" id="weather"><span class="octicon octicon-link"></span></a>Погода
|
||||
|
||||
Для показа погоды используются данные и API [OpenWeatherMap](//openweathermap.org/ "Сайт OpenWeatherMap"). Директория называется `weather`, файлы настроек имеют следующие поля:
|
||||
Для показа погоды используются данные и API [OpenWeatherMap]
|
||||
(//openweathermap.org/ "Сайт OpenWeatherMap"). Директория называется `weather`,
|
||||
файлы настроек имеют следующие поля:
|
||||
|
||||
| Поле | Обязательное | Значение | По-умолчанию |
|
||||
|------|--------------|----------|--------------|
|
||||
|
||||
@ -7,7 +7,9 @@ tags: разработка, c++, cmake
|
||||
title: Добавляем cppcheck и clang-format для проекта на cmake
|
||||
short: cppcheck-and-clang-format
|
||||
---
|
||||
Небольшое How-To посвященное прикручиванию автоматической проверки стиля, а также статического анализатора к проекту на `C++`, который использует в качестве системы сборки `cmake`.
|
||||
Небольшое How-To посвященное прикручиванию автоматической проверки стиля, а
|
||||
также статического анализатора к проекту на `C++`, который использует в качестве
|
||||
системы сборки `cmake`.
|
||||
|
||||
<!--more-->
|
||||
|
||||
@ -23,27 +25,47 @@ sources/
|
||||
|- second_component/
|
||||
```
|
||||
|
||||
**3rdparty** - директория с различными дополнительными библиотеками, которую надо исключить из проверок (в дальнейшем соответствует переменной cmake `PROJECT_TRDPARTY_DIR`). Дополнительно допустим, что у нас, помимо обычных файлов исходного кода (`*.cpp`, `*.h`) есть еще какие-либо (например, `*.qml`).
|
||||
**3rdparty** - директория с различными дополнительными библиотеками, которую
|
||||
надо исключить из проверок (в дальнейшем соответствует переменной cmake
|
||||
`PROJECT_TRDPARTY_DIR`). Дополнительно допустим, что у нас, помимо обычных
|
||||
файлов исходного кода (`*.cpp`, `*.h`) есть еще какие-либо (например, `*.qml`).
|
||||
|
||||
Дополнительно используемые ниже команды можно вставить в pre-commit hook и невозбранно тролить коллег по ынтырпрайзу, не давая им закоммитить ничего, пока они не научатся читать `CONTRIBUTING.md`.
|
||||
Дополнительно используемые ниже команды можно вставить в pre-commit hook и
|
||||
невозбранно тролить коллег по ынтырпрайзу, не давая им закоммитить ничего, пока
|
||||
они не научатся читать `CONTRIBUTING.md`.
|
||||
|
||||
## <a href="#cppcheck" class="anchor" id="cppcheck"><span class="octicon octicon-link"></span></a>cppcheck
|
||||
|
||||
Коль скоро нормальных (из коробки) статических анализаторов не завезли в open source будем использовать то, что имеется. Знатоки говорят, что [cppcheck](//cppcheck.sourceforge.net/ "Сайт cppcheck") при должной конфигурации будет лучше, чем любой аналог, но конфигурация его для достаточно большого проекта похожа больше на написание нового проекта. Суть добавления cppheck к проекту сводится к указанию очевидных недоработок в коде и тыканью в ~~лужу~~ них.
|
||||
Коль скоро нормальных (из коробки) статических анализаторов не завезли в open
|
||||
source будем использовать то, что имеется. Знатоки говорят, что
|
||||
[cppcheck](//cppcheck.sourceforge.net/ "Сайт cppcheck") при должной конфигурации
|
||||
будет лучше, чем любой аналог, но конфигурация его для достаточно большого
|
||||
проекта похожа больше на написание нового проекта. Суть добавления cppheck к
|
||||
проекту сводится к указанию очевидных недоработок в коде и тыканью в <del>лужу</del>
|
||||
них.
|
||||
|
||||
### <a href="#cppcheck-run" class="anchor" id="cppcheck-run"><span class="octicon octicon-link"></span></a>Общий пример запуска
|
||||
|
||||
Тут все, казалось бы, очень просто:
|
||||
|
||||
```bash
|
||||
cppcheck --enable=warning,performance,portability,information,missingInclude --std=c++11 --library=qt.cfg --template="[{severity}][{id}] {message} {callstack} (On {file}:{line})" --verbose --quiet path/to/source/files/or/directory
|
||||
cppcheck --enable=warning,performance,portability,information,missingInclude
|
||||
--std=c++11 --library=qt.cfg --template="[{severity}][{id}] {message}
|
||||
{callstack} (On {file}:{line})" --verbose --quiet
|
||||
path/to/source/files/or/directory
|
||||
```
|
||||
|
||||
* `--enable` говорит о том, какие уведомления надо включить. Я выключил `style` (для этого ниже мы заведем `clang-format`), `unusedFunction` - выдает false-positive для некоторых мест.
|
||||
* `--enable` говорит о том, какие уведомления надо включить. Я выключил `style`
|
||||
(для этого ниже мы заведем `clang-format`), `unusedFunction` - выдает
|
||||
false-positive для некоторых мест.
|
||||
* `--std` говорит об используемом стандарте.
|
||||
* `--library=qt.cfg` некий файл настроек, который говорит о том, что и как надо обрабатывать. Добрые разработчики предлагаю почитать на эту тему [мануал](//cppcheck.sourceforge.net/manual.pdf "cppcheck мануал"). В данном случае я использовал шаблон из `/usr/share/cppcheck/cfg/`.
|
||||
* `--library=qt.cfg` некий файл настроек, который говорит о том, что и как надо
|
||||
обрабатывать. Добрые разработчики предлагаю почитать на эту тему
|
||||
[мануал](//cppcheck.sourceforge.net/manual.pdf "cppcheck мануал"). В данном
|
||||
случае я использовал шаблон из `/usr/share/cppcheck/cfg/`.
|
||||
* `--template` - шаблон строки уведомления.
|
||||
* `---verbose --quiet` две противоречащие друг другу опции. Первая включает более информативные сообщения, вторая выключает отчет о прогрессе.
|
||||
* `---verbose --quiet` две противоречащие друг другу опции. Первая включает
|
||||
более информативные сообщения, вторая выключает отчет о прогрессе.
|
||||
|
||||
### <a href="#cppcheck-cmake" class="anchor" id="cppcheck-cmake"><span class="octicon octicon-link"></span></a>Интеграция с cmake
|
||||
|
||||
@ -75,7 +97,11 @@ add_custom_target(
|
||||
)
|
||||
```
|
||||
|
||||
`cppcheck` умеет рекурсивно директории проверять, однако, на моем примере, мне нужно было пропустить проверку qml-файлов, потому что open source проект, в лучших традициях, сегфолтился на некоторых из них - именно для этого используется поиск исходных файлов с дальнейшим выбрасыванием из них файлов, которые не должны проверяться.
|
||||
`cppcheck` умеет рекурсивно директории проверять, однако, на моем примере, мне
|
||||
нужно было пропустить проверку qml-файлов, потому что open source проект, в
|
||||
лучших традициях, сегфолтился на некоторых из них - именно для этого
|
||||
используется поиск исходных файлов с дальнейшим выбрасыванием из них файлов,
|
||||
которые не должны проверяться.
|
||||
|
||||
Включаем в проект (`CMakeLists.txt`)...
|
||||
|
||||
@ -95,11 +121,17 @@ make cppcheck
|
||||
### <a href="#cppcheck-adds" class="anchor" id="cppcheck-adds"><span class="octicon octicon-link"></span></a>Дополнительно
|
||||
|
||||
* Можно добавить свои директории для поиска хидеров, используя опцию `-I dir`.
|
||||
* Можно вычеркнуть файлы и/или директории из проверки, используя опцию `-i path/to/file/or/directory`.
|
||||
* Можно вычеркнуть файлы и/или директории из проверки, используя опцию `-i
|
||||
path/to/file/or/directory`.
|
||||
|
||||
## <a href="#clang" class="anchor" id="clang"><span class="octicon octicon-link"></span></a>clang-format
|
||||
|
||||
[clang-format](//clang.llvm.org/docs/ClangFormat.html "Сайт clang-format") предназначен для автоматического подгона стиля под желаемый или требуемый. Среди аналогов стоит выделить [astyle](//astyle.sourceforge.net/ "Сайт astyle"), который имеет очень скромные возможности, и [uncrustify](//uncrustify.sourceforge.net/ "Сайт uncrustify"), который, наоборот, имеет слишком много опций.
|
||||
[clang-format](//clang.llvm.org/docs/ClangFormat.html "Сайт clang-format")
|
||||
предназначен для автоматического подгона стиля под желаемый или требуемый. Среди
|
||||
аналогов стоит выделить [astyle](//astyle.sourceforge.net/ "Сайт astyle"),
|
||||
который имеет очень скромные возможности, и
|
||||
[uncrustify](//uncrustify.sourceforge.net/ "Сайт uncrustify"), который,
|
||||
наоборот, имеет слишком много опций.
|
||||
|
||||
### <a href="#clang-run" class="anchor" id="clang-run"><span class="octicon octicon-link"></span></a>Общий пример запуска
|
||||
|
||||
@ -109,8 +141,10 @@ clang-format -i -style=LLVM /path/to/source/files
|
||||
|
||||
(К сожалению, он **не умеет** в рекурсивный обход директории.)
|
||||
|
||||
* `-i` включает автозамену файлов (в противном случае, результат будет печататься в stdout).
|
||||
* `-style` выбор определенного стиля либо из предустановленных, либо из файла (`file`), см. ниже.
|
||||
* `-i` включает автозамену файлов (в противном случае, результат будет
|
||||
печататься в stdout).
|
||||
* `-style` выбор определенного стиля либо из предустановленных, либо из файла
|
||||
(`file`), см. ниже.
|
||||
|
||||
### <a href="#clang-cmake" class="anchor" id="clang-cmake"><span class="octicon octicon-link"></span></a>Интеграция с cmake
|
||||
|
||||
@ -137,7 +171,8 @@ add_custom_target(
|
||||
)
|
||||
```
|
||||
|
||||
Аналогичных способ поиска исходных файлов, как и для `cppcheck`, поскольку `clang-format` не умеет в рекурсию.
|
||||
Аналогичных способ поиска исходных файлов, как и для `cppcheck`, поскольку
|
||||
`clang-format` не умеет в рекурсию.
|
||||
|
||||
Включаем в проект (`CMakeLists.txt`)...
|
||||
|
||||
@ -156,10 +191,18 @@ make clangformat
|
||||
|
||||
### <a href="#clang-adds" class="anchor" id="clang-adds"><span class="octicon octicon-link"></span></a>Дополнительно
|
||||
|
||||
* Настройка. Можно почитать опции на [официальном сайте](//clang.llvm.org/docs/ClangFormat.html "Сайт clang-format"). Также можно воспользоваться [интерактивной утилитой](//clangformat.com/ "Сайт") для просмотра опций. Для использования уже готового стиля за базу используем следующую команду:
|
||||
* Настройка. Можно почитать опции на [официальном
|
||||
сайте](//clang.llvm.org/docs/ClangFormat.html "Сайт clang-format"). Также можно
|
||||
воспользоваться [интерактивной утилитой](//clangformat.com/ "Сайт") для
|
||||
просмотра опций. Для использования уже готового стиля за базу используем
|
||||
следующую команду:
|
||||
|
||||
```bash
|
||||
clang-format -style=LLVM -dump-config > .clang-format
|
||||
```
|
||||
|
||||
Далее редактируется полученный файл `.clang-format`. Для включения его необходимо передать опцию `-style=file`, файл должен находиться в одной из родительских директории для каждого файла (например, в корне проекта). Также, можно передать нужные опции прямо в командной строке, например `-style="{BasedOnStyle: llvm, IndentWidth: 8}"`.
|
||||
Далее редактируется полученный файл `.clang-format`. Для включения его
|
||||
необходимо передать опцию `-style=file`, файл должен находиться в одной из
|
||||
родительских директории для каждого файла (например, в корне проекта). Также,
|
||||
можно передать нужные опции прямо в командной строке, например
|
||||
`-style="{BasedOnStyle: llvm, IndentWidth: 8}"`.
|
||||
|
||||
@ -7,4 +7,9 @@ tags: сайт
|
||||
title: Изменения URL
|
||||
short: url-changes
|
||||
---
|
||||
Хочу заметить, что я изменил адреса сайта и репозитория с [arcanis.name](//arcanis.name) на [arcanis.me](//arcanis.me). Изменения были сделаны исключительно потому что ME домен чуть более симпатичнее. Старые адреса пока еще рабочие и будут такими до марта 2016 год (дата регистрации домена), но на текущий момент я настроил переадресацию со старых адресов на новые. Извините за недобства.
|
||||
Хочу заметить, что я изменил адреса сайта и репозитория с [arcanis.name]
|
||||
(//arcanis.name) на [arcanis.me](//arcanis.me). Изменения были сделаны
|
||||
исключительно потому что ME домен чуть более симпатичнее. Старые адреса пока еще
|
||||
рабочие и будут такими до марта 2016 год (дата регистрации домена), но на
|
||||
текущий момент я настроил переадресацию со старых адресов на новые. Извините за
|
||||
недобства.
|
||||
|
||||
Reference in New Issue
Block a user