SERVER-11045 Update man pages from the MongoDB Manual

This is a direct copy of generated man page content from
the MongoDB Manual.

1 files changed, 170 insertions, 98 deletions

diff --git a/debian/mongofiles.1 b/debian/mongofiles.1
index 95434b1e0ac..9cb2b31dafd 100644
--- a/debian/mongofiles.1
+++ b/debian/mongofiles.1
@@ -1,8 +1,8 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "MONGOFILES" "1" "October 03, 2013" "2.4" "mongodb-manual"
+.TH "MONGOFILES" "1" "March 18, 2014" "2.6" "mongodb-manual"
 .SH NAME
-mongofiles \- MongoDB
+mongofiles \- MongoDB GridFS Utility
 .
 .nr rst2man-indent-level 0
 .
@@ -82,90 +82,175 @@ For \fIreplica sets\fP,
 .UNINDENT
 .INDENT 0.0
 .TP
-.B \-\-help
-Returns a basic help and usage text.
+.B \-\-help, \-h
+Returns information on \fBmongofiles\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 \fBmongofiles\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 \fBmongofiles\fP utility.
+Returns the \fBmongofiles\fP release number.
 .UNINDENT
 .INDENT 0.0
 .TP
 .B \-\-host <hostname><:port>
-Specifies a resolvable hostname for the \fBmongod\fP that
-holds your GridFS system. By default \fBmongofiles\fP attempts
-to connect to a MongoDB process ruining on the localhost port
-number \fB27017\fP\&.
+Specifies a resolvable hostname for the \fBmongod\fP that holds
+your GridFS system. By default \fBmongofiles\fP attempts to connect
+to a MongoDB process running on the localhost port number \fB27017\fP\&.
 .sp
-Optionally, specify a port number to connect a MongoDB instance
-running on a port other than 27017.
+Optionally, specify a port number to connect a MongoDB instance running
+on a port other than 27017.
 .UNINDENT
 .INDENT 0.0
 .TP
 .B \-\-port <port>
-Specifies the port number, if the MongoDB instance is not running on
-the standard port. (i.e. \fB27017\fP) You may also specify a port
-number using the \fImongofiles \-\-host\fP command.
+Specifies the port number when the MongoDB instance is not running on the
+standard port of \fB27017\fP\&. You may also specify the port number
+using the \fB\-\-host\fP option.
 .UNINDENT
 .INDENT 0.0
 .TP
 .B \-\-ipv6
-Enables IPv6 support that allows \fBmongofiles\fP to connect
-to the MongoDB instance using an IPv6 network. All MongoDB programs
-and processes, including \fBmongofiles\fP, disable IPv6
-support by default.
+Enables IPv6 support, which allows \fBmongofiles\fP to connect to the MongoDB
+instance using an IPv6 network. All MongoDB programs and processes,
+including \fBmongofiles\fP, disable IPv6 support by default.
 .UNINDENT
 .INDENT 0.0
 .TP
 .B \-\-ssl
-New in version 2.4: MongoDB added support for SSL connections to \fBmongod\fP
-instances in mongofiles\&.
+New in version 2.6.
 
 .sp
-\fBNOTE:\fP
-.INDENT 7.0
-.INDENT 3.5
-SSL support in mongofiles is not compiled into the default
-distribution of MongoDB. See
-http://docs.mongodb.org/manual/tutorial/configure\-ssl for more information on SSL
-and MongoDB.
+Enables connection to a \fBmongod\fP or \fBmongos\fP that has
+SSL support enabled.
+.sp
+The default distribution of MongoDB does not contain support for SSL.
+For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-sslCAFile <filename>
+New in version 2.6.
+
+.sp
+Specifies the \fB\&.pem\fP file that contains the root certificate chain
+from the Certificate Authority. Specify the file name of the
+\fB\&.pem\fP file using relative or absolute paths.
 .sp
-Additionally, mongofiles does not support connections to
-\fBmongod\fP instances that require client certificate
-validation.
+The default distribution of MongoDB does not contain support for SSL.
+For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&.
 .UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-sslPEMKeyFile <filename>
+New in version 2.6.
+
+.sp
+Specifies the \fB\&.pem\fP file that contains both the SSL certificate
+and key. Specify the file name of the \fB\&.pem\fP file using relative
+or absolute paths.
+.sp
+This option is required when using the \fI\-\-ssl\fP option to connect
+to a \fBmongod\fP or \fBmongos\fP that has
+\fBsslCAFile\fP enabled \fIwithout\fP
+\fBsslWeakCertificateValidation\fP\&.
+.sp
+The default distribution of MongoDB does not contain support for SSL.
+For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-sslPEMKeyPassword <value>
+New in version 2.6.
+
+.sp
+Specifies the password to de\-crypt the certificate\-key file (i.e.
+\fI\-\-sslPEMKeyFile\fP). Use \fI\-\-sslPEMKeyPassword\fP only if
+the certificate\-key file is encrypted. In all cases, \fBmongofiles\fP will
+redact the password from all logging and reporting output.
+.sp
+If the private key in the PEM file is encrypted and you do not specify
+\fI\-\-sslPEMKeyPassword\fP, \fBmongofiles\fP will prompt for a passphrase.
+See \fIssl\-certificate\-password\fP\&.
+.sp
+The default distribution of MongoDB does not contain support for SSL.
+For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&.
 .UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-sslCRLFile <filename>
