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

man pages

This commit is contained in:
Jan Steemann 2012-09-03 13:02:19 +02:00
parent 634b6f65e9
commit ffc5f9ed6d
4 changed files with 77 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Documentation/Makefile.doxygen
View File

@ -28,6 +28,8 @@ Doxygen/.setup-directories:
@test -d Doxygen/latex || mkdir Doxygen/latex @test -d Doxygen/latex || mkdir Doxygen/latex
@test -d Doxygen/latex/images || mkdir Doxygen/latex/images @test -d Doxygen/latex/images || mkdir Doxygen/latex/images
@test -d Doxygen/man || mkdir Doxygen/man @test -d Doxygen/man || mkdir Doxygen/man
@test -d Doxygen/man/man1 || mkdir Doxygen/man/man1
@test -d Doxygen/man/man8 || mkdir Doxygen/man/man8
@test -d Doxygen/wiki || mkdir Doxygen/wiki @test -d Doxygen/wiki || mkdir Doxygen/wiki
@test -d Doxygen/xml || mkdir Doxygen/xml @test -d Doxygen/xml || mkdir Doxygen/xml
@touch $@ @touch $@
@ -71,12 +73,8 @@ doxygen: Doxygen/.setup-directories Doxygen/arango-html.doxy $(DOXYGEN)
.PHONY: man .PHONY: man
Doxygen/arango-man.doxy: Documentation/arango.template man: Doxygen/.setup-directories
sed -e 's:GENERATE_MAN *= *NO:GENERATE_MAN = YES:' -e 's:ENABLED_SECTIONS *=:ENABLED_SECTIONS = MAN:' < $< > $@ sed -f Documentation/man.sed -e "s/DATE/`date`/g" arangod/Documentation/arangod > Doxygen/man/man8/arangod.8
$(MAKE) lib/BasicsC/voc-errors.h
man: Doxygen/.setup-directories Doxygen/arango-man.doxy $(DOXYGEN)
doxygen Doxygen/arango-man.doxy > /dev/null
################################################################################ ################################################################################
### @brief wiki ### @brief wiki

22
Documentation/man.sed Normal file
View File

@ -0,0 +1,22 @@
1s/^\(.*\)$/\.TH \1/
/NAME/s/^\(.*\)$/\.SH \1/
/SYNOPSIS/s/^\(.*\)$/\.SH \1/
/DESCRIPTION/s/^\(.*\)$/\.SH \1/
/OPTIONS/s/^\(.*\)$/\.SH \1/
/\<EXAMPLES\>/s/^\(.*\)$/\.SH \1/
/FILES/s/^\(.*\)$/\.SH \1/
/AUTHOR/s/^\(.*\)$/\.SH \1/
s/\<OPTION\>/\.IP/g
s/\<ENDOPTION\>//g
s/\<EXAMPLE\>/\.EX\nshell>/g
s/\<ENDEXAMPLE\>/\n\.EE\n/g
/SEE ALSO/,/AUTHOR/{
/^[a-z]/s/^\(.*\)$/\.BR \1/
s/(\([1-9]\))/ "(\1), "/g
}
/AUTHOR/{
i\
a\
Copyright 2012, triAGENS GmbH, Cologne, Germany
}

10
Makefile.in
View File

@ -5616,6 +5616,8 @@ Doxygen/.setup-directories:
@test -d Doxygen/latex || mkdir Doxygen/latex @test -d Doxygen/latex || mkdir Doxygen/latex
@test -d Doxygen/latex/images || mkdir Doxygen/latex/images @test -d Doxygen/latex/images || mkdir Doxygen/latex/images
@test -d Doxygen/man || mkdir Doxygen/man @test -d Doxygen/man || mkdir Doxygen/man
@test -d Doxygen/man/man1 || mkdir Doxygen/man/man1
@test -d Doxygen/man/man8 || mkdir Doxygen/man/man8
@test -d Doxygen/wiki || mkdir Doxygen/wiki @test -d Doxygen/wiki || mkdir Doxygen/wiki
@test -d Doxygen/xml || mkdir Doxygen/xml @test -d Doxygen/xml || mkdir Doxygen/xml
@touch $@ @touch $@
@ -5659,12 +5661,8 @@ doxygen: Doxygen/.setup-directories Doxygen/arango-html.doxy $(DOXYGEN)
.PHONY: man .PHONY: man
Doxygen/arango-man.doxy: Documentation/arango.template man: Doxygen/.setup-directories
sed -e 's:GENERATE_MAN *= *NO:GENERATE_MAN = YES:' -e 's:ENABLED_SECTIONS *=:ENABLED_SECTIONS = MAN:' < $< > $@ sed -f Documentation/man.sed -e "s/DATE/`date`/g" arangod/Documentation/arangod > Doxygen/man/man8/arangod.8
$(MAKE) lib/BasicsC/voc-errors.h
man: Doxygen/.setup-directories Doxygen/arango-man.doxy $(DOXYGEN)
doxygen Doxygen/arango-man.doxy > /dev/null
################################################################################ ################################################################################
### @brief wiki ### @brief wiki

47
arangod/Documentation/arangod Normal file
View File

@ -0,0 +1,47 @@
arangod 8 "DATE" "" "ArangoDB"
NAME
arangod - the ArangoDB database server
SYNOPSIS
arangod [options] database-directory
DESCRIPTION
The arangod binary can be used to start the ArangoDB database
server. By default, the server will run in a mode that allows
clients to connect to it via the network. The server also has
an emergency console mode that can be used for any sort of
maintenance operations. In the emergency console mode, the
server does not allow any clients to connect.
OPTIONS
The arangod binary has many options that can be used to control
its behavior.
For a complete list of options, please refer to the ArangoDB
online manual, available at http://www.arangodb.org/
The most important startup options are:
OPTION "--configuration <string>"
read configuration from file <string> ENDOPTION
OPTION "--console"
do not start as server, start an emergency console instead ENDOPTION
OPTION "--log.file <string>"
log to file <string> ENDOPTION
OPTION "--log.level <string>"
set the log level (possible values: "fatal", "error", "warning", "info", "debug", "trace") ENDOPTION
OPTION "--server.endpoint <string>"
listen endpoint for client requests, consisting of protocol, ip address and port ENDOPTION
OPTION "--database.directory <string>"
path to the database directory ENDOPTION
EXAMPLES
EXAMPLE arangod /data/arangodb
starts the server with database directory /data/arangodb ENDEXAMPLE
EXAMPLE arangod --database.directory /data/arangodb
same, but uses --database.directory option instead ENDEXAMPLE
EXAMPLE arangod --log.level debug /data/arangodb
starts server with log level "debug" ENDEXAMPLE
EXAMPLE arangod --server.endpoint tcp://127.0.0.1:8529 /data/arangodb
starts server listening on port 8529 of IP 127.0.0.1 ENDEXAMPLE
EXAMPLE arangod --server.endpoint tcp://192.168.173.13:8529
--server.endpoint ssl://192.168.173.13:8530 /data/arangodb
starts server with two endpoints: port 8529 for unencrypted requests and 8530 for ssl-encrypted requests ENDEXAMPLE
EXAMPLE arangod --console /data/arangodb
starts the emergency console ENDEXAMPLE
AUTHOR