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