should get replaced

merge into main include Bareos utilities into main documentation Signed-off-by: Marco van Wieringen <marco.van.wieringen@bareos.com>
bareos · Sep 12, 2013 · b7b4c5d · b7b4c5d
1 parent 4a011d4
commit b7b4c5d
Show file tree

Hide file tree

Showing 10 changed files with 1,481 additions and 2,116 deletions.
diff --git a/manuals/en/main/README.document-conventions.txt b/manuals/en/main/README.document-conventions.txt
@@ -1,5 +1,11 @@
 Conventions
 
+Domain: example.com
+Hosts: ???
+
+\fileStoragePath
+\unixConfigPath
+
 Links, internal:
 \ilink{Description}{LaTex-Label}
 
@@ -13,6 +19,8 @@ Links, external
 \newcommand{\group}[1]{\path|#1|}
 \newcommand{\variable}[1]{\path|#1|}
 \newcommand{\parameter}[1]{\path|#1|}
+\newcommand{\configdirective}[1]{\textbf{#1}}
+
 
 Bareos configuration files:
 \begin{bconfig}{<CAPTION>}
@@ -31,6 +39,13 @@ output
 \begin{bconsole}{}{}{}{}
 \end{bconsole}
 
+Unix (Linux) Command with output:
+\begin{commandOut}{[caption]}{[prompt]}{command}
+output
+\end{commandOut}
+
+\begin{commandOut}{}{}{}
+\end{commandOut}
 
 
 

diff --git a/manuals/en/main/bareos.sty b/manuals/en/main/bareos.sty
@@ -25,6 +25,10 @@
 
 \def\version{12.4.0}
 
+\newcommand{\fileStoragePath}{\path|/var/lib/bareos/storage/|}
+\newcommand{\unixConfigPath}{\path|/etc/bareos/|}
+
+
 %%
 \newcommand*{\elink}[2]{%
   \htmladdnormallink{#1}{#2}%
@@ -44,8 +48,6 @@
 \newcommand{\group}[1]{\path|#1|}
 \newcommand{\parameter}[1]{\path|#1|}
 \newcommand{\variable}[1]{\path|#1|}
-
-
 \newcommand{\configdirective}[1]{\textbf{#1}}
 %%
 \newcommand{\debug}[1]{\marginpar{#1}}
@@ -132,6 +134,31 @@
     }
 }
 
+\newfloat{floatCommandOut}{h}{lop}
+\floatname{floatCommandOut}{Command}
+
+\newenvironment{commandOut}[3]{%
+    % #1 caption
+    % #2 prompt (TODO)
+    % #3 command
+    \footnotesize
+    \def\commandOut1{#1}
+    \definecolor{shadecolor}{gray}{0.95}
+    \snugshade
+    \verbatim
+% root@linux:~# #3
+root@linux:\~{}\# #3 ...
+}
+{
+    \endverbatim
+    \endsnugshade
+    \ifthenelse{\isempty{\commandOut1}}{
+    }{
+        \captionof{floatCommandOut}{\commandOut1}
+        \label{command:\commandOut1}
+    }
+}
+
 
 
 

diff --git a/manuals/en/main/bootstrap.tex b/manuals/en/main/bootstrap.tex
@@ -7,7 +7,7 @@ \chapter{The Bootstrap File}
 \index[general]{Bootstrap!File}
 
 
-\TODO{This chapter is going to be rewritten by Philipp Storz.}
+\TODO{This chapter is going to be rewritten (by Philipp).}
 
 The information in this chapter is provided so that you may either create your
 own bootstrap files, or so that you can edit a bootstrap file produced by

diff --git a/manuals/en/main/troubleshooting.tex b/manuals/en/main/troubleshooting.tex
@@ -1,4 +1,9 @@
 
+\section{Tape Drive}
+\label{TapeTestingChapter}
+
+\TODO{Tape Testing Chapter is to be written}
+
 \section{Autochanger}
 
 \subsection{Testing Autochanger and Adapting mtx-changer script}