Documentation/Manpages/netsniff-ng.8

   1 =head1 NAME
   2
   3 netsniff-ng - the packet sniffing beast
   4
   5 =head1 SYNOPSIS
   6
   7 netsniff-ng -i|-d|--dev|--in <dev|pcap> -o|--out <dev|pcap|dir|txf>
   8 [-f|--filter <bpf-file>][-t|--type <type>][-F|--interval <uint>]
   9 [-s|--silent][-J|--jumbo-support][-n|--num <uint>][-r|--rand]
  10 [-M|--no-promisc][-m|--mmap | -c|--clrw][-S|--ring-size <size>]
  11 [-k|--kernel-pull <uint>][-b|--bind-cpu <cpu> | -B|--unbind-cpu <cpu>]
  12 [-H|--prio-high][-Q|--notouch-irq][-q|--less | -X|--hex | -l|--ascii]
  13 [-v|--version][-h|--help]
  14
  15 =head1 DESCRIPTION
  16
  17 The first sniffer that invoked both, the zero-copy RX_RING as well as
  18 the zero-copy TX_RING for high-performance network I/O and scatter/gather
  19 or mmaped PCAP I/O.
  20
  21 =head1 EXAMPLES
  22
  23 =over
  24
  25 =item netsniff-ng --in eth0 --out dump.pcap
  26
  27 Capture traffic from interface 'eth0' and save it pcap file 'dump.pcap'
  28
  29 =item netsniff-ng --in any --filter http.bpf --payload
  30
  31 Capture HTTP traffic from any interface and print its payload on stdout
  32
  33 =item netsniff-ng --in wlan0 --bind-cpu 0,1
  34
  35 Capture all traffic from wlan0 interface.
  36 Schedule process on CPU 0 and 1.
  37
  38 =back
  39
  40 =head1 OPTIONS
  41
  42 =over
  43
  44 =item -i|-d|--dev|--in <dev|pcap>
  45
  46 Input source. Can be a network device or pcap file.
  47
  48 =item -o|--out <dev|pcap|dir|txf>
  49
  50 Output sink. Can be a network device, pcap file, a trafgen txf file or a
  51 directory. (There's only pcap to txf translation possible.)
  52
  53 =item -f|--filter <bpf-file>
  54
  55 Use BPF filter file from bpfc.
  56
  57 =item -t|--type <type>
  58
  59 =over
  60
  61 =item Only handle packets of defined type:
  62
  63 =over
  64
  65 =item - broadcast
  66
  67 =item - multicast
  68
  69 =item - others
  70
  71 =item - outgoing
  72
  73 =back
  74
  75 =back
  76
  77 =item -F|--interval <uint>
  78
  79 Dump interval in seconds. if -o is a directory, a new pcap will be created at each interval.
  80 The older files are left untouched. (default value: 60 seconds)
  81
  82 =item -s|--silent
  83
  84 Do not print captured packets to stdout.
  85
  86 =item -J|--jumbo-support
  87
  88 Support for 64KB Super Jumbo Frames.
  89
  90 =item -n|--num <uint>
  91
  92 When zerp, capture/replay until SIGINT is received (default).
  93 When non-zero, capture/replay the number of packets.
  94
  95 =item -r|--rand
  96
  97 Randomize packet forwarding order (replay mode only).
  98
  99 =item -M|--no-promisc
 100
 101 Do not place the interface in promiscuous mode.
 102
 103 =item -m|--mmap
 104
 105 Mmap pcap file i.e., for replaying. Default: scatter/gather I/O.
 106
 107 =item -c|--clrw
 108
 109 Instead of using scatter/gather I/O use slower read(2)/write(2) I/O.
 110
 111 =item -S|--ring-size <size>
 112
 113 Manually set ring size in KB/MB/GB, e.g. '10MB'.
 114
 115 =item -k|--kernel-pull <uint>
 116
 117 Kernel pull from user interval in microseconds. Default is 10us. (replay mode only).
 118
 119 =item -b|--bind-cpu <cpu>
 120
 121 Bind to specific CPU (or CPU-range).
 122
 123 =item -B|--unbind-cpu <cpu>
 124
 125 Forbid to use specific CPU (or CPU-range).
 126
 127 =item -H|--prio-high
 128
 129 Run the process in high-priority mode.
 130
 131 =item -Q|--notouch-irq
 132
 133 Do not touch IRQ CPU affinity of NIC.
 134
 135 =item -q|--less
 136
 137 Print less-verbose packet information.
 138
 139 =item -X|--hex
 140
 141 Print packet data in hex format.
 142
 143 =item -l|--ascii
 144
 145 Print human-readable packet data.
 146
 147 =item -v|--version
 148
 149 Print version.
 150
 151 =item -h|--help
 152
 153 Print help text and lists all options.
 154
 155 =back
 156
 157 =head1 AUTHOR
 158
 159 Written by Daniel Borkmann <daniel@netsniff-ng.org> and Emmanuel Roullit <emmanuel@netsniff-ng.org>
 160
 161 =head1 DOCUMENTATION
 162
 163 Documentation by Emmanuel Roullit <emmanuel@netsniff-ng.org>
 164
 165 =head1 BUGS
 166
 167 Please report bugs to <bugs@netsniff-ng.org>
 168
 169 =cut