1
0
Fork 0

fixed documentation

This commit is contained in:
Jan Steemann 2012-07-26 09:22:52 +02:00
parent 7a0e9d350d
commit cc9952f460
3 changed files with 36 additions and 16 deletions

View File

@ -1,16 +1,20 @@
> ./arangosh --help
STANDARD options:
--help help message
--log.level <string> log level (default: "info")
--max-upload-size <uint64> maximum size of import chunks (default: 500000)
--no-auto-complete disable auto completion
--no-colors deactivate color support
--pager <string> output pager (default: "less -X -R -F -L")
--pretty-print pretty print values
--server <string> server address and port (default: "127.0.0.1:8529")
--startup.directory <string> startup paths containing the JavaScript files; multiple directories can be
separated by cola
--startup.modules-path <string> one or more directories separated by cola (default:
"./js/client/modules;./js/common/modules")
--unit-tests <string> do not start as shell, run unit tests instead
--use-pager use pager
--help help message
--javascript.modules-path <string> one or more directories separated by cola (default: "bin/../js/client/modules;bin/../js/common/modules")
--javascript.startup-directory <string> startup paths containing the JavaScript files; multiple directories can be separated by cola
--javascript.unit-tests <string> do not start as shell, run unit tests instead
--jslint <string> do not start as shell, run jslint instead
--log.level <string> log level (default: "info")
--max-upload-size <uint64> maximum size of import chunks (in bytes) (default: 500000)
--no-auto-complete disable auto completion
--no-colors deactivate color support
--pager <string> output pager (default: "less -X -R -F -L")
--pretty-print pretty print values
--quiet no banner
--server.connect-timeout <int64> connect timeout in seconds (default: 3)
--server.endpoint <string> endpoint to connect to, use 'none' to start without a server (default: "tcp://127.0.0.1:8529")
--server.password <string> password to use when connecting (leave empty for prompt)
--server.request-timeout <int64> request timeout in seconds (default: 300)
--server.username <string> username to use when connecting (default: "root")
--use-pager use pager

View File

@ -75,10 +75,24 @@
/// To import these records, all you need to do is to put them into a file (with
/// one line for each record to import) and run the following command:
///
/// @LIT{arangoimp --file "data.json" --type json --collection "users"}
/// @LIT{./arangoimp --file "data.json" --type json --collection "users"}
///
/// This will transfer the data to the server, import the records, and print a
/// status summary.
/// status summary.
///
/// By default, the endpoint @LIT{tcp://127.0.0.1:8529} will be used.
/// If you want to specify a different endpoint, you can use the --server.endpoint
/// option. You probably want to specify a database user and password as well.
/// You can do so by using the options --server.username and --server.password.
/// If you do not specify a password, you will be prompted for one.
///
/// @LIT{./arangoimp --server.endpoint tcp://127.0.0.1:8529 --server.username root --file "data.json" --type json --collection "users"}
///
/// Note that the collection (@LIT{users} in this case) must already exist or
/// the import will fail. If you want to create a new collection with the import
/// data, you need to specify the --create-collection option.
///
/// @LIT{./arangoimp --file "data.json" --type json --collection "users" --create-collection true}
///
/// As the import file already contains the data in JSON format, attribute names
/// and data types are fully preserved. As can be seen in the example data,

View File

@ -329,6 +329,8 @@ namespace triagens {
/// Settings @CA{value} to true will turn off authentication on the server side
/// so all clients can execute any action without authorisation and privilege
/// checks.
///
/// The default value is @LIT{false}.
////////////////////////////////////////////////////////////////////////////////
bool _disableAuthentication;