File tree Expand file tree Collapse file tree 2 files changed +23
-11
lines changed Expand file tree Collapse file tree 2 files changed +23
-11
lines changed Original file line number Diff line number Diff line change 11Information
22===========
33
4+ Documentation
5+ -------------
6+
7+ The different commands are documented in their application groups to give
8+ a better overview of the processes. Every page shows the actual command to
9+ invoke the program, some additional context and optional examples, and an
10+ automatically generated view of the ``--help `` page of the command.
11+
412Command Structure
513-----------------
614
@@ -21,10 +29,19 @@ commands:
2129 iman validate sets -h
2230 iman calc sets -h
2331
24- Documentation
25- -------------
32+ Logging
33+ -------
2634
27- The different commands are documented in their application groups to give
28- a better overview of the processes. Every page shows the actual command to
29- invoke the program, some additional context and optional examples, and an
30- automatically generated view of the ``--help `` page of the command.
35+ Various commands (primarily the measurement programs) support logging. The
36+ logging can be set up through the logging options of the root command ``iman ``.
37+ These have to be set before specifying the command groups.
38+
39+ .. code-block :: shell
40+
41+ iman --info --file iman.log measure ...
42+
43+ Usage
44+ -----
45+
46+ .. click :: instrumentman:cli
47+ :prog: iman
Original file line number Diff line number Diff line change @@ -50,11 +50,6 @@ controlling computer (e.g. Task Scheduler on Windows, crontab on Linux).
5050Examples
5151--------
5252
53- .. code-block :: shell
54- :caption: Logging to file
55-
56- iman measure sets --debug COM3 targets.json results >> tps.log 2>&1
57-
5853.. code-block :: shell
5954 :caption: Enabling connection retries and timeout recovery attempts (might be useful with bluetooth connections)
6055
You can’t perform that action at this time.
0 commit comments