This completes (many!) changes resulting from reviews over the
[dwarf-doc.git] / dwarf5 / latexdoc / dwarf5.tex
index 6544b90..6a4f884 100644 (file)
@@ -1,10 +1,22 @@
-\documentclass[12pt,letterpaper,twoside]{memoir} 
+\documentclass[12pt,letterpaper,oneside]{memoir} 
 % for debugging, add 'draft' (without quotes) to the [] document class list.
 % If draft is in the document class list, pix are just suggested
 % by an outline, the pic does not appear as a picture.
 %
-\newcommand{\docdate}{19 April 2013 (***Draft***)}
+\newcommand{\docdate}{May 9, 2013 \hspace{1cm}(***\textbf{DRAFT}***)}
 %
+\usepackage[T1]{fontenc}
+\usepackage{palatino}
+\usepackage{cmtt}
+\renewcommand{\ttdefault}{cmtt}        % Use Computer Modern Typewriter instead of Courier
+%\usepackage{ascii}
+%\renewcommand{\ttdefault}{ascii}
+%\renewcommand{\ttfamily}{\asciifamily}
+%\usepackage{microtype}
+%\DisableLigatures[f]{encoding=T1}
+%\renewcommand{\familydefault}{phv}  % font family helvetica
+%
+
 \usepackage{url}                  % For color in letters. Links instead?
 \usepackage[usenames]{color} % For color in letters. Links instead?
 \usepackage{ellipsis}     % Provides ... as \dots
@@ -13,8 +25,8 @@
 \usepackage{alltt}
 \lstset{ %
 language={},               % choose the language of the code
-basicstyle=\footnotesize,  % the size of the fonts that are used for the code
-numbers=left,              % where to put the line-numbers
+basicstyle=\footnotesize\ttfamily,  % the size of the fonts that are used for the code
+numbers=none,              % where to put the line-numbers
 numberstyle=\footnotesize, % the size of the fonts that are used for the line-numbers
 numberfirstline=true,
 firstnumber=1,             % first line number in each listing
@@ -42,9 +54,12 @@ escapeinside={\%*}{*)}     % if you want to add a comment within your code
 \usepackage{needspace}     % For assuring space remaining on a page
 \usepackage{ifthen}        % For conditional processing
 \usepackage{changepage}    % For odd/even page checks
-\usepackage{epic}          % For eepic package 
-\usepackage{eepic}         % For the diagram of section relationships
-\usepackage{eepicemu}      % For the diagram of section relationships
+%\usepackage{epic}          % For eepic package 
+%\usepackage{eepic}         % For the diagram of section relationships
+%\usepackage{eepicemu}      % For the diagram of section relationships
+\usepackage{tikz}                      % graphics (Appendix B)
+\usetikzlibrary{shapes.geometric}
+\usetikzlibrary{arrows}
 \usepackage{makeidx}       % For making an index
 % hyperref must be the last package listed.
 % The hyperref settings helps hypertext get right links in the 
@@ -52,8 +67,6 @@ escapeinside={\%*}{*)}     % if you want to add a comment within your code
 \usepackage[plainpages=false,pdfpagelabels,pagebackref,allcolors=blue]{hyperref} % Lets us generate colored active links inside a pdf.
 \makeindex  % This and the makeidx package allow \index to create index entries.
 
-\renewcommand{\familydefault}{phv}  % font family helvetica
-
 \newcommand{\dwf}{DWARF Debugging Information Format}
 
 \newenvironment{myindentpara}[1]%
@@ -89,7 +102,7 @@ escapeinside={\%*}{*)}     % if you want to add a comment within your code
 \newcommand{\referfol}[1]{\ref{#1} following}
 
 % Generate a live link in the document
-% use like \livelink{chap:DWOPdup}{DW\-\_OP\-\_dup}
+% use like \livelink{chap:DWOPdup}{DW\_OP\_dup}
 \newcommand{\livelink}[2]{\hyperlink{#1}{#2}\index{#2}}
 % use when the index is different from the text and target.
 \newcommand{\livelinki}[3]{\hyperlink{#1}{#2}\index{#3}}
@@ -99,6 +112,9 @@ escapeinside={\%*}{*)}     % if you want to add a comment within your code
 % When we want the index entry to look different from the name.
 \newcommand{\livetargi}[3]{\hypertarget{#1}{#2}\index{#3}}
 
+\newcommand{\thirtytwobitdwarfformat}[1][]{\livelink{datarep:xxbitdwffmt}{32-bit DWARF format}}
+\newcommand{\sixtyfourbitdwarfformat}[1][]{\livelink{datarep:xxbitdwffmt}{64-bit DWARF format}}
+
 \newcommand{\dash}{\nobreakdash-\hspace{0pt}}  % So we handle dashes ok.
 
 % The following two let us mark a word as 'do not link' or
@@ -161,6 +177,16 @@ escapeinside={\%*}{*)}     % if you want to add a comment within your code
         \end{table}
         }
 
+% Anti-ligature commands added because \/ and {} don't work for unknown reasons
+% nor does the microtext package DisableLigatures command...???
+%
+\newcommand{\xiiif}                            {0x\hspace{1pt}3\hspace{2pt}f}
+\newcommand{\xiiifff}                  {0x\hspace{1pt}3\hspace{2pt}f\hspace{2pt}f\hspace{2pt}f}
+\newcommand{\xff}                              {0x\hspace{1pt}f\hspace{2pt}f}
+\newcommand{\xffff}                            {0x\hspace{1pt}f\hspace{2pt}f\hspace{2pt}f\hspace{2pt}f}
+%
+% These are intended for use in running text...
+%
 \newcommand{\xffffffff}                {\texttt{0xffffffff}}                   % use with following punctutation
 \newcommand{\wffffffff}                {\texttt{0xffffffff}\ }                 % use as separate "word"
 \newcommand{\xfffffffzero}             {\texttt{0xfffffff0}}                   % use with following punctutation
@@ -168,6 +194,9 @@ escapeinside={\%*}{*)}     % if you want to add a comment within your code
 \newcommand{\xffffffffffffffff}        {\texttt{0xffffffffffffffff}}   % use with following punctutation
 \newcommand{\wffffffffffffffff}        {\texttt{0xffffffffffffffff}\ }
 
+% Define commands for all of the DWARF names (DW\_*, .debug_*, a few others)
+\include{dwarfnamecmds}
+
 %--- Begin the document pages
 %
 \begin{document}
@@ -250,7 +279,7 @@ escapeinside={\%*}{*)}     % if you want to add a comment within your code
 
 \flushleft
 \raggedbottom
-\chapterstyle{section}
+\chapterstyle{default}
 
 \setlength{\parindent}{0pt} 
 
@@ -271,16 +300,20 @@ escapeinside={\%*}{*)}     % if you want to add a comment within your code
 \include{programscope}                  \emptypage
 \include{dataobject}                    \emptypage
 \include{typeentries}                   \emptypage
-\include{otherdebugginginformation} \emptypage
+\include{otherdebugginginformation}    \emptypage
 \include{datarepresentation}            %\emptypage
+
 %  The \appendix toggles us into appendix chapters
 \appendix
-\include{attributesbytag}
-\include{debugsectionrelationships}     %\emptypage
+
+\include{attributesbytag}                              %\emptypage
+\include{debugsectionrelationships}     \emptypage
 \include{encodingdecoding}              \emptypage
 \include{examples}                      %\emptypage
 \include{compression}                   %\emptypage
 \include{sectionversionnumbers}
 \include{gnulicense}
+
 \printindex
+
 \end{document}