.. _cookbook:

How to easily configure csensors
================================
.. index:: csensors_cookbook
       
Data descriptions
-----------------
Both :ref:`config` and :ref:`applet` need prepared files describing parts of
/sys pseudo file-system.

Automatical and semi-automatical configuration
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

When no data description is seen by :ref:`config` or :ref:`applet`,
:command:`csensors-scan` is automatically launched to create some :

.. code-block :: bash

   $ csensors-scan --rt-detect
  
This cause :command:`csensors-scan` to initiate run-time variable detection. Default only :file:/sys/class
subdirectories *hwmon,power_supply* and *thermal* are examined.
  
If you wish to add some other /sys/class subdirectories, invoke :command:`csensors-scan` like:
  
.. code-block :: bash
  
   $ csensors-scan --rt-detect --dir-list=rtc,msr

This command sniffs subdirectories *hwmon,power_supply,thermal,rtc* and msr under :file:/sys/class for
presence of known files. Items *rtc* and *msr* are provided here as example how to specify
additional directories to search.

To add system load to mimics/parody xload or gtkrelm run :

.. code-block :: bash
  
   $ csensors-scan  --rt-detect --add=/proc/loadavg

Without **--rt-detect** clever script refuses to recognize /proc/loadavg as source of variable.

**Checking all generated files for errors and non-senses is very good idea.**
  
Manual configuration
^^^^^^^^^^^^^^^^^^^^
* Read `csensors-data` and prepare all required file by your favorite editor.
* Get data descriptions for your kernel and hardware from : <NO_URL_YET>.

Graph descriptions
------------------
Now we are finished with data descriptions, but further configuration steps may be taken.