README
1 This folder includes source files (text and graphics) for Scapy's documentation,
2 which is automatically built using Sphinx <http://sphinx.pocoo.org/>
3
4 The *.rst files are written as reStructuredText and should be quite readable
5 in your favourite text editor without any further formatting.
6
7 To generate much nicer, searchable HTML docs, install Sphinx, open a command
8 line, change to the directory where this README is placed, and type the
9 following command:
10
11 $ make html
12
13 To generate a single PDF file (useful for printing) you need a working
14 LaTeX installation (e.g. <http://www.tug.org/texlive/>).
15 The following commands produce the file Scapy.pdf (>100 pages):
16
17 $ make latex
18 $ cd _build/latex
19 $ make all-pdf