efdbaf1fd1f7047bba49e41ed6d30e733edf540b
[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}{June 29, 2015}
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 \usepackage{float}
52 \restylefloat{figure}
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
64 \usepackage[usenames,dvipsnames]{xcolor}
65 \usepackage{lscape}        % For landscape mode (Appendix B)
66 \usepackage{tikz}          % graphics (Appendix B)
67 \usetikzlibrary{shapes.geometric}
68 \usetikzlibrary{arrows,decorations.pathmorphing}
69 \usepackage{makeidx}       % For making an index
70 % hyperref must be the last package listed.
71 % The hyperref settings helps hypertext get links right in the 
72 % pdf of the index. 
73 % Also, allcolors lets us generate colored active links inside a pdf.
74 % And breaklinks resolves truncation issues with very long link names.
75 \usepackage[breaklinks,plainpages=false,pdfpagelabels,pagebackref,allcolors=blue,bookmarksnumbered=true]{hyperref} 
76 \makeindex  % This and the makeidx package allow \index to create index entries.
77
78 \newcommand{\dwf}{DWARF Debugging Information Format}
79
80 \newenvironment{myindentpara}[1]%
81   {\begin{list}{}%
82     {\setlength{\leftmargin}{#1}}%
83     \item[]%
84   }
85   {\end{list}}
86
87 % broken somehow.
88 %\newcommand{\myindent1}[1]{\begin{myindentpara}{1cm}#1\end{myindentpara}}
89
90 \hypersetup{colorlinks=true,
91   %bookmarks=true,
92   pdfauthor={\dwf\ Committee},
93   pdftitle={\dwf\ Version 5}
94 }
95
96 % An environment to create a listing-like (boxed) presentation for DWARF examples
97 % Use like \begin{lstlisting}...\end{lstlisting}. Does not do line numbers (boo)
98 % but does full LaTex processing within its scope (unlike \verb).
99 \newsavebox{\savedwf}
100 \newenvironment{dwflisting}{\begin{lrbox}{\savedwf}
101   \begin{minipage}{\textwidth}\footnotesize}
102   {\end{minipage}\end{lrbox}\fbox{\usebox{\savedwf}}}
103 % A helper to annotate the parts of a multipage figure
104 \newcommand{\figurepart}[2]{\raggedleft{\textit{\tiny{part #1 of #2}}}}
105
106 % Define a simple hyper-reference to a given URL
107 \newcommand{\hrefself}[1]{\href{#1}{#1}}
108
109 % Generate a page ref.
110 % use like   \refersec{chap:registervalues}
111 %\newcommand{\refersec}[1]{\ref{#1} on page \pageref{#1}}
112 \newcommand{\refersec}[1]{\vref{#1}}  % beware possible rerun loop
113 \newcommand{\referfol}[1]{\ref{#1} following}
114
115 % Generate a live link in the document
116 % use like \livelink{chap:DWOPdup}{DW\_OP\_dup}
117 \newcommand{\livelink}[2]{\hyperlink{#1}{#2}\index{#2}}
118 % use when the index is different from the text and target.
119 \newcommand{\livelinki}[3]{\hyperlink{#1}{#2}\index{#3}}
120 % livetarg is the declaration that is the target of livelinks.
121 \newcommand{\livetarg}[2]{\hypertarget{#1}{#2}\index{#2}}
122 % When we want the index entry to look different from the name.
123 \newcommand{\livetargi}[3]{\hypertarget{#1}{#2}\index{#3}}
124
125 \newcommand{\thirtytwobitdwarfformat}[1][]{\livelink{datarep:xxbitdwffmt}{32-bit DWARF format}}
126 \newcommand{\sixtyfourbitdwarfformat}[1][]{\livelink{datarep:xxbitdwffmt}{64-bit DWARF format}}
127
128 \newcommand{\dash}{\nobreakdash-\hspace{0pt}}  % So we handle dashes ok.
129
130 % The following two let us mark a word as 'do not link' or
131 % 'do not index' to indicate the word is used generically
132 % and has been considered so do not index or link it.
133 % There is no significant difference in the two commands, though
134 % \nolink would be more oriented to words such as flag or address
135 % that might be linked (and indexed) in some circumstances.
136 \newcommand{\nolink}[1]{#1}
137 \newcommand{\noindex}[1]{#1}
138
139 % For index entries. The tt-variant of each pair is designed to
140 % allow a word to appear in tt font in the main test and the index
141 % but to collate in the index in its non-tt order. (LaTex normally
142 % sorts all tt words before all non-tt words.)
143 \newcommand{\addtoindex}[1]{#1\index{#1}}
144 \newcommand{\addttindex}[1]{\texttt{#1}\index{#1@\texttt{#1}}}
145 \newcommand{\addtoindexi}[2]{#1\index{#2}}
146 \newcommand{\addttindexi}[2]{\texttt{#1}\index{#2@\texttt{#2}}}
147 \newcommand{\addtoindexx}[1]{\index{#1}}
148 \newcommand{\addttindexx}[1]{\index{#1@\texttt{#1}}}
149
150 % Quote commands that avoid need for inline UTF-8 in these sources
151 \newcommand{\doublequote}[1]{\textquotedblleft #1\textquotedblright}
152 \newcommand{\singlequote}[1]{\textquoteleft #1\textquoteright}
153
154 % Better naming for the lowest level section header
155 \newcommand{\subsubsubsection}[1]{\paragraph{#1}~\newline}
156 %\newcommand{\subsubsubsubsection}[1]{\subparagraph{#1}.~}  %% Huh?
157 \newcommand{\subsubsubsubsection}[1]{\textbf{#1}.~~}
158 %\newcommand{\subsubsubsection}         %% Has to be in a style file--ugh...
159 %   {\@startsection{subsubsubsection}{4}{0mm}{-\baselineskip}{\baselineskip}{\normalfont\normalsize\itshap}}
160
161 % Issue \clearpage if less than n lines remain on page
162 \newcommand{\needlines}[1]{\needspace{#1\baselineskip}}
163
164 % Helper for item lists with bold subject markers
165 \newcommand{\itembf}[1]{\item \textbf{#1}}
166 \newcommand{\itembfnl}[1]{\itembf{#1} \\}
167
168 % And description lists with normal (not bold) text
169 \renewcommand{\descriptionlabel}[1]{\hspace{\labelsep}\textnormal{#1}}
170 \newcommand{\descriptionlabelnl}[1]{\item[#1] \mbox{}\\}
171
172 \newcommand{\emptypage}{
173     \clearpage
174     \vspace*{4in}
175     \begin{center} \textit{(empty page)} \end{center}
176     }
177
178 % Define a new column type P that is just like p except
179 % that it uses ragged right (rather than right justification}
180 % within a column  of a tabular environment. (See Goossens,
181 % Mittelback&Samarin, "The LaTex Companion", pp108&114.)
182 \newcommand{\PBS}[1]{\let\temp=\\#1\let\\=\temp}
183 \newcolumntype{P}[1]{>{\PBS\raggedright\hspace{0pt}}p{#1}}
184
185 % A simple rule used in simple tables; default length is 2 inches
186 \newcommand{\simplerule}[1][2in]{\rule[4pt]{#1}{0.5pt}}
187
188 % A simple one column table of names; default width is 2 inches
189 \newcommand{\simplenametablerule}{\simplerule[2in]}
190 \newenvironment{simplenametable}[3][2in]
191     {   \begin{table}[here] \caption{#2} \label{#3}
192         \begin{center}
193         \renewcommand{\simplenametablerule}{\simplerule[#1]}
194         \simplenametablerule \\
195         \begin{tabular*}{#1}{l}
196         }
197     {   \end{tabular*}
198         \vspace{4pt} \\
199         \simplenametablerule \\
200         \end{center}
201         \end{table}
202         }
203
204 % Define commands for all of the DWARF names (DW\_*, .debug_*, a few others)
205 %
206 \newcommand{\definition}[1]{\textcolor{red!80!black}{#1}}
207 \include{dwarfnamecmds}
208
209 %--- Begin the document pages
210 %
211 \begin{document}
212 \frontmatter
213 \thispagestyle{empty}
214
215 \nonzeroparskip
216 \setlength{\parindent}{0pt} 
217 \setlength{\headheight}{6cm}
218 \setlength{\uppermargin}{6cm}
219 \setlength{\topsep}{0pt}
220 \tightlists                                     % less spacing before/after lists
221
222 \begin{center}
223 \LARGE
224 \textbf{\dwf}
225 \\
226 \textbf{Version 5}
227 \\
228 \vspace{1cm}
229 \includegraphics[keepaspectratio=true,scale=1.0]{dwarf-logo}
230 \\
231 \vspace{1cm}
232 \href{http://www.dwarfstd.org}{\dwf}
233 \href{http://www.dwarfstd.org}{Committee}
234 \\
235 \vspace{0.5cm} 
236 \url{http://www.dwarfstd.org}
237 \\
238 \vspace{2cm}
239 {\Large \textbf{\docdate}}
240 \\
241 \ifthenelse{\boolean{isdraft}}{
242         \vspace{2cm}
243         \draftmark}
244         {}
245 \end{center}
246
247 \textmd
248 \normalsize
249 \setlength{\headheight}{15pt}  
250 \pagestyle{plain}
251 %\makeevenhead{plain}{}{}{}
252 %\makeoddhead{plain}{}{}{}
253 %\makeevenfoot{plain}{}{}{}
254 %\makeoddfoot{plain}{}{}{}
255 \nonzeroparskip
256 \setlength{\parindent}{0pt} 
257 \settrims{0.5in}{0.5in}
258 \settypeblocksize{8.2in}{6.0in}
259 %\setlrmarginsandblock{0.6in}{0.6in}{*}
260 %\setheadfoot{15pt}{15pt}
261 %\setheaderspaces {*}{2\onelineskip}{*}
262 \nouppercaseheads
263 \makeevenhead{plain}{}{\rightmark}{}
264 \makeoddhead{plain}{}{\rightmark}{}
265 \makeevenfoot{plain}{\docdate}{\draftmark}{Page \thepage}
266 \makeoddfoot{plain}{\docdate}{\draftmark}{Page \thepage}
267
268 %\openany
269
270 \nonzeroparskip
271 \setlength{\parindent}{0pt} 
272 \flushleft
273 \include{copyright}
274 \include{foreword}
275
276 \newpage
277 ~ % Make the page non-empty...
278 \newpage
279 \tableofcontents
280
281 \clearpage
282 \listoffigures
283
284 \clearpage
285 \listoftables
286
287 \ifthenelse{\boolean{isdraft}}
288         {       %\emptypage
289                 {% Environment to keep the following header change local
290                 \clearpage
291                 \makeevenhead{plain}{}{Change Summary}{}
292                 \makeoddhead{plain}{}{Change Summary}{}
293                 \include{changesummary}
294                 %\emptypage
295                 }
296         }{}
297 %\cleardoublepage
298 \flushleft
299 \raggedbottom
300 \chapterstyle{default}
301
302 \setlength{\parindent}{0pt} 
303
304 \makepagestyle{fragFirstChPage}
305     \makeevenhead{fragFirstChPage}{}{}{}
306     \makeoddhead{fragFirstChPage}{}{}{}
307     \makeoddfoot{fragFirstChPage}{\docdate}{\draftmark}{Page \thepage}
308     \makeevenfoot{fragFirstChPage}{\docdate}{\draftmark}{Page \thepage}
309 \nouppercaseheads
310 \aliaspagestyle{chapter}{fragFirstChPage}
311
312 % ----- Start the main part of the document -----
313 \mainmatter
314 % Define the levels of sectionality that are numbered.
315 \setcounter{secnumdepth}{5}
316
317 \include{introduction}                  %\emptypage
318 \include{generaldescription}            %\emptypage
319 \include{programscope}                  \emptypage
320 \include{dataobject}                    %\emptypage
321 \include{typeentries}                   %\emptypage
322 \include{otherdebugginginformation}     \emptypage
323 \include{datarepresentation}            \emptypage
324
325 %  The \appendix command toggles us into appendix chapters
326 \appendix
327
328 \include{attributesbytag}               %\emptypage
329 \include{debugsectionrelationships}     \emptypage
330 \include{encodingdecoding}              \emptypage
331 \include{examples}                      %\emptypage
332 \include{compression}                   \emptypage
333 \include{splitobjects}                  %\emptypage
334 \include{sectionversionnumbers}         \emptypage
335 \include{gnulicense}                    \emptypage
336 %\include{selectedglossary}              %\emptypage
337 %\include{unitattributecomparison}
338
339 \printindex
340
341 \end{document}