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

removes generated manpages from devel (#6468)

This commit is contained in:
Jan Christoph Uhde 2018-10-23 20:41:00 +02:00 committed by Jan
parent ad4d7dcc22
commit 66338f117d
15 changed files with 24 additions and 204 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.gitignore vendored
View File

@ -35,6 +35,8 @@ testresult.json
testsStarted testsStarted
soc-pokec-* soc-pokec-*
Documentation/man
build.sh build.sh
/build*/ /build*/
Build64/ Build64/

12
CMakeLists.txt
View File

@ -1120,6 +1120,7 @@ if (MSVC)
include(generate_product_version) include(generate_product_version)
endif() endif()
add_subdirectory(Documentation)
include(ArangoDBInstall) include(ArangoDBInstall)
include(frontend/aardvark) include(frontend/aardvark)
if (NOT(SKIP_PACKAGING)) if (NOT(SKIP_PACKAGING))
@ -1236,7 +1237,6 @@ add_subdirectory(lib)
add_subdirectory(arangosh) add_subdirectory(arangosh)
add_subdirectory(arangod) add_subdirectory(arangod)
add_subdirectory(Documentation)
if (USE_CATCH_TESTS) if (USE_CATCH_TESTS)
add_subdirectory(tests) add_subdirectory(tests)
@ -1250,6 +1250,16 @@ add_dependencies(arangoimport zlibstatic)
add_dependencies(arangorestore zlibstatic) add_dependencies(arangorestore zlibstatic)
add_dependencies(arangosh zlibstatic) add_dependencies(arangosh zlibstatic)
if(UNIX)
add_dependencies(arangobench man)
add_dependencies(arangod man)
add_dependencies(arangodump man)
add_dependencies(arangoexport man)
add_dependencies(arangoimport man)
add_dependencies(arangorestore man)
add_dependencies(arangosh man)
endif()
if (NOT USE_PRECOMPILED_V8) if (NOT USE_PRECOMPILED_V8)
# all binaries depend on v8_build because it contains ICU as well # all binaries depend on v8_build because it contains ICU as well
add_dependencies(arangobench v8_build) add_dependencies(arangobench v8_build)

7
Documentation/CMakeLists.txt
View File

@ -24,13 +24,12 @@ set(MAN_NAMES
man8/foxx-manager.8 man8/foxx-manager.8
) )
set(MAN_FILES) set(MAN_FILES "") #empty list
set(GENERATED_MAN_FILES)
foreach (m IN LISTS MAN_NAMES) foreach (m IN LISTS MAN_NAMES)
set(msrc ${CMAKE_SOURCE_DIR}/Documentation/${m}) set(msrc ${CMAKE_SOURCE_DIR}/Documentation/${m})
set(mdst ${CMAKE_SOURCE_DIR}/Documentation/man/${m}) set(mdst ${CMAKE_CURRENT_BINARY_DIR}/man/${m})
add_custom_command( add_custom_command(
WORKING_DIRECTORY ${CMAKE_BINARY_DIR} WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
@ -40,9 +39,9 @@ foreach (m IN LISTS MAN_NAMES)
COMMENT "Building manpage ${mdst}" COMMENT "Building manpage ${mdst}"
VERBATIM VERBATIM
) )
list(APPEND MAN_FILES ${mdst}) list(APPEND MAN_FILES ${mdst})
endforeach () endforeach ()
set(ARANGO_MAN_DIR "${CMAKE_CURRENT_BINARY_DIR}/man" PARENT_SCOPE)
add_custom_command( add_custom_command(
WORKING_DIRECTORY ${CMAKE_SOURCE_DIR} WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}

16
Documentation/man/man1/arangobench.1
View File

@ -1,16 +0,0 @@
.TH arangobench 1 "3.4.0-devel" "ArangoDB" "ArangoDB"
.SH NAME
arangobench - the ArangoDB benchmark and test tool
.SH SYNOPSIS
arangobench [options]
.SH DESCRIPTION
The arangob binary can be used to issue test requests to the
ArangoDB database. It can be used for benchmarks or server function
testing. It supports parallel querying and batch requests.
.SH OPTIONS
For a complete list of options, please refer to the ArangoDB
online manual, available at https://www.arangodb.com/
.SH AUTHOR
Copyright ArangoDB GmbH, Cologne, Germany

31
Documentation/man/man1/arangodump.1
View File

@ -1,31 +0,0 @@
.TH arangodump 1 "3.4.0-devel" "ArangoDB" "ArangoDB"
.SH NAME
arangodump - a tool to create logical dumps of an ArangoDB database
.SH SYNOPSIS
arangodump [options]
.SH DESCRIPTION
The arangodump binary can be used to create logical dumps of collection
meta information and collection data (documents) of an ArangoDB database.
By default, all non-system collections of the specified ArangoDB database
will be dumped with structural information and data.
For each collection, a file named "<collection>.structure.json" will be
created with information about the collection. When data is also dumped,
an additional file "<collection>.data.json" will also be created.
All dump files will be placed in a directory, which will be created by
arangodump when run. If the directory already exists, arangodump will refuse to
work unless started with the option "--overwrite true".
arangodump will work on the specified database only. If no database name
is specified, arangodump will work on the default database ("_system").
The dumped files can be re-stored in an ArangoDB database using the
arangorestore tool.
.SH OPTIONS
The arangodump 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 https://www.arangodb.com/
.SH AUTHOR
Copyright ArangoDB GmbH, Cologne, Germany

24
Documentation/man/man1/arangoexport.1
View File

@ -1,24 +0,0 @@
.TH arangoexport 1 "3.4.0-devel" "ArangoDB" "ArangoDB"
.SH NAME
arangoexport - a tool to export collections of an ArangoDB database
.SH SYNOPSIS
arangoexport [options]
.SH DESCRIPTION
The arangoexport binary can be used to export collections of an ArangoDB
database to json and jsonl. It can also export a graph or collections
to xgmml.
arangoexport will work on the specified database only. If no database name
is specified, arangoexport will work on the default database ("_system").
The exported jsonl files can be re-imported in an ArangoDB database
using the arangoimport tool.
.SH OPTIONS
The arangoexport 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 https://www.arangodb.com/ or run
arangoexport --help.
.SH AUTHOR
Copyright ArangoDB GmbH, Cologne, Germany

19
Documentation/man/man1/arangoimport.1
View File

@ -1,19 +0,0 @@
.TH arangoimport 1 "3.4.0-devel" "ArangoDB" "ArangoDB"
.SH NAME
arangoimport - a bulk importer for the ArangoDB database
.SH SYNOPSIS
arangoimport [options]
.SH DESCRIPTION
The arangoimport binary can be used to bulk import data from a file into the
ArangoDB database. Input data be present in the input file in either CSV
format with column headlines, or in JSON format. If JSON format is used,
each line in the input file must contain exactly one JSON document with
the attribute name/value pairs to import.
.SH OPTIONS
The arangoimport 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 https://www.arangodb.com/
.SH AUTHOR
Copyright ArangoDB GmbH, Cologne, Germany

18
Documentation/man/man1/arangorestore.1
View File

@ -1,18 +0,0 @@
.TH arangorestore 1 "3.4.0-devel" "ArangoDB" "ArangoDB"
.SH NAME
arangorestore - a data restore tool for the ArangoDB database
.SH SYNOPSIS
arangorestore [options]
.SH DESCRIPTION
The arangorestore binary can be used to restore data from logical dumps
created with the arangodump tool. Input data be present in the input
file in either CSV format with column headlines, or in JSON format. If
JSON format is used, each line in the input file must contain exactly
one JSON document with the attribute name/value pairs to import.
.SH OPTIONS
For a complete list of options, please refer to the ArangoDB
online manual, available at https://www.arangodb.com/
.SH AUTHOR
Copyright ArangoDB GmbH, Cologne, Germany

16
Documentation/man/man1/arangosh.1
View File

@ -1,16 +0,0 @@
.TH arangosh 1 "3.4.0-devel" "ArangoDB" "ArangoDB"
.SH NAME
arangosh - the ArangoDB shell
.SH SYNOPSIS
arangosh [options]
.SH DESCRIPTION
The arangosh binary can be used to establish an interactive
client connection to the ArangoDB database. When the connection
is established, it can be used to execute actions on the server.
.SH OPTIONS
For a complete list of options, please refer to the ArangoDB
online manual, available at https://www.arangodb.com/
.SH AUTHOR
Copyright ArangoDB GmbH, Cologne, Germany

18
Documentation/man/man8/arango-dfdb.8
View File

@ -1,18 +0,0 @@
.TH arango-dfdb 8 "3.4.0-devel" "ArangoDB" "ArangoDB"
.SH NAME
arango-dfdb - a datafile debugger for ArangoDB
.SH SYNOPSIS
arango-dfdb options
.SH DESCRIPTION
The arango-dfdb binary can be used to verify the datafiles of an
ArangoDB database server. The script must be run with exclusive access
to the server's data directory, meaning the ArangoDB server must not
be running and accessing the datafiles in the specified data
directory.
.SH OPTIONS
For a complete list of options, please refer to the ArangoDB
online manual, available at https://www.arangodb.com/
.SH AUTHOR
Copyright ArangoDB GmbH, Cologne, Germany

22
Documentation/man/man8/arangod.8
View File

@ -1,22 +0,0 @@
.TH arangod 8 "3.4.0-devel" "ArangoDB" "ArangoDB"
.SH NAME
arangod - the ArangoDB database server
.SH SYNOPSIS
arangod [options] database-directory
.SH 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. The server can be stopped gracefully at any
time by pressing CTRL-C or by sending the SIGINT signal to the
process.
.SH 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 https://www.arangodb.com/
.SH AUTHOR
Copyright ArangoDB GmbH, Cologne, Germany

16
Documentation/man/man8/foxx-manager.8
View File

@ -1,16 +0,0 @@
.TH foxx-manager 8 "3.4.0-devel" "ArangoDB" "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.
.SH OPTIONS
For a complete list of options, please refer to the ArangoDB
online manual, available at https://www.arangodb.com/
.SH AUTHOR
Copyright ArangoDB GmbH, Cologne, Germany

16
Documentation/man/man8/rcarangod.8
View File

@ -1,16 +0,0 @@
.TH rcarangod 8 "3.4.0-devel" "ArangoDB" "ArangoDB"
.SH NAME
rcarangod - control script for the ArangoDB database server
.SH SYNOPSIS
rcarangod start|stop
.SH DESCRIPTION
The rcarangod script controls the operation of the ArangoDB database
server daemon running on the system. The rcarangod script is normally
run at system boot time with the "start" argument, and at system
shutdown time with the "stop" argument. It can also be invoked
manually at any time to start or stop the ArangoDB database server.
.SH SEE ALSO
.BR arangod "(8), "
.SH AUTHOR
Copyright ArangoDB GmbH, Cologne, Germany

7
cmake/ArangoDBInstall.cmake
View File

@ -44,9 +44,12 @@ set(INSTALL_ICU_DT_DEST "${CMAKE_INSTALL_DATAROOTDIR}/${CMAKE_PROJECT_NAME}")
set(CMAKE_TEST_DIRECTORY "tests") set(CMAKE_TEST_DIRECTORY "tests")
include(InstallMacros) include(InstallMacros)
# install ---------------------------------------------------------------------- # install ----------------------------------------------------------------------
install(DIRECTORY ${PROJECT_SOURCE_DIR}/Documentation/man/ if(UNIX)
DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/man) install(DIRECTORY ${ARANGO_MAN_DIR}
DESTINATION ${CMAKE_INSTALL_DATAROOTDIR})
endif()
install_readme(README README.txt) install_readme(README README.txt)
install_readme(README.md README.md) install_readme(README.md README.md)

2
utils/manPages.sh
View File

@ -4,6 +4,8 @@ IN="$1"
OUT="$2" OUT="$2"
VERSION="$3" VERSION="$3"
mkdir -p ${OUT%/*}
section=`echo $IN | sed -e 's:.*\([0-9]\):\1:'` section=`echo $IN | sed -e 's:.*\([0-9]\):\1:'`
command=`echo $IN | sed -e 's:.*/\([^\.]*\).[0-9]:\1:'` command=`echo $IN | sed -e 's:.*/\([^\.]*\).[0-9]:\1:'`