From 2ab20938297d8e408931524cd24ebe154bfc8e4f Mon Sep 17 00:00:00 2001 From: arcan1s Date: Tue, 26 Jan 2016 11:45:49 +0300 Subject: [PATCH] rewrite project pages to md --- projects/awesome-widgets.html | 914 ---------------------------- projects/awesome-widgets.md | 418 +++++++++++++ projects/git-etc.html | 188 ------ projects/git-etc.md | 181 ++++++ projects/netctl-gui.html | 206 ------- projects/netctl-gui.md | 203 +++++++ projects/oblikuestrategies.html | 106 ---- projects/oblikuestrategies.md | 107 ++++ projects/queued.html | 169 ------ projects/queued.md | 153 +++++ projects/reportabug.html | 161 ----- projects/reportabug.md | 157 +++++ ru/projects/awesome-widgets.html | 915 ----------------------------- ru/projects/awesome-widgets.md | 421 +++++++++++++ ru/projects/git-etc.html | 188 ------ ru/projects/git-etc.md | 181 ++++++ ru/projects/netctl-gui.html | 209 ------- ru/projects/netctl-gui.md | 206 +++++++ ru/projects/oblikuestrategies.html | 107 ---- ru/projects/oblikuestrategies.md | 108 ++++ ru/projects/queued.html | 170 ------ ru/projects/queued.md | 154 +++++ ru/projects/reportabug.html | 161 ----- ru/projects/reportabug.md | 157 +++++ 24 files changed, 2446 insertions(+), 3494 deletions(-) delete mode 100644 projects/awesome-widgets.html create mode 100644 projects/awesome-widgets.md delete mode 100644 projects/git-etc.html create mode 100644 projects/git-etc.md delete mode 100644 projects/netctl-gui.html create mode 100644 projects/netctl-gui.md delete mode 100644 projects/oblikuestrategies.html create mode 100644 projects/oblikuestrategies.md delete mode 100644 projects/queued.html create mode 100644 projects/queued.md delete mode 100644 projects/reportabug.html create mode 100644 projects/reportabug.md delete mode 100644 ru/projects/awesome-widgets.html create mode 100644 ru/projects/awesome-widgets.md delete mode 100644 ru/projects/git-etc.html create mode 100644 ru/projects/git-etc.md delete mode 100644 ru/projects/netctl-gui.html create mode 100644 ru/projects/netctl-gui.md delete mode 100644 ru/projects/oblikuestrategies.html create mode 100644 ru/projects/oblikuestrategies.md delete mode 100644 ru/projects/queued.html create mode 100644 ru/projects/queued.md delete mode 100644 ru/projects/reportabug.html create mode 100644 ru/projects/reportabug.md diff --git a/projects/awesome-widgets.html b/projects/awesome-widgets.html deleted file mode 100644 index 5670339..0000000 --- a/projects/awesome-widgets.html +++ /dev/null @@ -1,914 +0,0 @@ ---- -hastr: true -layout: project -title: Awesome Widgets -short: awesome-widgets -tags: python, kde, qt, linux, system, awesome -hasgui: true -hasdocs: false -developers: - - Evgeniy Alekseev - - Ernesto Avilés Vzqz (Spanish translation) - - Mermouy (French translation) - - underr (Brazillian Portuguese translation) - - Виктор Слободян (Ukrainian translation) - - Lemueler (Chinese translation) - - Heimen Stoffels (Dutch translation) -license: GPLv3 -links: - - Plasmoid page on kde-look.org - - DataEngine page on kde-look.org - - Archlinux AUR package - - openSUSE package (thanks to Kott) - - Ubuntu package - - Migration to version 2.0 - - Extensions ---- - -

Information

-

A collection of minimalistic easily configurable Plasmoids written on C++/Qt. They look like widgets in Awesome WM. Also this packages has an additional system DataEngine.

- -

NOTE: LOOKING FOR TRANSLATORS!

-

PLASMA 5 COMPATIBLE!

- -

Developers and contributors

- - -

License

- - -

Changelog

-

CHANGELOG

- - - -

Installation

- -

Instruction

- - -

Dependencies

-

I want note that all were tested on latest version of dependencies.

- - - - -

How to use

-

Open your Plasma widgets and select Awesome Widget.

- -

Tips & tricks

-

You may use different colours inside. Just put label text into html code. See issue for more details.

- - - -

Configuration

- -

DataEngine configuration

-

You may edit DataEngine configuration. It is /etc/xdg/plasma-dataengine-extsysmon.conf and $HOME/.config/plasma-dataengine-extsysmon.conf. Uncomment needed line and edit it.

- -

DataEngine options

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ACPIPATHPath to ACPI devices. Default is /sys/class/power_supply/.
GPUDEVSet GPU device. May be nvidia (for nVidia), ati (for ATI Radeon), disable or auto. Default is auto.
HDDDEVSet block device for hddtemp comma separated or use all. disable will disable HDD temperature monitor. Default is all.
HDDTEMPCMDA command which will be run for hddtemp DataEngine. Default is sudo hddtemp. Supported applications are hddtemp and smartmontools.
MPDADDRESSMPD host address. Default is localhost.
MPDPORTMPD host port. Default is 6600.
PLAYERSet music player. Supported players are mpd and MPRIS/DBus supported. disable will disable this monitor.
PLAYERSYMBOLSSelect symbols count for dynamic player tags. Default is 10.
- -

Widget configuration

-

For edited output you must open Settings window and setup output format. HTML tags work normally.

- -

Available flags are in the table below.
-NOTE The numbering of all arrays in variables starts at 0.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeTagDescriptionSince
Time$timeTime in default format. For example, fri Nov 6 04:48:01 2013.1.5.1
$isotimeTime in ISO format.1.5.2
$shorttimeTime in short locale format.1.5.2
$longtimeTime in long locale format.1.5.2
$ctimeWill enable custom time format.2.0.0
Uptime$uptimeSystem uptime, ---d--h--m.
$cuptimeWill enable custom uptime format.2.0.0
Load average$la1Load average over 1 min, -----.2.4.0
$la5Load average over 5 min, -----.2.4.0
$la15Load average over 15 min, -----.2.4.0
CPU$cpuTotal load CPU, %, -----.
$cpuNLoad CPU for core N, %, -----.1.7.0
CPU clock$cpuclAverage CPU clock, MHz, ----.1.1.2
$cpuclNCPU clock for core N, MHz, ----.1.7.0
Temperature$tempNTemperature for device N, ----. For example, $temp0.
GPU$gpuGPU usage, %, -----. aticonfig or nvidia-smi must be installed.1.3.2
GPU temperature$gputempGPU temperature, ----. aticonfig or nvidia-smi must be installed.1.3.2
Memory$memMemory usage, %, -----.
$memmbMemory usage, MB, -----.1.1.1
$memgbMemory usage, GB, ----.1.7.3
$memfreembFree memory, MB, -----.2.0.0
$memfreegbFree memory, GB, ----.2.0.0
$memtotmbRAM, MB, -----.1.10.0
$memtotgbRAM, GB, ----.1.10.0
$memusedmbUsed and cached memory, MB, -----.2.0.0
$memusedgbUsed and cached memory, GB, ----.2.0.0
Swap$swapSwap usage, %, -----.
$swapmbSwap usage, MB, -----.1.1.1
$swapgbSwap usage, GB, ----.1.7.3
$swapfreembFree swap, MB, -----.2.0.0
$swapfreegbFree swap, GB, ----.2.0.0
$swaptotmbSwap, MB, -----.1.10.0
$swaptotgbSwap, GB, ----.1.10.0
HDD usage$hddNUsage for mount point N, %, -----. For example $hdd0.1.3.2
$hddmbNUsage for mount point N, MB, -----. For example $hddmb0.1.8.0
$hddgbNUsage for mount point N, GB, -----. For example $hddgb0.1.8.0
$hddfreembNFree space for mount point N, MB, -----. For example $hddfreemb0.2.0.0
$hddfreegbNFree space for mount point N, GB, -----. For example $hddfreegb0.2.0.0
$hddtotmbNTotal size of mount point N, MB, -----. For example $hddtotmb0.1.10.0
$hddtotgbNTotal size of mount point N, GB, -----. For example $hddtotgb0.1.10.0
HDD speed$hddrNRead speed of disk N, KB/s, -----. For example $hddr0.1.9.0
$hddwNWrite speed of disk N, KB/s, -----. For example $hddw0.1.9.0
HDD temperature$hddtempNTemperature for HDD N, ----. For example $hddtemp0. hddtemp or smartmontools must be installed.1.7.0
Network$downDownload speed for active device, KB/s or MB/s, ----.1.7.0
$downkbDownload speed for active device, KB/s, ----.3.0.0
$downunitsDownload speed units for active device, ----.3.0.0
$downNDownload speed for device N, KB/s or MB/s, ----.2.2.0
$downkbNDownload speed for device N, KB/s, ----.3.0.0
$downunitsNDownload speed units for device N, ----.3.0.0
$upUpload speed for active device, KB/s or MB/s, ----.1.7.0
$upkbUpload speed for active device, KB/s, ----.3.0.0
$upunitsUpload speed units for active device, ----.3.0.0
$upNUpload speed for device N, KB/s or MB/s, ----.2.2.0
$upkbNUpload speed for device N, KB/s, ----.3.0.0
$upunitsNUpload speed units for device N, ----.3.0.0
$netdevCurrent network device.1.1.1
Battery$batAverage battery charge, %, ---.
$batNBattery N charge, %, ---.2.0.3
$acStatus of AC device. Returns (*) if AC device is online or ( ) if offline.
Music player$albumCurrent song album. One of supported music players must be installed.1.5.3
$dalbumCurrent song album with fixed symbols count shown as a running line.3.0.0
$salbumCurrent song album with fixed symbols count shown with three dots at the end.3.0.0
$artistCurrent song artist. One of supported music players must be installed.1.5.0
$dartistCurrent song artist with fixed symbols count shown as a running line.3.0.0
$sartistCurrent song artist with fixed symbols count shown with three dots at the end.3.0.0
$durationCurrent song duration. One of supported music players must be installed.2.0.0
$progressCurrent song progress. One of supported music players must be installed.1.5.3
$titleCurrent song title. One of supported music players must be installed.1.5.0
$dtitleCurrent song title with fixed symbols count shown as a running line.3.0.0
$stitleCurrent song title with fixed symbols count shown with three dots at the end.3.0.0
Process$psList of running processes comma separated.1.8.0
$pscountNumber of running processes.1.8.0
$pstotalTotal number of processes.1.8.0
Package manager$pkgcountNNumber of packages, which available to upgrade for command N.1.8.0
Custom$customNGet output from custom command N. For example $custom0.1.9.0
Desktop$desktopName of the current desktop.2.0.0
$ndesktopNumber of the current desktop.2.0.0
$tdesktopsTotal number of desktops.2.0.0
Quotes$askNGet ask for ticker N. For example $ask0.2.2.2
$askchgNGet absolute ask change for ticker N. For example $askchg0.2.2.2
$percaskchgNGet ask change for ticker N, %. For example $percaskchg0.2.2.2
$bidNGet bid for ticker N. For example $bid0.2.2.2
$bidchgNGet absolute bid change for ticker N, %. For example $bidchg0.2.2.2
$percbidchgNGet bid change for ticker N. For example $percbidchg0.2.2.2
$priceNGet price for ticker N. For example $price0.2.2.2
$pricechgNGet absolute price change for ticker N. For example $pricechg0.2.2.2
$percaskchgNGet price change for ticker N, %. For example $percpricechg0.2.2.2
Weather$weatherIdNNumerical weather ID. For example $weatherId0.2.4.0
$weatherNWeather status. For example $weather0.2.4.0
$humidityNHumidity, %. For example $humidity0.2.4.0
$pressureNPressure, bars. For example $pressure0.2.4.0
$temperatureNTemperature. For example $temperature0.2.4.0
- -

Lambda functions

-

Since version 3.0.0 the main widgets supports lambda functions, which are calculated at runtime. It may be declared by using ${{ }} construction:

- -{% highlight javascript %} -{% raw %}${{{% endraw %} -function three() -{ - return 1+2; -} -three() -{% raw %}}}{% endraw %} -{% endhighlight %} - -

A functions inside will be interpret as JavaScript ones, any variables from main body is supported, thus the following function:

- -{% highlight javascript %} -{% raw %}${{{% endraw %} -function colorCpu() -{ - if ($cpu > 90.0) - return "$cpu" - else - return "$cpu" -} -colorCpu() -{% raw %}}}{% endraw %} -{% endhighlight %} - -

will show $cpu value in red if it is more than 90.0, otherwise it will be shown in default colour. Any calculations are also supported:

- -{% highlight javascript %} -{% raw %}${{{% endraw %} -$down - $up -{% raw %}}}{% endraw %} -{% endhighlight %} - -

will show difference between download and upload speed. Another feature provided by lambda functions is $this value which returns the last value of the lambda function. Here is a little more complicated example which will show running line "Artist - Title" with length less or equal than 20 symbols:

- -{% highlight javascript %} -{% raw %}${{{% endraw %} -function runningLine() { - var current = "$artist - $title"; - var index = current.indexOf("$this"); - if (("$this" == "") || ((index + 20 + 1) > current.length)) - return current.substring(0, 20); - else - return current.substring(index + 1, index + 20 + 1); -} -runningLine() -{% raw %}}}{% endraw %} -{% endhighlight %} - -

Thus this feature may be used for example to show any custom values which will be calculated in runtime and to show different information depending on some conditions. But please keep in mind that such runtime calculation may increase CPU load.

- -

Advanced settings

-

Enable background: Uncheck to disable default background and set transparent one. Default is true.

- -

Translate strings: Translate strings tags. Default is true.

- -

Wrap new lines: Replace \n to <br>. Default is false.

- -

Word wrap: Enable word wrap. Default is false.

- -

Enable popup: Uncheck box if you do not want popup messages on system events. Default is true.

- -

Check updates: Check updates on load. Default is true.

- -

Widget height: Disable automatic widget height definition and set it to this value. Default is 0 (auto).

- -

Widget width: Disable automatic widget width definition and set it to this value. Default is 0 (auto).

- -

Update interval: Widget update interval. Default is 1000.

- -

Queue limit: Use thread pool with this maximum thread counts. 0 means CPU ideal thread count. Default is 0.

- -

Temperature units: Select units for temperature. Available units are Celsius, Farenheit, Kelvin, Reaumur, cm^-1, kJ/mol, kcal/mol.

- -

Custom time format:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
$ddddWeekday in long format.
$dddWeekday in short format.
$ddDay.
$dDay without zero.
$MMMMMonth in long format.
$MMMMonth in short format.
$MMMonth.
$MMonth without zero.
$yyyyYear.
$yyYear in short format.
$hhHours.
$hHours without zero.
$HHHours in 24-hours format.
$HHours in 24-hours format without zero.
$mmMinutes.
$mMinutes without zero.
$ssSeconds.
$sSeconds without zero.
$tTimezone name.
$a/$apam or pm.
$A/$APAM or PM.
- -

Custom uptime format:

- - - - - - - - - - - - - - - - - - - - - - - - - -
$ddUptime days.
$dUptime days without zero.
$hhUptime hours.
$hUptime hours without zero.
$mmUptime minutes.
$mUptime minutes without zero.
- -

AC online tag: Line which will be shown when AC is online. Default is (*).

- -

AC offline tag: Line which will be shown when AC is offline. Default is ( ).

- -

Tooltips

-

Since version 1.7.0 CPU, CPU clock, memory, swap, network and battery support graphical tooltip. To enable them just select required fields. The number of stored values can be set in the tab. Colours of the graphs are configurable too.

- -

DataEngine settings

-

ACPI path: Path to ACPI devices. The file /sys/class/power_supply/.

- -

GPU device: Select one of supported GPU devices. auto will enable auto selection, disable will disable all GPU monitors. Default is auto.

- -

HDD: Select one of HDDs for HDD temperature monitor. all will enable monitor for all devices, disable will disable HDD temperature monitor. Default is all.

- -

hddtemp cmd: Type a command which will be run for hddtemp DataEngine. Default is sudo smartctl -a.

- -

Player symbol count: Symbol count for dynamic player tags.

- -

Music player: Select one of supported music players for player label.

- -

MPRIS: Select MPRIS player name. auto will enable auto selection. Default is auto.

- -

MPD address: Address of MPD server. Default is localhost.

- -

MPD port: Port of MPD server. Default is 6600.

- -

Desktop Panel

-

Since version 1.11.0 it provides a minimalistic panel for monitoring on desktops. And yes, it looks like the same panel in Awesome.

- -

Desktop panel configuration

-

Enable background: Uncheck to disable default background and set transparent one. Default is true.

- -

Vertical layout: Use vertical layout instead of horizontal one. Default is false.

- -

Widget height: Disable automatic widget height definition and set it to this value. Default is 0 (auto).

- -

Widget width: Disable automatic widget width definition and set it to this value. Default is 0 (auto).

- -

Mark: Type symbol (or string) which will be shown if this desktop is active now.

- -

Tooltip type: Select tooltip type. Default is windows.

- -

Tooltip width: Using tooltip width in px. Default is 200px.

- -

Color of tooltip: Colour which is used in some tooltip types. Default is #ffffff.

- -

Pattern tags

- - - - - - - - - - - - - - - - - -
$markShow mark if this desktop is active. Shows spaces in other way.
$nameName of the desktop.
$numberNumber of the desktop.
$totalTotal number of desktops.
- - - -

Graphical user interface

- -

Screenshots

