Prepare for merge...
[dwarf-doc.git] / dwarf5 / latexdoc / dwarf5.tex
1 \documentclass[12pt,letterpaper,oneside]{memoir} 
2 % for debugging, add 'draft' (without quotes) to the [] document class list.
3 % If draft is in the document class list, pix are just suggested
4 % by an outline, the pic does not appear as a picture.
5 %
6 \newcommand{\docdate}{July 10, 2015}
7 %
8 \usepackage{ifthen}
9 \newcommand{\ifthen}[2]{\ifthenelse{#1}{#2}{}}
10 \newboolean{isdraft}\setboolean{isdraft}{true}
11 \newcommand{\draftmark}{\ifthenelse{\boolean{isdraft}}{*** DRAFT ***}{}}
12 \newboolean{Trial1ReUnits}\setboolean{Trial1ReUnits}{true}
13 \newboolean{Trial2ReGlossary}\setboolean{Trial2ReGlossary}{true}
14 %
15 \usepackage[T1]{fontenc}
16 \usepackage{palatino}
17 \usepackage{cmtt}
18 \renewcommand{\ttdefault}{cmtt} % Use Computer Modern Typewriter instead of Courier
19 %\usepackage{ascii}
20 %\renewcommand{\ttdefault}{ascii}
21 %\renewcommand{\ttfamily}{\asciifamily}
22 %\usepackage{microtype}
23 %\DisableLigatures[f]{encoding=T1}
24 %\renewcommand{\familydefault}{phv}  % font family helvetica
25 %
26
27 \usepackage{url}           % For color in letters. Links instead?
28 \usepackage[usenames]{color} % For color in letters. Links instead?
29 \usepackage{ellipsis}      % Provides ... as \dots
30 %\usepackage{color}
31 \usepackage{listings}
32 \usepackage{alltt}
33 \lstset{ %
34 language={},               % choose the language of the code
35 basicstyle=\footnotesize\ttfamily,  % the size of the fonts that are used for the code
36 numbers=none,              % where to put the line-numbers
37 numberstyle=\footnotesize, % the size of the fonts that are used for the line-numbers
38 numberfirstline=true,
39 firstnumber=1,             % first line number in each listing
40 stepnumber=5,              % the step between two line-numbers. If it is 1 each line will be numbered
41 numbersep=10pt,            % how far the line-numbers are from the code
42 backgroundcolor=\color{white}, % choose the background color. You must add \usepackage{color}
43 showspaces=false,          % show spaces adding particular underscores
44 showstringspaces=false,    % underline spaces within strings
45 showtabs=false,            % show tabs within strings adding particular underscores
46 frame=single,              % adds a frame around the code
47 tabsize=2,                 % sets default tabsize to 2 spaces
48 captionpos=b,              % sets the caption-position to bottom
49 breaklines=true,           % sets automatic line breaking
50 breakatwhitespace=false,   % sets if automatic breaks should only happen at whitespace
51 escapeinside={\%*}{*)}     % if you want to add a comment within your code
52 }
53 \usepackage{float}
54 \restylefloat{figure}
55 \usepackage{amsmath}       % Provides \nobreakdash
56 \usepackage{graphicx}      % For pictures
57 \usepackage{longtable}     % For multipage tables
58 \usepackage{hhline}        % Single column horizontal lines
59 \usepackage{varioref}      % defines \vref
60 % \textregistered is the trademark symbol
61 \usepackage[headheight=16pt,paper=letterpaper]{geometry}
62 \setlength{\headheight}{15pt}  % avoids warning from latex
63 \usepackage{needspace}     % For assuring space remaining on a page
64 \usepackage{ifthen}        % For conditional processing
65 \usepackage{changepage}    % For odd/even page checks
66 \usepackage[usenames,dvipsnames]{xcolor}
67 \usepackage{lscape}        % For landscape mode (Appendix B)
68 \usepackage{tikz}          % graphics (Appendix B)
69 \usetikzlibrary{shapes.geometric}
70 \usetikzlibrary{arrows,decorations.pathmorphing}
71 \usepackage{changebar}     % For change bars in margin
72 \usepackage{amssymb}       % For math symbols
73 \usepackage{makeidx}       % For making an index
74 % hyperref must be the last package listed.
75 % The hyperref settings helps hypertext get links right in the 
76 % pdf of the index. 
77 % Also, allcolors lets us generate colored active links inside a pdf.
78 % And breaklinks resolves truncation issues with very long link names.
79 \usepackage[breaklinks,plainpages=false,pdfpagelabels,pagebackref,allcolors=blue,bookmarksnumbered=true]{hyperref}
80 \makeindex  % This and the makeidx package allow \index to create index entries.
81
82 \newcommand{\dwf}{DWARF Debugging Information Format}
83
84 \newenvironment{myindentpara}[1]%
85   {\begin{list}{}%
86     {\setlength{\leftmargin}{#1}}%
87     \item[]%
88   }
89   {\end{list}}
90
91 % broken somehow.
92 %\newcommand{\myindent1}[1]{\begin{myindentpara}{1cm}#1\end{myindentpara}}
93
94 \hypersetup{colorlinks=true,
95   %bookmarks=true,
96   pdfauthor={\dwf\ Committee},
97   pdftitle={\dwf\ Version 5}
98 }
99
100 % An environment to create a listing-like (boxed) presentation for DWARF examples
101 % Use like \begin{lstlisting}...\end{lstlisting}. Does not do line numbers (boo)
102 % but does full LaTex processing within its scope (unlike \verb).
103 \newsavebox{\savedwf}
104 \newenvironment{dwflisting}{\begin{lrbox}{\savedwf}
105   \begin{minipage}{\textwidth}\footnotesize}
106   {\end{minipage}\end{lrbox}\fbox{\usebox{\savedwf}}}
107 % A helper to annotate the parts of a multipage figure
108 \newcommand{\figurepart}[2]{\raggedleft{\textit{\tiny{part #1 of #2}}}}
109
110 % Define a simple hyper-reference to a given URL
111 \newcommand{\hrefself}[1]{\href{#1}{#1}}
112
113 % Generate a page ref.
114 % use like   \refersec{chap:registervalues}
115 %\newcommand{\refersec}[1]{\ref{#1} on page \pageref{#1}}
116 \newcommand{\refersec}[1]{\vref{#1}}  % beware possible rerun loop
117 \newcommand{\referfol}[1]{\ref{#1} following}
118
119 % Generate a live link in the document
120 % use like \livelink{chap:DWOPdup}{DW\_OP\_dup}
121 \newcommand{\livelink}[2]{\hyperlink{#1}{#2}\index{#2}}
122 % use when the index is different from the text and target.
123 \newcommand{\livelinki}[3]{\hyperlink{#1}{#2}\index{#3}}
124 % livetarg is the declaration that is the target of livelinks.
125 \newcommand{\livetarg}[2]{\hypertarget{#1}{#2}\index{#2}}
126 % When we want the index entry to look different from the name.
127 \newcommand{\livetargi}[3]{\hypertarget{#1}{#2}\index{#3}}
128
129 \newcommand{\thirtytwobitdwarfformat}[1][]{\livelink{datarep:xxbitdwffmt}{32-bit DWARF format}}
130 \newcommand{\sixtyfourbitdwarfformat}[1][]{\livelink{datarep:xxbitdwffmt}{64-bit DWARF format}}
131
132 \newcommand{\dash}{\nobreakdash-\hspace{0pt}}  % So we handle dashes ok.
133
134 % The following two let us mark a word as 'do not link' or
135 % 'do not index' to indicate the word is used generically
136 % and has been considered so do not index or link it.
137 % There is no significant difference in the two commands, though
138 % \nolink would be more oriented to words such as flag or address
139 % that might be linked (and indexed) in some circumstances.
140 \newcommand{\nolink}[1]{#1}
141 \newcommand{\noindex}[1]{#1}
142
143 % For index entries. The tt-variant of each pair is designed to
144 % allow a word to appear in tt font in the main test and the index
145 % but to collate in the index in its non-tt order. (LaTex normally
146 % sorts all tt words before all non-tt words.)
147 \newcommand{\addtoindex}[1]{#1\index{#1}}
148 \newcommand{\addttindex}[1]{\texttt{#1}\index{#1@\texttt{#1}}}
149 \newcommand{\addtoindexi}[2]{#1\index{#2}}
150 \newcommand{\addttindexi}[2]{\texttt{#1}\index{#2@\texttt{#2}}}
151 \newcommand{\addtoindexx}[1]{\index{#1}}
152 \newcommand{\addttindexx}[1]{\index{#1@\texttt{#1}}}
153
154 % Quote commands that avoid need for inline UTF-8 in these sources
155 \newcommand{\doublequote}[1]{\textquotedblleft #1\textquotedblright}
156 \newcommand{\singlequote}[1]{\textquoteleft #1\textquoteright}
157
158 % Better naming for the lowest level section header
159 \newcommand{\subsubsubsection}[1]{\paragraph{#1}~\newline}
160 %\newcommand{\subsubsubsubsection}[1]{\subparagraph{#1}.~}  %% Huh?
161 \newcommand{\subsubsubsubsection}[1]{\textbf{#1}.~~}
162 %\newcommand{\subsubsubsection}         %% Has to be in a style file--ugh...
163 %   {\@startsection{subsubsubsection}{4}{0mm}{-\baselineskip}{\baselineskip}{\normalfont\normalsize\itshap}}
164
165 % Issue \clearpage if less than n lines remain on page
166 \newcommand{\needlines}[1]{\needspace{#1\baselineskip}}
167
168 % Helper for item lists with bold subject markers
169 \newcommand{\itembf}[1]{\item \textbf{#1}}
170 \newcommand{\itembfnl}[1]{\itembf{#1} \\}
171
172 % And description lists with normal (not bold) text
173 \renewcommand{\descriptionlabel}[1]{\hspace{\labelsep}\textnormal{#1}}
174 \newcommand{\descriptionlabelnl}[1]{\item[#1] \mbox{}\\}
175
176 \newcommand{\emptypage}{
177     \clearpage
178     \vspace*{4in}
179     \begin{center} \textit{(empty page)} \end{center}
180     }
181
182 % Define a new column type P that is just like p except
183 % that it uses ragged right (rather than right justification}
184 % within a column  of a tabular environment. (See Goossens,
185 % Mittelback&Samarin, "The LaTex Companion", pp108&114.)
186 \newcommand{\PBS}[1]{\let\temp=\\#1\let\\=\temp}
187 \newcolumntype{P}[1]{>{\PBS\raggedright\hspace{0pt}}p{#1}}
188
189 % A simple rule used in simple tables; default length is 2 inches
190 \newcommand{\simplerule}[1][2in]{\rule[4pt]{#1}{0.5pt}}
191
192 % A simple one column table of names; default width is 2 inches
193 \newcommand{\simplenametablerule}{\simplerule[2in]}
194 \newenvironment{simplenametable}[3][2in]
195     {   \begin{table}[here] \caption{#2} \label{#3}
196         \begin{center}
197         \renewcommand{\simplenametablerule}{\simplerule[#1]}
198         \simplenametablerule \\
199         \begin{tabular*}{#1}{l}
200         }
201     {   \end{tabular*}
202         \vspace{4pt} \\
203         \simplenametablerule \\
204         \end{center}
205         \end{table}
206         }
207
208 % Complement of \isundefined
209 \newcommand{\isdefined}[1]{\not{\isundefined{#1}}}
210
211 % Preferred changebar asliases
212 \newcommand{\bb}{\cbstart}      % Begin bar
213 \newcommand{\eb}{\cbend}        % End bar
214
215 % Define commands for all of the DWARF names (DW\_*, .debug_*, a few others)
216 %
217 \newcommand{\definition}[1]{\textcolor{red!80!black}{#1}}
218 \include{dwarfnamecmds}
219
220 %--- Begin the document pages
221 %
222 \begin{document}
223 \frontmatter
224 \thispagestyle{empty}
225
226 \nonzeroparskip
227 \setlength{\parindent}{0pt} 
228 \setlength{\headheight}{6cm}
229 \setlength{\uppermargin}{6cm}
230 \setlength{\topsep}{0pt}
231 \tightlists                                     % less spacing before/after lists
232
233 \begin{center}
234 \LARGE
235 \textbf{\dwf}
236 \\
237 \textbf{Version 5}
238 \\
239 \vspace{1cm}
240 \includegraphics[keepaspectratio=true,scale=1.0]{dwarf-logo}
241 \\
242 \vspace{1cm}
243 \href{http://www.dwarfstd.org}{\dwf}
244 \href{http://www.dwarfstd.org}{Committee}
245 \\
246 \vspace{0.5cm} 
247 \url{http://www.dwarfstd.org}
248 \\
249 \vspace{2cm}
250 {\Large \textbf{\docdate}}
251 \\
252 \ifthenelse{\boolean{isdraft}}{
253         \vspace{2cm}
254         \draftmark}
255         {}
256 \end{center}
257
258 \textmd
259 \normalsize
260 \setlength{\headheight}{15pt}  
261 \pagestyle{plain}
262 %\makeevenhead{plain}{}{}{}
263 %\makeoddhead{plain}{}{}{}
264 %\makeevenfoot{plain}{}{}{}
265 %\makeoddfoot{plain}{}{}{}
266 \nonzeroparskip
267 \setlength{\parindent}{0pt} 
268 \settrims{0.5in}{0.5in}
269 \settypeblocksize{8.2in}{6.0in}
270 %\setlrmarginsandblock{0.6in}{0.6in}{*}
271 %\setheadfoot{15pt}{15pt}
272 %\setheaderspaces {*}{2\onelineskip}{*}
273 \nouppercaseheads
274 \makeevenhead{plain}{}{\rightmark}{}
275 \makeoddhead{plain}{}{\rightmark}{}
276 \makeevenfoot{plain}{\docdate}{\draftmark}{Page \thepage}
277 \makeoddfoot{plain}{\docdate}{\draftmark}{Page \thepage}
278
279 %\openany
280
281 \nonzeroparskip
282 \setlength{\parindent}{0pt} 
283 \flushleft
284 \include{copyright}
285 \include{foreword}
286
287 \newpage
288 ~ % Make the page non-empty...
289 \newpage
290 \tableofcontents
291
292 \clearpage
293 \listoffigures
294
295 \clearpage
296 \listoftables
297
298 \ifthenelse{\boolean{isdraft}}
299         {       %\emptypage
300                 {% Environment to keep the following header change local
301                 \clearpage
302                 \makeevenhead{plain}{}{Change Summary}{}
303                 \makeoddhead{plain}{}{Change Summary}{}
304                 \include{changesummary}
305                 %\emptypage
306                 }
307         }{}
308 %\cleardoublepage
309 \flushleft
310 \raggedbottom
311 \chapterstyle{default}
312
313 \setlength{\parindent}{0pt} 
314
315 \makepagestyle{fragFirstChPage}
316     \makeevenhead{fragFirstChPage}{}{}{}
317     \makeoddhead{fragFirstChPage}{}{}{}
318     \makeoddfoot{fragFirstChPage}{\docdate}{\draftmark}{Page \thepage}
319     \makeevenfoot{fragFirstChPage}{\docdate}{\draftmark}{Page \thepage}
320 \nouppercaseheads
321 \aliaspagestyle{chapter}{fragFirstChPage}
322
323 % ----- Start the main part of the document -----
324 \mainmatter
325 % Define the levels of sectionality that are numbered.
326 \setcounter{secnumdepth}{5}
327
328 \include{introduction}                  %\emptypage
329 \include{generaldescription}            %\emptypage
330 \include{programscope}                  \emptypage
331 \include{dataobject}                    %\emptypage
332 \include{typeentries}                   %\emptypage
333 \include{otherdebugginginformation}     \emptypage
334 \include{datarepresentation}            \emptypage
335
336 %  The \appendix command toggles us into appendix chapters
337 \appendix
338
339 \include{attributesbytag}               %\emptypage
340 \include{debugsectionrelationships}     \emptypage
341 \include{encodingdecoding}              \emptypage
342 \include{examples}                      %\emptypage
343 \include{compression}                   \emptypage
344 \include{splitobjects}                  %\emptypage
345 \include{sectionversionnumbers}         \emptypage
346 \include{gnulicense}                    \emptypage
347 \ifthenelse{\boolean{Trial2ReGlossary}}
348     {
349     \include{selectedglossary}          %\emptypage
350     \clearpage
351     \include{unitattributecomparison}   %\emptypage
352     }{}
353
354 \printindex
355
356 \end{document}