+New in version 2.6.
+
+.sp
+Specifies the \fB\&.pem\fP file that contains the Certificate Revocation
+List. Specify the file name of the \fB\&.pem\fP file using relative or
+absolute paths.
 .sp
-Allows \fBmongofiles\fP to connect to \fBmongod\fP
-instance over an SSL connection.
+The default distribution of MongoDB does not contain support for SSL.
+For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&.
 .UNINDENT
 .INDENT 0.0
 .TP
-.B \-\-username <username>, \-u <username>
-Specifies a username to authenticate to the MongoDB instance, if your
-database requires authentication. Use in conjunction with the
-\fImongofiles \-\-password\fP option to supply a password.
+.B \-\-sslAllowInvalidCertificates
+New in version 2.6.
+
+.sp
+Bypasses the validation checks for server certificates and allows
+the use of invalid certificates. When using the
+\fBsslAllowInvalidCertificates\fP setting, MongoDB logs as a
+warning the use of the invalid certificate.
+.sp
+The default distribution of MongoDB does not contain support for SSL.
+For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&.
 .UNINDENT
 .INDENT 0.0
 .TP
-.B \-\-password <password>, \-p <password>
-Specifies a password to authenticate to the MongoDB instance. Use
-in conjunction with the \fImongofiles \-\-username\fP option to
-supply a username.
+.B \-\-sslFIPSMode
+New in version 2.6.
+
+.sp
+Directs \fBmongofiles\fP to use the FIPS mode of the installed OpenSSL
+library. Your system must
+have a FIPS compliant OpenSSL library to use \fI\-\-sslFIPSMode\fP\&.
 .sp
-If you specify a \fI\-\-username\fP and
-do not pass an argument to \fI\-\-password\fP,
-\fBmongofiles\fP will prompt for a password interactively. If
-you do not specify a password on the command line,
-\fI\-\-password\fP must be the last argument specified.
+The default distribution of MongoDB does not contain support for SSL.
+For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-username <username>, \-u
+Specifies a username with which to authenticate to a MongoDB database
+that uses authentication. Use in conjunction with the \fB\-\-password\fP and
+\fB\-\-authenticationDatabase\fP options.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-password <password>, \-p
+Specifies a password with which to authenticate to a MongoDB database
+that uses authentication. Use in conjunction with the \fB\-\-username\fP and
+\fB\-\-authenticationDatabase\fP options.
 .UNINDENT
 .INDENT 0.0
 .TP
@@ -173,17 +258,10 @@ you do not specify a password on the command line,
 New in version 2.4.
 
 .sp