-
- {% assign scrdesc = "Widget (clickable)" %} - {% assign scrname = "awesomewidgets_widget" %} - {% include prj_scr.html %} - {% assign scrdesc = "Configuration window" %} - {% assign scrname = "awesomewidgets_config_01" %} - {% include prj_scr.html %} - {% assign scrdesc = "Configuration window" %} - {% assign scrname = "awesomewidgets_config_02" %} - {% include prj_scr.html %} - {% assign scrdesc = "Configuration window" %} - {% assign scrname = "awesomewidgets_config_03" %} - {% include prj_scr.html %} - {% assign scrdesc = "Configuration window" %} - {% assign scrname = "awesomewidgets_config_04" %} - {% include prj_scr.html %} - {% assign scrdesc = "Configuration window" %} - {% assign scrname = "awesomewidgets_config_05" %} - {% include prj_scr.html %} - {% assign scrdesc = "Tooltips" %} - {% assign scrname = "awesomewidgets_tooltips" %} - {% include prj_scr.html %} -
diff --git a/projects/awesome-widgets.md b/projects/awesome-widgets.md new file mode 100644 index 0000000..3125377 --- /dev/null +++ b/projects/awesome-widgets.md @@ -0,0 +1,418 @@ +--- +hastr: true +layout: project +title: Awesome Widgets +short: awesome-widgets +tags: python, kde, qt, linux, system, awesome +hasgui: true +hasdocs: false +developers: + - Evgeniy Alekseev + - Ernesto Avilés Vzqz (Spanish translation) + - Mermouy (French translation) + - underr (Brazillian Portuguese translation) + - Виктор Слободян (Ukrainian translation) + - Lemueler (Chinese translation) + - Heimen Stoffels (Dutch translation) +license: GPLv3 +links: + - Plasmoid page on kde-look.org + - DataEngine page on kde-look.org + - Archlinux AUR package + - openSUSE package (thanks to Kott) + - Ubuntu package + - Migration to version 2.0 + - Extensions +--- + +## Information + +A collection of minimalistic easily configurable Plasmoids written on `C++/Qt`. They look like widgets in [Awesome WM](//awesome.naquadah.org/ "Awesome Homepage"). Also this packages has an additional system [DataEngine](//techbase.kde.org/Development/Tutorials/Plasma/DataEngines "Developers tutorial"). + +**NOTE:** [LOOKING FOR TRANSLATORS!](//github.com/arcan1s/awesome-widgets/issues/14 "Ticket") + +**PLASMA 5 COMPATIBLE!** + +### Developers and contributors + +{% for devel in page.developers %} +* {{ devel }}{% endfor %} + +### License + +* {{ page.license }} + +### Changelog + +[CHANGELOG](//github.com/arcan1s/awesome-widgets/blob/master/CHANGELOG "GitHub") + + + + +## Installation + +### Instruction + +* Download an [archive](//github.com/arcan1s/awesome-widgets/releases "GitHub") with latest version of source files. +* Extract it and install: + + ```bash + cd /where/is/applet/ + mkdir build && cd build + cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr ../ + make + sudo make install + ``` + + **NOTE:** on Plasma 5 it very likely requires `-DKDE_INSTALL_USE_QT_SYS_PATHS=ON` flag + +### Dependencies + +I want note that all were tested on latest version of dependencies. + +* plasma-framework +* cmake *(make)* +* extra-cmake-modules *(make)* +* hddtemp **or** smartmontools *(optional, for HDD temperature monitor)* +* one of supported music player *(optional, for music player monitor)* +* proprietary video driver *(optional, for GPU monitor)* + + + + +## How to use + +Open your Plasma widgets and select `Awesome Widget`. + +### Tips & tricks + +You may use different colours inside. Just put label text into html code. See [issue](//github.com/arcan1s/awesome-widgets/issues/9 "GitHub") for more details. + + + + +## Configuration + +### DataEngine configuration + +You may edit DataEngine configuration. It is `/etc/xdg/plasma-dataengine-extsysmon.conf` and `$HOME/.config/plasma-dataengine-extsysmon.conf`. Uncomment needed line and edit it. + +#### DataEngine options + +| | | +|----------|-----------| +| ACPIPATH | Path to ACPI devices. Default is `/sys/class/power_supply/`. | +| GPUDEV | Set GPU device. May be `nvidia` (for nVidia), `ati` (for ATI Radeon), `disable` or `auto`. Default is `auto`. | +| HDDDEV | Set block device for `hddtemp` comma separated or use `all`. `disable` will disable HDD temperature monitor. Default is `all`. | +| HDDTEMPCMD | A command which will be run for hddtemp DataEngine. Default is `sudo hddtemp`. Supported applications are `hddtemp` and `smartmontools`. | +| MPDADDRESS | MPD host address. Default is `localhost`. | +| MPDPORT | MPD host port. Default is `6600`. | +| PLAYER | Set music player. Supported players are mpd and MPRIS/DBus supported. `disable` will disable this monitor. | +| PLAYERSYMBOLS | Select symbols count for dynamic player tags. Default is `10`. | + +### Widget configuration + +For edited output you must open Settings window and setup output format. HTML tags work normally. + +Available flags are in the table below. + +**NOTE** The numbering of all arrays in variables starts at 0. + +| Tag | Description | Since | +|-----|-------------|-------| +| `$time` | Time in default format. For example, `fri Nov 6 04:48:01 2013`. | 1.5.1 | +| `$isotime` | Time in ISO format. | 1.5.2 | +| `$shorttime` | Time in short locale format. | 1.5.2 | +| `$longtime` | Time in long locale format. | 1.5.2 | +| `$ctime` | Will enable custom time format. | 2.0.0 | +| `$uptime` | System uptime, `---d--h--m`. | +| `$cuptime` | Will enable custom uptime format. | 2.0.0 | +| `$la1` | Load average over 1 min, `-----`. | 2.4.0 | +| `$la5` | Load average over 5 min, `-----`. | 2.4.0 | +| `$la15` | Load average over 15 min, `-----`. | 2.4.0 | +| `$cpu` | Total load CPU, %, `-----`. | +| `$cpuN` | Load CPU for core N, %, `-----`. | 1.7.0 | +| `$cpucl` | Average CPU clock, MHz, `----`. | 1.1.2 | +| `$cpuclN` | CPU clock for core N, MHz, `----`. | 1.7.0 | +| `$tempN` | Temperature for device N, `----`. For example, `$temp0`. | +| `$gpu` | GPU usage, %, `-----`. `aticonfig` or `nvidia-smi` must be installed. | 1.3.2 | +| `$gputemp` | GPU temperature, `----`. `aticonfig` or `nvidia-smi` must be installed. | 1.3.2 | +| `$mem` | Memory usage, %, `-----`. | +| `$memmb` | Memory usage, MB, `-----`. | 1.1.1 | +| `$memgb` | Memory usage, GB, `----`. | 1.7.3 | +| `$memfreemb` | Free memory, MB, `-----`. | 2.0.0 | +| `$memfreegb` | Free memory, GB, `----`. | 2.0.0 | +| `$memtotmb` | RAM, MB, `-----`. | 1.10.0 | +| `$memtotgb` | RAM, GB, `----`. | 1.10.0 | +| `$memusedmb` | Used and cached memory, MB, `-----`. | 2.0.0 | +| `$memusedgb` | Used and cached memory, GB, `----`. | 2.0.0 | +| `$swap` | Swap usage, %, `-----`. | +| `$swapmb` | Swap usage, MB, `-----`. | 1.1.1 | +| `$swapgb` | Swap usage, GB, `----`. | 1.7.3 | +| `$swapfreemb` | Free swap, MB, `-----`. | 2.0.0 | +| `$swapfreegb` | Free swap, GB, `----`. | 2.0.0 | +| `$swaptotmb` | Swap, MB, `-----`. | 1.10.0 | +| `$swaptotgb` | Swap, GB, `----`. | 1.10.0 | +| `$hddN` | Usage for mount point N, %, `-----`. For example `$hdd0`. | 1.3.2 | +| `$hddmbN` | Usage for mount point N, MB, `-----`. For example `$hddmb0`. | 1.8.0 | +| `$hddgbN` | Usage for mount point N, GB, `-----`. For example `$hddgb0`. | 1.8.0 | +| `$hddfreembN` | Free space for mount point N, MB, `-----`. For example `$hddfreemb0`. | 2.0.0 | +| `$hddfreegbN` | Free space for mount point N, GB, `-----`. For example `$hddfreegb0`. | 2.0.0 | +| `$hddtotmbN` | Total size of mount point N, MB, `-----`. For example `$hddtotmb0`. | 1.10.0 | +| `$hddtotgbN` | Total size of mount point N, GB, `-----`. For example `$hddtotgb0`. | 1.10.0 | +| `$hddrN` | Read speed of disk N, KB/s, `-----`. For example `$hddr0`. | 1.9.0 | +| `$hddwN` | Write speed of disk N, KB/s, `-----`. For example `$hddw0`. | 1.9.0 | +| `$hddtempN` | Temperature for HDD N, `----`. For example `$hddtemp0`. `hddtemp` or `smartmontools` must be installed. | 1.7.0 | +| `$down` | Download speed for active device, KB/s or MB/s, `----`. | 1.7.0 | +| `$downkb` | Download speed for active device, KB/s, `----`. | 3.0.0 | +| `$downunits` | Download speed units for active device, `----`. | 3.0.0 | +| `$downN` | Download speed for device N, KB/s or MB/s, `----`. | 2.2.0 | +| `$downkbN` | Download speed for device N, KB/s, `----`. | 3.0.0 | +| `$downunitsN` | Download speed units for device N, `----`. | 3.0.0 | +| `$up` | Upload speed for active device, KB/s or MB/s, `----`. | 1.7.0 | +| `$upkb` | Upload speed for active device, KB/s, `----`. | 3.0.0 | +| `$upunits` | Upload speed units for active device, `----`. | 3.0.0 | +| `$upN` | Upload speed for device N, KB/s or MB/s, `----`. | 2.2.0 | +| `$upkbN` | Upload speed for device N, KB/s, `----`. | 3.0.0 | +| `$upunitsN` | Upload speed units for device N, `----`. | 3.0.0 | +| `$netdev` | Current network device. | 1.1.1 | +| `$bat` | Average battery charge, %, `---`. | +| `$batN` | Battery N charge, %, `---`. | 2.0.3 | +| `$ac` | Status of AC device. Returns `(*)` if AC device is online or `( )` if offline. | +| `$album` | Current song album. One of supported music players must be installed. | 1.5.3 | +| `$dalbum` | Current song album with fixed symbols count shown as a running line. | 3.0.0 | +| `$salbum` | Current song album with fixed symbols count shown with three dots at the end. | 3.0.0 | +| `$artist` | Current song artist. One of supported music players must be installed. | 1.5.0 | +| `$dartist` | Current song artist with fixed symbols count shown as a running line. | 3.0.0 | +| `$sartist` | Current song artist with fixed symbols count shown with three dots at the end. | 3.0.0 | +| `$duration` | Current song duration. One of supported music players must be installed. | 2.0.0 | +| `$progress` | Current song progress. One of supported music players must be installed. | 1.5.3 | +| `$title` | Current song title. One of supported music players must be installed. | 1.5.0 | +| `$dtitle` | Current song title with fixed symbols count shown as a running line. | 3.0.0 | +| `$stitle` | Current song title with fixed symbols count shown with three dots at the end. | 3.0.0 | +| `$ps` | List of running processes comma separated. | 1.8.0 | +| `$pscount` | Number of running processes. | 1.8.0 | +| `$pstotal` | Total number of processes. | 1.8.0 | +| `$pkgcountN` | Number of packages, which available to upgrade for command N. | 1.8.0 | +| `$customN` | Get output from custom command N. For example `$custom0`. | 1.9.0 | +| `$desktop` | Name of the current desktop. | 2.0.0 | +| `$ndesktop` | Number of the current desktop. | 2.0.0 | +| `$tdesktops` | Total number of desktops. | 2.0.0 | +| `$askN` | Get ask for ticker N. For example `$ask0`. | 2.2.2 | +| `$askchgN` | Get absolute ask change for ticker N. For example `$askchg0`. | 2.2.2 | +| `$percaskchgN` | Get ask change for ticker N, %. For example `$percaskchg0`. | 2.2.2 | +| `$bidN` | Get bid for ticker N. For example `$bid0`. | 2.2.2 | +| `$bidchgN` | Get absolute bid change for ticker N, %. For example `$bidchg0`. | 2.2.2 | +| `$percbidchgN` | Get bid change for ticker N. For example `$percbidchg0`. | 2.2.2 | +| `$priceN` | Get price for ticker N. For example `$price0`. | 2.2.2 | +| `$pricechgN` | Get absolute price change for ticker N. For example `$pricechg0`. | 2.2.2 | +| `$percaskchgN` | Get price change for ticker N, %. For example `$percpricechg0`. | 2.2.2 | +| `$weatherIdN` | Numerical weather ID. For example `$weatherId0`. | 2.4.0 | +| `$weatherN` | Weather status. For example `$weather0`. | 2.4.0 | +| `$humidityN` | Humidity, %. For example `$humidity0`. | 2.4.0 | +| `$pressureN` | Pressure, bars. For example `$pressure0`. | 2.4.0 | +| `$temperatureN` | Temperature. For example `$temperature0`. | 2.4.0 | + +##### Lambda functions + +Since version 3.0.0 the main widgets supports lambda functions, which are calculated at runtime. It may be declared by using `{% raw %}${{{% endraw %} {% raw %}}}{% endraw %}` construction: + +```javascript +{% raw %}${{{% endraw %} +function three() +{ + return 1+2; +} +three() +{% raw %}}}{% endraw %} +``` + +A functions inside will be interpret as JavaScript ones, any variables from main body is supported, thus the following function: + +```javascript +{% raw %}${{{% endraw %} +function colorCpu() +{ + if ($cpu > 90.0) + return "$cpu" + else + return "$cpu" +} +colorCpu() +{% raw %}}}{% endraw %} +``` + +will show `$cpu` value in red if it is more than 90.0, otherwise it will be shown in default colour. Any calculations are also supported: + +```javascript +{% raw %}${{{% endraw %} +$down - $up +{% raw %}}}{% endraw %} +``` + +will show difference between download and upload speed. Another feature provided by lambda functions is `$this` value which returns the last value of the lambda function. Here is a little more complicated example which will show running line "Artist - Title" with length less or equal than 20 symbols: + +```javascript +{% raw %}${{{% endraw %} +function runningLine() { + var current = "$artist - $title"; + var index = current.indexOf("$this"); + if (("$this" == "") || ((index + 20 + 1) > current.length)) + return current.substring(0, 20); + else + return current.substring(index + 1, index + 20 + 1); +} +runningLine() +{% raw %}}}{% endraw %} +``` + +Thus this feature may be used for example to show any custom values which will be calculated in runtime and to show different information depending on some conditions. But please keep in mind that such runtime calculation may increase CPU load. + +##### Advanced settings + +**Enable background:** Uncheck to disable default background and set transparent one. Default is `true`. + +**Translate strings:** Translate strings tags. Default is `true`. + +**Wrap new lines:** Replace `\n` to `<br>`. Default is `false`. + +**Word wrap:** Enable word wrap. Default is `false`. + +**Enable popup:** Uncheck box if you do not want popup messages on system events. Default is `true`. + +**Check updates:** Check updates on load. Default is `true`. + +**Widget height:** Disable automatic widget height definition and set it to this value. Default is `0` (auto). + +**Widget width:** Disable automatic widget width definition and set it to this value. Default is `0` (auto). + +**Update interval:** Widget update interval. Default is `1000`. + +**Queue limit:** Use thread pool with this maximum thread counts. `0` means CPU ideal thread count. Default is `0`. + +**Temperature units:** Select units for temperature. Available units are Celsius, Farenheit, Kelvin, Reaumur, cm^-1, kJ/mol, kcal/mol. + +**Custom time format:** + +| | | +|---------|-------------------------| +| `$dddd` | Weekday in long format. | +| `$ddd` | Weekday in short format. | +| `$dd` | Day. | +| `$d` | Day without zero. | +| `$MMMM` | Month in long format. | +| `$MMM` | Month in short format. | +| `$MM` | Month. | +| `$M` | Month without zero. | +| `$yyyy` | Year. | +| `$yy` | Year in short format. | +| `$hh` | Hours. | +| `$h` | Hours without zero. | +| `$HH` | Hours in 24-hours format. | +| `$H` | Hours in 24-hours format without zero. | +| `$mm` | Minutes. | +| `$m` | Minutes without zero. | +| `$ss` | Seconds. | +| `$s` | Seconds without zero. | +| `$t` | Timezone name. | +| `$a`/`$ap` | am or pm. | +| `$A`/`$AP` | AM or PM. | + +**Custom uptime format:** + +| | | +|-------|--------------| +| `$dd` | Uptime days. | +| `$d` | Uptime days without zero. | +| `$hh` | Uptime hours. | +| `$h` | Uptime hours without zero. | +| `$mm` | Uptime minutes. | +| `$m` | Uptime minutes without zero. | + +**AC online tag:** Line which will be shown when AC is online. Default is `(*)`. + +**AC offline tag:** Line which will be shown when AC is offline. Default is `( )`. + +#### Tooltips + +Since version 1.7.0 CPU, CPU clock, memory, swap, network and battery support graphical tooltip. To enable them just select required fields. The number of stored values can be set in the tab. Colours of the graphs are configurable too. + +#### DataEngine settings + +**ACPI path:** Path to ACPI devices. The file `/sys/class/power_supply/`. + +**GPU device:** Select one of supported GPU devices. `auto` will enable auto selection, `disable` will disable all GPU monitors. Default is `auto`. + +**HDD:** Select one of HDDs for HDD temperature monitor. `all` will enable monitor for all devices, `disable` will disable HDD temperature monitor. Default is `all`. + +**hddtemp cmd:** Type a command which will be run for hddtemp DataEngine. Default is `sudo smartctl -a`. + +**Player symbol count:** Symbol count for dynamic player tags. + +**Music player:** Select one of supported music players for player label. + +**MPRIS:** Select MPRIS player name. `auto` will enable auto selection. Default is `auto`. + +**MPD address:** Address of MPD server. Default is `localhost`. + +**MPD port:** Port of MPD server. Default is `6600`. + +### Desktop Panel +Since version 1.11.0 it provides a minimalistic panel for monitoring on desktops. And yes, it looks like the same panel in Awesome. + +##### Desktop panel configuration + +**Enable background:** Uncheck to disable default background and set transparent one. Default is `true`. + +**Vertical layout:** Use vertical layout instead of horizontal one. Default is `false`. + +**Widget height:** Disable automatic widget height definition and set it to this value. Default is `0` (auto). + +**Widget width:** Disable automatic widget width definition and set it to this value. Default is `0` (auto). + +**Mark:** Type symbol (or string) which will be shown if this desktop is active now. + +**Tooltip type:** Select tooltip type. Default is `windows`. + +**Tooltip width:** Using tooltip width in px. Default is `200px`. + +**Color of tooltip:** Colour which is used in some tooltip types. Default is `#ffffff`. + +**Pattern tags** + +| | | +|---------|---------| +| `$mark` | Show mark if this desktop is active. Shows spaces in other way. | +| `$name` | Name of the desktop. | +| `$number` | Number of the desktop. | +| `$total` | Total number of desktops. | + + + +## Graphical user interface + +## Screenshots + +
+ {% assign scrdesc = "Widget (clickable)" %} + {% assign scrname = "awesomewidgets_widget" %} + {% include prj_scr.html %} + {% assign scrdesc = "Configuration window" %} + {% assign scrname = "awesomewidgets_config_01" %} + {% include prj_scr.html %} + {% assign scrdesc = "Configuration window" %} + {% assign scrname = "awesomewidgets_config_02" %} + {% include prj_scr.html %} + {% assign scrdesc = "Configuration window" %} + {% assign scrname = "awesomewidgets_config_03" %} + {% include prj_scr.html %} + {% assign scrdesc = "Configuration window" %} + {% assign scrname = "awesomewidgets_config_04" %} + {% include prj_scr.html %} + {% assign scrdesc = "Configuration window" %} + {% assign scrname = "awesomewidgets_config_05" %} + {% include prj_scr.html %} + {% assign scrdesc = "Tooltips" %} + {% assign scrname = "awesomewidgets_tooltips" %} + {% include prj_scr.html %} +
diff --git a/projects/git-etc.html b/projects/git-etc.html deleted file mode 100644 index e109ca9..0000000 --- a/projects/git-etc.html +++ /dev/null @@ -1,188 +0,0 @@ ---- -hastr: true -layout: project -title: git-etc -short: git-etc -tags: git, python, qt, linux, daemon, system -hasgui: true -hasdocs: false -developers: - - Evgeniy Alekseev -license: GPLv3 -links: - - Archlinux AUR package ---- - -

Information

-

Simple daemon that automatically creates git repository in the given directory and creates commit at the specified time interval.

- -{% highlight bash %} -$ git-etc --help -Simple daemon written on BASH for monitoring changes in files - -Usage: git-etc [ -c | --config /etc/git-etc.conf ] [ -h | --help ] [ -v | --version ] - -Parametrs: - -c --config - path to configuration file - -h --help - show this help and exit - -v --version - show version and exit - -See "man 1 git-etc" for more details -{% endhighlight %} - -{% highlight bash %} -$ ctrlconf --help -GUI for git-etc daemon - -Usage: ctrlconf [ --default ] [ -h | --help ] [ -v | --version ] - -Additional parametrs: - --default - create default configuration file - -h --help - show this help and exit - -v --version - show version and exit - -See "man 1 ctrlconf" for more details -{% endhighlight %} - -

Developers and contributors

- - -

License

- - - - -

Installation

- -

Instruction

- - -

Dependencies

-

I want note that all were tested on latest version of dependencies.

- - - - -

How to use

-

If you want to start the daemon into /etc just run

- -{% highlight bash %} -systemctl start git-etc -{% endhighlight %} - -

If you want to enable daemon autoload run

- -{% highlight bash %} -systemctl enable git-etc -{% endhighlight %} - -

But you may change path to configuration file or change parameters. To do it just copy (recommended) the source configuration file to new path

- -{% highlight bash %} -cp /etc/git-etc.conf /new/path/to/file/git-etc.conf -{% endhighlight %} - -

and edit it. Then copy the source service file to /etc:

- -{% highlight bash %} -cp /usr/lib/systemd/system/git-etc.service /etc/systemd/system/git-etc-my-profile.service -{% endhighlight %} - -

Replace following string in the file:

- -{% highlight bash %} -ExecStart=/usr/bin/git-etc -c /etc/git-etc.conf -{% endhighlight %} - -

to

- -{% highlight bash %} -ExecStart=/usr/bin/git-etc -c /new/path/to/file/git-etc.conf -{% endhighlight %} - - - -

Configuration

-

All settings are stored in /etc/git-etc.conf. After edit them you must restart daemon

- -{% highlight bash %} -systemctl restart git-etc -{% endhighlight %} - -

Options

- - - - - - - - - - - - - - - - - -
DIRECTORYFull path to working directory with observed files. Default is /etc.
TIMESLEEPTime interval between updates, hours. It must be integer and >= 1. Default is 12.
IGNORELISTList of files that will not be observed. Separator is ";;". May be empty.
FORALL1 will enable access for normal user. Default is 1.
- - - -

Graphical user interface

-

Control Config (ctrlconf) is GUI for git-etc daemon written on Python2/PyQt4. This application allows you to view a list of commits and changes in files recorded in commit messages. Also, this application allows you to roll back to a specific commit all files (git reset --hard) or individual files (git diff && git apply). And you may merge old and new configuration files (used two branches repository - master and experimental). The application may need root privileges. Make sure that sudo package is installed.

- -

Configuration

-

Just run the application and open the settings window from menu!

- -

Screenshots

-

(Screenshots in Russian, but GUI has English translation.)

- -
- {% assign scrdesc = "Main window" %} - {% assign scrname = "git-etc_mainwindow" %} - {% include prj_scr.html %} - {% assign scrdesc = "About window" %} - {% assign scrname = "git-etc_aboutwindow" %} - {% include prj_scr.html %} - {% assign scrdesc = "Commit window" %} - {% assign scrname = "git-etc_commitwindow" %} - {% include prj_scr.html %} - {% assign scrdesc = "Merging window" %} - {% assign scrname = "git-etc_mergingwindow" %} - {% include prj_scr.html %} - {% assign scrdesc = "Roll back window" %} - {% assign scrname = "git-etc_rollbackwindow" %} - {% include prj_scr.html %} -
- diff --git a/projects/git-etc.md b/projects/git-etc.md new file mode 100644 index 0000000..1259a25 --- /dev/null +++ b/projects/git-etc.md @@ -0,0 +1,181 @@ +--- +hastr: true +layout: project +title: git-etc +short: git-etc +tags: git, python, qt, linux, daemon, system +hasgui: true +hasdocs: false +developers: + - Evgeniy Alekseev +license: GPLv3 +links: + - Archlinux AUR package +--- + +## Information + +Simple daemon that automatically creates git repository in the given directory and creates commit at the specified time interval. + +```bash +$ git-etc --help +Simple daemon written on BASH for monitoring changes in files + +Usage: git-etc [ -c | --config /etc/git-etc.conf ] [ -h | --help ] [ -v | --version ] + +Parametrs: + -c --config - path to configuration file + -h --help - show this help and exit + -v --version - show version and exit + +See "man 1 git-etc" for more details +``` + +```bash +$ ctrlconf --help +GUI for git-etc daemon + +Usage: ctrlconf [ --default ] [ -h | --help ] [ -v | --version ] + +Additional parametrs: + --default - create default configuration file + -h --help - show this help and exit + -v --version - show version and exit + +See "man 1 ctrlconf" for more details +``` + +### Developers and contributors + +{% for devel in page.developers %} +* {{ devel }}{% endfor %} + +### License + +* {{ page.license }} + + + + +## Installation + +### Instruction + +* Download an [archive](//github.com/arcan1s/git-etc/releases "GitHub") with latest version of source files. +* Extract it and install the application: + + ```bash + ./install.sh "/path/to/root" + ``` + + If you want install it to `/` you must run it as root, e.g.: + + ```bash + sudo ./install.sh + ``` + + If no path is specified it will be installed to `/` by default. + +### Dependencies + +I want note that all were tested on latest version of dependencies. + +* Bash (including awk, grep, sed) +* git +* python2 *(make)* +* systemd *(optional, service file)* +* python2-pyqt4 *(optional, GUI)* +* xterm *(optional, GUI)* + + + + +## How to use + +If you want to start the daemon into `/etc` just run + +```bash +systemctl start git-etc +``` + +If you want to enable daemon autoload run + +```bash +systemctl enable git-etc +``` + +But you may change path to configuration file or change parameters. To do it just copy (recommended) the source configuration file to new path + +```bash +cp /etc/git-etc.conf /new/path/to/file/git-etc.conf +``` + +and edit it. Then copy the source service file to `/etc`: + +```bash +cp /usr/lib/systemd/system/git-etc.service /etc/systemd/system/git-etc-my-profile.service +``` + +Replace following string in the file: + +```bash +ExecStart=/usr/bin/git-etc -c /etc/git-etc.conf +``` + +to + +```bash +ExecStart=/usr/bin/git-etc -c /new/path/to/file/git-etc.conf +``` + + + +## Configuration + +All settings are stored in `/etc/git-etc.conf`. After edit them you must restart daemon + +```bash +systemctl restart git-etc +``` + +### Options + +| | | +|------------|-------| +| DIRECTORY | Full path to working directory with observed files. Default is `/etc`. | +| TIMESLEEP | Time interval between updates, hours. It must be integer and >= 1\. Default is `12`. | +| IGNORELIST | List of files that will not be observed. Separator is ";;". May be empty. | +| FORALL | `1` will enable access for normal user. Default is `1`. | + + + +## Graphical user interface + +Control Config (`ctrlconf`) is GUI for `git-etc` daemon written on `Python2/PyQt4`. This application allows you to view a list of commits and changes in files recorded in commit messages. Also, this application allows you to roll back to a specific commit all files (`git reset --hard`) or individual files (`git diff && git apply`). And you may merge old and new configuration files (used two branches repository - master and experimental). The application may need root privileges. Make sure that `sudo` package is installed. + +### Configuration + +Just run the application and open the settings window from menu! + +### Screenshots + +(Screenshots in Russian, but GUI has English translation.) + +
+ {% assign scrdesc = "Main window" %} + {% assign scrname = "git-etc_mainwindow" %} + {% include prj_scr.html %} + {% assign scrdesc = "About window" %} + {% assign scrname = "git-etc_aboutwindow" %} + {% include prj_scr.html %} + {% assign scrdesc = "Commit window" %} + {% assign scrname = "git-etc_commitwindow" %} + {% include prj_scr.html %} + {% assign scrdesc = "Merging window" %} + {% assign scrname = "git-etc_mergingwindow" %} + {% include prj_scr.html %} + {% assign scrdesc = "Roll back window" %} + {% assign scrname = "git-etc_rollbackwindow" %} + {% include prj_scr.html %} +
+ diff --git a/projects/netctl-gui.html b/projects/netctl-gui.html deleted file mode 100644 index a823294..0000000 --- a/projects/netctl-gui.html +++ /dev/null @@ -1,206 +0,0 @@ ---- -hastr: true -layout: project -title: Netctl GUI -short: netctl-gui -tags: archlinux, c++, qt, network, kde, netctl, system, dbus, library -hasgui: true -hasdocs: true -developers: - - Evgeniy Alekseev - - nosada (Japanese translation) -license: GPLv3 -links: - - Page on Softpedia - - Page on kde-apps.org - - AUR package - - DBus API reference - - Security notes ---- - -

