1
0
Fork 0
arangodb/Documentation/man/man8/foxx-manager.8

48 lines
1.5 KiB
Groff

.TH foxx-manager 8 "Do 23. Jan 09:57:20 CET 2014" "" "ArangoDB"
.SH NAME
foxx-manager - a Foxx application manager for ArangoDB
.SH SYNOPSIS
foxx-manager options
.SH DESCRIPTION
The foxx-manager 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.
.SH OPTIONS
.IP "--server.database <string>"
database name to use when connection (default: "_system")
.IP "--server.username <string>"
username to use when connecting (default "root")
.IP "--server.password <string>"
password to use when connecting. Don't specify this option to get a password prompt
.IP "--server.disable-authentication <boolean>"
disable the password prompt and authentication when connecting to the server
.SH EXAMPLES
.EX
shell> foxx-manager search "foobar"
searches the central repository for an application "foobar"
.EE
.EX
shell> foxx-manager update
updates the local repository with applications from the central repositoryENDEXAMPLE
.EX
shell> foxx-manager list
list all installed Foxx applicationsENDEXAMPLE
.EX
shell> foxx-manager install "hello-foxx" "/hello"
installs the "hello-foxx" application under the mount point "/hello"
.EE
.EX
shell> foxx-manager uninstall "/hello"
uninstalls the application that is mounted under "/hello"
.EE
.EX
shell> foxx-manager help
shows the help pageENDEXAMPLE
.SH AUTHOR
Copyright triAGENS GmbH, Cologne, Germany