Difference between revisions of "Basic Tips for conky"

Marked this version for translation
(Updated style)
(Marked this version for translation)
Line 1: Line 1:
<languages/>
<languages/>
__TOC__
__TOC__
{{SectionTemplate|<translate>Installation</translate>|<translate>Conky can be installed using the package manager</translate>
{{SectionTemplate|<translate><!--T:1--> Installation</translate>|<translate><!--T:2--> Conky can be installed using the package manager</translate>
{{UserCmd|command=pamac install conky}}}}
{{UserCmd|command=pamac install conky}}}}


{{SectionTemplate|<translate>Configuration</translate>|
{{SectionTemplate|<translate><!--T:3--> Configuration</translate>|
<translate>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.
<translate><!--T:4-->
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.
</translate>
</translate>
{{SubContentTemplate|<translate>Configuration file</translate>|
{{SubContentTemplate|<translate><!--T:5--> Configuration file</translate>|
<translate>
<translate>
<!--T:6-->
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.  
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
Conky do not create a local conky folder so you will have to create beforehand
Line 16: Line 18:
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
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


<!--T:7-->
* Configuration
* Configuration
* Text
* Text
</translate>|4=1}}
</translate>|4=1}}


{{SubContentTemplate|<translate>Conky configuration</translate>|
{{SubContentTemplate|<translate><!--T:8--> Conky configuration</translate>|
<translate>
<translate>
<!--T:9-->
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 brackets like this
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 brackets like this
{{File|file=~/.config/conky/conky.conkyrc|
{{File|file=~/.config/conky/conky.conkyrc|
Line 29: Line 33:
Some rules apply
Some rules apply


<!--T:10-->
* 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>
Line 37: Line 42:


}}
}}
{{SectionTemplate|<translate>Examples</translate>|
{{SectionTemplate|<translate><!--T:11--> Examples</translate>|
<translate>
<translate>
<!--T:12-->
'''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:
{{File|file=~/.config/conky/conky.conkyrc|
{{File|file=~/.config/conky/conky.conkyrc|
Line 79: Line 85:
}}
}}


{{SectionTemplate|<translate>Conky text</translate>|
{{SectionTemplate|<translate><!--T:13--> Conky text</translate>|
<translate>
<translate>
<!--T:14-->
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.}}
{{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.}}


<!--T:15-->
The whole code belong between these two double bracket:
The whole code belong between these two double bracket:
{{File|file=~/.config/conky/conky.conkyrc|
{{File|file=~/.config/conky/conky.conkyrc|
Line 90: Line 98:
}}
}}
</translate>}}
</translate>}}
{{SectionTemplate|<translate>Examples</translate>|
{{SectionTemplate|<translate><!--T:16--> Examples</translate>|
<translate>
<translate>
<!--T:17-->
'''1.''' You can choose the color of your font using one of the following variables:
'''1.''' You can choose the color of your font using one of the following variables:
{{File|file=~/.config/conky/conky.conkyrc|
{{File|file=~/.config/conky/conky.conkyrc|
Line 102: Line 111:
}}
}}


<!--T:18-->
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).


<!--T:19-->
'''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:
{{File|file=~/.config/conky/conky.conkyrc|
{{File|file=~/.config/conky/conky.conkyrc|
Line 147: Line 158:
}}
}}


{{SectionTemplate|<translate>execi</translate>|
{{SectionTemplate|<translate><!--T:20--> execi</translate>|
<translate>
<translate>
<!--T:21-->
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.  


<!--T:22-->
Use any bash command instead of <code>XXXX</code> you can think of. The bash commands can be as long and complicated as you want.  
Use any bash command instead of <code>XXXX</code> you can think of. The bash commands can be as long and complicated as you want.  


<!--T:23-->
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.
</translate>}}
</translate>}}


{{SectionTemplate|<translate>Running conky</translate>|
{{SectionTemplate|<translate><!--T:24--> Running conky</translate>|
<translate>
<translate>
<!--T:25-->
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
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}}
{{UserCmd|command=conky -c ~/.config/conky/conky.conkyrc}}
Line 163: Line 178:
{{UserCmd|command=conky -d -c ~/.config/conky/conky.conkyrc}}
{{UserCmd|command=conky -d -c ~/.config/conky/conky.conkyrc}}


<!--T:26-->
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 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.
<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.


<!--T:27-->
{{UserCmd|command=conky -c ~/.config/conky/conky.conkyrc &}}
{{UserCmd|command=conky -c ~/.config/conky/conky.conkyrc &}}
{{UserCmd|command=sleep 20 && conky -c ~/.config/conky/conky.conkyrc &}}
{{UserCmd|command=sleep 20 && conky -c ~/.config/conky/conky.conkyrc &}}


<!--T:28-->
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
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
{{UserCmd|command=killall conky && conky -c ~/.config/config/conky.conkyrc}}
{{UserCmd|command=killall conky && conky -c ~/.config/config/conky.conkyrc}}
</translate>}}
</translate>}}


{{SectionTemplate|<translate>Troubleshooting & Tips</translate>|
{{SectionTemplate|<translate><!--T:29--> Troubleshooting & Tips</translate>|


{{SubContentTemplate|<translate>Missing rings</translate>|
{{SubContentTemplate|<translate><!--T:30--> Missing rings</translate>|
<translate>
<translate>
<!--T:31-->
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.
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.
</translate>
</translate>
|4=1}}
|4=1}}


{{SubContentTemplate|<translate>Missing network information</translate>|
{{SubContentTemplate|<translate><!--T:32--> Missing network information</translate>|
<translate>
<translate>
<!--T:33-->
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
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}}
{{UserCmd|command=ip a | grep ' state UP' | cut -d' ' -f2 | cut -d':' -f1}}
Line 190: Line 210:
}}
}}


{{SectionTemplate|<translate>Conky Manager</translate>|
{{SectionTemplate|<translate><!--T:34--> Conky Manager</translate>|
<translate>
<translate>
<!--T:35-->
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 build the package {{ic|conky-manager}} using [[Arch_User_Repository|AUR]]
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 build the package {{ic|conky-manager}} using [[Arch_User_Repository|AUR]]
</translate>
</translate>
Line 197: Line 218:
}}
}}


{{SectionTemplate|<translate>See Also</translate>|
{{SectionTemplate|<translate><!--T:36--> See Also</translate>|
* 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|Chmsee-icon.png}}
* The [https://wiki.archlinux.org/index.php/conky Arch Wiki] page for Conky|Chmsee-icon.png}}


[[Category:Contents Page{{#translation:}}]]
[[Category:Contents Page{{#translation:}}]]