updated documentation
This commit is contained in:
66
doc/man/carom-client.1
Normal file
66
doc/man/carom-client.1
Normal file
@@ -0,0 +1,66 @@
|
||||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.TH "CAROM-CLIENT" "1" "04.11.2018" "" "Carom Client"
|
||||
.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
|
||||
.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.
|
||||
.
|
Reference in New Issue
Block a user