A few miscelleaneous corrections including especially fixing the spacing
[dwarf-doc.git] / dwarf5 / latexdoc / dwarf5.tex
index 0598bc0..6882ae6 100644 (file)
@@ -3,10 +3,10 @@
 % 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}{25 April 2013 (***Draft***)}
+\newcommand{\docdate}{May 18, 2013 \hspace{1cm}(***\textbf{DRAFT}***)}
 %
 \usepackage[T1]{fontenc}
-\usepackage{bookman}
+\usepackage{palatino}
 \usepackage{cmtt}
 \renewcommand{\ttdefault}{cmtt}        % Use Computer Modern Typewriter instead of Courier
 %\usepackage{ascii}
@@ -16,6 +16,7 @@
 %\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
@@ -25,7 +26,7 @@
 \lstset{ %
 language={},               % choose the language of the code
 basicstyle=\footnotesize\ttfamily,  % the size of the fonts that are used for the code
-numbers=left,              % where to put the line-numbers
+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
@@ -53,10 +54,7 @@ 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{tikz}                      % graphics (Appendix B)
+\usepackage{tikz}                 % graphics (Appendix B)
 \usetikzlibrary{shapes.geometric}
 \usetikzlibrary{arrows}
 \usepackage{makeidx}       % For making an index
@@ -101,7 +99,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}}
@@ -111,6 +109,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
@@ -122,10 +123,16 @@ escapeinside={\%*}{*)}     % if you want to add a comment within your code
 \newcommand{\nolink}[1]{#1}
 \newcommand{\noindex}[1]{#1}
 
-% For index entries.
+% For index entries. The tt-variant of each pair is designed to
+% allow a word to appear in tt font in the main test and the index
+% but to collate in the index in its non-tt order. (LaTex normally
+% sorts all tt words before all non-tt words.)
 \newcommand{\addtoindex}[1]{#1\index{#1}}
+\newcommand{\addttindex}[1]{\texttt{#1}\index{#1@\texttt{#1}}}
 \newcommand{\addtoindexi}[2]{#1\index{#2}}
+\newcommand{\addttindexi}[2]{\texttt{#1}\index{#2@\texttt{#2}}}
 \newcommand{\addtoindexx}[1]{\index{#1}}
+\newcommand{\addttindexx}[1]{\index{#1@\texttt{#1}}}
 
 % Quote commands that avoid need for inline UTF-8 in these sources
 \newcommand{\doublequote}[1]{\textquotedblleft #1\textquotedblright}
@@ -145,9 +152,6 @@ escapeinside={\%*}{*)}     % if you want to add a comment within your code
 \renewcommand{\descriptionlabel}[1]{\hspace{\labelsep}\textnormal{#1}}
 \newcommand{\descriptionlabelnl}[1]{\item[#1] \mbox{}\\}
 
-% Reduce vertical space at beginning of a list
-\setlength{\topsep}{0in}
-
 \newcommand{\emptypage}{
     \clearpage
     \vspace*{4in}
@@ -190,7 +194,7 @@ 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)
+% Define commands for all of the DWARF names (DW\_*, .debug_*, a few others)
 \include{dwarfnamecmds}
 
 %--- Begin the document pages
@@ -203,6 +207,8 @@ escapeinside={\%*}{*)}     % if you want to add a comment within your code
 \setlength{\parindent}{0pt} 
 \setlength{\headheight}{6cm}
 \setlength{\uppermargin}{6cm}
+\setlength{\topsep}{0pt}
+\tightlists                                    % less spacing before/after lists
 
 \begin{centering}
 \LARGE
@@ -275,7 +281,7 @@ escapeinside={\%*}{*)}     % if you want to add a comment within your code
 
 \flushleft
 \raggedbottom
-\chapterstyle{section}
+\chapterstyle{default}
 
 \setlength{\parindent}{0pt} 
 
@@ -296,16 +302,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{datarepresentation}            %\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}