Blame doc/refman/refman.sty

Packit Service c5cf8c
% These are the definitions for the reference manual
Packit Service c5cf8c
%
Packit Service c5cf8c
% Things to change:
Packit Service c5cf8c
% 1.  While within argument text, insure that left margins line up
Packit Service c5cf8c
%     (currently, subsequent lines at extreme left margin)
Packit Service c5cf8c
% *** DONE ***
Packit Service c5cf8c
% 2.  Too much space after synopsis
Packit Service c5cf8c
% 3.  Index the main page (add index commands to mantitle)
Packit Service c5cf8c
% 4.  ``Notes'' needs to be a uniform distance after ``input parameters''
Packit Service c5cf8c
% 5.  Tabs and spaces are ignored in lines beginning with ``$''
Packit Service c5cf8c
% *** DONE *** (fixed by new doctext?)
Packit Service c5cf8c
%
Packit Service c5cf8c
% Set the sizes if in stand-alone mode
Packit Service c5cf8c
\def\manpagesonly{
Packit Service c5cf8c
\textheight=9in
Packit Service c5cf8c
\textwidth=6.1in
Packit Service c5cf8c
\oddsidemargin=.2in
Packit Service c5cf8c
\topmargin=-.50in
Packit Service c5cf8c
\hsize=\textwidth
Packit Service c5cf8c
}
Packit Service c5cf8c
%
Packit Service c5cf8c
% If \mancontentstrue, add each manual page to the contents list
Packit Service c5cf8c
\newif\ifmancontents
Packit Service c5cf8c
\mancontentsfalse
Packit Service c5cf8c
%
Packit Service c5cf8c
% Handle # and _ in text
Packit Service c5cf8c
\def\nopound{\catcode`\#=13}
Packit Service c5cf8c
{\nopound\gdef#{{\tt \char`\#}}}
Packit Service c5cf8c
\def\Makeusletter{\catcode`\_=11}
Packit Service c5cf8c
%\catcode`\_=11
Packit Service c5cf8c
% The above makes _ a ``letter''.  We need this incase the file name (because
Packit Service c5cf8c
% of the routine name) contains an underscore.  To make it print as an
Packit Service c5cf8c
% underscore, we need to make it a special
Packit Service c5cf8c
{\catcode`\_=\active\gdef_{{\tt\char`\_}}}
Packit Service c5cf8c
{\catcode`\_=\active\gdef\makeustext{\catcode`\_=\active\def_{{\tt\char`\_}}}}
Packit Service c5cf8c
%
Packit Service c5cf8c
% \mantitle{name}{level}{date}
Packit Service c5cf8c
\def\pagerule{\hbox to \hsize{\leaders\hrule height 2pt \hfil}}
Packit Service c5cf8c
%
Packit Service c5cf8c
% Note that we really need a routine that takes #1 and \protect's it
Packit Service c5cf8c
% when giving the output to \addcontentsline
Packit Service c5cf8c
%
Packit Service c5cf8c
\def\mantitle#1#2#3{\pagerule\nobreak\hbox to \hsize{{\bf #1}\hfil{\bf #1}}%
Packit Service c5cf8c
\ifmancontents\addcontentsline{toc}{subsection}{#1}\fi
Packit Service c5cf8c
\nobreak\pagerule\nobreak}
Packit Service c5cf8c
%
Packit Service c5cf8c
% \manname{name}
Packit Service c5cf8c
%\def\manname#1{\section*{#1}}
Packit Service c5cf8c
\def\manname#1{\noindent {\bf #1}}
Packit Service c5cf8c
%
Packit Service c5cf8c
% \location{filename}
Packit Service c5cf8c
\def\location#1{\subsection*{Location}\file{#1}\par}
Packit Service c5cf8c
%
Packit Service c5cf8c
% \startarg{argname}{meaning}
Packit Service c5cf8c
\def\startarg#1#2{\ifvmode\else\par\fi
Packit Service c5cf8c
     \setbox\@tempboxa\hbox{\bf #1}%
Packit Service c5cf8c
     \ifdim \the\wd\@tempboxa > 1in 
Packit Service c5cf8c
     \hbox to \hsize{\vtop{\box\@tempboxa}\hss}
Packit Service c5cf8c
     \hbox to \hsize{\hskip1in\vtop{\hsize = 5in \vtop{\noindent #2\par}\hfil}\hfil}
Packit Service c5cf8c
     %\vspace{3pt}% This isn't correct, but something is needed here.
Packit Service c5cf8c
     \else
Packit Service c5cf8c
     \hbox to \hsize{\vtop{\hbox to 1in{\bf #1\hfil}}%
Packit Service c5cf8c
                     \vtop{\hbox to 5in{%
Packit Service c5cf8c
                        \hsize = 5in\vtop{\noindent #2\par}\hfil}}\hfill}%
Packit Service c5cf8c
     \fi}
Packit Service c5cf8c
%
Packit Service c5cf8c
% \file{name}
Packit Service c5cf8c
\def\file#1{{\tt #1}}
Packit Service c5cf8c
%
Packit Service c5cf8c
% \subhead{name}
Packit Service c5cf8c
\def\subhead#1{\ifvmode\else\par\fi\vspace{5pt}\subsection*{#1}}
Packit Service c5cf8c
%
Packit Service c5cf8c
% \startmanpage
Packit Service c5cf8c
{\catcode`\_\active\gdef\redefus{\gdef_{{\tt\char`\_}}}}
Packit Service c5cf8c
\def\startmanpage{\begin{raggedright}\begingroup
Packit Service c5cf8c
\catcode`\_=\active\redefus}
Packit Service c5cf8c
Packit Service c5cf8c
% \endmanpage
Packit Service c5cf8c
\def\endmanpage{\ifvmode\else\par\fi\endgroup\vspace{15pt}\end{raggedright}}
Packit Service c5cf8c
%
Packit Service c5cf8c
% \nextline
Packit Service c5cf8c
\def\nextline{\ifvmode\else\hfill\hbox{}\linebreak\fi}
Packit Service c5cf8c
%
Packit Service c5cf8c
% Surround verbatim with these to get the proper effect (which is...?)
Packit Service c5cf8c
\def\startvb{\relax}
Packit Service c5cf8c
\def\endvb{\relax}
Packit Service c5cf8c
%
Packit Service c5cf8c
% Redefine \\ to be a paragraph break with the appropriate fill (should
Packit Service c5cf8c
% change doctext to generate \nl instead)
Packit Service c5cf8c
%\def\nl{\hfill\\}
Packit Service c5cf8c
%
Packit Service c5cf8c
% Allow a looser tolerance for paragraph formation
Packit Service c5cf8c
\pretolerance=300
Packit Service c5cf8c
\tolerance=500
Packit Service c5cf8c
%
Packit Service c5cf8c
% We really should make the manpage stuff an environment, and put all of the
Packit Service c5cf8c
% changes into that group.