Skip to content

Instantly share code, notes, and snippets.

@hansemro
Last active December 5, 2023 09:57
Show Gist options
  • Save hansemro/502dc8c768cc3a469d086c902a87e829 to your computer and use it in GitHub Desktop.
Save hansemro/502dc8c768cc3a469d086c902a87e829 to your computer and use it in GitHub Desktop.
[WIP] Man page for ngscopeclient
.TH NGSCOPECLIENT 1 "December 1, 2023" "scopehal-apps 0.0.252ddc2"
.SH NAME
ngscopeclient \- Advanced Test & Measurement remote control and analysis suite
.SH SYNOPSIS
.B ngscopeclient
[\fB\-\-quiet\fR]
[\fB\-\-verbose\fR]
[\fB\-\-debug\fR]
[\fB\-\-trace\fR \fIclass[::function]\fR]
[\fB\-l\fR \fIFILE\fR]
[\fB\-L\fR \fIFILE\fR]
.SH DESCRIPTION
.B ngscopeclient
is a GUI frontend for scopehal. The default logging verbosity level is "notice" (3).
.SH OPTIONS
.TP
\fB\-q\fR, \fB\-\-quiet\fR
Reduces the verbosity level by one.
Can be specified more than once to lower verbosity by several steps.
.TP
\fB\-\-verbose\fR
Sets the verbosity level to “verbose" (4).
.TP
\fB\-\-debug\fR
Sets the verbosity level to “debug" (5).
.TP
\fB\-\-trace\fR \fIclass[::function]\fR
Enables extra debug output from the class \fIclass\fR or the function \fIclass::function\fR.
Has no effect unless debug is also specified.
Can be specified more than once to trace multiple classes and functions.
.TP
\fB\-l\fR, \fB\-\-logfile\fR \fIFILE\fR
Writes a copy of all log messages to file with control escape sequences stripped.
.TP
\fB\-L\fR, \fB\-\-logfile\-lines\fR \fIFILE\fR
Same as \fI\-\-logfile\fR except line buffering is turned on.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment