summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/bytefield/README
blob: 5f8e64c3d2ec806d2f42e9960f8930ea5a44b3c0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
                 +---------------------------------+
                 |      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, register, or memory.


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.  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.


Copyright and license
---------------------

Copyright (C) 2000-2021 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.3c or later is part of all distributions of LaTeX version
2006/05/20 or later.