Information

-

Graphical interface for netctl (several scripts for work with network connection in Archlinux). It is written on C++ using Qt library. Now it may work with profiles and may create new profiles. Also it may create a connection to WiFi. Moreover, it provides a Qt library for interaction with netctl and widget and DataEngine for KDE4/KF5.

- -

NOTE: LOOKING FOR TRANSLATORS!

- -{% highlight bash %} -$ netctl-gui --help -Usage: -netctl-gui [ options ] -Options: - Open window: - --detached - start detached from console - --maximized - start maximized - --minimized - start minimized to tray - --about - show about window - --netctl-auto - show netctl-auto window - --settings - show settings window - Functions: - -e, --essid - select this ESSID - -o, --open - open this profile - -s, --select - select this profile - Additional flags: - -c, --config - read configuration from this file - -d, --debug - print debug information - --default - start with default settings - --set-opts - set options for this run, comma separated - -t, --tab - open a tab with this number - Show messages: - -v, --version - show version and exit - -i, --info - show build information and exit - -h, --help - show this help and exit -{% endhighlight %} - -{% highlight bash %} -$ netctlgui-helper --help -Usage: -netctlgui-helper [ options ] -Options: - -c, --config - read configuration from this file - -d, --debug - print debug information - --nodaemon - do not start as daemon - --replace - force replace the existing session - --restore - force restore the existing session - --system - do not read user configuration, system-wide only - Show messages: - -v, --version - show version and exit - -i, --info - show build information and exit - -h, --help - show this help and exit -{% endhighlight %} - -

Developers and contributors

-
    - {% for devel in page.developers %} -
  • {{ devel }}
    • - {% endfor %} -
- -

License

-
    -
  • {{ page.license }}
    • -
- -

Changelog

-

CHANGELOG

- - - -

Installation

- -

Instruction

-
    -
  • Download an archive with latest version of source files.
    • -
  • Extract it and install the application. If you want install it into /, you should run as root following commands: - -{% highlight bash %} -cd /path/to/extracted/archive -mkdir build && cd build -cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release ../ -make -sudo make install -{% endhighlight %} - -Available cmake flags are: -
      -
    • components: -
        -
      • -DBUILD_DATAENGINE:BOOL=0 - do not build DataEngine
        • -
      • -DBUILD_GUI:BOOL=0 - do not build GUI
        • -
      • -DBUILD_HELPER:BOOL=0 - do not build helper daemon
        • -
      • -DBUILD_LIBRARY:BOOL=0 - do not build library
        • -
      • -DBUILD_PLASMOID:BOOL=0 - do not build Plasmoid
        • -
      • -
    • additional components: -
        -
      • -DBUILD_DOCS:BOOL=0 - do not build developer documentation
        • -
      • -DBUILD_TEST:BOOL=1 - build auto tests for the library and the helper
        • -
      • -
    • project properties: -
        -
      • -DDBUS_SYSTEMCONF_PATH=/etc/dbus-1/system.d/ - path to DBus system configuration files
        • -
      • -DSYSTEMD_SERVICE_PATH=lib/systemd/system - path to systemd services
        • -
      • -DUSE_CAPABILITIES:BOOL=0 - do not use setcap to get privileges to the helper
        • -
      • -DBUILD_KDE4:BOOL=1 - build plasmoid under KDE4 instead of KF5
        • -
      • -DUSE_QT5:BOOL=0 - use Qt4 instead of Qt5 for GUI
        • -
      • -
    • -
- -

Dependencies

-

I want note that all were tested on latest version of dependencies.

-
    -
  • netctl
    • -
  • qt5-base (if Qt5 is used) or qt4 (if Qt4 is used)
    • -
  • automoc4 (make)
    • -
  • cmake (make)
    • -
  • qt5-tools (make, if Qt5 is used)
    • -
  • kdebase-workspace (optional, KDE4 widget)
    • -
  • plasma-frameworks (optional, KF5 widget)
    • -
  • sudo (optional, sudo support)
    • -
  • wpa_supplicant (optional, WiFi support)
    • -
- - - -

How to use

-

Just run application netctl-gui. If it is needed (and if you use KDE), you may add widget netctl, which provides by the application.

- - - -

Configuration

-

It is recommended to use graphical interface for configuration. Configuration files are:

-
    -
  • $HOME/.config/netctl-gui.conf - GUI/helper user configuration
    • -
  • /etc/netctl-gui.conf - helper system-wide configuration
    • -
      -
    • $KDEHOME/share/config/plasma-dataengine-netctl.conf - DataEngine user configuration
      • -
    • $KDESYSTEM/share/config/plasma-dataengine-netctl.conf - DataEngine system-wide configuration
      • -
    -
      -
    • $HOME/.config/plasma-dataengine-netctl.conf - DataEngine user configuration
      • -
    • /etc/xdg/plasma-dataengine-netctl.conf - DataEngine system-wide configuration
      • -
    -
- - - -

Graphical user interface

-

Graphical interface provides by netctl-gui application.

- -

Screenshots

-
- {% assign scrdesc = "DataEngine" %} - {% assign scrname = "netctl-gui_dataengine" %} - {% include prj_scr.html %} - {% assign scrdesc = "Widget" %} - {% assign scrname = "netctl-gui_plasmoid" %} - {% include prj_scr.html %} - {% assign scrdesc = "Widget settings window" %} - {% assign scrname = "netctl-gui_plasmoid_conf_01" %} - {% include prj_scr.html %} - {% assign scrdesc = "Widget settings window" %} - {% assign scrname = "netctl-gui_plasmoid_conf_02" %} - {% include prj_scr.html %} - {% assign scrdesc = "Widget settings window" %} - {% assign scrname = "netctl-gui_plasmoid_conf_03" %} - {% include prj_scr.html %} - {% assign scrdesc = "Main window" %} - {% assign scrname = "netctl-gui_main" %} - {% include prj_scr.html %} - {% assign scrdesc = "Profile window" %} - {% assign scrname = "netctl-gui_profile" %} - {% include prj_scr.html %} - {% assign scrdesc = "WiFi window" %} - {% assign scrname = "netctl-gui_wifi" %} - {% include prj_scr.html %} - {% assign scrdesc = "About window" %} - {% assign scrname = "netctl-gui_about" %} - {% include prj_scr.html %} - {% assign scrdesc = "netctl-auto window" %} - {% assign scrname = "netctl-gui_netctl-auto" %} - {% include prj_scr.html %} - {% assign scrdesc = "Settings window" %} - {% assign scrname = "netctl-gui_settings" %} - {% include prj_scr.html %} -
- diff --git a/projects/netctl-gui.md b/projects/netctl-gui.md new file mode 100644 index 0000000..1749019 --- /dev/null +++ b/projects/netctl-gui.md @@ -0,0 +1,203 @@ +--- +hastr: true +layout: project +title: Netctl GUI +short: netctl-gui +tags: archlinux, c++, qt, network, kde, netctl, system, dbus, library +hasgui: true +hasdocs: true +developers: + - Evgeniy Alekseev + - nosada (Japanese translation) +license: GPLv3 +links: + - Page on Softpedia + - Page on kde-apps.org + - AUR package + - DBus API reference + - Security notes +--- + +## Information + +Graphical interface for `netctl` (several scripts for work with network connection in Archlinux). It is written on `C++` using `Qt` library. Now it may work with profiles and may create new profiles. Also it may create a connection to WiFi. Moreover, it provides a Qt library for interaction with netctl and widget and DataEngine for KDE4/KF5. + +**NOTE:** [LOOKING FOR TRANSLATORS!](//github.com/arcan1s/netctl-gui/issues/3 "Ticket") + +```bash +$ netctl-gui --help +Usage: +netctl-gui [ options ] +Options: + Open window: + --detached - start detached from console + --maximized - start maximized + --minimized - start minimized to tray + --about - show about window + --netctl-auto - show netctl-auto window + --settings - show settings window + Functions: + -e, --essid - select this ESSID + -o, --open - open this profile + -s, --select - select this profile + Additional flags: + -c, --config - read configuration from this file + -d, --debug - print debug information + --default - start with default settings + --set-opts - set options for this run, comma separated + -t, --tab - open a tab with this number + Show messages: + -v, --version - show version and exit + -i, --info - show build information and exit + -h, --help - show this help and exit +``` + +```bash +$ netctlgui-helper --help +Usage: +netctlgui-helper [ options ] +Options: + -c, --config - read configuration from this file + -d, --debug - print debug information + --nodaemon - do not start as daemon + --replace - force replace the existing session + --restore - force restore the existing session + --system - do not read user configuration, system-wide only + Show messages: + -v, --version - show version and exit + -i, --info - show build information and exit + -h, --help - show this help and exit +``` + +### Developers and contributors + +{% for devel in page.developers %} +* {{ devel }}{% endfor %} + +### License + +* {{ page.license }} + +### Changelog + +[CHANGELOG](//github.com/arcan1s/netctl-gui/blob/master/CHANGELOG "GitHub") + + + + +## Installation + +### Instruction + +* Download an [archive](//github.com/arcan1s/netctl-gui/releases "GitHub") with latest version of source files. +* Extract it and install the application. If you want install it into `/`, you should run as root following commands: + + ```bash + cd /path/to/extracted/archive + mkdir build && cd build + cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release ../ + make + sudo make install + ``` + + Available cmake flags are: + + * components: + * `-DBUILD_DATAENGINE:BOOL=0` - do not build DataEngine + * `-DBUILD_GUI:BOOL=0` - do not build GUI + * `-DBUILD_HELPER:BOOL=0` - do not build helper daemon + * `-DBUILD_LIBRARY:BOOL=0` - do not build library + * `-DBUILD_PLASMOID:BOOL=0` - do not build Plasmoid + * additional components: + * `-DBUILD_DOCS:BOOL=0` - do not build developer documentation + * `-DBUILD_TEST:BOOL=1` - build auto tests for the library and the helper + * project properties: + * `-DDBUS_SYSTEMCONF_PATH=/etc/dbus-1/system.d/` - path to DBus system configuration files + * `-DSYSTEMD_SERVICE_PATH=lib/systemd/system` - path to systemd services + * `-DUSE_CAPABILITIES:BOOL=0` - do not use setcap to get privileges to the helper + * `-DBUILD_KDE4:BOOL=1` - build plasmoid under KDE4 instead of KF5 + * `-DUSE_QT5:BOOL=0` - use Qt4 instead of Qt5 for GUI + +### Dependencies + +I want note that all were tested on latest version of dependencies. + +* netctl +* qt5-base *(if Qt5 is used)* **or** qt4 *(if Qt4 is used)* +* automoc4 *(make)* +* cmake *(make)* +* qt5-tools *(make, if Qt5 is used)* +* kdebase-workspace *(optional, KDE4 widget)* +* plasma-frameworks *(optional, KF5 widget)* +* sudo *(optional, sudo support)* +* wpa_supplicant *(optional, WiFi support)* + + + + +## How to use + +Just run application `netctl-gui`. If it is needed (and if you use KDE), you may add widget `netctl`, which provides by the application. + + + + +## Configuration + +It is recommended to use graphical interface for configuration. Configuration files are: + +* UI and helper + * `$HOME/.config/netctl-gui.conf` - GUI/helper user configuration + * `/etc/netctl-gui.conf` - helper system-wide configuration +* DataEngine (KDE4 version) + * `$KDEHOME/share/config/plasma-dataengine-netctl.conf` - DataEngine user configuration + * `$KDESYSTEM/share/config/plasma-dataengine-netctl.conf` - DataEngine system-wide configuration +* DataEngine (KF5 version) + * `$HOME/.config/plasma-dataengine-netctl.conf` - DataEngine user configuration + * `/etc/xdg/plasma-dataengine-netctl.conf` - DataEngine system-wide configuration + + + + +## Graphical user interface + +Graphical interface provides by `netctl-gui` application. + +### Screenshots + +
+ {% assign scrdesc = "DataEngine" %} + {% assign scrname = "netctl-gui_dataengine" %} + {% include prj_scr.html %} + {% assign scrdesc = "Widget" %} + {% assign scrname = "netctl-gui_plasmoid" %} + {% include prj_scr.html %} + {% assign scrdesc = "Widget settings window" %} + {% assign scrname = "netctl-gui_plasmoid_conf_01" %} + {% include prj_scr.html %} + {% assign scrdesc = "Widget settings window" %} + {% assign scrname = "netctl-gui_plasmoid_conf_02" %} + {% include prj_scr.html %} + {% assign scrdesc = "Widget settings window" %} + {% assign scrname = "netctl-gui_plasmoid_conf_03" %} + {% include prj_scr.html %} + {% assign scrdesc = "Main window" %} + {% assign scrname = "netctl-gui_main" %} + {% include prj_scr.html %} + {% assign scrdesc = "Profile window" %} + {% assign scrname = "netctl-gui_profile" %} + {% include prj_scr.html %} + {% assign scrdesc = "WiFi window" %} + {% assign scrname = "netctl-gui_wifi" %} + {% include prj_scr.html %} + {% assign scrdesc = "About window" %} + {% assign scrname = "netctl-gui_about" %} + {% include prj_scr.html %} + {% assign scrdesc = "netctl-auto window" %} + {% assign scrname = "netctl-gui_netctl-auto" %} + {% include prj_scr.html %} + {% assign scrdesc = "Settings window" %} + {% assign scrname = "netctl-gui_settings" %} + {% include prj_scr.html %} +
+ diff --git a/projects/oblikuestrategies.html b/projects/oblikuestrategies.html deleted file mode 100644 index 75600c0..0000000 --- a/projects/oblikuestrategies.html +++ /dev/null @@ -1,106 +0,0 @@ ---- -hastr: true -layout: project -title: Oblikue strategies -short: oblikuestrategies -tags: qt, c++, kde, linux, fun -hasgui: true -hasdocs: false -developers: - - Evgeniy Alekseev -license: GPL -links: - - Page on kde-look.org - - Archlinux AUR package ---- - -

Information

-

Plasmoid written on CPP that displays a random draw from Brian Eno and Peter Schmidt's Oblique Strategies. It is GNOME applet fork with some of special features.

- -

Developers and contributors

-
    - {% for devel in page.developers %} -
  • {{ devel }}
    • - {% endfor %} -
- -

License

-
    -
  • {{ page.license }}
    • -
- - - -

Installation

- -

Instruction

-
    -
  • Download an archive with latest version of source files.
    • -
  • Extract it and install the application. For global isntallation type: - -{% highlight bash %} -cd /where/is/applet/ -mkdir build && cd build -cmake -DCMAKE_INSTALL_PREFIX=`kde4-config --prefix` -DCMAKE_BUILD_TYPE=Release ../ -make -sudo make install -{% endhighlight %} - -For local isntallation type: - -{% highlight bash %} -cd /where/is/applet/ -mkdir build && cd build -cmake -DCMAKE_INSTALL_PREFIX=`kde4-config --localprefix` -DCMAKE_BUILD_TYPE=Release ../ -make -make install -{% endhighlight %} - -
    • -
  • Restart plasma to load the applet: - -{% highlight bash %} -kquitapp plasma-desktop && sleep 2 && plasma-desktop -{% endhighlight %} - -Also you might need to run kbuildsycoca4 in order to get the *.desktop file recognized: - -{% highlight bash %} -kbuildsycoca4 &> /dev/null -{% endhighlight %} - -
    • -
- -

Dependencies

-

I want note that all were tested on latest version of dependencies.

-
    -
  • kdebase-workspace
    • -
  • automoc4 (make)
    • -
  • cmake (make)
    • -
- - - -

How to use

-

Open your Plasma widgets and select Oblikue strategies.

- - - -

Configuration

-

Right click on widget.

- - - -

Graphical user interface

- -

Screenshots

-
- {% assign scrdesc = "Widget" %} - {% assign scrname = "oblikuestrategies_widget" %} - {% include prj_scr.html %} - {% assign scrdesc = "Configuration window" %} - {% assign scrname = "oblikuestrategies_config" %} - {% include prj_scr.html %} -
- diff --git a/projects/oblikuestrategies.md b/projects/oblikuestrategies.md new file mode 100644 index 0000000..8e8efd3 --- /dev/null +++ b/projects/oblikuestrategies.md @@ -0,0 +1,107 @@ +--- +hastr: true +layout: project +title: Oblikue strategies +short: oblikuestrategies +tags: qt, c++, kde, linux, fun +hasgui: true +hasdocs: false +developers: + - Evgeniy Alekseev +license: GPL +links: + - Page on kde-look.org + - Archlinux AUR package +--- + +## Information + +Plasmoid written on `CPP` that displays a random draw from Brian Eno and Peter Schmidt's [Oblique Strategies](//en.wikipedia.org/wiki/Oblique_strategies "Wiki"). It is [GNOME applet](//gnome-look.org/content/show.php/Oblique+Strategies?content=78405 "gnome-look") fork with some of special features. + +### Developers and contributors + +{% for devel in page.developers %} +* {{ devel }}{% endfor %} + +### License + +* {{ page.license }} + + + + +## Installation + +### Instruction + +* Download an [archive](//github.com/arcan1s/oblikuestrategies/releases "GitHub") with latest version of source files. +* Extract it and install the application. For global isntallation type: + + ```bash + cd /where/is/applet/ + mkdir build && cd build + cmake -DCMAKE_INSTALL_PREFIX=`kde4-config --prefix` -DCMAKE_BUILD_TYPE=Release ../ + make + sudo make install + ``` + + For local installation type: + + ```bash + cd /where/is/applet/ + mkdir build && cd build + cmake -DCMAKE_INSTALL_PREFIX=`kde4-config --localprefix` -DCMAKE_BUILD_TYPE=Release ../ + make + make install + ``` + +* Restart plasma to load the applet: + + ```bash + kquitapp plasma-desktop && sleep 2 && plasma-desktop + ``` + + Also you might need to run `kbuildsycoca4` in order to get the `*.desktop` file recognized: + + ```bash + kbuildsycoca4 &> /dev/null + ``` + +### Dependencies + +I want note that all were tested on latest version of dependencies. + +* kdebase-workspace +* automoc4 *(make)* +* cmake *(make)* + + + + +## How to use + +Open your Plasma widgets and select `Oblikue strategies`. + + + + +## Configuration + +Right click on widget. + + + + +## Graphical user interface + +### Screenshots + +
+ {% assign scrdesc = "Widget" %} + {% assign scrname = "oblikuestrategies_widget" %} + {% include prj_scr.html %} + {% assign scrdesc = "Configuration window" %} + {% assign scrname = "oblikuestrategies_config" %} + {% include prj_scr.html %} +
+ diff --git a/projects/queued.html b/projects/queued.html deleted file mode 100644 index cfb6643..0000000 --- a/projects/queued.html +++ /dev/null @@ -1,169 +0,0 @@ ---- -hastr: true -layout: project -title: queued -short: queued -tags: linux, shell, daemon, system -hasgui: false -hasdocs: false -developers: - - Evgeniy Alekseev -license: GPLv3 -links: ---- - -

Information

-

Daemon for starting jobs to queue of calculations. It was written as proof-of-concept.

- -{% highlight bash %} -$ queued --help -Simple daemon written on BASH for starting jobs to queue of calculations - -Usage: queued [ -c /etc/queued.conf ] [ -v | --version ] [ -h | --help ] -Parametrs: - -c PATH - path to configuration file. Default is '/etc/queued.conf' - - -v --version - show version and exit - -h --help - show this help and exit -{% endhighlight %} - -{% highlight bash %} -$ add_queued --help -add_queued [ -c /etc/queued.conf ] [ -p NUM ] [ -u USER ] [ -h | --help ] /path/to/script - -Parameters: - -c PATH - path to configuration file. Default is '/etc/queued.conf' - -p NUM - job priority - -u USER - username - -h --help - show this help and exit -{% endhighlight %} - -

Developers and contributors

-
    - {% for devel in page.developers %} -
  • {{ devel }}
    • - {% endfor %} -
- -

License

-
    -
  • {{ page.license }}
    • -
- - - -

Installation

- -

Instruction

-
    -
  • Download an archive with latest version of source files.
    • -
  • Extract it and install the application: - -{% highlight bash %} -./install.sh "/path/to/root/" -{% endhighlight %} - -If you want install it to / you must run it as root, e.g.: - -{% highlight bash %} -sudo ./install.sh -{% endhighlight %} - -If no path is specified it will be installed to / by default.
    • -
- -

Dependencies

-

I want note that all were tested on latest version of dependencies.

-
    -
  • Bash (including awk, grep, sed)
    • -
  • systemd (optional, service file)
    • -
- - - -

How to use

-

If you want to start the daemon just run

- -{% highlight bash %} -systemctl start queued -{% endhighlight %} - -

If you want to enable daemon autoload run

- -{% highlight bash %} -systemctl enable queued -{% endhighlight %} - -

But you may change path to configuration file or change parameters. To do it just copy (recommended) the source configuration file to new path

