diff options
author | Ernie Hershey <ernie.hershey@10gen.com> | 2013-10-04 16:58:27 -0400 |
---|---|---|
committer | Ernie Hershey <ernie.hershey@10gen.com> | 2013-10-04 16:58:27 -0400 |
commit | 2a3826d6e7fc67d3698e8115c6e27412db1778b7 (patch) | |
tree | 850f16c163fa25cfb2e812b6268431e5cf2abd9b /debian/bsondump.1 | |
parent | 8e2c2af3e3bb2129018d956fe19db897197a76a9 (diff) | |
download | mongo-2a3826d6e7fc67d3698e8115c6e27412db1778b7.tar.gz |
SERVER-11045 Update man pages from the MongoDB Manual
Diffstat (limited to 'debian/bsondump.1')
-rw-r--r-- | debian/bsondump.1 | 64 |
1 files changed, 43 insertions, 21 deletions
diff --git a/debian/bsondump.1 b/debian/bsondump.1 index 75eda143a32..5aec65755da 100644 --- a/debian/bsondump.1 +++ b/debian/bsondump.1 @@ -1,4 +1,6 @@ -.TH "BSONDUMP" "1" "March 14, 2013" "2.2.3" "mongodb-manual" +.\" Man page generated from reStructuredText. +. +.TH "BSONDUMP" "1" "October 03, 2013" "2.4" "mongodb-manual" .SH NAME bsondump \- MongoDB BSON utility . @@ -28,13 +30,19 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.\" Man page generated from reStructuredText. -. .SH SYNOPSIS .sp -The \fI\%bsondump\fP converts \fIBSON\fP files into human\-readable -formats, including \fIJSON\fP. For example, \fI\%bsondump\fP is useful -for reading the output files generated by \fBmongodump\fP. +The \fBbsondump\fP converts \fIBSON\fP files into human\-readable +formats, including \fIJSON\fP\&. For example, \fBbsondump\fP is useful +for reading the output files generated by \fBmongodump\fP\&. +.sp +\fBIMPORTANT:\fP +.INDENT 0.0 +.INDENT 3.5 +\fBbsondump\fP is a diagnostic tool for inspecting +BSON files, not a tool for data ingestion or other application use. +.UNINDENT +.UNINDENT .SH OPTIONS .INDENT 0.0 .TP @@ -42,6 +50,10 @@ for reading the output files generated by \fBmongodump\fP. .UNINDENT .INDENT 0.0 .TP +.B bsondump +.UNINDENT +.INDENT 0.0 +.TP .B \-\-help Returns a basic help and usage text. .UNINDENT @@ -50,79 +62,89 @@ Returns a basic help and usage text. .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.) +the option multiple times, (e.g. \fB\-vvvvv\fP\&.) .UNINDENT .INDENT 0.0 .TP .B \-\-version -Returns the version of the \fI\%bsondump\fP utility. +Returns the version of the \fBbsondump\fP utility. .UNINDENT .INDENT 0.0 .TP .B \-\-objcheck Validates each \fIBSON\fP object before outputting it in -\fIJSON\fP format. By default, \fI\%bsondump\fP enables -\fI\%--objcheck\fP by default. 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 +\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 +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 database. + .UNINDENT .INDENT 0.0 .TP .B \-\-noobjcheck New in version 2.4. + .sp -Disables the default document validation that \fI\%bsondump\fP +Disables the default document validation that \fBbsondump\fP performs on all BSON documents. .UNINDENT .INDENT 0.0 .TP .B \-\-filter \(aq<JSON>\(aq -Limits the documents that \fI\%bsondump\fP exports to only those +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 +\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 \fI\%bsondump\fP from outputting "\fIJSON\fP" (the +Changes the operation of \fBbsondump\fP from outputting "\fIJSON\fP" (the default) to a debugging format. .UNINDENT .INDENT 0.0 .TP .B <bsonfilename> -The final argument to \fI\%bsondump\fP is a document containing -\fIBSON\fP. This data is typically generated by +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. .UNINDENT .SH USAGE .sp -By default, \fI\%bsondump\fP outputs data to standard output. To +By default, \fBbsondump\fP outputs data to standard output. To create corresponding \fIJSON\fP files, you will need to use the shell redirect. See the following command: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C bsondump collection.bson > collection.json .ft P .fi +.UNINDENT +.UNINDENT .sp Use the following command (at the system shell) to produce debugging output for a \fIBSON\fP file: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C bsondump \-\-type=debug collection.bson .ft P .fi +.UNINDENT +.UNINDENT .SH AUTHOR MongoDB Documentation Project .SH COPYRIGHT -2011-2013, 10gen, Inc. +2011-2013, MongoDB, Inc. .\" Generated by docutils manpage writer. . |