summaryrefslogtreecommitdiffstats
path: root/doc/tex/birddoc.sty
diff options
context:
space:
mode:
authorMartin Mares <mj@ucw.cz>2000-06-02 19:22:43 +0200
committerMartin Mares <mj@ucw.cz>2000-06-02 19:22:43 +0200
commit6cba2d5eeb522cbf6f1cc28c38fc2c445f41d1e6 (patch)
tree82132a93cfc0e01dd06facd9df36d2d13cb89659 /doc/tex/birddoc.sty
parent3fa5722defc340571a6518d5556b1e354f05ce18 (diff)
downloadbird-6cba2d5eeb522cbf6f1cc28c38fc2c445f41d1e6.tar
bird-6cba2d5eeb522cbf6f1cc28c38fc2c445f41d1e6.zip
Typographical enhancements. Now, the documentation is typeset using a modified
book style. Please look at this version and tell me your opinion. Especially I don't feel happy about the spacing and (not) indenting of paragraphs. Also, I've removed things like "fax" and "letter" from the LaTeX mapping file.
Diffstat (limited to 'doc/tex/birddoc.sty')
-rw-r--r--doc/tex/birddoc.sty113
1 files changed, 113 insertions, 0 deletions
diff --git a/doc/tex/birddoc.sty b/doc/tex/birddoc.sty
new file mode 100644
index 0000000..3cb7403
--- /dev/null
+++ b/doc/tex/birddoc.sty
@@ -0,0 +1,113 @@
+%% This is a LaTeX style file for typesetting BIRD documentation.
+%% Hacked up by Martin Mares <mj@ucw.cz>
+%%
+%% This is a modified version of linuxdoc-qwertz.sty, for use with SGML-generated LaTeX
+%% by Matt Welsh (mdw@sunsite.unc.edu)
+%%
+%% Based on linuxdoc.sty by Michael K. Johnson, and latex.tex by
+%% Leslie Lamport.
+
+\NeedsTeXFormat{LaTeX2e}
+\ProvidesClass{birddoc}
+
+%%% GLOBAL LAYOUT THINGS
+
+\marginparwidth 0.0 in
+\parindent 0 in
+\topmargin -0.5 in
+\setlength{\textheight}{\paperheight}
+\addtolength{\textheight}{-2 in}
+\advance\headsep 2 ex
+\advance\textheight -2 ex
+\renewcommand{\baselinestretch}{1.14}
+\addtolength{\parskip}{0.5 ex}
+\setcounter{tocdepth}{1}
+
+\oddsidemargin 0.0 in
+\evensidemargin 0 in
+\textwidth 7 in
+\def\ps@headings{\let\@mkboth\markboth
+ \def\@oddfoot{}\def\@evenfoot{}% No feet.
+ \def\@evenhead{\protect\rule[-4pt]{\textwidth}{.5pt}\kern-\textwidth
+ \rm \thepage\hfil \bf \leftmark} % Left heading.
+ \def\@oddhead{\protect\rule[-4pt]{\textwidth}{.5pt}\kern-\textwidth
+ {\bf \rightmark}\hfil \rm\thepage} % Right heading.
+ \def\chaptermark##1{\markboth {{\ifnum \c@secnumdepth >\m@ne
+ \@chapapp\ \thechapter. \ \fi ##1}}{}}%
+ \def\sectionmark##1{\markright {{\ifnum \c@secnumdepth >\z@
+ \thesection. \ \fi ##1}}}}
+
+\def\@makechapterhead#1{%
+ {\parindent \z@ \raggedright \normalfont
+ \huge \bfseries \@chapapp\space\thechapter: #1\par\nobreak
+ \vskip 20\p@
+ }}
+\def\@makeschapterhead#1{%
+ {\parindent \z@ \raggedright \normalfont
+ \huge \bfseries #1\par\nobreak
+ \vskip 20\p@
+ }}
+
+%% Titlepage stuff
+
+\gdef\@title{}
+\gdef\title#1{\gdef\@title{#1}}
+\gdef\@date{}
+\gdef\date#1{\gdef\@date{#1}}
+\gdef\@author{}
+\gdef\author#1{\gdef\@author{#1}}
+\gdef\@abstract{}
+\gdef\abstract#1{\gdef\@abstract{#1}}
+
+\def\maketitle{\thispagestyle{empty}\let\footnotesize\small%
+\let\footnoterule\relax
+%\setcounter{page}{0}%
+%\null
+%\vskip 3 in
+\noindent
+{\huge\sf \@title}\\
+\rule{\textwidth}{1mm}\\
+\mbox{}\@author\ \hfill \@date\ \\
+\vskip 1 ex
+\noindent{\sf \@abstract}
+\setcounter{footnote}{0}%
+\gdef\@author{}\gdef\@title{}\gdef\@years{}\gdef\@abstract{}
+\let\maketitle\relax}
+
+\def\birdnarrow{\advance\@totalleftmargin by 0.5in}
+
+%% Needs to be here for the previous ps@headings defs to work.
+\pagestyle{headings}
+
+%%% USEFUL MACROS
+
+\newcommand{\linux}{Linux} % Always use this when
+ % refering to the \linux\
+ % operating system, like that.
+\newcommand{\key}[1]{{\fbox{\small\tt #1}}} % Use this to mark keys, like
+ % \key{del} for the delete key.
+\newcommand{\ret}{\fbox{\sf return}} % Special case for the return key.
+\newcommand{\st}{\small\tt} % Small typewriter -- comes in handy.
+%\newcommand{\lb}{{\tt\char '173}} % Left Brace '{'
+%\newcommand{\rb}{{\tt\char '175}} % Right Brace '}'
+\newcommand{\lbr}{$\langle$} % Left Bracket '<'
+\newcommand{\rbr}{$\rangle$} % Right Bracket '>'
+\newcommand{\bs}{{\tt\char '134}} % BackSlash '\'
+\newcommand{\tm}{${}^{\mbox{\tiny\sf TM}}$}
+\newcommand{\TM}{\tm} % TM trademark symbol in
+ % either case
+\newcommand{\cparam}[1]{{\rm \lbr{\sl #1}\rbr}}
+ % Metavariables.
+
+%% Define NAMEURL macro to handle the optional name argument
+%% This calls on the \url macro from the url.sty package so the
+%% URL will be hyphenated correctly.
+\def\nameurl#1#2{{\em #2} {\tt <\url{#1}>}}
+\def\onlynameurl#1{{\em #1}}
+
+%% the tscreen environment automatically goes into typewriter type,
+%% but is otherwise like the screen environment
+
+\newenvironment{tscreen}%
+ {\begin{quote}\bgroup\small\tt}%
+ {\egroup\end{quote}}