[pulseview.git] / doc / pulseview.1

.TH PULSEVIEW 1 "June 6, 2017"
.SH "NAME"
PulseView \- Qt-based LA/scope/MSO GUI for sigrok
.SH "SYNOPSIS"
.B pulseview \fR[\fBOPTIONS\fR] [\fBFILE\fR]
.SH "DESCRIPTION"
.B PulseView
is a cross-platform Qt-based GUI for the
.B sigrok
software suite for test and measurement equipment such as logic analyzers,
oscilloscopes, MSOs, and more.
.SH "OPTIONS"
.B PulseView
has very few command line options, as most configuration elements are
available from the GUI itself.
.sp
If the optional \fBFILE\fR argument is supplied, PulseView tries to open
the specified file. It has to be in the "libsigrok session" format (.sr)
unless -I is used to specify the input file format.
.TP
.B "\-l, \-\-loglevel"
Set the libsigrok and libsigrokdecode loglevel. At the moment PulseView
doesn't support setting the two loglevels independently. The higher the
number, the more debug output will be printed. Valid loglevels are:
.sp
\fB0\fP   None
.br
\fB1\fP   Error
.br
\fB2\fP   Warnings
.br
\fB3\fP   Informational
.br
\fB4\fP   Debug
.br
\fB5\fP   Spew
.TP
.B "\-h, \-?, \-\-help"
Show a help text and exit.
.TP
.B "\-V, \-\-version"
Show version information and exit.
.TP
.BR "\-d, \-\-driver " <drivername>
Specify the capture device to connect to. If the
.B \-\-driver
option is not supplied, PulseView attempts to re-connect to the
most recently used device, or auto-detect available devices.
.TP
.BR "\-D, \-\-no\-scan "
Usually PulseView automatically scans all drivers to find suitable
devices during program startup. This option disables the auto-scan.
Users can either specify the
.B \-\-driver
option to pick a device at startup, or interactively scan for devices
after PulseView has finished starting up.
.TP
.BR "\-i, \-\-input\-file " <filename>
Load input from a file. If the
.B \-\-input\-format
option is not supplied, PulseView attempts to load the file as a sigrok session
file.
.TP
.BR "\-I, \-\-input\-format " <format>
Specifies the format of the input file to be loaded.
.TP
.BR "\-c, \-\-clean"
Prevents the previously used sessions to be restored from settings storage.
This is useful if you want only a single session with the file given on the
command line instead of restoring all previously used sessions as well.
.SH "KEYBOARD SHORTCUTS"
.TP
.B "f"
Zoom-to-fit.
.TP
.B "o"
Zoom 1:1.
.TP
.B "s"
Enable / disable sticky scrolling. When enabled, the right edge of the screen
always shows the most recently captured data.
.TP
.B "."
Show / hide sampling points.
.TP
.B "g"
Show / hide analog minor grid (in addition to the vdiv grid).
.TP
.B "c"
Show / hide cursors.
.TP
.B "b"
Toggle between coloured trace backgrounds and alternating light/dark
gray trace backgrounds.
.TP
.B "SPACE"
Start / stop an acquisition.
.TP
.B "Arrow keys"
Scroll up/down/left/right.
.TP
.B "CTRL+o"
Open file.
.TP
.B "CTRL+s"
Save as...
.TP
.B "CTRL+r"
Save selected range as...
.TP
.B "CTRL+g"
Group all currently selected traces into a trace group.
.TP
.B "CTRL+u"
Ungroup the traces in the currently selected trace group.
.TP
.B "CTRL++"
Zoom in.
.TP
.B "CTRL+-"
Zoom out.
.TP
.B "CTRL+q"
Quit, i.e. shutdown PulseView (closing all session tabs).
.TP
.B "CTRL+w"
Close the current session tab.
.SH "EXIT STATUS"
.B PulseView
exits with 0 on success, 1 on most failures.
.SH "SEE ALSO"
\fBsigrok\-cli\fP(1)
.SH "BUGS"
Please report any bugs via Bugzilla
.RB "(" http://sigrok.org/bugzilla ")"
or on the sigrok\-devel mailing list
.RB "(" sigrok\-devel@lists.souceforge.net ")."
.SH "LICENSE"
.B PulseView
is covered by the GNU General Public License (GPL), version 3 or later.
.SH "AUTHORS"
Please see the individual source code files.
.PP
This manual page was written by Uwe Hermann <uwe@hermann\-uwe.de>.
It is licensed under the terms of the GNU GPL (version 2 or later).
Commit	Line	Data
	1	.TH PULSEVIEW 1 "June 6, 2017"
	2	.SH "NAME"
	3	PulseView \- Qt-based LA/scope/MSO GUI for sigrok
	4	.SH "SYNOPSIS"
	5	.B pulseview \fR[\fBOPTIONS\fR] [\fBFILE\fR]
	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,
	11	oscilloscopes, MSOs, and more.
	12	.SH "OPTIONS"
	13	.B PulseView
	14	has very few command line options, as most configuration elements are
	15	available from the GUI itself.
	16	.sp
	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.
	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
	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.
	43	.TP
	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
	50	.BR "\-D, \-\-no\-scan "
	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
	58	.BR "\-i, \-\-input\-file " <filename>
	59	Load input from a file. If the
	60	.B \-\-input\-format
	61	option is not supplied, PulseView attempts to load the file as a sigrok session
	62	file.
	63	.TP
	64	.BR "\-I, \-\-input\-format " <format>
	65	Specifies the format of the input file to be loaded.
	66	.TP
	67	.BR "\-c, \-\-clean"
	68	Prevents the previously used sessions to be restored from settings storage.
	69	This is useful if you want only a single session with the file given on the
	70	command line instead of restoring all previously used sessions as well.
	71	.SH "KEYBOARD SHORTCUTS"
	72	.TP
	73	.B "f"
	74	Zoom-to-fit.
	75	.TP
	76	.B "o"
	77	Zoom 1:1.
	78	.TP
	79	.B "s"
	80	Enable / disable sticky scrolling. When enabled, the right edge of the screen
	81	always shows the most recently captured data.
	82	.TP
	83	.B "."
	84	Show / hide sampling points.
	85	.TP
	86	.B "g"
	87	Show / hide analog minor grid (in addition to the vdiv grid).
	88	.TP
	89	.B "c"
	90	Show / hide cursors.
	91	.TP
	92	.B "b"
	93	Toggle between coloured trace backgrounds and alternating light/dark
	94	gray trace backgrounds.
	95	.TP
	96	.B "SPACE"
	97	Start / stop an acquisition.
	98	.TP
	99	.B "Arrow keys"
	100	Scroll up/down/left/right.
	101	.TP
	102	.B "CTRL+o"
	103	Open file.
	104	.TP
	105	.B "CTRL+s"
	106	Save as...
	107	.TP
	108	.B "CTRL+r"
	109	Save selected range as...
	110	.TP
	111	.B "CTRL+g"
	112	Group all currently selected traces into a trace group.
	113	.TP
	114	.B "CTRL+u"
	115	Ungroup the traces in the currently selected trace group.
	116	.TP
	117	.B "CTRL++"
	118	Zoom in.
	119	.TP
	120	.B "CTRL+-"
	121	Zoom out.
	122	.TP
	123	.B "CTRL+q"
	124	Quit, i.e. shutdown PulseView (closing all session tabs).
	125	.TP
	126	.B "CTRL+w"
	127	Close the current session tab.
	128	.SH "EXIT STATUS"
	129	.B PulseView
	130	exits with 0 on success, 1 on most failures.
	131	.SH "SEE ALSO"
	132	\fBsigrok\-cli\fP(1)
	133	.SH "BUGS"
	134	Please report any bugs via Bugzilla
	135	.RB "(" http://sigrok.org/bugzilla ")"
	136	or on the sigrok\-devel mailing list
	137	.RB "(" sigrok\-devel@lists.souceforge.net ")."
	138	.SH "LICENSE"
	139	.B PulseView
	140	is covered by the GNU General Public License (GPL), version 3 or later.
	141	.SH "AUTHORS"
	142	Please see the individual source code files.
	143	.PP
	144	This manual page was written by Uwe Hermann <uwe@hermann\-uwe.de>.
	145	It is licensed under the terms of the GNU GPL (version 2 or later).