tds 0.9995
K. Berry
kb@cs.umb.edu
Mon, 26 Jan 1998 17:12:49 -0500 (EST)
I've put yet another tds version up at
ftp://tug.org/tex/tds.tar.gz
ftp://tug.org/tex/tds/ (including tds.dvi)
http://tug.org/tds/
There's a bad page break at Section 3.1, but I thought people should see
the text before worrying about that.
I'll probably read this over once more before making an official
release, but anyway.
Here are the diffs. If anyone has a better idea for a word besides
`Extensions', I'd love to hear it :-).
*** tds.tex 1998/01/23 22:14:00 1.15
--- tds.tex 1998/01/26 21:19:57
***************
*** 1,8 ****
%&latex
\NeedsTeXFormat{LaTeX2e} % sorry, compatibility with 2.09 is too painful
! \documentclass[draft]{tdsguide}
! \tdsVersion{0.9994}
\title{A Directory Structure for \TeX{} Files}
\author{TUG Working Group on a \TeX{} Directory Structure (TWG-TDS)}
--- 1,8 ----
%&latex
\NeedsTeXFormat{LaTeX2e} % sorry, compatibility with 2.09 is too painful
! \documentclass{tdsguide}
! \tdsVersion{0.9995}
\title{A Directory Structure for \TeX{} Files}
\author{TUG Working Group on a \TeX{} Directory Structure (TWG-TDS)}
***************
*** 13,22 ****
\begin{legalnotice}
! Copyright {\copyright} 1994, 95, 96, 97 \TeX{} Users Group.
! Permission to use, copy, and distribute this document for any purpose
! \emphasis{without modification} and without fee is hereby granted,
provided that this notice appears in all copies. It is provided ``as
is'' without expressed or implied warranty.
--- 13,22 ----
\begin{legalnotice}
! Copyright {\copyright} 1994, 95, 96, 97, 98 \TeX{} Users Group.
! Permission to use, copy, and distribute this document \emphasis{without
! modification} for any purpose and without fee is hereby granted,
provided that this notice appears in all copies. It is provided ``as
is'' without expressed or implied warranty.
***************
*** 28,35 ****
This document is available on any \abbr{ctan} host
(Appendix~\ref{sec:Related references} has a complete reference).
Please send questions or suggestions by email to
! \email|twg-tds@mail.tug.org| or by postal mail to Karl Berry, 135 Center
! Hill Road, Plymouth, MA\ \ 02360, USA\@. We welcome all comments.
\end{legalnotice}
--- 28,35 ----
This document is available on any \abbr{ctan} host
(Appendix~\ref{sec:Related references} has a complete reference).
Please send questions or suggestions by email to
! \email|tds@tug.org| or by postal mail to Karl Berry, 135 Center
! Hill Road, Plymouth, MA 02360, USA\@. We welcome all comments.
\end{legalnotice}
***************
*** 324,331 ****
\item[\path|source|] for sources. This includes both traditional
program sources (for example, \application{Web2c} sources go in
! \path|texmf/source/web2c|) and \LaTeX{} \path|dtx| sources (which go in
! \path|texmf/source/latex|). The \abbr{TDS} leaves unspecified any
structure under \path|source|.
\path|source| is intended for files which are not needed at runtime by
--- 324,331 ----
\item[\path|source|] for sources. This includes both traditional
program sources (for example, \application{Web2c} sources go in
! \path|texmf/source/web2c|) and, e.g., \LaTeX{} \path|dtx| sources (which
! go in \path|texmf/source/latex|). The \abbr{TDS} leaves unspecified any
structure under \path|source|.
\path|source| is intended for files which are not needed at runtime by
***************
*** 344,354 ****
implementation-specific trees} for examples of real
\replaceable{implementation} trees.
! \item[\replaceable{program}] for individual configuration files and
! program-specific input files for \TeX{}-related programs (examples:
\path|mft|, \path|dvips|). In fact, the \path|tex|, \path|metafont|,
! \path|metapost|, and \path|bibtex| directories above may be seen as
! instances of this case.
\end{description}
--- 344,359 ----
implementation-specific trees} for examples of real
\replaceable{implementation} trees.
! \item[\replaceable{extension}] for program-specific input files for new
! programs (examples: \path|etex|, \path|pdftex|, \path|omega|) that are
! extensions of \TeX{}, \MF{}, or any standard program. See
! Section~\ref{sec:Extensions}.
!
! \item[\replaceable{program}] for program-specific input and
! configuration files for any \TeX{}-related programs (examples:
\path|mft|, \path|dvips|). In fact, the \path|tex|, \path|metafont|,
! \path|metapost|, \path|bibtex|, and \replaceable{extension} items above
! may all be seen as instances of this case.
\end{description}
***************
*** 775,785 ****
See Section~\ref{sec:Documentation tree summary} for a summary.
\newpage
\section{Summary}
\label{sec:Summary}
! A skeleton of a \abbr{TDS} \texmf{} directory tree:
\begin{tdsSummary}
bibtex/ \BibTeX{} input files
. bib/ \BibTeX{} databases
--- 780,827 ----
See Section~\ref{sec:Documentation tree summary} for a summary.
+ \subsection{Extensions}
+ \label{sec:Extensions}
+
+ New programs that are extensions of old ones shall use a new top-level
+ directory name for their extension-specific input files. The new
+ directory shall have the same general structure as the top-level
+ directory of the original program, and the new program almost certainly
+ should search the original top-level directory.
+
+ For example, several variants of \TeX{} that recognize additional
+ commands have been released. Input files that use these new commands
+ cannot be placed in the top-level \path|tex| directory, since the
+ original \TeX{} program cannot read them. So they must go in a new
+ directory, with the same package structure as \path|tex| (see
+ Section~\ref{sec:Macros}).
+
+ Using e-\TeX{} as an example, we have the following:
+
+ \begin{itemize-squeeze}
+
+ \item A new top-level (in \path|texmf|) directory \path|etex|.
+
+ \item Since e-\TeX{} is an extension of \TeX{}, \path|texmf/etex|
+ follows the same conventions as \path|texmf/tex|.
+ \path|texmf/etex| contains only e-\TeX{}-specific files.
+
+ \item e-\TeX{} searches first \path|texmf/etex|, then \path|texmf/tex|.
+
+ \end{itemize-squeeze}
+
+ These same principles hold for PDF\TeX{}, Omega, and (most probably)
+ future variants of \TeX{} or \MF{}.
+
+
\newpage
\section{Summary}
\label{sec:Summary}
! A skeleton of a \abbr{TDS} \texmf{} directory tree. This is not to
! imply these are the only entries allowed. For example, \path|local| may
! occur at any level.
!
\begin{tdsSummary}
bibtex/ \BibTeX{} input files
. bib/ \BibTeX{} databases
***************
*** 791,796 ****
--- 833,839 ----
. . misc/ single-file styles
. <package>/ name of a package
doc/ see Section~\ref{sec:Documentation} and the summary below
+ etex/ as with \path|tex|, below
fonts/ font-related files
. <type>/ file type (e.g., \path|pk|)
. . <mode>/ type of output device (for \path|pk| and \path|gf| only)
***************
*** 798,803 ****
--- 841,847 ----
. . . . <typeface>/ name of a typeface (e.g., \path|cm|)
. . . . . dpi<nnn>/ font resolution (for \path|pk| and \path|gf| only)
<implementation>/ \TeX{} implementations, by name (e.g., \path|emtex|)
+ local/ files created or modified at the local site
metafont/ \MF{} (non-font) input files
. base/ base distribution (e.g., \path|plain.mf|)
. misc/ single-file packages (e.g., \path|modes.mf|)
***************
*** 828,834 ****
\subsection{Documentation tree summary}
\label{sec:Documentation tree summary}
! A skeleton of a \abbr{TDS} directory tree under \path|texmf/doc|:
\begin{tdsSummary}
ams/
--- 872,879 ----
\subsection{Documentation tree summary}
\label{sec:Documentation tree summary}
! A skeleton of a \abbr{TDS} directory tree under \path|texmf/doc|. This
! is not to imply these are the only entries allowed.
\begin{tdsSummary}
ams/
***************
*** 858,863 ****
--- 903,909 ----
latex/ example of \replaceable{format}
. base/ \path|ltnews*|, \path|*guide|, etc.
. graphics/ \path|grfguide|
+ local/ site-specific documentation
<program>/ \TeX{}-related programs, by name (examples follow)
metafont/ \path|mfbook.tex|, \path|metafont-for-beginners|, etc.
metapost/ \path|mpman|, \path|manfig|, etc.
***************
*** 866,871 ****
--- 912,918 ----
\end{tdsSummary}
+ \newpage
\appendix
\section{Unspecified pieces}
***************
*** 1111,1120 ****
(Email \email|scherer@physik.rwth-aachen.de| to contact the maintainer
of this implementation.)
! AmiWeb2c 2.0 is compatible with Web2c 7.0 to the greatest possible
extent, so only the very few differences are described in this
section. Detailed information about the basic concepts is given in
! the section for Web2c 7.0 below.
Thanks to the \verb|SELFAUTO| mechanism of Kpathsea 3.0 no specific
location for the installation of AmiWeb2c is required as long as the
--- 1158,1167 ----
(Email \email|scherer@physik.rwth-aachen.de| to contact the maintainer
of this implementation.)
! AmiWeb2c 2 is compatible with Web2c 7 to the greatest possible
extent, so only the very few differences are described in this
section. Detailed information about the basic concepts is given in
! the section for Web2c 7 below.
Thanks to the \verb|SELFAUTO| mechanism of Kpathsea 3.0 no specific
location for the installation of AmiWeb2c is required as long as the
***************
*** 1158,1164 ****
\end{tdsSummary}
! \subsubsection{Web2c 7.0}
All implementation-dependent \TeX{} system files (\path|.pool|,
\path|.fmt|, \path|.base|, \path|.mem|) are stored by default directly
--- 1205,1211 ----
\end{tdsSummary}
! \subsubsection{Web2c 7}
All implementation-dependent \TeX{} system files (\path|.pool|,
\path|.fmt|, \path|.base|, \path|.mem|) are stored by default directly
***************
*** 1181,1187 ****
. . . web2c/ implementation-dependent files (\path|.pool|, \path|.fmt|, \path|texmf.cnf|, etc.)
\end{tdsSummary}
! See \url|ftp://ftp.gnu.ai.mit.edu/pub/gnu/standards.text| for the
rationale behind and descriptions of this arrangement. A site may of
course override these defaults; for example, it may put everything under
a single directory such as \path|/usr/local/texmf|.
--- 1228,1234 ----
. . . web2c/ implementation-dependent files (\path|.pool|, \path|.fmt|, \path|texmf.cnf|, etc.)
\end{tdsSummary}
! See \url|ftp://ftp.gnu.org/pub/gnu/standards.text| for the
rationale behind and descriptions of this arrangement. A site may of
course override these defaults; for example, it may put everything under
a single directory such as \path|/usr/local/texmf|.
***************
*** 1355,1366 ****
name. For example:
\begin{ttdisplay}
\url|ftp://ftp.dante.de/tex-archive|
\url|ftp://ftp.tex.ac.uk/tex-archive|
\end{ttdisplay}
! Finger \path|ctan@ftp.tug.org| for a complete list of \abbr{ctan}
! sites; there are mirrors worldwide.
Here are the references:
--- 1402,1414 ----
name. For example:
\begin{ttdisplay}
+ \url|ftp://ctan.tug.org/tex-archive|
\url|ftp://ftp.dante.de/tex-archive|
\url|ftp://ftp.tex.ac.uk/tex-archive|
\end{ttdisplay}
! Finger \path|ctan@tug.org| for a complete list of \abbr{ctan} sites,
! there are mirrors worldwide.
Here are the references: