diff options
Diffstat (limited to 'doc/man/man3')
-rw-r--r-- | doc/man/man3/libnet-functions.3 | 62 | ||||
-rw-r--r-- | doc/man/man3/libnet-macros.3 | 6 | ||||
-rw-r--r-- | doc/man/man3/libnet.3 | 2 |
3 files changed, 35 insertions, 35 deletions
diff --git a/doc/man/man3/libnet-functions.3 b/doc/man/man3/libnet-functions.3 index 133a8d0..ac48714 100644 --- a/doc/man/man3/libnet-functions.3 +++ b/doc/man/man3/libnet-functions.3 @@ -1,4 +1,4 @@ -.TH "libnet-functions.h" 3 "Sat Sep 28 2019" "libnet-1.1" "libnet Programmers Guide" \" -*- nroff -*- +.TH "libnet-functions.h" 3 "Sun Sep 29 2019" "libnet-1.2-rc3" "libnet Programmers Guide" \" -*- nroff -*- .ad l .nh .SH NAME @@ -1139,7 +1139,7 @@ Builds a Cisco Discovery Protocol (CDP) header\&. Cisco Systems designed CDP to .br \fIttl\fP time to live (time information should be cached by recipient) .br -\fIsum\fP checksum (0 for libnet to autofill) +\fIsum\fP checksum (0 for libnet to auto-fill) .br \fItype\fP type of data contained in value .br @@ -1294,7 +1294,7 @@ header'\&. It is then followed by the GRE header and finally the encapsulated pa .br \fItype\fP which protocol is encapsulated (PPP, IP, \&.\&.\&.) .br -\fIsum\fP checksum (0 for libnet to autofill)\&. +\fIsum\fP checksum (0 for libnet to auto-fill)\&. .br \fIoffset\fP byte offset from the start of the routing field to the first byte of the SRE .br @@ -1406,7 +1406,7 @@ header'\&. It is then followed by the GRE header and finally the encapsulated pa .br \fItype\fP which protocol is encapsulated (PPP, IP, \&.\&.\&.) .br -\fIsum\fP checksum (0 for libnet to autofill)\&. +\fIsum\fP checksum (0 for libnet to auto-fill)\&. .br \fIoffset\fP byte offset from the start of the routing field to the first byte of the SRE .br @@ -1491,7 +1491,7 @@ protocol tag value on success .PP .SS "LIBNET_API libnet_ptag_t libnet_build_hsrp (uint8_t version, uint8_t opcode, uint8_t state, uint8_t hello_time, uint8_t hold_time, uint8_t priority, uint8_t group, uint8_t reserved, uint8_t authdata[HSRP_AUTHDATA_LENGTH], uint32_t virtual_ip, const uint8_t * payload, uint32_t payload_s, libnet_t * l, libnet_ptag_t ptag)" -Builds a HSRP header\&. HSRP is a Cisco propietary protocol defined in RFC 2281 +Builds a HSRP header\&. HSRP is a Cisco proprietary protocol defined in RFC 2281 .PP \fBParameters:\fP .RS 4 @@ -1505,7 +1505,7 @@ Builds a HSRP header\&. HSRP is a Cisco propietary protocol defined in RFC 2281 .br \fIhold_time\fP seconds that the current hello message is valid .br -\fIpriority\fP priority for the election proccess +\fIpriority\fP priority for the election process .br \fIgroup\fP standby group .br @@ -1544,7 +1544,7 @@ Builds an IP version 4 RFC 792 Internet Control Message Protocol (ICMP) echo req .br \fIcode\fP code of ICMP packet (should be 0) .br -\fIsum\fP checksum (0 for libnet to autofill) +\fIsum\fP checksum (0 for libnet to auto-fill) .br \fIid\fP identification number .br @@ -1579,7 +1579,7 @@ Builds an IP version 4 RFC 792 Internet Control Message Protocol (ICMP) IP netma .br \fIcode\fP code of ICMP packet (should be 0) .br -\fIsum\fP checksum (0 for libnet to autofill) +\fIsum\fP checksum (0 for libnet to auto-fill) .br \fIid\fP identification number .br @@ -1616,7 +1616,7 @@ Builds an IP version 4 RFC 792 Internet Message Control Protocol (ICMP) redirect .br \fIcode\fP code of ICMP packet (should be one of the four redirect codes) .br -\fIsum\fP checksum (0 for libnet to autofill) +\fIsum\fP checksum (0 for libnet to auto-fill) .br \fIgateway\fP .br @@ -1649,7 +1649,7 @@ Builds an IP version 4 RFC 792 Internet Control Message Protocol (ICMP) time exc .br \fIcode\fP code of ICMP packet (ICMP_TIMXCEED_INTRANS / ICMP_TIMXCEED_REASS) .br -\fIsum\fP checksum (0 for libnet to autofill) +\fIsum\fP checksum (0 for libnet to auto-fill) .br \fIpayload\fP optional payload or NULL .br @@ -1682,7 +1682,7 @@ Builds an IP version 4 RFC 792 Internet Control Message Protocol (ICMP) timestam .br \fIcode\fP code of ICMP packet (should be 0) .br -\fIsum\fP checksum (0 for libnet to autofill) +\fIsum\fP checksum (0 for libnet to auto-fill) .br \fIid\fP identification number .br @@ -1723,7 +1723,7 @@ Builds an IP version 4 RFC 792 Internet Control Message Protocol (ICMP) unreacha .br \fIcode\fP code of ICMP packet (should be one of the 16 unreachable codes) .br -\fIsum\fP checksum (0 for libnet to autofill) +\fIsum\fP checksum (0 for libnet to auto-fill) .br \fIpayload\fP optional payload or NULL .br @@ -1754,7 +1754,7 @@ Builds an IP version 6 RFC 4443 Internet Control Message Protocol (ICMP) echo or .br \fIcode\fP code of ICMP packet (should be zero) .br -\fIsum\fP checksum (0 for libnet to autofill) +\fIsum\fP checksum (0 for libnet to auto-fill) .br \fIid\fP echo id number .br @@ -1789,7 +1789,7 @@ Builds an IP version 6 RFC 2461 Internet Control Message Protocol (ICMP) NDP nei .br \fIcode\fP code of ICMP packet (should be zero) .br -\fIsum\fP checksum (0 for libnet to autofill) +\fIsum\fP checksum (0 for libnet to auto-fill) .br \fIflags\fP should be a bitwise or of any applicable ND_NA_FLAG_* flags .br @@ -1824,7 +1824,7 @@ Builds an IP version 6 RFC 2461 Internet Control Message Protocol (ICMP) NDP nei .br \fIcode\fP code of ICMP packet (should be zero) .br -\fIsum\fP checksum (0 for libnet to autofill) +\fIsum\fP checksum (0 for libnet to auto-fill) .br \fItarget\fP target ipv6 address .br @@ -1884,7 +1884,7 @@ Builds an IP version 6 RFC 4443 Internet Control Message Protocol (ICMP) unreach .br \fIcode\fP code of ICMP packet (should be one of the 5 ICMP6_DST_UNREACH_* codes) .br -\fIsum\fP checksum (0 for libnet to autofill) +\fIsum\fP checksum (0 for libnet to auto-fill) .br \fIpayload\fP optional payload or NULL .br @@ -1907,7 +1907,7 @@ protocol tag value on success .PP .SS "LIBNET_API libnet_ptag_t libnet_build_igmp (uint8_t type, uint8_t reserved, uint16_t sum, uint32_t ip, const uint8_t * payload, uint32_t payload_s, libnet_t * l, libnet_ptag_t ptag)" -Builds an RFC 1112 Internet Group Memebership Protocol (IGMP) header\&. +Builds an RFC 1112 Internet Group Membership Protocol (IGMP) header\&. .PP \fBParameters:\fP .RS 4 @@ -1915,7 +1915,7 @@ Builds an RFC 1112 Internet Group Memebership Protocol (IGMP) header\&. .br \fIreserved\fP (should be 0 for IGMPv1) .br -\fIsum\fP checksum (0 for libnet to autofill) +\fIsum\fP checksum (0 for libnet to auto-fill) .br \fIip\fP IPv4 address (in standard/network byte order) .br @@ -2060,7 +2060,7 @@ Builds a version 4 RFC 791 Internet Protocol (IP) header\&. .br \fIprot\fP upper layer protocol .br -\fIsum\fP checksum (0 for libnet to autofill) +\fIsum\fP checksum (0 for libnet to auto-fill) .br \fIsrc\fP source IPv4 address (little endian) .br @@ -2291,7 +2291,7 @@ Builds a Cisco Inter-Switch Link (ISL) header\&. .br \fIshost\fP source mac address .br -\fIlen\fP total length of the encapuslated packet less 18 bytes +\fIlen\fP total length of the encapsulated packet less 18 bytes .br \fIsnap\fP SNAP information (0xaaaa03 + vendor code) .br @@ -2424,7 +2424,7 @@ Builds an RFC 958 Network Time Protocol (NTP) header\&. .br \fIrec_ts_int\fP receiver timestamp integer .br -\fIrec_ts_frac\fP reciever timestamp fraction +\fIrec_ts_frac\fP receiver timestamp fraction .br \fIxmt_ts_int\fP transmit timestamp integer .br @@ -3065,7 +3065,7 @@ Builds an RFC 793 Transmission Control Protocol (TCP) header\&. .br \fIwin\fP window size .br -\fIsum\fP checksum (0 for libnet to autofill) +\fIsum\fP checksum (0 for libnet to auto-fill) .br \fIurg\fP urgent pointer .br @@ -3170,7 +3170,7 @@ Builds an RFC 768 User Datagram Protocol (UDP) header\&. .br \fIlen\fP total length of the UDP packet .br -\fIsum\fP checksum (0 for libnet to autofill) +\fIsum\fP checksum (0 for libnet to auto-fill) .br \fIpayload\fP optional payload or NULL .br @@ -3193,7 +3193,7 @@ protocol tag value on success .PP .SS "LIBNET_API libnet_ptag_t libnet_build_vrrp (uint8_t version, uint8_t type, uint8_t vrouter_id, uint8_t priority, uint8_t ip_count, uint8_t auth_type, uint8_t advert_int, uint16_t sum, const uint8_t * payload, uint32_t payload_s, libnet_t * l, libnet_ptag_t ptag)" -Builds an RFC 2338 Virtual Router Redundacy Protool (VRRP) header\&. Use the payload interface to specify address and autthentication information\&. To build a 'legal' packet, the destination IPv4 address should be the multicast * address 224\&.0\&.0\&.18, the IP TTL should be set to 255, and the IP protocol should be set to 112\&. +Builds an RFC 2338 Virtual Router Redundacy Protool (VRRP) header\&. Use the payload interface to specify address and authentication information\&. To build a 'legal' packet, the destination IPv4 address should be the multicast * address 224\&.0\&.0\&.18, the IP TTL should be set to 255, and the IP protocol should be set to 112\&. .PP \fBParameters:\fP .RS 4 @@ -3486,7 +3486,7 @@ Returns the IPv6 address for the device libnet was initialized with\&. If libnet .PP .SS "LIBNET_API uint32_t libnet_get_prand (int mod)" -Generates an unsigned psuedo-random value within the range specified by mod\&. LIBNET_PR2 0 - 1 LIBNET_PR8 0 - 255 LIBNET_PR16 0 - 32767 LIBNET_PRu16 0 - 65535 LIBNET_PR32 0 - 2147483647 LIBNET_PRu32 0 - 4294967295 +Generates an unsigned pseudo-random value within the range specified by mod\&. LIBNET_PR2 0 - 1 LIBNET_PR8 0 - 255 LIBNET_PR16 0 - 32767 LIBNET_PRu16 0 - 65535 LIBNET_PR32 0 - 2147483647 LIBNET_PRu32 0 - 4294967295 .PP \fBParameters:\fP .RS 4 @@ -3525,7 +3525,7 @@ Returns the last error set inside of the referenced libnet context\&. This funct .PP \fBReturns:\fP .RS 4 -an error string or NULL if no error has occured +an error string or NULL if no error has occurred .RE .PP @@ -3563,7 +3563,7 @@ size .PP .SS "LIBNET_API uint32_t libnet_getpacket_size (libnet_t * l)" -Returns the sum of the size of all of the pblocks inside of l (this should be the resuling packet size)\&. +Returns the sum of the size of all of the pblocks inside of l (this should be the resulting packet size)\&. .PP \fBParameters:\fP .RS 4 @@ -3792,7 +3792,7 @@ Returns the next port list chain pair from the port list chain plist\&. bport an .PP .SS "LIBNET_API int libnet_seed_prand (libnet_t * l)" -Seeds the psuedo-random number generator\&. +Seeds the pseudo-random number generator\&. .PP \fBParameters:\fP .RS 4 @@ -3819,7 +3819,7 @@ Fills in a libnet_stats structure with packet injection statistics (packets writ .PP .SS "LIBNET_API int libnet_toggle_checksum (libnet_t * l, libnet_ptag_t ptag, int mode)" -If a given protocol header is built with the checksum field set to '0', by default libnet will calculate the header checksum prior to injection\&. If the header is set to any other value, by default libnet will not calculate the header checksum\&. To over-ride this behavior, use \fBlibnet_toggle_checksum()\fP\&. Switches auto-checksumming on or off for the specified ptag\&. If mode is set to LIBNET_ON, libnet will mark the specificed ptag to calculate a checksum for the ptag prior to injection\&. This assumes that the ptag refers to a protocol that has a checksum field\&. If mode is set to LIBNET_OFF, libnet will clear the checksum flag and no checksum will be computed prior to injection\&. This assumes that the programmer will assign a value (zero or otherwise) to the checksum field\&. Often times this is useful if a precomputed checksum or some other predefined value is going to be used\&. Note that when libnet is initialized with LIBNET_RAW4, the IPv4 header checksum will always be computed by the kernel prior to injection, regardless of what the programmer sets\&. +If a given protocol header is built with the checksum field set to '0', by default libnet will calculate the header checksum prior to injection\&. If the header is set to any other value, by default libnet will not calculate the header checksum\&. To over-ride this behavior, use \fBlibnet_toggle_checksum()\fP\&. Switches auto-checksumming on or off for the specified ptag\&. If mode is set to LIBNET_ON, libnet will mark the specified ptag to calculate a checksum for the ptag prior to injection\&. This assumes that the ptag refers to a protocol that has a checksum field\&. If mode is set to LIBNET_OFF, libnet will clear the checksum flag and no checksum will be computed prior to injection\&. This assumes that the programmer will assign a value (zero or otherwise) to the checksum field\&. Often times this is useful if a precomputed checksum or some other predefined value is going to be used\&. Note that when libnet is initialized with LIBNET_RAW4, the IPv4 header checksum will always be computed by the kernel prior to injection, regardless of what the programmer sets\&. .PP \fBParameters:\fP .RS 4 @@ -3866,9 +3866,9 @@ the number of bytes written .RE .PP --e .SH "SEE ALSO" +.SH "SEE ALSO" \.IX Header "SEE ALSO" -libnet(3), libnet\-config(1) +libnet(3) .SH "AUTHORS" .IX Header "AUTHORS" The original author of libnet is Mike D. Schiffman. diff --git a/doc/man/man3/libnet-macros.3 b/doc/man/man3/libnet-macros.3 index ddaef31..6dd4850 100644 --- a/doc/man/man3/libnet-macros.3 +++ b/doc/man/man3/libnet-macros.3 @@ -1,4 +1,4 @@ -.TH "libnet-macros.h" 3 "Sat Sep 28 2019" "libnet-1.1" "libnet Programmers Guide" \" -*- nroff -*- +.TH "libnet-macros.h" 3 "Sun Sep 29 2019" "libnet-1.2-rc3" "libnet Programmers Guide" \" -*- nroff -*- .ad l .nh .SH NAME @@ -75,9 +75,9 @@ Used several places, to specify 'on' or 'one' Used for \fBlibnet_get_prand()\fP to specify function disposition .SS "#define LIBNET_RESOLVE 1" Used for libnet's name resolution functions, specifies that a DNS lookup can be performed if needed to resolve the IP address to a canonical form\&. --e .SH "SEE ALSO" +.SH "SEE ALSO" \.IX Header "SEE ALSO" -libnet(3), libnet\-config(1) +libnet(3) .SH "AUTHORS" .IX Header "AUTHORS" The original author of libnet is Mike D. Schiffman. diff --git a/doc/man/man3/libnet.3 b/doc/man/man3/libnet.3 index 00a7bca..9c3b955 100644 --- a/doc/man/man3/libnet.3 +++ b/doc/man/man3/libnet.3 @@ -133,7 +133,7 @@ .\" ======================================================================== .\" .IX Title "LIBNET 3" -.TH LIBNET 3 "lör sep 28 2019" "libnet-1.2-rc3" "libnet Programmers Guide" +.TH LIBNET 3 "sön sep 29 2019" "libnet-1.2-rc3" "libnet Programmers Guide" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l |