|
2 | 2 | .\" First parameter, NAME, should be all caps |
3 | 3 | .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection |
4 | 4 | .\" other parameters are allowed: see man(7), man(1) |
5 | | -.TH mm-link 1 "February 2014" |
| 5 | +.TH mm-link 1 "October 2018" |
6 | 6 | .\" Please adjust this date whenever revising the manpage. |
7 | 7 | .\" |
8 | 8 | .\" Some roff macros, for reference: |
@@ -50,6 +50,49 @@ link rate. |
50 | 50 |
|
51 | 51 | To exit mm-link, simply type "exit" or CTRL-D inside mm-link. |
52 | 52 |
|
| 53 | +.SH OUTPUT |
| 54 | +mm-link can optionally log detailed performance information for both the uplink and downlink, specified with the \fB--uplink-log\fR and \fB--downlink-log\fR flags respectively. A log file has the following format: |
| 55 | + |
| 56 | +.EX |
| 57 | +# mahimahi mm-link (name of link) [/path/to/trace] > /path/to/log |
| 58 | +# command line: [command used to run mm-link] |
| 59 | +# queue: [queue information] |
| 60 | +# init timestamp: [start time of mm-link] |
| 61 | +# base timestamp: [starting log timestamp] |
| 62 | +[# mahimahi config: [mahimahi shell prefix]] |
| 63 | +[log lines] |
| 64 | +.EE |
| 65 | + |
| 66 | +Each log line is one of the following: |
| 67 | + |
| 68 | +[timestamp] # packet_size |
| 69 | +. |
| 70 | +.IP "" |
| 71 | +.RS |
| 72 | +An unused delivery opportunity. |
| 73 | +.RE |
| 74 | + |
| 75 | +[timestamp] + packet_size |
| 76 | +. |
| 77 | +.IP "" |
| 78 | +.RS |
| 79 | +A packet arrival to the link, it may be dropped later |
| 80 | +.RE |
| 81 | + |
| 82 | +[timestamp] - packet_size |
| 83 | +. |
| 84 | +.IP "" |
| 85 | +.RS |
| 86 | +A successful packet delivery |
| 87 | +.RE |
| 88 | + |
| 89 | +[timestamp] d packets_dropped bytes_dropped |
| 90 | +. |
| 91 | +.IP "" |
| 92 | +.RS |
| 93 | +A dropped packet (or multiple packets) |
| 94 | +.RE |
| 95 | + |
53 | 96 | .SH EXAMPLE |
54 | 97 |
|
55 | 98 | .nf |
|
0 commit comments