mirror of https://github.com/dirtbags/fluffy.git
added: man pages for all utilities
This commit is contained in:
pi-rho
parent
4fef3ee62d
commit
3695b6e3a2
|
|
@ -0,0 +1,77 @@
|
||||||
|
.TH "hdng" "1"
|
||||||
|
.SH "NAME"
|
||||||
|
hdng \(em a hex dumper for the next generation\)
|
||||||
|
.SH "SYNOPSIS"
|
||||||
|
.PP
|
||||||
|
\fBhdng\fR [ [\-oxsg] [\-w width] | [\-X] | [\-G] ] [FILE]
|
||||||
|
.SH "DESCRIPTION"
|
||||||
|
.PP
|
||||||
|
The basic concept for this utility is to emulate the base
|
||||||
|
functionality of a hex dumper as found in bsdmainutils while
|
||||||
|
providing better representation of the data. A special character set
|
||||||
|
is used so that one might better observe patterns in the data.
|
||||||
|
Additionally, the three areas of the hexdump (offsets, hexits,
|
||||||
|
glyphs) can be turned off and the width of data represented in each
|
||||||
|
line of data can be changed.
|
||||||
|
|
||||||
|
.SH "USAGE"
|
||||||
|
.IP "With a file specified" 10
|
||||||
|
\fBhdng\fR data.bin
|
||||||
|
|
||||||
|
.IP "As a filter" 10
|
||||||
|
... | \fBhdng\fR | ...
|
||||||
|
|
||||||
|
.SH "OPTIONS"
|
||||||
|
.PP
|
||||||
|
A summary of the options supported by \fBhdng\fR is included below.
|
||||||
|
|
||||||
|
.IP "\-o" 10
|
||||||
|
The optional \fI\-o\fP flag tells hdng to turn off offsets and
|
||||||
|
to not display the byte count at the end of execution
|
||||||
|
.IP "\-x" 10
|
||||||
|
The optional \fI\-x\fP flag tells hdng to turn off the display
|
||||||
|
of hexits
|
||||||
|
.IP "\-s" 10
|
||||||
|
The optional \fI\-s\fP flag tells hdng to not abbreviate
|
||||||
|
rendundant data
|
||||||
|
.IP "\-g" 10
|
||||||
|
The optional \fI\-g\fP flag tells hdng to turn off the display
|
||||||
|
of glyphs
|
||||||
|
.IP "\-w width" 10
|
||||||
|
The optional \fI\-w\fP \fIwidth\fP flag tells
|
||||||
|
hdng the width of data to represent on each line of
|
||||||
|
output
|
||||||
|
.IP "\-X" 10
|
||||||
|
The \fI\-X\fP flag turns on continuous
|
||||||
|
\fIhexdump\fP mode, which overrides all
|
||||||
|
other options
|
||||||
|
.IP "\-G" 10
|
||||||
|
The \fI\-G\fP flag turns on continuous
|
||||||
|
\fIglyphdump\fP mode, which overrides all
|
||||||
|
other options
|
||||||
|
.IP "FILE" 10
|
||||||
|
The file to be dumped
|
||||||
|
|
||||||
|
.SH "REQUIRES"
|
||||||
|
.PP
|
||||||
|
n/a
|
||||||
|
|
||||||
|
.SH "VERSION"
|
||||||
|
.PP
|
||||||
|
0.1337
|
||||||
|
|
||||||
|
.SH "BUGS"
|
||||||
|
.PP
|
||||||
|
n/a
|
||||||
|
|
||||||
|
.SH "SEE ALSO"
|
||||||
|
.PP
|
||||||
|
n/a
|
||||||
|
|
||||||
|
.SH "AUTHORS"
|
||||||
|
.PP
|
||||||
|
Zephyr zephyr@dirtbags.net
|
||||||
|
.PP
|
||||||
|
pi-rho pi-rho@tyr.cx
|
||||||
|
.PP
|
||||||
|
This man-page was written by pi-rho ubuntu@tyr.cx
|
||||||
|
|
@ -0,0 +1,53 @@
|
||||||
|
.TH "p4split" "1"
|
||||||
|
.SH "NAME"
|
||||||
|
p4split \(em split a PCAP based on CIDR
|
||||||
|
.SH "SYNOPSIS"
|
||||||
|
.PP
|
||||||
|
\fBp4split\fR [\-i INPUT] <CIDR>
|
||||||
|
|
||||||
|
.SH "DESCRIPTION"
|
||||||
|
.PP
|
||||||
|
The basic concept for this utility is to filter and split a PCAP packet capture
|
||||||
|
file into smaller files. This utility will create up to 256 smaller files.
|
||||||
|
|
||||||
|
.SH "USAGE"
|
||||||
|
.IP "As a filter" 10
|
||||||
|
... | \fBp4split\fR 192.168.1.0/24
|
||||||
|
|
||||||
|
.IP "Command mode" 10
|
||||||
|
\fBp4split\fR \-i big.pcap 192.168.1.0/24
|
||||||
|
|
||||||
|
.SH "OPTIONS"
|
||||||
|
.PP
|
||||||
|
A summary of the options supported by \fBp4split\fR is included below.
|
||||||
|
|
||||||
|
.IP "\-i INPUT" 10
|
||||||
|
When the \fB\-i\fR argument is specified, \fBINPUT\fR is used as input, instead
|
||||||
|
of stdin
|
||||||
|
|
||||||
|
.IP "CIDR" 10
|
||||||
|
A network address in CIDR notation (ad.dre.ss/subnet-bits)
|
||||||
|
|
||||||
|
.SH "REQUIRES"
|
||||||
|
.PP
|
||||||
|
n/a
|
||||||
|
|
||||||
|
.SH "VERSION"
|
||||||
|
.PP
|
||||||
|
0.1337
|
||||||
|
|
||||||
|
.SH "BUGS"
|
||||||
|
.PP
|
||||||
|
n/a
|
||||||
|
|
||||||
|
.SH "SEE ALSO"
|
||||||
|
.PP
|
||||||
|
n/a
|
||||||
|
|
||||||
|
.SH "AUTHORS"
|
||||||
|
.PP
|
||||||
|
Zephyr zephyr@dirtbags.net
|
||||||
|
.PP
|
||||||
|
pi-rho pi-rho@tyr.cx
|
||||||
|
.PP
|
||||||
|
This man-page was written by pi-rho ubuntu@tyr.cx
|
||||||
|
|
@ -0,0 +1,52 @@
|
||||||
|
.TH "pmerge" "1"
|
||||||
|
.SH "NAME"
|
||||||
|
pmerge \(em merge multiple PCAP files in timeline order
|
||||||
|
.SH "SYNOPSIS"
|
||||||
|
.PP
|
||||||
|
\fBpmerge\fR [\-o OUTPUT] <FILE> [FILE]*
|
||||||
|
.SH "DESCRIPTION"
|
||||||
|
.PP
|
||||||
|
The basic concept for this utility is to merge multiple PCAP files while
|
||||||
|
maintaining timeline order.
|
||||||
|
|
||||||
|
.SH "USAGE"
|
||||||
|
.IP "As a filter" 10
|
||||||
|
\fBpmerge\fR one.pcap two.pcap > merged.pcap
|
||||||
|
|
||||||
|
.IP "In simple command form" 10
|
||||||
|
\fBpmerge\fR \-o merged.pcap one.pcap two.pcap
|
||||||
|
|
||||||
|
.SH "OPTIONS"
|
||||||
|
.PP
|
||||||
|
A summary of the options supported by \fBpmerge\fR is included below.
|
||||||
|
|
||||||
|
.IP "\-o OUTPUT" 10
|
||||||
|
The \fB\-o\fR command flag sets the output filename. If this option flag is not
|
||||||
|
specified, stdout is used to output the merged PCAP.
|
||||||
|
|
||||||
|
.IP "FILE" 10
|
||||||
|
At least one input file argument is required.
|
||||||
|
|
||||||
|
.SH "REQUIRES"
|
||||||
|
.PP
|
||||||
|
n/a
|
||||||
|
|
||||||
|
.SH "VERSION"
|
||||||
|
.PP
|
||||||
|
0.1337
|
||||||
|
|
||||||
|
.SH "BUGS"
|
||||||
|
.PP
|
||||||
|
n/a
|
||||||
|
|
||||||
|
.SH "SEE ALSO"
|
||||||
|
.PP
|
||||||
|
n/a
|
||||||
|
|
||||||
|
.SH "AUTHORS"
|
||||||
|
.PP
|
||||||
|
Zephyr zephyr@dirtbags.net
|
||||||
|
.PP
|
||||||
|
pi-rho pi-rho@tyr.cx
|
||||||
|
.PP
|
||||||
|
This man-page was written by pi-rho ubuntu@tyr.cx
|
||||||
|
|
@ -0,0 +1,52 @@
|
||||||
|
.TH "puniq" "1"
|
||||||
|
.SH "NAME"
|
||||||
|
puniq \(em filter one to many PCAP files for unique frames
|
||||||
|
.SH "SYNOPSIS"
|
||||||
|
.PP
|
||||||
|
\fBpuniq\fR [\-o OUTPUT] <FILE> [FILE]*
|
||||||
|
.SH "DESCRIPTION"
|
||||||
|
.PP
|
||||||
|
The basic concept for this utility is to filter one to many PCAP files for
|
||||||
|
unique frames
|
||||||
|
|
||||||
|
.SH "USAGE"
|
||||||
|
.IP "As a filter" 10
|
||||||
|
\fBpuniq\fR one.pcap two.pcap > unique.pcap
|
||||||
|
|
||||||
|
.IP "In simple command form" 10
|
||||||
|
\fBpuniq\fR \-o unique.pcap one.pcap two.pcap
|
||||||
|
|
||||||
|
.SH "OPTIONS"
|
||||||
|
.PP
|
||||||
|
A summary of the options supported by \fBpuniq\fR is included below.
|
||||||
|
|
||||||
|
.IP "\-o OUTPUT" 10
|
||||||
|
The \fB\-o\fR command flag sets the output filename. If this option flag is not
|
||||||
|
specified, stdout is used to output the merged PCAP.
|
||||||
|
|
||||||
|
.IP "FILE" 10
|
||||||
|
At least one input file argument is required.
|
||||||
|
|
||||||
|
.SH "REQUIRES"
|
||||||
|
.PP
|
||||||
|
n/a
|
||||||
|
|
||||||
|
.SH "VERSION"
|
||||||
|
.PP
|
||||||
|
0.1337
|
||||||
|
|
||||||
|
.SH "BUGS"
|
||||||
|
.PP
|
||||||
|
n/a
|
||||||
|
|
||||||
|
.SH "SEE ALSO"
|
||||||
|
.PP
|
||||||
|
n/a
|
||||||
|
|
||||||
|
.SH "AUTHORS"
|
||||||
|
.PP
|
||||||
|
Zephyr zephyr@dirtbags.net
|
||||||
|
.PP
|
||||||
|
pi-rho pi-rho@tyr.cx
|
||||||
|
.PP
|
||||||
|
This man-page was written by pi-rho ubuntu@tyr.cx
|
||||||
|
|
@ -0,0 +1,44 @@
|
||||||
|
.TH "repr" "1"
|
||||||
|
.SH "NAME"
|
||||||
|
repr \(em escape unprintable characters\)
|
||||||
|
.SH "SYNOPSIS"
|
||||||
|
.PP
|
||||||
|
\fBrepr\fR [FILE]
|
||||||
|
.SH "DESCRIPTION"
|
||||||
|
.PP
|
||||||
|
The basic concept for this utility is to emulate python's repr() function
|
||||||
|
|
||||||
|
.SH "USAGE"
|
||||||
|
.IP "With a file specified" 10
|
||||||
|
\fBrepr\fR data.bin
|
||||||
|
|
||||||
|
.IP "As a filter" 10
|
||||||
|
... | \fBrepr\fR | ...
|
||||||
|
|
||||||
|
.SH "OPTIONS"
|
||||||
|
.PP
|
||||||
|
n/a
|
||||||
|
|
||||||
|
.SH "REQUIRES"
|
||||||
|
.PP
|
||||||
|
n/a
|
||||||
|
|
||||||
|
.SH "VERSION"
|
||||||
|
.PP
|
||||||
|
0.1337
|
||||||
|
|
||||||
|
.SH "BUGS"
|
||||||
|
.PP
|
||||||
|
n/a
|
||||||
|
|
||||||
|
.SH "SEE ALSO"
|
||||||
|
.PP
|
||||||
|
n/a
|
||||||
|
|
||||||
|
.SH "AUTHORS"
|
||||||
|
.PP
|
||||||
|
Zephyr zephyr@dirtbags.net
|
||||||
|
.PP
|
||||||
|
pi-rho pi-rho@tyr.cx
|
||||||
|
.PP
|
||||||
|
This man-page was written by pi-rho ubuntu@tyr.cx
|
||||||
|
|
@ -0,0 +1,45 @@
|
||||||
|
.TH "unhex" "1"
|
||||||
|
.SH "NAME"
|
||||||
|
unhex \(em translate hexits to their binary equivalent\)
|
||||||
|
.SH "SYNOPSIS"
|
||||||
|
.PP
|
||||||
|
\fBunhex\fR [FILE]
|
||||||
|
.SH "DESCRIPTION"
|
||||||
|
.PP
|
||||||
|
The basic concept for this utility is to translate hexits (00-ff) to their binary
|
||||||
|
equivalent.
|
||||||
|
|
||||||
|
.SH "USAGE"
|
||||||
|
.IP "With a file specified" 10
|
||||||
|
\fBunhex\fR data.bin
|
||||||
|
|
||||||
|
.IP "As a filter" 10
|
||||||
|
... | \fBunhex\fR | ...
|
||||||
|
|
||||||
|
.SH "OPTIONS"
|
||||||
|
.PP
|
||||||
|
n/a
|
||||||
|
|
||||||
|
.SH "REQUIRES"
|
||||||
|
.PP
|
||||||
|
n/a
|
||||||
|
|
||||||
|
.SH "VERSION"
|
||||||
|
.PP
|
||||||
|
0.1337
|
||||||
|
|
||||||
|
.SH "BUGS"
|
||||||
|
.PP
|
||||||
|
n/a
|
||||||
|
|
||||||
|
.SH "SEE ALSO"
|
||||||
|
.PP
|
||||||
|
n/a
|
||||||
|
|
||||||
|
.SH "AUTHORS"
|
||||||
|
.PP
|
||||||
|
Zephyr zephyr@dirtbags.net
|
||||||
|
.PP
|
||||||
|
pi-rho pi-rho@tyr.cx
|
||||||
|
.PP
|
||||||
|
This man-page was written by pi-rho ubuntu@tyr.cx
|
||||||
|
|
@ -0,0 +1,50 @@
|
||||||
|
.TH "xor" "1"
|
||||||
|
.SH "NAME"
|
||||||
|
xor \(em apply mask bytes to a stream using XOR
|
||||||
|
.SH "SYNOPSIS"
|
||||||
|
.PP
|
||||||
|
\fBxor\fR [\-x] <MASK>*
|
||||||
|
.SH "DESCRIPTION"
|
||||||
|
.PP
|
||||||
|
The basic concept for this utility is to apply a set of mask bytes, repeatedly,
|
||||||
|
to a stream of input. The application of the mask bytes is accomplished using
|
||||||
|
the bitwise XOR operation.
|
||||||
|
|
||||||
|
.SH "USAGE"
|
||||||
|
.IP "As a filter" 10
|
||||||
|
... | \fBxor\fR \-x 20 2f | ...
|
||||||
|
|
||||||
|
.SH "OPTIONS"
|
||||||
|
.PP
|
||||||
|
A summary of the options supported by \fBxor\fR is included below.
|
||||||
|
|
||||||
|
.IP "\-x" 10
|
||||||
|
The optional \fI\-x\fP flag tells xor that mask bytes are specified in
|
||||||
|
hexadecimal notation
|
||||||
|
|
||||||
|
.IP "MASK" 10
|
||||||
|
This represents a list of mask bytes to apply to the input stream. Bytes should
|
||||||
|
be listed in decimal, unless the optional \fI\-x\fR flag is
|
||||||
|
given.
|
||||||
|
|
||||||
|
.SH "REQUIRES"
|
||||||
|
.PP
|
||||||
|
n/a
|
||||||
|
|
||||||
|
.SH "VERSION"
|
||||||
|
.PP
|
||||||
|
0.1337
|
||||||
|
|
||||||
|
.SH "BUGS"
|
||||||
|
.PP
|
||||||
|
n/a
|
||||||
|
|
||||||
|
.SH "SEE ALSO"
|
||||||
|
.PP
|
||||||
|
n/a
|
||||||
|
|
||||||
|
.SH "AUTHORS"
|
||||||
|
.PP
|
||||||
|
Zephyr zephyr@dirtbags.net
|
||||||
|
.PP
|
||||||
|
This man-page was written by pi-rho ubuntu@tyr.cx
|
||||||
Loading…
Reference in New Issue