Hawkin
/
arangodb
mirror of https://gitee.com/bigwinds/arangodb
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

added man page for foxx manager

This commit is contained in:
Jan Steemann 2013-07-26 22:30:18 +02:00
parent 44d6aecef1
commit d8325a1d15
3 changed files with 32 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Documentation/Makefile.files
View File

@ -27,7 +27,8 @@ dist_man_MANS += \
Documentation/man/man1/arangosh.1 \ Documentation/man/man1/arangosh.1 \
Documentation/man/man8/rcarangod.8 \ Documentation/man/man8/rcarangod.8 \
Documentation/man/man8/arangod.8 \ Documentation/man/man8/arangod.8 \
Documentation/man/man8/arango-dfdb.8 Documentation/man/man8/arango-dfdb.8 \
Documentation/man/man8/foxx-manager.8
################################################################################ ################################################################################
### @brief JavaScript files ### @brief JavaScript files
@ -172,6 +173,8 @@ Doxygen/.setup-directories:
@test -d Doxygen/js/common/modules/org/arangodb/aql || mkdir -p Doxygen/js/common/modules/org/arangodb/aql @test -d Doxygen/js/common/modules/org/arangodb/aql || mkdir -p Doxygen/js/common/modules/org/arangodb/aql
@test -d Doxygen/js/server/modules/org/arangodb/graph || mkdir -p Doxygen/js/server/modules/org/arangodb/graph @test -d Doxygen/js/server/modules/org/arangodb/graph || mkdir -p Doxygen/js/server/modules/org/arangodb/graph
@test -d Doxygen/js/client || mkdir -p Doxygen/js/client @test -d Doxygen/js/client || mkdir -p Doxygen/js/client
@test -d Doxygen/man/man1 || mkdir -p Doxygen/man/man1
@test -d Doxygen/man/man8 || mkdir -p Doxygen/man/man8
@test -d Doxygen/latex/images || mkdir -p Doxygen/latex/images @test -d Doxygen/latex/images || mkdir -p Doxygen/latex/images
@test -d Doxygen/wiki || mkdir -p Doxygen/wiki @test -d Doxygen/wiki || mkdir -p Doxygen/wiki
@test -d Doxygen/xml || mkdir -p Doxygen/xml @test -d Doxygen/xml || mkdir -p Doxygen/xml

2
Documentation/Scripts/man.sed
View File

@ -19,5 +19,5 @@ s/\<ENDEXAMPLE\>/\n\.EE\n/g
i\ i\
a\ a\
Copyright 2012, triAGENS GmbH, Cologne, Germany Copyright triAGENS GmbH, Cologne, Germany
} }

27
Documentation/man8/foxx-manager Normal file
View File

@ -0,0 +1,27 @@
COMMAND SECTION "DATE" "" "ArangoDB"
NAME
COMMAND - a Foxx application manager for ArangoDB
SYNOPSIS
COMMAND options
DESCRIPTION
The COMMAND binary can be used to manage Foxx applications in the
ArangoDB database server. Foxx applications can be installed and
uninstalled.
More specific instructions are displayed when the program is invoked.
OPTIONS
OPTION "--server.disable-authentication <boolean>"
disable the password prompt when connecting to the server ENDOPTION
EXAMPLES
EXAMPLE COMMAND search "foobar"
searches the central repository for an application "foobar"ENDEXAMPLE
EXAMPLE COMMAND update
updates the local repository with applications from the central repositoryENDEXAMPLE
EXAMPLE COMMAND list
list all installed Foxx applicationsENDEXAMPLE
EXAMPLE COMMAND install "hello-foxx" "/hello"
installs the "hello-foxx" application under the mount point "/hello"ENDEXAMPLE
EXAMPLE COMMAND uninstall "/hello"
uninstalls the application that is mounted under "/hello"ENDEXAMPLE
EXAMPLE COMMAND help
shows the help pageENDEXAMPLE
AUTHOR