Llewellyn/conky
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/conky.git synced 2024-09-27 12:49:01 +00:00
Code Issues Releases Activity

More doc fixes.

Browse Source
This commit is contained in:
Brenden Matthews 2022-10-12 11:39:19 -05:00 committed by Brenden Matthews
parent 4473af9ed4
commit 8af8c8f68e
2 changed files with 103 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/README.md
View File

@ -34,4 +34,6 @@ process:
``` ```
These steps are also part of the CMake build, and can be executed by configuring These steps are also part of the CMake build, and can be executed by configuring
the build with `-DBUILD_DOCS=ON`. the build with `-DBUILD_DOCS=ON`. When building the docs with CMake, target
files are written to the CMake build directory, and not necessarily the same
path as the source files.

137
doc/variables.yaml
View File

@ -225,8 +225,9 @@ values:
Reads a file and displays the contents in conky. This is Reads a file and displays the contents in conky. This is
useful if you have an independent process generating output that you useful if you have an independent process generating output that you
want to include in conky. This differs from $cat in that it parses the want to include in conky. This differs from $cat in that it parses the
contents of the file, so you can insert things like ${color contents of the file, so you can insert things like
red}hi!${color} in your file and have it correctly parsed by Conky. `${color red}hi!${color}` in your file and have it correctly parsed by
Conky.
args: args:
- file - file
- name: cmdline_to_pid - name: cmdline_to_pid
@ -1943,34 +1944,92 @@ values:
- name: stock - name: stock
desc: |- desc: |-
Displays the data of a stock symbol. The following data is Displays the data of a stock symbol. The following data is
supported: adv(Average Daily Volume), ask, asksize, bid, askrt(ask supported:
realtime), bidrt(bid realtime), bookvalue, bidsize, change,
commission, changert(change realtime), ahcrt(After Hours Change | Name | Description |
realtime), ds(dividend/share), ltd(Last Trade Date), tradedate, |-------------|--------------------------------------------|
es(earnings/share), ei(error indication), epsecy(EPS Estimate Current | 1ytp | 1 yr Target Price |
Year), epseny(EPS Estimate Next Year), epsenq(EPS Estimate Next | 200ma | 200-day Moving Average |
Quarter), floatshares, dayslow, dayshigh, 52weeklow, 52weekhigh, | 50ma | 50-day Moving Average |
hgp(Holdings Gain Percent), ag(Annualized Gain), hg(Holdings Gain), | 52weekhigh | |
hgprt(Holdings Gain Percent realtime), hgrt(Holdings Gain realtime), | 52weeklow | |
moreinfo, obrt(Order Book realtime), mc(Market Capitalization), | 52weekrange | |
mcrt(Market Cap realtime), ebitda, c52wlow(Change From 52-week Low), | adv | Average Daily Volume |
pc52wlow(Percent Change From 52-week Low), cprt(change percent | ag | Annualized Gain |
realtime), lts(Last Trade Size), c52whigh(Change from 52-week high), | ahcrt | After Hours Change realtime |
pc52whigh(percent change from 52-week high), ltp(last trade price), | ask | |
hl(high limit), ll(low limit), dr(day's range), drrt(day's range | askrt | ask realtime |
realtime), 50ma(50-day Moving Average), 200ma(200-day Moving Average), | asksize | |
c200ma(Change From 200-day Moving Average), pc200ma(Percent Change | bid | |
From 200-day Moving Average), c50ma(Change From 50-day Moving | bidrt | bid realtime |
Average), pc50ma(Percent Change From 50-day Moving Average), name, | bidsize | |
notes, open, pc(previous close), pricepaid, cip(change in percent), | bookvalue | |
ps(price/sales), pb(price/book), edv(Ex-Dividend Date), per(P/E | c200ma | Change From 200-day Moving Average |
Ratio), dpd(Dividend Pay Date), perrt(P/E Ratio realtime), pegr(PEG | c50ma | Change From 50-day Moving Average |
Ratio), pepsecy(Price/EPS Estimate Current Year), pepseny(Price/EPS | c52whigh | Change from 52-week high |
Estimate Next Year), symbol, sharesowned, shortratio, ltt(Last Trade | c52wlow | Change From 52-week Low |
Time), tradelinks, tt(Ticker Trend), 1ytp(1 yr Target Price), volume, | change | |
hv(Holdings Value), hvrt(Holdings Value realtime), 52weekrange, | changert | change realtime |
dvc(Day's Value Change), dvcrt(Day's Value Change realtime), se(Stock | cip | change in percent |
Exchange), dy(Dividend Yield). | commission | |
| cprt | change percent realtime |
| dayshigh | |
| dayslow | |
| dpd | Dividend Pay Date |
| dr | day's range |
| drrt | day's range realtime |
| ds | dividend/share |
| dvc | Day's Value Change |
| dvcrt | Day's Value Change realtime |
| dy | Dividend Yield |
| ebitda | |
| edv | Ex-Dividend Date |
| ei | error indication |
| epsecy | EPS Estimate Current Year |
| epsenq | EPS Estimate Next Quarter |
| epseny | EPS Estimate Next Year |
| es | earnings/share |
| floatshares | |
| hg | Holdings Gain |
| hgp | Holdings Gain Percent |
| hgprt | Holdings Gain Percent realtime |
| hgrt | Holdings Gain realtime |
| hl | high limit |
| hv | Holdings Value |
| hvrt | Holdings Value realtime |
| ll | low limit |
| ltd | Last Trade Date |
| ltp | last trade price |
| lts | Last Trade Size |
| ltt | Last Trade Time |
| mc | Market Capitalization |
| mcrt | Market Cap realtime |
| moreinfo | |
| name | |
| notes | |
| obrt | Order Book realtime |
| open | |
| pb | price/book |
| pc | previous close |
| pc200ma | Percent Change From 200-day Moving Average |
| pc50ma | Percent Change From 50-day Moving Average |
| pc52whigh | percent change from 52-week high |
| pc52wlow | Percent Change From 52-week Low |
| pegr | PEG Ratio |
| pepsecy | Price/EPS Estimate Current Year |
| pepseny | Price/EPS Estimate Next Year |
| per | P/E Ratio |
| perrt | P/E Ratio realtime |
| pricepaid | |
| ps | price/sales |
| se | Stock Exchange |
| sharesowned | |
| shortratio | |
| symbol | |
| tradedate | |
| tradelinks | |
| tt | Ticker Trend |
| volume | |
args: args:
- symbol - symbol
- data - data
@ -2075,20 +2134,22 @@ values:
simple nesting of templates is possible this way. simple nesting of templates is possible this way.
Here are some examples of template definitions, note they are placed Here are some examples of template definitions, note they are placed
between \[\[ \... \]\] instead of \' \... \': between `[[ ... ]]` instead of ` ... `:
template0 = \[\[\$\\1\\2\]\]\ ```lua
template1 = \[\[\\1: \${fs_used \\2} / \${fs_size \\2}\]\]\ template0 = [[$12]]
template2 = \[\[\\1 \\2\]\] template1 = [[1: ${fs_used 2} / ${fs_size 2}]]
template2 = [[1 2]]
```
The following list shows sample usage of the templates defined above, The following list shows sample usage of the templates defined above,
with the equivalent syntax when not using any template at all: with the equivalent syntax when not using any template at all:
Using template Same without template
--------------------------------------------- ------------------------------------------ --------------------------------------------- ------------------------------------------
using template same without template ${template0 node name} $nodename
\${template0 node name} \$nodename ${template1 root /} root: ${fs_free /} / ${fs_size /}
\${template1 root /} root: \${fs_free /} / \${fs_size /} ${template1 ${template2 disk root} /} disk root: ${fs_free /} / ${fs_size /}
\${template1 \${template2\\ disk\\ root} /} disk root: \${fs_free /} / \${fs_size /}
--------------------------------------------- ------------------------------------------ --------------------------------------------- ------------------------------------------
args: args:
- (arg1) - (arg1)