update man pages

This commit is contained in:
pi-rho 2013-02-05 12:57:34 -06:00
parent 7af0d0e4ba
commit 4ef7224d24
8 changed files with 214 additions and 184 deletions

View File

@ -16,19 +16,19 @@
.\" On Debian systems, the complete text of the GNU General .\" On Debian systems, the complete text of the GNU General
.\" Public License version 3 can be found in "/usr/share/common-licenses/GPL-3". .\" Public License version 3 can be found in "/usr/share/common-licenses/GPL-3".
. .
.Dd March 3, 2012 .Dd May 23, 2012
.Dt HDNG 1 .Dt HDNG 1
.Os "network reverse engineering toolkit" .Os "Network Reverse Engineering Toolkit" 1.1337
.
.Sh NAME .Sh NAME
.Nm hdng .Nm hdng
.Nd a hex dumper for the next generation .Nd a hex dumper for the next generation
. .
.Sh SYNOPSIS .Sh SYNOPSIS
.Nm hdng .Nm hdng
.Oo Fl h | Fl v Oc .Op Fl h | Fl v
.Nm hdng .Nm hdng
.Op Fl oxsg .Op Fl o x s g w Ar width
.Op Fl w Ar width
.Op Ar file .Op Ar file
.Nm hdng .Nm hdng
.Op Fl X | Fl G .Op Fl X | Fl G
@ -36,24 +36,16 @@
. .
.Sh DESCRIPTION .Sh DESCRIPTION
The basic concept for this utility is to emulate the base functionality of a hex 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 dumper as found in bsdmainutil's
data. A special character set is used so that one might better observe patterns .Xr hexdump 1
in the data. Additionally, the three areas of the hexdump (offsets, hexits, while providing better representation of the data. A special character set is
glyphs) can be turned off and the width of data represented in each line of data used so that one might better observe patterns in the data. Additionally,
can be changed. 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
With a file specified
.D1 Nm hdng Pa data.bin
.Pp .Pp
As a filter The available options include:
.D1 ... | Nm hdng | ... .Pp
. .Bl -tag -compact -width Ds
.Sh OPTIONS
A summary of the options supported by
.Nm
is included below.
.Bl -tag -width -Ds
.It Fl h .It Fl h
usage information usage information
.It Fl v .It Fl v
@ -70,30 +62,41 @@ do not display glyphs
the the
.Em width .Em width
of data to represent on each line of output of data to represent on each line of output
.It Ar file
the file to be dumped
.El .El
. .
.Ss Special Modes .Ss Special Modes
The following flags are mutually exclusive. When specified, The following flags are mutually exclusive. When specified,
.Nm .Nm
ignores all other flags. ignores all other flags.
.Bl -tag -width Ds .Pp
.Bl -tag -compact -width Ds
.It Fl X .It Fl X
turns on continuous turns on continuous
.Em hexdump .Em hexdump
mode, which overrides all other options mode
.It Fl G .It Fl G
turns on continuous turns on continuous
.Em glyphdump .Em glyphdump
mode, which overrides all other options mode
.El .El
. .
.Sh EXAMPLES
With a file specified
.D1 Ic $ Nm hdng Pa data.bin
.Pp
As a filter
.D1 Ic $ No ... | Nm hdng | No ...
.
.Sh SEE ALSO .Sh SEE ALSO
.Xr unhex 1 , .Xr hexdump 1 ,
.Xr repr 1 , .Xr repr 1 ,
.Xr unhex 1 ,
.Xr xor 1 .Xr xor 1
. .
.Sh AUTHORS .Sh AUTHORS
.An Zephyr Aq Ad zephyr@dirtbags.net , .An Zephyr Aq Ad zephyr@dirtbags.net ,
.An pi-rho Aq Ad pi-rho@tyr.cx .An pi-rho Aq Ad pi-rho@tyr.cx
.
.Sh BUGS
Bugs may be submitted at
.Aq Ad https://bugs.launchpad.net/netre-tools

View File

