mirror of
https://github.com/arcan1s/arcanis.me.git
synced 2025-07-15 06:05:47 +00:00
some update of ext description
This commit is contained in:
@ -25,7 +25,17 @@ simply editing the desktop file.
|
||||
Items are stored in the two directories: `/usr/share/awesomewidgets/%TYPE%/` and
|
||||
`$HOME/.local/share/awesomewidgets/%TYPE%/` (path may be differ in depend from
|
||||
your distro). Settings in the home directory have a higher priority that global
|
||||
ones.
|
||||
ones. Common settings for all extensions are:
|
||||
|
||||
| Field | Required | Value | Default |
|
||||
| -------------------|----------|----------------------------------|------------|
|
||||
| Name | yes | name | none |
|
||||
| Comment | no | comment | empty |
|
||||
| X-AW-Active | no | whether or not the item is active, N/A for bars | true |
|
||||
| X-AW-ApiVersion | yes | API compatibility index. Do not touch it if you don't know what does it mean | 0 |
|
||||
| X-AW-Interval | no | update interval in standard widget intervals, N/A for bars | 1 |
|
||||
| X-AW-Number | yes | unique number which will be associated with the item | random number which is less than 1000 |
|
||||
|
||||
|
||||
## <a href="#bars" class="anchor" id="bars"><span class="octicon octicon-link"></span></a>Bars
|
||||
|
||||
@ -33,8 +43,6 @@ Directory is `desktops`, configuration files have the following fields:
|
||||
|
||||
| Field | Required | Value | Default |
|
||||
| -------------------|----------|----------------------------------|------------|
|
||||
| Name | yes | bar name | none |
|
||||
| Comment | no | comment | empty |
|
||||
| X-AW-Custom | yes | does value have custom formula or not, boolean | false |
|
||||
| X-AW-Value | yes | bar value. The following tags are available `cpu*`, `gpu`, `mem`, `swap`, `hdd*`, `bat`. In case of `X-AW-Custom=true` it uses syntax similar to [lambda functions](/projects/awesome-widgets/#lambda) | cpu |
|
||||
| X-AW-Max | no | maximal possible value, float | 100.0 |
|
||||
@ -46,7 +54,6 @@ Directory is `desktops`, configuration files have the following fields:
|
||||
| X-AW-Direction | yes | the fill direction. The following variants are supported `LeftToRight`, `RightToLeft` | LeftToRight |
|
||||
| X-AW-Height | yes | height, pixels | 100 |
|
||||
| X-AW-Width | yes | width, pixels | 100 |
|
||||
| X-AW-Number | yes | unique number which will be associated with the script | random number which is less than 1000 |
|
||||
|
||||
## <a href="#quotes" class="anchor" id="quotes"><span class="octicon octicon-link"></span></a>Quotes
|
||||
|
||||
@ -56,12 +63,7 @@ following fields:
|
||||
|
||||
| Field | Required | Value | Default |
|
||||
|-------|----------|-------|---------|
|
||||
| Name | yes | quotes name | none |
|
||||
| Comment | no | comment | empty |
|
||||
| X-AW-Ticker | yes | ticker from Yahoo! Finance system | EURUSD=X |
|
||||
| X-AW-Active | no | whether or not the quotes is active | true |
|
||||
| X-AW-Interval | no | update interval in standard widget intervals | 1 |
|
||||
| X-AW-Number | yes | unique number which will be associated with the script | random number which is less than 1000 |
|
||||
|
||||
## <a href="#scripts" class="anchor" id="scripts"><span class="octicon octicon-link"></span></a>Scripts
|
||||
|
||||
@ -69,14 +71,9 @@ Directory is `scripts`, configuration files have the following fields:
|
||||
|
||||
| Field | Required | Value | Default |
|
||||
|-------|----------|-------|---------|
|
||||
| Name | yes | script name | none |
|
||||
| Comment | no | comment | empty |
|
||||
| Exec | yes | path to executable file | /usr/bin/true |
|
||||
| X-AW-Prefix | no | prefix to executable file. Usually it's not required, but in other you may want to specify interpreter for example |
|
||||
| X-AW-Active | no | whether or not the script is active | true |
|
||||
| X-AW-Redirect | no | stream redirection. The following variants are available `stderr2stdout`, `nothing`, `stdout2stderr`, `swap`. stderr will be available, if you run application in the debug mode | nothing |
|
||||
| X-AW-Interval | no | update interval in standard widget intervals | 1 |
|
||||
| X-AW-Number | yes | unique number which will be associated with the script | random number which is less than 1000 |
|
||||
| X-AW-Filters | no | comma separated filters from `awesomewidgets-extscripts-filters.json` |
|
||||
|
||||
## <a href="#upgrade" class="anchor" id="upgrade"><span class="octicon octicon-link"></span></a>Upgrade
|
||||
@ -85,14 +82,9 @@ Directory is `upgrade`, configuration files have the following fields:
|
||||
|
||||
| Field | Required | Value | Default |
|
||||
|-------|----------|-------|---------|
|
||||
| Name | yes | upgrade name | none |
|
||||
| Comment | no | comment | empty |
|
||||
| Exec | yes | path to executable file | /usr/bin/true |
|
||||
| X-AW-Filter | no | the regexp which will be applied to command output. If set `X-AW-Null` will be ignored |
|
||||
| X-AW-Active | no | whether or not the upgrade script is active | true |
|
||||
| X-AW-Null | no | the number of lines which should be skipped in output | 0 |
|
||||
| X-AW-Interval | no | update interval in standard widget intervals | 1 |
|
||||
| X-AW-Number | yes | unique number which will be associated with the bar | random number which is less than 1000 |
|
||||
|
||||
## <a href="#weather" class="anchor" id="weather"><span class="octicon octicon-link"></span></a>Weather
|
||||
|
||||
@ -102,12 +94,8 @@ following fields:
|
||||
|
||||
| Field | Required | Value | Default |
|
||||
|-------|----------|-------|---------|
|
||||
| Name | yes | weather name | none |
|
||||
| Comment | no | comment | empty |
|
||||
| X-AW-City | yes | city | London |
|
||||
| X-AW-Country | yes | two-letter country code | uk |
|
||||
| X-AW-Image | no | use images as weather icon or text. | false |
|
||||
| X-AW-Provider | yes | weather provider. Supported ones are `Yahoo`, `OWM` | OWM |
|
||||
| X-AW-TS | yes | time to which weather should be. `0` is a current weather, `1` - weather 3 hours later, etc | 0 |
|
||||
| X-AW-Active | no | whether or not the monitor is active | true |
|
||||
| X-AW-Interval | no | update interval in standard widget intervals | 1 |
|
||||
| X-AW-Number | yes | unique number which will be associated with the upgrade weather | random number which is less than 1000 |
|
||||
|
@ -35,7 +35,11 @@ fields inside `[Desktop Entry]` section:
|
||||
| -------------------|----------|----------------------------------|------------|
|
||||
| Name | yes | formatter name | none |
|
||||
| Comment | no | comment | empty |
|
||||
| X-AW-Type | no | formatter type. The following types are supported: `NoFormat`, `DateTime`, `Float`, `List`, `Script` | NoFormat |
|
||||
| X-AW-ApiVersion | yes | API compatibility index. Do not touch it if you don't know what does it mean | 0 |
|
||||
| X-AW-Type | no | formatter type. The following types are supported: `NoFormat`, `DateTime`, `Float`, `List`, `Script`, `String` | NoFormat |
|
||||
|
||||
Additionaly the following fields will be added by common extesions: `X-AW-Active`,
|
||||
`X-AW-Interval`, `X-AW-Number`, but they will be ignored.
|
||||
|
||||
Each formatter type has own behaviour and own settings and they are described
|
||||
below. Also there are system-wide settings which are stored in `/usr/share/awesomewidgets/formatters/`, system formatters will be overwritten by
|
||||
@ -66,7 +70,7 @@ Converts any number to string.
|
||||
| X-AW-Multiplier | no | float to which value will be multiplied | 1.0 |
|
||||
| X-AW-Precision | no | show this count of symbols after dot | -1 (as expected) |
|
||||
| X-AW-Summand | no | float to which value will be increased | 0.0 |
|
||||
| X-AW-Width | no | width of the field | 0 (do not limit) |
|
||||
| X-AW-Width | no | width of the field, negative means left-alignment | 0 (do not limit) |
|
||||
|
||||
Please note that actual formula is `X-AW-Multiplier * value + X-AW-Summand`.
|
||||
|
||||
@ -80,6 +84,16 @@ Coverts list of string objects to string.
|
||||
| X-AW-Separator | no | use this separator to join strings | (empty |
|
||||
| X-AW-Sort | no | boolean, sort or not list | false |
|
||||
|
||||
## <a href="#formatter-script" class="anchor" id="formatter-script"><span class="octicon octicon-link"></span></a>String formatter
|
||||
|
||||
Improved version of `NoFormat`.
|
||||
|
||||
| Field | Required | Value | Default |
|
||||
| -------------------|----------|----------------------------------|------------|
|
||||
| X-AW-FillChar | no | char to fill string to `X-AW-Width` | (space) |
|
||||
| X-AW-ForceWidth | no | strip string after `X-AW-Width` | false |
|
||||
| X-AW-Width | no | width of the field, negative means left-alignment | 0 (do not limit) |
|
||||
|
||||
## <a href="#formatter-script" class="anchor" id="formatter-script"><span class="octicon octicon-link"></span></a>Script formatter
|
||||
|
||||
Uses javascript code to convert value to string. Value will be passed as argument
|
||||
|
Reference in New Issue
Block a user