bareos.sty

%% bareos.sty
%% Provides macros and other stuff for the bareos manual
%%
%% Original Creation -- K. Cunningham 2005-01-09
%%
%% New Commands Currently implemented:
%%
%% \elink{target}{text}
%%    Inserts the text indicated (highlighted) and provides
%%    an external hyperlink to the target.
%%
%% \ilink{target}{text}
%%    Inserts the text indicated (highlighted) and provides
%%    an internal hyperlink to the target. Target must be a
%%    \label somewhere in the same document.
%%
%% \idir
%%    Inserts the path to the images
%%
\ProvidesPackage{bareos}[2012/11/16]
%%
%%
%% define images directory
\def\idir{../../images/conv/}  %% images directory

\newcommand{\fileStoragePath}{\path|/var/lib/bareos/storage/|}
\newcommand{\scriptPathUnix}{\path|/usr/lib/bareos/scripts/|}
\newcommand{\configPathUnix}{\path|/etc/bareos/|}
\newcommand{\configFileDirUnix}{\path|/etc/bareos/bareos-dir.conf|}
\newcommand{\logfileUnix}{\path|/var/log/bareos/bareos.log|}

\newcommand{\yesno}{yes{\textbar}no}

% data type definitions. 
% all data types should be defined here.
% use them in xdirective.
\newcommand{\dtDirectory}{\ilink{directory}{DataTypeDirectory}}
\newcommand{\dtName}{\ilink{name}{DataTypeName}}
\newcommand{\dtNetAddress}{\ilink{net-address}{DataTypeNetAddress}}
\newcommand{\dtNetAddresses}{\ilink{net-addresses}{DataTypeNetAddresses}}
\newcommand{\dtNetPort}{\ilink{net-port}{DataTypeNetPort}}
\newcommand{\dtPassword}{\ilink{password}{DataTypePassword}}
\newcommand{\dtPath}{\ilink{path}{DataTypePath}}
\newcommand{\dtPositiveInteger}{\ilink{positive-integer}{DataTypePositiveInteger}}
\newcommand{\dtUInt}{\dtPositiveInteger}
\newcommand{\dtSize}{\ilink{size}{DataTypeSize}}
\newcommand{\dtString}{\ilink{string}{DataTypeString}}
\newcommand{\dtStringList}[1]{\ilink{string-list (separated by #1)}{DataTypeStringList}}
\newcommand{\dtTime}{\ilink{time}{DataTypeTime}}
\newcommand{\dtYesNo}{\ilink{\yesno}{DataTypeYesNo}}

%%
\newcommand*{\elink}[2]{%
  \htmladdnormallink{#1}{#2}%
}
%%
\newcommand*{\ilink}[2]{%
  \htmlref{#1}{#2}%
}
%%
\newcommand{\dq}{\verb+"+}
\newcommand{\at}{\makeatletter @\makeatother}
\newcommand{\lt}{\textless}
\newcommand{\gt}{\textgreater}

\newcommand{\commandPrompt}{root{\at}linux:\~{}\# }
\newcommand{\command}[1]{\path|#1|}
\newcommand{\bcommand}[1]{\path|#1|}
\newcommand{\file}[1]{\path|#1|}
\newcommand{\directory}[1]{\path|#1|}
\newcommand{\package}[1]{\path|#1|}
\newcommand{\name}[1]{\textbf{#1}}
\newcommand{\user}[1]{\path|#1|}
\newcommand{\group}[1]{\path|#1|}
\newcommand{\parameter}[1]{\path|#1|}
\newcommand{\variable}[1]{\path|#1|}
\newcommand{\configdirective}[1]{\textbf{#1}}
\newcommand{\host}[1]{\path|#1|}
\newcommand{\email}[1]{\url{#1}}

%%
\newcommand{\debug}[1]{\marginpar{#1}}
%%
%\newcommand{\TODO}[1]{\textit{#1}\marginpar{TODO: #1}}
\newcommand{\TODO}[1]{\textit{TODO: #1}}
%\newcommand{\TODO}[1]{}
\newcommand{\hide}[1]{}
%%
\newcommand{\warning}[1]{Please note! \textit{#1}}
%%
\newcommand{\releasenote}[2]{
    \subsection*{bareos-#1}
    \index[general]{#1!Release Notes}%
    #2
}
\newcommand{\sinceVersion}[3]{Version $>=$ #3%
    \index[#1]{#2}%
    \index[general]{#3!#2}%
}
\newcommand{\betaSince}[3]{\index[#1]{#2}Included as beta since version #3. Don't use in productive environment!}
\newcommand{\deprecatedSince}[3]{This option is deprecated since version #3}
\newcommand{\removedSince}[3]{This option is removed since version #3}

% \newenvironment{directives}[1]
%     {%
%         \def\configfile{#1}
%         \begin{itemize}
%     }{%
%         \end{itemize}
%     }

% \newcommand{\xdirective}[5]{
% %% 1: config file (dir | sd | fd)
% % 2: directive name
% % 3: directive type/value
% % 4: "required" | ""
% % 5: default value
% % 6: since version
% \item [#1 = {\textless}#2{\textgreater}]
%     \hfill
%   \ifthenelse{\isempty{#4}}{}{(default: #4)}
%   \ifthenelse{\isempty{#3}}{}{(#3)}
%   \hfill \\
%   \index[\configfile]{#1}
%   \index[\configfile]{Directive!#1}
%   \ifthenelse{\isempty{#5}}{}{\sinceVersion{\configfile}{#1}{#5}}
% }

% deprecated. use xdirective instead.
\newcommand{\directive}[6]{
% 1: config file (dir | sd | fd)
% 2: directive name
% 3: directive type/value
% 4: "required" | ""
% 5: default value
% 6: since version
\item [#2 = {\textless}#3{\textgreater}]
    \hfill
  \ifthenelse{\isempty{#5}}{}{(default: #5)}
  \ifthenelse{\isempty{#4}}{}{(#4)}
  \ifthenelse{\isempty{#6}}{}{\sinceVersion{#1}{#2}{#6}}
  \hfill \\
  \index[#1]{#2}
  \index[#1]{Directive!#2}
}

\newcommand{\xdirective}[7]{
% 1: config file (dir | sd | fd)
% 2: directive name
% 3: directive data type (\dtXXX) or value
% 4: "required" | ""
% 5: default value
% 6: "deprecated" | since version
% 7: description
\item [#2 = {\textless}#3{\textgreater}]%
    \hfill%
  \ifthenelse{\isempty{#5}}{}{(default: #5)}%
  \ifthenelse{\isempty{#4}}{}{(#4)}%
  \hfill \\%
  \index[#1]{#2}%
  \index[#1]{Directive!#2}%
  \ifthenelse{\equal{#6}{deprecated}}{%
\warning{This directive is deprecated.\\}
  }{}%
#7\ \\%
  \ifthenelse{\equal{#6}{deprecated}}{}{%
    \ifthenelse{\isempty{#6}}{}{%
      \sinceVersion{#1}{#2}{#6}%
      %\marginpar{#6}
    }%
  }%
}
% \xdirective{dir|sd|fd}{name}{\dtXXX}{required}{default}{version}{%
% }
% \xdirective{}{}{}{required}{}{}{}


% \floatstyle{boxed}
% \newfloat{floatProgram}{h}{lop}
% \floatname{floatProgram}{bconsole}
% %\newbox\examplebox
% \newenvironment{bconsole}[4]{%
%     % #1 prompt
%     % #2 command
%     % #3 caption (caption is "command", if #3 is not given)
%     % #4 input
%     \ifthenelse{\isempty{#4}}{
%         \def\bconsoleinput{\vskip-1.0\baselineskip}
%     }{
%         \def\bconsoleinput{{\it enter #4}}
%     }
%     %\floatProgram
%     \footnotesize
%     \ifthenelse{\isempty{#3}}{
%         \captionof{floatProgram}{#2}
%         \label{#2}
%     }{
%         \captionof{floatProgram}{#3}
%         \label{#3}
%     }
%     \verbatim
% #1 #2\\
% }
% {
%     \endverbatim
%     \bconsoleinput
% %    \endfloatProgram
% }

\lstnewenvironment{bconsole}[1]{
    % #1 caption
    \renewcommand*{\lstlistingname}{bconsole}
    \definecolor{colorBconsole}{gray}{0.9}
    \lstset{
        %label=bconsole:#1,
        caption=#1,
        %basicstyle=\ttfamily,
        basicstyle=\small,
        stringstyle=\ttfamily,
        keepspaces=true,
        columns=fixed,
        backgroundcolor=\color{colorBconsole},
        frame=single,
        framerule=0pt,
        captionpos=b,
        %moredelim=[l][\bf]{* },
        %moredelim=[l][\bf]{Select\ item: },
        %moredelim=[l][\bf]{Select\ Client },
        moredelim=[is][\bf]{<input>}{</input>},
        moredelim=[is][\underline]{<strong>}{</strong>},
    }
}{}


\lstnewenvironment{bmessage}[1]{%
    % #1 caption
    \renewcommand*{\lstlistingname}{Messages} 
    \footnotesize
    \definecolor{colorConfig}{gray}{0.9}
    \lstset{
        backgroundcolor=\color{colorConfig},
        frame=single,
        framerule=0pt,
        basicstyle=\ttfamily,
        keepspaces=true,
        columns=fullflexible,
        %label=config:#1,
        caption=#1,
        captionpos=b,
        moredelim=[is][\it]{<input>}{</input>},
        moredelim=[is][\underline]{<strong>}{</strong>},
    }
}{}



\lstnewenvironment{bconfig}[1]{%
    % #1 caption
    \renewcommand*{\lstlistingname}{Configuration} 
    \footnotesize
    \definecolor{colorConfig}{gray}{0.9}
    \lstset{
        backgroundcolor=\color{colorConfig},
        frame=single,
        framerule=0pt,
        basicstyle=\ttfamily,
        keepspaces=true,
        columns=fullflexible,
        %label=config:#1,
        caption=#1,
        captionpos=b,
        moredelim=[is][\it]{<input>}{</input>},
        moredelim=[is][\underline]{<strong>}{</strong>},
    }
}{}

\lstnewenvironment{config}[1]{%
    % #1 caption
    \renewcommand*{\lstlistingname}{Configuration}
    \footnotesize
    \definecolor{colorConfig}{gray}{0.9}
    \lstset{
        backgroundcolor=\color{colorConfig},
        frame=single,
        framerule=0pt,
        basicstyle=\ttfamily,
        keepspaces=true,
        columns=fullflexible,
        %label=config:#1,
        caption=#1,
        captionpos=b,
        moredelim=[is][\it]{<input>}{</input>},
        moredelim=[is][\underline]{<strong>}{</strong>},
    }
}{}

\lstnewenvironment{commands}[1]{%
    % #1 caption
    \renewcommand*{\lstlistingname}{Commands}
    \footnotesize
    \definecolor{colorConfig}{gray}{0.9}
    \lstset{
        backgroundcolor=\color{colorConfig},
        frame=single,
        framerule=0pt,
        basicstyle=\ttfamily,
        keepspaces=true,
        columns=fullflexible,
        caption=#1,
        captionpos=b,
        % command only work for single commands without parameter.
        % as workaround, split a command and its parameter as in following example:
        % <command>su</command><input> - bareos</input>
        moredelim=[is][\commandPrompt\bf]{<command>}{</command>},
        moredelim=[is][\bf]{<parameter>}{</parameter>},
        moredelim=[is][\bf]{<input>}{</input>},
        moredelim=[is][\underline]{<strong>}{</strong>},
    }
}{}



\newfloat{floatCommandOut}{h}{lop}
\floatname{floatCommandOut}{Command}

\newenvironment{commandOut}[3]{%
    % #1 caption
    % #2 prompt
    % #3 command
    \footnotesize
    \def\commandOut1{#1}
    \ifthenelse{\isempty{#2}}{
        \def\commandOutPrompt{\commandPrompt}
    }{
        \def\commandOutPrompt{#2}
    }

    % \definecolor{shadecolor}{gray}{0.95}
    % TODO: does not work with htlatex
    % \snugshade
    \verbatim
\commandOutPrompt{}#3
}
{
    \endverbatim
    % \endsnugshade
    \ifthenelse{\isempty{\commandOut1}}{
    }{
        \captionof{floatCommandOut}{\commandOut1}
    }
}


\endinput