X-Git-Url: http://wpitchoune.net/gitweb/?p=psensor-pkg-debian.git;a=blobdiff_plain;f=src%2Fserver%2Fpsensor-server.1;h=701d8860c948b08fd8e05546b06e8fbe827d1322;hp=c5f751dca9de552632924be82318d3cd5f78922f;hb=c7769a33301029863318e7a94eb52aa13c0d3620;hpb=f055e7507526592d3a74c652f5f053701614c9c0 diff --git a/src/server/psensor-server.1 b/src/server/psensor-server.1 index c5f751d..701d886 100644 --- a/src/server/psensor-server.1 +++ b/src/server/psensor-server.1 @@ -1,5 +1,5 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.40.4. -.TH PSENSOR-SERVER "1" "March 2012" "psensor-server 0.6.2.17" "User Commands" +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.44.1. +.TH PSENSOR-SERVER "1" "August 2014" "psensor-server 1.0.3" "User Commands" .SH NAME psensor-server \- Temperature and system monitoring Web server .SH SYNOPSIS @@ -56,7 +56,7 @@ Fields of the type 'sensor': The URL http://hostname:3131/api/1.0/sensors returns a JSON array containing all JSON objects of type 'sensor'. -If run in debug mode, psensor\-server can be stopped by sending an HTTP +psensor\-server can be stopped by sending an HTTP request with the URL 'http://hostname:port/api/1.0/server/stop'. .SH OPTIONS .TP @@ -66,14 +66,64 @@ display this help and exit \fB\-v\fR, \fB\-\-version\fR display version information and exit .TP -\fB\-d\fR,\-\-debug -run in debug mode -.TP \fB\-p\fR,\-\-port=PORT webserver port .TP \fB\-w\fR,\-\-wdir=DIR directory containing webserver pages +.TP +\fB\-d\fR, \fB\-\-debug\fR=\fILEVEL\fR +set the debug level, integer between 0 and 3 +.TP +\fB\-l\fR, \fB\-\-log\-file\fR=\fIPATH\fR +set the log file to PATH +.HP +\fB\-\-sensor\-log\-file\fR=\fIPATH\fR set the sensor log file to PATH +.HP +\fB\-\-sensor\-log\-interval\fR=\fIS\fR set the sensor log interval to S (seconds) +.SH "SENSOR LOG FILE" + +Sensors can be logged using the \-\-sensor-log-file option. + +It is using a text format, each line is terminated with a NEWLINE +char. + +The first line is: I,%D,%V + +%D is the starting time of the log expressed as the number of seconds +since EPOC. + +%V is the version of psensor-server. + +Following lines gives the ordered list of sensors: S,%I,%T + +%I is the uniq identifier of the sensor. + +%T is the hexadecimal representation of the sensor type. + +Then, the values of all sensors are written: %D,%V... + +%D is the number of seconds elapsed since the starting time of the +log. + +%V... is the list separated by a comma of the current value of all +sensors. The ordering is the same than the list of sensor identifiers. + +The value is expressed as a float with one digit precision. Temperatures +are using Celsius unit. + +The value is written only if it has changed. + +Example: +I,1345974927,0.7.0.4 +S,lmsensor coretemp-isa-0000 Physical id 0,101 +S,lmsensor coretemp-isa-0000 Core 0,101 +S,lmsensor coretemp-isa-0000 Core 1,101 +0,37.0,37.0,36.0 +5,36.0,,36.0 + +Five seconds after the log starts, the temperature of the second +sensor (Core 0) is still 37C. .SH WARNING psensor\-server does not provide any way to restrict the connection to