- -{% highlight bash %} -cp /etc/queued.conf /path/to/new/queued.conf -{% endhighlight %} - -

and edit it. Then copy the source service file to /etc:

- -{% highlight bash %} -cp /usr/lib/systemd/system/queued.service /etc/systemd/system/queued-my-profile.service -{% endhighlight %} - -

Replace following string in the file:

- -{% highlight bash %} -ExecStart=/usr/bin/queued -{% endhighlight %} - -

to

- -{% highlight bash %} -ExecStart=/usr/bin/queued -c /path/to/new/queued.conf -{% endhighlight %} - -

Adding a job

-
    -
  1. Create shell script with the command (e.g. it have a name script.sh).
    2. -
  2. Create priority file (script.sh.pr) with the job priority if it is needed.
    3. -
  3. Create user file (script.sh.user) with the job username if it is needed.
    4. -
  4. Copy files to $WORKDIR.
    5. -
-

Also you may use add_queued.

- -

Configuration

-

All settings are stored in /etc/queued.conf. After edit them you must restart daemon

- -{% highlight bash %} -systemctl restart queued -{% endhighlight %} - - - -

Options

- - - - - - - - - - - - - - - - - - - - - - - - - -
WORKDIRFull path to directory with source jobs. Default is /var/lib/queued/work. This directory must contain source scripts script-name, a priority file (it is not necessary) script-name.pr and a file with username (it is not necessary too) script-name.user.
JOBDIRFull path to directory with running jobs. Default is /var/lib/queued/job. All job files will be moved here.
QUEUEFILEFull path to file with queue list. Default is /var/lib/queued/queue.
PRIORITYDefault priority. Default is 0. The higher the value, the higher the priority of the task.
SLEEPTIMETime interval in minutes. Default is 5.
STARTASUSERDefault user. Default is root. This user will own created files.
- - - - diff --git a/projects/queued.md b/projects/queued.md new file mode 100644 index 0000000..49a4b16 --- /dev/null +++ b/projects/queued.md @@ -0,0 +1,153 @@ +--- +hastr: true +layout: project +title: queued +short: queued +tags: linux, shell, daemon, system +hasgui: false +hasdocs: false +developers: + - Evgeniy Alekseev +license: GPLv3 +links: +--- + +## Information + +Daemon for starting jobs to queue of calculations. It was written as proof-of-concept. + +```bash +$ queued --help +Simple daemon written on BASH for starting jobs to queue of calculations + +Usage: queued [ -c /etc/queued.conf ] [ -v | --version ] [ -h | --help ] +Parametrs: + -c PATH - path to configuration file. Default is '/etc/queued.conf' + + -v --version - show version and exit + -h --help - show this help and exit +``` + +```bash +$ add_queued --help +add_queued [ -c /etc/queued.conf ] [ -p NUM ] [ -u USER ] [ -h | --help ] /path/to/script + +Parameters: + -c PATH - path to configuration file. Default is '/etc/queued.conf' + -p NUM - job priority + -u USER - username + -h --help - show this help and exit +``` + +### Developers and contributors + +{% for devel in page.developers %} +* {{ devel }}{% endfor %} + +### License + +* {{ page.license }} + + + + +## Installation + +### Instruction + +* Download an [archive](//github.com/arcan1s/queued/releases "GitHub") with latest version of source files. +* Extract it and install the application: + + ```bash + ./install.sh "/path/to/root/" + ``` + + If you want install it to `/` you must run it as root, e.g.: + + ```bash + sudo ./install.sh + ``` + + If no path is specified it will be installed to `/` by default. + +### Dependencies + +I want note that all were tested on latest version of dependencies. + +* Bash (including awk, grep, sed) +* systemd *(optional, service file)* + + + + +## How to use + +If you want to start the daemon just run + +```bash +systemctl start queued +``` + +If you want to enable daemon autoload run + +```bash +systemctl enable queued +``` + +But you may change path to configuration file or change parameters. To do it just copy (recommended) the source configuration file to new path + +```bash +cp /etc/queued.conf /path/to/new/queued.conf +``` + +and edit it. Then copy the source service file to `/etc`: + +```bash +cp /usr/lib/systemd/system/queued.service /etc/systemd/system/queued-my-profile.service +``` + +Replace following string in the file: + +```bash +ExecStart=/usr/bin/queued +``` + +to + +```bash +ExecStart=/usr/bin/queued -c /path/to/new/queued.conf +``` + +### Adding a job + +1. Create shell script with the command (e.g. it have a name `script.sh`). +2. Create priority file (`script.sh.pr`) with the job priority if it is needed. +3. Create user file (`script.sh.user`) with the job username if it is needed. +4. Copy files to `$WORKDIR`. + +Also you may use `add_queued`. + +## Configuration + +All settings are stored in `/etc/queued.conf`. After edit them you must restart daemon + +```bash +systemctl restart queued +``` + + + +### Options + +| | | +|---------|---------| +| WORKDIR | Full path to directory with source jobs. Default is `/var/lib/queued/work`. This directory must contain source scripts `script-name`, a priority file (it is not necessary) `script-name.pr` and a file with username (it is not necessary too) `script-name.user`. | +| JOBDIR | Full path to directory with running jobs. Default is `/var/lib/queued/job`. All job files will be moved here. | +| QUEUEFILE | Full path to file with queue list. Default is `/var/lib/queued/queue`. | +| PRIORITY | Default priority. Default is `0`. The higher the value, the higher the priority of the task. | +| SLEEPTIME | Time interval in minutes. Default is `5`. | +| STARTASUSER | Default user. Default is `root`. This user will own created files. | + + + + diff --git a/projects/reportabug.html b/projects/reportabug.html deleted file mode 100644 index 75db6d0..0000000 --- a/projects/reportabug.html +++ /dev/null @@ -1,161 +0,0 @@ ---- -hastr: true -layout: project -title: Report a Bug -short: reportabug -tags: qt, c++, library, development -hasgui: false -hasdocs: true -developers: - - Evgeniy Alekseev -license: LGPLv3 -links: ---- - -

Information

-

Qt application/library which allows users to create an issue for projects which are hosted on GitHub. It may work over GitHub or GitReport. It works fine, but it was created as proof-of-concept.

- -

Developers and contributors

-
    - {% for devel in page.developers %} -
  • {{ devel }}
    • - {% endfor %} -
- -

License

-
    -
  • {{ page.license }}
    • -
- - - -

Installation

- -

Instruction

-

Build as a single application

-
    -
  • Download the actual source tarball.
    • -
  • Extract it and set up your configuration.
    • -
  • Install the application: - -{% highlight bash %} -cd /path/to/extracted/archive -mkdir build && cd build -cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release -DBUILD_AS_LIBRARY:BOOL=0 ../ -make -sudo make install -{% endhighlight %} - -
    • -
- -

Build as a library in your project

-
    -
  • Download the actual source tarball.
    • -
  • Extract it and set up your configuration.
    • -
  • include it into your project. For example if you use cmake: - -{% highlight cmake %} -add_subdirectory (reportabug) -{% endhighlight %} - -
    • -
  • Declare class in you sources. For example: - -{% highlight cpp %} -Reportabug *reportWindow = new Reportabug(parent=this, - debugCmd=false, - params=0); -reportWindow->showWindow(); -{% endhighlight %} - -
    • -
  • Link your application with this library.
    • -
- -

Available cmake flags:

-
    -
  • -DBUILD_AS_LIBRARY=0 - build the application but not a library.
    • -
  • -DBUILD_DOCS=1 - build developer documentation.
    • -
  • -DBUILD_SHARED_LIBRARY=1 - build the shared library instead of static one.
    • -
  • -DENABLE_GITHUB=0 - disable GitHub module.
    • -
  • -DENABLE_GITREPORT=0 - disable GitReport module.
    • -
  • -DOWN_GITHUB_TOKEN=STRING - use STRING as own GitHub token.
    • -
  • -DUSE_QT5=0 - use Qt4 instead of Qt5.
    • -
- -

Dependencies

-

I want note that all were tested on latest version of dependencies.

-
    -
  • qt5-base (if Qt5 is used) or qt4 (if Qt4 is used)
    • -
  • qt5-network (if Qt5 is used)
    • -
  • automoc4 (make)
    • -
  • cmake (make)
    • -
  • doxygen (make, documentation)
    • -
  • qt5-webkit (if Qt5 is used) or qtwebkit (if Qt4 is used) (optional, required by GitReports module)
    • -
- - - -

How to use

-

GitHub module

- -

This module creates an issue over GitHub. GitHub API is used for creating issue. User should type own username and password. The typical POST request is:

- -{% highlight bash %} -curl -X POST -u user:pass -d '{"title":"A new bug","body":"Some error occurs"}' \ - //api.github.com/repos/owner/repo/issues -{% endhighlight %} - -

To disable this module use -DENABLE_GITHUB=0 cmake flag.

- -

This module may send request using developer's token too. Please visit this page and generate a new one. Needed scopes are public_repo (or repo if you will use it for a private repository).
-Please keep in mind that passing the token in the clear, you may discredit your account.

- -

The typical POST request is:

- -{% highlight bash %} -curl -X POST -H "Authorization: token token" -d '{"title":"A new bug","body":"Some error occurs"}' \ - //api.github.com/repos/owner/repo/issues -{% endhighlight %} - -

To enable this module set up your token using -DOWN_GITHUB_TOKEN=0 cmake flag.

- -

This module requires QtNetwork module.

- -

GitReports module

-

This module creates issue over GitReports. Please visit this page and set up it for your repository.

- -

To disable this module use -DENABLE_GITREPORT=0 cmake flag. This module requires QtNetwork and QtWebKit modules.

- - - -

Configuration

-

