From 12fc68a3a733a019799c14357931aea372f8f953 Mon Sep 17 00:00:00 2001 From: Joerg Steffens Date: Fri, 30 Jan 2015 16:09:41 +0100 Subject: [PATCH] cleanup bpipe infos --- manuals/en/main/dirdconf-fileset.tex | 8 ++++---- manuals/en/main/howto.tex | 12 ++++++------ manuals/en/main/plugins.tex | 12 ++++++------ 3 files changed, 16 insertions(+), 16 deletions(-) diff --git a/manuals/en/main/dirdconf-fileset.tex b/manuals/en/main/dirdconf-fileset.tex index 581027d..62790db 100644 --- a/manuals/en/main/dirdconf-fileset.tex +++ b/manuals/en/main/dirdconf-fileset.tex @@ -349,14 +349,14 @@ \subsection{FileSet Include Ressource} Thus the plugin writer may define the meaning of the rest of the string as he wishes. - The program \command{bpluginfo} can be used, to retreive information about a specific plugin, see the \ilink{bpluginfo}{bpluginfo} section. + The program \nameref{bpluginfo} can be used, to retreive information about a specific plugin. - Examples about the bpipe- and the mssql-plugin can be found in the sections about the \ilink{bpipe plugin}{bpipe} and the \ilink{MSSQL plugin}{MSSQL}. + Examples about the bpipe- and the mssql-plugin can be found in the sections about the \nameref{bpipe} and the \nameref{MSSQL}. Note: It is also possible to define more than one plugin directive in a FileSet to do several database dumps at once. \directive{dir}{Options}{$\ldots$}{}{}{} - See the \ilink{File Set Options}{fileset-options} section. + See the \nameref{fileset-options} section. \end{description} @@ -839,7 +839,7 @@ \subsubsection{FileSet Options Ressource} after one minute, Bareos will time out the write to the fifo and move on to the next file. - If you are planing to use a Fifo for backup, better take a look to the \ilink{bpipe plugin}{bpipe} section. + If you are planing to use a Fifo for backup, better take a look to the \nameref{bpipe} section. \item [noatime=yes{\textbar}no] \hfill \\ diff --git a/manuals/en/main/howto.tex b/manuals/en/main/howto.tex index 13fdf27..55a4459 100644 --- a/manuals/en/main/howto.tex +++ b/manuals/en/main/howto.tex @@ -661,7 +661,7 @@ \subsubsection{Backup of a PostgreSQL Databases by using the bpipe plugin} FileSet { Name = "postgresql-all" Include { - Plugin = "bpipe:/POSTGRESQL/dump.sql:pg_dumpall -U postgres:psql -U postgres" + Plugin = "bpipe:file=/POSTGRESQL/dump.sql:reader=pg_dumpall -U postgres:writer=psql -U postgres" Options { signature = MD5 compression = gzip @@ -681,7 +681,7 @@ \subsubsection{Backup of a PostgreSQL Databases by using the bpipe plugin} FileSet { Name = "postgresql-remote" Include { - Plugin = "bpipe:/POSTGRESQL/dump.sql:pg_dumpall -h -U -W :psql -h -U -W " + Plugin = "bpipe:file=/POSTGRESQL/dump.sql:reader=pg_dumpall -h -U -W :writer=psql -h -U -W " Options { signature = MD5 compression = gzip @@ -753,13 +753,13 @@ \subsubsection{Backup of a MySQL Databases by using the bpipe plugin} Instead of creating a temporary database dump file, the bpipe plugin can be used. -For general information about bpipe, see the \ilink{bpipe plugin}{bpipe} section. +For general information about bpipe, see the \nameref{bpipe} section. The bpipe plugin is configured inside the Include section of a File Set, e.g.: \begin{bconfig}{bpipe fileset for MySQL backup} FileSet { Name = "mysql-all" Include = { - Plugin = "bpipe:/MYSQL/dump.sql:mysqldump --user= --password= --opt --all-databases:mysql --user= --password=" + Plugin = "bpipe:file=/MYSQL/dump.sql:reader=mysqldump --user= --password= --opt --all-databases:mysql --user= --password=" Options { signature = MD5 compression = gzip @@ -773,7 +773,7 @@ \subsubsection{Backup of a MySQL Databases by using the bpipe plugin} FileSet{ Name = "mysql-all" Include { - Plugin = "bpipe:/MYSQL/dump.sql:mysqldump --host= --user= --password= --opt --all-databases:mysql --host= --user= --password=" + Plugin = "bpipe:file=/MYSQL/dump.sql:reader=mysqldump --host= --user= --password= --opt --all-databases:mysql --host= --user= --password=" Options { signature = MD5 compression = gzip @@ -788,7 +788,7 @@ \subsubsection{Backup of a MySQL Databases by using the bpipe plugin} FileSet{ Name = "mysql-all" Include { - Plugin = "bpipe:/MYSQL/dump.sql:mysqldump --host= --user= --password= --opt --all-databases:/usr/lib/bareos/scripts/bpipe-restore.sh" + Plugin = "bpipe:file=/MYSQL/dump.sql:reader=mysqldump --host= --user= --password= --opt --all-databases:writer=/usr/lib/bareos/scripts/bpipe-restore.sh" Options { signature = MD5 compression = gzip diff --git a/manuals/en/main/plugins.tex b/manuals/en/main/plugins.tex index 0db4f56..61f3cee 100644 --- a/manuals/en/main/plugins.tex +++ b/manuals/en/main/plugins.tex @@ -39,7 +39,7 @@ \subsection{bpipe Plugin} signature = MD5 compression = gzip } - Plugin = "bpipe:::" + Plugin = "bpipe:file=:reader=:writer= } } \end{bconfig} @@ -49,21 +49,21 @@ \subsection{bpipe Plugin} meaning of the rest of the string as he wishes. The full syntax of the plugin directive as interpreted by the bpipe plugin is: \begin{bconfig}{bpipe directive} -Plugin = ":::" +Plugin = ":file=:reader=:writer=" \end{bconfig} \begin{description} \item[plugin] is the name of the plugin with the trailing -fd.so stripped off, so in this case, we would put bpipe in the field. -\item[path] specifies the namespace, which for bpipe is the pseudo path and filename under which the backup will be saved. This +\item[filepath] specifies the namespace, which for bpipe is the pseudo path and filename under which the backup will be saved. This pseudo path and filename will be seen by the user in the restore file tree. For example, if the value is /MySQL/mydump.sql, the data backed up by the plugin will be put under that "pseudo" path and filename. You must be careful to choose a naming convention that is unique to avoid a conflict with a path and filename that actually exists on your system. -\item[backup-command] for the bpipe plugin specifies the "reader" program that is called by the plugin during backup to read the data. bpipe +\item[readprogram] for the bpipe plugin specifies the "reader" program that is called by the plugin during backup to read the data. bpipe will call this program by doing a popen on it. -\item[restore-command] for the bpipe plugin specifies the "writer" program that is called by the plugin during restore to write the data back +\item[writeprogram] for the bpipe plugin specifies the "writer" program that is called by the plugin during restore to write the data back to the filesystem. \end{description} @@ -73,7 +73,7 @@ \subsection{bpipe Plugin} backup a file with reader program, when running the writer program during the restore, Bareos will not automatically create the path to the file. Either the path must exist, or you must explicitly do so with your command or in a shell script. -See the examples about \ilink{Backup PostgreSQL}{backup-postgresql} and \ilink{Backup MySQL}{backup-mysql}. +See the examples about \nameref{backup-postgresql} and \nameref{backup-mysql}. \subsection{PGSQL Plugin}