summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/tugboat/README
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
committerNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
commite0c6872cf40896c7be36b11dcc744620f10adf1d (patch)
tree60335e10d2f4354b0674ec22d7b53f0f8abee672 /macros/latex/contrib/tugboat/README
Initial commit
Diffstat (limited to 'macros/latex/contrib/tugboat/README')
-rw-r--r--macros/latex/contrib/tugboat/README72
1 files changed, 72 insertions, 0 deletions
diff --git a/macros/latex/contrib/tugboat/README b/macros/latex/contrib/tugboat/README
new file mode 100644
index 0000000000..11e6e50e24
--- /dev/null
+++ b/macros/latex/contrib/tugboat/README
@@ -0,0 +1,72 @@
+$Id: README 205 2018-09-06 17:28:53Z karl $
+Copyright 2006, 2009-2018 TeX Users Group.
+You may freely use, modify and/or distribute this file.
+
+LaTeX macros for use in TUGboat
+===============================
+
+See the TUGboat web pages at http://tug.org/TUGboat for upcoming
+deadlines, tips on writing articles, access to online issues, etc.
+We greatly appreciate new article submissions!
+
+The files in this directory generate the TUGboat article class
+ltugboat.cls, which should be used for all articles nowadays -- both
+proceedings and regular issues.
+
+These macros are supported. Feel free to write to us.
+
+The TUGboat staff <tugboat@tug.org>
+
+
+Installation and use:
+=====================
+
+Usually you can get the tugboat packages through your distribution.
+
+But if you want to install it by hand from CTAN, its directory there
+(see http://ctan.org/pkg/tugboat) has three files containing TeX code:
+
+ tugboat.dtx -- the source for the macros
+ tugboat.ins -- the docstrip instructions
+ ltubguid.ltx -- documentation for the macros (published in
+ http://tug.org/TUGboat/tb17-3/tb52guid.pdf,
+ but much updated since)
+
+other files are
+ ltubguid.pdf -- user documentation
+ tugboat.bst -- recommended BibTeX style for TUGboat
+ (approximately abbrvurl plus yet more abbreviations)
+ ltugbib.bst -- BibTeX style for ltugboat.cls's Harvard-cite capabilities
+
+Processing the .ins file produces:
+
+ ltugboat.cls -- for preparing any TUGboat article
+ ltugproc.cls -- (obsolete)
+ ltugboat.sty -- The usual `obsolete file' warning
+ ltugproc.sty -- The usual `obsolete file' warning
+ ltugcomn.sty -- Used when processing tugboat.dtx for its
+ documentation content
+
+The procedure for using the macros should therefore be:
+
+ process the .ins file
+ move the .sty and .cls to "somewhere LaTeX will search"
+ move the .bib to "somewhere BibTeX will search"
+ move the browsable documentation to "somewhere texdoc will search"
+
+On a TDS installation, common search locations are:
+
+ $TEXMF/tex/latex/tugboat (for .sty, .cls)
+ $TEXMF/bibtex/bst/tugboat (for .bst)
+ $TEXMF/doc/latex/tugboat (for .pdf)
+
+($TEXMF being a pointer to the root of a TDS tree, preferably a local
+one, to avoid tangling with future releases of your TeX distribution.)
+
+`User-level' documentation is provided in file ltubguid.pdf, which is
+a revised version of a TUGboat paper. The documented source of the
+macros is also provided in readily readable form, as tugboat.pdf.
+
+By the way, tugboat.sty, tugproc.sty, and tugboat.cmn are the plain TeX
+files for TUGboat and not included here (see the separate tugboat-plain
+package).