.. default-role:: any
.. _scan:

===============
 csensors-scan
===============
Data description builder for csensors
.. index:: csensors-scan, scan
.. program:: csensors-scan	 

.. hlist::
   * search through part of /sys tree
   * determine interesting ( in csensors sense ) parts of /sys tree
   * parse interesting parts and try to classify/guess nature of constant/variable/variable array/text
   * broke down retrieved data by each logical :term:`device`
   * write human readable data descripton file(s) :ref:`data` for the rest of package
     :ref:`config` and :ref:`applet`.

.. .. index:: `csensors-scan` invocation 

csensors-scan invocation
------------------------
   
The :program:`csensors-scan` script has several options:

.. option:: -h, --help
 
	    Print a brief help message and exits.
 
.. option:: --man
 
	    Prints the manual page and exits.
 
.. option:: -n, --dry-run
 
	    Don't actually create new data descriptions (input configurations) - just
	    print what is found.
 
.. option:: -v, --verbose
 
	    Print all available information.

.. option:: --dir-list=DirA,DirB,...
	    
	    Comma separated List of directories to add to default ones ( to append to /sys/class/...). Default "". 
	    Disabled by --add mode.
 
.. option:: --dir=DirA,DirB,...
 
	    List of directories to scan insted of default ones. Default "{hwmon,power_supply,thermal}". 
	    Disabled by --add mode.
 
.. option:: --root
 
	    Direcroty root to scan. Default "/sys/class". Disabled by --add mode.
 
.. option:: --add
 
	    Add just one file . Disables --root,--dir-list and --dir options
 
.. option:: --rt-detect
 
	    Solve which (/sys/\*) items are constant and which are variables simply by repeated reading.
	    This method can find rapidly changing items like CPU temperature, but is guaranted to
	    fail in the case of battery capacity of wall plugged notebook and so on.
 
.. option:: --prefix=PREFIX
 
	    Override configuration prefix. Files and directories outside configuration prefix
	    are unreachable by the rest of csensros package. Use with care.xs
 





AUTHOR
^^^^^^

|AUTHOR|


LICENSE AND COPYRIGHT
^^^^^^^^^^^^^^^^^^^^^


This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or (at
your option) any later version.

This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

Copyright (C) 2018 |AUTHOR|


.. seealso:: :ref:`intro`  :ref:`data`  :ref:`config`  :ref:`applet`