Updated commandline args: Added -V for version, -h for help, changed -d to -v for...

[ltp2tcp] / README

diff --git a/README b/README
index 32970daafe1cc8923bf2c294d4191be8e2416985..3b95989541b2d24778c9bde2d4874d8d7539d462 100644 (file)
--- a/README
+++ b/README
@@ -8,19 +8,21 @@ In order to build this program, please simply type make at the commandline. I ha
 included a ./configure script at this time. Contact me, if major problems arise.
 
 Usage is as follows:
 included a ./configure script at this time. Contact me, if major problems arise.
 
 Usage is as follows:

-ltptrace -t{encapsulation} ltp_file tcp_file [-d] [-b{block_size}] [-s{start session}-{end session}]
-       -d is debug (repeat for additional verbosity)
-       -t specifies what protocol LTP is encapsulated in.  Right now, only udp and dccp are supported.
-       -b specifies the LTP block size (NOT the bundle size) that is being used over this connection.
+ltp2tcp -t{encapsulation} [-v] [-V] [-h] [-b{block_size}] [-s{start session}-{end session}] ltp_file tcp_file
+       -v  verbose (repeat for additional verbosity)
+       -V      Version information
+       -h  Help
+    -t The protocol LTP is encapsulated in.  Right now, only udp, dccp, and sll are supported.
+    -b  The LTP block size (NOT the bundle size) that is being used over this connection.

                This information can't be determined from a packet capture, so if not specified
                it defaults to is 500,000. If you set this value larger than your actual block size, the graph
                This information can't be determined from a packet capture, so if not specified
                it defaults to is 500,000. If you set this value larger than your actual block size, the graph

-               will contain empty spaces between each session, which is handy to separate sessions. However, in that case, tcptrace will report 
-               inaccurate, lost data statistics.
-       -s requests a graph of only the specified range of sessions. Note that the session numbers are just the "session number"
+               will contain empty spaces between each session, which is handy to separate sessions. However, in
+               that case, tcptrace will report inaccurate, lost data statistics.
+       -s  Requests a graph of only the specified range of sessions. Note that the session numbers are just the "session number"

                from wireshark, not the whole session id.
 
 To generate the graphs run:
                from wireshark, not the whole session id.
 
 To generate the graphs run:

-       ltptrace -tudp ltp_file.dmp tcp_file.dmp
+       ltp2tcp -tudp ltp_file.dmp tcp_file.dmp

        tcptrace -lGt tcp_file.dmp
        xplot a2b_tsg.xpl
 
        tcptrace -lGt tcp_file.dmp
        xplot a2b_tsg.xpl
 


@@ -51,25 +53,25 @@ Limitations:
        1)Only handles one LTP "connection". There isn't a good way to separate
                different LTP "connections" from new sessions of the same "connection".
                Use Tcpdump filters to separate connections. Libpcap filtering could also
        1)Only handles one LTP "connection". There isn't a good way to separate
                different LTP "connections" from new sessions of the same "connection".
                Use Tcpdump filters to separate connections. Libpcap filtering could also

-               be added in ltptrace.
+               be added in ltp2tcp.

        2)Uses some special types from Linux (u_char, u_int32_t)
 
 
        2)Uses some special types from Linux (u_char, u_int32_t)
 
 

-ltptrace is free software: you can redistribute it and/or modify
+ltp2tcp is free software: you can redistribute it and/or modify

 it under the terms of the GNU General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.
 
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.
 

-ltptrace is distributed in the hope that it will be useful,
+ltp2tcp is distributed in the hope that it will be useful,

 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License

-along with ltptrace.  If not, see <http://www.gnu.org/licenses/>.
+along with ltp2tcp.  If not, see <http://www.gnu.org/licenses/>.

 
 Samuel Jero
 Internetworking Research Group
 Ohio University
 sj323707@ohio.edu
 
 Samuel Jero
 Internetworking Research Group
 Ohio University
 sj323707@ohio.edu

-2/23/2011
+6/28/2013