Manjaro

Difference between revisions of "Basic Tips for conky"

Basic Tips for conky (view source)

Revision as of 14:54, 2 October 2020

1,705 bytes added ,  4 years ago
general reformatting and proofreading
imported>Dalto
(General clean-up, remove outdated links/references, formatting)
(general reformatting and proofreading)
Line 1: Line 1:
__TOC__
__TOC__
 
==Installation==
 
=Installation=
 
Conky can be installed with this command:
Conky can be installed with this command:
pamac install conky
{{UserCmd|command=pamac install conky}}
 
 
=Configuration=
 
==Configuration file==
 
Default Conky configuration file is located in:
~/.config/conky/conky.conf


==Configuration==
All file names starting with a dot <code>.</code> are hidden files. If you want to see hidden files in your file manager, you need to make them visible. In most file managers this will be available in the options.
All file names starting with a dot <code>.</code> are hidden files. If you want to see hidden files in your file manager, you need to make them visible. In most file managers this will be available in the options.


===Configuration file===
The default configuration file is located in <code>/usr/share/doc/conky-1.11.5_pre/conky.conf</code> where version are subject to change.
Conky do not create a local conky folder so you will have to create beforehand
{{UserCmd|command=mkdir -p ~/.config/conky}}
Then copy the default to home
{{UserCmd|command=cp /usr/share/doc/conky-1.11.5_pre/conky.conf ~/.config/conky/conky.conkyrc}}


