summaryrefslogtreecommitdiff
path: root/doc/man/taurus.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/taurus.1')
-rw-r--r--doc/man/taurus.121
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/man/taurus.1 b/doc/man/taurus.1
new file mode 100644
index 00000000..16b73ac1
--- /dev/null
+++ b/doc/man/taurus.1
@@ -0,0 +1,21 @@
+.TH TAURUS 1
+.SH NAME
+taurus \- Taurus command line interface
+.SH SYNOPSIS
+.TP
+\fBtaurus\fP [\fIoptions\fP] [\fIsubcommand\fP [\fIsuboptions\fP] [\fIargs\fP] ... ]
+.SH OVERVIEW
+Taurus is a python framework for control and data acquisition CLIs and
+GUIs in scientific/industrial environments.
+
+The \fBtaurus\fP command is the main CLI access to launch Taurus
+tools. It uses subcommands (e.g. `form', `gui', ...) to provide
+functionality.
+
+The subcommands can be dynamically provided by plugins, so the best
+source for information about the available options and subcommands is
+to run `taurus --help`. Each subcommand will also provide more detailed help
+about its own options and arguments if run as `taurus <command> --help`
+
+For more information about the Taurus project, visit
+http://taurus-scada.org.