-Specifies the database that holds the user\(aqs (e.g
-\fI\-\-username\fP) credentials.
-.sp
-By default, \fBmongofiles\fP assumes that the database specified to the
-\fI\-\-db\fP argument holds the user\(aqs credentials, unless you
-specify \fI\-\-authenticationDatabase\fP\&.
-.sp
-See \fBuserSource\fP,
-http://docs.mongodb.org/manual/reference/privilege\-documents and
-http://docs.mongodb.org/manual/reference/user\-privileges for more information about
-delegated authentication in MongoDB.
+Specifies the database that holds the user\(aqs credentials.
+If you do not specify an authentication database, \fBmongofiles\fP assumes
+that the database specified as the argument to the \fI\-\-db\fP option
+holds the user\(aqs credentials.
 .UNINDENT
 .INDENT 0.0
 .TP
@@ -191,82 +269,76 @@ delegated authentication in MongoDB.
 New in version 2.4.
 
 .sp
-Specifies the authentication mechanism. By default, the
-authentication mechanism is \fBMONGODB\-CR\fP, which is the MongoDB
-challenge/response authentication mechanism. In MongoDB Enterprise,
-\fBmongofiles\fP also includes support for \fBGSSAPI\fP to handle
-Kerberos authentication.
-.sp
-See http://docs.mongodb.org/manual/tutorial/control\-access\-to\-mongodb\-with\-kerberos\-authentication
+Specifies the authentication mechanism. By default, the authentication
+mechanism is \fBMONGODB\-CR\fP, which is the MongoDB challenge/response
+authentication mechanism. In MongoDB Enterprise, \fBmongofiles\fP also includes
+support for \fBGSSAPI\fP to handle Kerberos authentication. See
+http://docs.mongodb.org/manual/tutorial/control\-access\-to\-mongodb\-with\-kerberos\-authentication
 for more information about Kerberos authentication.
 .UNINDENT
 .INDENT 0.0
 .TP
 .B \-\-dbpath <path>
 Specifies the directory of the MongoDB data files. If used, the
-\fI\-\-dbpath\fP option enables \fBmongofiles\fP to attach directly to
-local data files interact with the GridFS data without the
-\fBmongod\fP\&. To run with \fI\-\-dbpath\fP, \fBmongofiles\fP needs to lock
-access to the data directory: as a result, no \fBmongod\fP can access
-the same path while the process runs.
+\fI\-\-dbpath\fP option enables \fBmongofiles\fP to attach directly to local data
+files without a running \fBmongod\fP\&. When run with \fI\-\-dbpath\fP,
+\fBmongofiles\fP locks access to the data directory. No \fBmongod\fP can
+access the same path while the process runs.
 .UNINDENT
 .INDENT 0.0
 .TP
 .B \-\-directoryperdb
-Use the \fI\-\-directoryperdb\fP in conjunction with the corresponding
-option to \fBmongod\fP, which allows \fBmongofiles\fP when
-running with the \fI\-\-dbpath\fP option and MongoDB uses an
-on\-disk format where every database has a distinct
+When used in conjunction with the corresponding option in
+\fBmongod\fP, allows \fBmongofiles\fP to access data from MongoDB
+instances that use an on\-disk format where every database has a distinct
 directory. This option is only relevant when specifying the
 \fI\-\-dbpath\fP option.
 .UNINDENT
 .INDENT 0.0
 .TP
 .B \-\-journal
-Allows \fBmongofiles\fP operations to use the durability
-\fIjournal\fP when running with \fI\-\-dbpath\fP
-to ensure that the database maintains a recoverable state. This
-forces \fBmongofiles\fP to record all data on disk regularly.
+Allows \fBmongofiles\fP operations to use the durability \fIjournal\fP to
+ensure data files remain valid and recoverable. This option is only
+relevant when specifying the \fI\-\-dbpath\fP option.
 .UNINDENT
 .INDENT 0.0
 .TP
-.B \-\-db <db>, \-d <db>
-Use the \fI\-\-db\fP option to specify the MongoDB database that stores
-or will store the GridFS files.
+.B \-\-db <database>, \-d
+Specifies the name of the database on which to run \fBmongofiles\fP\&.
 .UNINDENT
 .INDENT 0.0
 .TP
-.B \-\-collection <collection>, \-c <collection>
+.B \-\-collection <collection>, \-c
 This option has no use in this context and a future release may
-remove it. See \fI\%SERVER-4931\fP for more information.
+remove it. See \fI\%SERVER\-4931\fP for more information.
 .UNINDENT
 .INDENT 0.0
 .TP
-.B \-\-local <filename>, \-l <filename>
+.B \-\-local <filename>, \-l
 Specifies the local filesystem name of a file for get and put
 operations.
 .sp
-In the \fBmongofiles put\fP and \fBmongofiles get\fP
-commands the required \fB<filename>\fP modifier refers to the name
-the object will have in GridFS. \fBmongofiles\fP assumes that
-this reflects the file\(aqs name on the local file
-system. This setting overrides this default.
+In the \fBmongofiles put\fP and \fBmongofiles get\fP commands,
+the required \fB<filename>\fP modifier refers to the name the object will
+have in GridFS. \fBmongofiles\fP assumes that this reflects the
+file\(aqs name on the local file system. This setting overrides this
+default.
 .UNINDENT
 .INDENT 0.0
 .TP
-.B \-\-type <MIME>, t <MIME>
-Provides the ability to specify a \fIMIME\fP type to describe the
-file inserted into GridFS storage. \fBmongofiles\fP omits this
-option in the default operation.
+.B \-\-type <MIME>
+Provides the ability to specify a \fIMIME\fP type to describe the file
+inserted into GridFS storage. \fBmongofiles\fP omits this option in
+the default operation.
 .sp
 Use only with \fBmongofiles put\fP operations.
 .UNINDENT
 .INDENT 0.0
 .TP
 .B \-\-replace, \-r
-Alters the behavior of \fBmongofiles put\fP to replace
-existing GridFS objects with the specified local file, rather than
-adding an additional object with the same name.
+Alters the behavior of \fBmongofiles put\fP to replace existing
+GridFS objects with the specified local file, rather than adding an
+additional object with the same name.
 .sp
 In the default operation, files will not be overwritten by a
 \fBmongofiles put\fP option.
@@ -415,6 +487,6 @@ mongofiles \-d records get 32\-corinth.lp
 .SH AUTHOR
 MongoDB Documentation Project
 .SH COPYRIGHT
-2011-2013, MongoDB, Inc.
+2011-2014, MongoDB, Inc.
 .\" Generated by docutils manpage writer.
 .