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

user manual

This commit is contained in:
Frank Celler 2012-05-13 15:53:44 +02:00
parent d514e197c2
commit 2688788454
5 changed files with 16 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Doxygen/latex/user-manual-server.tex → Doxygen/latex/user-manual.tex
View File

@ -1,6 +1,6 @@
\input{header.tex} \input{header.tex}
\begin{center} \begin{center}
{\Large ArangoDB User Manual }\\ {\Large ArangoDB's User Manual }\\
\vspace*{1cm} \vspace*{1cm}
{\large The ArangoDB Team}\\ {\large The ArangoDB Team}\\
\vspace*{0.5cm} \vspace*{0.5cm}
@ -13,6 +13,6 @@
\tableofcontents \tableofcontents
\clearemptydoublepage \clearemptydoublepage
\pagenumbering{arabic} \pagenumbering{arabic}
\input{UserManualServer.inc} \input{UserManual.inc}
\printindex \printindex
\end{document} \end{document}

4
Makefile.doxygen
View File

@ -85,8 +85,8 @@ latex: Doxygen/arango-latex.doxy $(DOXYGEN)
python @top_srcdir@/Doxygen/Scripts/tex2tex.py Doxygen/latex/InstallManual.tex > Doxygen/latex/InstallManual.inc.tex python @top_srcdir@/Doxygen/Scripts/tex2tex.py Doxygen/latex/InstallManual.tex > Doxygen/latex/InstallManual.inc.tex
cd Doxygen/latex && pdflatex -interaction batchmode install-manual.tex || true cd Doxygen/latex && pdflatex -interaction batchmode install-manual.tex || true
python @top_srcdir@/Doxygen/Scripts/tex2tex.py Doxygen/latex/UserManualServer.tex > Doxygen/latex/UserManualServer.inc.tex python @top_srcdir@/Doxygen/Scripts/tex2tex.py Doxygen/latex/UserManual.tex > Doxygen/latex/UserManual.inc.tex
cd Doxygen/latex && pdflatex -interaction batchmode user-manual-server.tex || true cd Doxygen/latex && pdflatex -interaction batchmode user-manual.tex || true
python @top_srcdir@/Doxygen/Scripts/tex2tex.py Doxygen/latex/ImplementorManual.tex > Doxygen/latex/ImplementorManual.inc.tex python @top_srcdir@/Doxygen/Scripts/tex2tex.py Doxygen/latex/ImplementorManual.tex > Doxygen/latex/ImplementorManual.inc.tex
cd Doxygen/latex && pdflatex -interaction batchmode implementor-manual.tex || true cd Doxygen/latex && pdflatex -interaction batchmode implementor-manual.tex || true

8
Makefile.in
View File

@ -982,9 +982,7 @@ WIKI = \
ShellIndex \ ShellIndex \
SimpleQueries \ SimpleQueries \
UserManual \ UserManual \
UserManualServerBasics \ UserManualBasics \
UserManualShell \
UserManualShellStartStop \
jsUnity jsUnity
FORCE = 0 FORCE = 0
@ -2939,8 +2937,8 @@ latex: Doxygen/arango-latex.doxy $(DOXYGEN)
python @top_srcdir@/Doxygen/Scripts/tex2tex.py Doxygen/latex/InstallManual.tex > Doxygen/latex/InstallManual.inc.tex python @top_srcdir@/Doxygen/Scripts/tex2tex.py Doxygen/latex/InstallManual.tex > Doxygen/latex/InstallManual.inc.tex
cd Doxygen/latex && pdflatex -interaction batchmode install-manual.tex || true cd Doxygen/latex && pdflatex -interaction batchmode install-manual.tex || true
python @top_srcdir@/Doxygen/Scripts/tex2tex.py Doxygen/latex/UserManualServer.tex > Doxygen/latex/UserManualServer.inc.tex python @top_srcdir@/Doxygen/Scripts/tex2tex.py Doxygen/latex/UserManual.tex > Doxygen/latex/UserManual.inc.tex
cd Doxygen/latex && pdflatex -interaction batchmode user-manual-server.tex || true cd Doxygen/latex && pdflatex -interaction batchmode user-manual.tex || true
python @top_srcdir@/Doxygen/Scripts/tex2tex.py Doxygen/latex/ImplementorManual.tex > Doxygen/latex/ImplementorManual.inc.tex python @top_srcdir@/Doxygen/Scripts/tex2tex.py Doxygen/latex/ImplementorManual.tex > Doxygen/latex/ImplementorManual.inc.tex
cd Doxygen/latex && pdflatex -interaction batchmode implementor-manual.tex || true cd Doxygen/latex && pdflatex -interaction batchmode implementor-manual.tex || true

2
Makefile.local
View File

@ -21,5 +21,5 @@ publish-html:
publish-pdf: publish-pdf:
scp Doxygen/latex/install-manual.pdf $(MANUAL_DST) scp Doxygen/latex/install-manual.pdf $(MANUAL_DST)
scp Doxygen/latex/user-manual-server.pdf $(MANUAL_DST) scp Doxygen/latex/user-manual.pdf $(MANUAL_DST)
scp Doxygen/latex/implementor-manual.pdf $(MANUAL_DST) scp Doxygen/latex/implementor-manual.pdf $(MANUAL_DST)

13
RestServer/user-manual.dox
View File

@ -55,8 +55,10 @@
/// </ul> /// </ul>
/// </li> /// </li>
/// <li>@ref UserManualShellStartStop /// <li>@ref UserManualShellStartStop
/// <ul>
/// <li>@ref UserManualShellStartStopOptions</li>
/// </ul>
/// </li> /// </li>
/// <li>@ref UserManualShellStartStopOptions</li>
/// </li> /// </li>
/// <li>@ref UserManualServerStartStopDebug /// <li>@ref UserManualServerStartStopDebug
/// </li> /// </li>
@ -120,7 +122,7 @@
/// - @LIT{arangosh}: The ArangoDB shell. A client that implements a /// - @LIT{arangosh}: The ArangoDB shell. A client that implements a
/// read-eval-print loop (REPL) and provides functions to access and /// read-eval-print loop (REPL) and provides functions to access and
/// administrate the ArangoDB server. See @ref UserManualShellStartStop. /// administrate the ArangoDB server. See @ref UserManualShellStartStop.
/// - @LIT{arangoimp}: A buld importer for the ArangoDB server. /// - @LIT{arangoimp}: A bulk importer for the ArangoDB server.
/// See @ref UserManualImporterStartStop. /// See @ref UserManualImporterStartStop.
/// ///
/// @EMBEDTOC{UserManualBasicsTOC} /// @EMBEDTOC{UserManualBasicsTOC}
@ -199,11 +201,12 @@
/// The shell will print its own version number and, if successfully connected /// The shell will print its own version number and, if successfully connected
/// to a server, the version number of the ArangoDB server. /// to a server, the version number of the ArangoDB server.
/// ///
/// @section UserManualShellStartStopOptions Command-Line Options /// @subsection UserManualShellStartStopOptions Command-Line Options
////////////////////////////////////////////////////////////////////
/// ///
/// Use @LIT{--help} to get a list of command-line options: /// Use @LIT{--help} to get a list of command-line options:
/// ///
/// @verbinclude avocsh2 /// @verbinclude arangosh-options
/// ///
/// @section UserManualServerStartStopDebug Starting the ArangoDB Emergency Console /// @section UserManualServerStartStopDebug Starting the ArangoDB Emergency Console
/////////////////////////////////////////////////////////////////////////////////// ///////////////////////////////////////////////////////////////////////////////////
@ -212,7 +215,7 @@
/// frequently used options, see @ref CommandLine "here" for a complete list. /// frequently used options, see @ref CommandLine "here" for a complete list.
/// ///
/// @note Never start the emergency console for a database which also has a /// @note Never start the emergency console for a database which also has a
/// server attached to it. /// server attached to it. In general the ArangoDB shell is what you want.
/// ///
/// @verbinclude start-emergency-console /// @verbinclude start-emergency-console
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////