more pretty md files

This commit is contained in:
2016-02-02 00:55:13 +07:00
parent c0ad1a6912
commit 518956bdff
39 changed files with 1550 additions and 484 deletions

View File

@ -16,7 +16,8 @@ links:
---
<!-- info block -->
Простой демон, который создает git репозиторий в указанной директории и создает коммит в указанный промежуток времени.
Простой демон, который создает git репозиторий в указанной директории и создает
коммит в указанный промежуток времени.
<!--more-->
@ -64,7 +65,8 @@ See "man 1 ctrlconf" for more details
### <a href="#instruction" class="anchor" id="instruction"><span class="octicon octicon-link"></span></a>Инструкция
* Скачайте [архив](//github.com/arcan1s/git-etc/releases "GitHub") с актуальной версией исходных файлов.
* Скачайте [архив](//github.com/arcan1s/git-etc/releases "GitHub") с актуальной
версией исходных файлов.
* Извлеките из него файлы и установите приложение:
```bash
@ -107,7 +109,8 @@ systemctl start git-etc
systemctl enable git-etc
```
Но Вы можете изменить путь к конфигурационному файлу или изменить параметры. Для этого, скопируйте (рекомендуется) исходный конфигурационный файл
Но Вы можете изменить путь к конфигурационному файлу или изменить параметры. Для
этого, скопируйте (рекомендуется) исходный конфигурационный файл
```bash
cp /etc/git-etc.conf /новый/путь/к/git-etc.conf
@ -135,7 +138,8 @@ ExecStart=/usr/bin/git-etc -c /новый/путь/к/git-etc.conf
<!-- config block -->
## <a href="#config" class="anchor" id="config"><span class="octicon octicon-link"></span></a>Настройка
Все настройки хранятся в `/etc/git-etc.conf`. После редактирования, Вы должны перезапустить демон
Все настройки хранятся в `/etc/git-etc.conf`. После редактирования, Вы должны
перезапустить демон
```bash
systemctl restart git-etc
@ -154,8 +158,14 @@ systemctl restart git-etc
<!-- gui block -->
## <a href="#gui" class="anchor" id="gui"><span class="octicon octicon-link"></span></a>Графический интерфейс
Control Config (`ctrlconf`) - графический интерфейс для `git-etc`, написанный на `Python2/PyQt4`. Данное приложение позволяет Вам увидеть список коммитов и изменения в файлах в данных коммитах. Также данное приложение позволит Вам откатиться на указанный коммит (все файлы, посредством `git reset --hard`, или только указанный, посредством `git diff && git apply`). Также Вы можете объединить старый и новый конфигурационные файлы (используются две
ветки репозитория master и experimental). Приложение может потребовать привелегии root, убедитесь, что пакет `sudo` установлен.
Control Config (`ctrlconf`) - графический интерфейс для `git-etc`, написанный на
`Python2/PyQt4`. Данное приложение позволяет Вам увидеть список коммитов и
изменения в файлах в данных коммитах. Также данное приложение позволит Вам
откатиться на указанный коммит (все файлы, посредством `git reset --hard`, или
только указанный, посредством `git diff && git apply`). Также Вы можете
объединить старый и новый конфигурационные файлы (используются две
ветки репозитория master и experimental). Приложение может потребовать привелегии
root, убедитесь, что пакет `sudo` установлен.
### <a href="#gui_configuration" class="anchor" id="gui_configuration"><span class="octicon octicon-link"></span></a>Настройка

View File

@ -28,11 +28,16 @@ links:
---
<!-- info block -->
Набор минималистичных легко настраиваемых пламоидов, написанных на `C++/Qt`. Они выглядят, как виджеты в [Awesome WM](//awesome.naquadah.org/ "Домашняя страница Awesome"). Также пакет предоставляет дополнительный системный [DataEngine](//techbase.kde.org/Development/Tutorials/Plasma/DataEngines "Мануал для разработчиков").
Набор минималистичных легко настраиваемых пламоидов, написанных на `C++/Qt`. Они
выглядят, как виджеты в [Awesome WM](//awesome.naquadah.org/ "Домашняя страница
Awesome"). Также пакет предоставляет дополнительный системный [DataEngine]
(//techbase.kde.org/Development/Tutorials/Plasma/DataEngines "Мануал для
разработчиков").
<!--more-->
**ВНИМАНИЕ:** [НУЖНЫ ПЕРЕВОДЧИКИ!](//github.com/arcan1s/awesome-widgets/issues/14 "Тикет")
**ВНИМАНИЕ:** [НУЖНЫ ПЕРЕВОДЧИКИ!](//github.com/arcan1s/awesome-widgets/issues/14
"Тикет")
**Совместим с Plasma 5!**
@ -47,7 +52,8 @@ links:
### <a href="#changelog" class="anchor" id="changelog"><span class="octicon octicon-link"></span></a>Список изменений
[CHANGELOG-RU](//github.com/arcan1s/awesome-widgets/blob/master/CHANGELOG-RU "GitHub")
[CHANGELOG-RU](//github.com/arcan1s/awesome-widgets/blob/master/CHANGELOG-RU
"GitHub")
<!-- end of info block -->
@ -56,7 +62,8 @@ links:
### <a href="#instruction" class="anchor" id="instruction"><span class="octicon octicon-link"></span></a>Инструкция
* Скачайте [архив](//github.com/arcan1s/awesome-widgets/releases "GitHub") с актуальной версией исходных файлов.
* Скачайте [архив](//github.com/arcan1s/awesome-widgets/releases "GitHub") с
актуальной версией исходных файлов.
* Извлеките из него файлы и установите:
```bash
@ -67,7 +74,8 @@ links:
sudo make install
```
**ВНИМАНИЕ:** Для Plasma 5, вероятно, потребуется флаг `-DKDE_INSTALL_USE_QT_SYS_PATHS=ON`
**ВНИМАНИЕ:** Для Plasma 5, вероятно, потребуется флаг
`-DKDE_INSTALL_USE_QT_SYS_PATHS=ON`
### <a href="#dependencies" class="anchor" id="dependencies"><span class="octicon octicon-link"></span></a>Зависимости
@ -77,7 +85,8 @@ links:
* cmake *(make)*
* extra-cmake-modules *(make)*
* hddtemp **или** smartmontools *(опционально, для контроля за температурой HDD)*
* один из поддерживаемых музыкальных плееров *(опционально, для контроля за музыкальным плеером)*
* один из поддерживаемых музыкальных плееров *(опционально, для контроля за
музыкальным плеером)*
* проприетарный видеодрайвер *(опционально, для контроля за GPU)*
<!-- end of install block -->
@ -89,7 +98,9 @@ links:
### <a href="#tips" class="anchor" id="tips"><span class="octicon octicon-link"></span></a>Tips & tricks
Вы можете использовать несколько цветов в тексте. Просто вставьте нужный текст в html код. Смотри [вопрос](//github.com/arcan1s/awesome-widgets/issues/9 "GitHub") для более подробной информации.
Вы можете использовать несколько цветов в тексте. Просто вставьте нужный текст в
html код. Смотри [вопрос](//github.com/arcan1s/awesome-widgets/issues/9 "GitHub")
для более подробной информации.
<!-- end of howto block -->
@ -98,7 +109,10 @@ links:
### <a href="#deconf" class="anchor" id="deconf"><span class="octicon octicon-link"></span></a>Настройка DataEngine
Вы можете отредактировать настройки DataEngine, которые хранятся в `/etc/xdg/plasma-dataengine-extsysmon.conf` и `$HOME/.config/plasma-dataengine-extsysmon.conf`. Раскомментируйте необходимые строчки и отредактируйте их.
Вы можете отредактировать настройки DataEngine, которые хранятся в
`/etc/xdg/plasma-dataengine-extsysmon.conf` и
`$HOME/.config/plasma-dataengine-extsysmon.conf`. Раскомментируйте необходимые
строчки и отредактируйте их.
### <a href="#deoptions" class="anchor" id="deoptions"><span class="octicon octicon-link"></span></a>Опции DataEngine
@ -115,7 +129,8 @@ links:
### <a href="#widconf" class="anchor" id="widconf"><span class="octicon octicon-link"></span></a>Настройка виджета
Для настройки внешнего вида Вы должны открыть окно настроек и установить требуемый формат текста. HTML теги обрабатываются корректно.
Для настройки внешнего вида Вы должны открыть окно настроек и установить
требуемый формат текста. HTML теги обрабатываются корректно.
Доступные флаги приведены в таблице ниже.
@ -218,7 +233,9 @@ links:
### <a href="#lambda" class="anchor" id="lambda"><span class="octicon octicon-link"></span></a>Лямбда функции
Начиная с версии 3.0.0 основной виджет поддерживает лямбда выражения, которые рассчитываются в рантайме. Они объявляются использованием конструкции `${% raw %}${{{% endraw %} {% raw %}}}{% endraw %}`:
Начиная с версии 3.0.0 основной виджет поддерживает лямбда выражения, которые
рассчитываются в рантайме. Они объявляются использованием конструкции
`${% raw %}${{{% endraw %} {% raw %}}}{% endraw %}`:
```javascript
{% raw %}${{{% endraw %}
@ -230,7 +247,8 @@ three()
{% raw %}}}{% endraw %}
```
Функции внутри будут интерпретированы, как JavaScript, любая переменная из основного набора поддерживается. Так, функция:
Функции внутри будут интерпретированы, как JavaScript, любая переменная из
основного набора поддерживается. Так, функция:
```javascript
{% raw %}${{{% endraw %}
@ -245,7 +263,8 @@ colorCpu()
{% raw %}}}{% endraw %}
```
покажет значение `$cpu` красным, если оно больше 90.0, иначе - покажет цветом по-умолчанию. Также поддерживаются произвольные вычисления:
покажет значение `$cpu` красным, если оно больше 90.0, иначе - покажет цветом
по-умолчанию. Также поддерживаются произвольные вычисления:
```javascript
{% raw %}${{{% endraw %}
@ -253,7 +272,10 @@ $down - $up
{% raw %}}}{% endraw %}
```
покажет разность между скоростями загрузки и отдачи. Другая особенность, предоставляемая лямбда выражениями - тег `$this`, который вернет последнее значение данной лямбда функции. Ниже чуть более сложный пример, который покажет бегущую строку "Артист - Название" с длиной меньшей либо равной 10 символам:
покажет разность между скоростями загрузки и отдачи. Другая особенность,
предоставляемая лямбда выражениями - тег `$this`, который вернет последнее
значение данной лямбда функции. Ниже чуть более сложный пример, который покажет
бегущую строку "Артист - Название" с длиной меньшей либо равной 10 символам:
```javascript
{% raw %}${{{% endraw %}
@ -269,31 +291,43 @@ runningLine()
{% raw %}}}{% endraw %}
```
Таким образом, лямбда выражения могут быть использованы, например, чтобы показывать произвольное значение, которое будет рассчитано в рантайме, или, чтобы показать различную информацию, в зависимости от некоторых условий. Однако, пожалуйста, учитывайте, что подобные вычисления в рантайме могут увеличить нагрузку на CPU.
Таким образом, лямбда выражения могут быть использованы, например, чтобы
показывать произвольное значение, которое будет рассчитано в рантайме, или,
чтобы показать различную информацию, в зависимости от некоторых условий. Однако,
пожалуйста, учитывайте, что подобные вычисления в рантайме могут увеличить
нагрузку на CPU.
### <a href="#advanced" class="anchor" id="advanced"><span class="octicon octicon-link"></span></a>Расширенные настройки
**Включить фон:** Снимите галочку, чтобы отключить стандартный фон виджета и установить прозрачный. По умолчанию `true`.
**Включить фон:** Снимите галочку, чтобы отключить стандартный фон виджета и
установить прозрачный. По умолчанию `true`.
**Переводить строки:** Переводить или нет строковые теги. По умолчанию `true`.
**Заменить символ перевода строки:** Заменить `\n` на `&#60;br&#62;`. По умолчанию `false`.
**Заменить символ перевода строки:** Заменить `\n` на `&#60;br&#62;`. По
умолчанию `false`.
**Перенос слов:** Включить перенос слов. По умолчанию `false`.
**Включить всплывающие сообщения:** Снимите галочку, если вы не хотите всплывающих сообщений на системные события. По умолчанию `true`.
**Включить всплывающие сообщения:** Снимите галочку, если вы не хотите
всплывающих сообщений на системные события. По умолчанию `true`.
**Проверять обновления:** Проверять или нет обновления при запуске. По умолчанию `true`.
**Проверять обновления:** Проверять или нет обновления при запуске. По умолчанию
`true`.
**Высота виджета:** Отключит автоматическое определение высоты виджета и установит ее в данное значение. По умолчанию `0` (автоматически).
**Высота виджета:** Отключит автоматическое определение высоты виджета и
установит ее в данное значение. По умолчанию `0` (автоматически).
**Ширина виджета:** Отключит автоматическое определение ширины виджета и установит ее в данное значение. По умолчанию `0` (автоматически).
**Ширина виджета:** Отключит автоматическое определение ширины виджета и
установит ее в данное значение. По умолчанию `0` (автоматически).
**Интервал обновления:** Интервал обновления виджета, мс. По умолчанию `1000`.
**Очередь сообщений:** Использовать указанное количество тредов в пуле. `0` означает идеальное количество тредов. По умолчанию `0`.
**Очередь сообщений:** Использовать указанное количество тредов в пуле. `0`
означает идеальное количество тредов. По умолчанию `0`.
**Температурные единицы:** Выберете единицы температуры. Доступные единицы следующие: Цельсий, Фаренгейт и Кельвин.
**Температурные единицы:** Выберете единицы температуры. Доступные единицы
следующие: Цельсий, Фаренгейт и Кельвин.
**Свой формат времени:**
@ -332,29 +366,42 @@ runningLine()
| `$mm` | Минуты аптайма. |
| `$m` | Минуты аптайма без нуля. |
**AC online тег:** Строка, которая будет показана, когда AC онлайн. По умолчанию `(*)`.
**AC online тег:** Строка, которая будет показана, когда AC онлайн. По умолчанию
`(*)`.
**AC offline тег:** Строка, которая будет показана, когда AC оффлайн. По умолчанию `( )`.
**AC offline тег:** Строка, которая будет показана, когда AC оффлайн. По
умолчанию `( )`.
### <a href="#tooltips" class="anchor" id="tooltips"><span class="octicon octicon-link"></span></a>Тултипы
Начиная с версии 1.7.0, поля CPU, частота CPU, память, swap, сеть и батарея поддерживают графический тултип (всплывающая подсказка). Чтобы включить их, просто поставьте нужные галочки. Число хранимых значений может быть установлено во вкладке. Также есть возможность настроить цвета графиков.
Начиная с версии 1.7.0, поля CPU, частота CPU, память, swap, сеть и батарея
поддерживают графический тултип (всплывающая подсказка). Чтобы включить их,
просто поставьте нужные галочки. Число хранимых значений может быть установлено
во вкладке. Также есть возможность настроить цвета графиков.
### <a href="#deguiconf" class="anchor" id="deguiconf"><span class="octicon octicon-link"></span></a>Настройка DataEngine
**Устройства ACPI:** Путь к устройствам ACPI. По умолчанию `/sys/class/power_supply/`.
**Устройство GPU:** Выберете одно из поддерживаемых устройств GPU. `auto` включит автоматическое определение устройства, `disable` отключит все мониторы GPU. По умолчанию `auto`.
**Устройство GPU:** Выберете одно из поддерживаемых устройств GPU. `auto`
включит автоматическое определение устройства, `disable` отключит все мониторы
GPU. По умолчанию `auto`.
**HDD:** Выберете один из HDD для монитора температуры HDD. `all` включит монитор для всех доступных устройств, `disable` отключит монитор температуры HDD. По умолчанию `all`.
**HDD:** Выберете один из HDD для монитора температуры HDD. `all` включит
монитор для всех доступных устройств, `disable` отключит монитор температуры HDD.
По умолчанию `all`.
**Команда hddtemp:** Введите команду, которая будет запущена для hddtemp DataEngine. По умолчанию `sudo hddtemp`.
**Команда hddtemp:** Введите команду, которая будет запущена для hddtemp
DataEngine. По умолчанию `sudo hddtemp`.
**Количество символов для плеера:** Количество символов, которые будут показываться в динамических тегах плеера.
**Количество символов для плеера:** Количество символов, которые будут
показываться в динамических тегах плеера.
**Музыкальный плеер:** Выберете один из поддерживаемых музыкальных плееров для соответствующего поля.
**Музыкальный плеер:** Выберете один из поддерживаемых музыкальных плееров для
соответствующего поля.
**MPRIS:** Выберете имя плеера MPRIS. `auto` включит автоматическое определение плеера. По умолчанию `auto`.
**MPRIS:** Выберете имя плеера MPRIS. `auto` включит автоматическое определение
плеера. По умолчанию `auto`.
**Адрес MPD:** Адрес MPD сервера. По умолчанию `localhost`.
@ -362,25 +409,32 @@ runningLine()
### <a href="#desktoppanel" class="anchor" id="desktoppanel"><span class="octicon octicon-link"></span></a>Desktop panel
Начиная с версии 1.11.0 виджеты предоставляют панель для мониторинга за рабочими столами. И да, он выглядит, как аналогичная панель в Awesome.
Начиная с версии 1.11.0 виджеты предоставляют панель для мониторинга за рабочими
столами. И да, он выглядит, как аналогичная панель в Awesome.
### <a href="#dpconf" class="anchor" id="dpconf"><span class="octicon octicon-link"></span></a>Настройка Desktop panel
**Включить фон:** Снимите галочку, чтобы отключить стандартный фон виджета и установить прозрачный. По умолчанию `true`.
**Включить фон:** Снимите галочку, чтобы отключить стандартный фон виджета и
установить прозрачный. По умолчанию `true`.
**Вертикальная разметка:** Использовать вертикальную разметку вместо горизонтальной. По умолчанию `false`.
**Вертикальная разметка:** Использовать вертикальную разметку вместо
горизонтальной. По умолчанию `false`.
**Высота виджета:** Отключит автоматическое определение высоты виджета и установит ее в данное значение. По умолчанию `0` (автоматически).
**Высота виджета:** Отключит автоматическое определение высоты виджета и
установит ее в данное значение. По умолчанию `0` (автоматически).
**Ширина виджета:** Отключит автоматическое определение ширины виджета и установит ее в данное значение. По умолчанию `0` (автоматически).
**Ширина виджета:** Отключит автоматическое определение ширины виджета и
установит ее в данное значение. По умолчанию `0` (автоматически).
**Метка** Введите символ (или строку), которая будет показана, если данный рабочий стол сейчас активен.
**Метка** Введите символ (или строку), которая будет показана, если данный
рабочий стол сейчас активен.
**Тип тултипа:** Тип превью, по умолчанию `Окна`.
**Ширина тултипа:** Ширина тултипа в пикселях. По умолчанию `200px`.
**Цвет тултипа:** Цвет, который будет использован в некоторых типах тултипа. По умолчанию `#ffffff`.
**Цвет тултипа:** Цвет, который будет использован в некоторых типах тултипа.
По умолчанию `#ffffff`.
**Теги шаблона**

View File

@ -17,7 +17,11 @@ links:
---
<!-- info block -->
Плазмоид, написанный на `CPP` который показывает случайные карты из Brian Eno и Peter Schmidt's [Oblique Strategies](//en.wikipedia.org/wiki/Oblique_strategies "Wiki"). Это форк [апплета для GNOME](//gnome-look.org/content/show.php/Oblique+Strategies?content=78405 "gnome-look") с некоторыми дополнительными фичами.
Плазмоид, написанный на `CPP` который показывает случайные карты из Brian Eno и
Peter Schmidt's [Oblique Strategies](//en.wikipedia.org/wiki/Oblique_strategies
"Wiki"). Это форк [апплета для GNOME]
(//gnome-look.org/content/show.php/Oblique+Strategies?content=78405 "gnome-look")
с некоторыми дополнительными фичами.
<!--more-->
@ -37,7 +41,8 @@ links:
### <a href="#instruction" class="anchor" id="instruction"><span class="octicon octicon-link"></span></a>Инструкция
* Скачайте [архив](//github.com/arcan1s/oblikuestrategies/releases "GitHub") с актуальной версией исходных файлов.
* Скачайте [архив](//github.com/arcan1s/oblikuestrategies/releases "GitHub") с
актуальной версией исходных файлов.
* Извлеките из него файлы и установите приложение. Для глобальной установки наберите:
```bash
@ -64,7 +69,8 @@ links:
kquitapp plasma-desktop && sleep 2 && plasma-desktop
```
Также Вам может потребоваться запустить `kbuildsycoca4`, чтобы распознать `*.desktop` файл:
Также Вам может потребоваться запустить `kbuildsycoca4`, чтобы распознать
`*.desktop` файл:
```bash
kbuildsycoca4 &> /dev/null

View File

@ -58,7 +58,8 @@ Parameters:
### <a href="#instruction" class="anchor" id="instruction"><span class="octicon octicon-link"></span></a>Инструкция
* Скачайте [архив](//github.com/arcan1s/queued/releases "GitHub") с актуальной версией исходных файлов.
* Скачайте [архив](//github.com/arcan1s/queued/releases "GitHub") с актуальной
версией исходных файлов.
* Извлеките из него файлы и установите приложение:
```bash
@ -97,7 +98,8 @@ systemctl start queued
systemctl enable queued
```
Но Вы можете изменить путь к конфигурационному файлу или изменить параметры. Для этого, скопируйте (рекомендуется) исходный конфигурационный файл
Но Вы можете изменить путь к конфигурационному файлу или изменить параметры. Для
этого, скопируйте (рекомендуется) исходный конфигурационный файл
```bash
cp /etc/queued.conf /новый/путь/к/queued.conf
@ -124,15 +126,18 @@ ExecStart=/usr/bin/queued -c /path/to/new/queued.conf
### <a href="#adding" class="anchor" id="adding"><span class="octicon octicon-link"></span></a>Добавление задачи
1. Создайте скрипт с командой (например, с именем `script.sh`).
2. Создайте файл с приоритетом (`script.sh.pr`) для данной задачи, если это необходимо.
3. Создайте файл с именем пользователя (`script.sh.user`) для данной задачи, если это необходимо
2. Создайте файл с приоритетом (`script.sh.pr`) для данной задачи, если это
необходимо.
3. Создайте файл с именем пользователя (`script.sh.user`) для данной задачи, если
это необходимо
4. Скопируйте файлы в `$WORKDIR`
Также Вы можете воспользоваться `add_queued`.
## <a href="#configuration" class="anchor" id="configuration"><span class="octicon octicon-link"></span></a>Настройка
Все настройки хранятся в `/etc/queued.conf`. После редактирования, Вы должны перезапустить демон
Все настройки хранятся в `/etc/queued.conf`. После редактирования, Вы должны
перезапустить демон
```bash
systemctl restart queued

View File

@ -21,11 +21,16 @@ links:
---
<!-- info block -->
Графическая оболочка для `netctl` (набор скриптов для поднятия сети в Arch'е). Написана на `C++` с использованием библиотеки `Qt`. На текущим момент умеет работать с профилями, в том числе создавать новые, а также умеет подключаться к WiFi. Также предоставляет библиотеку для взаимодействия с netctl и виджет и DataEngine для KDE.
Графическая оболочка для `netctl` (набор скриптов для поднятия сети в Arch'е).
Написана на `C++` с использованием библиотеки `Qt`. На текущим момент умеет
работать с профилями, в том числе создавать новые, а также умеет подключаться к
WiFi. Также предоставляет библиотеку для взаимодействия с netctl, виджет и
DataEngine для KDE.
<!--more-->
**ВНИМАНИЕ:** [НУЖНЫ ПЕРЕВОДЧИКИ!](//github.com/arcan1s/netctl-gui/issues/3 "Тикет")
**ВНИМАНИЕ:** [НУЖНЫ ПЕРЕВОДЧИКИ!](//github.com/arcan1s/netctl-gui/issues/3
"Тикет")
```bash
$ netctl-gui --help
@ -92,8 +97,10 @@ netctlgui-helper [ options ]
### <a href="#instruction" class="anchor" id="instruction"><span class="octicon octicon-link"></span></a>Инструкция
* Скачайте [архив](//github.com/arcan1s/netctl-gui/releases "GitHub") с актуальной версией исходных файлов.
* Извлеките из него файлы и установите приложение. Если Вы хотите установить в `/`, Вы должны запустить как root:
* Скачайте [архив](//github.com/arcan1s/netctl-gui/releases "GitHub") с
актуальной версией исходных файлов.
* Извлеките из него файлы и установите приложение. Если Вы хотите установить в
`/`, Вы должны запустить как root:
```bash
cd /путь/к/распакованному/архиву
@ -115,9 +122,11 @@ netctlgui-helper [ options ]
* `-DBUILD_DOCS:BOOL=0` - не собирать документацию разработчика
* `-DBUILD_TEST:BOOL=1` - собирать авто тесты для библиотеки и хелпера
* свойства проекта:
* `-DDBUS_SYSTEMCONF_PATH=/etc/dbus-1/system.d/` - путь к системный файлам конфигурации DBus
* `-DDBUS_SYSTEMCONF_PATH=/etc/dbus-1/system.d/` - путь к системный
файлам конфигурации DBus
* `-DSYSTEMD_SERVICE_PATH=lib/systemd/system` - путь к сервису systemd
* `-DUSE_CAPABILITIES:BOOL=0` - не использовать setcap, чтобы дать необходимые привилегии хелперу
* `-DUSE_CAPABILITIES:BOOL=0` - не использовать setcap, чтобы дать
необходимые привилегии хелперу
* `-DBUILD_KDE4:BOOL=1` - собирать виджет под KDE4 вместо KF5
* `-DUSE_QT5:BOOL=0` - использовать Qt4 вместо Qt5
@ -140,26 +149,34 @@ netctlgui-helper [ options ]
<!-- howto block -->
## <a href="#howto" class="anchor" id="howto"><span class="octicon octicon-link"></span></a>Использование
Просто запустите приложение `netctl-gui`. Если потребуется (и если Вы используете KDE), можете добавить виджет `netctl`, предоставляемый приложением.
Просто запустите приложение `netctl-gui`. Если потребуется (и если Вы
используете KDE), можете добавить виджет `netctl`, предоставляемый приложением.
<!-- end of howto block -->
<!-- config block -->
## <a href="#config" class="anchor" id="config"><span class="octicon octicon-link"></span></a>Настройка
Рекомендуется использовать графический интерфейс для настройки. Конфигурационные файлы:
Рекомендуется использовать графический интерфейс для настройки. Конфигурационные
файлы:
* Графический интерфейс и хелпер
* `$HOME/.config/netctl-gui.conf` - пользовательские настройки GUI/хелпера
* `/etc/netctl-gui.conf` - системные настройки хелпера
* DataEngine (KDE4 версия)
* `$KDEHOME/share/config/plasma-dataengine-netctl.conf` - пользовательские настройки DataEngine
* `$KDESYSTEM/share/config/plasma-dataengine-netctl.conf` - системные настройки DataEngine
* `$KDEHOME/share/config/plasma-dataengine-netctl.conf` - пользовательские
настройки DataEngine
* `$KDESYSTEM/share/config/plasma-dataengine-netctl.conf` - системные
настройки DataEngine
* DataEngine (KF5 версия)
* `$HOME/.config/plasma-dataengine-netctl.conf` - пользовательские настройки DataEngine
* `$HOME/.config/plasma-dataengine-netctl.conf` - пользовательские настройки
DataEngine
* `/etc/xdg/plasma-dataengine-netctl.conf` - системные настройки DataEngine
Для настройки виджета и DataEngine рекомендуется использовать графический интерфейс. Все настройки графического интерфейса хранятся в `$HOME/.config/netctl-gui.conf`. Для редактирования настоятельно рекомендуется использовать графический интерфейс.
Для настройки виджета и DataEngine рекомендуется использовать графический
интерфейс. Все настройки графического интерфейса хранятся в
`$HOME/.config/netctl-gui.conf`. Для редактирования настоятельно рекомендуется
использовать графический интерфейс.
<!-- end of config block -->

View File

@ -15,7 +15,11 @@ links:
---
<!-- info block -->
Приложение/библиотека, написанное на Qt, которое позволяет пользователям отправлять багрепорт для проектов, расположенных на GitHub. Оно может работать как через [GitHub](//github.com "GitHub"), так и через [GitReports](//gitreports.com "GitReports"). Работает нормально, однако данное приложение было создано as proof-of-concept.
Приложение/библиотека, написанное на Qt, которое позволяет пользователям
отправлять багрепорт для проектов, расположенных на GitHub. Оно может работать
как через [GitHub](//github.com "GitHub"), так и через [GitReports]
(//gitreports.com "GitReports"). Работает нормально, однако данное приложение
было создано as proof-of-concept.
<!--more-->
@ -34,9 +38,11 @@ links:
## <a href="#install" class="anchor" id="install"><span class="octicon octicon-link"></span></a>Установка
### <a href="#instruction" class="anchor" id="instruction"><span class="octicon octicon-link"></span></a>Инструкция
### <a href="#singleapp" class="anchor" id="singleapp"><span class="octicon octicon-link"></span></a>Сборка, как отдельное приложение
* Скачайте [архив](//github.com/arcan1s/reportabug/releases "GitHub") с актуальной версией исходных файлов.
#### <a href="#singleapp" class="anchor" id="singleapp"><span class="octicon octicon-link"></span></a>Сборка, как отдельное приложение
* Скачайте [архив](//github.com/arcan1s/reportabug/releases "GitHub") с
актуальной версией исходных файлов.
* Извлеките из него файлы и настройте под себя.
* Установите приложение:
@ -48,9 +54,10 @@ links:
sudo make install
```
### <a href="#aslibrary" class="anchor" id="aslibrary"><span class="octicon octicon-link"></span></a>Сборка, как библиотека в проекте
#### <a href="#aslibrary" class="anchor" id="aslibrary"><span class="octicon octicon-link"></span></a>Сборка, как библиотека в проекте
* Скачайте [архив](//github.com/arcan1s/reportabug/releases "GitHub") с актуальной версией исходных файлов.
* Скачайте [архив](//github.com/arcan1s/reportabug/releases "GitHub") с
актуальной версией исходных файлов.
* Извлеките из него файлы и настройте под себя.
* Включите библиотеку в Ваш проект. Например, если Вы используете `cmake`:
@ -86,7 +93,8 @@ links:
* automoc4 *(make)*
* cmake *(make)*
* doxygen *(make, документация)*
* qt5-webkit (если используется Qt5) **или** qtwebkit (если используется Qt4) *(опционально, требуется для модуля GitReports)*
* qt5-webkit (если используется Qt5) **или** qtwebkit (если используется Qt4)
*(опционально, требуется для модуля GitReports)*
<!-- end of install block -->
@ -95,16 +103,22 @@ links:
### <a href="#github" class="anchor" id="github"><span class="octicon octicon-link"></span></a>Модуль GitHub
Данный модуль создает тикет, используя [GitHub API](//developer.github.com/v3/issues/ "Документация"). Данный модуль требует авторизации пользователя. Типичный POST запрос выглядит так:
Данный модуль создает тикет, используя [GitHub API](//developer.github.com/v3/issues/
"Документация"). Данный модуль требует авторизации пользователя. Типичный POST
запрос выглядит так:
```bash
curl -X POST -u user:pass -d '{"title":"A new bug","body":"Some error occurs"}' \
//api.github.com/repos/owner/repo/issues
```
Для того, чтобы отключить данный модуль, используйте `-DENABLE_GITHUB=0` флаг cmake.
Для того, чтобы отключить данный модуль, используйте `-DENABLE_GITHUB=0` флаг
cmake.
Также данный модуль может отправлять запросы, используя токен разработчика. Пожалуйста, посетите [данную страницу](//github.com/settings/applications "Настройки") и сгенерируйте токен. Требуемые права для токена - **public_repo** (или **repo**, если Вы используете для приватных репозиториев).
Также данный модуль может отправлять запросы, используя токен разработчика.
Пожалуйста, посетите [данную страницу](//github.com/settings/applications
"Настройки") и сгенерируйте токен. Требуемые права для токена - **public_repo**
(или **repo**, если Вы используете для приватных репозиториев).
**Имейте в виду, что передача токена в открытом виде может скомпрометировать его!**
@ -115,43 +129,61 @@ curl -X POST -H "Authorization: token token" -d '{"title":"A new bug","body":"So
//api.github.com/repos/owner/repo/issues
```
Для того, чтобы включить данный модуль, используйте `-DOWN_GITHUB_TOKEN=STRING` флаг cmake.
Для того, чтобы включить данный модуль, используйте `-DOWN_GITHUB_TOKEN=STRING`
флаг cmake.
Данный модуль требует наличия в системе `QtNetwork`.
### <a href="#gitreports" class="anchor" id="gitreports"><span class="octicon octicon-link"></span></a>Модуль GitReports
Данный модуль создает тикет, используя возможности [GitReports](//gitreports.com/about "GitReports"). Пожалуйста, посетите [данную страницу](//gitreports.com/ "GitReports") и настройте под Ваши репозитории.
Данный модуль создает тикет, используя возможности [GitReports]
(//gitreports.com/about "GitReports"). Пожалуйста, посетите [данную страницу]
(//gitreports.com/ "GitReports") и настройте под Ваши репозитории.
Для того, чтобы отключить данный модуль, используйте `-DENABLE_GITREPORT=0` флаг cmake. Данный модуль требует наличия в системе `QtNetwork` и `QtWebKit`.
Для того, чтобы отключить данный модуль, используйте `-DENABLE_GITREPORT=0` флаг
cmake. Данный модуль требует наличия в системе `QtNetwork` и `QtWebKit`.
<!-- end of howto block -->
<!-- config block -->
## <a href="#config" class="anchor" id="config"><span class="octicon octicon-link"></span></a>Настройка
Для настройки перед компиляцией отредактируйте хидер `src/config.h`. Также Вы можете подгрузить параметры автоматически, используя массив `params` (необходимые ключи такие же, как и для хидера).
Для настройки перед компиляцией отредактируйте хидер `src/config.h`. Также Вы
можете подгрузить параметры автоматически, используя массив `params`
(необходимые ключи такие же, как и для хидера).
### <a href="#mainconfig" class="anchor" id="mainconfig"><span class="octicon octicon-link"></span></a>Основные настройки
* `OWNER` - владелец репозитория.
* `PROJECT` - имя проекта.
* `TAG_BODY` - тело тикета по умолчанию. Может быть использовано в обоих модулях.
* `TAG_TITLE` - имя тикета по умолчанию. Может быть использовано только в модуле GitHub.
* `TAG_ASSIGNEE` - прикрепить тикет к данному аккаунту. Может быть использовано только в модуле GitHub. Данный тег будет работать, только если пользователь имеет права на запись. Если будет пустым, будет проигнорировано.
* `TAG_LABELS` - установить данные метки тикету. Метки должны быть разделены запятыми. Может быть использовано только в модуле GitHub. Данный тег будет работать, только если пользователь имеет права на запись. Если будет пустым, будет проигнорировано.
* `TAG_MILESTONE` - установить данную веху тикету. Может быть использовано только в модуле GitHub. Данный тег будет работать, только если пользователь имеет права на запись. Если будет пустым, будет проигнорировано.
* `TAG_TITLE` - имя тикета по умолчанию. Может быть использовано только в модуле
GitHub.
* `TAG_ASSIGNEE` - прикрепить тикет к данному аккаунту. Может быть использовано
только в модуле GitHub. Данный тег будет работать, только если пользователь имеет
права на запись. Если будет пустым, будет проигнорировано.
* `TAG_LABELS` - установить данные метки тикету. Метки должны быть разделены
запятыми. Может быть использовано только в модуле GitHub. Данный тег будет
работать, только если пользователь имеет права на запись. Если будет пустым,
будет проигнорировано.
* `TAG_MILESTONE` - установить данную веху тикету. Может быть использовано только
в модуле GitHub. Данный тег будет работать, только если пользователь имеет права
на запись. Если будет пустым, будет проигнорировано.
### <a href="#githubconfig" class="anchor" id="githubconfig"><span class="octicon octicon-link"></span></a>Настройки модуля GitHub
* `GITHUB_COMBOBOX` - текст модуля в ComboBox.
* `ISSUES_URL` - URL, в большинстве случаев, не редактируйте его. По умолчанию `//api.github.com/repos/$OWNER/$PROJECT/issues`. Доступные теги `$PROJECT`, `$OWNER`.
* `ISSUES_URL` - URL, в большинстве случаев, не редактируйте его. По умолчанию
`//api.github.com/repos/$OWNER/$PROJECT/issues`. Доступные теги `$PROJECT`,
`$OWNER`.
### <a href="#gitreportsconfig" class="anchor" id="gitreportsconfig"><span class="octicon octicon-link"></span></a>Настройки модуля GitReports
* `CAPTCHA_URL` - URL капчи, в большинстве случаев, не редактируйте его. По умолчанию `//gitreports.com/simple_captcha?code=`.
* `CAPTCHA_URL` - URL капчи, в большинстве случаев, не редактируйте его. По
умолчанию `//gitreports.com/simple_captcha?code=`.
* `GITREPORT_COMBOBOX` - текст модуля в ComboBox.
* `PUBLIC_URL` - URL, в большинстве случаев, не редактируйте его. По умолчанию `//gitreports.com/issue/$OWNER/$PROJECT`. Доступные теги `$PROJECT`, `$OWNER`.
* `PUBLIC_URL` - URL, в большинстве случаев, не редактируйте его. По умолчанию
`//gitreports.com/issue/$OWNER/$PROJECT`. Доступные теги `$PROJECT`, `$OWNER`.
<!-- end of config block -->