From c3bc85826a7a1b38c9862c10282bddcd0f72d799 Mon Sep 17 00:00:00 2001 From: Frank Celler Date: Fri, 23 Nov 2012 11:11:41 +0100 Subject: [PATCH] renamed Manual to UserManual, fixed references, removed First section --- .../FirstStepsArangoDB.md | 69 +++++++++++++- .../FirstStepsArangoDBTOC.md | 5 +- Documentation/{Manual => UserManual}/Home.md | 0 .../{Manual => UserManual}/NewFeatures11.md | 0 .../{Manual => UserManual}/Upgrading.md | 0 Documentation/arango.template.in | 5 +- Documentation/arangodb.css | 4 + arangod/Documentation/dba-manual.dox | 29 ++++++ arangod/Documentation/user-manual.dox | 91 ------------------- 9 files changed, 104 insertions(+), 99 deletions(-) rename Documentation/{Manual => UserManual}/FirstStepsArangoDB.md (81%) rename Documentation/{Manual => UserManual}/FirstStepsArangoDBTOC.md (66%) rename Documentation/{Manual => UserManual}/Home.md (100%) rename Documentation/{Manual => UserManual}/NewFeatures11.md (100%) rename Documentation/{Manual => UserManual}/Upgrading.md (100%) diff --git a/Documentation/Manual/FirstStepsArangoDB.md b/Documentation/UserManual/FirstStepsArangoDB.md similarity index 81% rename from Documentation/Manual/FirstStepsArangoDB.md rename to Documentation/UserManual/FirstStepsArangoDB.md index 60f1ebf024..c6b221c6bb 100644 --- a/Documentation/Manual/FirstStepsArangoDB.md +++ b/Documentation/UserManual/FirstStepsArangoDB.md @@ -1,7 +1,7 @@ First Steps with ArangoDB {#FirstStepsArangoDB} =============================================== -@NAVIGATE{UserManualBasics,UserManual,UserManualArangosh} +@NAVIGATE_FIRST{UserManual,UserManualArangosh} @EMBEDTOC{FirstStepsArangoDBTOC} What is ArangoDB? {#FirstStepsArangoDBIntro} @@ -90,11 +90,11 @@ The ArangoDB database package comes with the following programs: - `arangod`: The ArangoDB database daemon. This server program is intended to run as daemon process and to server the various clients connection to the server via TCP / HTTP. See @ref - UserManualServerStartStop. + FirstStepsServerStartStop. - `arango-update`: Used to initialize or update the database. - `arangosh`: The ArangoDB shell. A client that implements a read-eval-print loop (REPL) and provides functions to access and - administrate the ArangoDB server. See @ref UserManualShellStartStop. + administrate the ArangoDB server. See @ref FirstStepsShellStartStop. - `arangoimp`: A bulk importer for the ArangoDB server. See @ref ImpManual @@ -304,8 +304,26 @@ You can learn all about the query language @ref Aql "here". Note that `_query` is a short-cut for `_createStatement` and `execute`. We will come back to these functions when we talk about cursors. -Details about Starting the ArangoDB Server {#FirstStepsServerStartStop} -======================================================================= +ArangoDB's Front-End {#FirstStepsArangoDBFE} +-------------------------------------------- + +The ArangoDB server has a graphical front-end, which allows you to +inspect the current state of the server from within your browser. You +can use the front-end using the following URL: + + http://localhost:8529/_admin + +Unless you have loaded an application into the ArangoDB server, which remaps +the paths, the front-end will also be available under + + http://localhost:8529/ + +The front-end allows you to browse through the collections and +documents. If you need to administrate the database, please use +the ArangoDB shell described in the next section. + +Details about the ArangoDB Server {#FirstStepsServerStartStop} +============================================================== The ArangoDB database server has two modes of operation: as server, where it will answer to client requests, and an emergency console, in which you can @@ -398,3 +416,44 @@ more information see @ref CommandLineLogging "here". @CMDOPT{\--daemon} Runs the server as a daemon (as a background process). + +Details about the ArangoDB Shell {#FirstStepsShellStartStop} +============================================================ + +After the server has been @ref FirstStepsServerStartStop "started", +you can use the ArangoDB shell (arangosh) to administrate the +server. Without any arguments, the ArangoDB shell will try to contact +the server on port 8529 on the localhost. For more information see +@ref UserManualArangosh. You might need to set additional options +(endpoint, username, and password) when connecting: + + unix> ./arangosh --server.endpoint tcp://127.0.0.1:8529 --server.username root + +The shell will print its own version number and, if successfully connected +to a server, the version number of the ArangoDB server. + +Command-Line Options {#FirstStepsShellStartStopOptions} +------------------------------------------------------- + +Use @LIT{--help} to get a list of command-line options: + + > ./arangosh --help + STANDARD options: + --help help message + --javascript.modules-path one or more directories separated by cola (default: "...") + --javascript.startup-directory startup paths containing the JavaScript files; multiple directories can be separated by cola + --javascript.unit-tests do not start as shell, run unit tests instead + --jslint do not start as shell, run jslint instead + --log.level log level (default: "info") + --max-upload-size maximum size of import chunks (in bytes) (default: 500000) + --no-auto-complete disable auto completion + --no-colors deactivate color support + --pager output pager (default: "less -X -R -F -L") + --pretty-print pretty print values + --quiet no banner + --server.connect-timeout connect timeout in seconds (default: 3) + --server.endpoint endpoint to connect to, use 'none' to start without a server (default: "tcp://127.0.0.1:8529") + --server.password password to use when connecting (leave empty for prompt) + --server.request-timeout request timeout in seconds (default: 300) + --server.username username to use when connecting (default: "root") + --use-pager use pager diff --git a/Documentation/Manual/FirstStepsArangoDBTOC.md b/Documentation/UserManual/FirstStepsArangoDBTOC.md similarity index 66% rename from Documentation/Manual/FirstStepsArangoDBTOC.md rename to Documentation/UserManual/FirstStepsArangoDBTOC.md index 2aee4855cc..5a38afcee8 100644 --- a/Documentation/Manual/FirstStepsArangoDBTOC.md +++ b/Documentation/UserManual/FirstStepsArangoDBTOC.md @@ -7,5 +7,8 @@ TOC {#FirstStepsArangoDBTOC} - @ref FirstStepsArangoDBFirstSteps - @ref FirstStepsArangoDBConnecting - @ref FirstStepsArangoDBQuerying + - @ref FirstStepsArangoDBFE - @ref FirstStepsServerStartStop - - @ref FirstStepsServerStartStopOptions \ No newline at end of file + - @ref FirstStepsServerStartStopOptions + - @ref FirstStepsShellStartStop + - @ref FirstStepsShellStartStopOptions diff --git a/Documentation/Manual/Home.md b/Documentation/UserManual/Home.md similarity index 100% rename from Documentation/Manual/Home.md rename to Documentation/UserManual/Home.md diff --git a/Documentation/Manual/NewFeatures11.md b/Documentation/UserManual/NewFeatures11.md similarity index 100% rename from Documentation/Manual/NewFeatures11.md rename to Documentation/UserManual/NewFeatures11.md diff --git a/Documentation/Manual/Upgrading.md b/Documentation/UserManual/Upgrading.md similarity index 100% rename from Documentation/Manual/Upgrading.md rename to Documentation/UserManual/Upgrading.md diff --git a/Documentation/arango.template.in b/Documentation/arango.template.in index 15f0e5431b..9f62ca9840 100644 --- a/Documentation/arango.template.in +++ b/Documentation/arango.template.in @@ -221,6 +221,7 @@ ALIASES += \ # navigation ALIASES += \ "NAVIGATE{3}=@htmlonly
prev | home | next
@endhtmlonly" \ + "NAVIGATE_FIRST{2}=@htmlonly
prev | home | next
@endhtmlonly" \ "EMBEDTOC{1}=@if LATEX@else@htmlonly
@endhtmlonly@copydoc \1\n@htmlonly
@endhtmlonly@endif" # glossary @@ -713,7 +714,7 @@ WARN_LOGFILE = # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = @srcdir@/Documentation/Manual \ +INPUT = @srcdir@/Documentation/UserManual \ @srcdir@/Doxygen/js \ @srcdir@/arangod \ @srcdir@/lib @@ -1833,7 +1834,7 @@ MSCFILE_DIRS = # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. -DOT_GRAPH_MAX_NODES = 50 +DOT_GRAPH_MAX_NODES = 100 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the # graphs generated by dot. A depth value of 3 means that only nodes reachable diff --git a/Documentation/arangodb.css b/Documentation/arangodb.css index 428d2dd2f3..3e5b5e1157 100644 --- a/Documentation/arangodb.css +++ b/Documentation/arangodb.css @@ -85,6 +85,10 @@ margin-bottom: 0px; } +#content div.arangodb ul ul { + margin-bottom: 0px; +} + /* ************************************************************************** */ /* pre */ /* ************************************************************************** */ diff --git a/arangod/Documentation/dba-manual.dox b/arangod/Documentation/dba-manual.dox index 0f081b347e..e410b16d1e 100644 --- a/arangod/Documentation/dba-manual.dox +++ b/arangod/Documentation/dba-manual.dox @@ -37,6 +37,7 @@ ///
  • @ref DbaManualBasics
    • ///
  • @ref DbaManualAuthentication
    • ///
  • @ref DbaManualDatafileDebugger
    • +///
  • @ref DbaManualEmergencyConsole
    • ///
  • @ref ShellCollection
    • ///
  • @ref ShellIndex
    • ///
  • @ref IndexCap
    • @@ -51,6 +52,7 @@ /// @copydetails DbaManualBasicsTOC /// @copydetails DbaManualAuthenticationTOC /// @copydetails DbaManualDatafileDebuggerTOC +/// @copydetails DbaManualEmergencyConsoleTOC /// @copydetails ShellCollectionTOC /// @copydetails ShellIndexTOC /// @copydetails IndexesTOC @@ -203,6 +205,33 @@ /// in order to check the consistency of the datafiles and journals. //////////////////////////////////////////////////////////////////////////////// +// ----------------------------------------------------------------------------- +// --SECTION-- DBA MANUAL EMERGENCY CONSOLE +// ----------------------------------------------------------------------------- + +//////////////////////////////////////////////////////////////////////////////// +/// @page DbaManualEmergencyConsoleTOC +/// +///
      +///
    • @ref DbaManualEmergencyConsole +///
      • +///
    +//////////////////////////////////////////////////////////////////////////////// + +//////////////////////////////////////////////////////////////////////////////// +/// @page DbaManualEmergencyConsole Emergency Console +/// +/// @EMBEDTOC{DbaManualEmergencyConsoleTOC} +/// +/// The following command starts a emergency console. See below for a list of +/// frequently used options, see @ref CommandLine "here" for a complete list. +/// +/// @note Never start the emergency console for a database which also has a +/// server attached to it. In general the ArangoDB shell is what you want. +/// +/// @EXAMPLE{start-emergency-console,emergency console} +//////////////////////////////////////////////////////////////////////////////// + // ----------------------------------------------------------------------------- // --SECTION-- END-OF-FILE // ----------------------------------------------------------------------------- diff --git a/arangod/Documentation/user-manual.dox b/arangod/Documentation/user-manual.dox index f213b99cdd..140c081500 100644 --- a/arangod/Documentation/user-manual.dox +++ b/arangod/Documentation/user-manual.dox @@ -34,7 +34,6 @@ /// /// @if LATEX ///
      -///
    • @ref UserManualBasics
      • ///
    • @ref FirstStepsArangoDB
      • ///
    • @ref UserManualArangosh
      • ///
    • @ref ShellCollection
      • @@ -49,7 +48,6 @@ ///
    • @ref Glossary
      • ///
    /// @else -/// @copydetails UserManualBasicsTOC /// @copydetails FirstStepsArangoDBTOC /// @copydetails UserManualArangoshTOC /// @copydetails ShellCollectionTOC @@ -62,95 +60,6 @@ /// @endif //////////////////////////////////////////////////////////////////////////////// -// ----------------------------------------------------------------------------- -// --SECTION-- USER MANUAL BASICS -// ----------------------------------------------------------------------------- - -//////////////////////////////////////////////////////////////////////////////// -/// @page UserManualBasicsTOC -/// -///
      -///
    • @ref UserManualBasics -///
        -///
      • @ref UserManualServerStartStop -///
          -///
        • @ref UserManualServerStartStopOptions
          • -///
        -///
        • -///
      • @ref UserManualServerFE
        • -///
      • @ref UserManualShellStartStop -///
          -///
        • @ref UserManualShellStartStopOptions
          • -///
        -///
        • -///
      • @ref UserManualServerStartStopDebug -///
        • -///
      -///
      • -///
    -//////////////////////////////////////////////////////////////////////////////// - -//////////////////////////////////////////////////////////////////////////////// -/// @page UserManualBasics About ArangoDB -/// -/// @EMBEDTOC{UserManualBasicsTOC} -/// -/// @section UserManualServerFE ArangoDB's Front-End -//////////////////////////////////////////////////// -/// -/// The ArangoDB server has a graphical front-end, which allows you to inspect -/// the current state of the server from within your browser. You can use the -/// front-end using the following URL: -/// -/// @LIT{http://localhost:8529/_admin} -/// -/// Unless you have loaded an application into the ArangoDB server, which remaps -/// the paths, the front-end will also be available under -/// -/// @LIT{http://localhost:8529/}. -/// -/// The front-end allows you to browse through the collections and -/// documents. If you need to administrate the database, please use -/// the ArangoDB shell described in the next section. -/// -/// @section UserManualShellStartStop Starting the ArangoDB Shell -///////////////////////////////////////////////////////////////// -/// -/// After the server has been @ref UserManualServerStartStop "started", -/// you can use the ArangoDB shell (arangosh) to administrate the server. Without -/// any arguments, the ArangoDB shell will try to contact the server -/// on port 8529 on the localhost. For more information see @ref -/// UserManualArangosh. -/// -/// @TINYEXAMPLE{arangosh-start,starting the shell} -/// -/// You might need to set additional options (endpoint, username, and password) -/// when connecting: -/// -/// @verbinclude arangosh-start-full -/// -/// The shell will print its own version number and, if successfully connected -/// to a server, the version number of the ArangoDB server. -/// -/// @subsection UserManualShellStartStopOptions Command-Line Options -//////////////////////////////////////////////////////////////////// -/// -/// Use @LIT{\-\-help} to get a list of command-line options: -/// -/// @TINYEXAMPLE{arangosh-options,shell options} -/// -/// @section UserManualServerStartStopDebug Starting the ArangoDB Emergency Console -/////////////////////////////////////////////////////////////////////////////////// -/// -/// The following command starts a emergency console. See below for a list of -/// frequently used options, see @ref CommandLine "here" for a complete list. -/// -/// @note Never start the emergency console for a database which also has a -/// server attached to it. In general the ArangoDB shell is what you want. -/// -/// @EXAMPLE{start-emergency-console,emergency console} -//////////////////////////////////////////////////////////////////////////////// - // ----------------------------------------------------------------------------- // --SECTION-- USER MANUAL ARANGOSH // -----------------------------------------------------------------------------