@ -16,9 +16,10 @@
.\" On Debian systems, the complete text of the GNU General .\" On Debian systems, the complete text of the GNU General
.\" Public License version 3 can be found in "/usr/share/common-licenses/GPL-3". .\" Public License version 3 can be found in "/usr/share/common-licenses/GPL-3".
. .
.Dd May 1, 2012 .Dd May 23, 2012
.Dt NETRE-TOOLS 7 .Dt NETRE-TOOLS 7
.Os "Network Reverse Engineering Toolkit" .Os "Network Reverse Engineering Toolkit" 1.1337
.
.Sh NAME .Sh NAME
.Nm netre-tools .Nm netre-tools
.Nd network reverse engineering toolkit .Nd network reverse engineering toolkit
@ -37,49 +38,67 @@ the gaps left by more complex tools.
. .
.Sh IMPLEMENTATION NOTES .Sh IMPLEMENTATION NOTES
The following tools are currently included in the toolkit: The following tools are currently included in the toolkit:
.
.Ss Data Inspection and Manipulation .Ss Data Inspection and Manipulation
This subgroup aids in inspecting data and manipulating data. This subgroup aids in inspecting data and manipulating data.
.Pp .Pp
.Bl -tag -width caesar -compact .Bl -tag -width caesar -compact
.It Nm hdng
Hex Dumper - Next Generation (also symbolically linked as
.Nm hd )
.It Nm unhex
converts hexits to binary data (i.e. "61 62" \(rA "AB")
.It Nm xor
applies bytes to the pipeline using XOR
.It Nm rot
applies bytes to the pipeline using ROT (bitwise rotation)
.It Nm rol
applies bytes to the pipeline using ROL (bytewise rotation)
.It Nm caesar .It Nm caesar
applies bytes to the pipeline using Caesar's Cipher (alphabetic rotation) applies bytes to the pipeline using Caesar's Cipher (alphabetic rotation)
.It Nm hdng
Hex Dumper - Next Generation
.Pq also symbolically linked as Nm hd
.It Nm repr
escapes non-printable characters like Python's
.Fn repr
.Pq i.e. Li 0x03 becomes Li \ex03
.It Nm rol
applies bytes to the pipeline using ROL (bytewise rotation)
.It Nm rot
applies bytes to the pipeline using ROT (bitwise rotation)
.It Nm unhex
converts hexits to binary data
.Pq i.e. Qo Li 61 62 Qc becomes Qo Li AB Qc
.It Nm xor
applies bytes to the pipeline using XOR
.El .El
. .
.Ss PCAP Manipulation .Ss Packet Capture Manipulation
This subgroup allows frames in PCAP (packet capture) files to be manipulated This subgroup allows frames in PCAP (packet capture) files to be manipulated
from the command line. from the command line.
.Pp .Pp
.Bl -tag -width p4split -compact .Bl -tag -width dumbdecode -compact
.It Nm p4split .It Nm pcat
split a large PCAP file into smaller files, using a CIDR-notation filter dump a packet capture in a line-based, parsable format
.It Nm pmerge .It Nm pmerge
join PCAP files into a larger file while preserving date/time order join PCAP files into a larger file while preserving date/time order
.It Nm puniq .It Nm puniq
drop duplicated packets from a PCAP drop duplicated packets from a PCAP
.It Nm p4split
split a large PCAP file into smaller files, using a CIDR-notation filter
.It Nm dumbdecode
dump packet captures in a nice text-based display
.El .El
. .
.Sh SEE ALSO .Sh SEE ALSO
.Xr hdng 1 ,
.Xr unhex 1 ,
.Xr xor 1 ,
.Xr rot 1 ,
.Xr rol 1 ,
.Xr caesar 1 , .Xr caesar 1 ,
.Xr dumbdecode 1 ,
.Xr hdng 1 ,
.Xr p4split 1 , .Xr p4split 1 ,
.Xr pcat 1 ,
.Xr pmerge 1 , .Xr pmerge 1 ,
.Xr puniq 1 .Xr puniq 1 ,
.Xr repr 1 ,
.Xr rol 1 ,
.Xr rot 1 ,
.Xr unhex 1 ,
.Xr xor 1
. .
.Sh AUTHORS .Sh AUTHORS
.An Xephyr Aq Ad zephyr@dirtbags.net , .An Xephyr Aq Ad zephyr@dirtbags.net ,
.An pi-rho Aq Ad pi-rho@tyr.cx .An pi-rho Aq Ad pi-rho@tyr.cx
.
.Sh BUGS
Bugs may be submitted at
.Aq Ad https://bugs.launchpad.net/netre-tools
.\" vim:ft=mandoc:

View File

@ -16,9 +16,10 @@
.\" On Debian systems, the complete text of the GNU General .\" On Debian systems, the complete text of the GNU General
.\" Public License version 3 can be found in "/usr/share/common-licenses/GPL-3". .\" Public License version 3 can be found in "/usr/share/common-licenses/GPL-3".
. .
.Dd March 3, 2012 .Dd May 23, 2012
.Dt P4SPLIT 1 .Dt P4SPLIT 1
.Os "Network Reverse Engineering Toolkit" .Os "Network Reverse Engineering Toolkit" 1.1337
.
.Sh NAME .Sh NAME
.Nm p4split .Nm p4split
.Nd split a PCAP based on CIDR filter .Nd split a PCAP based on CIDR filter
@ -33,34 +34,37 @@
.Sh DESCRIPTION .Sh DESCRIPTION
The basic concept for this utility is to filter and split a PCAP packet capture 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. file into smaller files. This utility will create up to 256 smaller files.
.
.Sh USAGE
As a filter
.D1 ... | Nm p4split 192.168.1.0/24
.Pp .Pp
Command mode The available options include:
.D1 Nm p4split Fl i Pa big.pcap Ad 192.168.1.0/24 .Pp
. .Bl -tag -compact -width "-i input.pcap"
.Sh OPTIONS
A summary of the options supported by
.Nm
is included below.
.Bl -tag -width Ds
.It Fl h .It Fl h
usage information usage information
.It Fl v .It Fl v
the program's version the program's version
.It Fl i Pa input.pcap .It Fl i Pa input.pcap
.Pa input.pcap .Pa input.pcap No is used as input, instead of stdin
is used as input, instead of stdin .It Aq CIDR filter
.It Ao CIDR filter Ac A filter in CIDR notation
A filter in CIDR notation (ad.dre.ss/subnet-bits) .Pq a.dd.re.ss/subnet-bits
.El .El
. .
.Sh EXAMPLES
As a filter:
.D1 Ic $ No ... | Nm p4split Ar 192.168.1.0/24
.Pp
With an input file specified:
.D1 Ic $ Nm p4split Fl i Pa big.pcap Ad 192.168.1.0/24
.
.Sh SEE ALSO .Sh SEE ALSO
.Xr pcat 1 ,
.Xr pmerge 1 , .Xr pmerge 1 ,
.Xr puniq 1 .Xr puniq 1
. .
.Sh AUTHORS .Sh AUTHORS
.An Zephyr Aq Ad zephyr@dirtbags.net , .An Zephyr Aq Ad zephyr@dirtbags.net ,
.An pi-rho Aq Ad pi-rho@tyr.cx .An pi-rho Aq Ad pi-rho@tyr.cx
.
.Sh BUGS
Bugs may be submitted at
.Aq Ad https://bugs.launchpad.net/netre-tools

View File

@ -16,9 +16,10 @@
.\" On Debian systems, the complete text of the GNU General .\" On Debian systems, the complete text of the GNU General
.\" Public License version 3 can be found in "/usr/share/common-licenses/GPL-3". .\" Public License version 3 can be found in "/usr/share/common-licenses/GPL-3".
. .
.Dd March 3, 2012 .Dd May 23, 2012
.Dt PMERGE 1 .Dt PMERGE 1
.Os "Network Reverse Engineering Toolkit" .Os "Network Reverse Engineering Toolkit" 1.1337
.
.Sh NAME .Sh NAME
.Nm pmerge .Nm pmerge
.Nd merge multiple PCAP files in timeline order .Nd merge multiple PCAP files in timeline order
@ -27,47 +28,46 @@
.Nm pmerge .Nm pmerge
.Op Fl h | Fl v .Op Fl h | Fl v
.Nm pmerge .Nm pmerge
.Op Fl o Ar Pa output.pcap .Op Fl o Ar output.pcap
.Pa input.pcap .Pa input.pcap
.Op Ar .Op Ar ...
. .
.Sh DESCRIPTION .Sh DESCRIPTION
The basic concept for this utility is to merge multiple PCAP files while The basic concept for this utility is to merge multiple PCAP files while
maintaining timeline order. maintaining timeline order.
.
.Sh USAGE
As a filter
.D1 Nm pmerge Pa one.pcap Pa two.pcap Li > Pa merged.pcap
.Pp .Pp
In simple command form The available options include:
.D1 Nm pmerge Fl o Pa merged.pcap Pa one.pcap Pa two.pcap .Pp
. .Bl -tag -compact -width "input.pcap [...]"
.Sh OPTIONS
A summary of the options supported by
.Nm pmerge
is included below.
.
.Bl -tag -width Ds
.It Fl h .It Fl h
usage information usage information
.It Fl v .It Fl v
the program's version the program's version
.It Fl o Ar output.pcap .It Fl o Ar output.pcap
sets the output filename to sets the output filename to
.Pa output.pcap . .Pa output.pcap . No If this option flag is not specified, the merged PCAP is
If this option flag is not specified, output to
.Ev stdout .Dv stdout .
is used to output the merged PCAP .It Ar input.pcap Op Ar ...
.It Pa input.pcap
At least one input file argument is required. At least one input file argument is required.
.It Ar
additional input files may be specified
.El .El
. .
.Sh EXAMPLES
As a filter:
.D1 Ic $ Nm pmerge Pa one.pcap Pa two.pcap Li > Pa merged.pcap
.Pp
In simple command form:
.D1 Ic $ Nm pmerge Fl o Pa merged.pcap Pa one.pcap Pa two.pcap
.
.Sh SEE ALSO .Sh SEE ALSO
.Xr p4split 1 , .Xr p4split 1 ,
.Xr pcat 1 ,
.Xr puniq 1 .Xr puniq 1
. .
.Sh AUTHORS .Sh AUTHORS
.An Zephyr Aq Ad zephyr@dirtbags.net , .An Zephyr Aq Ad zephyr@dirtbags.net ,
.An pi-rho Aq Ad pi-rho@tyr.cx .An pi-rho Aq Ad pi-rho@tyr.cx
.
.Sh BUGS
Bugs may be submitted at
.Aq Ad https://bugs.launchpad.net/netre-tools

View File

@ -16,9 +16,10 @@
.\" On Debian systems, the complete text of the GNU General .\" On Debian systems, the complete text of the GNU General
.\" Public License version 3 can be found in "/usr/share/common-licenses/GPL-3". .\" Public License version 3 can be found in "/usr/share/common-licenses/GPL-3".
. .
.Dd March 3, 2012 .Dd May 23, 2012
.Dt PUNIQ 1 .Dt PUNIQ 1
.Os "Network Reverse Engineering Toolkit" .Os "Network Reverse Engineering Toolkit" 1.1337
.
.Sh NAME .Sh NAME
.Nm puniq .Nm puniq
.Nd filter one to many PCAP files for unique frames .Nd filter one to many PCAP files for unique frames
@ -27,43 +28,37 @@
.Nm puniq .Nm puniq
.Op Fl h | Fl v .Op Fl h | Fl v
.Nm puniq .Nm puniq
.Op Fl o Ar output.pcap .Op Fl o Pa output.pcap
.Pa input.pcap .Pa input.pcap
.Op Ar .Op Ar ...
. .
.Sh DESCRIPTION .Sh DESCRIPTION
The basic concept for this utility is to filter one to many PCAP files for The basic concept for this utility is to filter one to many PCAP files for
unique frames unique frames
.
.Sh USAGE
As a filter
.D1 Nm puniq Pa one.pcap Pa two.pcap Li > Pa unique.pcap
.Pp .Pp
In simple command form The available options include:
.D1 Nm puniq Fl o Pa unique.pcap Pa one.pcap Pa two.pcap .Pp
. .Bl -tag -compact -width "input.pcap [...]"
.Sh OPTIONS
A summary of the options supported by
.Nm puniq
is included below.
.
.Bl -tag -width Ds
.It Fl h .It Fl h
usage information usage information
.It Fl v .It Fl v
the program's version the program's version
.It Fl o Ar output.pcap .It Fl o Ar output.pcap
sets the output filename to sets the output filename to
.Pa output.pcap . .Pa output.pcap . No If this option flag is not specified, the merged PCAP is
If this option flag is not specified, ouput to
.Dv stdout .Dv stdout
is used to output the merged PCAP .It Pa input.pcap Op Ar ...
.It Pa input.pcap
At least one input file argument is required At least one input file argument is required
.It Ar
additional input files may be specified
.El .El
. .
.Sh EXAMPLES
As a filter
.D1 Ic $ Nm puniq Pa one.pcap Pa two.pcap Li > Pa unique.pcap
.Pp
In simple command form
.D1 Ic $ Nm puniq Fl o Pa unique.pcap Pa one.pcap Pa two.pcap
.
.Sh SEE ALSO .Sh SEE ALSO
.Xr p4split 1 , .Xr p4split 1 ,
.Xr pmerge 1 .Xr pmerge 1
@ -71,3 +66,7 @@ additional input files may be specified
.Sh AUTHORS .Sh AUTHORS
.An Zephyr Aq Ad zephyr@dirtbags.net , .An Zephyr Aq Ad zephyr@dirtbags.net ,
.An pi-rho Aq Ad pi-rho@tyr.cx .An pi-rho Aq Ad pi-rho@tyr.cx
.
.Sh BUGS
Bugs may be submitted at
.Aq Ad https://bugs.launchpad.net/netre-tools

View File

@ -16,9 +16,9 @@
.\" On Debian systems, the complete text of the GNU General .\" On Debian systems, the complete text of the GNU General
.\" Public License version 3 can be found in "/usr/share/common-licenses/GPL-3". .\" Public License version 3 can be found in "/usr/share/common-licenses/GPL-3".
. .
.Dd March 3, 2012 .Dd May 23, 2012
.Dt REPR 1 .Dt REPR 1
.Os "Network Reverse Engineering Toolkit" .Os "Network Reverse Engineering Toolkit" 1.1337
. .
.Sh NAME .Sh NAME
.Nm repr .Nm repr
@ -31,29 +31,26 @@
.Op Ar .Op Ar
. .
.Sh DESCRIPTION .Sh DESCRIPTION
The basic concept for this utility is to emulate python's repr() function. Input The basic concept for this utility is to emulate Python's
bytes are escaped using Python's byte notation if they do not fall within the .Fn repr No function. Input bytes are escaped using Python's byte notation if
printable range. they do not fall within the printable range.
.
.Sh USAGE
With a file specified
.D1 Nm repr Pa data.bin
.Pp .Pp
As a filter The available options include:
.D1 ... | Nm repr | ... .Pp
. .Bl -tag -compact -width Ds
.Sh OPTIONS
A summary of the options supported by
.Nm repr
is included below.
.
.Bl -tag -width Ds
.It Fl h .It Fl h
usage information usage information
.It Fl v .It Fl v
the program's version the program's version
.El .El
. .
.Sh EXAMPLES
With a file specified:
.D1 Ic $ Nm repr Pa data.bin
.Pp
As a filter:
.D1 Ic $ No ... | Nm repr | No ...
.
.Sh SEE ALSO .Sh SEE ALSO
.Xr hdng 1 , .Xr hdng 1 ,
.Xr xor 1 .Xr xor 1
@ -61,3 +58,7 @@ the program's version
.Sh AUTHORS .Sh AUTHORS
.An Zephyr Aq Ad zephyr@dirtbags.net , .An Zephyr Aq Ad zephyr@dirtbags.net ,
.An pi-rho Aq Ad pi-rho@tyr.cx .An pi-rho Aq Ad pi-rho@tyr.cx
.
.Sh BUGS
Bugs may be submitted at
.Aq Ad https://bugs.launchpad.net/netre-tools

View File

@ -16,9 +16,9 @@
.\" On Debian systems, the complete text of the GNU General .\" On Debian systems, the complete text of the GNU General
.\" Public License version 3 can be found in "/usr/share/common-licenses/GPL-3". .\" Public License version 3 can be found in "/usr/share/common-licenses/GPL-3".
. .
.Dd March 3, 2012 .Dd May 23, 2012
.Dt UNHEX 1 .Dt UNHEX 1
.Os "Network Reverse Engineering Toolkit" .Os "Network Reverse Engineering Toolkit" 1.1337
. .
.Sh NAME .Sh NAME
.Nm unhex .Nm unhex
@ -32,32 +32,34 @@
. .
.Sh DESCRIPTION .Sh DESCRIPTION
The basic concept for this utility is to translate hexits (00-ff) to their The basic concept for this utility is to translate hexits (00-ff) to their
binary equivalent. If the text input includes spaces and non-hexadecimal binary equivalent. Spaces and other non-hexadecimal characters are ignored in
characters, these characters are ignored. If non-hexadecimal characters appear the input stream. If non-hexadecimal characters appear between hexit pairs, an
between hexit pairs, an error is produced. error is produced.
.
.Sh USAGE
With a file specified
.D1 Nm unhex Pa data.bin
.Pp .Pp
As a filter The available options include:
.D1 ... | Nm unhex | ... .Pp
. .Bl -tag -compact -width Ds
.Sh OPTIONS
A summary of the options supported by
.Nm unhex
is included below.
.
.Bl -tag -width Ds
.It Fl h .It Fl h
usage information usage information
.It Fl v .It Fl v
the program's version the program's version
.El .El
.
.Sh SEE ALSO .Sh SEE ALSO
.Xr hdng 1 , .Xr hdng 1 ,
.Xr xor 1 .Xr xor 1
. .
.Sh EXAMPLES
With a file specified
.D1 Ic $ Nm unhex Pa data.bin
.Pp
As a filter
.D1 Ic $ No ... | Nm unhex | No ...
.
.Sh AUTHORS .Sh AUTHORS
.An Zephyr Aq Ad zephyr@dirtbags.net , .An Zephyr Aq Ad zephyr@dirtbags.net ,
.An pi-rho Aq Ad pi-rho@tyr.cx .An pi-rho Aq Ad pi-rho@tyr.cx
.
.Sh BUGS
Bugs may be submitted at
.Aq Ad https://bugs.launchpad.net/netre-tools

View File

@ -16,9 +16,9 @@
.\" On Debian systems, the complete text of the GNU General .\" On Debian systems, the complete text of the GNU General
.\" Public License version 3 can be found in "/usr/share/common-licenses/GPL-3". .\" Public License version 3 can be found in "/usr/share/common-licenses/GPL-3".
. .
.Dd May 1, 2012 .Dd May 23, 2012
.Dt TRANSFORMER 1 .Dt TRANSFORMER 1
.Os "Network Reverse Engineering Toolkit" .Os "Network Reverse Engineering Toolkit" 1.1337
. .
.Sh NAME .Sh NAME
.Nm xor .Nm xor
@ -40,7 +40,7 @@
.Op Fl u .Op Fl u
.Op Fl x .Op Fl x
.Ar BYTE .Ar BYTE
.Op Ar BYTE ... .Op Ar ...
.Nm <transform> .Nm <transform>
.Op Fl u .Op Fl u
.Fl s .Fl s
@ -49,24 +49,10 @@
.Sh DESCRIPTION .Sh DESCRIPTION
The basic concept for this utility is to apply a set of bytes, repeatedly, to a The basic concept for this utility is to apply a set of bytes, repeatedly, to a
stream of input. stream of input.
.
.Sh USAGE
As a filter with the hexadecimal bytes
.Bq 0x20 , 0x2f
applied to the input stream using
.Nm xor .
The bytes are applied repeatedly until the end-of-file (i.e.
.Bq 0x20 , 0x2f , 0x20 , 0x2f , ... Ns ) .
.D1 ... | Nm xor Fl x Ar 20 Ar 2f | Li ...
.Pp .Pp
As a filter with a string of characters used as a byte source (i.e. The available options include:
.Bq 0x20 , 0x6b , 0x65 , 0x79 , 0x20 , ... Ns ) . .Pp
.D1 ... | Nm xor Fl s Qo Ar " key " Qc | Li ... .Bl -tag -compact -width "-s STRING"
.
.Sh OPTIONS
A summary of the options is included below.
.
.Bl -tag -width Ds
.It Fl h .It Fl h
usage information usage information
.It Fl v .It Fl v
@ -76,29 +62,41 @@ explicity interpret bytes as hexadecimal digits
.It Fl s Ar STRING .It Fl s Ar STRING
use a string of characters as the byte source use a string of characters as the byte source
.It Fl u .It Fl u
undo - reverse the transform (this is ignored for undo - reverse the transform
.Nm xor ) .Pq this is ignored for Nm xor
.It Ar BYTE Op Ar BYTE ... .It Ar BYTE Op Ar ...
a list of bytes to apply to the input stream a list of bytes to apply to the input stream
.El .El
. .
.Sh IMPLEMENTATION NOTES .Sh IMPLEMENTATION NOTES
The application of the bytes is accomplished using one of the following The application of the key bytes is accomplished using one of the following
transforms: transforms:
. .
.Bd -unfilled -offset indent .Bd -unfilled -offset left
.TS .TS
box tab(:); box tab(:);
l | l | l | l. l | l | l | l | l.
\fBTransform:Description:Bytes:Undo\fR \fBName:Description:Subj:Argument:Undo\fR
_:_:_:_ _:_:_:_:_
xor:bitwise exclusive OR:integers [0-255]:- xor:bitwise exclusive OR:bytes:int [0-255]:N/A
rot:bitwise rotate left:integers [0-7]:bitwise rotate right rot:rotate left:bits:int [0-7]:rotate right
rol:bytewise rotate (-):integers [0-255]:bytewise rotate (+) rol:rotate (-):bytes:int [0-255]:rotate (+)
caesar:alphabet shift (+):integers [0-26]:alphabet shift (-) caesar:shift (+):alpha:int [0-26]:shift (-)
.TE .TE
.Ed .Ed
.
.Sh EXAMPLES
As a filter with the hexadecimal bytes
.Bq 0x20 , 0x2f
applied to the input stream using
.Nm xor .
The bytes are applied repeatedly until the end-of-file
.Pq i.e. Bo 0x20 , 0x2f , 0x20 , 0x2f , ... Bc .
.D1 Ic $ No ... | Nm xor Fl x Ar 20 Ar 2f | No ...
.Pp .Pp
As a filter with a string of characters used as a byte source
.Pq i.e. Qo key Qc becomes Bo 0x6b , 0x65 , 0x79 , ... Bc .
.D1 Ic $ No ... | Nm xor Fl s Qo Ar key Qc | No ...
. .
.Sh SEE ALSO .Sh SEE ALSO
.Xr hdng 1 , .Xr hdng 1 ,
@ -107,3 +105,7 @@ caesar:alphabet shift (+):integers [0-26]:alphabet shift (-)
.Sh AUTHORS .Sh AUTHORS
.An Zephyr Aq Ad zephyr@dirtbags.net , .An Zephyr Aq Ad zephyr@dirtbags.net ,
.An pi-rho Aq Ad pi-rho@tyr.cx .An pi-rho Aq Ad pi-rho@tyr.cx
.
.Sh BUGS
Bugs may be submitted at
.Aq Ad https://bugs.launchpad.net/netre-tools