SERVER-17136: update manpages

1 files changed, 216 insertions, 57 deletions

diff --git a/debian/mongotop.1 b/debian/mongotop.1
index d6646d51470..ec868094a84 100644
--- a/debian/mongotop.1
+++ b/debian/mongotop.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "MONGOTOP" "1" "March 18, 2014" "2.6" "mongodb-manual"
+.TH "MONGOTOP" "1" "January 30, 2015" "3.0" "mongodb-manual"
 .SH NAME
 mongotop \- MongoDB Activity Monitor
 .
@@ -37,6 +37,21 @@ MongoDB instance spends reading and writing data. \fBmongotop\fP
 provides statistics on a per\-collection level. By default,
 \fBmongotop\fP returns values every second.
 .sp
+\fBIMPORTANT:\fP
+.INDENT 0.0
+.INDENT 3.5
+In order to connect to a \fBmongod\fP that enforces
+authorization with the \fI\-\-auth\fP option, the
+\fI\-\-username\fP and
+\fI\-\-password\fP options must be used, and the
+user specified must have the \fBserverStatus\fP and
+\fBtop\fP privileges.
+.sp
+The most appropriate built\-in role that has these privileges is
+\fBclusterMonitor\fP\&.
+.UNINDENT
+.UNINDENT
+.sp
 \fBSEE ALSO:\fP
 .INDENT 0.0
 .INDENT 3.5
@@ -71,8 +86,8 @@ see \fBmongostat\fP\&.
 .UNINDENT
 .INDENT 0.0
 .TP
-.B \-\-help, \-h
-Returns information on \fBmongotop\fP options and usage.
+.B \-\-help
+Returns information on the options and use of \fBmongotop\fP\&.
 .UNINDENT
 .INDENT 0.0
 .TP
@@ -84,8 +99,10 @@ including the option multiple times, (e.g. \fB\-vvvvv\fP\&.)
 .INDENT 0.0
 .TP
 .B \-\-quiet
-Runs \fBmongotop\fP in a quiet mode that attempts to limit the amount of
-output. This option suppresses:
+Runs the \fBmongotop\fP in a quiet mode that attempts to limit the amount
+of output.
+.sp
+This option suppresses:
 .INDENT 7.0
 .IP \(bu 2
 output from \fIdatabase commands\fP
@@ -104,19 +121,22 @@ Returns the \fBmongotop\fP release number.
 .UNINDENT
 .INDENT 0.0
 .TP
-.B \-\-host <hostname><:port>, \-h
+.B \-\-host <hostname><:port>, \-h <hostname><:port>
+\fIDefault\fP: localhost:27017
+.sp
 Specifies a resolvable hostname for the \fBmongod\fP to which to
-connect. By default \fBmongotop\fP attempts to connect to a MongoDB instance
-running on the localhost on port number \fB27017\fP\&.
+connect. By default, the \fBmongotop\fP attempts to connect to a MongoDB
+instance running on the localhost on port number \fB27017\fP\&.
 .sp
-To connect to a replica set, specify the replica set seed name and the
-seed list of set members. Use the following format:
+To connect to a replica set, specify the
+\fBreplSetName\fP and a seed list of set members, as in
+the following:
 .INDENT 7.0
 .INDENT 3.5
 .sp
 .nf
 .ft C
-<replica_set_name>/<hostname1><:port>,<hostname2:<port>,...
+<replSetName>/<hostname1><:port>,<hostname2><:port>,<...>
 .ft P
 .fi
 .UNINDENT
@@ -124,20 +144,29 @@ seed list of set members. Use the following format:
 .sp
 You can always connect directly to a single MongoDB instance by
 specifying the host and port number directly.
+.sp
+Changed in version 3.0.0: If you use IPv6 and use the \fB<address>:<port>\fP format, you must
+enclose the portion of an address and port combination in
+brackets (e.g. \fB[<address>]\fP).
+
+.sp
+If connected to a replica set where the \fIprimary\fP is not
+reachable, \fBmongotop\fP returns an error message.
 .UNINDENT
 .INDENT 0.0
 .TP
 .B \-\-port <port>
-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.
+\fIDefault\fP: 27017
+.sp
+Specifies the TCP port on which the MongoDB instance listens for
+client connections.
 .UNINDENT
 .INDENT 0.0
 .TP
 .B \-\-ipv6
-Enables IPv6 support, which allows \fBmongotop\fP to connect to the MongoDB
-instance using an IPv6 network. All MongoDB programs and processes,
-including \fBmongotop\fP, disable IPv6 support by default.
+Enables IPv6 support and allows the \fBmongotop\fP to connect to the
+MongoDB instance using an IPv6 network. All MongoDB programs and
+processes disable IPv6 support by default.
 .UNINDENT
 .INDENT 0.0
 .TP
@@ -163,6 +192,21 @@ from the Certificate Authority. Specify the file name of the
 .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\&.
+.sp
+\fBWARNING:\fP
+.INDENT 7.0
+.INDENT 3.5
+If the \fBmongo\fP shell or any other tool that connects to
+\fBmongos\fP or \fBmongod\fP is run without
+\fI\-\-sslCAFile\fP, it will not attempt to validate
+server certificates. This results in vulnerability to expired
+\fBmongod\fP and \fBmongos\fP certificates as well as to foreign
+processes posing as valid \fBmongod\fP or \fBmongos\fP
+instances. Ensure that you \fIalways\fP specify the CA file against which
+server certificates should be validated in cases where intrusion is a
+possibility.
+.UNINDENT
+.UNINDENT
 .UNINDENT
 .INDENT 0.0
 .TP
@@ -176,8 +220,8 @@ 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\&.
+\fBCAFile\fP enabled \fIwithout\fP
+\fBallowConnectionsWithoutCertificates\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\&.
@@ -189,13 +233,13 @@ 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, \fBmongotop\fP will
+\fI\%\-\-sslPEMKeyFile\fP). Use the \fI\%\-\-sslPEMKeyPassword\fP option only if the
+certificate\-key file is encrypted. In all cases, the \fBmongotop\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, \fBmongotop\fP will prompt for a passphrase.
-See \fIssl\-certificate\-password\fP\&.
+the \fI\%\-\-sslPEMKeyPassword\fP option, the \fBmongotop\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\&.
@@ -221,7 +265,7 @@ 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
+\fBallowInvalidCertificates\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.
@@ -229,30 +273,49 @@ For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tuto
 .UNINDENT
 .INDENT 0.0
 .TP
