scopehal-docs/ngscopeclient-manual.tex at master · ngscopeclient/scopehal-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
\documentclass[11pt,letterpaper]{book}
\usepackage[T1]{fontenc}
\usepackage[margin=1in,top=0.6in,bottom=0.6in]{geometry}
\usepackage[bookmarks,colorlinks=true,linkcolor=blue,urlcolor=blue]{hyperref}
\usepackage{url}
\usepackage{tabularx}
\usepackage{graphicx}
\usepackage{placeins}
\usepackage{paralist}
\usepackage{makecell}
\usepackage{colortbl}
\usepackage{zi4}
\usepackage{float}
\usepackage{textcomp}
\usepackage{tocloft}
\usepackage{gensymb}
\usepackage{verbatim}
\usepackage[libertine,cmbraces]{newtxmath}
\usepackage{booktabs}

\setlength{\parskip}{2mm}

% configuration of source code examples
\usepackage{listings}
\lstset{language=c++}
\lstset{numbers=left}
\lstset{xleftmargin=2em}
\lstset{framexleftmargin=2em}
\lstset{belowskip=0em}
\lstset{belowcaptionskip=0em}
\lstset{tabsize=4}
\lstset{frame=single}
\lstset{breaklines=true}
\lstset{showspaces=false}
\lstset{showstringspaces=false}
\lstset{showtabs=false}
\lstset{breakatwhitespace=false}
\lstset{basicstyle=\small\ttfamily}
\lstset{columns=fullflexible}
\lstset{prebreak=\textbackslash}
\lstset{breakindent=0em}
\lstset{keepspaces=true}
\lstset{literate=+{{+\penalty10000}}2}
\lstset{literate=-{{-\penalty10000}}2}
\lstset{literate=\_{{\_\penalty10000}}2}
\lstset{literate=/{{/\penalty10000}}2}


% standard colors for protocol decodes
\usepackage{xcolor}
\definecolor{control}{HTML}{c000a0}
\definecolor{data}{HTML}{336699}
\definecolor{address}{HTML}{ffff00}
\definecolor{preamble}{HTML}{808080}
\definecolor{checksumok}{HTML}{00ff00}
\definecolor{checksumbad}{HTML}{ff0000}
\definecolor{error}{HTML}{ff0000}
\definecolor{idle}{HTML}{404040}

\definecolor{protocmd}{HTML}{600050}
\definecolor{protoctl}{HTML}{808000}
\definecolor{protoread}{HTML}{336699}
\definecolor{protowrite}{HTML}{339966}
\definecolor{protoerror}{HTML}{800000}
\definecolor{protostatus}{HTML}{000080}

% table lines
\setlength{\heavyrulewidth}{0.12em}
\setlength{\lightrulewidth}{0.04em}
\newcommand{\thickhline}{\toprule[\heavyrulewidth]}
\newcommand{\thinhline}{\midrule[\lightrulewidth]}

% fonts for formatting commands
\newcommand{\menustyle}[1]{\texttt{#1}}
\newcommand{\codestyle}[1]{\texttt{#1}}

% table of contents configuration
\setcounter{tocdepth}{2}
\setlength{\cftsecnumwidth}{1.5cm}
\setlength{\cftsubsecnumwidth}{1.5cm}

% urls to issue trackers
\newcommand{\issue}[2]{\href{https://github.com/ngscopeclient/#1/issues/#2}{#1:#2}}

% helper for largeish images
\usepackage{ifpdf}
\ifpdf
	\newcommand{\bigimage}[1]{\includegraphics[width=16cm]{#1}}
\else
	\newcommand{\bigimage}[1]{\includegraphics[width=1024px]{#1}}
\fi

\begin{document}

\title{ngscopeclient Operator Manual}
\author{Andrew D. Zonenberg}
\include{ngscopeclient-version}

\maketitle

\include{section-copyright}
\frontmatter

\mainmatter
\tableofcontents

\raggedbottom

\include{section-intro}
\include{section-legal}
\include{section-gettingstarted}
\include{section-tutorials}
\include{section-mainwindow}
\include{section-dialogs}
\include{section-workspaces}
\include{section-waveformgroups}
\include{section-waveformviews}
\include{section-history}
\include{section-streambrowser}
\include{section-grapheditor}
\include{section-transports}
\include{section-bert-drivers}
\include{section-funcgen-drivers}
\include{section-load-drivers}
\include{section-meter-drivers}
\include{section-misc-drivers}
\include{section-scope-drivers}
\include{section-sdr-drivers}
\include{section-spectrometer-drivers}
\include{section-powersupply-drivers}
\include{section-rfgen-drivers}
\include{section-vna-drivers}
\include{section-triggers}
\include{section-decodes}

%\FloatBarrier
%\include{section-timeline}
%\include{section-protoanalyzer}
%\include{section-exports}
%\include{section-internals}

\end{document}