DOCS-223 MongoS.exe reference page

Author: Andrew Leung

source/reference/mongos.exe.txt

@@ -0,0 +1,100 @@
+.. _mongos.exe:
+
+.. default-domain:: mongodb
+
+============================
+:program:`mongos.exe` Manual
+============================
+
+Sypnosis
+--------
+
+:program:`mongos.exe` is the build of the MongoDB Shard
+(i.e. :program:`mongos`) for the Windows
+platform. :program:`mongos.exe` has all of the features of
+:program:`mongos` on Unix-like platforms and is completely compatible
+with the other builds of :program:`mongos`. In addition,
+:program:`mongos.exe` provides several options for interacting with
+the Windows platform itself.
+
+This document only references options that are unique to
+:program:`mongos.exe`. All :program:`mongos` options are
+available. See the ":doc:`/reference/mongos`" and the
+":doc:`/reference/configuration-options`" documents for more
+information regarding :program:`mongos.exe`.
+
+To install and use :program:`mongos.exe`, read the
+":doc:`/tutorial/install-mongodb-on-windows`" document.
+
+Options
+-------
+
+.. program:: mongos.exe
+
+.. option:: --install
+
+   Installs :program:`mongos.exe` as a Windows Service and exits.
+
+.. option:: --remove
+
+   Removes the :program:`mongos.exe` Windows Service. If :program:`mongos.exe` is
+   running, this operation will stop and then remove the service.
+
+   .. note::
+
+      :option:`--remove` requires the :option:`--serviceName` if you
+      configured a non-default :option:`--serviceName` during the
+      :option:`--install` operation.
+
+.. option:: --reinstall
+
+   Removes :program:`mongos.exe` and reinstalls :program:`mongos.exe` as a Windows
+   Service.
+
+.. option:: --serviceName <name>
+
+   *Default*: "MongoS"
+
+   Set the service name of :program:`mongos.exe` when running as a
+   Windows Service. Use this name with the ``net start <name>`` and
+   ``net stop <name>`` operations.
+
+   You must use :option:`--serviceName` in conjunction with either
+   the :option:`--install` or :option:`--remove` install option.
+
+.. option:: --serviceDisplayName <name>
+
+   *Default*: "Mongo DB Router"
+
+   Sets the name listed for MongoDB on the Services administrative
+   application.
+
+.. option:: --serviceDescription <description>
+
+   *Default*: "Mongo DB Sharding Router"
+
+   Sets the :program:`mongos.exe` service description.
+
+   You must use :option:`--serviceDescription` in conjunction with the
+   :option:`--install` option.
+
+   .. note::
+
+      For descriptions that contain spaces, you must enclose the
+      description in quotes.
+
+.. option:: --serviceUser <user>
+
+   Runs the :program:`mongos.exe` service in the context of a certain user. This
+   user must have "Log on as a service" privileges.
+
+   You must use :option:`--serviceUser` in conjunction with the
+   :option:`--install` option.
+
+.. option:: --servicePassword <password>
+
+   Sets the password for ``<user>`` for :program:`mongos.exe` when running with
+   the :option:`--serviceUser` option.
+
+   You must use :option:`--servicePassword` in conjunction with the
+   :option:`--install` option.