2018-11-04 22:57:20 +01:00
|
|
|
.\" Man page generated from reStructuredText.
|
|
|
|
|
.
|
2018-11-22 20:47:36 +01:00
|
|
|
.TH "CAROM-CLIENT" "1" "22.11.2018" "" "Carom Client"
|
2018-11-04 22:57:20 +01:00
|
|
|
.SH NAME
|
|
|
|
|
carom-client \- Carom Client Documentation
|
|
|
|
|
.
|
|
|
|
|
.nr rst2man-indent-level 0
|
|
|
|
|
.
|
|
|
|
|
.de1 rstReportMargin
|
|
|
|
|
\\$1 \\n[an-margin]
|
|
|
|
|
level \\n[rst2man-indent-level]
|
|
|
|
|
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
|
|
|
-
|
|
|
|
|
\\n[rst2man-indent0]
|
|
|
|
|
\\n[rst2man-indent1]
|
|
|
|
|
\\n[rst2man-indent2]
|
|
|
|
|
..
|
|
|
|
|
.de1 INDENT
|
|
|
|
|
.\" .rstReportMargin pre:
|
|
|
|
|
. RS \\$1
|
|
|
|
|
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
|
|
|
|
|
. nr rst2man-indent-level +1
|
|
|
|
|
.\" .rstReportMargin post:
|
|
|
|
|
..
|
|
|
|
|
.de UNINDENT
|
|
|
|
|
. RE
|
|
|
|
|
.\" indent \\n[an-margin]
|
|
|
|
|
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
|
|
|
.nr rst2man-indent-level -1
|
|
|
|
|
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
|
|
|
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
|
|
|
|
..
|
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.INDENT 3.5
|
|
|
|
|
.sp
|
|
|
|
|
.nf
|
|
|
|
|
.ft C
|
|
|
|
|
carom\-client [OPTIONS] COMMAND [ARGS]...
|
|
|
|
|
.ft P
|
|
|
|
|
.fi
|
|
|
|
|
.UNINDENT
|
|
|
|
|
.UNINDENT
|
|
|
|
|
Options.INDENT 0.0
|
|
|
|
|
.TP
|
|
|
|
|
.B \-v, \-\-verbosity <verbosity>
|
|
|
|
|
Either CRITICAL, ERROR, WARNING, INFO or DEBUG
|
|
|
|
|
.UNINDENT
|
2018-11-05 19:04:19 +01:00
|
|
|
.SH CHECK-CONFIG
|
|
|
|
|
.sp
|
|
|
|
|
This command checks the config for carom client.
|
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.INDENT 3.5
|
|
|
|
|
.sp
|
|
|
|
|
.nf
|
|
|
|
|
.ft C
|
|
|
|
|
carom\-client check\-config [OPTIONS]
|
|
|
|
|
.ft P
|
|
|
|
|
.fi
|
|
|
|
|
.UNINDENT
|
|
|
|
|
.UNINDENT
|
2018-11-22 20:47:36 +01:00
|
|
|
.SH GET-GPIO
|
|
|
|
|
.sp
|
|
|
|
|
Get the current status of all Tables.
|
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.INDENT 3.5
|
|
|
|
|
.sp
|
|
|
|
|
.nf
|
|
|
|
|
.ft C
|
|
|
|
|
carom\-client get\-gpio [OPTIONS]
|
|
|
|
|
.ft P
|
|
|
|
|
.fi
|
|
|
|
|
.UNINDENT
|
|
|
|
|
.UNINDENT
|
|
|
|
|
.SH GET-UUID
|
|
|
|
|
.sp
|
|
|
|
|
Get the UUID of the Client. This is need to add a new client to the carom server installation.
|
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.INDENT 3.5
|
|
|
|
|
.sp
|
|
|
|
|
.nf
|
|
|
|
|
.ft C
|
|
|
|
|
carom\-client get\-uuid [OPTIONS]
|
|
|
|
|
.ft P
|
|
|
|
|
.fi
|
|
|
|
|
.UNINDENT
|
|
|
|
|
.UNINDENT
|
2018-11-04 22:57:20 +01:00
|
|
|
.SH RUN
|
|
|
|
|
.sp
|
|
|
|
|
This command runs the carom\-client daemon process.
|
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.INDENT 3.5
|
|
|
|
|
.sp
|
|
|
|
|
.nf
|
|
|
|
|
.ft C
|
|
|
|
|
carom\-client run [OPTIONS]
|
|
|
|
|
.ft P
|
|
|
|
|
.fi
|
|
|
|
|
.UNINDENT
|
|
|
|
|
.UNINDENT
|
|
|
|
|
.SH AUTHOR
|
|
|
|
|
Robert Einsle
|
|
|
|
|
.SH COPYRIGHT
|
|
|
|
|
2018, Robert Einsle
|
|
|
|
|
.\" Generated by docutils manpage writer.
|
|
|
|
|
.
|
