Return to libnet.Pod CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / libnet / doc

Annotation of embedaddon/libnet/doc/libnet.Pod, revision 1.1.1.1

1.1       misho       1: =pod
                      2: 
                      3: =encoding utf8
                      4: 
                      5: =head1 NAME
                      6: 
                      7: libnet - A C library for packet creation and injection
                      8: 
                      9: =head1 SYNOPSIS
                     10: 
                     11: B<#include E<lt>libnet.hE<gt>>
                     12: 
                     13: =head1 DESCRIPTION
                     14: 
                     15: libnet is a packet assembly library that provides a portable interface for
                     16: packet creation and injection.
                     17: 
                     18: It is a high-level API that allows an application programmer to construct and
                     19: inject network packets. libnet provides a simplified interface for low-level
                     20: network packet shaping, handling and injection.
                     21: 
                     22: libnet hides much of the tedium of packet creation from the application
                     23: programmer such as multiplexing, buffer management, arcane packet header
                     24: information, byte-ordering, OS-dependent issues, and much more. libnet features
                     25: portable packet creation interfaces at the IP and link layer, as well as a host
                     26: of supplementary and complementary functionality. Using libnet, quick and
                     27: simple packet assembly applications can be whipped up with little effort.  With
                     28: a bit more time, more complex programs can be written (L<traceroute(8)> and
                     29: L<ping(8)> were easily rewritten using libnet and L<pcap(3)>.
                     30: 
                     31: When building applications with libnet we recommend using L<pkg-config(1)> to
                     32: detect the precense and required version of libnet.  The L<libnet-config(1)>
                     33: script is still bundled in the libnet distribution, but is considered to be
                     34: deprecated in favor of L<pkg-config(1)>.  Both can be used to get compiler and
                     35: linker flags of the installed libnet library, as well as provide other useful
                     36: information.  For applications using GNU autotools, we recommend using the
                     37: PKG_PROG_PKG_CONFIG and PKG_CHECK_MODULES m4 macros.
                     38: 
                     39: B<NOTE>: If you are writing your application with libnet, include F<libnet.h>,
                     40: which will include any additional header for you, rather than including
                     41: F<libnet/libnet-functions.h>, F<libnet/libnet-macros.h> or any of the others.
                     42: 
                     43: =head1 BACKWARDS COMPATIBILITY
                     44: 
                     45: Your old code (circa libnet B<1.0.x>) WILL NOT WORK with libnet> B<E<gt>=1.1.x>.
                     46: See B<doc/MIGRATION.md> for easy steps on porting your old code.
                     47: 
                     48: =head1 SEE ALSO
                     49: 
                     50: L<pkg-config(1)>, L<libnet-config(1)>, L<libnet-functions(3)>, L<libnet-macros(3)>
                     51: 
                     52: =head1 AUTHORS
                     53: 
                     54: The original author of libnet is Mike D. Schiffman.
                     55: 
                     56: libnet has been maintained and extensively enhanced since 2009 by Sam Roberts.
                     57: It is currently maintained by the Libnet Maintainers at GitHub:
                     58: 
                     59:         <https://github.com/libnet/libnet>
                     60: 
                     61: =head1 BUGS
                     62: 
                     63: Suggestions, bug reports/fixes, and pull requests, see:
                     64: 
                     65:         <https://github.com/libnet/libnet/issues>
                     66: 
                     67: =head1 COPYRIGHT
                     68: 
                     69: libnet is licensed under the 3-Clause BSD License.
                     70: 
                     71: =cut
                     72: