////////////////////////////////////////////////////////////////////////////////
/// @brief reference manual
///
/// @file
///
/// DISCLAIMER
///
/// Copyright 2012 triagens GmbH, Cologne, Germany
///
/// Licensed under the Apache License, Version 2.0 (the "License");
/// you may not use this file except in compliance with the License.
/// You may obtain a copy of the License at
///
///     http://www.apache.org/licenses/LICENSE-2.0
///
/// Unless required by applicable law or agreed to in writing, software
/// distributed under the License is distributed on an "AS IS" BASIS,
/// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
/// See the License for the specific language governing permissions and
/// limitations under the License.
///
/// Copyright holder is triAGENS GmbH, Cologne, Germany
///
/// @author Dr. Frank Celler
/// @author Copyright 2012, triAGENS GmbH, Cologne, Germany
////////////////////////////////////////////////////////////////////////////////

////////////////////////////////////////////////////////////////////////////////
/// @page RefManual AvocadoDB Reference Manual
///
/// <ol>
///  <li>@ref CommandLine
///   @copydetails CommandLineSubTOC
///  </li>
///  <li>@ref JSModules
///   <ol>
///    <li>User Modules
///     <ol>
///      <li>@ref JSModuleGraph</li>
///     </ol>
///    </li>
///    <li>System Modules
///     <ol>
///      <li>@ref JSModuleActions</li>
///      <li>@ref JSModuleConsole</li>
///      <li>@ref JSModuleFs</li>
///      <li>@ref JSModuleInternal</li>
///     </ol>
///    </li>
///   </ol>
///  </li>
///  <li>@ref OTWP
///   <ol>
///    <li>REST Interface
///     <ol>
///      <li>@ref RestDocument</li>
///      <li>@ref RestEdge</li>
///     </ol>
///    </li>
///    <li>Light-Weight HTTP for Queries
///     <ol>
///      <li>@ref HttpCursor</li>
///      <li>@ref HttpSimple</li>
///     </ol>
///    </li>
///    <li>Light-Weight HTTP for Administration
///     <ol>
///      <li>@ref HttpCollection</li>
///      <li>@ref HttpIndex</li>
///      <li>@ref HttpSystem</li>
///     </ol>
///    </li>
///   </ol>
///  </li>
///  <li>Shell Commands
///   <ol>
///      <li>@ref ShellDocument</li>
///      <li>@ref ShellEdge</li>
///      <li>@ref ShellCollection</li>
///      <li>@ref ShellIndex</li>
///   </ol>
///  </li>
///  <li>Indexes
///   @copydetails IndexesTOC
///  </li>
/// </ol>
////////////////////////////////////////////////////////////////////////////////

////////////////////////////////////////////////////////////////////////////////
/// @page CommandLineSubTOC
///
/// <ol>
///  <li>@ref CommandLineAvocado</li>
///  <li>@ref CommandLineScheduler</li>
///  <li>@ref CommandLineLogging</li>
///  <li>@ref CommandLineRandom</li>
/// </ol>
////////////////////////////////////////////////////////////////////////////////

////////////////////////////////////////////////////////////////////////////////
/// @page CommandLineTOC
///
/// <ol>
///  <li>@ref CommandLineHelp "help"</li>
///  <li>@ref CommandLineVersion "version"</li>
///  <li>@ref CommandLineConfiguration "configuration"</li>
///  <li>@ref CommandLineDaemon "daemon"</li>
///  <li>@ref CommandLineSupervisor "supervisor"</li>
///  <li>@ref CommandLineUid "uid"</li>
///  <li>@ref CommandLineGid "gid"</li>
///  <li>@ref CommandLinePidFile "pid-file"</li>
/// </ol>
////////////////////////////////////////////////////////////////////////////////

