Skip to content

Commit

Permalink
Minor documentation tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
gpotter2 committed Jul 23, 2023
1 parent a24252e commit 74f12f3
Show file tree
Hide file tree
Showing 3 changed files with 2 additions and 19 deletions.
Binary file not shown.
19 changes: 1 addition & 18 deletions doc/scapy/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,30 +27,13 @@ some features will not be available::

The basic features of sending and receiving packets should still work, though.


Customizing the Terminal
------------------------

Before you actually start using Scapy, you may want to configure Scapy to properly render colors on your terminal. To do so, set ``conf.color_theme`` to one of of the following themes::

DefaultTheme, BrightTheme, RastaTheme, ColorOnBlackTheme, BlackAndWhite, HTMLTheme, LatexTheme

For instance::

conf.color_theme = BrightTheme()

.. image:: graphics/animations/animation-scapy-themes-demo.gif
:align: center

Other parameters such as ``conf.prompt`` can also provide some customization. Note Scapy will update the shell automatically as soon as the ``conf`` values are changed.


Interactive tutorial
====================

This section will show you several of Scapy's features with Python 2.
Just open a Scapy session as shown above and try the examples yourself.

.. note:: You can configure the Scapy terminal by modifying the ``~/.config/scapy/prestart.py`` file.

First steps
-----------
Expand Down
2 changes: 1 addition & 1 deletion scapy/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ def _validate_local(k):
# default interpreter
conf.interactive_shell = "auto"
# color theme
# color theme (DefaultTheme, BrightTheme, ColorOnBlackTheme, BlackAndWhite, ...)
conf.color_theme = DefaultTheme()
# force-use libpcap
Expand Down

0 comments on commit 74f12f3

Please sign in to comment.