diff options
author | CI <controls@cells.es> | 2019-11-14 08:36:27 +0000 |
---|---|---|
committer | CI <controls@cells.es> | 2019-11-14 08:36:27 +0000 |
commit | 1eacd7351803ab4a0bcc0d19c6a9d903cca93058 (patch) | |
tree | 90d5033f00f4dd044323092d65fe8de019864995 | |
parent | 1aead4bc6937e2eb04a362bef64ed01e2d4ad6d0 (diff) | |
parent | 9f6895f0901cddc8ab69cc334e25ff3a702466d3 (diff) |
Merge upstream/3.0.2a0+34.9f6895 into sid
-rw-r--r-- | .gitlab-ci-alba.yml | 10 | ||||
-rw-r--r-- | doc/man/MacroServer.1 | 52 | ||||
-rw-r--r-- | doc/man/Pool.1 | 51 | ||||
-rw-r--r-- | doc/man/Sardana.1 | 51 | ||||
-rw-r--r-- | doc/man/diffractometeralignment.1 | 51 | ||||
-rw-r--r-- | doc/man/hklscan.1 | 49 | ||||
-rw-r--r-- | doc/man/macroexecutor.1 | 51 | ||||
-rw-r--r-- | doc/man/sardanatestsuite.1 | 31 | ||||
-rw-r--r-- | doc/man/sequencer.1 | 57 | ||||
-rw-r--r-- | doc/man/spock.1 | 383 | ||||
-rw-r--r-- | doc/man/ubmatrix.1 | 53 |
11 files changed, 147 insertions, 692 deletions
diff --git a/.gitlab-ci-alba.yml b/.gitlab-ci-alba.yml index 0d2dc0a0..90f768f8 100644 --- a/.gitlab-ci-alba.yml +++ b/.gitlab-ci-alba.yml @@ -1,8 +1,8 @@ +# This file is for configuring the CI/CD for creating (unofficial) +# debian packages for sardana at ALBA +# It has no efect unless you configure your gitlab instance to use it. +# TODO: generalise this so that it does not depend on ALBA's infrastructure + include: - https://git.cells.es/ctpkg/ci/ctpipeline/raw/master/ctjobdefs-ci.yml - https://git.cells.es/ctpkg/ci/ctpipeline/raw/master/ctpipeline.yml - -variables: - DEBEMAIL: 'cpascual@cells.es' - DEBFULLNAME: 'Carlos Pascual' - diff --git a/doc/man/MacroServer.1 b/doc/man/MacroServer.1 index 83823ff4..338f42eb 100644 --- a/doc/man/MacroServer.1 +++ b/doc/man/MacroServer.1 @@ -1,38 +1,18 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4. -.TH MACROSERVER "1" "September 2019" "MacroServer 2.8.3" "User Commands" +.TH MacroServer "1" .SH NAME -MacroServer \- manual page for MacroServer 2.8.3 +MacroServer \- Sardana MacroServer Tango device server .SH SYNOPSIS -.B usage: -\fI\,MacroServer instance_name \/\fR[\fI\,options\/\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=\fI\,LOG_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=\fI\,LOG_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=\fI\,LOG_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=\fI\,WITHOUT_LOG_FILE\/\fR -When set to True disables logging into a file -[default: False] -.TP -\fB\-\-rconsole\-port\fR=\fI\,RCONSOLE_PORT\/\fR -rconsole port number. [default: 0 meaning rconsole NOT -active] +.B MacroServer +\fI\,[instance_name] \/ +.SH DESCRIPTION +Sardana is a software suite for Supervision, Control and Data Acquisition +in scientific installations. + +The \fBMacroServer\fP command launches the Sardana MacroServer Tango +device server. + +The best source for information about the available options is +to run `MacroServer --help`. + +For more information about the Sardana project, visit +http://sardana-controls.org. diff --git a/doc/man/Pool.1 b/doc/man/Pool.1 index 14a3bec9..1c5272c8 100644 --- a/doc/man/Pool.1 +++ b/doc/man/Pool.1 @@ -1,38 +1,17 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4. -.TH POOL "1" "September 2019" "Pool 2.8.3" "User Commands" +.TH POOL "1" .SH NAME -Pool \- manual page for Pool 2.8.3 +Pool \- Sardana Pool Tango device server .SH SYNOPSIS -.B usage: -\fI\,Pool instance_name \/\fR[\fI\,options\/\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=\fI\,LOG_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=\fI\,LOG_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=\fI\,LOG_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=\fI\,WITHOUT_LOG_FILE\/\fR -When set to True disables logging into a file -[default: False] -.TP -\fB\-\-rconsole\-port\fR=\fI\,RCONSOLE_PORT\/\fR -rconsole port number. [default: 0 meaning rconsole NOT -active] +.B Pool +\fI\,[instance_name] \/ +.SH DESCRIPTION +Sardana is a software suite for Supervision, Control and Data Acquisition +in scientific installations. + +The \fBPool\fP command launches the Sardana Pool Tango device server. + +The best source for information about the available options is +to run `Pool --help`. + +For more information about the Sardana project, visit +http://sardana-controls.org. diff --git a/doc/man/Sardana.1 b/doc/man/Sardana.1 index 74156ec9..c42bc106 100644 --- a/doc/man/Sardana.1 +++ b/doc/man/Sardana.1 @@ -1,38 +1,17 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4. -.TH SARDANA "1" "September 2019" "Sardana 2.8.3" "User Commands" +.TH SARDANA "1" .SH NAME -Sardana \- manual page for Sardana 2.8.3 +Sardana \- Sardana Tango device server .SH SYNOPSIS -.B usage: -\fI\,Sardana instance_name \/\fR[\fI\,options\/\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=\fI\,LOG_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=\fI\,LOG_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=\fI\,LOG_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=\fI\,WITHOUT_LOG_FILE\/\fR -When set to True disables logging into a file -[default: False] -.TP -\fB\-\-rconsole\-port\fR=\fI\,RCONSOLE_PORT\/\fR -rconsole port number. [default: 0 meaning rconsole NOT -active] +.B Sardana +\fI\,[instance_name] \/ +.SH DESCRIPTION +Sardana is a software suite for Supervision, Control and Data Acquisition +in scientific installations. + +The \fBSardana\fP command launches the Sardana Tango device server. + +The best source for information about the available options is +to run `Sardana --help`. + +For more information about the Sardana project, visit +http://sardana-controls.org. diff --git a/doc/man/diffractometeralignment.1 b/doc/man/diffractometeralignment.1 index f36a7b90..1967c24e 100644 --- a/doc/man/diffractometeralignment.1 +++ b/doc/man/diffractometeralignment.1 @@ -1,43 +1,18 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4. -.TH DIFFRACTOMETERALIGNMENT "1" "September 2019" "diffractometeralignment 2.8.3" "User Commands" +.TH DIFFRACTOMETERALIGNMENT "1" .SH NAME -diffractometeralignment \- manual page for diffractometeralignment 2.8.3 +diffractometeralignment \- Sardana diffractometer alignment GUI .SH SYNOPSIS .B diffractometeralignment \fI\,<model> \/\fR[\fI\,door_name\/\fR] .SH DESCRIPTION -a taurus application for diffractometer alignment: h, k, l movements and -scans, go to maximum, ... -.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 (either HOST:PORT or a Taurus URI, -e.g. tango://foo:1234) -.TP -\fB\-\-remote\-console\-port\fR=\fI\,PORT\/\fR -enables remote debugging using the given port -.TP -\fB\-\-default\-formatter\fR=\fI\,FORMATTER\/\fR -Override the default formatter +Sardana is a software suite for Supervision, Control and Data Acquisition +in scientific installations. + +The \fBdiffractometeralignment\fP command is the GUI application +for diffractometer alignment: h, k, l movements and scans, go to maximum, ... + +The best source for information about the available options is +to run `diffractometeralignment --help`. + +For more information about the Sardana project, visit +http://sardana-controls.org. diff --git a/doc/man/hklscan.1 b/doc/man/hklscan.1 index 5f35b0b1..50d5f4a0 100644 --- a/doc/man/hklscan.1 +++ b/doc/man/hklscan.1 @@ -1,42 +1,17 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4. -.TH HKLSCAN "1" "September 2019" "hklscan 2.8.3" "User Commands" +.TH HKLSCAN "1" .SH NAME -hklscan \- manual page for hklscan 2.8.3 +hklscan \- Sardana HKL scan GUI .SH SYNOPSIS .B hklscan \fI\,<model> \/\fR[\fI\,door_name\/\fR] .SH DESCRIPTION -a taurus application for performing hkl scans -.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 (either HOST:PORT or a Taurus URI, -e.g. tango://foo:1234) -.TP -\fB\-\-remote\-console\-port\fR=\fI\,PORT\/\fR -enables remote debugging using the given port -.TP -\fB\-\-default\-formatter\fR=\fI\,FORMATTER\/\fR -Override the default formatter +Sardana is a software suite for Supervision, Control and Data Acquisition +in scientific installations. + +The \fBhklscan\fP command is the GUI application for performing hkl scans. + +The best source for information about the available options is +to run `hklscan --help`. + +For more information about the Sardana project, visit +http://sardana-controls.org.
\ No newline at end of file diff --git a/doc/man/macroexecutor.1 b/doc/man/macroexecutor.1 index 759b6067..12e6f5e3 100644 --- a/doc/man/macroexecutor.1 +++ b/doc/man/macroexecutor.1 @@ -1,40 +1,17 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4. -.TH MACROEXECUTOR "1" "September 2019" "macroexecutor 2.8.3" "User Commands" +.TH MACROEXECUTOR "1" .SH NAME -macroexecutor \- manual page for macroexecutor 2.8.3 +macroexecutor \- Sardana GUI application for executing macros .SH SYNOPSIS .B macroexecutor -[\fI\,options\/\fR] -.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 (either HOST:PORT or a Taurus URI, -e.g. tango://foo:1234) -.TP -\fB\-\-remote\-console\-port\fR=\fI\,PORT\/\fR -enables remote debugging using the given port -.TP -\fB\-\-default\-formatter\fR=\fI\,FORMATTER\/\fR -Override the default formatter +\fI\,<model> \/\fR[\fI\,door_name\/\fR] +.SH DESCRIPTION +Sardana is a software suite for Supervision, Control and Data Acquisition +in scientific installations. + +The \fBmacroexecutor\fP command is the GUI application for executing macros. + +The best source for information about the available options is +to run `macroexecutor --help`. + +For more information about the Sardana project, visit +http://sardana-controls.org. diff --git a/doc/man/sardanatestsuite.1 b/doc/man/sardanatestsuite.1 index 3ffab16d..9777120f 100644 --- a/doc/man/sardanatestsuite.1 +++ b/doc/man/sardanatestsuite.1 @@ -1,19 +1,16 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4. -.TH SARDANATESTSUITE "1" "September 2019" "sardanatestsuite 2.8.3" "User Commands" +.TH SARDANATESTSUITE "1" .SH NAME -sardanatestsuite \- manual page for sardanatestsuite 2.8.3 +sardanatestsuite \- Sardana test suite +.SH SYNOPSIS +.B sardanatestsuite .SH DESCRIPTION -usage: sardanatestsuite [\-h] [\-e EXCLUDE_PATTERN] [\-\-version] -.PP -Main test suite for Sardana -.SS "optional arguments:" -.TP -\fB\-h\fR, \fB\-\-help\fR -show this help message and exit -.TP -\fB\-e\fR EXCLUDE_PATTERN, \fB\-\-exclude\-pattern\fR EXCLUDE_PATTERN -regexp pattern matching test ids to be excluded. (e.g. -\&'sardana\e.pool\e..*' would exclude sardana.pool tests) -.TP -\fB\-\-version\fR -show program's version number and exit +Sardana is a software suite for Supervision, Control and Data Acquisition +in scientific installations. + +The \fBsardanatestsuite\fP command launches the Sardana test suite. + +The best source for information about the available options is +to run `sardanatestsuite --help`. + +For more information about the Sardana project, visit +http://sardana-controls.org. diff --git a/doc/man/sequencer.1 b/doc/man/sequencer.1 index 70b96446..2e5dd048 100644 --- a/doc/man/sequencer.1 +++ b/doc/man/sequencer.1 @@ -1,46 +1,19 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4. -.TH SEQUENCER "1" "September 2019" "sequencer 2.8.3" "User Commands" +.TH SEQUENCER "1" .SH NAME -sequencer \- manual page for sequencer 2.8.3 +sequencer \- Sardana GUI application for executing macro sequences .SH SYNOPSIS .B sequencer -[\fI\,options\/\fR] +\fI\,<model> \/\fR[\fI\,door_name\/\fR] .SH DESCRIPTION -Sardana macro sequencer. It allows the creation of sequences of macros, -executed one after the other. The sequences can be stored under xml files -.SH OPTIONS -.TP -\fB\-h\fR, \fB\-\-help\fR -show this help message and exit -.TP -\fB\-f\fR FILE, \fB\-\-file\fR=\fI\,FILE\/\fR -load macro sequence from a file(XML or spock syntax) -.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 (either HOST:PORT or a Taurus URI, -e.g. tango://foo:1234) -.TP -\fB\-\-remote\-console\-port\fR=\fI\,PORT\/\fR -enables remote debugging using the given port -.TP -\fB\-\-default\-formatter\fR=\fI\,FORMATTER\/\fR -Override the default formatter +Sardana is a software suite for Supervision, Control and Data Acquisition +in scientific installations. + +The \fBsequencer\fP command is the GUI application for executing macro +sequences. It allows creation of sequences of macros, +executed one after the other. The sequences can be stored under xml files. + +The best source for information about the available options is +to run `sequencer --help`. + +For more information about the Sardana project, visit +http://sardana-controls.org. diff --git a/doc/man/spock.1 b/doc/man/spock.1 index 32ec46ba..a95b5b2d 100644 --- a/doc/man/spock.1 +++ b/doc/man/spock.1 @@ -1,371 +1,16 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4. -.TH SPOCK "1" "September 2019" "spock 2.8.2" "User Commands" +.TH SPOCK "1" .SH NAME -spock \- manual page for spock 2.8.2 +spock \- Sardana CLI application +.SH SYNOPSIS +.B spock .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. IPYTHONDIR -defaults to to `$HOME/.ipython`. For Windows users, $HOME resolves to -C:\eUsers\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 `ipython cmd [args]`. For information on using -subcommand 'cmd', do: `ipython cmd \fB\-h\fR`. -.PP -locate -.IP -print the path to the IPython dir -.PP -kernel -.IP -Start a kernel without an attached frontend. -.PP -console -.IP -DEPRECATED, Will be removed in IPython 6.0 : Launch the Jupyter terminal\-based Console. -.PP -install\-nbextension -.IP -DEPRECATED, Will be removed in IPython 6.0 : Install Jupyter notebook extension files -.PP -kernelspec -.IP -DEPRECATED, Will be removed in IPython 6.0 : Manage Jupyter kernel specifications. -.PP -notebook -.IP -DEPRECATED, Will be removed in IPython 6.0 : Launch the Jupyter HTML Notebook Server. -.PP -profile -.IP -Create and manage IPython profiles. -.PP -qtconsole -.IP -DEPRECATED, Will be removed in IPython 6.0 : Launch the Jupyter Qt Console. -.PP -nbconvert -.IP -DEPRECATED, Will be removed in IPython 6.0 : Convert notebooks to/from other formats. -.PP -trust -.IP -DEPRECATED, Will be removed in IPython 6.0 : Sign notebooks to trust their potentially unsafe contents at load. -.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\-\-pylab\fR -.IP -Pre\-load matplotlib and numpy for interactive use with -the default matplotlib backend. -.PP -\fB\-\-simple\-prompt\fR -.IP -Force simple minimal prompt using `raw_input` -.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\-\-no\-autoedit\-syntax\fR -.IP -Turn off auto editing of files with syntax errors. -.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\-\-no\-confirm\-exit\fR -.IP -Don't prompt the user when exiting. -.PP -\fB\-\-autoindent\fR -.IP -Turn on autoindenting. -.PP -\fB\-\-no\-automagic\fR -.IP -Turn off the auto calling of magic commands. -.PP -\fB\-\-no\-simple\-prompt\fR -.IP -Use a rich interactive prompt with prompt_toolkit -.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\-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. -It is often useful to follow this with `\-\-` to treat remaining flags as -script arguments. -.PP -\fB\-\-debug\fR -.IP -set log level to logging.DEBUG (maximize logging output) -.PP -\fB\-\-classic\fR -.IP -Gives IPython a similar feel to the classic Python prompt. -.PP -\fB\-\-quiet\fR -.IP -set log level to logging.CRITICAL (minimize logging output) -.PP -\fB\-\-pprint\fR -.IP -Enable auto pretty printing of results. -.PP -\fB\-\-pdb\fR -.IP -Enable auto calling the pdb debugger after every exception. -.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. This is on by default, but can cause -problems with some pagers. If you see such problems, you can disable the -colours. -.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\-color\-info\fR -.IP -Disable using colors for info related things. -.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\-\-pylab=\fR<CaselessStrEnum> (InteractiveShellApp.pylab) -.IP -Default: None -Choices: [u'auto', u'gtk', u'gtk3', u'inline', u'nbagg', u'notebook', u'osx', u'qt', u'qt4', u'qt5', u'tk', u'wx'] -Pre\-load matplotlib and numpy for interactive use, selecting a particular -matplotlib backend and loop integration. -.PP -\fB\-\-matplotlib=\fR<CaselessStrEnum> (InteractiveShellApp.matplotlib) -.IP -Default: None -Choices: [u'auto', u'gtk', u'gtk3', u'inline', u'nbagg', u'notebook', u'osx', u'qt', u'qt4', u'qt5', u'tk', u'wx'] -Configure matplotlib for interactive use with the default matplotlib -backend. -.PP -\fB\-\-colors=\fR<CaselessStrEnum> (InteractiveShell.colors) -.IP -Default: 'Neutral' -Choices: [u'Neutral', u'NoColor', u'LightBG', u'Linux'] -Set the color scheme (NoColor, Neutral, Linux, or LightBG). -.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\-\-profile\-dir=\fR<Unicode> (ProfileDir.location) -.IP -Default: u'' -Set the profile location directly. This overrides the logic used by the -`profile` option. -.PP -\fB\-c\fR <Unicode> (InteractiveShellApp.code_to_run) -.IP -Default: '' -Execute the given command string. -.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'' -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 option can also be specified through the -environment variable IPYTHONDIR. -.PP -\fB\-\-gui=\fR<CaselessStrEnum> (InteractiveShellApp.gui) -.IP -Default: None -Choices: [u'glut', u'gtk', u'gtk2', u'gtk3', u'osx', u'pyglet', u'qt', u'qt4', u'qt5', u'tk', u'wx', u'gtk2', u'qt4'] -Enable GUI event loop integration with any of ('glut', 'gtk', 'gtk2', -\&'gtk3', 'osx', 'pyglet', 'qt', 'qt4', 'qt5', 'tk', 'wx', 'gtk2', 'qt4'). -.PP -\fB\-\-logappend=\fR<Unicode> (InteractiveShell.logappend) -.IP -Default: '' -Start logging to the given file in append mode. Use `logfile` to specify a -log file to **overwrite** logs to. -.PP -\fB\-m\fR <Unicode> (InteractiveShellApp.module_to_run) -.IP -Default: '' -Run the module as a script. -.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\-\-ext=\fR<Unicode> (InteractiveShellApp.extra_extension) -.IP -Default: '' -dotted module name of an IPython extension to load. -.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\-\-matplotlib\fR=\fI\,qt\/\fR -# enable matplotlib integration with qt4 backend -.TP -ipython \fB\-\-log\-level\fR=\fI\,DEBUG\/\fR -# set logging to DEBUG -.TP -ipython \fB\-\-profile\fR=\fI\,foo\/\fR -# start with profile foo -.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` +Sardana is a software suite for Supervision, Control and Data Acquisition +in scientific installations. + +The \fBspock\fP command launches the Sardana CLI application based on IPython. + +The best source for information about the available options is +to visit the Spock documentation: http://sardana-controls.org/users/spock.html. + +For more information about the Sardana project, visit +http://sardana-controls.org. diff --git a/doc/man/ubmatrix.1 b/doc/man/ubmatrix.1 index ae975951..393a9763 100644 --- a/doc/man/ubmatrix.1 +++ b/doc/man/ubmatrix.1 @@ -1,43 +1,18 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4. -.TH UBMATRIX "1" "September 2019" "ubmatrix 2.8.3" "User Commands" +.TH UBMATRIX "1" .SH NAME -ubmatrix \- manual page for ubmatrix 2.8.3 +ubmatrix \- Sardana GUI application for setting diffractomer parameters .SH SYNOPSIS .B ubmatrix -\fI\,<model>\/\fR +\fI\,<model> \/\fR[\fI\,door_name\/\fR] .SH DESCRIPTION -a taurus application for setting diffractometer parameters: ubmatrix, lattice, -reflections, ... -.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 (either HOST:PORT or a Taurus URI, -e.g. tango://foo:1234) -.TP -\fB\-\-remote\-console\-port\fR=\fI\,PORT\/\fR -enables remote debugging using the given port -.TP -\fB\-\-default\-formatter\fR=\fI\,FORMATTER\/\fR -Override the default formatter +Sardana is a software suite for Supervision, Control and Data Acquisition +in scientific installations. + +The \fBubmatrix\fP command is the GUI application for setting diffractometer +parameters: ubmatrix, lattice, reflections, ... + +The best source for information about the available options is +to run `ubmatrix --help`. + +For more information about the Sardana project, visit +http://sardana-controls.org. |