diff options
author | coutinho <coutinho@esrf.fr> | 2015-03-26 12:21:41 +0100 |
---|---|---|
committer | coutinho <coutinho@esrf.fr> | 2015-03-26 12:21:41 +0100 |
commit | 6f2a9f4d65212ef253a5ce6fc173d52b8a470c57 (patch) | |
tree | 674c3ba22a326794b20abf345ec5e01c102a1b11 /doc/man | |
parent | 3d39d0a483286c6cc6abc58d5514dc5390104736 (diff) |
First commit in tauruslib. Restructure according to SEP10
Diffstat (limited to 'doc/man')
-rw-r--r-- | doc/man/MacroServer.1 | 38 | ||||
-rw-r--r-- | doc/man/Pool.1 | 38 | ||||
-rw-r--r-- | doc/man/Sardana.1 | 38 | ||||
-rw-r--r-- | doc/man/spock.1 | 389 | ||||
-rw-r--r-- | doc/man/tau2taurus.1 | 19 | ||||
-rw-r--r-- | doc/man/taurusconfigbrowser.1 | 38 | ||||
-rw-r--r-- | doc/man/tauruscurve.1 | 44 | ||||
-rw-r--r-- | doc/man/taurusdemo.1 (renamed from doc/man/sequencer.1) | 28 | ||||
-rw-r--r-- | doc/man/taurusdesigner.1 | 22 | ||||
-rw-r--r-- | doc/man/taurusdevicepanel.1 | 41 | ||||
-rw-r--r-- | doc/man/taurusdoc.1 | 48 | ||||
-rw-r--r-- | doc/man/taurusform.1 | 44 | ||||
-rw-r--r-- | doc/man/taurusgui.1 | 50 | ||||
-rw-r--r-- | doc/man/taurusimage.1 | 47 | ||||
-rw-r--r-- | doc/man/tauruspanel.1 (renamed from doc/man/macroexecutor.1) | 28 | ||||
-rw-r--r-- | doc/man/taurusplot.1 | 53 | ||||
-rw-r--r-- | doc/man/taurusremotelogmonitor.1 | 54 | ||||
-rw-r--r-- | doc/man/taurustrend.1 | 63 | ||||
-rw-r--r-- | doc/man/taurustrend1d.1 | 54 | ||||
-rw-r--r-- | doc/man/taurustrend2d.1 | 54 | ||||
-rw-r--r-- | doc/man/taurusui.1 | 38 | ||||
-rw-r--r-- | doc/man/taurusuic4.1 | 47 |
22 files changed, 746 insertions, 529 deletions
diff --git a/doc/man/MacroServer.1 b/doc/man/MacroServer.1 deleted file mode 100644 index 628cbc4e..00000000 --- a/doc/man/MacroServer.1 +++ /dev/null @@ -1,38 +0,0 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.43.3. -.TH MACROSERVER "1" "February 2015" "MacroServer 1.5.0" "User Commands" -.SH NAME -MacroServer \- manual page for MacroServer 1.5.0 -.SH SYNOPSIS -.B usage: -\fIMacroServer instance_name \fR[\fIoptions\fR] -.SH OPTIONS -.TP -\fB\-\-version\fR -show program's version number and exit -.TP -\fB\-h\fR, \fB\-\-help\fR -show this help message and exit -.TP -\fB\-\-log\-level\fR=\fILOG_LEVEL\fR -log output level. Possible values are (case -sensitive): critical (or 0), error (1), warning (2), -info (3) debug (4), trace (5) [default: warning] -.TP -\fB\-\-log\-file\-level\fR=\fILOG_FILE_LEVEL\fR -log file level. Possible values are (case sensitive): -critical (or 0), error (1), warning (2), info (3) -debug (4), trace (5) [default: debug]. Ignored if -\fB\-\-without\-log\-file\fR is True -.TP -\fB\-\-log\-file\-name\fR=\fILOG_FILE_NAME\fR -log file name. When given, MUST be absolute file name. -[default: /tmp/tango/<DS name>/<DS instance name lower -case>/log.txt]. Ignored if \fB\-\-without\-log\-file\fR is True -.TP -\fB\-\-without\-log\-file\fR=\fIWITHOUT_LOG_FILE\fR -When set to True disables logging into a file -[default: False] -.TP -\fB\-\-rconsole\-port\fR=\fIRCONSOLE_PORT\fR -rconsole port number. [default: 0 meaning rconsole NOT -active] diff --git a/doc/man/Pool.1 b/doc/man/Pool.1 deleted file mode 100644 index 190fa1c0..00000000 --- a/doc/man/Pool.1 +++ /dev/null @@ -1,38 +0,0 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.43.3. -.TH POOL "1" "February 2015" "Pool 1.5.0" "User Commands" -.SH NAME -Pool \- manual page for Pool 1.5.0 -.SH SYNOPSIS -.B usage: -\fIPool instance_name \fR[\fIoptions\fR] -.SH OPTIONS -.TP -\fB\-\-version\fR -show program's version number and exit -.TP -\fB\-h\fR, \fB\-\-help\fR -show this help message and exit -.TP -\fB\-\-log\-level\fR=\fILOG_LEVEL\fR -log output level. Possible values are (case -sensitive): critical (or 0), error (1), warning (2), -info (3) debug (4), trace (5) [default: warning] -.TP -\fB\-\-log\-file\-level\fR=\fILOG_FILE_LEVEL\fR -log file level. Possible values are (case sensitive): -critical (or 0), error (1), warning (2), info (3) -debug (4), trace (5) [default: debug]. Ignored if -\fB\-\-without\-log\-file\fR is True -.TP -\fB\-\-log\-file\-name\fR=\fILOG_FILE_NAME\fR -log file name. When given, MUST be absolute file name. -[default: /tmp/tango/<DS name>/<DS instance name lower -case>/log.txt]. Ignored if \fB\-\-without\-log\-file\fR is True -.TP -\fB\-\-without\-log\-file\fR=\fIWITHOUT_LOG_FILE\fR -When set to True disables logging into a file -[default: False] -.TP -\fB\-\-rconsole\-port\fR=\fIRCONSOLE_PORT\fR -rconsole port number. [default: 0 meaning rconsole NOT -active] diff --git a/doc/man/Sardana.1 b/doc/man/Sardana.1 deleted file mode 100644 index a297ca5c..00000000 --- a/doc/man/Sardana.1 +++ /dev/null @@ -1,38 +0,0 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.43.3. -.TH SARDANA "1" "February 2015" "Sardana 1.5.0" "User Commands" -.SH NAME -Sardana \- manual page for Sardana 1.5.0 -.SH SYNOPSIS -.B usage: -\fISardana instance_name \fR[\fIoptions\fR] -.SH OPTIONS -.TP -\fB\-\-version\fR -show program's version number and exit -.TP -\fB\-h\fR, \fB\-\-help\fR -show this help message and exit -.TP -\fB\-\-log\-level\fR=\fILOG_LEVEL\fR -log output level. Possible values are (case -sensitive): critical (or 0), error (1), warning (2), -info (3) debug (4), trace (5) [default: warning] -.TP -\fB\-\-log\-file\-level\fR=\fILOG_FILE_LEVEL\fR -log file level. Possible values are (case sensitive): -critical (or 0), error (1), warning (2), info (3) -debug (4), trace (5) [default: debug]. Ignored if -\fB\-\-without\-log\-file\fR is True -.TP -\fB\-\-log\-file\-name\fR=\fILOG_FILE_NAME\fR -log file name. When given, MUST be absolute file name. -[default: /tmp/tango/<DS name>/<DS instance name lower -case>/log.txt]. Ignored if \fB\-\-without\-log\-file\fR is True -.TP -\fB\-\-without\-log\-file\fR=\fIWITHOUT_LOG_FILE\fR -When set to True disables logging into a file -[default: False] -.TP -\fB\-\-rconsole\-port\fR=\fIRCONSOLE_PORT\fR -rconsole port number. [default: 0 meaning rconsole NOT -active] diff --git a/doc/man/spock.1 b/doc/man/spock.1 deleted file mode 100644 index d4e32e4e..00000000 --- a/doc/man/spock.1 +++ /dev/null @@ -1,389 +0,0 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.43.3. -.TH SPOCK "1" "February 2015" "spock 1.5.0" "User Commands" -.SH NAME -spock \- manual page for spock 1.5.0 -.SH DESCRIPTION -========= -.IP -IPython -.PP -========= -.PP -Tools for Interactive Computing in Python -========================================= -.IP -A Python shell with automatic history (input and output), dynamic object -introspection, easier configuration, command completion, access to the -system shell and more. IPython can also be embedded in running programs. -.PP -Usage -.IP -ipython [subcommand] [options] [\-c cmd | \fB\-m\fR mod | file] [\-\-] [arg] ... -.IP -If invoked with no options, it executes the file and exits, passing the -remaining arguments to the script, just as if you had specified the same -command with python. You may need to specify `\-\-` before args to be passed -to the script, to prevent IPython from attempting to parse them. If you -specify the option `\-i` before the filename, it will enter an interactive -IPython session after running the script, rather than exiting. Files ending -in .py will be treated as normal Python, but files ending in .ipy can -contain special IPython syntax (magic commands, shell expansions, etc.). -.IP -Almost all configuration in IPython is available via the command\-line. Do -`ipython \fB\-\-help\-all\fR` to see all available options. For persistent -configuration, look into your `ipython_config.py` configuration file for -details. -.IP -This file is typically installed in the `IPYTHONDIR` directory, and there -is a separate configuration directory for each profile. The default profile -directory will be located in \fI$IPYTHONDIR/profile_default\fP. For Linux users, -IPYTHONDIR defaults to `$HOME/.config/ipython`, and for other Unix systems -to `$HOME/.ipython`. For Windows users, $HOME resolves to C:\eDocuments -and Settings\eYourUserName in most instances. -.IP -To initialize a profile with the default configuration file, do:: -.IP -$> ipython profile create -.IP -and start editing `IPYTHONDIR/profile_default/ipython_config.py` -.IP -In IPython's documentation, we will refer to this directory as -`IPYTHONDIR`, you can change its default location by creating an -environment variable with this name and setting it to the desired path. -.IP -For more information, see the manual available in HTML and PDF in your -installation, or online at http://ipython.org/documentation.html. -.PP -Subcommands -\fB\-\-\-\-\-\-\-\-\-\-\-\fR -.PP -Subcommands are launched as `spock cmd [args]`. For information on using -subcommand 'cmd', do: `spock cmd \fB\-h\fR`. -.PP -locate -.IP -print the path to the IPython dir -.PP -profile -.IP -Create and manage IPython profiles. -.PP -console -.IP -Launch the IPython terminal\-based Console. -.PP -kernel -.IP -Start a kernel without an attached frontend. -.PP -notebook -.IP -Launch the IPython HTML Notebook Server. -.PP -nbconvert -.IP -Convert notebooks to/from other formats. -.PP -qtconsole -.IP -Launch the IPython Qt Console. -.PP -history -.IP -Manage the IPython history database. -.PP -Options -\fB\-\-\-\-\-\-\-\fR -.PP -Arguments that take values are actually convenience aliases to full -Configurables, whose aliases are listed on the help line. For more information -on full configurables, see '\-\-help\-all'. -.PP -\fB\-\-no\-autoindent\fR -.IP -Turn off autoindenting. -.PP -\fB\-\-autoedit\-syntax\fR -.IP -Turn on auto editing of files with syntax errors. -.PP -\fB\-\-deep\-reload\fR -.IP -Enable deep (recursive) reloading by default. IPython can use the -deep_reload module which reloads changes in modules recursively (it -replaces the reload() function, so you don't need to change anything to -use it). deep_reload() forces a full reload of modules whose code may -have changed, which the default reload() function does not. When -deep_reload is off, IPython will use the normal reload(), but -deep_reload will still be available as dreload(). This feature is off -by default [which means that you have both normal reload() and -dreload()]. -.PP -\fB\-\-confirm\-exit\fR -.IP -Set to confirm when you try to exit IPython with an EOF (Control\-D -in Unix, Control\-Z/Enter in Windows). By typing 'exit' or 'quit', -you can force a direct exit without any confirmation. -.PP -\fB\-\-pylab\fR -.IP -Pre\-load matplotlib and numpy for interactive use with -the default matplotlib backend. -.PP -\fB\-\-matplotlib\fR -.IP -Configure matplotlib for interactive use with -the default matplotlib backend. -.PP -\fB\-\-term\-title\fR -.IP -Enable auto setting the terminal title. -.PP -\fB\-\-classic\fR -.IP -Gives IPython a similar feel to the classic Python prompt. -.PP -\fB\-\-autoindent\fR -.IP -Turn on autoindenting. -.PP -\fB\-\-no\-automagic\fR -.IP -Turn off the auto calling of magic commands. -.PP -\fB\-\-banner\fR -.IP -Display a banner upon starting IPython. -.PP -\fB\-\-automagic\fR -.IP -Turn on the auto calling of magic commands. Type %%magic at the -IPython prompt for more information. -.PP -\fB\-\-no\-deep\-reload\fR -.IP -Disable deep (recursive) reloading by default. -.PP -\fB\-\-no\-term\-title\fR -.IP -Disable auto setting the terminal title. -.PP -\fB\-\-nosep\fR -.IP -Eliminate all spacing between prompts. -.PP -\fB\-i\fR -.IP -If running code from the command line, become interactive afterwards. -Note: can also be given simply as '\-i.' -.PP -\fB\-\-debug\fR -.IP -set log level to logging.DEBUG (maximize logging output) -.PP -\fB\-\-pprint\fR -.IP -Enable auto pretty printing of results. -.PP -\fB\-\-no\-autoedit\-syntax\fR -.IP -Turn off auto editing of files with syntax errors. -.PP -\fB\-\-quiet\fR -.IP -set log level to logging.CRITICAL (minimize logging output) -.PP -\fB\-\-no\-color\-info\fR -.IP -Disable using colors for info related things. -.PP -\fB\-\-color\-info\fR -.IP -IPython can display information about objects via a set of functions, and optionally can use colors for this, syntax highlighting -source code and various other elements. However, because this -information is passed through a pager (like 'less') and many pagers get -confused with color codes, this option is off by default. You can test -it and turn it on permanently in your ipython_config.py file if it -works for you. Test it and turn it on permanently if it works with -your system. The magic function %%color_info allows you to toggle this -interactively for testing. -.PP -\fB\-\-init\fR -.TP -Initialize profile with default config files. -This is equivalent -.IP -to running `ipython profile create <profile>` prior to startup. -.PP -\fB\-\-no\-pdb\fR -.IP -Disable auto calling the pdb debugger after every exception. -.PP -\fB\-\-quick\fR -.IP -Enable quick startup with no config files. -.PP -\fB\-\-no\-confirm\-exit\fR -.IP -Don't prompt the user when exiting. -.PP -\fB\-\-pydb\fR -.IP -Use the third party 'pydb' package as debugger, instead of pdb. -Requires that pydb is installed. -.PP -\fB\-\-pdb\fR -.IP -Enable auto calling the pdb debugger after every exception. -.PP -\fB\-\-no\-pprint\fR -.IP -Disable auto pretty printing of results. -.PP -\fB\-\-no\-banner\fR -.IP -Don't display a banner upon starting IPython. -.PP -\fB\-\-profile=\fR<Unicode> (BaseIPythonApplication.profile) -.IP -Default: u'default' -The IPython profile to use. -.PP -\fB\-c\fR <Unicode> (InteractiveShellApp.code_to_run) -.IP -Default: '' -Execute the given command string. -.PP -\fB\-\-pylab=\fR<CaselessStrEnum> (InteractiveShellApp.pylab) -.IP -Default: None -Choices: ['auto', 'gtk', 'inline', 'osx', 'qt', 'qt4', 'tk', 'wx'] -Pre\-load matplotlib and numpy for interactive use, selecting a particular -matplotlib backend and loop integration. -.PP -\fB\-\-autocall=\fR<Enum> (InteractiveShell.autocall) -.IP -Default: 0 -Choices: (0, 1, 2) -Make IPython automatically call any callable object even if you didn't type -explicit parentheses. For example, 'str 43' becomes 'str(43)' automatically. -The value can be '0' to disable the feature, '1' for 'smart' autocall, where -it is not applied if there are no more arguments on the line, and '2' for -\&'full' autocall, where all callable objects are automatically called (even -if no arguments are present). -.PP -\fB\-\-ipython\-dir=\fR<Unicode> (BaseIPythonApplication.ipython_dir) -.IP -Default: u'/home/zreszela/.ipython' -The name of the IPython directory. This directory is used for logging -configuration (through profiles), history storage, etc. The default is -usually $HOME/.ipython. This options can also be specified through the -environment variable IPYTHONDIR. -.PP -\fB\-\-gui=\fR<CaselessStrEnum> (InteractiveShellApp.gui) -.IP -Default: None -Choices: ('qt', 'wx', 'gtk', 'glut', 'pyglet', 'osx') -Enable GUI event loop integration ('qt', 'wx', 'gtk', 'glut', 'pyglet', -\&'osx'). -.PP -\fB\-\-logappend=\fR<Unicode> (InteractiveShell.logappend) -.IP -Default: '' -Start logging to the given file in append mode. -.PP -\fB\-m\fR <Unicode> (InteractiveShellApp.module_to_run) -.IP -Default: '' -Run the module as a script. -.PP -\fB\-\-ext=\fR<Unicode> (InteractiveShellApp.extra_extension) -.IP -Default: '' -dotted module name of an IPython extension to load. -.PP -\fB\-\-log\-level=\fR<Enum> (Application.log_level) -.IP -Default: 30 -Choices: (0, 10, 20, 30, 40, 50, 'DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL') -Set the log level by value or name. -.PP -\fB\-\-colors=\fR<CaselessStrEnum> (InteractiveShell.colors) -.IP -Default: 'Linux' -Choices: ('NoColor', 'LightBG', 'Linux') -Set the color scheme (NoColor, Linux, or LightBG). -.PP -\fB\-\-matplotlib=\fR<CaselessStrEnum> (InteractiveShellApp.matplotlib) -.IP -Default: None -Choices: ['auto', 'gtk', 'inline', 'osx', 'qt', 'qt4', 'tk', 'wx'] -Configure matplotlib for interactive use with the default matplotlib -backend. -.PP -\fB\-\-cache\-size=\fR<Integer> (InteractiveShell.cache_size) -.IP -Default: 1000 -Set the size of the output cache. The default is 1000, you can change it -permanently in your config file. Setting it to 0 completely disables the -caching system, and the minimum value accepted is 20 (if you provide a value -less than 20, it is reset to 0 and a warning is issued). This limit is -defined because otherwise you'll spend more time re\-flushing a too small -cache than working -.PP -\fB\-\-logfile=\fR<Unicode> (InteractiveShell.logfile) -.IP -Default: '' -The name of the logfile to use. -.PP -\fB\-\-config=\fR<Unicode> (BaseIPythonApplication.extra_config_file) -.IP -Default: u'' -Path to an extra config file to load. -If specified, load this config file in addition to any other IPython config. -.PP -To see all available configurables, use `\-\-help\-all` -.PP -Examples -\fB\-\-\-\-\-\-\-\-\fR -.TP -ipython \fB\-\-matplotlib\fR -# enable matplotlib integration -.TP -ipython \fB\-\-matploltib\fR=\fIqt\fR -# enable matplotlib integration with qt4 backend -.TP -ipython \fB\-\-log\-level\fR=\fIDEBUG\fR -# set logging to DEBUG -.TP -ipython \fB\-\-profile\fR=\fIfoo\fR -# start with profile foo -.TP -ipython qtconsole -# start the qtconsole GUI application -.TP -ipython help qtconsole -# show the help for the qtconsole subcmd -.TP -ipython console -# start the terminal\-based console application -.TP -ipython help console -# show the help for the console subcmd -.TP -ipython notebook -# start the IPython notebook -.TP -ipython help notebook -# show the help for the notebook subcmd -.IP -ipython profile create foo # create profile foo w/ default config files -ipython help profile # show the help for the profile subcmd -.TP -ipython locate -# print the path to the IPython directory -.IP -ipython locate profile foo # print the path to the directory for profile `foo` -.TP -ipython nbconvert -# convert notebooks to/from other formats diff --git a/doc/man/tau2taurus.1 b/doc/man/tau2taurus.1 new file mode 100644 index 00000000..3826f0fa --- /dev/null +++ b/doc/man/tau2taurus.1 @@ -0,0 +1,19 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.4. +.TH TAU2TAURUS "1" "February 2015" "tau2taurus 3.4.0" "User Commands" +.SH NAME +tau2taurus \- manual page for tau2taurus 3.4.0 +.SH SYNOPSIS +.B tau2taurus +[\fI\,options\/\fR] \fI\,inputfile\/\fR +.SH DESCRIPTION +tau to taurus ui file translator +.SH OPTIONS +.TP +\fB\-\-version\fR +show program's version number and exit +.TP +\fB\-h\fR, \fB\-\-help\fR +show this help message and exit +.TP +\fB\-o\fR FILE, \fB\-\-output\fR=\fI\,FILE\/\fR +output FILE [default=console] diff --git a/doc/man/taurusconfigbrowser.1 b/doc/man/taurusconfigbrowser.1 new file mode 100644 index 00000000..c82f4356 --- /dev/null +++ b/doc/man/taurusconfigbrowser.1 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.4. +.TH TAURUSCONFIGEDITOR "1" "February 2015" "taurusconfigeditor 3.4.0" "User Commands" +.SH NAME +taurusconfigeditor \- manual page for taurusconfigeditor 3.4.0 +.SH SYNOPSIS +.B taurusconfigbrowser +[\fI\,options\/\fR] [\fI\,INIFILENAME\/\fR] +.SH DESCRIPTION +taurus configuration editor +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +show this help message and exit +.TP +\fB\-\-version\fR +show program's version number and exit +.IP +Taurus Options: +.IP +Basic options present in any taurus application +.TP +\fB\-\-taurus\-log\-level\fR=\fI\,LEVEL\/\fR +taurus log level. Allowed values are (case +insensitive): critical, error, warning/warn, info, +debug, trace +.TP +\fB\-\-taurus\-polling\-period\fR=\fI\,MILLISEC\/\fR +taurus global polling period in milliseconds +.TP +\fB\-\-taurus\-serialization\-mode\fR=\fI\,SERIAL\/\fR +taurus serialization mode. Allowed values are (case +insensitive): serial, concurrent (default) +.TP +\fB\-\-tango\-host\fR=\fI\,TANGO_HOST\/\fR +Tango host name +.TP +\fB\-\-remote\-console\-port\fR=\fI\,PORT\/\fR +enables remote debugging using the given port diff --git a/doc/man/tauruscurve.1 b/doc/man/tauruscurve.1 new file mode 100644 index 00000000..0c6aef4c --- /dev/null +++ b/doc/man/tauruscurve.1 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.4. +.TH TAURUS "1" "February 2015" "Taurus Curve Dialog 3.4.0" "User Commands" +.SH NAME +Taurus \- manual page for Taurus Curve Dialog 3.4.0 +.SH SYNOPSIS +.B tauruscurve +[\fI\,options\/\fR] [\fI\,<model1> \/\fR[\fI\,<model2>\/\fR] ...] +.SH DESCRIPTION +a taurus application for plotting 1D data sets +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +show this help message and exit +.TP +\fB\-\-demo\fR +show a demo of the widget +.TP +\fB\-\-window\-name\fR=\fI\,WINDOW_NAME\/\fR +Name of the window +.TP +\fB\-\-version\fR +show program's version number and exit +.IP +Taurus Options: +.IP +Basic options present in any taurus application +.TP +\fB\-\-taurus\-log\-level\fR=\fI\,LEVEL\/\fR +taurus log level. Allowed values are (case +insensitive): critical, error, warning/warn, info, +debug, trace +.TP +\fB\-\-taurus\-polling\-period\fR=\fI\,MILLISEC\/\fR +taurus global polling period in milliseconds +.TP +\fB\-\-taurus\-serialization\-mode\fR=\fI\,SERIAL\/\fR +taurus serialization mode. Allowed values are (case +insensitive): serial, concurrent (default) +.TP +\fB\-\-tango\-host\fR=\fI\,TANGO_HOST\/\fR +Tango host name +.TP +\fB\-\-remote\-console\-port\fR=\fI\,PORT\/\fR +enables remote debugging using the given port diff --git a/doc/man/sequencer.1 b/doc/man/taurusdemo.1 index 81aa8187..dad64262 100644 --- a/doc/man/sequencer.1 +++ b/doc/man/taurusdemo.1 @@ -1,36 +1,38 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.43.3. -.TH SEQUENCER "1" "February 2015" "sequencer 3.4.0" "User Commands" +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.4. +.TH TAURUSDEMO "1" "February 2015" "taurusdemo 1.0" "User Commands" .SH NAME -sequencer \- manual page for sequencer 3.4.0 +taurusdemo \- manual page for taurusdemo 1.0 .SH SYNOPSIS -.B sequencer -[\fIoptions\fR] +.B taurusdemo +[\fI\,options\/\fR] +.SH DESCRIPTION +A demo application for taurus .SH OPTIONS .TP -\fB\-\-version\fR -show program's version number and exit -.TP \fB\-h\fR, \fB\-\-help\fR show this help message and exit +.TP +\fB\-\-version\fR +show program's version number and exit .IP Taurus Options: .IP Basic options present in any taurus application .TP -\fB\-\-taurus\-log\-level\fR=\fILEVEL\fR +\fB\-\-taurus\-log\-level\fR=\fI\,LEVEL\/\fR taurus log level. Allowed values are (case insensitive): critical, error, warning/warn, info, debug, trace .TP -\fB\-\-taurus\-polling\-period\fR=\fIMILLISEC\fR +\fB\-\-taurus\-polling\-period\fR=\fI\,MILLISEC\/\fR taurus global polling period in milliseconds .TP -\fB\-\-taurus\-serialization\-mode\fR=\fISERIAL\fR +\fB\-\-taurus\-serialization\-mode\fR=\fI\,SERIAL\/\fR taurus serialization mode. Allowed values are (case insensitive): serial, concurrent (default) .TP -\fB\-\-tango\-host\fR=\fITANGO_HOST\fR +\fB\-\-tango\-host\fR=\fI\,TANGO_HOST\/\fR Tango host name .TP -\fB\-\-remote\-console\-port\fR=\fIPORT\fR +\fB\-\-remote\-console\-port\fR=\fI\,PORT\/\fR enables remote debugging using the given port diff --git a/doc/man/taurusdesigner.1 b/doc/man/taurusdesigner.1 new file mode 100644 index 00000000..a1aecb35 --- /dev/null +++ b/doc/man/taurusdesigner.1 @@ -0,0 +1,22 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.4. +.TH TAURUSDESIGNER "1" "February 2015" "taurusdesigner 3.4.0" "User Commands" +.SH NAME +taurusdesigner \- manual page for taurusdesigner 3.4.0 +.SH SYNOPSIS +.B taurusdesigner +[\fI\,options\/\fR] \fI\,<ui file(s)>\/\fR +.SH DESCRIPTION +The Qt designer application customized for taurus +.SH OPTIONS +.TP +\fB\-\-version\fR +show program's version number and exit +.TP +\fB\-h\fR, \fB\-\-help\fR +show this help message and exit +.TP +\fB\-\-taurus\-path\fR=\fI\,TAURUSPATH\/\fR +additional directories to look for taurus widgets +.TP +\fB\-\-qt\-designer\-path\fR=\fI\,PYQTDESIGNERPATH\/\fR +additional directories to look for python qt widgets diff --git a/doc/man/taurusdevicepanel.1 b/doc/man/taurusdevicepanel.1 new file mode 100644 index 00000000..d699e04e --- /dev/null +++ b/doc/man/taurusdevicepanel.1 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.4. +.TH TAURUSDEVICEPANEL "1" "February 2015" "TaurusDevicePanel 3.4.0" "User Commands" +.SH NAME +TaurusDevicePanel \- manual page for TaurusDevicePanel 3.4.0 +.SH SYNOPSIS +.B taurusdevicepanel +[\fI\,options\/\fR] [\fI\,devname \/\fR[\fI\,attrs\/\fR]] +.SH DESCRIPTION +Taurus Application inspired in Jive and Atk Panel +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +show this help message and exit +.TP +\fB\-\-config\-file\fR=\fI\,CONFIG_FILE\/\fR +load a config file (TODO: document this option) +.TP +\fB\-\-version\fR +show program's version number and exit +.IP +Taurus Options: +.IP +Basic options present in any taurus application +.TP +\fB\-\-taurus\-log\-level\fR=\fI\,LEVEL\/\fR +taurus log level. Allowed values are (case +insensitive): critical, error, warning/warn, info, +debug, trace +.TP +\fB\-\-taurus\-polling\-period\fR=\fI\,MILLISEC\/\fR +taurus global polling period in milliseconds +.TP +\fB\-\-taurus\-serialization\-mode\fR=\fI\,SERIAL\/\fR +taurus serialization mode. Allowed values are (case +insensitive): serial, concurrent (default) +.TP +\fB\-\-tango\-host\fR=\fI\,TANGO_HOST\/\fR +Tango host name +.TP +\fB\-\-remote\-console\-port\fR=\fI\,PORT\/\fR +enables remote debugging using the given port diff --git a/doc/man/taurusdoc.1 b/doc/man/taurusdoc.1 new file mode 100644 index 00000000..15ccacb4 --- /dev/null +++ b/doc/man/taurusdoc.1 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.4. +.TH TAURUSDOC "1" "February 2015" "taurusdoc 3.4.0" "User Commands" +.SH NAME +taurusdoc \- manual page for taurusdoc 3.4.0 +.SH SYNOPSIS +.B taurusdoc +[\fI\,options\/\fR] +.SH DESCRIPTION +a tool to help developers preview the documentation generated by their code +.SH OPTIONS +.TP +\fB\-\-version\fR +show program's version number and exit +.TP +\fB\-h\fR, \fB\-\-help\fR +show this help message and exit +.TP +\fB\-v\fR, \fB\-\-verbose\fR +display a lot of information [default] +.TP +\fB\-q\fR, \fB\-\-quiet\fR +be really silent +.TP +\fB\-\-build\-dir\fR=\fI\,BUILD_DIR\/\fR +build directory [default=./build] +.TP +\fB\-a\fR, \fB\-\-all\-files\fR +generate from scratch [default] +.TP +\fB\-\-cache\fR +use previously generated files +.TP +\fB\-\-format\fR=\fI\,BUILDER\/\fR +output format [default=html] +.TP +\fB\-\-prefix\fR=\fI\,PREFIX\/\fR +output directory +.TP +\fB\-\-class\fR=\fI\,KLASS\/\fR +full class name to generate doc for (ex.: +taurus.qt.qtgui.display.TaurusLabel +.TP +\fB\-\-package\fR=\fI\,PACKAGE\/\fR +full package name to generate doc for (ex.: +taurus.qt.qtgui.display) +.TP +\fB\-\-file\fR=\fI\,FILENAME\/\fR +RST file diff --git a/doc/man/taurusform.1 b/doc/man/taurusform.1 new file mode 100644 index 00000000..21d7e707 --- /dev/null +++ b/doc/man/taurusform.1 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.4. +.TH TAURUSFORM "1" "February 2015" "taurusform 3.4.0" "User Commands" +.SH NAME +taurusform \- manual page for taurusform 3.4.0 +.SH SYNOPSIS +.B taurusform +[\fI\,options\/\fR] [\fI\,model1 \/\fR[\fI\,model2 \/\fR...]] +.SH DESCRIPTION +the taurus form panel application +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +show this help message and exit +.TP +\fB\-\-window\-name\fR=\fI\,WINDOW_NAME\/\fR +Name of the window +.TP +\fB\-\-config\fR=\fI\,CONFIG_FILE\/\fR, \fB\-\-config\-file\fR=\fI\,CONFIG_FILE\/\fR +use the given config file for initialization +.TP +\fB\-\-version\fR +show program's version number and exit +.IP +Taurus Options: +.IP +Basic options present in any taurus application +.TP +\fB\-\-taurus\-log\-level\fR=\fI\,LEVEL\/\fR +taurus log level. Allowed values are (case +insensitive): critical, error, warning/warn, info, +debug, trace +.TP +\fB\-\-taurus\-polling\-period\fR=\fI\,MILLISEC\/\fR +taurus global polling period in milliseconds +.TP +\fB\-\-taurus\-serialization\-mode\fR=\fI\,SERIAL\/\fR +taurus serialization mode. Allowed values are (case +insensitive): serial, concurrent (default) +.TP +\fB\-\-tango\-host\fR=\fI\,TANGO_HOST\/\fR +Tango host name +.TP +\fB\-\-remote\-console\-port\fR=\fI\,PORT\/\fR +enables remote debugging using the given port diff --git a/doc/man/taurusgui.1 b/doc/man/taurusgui.1 new file mode 100644 index 00000000..918d3a05 --- /dev/null +++ b/doc/man/taurusgui.1 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.4. +.TH TAURUSGUI "1" "February 2015" "taurusgui 3.4.0" "User Commands" +.SH NAME +taurusgui \- manual page for taurusgui 3.4.0 +.SH SYNOPSIS +.B taurusgui +[\fI\,options\/\fR] \fI\,confname\/\fR +.SH DESCRIPTION +The taurus GUI application +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +show this help message and exit +.TP +\fB\-\-config\-dir\fR=\fI\,CONFIG_DIR\/\fR +use the given configuration directory for +initialization +.TP +\fB\-\-new\-gui\fR +launch a wizard for creating a new TaurusGUI +application +.TP +\fB\-\-fail\-proof\fR +launch in fail proof mode (it prevents potentially +problematic configs from being loaded) +.TP +\fB\-\-version\fR +show program's version number and exit +.IP +Taurus Options: +.IP +Basic options present in any taurus application +.TP +\fB\-\-taurus\-log\-level\fR=\fI\,LEVEL\/\fR +taurus log level. Allowed values are (case +insensitive): critical, error, warning/warn, info, +debug, trace +.TP +\fB\-\-taurus\-polling\-period\fR=\fI\,MILLISEC\/\fR +taurus global polling period in milliseconds +.TP +\fB\-\-taurus\-serialization\-mode\fR=\fI\,SERIAL\/\fR +taurus serialization mode. Allowed values are (case +insensitive): serial, concurrent (default) +.TP +\fB\-\-tango\-host\fR=\fI\,TANGO_HOST\/\fR +Tango host name +.TP +\fB\-\-remote\-console\-port\fR=\fI\,PORT\/\fR +enables remote debugging using the given port diff --git a/doc/man/taurusimage.1 b/doc/man/taurusimage.1 new file mode 100644 index 00000000..59ad39da --- /dev/null +++ b/doc/man/taurusimage.1 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.4. +.TH TAURUS "1" "February 2015" "Taurus Image Dialog 3.4.0" "User Commands" +.SH NAME +Taurus \- manual page for Taurus Image Dialog 3.4.0 +.SH SYNOPSIS +.B taurusimage +[\fI\,options\/\fR] \fI\,<model>\/\fR +.SH DESCRIPTION +a Taurus application for plotting Image Attributes +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +show this help message and exit +.TP +\fB\-\-demo\fR +show a demo of the widget +.TP +\fB\-\-rgb\fR +assume image is RGB +.TP +\fB\-\-window\-name\fR=\fI\,WINDOW_NAME\/\fR +Name of the window +.TP +\fB\-\-version\fR +show program's version number and exit +.IP +Taurus Options: +.IP +Basic options present in any taurus application +.TP +\fB\-\-taurus\-log\-level\fR=\fI\,LEVEL\/\fR +taurus log level. Allowed values are (case +insensitive): critical, error, warning/warn, info, +debug, trace +.TP +\fB\-\-taurus\-polling\-period\fR=\fI\,MILLISEC\/\fR +taurus global polling period in milliseconds +.TP +\fB\-\-taurus\-serialization\-mode\fR=\fI\,SERIAL\/\fR +taurus serialization mode. Allowed values are (case +insensitive): serial, concurrent (default) +.TP +\fB\-\-tango\-host\fR=\fI\,TANGO_HOST\/\fR +Tango host name +.TP +\fB\-\-remote\-console\-port\fR=\fI\,PORT\/\fR +enables remote debugging using the given port diff --git a/doc/man/macroexecutor.1 b/doc/man/tauruspanel.1 index a2de0a8e..80eecb22 100644 --- a/doc/man/macroexecutor.1 +++ b/doc/man/tauruspanel.1 @@ -1,36 +1,38 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.43.3. -.TH MACROEXECUTOR "1" "February 2015" "macroexecutor 3.4.0" "User Commands" +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.4. +.TH TAURUSPANEL "1" "February 2015" "tauruspanel 3.4.0" "User Commands" .SH NAME -macroexecutor \- manual page for macroexecutor 3.4.0 +tauruspanel \- manual page for tauruspanel 3.4.0 .SH SYNOPSIS -.B macroexecutor -[\fIoptions\fR] +.B tauruspanel +[\fI\,options\/\fR] [\fI\,devname\/\fR] +.SH DESCRIPTION +Taurus Application inspired in Jive and Atk Panel .SH OPTIONS .TP -\fB\-\-version\fR -show program's version number and exit -.TP \fB\-h\fR, \fB\-\-help\fR show this help message and exit +.TP +\fB\-\-version\fR +show program's version number and exit .IP Taurus Options: .IP Basic options present in any taurus application .TP -\fB\-\-taurus\-log\-level\fR=\fILEVEL\fR +\fB\-\-taurus\-log\-level\fR=\fI\,LEVEL\/\fR taurus log level. Allowed values are (case insensitive): critical, error, warning/warn, info, debug, trace .TP -\fB\-\-taurus\-polling\-period\fR=\fIMILLISEC\fR +\fB\-\-taurus\-polling\-period\fR=\fI\,MILLISEC\/\fR taurus global polling period in milliseconds .TP -\fB\-\-taurus\-serialization\-mode\fR=\fISERIAL\fR +\fB\-\-taurus\-serialization\-mode\fR=\fI\,SERIAL\/\fR taurus serialization mode. Allowed values are (case insensitive): serial, concurrent (default) .TP -\fB\-\-tango\-host\fR=\fITANGO_HOST\fR +\fB\-\-tango\-host\fR=\fI\,TANGO_HOST\/\fR Tango host name .TP -\fB\-\-remote\-console\-port\fR=\fIPORT\fR +\fB\-\-remote\-console\-port\fR=\fI\,PORT\/\fR enables remote debugging using the given port diff --git a/doc/man/taurusplot.1 b/doc/man/taurusplot.1 new file mode 100644 index 00000000..61cebef7 --- /dev/null +++ b/doc/man/taurusplot.1 @@ -0,0 +1,53 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.4. +.TH TAURUSPLOT "1" "February 2015" "taurusplot 3.4.0" "User Commands" +.SH NAME +taurusplot \- manual page for taurusplot 3.4.0 +.SH SYNOPSIS +.B taurusplot +[\fI\,options\/\fR] [\fI\,<model1> \/\fR[\fI\,<model2>\/\fR] ...] +.SH DESCRIPTION +a taurus application for plotting 1D data sets +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +show this help message and exit +.TP +\fB\-x\fR t|n, \fB\-\-x\-axis\-mode\fR=\fI\,t\/\fR|n +interprete X values as either timestamps (t) or +numbers (n). Accepted values: t|n (e is also accepted +as a synonim of n) +.TP +\fB\-\-config\fR=\fI\,CONFIG_FILE\/\fR, \fB\-\-config\-file\fR=\fI\,CONFIG_FILE\/\fR +use the given config file for initialization +.TP +\fB\-\-export\fR=\fI\,EXPORT_FILE\/\fR, \fB\-\-export\-file\fR=\fI\,EXPORT_FILE\/\fR +use the given file to as output instead of showing the +plot +.TP +\fB\-\-window\-name\fR=\fI\,WINDOW_NAME\/\fR +Name of the window +.TP +\fB\-\-version\fR +show program's version number and exit +.IP +Taurus Options: +.IP +Basic options present in any taurus application +.TP +\fB\-\-taurus\-log\-level\fR=\fI\,LEVEL\/\fR +taurus log level. Allowed values are (case +insensitive): critical, error, warning/warn, info, +debug, trace +.TP +\fB\-\-taurus\-polling\-period\fR=\fI\,MILLISEC\/\fR +taurus global polling period in milliseconds +.TP +\fB\-\-taurus\-serialization\-mode\fR=\fI\,SERIAL\/\fR +taurus serialization mode. Allowed values are (case +insensitive): serial, concurrent (default) +.TP +\fB\-\-tango\-host\fR=\fI\,TANGO_HOST\/\fR +Tango host name +.TP +\fB\-\-remote\-console\-port\fR=\fI\,PORT\/\fR +enables remote debugging using the given port diff --git a/doc/man/taurusremotelogmonitor.1 b/doc/man/taurusremotelogmonitor.1 new file mode 100644 index 00000000..d0c8e6d9 --- /dev/null +++ b/doc/man/taurusremotelogmonitor.1 @@ -0,0 +1,54 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.4. +.TH TAURUS "1" "February 2015" "Taurus remote logger 1.0" "User Commands" +.SH NAME +Taurus \- manual page for Taurus remote logger 1.0 +.SH SYNOPSIS +.B taurusremotelogmonitor +[\fI\,options\/\fR] +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +show this help message and exit +.TP +\fB\-g\fR, \fB\-\-gui\fR +gui mode [default] +.TP +\fB\-c\fR, \fB\-\-console\fR +console mode +.TP +\fB\-\-log\-port\fR=\fI\,LOG_PORT\/\fR +port where log server is running [default: 9020] +.TP +\fB\-\-log\-name\fR=\fI\,LOG_NAME\/\fR +filter specific log object [default: None, meaning +don't filter] +.TP +\fB\-\-log\-level\fR=\fI\,LOG_LEVEL\/\fR +filter specific log level.Allowed values are (case +insensitive): critical, error, warning/warn, info, +debug, trace [default: debug]. +.TP +\fB\-\-version\fR +show program's version number and exit +.IP +Taurus Options: +.IP +Basic options present in any taurus application +.TP +\fB\-\-taurus\-log\-level\fR=\fI\,LEVEL\/\fR +taurus log level. Allowed values are (case +insensitive): critical, error, warning/warn, info, +debug, trace +.TP +\fB\-\-taurus\-polling\-period\fR=\fI\,MILLISEC\/\fR +taurus global polling period in milliseconds +.TP +\fB\-\-taurus\-serialization\-mode\fR=\fI\,SERIAL\/\fR +taurus serialization mode. Allowed values are (case +insensitive): serial, concurrent (default) +.TP +\fB\-\-tango\-host\fR=\fI\,TANGO_HOST\/\fR +Tango host name +.TP +\fB\-\-remote\-console\-port\fR=\fI\,PORT\/\fR +enables remote debugging using the given port diff --git a/doc/man/taurustrend.1 b/doc/man/taurustrend.1 new file mode 100644 index 00000000..13d372fc --- /dev/null +++ b/doc/man/taurustrend.1 @@ -0,0 +1,63 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.4. +.TH TAURUSTREND "1" "February 2015" "taurustrend 3.4.0" "User Commands" +.SH NAME +taurustrend \- manual page for taurustrend 3.4.0 +.SH SYNOPSIS +.B taurustrend +[\fI\,options\/\fR] [\fI\,<model1> \/\fR[\fI\,<model2>\/\fR] ...] +.SH DESCRIPTION +a taurus application for plotting trends +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +show this help message and exit +.TP +\fB\-x\fR t|e, \fB\-\-x\-axis\-mode\fR=\fI\,t\/\fR|e +interprete X values as either timestamps (t) or event +numbers (e). Accepted values: t|e +.TP +\fB\-b\fR MAX_BUFFER_SIZE, \fB\-\-buffer\fR=\fI\,MAX_BUFFER_SIZE\/\fR +maximum number of values per curve to be plotted +(default = 65536) (when reached, the oldest values +will be discarded) +.TP +\fB\-\-config\fR=\fI\,CONFIG_FILE\/\fR, \fB\-\-config\-file\fR=\fI\,CONFIG_FILE\/\fR +use the given config file for initialization +.TP +\fB\-\-export\fR=\fI\,EXPORT_FILE\/\fR, \fB\-\-export\-file\fR=\fI\,EXPORT_FILE\/\fR +use the given file to as output instead of showing the +plot +.TP +\fB\-r\fR MILLISECONDS, \fB\-\-forced\-read\fR=\fI\,MILLISECONDS\/\fR +force Taurustrend to re\-read the attributes every +MILLISECONDS ms +.HP +\fB\-a\fR, \fB\-\-use\-archiving\fR +.TP +\fB\-\-window\-name\fR=\fI\,WINDOW_NAME\/\fR +Name of the window +.TP +\fB\-\-version\fR +show program's version number and exit +.IP +Taurus Options: +.IP +Basic options present in any taurus application +.TP +\fB\-\-taurus\-log\-level\fR=\fI\,LEVEL\/\fR +taurus log level. Allowed values are (case +insensitive): critical, error, warning/warn, info, +debug, trace +.TP +\fB\-\-taurus\-polling\-period\fR=\fI\,MILLISEC\/\fR +taurus global polling period in milliseconds +.TP +\fB\-\-taurus\-serialization\-mode\fR=\fI\,SERIAL\/\fR +taurus serialization mode. Allowed values are (case +insensitive): serial, concurrent (default) +.TP +\fB\-\-tango\-host\fR=\fI\,TANGO_HOST\/\fR +Tango host name +.TP +\fB\-\-remote\-console\-port\fR=\fI\,PORT\/\fR +enables remote debugging using the given port diff --git a/doc/man/taurustrend1d.1 b/doc/man/taurustrend1d.1 new file mode 100644 index 00000000..774fafba --- /dev/null +++ b/doc/man/taurustrend1d.1 @@ -0,0 +1,54 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.4. +.TH TAURUS "1" "February 2015" "Taurus Trend 3.4.0" "User Commands" +.SH NAME +Taurus \- manual page for Taurus Trend 3.4.0 +.SH SYNOPSIS +.B taurustrend1d +[\fI\,options\/\fR] \fI\,<model>\/\fR +.SH DESCRIPTION +a Taurus application for plotting trends of scalars +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +show this help message and exit +.TP +\fB\-x\fR t|d|e, \fB\-\-x\-axis\-mode\fR=\fI\,t\/\fR|d|e +interpret X values as timestamps (t), time deltas (d) +or event numbers (e). Accepted values: t|d|e +.TP +\fB\-b\fR MAX_BUFFER_SIZE, \fB\-\-buffer\fR=\fI\,MAX_BUFFER_SIZE\/\fR +maximum number of values to be plotted (when reached, +the oldest values will be discarded) +.HP +\fB\-a\fR, \fB\-\-use\-archiving\fR +.TP +\fB\-\-demo\fR +show a demo of the widget +.TP +\fB\-\-window\-name\fR=\fI\,WINDOW_NAME\/\fR +Name of the window +.TP +\fB\-\-version\fR +show program's version number and exit +.IP +Taurus Options: +.IP +Basic options present in any taurus application +.TP +\fB\-\-taurus\-log\-level\fR=\fI\,LEVEL\/\fR +taurus log level. Allowed values are (case +insensitive): critical, error, warning/warn, info, +debug, trace +.TP +\fB\-\-taurus\-polling\-period\fR=\fI\,MILLISEC\/\fR +taurus global polling period in milliseconds +.TP +\fB\-\-taurus\-serialization\-mode\fR=\fI\,SERIAL\/\fR +taurus serialization mode. Allowed values are (case +insensitive): serial, concurrent (default) +.TP +\fB\-\-tango\-host\fR=\fI\,TANGO_HOST\/\fR +Tango host name +.TP +\fB\-\-remote\-console\-port\fR=\fI\,PORT\/\fR +enables remote debugging using the given port diff --git a/doc/man/taurustrend2d.1 b/doc/man/taurustrend2d.1 new file mode 100644 index 00000000..fa580892 --- /dev/null +++ b/doc/man/taurustrend2d.1 @@ -0,0 +1,54 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.4. +.TH TAURUS "1" "February 2015" "Taurus Trend 2D 3.4.0" "User Commands" +.SH NAME +Taurus \- manual page for Taurus Trend 2D 3.4.0 +.SH SYNOPSIS +.B taurustrend2d +[\fI\,options\/\fR] \fI\,<model>\/\fR +.SH DESCRIPTION +a Taurus application for plotting trends of arrays (aka "spectrograms") +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +show this help message and exit +.TP +\fB\-x\fR t|d|e, \fB\-\-x\-axis\-mode\fR=\fI\,t\/\fR|d|e +interpret X values as timestamps (t), time deltas (d) +or event numbers (e). Accepted values: t|d|e +.TP +\fB\-b\fR MAX_BUFFER_SIZE, \fB\-\-buffer\fR=\fI\,MAX_BUFFER_SIZE\/\fR +maximum number of values to be stacked (when reached, +the oldest values will be discarded) +.HP +\fB\-a\fR, \fB\-\-use\-archiving\fR +.TP +\fB\-\-demo\fR +show a demo of the widget +.TP +\fB\-\-window\-name\fR=\fI\,WINDOW_NAME\/\fR +Name of the window +.TP +\fB\-\-version\fR +show program's version number and exit +.IP +Taurus Options: +.IP +Basic options present in any taurus application +.TP +\fB\-\-taurus\-log\-level\fR=\fI\,LEVEL\/\fR +taurus log level. Allowed values are (case +insensitive): critical, error, warning/warn, info, +debug, trace +.TP +\fB\-\-taurus\-polling\-period\fR=\fI\,MILLISEC\/\fR +taurus global polling period in milliseconds +.TP +\fB\-\-taurus\-serialization\-mode\fR=\fI\,SERIAL\/\fR +taurus serialization mode. Allowed values are (case +insensitive): serial, concurrent (default) +.TP +\fB\-\-tango\-host\fR=\fI\,TANGO_HOST\/\fR +Tango host name +.TP +\fB\-\-remote\-console\-port\fR=\fI\,PORT\/\fR +enables remote debugging using the given port diff --git a/doc/man/taurusui.1 b/doc/man/taurusui.1 new file mode 100644 index 00000000..645a40f3 --- /dev/null +++ b/doc/man/taurusui.1 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.4. +.TH TAURUSUI "1" "February 2015" "taurusui 1.0" "User Commands" +.SH NAME +taurusui \- manual page for taurusui 1.0 +.SH SYNOPSIS +.B taurusui +[\fI\,options\/\fR] \fI\,<ui_file1> \/\fR[\fI\,<ui_file2> \/\fR...] +.SH DESCRIPTION +a taurus application that launches GUI(s) for the given .ui file(s) +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +show this help message and exit +.TP +\fB\-\-version\fR +show program's version number and exit +.IP +Taurus Options: +.IP +Basic options present in any taurus application +.TP +\fB\-\-taurus\-log\-level\fR=\fI\,LEVEL\/\fR +taurus log level. Allowed values are (case +insensitive): critical, error, warning/warn, info, +debug, trace +.TP +\fB\-\-taurus\-polling\-period\fR=\fI\,MILLISEC\/\fR +taurus global polling period in milliseconds +.TP +\fB\-\-taurus\-serialization\-mode\fR=\fI\,SERIAL\/\fR +taurus serialization mode. Allowed values are (case +insensitive): serial, concurrent (default) +.TP +\fB\-\-tango\-host\fR=\fI\,TANGO_HOST\/\fR +Tango host name +.TP +\fB\-\-remote\-console\-port\fR=\fI\,PORT\/\fR +enables remote debugging using the given port diff --git a/doc/man/taurusuic4.1 b/doc/man/taurusuic4.1 new file mode 100644 index 00000000..0383b74c --- /dev/null +++ b/doc/man/taurusuic4.1 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.4. +.TH TAURUSUIC4 "1" "February 2015" "taurusuic4 *******************************************************************************" "User Commands" +.SH NAME +taurusuic4 \- manual page for taurusuic4 ******************************************************************************* +.SH SYNOPSIS +.B taurusuic4 +[\fI\,options\/\fR] \fI\,<ui-file>\/\fR +.SH DESCRIPTION +******************************************************************************* +taurusuic4 is deprecated since SEP11 (http://sf.net/p/sardana/wiki/SEP11) +Consider using the taurus.qt.qtgui.util.UILoadable decorator instead +******************************************************************************* +.PP +a taurus customized pyuic4 +.SH OPTIONS +.TP +\fB\-\-version\fR +show program's version number and exit +.TP +\fB\-h\fR, \fB\-\-help\fR +show this help message and exit +.HP +\fB\-p\fR PREVIEW, \fB\-\-preview\fR=\fI\,PREVIEW\/\fR +.TP +\fB\-o\fR FILE, \fB\-\-output\fR=\fI\,FILE\/\fR +write generated code to FILE instead of stdout +.TP +\fB\-x\fR, \fB\-\-execute\fR +generate extra code to test and display the class +.TP +\fB\-d\fR, \fB\-\-debug\fR +show debug output +.TP +\fB\-i\fR N, \fB\-\-indent\fR=\fI\,N\/\fR +set indent width to N spaces, tab if N is 0 (default: +4) +.TP +\fB\-w\fR, \fB\-\-pyqt3\-wrapper\fR +generate a PyQt v3 style wrapper +.TP +\fB\-T\fR +generate an additional taurus python file +.PP +taurusuic4 is deprecated since SEP11 (http://sf.net/p/sardana/wiki/SEP11) +Consider using the taurus.qt.qtgui.util.UILoadable decorator instead +******************************************************************************* +taurusuic4 3.4.0 |