summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/bytefield/README
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2006-01-09 00:49:07 +0000
committerKarl Berry <karl@freefriends.org>2006-01-09 00:49:07 +0000
commit007f67a693e4d031fd3d792df8e4d5f43e2cb2e7 (patch)
tree90d17e00e572ecb1e24764b6f29c80e098b08d29 /Master/texmf-dist/doc/latex/bytefield/README
parent950209b26f70aa87ed07c54f82a95b6f03b7c3a0 (diff)
doc/latex
git-svn-id: svn://tug.org/texlive/trunk@84 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/bytefield/README')
-rw-r--r--Master/texmf-dist/doc/latex/bytefield/README44
1 files changed, 44 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/bytefield/README b/Master/texmf-dist/doc/latex/bytefield/README
new file mode 100644
index 00000000000..0828830be07
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/bytefield/README
@@ -0,0 +1,44 @@
+ +---------------------------------+
+ | THE BYTEFIELD PACKAGE |
+ | Scott Pakin, scott+bf@pakin.org |
+ +---------------------------------+
+
+
+Description
+-----------
+The bytefield package helps the user create illustrations for network
+protocol specifications and anything else that utilizes fields of
+data. These illustrations show how the bits and bytes are laid out in
+a packet or in memory.
+
+
+Copyright and license
+---------------------
+Copyright (C) 2005 Scott Pakin, scott+bf@pakin.org
+
+This package may be distributed and/or modified under the conditions
+of the LaTeX Project Public License, either version 1.3a of this
+license or (at your option) any later version. The latest version of
+this license is in:
+
+ http://www.latex-project.org/lppl.txt
+
+and version 1.3a or later is part of all distributions of LaTeX version
+2004/10/11 or later.
+
+
+Building bytefield
+------------------
+tex bytefield.ins <== Produces bytefield.sty (the package proper)
+latex bytefield.dtx <== Produces bytefield.dvi (the documentation)
+makeindex -s gind.ist bytefield.idx -o bytefield.ind <== Writes an index
+makeindex -s gglo.ist bytefield.glo -o bytefield.gls <== Writes a change log
+latex bytefield.dtx <== Incorporates the index and change log into
+ bytefield.dvi
+
+Note that bytefield comes with pre-built documentation (PDF format,
+U.S. letter-sized paper, 24 pages). Also, there is an example.tex
+file that shows how one might include hyperlinks in a protocol
+diagram. example.tex needs the hyperref package and should be run
+through pdfLaTeX, VTeX, dvipdfm, or any other backend that supports
+hyperref hyperlinks.