<code>conky.conf</code> can be edited with every text editor. It's code is split into two parts:
The configuation file is a simple text file and the content written using [[https://www.lua.org/|LUA syntax]] and is split into two parts


* Configuration
* Text


==First Part - Window/Conky configuration==
===Conky configuration===
The first/upper part contains all the configuration settings for the entire conky. Things like the position of the conky on your screen, transparency settings, border settings, the default font and it's size, and how often your conky gets updated.
The first/upper part contains all the configuration settings for the entire conky. Things like the position of the conky on your screen, transparency settings, border settings, the default font and it's size, and how often your conky gets updated.


The whole configuration belong between these two accolade:
The whole configuration belong between these two accolade:
conky.config = {
{{File|file=~/.config/conky/conky.conkyrc|
}
content=<pre>conky.config = {
 
}
</pre>
}}
Some rules to respect:
Some rules to respect:


Every line end with <code>,</code>
* Every line end with <code>,</code>
 
* Non-boolean/numerical value should be placed between <code>'</code>
Non-boolean/numerical value should be placed between <code>'</code>
* Comment start with <code>--</code>
 
Comment start with <code>--</code>
 
 
===Examples:===


====Examples:====
'''1.''' This will set the default font color of your conky to white. Additionally, a <code>color1</code> gets set using a [http://html-color-codes.info/ Html Color Code]to a light blue:
'''1.''' This will set the default font color of your conky to white. Additionally, a <code>color1</code> gets set using a [http://html-color-codes.info/ Html Color Code]to a light blue:
conky.config = {
{{File|file=~/.config/conky/conky.conkyrc|
    default_color = 'white',    -- White default color
content=<pre>conky.config = {
    color1 = '0ab1ff',          -- Light blue
...
}
    default_color = 'white',    -- White default color
 
    color1 = '0ab1ff',          -- Light blue
...
}
</pre>
}}
'''2.''' This enables Xft, set the default font (LiberationMono), make it bold and set it's size (8):
'''2.''' This enables Xft, set the default font (LiberationMono), make it bold and set it's size (8):
conky.config = {
{{File|file=~/.config/conky/conky.conkyrc|
    use_xft = true,
content=<pre>conky.config = {
    font = 'LiberationMono:bold:size=8',
...
}
    use_xft = true,
 
    font = 'LiberationMono:bold:size=8',
...
}
</pre>
}}
'''3.''' In order to position your conky on your screen, modify these settings:
'''3.''' In order to position your conky on your screen, modify these settings:
conky.config = {
{{File|file=~/.config/conky/conky.conkyrc|
    alignment = 'top_right',    -- Conky gets placed in the top right corner of your desktop
content=<pre>conky.config = {
    gap_x 18,                    -- with a horizontal gap of 18 pixels (to your right screen edge)
...
    gap_y 20,                    -- and a vertical gap of 20 pixels (to your top screen edge).
    alignment = 'top_right',    -- Conky gets placed in the top right corner of your desktop
}
    gap_x 18,                    -- with a horizontal gap of 18 pixels (to your right screen edge)
 
    gap_y 20,                    -- and a vertical gap of 20 pixels (to your top screen edge).
...
}
</pre>
}}
'''4.''' In some case you can have multiple values for one setting, they will be separated by a coma:
'''4.''' In some case you can have multiple values for one setting, they will be separated by a coma:
conky.config = {
{{File|file=~/.config/conky/conky.conkyrc|
    own_window_hints = 'undecorated,sticky,skip_taskbar,skip_pager,below',
content=<pre>conky.config = {
}
...
 
    own_window_hints = 'undecorated,sticky,skip_taskbar,skip_pager,below',
...
}
</pre>
}}
Use the command: <code>man conky</code>, and look into the '''CONFIGURATION SETTINGS''' section to see every settings available.
Use the command: <code>man conky</code>, and look into the '''CONFIGURATION SETTINGS''' section to see every settings available.
 
===Conky text===
 
==Second Part - What is displayed by conky==
 
The second part contains the displayed conky code. Every code line corresponds to one displayed line on your desktop. There are a lot of available for displaying and modifying all kinds of information. Use the command: <code>man conky</code>, and look into the '''OBJECTS/VARIABLES''' section to see every objects/variables available.
The second part contains the displayed conky code. Every code line corresponds to one displayed line on your desktop. There are a lot of available for displaying and modifying all kinds of information. Use the command: <code>man conky</code>, and look into the '''OBJECTS/VARIABLES''' section to see every objects/variables available.
 
{{Info|The lines in the '''conky.text''' section is printed exactly as is. E.g. if you create an empty line between sections - conky will display an empty line.}}


The whole code belong between these two double bracket:
The whole code belong between these two double bracket:
conky.text = [[
{{File|file=~/.config/conky/conky.conkyrc|
]]
content=<pre>conky.text = [[
]]</pre>
}}


====Examples:====
'''1.''' You can choose the color of your font using one of the following variables:
{{File|file=~/.config/conky/conky.conkyrc|
content=<pre>conky.text = [[
...
${color}
${color1}
...
]]</pre>
}}


===Examples:===
'''1.''' You can choose the color of your font using one of the following variables:
${color}
${color1}
Every variable is marked with a <code>$</code> sign and by <code>{ }</code> brackets (only needed, if the variable contains more than one word).
Every variable is marked with a <code>$</code> sign and by <code>{ }</code> brackets (only needed, if the variable contains more than one word).


'''2.''' You can call the default font (and it's size) with this command:
'''2.''' You can call the default font (and it's size) with this command:
$font
{{File|file=~/.config/conky/conky.conkyrc|
content=<pre>conky.text = [[
...
$font
...
]]</pre>
}}
If you want a different font (DejaVuSerif) and font size (9) in your conky, use this command in your <code>.conkyrc</code> code:
If you want a different font (DejaVuSerif) and font size (9) in your conky, use this command in your <code>.conkyrc</code> code:
${font DejaVuSerif:size=9}
{{File|file=~/.config/conky/conky.conkyrc|
 
content=<pre>conky.text = [[
'''4.''' This code line displays the text "Kernel: " and the kernel you are using (using <code>$alignr</code> just yields a nicer formatting, it is not necessary: <code>$alignr</code> aligns all following text on the right of your conky):
...
Kernel: ${alignr}${kernel}
${font DejaVuSerif:size=9}
 
...
'''5.''' This variable gives you the latest 3 manjaro blog entry titles (using rss). It checks for updates every 60 minutes.
]]</pre>
${rss http://manjaro.org/feed/ 60 item_titles 3}
}}
 
'''3.''' This code line displays the text "Kernel: " and the kernel you are using (using <code>$alignr</code> just yields a nicer formatting, it is not necessary: <code>$alignr</code> aligns all following text on the right of your conky):
'''6.''' Information about the root partition <code>/</code> of your manjaro installation is displayed using
{{File|file=~/.config/conky/conky.conkyrc|
Root: ${alignr}${fs_used /} of ${fs_size /}
content=<pre>conky.text = [[
 
Kernel: ${alignr}${kernel}
'''7.''' Instead of example 4, you can use the following code to display the exact same information:
]]</pre>
Kernel: ${alignr}${execi 3600 uname -r}
}}
'''4.''' This variable gives you the latest 3 manjaro blog entry titles (using rss). It checks for updates every 60 minutes.
{{File|file=~/.config/conky/conky.conkyrc|
content=<pre>conky.text = [[
${rss http://manjaro.org/feed/ 60 item_titles 3}
]]</pre>
}}
'''5.''' Information about the root partition <code>/</code> of your manjaro installation is displayed using
{{File|file=~/.config/conky/conky.conkyrc|
content=<pre>conky.text = [[
Root: ${alignr}${fs_used /} of ${fs_size /}
]]</pre>
}}
'''6.''' Instead of example 3, you can use the following code to display the exact same information:
{{File|file=~/.config/conky/conky.conkyrc|
content=<pre>conky.text = [[
Kernel: ${alignr}${execi 3600 uname -r}
]]</pre>
}}
=====execi=====
The variable <code>${execi 3600 XXXX}</code> runs the <code>XXXX</code> bash code in your terminal every 3600 seconds and displays the result in your conky. The result of the <code>uname -r</code> bash command is your currently used kernel name.  
The variable <code>${execi 3600 XXXX}</code> runs the <code>XXXX</code> bash code in your terminal every 3600 seconds and displays the result in your conky. The result of the <code>uname -r</code> bash command is your currently used kernel name.  


Line 105: Line 146:
Warning: Using complicated bash commands (e.g. which call other programs or use large files) with low intervals (e.g. <code>${execi 2 XXXX}</code> runs the <code>XXXX</code> code once every 2 seconds and displays it's result in your conky) can use a lot of hardware resources and/or make your computer unresponsive.
Warning: Using complicated bash commands (e.g. which call other programs or use large files) with low intervals (e.g. <code>${execi 2 XXXX}</code> runs the <code>XXXX</code> code once every 2 seconds and displays it's result in your conky) can use a lot of hardware resources and/or make your computer unresponsive.


==Running conky==
If you want to display a conky on your desktop a {{ic|~/.config/conky/conky.conkyrc}} file with code in it is required. Next, open a terminal and run conky pointing to the file
{{UserCmd|command=conky -c ~/.config/conky/conky.conkyrc}}
or to run as background daemon
{{UserCmd|command=conky -d -c ~/.config/conky/conky.conkyrc}}


=Running conky=
If you want to run conky automatically after each boot of your computer, you need to find out how to autostart a program. This depends on the Desktop Manager you are using. The next is examples of how to run conky from your system autostart folder/file/script/command.
If you want to display a conky on your desktop a <code>.config/conky/conky.conf</code> file with code in it is required. Next, open a terminal and run conky:
conky
or
conky -d
if you want to run conky as a background daemon.
 
 
If you want to run conky automatically after each boot of your computer, you need to find out how to autostart a program. This depends on the Desktop Manager you are using. Putting one of the following commands into your autostart folder/file/script/command should work:
conky
 
sleep 20 && conky
 
conky -p 20
 
sh -c "sleep 20 && conky"
<code>sleep 20</code> and <code>-p 20</code> delay the start of conky by 20 seconds after your Desktop Environment has started. Adjust this value to your liking.
<code>sleep 20</code> and <code>-p 20</code> delay the start of conky by 20 seconds after your Desktop Environment has started. Adjust this value to your liking.


{{UserCmd|command=conky -c ~/.config/conky/conky.conkyrc &}}
{{UserCmd|command=sleep 20 && conky -c ~/.config/conky/conky.conkyrc &}}


If you want to reload conky with the latest <code>.conkyrc</code> file (e.g. because you changed a variable and want to see the consequences) use one of the following commands:
When you change the running conky configuration file - conky will reload. But if you changed one of your dependency scripts (e.g. because you changed a variable and want to see the consequences) you will have to reload conky
killall conky && conky
{{UserCmd|command=killall conky && conky -c ~/.config/config/conky.conkyrc}}


pkill conky && conky
==Troubleshooting & Tips==
 
 
=Troubleshooting & Tips=
 
==Missing rings==
If (often colored) rings are missing in your conky, you may install the package {{ic|conky-lua}} from [[Arch_User_Repository|AUR]] using your favorite package manager or with the command:
pamac build conky-lua


===Missing rings===
To be able to use LUA scripts to execute drawing functions like clock rings - you will a conky package compiled with LUA support. Either build the package the package {{ic|conky-lua}} from [[Arch_User_Repository|AUR]] or install the {{ic|conky-lua-nv}} from the official repo.


==Missing network information==
==Missing network information==
If network information is missing like download speed or network name (SSID), you need to replace the network interfaces in the configuration file with your network interface name. To get the names of your interfaces - open a terminal and execute
{{UserCmd|command=ip a | grep ' state UP' | cut -d' ' -f2 | cut -d':' -f1}}
Use the output from the command. Interface names starting with <code>en</code> is ethernet interface and names starting with <code>wl</code> is wireless interfaces. Replace all network interfaces names with (e.g. <code>wlan0</code>, <code>eth0</code>) in your <code>.conkyrc</code> text section with the interface name(s) you retrieved from the above command.


If network information is missing like download speed or network name (SSID), you need to replace the network card name in network variables in the <code>.conkyrc</code> file with your network card name.
==Conky Manager==
 
An application named Conky manager exist but has not been updated for years and the configurations found in the package may work or they may not. You may install it - it can be a used as an inspiration but you should not rely on it. If you still think you it is a must have - you can install Conky Manager build the package {{ic|conky-manager}} from [[Arch_User_Repository|AUR]]
Open a terminal and enter
{{UserCmd|command=pamac build conky-manager}}
ip a
in order to see all available network cards in your computer. A sample output looks like this:
$ ip a
1: lo: <LOOPBACK,UP,LOWER_UP> ....
2: enp9s0: <BROADCAST,MULTICAST,UP,LOWER_UP> .....
3: wlp2s0: <BROADCAST,MULTICAST> .....
In this case, <code>enp9s0</code> is the name of your ethernet card and <code>wlp2s0</code> is the name of your wireless network card. Replace all network card names (e.g. <code>wlan0</code>, <code>eth0</code>) in network variables in your <code>.conkyrc</code> file with your preferred network card name.
 
 
=Alternative: Conky Manager=


For everybody, who does not like to look at conky code and mess around in config files or who just wants a quick and simple conky, Conky Manager is great. Conky Manager offers a simple GUI for managing and customizing conkys. Additional theme packs are available, too.
==See Also==
 
To install Conky Manager install the package {{ic|conky-manager}} from [[Arch_User_Repository|AUR]] using your favorite package manager or with the command:
pamac build conky-manager
 
 
=See Also=


* The [https://github.com/brndnmtthws/conky/wiki Conky website]
* The [https://github.com/brndnmtthws/conky/wiki Conky website]
* The [https://wiki.archlinux.org/index.php/conky Arch Wiki] page for Conky
* The [https://wiki.archlinux.org/index.php/conky Arch Wiki] page for Conky


[[Category:Contents Page]]
[[Category:Contents Page]]
Fhdk
Moderators, translator
455

edits

Retrieved from "https://wiki.manjaro.org/index.php/Special:MobileDiff/6611"