For the developer configuration please use config.h header. Also you may load parametrs dynamically using params array (needed keys is the same as for the header

-

Main configuration

-
    -
  • OWNER - the owner of the source repository.
    • -
  • PROJECT - the project name.
    • -
  • TAG_BODY - default body of an issue. It may be used for both modules.
    • -
  • TAG_TITLE - default title of an issue. It may be used only for GitHub module.
    • -
  • TAG_ASSIGNEE - assign an issue to this account. It may be used only for GitHub module. This tag will work only if user has push access. If it will be empty, it will be ignored.
    • -
  • TAG_LABELS - set these labels to an issue. Labels should be comma separated. It may be used only for GitHub module. This tag will work only if user has push access. If it will be empty, it will be ignored.
    • -
  • TAG_MILESTONE - set this milestone to an issue. It may be used only for GitHub module. This tag will work only if user has push access. If it will be empty, it will be ignored.
    • -
- -

GitHub module settings

-
    -
  • GITHUB_COMBOBOX - text of this module into comboBox.
    • -
  • ISSUES_URL - issues url, in the most cases do not touch it. Default is //api.github.com/repos/$OWNER/$PROJECT/issues. Available tags here are $PROJECT, $OWNER.
    • -
- -

GitReports module settings

-
    -
  • CAPTCHA_URL - captcha url, in the most cases do not touch it. Default is //gitreports.com/simple_captcha?code=.
    • -
  • GITREPORT_COMBOBOX - text of this module into comboBox.
    • -
  • PUBLIC_URL - issues url, in the most cases do not touch it. Default is //gitreports.com/issue/$OWNER/$PROJECT. Available tags here are $PROJECT, $OWNER.
    • -
- - - - diff --git a/projects/reportabug.md b/projects/reportabug.md new file mode 100644 index 0000000..fc971e7 --- /dev/null +++ b/projects/reportabug.md @@ -0,0 +1,157 @@ +--- +hastr: true +layout: project +title: Report a Bug +short: reportabug +tags: qt, c++, library, development +hasgui: false +hasdocs: true +developers: + - Evgeniy Alekseev +license: LGPLv3 +links: +--- + +## Information + +Qt application/library which allows users to create an issue for projects which are hosted on GitHub. It may work over [GitHub](//github.com "GitHub") or [GitReport](//gitreports.com/ "GitReports"). It works fine, but it was created as proof-of-concept. + +### Developers and contributors + +{% for devel in page.developers %} +* {{ devel }}{% endfor %} + +### License + +* {{ page.license }} + + + + +## Installation + +### Instruction + +#### Build as a standalone application + +* Download the actual source [tarball](//github.com/arcan1s/reportabug/releases "GitHub"). +* Extract it and set up your configuration. +* Install the application: + + ```bash + cd /path/to/extracted/archive + mkdir build && cd build + cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release -DBUILD_AS_LIBRARY:BOOL=0 ../ + make + sudo make install + ``` + +#### Build as a library in your project + +* Download the actual source [tarball](//github.com/arcan1s/reportabug/releases "GitHub"). +* Extract it and set up your configuration. +* include it into your project. For example if you use `cmake`: + + ```cmake + add_subdirectory (reportabug) + ``` + +* Declare class in you sources. For example: + + ```cpp + Reportabug *reportWindow = new Reportabug(parent=this, debugCmd=false, params=0); + reportWindow->showWindow(); + ``` + +* Link your application with this library. + +#### Available cmake flags: + +* `-DBUILD_AS_LIBRARY=0` - build the application but not a library. +* `-DBUILD_DOCS=1` - build developer documentation. +* `-DBUILD_SHARED_LIBRARY=1` - build the shared library instead of static one. +* `-DENABLE_GITHUB=0` - disable GitHub module. +* `-DENABLE_GITREPORT=0` - disable GitReport module. +* `-DOWN_GITHUB_TOKEN=STRING` - use STRING as own GitHub token. +* `-DUSE_QT5=0` - use Qt4 instead of Qt5. + +### Dependencies + +I want note that all were tested on latest version of dependencies. + +* qt5-base *(if Qt5 is used)* **or** qt4 *(if Qt4 is used)* +* qt5-network (if Qt5 is used) +* automoc4 *(make)* +* cmake *(make)* +* doxygen *(make, documentation)* +* qt5-webkit (if Qt5 is used) **or** qtwebkit (if Qt4 is used) *(optional, required by GitReports module)* + + + + +## How to use + +### GitHub module + +This module creates an issue over GitHub. [GitHub API](//developer.github.com/v3/issues/ "Documentation") is used for creating issue. User should type own username and password. The typical POST request is: + +```bash +curl -X POST -u user:pass -d '{"title":"A new bug","body":"Some error occurs"}' \ + //api.github.com/repos/owner/repo/issues +``` + +To disable this module use `-DENABLE_GITHUB=0` cmake flag. + +This module may send request using developer's token too. Please visit [this page](//github.com/settings/applications "Settings") and generate a new one. Needed scopes are `public_repo` (or `repo` if you will use it for a private repository). + +**Please keep in mind that passing the token in the clear, you may discredit your account.** + +The typical POST request is: + +```bash +curl -X POST -H "Authorization: token token" -d '{"title":"A new bug","body":"Some error occurs"}' \ + //api.github.com/repos/owner/repo/issues +``` + +To enable this module set up your token using `-DOWN_GITHUB_TOKEN=0` cmake flag. + +This module requires `QtNetwork` module. + +### GitReports module + +This module creates issue over [GitReports](//gitreports.com/about "GitReports"). Please visit [this page](//gitreports.com/ "GitReports") and set up it for your repository. + +To disable this module use `-DENABLE_GITREPORT=0` cmake flag. This module requires `QtNetwork` and `QtWebKit` modules. + + + + +## Configuration + +For the developer configuration please use `config.h` header. Also you may load parametrs dynamically using `params` array (needed keys is the same as for the header + +### Main configuration + +* `OWNER` - the owner of the source repository. +* `PROJECT` - the project name. +* `TAG_BODY` - default body of an issue. It may be used for both modules. +* `TAG_TITLE` - default title of an issue. It may be used only for GitHub module. +* `TAG_ASSIGNEE` - assign an issue to this account. It may be used only for GitHub module. This tag will work only if user has push access. If it will be empty, it will be ignored. +* `TAG_LABELS` - set these labels to an issue. Labels should be comma separated. It may be used only for GitHub module. This tag will work only if user has push access. If it will be empty, it will be ignored. +* `TAG_MILESTONE` - set this milestone to an issue. It may be used only for GitHub module. This tag will work only if user has push access. If it will be empty, it will be ignored. + +### GitHub module settings + +* `GITHUB_COMBOBOX` - text of this module into comboBox. +* `ISSUES_URL` - issues url, in the most cases do not touch it. Default is `//api.github.com/repos/$OWNER/$PROJECT/issues`. Available tags here are `$PROJECT`, `$OWNER`. + +### GitReports module settings + +* `CAPTCHA_URL` - captcha url, in the most cases do not touch it. Default is `//gitreports.com/simple_captcha?code=`. +* `GITREPORT_COMBOBOX` - text of this module into comboBox. +* `PUBLIC_URL` - issues url, in the most cases do not touch it. Default is `//gitreports.com/issue/$OWNER/$PROJECT`. Available tags here are `$PROJECT`, `$OWNER`. + + + + + diff --git a/ru/projects/awesome-widgets.html b/ru/projects/awesome-widgets.html deleted file mode 100644 index 64b7a36..0000000 --- a/ru/projects/awesome-widgets.html +++ /dev/null @@ -1,915 +0,0 @@ ---- -category: ru -hastr: true -layout: project -title: Awesome Widgets -short: awesome-widgets -tags: python, kde, qt, linux, система, awesome -hasgui: true -hasdocs: false -developers: - - Evgeniy Alekseev - - Ernesto Avilés Vzqz (перевод на испанский) - - Mermouy (перевод на французский) - - underr (перевод на бразильский португальский) - - Виктор Слободян (перевод на украинский) - - Lemueler (перевод на китайский) - - Heimen Stoffels (перевод на голландский) -license: GPLv3 -links: - - Страница плазмоида на kde-look.org - - Страница DataEngine на kde-look.org - - Пакет в AUR - - Пакет для openSUSE (спасибо Kott) - - Пакеты для Ubuntu - - Миграция на версию 2.0 - - Расширения ---- - -

Информация

-

Набор минималистичных легко настраиваемых пламоидов, написанных на C++/Qt. Они выглядят, как виджеты в Awesome WM. Также пакет предоставляет дополнительный системный DataEngine.

- -

ВНИМАНИЕ: НУЖНЫ ПЕРЕВОДЧИКИ!

-

Совместим с Plasma 5!

- -

Разработчики

-
    - {% for devel in page.developers %} -
  • {{ devel }}
    • - {% endfor %} -
- -

Лицензия

-
    -
  • {{ page.license }}
    • -
- -

Список изменений

-

CHANGELOG-RU

- - - -

Установка

- -

Инструкция

-
    -
  • Скачайте архив с актуальной версией исходных файлов.
    • -
  • Извлеките из него файлы и установите: - -{% highlight bash %} -cd /путь/к/извлеченным/файлам/ -mkdir build && cd build -cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr ../ -make -sudo make install -{% endhighlight %} - - ВНИМАНИЕ: Для Plasma 5, вероятно, потребуется флаг -DKDE_INSTALL_USE_QT_SYS_PATHS=ON -
    • -
- -

Зависимости

-

Все было протестировано на последних версиях зависимостей.

-
    -
  • plasma-framework
    • -
  • cmake (make)
    • -
  • extra-cmake-modules (make)
    • -
  • hddtemp или smartmontools (опционально, для контроля за температурой HDD)
    • -
  • один из поддерживаемых музыкальных плееров (опционально, для контроля за музыкальным плеером)
    • -
  • проприетарный видеодрайвер (опционально, для контроля за GPU)
    • -
- - - -

Использование

-

Откройте список виджетов Plasma и выберете Awesome Widget.

- -

Tips & tricks

-

Вы можете использовать несколько цветов в тексте. Просто вставьте нужный текст в html код. Смотри вопрос для более подробной информации.

- - - -

Настройка

- -

Настройка DataEngine

-

Вы можете отредактировать настройки DataEngine, которые хранятся в /etc/xdg/plasma-dataengine-extsysmon.conf и $HOME/.config/plasma-dataengine-extsysmon.conf. Раскомментируйте необходимые строчки и отредактируйте их.

- -

Опции DataEngine

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ACPIPATHПуть к устройствам ACPI. По умолчанию /sys/class/power_supply/.
GPUDEVУстанавливает тип GPU. Может быть nvidia (для nVidia), ati (для ATI Radeon), disable или auto. По умолчанию auto.
HDDDEVУстанавливает блочное устройство для hddtemp через запятую или all для всех возможных. disable отключит монитор температуры HDD. По умолчанию all.
HDDTEMPCMDКоманда, которая будет запущена для hddtemp. По умолчанию sudo smartctl -a. Поддерживаемые приложения - hddtemp и smartmontools.
MPDADDRESSАдрес MPD хоста. По умолчанию localhost.
MPDPORTАдрес MPD хоста. По умолчанию 6600.
PLAYERУстанавливает музыкальный плеер. Поддерживаемые плееры: mpd и с поддержкой MPRIS/DBus. disable отключит данный монитор.
PLAYERSYMBOLSКоличество символов в динамических тегах монитора за плеером. По умолчанию 10.
- -

Настройка виджета

-

Для настройки внешнего вида Вы должны открыть окно настроек и установить требуемый формат текста. HTML теги обрабатываются корректно.

- -

Доступные флаги приведены в таблице ниже.
-ЗАМЕЧАНИЕ Нумерация всех массивов в переменных начинается с 0.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ТипТегОписаниеВведен
Время$timeВремя в стандартном формате. Например, fri Nov 6 04:48:01 2013.1.5.1
$isotimeВремя в формате ISO.1.5.2
$shorttimeВремя в коротком формате локали.1.5.2
$longtimeВремя в длинном формате локали.1.5.2
$ctimeСпециальный формат времени.2.0.0
Время работы$uptimeСистемный аптайм, ---d--h--m.
$cuptimeСпециальный формат аптайма.2.0.0
Средняя загрузка$la1Средняя загрузка за 1 минуту, -----.2.4.0
$la5Средняя загрузка за 5 минут, -----.2.4.0
$la15Средняя загрузка за 15 минут, -----.2.4.0
CPU$cpuПолная загрузка CPU, %, -----.
$cpuNЗагрузка CPU для ядра N, %, -----.1.7.0
Частота CPU$cpuclСредняя частота CPU, МГц, ----.1.1.2
$cpuclNЧастота CPU для ядра N, МГц, ----.1.7.0
Температура$tempNТемпература для датчика N, ----. Пример: $temp0
GPU$gpuИспользование GPU, %, -----. aticonfig или nvidia-smi должны быть установлены.1.3.2
Температура GPU$gputempТемпература GPU, ----. aticonfig или nvidia-smi должны быть установлены.1.3.2
Память$memИспользование RAM, %, -----.
$memmbИспользование RAM, MB, -----.1.1.1
$memgbИспользование RAM, GB, ----.1.7.3
$memfreembСвободная RAM, MB, -----.2.0.0
$memfreegbСвободная RAM, GB, ----.2.0.0
$memtotmbRAM, MB, -----.1.10.0
$memtotgbRAM, GB, ----.1.10.0
$memusedmbЗанятая и кэшированная RAM, MB, -----.2.0.0
$memusedgbЗанятая и кэшированная RAM, GB, ----.2.0.0
Swap$swapИспользование swap, %, -----.
$swapmbИспользование swap, MB, -----.1.1.1
$swapgbИспользование swap, GB, ----.1.7.3
$swapfreembСвободный swap, MB, -----.2.0.0
$swapfreegbСвободный swap, GB, ----.2.0.0
$swaptotmbswap, MB, -----.1.10.0
$swaptotgbswap, GB, ----.1.10.0
HDD$hddNЗанятость точки монтирования N, %, -----. Пример: $hdd0.1.3.2
$hddmbNЗанятость точки монтирования N, MB, -----. Пример: $hddmb0.1.8.0
$hddgbNЗанятость точки монтирования N, GB, -----. Пример: $hddgb0.1.8.0
$hddfreembNСвободное место точки монтирования N, MB, -----. Пример: $hddfreemb0.2.0.0
$hddfreegbNСвободное место точки монтирования N, GB, -----. Пример: $hddfreegb0.2.0.0
$hddtotmbNРазмер точки монтирования N, MB, -----. Пример: $hddtotmb0.1.10.0
$hddtotgbNРазмер точки монтирования N, GB, -----. Пример: $hddtotgb0.1.10.0
Скорость HDD$hddrNСкорость записи диска N, KB/s, -----. Пример: $hddr0.1.9.0
$hddwNСкорость чтения диска N, KB/s, -----. Пример: $hddw0.1.9.0
Температура HDD$hddtempNТемпература HDD с номером N, ----. Пример $hddtemp0. hddtemp или smartmontools должен быть установлен.1.7.0
Сеть$downСкорость загрузки активного устройства, KB/s или MB/s, ----.1.7.0
$downkbСкорость загрузки активного устройства, KB/s, ----.3.0.0
$downunitsЕдиницы скорости загрузки активного устройства, ----.3.0.0
$downNСкорость загрузки устройства N, KB/s или MB/s, ----.2.2.0
$downkbNСкорость загрузки устройства N, KB/s, ----.3.0.0
$downunitsNЕдиницы cкорости загрузки устройства N, ----.3.0.0
$upСкорость отдачи активного устройства, KB/s или MB/s, ----.1.7.0
$upkbСкорость отдачи активного устройства, KB/s, ----.3.0.0
$upunitsЕдиницы скорости отдачи активного устройства, ----.3.0.0
$upNСкорость отдачи устройства N, KB/s или MB/s, ----.2.2.0
$upkbNСкорость отдачи устройства N, KB/s, ----.3.0.0
$upunitsNЕдиницы скорости отдачи устройства N, ----.3.0.0
$netdevТекущее устройство.1.1.1
Батарея$batСредний заряд батареи, %, ---.
$batNЗаряд батареи N, %, ---.2.0.3
$acСтатус зарядного устройства. Возвращает (*), если устройство подключено, или ( ), если нет.
Музыкальный плеер$albumАльбом текущей песни. Один из поддерживаемых музыкальных плееров должен быть установлен.1.5.3
$dalbumАльбом текущей песни с фиксированным количеством символов, показывающийся, как бегущая строка.3.0.0
$salbumАльбом текущей песни с фиксированным количеством символов, показывающийся с многоточием на конце.3.0.0
$artistИсполнитель текущей песни. Один из поддерживаемых музыкальных плееров должен быть установлен.1.5.0
$dartistИсполнитель текущей песни с фиксированным количеством символов, показывающийся, как бегущая строка.3.0.0
$sartistИсполнитель текущей песни с фиксированным количеством символов, показывающийся с многоточием на конце.3.0.0
$durationДлительность текущей песни. Один из поддерживаемых музыкальных плееров должен быть установлен.2.0.0
$progressПрогресс текущей песни. Один из поддерживаемых музыкальных плееров должен быть установлен.1.5.3
$titleНазвание текущей песни. Один из поддерживаемых музыкальных плееров должен быть установлен.1.5.0
$dtitleНазвание текущей песни с фиксированным количеством символов, показывающийся, как бегущая строка.3.0.0
$stitleНазвание текущей песни с фиксированным количеством символов, показывающийся с многоточием на конце.3.0.0
Процессы$psСписок запущенных процессов, разделенных запятой.1.8.0
$pscountЧисло запущенных процессов.1.8.0
$pstotalОбщее число процессов.1.8.0
Пакетный менеджер$pkgcountNЧисло пакетов, доступных для обновления, для команды N.1.8.0
Своя команда$customNПолучить данные из указанной команды N. Например, $custom0.1.9.0
Рабочий стол$desktopИмя текущего рабочего стола.2.0.0
$ndesktopНомер текущего рабочего стола.2.0.0
$tdesktopsОбщее число рабочих столов.2.0.0
Котировки$askNПолучить аск по тикеру N. Например, $ask0.2.2.2
$askchgNАбсолютное изменение аск по тикеру N. Например, $askchg0.2.2.2
$percaskchgNИзменение аск по тикеру N, %. Например, $percaskchg0.2.2.2
$bidNПолучить бид по тикеру N. Например, $bid0.2.2.2
$bidchgNАбсолютное изменение бид по тикеру N. Например, $bidchg0.2.2.2
$percbidchgNИзменение бид по тикеру N, %. Например, $percbidchg0.2.2.2
$priceNПолучить цену по тикеру N. Например, $price0.2.2.2
$pricechgNАбсолютное изменение цены по тикеру N. Например, $pricechg0.2.2.2
$percpricechgNИзменение цены по тикеру N, %. Например, $percpricechg0.2.2.2
Погода$weatherIdNЧисленное ID погоды. Например $weatherId0.2.4.0
$weatherNСтатус погоды. Например $weather0.2.4.0
$humidityNВлажность, %. Например $humidity0.2.4.0
$pressureNДавление, бар. Например $pressure0.2.4.0
$temperatureNТемпература. Humidity $temperature0.2.4.0
- -

Лямбда функции

-

Начиная с версии 3.0.0 основной виджет поддерживает лямбда выражения, которые рассчитываются в рантайме. Они объявляются использованием конструкции ${{ }}:

- -{% highlight javascript %} -{% raw %}${{{% endraw %} -function three() -{ - return 1 + 2; -} -three() -{% raw %}}}{% endraw %} -{% endhighlight %} - -

Функции внутри будут интерпретированы, как JavaScript, любая переменная из основного набора поддерживается. Так, функция:

- -{% highlight javascript %} -{% raw %}${{{% endraw %} -function colorCpu() -{ - if ($cpu > 90.0) - return "$cpu" - else - return "$cpu" -} -colorCpu() -{% raw %}}}{% endraw %} -{% endhighlight %} - -

покажет значение $cpu красным, если оно больше 90.0, иначе - покажет цветом по-умолчанию. Также поддерживаются произвольные вычисления:

- -{% highlight javascript %} -{% raw %}${{{% endraw %} -$down - $up -{% raw %}}}{% endraw %} -{% endhighlight %} - -

покажет разность между скоростями загрузки и отдачи. Другая особенность, предоставляемая лямбда выражениями - тег $this, который вернет последнее значение данной лямбда функции. Ниже чуть более сложный пример, который покажет бегущую строку "Артист - Название" с длиной меньшей либо равной 10 символам:

- -{% highlight javascript %} -{% raw %}${{{% endraw %} -function runningLine() { - var current = "$artist - $title"; - var index = current.indexOf("$this"); - if (("$this" == "") || ((index + 20 + 1) > current.length)) - return current.substring(0, 20); - else - return current.substring(index + 1, index + 20 + 1); -} -runningLine() -{% raw %}}}{% endraw %} -{% endhighlight %} - -

Таким образом, лямбда выражения могут быть использованы, например, чтобы показывать произвольное значение, которое будет рассчитано в рантайме, или, чтобы показать различную информацию, в зависимости от некоторых условий. Однако, пожалуйста, учитывайте, что подобные вычисления в рантайме могут увеличить нагрузку на CPU.

- -

Расширенные настройки

-

Включить фон: Снимите галочку, чтобы отключить стандартный фон виджета и установить прозрачный. По умолчанию true.

- -

Переводить строки: Переводить или нет строковые теги. По умолчанию true.

- -

Заменить символ перевода строки: Заменить \n на <br>. По умолчанию false.

- -

Перенос слов: Включить перенос слов. По умолчанию false.

- -

Включить всплывающие сообщения: Снимите галочку, если вы не хотите всплывающих сообщений на системные события. По умолчанию true.

- -

Проверять обновления: Проверять или нет обновления при запуске. По умолчанию true.

- -

Высота виджета: Отключит автоматическое определение высоты виджета и установит ее в данное значение. По умолчанию 0 (автоматически).

- -

Ширина виджета: Отключит автоматическое определение ширины виджета и установит ее в данное значение. По умолчанию 0 (автоматически).

- -

Интервал обновления: Интервал обновления виджета, мс. По умолчанию 1000.

- -

Очередь сообщений: Использовать указанное количество тредов в пуле. 0 означает идеальное количество тредов. По умолчанию 0.

- -

Температурные единицы: Выберете единицы температуры. Доступные единицы следующие: Цельсий, Фаренгейт и Кельвин.

- -

Свой формат времени:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
$ddddДлинный день недели.
$dddКороткий день недели.
$ddДень.
$dДень без нуля.
$MMMMМесяц в длинном формате.
$MMMМесяц в коротком формате.
$MMМесяц.
$MМесяц без нуля.
$yyyyГод.
$yyГод в коротком формате.
$hhЧасы.
$hЧасы без нуля.
$HHЧасы в 24-часовом формате.
$HЧасы в 24-часовом формате без нуля.
$mmМинуты.
$mМинуты без нуля.
$ssСекунды.
$sСекунды без нуля.
$tВременная зона.
$a/$apam или pm.
$A/$APAM или PM.
- -

Свой формат времени работы:

- - - - - - - - - - - - - - - - - - - - - - - - - -
$ddДни аптайма.
$dДни аптайма без нуля.
$hhЧасы аптайма.
$hЧасы аптайма без нуля.
$mmМинуты аптайма.
$mМинуты аптайма без нуля.
- -

AC online тег: Строка, которая будет показана, когда AC онлайн. По умолчанию (*).

- -

AC offline тег: Строка, которая будет показана, когда AC оффлайн. По умолчанию ( ).

- -

Тултипы

-

Начиная с версии 1.7.0, поля CPU, частота CPU, память, swap, сеть и батарея поддерживают графический тултип (всплывающая подсказка). Чтобы включить их, просто поставьте нужные галочки. Число хранимых значений может быть установлено во вкладке. Также есть возможность настроить цвета графиков.

- -

Настройка DataEngine

-

Устройства ACPI: Путь к устройствам ACPI. По умолчанию /sys/class/power_supply/.

- -

Устройство GPU: Выберете одно из поддерживаемых устройств GPU. auto включит автоматическое определение устройства, disable отключит все мониторы GPU. По умолчанию auto.

- -

HDD: Выберете один из HDD для монитора температуры HDD. all включит монитор для всех доступных устройств, disable отключит монитор температуры HDD. По умолчанию all.

- -

Команда hddtemp: Введите команду, которая будет запущена для hddtemp DataEngine. По умолчанию sudo hddtemp.

- -

Количество символов для плеера: Количество символов, которые будут показываться в динамических тегах плеера.

- -

Музыкальный плеер: Выберете один из поддерживаемых музыкальных плееров для соответствующего поля.

- -

MPRIS: Выберете имя плеера MPRIS. auto включит автоматическое определение плеера. По умолчанию auto.

- -

Адрес MPD: Адрес MPD сервера. По умолчанию localhost.

- -

Порт MPD: Порт MPD сервера. По умолчанию 6600.

- -

Desktop panel

-

Начиная с версии 1.11.0 виджеты предоставляют панель для мониторинга за рабочими столами. И да, он выглядит, как аналогичная панель в Awesome.

- -

Настройка Desktop panel

-

Включить фон: Снимите галочку, чтобы отключить стандартный фон виджета и установить прозрачный. По умолчанию true.

- -

Вертикальная разметка: Использовать вертикальную разметку вместо горизонтальной. По умолчанию false.

- -

Высота виджета: Отключит автоматическое определение высоты виджета и установит ее в данное значение. По умолчанию 0 (автоматически).

- -

Ширина виджета: Отключит автоматическое определение ширины виджета и установит ее в данное значение. По умолчанию 0 (автоматически).

- -

Метка Введите символ (или строку), которая будет показана, если данный рабочий стол сейчас активен.

- -

Тип тултипа: Тип превью, по умолчанию Окна.

- -

Ширина тултипа: Ширина тултипа в пикселях. По умолчанию 200px.

- -

Цвет тултипа: Цвет, который будет использован в некоторых типах тултипа. По умолчанию #ffffff.

- -

Теги шаблона

- - - - - - - - - - - - - - - - - -
$markПоказать метку, если данный рабочий стол активен. Иначе показывает пробелы
$nameИмя рабочего стола.
$numberНомер рабочего стола.
$totalОбщее число рабочих столов.
- - - -

Графический интерфейс

- -

Скриншоты

-
- {% assign scrdesc = "Виджет (кликабельно)" %} - {% assign scrname = "awesomewidgets_widget" %} - {% include prj_scr.html %} - {% assign scrdesc = "Окно настроек" %} - {% assign scrname = "awesomewidgets_config_01" %} - {% include prj_scr.html %} - {% assign scrdesc = "Окно настроек" %} - {% assign scrname = "awesomewidgets_config_02" %} - {% include prj_scr.html %} - {% assign scrdesc = "Окно настроек" %} - {% assign scrname = "awesomewidgets_config_03" %} - {% include prj_scr.html %} - {% assign scrdesc = "Окно настроек" %} - {% assign scrname = "awesomewidgets_config_04" %} - {% include prj_scr.html %} - {% assign scrdesc = "Окно настроек" %} - {% assign scrname = "awesomewidgets_config_05" %} - {% include prj_scr.html %} - {% assign scrdesc = "Тултипы" %} - {% assign scrname = "awesomewidgets_tooltips" %} - {% include prj_scr.html %} -
diff --git a/ru/projects/awesome-widgets.md b/ru/projects/awesome-widgets.md new file mode 100644 index 0000000..acf505e --- /dev/null +++ b/ru/projects/awesome-widgets.md @@ -0,0 +1,421 @@ +--- +category: ru +hastr: true +layout: project +title: Awesome Widgets +short: awesome-widgets +tags: python, kde, qt, linux, система, awesome +hasgui: true +hasdocs: false +developers: + - Evgeniy Alekseev + - Ernesto Avilés Vzqz (перевод на испанский) + - Mermouy (перевод на французский) + - underr (перевод на бразильский португальский) + - Виктор Слободян (перевод на украинский) + - Lemueler (перевод на китайский) + - Heimen Stoffels (перевод на голландский) +license: GPLv3 +links: + - Страница плазмоида на kde-look.org + - Страница DataEngine на kde-look.org + - Пакет в AUR + - Пакет для openSUSE (спасибо Kott) + - Пакеты для Ubuntu + - Миграция на версию 2.0 + - Расширения +--- + +## Информация + +Набор минималистичных легко настраиваемых пламоидов, написанных на `C++/Qt`. Они выглядят, как виджеты в [Awesome WM](//awesome.naquadah.org/ "Домашняя страница Awesome"). Также пакет предоставляет дополнительный системный [DataEngine](//techbase.kde.org/Development/Tutorials/Plasma/DataEngines "Мануал для разработчиков"). + +**ВНИМАНИЕ:** [НУЖНЫ ПЕРЕВОДЧИКИ!](//github.com/arcan1s/awesome-widgets/issues/14 "Тикет") + +**Совместим с Plasma 5!** + +### Разработчики + +{% for devel in page.developers %} +* {{ devel }}{% endfor %} + +### Лицензия + +* {{ page.license }} + +### Список изменений + +[CHANGELOG-RU](//github.com/arcan1s/awesome-widgets/blob/master/CHANGELOG-RU "GitHub") + + + + +## Установка + +### Инструкция + +* Скачайте [архив](//github.com/arcan1s/awesome-widgets/releases "GitHub") с актуальной версией исходных файлов. +* Извлеките из него файлы и установите: + + ```bash + cd /путь/к/извлеченным/файлам/ + mkdir build && cd build + cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr ../ + make + sudo make install + ``` + + **ВНИМАНИЕ:** Для Plasma 5, вероятно, потребуется флаг `-DKDE_INSTALL_USE_QT_SYS_PATHS=ON` + +### Зависимости + +Все было протестировано на последних версиях зависимостей. + +* plasma-framework +* cmake *(make)* +* extra-cmake-modules *(make)* +* hddtemp **или** smartmontools *(опционально, для контроля за температурой HDD)* +* один из поддерживаемых музыкальных плееров *(опционально, для контроля за музыкальным плеером)* +* проприетарный видеодрайвер *(опционально, для контроля за GPU)* + + + + +## Использование + +Откройте список виджетов Plasma и выберете `Awesome Widget`. + +### Tips & tricks + +Вы можете использовать несколько цветов в тексте. Просто вставьте нужный текст в html код. Смотри [вопрос](//github.com/arcan1s/awesome-widgets/issues/9 "GitHub") для более подробной информации. + + + + +## Настройка + +### Настройка DataEngine + +Вы можете отредактировать настройки DataEngine, которые хранятся в `/etc/xdg/plasma-dataengine-extsysmon.conf` и `$HOME/.config/plasma-dataengine-extsysmon.conf`. Раскомментируйте необходимые строчки и отредактируйте их. + +### Опции DataEngine + +| | | +|----------|----------| +| ACPIPATH | Путь к устройствам ACPI. По умолчанию `/sys/class/power_supply/`. | +| GPUDEV | Устанавливает тип GPU. Может быть `nvidia` (для nVidia), `ati` (для ATI Radeon), `disable` или `auto`. По умолчанию `auto`. | +| HDDDEV | Устанавливает блочное устройство для `hddtemp` через запятую или `all` для всех возможных. `disable` отключит монитор температуры HDD. По умолчанию `all`. | +| HDDTEMPCMD | Команда, которая будет запущена для hddtemp. По умолчанию `sudo smartctl -a`. Поддерживаемые приложения - `hddtemp` и `smartmontools`. | +| MPDADDRESS | Адрес MPD хоста. По умолчанию `localhost`. | +| MPDPORT | Адрес MPD хоста. По умолчанию `6600`. | +| PLAYER | Устанавливает музыкальный плеер. Поддерживаемые плееры: mpd и с поддержкой MPRIS/DBus. `disable` отключит данный монитор. | +| PLAYERSYMBOLS | Количество символов в динамических тегах монитора за плеером. По умолчанию `10`. | + +### Настройка виджета + +Для настройки внешнего вида Вы должны открыть окно настроек и установить требуемый формат текста. HTML теги обрабатываются корректно. + +Доступные флаги приведены в таблице ниже. + +**ЗАМЕЧАНИЕ** Нумерация всех массивов в переменных начинается с 0. + +| Тег | Описание | Введен | +|-----|----------|--------| +| `$time` | Время в стандартном формате. Например, `fri Nov 6 04:48:01 2013`. | 1.5.1 | +| `$isotime` | Время в формате ISO. | 1.5.2 | +| `$shorttime` | Время в коротком формате локали. | 1.5.2 | +| `$longtime` | Время в длинном формате локали. | 1.5.2 | +| `$ctime` | Специальный формат времени. | 2.0.0 | +| `$uptime` | Системный аптайм, `---d--h--m`. | +| `$cuptime` | Специальный формат аптайма. | 2.0.0 | +| `$la1` | Средняя загрузка за 1 минуту, `-----`. | 2.4.0 | +| `$la5` | Средняя загрузка за 5 минут, `-----`. | 2.4.0 | +| `$la15` | Средняя загрузка за 15 минут, `-----`. | 2.4.0 | +| `$cpu` | Полная загрузка CPU, %, `-----`. | +| `$cpuN` | Загрузка CPU для ядра N, %, `-----`. | 1.7.0 | +| `$cpucl` | Средняя частота CPU, МГц, `----`. | 1.1.2 | +| `$cpuclN` | Частота CPU для ядра N, МГц, `----`. | 1.7.0 | +| `$tempN` | Температура для датчика N, `----`. Пример: `$temp0` | +| `$gpu` | Использование GPU, %, `-----`. `aticonfig` или `nvidia-smi` должны быть установлены. | 1.3.2 | +| `$gputemp` | Температура GPU, `----`. `aticonfig` или `nvidia-smi` должны быть установлены. | 1.3.2 | +| `$mem` | Использование RAM, %, `-----`. | +| `$memmb` | Использование RAM, MB, `-----`. | 1.1.1 | +| `$memgb` | Использование RAM, GB, `----`. | 1.7.3 | +| `$memfreemb` | Свободная RAM, MB, `-----`. | 2.0.0 | +| `$memfreegb` | Свободная RAM, GB, `----`. | 2.0.0 | +| `$memtotmb` | RAM, MB, `-----`. | 1.10.0 | +| `$memtotgb` | RAM, GB, `----`. | 1.10.0 | +| `$memusedmb` | Занятая и кэшированная RAM, MB, `-----`. | 2.0.0 | +| `$memusedgb` | Занятая и кэшированная RAM, GB, `----`. | 2.0.0 | +| `$swap` | Использование swap, %, `-----`. | +| `$swapmb` | Использование swap, MB, `-----`. | 1.1.1 | +| `$swapgb` | Использование swap, GB, `----`. | 1.7.3 | +| `$swapfreemb` | Свободный swap, MB, `-----`. | 2.0.0 | +| `$swapfreegb` | Свободный swap, GB, `----`. | 2.0.0 | +| `$swaptotmb` | swap, MB, `-----`. | 1.10.0 | +| `$swaptotgb` | swap, GB, `----`. | 1.10.0 | +| `$hddN` | Занятость точки монтирования N, %, `-----`. Пример: `$hdd0`. | 1.3.2 | +| `$hddmbN` | Занятость точки монтирования N, MB, `-----`. Пример: `$hddmb0`. | 1.8.0 | +| `$hddgbN` | Занятость точки монтирования N, GB, `-----`. Пример: `$hddgb0`. | 1.8.0 | +| `$hddfreembN` | Свободное место точки монтирования N, MB, `-----`. Пример: `$hddfreemb0`. | 2.0.0 | +| `$hddfreegbN` | Свободное место точки монтирования N, GB, `-----`. Пример: `$hddfreegb0`. | 2.0.0 | +| `$hddtotmbN` | Размер точки монтирования N, MB, `-----`. Пример: `$hddtotmb0`. | 1.10.0 | +| `$hddtotgbN` | Размер точки монтирования N, GB, `-----`. Пример: `$hddtotgb0`. | 1.10.0 | +| `$hddrN` | Скорость записи диска N, KB/s, `-----`. Пример: `$hddr0`. | 1.9.0 | +| `$hddwN` | Скорость чтения диска N, KB/s, `-----`. Пример: `$hddw0`. | 1.9.0 | +| `$hddtempN` | Температура HDD с номером N, `----`. Пример `$hddtemp0`. `hddtemp` или `smartmontools` должен быть установлен. | 1.7.0 | +| `$down` | Скорость загрузки активного устройства, KB/s или MB/s, `----`. | 1.7.0 | +| `$downkb` | Скорость загрузки активного устройства, KB/s, `----`. | 3.0.0 | +| `$downunits` | Единицы скорости загрузки активного устройства, `----`. | 3.0.0 | +| `$downN` | Скорость загрузки устройства N, KB/s или MB/s, `----`. | 2.2.0 | +| `$downkbN` | Скорость загрузки устройства N, KB/s, `----`. | 3.0.0 | +| `$downunitsN` | Единицы cкорости загрузки устройства N, `----`. | 3.0.0 | +| `$up` | Скорость отдачи активного устройства, KB/s или MB/s, `----`. | 1.7.0 | +| `$upkb` | Скорость отдачи активного устройства, KB/s, `----`. | 3.0.0 | +| `$upunits` | Единицы скорости отдачи активного устройства, `----`. | 3.0.0 | +| `$upN` | Скорость отдачи устройства N, KB/s или MB/s, `----`. | 2.2.0 | +| `$upkbN` | Скорость отдачи устройства N, KB/s, `----`. | 3.0.0 | +| `$upunitsN` | Единицы скорости отдачи устройства N, `----`. | 3.0.0 | +| `$netdev` | Текущее устройство. | 1.1.1 | +| `$bat` | Средний заряд батареи, %, `---`. | +| `$batN` | Заряд батареи N, %, `---`. | 2.0.3 | +| `$ac` | Статус зарядного устройства. Возвращает `(*)`, если устройство подключено, или `( )`, если нет. | +| `$album` | Альбом текущей песни. Один из поддерживаемых музыкальных плееров должен быть установлен. | 1.5.3 | +| `$dalbum` | Альбом текущей песни с фиксированным количеством символов, показывающийся, как бегущая строка. | 3.0.0 | +| `$salbum` | Альбом текущей песни с фиксированным количеством символов, показывающийся с многоточием на конце. | 3.0.0 | +| `$artist` | Исполнитель текущей песни. Один из поддерживаемых музыкальных плееров должен быть установлен. | 1.5.0 | +| `$dartist` | Исполнитель текущей песни с фиксированным количеством символов, показывающийся, как бегущая строка. | 3.0.0 | +| `$sartist` | Исполнитель текущей песни с фиксированным количеством символов, показывающийся с многоточием на конце. | 3.0.0 | +| `$duration` | Длительность текущей песни. Один из поддерживаемых музыкальных плееров должен быть установлен. | 2.0.0 | +| `$progress` | Прогресс текущей песни. Один из поддерживаемых музыкальных плееров должен быть установлен. | 1.5.3 | +| `$title` | Название текущей песни. Один из поддерживаемых музыкальных плееров должен быть установлен. | 1.5.0 | +| `$dtitle` | Название текущей песни с фиксированным количеством символов, показывающийся, как бегущая строка. | 3.0.0 | +| `$stitle` | Название текущей песни с фиксированным количеством символов, показывающийся с многоточием на конце. | 3.0.0 | +| `$ps` | Список запущенных процессов, разделенных запятой. | 1.8.0 | +| `$pscount` | Число запущенных процессов. | 1.8.0 | +| `$pstotal` | Общее число процессов. | 1.8.0 | +| `$pkgcountN` | Число пакетов, доступных для обновления, для команды N. | 1.8.0 | +| `$customN` | Получить данные из указанной команды N. Например, `$custom0`. | 1.9.0 | +| `$desktop` | Имя текущего рабочего стола. | 2.0.0 | +| `$ndesktop` | Номер текущего рабочего стола. | 2.0.0 | +| `$tdesktops` | Общее число рабочих столов. | 2.0.0 | +| `$askN` | Получить аск по тикеру N. Например, `$ask0`. | 2.2.2 | +| `$askchgN` | Абсолютное изменение аск по тикеру N. Например, `$askchg0`. | 2.2.2 | +| `$percaskchgN` | Изменение аск по тикеру N, %. Например, `$percaskchg0`. | 2.2.2 | +| `$bidN` | Получить бид по тикеру N. Например, `$bid0`. | 2.2.2 | +| `$bidchgN` | Абсолютное изменение бид по тикеру N. Например, `$bidchg0`. | 2.2.2 | +| `$percbidchgN` | Изменение бид по тикеру N, %. Например, `$percbidchg0`. | 2.2.2 | +| `$priceN` | Получить цену по тикеру N. Например, `$price0`. | 2.2.2 | +| `$pricechgN` | Абсолютное изменение цены по тикеру N. Например, `$pricechg0`. | 2.2.2 | +| `$percpricechgN` | Изменение цены по тикеру N, %. Например, `$percpricechg0`. | 2.2.2 | +| `$weatherIdN` | Численное ID погоды. Например `$weatherId0`. | 2.4.0 | +| `$weatherN` | Статус погоды. Например `$weather0`. | 2.4.0 | +| `$humidityN` | Влажность, %. Например `$humidity0`. | 2.4.0 | +| `$pressureN` | Давление, бар. Например `$pressure0`. | 2.4.0 | +| `$temperatureN` | Температура. Humidity `$temperature0`. | 2.4.0 | + +### Лямбда функции + +Начиная с версии 3.0.0 основной виджет поддерживает лямбда выражения, которые рассчитываются в рантайме. Они объявляются использованием конструкции `${% raw %}${{{% endraw %} {% raw %}}}{% endraw %}`: + +```javascript +{% raw %}${{{% endraw %} +function three() +{ + return 1 + 2; +} +three() +{% raw %}}}{% endraw %} +``` + +Функции внутри будут интерпретированы, как JavaScript, любая переменная из основного набора поддерживается. Так, функция: + +```javascript +{% raw %}${{{% endraw %} +function colorCpu() +{ + if ($cpu > 90.0) + return "$cpu" + else + return "$cpu" +} +colorCpu() +{% raw %}}}{% endraw %} +``` + +покажет значение `$cpu` красным, если оно больше 90.0, иначе - покажет цветом по-умолчанию. Также поддерживаются произвольные вычисления: + +```javascript +{% raw %}${{{% endraw %} +$down - $up +{% raw %}}}{% endraw %} +``` + +покажет разность между скоростями загрузки и отдачи. Другая особенность, предоставляемая лямбда выражениями - тег `$this`, который вернет последнее значение данной лямбда функции. Ниже чуть более сложный пример, который покажет бегущую строку "Артист - Название" с длиной меньшей либо равной 10 символам: + +```javascript +{% raw %}${{{% endraw %} +function runningLine() { + var current = "$artist - $title"; + var index = current.indexOf("$this"); + if (("$this" == "") || ((index + 20 + 1) > current.length)) + return current.substring(0, 20); + else + return current.substring(index + 1, index + 20 + 1); +} +runningLine() +{% raw %}}}{% endraw %} +``` + +Таким образом, лямбда выражения могут быть использованы, например, чтобы показывать произвольное значение, которое будет рассчитано в рантайме, или, чтобы показать различную информацию, в зависимости от некоторых условий. Однако, пожалуйста, учитывайте, что подобные вычисления в рантайме могут увеличить нагрузку на CPU. + +### Расширенные настройки + +**Включить фон:** Снимите галочку, чтобы отключить стандартный фон виджета и установить прозрачный. По умолчанию `true`. + +**Переводить строки:** Переводить или нет строковые теги. По умолчанию `true`. + +**Заменить символ перевода строки:** Заменить `\n` на `<br>`. По умолчанию `false`. + +**Перенос слов:** Включить перенос слов. По умолчанию `false`. + +**Включить всплывающие сообщения:** Снимите галочку, если вы не хотите всплывающих сообщений на системные события. По умолчанию `true`. + +**Проверять обновления:** Проверять или нет обновления при запуске. По умолчанию `true`. + +**Высота виджета:** Отключит автоматическое определение высоты виджета и установит ее в данное значение. По умолчанию `0` (автоматически). + +**Ширина виджета:** Отключит автоматическое определение ширины виджета и установит ее в данное значение. По умолчанию `0` (автоматически). + +**Интервал обновления:** Интервал обновления виджета, мс. По умолчанию `1000`. + +**Очередь сообщений:** Использовать указанное количество тредов в пуле. `0` означает идеальное количество тредов. По умолчанию `0`. + +**Температурные единицы:** Выберете единицы температуры. Доступные единицы следующие: Цельсий, Фаренгейт и Кельвин. + +**Свой формат времени:** + +| | | +|---------|---------| +| `$dddd` | Длинный день недели. | +| `$ddd` | Короткий день недели. | +| `$dd` | День. | +| `$d` | День без нуля. | +| `$MMMM` | Месяц в длинном формате. | +| `$MMM` | Месяц в коротком формате. | +| `$MM` | Месяц. | +| `$M` | Месяц без нуля. | +| `$yyyy` | Год. | +| `$yy` | Год в коротком формате. | +| `$hh` | Часы. | +| `$h` | Часы без нуля. | +| `$HH` | Часы в 24-часовом формате. | +| `$H` | Часы в 24-часовом формате без нуля. | +| `$mm` | Минуты. | +| `$m` | Минуты без нуля. | +| `$ss` | Секунды. | +| `$s` | Секунды без нуля. | +| `$t` | Временная зона. | +| `$a`/`$ap` | am или pm. | +| `$A`/`$AP` | AM или PM. | + +**Свой формат времени работы:** + +| | | +|-------|-------| +| `$dd` | Дни аптайма. | +| `$d` | Дни аптайма без нуля. | +| `$hh` | Часы аптайма. | +| `$h` | Часы аптайма без нуля. | +| `$mm` | Минуты аптайма. | +| `$m` | Минуты аптайма без нуля. | + +**AC online тег:** Строка, которая будет показана, когда AC онлайн. По умолчанию `(*)`. + +**AC offline тег:** Строка, которая будет показана, когда AC оффлайн. По умолчанию `( )`. + +### Тултипы + +Начиная с версии 1.7.0, поля CPU, частота CPU, память, swap, сеть и батарея поддерживают графический тултип (всплывающая подсказка). Чтобы включить их, просто поставьте нужные галочки. Число хранимых значений может быть установлено во вкладке. Также есть возможность настроить цвета графиков. + +### Настройка DataEngine + +**Устройства ACPI:** Путь к устройствам ACPI. По умолчанию `/sys/class/power_supply/`. + +**Устройство GPU:** Выберете одно из поддерживаемых устройств GPU. `auto` включит автоматическое определение устройства, `disable` отключит все мониторы GPU. По умолчанию `auto`. + +**HDD:** Выберете один из HDD для монитора температуры HDD. `all` включит монитор для всех доступных устройств, `disable` отключит монитор температуры HDD. По умолчанию `all`. + +**Команда hddtemp:** Введите команду, которая будет запущена для hddtemp DataEngine. По умолчанию `sudo hddtemp`. + +**Количество символов для плеера:** Количество символов, которые будут показываться в динамических тегах плеера. + +**Музыкальный плеер:** Выберете один из поддерживаемых музыкальных плееров для соответствующего поля. + +**MPRIS:** Выберете имя плеера MPRIS. `auto` включит автоматическое определение плеера. По умолчанию `auto`. + +**Адрес MPD:** Адрес MPD сервера. По умолчанию `localhost`. + +**Порт MPD:** Порт MPD сервера. По умолчанию `6600`. + +### Desktop panel + +Начиная с версии 1.11.0 виджеты предоставляют панель для мониторинга за рабочими столами. И да, он выглядит, как аналогичная панель в Awesome. + +### Настройка Desktop panel + +**Включить фон:** Снимите галочку, чтобы отключить стандартный фон виджета и установить прозрачный. По умолчанию `true`. + +**Вертикальная разметка:** Использовать вертикальную разметку вместо горизонтальной. По умолчанию `false`. + +**Высота виджета:** Отключит автоматическое определение высоты виджета и установит ее в данное значение. По умолчанию `0` (автоматически). + +**Ширина виджета:** Отключит автоматическое определение ширины виджета и установит ее в данное значение. По умолчанию `0` (автоматически). + +**Метка** Введите символ (или строку), которая будет показана, если данный рабочий стол сейчас активен. + +**Тип тултипа:** Тип превью, по умолчанию `Окна`. + +**Ширина тултипа:** Ширина тултипа в пикселях. По умолчанию `200px`. + +**Цвет тултипа:** Цвет, который будет использован в некоторых типах тултипа. По умолчанию `#ffffff`. + +**Теги шаблона** + +| | | +|---------|---------| +| `$mark` | Показать метку, если данный рабочий стол активен. Иначе показывает пробелы | +| `$name` | Имя рабочего стола. | +| `$number` | Номер рабочего стола. | +| `$total` | Общее число рабочих столов. | + + + + +## Графический интерфейс + +## Скриншоты + +
+ {% assign scrdesc = "Виджет (кликабельно)" %} + {% assign scrname = "awesomewidgets_widget" %} + {% include prj_scr.html %} + {% assign scrdesc = "Окно настроек" %} + {% assign scrname = "awesomewidgets_config_01" %} + {% include prj_scr.html %} + {% assign scrdesc = "Окно настроек" %} + {% assign scrname = "awesomewidgets_config_02" %} + {% include prj_scr.html %} + {% assign scrdesc = "Окно настроек" %} + {% assign scrname = "awesomewidgets_config_03" %} + {% include prj_scr.html %} + {% assign scrdesc = "Окно настроек" %} + {% assign scrname = "awesomewidgets_config_04" %} + {% include prj_scr.html %} + {% assign scrdesc = "Окно настроек" %} + {% assign scrname = "awesomewidgets_config_05" %} + {% include prj_scr.html %} + {% assign scrdesc = "Тултипы" %} + {% assign scrname = "awesomewidgets_tooltips" %} + {% include prj_scr.html %} +
diff --git a/ru/projects/git-etc.html b/ru/projects/git-etc.html deleted file mode 100644 index ef7677b..0000000 --- a/ru/projects/git-etc.html +++ /dev/null @@ -1,188 +0,0 @@ ---- -category: ru -hastr: true -layout: project -title: git-etc -short: git-etc -tags: git, python, qt, linux, system, демон -hasgui: true -hasdocs: false -developers: - - Evgeniy Alekseev -license: GPLv3 -links: - - Пакет в AUR ---- - -

Информация

-

Простой демон, который создает git репозиторий в указанной директории и создает коммит в указанный промежуток времени.

- -{% highlight bash %} -$ git-etc --help -Simple daemon written on BASH for monitoring changes in files - -Usage: git-etc [ -c | --config /etc/git-etc.conf ] [ -h | --help ] [ -v | --version ] - -Parametrs: - -c --config - path to configuration file - -h --help - show this help and exit - -v --version - show version and exit - -See "man 1 git-etc" for more details -{% endhighlight %} - -{% highlight bash %} -$ ctrlconf --help -GUI for git-etc daemon - -Usage: ctrlconf [ --default ] [ -h | --help ] [ -v | --version ] - -Additional parametrs: - --default - create default configuration file - -h --help - show this help and exit - -v --version - show version and exit - -See "man 1 ctrlconf" for more details -{% endhighlight %} - -

Разработчики

-
    - {% for devel in page.developers %} -
  • {{ devel }}
    • - {% endfor %} -
- -

Лицензия

-
    -
  • {{ page.license }}
    • -
- - - -

Установка

- -

Инструкция

-
    -
  • Скачайте архив с актуальной версией исходных файлов.
    • -
  • Извлеките из него файлы и установите приложение: - -{% highlight bash %} -./install.sh "/путь/к/корню/" -{% endhighlight %} - -Если Вы хотите установить в /, Вы должны запустить это, как root: - -{% highlight bash %} -sudo ./install.sh -{% endhighlight %} - -Если путь не указан, пакет будет установлен в /.
    • -
- -

Зависимости

-

Все было протестировано на последних версиях зависимостей.

-
    -
  • Bash (включая awk, grep, sed)
    • -
  • git
    • -
  • python2 (make)
    • -
  • systemd (опционально, service-файл)
    • -
  • python2-pyqt4 (опционально, GUI)
    • -
  • xterm (опционально, GUI)
    • -
- - - -

Использование

-

Если Вы хотите запустить демон в /etc, просто запустите

- -{% highlight bash %} -systemctl start git-etc -{% endhighlight %} - -

Если Вы хотите включить автозагрузку демона, запутите

- -{% highlight bash %} -systemctl enable git-etc -{% endhighlight %} - -

Но Вы можете изменить путь к конфигурационному файлу или изменить параметры. Для этого, скопируйте (рекомендуется) исходный конфигурационный файл

- -{% highlight bash %} -cp /etc/git-etc.conf /новый/путь/к/git-etc.conf -{% endhighlight %} - -

и отредактируйте его. Затем скопируйте исходный service-файл в /etc:

- -{% highlight bash %} -cp /usr/lib/systemd/system/git-etc.service /etc/systemd/system/git-etc-my-profile.service -{% endhighlight %} - -

Замените следующую строку в этом файле:

- -{% highlight bash %} -ExecStart=/usr/bin/git-etc -c /etc/git-etc.conf -{% endhighlight %} - -

на

- -{% highlight bash %} -ExecStart=/usr/bin/git-etc -c /новый/путь/к/git-etc.conf -{% endhighlight %} - - - -

Настройка

-

Все настройки хранятся в /etc/git-etc.conf. После редактирования, Вы должны перезапустить демон

- -{% highlight bash %} -systemctl restart git-etc -{% endhighlight %} - -

Опции

- - - - - - - - - - - - - - - - - -
DIRECTORYПолный путь к рабочей директории с наблюдаемыми файлами. По умолчанию /etc.
TIMESLEEPПромежуток времени между обновлениями, часы. Должно быть целым и >= 1. По умолчанию 12.
IGNORELISTСписок файлов, которые не будут наблюдаться. Разделитель ";;". Может быть пустым.
FORALL1 включит доступ для обычного пользователя. По умолчанию 1.
- - - -

Графический интерфейс

-

Control Config (ctrlconf) - графический интерфейс для git-etc, написанный на Python2/PyQt4. Данное приложение позволяет Вам увидеть список коммитов и изменения в файлах в данных коммитах. Также данное приложение позволит Вам откатиться на указанный коммит (все файлы, посредством git reset --hard, или только указанный, посредством git diff && git apply). Также Вы можете объединить старый и новый конфигурационные файлы (используются две -ветки репозитория master и experimental). Приложение может потребовать привелегии root, убедитесь, что пакет sudo установлен.

- -

Настройка

-

Запустите приложение и откройте окно настроек из меню.

- -

Скриншоты

-
- {% assign scrdesc = "Основное окно" %} - {% assign scrname = "git-etc_mainwindow" %} - {% include prj_scr.html %} - {% assign scrdesc = "Окно 'О программе'" %} - {% assign scrname = "git-etc_aboutwindow" %} - {% include prj_scr.html %} - {% assign scrdesc = "Окно с просмотром изменений при коммите" %} - {% assign scrname = "git-etc_commitwindow" %} - {% include prj_scr.html %} - {% assign scrdesc = "Окно объединения" %} - {% assign scrname = "git-etc_mergingwindow" %} - {% include prj_scr.html %} - {% assign scrdesc = "Окно отката" %} - {% assign scrname = "git-etc_rollbackwindow" %} - {% include prj_scr.html %} -
- diff --git a/ru/projects/git-etc.md b/ru/projects/git-etc.md new file mode 100644 index 0000000..46507f5 --- /dev/null +++ b/ru/projects/git-etc.md @@ -0,0 +1,181 @@ +--- +category: ru +hastr: true +layout: project +title: git-etc +short: git-etc +tags: git, python, qt, linux, system, демон +hasgui: true +hasdocs: false +developers: + - Evgeniy Alekseev +license: GPLv3 +links: + - Пакет в AUR +--- + +## Информация + +Простой демон, который создает git репозиторий в указанной директории и создает коммит в указанный промежуток времени. + +```bash +$ git-etc --help +Simple daemon written on BASH for monitoring changes in files + +Usage: git-etc [ -c | --config /etc/git-etc.conf ] [ -h | --help ] [ -v | --version ] + +Parametrs: + -c --config - path to configuration file + -h --help - show this help and exit + -v --version - show version and exit + +See "man 1 git-etc" for more details +``` + +```bash +$ ctrlconf --help +GUI for git-etc daemon + +Usage: ctrlconf [ --default ] [ -h | --help ] [ -v | --version ] + +Additional parametrs: + --default - create default configuration file + -h --help - show this help and exit + -v --version - show version and exit + +See "man 1 ctrlconf" for more details +``` + +### Разработчики + +{% for devel in page.developers %} +* {{ devel }}{% endfor %} + +### Лицензия + +* {{ page.license }} + + + + +## Установка + +### Инструкция + +* Скачайте [архив](//github.com/arcan1s/git-etc/releases "GitHub") с актуальной версией исходных файлов. +* Извлеките из него файлы и установите приложение: + + ```bash + ./install.sh "/путь/к/корню/" + ``` + + Если Вы хотите установить в `/`, Вы должны запустить это, как root: + + ```bash + sudo ./install.sh + ``` + + Если путь не указан, пакет будет установлен в `/`. + +### Зависимости + +Все было протестировано на последних версиях зависимостей. + +* Bash (включая awk, grep, sed) +* git +* python2 *(make)* +* systemd *(опционально, service-файл)* +* python2-pyqt4 *(опционально, GUI)* +* xterm *(опционально, GUI)* + + + + +## Использование + +Если Вы хотите запустить демон в `/etc`, просто запустите + +```bash +systemctl start git-etc +``` + +Если Вы хотите включить автозагрузку демона, запутите + +```bash +systemctl enable git-etc +``` + +Но Вы можете изменить путь к конфигурационному файлу или изменить параметры. Для этого, скопируйте (рекомендуется) исходный конфигурационный файл + +```bash +cp /etc/git-etc.conf /новый/путь/к/git-etc.conf +``` + +и отредактируйте его. Затем скопируйте исходный service-файл в `/etc`: + +```bash +cp /usr/lib/systemd/system/git-etc.service /etc/systemd/system/git-etc-my-profile.service +``` + +Замените следующую строку в этом файле: + +```bash +ExecStart=/usr/bin/git-etc -c /etc/git-etc.conf +``` + +на + +```bash +ExecStart=/usr/bin/git-etc -c /новый/путь/к/git-etc.conf +``` + + + +## Настройка + +Все настройки хранятся в `/etc/git-etc.conf`. После редактирования, Вы должны перезапустить демон + +```bash +systemctl restart git-etc +``` + +### Опции + +| | | +|-------|-------| +| DIRECTORY | Полный путь к рабочей директории с наблюдаемыми файлами. По умолчанию `/etc`. | +| TIMESLEEP | Промежуток времени между обновлениями, часы. Должно быть целым и >= 1\. По умолчанию `12`. | +| IGNORELIST | Список файлов, которые не будут наблюдаться. Разделитель ";;". Может быть пустым. | +| FORALL | `1` включит доступ для обычного пользователя. По умолчанию `1`. | + + + +## Графический интерфейс + +Control Config (`ctrlconf`) - графический интерфейс для `git-etc`, написанный на `Python2/PyQt4`. Данное приложение позволяет Вам увидеть список коммитов и изменения в файлах в данных коммитах. Также данное приложение позволит Вам откатиться на указанный коммит (все файлы, посредством `git reset --hard`, или только указанный, посредством `git diff && git apply`). Также Вы можете объединить старый и новый конфигурационные файлы (используются две +ветки репозитория master и experimental). Приложение может потребовать привелегии root, убедитесь, что пакет `sudo` установлен. + +### Настройка + +Запустите приложение и откройте окно настроек из меню. + +### Скриншоты + +
+ {% assign scrdesc = "Основное окно" %} + {% assign scrname = "git-etc_mainwindow" %} + {% include prj_scr.html %} + {% assign scrdesc = "Окно 'О программе'" %} + {% assign scrname = "git-etc_aboutwindow" %} + {% include prj_scr.html %} + {% assign scrdesc = "Окно с просмотром изменений при коммите" %} + {% assign scrname = "git-etc_commitwindow" %} + {% include prj_scr.html %} + {% assign scrdesc = "Окно объединения" %} + {% assign scrname = "git-etc_mergingwindow" %} + {% include prj_scr.html %} + {% assign scrdesc = "Окно отката" %} + {% assign scrname = "git-etc_rollbackwindow" %} + {% include prj_scr.html %} +
+ diff --git a/ru/projects/netctl-gui.html b/ru/projects/netctl-gui.html deleted file mode 100644 index 8b7dfd1..0000000 --- a/ru/projects/netctl-gui.html +++ /dev/null @@ -1,209 +0,0 @@ ---- -category: ru -hastr: true -layout: project -title: Netctl GUI -short: netctl-gui -tags: archlinux, c++, qt, сеть, kde, netctl, система, dbus, библиотека -hasgui: true -hasdocs: true -developers: - - Evgeniy Alekseev - - nosada (перевод на японский) -license: GPLv3 -links: - - Страница на Softpedia - - Страница на kde-apps.org - - Пакет в AUR - - Описание DBus API - - Примечания о безопасности ---- - -

Информация

-

Графическая оболочка для netctl (набор скриптов для поднятия сети в Arch'е). Написана на C++ с использованием библиотеки Qt. На текущим момент умеет работать с профилями, в том числе создавать новые, а также умеет подключаться к WiFi. Также предоставляет библиотеку для взаимодействия с netctl и виджет и DataEngine для KDE.

- -

ВНИМАНИЕ: НУЖНЫ ПЕРЕВОДЧИКИ!

- -{% highlight bash %} -$ netctl-gui --help -Использование: -netctl-gui [ options ] -Опции: - Открыть окно: - --detached - запустить открепленным от консоли - --maximized - запустить развернутым - --minimized - запустить свернутым в трей - --about - показать окно "О программе" - --netctl-auto - показать окно netctl-auto - --settings - показать окно настроек - Функции: - -e, --essid - выбрать данный ESSID - -o, --open - открыть данный профиль - -s, --select - выбрать данный профиль - Дополнительные флаги: - -c, --config - прочитать настройки из данного файла - -d, --debug - показать отладочную информацию - --default - запустить со стандартными настройками - --set-opts - установить опции для данного запуска, разделенные запятыми - -t, --tab - открыть вкладку с этим номером - Показать сообщения: - -v, --version - показать версию и выход - -i, --info - показать информацию о сборке и выход - -h, --help - показать справку и выход -{% endhighlight %} - -{% highlight bash %} -$ netctlgui-helper --help -Использование: -netctlgui-helper [ options ] -Опции: - -c, --config - прочитать настройки из данного файла - -d, --debug - показать отладочную информацию - --nodaemon - не запускать как демон - --replace - принудительно заменить существующую сессию - --restore - принудительно восстановить существующую сессию - --system - не считывать пользовательские настройки, только системные - Показать сообщения: - -v, --version - показать версию и выход - -i, --info - показать информацию о сборке и выход - -h, --help - показать справку и выход -{% endhighlight %} - -

Разработчики

-
    - {% for devel in page.developers %} -
  • {{ devel }}
    • - {% endfor %} -
- -

Лицензия

-
    -
  • {{ page.license }}
    • -
- -

Changelog

-

CHANGELOG

- - - -

Установка

- -

Инструкция

-
    -
  • Скачайте архив с актуальной версией исходных файлов.
    • -
  • Извлеките из него файлы и установите приложение. Если Вы хотите установить в /, Вы должны запустить как root: - -{% highlight bash %} -cd /путь/к/распакованному/архиву -mkdir build && cd build -cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release ../ -make -sudo make install -{% endhighlight %} - -Доступные флаги cmake: -
      -
    • компоненты: -
        -
      • -DBUILD_DATAENGINE:BOOL=0 - не собирать DataEngine
        • -
      • -DBUILD_GUI:BOOL=0 - не собирать GUI
        • -
      • -DBUILD_HELPER:BOOL=0 - не собирать хелпер
        • -
      • -DBUILD_LIBRARY:BOOL=0 - не собирать библиотеку
        • -
      • -DBUILD_PLASMOID:BOOL=0 - не собирать плазмоид
        • -
      • -
    • дополнительные компоненты: -
        -
      • -DBUILD_DOCS:BOOL=0 - не собирать документацию разработчика
        • -
      • -DBUILD_TEST:BOOL=1 - собирать авто тесты для библиотеки и хелпера
        • -
      • -
    • свойства проекта: -
        -
      • -DDBUS_SYSTEMCONF_PATH=/etc/dbus-1/system.d/ - путь к системный файлам конфигурации DBus
        • -
      • -DSYSTEMD_SERVICE_PATH=lib/systemd/system - путь к сервису systemd
        • -
      • -DUSE_CAPABILITIES:BOOL=0 - не использовать setcap, чтобы дать необходимые привилегии хелперу
        • -
      • -DBUILD_KDE4:BOOL=1 - собирать виджет под KDE4 вместо KF5
        • -
      • -DUSE_QT5:BOOL=0 - использовать Qt4 вместо Qt5
        • -
      • -
    • -
- -

Зависимости

-

Все было протестировано на последних версиях зависимостей.

-
    -
  • netctl
    • -
  • qt5-base (если используется Qt5) или qt4 (если используется Qt4)
    • -
  • automoc4 (make)
    • -
  • cmake (make)
    • -
  • qt5-tools (make, если используется Qt5)
    • -
  • kdebase-workspace (опционально, KDE4 виджет)
    • -
  • plasma-frameworks (опционально, KF5 виджет)
    • -
  • sudo (опционально, поддержка sudo)
    • -
  • wpa_supplicant (опционально, поддержка WiFi)
    • -
- - - -

Использование

-

Просто запустите приложение netctl-gui. Если потребуется (и если Вы используете KDE), можете добавить виджет netctl, предоставляемый приложением.

- - - -

Настройка

-

Рекомендуется использовать графический интерфейс для настройки. Конфигурационные файлы:

-
    -
  • $HOME/.config/netctl-gui.conf - пользовательские настройки GUI/хелпера
    • -
  • /etc/netctl-gui.conf - системные настройки хелпера
    • -
      -
    • $KDEHOME/share/config/plasma-dataengine-netctl.conf - пользовательские настройки DataEngine
      • -
    • $KDESYSTEM/share/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. Для редактирования настоятельно рекомендуется использовать графический интерфейс.

- - - -

Графический интерфейс

-

Графический интерфейс предоставляется приложением netctl-gui.

- -

Скриншоты

-
- {% assign scrdesc = "DataEngine" %} - {% assign scrname = "netctl-gui_dataengine" %} - {% include prj_scr.html %} - {% assign scrdesc = "Виджет" %} - {% assign scrname = "netctl-gui_plasmoid" %} - {% include prj_scr.html %} - {% assign scrdesc = "Настройки виджета" %} - {% assign scrname = "netctl-gui_plasmoid_conf_01" %} - {% include prj_scr.html %} - {% assign scrdesc = "Настройки виджета" %} - {% assign scrname = "netctl-gui_plasmoid_conf_02" %} - {% include prj_scr.html %} - {% assign scrdesc = "Настройки виджета" %} - {% assign scrname = "netctl-gui_plasmoid_conf_03" %} - {% include prj_scr.html %} - {% assign scrdesc = "Главное окно" %} - {% assign scrname = "netctl-gui_main" %} - {% include prj_scr.html %} - {% assign scrdesc = "Окно создания профиля" %} - {% assign scrname = "netctl-gui_profile" %} - {% include prj_scr.html %} - {% assign scrdesc = "WiFi меню" %} - {% assign scrname = "netctl-gui_wifi" %} - {% include prj_scr.html %} - {% assign scrdesc = "Окно 'О программе'" %} - {% assign scrname = "netctl-gui_about" %} - {% include prj_scr.html %} - {% assign scrdesc = "Окно netctl-auto" %} - {% assign scrname = "netctl-gui_netctl-auto" %} - {% include prj_scr.html %} - {% assign scrdesc = "Окно настроек" %} - {% assign scrname = "netctl-gui_settings" %} - {% include prj_scr.html %} -
- diff --git a/ru/projects/netctl-gui.md b/ru/projects/netctl-gui.md new file mode 100644 index 0000000..ee8c3d5 --- /dev/null +++ b/ru/projects/netctl-gui.md @@ -0,0 +1,206 @@ +--- +category: ru +hastr: true +layout: project +title: Netctl GUI +short: netctl-gui +tags: archlinux, c++, qt, сеть, kde, netctl, система, dbus, библиотека +hasgui: true +hasdocs: true +developers: + - Evgeniy Alekseev + - nosada (перевод на японский) +license: GPLv3 +links: + - Страница на Softpedia + - Страница на kde-apps.org + - Пакет в AUR + - Описание DBus API + - Примечания о безопасности +--- + +## Информация + +Графическая оболочка для `netctl` (набор скриптов для поднятия сети в Arch'е). Написана на `C++` с использованием библиотеки `Qt`. На текущим момент умеет работать с профилями, в том числе создавать новые, а также умеет подключаться к WiFi. Также предоставляет библиотеку для взаимодействия с netctl и виджет и DataEngine для KDE. + +**ВНИМАНИЕ:** [НУЖНЫ ПЕРЕВОДЧИКИ!](//github.com/arcan1s/netctl-gui/issues/3 "Тикет") + +```bash +$ netctl-gui --help +Использование: +netctl-gui [ options ] +Опции: + Открыть окно: + --detached - запустить открепленным от консоли + --maximized - запустить развернутым + --minimized - запустить свернутым в трей + --about - показать окно "О программе" + --netctl-auto - показать окно netctl-auto + --settings - показать окно настроек + Функции: + -e, --essid - выбрать данный ESSID + -o, --open - открыть данный профиль + -s, --select - выбрать данный профиль + Дополнительные флаги: + -c, --config - прочитать настройки из данного файла + -d, --debug - показать отладочную информацию + --default - запустить со стандартными настройками + --set-opts - установить опции для данного запуска, разделенные запятыми + -t, --tab - открыть вкладку с этим номером + Показать сообщения: + -v, --version - показать версию и выход + -i, --info - показать информацию о сборке и выход + -h, --help - показать справку и выход +``` + +```bash +$ netctlgui-helper --help +Использование: +netctlgui-helper [ options ] +Опции: + -c, --config - прочитать настройки из данного файла + -d, --debug - показать отладочную информацию + --nodaemon - не запускать как демон + --replace - принудительно заменить существующую сессию + --restore - принудительно восстановить существующую сессию + --system - не считывать пользовательские настройки, только системные + Показать сообщения: + -v, --version - показать версию и выход + -i, --info - показать информацию о сборке и выход + -h, --help - показать справку и выход +``` + +### Разработчики + +{% for devel in page.developers %} +* {{ devel }}{% endfor %} + +### Лицензия + +* {{ page.license }} + +### Changelog + +[CHANGELOG](//github.com/arcan1s/netctl-gui/blob/master/CHANGELOG "GitHub") + + + + +## Установка + +### Инструкция + +* Скачайте [архив](//github.com/arcan1s/netctl-gui/releases "GitHub") с актуальной версией исходных файлов. +* Извлеките из него файлы и установите приложение. Если Вы хотите установить в `/`, Вы должны запустить как root: + + ```bash + cd /путь/к/распакованному/архиву + mkdir build && cd build + cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release ../ + make + sudo make install + ``` + + Доступные флаги cmake: + + * компоненты: + * `-DBUILD_DATAENGINE:BOOL=0` - не собирать DataEngine + * `-DBUILD_GUI:BOOL=0` - не собирать GUI + * `-DBUILD_HELPER:BOOL=0` - не собирать хелпер + * `-DBUILD_LIBRARY:BOOL=0` - не собирать библиотеку + * `-DBUILD_PLASMOID:BOOL=0` - не собирать плазмоид + * дополнительные компоненты: + * `-DBUILD_DOCS:BOOL=0` - не собирать документацию разработчика + * `-DBUILD_TEST:BOOL=1` - собирать авто тесты для библиотеки и хелпера + * свойства проекта: + * `-DDBUS_SYSTEMCONF_PATH=/etc/dbus-1/system.d/` - путь к системный файлам конфигурации DBus + * `-DSYSTEMD_SERVICE_PATH=lib/systemd/system` - путь к сервису systemd + * `-DUSE_CAPABILITIES:BOOL=0` - не использовать setcap, чтобы дать необходимые привилегии хелперу + * `-DBUILD_KDE4:BOOL=1` - собирать виджет под KDE4 вместо KF5 + * `-DUSE_QT5:BOOL=0` - использовать Qt4 вместо Qt5 + +### Зависимости + +Все было протестировано на последних версиях зависимостей. + +* netctl +* qt5-base *(если используется Qt5)* **или** qt4 *(если используется Qt4)* +* automoc4 *(make)* +* cmake *(make)* +* qt5-tools *(make, если используется Qt5)* +* kdebase-workspace *(опционально, KDE4 виджет)* +* plasma-frameworks *(опционально, KF5 виджет)* +* sudo *(опционально, поддержка sudo)* +* wpa_supplicant *(опционально, поддержка WiFi)* + + + + +## Использование + +Просто запустите приложение `netctl-gui`. Если потребуется (и если Вы используете KDE), можете добавить виджет `netctl`, предоставляемый приложением. + + + + +## Настройка + +Рекомендуется использовать графический интерфейс для настройки. Конфигурационные файлы: + +* Графический интерфейс и хелпер + * `$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 +* DataEngine (KF5 версия) + * `$HOME/.config/plasma-dataengine-netctl.conf` - пользовательские настройки DataEngine + * `/etc/xdg/plasma-dataengine-netctl.conf` - системные настройки DataEngine + +Для настройки виджета и DataEngine рекомендуется использовать графический интерфейс. Все настройки графического интерфейса хранятся в `$HOME/.config/netctl-gui.conf`. Для редактирования настоятельно рекомендуется использовать графический интерфейс. + + + + +## Графический интерфейс + +Графический интерфейс предоставляется приложением `netctl-gui`. + +### Скриншоты + +
+ {% assign scrdesc = "DataEngine" %} + {% assign scrname = "netctl-gui_dataengine" %} + {% include prj_scr.html %} + {% assign scrdesc = "Виджет" %} + {% assign scrname = "netctl-gui_plasmoid" %} + {% include prj_scr.html %} + {% assign scrdesc = "Настройки виджета" %} + {% assign scrname = "netctl-gui_plasmoid_conf_01" %} + {% include prj_scr.html %} + {% assign scrdesc = "Настройки виджета" %} + {% assign scrname = "netctl-gui_plasmoid_conf_02" %} + {% include prj_scr.html %} + {% assign scrdesc = "Настройки виджета" %} + {% assign scrname = "netctl-gui_plasmoid_conf_03" %} + {% include prj_scr.html %} + {% assign scrdesc = "Главное окно" %} + {% assign scrname = "netctl-gui_main" %} + {% include prj_scr.html %} + {% assign scrdesc = "Окно создания профиля" %} + {% assign scrname = "netctl-gui_profile" %} + {% include prj_scr.html %} + {% assign scrdesc = "WiFi меню" %} + {% assign scrname = "netctl-gui_wifi" %} + {% include prj_scr.html %} + {% assign scrdesc = "Окно 'О программе'" %} + {% assign scrname = "netctl-gui_about" %} + {% include prj_scr.html %} + {% assign scrdesc = "Окно netctl-auto" %} + {% assign scrname = "netctl-gui_netctl-auto" %} + {% include prj_scr.html %} + {% assign scrdesc = "Окно настроек" %} + {% assign scrname = "netctl-gui_settings" %} + {% include prj_scr.html %} +
+ diff --git a/ru/projects/oblikuestrategies.html b/ru/projects/oblikuestrategies.html deleted file mode 100644 index 1e55995..0000000 --- a/ru/projects/oblikuestrategies.html +++ /dev/null @@ -1,107 +0,0 @@ ---- -category: ru -hastr: true -layout: project -title: Oblikue strategies -short: oblikuestrategies -tags: qt, c++, kde, linux, досуг -hasgui: true -hasdocs: false -developers: - - Evgeniy Alekseev -license: GPL -links: - - Страница на kde-look.org - - Пакет в AUR ---- - -

Информация

-

Плазмоид, написанный на CPP который показывает случайные карты из Brian Eno и Peter Schmidt's Oblique Strategies. Это форк апплета для GNOME с некоторыми дополнительными фичами.

- -

Разработчики

-
    - {% for devel in page.developers %} -
  • {{ devel }}
    • - {% endfor %} -
- -

Лицензия

-
    -
  • {{ page.license }}
    • -
- - - -

Установка

- -

Инструкция

-
    -
  • Скачайте архив с актуальной версией исходных файлов.
    • -
  • Извлеките из него файлы и установите приложение. Для глобальной установки наберите: - -{% highlight bash %} -cd /путь/куда/распакован/архив -mkdir build && cd build -cmake -DCMAKE_INSTALL_PREFIX=`kde4-config --prefix` -DCMAKE_BUILD_TYPE=Release ../ -make -sudo make install -{% endhighlight %} - -Для локальной: - -{% highlight bash %} -cd /where/your/applet/is/installed -mkdir build && cd build -cmake -DCMAKE_INSTALL_PREFIX=`kde4-config --localprefix` -DCMAKE_BUILD_TYPE=Release ../ -make -make install -{% endhighlight %} - -
    • -
  • Перезапустите plasma, чтобы загрузить апплет: - -{% highlight bash %} -kquitapp plasma-desktop && sleep 2 && plasma-desktop -{% endhighlight %} - -Также Вам может потребоваться запустить kbuildsycoca4, чтобы распознать *.desktop файл: - -{% highlight bash %} -kbuildsycoca4 &> /dev/null -{% endhighlight %} - -
    • -
- -

Зависимости

-

Все было протестировано на последних версиях зависимостей.

-
    -
  • kdebase-workspace
    • -
  • automoc4 (make)
    • -
  • cmake (make)
    • -
- - - -

Использование

-

Откройте список виджетов Plasma и выберете Oblikue strategies.

- - - -

Настройка

-

Клик правой кнопкой по виджету.

- - - -

Графический интерфейс

- -

Скриншоты

-
- {% assign scrdesc = "Виджет" %} - {% assign scrname = "oblikuestrategies_widget" %} - {% include prj_scr.html %} - {% assign scrdesc = "Окно настроек" %} - {% assign scrname = "oblikuestrategies_config" %} - {% include prj_scr.html %} -
- diff --git a/ru/projects/oblikuestrategies.md b/ru/projects/oblikuestrategies.md new file mode 100644 index 0000000..2ca47ef --- /dev/null +++ b/ru/projects/oblikuestrategies.md @@ -0,0 +1,108 @@ +--- +category: ru +hastr: true +layout: project +title: Oblikue strategies +short: oblikuestrategies +tags: qt, c++, kde, linux, досуг +hasgui: true +hasdocs: false +developers: + - Evgeniy Alekseev +license: GPL +links: + - Страница на kde-look.org + - Пакет в AUR +--- + +## Информация + +Плазмоид, написанный на `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") с некоторыми дополнительными фичами. + +### Разработчики + +{% for devel in page.developers %} +* {{ devel }}{% endfor %} + +### Лицензия + +* {{ page.license }} + + + + +## Установка + +### Инструкция + +* Скачайте [архив](//github.com/arcan1s/oblikuestrategies/releases "GitHub") с актуальной версией исходных файлов. +* Извлеките из него файлы и установите приложение. Для глобальной установки наберите: + + ```bash + cd /путь/куда/распакован/архив + mkdir build && cd build + cmake -DCMAKE_INSTALL_PREFIX=`kde4-config --prefix` -DCMAKE_BUILD_TYPE=Release ../ + make + sudo make install + ``` + + Для локальной: + + ```bash + cd /where/your/applet/is/installed + mkdir build && cd build + cmake -DCMAKE_INSTALL_PREFIX=`kde4-config --localprefix` -DCMAKE_BUILD_TYPE=Release ../ + make + make install + ``` + +* Перезапустите plasma, чтобы загрузить апплет: + + ```bash + kquitapp plasma-desktop && sleep 2 && plasma-desktop + ``` + + Также Вам может потребоваться запустить `kbuildsycoca4`, чтобы распознать `*.desktop` файл: + + ```bash + kbuildsycoca4 &> /dev/null + ``` + +### Зависимости + +Все было протестировано на последних версиях зависимостей. + +* kdebase-workspace +* automoc4 *(make)* +* cmake *(make)* + + + + +## Использование + +Откройте список виджетов Plasma и выберете `Oblikue strategies`. + + + + +## Настройка + +Клик правой кнопкой по виджету. + + + + +## Графический интерфейс + +### Скриншоты + +
+ {% assign scrdesc = "Виджет" %} + {% assign scrname = "oblikuestrategies_widget" %} + {% include prj_scr.html %} + {% assign scrdesc = "Окно настроек" %} + {% assign scrname = "oblikuestrategies_config" %} + {% include prj_scr.html %} +
+ diff --git a/ru/projects/queued.html b/ru/projects/queued.html deleted file mode 100644 index b1cb3c6..0000000 --- a/ru/projects/queued.html +++ /dev/null @@ -1,170 +0,0 @@ ---- -category: ru -hastr: true -layout: project -title: queued -short: queued -tags: linux, shell, демон, система -hasgui: false -hasdocs: false -developers: - - Evgeniy Alekseev -license: GPLv3 -links: ---- - -

Информация

-

Демон для запуска задач в очередь вычислений. Был создан, как proof-of-concept.

- -{% highlight bash %} -$ queued --help -Simple daemon written on BASH for starting jobs to queue of calculations - -Usage: queued [ -c /etc/queued.conf ] [ -v | --version ] [ -h | --help ] -Parametrs: - -c PATH - path to configuration file. Default is '/etc/queued.conf' - - -v --version - show version and exit - -h --help - show this help and exit -{% endhighlight %} - -{% highlight bash %} -$ add_queued --help -add_queued [ -c /etc/queued.conf ] [ -p NUM ] [ -u USER ] [ -h | --help ] /path/to/script - -Parameters: - -c PATH - path to configuration file. Default is '/etc/queued.conf' - -p NUM - job priority - -u USER - username - -h --help - show this help and exit -{% endhighlight %} - -

Разработчики

-
    - {% for devel in page.developers %} -
  • {{ devel }}
    • - {% endfor %} -
- -

Лицензия

-
    -
  • {{ page.license }}
    • -
- - - -

Установка

- -

Инструкция

-
    -
  • Скачайте архив с актуальной версией исходных файлов.
    • -
  • Извлеките из него файлы и установите приложение: - -{% highlight bash %} -./install.sh "/путь/к/корню/" -{% endhighlight %} - -Если Вы хотите установить в /, Вы должны запустить это, как root: - -{% highlight bash %} -sudo ./install.sh -{% endhighlight %} - -Если путь не указан, пакет будет установлен в /.
    • -
- -

Зависимости

-

Все было протестировано на последних версиях зависимостей.

-
    -
  • Bash (включая awk, grep, sed)
    • -
  • systemd (опционально, service-файл)
    • -
- - - -

Использование

-

Если Вы хотите запустить демон, просто запустите

- -{% highlight bash %} -systemctl start queued -{% endhighlight %} - -

Если Вы хотите включить автозагрузку демона, запутите

- -{% highlight bash %} -systemctl enable queued -{% endhighlight %} - -

Но Вы можете изменить путь к конфигурационному файлу или изменить параметры. Для этого, скопируйте (рекомендуется) исходный конфигурационный файл

- -{% highlight bash %} -cp /etc/queued.conf /новый/путь/к/queued.conf -{% endhighlight %} - -

и отредактируйте его. Затем скопируйте исходный service-файл в /etc:

- -{% highlight bash %} -cp /usr/lib/systemd/system/queued.service /etc/systemd/system/queued-my-profile.service -{% endhighlight %} - -

Замените следующую строку в этом файле:

- -{% highlight bash %} -ExecStart=/usr/bin/queued -{% endhighlight %} - -

на

- -{% highlight bash %} -ExecStart=/usr/bin/queued -c /path/to/new/queued.conf -{% endhighlight %} - -

Добавление задачи

-
    -
  1. Создайте скрипт с командой (например, с именем script.sh).
    2. -
  2. Создайте файл с приоритетом (script.sh.pr) для данной задачи, если это необходимо.
    3. -
  3. Создайте файл с именем пользователя (script.sh.user) для данной задачи, если это необходимо
    4. -
  4. Скопируйте файлы в $WORKDIR
    5. -
-

Также Вы можете воспользоваться add_queued.

- -

Настройка

-

Все настройки хранятся в /etc/queued.conf. После редактирования, Вы должны перезапустить демон

- -{% highlight bash %} -systemctl restart queued -{% endhighlight %} - - - -

Опции

- - - - - - - - - - - - - - - - - - - - - - - - - -
WORKDIRПолный путь к директории с исходными файлами задач. По умолчанию /var/lib/queued/work. Эта директория должна содержать исходные скрипты script-name, файл с приоритетом (если необходимо) script-name.pr и файл с именем пользователя (если необходимо) script-name.user.
JOBDIRПолный путь к директории с запущенными задачами. По умолчанию /var/lib/queued/job. Все файлы будут перемещены сюда.
QUEUEFILEПолный путь к файлу с очередью вычислений. По умолчанию /var/lib/queued/queue.
PRIORITYСтандартный приоритет. По умолчанию 0. Чем выше значение, тем выше приоритет задачи.
SLEEPTIMEИнтервал обновлений в минутах. По умолчанию 5.
STARTASUSERСтандартное имя пользователя. По умолчанию root. Именно данному пользователю будут принадлежать все созданные файлы.
- - - - diff --git a/ru/projects/queued.md b/ru/projects/queued.md new file mode 100644 index 0000000..1bcc026 --- /dev/null +++ b/ru/projects/queued.md @@ -0,0 +1,154 @@ +--- +category: ru +hastr: true +layout: project +title: queued +short: queued +tags: linux, shell, демон, система +hasgui: false +hasdocs: false +developers: + - Evgeniy Alekseev +license: GPLv3 +links: +--- + +## Информация + +Демон для запуска задач в очередь вычислений. Был создан, как proof-of-concept. + +```bash +$ queued --help +Simple daemon written on BASH for starting jobs to queue of calculations + +Usage: queued [ -c /etc/queued.conf ] [ -v | --version ] [ -h | --help ] +Parametrs: + -c PATH - path to configuration file. Default is '/etc/queued.conf' + + -v --version - show version and exit + -h --help - show this help and exit +``` + +```bash +$ add_queued --help +add_queued [ -c /etc/queued.conf ] [ -p NUM ] [ -u USER ] [ -h | --help ] /path/to/script + +Parameters: + -c PATH - path to configuration file. Default is '/etc/queued.conf' + -p NUM - job priority + -u USER - username + -h --help - show this help and exit +``` + +### Разработчики + +{% for devel in page.developers %} +* {{ devel }}{% endfor %} + +### Лицензия + +* {{ page.license }} + + + + +## Установка + +### Инструкция + +* Скачайте [архив](//github.com/arcan1s/queued/releases "GitHub") с актуальной версией исходных файлов. +* Извлеките из него файлы и установите приложение: + + ```bash + ./install.sh "/путь/к/корню/" + ``` + + Если Вы хотите установить в `/`, Вы должны запустить это, как root: + + ```bash + sudo ./install.sh + ``` + + Если путь не указан, пакет будет установлен в `/`. + +### Зависимости + +Все было протестировано на последних версиях зависимостей. + +* Bash (включая awk, grep, sed) +* systemd *(опционально, service-файл)* + + + + +## Использование + +Если Вы хотите запустить демон, просто запустите + +```bash +systemctl start queued +``` + +Если Вы хотите включить автозагрузку демона, запутите + +```bash +systemctl enable queued +``` + +Но Вы можете изменить путь к конфигурационному файлу или изменить параметры. Для этого, скопируйте (рекомендуется) исходный конфигурационный файл + +```bash +cp /etc/queued.conf /новый/путь/к/queued.conf +``` + +и отредактируйте его. Затем скопируйте исходный service-файл в `/etc`: + +```bash +cp /usr/lib/systemd/system/queued.service /etc/systemd/system/queued-my-profile.service +``` + +Замените следующую строку в этом файле: + +```bash +ExecStart=/usr/bin/queued +``` + +на + +```bash +ExecStart=/usr/bin/queued -c /path/to/new/queued.conf +``` + +### Добавление задачи + +1. Создайте скрипт с командой (например, с именем `script.sh`). +2. Создайте файл с приоритетом (`script.sh.pr`) для данной задачи, если это необходимо. +3. Создайте файл с именем пользователя (`script.sh.user`) для данной задачи, если это необходимо +4. Скопируйте файлы в `$WORKDIR` + +Также Вы можете воспользоваться `add_queued`. + +## Настройка + +Все настройки хранятся в `/etc/queued.conf`. После редактирования, Вы должны перезапустить демон + +```bash +systemctl restart queued +``` + + + +### Опции + +| | | +|---------|---------| +| WORKDIR | Полный путь к директории с исходными файлами задач. По умолчанию `/var/lib/queued/work`. Эта директория должна содержать исходные скрипты `script-name`, файл с приоритетом (если необходимо) `script-name.pr` и файл с именем пользователя (если необходимо) `script-name.user`. | +| JOBDIR | Полный путь к директории с запущенными задачами. По умолчанию `/var/lib/queued/job`. Все файлы будут перемещены сюда. | +| QUEUEFILE | Полный путь к файлу с очередью вычислений. По умолчанию `/var/lib/queued/queue`. | +| PRIORITY | Стандартный приоритет. По умолчанию `0`. Чем выше значение, тем выше приоритет задачи. | +| SLEEPTIME | Интервал обновлений в минутах. По умолчанию `5`. | +| STARTASUSER | Стандартное имя пользователя. По умолчанию `root`. Именно данному пользователю будут принадлежать все созданные файлы. | + + + + diff --git a/ru/projects/reportabug.html b/ru/projects/reportabug.html deleted file mode 100644 index 31f6493..0000000 --- a/ru/projects/reportabug.html +++ /dev/null @@ -1,161 +0,0 @@ ---- -category: ru -hastr: true -layout: project -title: Report a Bug -short: reportabug -tags: qt, c++, библиотека, разработка -hasgui: false -hasdocs: true -developers: - - Evgeniy Alekseev -license: LGPLv3 -links: ---- - -

Информация

-

Приложение/библиотека, написанное на Qt, которое позволяет пользователям отправлять багрепорт для проектов, расположенных на GitHub. Оно может работать как через GitHub, так и через GitReports. Работает нормально, однако данное приложение было создано as proof-of-concept.

- -

Разработчики

-
    - {% for devel in page.developers %} -
  • {{ devel }}
    • - {% endfor %} -
- -

Лицензия

-
    -
  • {{ page.license }}
    • -
- - - -

Установка

- -

Инструкция

-

Сборка, как отдельное приложение

-
    -
  • Скачайте архив с актуальной версией исходных файлов.
    • -
  • Извлеките из него файлы и настройте под себя.
    • -
  • Установите приложение: - -{% highlight bash %} -cd /path/to/extracted/archive -mkdir build && cd build -cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release -DBUILD_AS_LIBRARY:BOOL=0 ../ -make -sudo make install -{% endhighlight %} - -
    • -
- -

Сборка, как библиотека в проекте

-
    -
  • Скачайте архив с актуальной версией исходных файлов.
    • -
  • Извлеките из него файлы и настройте под себя.
    • -
  • Включите библиотеку в Ваш проект. Например, если Вы используете cmake: - -{% highlight cmake %} -add_subdirectory (reportabug) -{% endhighlight %} - -
    • -
  • Объявите класс в Вашем приложении, например: - -{% highlight cpp %} -Reportabug *reportWindow = new Reportabug(parent=this, - debugCmd=false, - params=0); -reportWindow->showWindow(); -{% endhighlight %} - -
    • -
  • Слинкуйте Ваше приложение с библиотекой.
    • -
- -

Доступные флаги cmake

-
    -
  • -DBUILD_AS_LIBRARY=0 - собирать отдельное приложение, а не библиотеку.
    • -
  • -DBUILD_DOCS=1 - собирать документацию для разработчиков.
    • -
  • -DBUILD_SHARED_LIBRARY=1 - собирать библиотеку общего доступа, а не статическую.
    • -
  • -DENABLE_GITHUB=0 - отключить модуль GitHub.
    • -
  • -DENABLE_GITREPORT=0 - отключить модуль GitReports
    • -
  • -DOWN_GITHUB_TOKEN=STRING - использовать STRING, как свой GitHub токен.
    • -
  • -DUSE_QT5=0 - использовать Qt4 вместо Qt5.
    • -
- -

Зависимости

-

Все было протестировано на последних версиях зависимостей.

-
    -
  • qt5-base (если используется Qt5) или qt4 (если используется Qt4)
    • -
  • qt5-network (если используется Qt5)
    • -
  • automoc4 (make)
    • -
  • cmake (make)
    • -
  • doxygen (make, документация)
    • -
  • qt5-webkit (если используется Qt5) или qtwebkit (если используется Qt4) (опционально, требуется для модуля GitReports)
    • -
- - - -

Использование

-

Модуль GitHub

-

Данный модуль создает тикет, используя GitHub API. Данный модуль требует авторизации пользователя. Типичный POST запрос выглядит так:

- -{% highlight bash %} -curl -X POST -u user:pass -d '{"title":"A new bug","body":"Some error occurs"}' \ - //api.github.com/repos/owner/repo/issues -{% endhighlight %} - -

Для того, чтобы отключить данный модуль, используйте -DENABLE_GITHUB=0 флаг cmake.

- -

Также данный модуль может отправлять запросы, используя токен разработчика. Пожалуйста, посетите данную страницу и сгенерируйте токен. Требуемые права для токена - public_repo (или repo, если Вы используете для приватных репозиториев).
-Имейте в виду, что передача токена в открытом виде может скомпрометировать его!

- -

Типичный POST запрос выглядит так:

- -{% highlight bash %} -curl -X POST -H "Authorization: token token" -d '{"title":"A new bug","body":"Some error occurs"}' \ - //api.github.com/repos/owner/repo/issues -{% endhighlight %} - -

Для того, чтобы включить данный модуль, используйте -DOWN_GITHUB_TOKEN=STRING флаг cmake.

- -

Данный модуль требует наличия в системе QtNetwork.

- -

Модуль GitReports

-

Данный модуль создает тикет, используя возможности GitReports. Пожалуйста, посетите данную страницу и настройте под Ваши репозитории.

- -

Для того, чтобы отключить данный модуль, используйте -DENABLE_GITREPORT=0 флаг cmake. Данный модуль требует наличия в системе QtNetwork и QtWebKit.

- - - -

Настройка

-

Для настройки перед компиляцией отредактируйте хидер src/config.h. Также Вы можете подгрузить параметры автоматически, используя массив params (необходимые ключи такие же, как и для хидера).

-

Основные настройки

-
    -
  • OWNER - владелец репозитория.
    • -
  • PROJECT - имя проекта.
    • -
  • TAG_BODY - тело тикета по умолчанию. Может быть использовано в обоих модулях.
    • -
  • TAG_TITLE - имя тикета по умолчанию. Может быть использовано только в модуле GitHub.
    • -
  • TAG_ASSIGNEE - прикрепить тикет к данному аккаунту. Может быть использовано только в модуле GitHub. Данный тег будет работать, только если пользователь имеет права на запись. Если будет пустым, будет проигнорировано.
    • -
  • TAG_LABELS - установить данные метки тикету. Метки должны быть разделены запятыми. Может быть использовано только в модуле GitHub. Данный тег будет работать, только если пользователь имеет права на запись. Если будет пустым, будет проигнорировано.
    • -
  • TAG_MILESTONE - установить данную веху тикету. Может быть использовано только в модуле GitHub. Данный тег будет работать, только если пользователь имеет права на запись. Если будет пустым, будет проигнорировано.
    • -
- -

Настройки модуля GitHub

-
    -
  • GITHUB_COMBOBOX - текст модуля в ComboBox.
    • -
  • ISSUES_URL - URL, в большинстве случаев, не редактируйте его. По умолчанию //api.github.com/repos/$OWNER/$PROJECT/issues. Доступные теги $PROJECT, $OWNER.
    • -
- -

Настройки модуля GitReports

-
    -
  • CAPTCHA_URL - URL капчи, в большинстве случаев, не редактируйте его. По умолчанию //gitreports.com/simple_captcha?code=.
    • -
  • GITREPORT_COMBOBOX - текст модуля в ComboBox.
    • -
  • PUBLIC_URL - URL, в большинстве случаев, не редактируйте его. По умолчанию //gitreports.com/issue/$OWNER/$PROJECT. Доступные теги $PROJECT, $OWNER.
    • -
- - - - diff --git a/ru/projects/reportabug.md b/ru/projects/reportabug.md new file mode 100644 index 0000000..518c7f7 --- /dev/null +++ b/ru/projects/reportabug.md @@ -0,0 +1,157 @@ +--- +category: ru +hastr: true +layout: project +title: Report a Bug +short: reportabug +tags: qt, c++, библиотека, разработка +hasgui: false +hasdocs: true +developers: + - Evgeniy Alekseev +license: LGPLv3 +links: +--- + +## Информация + +Приложение/библиотека, написанное на Qt, которое позволяет пользователям отправлять багрепорт для проектов, расположенных на GitHub. Оно может работать как через [GitHub](//github.com "GitHub"), так и через [GitReports](//gitreports.com "GitReports"). Работает нормально, однако данное приложение было создано as proof-of-concept. + +### Разработчики + +{% for devel in page.developers %} +* {{ devel }}{% endfor %} + +### Лицензия + +* {{ page.license }} + + + + +## Установка + +### Инструкция +### Сборка, как отдельное приложение + +* Скачайте [архив](//github.com/arcan1s/reportabug/releases "GitHub") с актуальной версией исходных файлов. +* Извлеките из него файлы и настройте под себя. +* Установите приложение: + + ```bash + cd /path/to/extracted/archive + mkdir build && cd build + cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release -DBUILD_AS_LIBRARY:BOOL=0 ../ + make + sudo make install + ``` + +### Сборка, как библиотека в проекте + +* Скачайте [архив](//github.com/arcan1s/reportabug/releases "GitHub") с актуальной версией исходных файлов. +* Извлеките из него файлы и настройте под себя. +* Включите библиотеку в Ваш проект. Например, если Вы используете `cmake`: + + ```cmake + add_subdirectory (reportabug) + ``` + +* Объявите класс в Вашем приложении, например: + + ```cpp + Reportabug *reportWindow = new Reportabug(parent=this, debugCmd=false, params=0); + reportWindow->showWindow(); + ``` + +* Слинкуйте Ваше приложение с библиотекой. + +### Доступные флаги cmake + +* `-DBUILD_AS_LIBRARY=0` - собирать отдельное приложение, а не библиотеку. +* `-DBUILD_DOCS=1` - собирать документацию для разработчиков. +* `-DBUILD_SHARED_LIBRARY=1` - собирать библиотеку общего доступа, а не статическую. +* `-DENABLE_GITHUB=0` - отключить модуль GitHub. +* `-DENABLE_GITREPORT=0` - отключить модуль GitReports +* `-DOWN_GITHUB_TOKEN=STRING` - использовать STRING, как свой GitHub токен. +* `-DUSE_QT5=0` - использовать Qt4 вместо Qt5. + +### Зависимости + +Все было протестировано на последних версиях зависимостей. + +* qt5-base *(если используется Qt5)* **или** qt4 *(если используется Qt4)* +* qt5-network (если используется Qt5) +* automoc4 *(make)* +* cmake *(make)* +* doxygen *(make, документация)* +* qt5-webkit (если используется Qt5) **или** qtwebkit (если используется Qt4) *(опционально, требуется для модуля GitReports)* + + + + +## Использование + +### Модуль GitHub + +Данный модуль создает тикет, используя [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. + +Также данный модуль может отправлять запросы, используя токен разработчика. Пожалуйста, посетите [данную страницу](//github.com/settings/applications "Настройки") и сгенерируйте токен. Требуемые права для токена - **public_repo** (или **repo**, если Вы используете для приватных репозиториев). + +**Имейте в виду, что передача токена в открытом виде может скомпрометировать его!** + +Типичный POST запрос выглядит так: + +```bash +curl -X POST -H "Authorization: token token" -d '{"title":"A new bug","body":"Some error occurs"}' \ + //api.github.com/repos/owner/repo/issues +``` + +Для того, чтобы включить данный модуль, используйте `-DOWN_GITHUB_TOKEN=STRING` флаг cmake. + +Данный модуль требует наличия в системе `QtNetwork`. + +### Модуль GitReports + +Данный модуль создает тикет, используя возможности [GitReports](//gitreports.com/about "GitReports"). Пожалуйста, посетите [данную страницу](//gitreports.com/ "GitReports") и настройте под Ваши репозитории. + +Для того, чтобы отключить данный модуль, используйте `-DENABLE_GITREPORT=0` флаг cmake. Данный модуль требует наличия в системе `QtNetwork` и `QtWebKit`. + + + + +## Настройка + +Для настройки перед компиляцией отредактируйте хидер `src/config.h`. Также Вы можете подгрузить параметры автоматически, используя массив `params` (необходимые ключи такие же, как и для хидера). + +### Основные настройки + +* `OWNER` - владелец репозитория. +* `PROJECT` - имя проекта. +* `TAG_BODY` - тело тикета по умолчанию. Может быть использовано в обоих модулях. +* `TAG_TITLE` - имя тикета по умолчанию. Может быть использовано только в модуле GitHub. +* `TAG_ASSIGNEE` - прикрепить тикет к данному аккаунту. Может быть использовано только в модуле GitHub. Данный тег будет работать, только если пользователь имеет права на запись. Если будет пустым, будет проигнорировано. +* `TAG_LABELS` - установить данные метки тикету. Метки должны быть разделены запятыми. Может быть использовано только в модуле GitHub. Данный тег будет работать, только если пользователь имеет права на запись. Если будет пустым, будет проигнорировано. +* `TAG_MILESTONE` - установить данную веху тикету. Может быть использовано только в модуле GitHub. Данный тег будет работать, только если пользователь имеет права на запись. Если будет пустым, будет проигнорировано. + +### Настройки модуля GitHub + +* `GITHUB_COMBOBOX` - текст модуля в ComboBox. +* `ISSUES_URL` - URL, в большинстве случаев, не редактируйте его. По умолчанию `//api.github.com/repos/$OWNER/$PROJECT/issues`. Доступные теги `$PROJECT`, `$OWNER`. + +### Настройки модуля GitReports + +* `CAPTCHA_URL` - URL капчи, в большинстве случаев, не редактируйте его. По умолчанию `//gitreports.com/simple_captcha?code=`. +* `GITREPORT_COMBOBOX` - текст модуля в ComboBox. +* `PUBLIC_URL` - URL, в большинстве случаев, не редактируйте его. По умолчанию `//gitreports.com/issue/$OWNER/$PROJECT`. Доступные теги `$PROJECT`, `$OWNER`. + + + + +