////////////////////////////////////////////////////////////////////////////////
/// @page CommandLine Command-Line Options
///
/// <hr>
/// @copydoc CommandLineTOC
/// <hr>
///
/// @section GeneralOptions General Options
///////////////////////////////////////////
///
/// @anchor CommandLineHelp
///////////////////////////
/// @copydetails triagens::rest::ApplicationServerImpl::options
/// <hr>
///
/// @anchor CommandLineVersion
//////////////////////////////
/// @copydetails triagens::rest::ApplicationServerImpl::version
/// <hr>
///
/// @anchor CommandLineConfiguration
////////////////////////////////////
/// @copydetails triagens::rest::ApplicationServerImpl::initFile
/// <hr>
///
/// @anchor CommandLineDaemon
/////////////////////////////
/// @CMDOPT{--daemon}
///
/// Runs the server as a daemon (as a background process). This parameter can
/// only be set if the pid (process id) file is specified. That is, unless a
/// value to the parameter pid-file is given, then the server will report an
/// error and exit.
///
/// <hr>
///
/// @anchor CommandLineSupervisor
/////////////////////////////////
/// @CMDOPT{--supervisor}
///
/// Executes the server in supervisor mode. In the event that the server
/// unexpectedly terminates due to an internal error, the supervisor will
/// automatically restart the server. Setting this flag automatically implies
/// that the server will run as a daemon. Note that, as with the daemon flag,
/// this flag requires that the pid-file parameter will set.
///
/// <hr>
///
/// @anchor CommandLineUid
//////////////////////////
/// @copydetails triagens::rest::ApplicationServerImpl::uid
/// <hr>
///
/// @anchor CommandLineGid
//////////////////////////
/// @copydetails triagens::rest::ApplicationServerImpl::gid
/// <hr>
///
/// @anchor CommandLinePidFile
//////////////////////////////
/// @copydetails triagens::rest::AnyServer::_pidFile
/// <hr>
///
/// Next steps:
///////////////
///
/// @copydetails CommandLineSubTOC
////////////////////////////////////////////////////////////////////////////////

////////////////////////////////////////////////////////////////////////////////
/// @page CommandLineAvocadoTOC
///
/// <ol>
///  <li>@ref CommandLineAvocadoHttpPort "server.http-port"</li>
///  <li>@ref CommandLineAvocadoAdminPort "server.admin-port"</li>
///  <li>@ref CommandLineAvocadoDirectory "database.directory"</li>
///  <li>@ref CommandLineAvocadoMaximalJournalSize "database.maximal-journal-size"</li>
///  <li>@ref CommandLineAvocadoRemoveOnDrop "database.remove-on-drop"</li>
/// </ol>
////////////////////////////////////////////////////////////////////////////////

////////////////////////////////////////////////////////////////////////////////
/// @page CommandLineAvocado Command-Line Options for the AvocadoDB
///
/// <hr>
/// @copydoc CommandLineAvocadoTOC
/// <hr>
///
/// @anchor CommandLineAvocadoHttpPort
/// @copydetails triagens::avocado::AvocadoServer::_httpPort
/// <hr>
///
/// @anchor CommandLineAvocadoAdminPort
/// @copydetails triagens::avocado::AvocadoServer::_adminPort
/// <hr>
///
/// @anchor CommandLineAvocadoDirectory
/// @copydetails triagens::avocado::AvocadoServer::_databasePath
/// <hr>
///
/// @anchor CommandLineAvocadoMaximalJournalSize
/// @copydetails triagens::avocado::AvocadoServer::_defaultMaximalSize
/// <hr>
///
/// @anchor CommandLineAvocadoRemoveOnDrop
/// @copydetails triagens::avocado::AvocadoServer::_removeOnDrop
////////////////////////////////////////////////////////////////////////////////

// Local Variables:
// mode: c++
// mode: outline-minor
// outline-regexp: "^\\(/// @brief\\|/// {@inheritDoc}\\|/// @addtogroup\\|// --SECTION--\\|/// @page\\|/// @\\}\\)"
// End: