]>
Commit | Line | Data |
---|---|---|
57dd6be4 | 1 | .TH PULSEVIEW 1 "March 31, 2020" |
94236aa4 | 2 | .SH "NAME" |
e65ff35e | 3 | PulseView \- Qt-based LA/scope/MSO GUI for sigrok |
94236aa4 | 4 | .SH "SYNOPSIS" |
99d4a087 | 5 | .B pulseview \fR[\fBOPTIONS\fR] [\fBFILE\fR] |
94236aa4 UH |
6 | .SH "DESCRIPTION" |
7 | .B PulseView | |
8 | is a cross-platform Qt-based GUI for the | |
9 | .B sigrok | |
10 | software suite for test and measurement equipment such as logic analyzers, | |
e65ff35e | 11 | oscilloscopes, MSOs, and more. |
94236aa4 UH |
12 | .SH "OPTIONS" |
13 | .B PulseView | |
14 | has very few command line options, as most configuration elements are | |
15 | available from the GUI itself. | |
6ce79e39 | 16 | .sp |
99d4a087 SA |
17 | If the optional \fBFILE\fR argument is supplied, PulseView tries to open |
18 | the specified file. It has to be in the "libsigrok session" format (.sr) | |
19 | unless -I is used to specify the input file format. | |
6ce79e39 UH |
20 | .TP |
21 | .B "\-l, \-\-loglevel" | |
22 | Set the libsigrok and libsigrokdecode loglevel. At the moment PulseView | |
23 | doesn't support setting the two loglevels independently. The higher the | |
24 | number, the more debug output will be printed. Valid loglevels are: | |
25 | .sp | |
26 | \fB0\fP None | |
27 | .br | |
28 | \fB1\fP Error | |
29 | .br | |
30 | \fB2\fP Warnings | |
31 | .br | |
32 | \fB3\fP Informational | |
33 | .br | |
34 | \fB4\fP Debug | |
35 | .br | |
36 | \fB5\fP Spew | |
94236aa4 UH |
37 | .TP |
38 | .B "\-h, \-?, \-\-help" | |
39 | Show a help text and exit. | |
40 | .TP | |
41 | .B "\-V, \-\-version" | |
42 | Show version information and exit. | |
e3c79b07 | 43 | .TP |
2bc3626e GS |
44 | .BR "\-d, \-\-driver " <drivername> |
45 | Specify the capture device to connect to. If the | |
46 | .B \-\-driver | |
47 | option is not supplied, PulseView attempts to re-connect to the | |
48 | most recently used device, or auto-detect available devices. | |
49 | .TP | |
0e96068d | 50 | .BR "\-D, \-\-dont\-scan " |
ba0c5f89 GS |
51 | Usually PulseView automatically scans all drivers to find suitable |
52 | devices during program startup. This option disables the auto-scan. | |
53 | Users can either specify the | |
54 | .B \-\-driver | |
55 | option to pick a device at startup, or interactively scan for devices | |
56 | after PulseView has finished starting up. | |
57 | .TP | |
e3c79b07 JH |
58 | .BR "\-i, \-\-input\-file " <filename> |
59 | Load input from a file. If the | |
60 | .B \-\-input\-format | |
228a5480 | 61 | option is not supplied, PulseView attempts to load the file as a sigrok session |
e3c79b07 JH |
62 | file. |
63 | .TP | |
64 | .BR "\-I, \-\-input\-format " <format> | |
65 | Specifies the format of the input file to be loaded. | |
99d4a087 | 66 | .TP |
611c8625 DL |
67 | .BR "\-s, \-\-settings " <filename> |
68 | Load PulseView session setup to use with the input file. The setup file must be | |
69 | in the "PulseView session setup" format (.pvs). | |
70 | .TP | |
99d4a087 SA |
71 | .BR "\-c, \-\-clean" |
72 | Prevents the previously used sessions to be restored from settings storage. | |
73 | This is useful if you want only a single session with the file given on the | |
74 | command line instead of restoring all previously used sessions as well. | |
1022c445 UH |
75 | .SH "KEYBOARD SHORTCUTS" |
76 | .TP | |
77 | .B "f" | |
78 | Zoom-to-fit. | |
79 | .TP | |
1022c445 | 80 | .B "s" |
99d4a087 SA |
81 | Enable / disable sticky scrolling. When enabled, the right edge of the screen |
82 | always shows the most recently captured data. | |
1022c445 | 83 | .TP |
051ba3b3 UH |
84 | .B "." |
85 | Show / hide sampling points. | |
86 | .TP | |
8ad61f40 UH |
87 | .B "g" |
88 | Show / hide analog minor grid (in addition to the vdiv grid). | |
89 | .TP | |
1022c445 UH |
90 | .B "c" |
91 | Show / hide cursors. | |
92 | .TP | |
6b8b739d UH |
93 | .B "d" |
94 | Show / hide protocol decoder selector. | |
95 | .TP | |
c281fdc6 UH |
96 | .B "b" |
97 | Toggle between coloured trace backgrounds and alternating light/dark | |
98 | gray trace backgrounds. | |
99 | .TP | |
1022c445 UH |
100 | .B "SPACE" |
101 | Start / stop an acquisition. | |
102 | .TP | |
9c91ad7f UH |
103 | .B "Left/right arrow keys" |
104 | Scroll left/right. | |
105 | .TP | |
57dd6be4 UH |
106 | .B "+/-" |
107 | Zoom in/out. | |
108 | .TP | |
9c91ad7f UH |
109 | .B "Up/down arrow keys" |
110 | Zoom in/out. | |
111 | .TP | |
57dd6be4 UH |
112 | .B "Home/End" |
113 | Jump to the start/end of the sample data. | |
9c91ad7f | 114 | .TP |
57dd6be4 UH |
115 | .B "1/2" |
116 | Attach left/right side of the cursors to the mouse. | |
1022c445 UH |
117 | .TP |
118 | .B "CTRL+o" | |
119 | Open file. | |
120 | .TP | |
121 | .B "CTRL+s" | |
122 | Save as... | |
123 | .TP | |
124 | .B "CTRL+r" | |
125 | Save selected range as... | |
126 | .TP | |
127 | .B "CTRL+g" | |
128 | Group all currently selected traces into a trace group. | |
129 | .TP | |
130 | .B "CTRL+u" | |
131 | Ungroup the traces in the currently selected trace group. | |
132 | .TP | |
9c91ad7f UH |
133 | .B "CTRL+up/down arrow keys" |
134 | Scroll down/up. | |
135 | .TP | |
1022c445 | 136 | .B "CTRL+q" |
78e14473 UH |
137 | Quit, i.e. shutdown PulseView (closing all session tabs). |
138 | .TP | |
139 | .B "CTRL+w" | |
140 | Close the current session tab. | |
18a155ce SA |
141 | .TP |
142 | .B "SHIFT+mouse wheel" | |
143 | Scroll horizontally instead of zooming in/out. | |
94236aa4 UH |
144 | .SH "EXIT STATUS" |
145 | .B PulseView | |
146 | exits with 0 on success, 1 on most failures. | |
147 | .SH "SEE ALSO" | |
e65ff35e | 148 | \fBsigrok\-cli\fP(1) |
94236aa4 | 149 | .SH "BUGS" |
e65ff35e UH |
150 | Please report any bugs via Bugzilla |
151 | .RB "(" http://sigrok.org/bugzilla ")" | |
152 | or on the sigrok\-devel mailing list | |
94236aa4 UH |
153 | .RB "(" sigrok\-devel@lists.souceforge.net ")." |
154 | .SH "LICENSE" | |
155 | .B PulseView | |
0ec7aba5 | 156 | is covered by the GNU General Public License (GPL), version 3 or later. |
94236aa4 UH |
157 | .SH "AUTHORS" |
158 | Please see the individual source code files. | |
159 | .PP | |
160 | This manual page was written by Uwe Hermann <uwe@hermann\-uwe.de>. | |
161 | It is licensed under the terms of the GNU GPL (version 2 or later). |