index

Documentation

Index

• Variables
• func New(parent charm.Command, f *flag.FlagSet) (charm.Command, error)
• type Command
  • func (c *Command) Run(args []string) (err error)
  • func (c *Command) Warn(msg string) error

Variables

var Index = &charm.Spec{
	Name:  "index",
	Usage: "index [options]",
	Short: "creates time index files for pcaps for use by pcap slice",
	Long: `
The index command creates a time index for a pcap file.  The pcap file is not
modified or copied.

Roughly speaking, the index is a list of slots that represents
a seek offset and time range covered by the packets starting at the offset
and ending at the seek offset specified in the next slot.  It also includes
offset information for section and interface headers for pcap-ng format so
all blocks with referenced metadata are included in the output pcap.

The number of index slots is bounded by -n argument (technically speaking,
the number of slots is computed by choosing D, the smallest
power-of-2 divisor of N, the number of packets in the pcap file, such that N / D
is less than or equal to the limit specified by -n).

The output is written in json format to standard output or if -x is specified,
to the indicate file.

If the -root flag is specified the pcap index will be written to a common
directory, then multiple pcaps can be searched in parallel using the brimcap
search command.
`,
	New: New,
}

Functions

func New

func New(parent charm.Command, f *flag.FlagSet) (charm.Command, error)

Types

type Command

type Command struct {
	*root.Command
	// contains filtered or unexported fields
}

func (*Command) Run

func (c *Command) Run(args []string) (err error)

func (*Command) Warn

func (c *Command) Warn(msg string) error

XXX this should log to json in root command -json flag is set