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 \usepackage{url} % For color in letters. Links instead?
   7 \usepackage{color} % For color in letters. Links instead?
   8 \usepackage{ellipsis} % Provides ... as \dots
   9 \usepackage{color}
  10 \usepackage{listings}
  11 \usepackage{alltt}
  12 \lstset{ %
  13 language=C++,              % choose the language of the code
  14 basicstyle=\footnotesize,  % the size of the fonts that are used for the code
  15 numbers=left,              % where to put the line-numbers
  16 numberstyle=\footnotesize, % the size of the fonts that are used for the line-numbers
  17 stepnumber=1,              % the step between two line-numbers. If it is 1 each line will be numbered
  18 numbersep=5pt,             % how far the line-numbers are from the code
  19 backgroundcolor=\color{white}, % choose the background color. You must add \usepackage{color}
  20 showspaces=false,          % show spaces adding particular underscores
  21 showstringspaces=false,    % underline spaces within strings
  22 showtabs=false,            % show tabs within strings adding particular underscores
  23 frame=single,           % adds a frame around the code
  24 tabsize=2,              % sets default tabsize to 2 spaces
  25 captionpos=b,           % sets the caption-position to bottom
  26 breaklines=true,        % sets automatic line breaking
  27 breakatwhitespace=false,% sets if automatic breaks should only happen at whitespace
  28 escapeinside={\%*}{*)}  % if you want to add a comment within your code
  29 }
  30
  31 \usepackage{amsmath} % Provides \nobreakdash
  32 \usepackage{graphicx} % For pictures
  33 \usepackage{longtable}
  34 % \textregistered is the trademark symbol
  35 \usepackage[headheight=16pt,paper=letterpaper]{geometry}
  36 \setlength{\headheight}{15pt}  % avoids warning from latex
  37 \usepackage{epic} % For eepic package
  38 \usepackage{eepic} % For the diagram of section relationships
  39 \usepackage{makeidx}
  40 % hyperref must be the last package listed.
  41 % The hyperref settings helps hypertext get right links in the
  42 % pdf of the index.
  43 \usepackage[plainpages=false,pdfpagelabels,pagebackref]{hyperref}  % Lets us generate colored active links inside a pdf.
  44 \makeindex  % This and the makeidx package allow \index to create index entries.
  45
  46 \newcommand{\docdate}{17 December 2012}
  47
  48 \newcommand{\dwf}{DWARF Debugging Information Format}
  49 \newenvironment{myindentpara}[1]%
  50  {\begin{list}{}%
  51    {\setlength{\leftmargin}{#1}}%
  52    \item[]%
  53  }
  54  {\end{list}}
  55
  56 % broken somehow.
  57 %\newcommand{\myindent1}[1]{\begin{myindentpara}{1cm}#1\end{myindentpara}}
  58
  59 \hypersetup{colorlinks=true,
  60   %bookmarks=true,
  61   pdfauthor={\dwf\ Committee},
  62   pdftitle={\dwf\ Version 4.1}
  63 }
  64
  65 % Generate a page ref.
  66 % use like   \refersec{chap:registerbasedaddressing}
  67 \newcommand{\refersec}[1]{\ref{#1} on page \pageref{#1}}
  68
  69 % Generate a live link in the document
  70 % use like \livelink{chap:DWOPdup}{DW\-\_OP\-\_dup}
  71 \newcommand{\livelink}[2]{\hyperlink{#1}{#2}\index{#2}}
  72 % use when the index is different from the text and target.
  73 \newcommand{\livelinki}[3]{\hyperlink{#1}{#2}\index{#3}}
  74 % livetarg is the declaration this is the target of livelinks.
  75 % FIXME: we might want livetarg and livetargi  #2 to be \textbf{#2}
  76 \newcommand{\livetarg}[2]{\hypertarget{#1}{#2}\index{#2}}
  77 % When we want the index entry to look different from the name.
  78 \newcommand{\livetargi}[3]{\hypertarget{#1}{#2}\index{#3}}
  79
  80 \newcommand{\dash}{\nobreakdash-\hspace{0pt}}  % So we handle dashes ok.
  81
  82 % The following two let us mark a word as 'do not link' or
  83 % 'do not index' to indicate the word is used generically
  84 % and has been considered so do not index or link it.
  85 % There is no significant difference in the two commands, though
  86 % \nolink would be more oriented to words such as flag or address
  87 % that might be linked (and indexed) in some circumstances.
  88 \newcommand{\nolink}[1]{#1}
  89 \newcommand{\noindex}[1]{#1}
  90
  91 %For index entries.
  92 \newcommand{\addtoindex}[1]{#1\index{#1}}
  93 \newcommand{\addtoindexi}[2]{#1\index{#2}}
  94 \newcommand{\addtoindexx}[1]{\index{#1}}
  95
  96
  97 \begin{document}
  98 \pagestyle{empty}
  99
 100 \nonzeroparskip
 101 \setlength{\parindent}{0pt}
 102 \setlength{\headheight}{6cm}
 103 \setlength{\uppermargin}{6cm}
 104
 105
 106
 107 \begin{centering}
 108 \LARGE
 109 \textbf{\dwf}
 110
 111 \textbf{Version 4.1}
 112
 113 \centering
 114 \includegraphics[keepaspectratio=true,scale=1.0]{DWlogo}
 115
 116 \centering
 117 \href{http://www.dwarfstd.org}{\dwf\ Committee}
 118
 119 \url{http://www.dwarfstd.org}
 120
 121 \large
 122 \textbf{\docdate}
 123
 124 \end{centering}
 125 \openany
 126 \clearpage
 127 \openany
 128
 129 \frontmatter
 130 \textmd
 131 \normalsize
 132 \setlength{\headheight}{15pt}
 133
 134 \pagestyle{plain}
 135 \makeevenhead{plain}{}{}{}
 136 \makeoddhead{plain}{}{}{}
 137 \makeevenfoot{plain}{}{}{}
 138 \makeoddfoot{plain}{}{}{}
 139
 140 \nonzeroparskip
 141 \setlength{\parindent}{0pt}
 142 \settrims{0.5in}{0.5in}
 143 \settypeblocksize{8.2in}{6.0in}
 144 %\setlrmarginsandblock{0.6in}{0.6in}{*}
 145 %\setheadfoot{15pt}{15pt}
 146 %\setheaderspaces {*}{2\onelineskip}{*}
 147 \nouppercaseheads
 148 \makeevenhead{plain}{}{\rightmark}{}
 149 \makeoddhead{plain}{}{\rightmark}{}
 150 \makeevenfoot{plain}{\docdate}{}{Page \thepage}
 151 \makeoddfoot{plain}{\docdate}{}{Page \thepage}
 152
 153 \openany
 154 \pagenumbering{roman}
 155 \nonzeroparskip
 156 \setlength{\parindent}{0pt}
 157
 158 \include{copyright}
 159 \include{foreword}
 160 \include{foreword4.1}
 161
 162 \tableofcontents
 163
 164 \newpage
 165 \listoffigures
 166
 167 \newpage
 168 \listoftables
 169
 170 \newpage
 171 \mainmatter
 172
 173 % Define the levels of sectionality that are numbered.
 174 \setcounter{secnumdepth}{5}
 175
 176 \nonzeroparskip
 177 \setlength{\parindent}{0pt}
 178
 179 \makepagestyle{fragFirstChPage}
 180
 181 \makeevenhead{fragFirstChPage}{}{}{}
 182 \makeoddhead{fragFirstChPage}{}{}{}
 183 \makeoddfoot{fragFirstChPage}{\docdate}{}{Page \thepage}
 184 \makeevenfoot{fragFirstChPage}{\docdate}{}{Page \thepage}
 185
 186 \aliaspagestyle{chapter}{fragFirstChPage}
 187
 188
 189
 190 \chapterstyle{section}
 191 \pagenumbering{arabic}
 192
 193 \aliaspagestyle{chapter}{fragFirstChPage}
 194
 195 \flushleft
 196
 197 \include{introduction}
 198 \include{generaldescription}
 199 \include{programscope}
 200 \include{dataobject}
 201 \include{typeentries}
 202 \include{otherdebugginginformation}
 203 \include{datarepresentation}
 204 %  The \appendix toggles us into appendix chapters
 205 \appendix
 206 \include{attributesbytag}
 207 \include{debugsectionrelationships}
 208 \include{encodingdecoding}
 209 \include{examples}
 210 \include{compression}
 211 \include{sectionversionnumbers}
 212 \include{gnulicense}
 213 \printindex
 214 \end{document}