summaryrefslogtreecommitdiff
path: root/debian/mongosniff.1
diff options
context:
space:
mode:
Diffstat (limited to 'debian/mongosniff.1')
-rw-r--r--debian/mongosniff.148
1 files changed, 23 insertions, 25 deletions
diff --git a/debian/mongosniff.1 b/debian/mongosniff.1
index 71bb9211706..2f9b72e4e5a 100644
--- a/debian/mongosniff.1
+++ b/debian/mongosniff.1
@@ -1,8 +1,8 @@
.\" Man page generated from reStructuredText.
.
-.TH "MONGOSNIFF" "1" "October 03, 2013" "2.4" "mongodb-manual"
+.TH "MONGOSNIFF" "1" "March 18, 2014" "2.6" "mongodb-manual"
.SH NAME
-mongosniff \- MongoDB
+mongosniff \- MongoDB Protocol Introspection Utility
.
.nr rst2man-indent-level 0
.
@@ -77,21 +77,20 @@ wire protocol.
.UNINDENT
.INDENT 0.0
.TP
-.B \-\-help
-Returns a basic help and usage text.
+.B \-\-help, \-h
+Returns information on \fBmongosniff\fP options and usage.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-forward <host><:port>
Declares a host to forward all parsed requests that the
-\fBmongosniff\fP intercepts to another \fBmongod\fP
-instance and issue those operations on that database instance.
+\fBmongosniff\fP intercepts to another \fBmongod\fP instance
+and issue those operations on that database instance.
.sp
-Specify the target host name and port in the \fB<host><:port>\fP
-format.
+Specify the target host name and port in the \fB<host><:port>\fP format.
.sp
-To connect to a replica set, you can specify the replica set seed
-name, and a seed list of set members, in the following format:
+To connect to a replica set, specify the replica set seed name and the
+seed list of set members. Use the following format:
.INDENT 7.0
.INDENT 3.5
.sp
@@ -105,33 +104,32 @@ name, and a seed list of set members, in the following format:
.UNINDENT
.INDENT 0.0
.TP
-.B \-\-source <NET [interface]>, <FILE [filename]>, <DIAGLOG [filename]>
-Specifies source material to inspect. Use \fB\-\-source NET
-[interface]\fP to inspect traffic from a network interface
-(e.g. \fBeth0\fP or \fBlo\fP\&.) Use \fB\-\-source FILE [filename]\fP to
-read captured packets in \fIpcap\fP format.
-.sp
-You may use the \fB\-\-source DIAGLOG [filename]\fP option to read
-the output files produced by the \fI\-\-diaglog\fP
+.B \-\-source <NET [interface]>
+Specifies source material to inspect. Use \fB\-\-source NET [interface]\fP
+to inspect traffic from a network interface (e.g. \fBeth0\fP or \fBlo\fP\&.)
+Use \fB\-\-source FILE [filename]\fP to read captured packets in
+\fIpcap\fP format.
+.sp
+You may use the \fB\-\-source DIAGLOG [filename]\fP option to read the
+output files produced by the \fI\-\-diaglog\fP
option.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-objcheck
-Modifies the behavior to \fIonly\fP display invalid BSON objects and
-nothing else. Use this option for troubleshooting driver
-development. This option has some performance impact on the
-performance of \fBmongosniff\fP\&.
+Displays invalid BSON objects only and nothing else. Use this option for
+troubleshooting driver development. This option has some performance
+impact on the performance of \fBmongosniff\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B <port>
Specifies alternate ports to sniff for traffic. By default,
-\fBmongosniff\fP watches for MongoDB traffic on port 27017. Append
+\fBmongosniff\fP watches for MongoDB traffic on port \fB27017\fP\&. Append
multiple port numbers to the end of \fBmongosniff\fP to monitor
traffic on multiple ports.
.UNINDENT
-.SH USAGE
+.SH USE
.sp
Use the following command to connect to a \fBmongod\fP or
\fBmongos\fP running on port 27017 \fIand\fP 27018 on the localhost
@@ -214,6 +212,6 @@ must run \fBscons clean\fP before you can build \fBmongosniff\fP\&.
.SH AUTHOR
MongoDB Documentation Project
.SH COPYRIGHT
-2011-2013, MongoDB, Inc.
+2011-2014, MongoDB, Inc.
.\" Generated by docutils manpage writer.
.