+.B \-\-sslAllowInvalidHostnames
+New in version 3.0.
+
+.sp
+Disables the validation of the hostnames in SSL certificates. Allows
+\fBmongotop\fP to connect to MongoDB instances if the hostname their
+certificates do not match the specified hostname.
+.UNINDENT
+.INDENT 0.0
+.TP
 .B \-\-sslFIPSMode
 New in version 2.6.
 
 .sp
-Directs \fBmongotop\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\&.
+Directs the \fBmongotop\fP to use the FIPS mode of the installed OpenSSL
+library. Your system must have a FIPS compliant OpenSSL library to use
+the \fI\%\-\-sslFIPSMode\fP option.
 .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\&.
+\fBNOTE:\fP
+.INDENT 7.0
+.INDENT 3.5
+FIPS Compatible SSL is
+available only in \fI\%MongoDB Enterprise\fP\&. See
+http://docs.mongodb.org/manual/tutorial/configure\-fips for more information.
+.UNINDENT
+.UNINDENT
 .UNINDENT
 .INDENT 0.0
 .TP
-.B \-\-username <username>, \-u
+.B \-\-username <username>, \-u <username>
 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
+.B \-\-password <password>, \-p <password>
 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.
+.sp
+If you do not specify an argument for \fI\%\-\-password\fP, \fBmongotop\fP will
+prompt interactively for a password on the console.
 .UNINDENT
 .INDENT 0.0
 .TP
