[tauruslib-devel] [PATCH 8/8] Add documentation for taurusremotelogmonitor

[mrosanes <mro...@ce...>]

Add documentation for taurusremotelogmonitor application in
Taurus User's Guide.
---
 doc/source/users/ui/index.rst |  1 +
 doc/source/users/ui/logs.rst  | 56 +++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 57 insertions(+)
 create mode 100644 doc/source/users/ui/logs.rst

diff --git a/doc/source/users/ui/index.rst b/doc/source/users/ui/index.rst
index 4f18c97..229abe3 100644
--- a/doc/source/users/ui/index.rst
+++ b/doc/source/users/ui/index.rst
@@ -20,6 +20,7 @@ User's Interface
     Macros <macros/index>
     TaurusGui <taurusgui>
     TaurusDemo <taurusdemo>
+    Logs <logs>
     Configurations <configurations>
     Experiment Configuration <experimentconfiguration>
     Sardana Editor <sardanaeditor>
diff --git a/doc/source/users/ui/logs.rst b/doc/source/users/ui/logs.rst
new file mode 100644
index 0000000..f31762d
--- /dev/null
+++ b/doc/source/users/ui/logs.rst
@@ -0,0 +1,56 @@
+.. currentmodule:: taurus.qt.qtgui.table
+
+.. _logs:
+
+===========================================
+Taurus Remote Log Monitor User's Interface
+===========================================
+
+.. contents::
+
+Taurus provides a user interface that allows to visualize logs generated by a 
+given Taurus GUI.
+
+
+Taurus Remote Log Monitor Application
+--------------------------------------
+
+taurusremotelogmonitor allows to visualize Taurus logs for the following 
+log levels: trace, debug, info, warning, error and critical. 
+This application can be launched using the following command::
+
+	taurusremotelogmonitor
+
+Options::
+
+  -h, --help            show this help message and exit
+  -g, --gui             gui mode [default]
+  -c, --console         console mode
+  --log-port=LOG_PORT   port where log server is running [default: 9020]
+  --log-name=LOG_NAME   filter specific log object [default: None, meaning
+                        don't filter]
+  --log-level=LOG_LEVEL
+                        filter specific log level.Allowed values are (case
+                        insensitive): critical, error, warning/warn, info,
+                        debug, trace [default: debug].
+  --version             show program's version number and exit
+
+  Taurus Options:
+    Basic options present in any taurus application
+
+    --taurus-log-level=LEVEL
+                        taurus log level. Allowed values are (case
+                        insensitive): critical, error, warning/warn, info,
+                        debug, trace
+    --taurus-polling-period=MILLISEC
+                        taurus global polling period in milliseconds
+    --taurus-serialization-mode=SERIAL
+                        taurus serialization mode. Allowed values are (case
+                        insensitive): serial, concurrent (default)
+    --tango-host=TANGO_HOST
+                        Tango host name
+    --remote-console-port=PORT
+                        enables remote debugging using the given port
+
+
+
-- 
1.8.3.4