prevnext   » MKW-ANA: Wiimms MKWii Network Analyzer » mkw-ana: Wiimms MKWii Network Analyzer » mkw-ana dump1

mkw-ana dump1

Packet based hex dumper.

Contents

1.   Syntax

mkw-ana DUMP1 [source]...

2.   Options

Options
Option Param Description
--adjust time Adjust time stamps of the network dump by adding 'time' seconds. This may help to synchronize different dumps. The argument is scanned for SI factors, time units, plus and minus terms.
--skip time Skip first 'time' seconds of each read network dump. The argument is scanned for SI factors, time units, plus and minus terms. Negative values are relative to the end (or ignored for pipes).
--term time Terminate each dump at 'time' seconds. The argument is scanned for SI factors, time units, plus and minus terms. Negative values are relative to the end (or ignored for pipes).
--combine Logical combine network dumps to one single dump before executing options --skip and --term.
--checksum Normally, UDP packets with wrong checksums are dropped. If --checksum is set, the checksums are calculated, but no packet is dropped. Some dumps will print a status info. If set twice, checksums are never calculated and assumed to be correct. --csum is a short cut.
-f --follow Don't close the last input dump on reaching end of file. Instead wait for appended data. This works like the unix tool 'tail -f'.
--ip addr[:port] Define an address (IP or DNS name) and optional a port for filtering. Only packets from or to this host are accepted, all others are ignored.
--home addr Define an address (IP or DNS name) as home client.

Without this options, the tool tries to determine the home client by analysing sender and receiver of the first non filtered packet. A local network (10/8, 172.16/12, 192.168/16, 169.254/16) has priority over a non local network. If sender and receiver have the same priority, the IP of the sender is used.

--wii addr[:port] Define an address (IP or DNS name) and optional a port as home client and for filtering. This options is a shortcut for »--home addr --ip addr:port«.
--real-time-factor factor If set (>0.0), the time differences of the packet time is compared with the real time difference. If a packet will be served to early, the tool sleeps a while.

Value 1.0 forces a real time dump. Values >1.0 force a time-laps effect and values <1.0 a slow-motion effect. --rtf is a short cut.

The intention of this option is to simulate a regular input stream on already dumped and stored data in real time. Use this option never for live incoming data, because packets may be lost.

--real-time-wait seconds If set (>0.0) and the real time option --real-time-factor is enabled, it defines the maximum real time between 2 packets. The default is 3 seconds. --rtw is a short cut.
--write file Write filtered network packets as PCAP v2.4 to 'file' with local endian and microseconds format.
--wflush Flush the output after each packet written by --write.
--dflush The dump commands flush the output after each packet dump.
--flush Short cut for »--wflush --dflush«.
-p --no-proxy Don't dump proxy packets (packets, which contains a PROXY record).
--and If one or more filters are enabled by --receive, --send, --receive-mac, --send-mac, --receive-ip or --send-ip, then a packet or record is only dumped, if it match to at least one of the enabled filters.

But if --and is set, a packet must match *all* enabled filters.

-r --receive Dump only network packets received by the home client (option --home). For combinations with other packet filters see option --and.
-s --send Dump only network packets send by the home client (option --home). For combinations with other packet filters see option --and.
--receive-mac addr Dump only network packets received by the entered MAC address. --rmac is a short cut for --receive-mac. For combinations with other packet filters see option --and.
--send-mac addr Dump only network packets send by the entered MAC address. --smac is a short cut for --send-mac. For combinations with other packet filters see option --and.
--transfer-mac addr Dump only network packets receiced or send by the entered MAC address. --tmac is a short cut for --transfer-mac and both are short cuts for »--rmac addr --smac addr«.
--receive-ip addr Dump only network packets received by the entered address (IP or DNS name). --rip is a short cut for --receive-ip. For combinations with other packet filters see option --and.
--send-ip addr Dump only network packets send by the entered address (IP or DNS name). --sip is a short cut for --send-ip. For combinations with other packet filters see option --and.
--transfer-ip addr Dump only network packets received or send by the entered address. --tip is a short cut for --transfer-ip and both are short cuts for »--rip addr --sip addr«.
-o --only-servers Dump only network packets from and to known servers.
-L --length ranges Dump only UDP packets with specified UDP data length. The 8 bytes long UDP header does not count.

