scapy/doc/scapy
gpotter2 ea779e37b2 Update UDP checksum manual computation doc 2018-01-12 20:01:43 +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 Compress scapy-main-console.png 2018-01-12 19:40:56 +01:00
BuildDoc.bat General docs improvement 2017-03-04 12:53:39 +01: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 Doc: remove some str() calls 2018-01-06 23:56:38 +01:00
backmatter.rst Modified windows links/doc 2017-01-15 02:46:09 +01:00
build_dissect.rst Doc: remove some str() calls 2018-01-06 23:56:38 +01:00
conf.py Update doc: new graphics + Python 3 2017-12-27 19:50:55 +01:00
development.rst fix in doc cmd to run a specific uts file 2017-07-12 21:14:39 +02:00
extending.rst Spelling fixes in documentation 2015-07-13 16:23:10 +01:00
functions.rst Update UDP checksum manual computation doc 2018-01-12 20:01:43 +01:00
index.rst Update doc: new graphics + Python 3 2017-12-27 19:50:55 +01:00
installation.rst Fix Cryptography link 2018-01-12 20:01:23 +01:00
introduction.rst Fixed spacing bug (#532) 2017-03-01 13:08:36 +01:00
troubleshooting.rst Fix typo in troubleshooting.rst 2017-05-23 18:09:28 +03:00
usage.rst Add note about monitor mode on windows 2018-01-12 19:41:08 +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