@@ -261,22 +324,86 @@ New in version 2.4.
 
 .sp
 Specifies the database that holds the user\(aqs credentials.
-If you do not specify an authentication database, \fBmongotop\fP assumes
-that the database specified as the argument to the \fI\-\-db\fP option
-holds the user\(aqs credentials.
+.sp
+Changed in version 3.0.0: \fI\%\-\-authenticationDatabase\fP is required for \fBmongod\fP
+and \fBmongos\fP instances that use \fIauthentication\fP\&.
+
 .UNINDENT
 .INDENT 0.0
 .TP
 .B \-\-authenticationMechanism <name>
+\fIDefault\fP: MONGODB\-CR
+.sp
 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, \fBmongotop\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.
+Changed in version 2.6: Added support for the \fBPLAIN\fP and \fBMONGODB\-X509\fP authentication
+mechanisms.
+
+.sp
+Specifies the authentication mechanism the \fBmongotop\fP instance uses to
+authenticate to the \fBmongod\fP or \fBmongos\fP\&.
+.TS
+center;
+|l|l|.
+_
+T{
+Value
+T}	T{
+Description
+T}
+_
+T{
+MONGODB\-CR
+T}	T{
+MongoDB challenge/response authentication.
+T}
+_
+T{
+MONGODB\-X509
+T}	T{
+MongoDB SSL certificate authentication.
+T}
+_
+T{
+PLAIN
+T}	T{
+External authentication using LDAP. You can also use \fBPLAIN\fP
+for authenticating in\-database users. \fBPLAIN\fP transmits
+passwords in plain text. This mechanism is available only in
+\fI\%MongoDB Enterprise\fP\&.
+T}
+_
+T{
+GSSAPI
+T}	T{
+External authentication using Kerberos. This mechanism is
+available only in \fI\%MongoDB Enterprise\fP\&.
+T}
+_
+.TE
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-gssapiServiceName
+New in version 2.6.
+
+.sp
+Specify the name of the service using \fBGSSAPI/Kerberos\fP\&. Only required if the service does not use the
+default name of \fBmongodb\fP\&.
+.sp
+This option is available only in MongoDB Enterprise.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-gssapiHostName
+New in version 2.6.
+
+.sp
+Specify the hostname of a service using \fBGSSAPI/Kerberos\fP\&. \fIOnly\fP required if the hostname of a machine does
+not match the hostname resolved by DNS.
+.sp
+This option is available only in MongoDB Enterprise.
 .UNINDENT
 .INDENT 0.0
 .TP
@@ -284,6 +411,22 @@ for more information about Kerberos authentication.
 Toggles the mode of \fBmongotop\fP to report on use of per\-database
 \fIlocks\fP\&. These data are useful for measuring concurrent
 operations and lock percentage.
+.sp
+\fI\%\-\-locks\fP returns an error when called against a \fBmongod\fP instance
+that does not report lock usage.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-rowcount int, \-n int
+Number of lines of data that \fBmongotop\fP should print. "0 for indefinite"
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-json
+New in version 3.0.0.
+
+.sp
+Returns output for \fBmongotop\fP in \fIJSON\fP format.
 .UNINDENT
 .INDENT 0.0
 .TP
@@ -308,7 +451,7 @@ affect the output of \fBmongotop\fP\&.
 Contains the database namespace, which combines the database name
 and collection.
 .sp
-Changed in version 2.2: If you use the \fI\%\-\-locks\fP, the \fBns\fP field does not
+Changed in version 2.2: If you use the \fImongotop \-\-locks\fP, the \fBns\fP field does not
 appear in the \fBmongotop\fP output.
 
 .UNINDENT
@@ -375,26 +518,37 @@ This command produces the following output:
 .sp
 .nf
 .ft C
-connected to: 127.0.0.1
-
-                    ns       total        read       write           2012\-08\-13T15:45:40
-test.system.namespaces         0ms         0ms         0ms
-  local.system.replset         0ms         0ms         0ms
-  local.system.indexes         0ms         0ms         0ms
-  admin.system.indexes         0ms         0ms         0ms
-                admin.         0ms         0ms         0ms
+                     ns    total    read    write          2014\-12\-19T15:32:01\-05:00
+     admin.system.roles      0ms     0ms      0ms
+   admin.system.version      0ms     0ms      0ms
+               local.me      0ms     0ms      0ms
+         local.oplog.rs      0ms     0ms      0ms
+ local.replset.minvalid      0ms     0ms      0ms
+      local.startup_log      0ms     0ms      0ms
+   local.system.indexes      0ms     0ms      0ms
+local.system.namespaces      0ms     0ms      0ms
+   local.system.replset      0ms     0ms      0ms
 
-                    ns       total        read       write           2012\-08\-13T15:45:55
-test.system.namespaces         0ms         0ms         0ms
-  local.system.replset         0ms         0ms         0ms
-  local.system.indexes         0ms         0ms         0ms
-  admin.system.indexes         0ms         0ms         0ms
-                admin.         0ms         0ms         0ms
+                     ns    total    read    write          2014\-12\-19T15:47:01\-05:00
+     admin.system.roles      0ms     0ms      0ms
+   admin.system.version      0ms     0ms      0ms
+               local.me      0ms     0ms      0ms
+         local.oplog.rs      0ms     0ms      0ms
+ local.replset.minvalid      0ms     0ms      0ms
+      local.startup_log      0ms     0ms      0ms
+   local.system.indexes      0ms     0ms      0ms
+local.system.namespaces      0ms     0ms      0ms
+   local.system.replset      0ms     0ms      0ms
 .ft P
 .fi
 .UNINDENT
 .UNINDENT
 .sp
+The output varies depending on your MongoDB setup. For example,
+\fBlocal.system.indexes\fP and \fBlocal.system.namespaces\fP only appear
+for \fBmongod\fP instances using the \fIMMAPv1\fP
+storage engine.
+.sp
 To return a \fBmongotop\fP report every 5 minutes, use the
 following command:
 .INDENT 0.0
@@ -408,7 +562,7 @@ mongotop 300
 .UNINDENT
 .UNINDENT
 .sp
-To report the use of per\-database locks, use \fImongotop \-\-locks\fP,
+To report the use of per\-database locks, use \fI\%\-\-locks\fP,
 which produces the following output:
 .INDENT 0.0
 .INDENT 3.5
@@ -426,9 +580,14 @@ connected to: 127.0.0.1
 .fi
 .UNINDENT
 .UNINDENT
+.sp
+Changed in version 3.0.0: When called against a \fBmongod\fP that does not report lock
+usage, \fI\%\-\-locks\fP will return a \fBFailed: Server does not
+support reporting locking information\fP error.
+
 .SH AUTHOR
 MongoDB Documentation Project
 .SH COPYRIGHT
-2011-2014, MongoDB, Inc.
+2011-2015
 .\" Generated by docutils manpage writer.
 .