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