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