mirror of https://gitee.com/bigwinds/arangodb
issue #182: add manpages
This commit is contained in:
Jan Steemann
parent
b8c5c4e3c0
commit
751474c43f
|
|
@ -104,7 +104,6 @@ Doxygen/*.doxy
|
|||
Doxygen/html
|
||||
Doxygen/js
|
||||
Doxygen/latex
|
||||
Doxygen/man
|
||||
Doxygen/web
|
||||
Doxygen/wiki
|
||||
Doxygen/xml
|
||||
|
|
|
|||
|
|
@ -67,15 +67,6 @@ doxygen: Doxygen/.setup-directories Doxygen/arango-html.doxy $(DOXYGEN)
|
|||
@for w in $(WIKI); do @top_srcdir@/Documentation/Scripts/html2html.sh Doxygen/html/$$w.html Doxygen/doc/$$w.html; done
|
||||
cp -R @top_srcdir@/Documentation/images/* Doxygen/doc/images
|
||||
|
||||
################################################################################
|
||||
### @brief man pages
|
||||
################################################################################
|
||||
|
||||
.PHONY: man
|
||||
|
||||
man: Doxygen/.setup-directories
|
||||
for section in 1 8; do for i in `ls arangod/Documentation/man$$section`; do sed -f Documentation/man.sed -e "s/\<SECTION\>/$$section/" -e "s/\<COMMAND\>/$$i/g" -e "s/DATE/`date`/g" arangod/Documentation/man$$section/$$i > Doxygen/man/man$$section/$$i.$$section; done; done
|
||||
|
||||
################################################################################
|
||||
### @brief wiki
|
||||
################################################################################
|
||||
|
|
@ -130,6 +121,27 @@ latex: Doxygen/.setup-directories Doxygen/arango-latex.doxy $(DOXYGEN)
|
|||
python @top_srcdir@/Documentation/Scripts/tex2tex.py Doxygen/latex/ImpManual.tex > Doxygen/latex/ImpManual.inc.tex
|
||||
cd Doxygen/latex && pdflatex -interaction batchmode imp-manual.tex || true
|
||||
|
||||
################################################################################
|
||||
### @brief man pages
|
||||
################################################################################
|
||||
|
||||
.PHONY: man
|
||||
|
||||
man: Doxygen/.setup-directories
|
||||
for section in 1 8; do for i in `ls arangod/Documentation/man$$section`; do sed -f Documentation/man.sed -e "s/\<SECTION\>/$$section/" -e "s/\<COMMAND\>/$$i/g" -e "s/DATE/`date`/g" arangod/Documentation/man$$section/$$i > Doxygen/man/man$$section/$$i.$$section; done; done
|
||||
|
||||
################################################################################
|
||||
### @brief install man pages
|
||||
################################################################################
|
||||
|
||||
dist_man_MANS += \
|
||||
Doxygen/man/man1/arangoimp.1 \
|
||||
Doxygen/man/man1/arangosh.1 \
|
||||
Doxygen/man/man1/arangod.8 \
|
||||
Doxygen/man/man1/arango-dfdb.8 \
|
||||
Doxygen/man/man1/arango-password.8 \
|
||||
Doxygen/man/man1/arango-upgrade.8
|
||||
|
||||
################################################################################
|
||||
### @brief cleanup
|
||||
################################################################################
|
||||
|
|
|
|||
|
|
@ -0,0 +1,37 @@
|
|||
.TH arangoimp 1 "Mo 3. Sep 13:44:52 CEST 2012" "" "ArangoDB"
|
||||
.SH NAME
|
||||
arangoimp - a bulk importer for the ArangoDB database
|
||||
.SH SYNOPSIS
|
||||
arangoimp [options]
|
||||
.SH DESCRIPTION
|
||||
The arangoimp 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
|
||||
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:
|
||||
|
||||
.IP "--configuration <string>"
|
||||
read configuration from file <string>
|
||||
.IP "--collection <string>"
|
||||
name of collection to import into
|
||||
.IP "--create-collection <bool>"
|
||||
set to "true" if collection should be created by the import
|
||||
.IP "--file <string>"
|
||||
input file with the data to import
|
||||
.IP "--type <string>"
|
||||
set to "json" or "csv", depending on the input file format
|
||||
.IP "--server.endpoint <string>"
|
||||
server endpoint to connect to, consisting of protocol, ip address and port
|
||||
.IP "--server.username <string>"
|
||||
username to use when connecting (default "root")
|
||||
.IP "--server.password <string>"
|
||||
password to use when connecting. Leave empty for a password prompt
|
||||
.SH EXAMPLES
|
||||
|
||||
.SH AUTHOR
|
||||
Copyright 2012, triAGENS GmbH, Cologne, Germany
|
||||
|
|
@ -0,0 +1,54 @@
|
|||
.TH arangosh 1 "Mo 3. Sep 13:44:52 CEST 2012" "" "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 http://www.arangodb.org/
|
||||
|
||||
The most important startup options are:
|
||||
|
||||
.IP "--configuration <string>"
|
||||
read configuration from file <string>
|
||||
.IP "--log.level <string>"
|
||||
set the log level (possible values: "fatal", "error", "warning", "info", "debug", "trace")
|
||||
.IP "--server.endpoint <string>"
|
||||
server endpoint to connect to, consisting of protocol, ip address and port
|
||||
.IP "--server.username <string>"
|
||||
username to use when connecting (default "root")
|
||||
.IP "--server.password <string>"
|
||||
password to use when connecting. Leave empty for a password prompt
|
||||
.SH EXAMPLES
|
||||
.EX
|
||||
shell> arangosh
|
||||
starts arangosh with the default user and server endpoint
|
||||
.EE
|
||||
|
||||
.EX
|
||||
shell> arangosh --server.username fuchsia
|
||||
starts arangosh with a specific user. Password prompt will follow
|
||||
.EE
|
||||
|
||||
.EX
|
||||
shell> arangosh --server.username fuchsia --server.password "abcd@34"
|
||||
starts arangosh with a specific user and password given on command line
|
||||
.EE
|
||||
|
||||
.EX
|
||||
shell> arangosh --server.endpoint tcp://192.168.173.13:8529
|
||||
starts arangosh connecting to a specific server
|
||||
.EE
|
||||
|
||||
.EX
|
||||
shell> arangosh --server.endpoint ssl://192.168.173.13:8530
|
||||
starts arangosh connecting to a specific server using an SSL connection
|
||||
.EE
|
||||
|
||||
|
||||
.SH AUTHOR
|
||||
Copyright 2012, triAGENS GmbH, Cologne, Germany
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
.TH arango-dfdb 8 "Mo 3. Sep 13:44:52 CEST 2012" "" "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.
|
||||
More specific instructions are displayed when the program is invoked.
|
||||
.SH OPTIONS
|
||||
.IP "--database.directory <string>"
|
||||
path to the database directory
|
||||
.SH EXAMPLES
|
||||
.EX
|
||||
shell> arango-dfdb --database.directory /data/arangodb
|
||||
starts the debugger with database directory /data/arangodb
|
||||
.EE
|
||||
|
||||
|
||||
.SH AUTHOR
|
||||
Copyright 2012, triAGENS GmbH, Cologne, Germany
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
.TH arango-password 8 "Mo 3. Sep 13:44:52 CEST 2012" "" "ArangoDB"
|
||||
.SH NAME
|
||||
arango-password - user setup utility for the ArangoDB database server
|
||||
.SH SYNOPSIS
|
||||
arango-password database-directory username [password]
|
||||
.SH DESCRIPTION
|
||||
The arango-password utility can be used to create additional users in an
|
||||
ArangoDB database server.
|
||||
The utility 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
|
||||
The options of the arango-password utility are:
|
||||
.IP "--database.directory <string>"
|
||||
path to the database directory
|
||||
.IP "username"
|
||||
name of the user to add
|
||||
.IP "password"
|
||||
password for the user. Leave empty for a password prompt
|
||||
.SH EXAMPLES
|
||||
.EX
|
||||
shell> arango-password --database.directory /data/arangodb fuchsia
|
||||
creates a new user "fuchsia". Password prompt will follow
|
||||
.EE
|
||||
|
||||
.EX
|
||||
shell> arango-password --database.directory /data/arangodb fuchsia "1234@ab"
|
||||
creates a new user "fuchsia" with the specified password
|
||||
.EE
|
||||
|
||||
|
||||
.SH AUTHOR
|
||||
Copyright 2012, triAGENS GmbH, Cologne, Germany
|
||||
|
|
@ -0,0 +1,30 @@
|
|||
.TH arango-upgrade 8 "Mo 3. Sep 13:44:52 CEST 2012" "" "ArangoDB"
|
||||
.SH NAME
|
||||
arango-upgrade - upgrade script for the ArangoDB database server
|
||||
.SH SYNOPSIS
|
||||
arango-upgrade --database.directory database-directory
|
||||
.SH DESCRIPTION
|
||||
The arango-upgrade command can be used to perform any necessary system
|
||||
data modification in an ArangoDB database after a version upgrade.
|
||||
The command must be run with exclusive access to the server's data directory,
|
||||
that means the ArangoDB server must not be running and accessing the
|
||||
datafiles in the specified data directory.
|
||||
|
||||
The arango-upgrade command will print a list of tasks it executes and a
|
||||
success/failure status for each. If some task cannot be accomplished
|
||||
successfully, the root cause must be fixed and the arango-upgrade command be
|
||||
run again afterwards.
|
||||
.SH OPTIONS
|
||||
The arango-upgrade binary the following option:
|
||||
|
||||
.IP "--database.directory <string>"
|
||||
path to the database directory
|
||||
.SH EXAMPLES
|
||||
.EX
|
||||
shell> arango-upgrade --database.directory /data/arangodb
|
||||
starts the upgrade script with database directory /data/arangodb
|
||||
.EE
|
||||
|
||||
|
||||
.SH AUTHOR
|
||||
Copyright 2012, triAGENS GmbH, Cologne, Germany
|
||||
|
|
@ -0,0 +1,67 @@
|
|||
.TH arangod 8 "Mo 3. Sep 13:44:52 CEST 2012" "" "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.
|
||||
.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 http://www.arangodb.org/
|
||||
|
||||
The most important startup options are:
|
||||
|
||||
.IP "--configuration <string>"
|
||||
read configuration from file <string>
|
||||
.IP "--console"
|
||||
do not start as server, start an emergency console instead
|
||||
.IP "--log.file <string>"
|
||||
log to file <string>
|
||||
.IP "--log.level <string>"
|
||||
set the log level (possible values: "fatal", "error", "warning", "info", "debug", "trace")
|
||||
.IP "--server.endpoint <string>"
|
||||
listen endpoint for client requests, consisting of protocol, ip address and port
|
||||
.IP "--database.directory <string>"
|
||||
path to the database directory
|
||||
.SH EXAMPLES
|
||||
.EX
|
||||
shell> arangod /data/arangodb
|
||||
starts the server with database directory /data/arangodb
|
||||
.EE
|
||||
|
||||
.EX
|
||||
shell> arangod --database.directory /data/arangodb
|
||||
same, but uses --database.directory option instead
|
||||
.EE
|
||||
|
||||
.EX
|
||||
shell> arangod --log.level debug /data/arangodb
|
||||
starts server with log level "debug"
|
||||
.EE
|
||||
|
||||
.EX
|
||||
shell> arangod --server.endpoint tcp://127.0.0.1:8529 /data/arangodb
|
||||
starts server listening on port 8529 of IP 127.0.0.1
|
||||
.EE
|
||||
|
||||
.EX
|
||||
shell> 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
|
||||
.EE
|
||||
|
||||
.EX
|
||||
shell> arangod --console /data/arangodb
|
||||
starts the emergency console
|
||||
.EE
|
||||
|
||||
|
||||
.SH AUTHOR
|
||||
Copyright 2012, triAGENS GmbH, Cologne, Germany
|
||||
|
|
@ -10,6 +10,12 @@
|
|||
|
||||
BUILT_SOURCES = build.h
|
||||
|
||||
################################################################################
|
||||
### @brief man pages to install
|
||||
################################################################################
|
||||
|
||||
dist_man_MANS =
|
||||
|
||||
################################################################################
|
||||
### @brief files to cleanup
|
||||
################################################################################
|
||||
|
|
|
|||
150
Makefile.in
150
Makefile.in
|
|
@ -206,7 +206,7 @@ noinst_PROGRAMS = $(am__EXEEXT_2) $(am__EXEEXT_3)
|
|||
@ENABLE_MRUBY_TRUE@am__append_10 = \
|
||||
@ENABLE_MRUBY_TRUE@ $(shell find @srcdir@/mr/actions/system -name "*.rb" -print)
|
||||
|
||||
DIST_COMMON = README $(am__configure_deps) \
|
||||
DIST_COMMON = README $(am__configure_deps) $(dist_man_MANS) \
|
||||
$(srcdir)/3rdParty/Makefile.all-in-one-libev \
|
||||
$(srcdir)/3rdParty/Makefile.all-in-one-mruby \
|
||||
$(srcdir)/3rdParty/Makefile.all-in-one-protobuf \
|
||||
|
|
@ -561,6 +561,7 @@ am_lib_libarango_v8_a_OBJECTS = lib/V8/JSLoader.$(OBJEXT) \
|
|||
lib_libarango_v8_a_OBJECTS = $(am_lib_libarango_v8_a_OBJECTS)
|
||||
@ENABLE_MRUBY_TRUE@am__EXEEXT_1 = bin/arangoirb$(EXEEXT)
|
||||
am__installdirs = "$(DESTDIR)$(bindir)" "$(DESTDIR)$(sbindir)" \
|
||||
"$(DESTDIR)$(man1dir)" "$(DESTDIR)$(man8dir)" \
|
||||
"$(DESTDIR)$(arangosysconfdir)" "$(DESTDIR)$(pkgdatadir)"
|
||||
@ENABLE_ZEROMQ_TRUE@am__EXEEXT_2 = bin/zclient$(EXEEXT) \
|
||||
@ENABLE_ZEROMQ_TRUE@ bin/zserver$(EXEEXT)
|
||||
|
|
@ -854,6 +855,10 @@ am__nobase_list = $(am__nobase_strip_setup); \
|
|||
am__base_list = \
|
||||
sed '$$!N;$$!N;$$!N;$$!N;$$!N;$$!N;$$!N;s/\n/ /g' | \
|
||||
sed '$$!N;$$!N;$$!N;$$!N;s/\n/ /g'
|
||||
man1dir = $(mandir)/man1
|
||||
man8dir = $(mandir)/man8
|
||||
NROFF = nroff
|
||||
MANS = $(dist_man_MANS)
|
||||
DATA = $(arangosysconf_DATA) $(nobase_pkgdata_DATA)
|
||||
ETAGS = etags
|
||||
CTAGS = ctags
|
||||
|
|
@ -1040,6 +1045,19 @@ BUILT_SOURCES = build.h $(JAVASCRIPT_HEADER) $(JAVASCRIPT_BROWSER) \
|
|||
$(PROTOBUF_FILES) $(am__append_24) $(am__append_25) \
|
||||
$(am__append_26) $(am__append_27) $(am__append_28)
|
||||
|
||||
################################################################################
|
||||
### @brief man pages to install
|
||||
################################################################################
|
||||
|
||||
################################################################################
|
||||
### @brief install man pages
|
||||
################################################################################
|
||||
dist_man_MANS = Doxygen/man/man1/arangoimp.1 \
|
||||
Doxygen/man/man1/arangosh.1 Doxygen/man/man1/arangod.8 \
|
||||
Doxygen/man/man1/arango-dfdb.8 \
|
||||
Doxygen/man/man1/arango-password.8 \
|
||||
Doxygen/man/man1/arango-upgrade.8
|
||||
|
||||
################################################################################
|
||||
### @brief files to cleanup
|
||||
################################################################################
|
||||
|
|
@ -4788,6 +4806,82 @@ PerfTests/bin_zserver-zserver.obj: PerfTests/zserver.cpp
|
|||
@AMDEP_TRUE@@am__fastdepCXX_FALSE@ source='PerfTests/zserver.cpp' object='PerfTests/bin_zserver-zserver.obj' libtool=no @AMDEPBACKSLASH@
|
||||
@AMDEP_TRUE@@am__fastdepCXX_FALSE@ DEPDIR=$(DEPDIR) $(CXXDEPMODE) $(depcomp) @AMDEPBACKSLASH@
|
||||
@am__fastdepCXX_FALSE@ $(CXX) $(DEFS) $(DEFAULT_INCLUDES) $(INCLUDES) $(bin_zserver_CPPFLAGS) $(CPPFLAGS) $(AM_CXXFLAGS) $(CXXFLAGS) -c -o PerfTests/bin_zserver-zserver.obj `if test -f 'PerfTests/zserver.cpp'; then $(CYGPATH_W) 'PerfTests/zserver.cpp'; else $(CYGPATH_W) '$(srcdir)/PerfTests/zserver.cpp'; fi`
|
||||
install-man1: $(dist_man_MANS)
|
||||
@$(NORMAL_INSTALL)
|
||||
test -z "$(man1dir)" || $(MKDIR_P) "$(DESTDIR)$(man1dir)"
|
||||
@list=''; test -n "$(man1dir)" || exit 0; \
|
||||
{ for i in $$list; do echo "$$i"; done; \
|
||||
l2='$(dist_man_MANS)'; for i in $$l2; do echo "$$i"; done | \
|
||||
sed -n '/\.1[a-z]*$$/p'; \
|
||||
} | while read p; do \
|
||||
if test -f $$p; then d=; else d="$(srcdir)/"; fi; \
|
||||
echo "$$d$$p"; echo "$$p"; \
|
||||
done | \
|
||||
sed -e 'n;s,.*/,,;p;h;s,.*\.,,;s,^[^1][0-9a-z]*$$,1,;x' \
|
||||
-e 's,\.[0-9a-z]*$$,,;$(transform);G;s,\n,.,' | \
|
||||
sed 'N;N;s,\n, ,g' | { \
|
||||
list=; while read file base inst; do \
|
||||
if test "$$base" = "$$inst"; then list="$$list $$file"; else \
|
||||
echo " $(INSTALL_DATA) '$$file' '$(DESTDIR)$(man1dir)/$$inst'"; \
|
||||
$(INSTALL_DATA) "$$file" "$(DESTDIR)$(man1dir)/$$inst" || exit $$?; \
|
||||
fi; \
|
||||
done; \
|
||||
for i in $$list; do echo "$$i"; done | $(am__base_list) | \
|
||||
while read files; do \
|
||||
test -z "$$files" || { \
|
||||
echo " $(INSTALL_DATA) $$files '$(DESTDIR)$(man1dir)'"; \
|
||||
$(INSTALL_DATA) $$files "$(DESTDIR)$(man1dir)" || exit $$?; }; \
|
||||
done; }
|
||||
|
||||
uninstall-man1:
|
||||
@$(NORMAL_UNINSTALL)
|
||||
@list=''; test -n "$(man1dir)" || exit 0; \
|
||||
files=`{ for i in $$list; do echo "$$i"; done; \
|
||||
l2='$(dist_man_MANS)'; for i in $$l2; do echo "$$i"; done | \
|
||||
sed -n '/\.1[a-z]*$$/p'; \
|
||||
} | sed -e 's,.*/,,;h;s,.*\.,,;s,^[^1][0-9a-z]*$$,1,;x' \
|
||||
-e 's,\.[0-9a-z]*$$,,;$(transform);G;s,\n,.,'`; \
|
||||
test -z "$$files" || { \
|
||||
echo " ( cd '$(DESTDIR)$(man1dir)' && rm -f" $$files ")"; \
|
||||
cd "$(DESTDIR)$(man1dir)" && rm -f $$files; }
|
||||
install-man8: $(dist_man_MANS)
|
||||
@$(NORMAL_INSTALL)
|
||||
test -z "$(man8dir)" || $(MKDIR_P) "$(DESTDIR)$(man8dir)"
|
||||
@list=''; test -n "$(man8dir)" || exit 0; \
|
||||
{ for i in $$list; do echo "$$i"; done; \
|
||||
l2='$(dist_man_MANS)'; for i in $$l2; do echo "$$i"; done | \
|
||||
sed -n '/\.8[a-z]*$$/p'; \
|
||||
} | while read p; do \
|
||||
if test -f $$p; then d=; else d="$(srcdir)/"; fi; \
|
||||
echo "$$d$$p"; echo "$$p"; \
|
||||
done | \
|
||||
sed -e 'n;s,.*/,,;p;h;s,.*\.,,;s,^[^8][0-9a-z]*$$,8,;x' \
|
||||
-e 's,\.[0-9a-z]*$$,,;$(transform);G;s,\n,.,' | \
|
||||
sed 'N;N;s,\n, ,g' | { \
|
||||
list=; while read file base inst; do \
|
||||
if test "$$base" = "$$inst"; then list="$$list $$file"; else \
|
||||
echo " $(INSTALL_DATA) '$$file' '$(DESTDIR)$(man8dir)/$$inst'"; \
|
||||
$(INSTALL_DATA) "$$file" "$(DESTDIR)$(man8dir)/$$inst" || exit $$?; \
|
||||
fi; \
|
||||
done; \
|
||||
for i in $$list; do echo "$$i"; done | $(am__base_list) | \
|
||||
while read files; do \
|
||||
test -z "$$files" || { \
|
||||
echo " $(INSTALL_DATA) $$files '$(DESTDIR)$(man8dir)'"; \
|
||||
$(INSTALL_DATA) $$files "$(DESTDIR)$(man8dir)" || exit $$?; }; \
|
||||
done; }
|
||||
|
||||
uninstall-man8:
|
||||
@$(NORMAL_UNINSTALL)
|
||||
@list=''; test -n "$(man8dir)" || exit 0; \
|
||||
files=`{ for i in $$list; do echo "$$i"; done; \
|
||||
l2='$(dist_man_MANS)'; for i in $$l2; do echo "$$i"; done | \
|
||||
sed -n '/\.8[a-z]*$$/p'; \
|
||||
} | sed -e 's,.*/,,;h;s,.*\.,,;s,^[^8][0-9a-z]*$$,8,;x' \
|
||||
-e 's,\.[0-9a-z]*$$,,;$(transform);G;s,\n,.,'`; \
|
||||
test -z "$$files" || { \
|
||||
echo " ( cd '$(DESTDIR)$(man8dir)' && rm -f" $$files ")"; \
|
||||
cd "$(DESTDIR)$(man8dir)" && rm -f $$files; }
|
||||
install-arangosysconfDATA: $(arangosysconf_DATA)
|
||||
@$(NORMAL_INSTALL)
|
||||
test -z "$(arangosysconfdir)" || $(MKDIR_P) "$(DESTDIR)$(arangosysconfdir)"
|
||||
|
|
@ -4885,6 +4979,19 @@ distclean-tags:
|
|||
-rm -f TAGS ID GTAGS GRTAGS GSYMS GPATH tags
|
||||
|
||||
distdir: $(DISTFILES)
|
||||
@list='$(MANS)'; if test -n "$$list"; then \
|
||||
list=`for p in $$list; do \
|
||||
if test -f $$p; then d=; else d="$(srcdir)/"; fi; \
|
||||
if test -f "$$d$$p"; then echo "$$d$$p"; else :; fi; done`; \
|
||||
if test -n "$$list" && \
|
||||
grep 'ab help2man is required to generate this page' $$list >/dev/null; then \
|
||||
echo "error: found man pages containing the \`missing help2man' replacement text:" >&2; \
|
||||
grep -l 'ab help2man is required to generate this page' $$list | sed 's/^/ /' >&2; \
|
||||
echo " to fix them, install help2man, remove and regenerate the man pages;" >&2; \
|
||||
echo " typically \`make maintainer-clean' will remove them" >&2; \
|
||||
exit 1; \
|
||||
else :; fi; \
|
||||
else :; fi
|
||||
$(am__remove_distdir)
|
||||
test -d "$(distdir)" || mkdir "$(distdir)"
|
||||
@srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \
|
||||
|
|
@ -5034,9 +5141,9 @@ distcleancheck: distclean
|
|||
check-am: all-am
|
||||
check: $(BUILT_SOURCES)
|
||||
$(MAKE) $(AM_MAKEFLAGS) check-am
|
||||
all-am: Makefile $(LIBRARIES) $(PROGRAMS) $(DATA)
|
||||
all-am: Makefile $(LIBRARIES) $(PROGRAMS) $(MANS) $(DATA)
|
||||
installdirs:
|
||||
for dir in "$(DESTDIR)$(bindir)" "$(DESTDIR)$(sbindir)" "$(DESTDIR)$(arangosysconfdir)" "$(DESTDIR)$(pkgdatadir)"; do \
|
||||
for dir in "$(DESTDIR)$(bindir)" "$(DESTDIR)$(sbindir)" "$(DESTDIR)$(man1dir)" "$(DESTDIR)$(man8dir)" "$(DESTDIR)$(arangosysconfdir)" "$(DESTDIR)$(pkgdatadir)"; do \
|
||||
test -z "$$dir" || $(MKDIR_P) "$$dir"; \
|
||||
done
|
||||
install: $(BUILT_SOURCES)
|
||||
|
|
@ -5183,7 +5290,8 @@ info: info-am
|
|||
|
||||
info-am:
|
||||
|
||||
install-data-am: install-arangosysconfDATA install-nobase_pkgdataDATA
|
||||
install-data-am: install-arangosysconfDATA install-man \
|
||||
install-nobase_pkgdataDATA
|
||||
|
||||
install-dvi: install-dvi-am
|
||||
|
||||
|
|
@ -5199,7 +5307,7 @@ install-info: install-info-am
|
|||
|
||||
install-info-am:
|
||||
|
||||
install-man:
|
||||
install-man: install-man1 install-man8
|
||||
|
||||
install-pdf: install-pdf-am
|
||||
|
||||
|
|
@ -5231,7 +5339,10 @@ ps: ps-am
|
|||
ps-am:
|
||||
|
||||
uninstall-am: uninstall-arangosysconfDATA uninstall-binPROGRAMS \
|
||||
uninstall-nobase_pkgdataDATA uninstall-sbinPROGRAMS
|
||||
uninstall-man uninstall-nobase_pkgdataDATA \
|
||||
uninstall-sbinPROGRAMS
|
||||
|
||||
uninstall-man: uninstall-man1 uninstall-man8
|
||||
|
||||
.MAKE: all check install install-am install-strip
|
||||
|
||||
|
|
@ -5246,13 +5357,14 @@ uninstall-am: uninstall-arangosysconfDATA uninstall-binPROGRAMS \
|
|||
install-arangosysconfDATA install-binPROGRAMS install-data \
|
||||
install-data-am install-dvi install-dvi-am install-exec \
|
||||
install-exec-am install-html install-html-am install-info \
|
||||
install-info-am install-man install-nobase_pkgdataDATA \
|
||||
install-pdf install-pdf-am install-ps install-ps-am \
|
||||
install-sbinPROGRAMS install-strip installcheck \
|
||||
installcheck-am installdirs maintainer-clean \
|
||||
install-info-am install-man install-man1 install-man8 \
|
||||
install-nobase_pkgdataDATA install-pdf install-pdf-am \
|
||||
install-ps install-ps-am install-sbinPROGRAMS install-strip \
|
||||
installcheck installcheck-am installdirs maintainer-clean \
|
||||
maintainer-clean-generic mostlyclean mostlyclean-compile \
|
||||
mostlyclean-generic pdf pdf-am ps ps-am tags uninstall \
|
||||
uninstall-am uninstall-arangosysconfDATA uninstall-binPROGRAMS \
|
||||
uninstall-man uninstall-man1 uninstall-man8 \
|
||||
uninstall-nobase_pkgdataDATA uninstall-sbinPROGRAMS
|
||||
|
||||
|
||||
|
|
@ -5655,15 +5767,6 @@ doxygen: Doxygen/.setup-directories Doxygen/arango-html.doxy $(DOXYGEN)
|
|||
@for w in $(WIKI); do @top_srcdir@/Documentation/Scripts/html2html.sh Doxygen/html/$$w.html Doxygen/doc/$$w.html; done
|
||||
cp -R @top_srcdir@/Documentation/images/* Doxygen/doc/images
|
||||
|
||||
################################################################################
|
||||
### @brief man pages
|
||||
################################################################################
|
||||
|
||||
.PHONY: man
|
||||
|
||||
man: Doxygen/.setup-directories
|
||||
for section in 1 8; do for i in `ls arangod/Documentation/man$$section`; do sed -f Documentation/man.sed -e "s/\<SECTION\>/$$section/" -e "s/\<COMMAND\>/$$i/g" -e "s/DATE/`date`/g" arangod/Documentation/man$$section/$$i > Doxygen/man/man$$section/$$i.$$section; done; done
|
||||
|
||||
################################################################################
|
||||
### @brief wiki
|
||||
################################################################################
|
||||
|
|
@ -5718,6 +5821,15 @@ latex: Doxygen/.setup-directories Doxygen/arango-latex.doxy $(DOXYGEN)
|
|||
python @top_srcdir@/Documentation/Scripts/tex2tex.py Doxygen/latex/ImpManual.tex > Doxygen/latex/ImpManual.inc.tex
|
||||
cd Doxygen/latex && pdflatex -interaction batchmode imp-manual.tex || true
|
||||
|
||||
################################################################################
|
||||
### @brief man pages
|
||||
################################################################################
|
||||
|
||||
.PHONY: man
|
||||
|
||||
man: Doxygen/.setup-directories
|
||||
for section in 1 8; do for i in `ls arangod/Documentation/man$$section`; do sed -f Documentation/man.sed -e "s/\<SECTION\>/$$section/" -e "s/\<COMMAND\>/$$i/g" -e "s/DATE/`date`/g" arangod/Documentation/man$$section/$$i > Doxygen/man/man$$section/$$i.$$section; done; done
|
||||
|
||||
################################################################################
|
||||
################################################################################
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue