scapy/doc/scapy
Guillaume Valadon a7a85a2639 Merge pull request #330 from danieljakots/master
improve installation doc regarding OpenBSD
2016-11-20 20:01:08 +01:00
..
_static Added Scapy doc (!) (Thanks to D. Loss) 2008-12-27 00:34:05 +01:00
_templates Added Scapy doc (!) (Thanks to D. Loss) 2008-12-27 00:34:05 +01:00
graphics Added graphics for automata 2009-04-15 19:08:01 +02:00
Makefile Added Scapy doc (!) (Thanks to D. Loss) 2008-12-27 00:34:05 +01:00
README Added README with build instructions for the docs 2009-04-15 19:35:28 +02:00
advanced_usage.rst Add PROFINET IO real-time layer 2016-09-12 17:23:31 +02:00
backmatter.rst Added credits for Peter Kacherginsky 2009-02-20 23:17:05 +01:00
build_dissect.rst doc improvement proposal (#207) 2016-07-08 08:48:44 +02:00
conf.py Open 2.3.1-dev 2014-12-23 12:33:20 +01:00
development.rst doc improvement proposal (#207) 2016-07-08 08:48:44 +02:00
extending.rst Spelling fixes in documentation 2015-07-13 16:23:10 +01:00
index.rst Reordered table of contents 2009-03-15 22:13:35 +01:00
installation.rst Merge pull request #330 from danieljakots/master 2016-11-20 20:01:08 +01:00
introduction.rst Added missing` in introduction 2016-10-08 15:14:24 +02:00
troubleshooting.rst Spelling fixes in documentation 2015-07-13 16:23:10 +01:00
usage.rst Fixed bug in bridge_and_sniff 2016-03-21 19:34:49 +01:00

README

This folder includes source files (text and graphics) for Scapy's documentation,
which is automatically built using Sphinx <http://sphinx.pocoo.org/>

The *.rst files are written as reStructuredText and should be quite readable
in your favourite text editor without any further formatting.

To generate much nicer, searchable HTML docs, install Sphinx, open a command 
line, change to the directory where this README is placed, and type the
following command:

  $ make html

To generate a single PDF file (useful for printing) you need a working
LaTeX installation (e.g. <http://www.tug.org/texlive/>). 
The following commands produce the file Scapy.pdf (>100 pages):

  $ make latex
  $ cd _build/latex
  $ make all-pdf