diff --git a/docs/debian/control b/docs/debian/control index 55732402e99..5e23640b360 100644 --- a/docs/debian/control +++ b/docs/debian/control @@ -1,7 +1,7 @@ Source: bareos-docs Priority: extra Maintainer: Joerg Steffens -Build-Depends: bareos-director, bareos-database-sqlite3, bareos-storage, bareos-filedaemon, bareos-bconsole, bareos-traymonitor, debhelper, ghostscript, imagemagick, librsvg2-bin, pandoc, python, texlive-fonts-recommended, texlive-latex-recommended, tex4ht +Build-Depends: bareos-director, bareos-database-sqlite3, bareos-storage, bareos-filedaemon, bareos-bconsole, bareos-traymonitor, debhelper, ghostscript, imagemagick, librsvg2-bin, pandoc, python, texlive-fonts-recommended, texlive-latex-recommended, tex4ht, perl Standards-Version: 3.8.4 Section: doc Vcs-Git: https://github.com/bareos/bareos-docs.git diff --git a/docs/manuals/en/developers/source/index.rst b/docs/manuals/en/developers/source/index.rst index 32e09f81c15..490c683eb75 100644 --- a/docs/manuals/en/developers/source/index.rst +++ b/docs/manuals/en/developers/source/index.rst @@ -15,21 +15,21 @@ Welcome to Bareos Developer Guide's documentation! messages.rst pluginAPI.rst platformsupport.rst - daemonprotocol.rst + daemonprotocol.rst file.rst storage.rst - catalog.rst + catalog.rst mediaformat.rst porting.rst api.rst tls-techdoc.rst regression.rst - mempool.rst + mempool.rst netprotocol.rst directorConsole.rst smartall.rst fdl.rst - + Indices and tables ================== diff --git a/docs/manuals/en/main/ansi-labels.tex b/docs/manuals/en/main/ansi-labels.tex index b021d208eba..8bfbeda9a34 100644 --- a/docs/manuals/en/main/ansi-labels.tex +++ b/docs/manuals/en/main/ansi-labels.tex @@ -5,7 +5,7 @@ \section{Tape Labels: ANSI or IBM} \index[general]{Tape!Label!ANSI} \index[general]{Tape!Label!IBM} -By default, Bareos uses its own tape label (see \nameref{backward-compability-tape-format} and \linkResourceDirective{Dir}{Pool}{Label Type}). +By default, Bareos uses its own tape label (see \nameref{backward-compatibility-tape-format} and \linkResourceDirective{Dir}{Pool}{Label Type}). However, Bareos also supports reading and write ANSI and IBM tape labels. \subsection{Reading} diff --git a/docs/manuals/en/main/backward-compability.tex b/docs/manuals/en/main/backward-compatibility.tex similarity index 97% rename from docs/manuals/en/main/backward-compability.tex rename to docs/manuals/en/main/backward-compatibility.tex index a51766b5d55..9db026101dc 100644 --- a/docs/manuals/en/main/backward-compability.tex +++ b/docs/manuals/en/main/backward-compatibility.tex @@ -1,13 +1,13 @@ \chapter{Backward Compatibility} \index[general]{Compatibility!Backward} -\label{backward-compability} +\label{backward-compatibility} \section{Tape Formats} \index[general]{Tape!Format} -\label{backward-compability-tape-format} +\label{backward-compatibility-tape-format} -One of the major goals of Backup softare is to ensure that you can restore +One of the major goals of Backup software is to ensure that you can restore tapes (the word tape should also include disk volumes) that you wrote years ago. This means that each new version of the software should be able to read old format tapes. The first problem you will have is to ensure that the diff --git a/docs/manuals/en/main/configure.tex b/docs/manuals/en/main/configure.tex index bd5cac7655f..fb31959ad36 100644 --- a/docs/manuals/en/main/configure.tex +++ b/docs/manuals/en/main/configure.tex @@ -401,15 +401,15 @@ \section{Resource} A resource is defined as the resource type (see \nameref{ResTypes}), followed by an open brace (\path|{|), a number of \nameref{sec:ConfigurationResourceDirective}s, and ended by a closing brace (\path|}|) -\hide{ -\begin{bconfig}{Resource} -$RESOURCETYPE { - Name = $RESOURCENAME - $KEY1 = $VALUE1 - $KEY2 = $VALUE2 -} -\end{bconfig} -} +% \hide{ +% \begin{bconfig}{Resource} +% $RESOURCETYPE { +% Name = $RESOURCENAME +% $KEY1 = $VALUE1 +% $KEY2 = $VALUE2 +% } +% \end{bconfig} +% } Each resource definition MUST contain a \configdirective{Name} directive. It can contain a \configdirective{Description} directive. diff --git a/docs/manuals/en/main/dirdconf.tex b/docs/manuals/en/main/dirdconf.tex index fcabe890dc0..cfb6ffc7dd3 100644 --- a/docs/manuals/en/main/dirdconf.tex +++ b/docs/manuals/en/main/dirdconf.tex @@ -396,7 +396,7 @@ \section{Storage Resource} Storage { Name = DLTDrive Address = lpmatou - Password = storage_password # password for Storage daemon + Password = storage\_password # password for Storage daemon Device = "HP DLT 80" # same as Device in Storage daemon Media Type = DLT8000 # same as MediaType in Storage daemon } diff --git a/docs/manuals/en/main/general.tex b/docs/manuals/en/main/general.tex index 32587e34734..d934f403e06 100644 --- a/docs/manuals/en/main/general.tex +++ b/docs/manuals/en/main/general.tex @@ -27,7 +27,7 @@ \section{History} This documentation also bases on the \elink{original Bacula documentation}{http://www.bacula.org/5.2.x-manuals/en/main/main/}, it is technically also a fork of the documenation created following the rules of the GNU Free Documentation License. -Original author of Bacula and it's documentation is Kern Sibbald. We thank Kern and all contributors to Bacula and it's documentation. +Original author of Bacula and its documentation is Kern Sibbald. We thank Kern and all contributors to Bacula and it's documentation. We maintain a list of contributors to Bacula (until the time we've started the fork) and Bareos in our \elink{AUTHORS}{https://github.com/bareos/bareos/blob/master/AUTHORS} file. @@ -503,8 +503,8 @@ \section{Terminology} easily restored. This function is particularly useful if certain Volumes or Jobs have exceeded their retention period and have been pruned or purged from the Catalog. Scanning data from Volumes into the - Catalog is done by using the {\bf bscan} program. See the \ilink{bscan - section}{bscan} of the Bareos Utilities chapter of this manual for more + Catalog is done by using the {\bf bscan} program. See the \ilink{bscan section}{bscan} + of the Bareos Utilities chapter of this manual for more details. \item [Volume] diff --git a/docs/manuals/en/main/storedconf.tex b/docs/manuals/en/main/storedconf.tex index ea3467640bc..b4bc60e5e2a 100644 --- a/docs/manuals/en/main/storedconf.tex +++ b/docs/manuals/en/main/storedconf.tex @@ -98,7 +98,7 @@ \section{Director Resource} \begin{bconfig}{Storage daemon Director definition} Director { Name = MainDirector - Password = my_secret_password + Password = my\_secret\_password } \end{bconfig} diff --git a/docs/manuals/en/main/tutorial.tex b/docs/manuals/en/main/tutorial.tex index 0fc52e5f460..53e51e50748 100644 --- a/docs/manuals/en/main/tutorial.tex +++ b/docs/manuals/en/main/tutorial.tex @@ -51,11 +51,11 @@ \section{Starting the Daemons} Assuming you have installed the packages, to start the three daemons, from your installation directory, simply enter: -\begin{verbatim} +\begin{bconsole}{start services} service bareos-dir start service bareos-sd start service bareos-fd start -\end{verbatim} +\end{bconsole} \section{Using the Director to Query and Start Jobs} @@ -280,15 +280,15 @@ \section{Running a Job} Now, let's actually run a job with: \footnotesize -\begin{verbatim} +\begin{bconsole}{run} run -\end{verbatim} +\end{bconsole} \normalsize you should get the following output: \footnotesize -\begin{verbatim} +\begin{bconsole}{select job} Automatically selected Catalog: MyCatalog Using Catalog "MyCatalog" A job name must be specified. @@ -297,14 +297,14 @@ \section{Running a Job} 2: BackupCatalog 3: RestoreFiles Select Job resource (1-3): -\end{verbatim} +\end{bconsole} \normalsize Here, Bareos has listed the three different Jobs that you can run, and you should choose number {\bf 1} and type enter, at which point you will get: \footnotesize -\begin{verbatim} +\begin{bconsole}{run job} Run Backup job JobName: BackupClient1 Level: Incremental @@ -317,7 +317,7 @@ \section{Running a Job} When: 2013-05-23 14:50:04 Priority: 10 OK to run? (yes/mod/no): -\end{verbatim} +\end{bconsole} \normalsize At this point, take some time to look carefully at what is printed and @@ -337,7 +337,7 @@ \section{Running a Job} % \footnotesize -% \begin{verbatim} +% \begin{bconsole} % 28-Apr-2003 14:22 bareos-dir: Last FULL backup time not found. Doing % FULL backup. % 28-Apr-2003 14:22 bareos-dir: Start Backup JobId 1, @@ -348,7 +348,7 @@ \section{Running a Job} % Storage: FileStorage % Media type: File % Pool: Default -% \end{verbatim} +% \end{bconsole} % \normalsize % % The first message, indicates that no previous Full backup was done, so Bareos @@ -363,20 +363,20 @@ \section{Running a Job} % Volume that Bareos can write on. We do so with: % % \footnotesize -% \begin{verbatim} +% \begin{bconsole} % label -% \end{verbatim} +% \end{bconsole} % \normalsize % % and Bareos will print: % % \footnotesize -% \begin{verbatim} +% \begin{bconsole} % The defined Storage resources are: % 1: File % Item 1 selected automatically. % Enter new Volume name: -% \end{verbatim} +% \end{bconsole} % \normalsize % % at which point, you should enter some name beginning with a letter and @@ -384,7 +384,7 @@ \section{Running a Job} % permitted. For example, enter {\bf TestVolume001}, and you should get back: % % \footnotesize -% \begin{verbatim} +% \begin{bconsole} % Defined Pools: % 1: Default % Item 1 selected automatically. @@ -394,7 +394,7 @@ \section{Running a Job} % Catalog record for Volume "TestVolume002", Slot 0 successfully created. % Requesting mount FileStorage ... % 3001 OK mount. Device=/var/lib/bareos/storage -% \end{verbatim} +% \end{bconsole} % \normalsize % % Finally, enter {\bf messages} and you should get something like: @@ -449,9 +449,9 @@ \section{Running a Job} have the following item: \footnotesize -\begin{verbatim} +\begin{bconsole}{volume} -rw-r----- 1 bareos bareos 39072153 Apr 28 14:30 Full-001 -\end{verbatim} +\end{bconsole} \normalsize This is the file Volume that you just wrote and it contains all the data of @@ -471,10 +471,10 @@ \section{Running a Job} % your database using: % % \footnotesize -% \begin{verbatim} +% \begin{bconsole} % ./drop_bareos_tables % ./make_bareos_tables -% \end{verbatim} +% \end{bconsole} % \normalsize % % Please note that this will erase all information about the previous jobs that @@ -523,13 +523,13 @@ \section{Restoring Your Files} did, and you will get the following output: \footnotesize -\begin{verbatim} +\begin{bconsole}{select resource} Automatically selected Client: bareos-fd The defined FileSet resources are: 1: Catalog 2: Full Set Select FileSet resource (1-2): -\end{verbatim} +\end{bconsole} \normalsize As you can see, Bareos knows what client @@ -537,7 +537,7 @@ \section{Restoring Your Files} Select {\bf 2}, because you want to restore files from the file set. \footnotesize -\begin{verbatim} +\begin{bconsole}{restore filesystem} +-------+-------+----------+------------+---------------------+---------------+ | jobid | level | jobfiles | jobbytes | starttime | volumename | +-------+-------+----------+------------+---------------------+---------------+ @@ -555,7 +555,7 @@ \section{Restoring Your Files} cwd is: / $ -\end{verbatim} +\end{bconsole} \normalsize where I have truncated the listing on the right side to make it more readable. @@ -577,15 +577,15 @@ \section{Restoring Your Files} To exit this mode, simply enter: \footnotesize -\begin{verbatim} +\begin{bconsole}{done} done -\end{verbatim} +\end{bconsole} \normalsize and you will get the following output: \footnotesize -\begin{verbatim} +\begin{bconsole}{job report} Bootstrap records written to /home/user/bareos/testbin/working/restore.bsr The restore job will require the following Volumes: @@ -632,7 +632,7 @@ \section{Restoring Your Files} Priority: 10 Plugin Options: *None* OK to run? (yes/mod/no): -\end{verbatim} +\end{bconsole} \normalsize If you answer {\bf yes} your files will be restored to @@ -644,7 +644,7 @@ \section{Restoring Your Files} similar to this: \footnotesize -\begin{verbatim} +\begin{bconsole}{job report} 23-May 15:24 bareos-dir JobId 2: Start Restore Job RestoreFiles.2013-05-23_15.24.01_10 23-May 15:24 bareos-dir JobId 2: Using Device "FileStorage" to read. 23-May 15:24 bareos-sd JobId 2: Ready to read from volume "TestVolume001" on device "FileStorage" (/var/lib/bareos/storage). @@ -664,7 +664,7 @@ \section{Restoring Your Files} FD termination status: OK SD termination status: OK Termination: Restore OK -\end{verbatim} +\end{bconsole} \normalsize After exiting the Console program, you can examine the files in \directory{/tmp/bareos-restores}, @@ -882,9 +882,9 @@ \subsection*{Director: test client, add a job} % send you a message similar to the following: % % \footnotesize -% \begin{verbatim} +% \begin{bconsole} % bareos-sd: block.c:337 === Write error errno=28: ERR=No space left on device -% \end{verbatim} +% \end{bconsole} % \normalsize % % This indicates that Bareos got a write error because the tape is full. Bareos @@ -905,14 +905,14 @@ \subsection*{Director: test client, add a job} % message similar to the following: % % \footnotesize -% \begin{verbatim} +% \begin{bconsole} % bareos-sd: Job usersave.2002-09-19.10:50:48 waiting. Cannot find any % appendable volumes. % Please use the "label" command to create a new Volume for: % Storage: SDT-10000 % Media type: DDS-4 % Pool: Default -% \end{verbatim} +% \end{bconsole} % \normalsize % % Until you create a new Volume, this message will be repeated an hour later, @@ -995,9 +995,9 @@ \subsection*{Director: test client, add a job} % daemons from the install directory as follows: % % \footnotesize -% \begin{verbatim} +% \begin{bconsole} % ./bareos start -d100 -% \end{verbatim} +% \end{bconsole} % \normalsize % % This can be particularly helpful if your daemons do not start correctly, @@ -1008,9 +1008,9 @@ \subsection*{Director: test client, add a job} % To stop the three daemons, enter the following from the install directory: % % \footnotesize -% \begin{verbatim} +% \begin{bconsole} % ./bareos stop -% \end{verbatim} +% \end{bconsole} % \normalsize % % The execution of {\bf bareos stop} may complain about pids not found. This is @@ -1134,14 +1134,14 @@ \section{Pools} % the following: % % \footnotesize -% \begin{verbatim} +% \begin{bconsole} % The defined Storage resources are: % 1: File % 2: 8mmDrive % 3: DLTDrive % 4: SDT-10000 % Select Storage resource (1-4): -% \end{verbatim} +% \end{bconsole} % \normalsize % % At this point, you should have a blank tape in the drive corresponding to the @@ -1150,17 +1150,17 @@ \section{Pools} % It will then ask you for the Volume name. % % \footnotesize -% \begin{verbatim} +% \begin{bconsole} % Enter new Volume name: -% \end{verbatim} +% \end{bconsole} % \normalsize % % If Bareos complains: % % \footnotesize -% \begin{verbatim} +% \begin{bconsole} % Media record for Volume xxxx already exists. -% \end{verbatim} +% \end{bconsole} % \normalsize % % It means that the volume name {\bf xxxx} that you entered already exists in @@ -1169,7 +1169,7 @@ \section{Pools} % proper printing. % % \footnotesize -% \begin{verbatim} +% \begin{bconsole} % +---------------+---------+--------+----------------+-----/~/-+------------+-----+ % | VolumeName | MediaTyp| VolStat| VolBytes | LastWri | VolReten | Recy| % +---------------+---------+--------+----------------+---------+------------+-----+ @@ -1186,7 +1186,7 @@ \section{Pools} % | DLT-04May2002 | DLT8000 | Full | 60,486,677,724 | 2002-05 | 31,536,000 | 0 | % | DLT-26May02 | DLT8000 | Append | 1,336,699,620 | 2002-05 | 31,536,000 | 1 | % +---------------+---------+--------+----------------+-----/~/-+------------+-----+ -% \end{verbatim} +% \end{bconsole} % \normalsize % % Once Bareos has verified that the volume does not already exist, it will @@ -1289,4 +1289,4 @@ \section{Other Useful Console Commands} Most of the commands given above, with the exception of {\bf list}, will prompt you for the necessary arguments if you simply enter the command name. -The full list of commands is shown in the chapter \nameref{sec:ConsoleCommands}. \ No newline at end of file +The full list of commands is shown in the chapter \nameref{sec:ConsoleCommands}. diff --git a/docs/manuals/en/main/webui.tex b/docs/manuals/en/main/webui.tex index 590226959a7..025a97dd967 100644 --- a/docs/manuals/en/main/webui.tex +++ b/docs/manuals/en/main/webui.tex @@ -184,7 +184,7 @@ \subsubsection{Configuration of profile resources} The package \package{bareos-webui} comes with a predefined profile for \bareosWebui: \resourcename{Dir}{Profile}{webui-admin}. -If your \bareosWebui is installed on another system then the \bareosDir, you have to copy the profile to the \bareosDir. +If your \bareosWebui is installed on another system than the \bareosDir, you have to copy the profile to the \bareosDir. This is the default profile, giving access to all Bareos resources and allowing all commands used by the \bareosWebui: @@ -381,7 +381,7 @@ \subsection{Console/Profile changes} The \bareosWebui Director profile shipped with Bareos 15.2 (\resourcename{Dir}{Profile}{webui} in the file \file{/etc/bareos/bareos-dir.d/webui-profiles.conf}) is not sufficient to use the \bareosWebui 16.2. This has several reasons: \begin{enumerate} - \item The handling of \dt{Acl}s is more strict in Bareos 16.2 then it has been in Bareos 15.2. + \item The handling of \dt{Acl}s is more strict in Bareos 16.2 than it has been in Bareos 15.2. Substring matching is no longer enabled, therefore you need to change \bcommand{.bvfs_*} to \bcommand{.bvfs_.*} in your \linkResourceDirective{Dir}{Profile}{Command ACL} to have a proper regular expression. Otherwise the restore module won't work any longer, especially the file browser. diff --git a/docs/manuals/en/new_main_reference/Makefile b/docs/manuals/en/new_main_reference/Makefile index a6642196fa7..652b64b891e 100644 --- a/docs/manuals/en/new_main_reference/Makefile +++ b/docs/manuals/en/new_main_reference/Makefile @@ -11,6 +11,7 @@ BUILDDIR = BareosMainReference # Put it first so that "make" without argument is like "make help". all: + ./convert_all_tex_files_to_rst.sh @$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) #@$(SPHINXBUILD) -M latexpdf "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/manuals/en/new_main_reference/README.txt b/docs/manuals/en/new_main_reference/README.txt new file mode 100644 index 00000000000..f266c44c915 --- /dev/null +++ b/docs/manuals/en/new_main_reference/README.txt @@ -0,0 +1,22 @@ + + +Automatic conversion of the old documentation into the new Sphinx rst format. + +The conversion of the original textfiles works in two passes. The +files that are processed are listed in "destfiles.txt". + +The script "convert_all_tex_files_to_rst.sh" converts all files to the new format. +The conversion hast two phases: + +* **pre_conversion_changes.sh** changes things in the original tex files + that cause problems for pandoc. These are mostly the self-created environments + which are converted to "verbatim" enviroments. + +* then pandoc is called to convert the .tex file to .rst files. + +* **post_conversion_changes.sh** then converts the things that pandoc was not able to convert + (:raw-latex:`xxxxx`) output to the correct restructured text structures. + +The resulting rst files are then processed by sphinx. + +As the developers guide is already converted to rst. these files are only copied over. diff --git a/docs/manuals/en/new_main_reference/build/.gitignore b/docs/manuals/en/new_main_reference/build/.gitignore deleted file mode 100644 index 90d213bcb84..00000000000 --- a/docs/manuals/en/new_main_reference/build/.gitignore +++ /dev/null @@ -1,4 +0,0 @@ -doctrees -html -latex -singlehtml diff --git a/docs/manuals/en/new_main_reference/convert.sh b/docs/manuals/en/new_main_reference/convert.sh deleted file mode 100755 index e07287ae86f..00000000000 --- a/docs/manuals/en/new_main_reference/convert.sh +++ /dev/null @@ -1,11 +0,0 @@ -#!/bin/bash - -# pandoc - convert tex to rst - -./tex2rst.sh - -# sed - replace raw-latex with rst - -./replace.sh - -exit diff --git a/docs/manuals/en/new_main_reference/convert_all_tex_files_to_rst.sh b/docs/manuals/en/new_main_reference/convert_all_tex_files_to_rst.sh new file mode 100755 index 00000000000..9f94d3df27f --- /dev/null +++ b/docs/manuals/en/new_main_reference/convert_all_tex_files_to_rst.sh @@ -0,0 +1,25 @@ +#!/bin/bash +set -x + +ORIGIN_DIR="../main/" +TARGET_DIR="./source/" + +for destfile in `cat destfiles.txt | grep -v ^#`; +do + file=`echo $destfile | sed 's#.*/##g'` + chapterdir=`echo $destfile | sed 's#/.*##g'` + filebase=`basename $destfile .tex` + + mkdir -p ${TARGET_DIR}${chapterdir} + if [ "${chapterdir}" != "developers" ]; then + + ./pre_conversion_changes.sh ${ORIGIN_DIR}${file} ${TARGET_DIR}${destfile}; + + pandoc --verbose --columns=500 -f latex+raw_tex -t rst ${TARGET_DIR}${destfile} -o ${TARGET_DIR}${chapterdir}/${filebase}.rst || exit "could not convert file $file" + + ./post_conversion_changes.sh ${TARGET_DIR}${chapterdir}/${filebase}.rst + else + # developers files are only copied over + cp ../developers/source/${file} ${TARGET_DIR}${chapterdir} + fi +done diff --git a/docs/manuals/en/new_main_reference/destfiles.txt b/docs/manuals/en/new_main_reference/destfiles.txt new file mode 100755 index 00000000000..f3cbb285a6a --- /dev/null +++ b/docs/manuals/en/new_main_reference/destfiles.txt @@ -0,0 +1,79 @@ +# This file contains the filenames and target directories. +# Every file is copied from the original manual directory +# converted to rst and stored in the target directory. +# When workin on specific files, the rest can be commented +# out for faster processing and quick feedback + +# main chapters +chapter01/general.tex +chapter01/state.tex +chapter02/install.tex +chapter03/webui.tex +chapter04/update.tex +chapter05/quickstart.tex +chapter06/tutorial.tex +chapter07/critical.tex +chapter08/configure.tex +chapter09/dirdconf.tex +chapter10/storedconf.tex +chapter11/filedconf.tex +chapter12/messagesres.tex +chapter13/consoleconf.tex +chapter14/monitorconf.tex +chapter15/bconsole.tex +chapter16/restore.tex +chapter17/disk.tex +hapter17/recycling.tex +chapter18/pools.tex +chapter19/autochangers.tex +chapter20/tape-without-autochanger.tex +chapter21/spooling.tex +chapter22/migration.tex +chapter23/always-incremental.tex +chapter24/basejob.tex +chapter26/plugins.tex +chapter27/win32.tex +chapter28/client-initiated-connection.tex +chapter28/passiveclient.tex +chapter28/lanaddress.tex +chapter29/tls.tex +chapter30/dataencryption.tex +chapter31/ndmp.tex +chapter32/catmaintenance.tex +chapter33/security.tex + + +# appendix +appendix-a/requirements.tex +appendix-b/supportedoses.tex +appendix-c/programs.tex +appendix-d/bootstrap.tex +appendix-e/verify.tex +appendix-f/backward-compatibility.tex +appendix-g/tables.tex +appendix-h/howto.tex +appendix-i/rescue.tex +appendix-j/troubleshooting.tex +appendix-k/debug.tex +appendix-l/releasenotes.tex +appendix-m/license.tex + +# developer guide (only copying from developers guide) +developers/api.rst +developers/catalog.rst +developers/daemonprotocol.rst +developers/directorConsole.rst +developers/fdl.rst +developers/file.rst +developers/generaldevel.rst +developers/mediaformat.rst +developers/mempool.rst +developers/messages.rst +developers/netprotocol.rst +developers/platformsupport.rst +developers/pluginAPI.rst +developers/porting.rst +developers/regression.rst +developers/smartall.rst +developers/storage.rst +developers/tls-techdoc.rst diff --git a/docs/manuals/en/new_main_reference/post_conversion_changes.sh b/docs/manuals/en/new_main_reference/post_conversion_changes.sh new file mode 100755 index 00000000000..4fc090f56f0 --- /dev/null +++ b/docs/manuals/en/new_main_reference/post_conversion_changes.sh @@ -0,0 +1,344 @@ +#!/bin/bash + +DESTFILE=$1 + +PERL="perl -i.bak -pe" + +# links +# ${PERL} 's#':raw-latex:`\\elink\{fork\}\{http://www.bareos.org/en/faq/items/why_fork.html\}`#`\1 \2>`_#g' + +${PERL} 's#\\bconfigInput\{(.*?)\}#.. literalinclude:: ../../main/\1#g' ${DESTFILE} + +${PERL} 's#:raw-latex:`\\bareosWhitepaperTapeSpeedTuning`#\\elink{Bareos Whitepaper Tape Speed Tuning}{http://www.bareos.org/en/Whitepapers/articles/Speed_Tuning_of_Tape_Drives.html}#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\bareosMigrateConfigSh `#\\elink{bareos-migrate-config.sh}{https://github.com/bareos/bareos-contrib/blob/master/misc/bareos-migrate-config/bareos-migrate-config.sh} #g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\bareosTlsConfigurationExample`#\\elink{Bareos Regression Testing Base Configuration}{https://github.com/bareos/bareos-regress/tree/master/configs/BASE/}#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\externalReferenceDroplet`#\\url{https://github.com/scality/Droplet}#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\externalReferenceIsilonNdmpEnvironmentVariables`#}\elink{Isilon OneFS 7.2.0 CLI Administration Guide}{https://www.emc.com/collateral/TechnicalDocument/docu56048.pdf}, section \bquote{NDMP environment variables}#g' ${DESTFILE} + + + +${PERL} 's#:raw-latex:`\\linkResourceDirective\*\{(.*?)\}\{(.*?)\}\{(.*?)\}`#**\3**:sup:`\1`:sub:`\2`\ #g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\linkResourceDirectiveValue\{(.*?)\}\{(.*?)\}\{(.*?)\}\{(.*?)\}`#**\3**:sup:`\1`:sub:`\2`\ = **\4**#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\linkResourceDirective\{(.*?)\}\{(.*?)\}\{(.*?)\}`#**\3**:sup:`\1`:sub:`\2`\ #g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\linkResourceDirective\*\{(.*?)\}\{(.*?)\}\{(.*?)\}`#**\3**:sup:`\1`:sub:`\2`\ #g' ${DESTFILE} + + +${PERL} 's#:raw-latex:`\\resourceDirectiveValue\{(.*?)\}\{(.*?)\}\{(.*?)\}\{(.*?)\}`#**\3**:sup:`\1`:sub:`\2`\ = **\4**#g' ${DESTFILE} + + +${PERL} 's#:raw-latex:`\\bquote\{(.*?)\}`#:emphasis:`\1`#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\pluginevent\{(.*?)\}`#:strong:`\1`#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\textrightarrow`#->#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\textrightarrow `#->#g' ${DESTFILE} + +#``URL:http://download.bareos.org/bareos/release/latest/`` +${PERL} 's#``URL:(.*?)``#`\1 <\1>`_#g' ${DESTFILE} +${PERL} 's#``\\url\{(.*?)\}#`\1 \1>`_#g' ${DESTFILE} + +${PERL} 's#:raw-latex:`\\ref\{(.*?)\}`#`<\1>`_#g' ${DESTFILE} + +${PERL} 's#``path:(.*)``#:file:`\1`#g' ${DESTFILE} + + +# abbreviations +${PERL} 's#:raw-latex:`\\bareosDir(\s*)`#\|bareosDir\|\1#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\bareosFd(\s*)`#\|bareosFd\|\1#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\bareosSd(\s*)`#\|bareosSd\|\1#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\bareosTrayMonitor(\s*)`#\|bareosTrayMonitor\|\1#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\bareosWebui(\s*)`#\|bareosWebui\|\1#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\mysql(\s*)`# \|mysql\|\1#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\postgresql(\s*)`# \|postgresql\|\1#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\sqlite(\s*)`#\|sqlite\|\1#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\vmware(\s*)`#\|vmware\|\1#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\vSphere(\s*)`#\|vsphere\|\1#g' ${DESTFILE} + +# link targets +${PERL} 's#:raw-latex:`\\ilink\{(.*?)\}\{(.*?)\}`#:ref:`\1 <\2>`#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\nameref\{(.*?)\}`#:ref:`\1`#g' ${DESTFILE} +${PERL} 's#\\nameref\{(.*?)\}#:ref:`\1`#g' ${DESTFILE} + + + +${PERL} 's#:raw-latex:`\\elink\{(.*?)\}\{(.*?)\}`(\s*)#`\1 <\2>`_\3#g' ${DESTFILE} +${PERL} 's#\\elink\{(.*?)\}\{(.*?)\}(\s*)#`\1 <\2>`_\3#g' ${DESTFILE} + + + + +${PERL} 's#:raw-latex:`\\label\{(.*)\}`#\n\n.. _`\1`: \1#g' ${DESTFILE} + +#${PERL} 's#:raw-latex:`\\bcommand\{(.*?)\}\{(.+?)}`#:strong:`\1 \2`#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\bcommand\{(\w+)\}\{([\w/ ]+)}`#:strong:`\1 \2`#g' ${DESTFILE} + +${PERL} 's#:raw-latex:`\\bcommand\{(.*?)\}\{}`#:strong:`\1`#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\bcommand\{(.*?)\}`#:strong:`\1`#g' ${DESTFILE} + +${PERL} 's#\\bcommand\{(.*?)\}\{}#:strong:`\1`#g' ${DESTFILE} + +${PERL} 's#:raw-latex:`\\command\{(.*?)\}`#:program:`\1`#g' ${DESTFILE} + +${PERL} 's#:raw-latex:`\\configline\{(.*?)\}`#:strong:`\1`#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\configdirective\{(.*?)\}`#:strong:`\1`#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\configresource\{(.*?)\}`#:strong:`\1`#g' ${DESTFILE} + + + +# abbreviations +${PERL} 's#:raw-latex:`\\bareosDir\(\s*\)`#\|bareosDir\|\1#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\bareosFd\(\s*\)`#\|bareosFd\|\1#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\bareosSd\(\s*\)`#\|bareosSd\|\1#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\bareosTrayMonitor\(\s*\)`#\|bareosTrayMonitor\|\1#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\bareosWebui\(\s*\)`#\|bareosWebui\|\1#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\mysql\(\s*\)`# \|mysql\|\1#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\postgresql\(\s*\)`# \|postgresql\|\1#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\sqlite\(\s*\)`#\|sqlite\|\1#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\vmware\(\s*\)`#\|vmware\|\1#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\vSphere\(\s*\)`#\|vsphere\|\1#g' ${DESTFILE} + + + + + +# rename sec: to section- as : has special meaning in sphinx +${PERL} 's#sec:#section-#g' ${DESTFILE} +${PERL} 's#item:#item-#g' ${DESTFILE} + + +# \package +${PERL} 's#:raw-latex:`\\package\{(.*?)\}`#**\1**#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\package\{(.*?)\}`#**\1**#g' ${DESTFILE} + +${PERL} 's#:raw-latex:`\\volumestatus\{(.*?)\}`#**\1**#g' ${DESTFILE} + + +${PERL} 's#:raw-latex:`\\volumeparameter\{(.*?)\}\{(.*?)\}`#\1 = **\2**#g' ${DESTFILE} + +# remove nonsense lines +${PERL} 's# .. raw:: latex##g' ${DESTFILE} + +# \parameter +${PERL} 's#(\s+):raw-latex:`\\parameter\{(.*?)\}(\s*)`#\1 :option:`\2`\3#g' ${DESTFILE} +${PERL} 's#(\s+)\\parameter\{(.*?)\}(\s*)#\1 :option:`\2`\3#g' ${DESTFILE} + + + +# sinceversion +# raw-latex:`\sinceVersion{dir}{requires!jansson}{15.2.0}` +#sed 's#:raw-latex:`\\sinceVersion\{(.*)\}\{(.*)\}\{(.*)\}`#\n\n.. versionadded:: \3\n \1 \2\n#g' ${DESTFILE} +${PERL} 's|:raw-latex:`\\sinceVersion\{(.*)\}\{(.*)\}\{(.*)\}`|\3|g' ${DESTFILE} + + + +# file +${PERL} 's#:raw-latex:`\\file\{(.*?)\}`#:file:`\1`#g' ${DESTFILE} +${PERL} 's#\\file\{(.*?)\}#:file:`\1`#g' ${DESTFILE} + +${PERL} 's#:raw-latex:`\\directory\{(.*?)\}`#:file:`\1`#g' ${DESTFILE} + +${PERL} 's#:raw-latex:`\\argument\{(.*?)\}`#:strong:`\1`#g' ${DESTFILE} + +#\dt +${PERL} 's#:raw-latex:`\\dt\{([A-Za-z ]*)\}`#:strong:`\1`\ #g' ${DESTFILE} + +${PERL} 's#:raw-latex:`\\dtYesNo`#:strong:`Yes|No`#g' ${DESTFILE} + +#${PERL} 's#:raw-latex:`\\multicolumn\{[^}]*\}\{[^}]+\}\{([^}]*)\}`#:strong:`\1`\ #g' ${DESTFILE} + + +#\os +${PERL} 's#\\os\{(.*?)\}\{}#:strong:`\1`#g' ${DESTFILE} +${PERL} 's#\\os\{(.*?)\}\{(.*?)}#:strong:`\1 \2`#g' ${DESTFILE} + + + + +#code blocks +# {commands}{get the process ID of a running Bareos daemon} +# command> /command>parameter>ps fax | grep bareos-dir/parameter> +# 2103 ? S 0:00 /usr/sbin/bareos-dir + +#.. code-block:: c +# :caption: get the process ID of a running Bareos daemon + +${PERL} 's#begin\{verbatim\}##g' ${DESTFILE} +${PERL} 's#end\{verbatim\}##g' ${DESTFILE} + +${PERL} 's#\{bareosConfigResource\}\{(.*?)\}\{(.*?)\}\{(.*?)\}#\n.. code-block:: sh\n :caption: \1 \2 \3\n#g' ${DESTFILE} +#${PERL} 's#\{bareosConfigResource\}\{(.*?)\}#\n.. code-block:: sh\n :caption: \1\n#g' ${DESTFILE} + +${PERL} 's#\{commands\}\{(.*)\}#\n.. code-block:: sh\n :caption: \1\n#g' ${DESTFILE} +${PERL} 's#\{logging\}\{(.*)\}#\n.. code-block:: sh\n :caption: \1\n#g' ${DESTFILE} +${PERL} 's#\{config\}\{(.*)\}#\n.. code-block:: sh\n :caption: \1\n#g' ${DESTFILE} +${PERL} 's#\{bconfig\}\{(.*)\}#\n.. code-block:: sh\n :caption: \1\n#g' ${DESTFILE} +${PERL} 's#\{commandOut\}\{(.*)\}#\n.. code-block:: sh\n :caption: \1\n#g' ${DESTFILE} +${PERL} 's#\{bconsole\}\{(.*)\}#\n.. code-block:: sh\n :caption: \1\n#g' ${DESTFILE} + + +perl -i -pe 's#\{bareosConfigResource\}\{(.*)\}\{(.*)\}\{(.*)\}#\n.. code-block:: sh\n :caption: daemon:\1 resource:\2 name:\3\n#g' ${DESTFILE} + +#greater or equal sign +${PERL} 's#\$\\ge\$#≥#g' ${DESTFILE} +${PERL} 's#\$\\geq\$#≥#g' ${DESTFILE} +${PERL} 's#\$\$##g' ${DESTFILE} +${PERL} 's#\$=\$#≤#g' ${DESTFILE} + +# \user +${PERL} 's#:raw-latex:`\\user\{(.*)\}`#**\1**#g' ${DESTFILE} +${PERL} 's#\\user\{(.*)\}#**\1**#g' ${DESTFILE} + + + +# remove xml stuff + +${PERL} 's#\##g' ${DESTFILE} +${PERL} 's#\##g' ${DESTFILE} +${PERL} 's#\##g' ${DESTFILE} +${PERL} 's#\##g' ${DESTFILE} + + + + + +# resourcetype + +${PERL} 's#:raw-latex:`\\resourcetype\{(.*?)\}\{(.*?)\}`#:sup:`\1`\ :strong:`\2`#g' ${DESTFILE} + +# \name + + +# \dbtable +${PERL} 's#\\dbtable\{(.*)\}#**\1**#g' ${DESTFILE} + +# resourcename + +${PERL} 's#:raw-latex:`\\resourcename\{(.*?)\}\{(.*?)\}\{(.*?)\}`#**\3**:sup:`\1`:sub:`\2`\ #g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\resourcename\*\{(.*?)\}\{(.*?)\}\{(.*?)\}`#**\3**:sup:`\1`:sub:`\2`\ #g' ${DESTFILE} + + + + + +${PERL} 's#:raw-latex:`\\job\{(.*?)\}`#**\1**:sup:`Dir`:sub:`job`\ #g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\pool\{(.*?)\}`#**\1**:sup:`Dir`:sub:`pool`\ #g' ${DESTFILE} + +${PERL} 's#:raw-latex:`\\textbar`#|#g' ${DESTFILE} + + + + + + + +#\dt + + + +#\os + + + +# TODO: add link +${PERL} 's#:raw-latex:`\\linkResourceDirective\{([ \w]+)\}\{([ \w]+)\}\{([ \w]+)\}`#**\3**:sup:`\1`:sub:`\2`\ #g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\linkResourceDirective\*\{([ \w]+)\}\{([ \w]+)\}\{([ \w]+)\}`#**\3**:sup:`\1`:sub:`\2`\ #g' ${DESTFILE} + + +${PERL} 's#\\linkResourceDirective\{([ \w]+)\}\{([ \w]+)\}\{([ \w]+)\}#**\3**:sup:`\1`:sub:`\2`\ #g' ${DESTFILE} + + + + + + + + + +# TODO: check if |xxxx| replace can be used +${PERL} 's#\\configFileDirUnix#:file:`/etc/bareos/bareos-dir.conf`#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\fileStoragePath`#:file:`/var/lib/bareos/storage/`#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\scriptPathUnix`#:file:`/usr/lib/bareos/scripts/`#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\configPathUnix`#:file:`/etc/bareos/`#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\configFileDirUnix`#:file:`/etc/bareos/bareos-dir.conf`#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\configFileSdUnix`#:file:`/etc/bareos/bareos-sd.conf`#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\configFileFdUnix`#:file:`/etc/bareos/bareos-fd.conf`#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\configFileBconsoleUnix`#:file:`/etc/bareos/bconsole.conf`#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\configFileTrayMonitorUnix`#:file:`/etc/bareos/tray-monitor.conf`#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\configFileBatUnix`#:file:`/etc/bareos/bat.conf`#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\configDirectoryDirUnix`#:file:`/etc/bareos/bareos-dir.d/`#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\configDirectorySdUnix`#:file:`/etc/bareos/bareos-sd.d/`#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\configDirectoryFdUnix`#:file:`/etc/bareos/bareos-fd.d/`#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\configDirectoryBconsoleUnix`#:file:`/etc/bareos/bconsole.d/`#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\configDirectoryTrayMonitorUnix`#:file:`/etc/bareos/tray-monitor.d/`#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\logfileUnix`#:file:`/var/log/bareos/bareos.log`#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\yesno`#yes\\|no#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\NdmpBareos`#NDMP_BAREOS#g' ${DESTFILE} + + + +${PERL} 's|:raw-latex:`\\fileset\{(.*)\}`|**\1**|g' ${DESTFILE} + +${PERL} 's#:raw-latex:`\\cmlink\{([^}]*)\}`# **\1**#g' ${DESTFILE} +${PERL} 's#\\cmlink\{(.*)\}#**\1**#g' ${DESTFILE} + +# remove stuff that has no meaning anymore +${PERL} 's#\\footnotesize##g' ${DESTFILE} +${PERL} 's#\\normalsize##g' ${DESTFILE} +${PERL} 's#\\hfill##g' ${DESTFILE} + + +${PERL} 's#:math:`\ldots`#...#g' ${DESTFILE} + +PERL0="perl -0 -i.bak -pe" +# warning +${PERL0} 's#:raw-latex:`\\warning\{(.*?)\}`#\n.. warning:: \n \1#ims' ${DESTFILE} +${PERL0} 's#\\warning\{(.*?)\}#\n.. warning:: \n \1#ims' ${DESTFILE} + + + + + + +# clean empty :: at the start of line +${PERL} 's/\s*::$//g' ${DESTFILE} + + + +####### +# index +####### + + + +# index +#:raw-latex:`\index[general]{Version numbers}` +# -> +#:index:`Version numbers` +${PERL} 's#^(\s*):raw-latex:`\\index\[(.*?)\]\{([^!]*)\}`#.. index::\n\1 single: \3\n#g' ${DESTFILE} +#${PERL} 's#(\s*):raw-latex:`\\index\[(.*?)\]\{(.*?)\}`#\1:index:`\3 `#g' ${DESTFILE} + +#:raw-latex:`\index[general]{Problem!Windows}` +# -> +#:index:`pair: Problem;Windows>` +${PERL} 's#^(\s*):raw-latex:`\\index\[(.*?)\]\{([^!]*)!([^!}]*)\}`#.. index::\n\1 pair: \3; \4\n#g' ${DESTFILE} +${PERL} 's#^(\s*):raw-latex:`\\index\[(.*?)\]\{([^!]*)!([^!}]*)\}`#.. index::\n\1 pair: \3; \4\n#g' ${DESTFILE} +${PERL} 's#^(\s*):raw-latex:`\\index\[(.*?)\]\{([^!]*)!([^!}]*)\}`#.. index::\n\1 pair: \3; \4\n#g' ${DESTFILE} +#${PERL} 's#(\s*):raw-latex:`\\index\[(.*?)\]\{(.*?)!(.*?)\}`#\1:index:`\4 `#g' ${DESTFILE} + + + +#:raw-latex:`\index[general]{Windows!File Daemon!Command Line Options}` +# -> +#:index:`triple: ` +${PERL} 's#^(\s*):raw-latex:`\\index\[([^]]*)\]\{([^!]*)!([^!]*)!([^!}]*)\}`#\n.. index::\n\1 triple: \3; \4; \5;\n#g' ${DESTFILE} +#${PERL} 's#(\s*):raw-latex:`\\index\[(.*?)\]\{(.*?)!(.*?)!(.*?)\}`#\1:index:`\5 `#g' ${DESTFILE} + + + + +${PERL} 's#:raw-latex:`\\name\{(.*?)\}`#**\1**#g' ${DESTFILE} +${PERL} 's#:raw-latex:`\\host\{(.*?)\}`#:strong:`\1`#g' ${DESTFILE} + + + +diff --color -ruN ${DESTFILE}.bak ${DESTFILE} + +exit 0 diff --git a/docs/manuals/en/new_main_reference/pre_conversion_changes.sh b/docs/manuals/en/new_main_reference/pre_conversion_changes.sh new file mode 100755 index 00000000000..faf5823e872 --- /dev/null +++ b/docs/manuals/en/new_main_reference/pre_conversion_changes.sh @@ -0,0 +1,47 @@ +#!/bin/bash + +SOURCEFILE=$1 +DESTFILE=$2 + + cat ${SOURCEFILE}\ + | perl -pe 's#\\url\{(.*)\}#\\verb\|URL:\1\|#g' \ + | perl -pe 's#\{bmessage\}#{verbatim}#g' \ + | perl -pe 's#registrykey#textbf#g' \ + | perl -pe 's#HKEY_LOCAL_MACHINE#HKEY\\_LOCAL\\_MACHINE#g' \ +\ + | perl -pe 's#\\begin\{logging\}#\\begin{verbatim}{logging}#g' \ + | perl -pe 's#\\end\{logging\}#\\end{verbatim}#g' \ +\ + | perl -pe 's#\\begin\{config\}#\\begin{verbatim}{config}#g' \ + | perl -pe 's#\\end\{config\}#\\end{verbatim}#g' \ +\ + | perl -pe 's#\\begin\{bconfig\}#\\begin{verbatim}{bconfig}#g' \ + | perl -pe 's#\\end\{bconfig\}#\\end{verbatim}#g' \ +\ + | perl -pe 's#\\begin\{commands\}#\\begin{verbatim}{commands}#g' \ + | perl -pe 's#\\end\{commands\}#\\end{verbatim}#g' \ +\ + | perl -pe 's#\\begin\{bareosConfigResource\}#\\begin{verbatim}{bareosConfigResource}#g' \ + | perl -pe 's#\\end\{bareosConfigResource\}#\\end{verbatim}#g' \ +\ + | perl -pe 's#\\begin\{commandOut\}#\\begin{verbatim}{commandOut}#g' \ + | perl -pe 's#\\end\{commandOut\}#\\end{verbatim}#g' \ +\ + | perl -pe 's#\\begin\{bconsole\}#\\begin{verbatim}{bconsole}#g' \ + | perl -pe 's#\\end\{bconsole\}#\\end{verbatim}#g' \ +\ + | perl -pe 's#\\variable\{\$#\\textbf\{\\\$#g' \ + | perl -pe 's#sec:#section-#g' \ + | perl -pe 's#\$CONFIGDIR#CONFIGDIR#g'\ + | perl -pe 's#\$COMPONENT#COMPONENT#g'\ + | perl -pe 's#\$RESOURCE#RESOURCE#g'\ + | perl -pe 's#\$NAME#NAME#g'\ + | perl -pe 's#\$PATH#PATH#g'\ + | perl -pe 's#\\hide\{\$\}##g' \ + | perl -pe 's#\\path\|#\\verb\|path:#g' \ + | perl -pe 's#\\hfill##g' \ + | perl -pe 's#\\hypertarget#\textbf#g' \ + | perl -pe 's#\\bquote\{\\bconsoleOutput\{Building directory tree ...\}\}#\\bquote{Building directory tree ...}#g' \ + > ${DESTFILE} + + diff --color -ruN ${SOURCEFILE} ${DESTFILE} diff --git a/docs/manuals/en/new_main_reference/replace.sh b/docs/manuals/en/new_main_reference/replace.sh deleted file mode 100755 index a45b6ebc562..00000000000 --- a/docs/manuals/en/new_main_reference/replace.sh +++ /dev/null @@ -1,135 +0,0 @@ -#!/bin/bash - -WORKING_DIR="./source/" - -cd $WORKING_DIR - -echo '============================' -echo 'REPLACING RAW-LATEX WITH RST' -echo '============================' - -############################################################################### -# -# Substitutions -# -############################################################################### - -# -# DROP SOME STUFF WHICH IS NO LONGER NEEDED -# - -sed -i 's|:raw-latex:`\\footnotesize`||g' *.rst -sed -i 's|:raw-latex:`\\normalsize`||g' *.rst -sed -i 's|:raw-latex:`\\hfill`||g' *.rst - -# -# General substitutions -# - -sed -i 's#:raw-latex:`\\bareosFd`# \|bareosFd\| #g' *.rst -sed -i 's#:raw-latex:`\\bareosSd`# \|bareosSd\| #g' *.rst -sed -i 's#:raw-latex:`\\bareosDir`# \|bareosDir\| #g' *.rst -sed -i 's#:raw-latex:`\\bareosTraymonitor`# \|bareosTraymonitor\| #g' *.rst -sed -i 's#:raw-latex:`\\bareosWebui`# \|bareosWebui\| #g' *.rst - -sed -i 's#:raw-latex:`\\mysql`# \|mysql\| #g' *.rst -sed -i 's#:raw-latex:`\\postgresql`# \|postgresql\| #g' *.rst -sed -i 's#:raw-latex:`\\sqlite`# \|sqlite\| #g' *.rst -sed -i 's#:raw-latex:`\\vmware`# \|vmware\| #g' *.rst -sed -i 's#:raw-latex:`\\vSphere`# \|vsphere\| #g' *.rst - -# -# Bareos path and filenames -# - -sed -i 's#:raw-latex:`\\fileStoragePath`#*/var/lib/bareos/storage/*#g' *.rst -sed -i 's#:raw-latex:`\\scriptPathUnix`#*/usr/lib/bareos/scripts/*#g' *.rst -sed -i 's#:raw-latex:`\\configPathUnix`#*/etc/bareos/*#g' *.rst -sed -i 's#:raw-latex:`\\configFileDirUnix`#*/etc/bareos/bareos-dir.conf*#g' *.rst -sed -i 's#:raw-latex:`\\configFileSdUnix`#*/etc/bareos/bareos-sd.conf*#g' *.rst -sed -i 's#:raw-latex:`\\configFileFdUnix}`#*/etc/bareos/bareos-fd.conf*#g' *.rst -sed -i 's#:raw-latex:`\\configFileBconsoleUnix}`#*/etc/bareos/bconsole.conf*#g' *.rst -sed -i 's#:raw-latex:`\\configFileTrayMonitorUnix`#*/etc/bareos/tray-monitor.conf*#g' *.rst -sed -i 's#:raw-latex:`\\configFileBatUnix`#*/etc/bareos/bat.conf*#g' *.rst -sed -i 's#:raw-latex:`\\configDirectoryDirUnix`#*/etc/bareos/bareos-dir.d/*#g' *.rst -sed -i 's#:raw-latex:`\\configDirectorySdUnix`#*/etc/bareos/bareos-sd.d/*#g' *.rst -sed -i 's#:raw-latex:`\\configDirectoryFdUnix`#*/etc/bareos/bareos-fd.d/*#g' *.rst -sed -i 's#:raw-latex:`\\configDirectoryBconsoleUnix`#*/etc/bareos/bconsole.d/*#g' *.rst -sed -i 's#:raw-latex:`\\configDirectoryTrayMonitorUnix`#*/etc/bareos/tray-monitor.d/*#g' *.rst -sed -i 's#:raw-latex:`\\logfileUnix`#*/var/log/bareos/bareos.log*#g' *.rst -sed -i 's#:raw-latex:`\\yeno`#yes\\|no#g' *.rst - -# -# General -# - -sed -i 's|:raw-latex:`\\command{bconsole}`|:command:`bconsole`|g' *.rst -sed -i -E 's|:raw-latex:`\\command\{(.*)\}`|:command:`\1`|g' *.rst -sed -i -E 's|:raw-latex:`\\bcommand\{(.*)\}\{(.*)\}`|:command:`\1 \2`|g' *.rst - -sed -i -E 's|:raw-latex:`\\file\{(.*)\}`|*\1*|g' *.rst -sed -i -E 's|:raw-latex:`\\directory\{(.*)\}`|*\1*|g' *.rst -#sed -i -E 's#:raw-latex:`\\path\|(.*)\|`#*\1*#g' *.rst - -sed -i 's/:raw-latex:`\\textbar`/ \\| /g' *.rst -sed -i 's/:raw-latex:`\\textbar{}`/ \\| /g' *.rst - -sed -i -E 's|:raw-latex:`\\user\{(.*)\}`|**\1**|g' *.rst -sed -i -E 's|:raw-latex:`\\group\{(.*)\}`|**\1**|g' *.rst - -sed -i -E 's|:raw-latex:`\\parameter\{(.*)\}`|**\1**|g' *.rst -sed -i -E 's|:raw-latex:`\\argument\{(.*)\}`|**\1**|g' *.rst -sed -i -E 's|:raw-latex:`\\variable\{(.*)\}`|**\1**|g' *.rst - - -sed -i -E 's|:raw-latex:`\\sinceVersion\{(.*)\}\{(.*)\}\{(.*)\}`|\3|g' *.rst - -sed -i -E 's|:raw-latex:`\\job\{(.*)\}`|**\1**|g' *.rst -sed -i -E 's|:raw-latex:`\\fileset\{(.*)\}`|**\1**|g' *.rst - -sed -i -E 's|:raw-latex:`\\name\{(.*)\}`|**\1**|g' *.rst - -sed -i -E 's|:raw-latex:`\\host\{(.*)\}`|**\1**|g' *.rst - -sed -i -E 's|:raw-latex:`\\email\{(.*)\}`|**\1**|g' *.rst - -sed -i -E 's|:raw-latex:`\\package\{(.*)\}`|**\1**|g' *.rst - -sed -i -E 's|:raw-latex:`\\pool\{(.*)\}`|**\1**|g' *.rst -sed -i -E 's|:raw-latex:`\\volumestatus\{(.*)\}`|**\1**|g' *.rst - -sed -i -E 's|:raw-latex:`\\trademark\{(.*)\}`|*\1*|g' *.rst - -# -# INDEX -# - -sed -i -E 's|:raw-latex:`\\index\[general\]\{(.*)!(.*)\}`|\n.. index:: \n triple: General; \1; \2|g' *.rst -sed -i -E 's|:raw-latex:`\\index\[general\]\{(.*)\}`|.. index:: General; \1 |g' *.rst -sed -i -E 's|:raw-latex:`\\index\[sd\]\{(.*)\}`|.. index:: SD; \1 |g' *.rst - -# -# LABEL AND REFERENCES -# - -sed -i -E 's|:raw-latex:`\\label\{(.*)\}`|.. _\1: \1|g' *.rst - -sed -i -E 's|:raw-latex:`\\nameref\{(.*)\}`|:ref:`\1`|g' *.rst - -sed -i -E 's|:raw-latex:`\\elink\{(.*)\}\{(.*)\}`|:ref:`\1 \2`|g' *.rst - -sed -i -E 's|:raw-latex:`\\ilink\{(.*)\}\{(.*)\}`|:ref:`\2 \1`|g' *.rst - -# -# Warnings -# - -sed -i -E 's|:raw-latex:`\\warning\{(.*)\}`|\n.. warning:: \n \1|g' *.rst - -# -# IMAGES (JUST A FEW, SO MAYBE MANUALLY) -# - -echo "DONE!!" - -exit diff --git a/docs/manuals/en/new_main_reference/source/conf.py b/docs/manuals/en/new_main_reference/source/conf.py index 64e188e0315..770ab3c5bb5 100644 --- a/docs/manuals/en/new_main_reference/source/conf.py +++ b/docs/manuals/en/new_main_reference/source/conf.py @@ -46,7 +46,9 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = ['sphinx.ext.todo', - 'sphinx.ext.coverage'] + 'sphinx.ext.coverage', + 'sphinx.ext.autosectionlabel' + ] # Add any paths that contain templates here, relative to this directory. templates_path = ['templates'] diff --git a/docs/manuals/en/new_main_reference/source/images/bareos-full-logo.png b/docs/manuals/en/new_main_reference/source/images/bareos-full-logo.png deleted file mode 100644 index 96d3b6883a8..00000000000 Binary files a/docs/manuals/en/new_main_reference/source/images/bareos-full-logo.png and /dev/null differ diff --git a/docs/manuals/en/new_main_reference/source/index-appendix-a.rst b/docs/manuals/en/new_main_reference/source/index-appendix-a.rst index 2c30e8de145..441295577ea 100644 --- a/docs/manuals/en/new_main_reference/source/index-appendix-a.rst +++ b/docs/manuals/en/new_main_reference/source/index-appendix-a.rst @@ -1,4 +1,2 @@ -System requirements -################### -.. include:: requirements.rst +.. include:: appendix-a/requirements.rst diff --git a/docs/manuals/en/new_main_reference/source/index-appendix-b.rst b/docs/manuals/en/new_main_reference/source/index-appendix-b.rst index 5a9d27be232..a879ccde3a9 100644 --- a/docs/manuals/en/new_main_reference/source/index-appendix-b.rst +++ b/docs/manuals/en/new_main_reference/source/index-appendix-b.rst @@ -1,4 +1,4 @@ Operating Systems ################# -.. include:: supportedoses.rst +.. include:: appendix-b/supportedoses.rst diff --git a/docs/manuals/en/new_main_reference/source/index-appendix-c.rst b/docs/manuals/en/new_main_reference/source/index-appendix-c.rst index 33db68bdba2..0702fc3e35c 100644 --- a/docs/manuals/en/new_main_reference/source/index-appendix-c.rst +++ b/docs/manuals/en/new_main_reference/source/index-appendix-c.rst @@ -1,4 +1,2 @@ -Bareos Programs -############### -.. include:: programs.rst +.. include:: appendix-c/programs.rst diff --git a/docs/manuals/en/new_main_reference/source/index-appendix-d.rst b/docs/manuals/en/new_main_reference/source/index-appendix-d.rst index e011a932ac6..5c324fa0211 100644 --- a/docs/manuals/en/new_main_reference/source/index-appendix-d.rst +++ b/docs/manuals/en/new_main_reference/source/index-appendix-d.rst @@ -1,4 +1,2 @@ -The Bootstrap File -################## -.. include:: bootstrap.rst +.. include:: appendix-d/bootstrap.rst diff --git a/docs/manuals/en/new_main_reference/source/index-appendix-e.rst b/docs/manuals/en/new_main_reference/source/index-appendix-e.rst index e960e142058..9e01a62ffd6 100644 --- a/docs/manuals/en/new_main_reference/source/index-appendix-e.rst +++ b/docs/manuals/en/new_main_reference/source/index-appendix-e.rst @@ -1,4 +1,2 @@ -Verify File Integrity with Bareos -################################# -.. include:: verify.rst +.. include:: appendix-e/verify.rst diff --git a/docs/manuals/en/new_main_reference/source/index-appendix-f.rst b/docs/manuals/en/new_main_reference/source/index-appendix-f.rst index c80e7bdb908..d2bba31456a 100644 --- a/docs/manuals/en/new_main_reference/source/index-appendix-f.rst +++ b/docs/manuals/en/new_main_reference/source/index-appendix-f.rst @@ -1,4 +1,2 @@ -Backward Compatibility -###################### -.. include:: backward-compatibility.rst +.. include:: appendix-f/backward-compatibility.rst diff --git a/docs/manuals/en/new_main_reference/source/index-appendix-g.rst b/docs/manuals/en/new_main_reference/source/index-appendix-g.rst index 69091e49e63..cf0dc640b15 100644 --- a/docs/manuals/en/new_main_reference/source/index-appendix-g.rst +++ b/docs/manuals/en/new_main_reference/source/index-appendix-g.rst @@ -1,4 +1,2 @@ -Catalog Tables -############## -.. include:: tables.rst +.. include:: appendix-g/tables.rst diff --git a/docs/manuals/en/new_main_reference/source/index-appendix-h.rst b/docs/manuals/en/new_main_reference/source/index-appendix-h.rst index a6ab6889be1..acebac35bcb 100644 --- a/docs/manuals/en/new_main_reference/source/index-appendix-h.rst +++ b/docs/manuals/en/new_main_reference/source/index-appendix-h.rst @@ -1,4 +1,4 @@ Howtos ###### -.. include:: howto.rst +.. include:: appendix-h/howto.rst diff --git a/docs/manuals/en/new_main_reference/source/index-appendix-i.rst b/docs/manuals/en/new_main_reference/source/index-appendix-i.rst index e51586527d7..f347e52cb44 100644 --- a/docs/manuals/en/new_main_reference/source/index-appendix-i.rst +++ b/docs/manuals/en/new_main_reference/source/index-appendix-i.rst @@ -1,4 +1,2 @@ -Disaster Recovery Using Bareos -############################## -.. include:: rescue.rst +.. include:: appendix-i/rescue.rst diff --git a/docs/manuals/en/new_main_reference/source/index-appendix-j.rst b/docs/manuals/en/new_main_reference/source/index-appendix-j.rst index 287d8b716a8..74bce56cbd6 100644 --- a/docs/manuals/en/new_main_reference/source/index-appendix-j.rst +++ b/docs/manuals/en/new_main_reference/source/index-appendix-j.rst @@ -1,4 +1,4 @@ Troubleshooting ############### -.. include:: troubleshooting.rst +.. include:: appendix-j/troubleshooting.rst diff --git a/docs/manuals/en/new_main_reference/source/index-appendix-k.rst b/docs/manuals/en/new_main_reference/source/index-appendix-k.rst index 81a49add4ba..d7ad5d94758 100644 --- a/docs/manuals/en/new_main_reference/source/index-appendix-k.rst +++ b/docs/manuals/en/new_main_reference/source/index-appendix-k.rst @@ -1,4 +1,4 @@ Debugging ######### -.. include:: debug.rst +.. include:: appendix-k/debug.rst diff --git a/docs/manuals/en/new_main_reference/source/index-appendix-l.rst b/docs/manuals/en/new_main_reference/source/index-appendix-l.rst index 6f1fca7f45c..22519847b5e 100644 --- a/docs/manuals/en/new_main_reference/source/index-appendix-l.rst +++ b/docs/manuals/en/new_main_reference/source/index-appendix-l.rst @@ -1,4 +1,4 @@ Release Notes ############# -.. include:: releasenotes.rst +.. include:: appendix-l/releasenotes.rst diff --git a/docs/manuals/en/new_main_reference/source/index-appendix-m.rst b/docs/manuals/en/new_main_reference/source/index-appendix-m.rst index 85fd06cec03..b97a4a8bfe3 100644 --- a/docs/manuals/en/new_main_reference/source/index-appendix-m.rst +++ b/docs/manuals/en/new_main_reference/source/index-appendix-m.rst @@ -1,19 +1,19 @@ Bareos Copyright, Trademark and Licenses ######################################## -.. include:: license.rst +.. include:: appendix-m/license.rst GNU Free Documentation License ------------------------------ -.. include:: fdl.txt +.. include:: appendix-m/fdl.txt GNU Affero General Public License --------------------------------- -.. include:: agpl.txt +.. include:: appendix-m/agpl.txt GNU Lesser General Public License --------------------------------- -.. include:: lgpl.txt +.. include:: appendix-m/lgpl.txt diff --git a/docs/manuals/en/new_main_reference/source/index-chapter-01.rst b/docs/manuals/en/new_main_reference/source/index-chapter-01.rst new file mode 100644 index 00000000000..a3fa3764fd8 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/index-chapter-01.rst @@ -0,0 +1,5 @@ + +.. toctree:: + + chapter01/general.rst + chapter01/state.rst diff --git a/docs/manuals/en/new_main_reference/source/index-chapter-2.rst b/docs/manuals/en/new_main_reference/source/index-chapter-02.rst similarity index 51% rename from docs/manuals/en/new_main_reference/source/index-chapter-2.rst rename to docs/manuals/en/new_main_reference/source/index-chapter-02.rst index 9b1196c63be..9f0e64ff12a 100644 --- a/docs/manuals/en/new_main_reference/source/index-chapter-2.rst +++ b/docs/manuals/en/new_main_reference/source/index-chapter-02.rst @@ -1,6 +1,4 @@ Installing Bareos ################# -.. toctree:: - - install.rst +.. include:: chapter02/install.rst diff --git a/docs/manuals/en/new_main_reference/source/index-chapter-3.rst b/docs/manuals/en/new_main_reference/source/index-chapter-03.rst similarity index 59% rename from docs/manuals/en/new_main_reference/source/index-chapter-3.rst rename to docs/manuals/en/new_main_reference/source/index-chapter-03.rst index 740f0fa012d..21c8ef1494d 100644 --- a/docs/manuals/en/new_main_reference/source/index-chapter-3.rst +++ b/docs/manuals/en/new_main_reference/source/index-chapter-03.rst @@ -1,6 +1,4 @@ Installing Bareos Webui ####################### -.. toctree:: - - webui.rst +.. include:: chapter03/webui.rst diff --git a/docs/manuals/en/new_main_reference/source/index-chapter-04.rst b/docs/manuals/en/new_main_reference/source/index-chapter-04.rst new file mode 100644 index 00000000000..a57086d5628 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/index-chapter-04.rst @@ -0,0 +1,4 @@ +Updating Bareos +############### + +.. include:: chapter04/update.rst diff --git a/docs/manuals/en/new_main_reference/source/index-chapter-5.rst b/docs/manuals/en/new_main_reference/source/index-chapter-05.rst similarity index 60% rename from docs/manuals/en/new_main_reference/source/index-chapter-5.rst rename to docs/manuals/en/new_main_reference/source/index-chapter-05.rst index 593db137f0b..2972afc9179 100644 --- a/docs/manuals/en/new_main_reference/source/index-chapter-5.rst +++ b/docs/manuals/en/new_main_reference/source/index-chapter-05.rst @@ -1,6 +1,4 @@ Getting Started with Bareos ########################### -.. toctree:: - - quickstart.rst +.. include:: chapter05/quickstart.rst diff --git a/docs/manuals/en/new_main_reference/source/index-chapter-06.rst b/docs/manuals/en/new_main_reference/source/index-chapter-06.rst new file mode 100644 index 00000000000..c185a7f7247 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/index-chapter-06.rst @@ -0,0 +1,2 @@ + +.. include:: chapter06/tutorial.rst diff --git a/docs/manuals/en/new_main_reference/source/index-chapter-07.rst b/docs/manuals/en/new_main_reference/source/index-chapter-07.rst new file mode 100644 index 00000000000..190f3877004 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/index-chapter-07.rst @@ -0,0 +1,2 @@ + +.. include:: chapter07/critical.rst diff --git a/docs/manuals/en/new_main_reference/source/index-chapter-08.rst b/docs/manuals/en/new_main_reference/source/index-chapter-08.rst new file mode 100644 index 00000000000..75f0d6c8f68 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/index-chapter-08.rst @@ -0,0 +1,2 @@ + +.. include:: chapter08/configure.rst diff --git a/docs/manuals/en/new_main_reference/source/index-chapter-09.rst b/docs/manuals/en/new_main_reference/source/index-chapter-09.rst new file mode 100644 index 00000000000..23f71e43959 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/index-chapter-09.rst @@ -0,0 +1,2 @@ + +.. include:: chapter09/dirdconf.rst diff --git a/docs/manuals/en/new_main_reference/source/index-chapter-1.rst b/docs/manuals/en/new_main_reference/source/index-chapter-1.rst deleted file mode 100644 index 273a93602dd..00000000000 --- a/docs/manuals/en/new_main_reference/source/index-chapter-1.rst +++ /dev/null @@ -1,5 +0,0 @@ - -.. toctree:: - - general.rst - state.rst diff --git a/docs/manuals/en/new_main_reference/source/index-chapter-10.rst b/docs/manuals/en/new_main_reference/source/index-chapter-10.rst index 84c0763e392..f77288278f2 100644 --- a/docs/manuals/en/new_main_reference/source/index-chapter-10.rst +++ b/docs/manuals/en/new_main_reference/source/index-chapter-10.rst @@ -1,4 +1,2 @@ -Storage Daemon Configuration -############################ -.. include:: storedconf.rst +.. include:: chapter10/storedconf.rst diff --git a/docs/manuals/en/new_main_reference/source/index-chapter-11.rst b/docs/manuals/en/new_main_reference/source/index-chapter-11.rst index 7bafaf83cd4..333d4a72c04 100644 --- a/docs/manuals/en/new_main_reference/source/index-chapter-11.rst +++ b/docs/manuals/en/new_main_reference/source/index-chapter-11.rst @@ -1,4 +1,2 @@ -Client/File Daemon Configuration -################################ -.. include:: filed.conf +.. include:: chapter11/filedconf.rst diff --git a/docs/manuals/en/new_main_reference/source/index-chapter-12.rst b/docs/manuals/en/new_main_reference/source/index-chapter-12.rst index 2a50579dc3f..c907d818941 100644 --- a/docs/manuals/en/new_main_reference/source/index-chapter-12.rst +++ b/docs/manuals/en/new_main_reference/source/index-chapter-12.rst @@ -1,4 +1,2 @@ -Message Resource -################ -.. include:: messageres.rst +.. include:: chapter12/messagesres.rst diff --git a/docs/manuals/en/new_main_reference/source/index-chapter-13.rst b/docs/manuals/en/new_main_reference/source/index-chapter-13.rst index c8f98397907..635aba26425 100644 --- a/docs/manuals/en/new_main_reference/source/index-chapter-13.rst +++ b/docs/manuals/en/new_main_reference/source/index-chapter-13.rst @@ -1,4 +1,2 @@ -Console Configuration -##################### -.. include:: consoleconf.rst +.. include:: chapter13/consoleconf.rst diff --git a/docs/manuals/en/new_main_reference/source/index-chapter-14.rst b/docs/manuals/en/new_main_reference/source/index-chapter-14.rst index 6bc97535f6d..1e6748f4da0 100644 --- a/docs/manuals/en/new_main_reference/source/index-chapter-14.rst +++ b/docs/manuals/en/new_main_reference/source/index-chapter-14.rst @@ -1,4 +1,2 @@ -Monitor Configuration -##################### -.. include:: monitorconf.rst +.. include:: chapter14/monitorconf.rst diff --git a/docs/manuals/en/new_main_reference/source/index-chapter-15.rst b/docs/manuals/en/new_main_reference/source/index-chapter-15.rst index 0660a3eae00..8e4593ff8e7 100644 --- a/docs/manuals/en/new_main_reference/source/index-chapter-15.rst +++ b/docs/manuals/en/new_main_reference/source/index-chapter-15.rst @@ -1,4 +1,2 @@ -Bareos Console -############## -.. include:: bconsole.rst +.. include:: chapter15/bconsole.rst diff --git a/docs/manuals/en/new_main_reference/source/index-chapter-16.rst b/docs/manuals/en/new_main_reference/source/index-chapter-16.rst index 5d94629eee6..aa237d8ed08 100644 --- a/docs/manuals/en/new_main_reference/source/index-chapter-16.rst +++ b/docs/manuals/en/new_main_reference/source/index-chapter-16.rst @@ -1,4 +1,2 @@ -The Restore Command -################### -.. include:: restore.rst +.. include:: chapter16/restore.rst diff --git a/docs/manuals/en/new_main_reference/source/index-chapter-17.rst b/docs/manuals/en/new_main_reference/source/index-chapter-17.rst index 4d35bd4a2f1..26fbe4bde9a 100644 --- a/docs/manuals/en/new_main_reference/source/index-chapter-17.rst +++ b/docs/manuals/en/new_main_reference/source/index-chapter-17.rst @@ -1,5 +1,5 @@ Volume Management ################# -.. include:: disk.rst -.. include:: recycling.rst +.. include:: chapter17/disk.rst +.. include:: chapter17/recycling.rst diff --git a/docs/manuals/en/new_main_reference/source/index-chapter-18.rst b/docs/manuals/en/new_main_reference/source/index-chapter-18.rst index 310a07f6ac0..b7a185606b0 100644 --- a/docs/manuals/en/new_main_reference/source/index-chapter-18.rst +++ b/docs/manuals/en/new_main_reference/source/index-chapter-18.rst @@ -1,4 +1,2 @@ -Automated Disk Backup -##################### -.. include:: pools.rst +.. include:: chapter18/pools.rst diff --git a/docs/manuals/en/new_main_reference/source/index-chapter-19.rst b/docs/manuals/en/new_main_reference/source/index-chapter-19.rst index 1fd648c3eae..ad011da6515 100644 --- a/docs/manuals/en/new_main_reference/source/index-chapter-19.rst +++ b/docs/manuals/en/new_main_reference/source/index-chapter-19.rst @@ -1,4 +1,2 @@ -Autochanger Support -################### -.. include:: autochangers.rst +.. include:: chapter19/autochangers.rst diff --git a/docs/manuals/en/new_main_reference/source/index-chapter-20.rst b/docs/manuals/en/new_main_reference/source/index-chapter-20.rst index 197c53ec687..56567a28ced 100644 --- a/docs/manuals/en/new_main_reference/source/index-chapter-20.rst +++ b/docs/manuals/en/new_main_reference/source/index-chapter-20.rst @@ -1,4 +1,2 @@ -Using Tape Drives without Autochanger -##################################### -.. include:: tape-without-autochanger.rst +.. include:: chapter20/tape-without-autochanger.rst diff --git a/docs/manuals/en/new_main_reference/source/index-chapter-21.rst b/docs/manuals/en/new_main_reference/source/index-chapter-21.rst index 4a1cc2833a2..3224f2c8611 100644 --- a/docs/manuals/en/new_main_reference/source/index-chapter-21.rst +++ b/docs/manuals/en/new_main_reference/source/index-chapter-21.rst @@ -1,4 +1,2 @@ -Data Spooling -############# -.. include:: spooling.rst +.. include:: chapter21/spooling.rst diff --git a/docs/manuals/en/new_main_reference/source/index-chapter-22.rst b/docs/manuals/en/new_main_reference/source/index-chapter-22.rst index 37e91c0c86c..d7a3616a496 100644 --- a/docs/manuals/en/new_main_reference/source/index-chapter-22.rst +++ b/docs/manuals/en/new_main_reference/source/index-chapter-22.rst @@ -1,4 +1,2 @@ -Migration and Copy -################## -.. include:: migration.rst +.. include:: chapter22/migration.rst diff --git a/docs/manuals/en/new_main_reference/source/index-chapter-23.rst b/docs/manuals/en/new_main_reference/source/index-chapter-23.rst index 94f7e5c095e..5556c0d9308 100644 --- a/docs/manuals/en/new_main_reference/source/index-chapter-23.rst +++ b/docs/manuals/en/new_main_reference/source/index-chapter-23.rst @@ -1,4 +1,2 @@ -Always Incremental Backup Scheme -################################ -.. include:: always-incremental.rst +.. include:: chapter23/always-incremental.rst diff --git a/docs/manuals/en/new_main_reference/source/index-chapter-24+25.rst b/docs/manuals/en/new_main_reference/source/index-chapter-24+25.rst index 5996dc63130..327952ba9ad 100644 --- a/docs/manuals/en/new_main_reference/source/index-chapter-24+25.rst +++ b/docs/manuals/en/new_main_reference/source/index-chapter-24+25.rst @@ -1 +1 @@ -.. include:: basejob.rst +.. include:: chapter24/basejob.rst diff --git a/docs/manuals/en/new_main_reference/source/index-chapter-26.rst b/docs/manuals/en/new_main_reference/source/index-chapter-26.rst index cd4068e4e8f..8f187c86fa5 100644 --- a/docs/manuals/en/new_main_reference/source/index-chapter-26.rst +++ b/docs/manuals/en/new_main_reference/source/index-chapter-26.rst @@ -1,4 +1,2 @@ -Plugins -####### -.. include:: plugins.rst +.. include:: chapter26/plugins.rst diff --git a/docs/manuals/en/new_main_reference/source/index-chapter-27.rst b/docs/manuals/en/new_main_reference/source/index-chapter-27.rst index c852f4047c1..7c3c3764042 100644 --- a/docs/manuals/en/new_main_reference/source/index-chapter-27.rst +++ b/docs/manuals/en/new_main_reference/source/index-chapter-27.rst @@ -1,4 +1,2 @@ -The Windows Version of Bareos -############################# -.. include:: win32.rst +.. include:: chapter27/win32.rst diff --git a/docs/manuals/en/new_main_reference/source/index-chapter-28.rst b/docs/manuals/en/new_main_reference/source/index-chapter-28.rst index 1d6adb7d87f..aa60fce831e 100644 --- a/docs/manuals/en/new_main_reference/source/index-chapter-28.rst +++ b/docs/manuals/en/new_main_reference/source/index-chapter-28.rst @@ -1,6 +1,6 @@ Network setup ############# -.. include:: client-initiated-connection.rst -.. include:: passiveclient.rst -.. include:: lanaddress.rst +.. include:: chapter28/client-initiated-connection.rst +.. include:: chapter28/passiveclient.rst +.. include:: chapter28/lanaddress.rst diff --git a/docs/manuals/en/new_main_reference/source/index-chapter-29.rst b/docs/manuals/en/new_main_reference/source/index-chapter-29.rst index 4d7489b7d8c..fc97ab9c492 100644 --- a/docs/manuals/en/new_main_reference/source/index-chapter-29.rst +++ b/docs/manuals/en/new_main_reference/source/index-chapter-29.rst @@ -1,4 +1,2 @@ -Transport Encryption -#################### -.. include:: tls.rst +.. include:: chapter29/tls.rst diff --git a/docs/manuals/en/new_main_reference/source/index-chapter-30.rst b/docs/manuals/en/new_main_reference/source/index-chapter-30.rst index ffb89028f3e..62a539ded9f 100644 --- a/docs/manuals/en/new_main_reference/source/index-chapter-30.rst +++ b/docs/manuals/en/new_main_reference/source/index-chapter-30.rst @@ -1,4 +1,2 @@ -Data Encryption -############### -.. include:: dataencrption.rst +.. include:: chapter30/dataencryption.rst diff --git a/docs/manuals/en/new_main_reference/source/index-chapter-31.rst b/docs/manuals/en/new_main_reference/source/index-chapter-31.rst index 613e3fb18de..e83da1d0187 100644 --- a/docs/manuals/en/new_main_reference/source/index-chapter-31.rst +++ b/docs/manuals/en/new_main_reference/source/index-chapter-31.rst @@ -1,4 +1,4 @@ NDMP Backups with Bareos ######################## -.. include:: ndmp.rst +.. include:: chapter31/ndmp.rst diff --git a/docs/manuals/en/new_main_reference/source/index-chapter-32.rst b/docs/manuals/en/new_main_reference/source/index-chapter-32.rst index 121f887849c..a7261aa769e 100644 --- a/docs/manuals/en/new_main_reference/source/index-chapter-32.rst +++ b/docs/manuals/en/new_main_reference/source/index-chapter-32.rst @@ -1,4 +1,2 @@ -Catalog Maintenance -################### -.. include:: catmaintenance.rst +.. include:: chapter32/catmaintenance.rst diff --git a/docs/manuals/en/new_main_reference/source/index-chapter-33.rst b/docs/manuals/en/new_main_reference/source/index-chapter-33.rst index c8f89515ff2..20576d22d59 100644 --- a/docs/manuals/en/new_main_reference/source/index-chapter-33.rst +++ b/docs/manuals/en/new_main_reference/source/index-chapter-33.rst @@ -1,4 +1,2 @@ -Bareos Security Issues -###################### -.. include:: security.rst +.. include:: chapter33/security.rst diff --git a/docs/manuals/en/new_main_reference/source/index-chapter-4.rst b/docs/manuals/en/new_main_reference/source/index-chapter-4.rst deleted file mode 100644 index 0b412fe98f9..00000000000 --- a/docs/manuals/en/new_main_reference/source/index-chapter-4.rst +++ /dev/null @@ -1,6 +0,0 @@ -Updating Bareos -############### - -.. toctree:: - - update.rst diff --git a/docs/manuals/en/new_main_reference/source/index-chapter-6.rst b/docs/manuals/en/new_main_reference/source/index-chapter-6.rst deleted file mode 100644 index a876c32a47c..00000000000 --- a/docs/manuals/en/new_main_reference/source/index-chapter-6.rst +++ /dev/null @@ -1,6 +0,0 @@ -Tutorial -######## - -.. toctree:: - - tutorial.rst diff --git a/docs/manuals/en/new_main_reference/source/index-chapter-7.rst b/docs/manuals/en/new_main_reference/source/index-chapter-7.rst deleted file mode 100644 index 3dd9dc45b0c..00000000000 --- a/docs/manuals/en/new_main_reference/source/index-chapter-7.rst +++ /dev/null @@ -1,6 +0,0 @@ -Critical Items to Implement Before Production -############################################# - -.. toctree:: - - critical.rst diff --git a/docs/manuals/en/new_main_reference/source/index-chapter-8.rst b/docs/manuals/en/new_main_reference/source/index-chapter-8.rst deleted file mode 100644 index b205988a4b9..00000000000 --- a/docs/manuals/en/new_main_reference/source/index-chapter-8.rst +++ /dev/null @@ -1,4 +0,0 @@ -Customizing the Configuration -############################# - -.. include:: configure.rst diff --git a/docs/manuals/en/new_main_reference/source/index-chapter-9.rst b/docs/manuals/en/new_main_reference/source/index-chapter-9.rst deleted file mode 100644 index 4d012ee9f60..00000000000 --- a/docs/manuals/en/new_main_reference/source/index-chapter-9.rst +++ /dev/null @@ -1,4 +0,0 @@ -Director Configuration -###################### - -.. include:: dirdconf.rst diff --git a/docs/manuals/en/new_main_reference/source/index-developer-guide.rst b/docs/manuals/en/new_main_reference/source/index-developer-guide.rst new file mode 100644 index 00000000000..5e7b2e20742 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/index-developer-guide.rst @@ -0,0 +1,23 @@ +Bareos Developer Guide +====================== + +.. toctree:: + + developers/generaldevel.rst + developers/messages.rst + developers/pluginAPI.rst + developers/platformsupport.rst + developers/daemonprotocol.rst + developers/file.rst + developers/storage.rst + developers/catalog.rst + developers/mediaformat.rst + developers/porting.rst + developers/api.rst + developers/tls-techdoc.rst + developers/regression.rst + developers/mempool.rst + developers/netprotocol.rst + developers/directorConsole.rst + developers/smartall.rst + developers/fdl.rst diff --git a/docs/manuals/en/new_main_reference/source/index-part-1.rst b/docs/manuals/en/new_main_reference/source/index-part-1.rst index ef888298f86..bc53a46b4e6 100644 --- a/docs/manuals/en/new_main_reference/source/index-part-1.rst +++ b/docs/manuals/en/new_main_reference/source/index-part-1.rst @@ -3,10 +3,11 @@ Introduction and Tutorial .. toctree:: - index-chapter-1 - index-chapter-2 - index-chapter-3 - index-chapter-4 - index-chapter-5 - index-chapter-6 - index-chapter-7 + index-chapter-01 + index-chapter-02 + index-chapter-03 + index-chapter-04 + index-chapter-05 + index-chapter-06 + index-chapter-07 + diff --git a/docs/manuals/en/new_main_reference/source/index-part-2.rst b/docs/manuals/en/new_main_reference/source/index-part-2.rst index 3a82dfe608f..f6e482b27d5 100644 --- a/docs/manuals/en/new_main_reference/source/index-part-2.rst +++ b/docs/manuals/en/new_main_reference/source/index-part-2.rst @@ -3,8 +3,8 @@ Configuration .. toctree:: - index-chapter-8.rst - index-chapter-9.rst + index-chapter-08.rst + index-chapter-09.rst index-chapter-10.rst index-chapter-11.rst index-chapter-12.rst diff --git a/docs/manuals/en/new_main_reference/source/index.rst b/docs/manuals/en/new_main_reference/source/index.rst new file mode 100644 index 00000000000..d5df985492f --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/index.rst @@ -0,0 +1,23 @@ +.. master index + +Bareos Main Reference and Documentation +======================================= + +.. toctree:: + :maxdepth: 3 + :numbered: + + index-part-1 + index-part-2 + index-part-3 + index-part-4 + index-developer-guide + +Indicies and tables +=================== + +* :ref:`genindex` + +.. * :ref:`modindex` +.. * :ref:`search` + diff --git a/docs/manuals/en/new_main_reference/tex2rst.sh b/docs/manuals/en/new_main_reference/tex2rst.sh deleted file mode 100755 index dd1901bd960..00000000000 --- a/docs/manuals/en/new_main_reference/tex2rst.sh +++ /dev/null @@ -1,198 +0,0 @@ -#!/bin/bash - -ORIGIN_DIR="../main/" -TARGET_DIR="./source/" - -echo '===========================' -echo 'Converting tex files to rst' -echo '===========================' - -############################################################################### -# -# Prepare tex files to avoid pandoc errors -# -############################################################################### - -# todo (maybe) - -############################################################################### -# -# CONVERT -# -############################################################################### - -### INTRODUCTION AND TUTORIAL - -echo 'general.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}general.tex -o ${TARGET_DIR}general.rst - -echo 'state.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}state.tex -o ${TARGET_DIR}state.rst - -echo 'install.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}install.tex -o ${TARGET_DIR}install.rst - -echo 'webui.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}webui.tex -o ${TARGET_DIR}webui.rst - -echo 'update.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}update.tex -o ${TARGET_DIR}update.rst - -echo 'quickstart.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}quickstart.tex -o ${TARGET_DIR}quickstart.rst - -echo 'tutorial.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}tutorial.tex -o ${TARGET_DIR}tutorial.rst - -echo 'critical.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}critical.tex -o ${TARGET_DIR}critical.rst - -### CONFIGURATION - -echo 'configure.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}configure.tex -o ${TARGET_DIR}configure.rst - -echo 'dirdconf.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}dirdconf.tex -o ${TARGET_DIR}dirdconf.rst - -echo 'storedconf.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}storedconf.tex -o ${TARGET_DIR}storedconf.rst - -echo 'filedconf.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}filedconf.tex -o ${TARGET_DIR}filedconf.rst - -echo 'messagesres.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}messagesres.tex -o ${TARGET_DIR}messagesres.rst - -echo 'consoleconf.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}consoleconf.tex -o ${TARGET_DIR}consoleconf.rst - -echo 'monitorconf.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}monitorconf.tex -o ${TARGET_DIR}monitorconf.rst - -### TASKS AND CONCEPTS - -echo 'bconsole.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}bconsole.tex -o ${TARGET_DIR}bconsole.rst - -echo 'restore.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}restore.tex -o ${TARGET_DIR}restore.rst - -### VOLUME MANAGEMENT - -echo 'disk.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}disk.tex -o ${TARGET_DIR}disk.rst - -echo 'recycling.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}recycling.tex -o ${TARGET_DIR}recycling.rst - -echo 'pools.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}pools.tex -o ${TARGET_DIR}pools.rst - -echo 'autochangers.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}autochangers.tex -o ${TARGET_DIR}autochangers.rst - -echo 'tape-without-autochanger.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}tape-without-autochanger.tex -o ${TARGET_DIR}tape-without-autochanger.rst - -echo 'spooling.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}spooling.tex -o ${TARGET_DIR}spooling.rst - -echo 'migration.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}migration.tex -o ${TARGET_DIR}migration.rst - -echo 'always-incremental.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}always-incremental.tex -o ${TARGET_DIR}always-incremental.rst - -echo 'basejob.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}basejob.tex -o ${TARGET_DIR}basejob.rst - -echo 'plugin.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}plugins.tex -o ${TARGET_DIR}plugins.rst - -echo 'win32.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}win32.tex -o ${TARGET_DIR}win32.rst - -### NETWORK SETUP - -echo 'client-initiated-connection.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}client-initiated-connection.tex -o ${TARGET_DIR}client-initiated-connection.rst - -echo 'passiveclient.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}passiveclient.tex -o ${TARGET_DIR}passiveclient.rst - -echo 'lanaddress.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}lanaddress.tex -o ${TARGET_DIR}lanaddress.rst - -echo 'tls.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}tls.tex -o ${TARGET_DIR}tls.rst - -echo 'dataencryption.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}dataencryption.tex -o ${TARGET_DIR}dataencryption.rst - -### NDMP BACKUPS WITH BAREOS - -echo 'ndmp.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}ndmp.tex -o ${TARGET_DIR}ndmp.rst - -echo 'catmaintenance.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}catmaintenance.tex -o ${TARGET_DIR}catmaintenance.rst - -echo 'security.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}security.tex -o ${TARGET_DIR}security.rst - -### APPENDIX - -# A -echo 'requirements.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}requirements.tex -o ${TARGET_DIR}requirements.rst - -# B -echo 'supportedoses.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}supportedoses.tex -o ${TARGET_DIR}supportedoses.rst - -# C -echo 'programs.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}programs.tex -o ${TARGET_DIR}programs.rst - -# D -echo 'bootstrap.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}bootstrap.tex -o ${TARGET_DIR}bootstrap.rst - -# E -echo 'verify.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}verify.tex -o ${TARGET_DIR}verify.rst - -# F -echo 'backward-compability.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}backward-compability.tex -o ${TARGET_DIR}backward-compatibility.rst - -# G -echo 'tables.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}tables.tex -o ${TARGET_DIR}tables.rst - -# H -echo 'howto.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}howto.tex -o ${TARGET_DIR}howto.rst - -# I -echo 'rescue.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}rescue.tex -o ${TARGET_DIR}rescue.rst - -# J -echo 'troubleshooting.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}troubleshooting.tex -o ${TARGET_DIR}troubleshooting.rst - -# K -echo 'debug.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}debug.tex -o ${TARGET_DIR}debug.rst - -# L -echo 'releasenotes.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}releasenotes.tex -o ${TARGET_DIR}releasenotes.rst - -# M -echo 'license.tex' -pandoc --verbose -f latex+raw_tex -t rst ${ORIGIN_DIR}license.tex -o ${TARGET_DIR}license.rst - -exit