Skip to content

Commit f4f0828

Browse files
author
Matt
committed
Minor README format changes
1 parent 324ac43 commit f4f0828

File tree

1 file changed

+16
-9
lines changed

1 file changed

+16
-9
lines changed

README.rst

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,14 @@ NetfilterQueue
55
NetfilterQueue provides access to packets matched by an iptables rule in
66
Linux. Packets so matched can be accepted, dropped, altered, or given a mark.
77

8-
Libnetfilter_queue (the netfilter library, not this module) is part of the `Netfilter project <http://netfilter.org/projects/libnetfilter_queue/>`_.
8+
Libnetfilter_queue (the netfilter library, not this module) is part of the
9+
`Netfilter project <http://netfilter.org/projects/libnetfilter_queue/>`_.
910

1011
Example
1112
=======
1213

13-
The following script prints a short description of each packet before accepting it. ::
14+
The following script prints a short description of each packet before accepting
15+
it. ::
1416

1517
from netfilterqueue import QueueHandler
1618
@@ -33,7 +35,8 @@ To send packets destined for your LAN to the script, type something like::
3335
Installation
3436
============
3537

36-
NetfilterQueue is a C extention module that links against libnetfilter_queue. Before installing, ensure you have:
38+
NetfilterQueue is a C extention module that links against libnetfilter_queue.
39+
Before installing, ensure you have:
3740

3841
1. A C compiler
3942

@@ -62,7 +65,8 @@ To install from source::
6265
cd NetfilterQueue-0.2
6366
python setup.py install
6467

65-
Setup will use Cython if it is installed, regenerating the .c source from the .pyx before compiling the .so.
68+
Setup will use Cython if it is installed, regenerating the .c source from the
69+
.pyx before compiling the .so.
6670

6771
API
6872
===
@@ -72,7 +76,8 @@ API
7276
``NetfilterQueue.COPY_META``
7377

7478
``NetfilterQueue.COPY_PACKET``
75-
These constants specify how much of the packet should be given to the script- nothing, metadata, or the whole packet.
79+
These constants specify how much of the packet should be given to the
80+
script- nothing, metadata, or the whole packet.
7681

7782
QueueHandler objects
7883
--------------------
@@ -97,7 +102,8 @@ handle() method. Handle() is called for each packet that appears in the queue.
97102

98103
``QueueHandler.handle(packet)``
99104
Handle a single packet from the queue. You must call either
100-
``packet.accept()`` or ``packet.drop()``.
105+
``packet.accept()`` or ``packet.drop()``. If you don't override this
106+
method, all packets will be accepted.
101107

102108
Packet objects
103109
--------------
@@ -177,8 +183,8 @@ More details coming soon...
177183
* Probably other stuff is omitted too
178184

179185
* When a packet has been marked, we use nfq_set_verdict_mark rather than
180-
nfq_set_verdict2. Apparently nfq_set_verdict_mark
181-
`is broken <http://netfilter.org/projects/libnetfilter_queue/doxygen/group__Queue.html#ga1986d6387c5aa2a837c02e87ae3b45ff>`_,
186+
nfq_set_verdict2. Apparently nfq_set_verdict_mark is
187+
`broken <http://netfilter.org/projects/libnetfilter_queue/doxygen/group__Queue.html#ga1986d6387c5aa2a837c02e87ae3b45ff>`_,
182188
although it works for me.
183189

184190
Source
@@ -191,4 +197,5 @@ License
191197

192198
Copyright (c) 2011, Kerkhoff Technologies, Inc. All rights reserved.
193199

194-
`BSD <https://github.com/kti/python-netfilterqueue/blob/master/LICENSE.txt>`_ licensed.
200+
`BSD <https://github.com/kti/python-netfilterqueue/blob/master/LICENSE.txt>`_
201+
licensed.

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy