|
From: mrosanes <mro...@ce...> - 2015-11-09 16:09:24
|
Add documentation for tauruscurve application in taurus user's guide.
---
doc/source/users/ui/plot.rst | 51 +++++++++++++++++---------------------------
1 file changed, 20 insertions(+), 31 deletions(-)
diff --git a/doc/source/users/ui/plot.rst b/doc/source/users/ui/plot.rst
index 9956774..c7eb9a6 100644
--- a/doc/source/users/ui/plot.rst
+++ b/doc/source/users/ui/plot.rst
@@ -9,7 +9,7 @@ TaurusPlot User's Interface
.. contents::
-The standard way for Tau application to show one-dimensional data is by
+The standard way for Taurus applications to show one-dimensional data is by
using a :class:`TaurusPlot` widget.
:class:`TaurusPlot` is shown as an area with X and Y axes where curves (data sets)
@@ -35,42 +35,31 @@ stand-alone :class:`TaurusPlot` with the following command::
taurusplot [options] [<model_list>]
-Options::
-
- -h, --help show this help message and exit
- -x t|n, --x-axis-mode=t|n
- interprete X values as either timestamps (t) or
- numbers (n). Accepted values: t|n (e is also accepted
- as a synonim of n)
- --config=CONFIG_FILE, --config-file=CONFIG_FILE
- use the given config file for initialization
- --export=EXPORT_FILE, --export-file=EXPORT_FILE
- use the given file to as output instead of showing the
- plot
- --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
-
+Run the following command for more details::
+ taurusplot --help
The <model_list> is a space-separated list of models for :class:`TaurusPlot`. Valid models are:
SPECTRUM attribute names or alias, and `Xattrname|Yattrname` constructions for indicating X-Y scatter plots.
See :class:`TaurusPlot` API for more information about valid models
+TaurusCurve as a Stand-alone application
+----------------------------------------
+
+In order to display attributes from the control system, the tauruscurve
+stand-alone application can also be used.
+This application is based on :class:`TaurusCurveDialog`.
+
+For launching it, use the following command::
+
+ tauruscurve [options] [<model_list>]
+
+Run the following command for more details::
+
+ tauruscurve --help
+
+
Working with two Y scales
-------------------------
@@ -316,4 +305,4 @@ Here are some tips for entering valid date/time values:
.. _numpy: http://numpy.scipy.org/
-.. |inspector_icon| image:: /_static/whatsthiscursor.png
\ No newline at end of file
+.. |inspector_icon| image:: /_static/whatsthiscursor.png
--
1.8.3.4
|