diff options
author | Ernie Hershey <ernie.hershey@10gen.com> | 2014-02-28 11:16:26 -0500 |
---|---|---|
committer | Ernie Hershey <ernie.hershey@10gen.com> | 2014-03-19 09:52:12 -0400 |
commit | 3b0a2b212f6003b4aaa9d8e1c0d8cb841cd2496f (patch) | |
tree | 900952421e1e87f95f662170c6ef4e8878c27496 /debian/bsondump.1 | |
parent | dcae4f6f020b0ee94a28ecb47577ad30fe11ddae (diff) | |
download | mongo-3b0a2b212f6003b4aaa9d8e1c0d8cb841cd2496f.tar.gz |
SERVER-11045 Update man pages from the MongoDB Manual
This is a direct copy of generated man page content from
the MongoDB Manual.
Diffstat (limited to 'debian/bsondump.1')
-rw-r--r-- | debian/bsondump.1 | 65 |
1 files changed, 40 insertions, 25 deletions
diff --git a/debian/bsondump.1 b/debian/bsondump.1 index 5aec65755da..f91b910787e 100644 --- a/debian/bsondump.1 +++ b/debian/bsondump.1 @@ -1,8 +1,8 @@ .\" Man page generated from reStructuredText. . -.TH "BSONDUMP" "1" "October 03, 2013" "2.4" "mongodb-manual" +.TH "BSONDUMP" "1" "March 18, 2014" "2.6" "mongodb-manual" .SH NAME -bsondump \- MongoDB BSON utility +bsondump \- MongoDB BSON Utility . .nr rst2man-indent-level 0 . @@ -54,30 +54,45 @@ BSON files, not a tool for data ingestion or other application use. .UNINDENT .INDENT 0.0 .TP -.B \-\-help -Returns a basic help and usage text. +.B \-\-help, \-h +Returns information on \fBbsondump\fP options and usage. .UNINDENT .INDENT 0.0 .TP .B \-\-verbose, \-v -Increases the amount of internal reporting returned on the command -line. Increase the verbosity with the \fB\-v\fP form by including -the option multiple times, (e.g. \fB\-vvvvv\fP\&.) +Increases the amount of internal reporting returned on standard output +or in log files. Increase the verbosity with the \fB\-v\fP form by +including the option multiple times, (e.g. \fB\-vvvvv\fP\&.) +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-quiet +Runs \fBbsondump\fP in a quiet mode that attempts to limit the amount of +output. This option suppresses: +.INDENT 7.0 +.IP \(bu 2 +output from \fIdatabase commands\fP +.IP \(bu 2 +replication activity +.IP \(bu 2 +connection accepted events +.IP \(bu 2 +connection closed events +.UNINDENT .UNINDENT .INDENT 0.0 .TP .B \-\-version -Returns the version of the \fBbsondump\fP utility. +Returns the \fBbsondump\fP release number. .UNINDENT .INDENT 0.0 .TP .B \-\-objcheck -Validates each \fIBSON\fP object before outputting it in -\fIJSON\fP format. By default, \fBbsondump\fP enables -\fI\-\-objcheck\fP\&. For objects with a high degree of -sub\-document nesting, \fI\-\-objcheck\fP can have a small impact -on performance. You can set \fI\-\-noobjcheck\fP to disable -object checking. +Validates each \fIBSON\fP object before outputting it in \fIJSON\fP +format. By default, \fBbsondump\fP enables \fI\-\-objcheck\fP\&. +For objects with a high degree of sub\-document nesting, +\fI\-\-objcheck\fP can have a small impact on performance. You can set +\fI\-\-noobjcheck\fP to disable object checking. .sp Changed in version 2.4: MongoDB enables \fI\-\-objcheck\fP by default, to prevent any client from inserting malformed or invalid BSON into a MongoDB @@ -90,31 +105,31 @@ database. New in version 2.4. .sp -Disables the default document validation that \fBbsondump\fP -performs on all BSON documents. +Disables the default document validation that MongoDB performs on all +incoming BSON documents. .UNINDENT .INDENT 0.0 .TP -.B \-\-filter \(aq<JSON>\(aq +.B \-\-filter <JSON> Limits the documents that \fBbsondump\fP exports to only those documents that match the \fIJSON document\fP specified as -\fB\(aq<JSON>\(aq\fP\&. Be sure to include the document in single quotes to -avoid interaction with your system\(aqs shell environment. +\fB\(aq<JSON>\(aq\fP\&. Be sure to include the document in single quotes to avoid +interaction with your system\(aqs shell environment. .UNINDENT .INDENT 0.0 .TP .B \-\-type <=json|=debug> -Changes the operation of \fBbsondump\fP from outputting "\fIJSON\fP" (the -default) to a debugging format. +Changes the operation of \fBbsondump\fP from outputting +"\fIJSON\fP" (the default) to a debugging format. .UNINDENT .INDENT 0.0 .TP -.B <bsonfilename> +.B <bsonFilename> The final argument to \fBbsondump\fP is a document containing \fIBSON\fP\&. This data is typically generated by -\fBmongodump\fP or by MongoDB in a \fIrollback\fP operation. +\fBbsondump\fP or by MongoDB in a \fIrollback\fP operation. .UNINDENT -.SH USAGE +.SH USE .sp By default, \fBbsondump\fP outputs data to standard output. To create corresponding \fIJSON\fP files, you will need to use the @@ -145,6 +160,6 @@ bsondump \-\-type=debug collection.bson .SH AUTHOR MongoDB Documentation Project .SH COPYRIGHT -2011-2013, MongoDB, Inc. +2011-2014, MongoDB, Inc. .\" Generated by docutils manpage writer. . |