mirror of https://gitee.com/bigwinds/arangodb
169 lines
5.5 KiB
Plaintext
169 lines
5.5 KiB
Plaintext
////////////////////////////////////////////////////////////////////////////////
|
|
/// @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>@ref JSModuleActions</li>
|
|
/// <li>@ref JSModuleConsole</li>
|
|
/// <li>@ref JSModuleFs</li>
|
|
/// <li>@ref JSModuleGraph</li>
|
|
/// <li>@ref JSModuleInternal</li>
|
|
/// </ol>
|
|
/// </li>
|
|
/// <li>@ref Indexes
|
|
/// @copydetails IndexesTOC
|
|
/// </li>
|
|
/// <li>Shell Commands
|
|
/// <ol>
|
|
/// <li>@ref ShellDocument</li>
|
|
/// </ol>
|
|
/// </li>
|
|
/// <li>@ref OTWP
|
|
/// <ol>
|
|
/// <li>@ref RestDocument</li>
|
|
/// <li>@ref RestEdge</li>
|
|
/// <li>@ref HttpCollection</li>
|
|
/// <li>@ref HttpIndex</li>
|
|
/// </ol>
|
|
/// </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>configuration</li>
|
|
/// <li>daemon</li>
|
|
/// <li>gid</li>
|
|
/// <li>help</li>
|
|
/// <li>pid-file</li>
|
|
/// <li>uid</li>
|
|
/// <li>version</li>
|
|
/// </ol>
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @page CommandLine Command-Line Options
|
|
///
|
|
/// <hr>
|
|
/// @copydoc CommandLineTOC
|
|
/// <hr>
|
|
///
|
|
/// @section GeneralOptions General Options
|
|
///
|
|
/// @copydetails triagens::rest::ApplicationServerImpl::initFile
|
|
///
|
|
/// @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.
|
|
///
|
|
/// @copydetails triagens::rest::ApplicationServerImpl::gid
|
|
///
|
|
/// @copydetails triagens::rest::ApplicationServerImpl::options
|
|
///
|
|
/// @copydetails triagens::rest::AnyServer::_pidFile
|
|
///
|
|
/// @CMDOPT{--show-io-backends}
|
|
///
|
|
/// If this option is specified, then the server will list available backends
|
|
/// and exit. This option is useful only when used in conjunction with the
|
|
/// option scheduler.backend. An integer is returned (which is platform
|
|
/// dependent) which indicates available backends on your platform. See libev
|
|
/// for further details and for the meaning of the integer returned. This
|
|
/// describes the allowed integers for @CODE{scheduler.backend}, see
|
|
/// @ref CommandLineScheduler "here" for details.
|
|
///
|
|
/// @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.
|
|
///
|
|
/// @copydetails triagens::rest::ApplicationServerImpl::uid
|
|
///
|
|
/// @copydetails triagens::rest::ApplicationServerImpl::version
|
|
///
|
|
/// <hr>
|
|
/// Next steps:
|
|
///
|
|
/// @copydetails CommandLineSubTOC
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @page CommandLineAvocadoTOC
|
|
///
|
|
/// <ol>
|
|
/// <li>database.directory</li>
|
|
/// <li>server.admin-port</li>
|
|
/// <li>server.http-port</li>
|
|
/// </ol>
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @page CommandLineAvocado Command-Line Options for the AvocadoDB
|
|
///
|
|
/// <hr>
|
|
/// @copydoc CommandLineAvocadoTOC
|
|
/// <hr>
|
|
///
|
|
/// @copydetails triagens::avocado::AvocadoServer::_databasePath
|
|
///
|
|
/// @copydetails triagens::avocado::AvocadoServer::_adminPort
|
|
///
|
|
/// @copydetails triagens::avocado::AvocadoServer::_httpPort
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
// Local Variables:
|
|
// mode: c++
|
|
// mode: outline-minor
|
|
// outline-regexp: "^\\(/// @brief\\|/// {@inheritDoc}\\|/// @addtogroup\\|// --SECTION--\\|/// @page\\|/// @\\}\\)"
|
|
// End:
|