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.
6 \newcommand{\docdate}{November 20, 2014}
10 \setboolean{isdraft}{true}
11 \newcommand{\draftmark}{\ifthenelse{\boolean{isdraft}}{*** DRAFT ***}{}}
13 \usepackage[T1]{fontenc}
16 \renewcommand{\ttdefault}{cmtt} % Use Computer Modern Typewriter instead of Courier
18 %\renewcommand{\ttdefault}{ascii}
19 %\renewcommand{\ttfamily}{\asciifamily}
20 %\usepackage{microtype}
21 %\DisableLigatures[f]{encoding=T1}
22 %\renewcommand{\familydefault}{phv} % font family helvetica
25 \usepackage{url} % For color in letters. Links instead?
26 \usepackage[usenames]{color} % For color in letters. Links instead?
27 \usepackage{ellipsis} % Provides ... as \dots
32 language={}, % choose the language of the code
33 basicstyle=\footnotesize\ttfamily, % the size of the fonts that are used for the code
34 numbers=none, % where to put the line-numbers
35 numberstyle=\footnotesize, % the size of the fonts that are used for the line-numbers
37 firstnumber=1, % first line number in each listing
38 stepnumber=5, % the step between two line-numbers. If it is 1 each line will be numbered
39 numbersep=10pt, % how far the line-numbers are from the code
40 backgroundcolor=\color{white}, % choose the background color. You must add \usepackage{color}
41 showspaces=false, % show spaces adding particular underscores
42 showstringspaces=false, % underline spaces within strings
43 showtabs=false, % show tabs within strings adding particular underscores
44 frame=single, % adds a frame around the code
45 tabsize=2, % sets default tabsize to 2 spaces
46 captionpos=b, % sets the caption-position to bottom
47 breaklines=true, % sets automatic line breaking
48 breakatwhitespace=false, % sets if automatic breaks should only happen at whitespace
49 escapeinside={\%*}{*)} % if you want to add a comment within your code
53 \usepackage{amsmath} % Provides \nobreakdash
54 \usepackage{graphicx} % For pictures
55 \usepackage{longtable} % For multipage tables
56 \usepackage{hhline} % Single column horizontal lines
57 \usepackage{varioref} % defines \vref
58 % \textregistered is the trademark symbol
59 \usepackage[headheight=16pt,paper=letterpaper]{geometry}
60 \setlength{\headheight}{15pt} % avoids warning from latex
61 \usepackage{needspace} % For assuring space remaining on a page
62 \usepackage{ifthen} % For conditional processing
63 \usepackage{changepage} % For odd/even page checks
65 \usepackage{tikz} % graphics (Appendix B)
66 \usetikzlibrary{shapes.geometric}
67 \usetikzlibrary{arrows}
68 \usepackage{makeidx} % For making an index
69 % hyperref must be the last package listed.
70 % The hyperref settings helps hypertext get links right in the
72 % Also, allcolors lets us generate colored active links inside a pdf.
73 % And breaklinks resolves truncation issues with very long link names.
74 \usepackage[breaklinks,plainpages=false,pdfpagelabels,pagebackref,allcolors=blue,bookmarksnumbered=true]{hyperref}
75 \makeindex % This and the makeidx package allow \index to create index entries.
77 \newcommand{\dwf}{DWARF Debugging Information Format}
79 \newenvironment{myindentpara}[1]%
81 {\setlength{\leftmargin}{#1}}%
87 %\newcommand{\myindent1}[1]{\begin{myindentpara}{1cm}#1\end{myindentpara}}
89 \hypersetup{colorlinks=true,
91 pdfauthor={\dwf\ Committee},
92 pdftitle={\dwf\ Version 5}
95 % An environment to create a listing-like (boxed) presentation for DWARF examples
96 % Use like \begin{lstlisting}...\end{lstlisting}. Does not do line numbers (boo)
97 % but does full LaTex processing within its scope (unlike \verb).
99 \newenvironment{dwflisting}{\begin{lrbox}{\savedwf}
100 \begin{minipage}{\textwidth}\footnotesize}
101 {\end{minipage}\end{lrbox}\fbox{\usebox{\savedwf}}}
102 % A helper to annotate the parts of a multipage figure
103 \newcommand{\figurepart}[2]{\raggedleft{\textit{\tiny{part #1 of #2}}}}
105 % Generate a page ref.
106 % use like \refersec{chap:registervalues}
107 %\newcommand{\refersec}[1]{\ref{#1} on page \pageref{#1}}
108 \newcommand{\refersec}[1]{\vref{#1}} % beware possible rerun loop
109 \newcommand{\referfol}[1]{\ref{#1} following}
111 % Generate a live link in the document
112 % use like \livelink{chap:DWOPdup}{DW\_OP\_dup}
113 \newcommand{\livelink}[2]{\hyperlink{#1}{#2}\index{#2}}
114 % use when the index is different from the text and target.
115 \newcommand{\livelinki}[3]{\hyperlink{#1}{#2}\index{#3}}
116 % livetarg is the declaration that is the target of livelinks.
117 % FIXME: we might want livetarg and livetargi #2 to be \textbf{#2}
118 \newcommand{\livetarg}[2]{\hypertarget{#1}{#2}\index{#2}}
119 % When we want the index entry to look different from the name.
120 \newcommand{\livetargi}[3]{\hypertarget{#1}{#2}\index{#3}}
122 \newcommand{\thirtytwobitdwarfformat}[1][]{\livelink{datarep:xxbitdwffmt}{32-bit DWARF format}}
123 \newcommand{\sixtyfourbitdwarfformat}[1][]{\livelink{datarep:xxbitdwffmt}{64-bit DWARF format}}
125 \newcommand{\dash}{\nobreakdash-\hspace{0pt}} % So we handle dashes ok.
127 % The following two let us mark a word as 'do not link' or
128 % 'do not index' to indicate the word is used generically
129 % and has been considered so do not index or link it.
130 % There is no significant difference in the two commands, though
131 % \nolink would be more oriented to words such as flag or address
132 % that might be linked (and indexed) in some circumstances.
133 \newcommand{\nolink}[1]{#1}
134 \newcommand{\noindex}[1]{#1}
136 % For index entries. The tt-variant of each pair is designed to
137 % allow a word to appear in tt font in the main test and the index
138 % but to collate in the index in its non-tt order. (LaTex normally
139 % sorts all tt words before all non-tt words.)
140 \newcommand{\addtoindex}[1]{#1\index{#1}}
141 \newcommand{\addttindex}[1]{\texttt{#1}\index{#1@\texttt{#1}}}
142 \newcommand{\addtoindexi}[2]{#1\index{#2}}
143 \newcommand{\addttindexi}[2]{\texttt{#1}\index{#2@\texttt{#2}}}
144 \newcommand{\addtoindexx}[1]{\index{#1}}
145 \newcommand{\addttindexx}[1]{\index{#1@\texttt{#1}}}
147 % Quote commands that avoid need for inline UTF-8 in these sources
148 \newcommand{\doublequote}[1]{\textquotedblleft #1\textquotedblright}
149 \newcommand{\singlequote}[1]{\textquoteleft #1\textquoteright}
151 % Better naming for the lowest level section header
152 \newcommand{\subsubsubsection}[1]{\paragraph{#1.}}
154 % Issue \clearpage if less than n lines remain on page
155 \newcommand{\needlines}[1]{\needspace{#1\baselineskip}}
157 % Helper for item lists with bold subject markers
158 \newcommand{\itembf}[1]{\item \textbf{#1}}
159 \newcommand{\itembfnl}[1]{\itembf{#1} \\}
161 % And description lists with normal (not bold) text
162 \renewcommand{\descriptionlabel}[1]{\hspace{\labelsep}\textnormal{#1}}
163 \newcommand{\descriptionlabelnl}[1]{\item[#1] \mbox{}\\}
165 \newcommand{\emptypage}{
168 \begin{center} \textit{(empty page)} \end{center}
171 % A simple rule used in simple tables; default length is 2 inches
172 \newcommand{\simplerule}[1][2in]{\rule[4pt]{#1}{0.5pt}}
174 % A simple one column table of names; default width is 2 inches
175 \newcommand{\simplenametablerule}{\simplerule[2in]}
176 \newenvironment{simplenametable}[3][2in]
177 { \begin{table}[here] \caption{#2} \label{#3}
179 \renewcommand{\simplenametablerule}{\simplerule[#1]}
180 \simplenametablerule \\
181 \begin{tabular*}{#1}{l}
185 \simplenametablerule \\
190 % Define commands for all of the DWARF names (DW\_*, .debug_*, a few others)
192 \include{dwarfnamecmds}
194 %--- Begin the document pages
198 \thispagestyle{empty}
201 \setlength{\parindent}{0pt}
202 \setlength{\headheight}{6cm}
203 \setlength{\uppermargin}{6cm}
204 \setlength{\topsep}{0pt}
205 \tightlists % less spacing before/after lists
214 \includegraphics[keepaspectratio=true,scale=1.0]{dwarf-logo}
217 \href{http://www.dwarfstd.org}{\dwf}
218 \href{http://www.dwarfstd.org}{Committee}
221 \url{http://www.dwarfstd.org}
226 \ifthenelse{\boolean{isdraft}}{
234 \setlength{\headheight}{15pt}
236 %\makeevenhead{plain}{}{}{}
237 %\makeoddhead{plain}{}{}{}
238 %\makeevenfoot{plain}{}{}{}
239 %\makeoddfoot{plain}{}{}{}
241 \setlength{\parindent}{0pt}
242 \settrims{0.5in}{0.5in}
243 \settypeblocksize{8.2in}{6.0in}
244 %\setlrmarginsandblock{0.6in}{0.6in}{*}
245 %\setheadfoot{15pt}{15pt}
246 %\setheaderspaces {*}{2\onelineskip}{*}
248 \makeevenhead{plain}{}{\rightmark}{}
249 \makeoddhead{plain}{}{\rightmark}{}
250 \makeevenfoot{plain}{\docdate}{\draftmark}{Page \thepage}
251 \makeoddfoot{plain}{\docdate}{\draftmark}{Page \thepage}
256 \setlength{\parindent}{0pt}
270 \ifthenelse{\boolean{isdraft}}
272 {% Environment to keep the following header change local
274 \makeevenhead{plain}{}{Change Summary}{}
275 \makeoddhead{plain}{}{Change Summary}{}
276 \include{changesummary}
283 \chapterstyle{default}
285 \setlength{\parindent}{0pt}
287 \makepagestyle{fragFirstChPage}
288 \makeevenhead{fragFirstChPage}{}{}{}
289 \makeoddhead{fragFirstChPage}{}{}{}
290 \makeoddfoot{fragFirstChPage}{\docdate}{\draftmark}{Page \thepage}
291 \makeevenfoot{fragFirstChPage}{\docdate}{\draftmark}{Page \thepage}
293 \aliaspagestyle{chapter}{fragFirstChPage}
295 % ----- Start the main part of the document -----
297 % Define the levels of sectionality that are numbered.
298 \setcounter{secnumdepth}{5}
300 \include{introduction} \emptypage
301 \include{generaldescription} %\emptypage
302 \include{programscope} %\emptypage
303 \include{dataobject} %\emptypage
304 \include{typeentries} %\emptypage
305 \include{otherdebugginginformation} \emptypage
306 \include{datarepresentation} \emptypage
308 % The \appendix toggles us into appendix chapters
311 \include{attributesbytag} \emptypage
312 \include{debugsectionrelationships} \emptypage
313 \include{encodingdecoding} \emptypage
314 \include{examples} %\emptypage
315 \include{compression} \emptypage
316 \include{splitobjects} %\emptypage
317 \include{sectionversionnumbers} \emptypage