Conky Panels Documentation. Release latest

Transcription

1 Conky Panels Documentation Release latest June 10, 2016

2

3 Contents 1 Video demo and screenshot 1 2 Features 3 3 License 5 4 Requirements Conky Fonts hddtemp Conky Manager Installation 9 6 Configuration Theming Placement Sizing CPU HDD NET Attributions 13 i

4 ii

5 CHAPTER 1 Video demo and screenshot 1

6 Conky Panels Documentation, Release latest 2 Chapter 1. Video demo and screenshot

7 CHAPTER 2 Features Clean design. No excesses, only the needed information. Easy installation and usage. Detailed documentation provided. Modular. Individual panels may be turned on and off, be repositioned on screen. Customizable. The main colors can be changed for all panels at the same time. Three themes built in. Wallpaper-agnostic. May be placed on any wallpaper and still be readable. Lua-only. The most recent standard for conkies. 3

8 Conky Panels Documentation, Release latest 4 Chapter 2. Features

9 CHAPTER 3 License BSD 5

10 Conky Panels Documentation, Release latest 6 Chapter 3. License

11 CHAPTER 4 Requirements The exact installation commands are mainly for Ubuntu (tested on LTS) but you should be able to replace those with your distro s solution for getting the software and/or downloading/compiling it by yourself. 4.1 Conky The Conky itself. The panels were tested to work on version You can install Conky from the PPA at here: sudo add-apt-repository ppa:vincent-c/conky sudo apt-get update sudo apt-get install conky-all 4.2 Fonts Droid Sans The Droid font is used for textual information. You can direct yourself through official Google pages to download a copy: Font Awesome The FontAwesome font is used to draw the icons. Can be installed via apt-get tool: sudo apt-get install fonts-font-awesome 4.3 hddtemp The hddtemp tool (service) is needed for hard disk temperature monitoring, when you use the HDD panel Installation On Ubuntu you can install the hddtemp tool via apt-get tool: sudo apt-get install hddtemp 7

12 Conky Panels Documentation, Release latest Configuration If needed, reconfigure hddtemp to allow usage as a non-root user: sudo dpkg-reconfigure hddtemp Warning. The temperature data is sensitive and it may not be safe to share it with non-root users if the PC is used as a public server, for example. 4.4 Conky Manager It is recommended to use the Conky Manager application to turn enable and disable individual panels and to auto-start them on session start Installation The package can be found in this PPA: 1. Add the PPA to your system: sudo apt-add-repository ppa:teejee2008/ppa && sudo apt-get update 2. Install the application: sudo apt-get install conky-manager Usage After you ve installed the Conky Panels, you may activate them with Conky Manager. 1. Launch the Conky Manager application. You may do so from the command line by typing: conky-manager 2. Refresh the list of available conky themes. Click on the Search for new themes button in the toolbar. 3. Click on the checkboxes near the individual panels to activate/deactivate them. 8 Chapter 4. Requirements

13 CHAPTER 5 Installation Clone this repository to your Conky folder: cd ~/.conky git clone 9

14 Conky Panels Documentation, Release latest 10 Chapter 5. Installation

15 CHAPTER 6 Configuration Gotta feel hacky about configuring the provided conkies. That is, you have to edit the source files, not some configuration data. Don t worry that s not hard at all and this documentation is non-programmer-safe. The main common configuration is in the common.lua file. You can set the main colors there. Just open the file in your favorite editor and change the numerical color values, presented in an RRGGBB format. Whenever you change any of the lua files, panels have to be re-enabled for changes to take effect. You can easily do so in Conky Manager by enabling/disabling a conky with the checkbox. 6.1 Theming Three themes are actually built-in: Icy, Hot and Vitamin. To use one of those, open the common.lua file and uncomment the theme s color preset. That is, remove the --[[ characters at its start and ]] after. 6.2 Placement If you can t see all (any) conkies on screen, don t worry. Chances are you didn t adjust their positions. By default, the panels are placed relative to a reference point, that is set in the common.lua file by the ref_pos_x and ref_pos_y variables. The position values may also be negative, which can be useful for multi-monitor setups. Configure the screen positions of individual panels by changing their corresponding <type>-panel.lua files. Set the gap_x and gap_y and alignment variables accordingly. 6.3 Sizing The conkies are fixed-width and you should not really change the predefined horizontal size. If you do, you would have to reposition some labels inside the conkies, so do that at your own risk. In case you see some excessive empty space at the bottom of the panel (due to how Conky lay outs the elements), search for the -- Bottom Padding -- comment at the bottom of the corresponding <type>-panel.lua file. Decrease the voffset numerical value consequently to adjust the padding size. 11

16 Conky Panels Documentation, Release latest 6.4 CPU Cores By default, the CPU panel monitors 8 cores. Chances are your system has more or less. To add or remove specific core graphs edit the./cpu-panel.lua file. Find an -- Individual Cores -- comment and look for core pack additions. Remove some by commenting them out, or add more by copy-pasting and setting the indexes accordingly. You can get the number of available cores on your system by running the nproc command. 6.5 HDD Open the hdd-panel.lua file to edit the configuration of the HDD panel Filesystems Go to the -- Filesystems -- paragraph. Edit the list of mount points and add/remove the filesystem items according to your system Usage Go the -- Disk Usage -- paragraph. Edit the list of disks to be monitored and add/remove the items accordingly. In order for disk temperature to be working, hddtemp has to be installed and configured appropriately. 6.6 NET Devices You can easily add your network devices by adding them into the array at the beginning of the file (separating them with a comma, symbol). To find out what devices are available on your system issue a sudo ifconfig command in the terminal. The names should be listed on the left side of the output. 12 Chapter 6. Configuration

17 CHAPTER 7 Attributions The package was originally developed based on some of the elements from this conkies: 13