63196e240535e2f4f7f4d2531f248e788f7e58ad
[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}{April 17, 2014}
7 %
8 \usepackage{ifthen}
9 \newboolean{isdraft}
10 \setboolean{isdraft}{true}
11 \newcommand{\draftmark}{\ifthenelse{\boolean{isdraft}}{*** DRAFT ***}{}}
12 %
13 \usepackage[T1]{fontenc}
14 \usepackage{palatino}
15 \usepackage{cmtt}
16 \renewcommand{\ttdefault}{cmtt} % Use Computer Modern Typewriter instead of Courier
17 %\usepackage{ascii}
18 %\renewcommand{\ttdefault}{ascii}
19 %\renewcommand{\ttfamily}{\asciifamily}
20 %\usepackage{microtype}
21 %\DisableLigatures[f]{encoding=T1}
22 %\renewcommand{\familydefault}{phv}  % font family helvetica
23 %
24
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
28 %\usepackage{color}
29 \usepackage{listings}
30 \usepackage{alltt}
31 \lstset{ %
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
36 numberfirstline=true,
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
50 }
51
52 \usepackage{amsmath}       % Provides \nobreakdash
53 \usepackage{graphicx}      % For pictures
54 \usepackage{longtable}     % For multipage tables
55 \usepackage{varioref}      % defines \vref
56 % \textregistered is the trademark symbol
57 \usepackage[headheight=16pt,paper=letterpaper]{geometry}
58 \setlength{\headheight}{15pt}  % avoids warning from latex
59 \usepackage{needspace}     % For assuring space remaining on a page
60 \usepackage{ifthen}        % For conditional processing
61 \usepackage{changepage}    % For odd/even page checks
62 \usepackage{tikz}                  % graphics (Appendix B)
63 \usetikzlibrary{shapes.geometric}
64 \usetikzlibrary{arrows}
65 \usepackage{makeidx}       % For making an index
66 % hyperref must be the last package listed.
67 % The hyperref settings helps hypertext get links right in the 
68 % pdf of the index. 
69 % Also, allcolors lets us generate colored active links inside a pdf.
70 % And breaklinks resolves truncation issues with very long link names.
71 \usepackage[breaklinks,plainpages=false,pdfpagelabels,pagebackref,allcolors=blue]{hyperref} 
72 \makeindex  % This and the makeidx package allow \index to create index entries.
73
74 \newcommand{\dwf}{DWARF Debugging Information Format}
75
76 \newenvironment{myindentpara}[1]%
77   {\begin{list}{}%
78     {\setlength{\leftmargin}{#1}}%
79     \item[]%
80   }
81   {\end{list}}
82
83 % broken somehow.
84 %\newcommand{\myindent1}[1]{\begin{myindentpara}{1cm}#1\end{myindentpara}}
85
86 \hypersetup{colorlinks=true,
87   %bookmarks=true,
88   pdfauthor={\dwf\ Committee},
89   pdftitle={\dwf\ Version 5}
90 }
91
92 % An environment to create a listing-like (boxed) presentation for DWARF examples
93 % Use like \begin{lstlisting}...\end{lstlisting}. Does not do line numbers (boo)
94 % but does full LaTex processing within its scope (unlike \verb).
95 \newsavebox{\savedwf}
96 \newenvironment{dwflisting}{\begin{lrbox}{\savedwf}
97   \begin{minipage}{\textwidth}\footnotesize}
98   {\end{minipage}\end{lrbox}\fbox{\usebox{\savedwf}}}
99 % A helper to annotate the parts of a multipage figure
100 \newcommand{\figurepart}[2]{\raggedleft{\textit{\tiny{part #1 of #2}}}}
101
102 % Generate a page ref.
103 % use like   \refersec{chap:registerbasedaddressing}
104 %\newcommand{\refersec}[1]{\ref{#1} on page \pageref{#1}}
105 \newcommand{\refersec}[1]{\vref{#1}}  % beware possible rerun loop
106 \newcommand{\referfol}[1]{\ref{#1} following}
107
108 % Generate a live link in the document
109 % use like \livelink{chap:DWOPdup}{DW\_OP\_dup}
110 \newcommand{\livelink}[2]{\hyperlink{#1}{#2}\index{#2}}
111 % use when the index is different from the text and target.
112 \newcommand{\livelinki}[3]{\hyperlink{#1}{#2}\index{#3}}
113 % livetarg is the declaration that is the target of livelinks.
114 % FIXME: we might want livetarg and livetargi  #2 to be \textbf{#2}
115 \newcommand{\livetarg}[2]{\hypertarget{#1}{#2}\index{#2}}
116 % When we want the index entry to look different from the name.
117 \newcommand{\livetargi}[3]{\hypertarget{#1}{#2}\index{#3}}
118
119 \newcommand{\thirtytwobitdwarfformat}[1][]{\livelink{datarep:xxbitdwffmt}{32-bit DWARF format}}
120 \newcommand{\sixtyfourbitdwarfformat}[1][]{\livelink{datarep:xxbitdwffmt}{64-bit DWARF format}}
121
122 \newcommand{\dash}{\nobreakdash-\hspace{0pt}}  % So we handle dashes ok.
123
124 % The following two let us mark a word as 'do not link' or
125 % 'do not index' to indicate the word is used generically
126 % and has been considered so do not index or link it.
127 % There is no significant difference in the two commands, though
128 % \nolink would be more oriented to words such as flag or address
129 % that might be linked (and indexed) in some circumstances.
130 \newcommand{\nolink}[1]{#1}
131 \newcommand{\noindex}[1]{#1}
132
133 % For index entries. The tt-variant of each pair is designed to
134 % allow a word to appear in tt font in the main test and the index
135 % but to collate in the index in its non-tt order. (LaTex normally
136 % sorts all tt words before all non-tt words.)
137 \newcommand{\addtoindex}[1]{#1\index{#1}}
138 \newcommand{\addttindex}[1]{\texttt{#1}\index{#1@\texttt{#1}}}
139 \newcommand{\addtoindexi}[2]{#1\index{#2}}
140 \newcommand{\addttindexi}[2]{\texttt{#1}\index{#2@\texttt{#2}}}
141 \newcommand{\addtoindexx}[1]{\index{#1}}
142 \newcommand{\addttindexx}[1]{\index{#1@\texttt{#1}}}
143
144 % Quote commands that avoid need for inline UTF-8 in these sources
145 \newcommand{\doublequote}[1]{\textquotedblleft #1\textquotedblright}
146 \newcommand{\singlequote}[1]{\textquoteleft #1\textquoteright}
147
148 % Better naming for the lowest level section header
149 \newcommand{\subsubsubsection}[1]{\paragraph{#1.}}
150
151 % Issue \clearpage if less than n lines remain on page
152 \newcommand{\needlines}[1]{\needspace{#1\baselineskip}}
153
154 % Helper for item lists with bold subject markers
155 \newcommand{\itembf}[1]{\item \textbf{#1}}
156 \newcommand{\itembfnl}[1]{\itembf{#1} \\}
157
158 % And description lists with normal (not bold) text
159 \renewcommand{\descriptionlabel}[1]{\hspace{\labelsep}\textnormal{#1}}
160 \newcommand{\descriptionlabelnl}[1]{\item[#1] \mbox{}\\}
161
162 \newcommand{\emptypage}{
163     \clearpage
164     \vspace*{4in}
165     \begin{center} \textit{(empty page)} \end{center}
166     }
167
168 % A simple rule used in simple tables; default length is 2 inches
169 \newcommand{\simplerule}[1][2in]{\rule[4pt]{#1}{0.5pt}}
170
171 % A simple one column table of names; default width is 2 inches
172 \newcommand{\simplenametablerule}{\simplerule[2in]}
173 \newenvironment{simplenametable}[3][2in]
174     {   \begin{table}[here] \caption{#2} \label{#3}
175         \begin{center}
176         \renewcommand{\simplenametablerule}{\simplerule[#1]}
177         \simplenametablerule \\
178         \begin{tabular*}{#1}{l}
179         }
180     {   \end{tabular*}
181         \vspace{4pt} \\
182         \simplenametablerule \\
183         \end{center}
184         \end{table}
185         }
186
187 % Anti-ligature commands added because \/ and {} don't work for unknown reasons
188 % nor does the microtext package DisableLigatures command...???
189 %
190 \newcommand{\xiiif}                             {0x3\hspace{1pt}f}
191 \newcommand{\xiiifff}                   {0x3\hspace{1pt}f\hspace{2pt}f\hspace{2pt}f}
192 \newcommand{\xff}                               {0x\hspace{1pt}f\hspace{2pt}f}
193 \newcommand{\xffff}                             {0x\hspace{1pt}f\hspace{2pt}f\hspace{2pt}f\hspace{2pt}f}
194 %
195 % These are intended for use in running text...
196 %
197 \newcommand{\xffffffff}                 {\texttt{0xffffffff}}                   % use with following punctutation
198 \newcommand{\wffffffff}                 {\texttt{0xffffffff}\ }                 % use as separate "word"
199 \newcommand{\xfffffffzero}              {\texttt{0xfffffff0}}                   % use with following punctutation
200 \newcommand{\wfffffffzero}              {\texttt{0xfffffff0}\ }
201 \newcommand{\xffffffffffffffff} {\texttt{0xffffffffffffffff}}   % use with following punctutation
202 \newcommand{\wffffffffffffffff} {\texttt{0xffffffffffffffff}\ }
203
204 % Define commands for all of the DWARF names (DW\_*, .debug_*, a few others)
205 \include{dwarfnamecmds}
206
207 %--- Begin the document pages
208 %
209 \begin{document}
210 \frontmatter
211 \thispagestyle{empty}
212
213 \nonzeroparskip
214 \setlength{\parindent}{0pt} 
215 \setlength{\headheight}{6cm}
216 \setlength{\uppermargin}{6cm}
217 \setlength{\topsep}{0pt}
218 \tightlists                                     % less spacing before/after lists
219
220 \begin{center}
221 \LARGE
222 \textbf{\dwf}
223 \\
224 \textbf{Version 5}
225 \\
226 \vspace{1cm}
227 \includegraphics[keepaspectratio=true,scale=1.0]{dwarf-logo}
228 \\
229 \vspace{1cm}
230 \href{http://www.dwarfstd.org}{\dwf}
231 \href{http://www.dwarfstd.org}{Committee}
232 \\
233 \vspace{0.3cm} 
234 \url{http://www.dwarfstd.org}
235 \\
236 \vspace{3cm}
237 \textbf{\docdate}
238 \\
239 \ifthenelse{\boolean{isdraft}}{
240         \vspace{1cm}
241         \draftmark}
242         {}
243 \end{center}
244
245 \textmd
246 \normalsize
247 \setlength{\headheight}{15pt}  
248 \pagestyle{plain}
249 %\makeevenhead{plain}{}{}{}
250 %\makeoddhead{plain}{}{}{}
251 %\makeevenfoot{plain}{}{}{}
252 %\makeoddfoot{plain}{}{}{}
253 \nonzeroparskip
254 \setlength{\parindent}{0pt} 
255 \settrims{0.5in}{0.5in}
256 \settypeblocksize{8.2in}{6.0in}
257 %\setlrmarginsandblock{0.6in}{0.6in}{*}
258 %\setheadfoot{15pt}{15pt}
259 %\setheaderspaces {*}{2\onelineskip}{*}
260 \nouppercaseheads
261 \makeevenhead{plain}{}{\rightmark}{}
262 \makeoddhead{plain}{}{\rightmark}{}
263 \makeevenfoot{plain}{\docdate}{\draftmark}{Page \thepage}
264 \makeoddfoot{plain}{\docdate}{\draftmark}{Page \thepage}
265
266 %\openany
267
268 \nonzeroparskip
269 \setlength{\parindent}{0pt} 
270 \flushleft
271 \include{copyright}
272 \include{foreword}
273
274 \newpage
275 \tableofcontents
276
277 \cleardoublepage
278 \listoffigures
279
280 \cleardoublepage
281 \listoftables
282
283 \ifthenelse{\boolean{isdraft}}
284         {       %\emptypage
285                 {% Environment to keep the following header change local
286                 \clearpage
287                 \makeevenhead{plain}{}{Change Summary}{}
288                 \makeoddhead{plain}{}{Change Summary}{}
289                 \include{changesummary}
290                 }
291         }{}
292 \cleardoublepage
293 \flushleft
294 \raggedbottom
295 \chapterstyle{default}
296
297 \setlength{\parindent}{0pt} 
298
299 \makepagestyle{fragFirstChPage}
300     \makeevenhead{fragFirstChPage}{}{}{}
301     \makeoddhead{fragFirstChPage}{}{}{}
302     \makeoddfoot{fragFirstChPage}{\docdate}{\draftmark}{Page \thepage}
303     \makeevenfoot{fragFirstChPage}{\docdate}{\draftmark}{Page \thepage}
304 \nouppercaseheads
305 \aliaspagestyle{chapter}{fragFirstChPage}
306
307 % ----- Start the main part of the document -----
308 \mainmatter
309 % Define the levels of sectionality that are numbered.
310 \setcounter{secnumdepth}{5}
311
312 \include{introduction}
313 \include{generaldescription}            \emptypage
314 \include{programscope}                  %\emptypage
315 \include{dataobject}                    \emptypage
316 \include{typeentries}                   %\emptypage
317 \include{otherdebugginginformation}     \emptypage
318 \include{datarepresentation}            \emptypage
319
320 %  The \appendix toggles us into appendix chapters
321 \appendix
322
323 \include{attributesbytag}                               \emptypage
324 \include{debugsectionrelationships}     \emptypage
325 \include{encodingdecoding}              %\emptypage
326 \include{examples}                      %\emptypage
327 \include{compression}                   %\emptypage
328 \include{splitobjects}                                  %\emptypage
329 \include{sectionversionnumbers}
330 \include{gnulicense}
331
332 \printindex
333
334 \end{document}