add man pages for ipx dump tools
This commit is contained in:
81
docs/ipx_dump.8
Normal file
81
docs/ipx_dump.8
Normal file
@@ -0,0 +1,81 @@
|
||||
.TH IPX_DUMP 8 "April 2026" "ipx-utils 1.3" "System Administration"
|
||||
.SH NAME
|
||||
ipx_dump \- dump IPX packets from a network interface
|
||||
.SH SYNOPSIS
|
||||
.B ipx_dump
|
||||
.RB [ \-r ]
|
||||
.RB [ \-d
|
||||
.IR device ]
|
||||
.RI [ node ]
|
||||
.br
|
||||
.B ipx_dump
|
||||
.B \-h
|
||||
.SH DESCRIPTION
|
||||
.B ipx_dump
|
||||
captures Ethernet frames from a network interface and prints IPX packets in a
|
||||
text format suitable for inspection or for later decoding with
|
||||
.BR ipx_parse (8).
|
||||
|
||||
By default,
|
||||
.B ipx_dump
|
||||
opens a raw packet socket on the selected interface, puts the interface into
|
||||
promiscuous mode while it is running, and prints decoded IPX frame information.
|
||||
The program must normally be run as root or with equivalent capabilities.
|
||||
|
||||
When
|
||||
.B \-r
|
||||
is used,
|
||||
.B ipx_dump
|
||||
prints raw Ethernet frames as hexadecimal data prefixed with
|
||||
.BR raweth .
|
||||
This raw output can be piped to
|
||||
.BR ipx_parse (8)
|
||||
for more detailed protocol decoding.
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
.B \-r
|
||||
Dump raw Ethernet frames instead of the default decoded IPX frame output.
|
||||
.TP
|
||||
.BI \-d " device"
|
||||
Capture packets from
|
||||
.IR device .
|
||||
If this option is not specified,
|
||||
.B eth0
|
||||
is used.
|
||||
.TP
|
||||
.B \-h
|
||||
Show usage information and exit.
|
||||
.TP
|
||||
.I node
|
||||
Optional IPX node filter. If specified, only packets whose source or
|
||||
destination node matches
|
||||
.I node
|
||||
are printed. The node value is parsed as an IPX node address.
|
||||
.SH EXAMPLES
|
||||
.TP
|
||||
Capture decoded IPX packets on the default interface:
|
||||
.B ipx_dump
|
||||
.TP
|
||||
Capture raw frames on interface
|
||||
.BR eth1 :
|
||||
.B ipx_dump -r -d eth1
|
||||
.TP
|
||||
Capture raw frames and decode them with
|
||||
.BR ipx_parse :
|
||||
.B ipx_dump -r -d eth1 | ipx_parse
|
||||
.SH NOTES
|
||||
.B ipx_dump
|
||||
temporarily enables promiscuous mode on the selected interface and restores the
|
||||
previous interface flags before exiting normally. If the program is killed
|
||||
abruptly, the interface flags may need to be checked manually.
|
||||
|
||||
The raw capture mode uses Linux packet sockets and is intended for diagnostic
|
||||
use.
|
||||
.SH SEE ALSO
|
||||
.BR ipx_parse (8),
|
||||
.BR ipx_configure (8),
|
||||
.BR ipx_interface (8),
|
||||
.BR ipx_route (8)
|
||||
.SH AUTHORS
|
||||
Originally written by Volker Lendecke and Petr Vandrovec.
|
||||
Maintained in the standalone ipx-utils package by Mario Fetka.
|
||||
Reference in New Issue
Block a user