The parameter is a comma separated list of INDEX, INDEX1:, INDEX1:INDEX2 and INDEX#LENGTH elements.

-S --stage list Dump UDP packets only, if one of the entered stages is active.

The parameter is a comma separated list of stage names, optional preceeded by '+' (enable) or '.' (disable). Type »mkw-ana test« for a list of stages or use the dumps to identify stage names.

--xevent Support the XEVENT record type. It is an overlay over the ITEM and EVENT records. --xeve is a shortcut. The option is automatically set, if --type or --TYPE call the XEVENT record.
-t --type list Dump UDP packets only, if at least one record of the packet match the entered record list.

The parameter is a comma separated list of record names, optional preceeded by '+' (enable) or '.' (disable). Type »mkw-ana test« for a list of records or use the dumps to identify record names.

-T --TYPE list Same as --type except for command DUMP3.
-b --brief If set once, the header (timestamp and client info) of single line dumps becomes smaller. If set twice, timestamp and client info are not printed. All previous --long are canceled.
-l --long This option is relevant for single line dumps. Usually the time format is printed as 'MM:SS.s' to keep the lines small. If set once, 'HH:MM:SS.s' is used. If set twice, 'HH:MM:SS.sss' is used. All previous --brief are canceled.
--rel Print timestamps as seconds relative to the beginning. Dependent of option --long the formats are: 'SSSSS', 'SSSSS.s' or 'SSSSS.sss'
--rel-info Like --rel, but reset the origin whenever a reference time is defined in the info file.
--hms Enable relative time stamps Like --rel, but print them in HH:MM:SS instead in seconds only.
--hms-info Short cut for »--rel-info --hms«.
-1 --one-line Print the hexdumps as one line for each record. This makes the dumps horizontal very large, but it is good for comparing objects of the same type. Very helpful is to pipe the output to 'less -S', which supports horizontal scrolling.

If set twice, some record types are additinally added a combined record (overlay).

-w --wide [=width] Usually hexdumps covers 16 bytes per line. If --wide is set, 32 bytes per line are covered. Optional it is possible to enter a value. This option is ignored if using --one-line or --sep-lines.
-a --ascii Append an ASCII character dump behind the hexdump. This option is ignored if using --one-line or --sep-lines.
--show-mac Show the MAC addresses of packets in some dumps. This is enabled by default, if at least one MAC packet filter (--receive-mac or --send-mac) is enabled.
--hide-mac Hide the MAC addresses of packets in all dumps. This is the default, if no MAC packet filter is enabled.
-I --index ranges Dump only bytes with an index selected by the range list. This makes the hex dump smaller especially for one-line dumps.

The parameter is a comma separated list of INDEX, INDEX1:, INDEX1:INDEX2 and INDEX#LENGTH elements.

--log-mode list Define, which elements are included into the log output (see --log). --lmd is a short cut. A comma separated list of keywords is expected: STATUS, STAGE, SELECT, STARTER, FINISH, GRANDPRIX, GTOTAL, TOTAL, LTOTAL, USLOT, RSLOT, GLITCHES, TRIGGER CHEATS, SLOTS, RTYPES, HOST, TEAM, TRACK, USER, TABLES, DISCONNECT, QUERY, REGION, MKWFUN, JOBS, GWIIMMFI, IDSELECT, LECODE, R-MASTER, R-NATNEG, R-STATUS, RECORD=R-*, TCP=QUERY+REGION, DEFAULT, NONE and ALL. VERBOSE is a flag to increase the output level. If the very first character is either '+' or '-', then the current settings are modified and not reset.
--min-race num This is a statistic option: If a Grand Prix (single or team) is aborted, the results of the Grand Prix are only used in the statistics, if NUM races has been completed. The default is 2 and possible values are 0..4.
--md file Create a MakeDoc script with results after each race.
--mdx file Create a MakeDoc script with results after each race. Same as --md, but replace %E, %R, %N and %T in the filename by 'event id', 'race id', 'total race' and 'event type' to create different files.
--php file Create a php script with results after each race.
--phpx file Create a php script with results after each race. Same as --php, but replace %E, %R, %N and %T in the filename by 'event id', 'race id', 'total race' and 'event type' to create different files.
--sleep duration Sleep 'duration' (SI units allowed; default is second) after a race has finished. This option slows down a simulation run direct after logging and printing the race statistics. Values of the range from 3 to 15 seconds seems to be good.