Skip to content

Commit

Permalink
adapted man pages to configuration directories
Browse files Browse the repository at this point in the history
  • Loading branch information
joergsteffens committed Jul 12, 2016
1 parent 24a4d16 commit 7fc424d
Show file tree
Hide file tree
Showing 14 changed files with 46 additions and 84 deletions.
6 changes: 3 additions & 3 deletions manpages/bareos-dbcheck.8
Expand Up @@ -48,12 +48,12 @@ dbcheck will enter interactive mode (see below).
print catalog configuration and exit.
.TP
.BI \-c\ config
If the \-c option is given with the Director's conf file, there is no need to
If the \-c option is given with the Director's configuration, there is no need to
enter any of the command line arguments, in particular the working directory
as dbcheck will read them from the file.
as dbcheck will read them from the configuration.
.TP
.BI \-C\ catalog
catalog name in the director conf file.
catalog name in the director configuration.
.TP
.BI \-d\ nnn
set debug level to \fInnn\fP.
Expand Down
16 changes: 5 additions & 11 deletions manpages/bareos-dir.8
Expand Up @@ -22,8 +22,8 @@ network backup system: it is responsible for scheduling and
coordinating backups across the network.
.SH OPTIONS
.TP
.BI \-c\ file
Specify the configuration file to use.
.BI \-c\ path
Specify the configuration file or directory to use.
.TP
.BI \-d\ nn
Set debug level to \fInn\fP.
Expand All @@ -47,7 +47,7 @@ Run <job>.
No signals (for debugging).
.TP
.B \-t
Test the configuration file and report errors.
Test the configuration and report errors.
.TP
.BI \-u\ user
Set the username/uid to run as.
Expand All @@ -60,20 +60,14 @@ Show version and usage of program.
.SH TCP-WRAPPERS CONFIGURATION
Tcpwrappers looks for the service name of the bareos daemons in
.I hosts.allow
, and the service names of these daemons is configured to be different from the
binary.
The service names are configured to be
.B %hostname%-%component%
rather than
.B bareos-dir
(As defined in the bareos-dir.conf.in file)

The service names are not the names of the binaries, but the configured names of the components, often %hostname%-%component%.

So the hosts.allow entry has to match
.B %hostname%-%component%
(servername-dir for example) instead of bareos-%component%

.B WARNING:

This means that if the hosts.allow file has the entry:

.B bareos-dir: ALL
Expand Down
4 changes: 2 additions & 2 deletions manpages/bareos-fd.8
Expand Up @@ -27,8 +27,8 @@ compressed.
.BI \-b
Enable backup only mode
.TP
.BI \-c\ file
Specify the configuration file to use.
.BI \-c\ path
Specify the configuration file or directory to use.
.TP
.BI \-d\ nn
Set debug level to \fInn\fP.
Expand Down
4 changes: 2 additions & 2 deletions manpages/bareos-sd.8
Expand Up @@ -22,8 +22,8 @@ network backup system and a tape drive/autochanger or filesystem where
the backups will be stored.
.SH OPTIONS
.TP
.BI \-c\ file
Specify the configuration file to use.
.BI \-c\ path
Specify the configuration file or directory to use.
.TP
.BI \-d\ nn
Set debug level to \fInn\fP.
Expand Down
5 changes: 2 additions & 3 deletions manpages/bareos-tray-monitor.1
Expand Up @@ -17,10 +17,9 @@ This manual page documents briefly the
command, a simple monitor for the 'system tray' in KDE/GNOME
.PP
.SH OPTIONS
bareos-tray-monitor [\-c config_file] [\-d debug_level] [\-t]
.TP
.B \-c <config>
Specify configuration file.
.B \-c path
Specify the configuration file or directory to use.
.TP
.B \-d <nn>
Set debug level to \fInn\fP.
Expand Down
50 changes: 11 additions & 39 deletions manpages/bareos.8
Expand Up @@ -16,8 +16,6 @@ Bareos \- Backup Archiving REcovery Open Sourced
.br
.B bconsole \- Console to control Bareos
.br
.B wx-console \- GUI Console
.br
.SH DESCRIPTION
.LP
Bareos is a set of computer programs that permits you (or the
Expand All @@ -35,19 +33,12 @@ hundreds of computers located over a large network.
Bareos Director service consists of the program that supervises
all the backup, restore, verify and archive operations. The
system administrator uses the Bareos Director to schedule backups
and to recover files. For more details see the Director Services
Daemon Design Document in the Bareos Developer's Guild. The
Director runs as a daemon or a service (i.e. in the background).
and to recover files. The Director runs as a daemon or a service
(i.e. in the background).

.LP
Bareos Console services is the program that allows the
administrator or user to communicate with the Bareos Director
(see above). Currently, the Bareos Console is available in two
versions. The first and simplest is to run the Console program
in a shell window (i.e. TTY interface). Most system
administrators will find this completely adequate. The second
version is a Qt 4.2 GUI interface named bat that has
more features than the bconsole program.
administrator or user to communicate with the Bareos Director.

.LP
Bareos File services (or Client program) is the software program
Expand All @@ -56,25 +47,19 @@ to the operating system on which it runs and is responsible for
providing the file attributes and data when requested by the
Director. The File services are also responsible for the file
system dependent part of restoring the file attributes and data
during a recovery operation. For more details see the File
Services Daemon Design Document in the Bareos Developer's Guide.
during a recovery operation.
This program runs as a daemon on the machine to be backed up, and
in some of the documentation, the File daemon is referred to as
the Client (for example in Bareos's configuration file). In
addition to Unix/Linux File daemons, there is a Windows File
daemon (normally distributed in binary format). The Windows File
daemon runs on all currently known Windows versions (2K, 2003, XP,
and Vista).
the Client (for example in Bareos's configuration file).

.LP
Bareos Storage services consist of the software programs that
perform the storage and recovery of the file attributes and data
to the physical backup media or volumes. In other words, the
Storage daemon is responsible for reading and writing your tapes
(or other storage media, e.g. files). For more details see the
Storage Services Daemon Design Document in the Bareos Developer's
Guide. The Storage services runs as a daemon on the machine that
has the backup device (usually a tape drive).
(or other storage media, e.g. files).
The Storage services runs as a daemon on the machine that
has the backup device.

.LP
Catalog services are comprised of the software programs
Expand All @@ -85,36 +70,23 @@ file. The Catalog services sets Bareos apart from simple backup
programs like tar and bru, because the catalog maintains a record
of all Volumes used, all Jobs run, and all Files saved,
permitting efficient restoration and Volume management. Bareos
currently supports three different databases, MySQL, PostgreSQL,
and SQLite3, one of which must be chosen when building Bareos.

.SH OPTIONS
See the HTML/PDF documentation at:
.br
<http://www.bareos.org>
.br
for details of the command line options.

supports multiple databases (e.g. MySQL, PostgreSQL, ...).

.SH CONFIGURATION
Each daemon has its own configuration file which must be
tailored for each particular installation. Please see the HTML/PDF
documentation for the details.

.SH SEE ALSO
The HTML manual installed on your system (typically found in
.br
/usr/share/doc/bareos-<version>) or the online manual at:
.br
<http://www.bareos.org>
.br
<http://doc.bareos.org>

.SH BUGS
See <http://bugs.bareos.org>

.SH AUTHOR
Kern Sibbald
.SS Current maintainer
Kern Sibbald
.SS Contributors
An enormous list of past and former persons who have devoted
their time and energy to this project -- thanks. See the AUTHORS
Expand Down
2 changes: 1 addition & 1 deletion manpages/bat.1
Expand Up @@ -14,7 +14,7 @@
.SH DESCRIPTION
This manual page documents briefly the
.B bat
command, the Qt4 version of the Bareos Administration Tool console.
command, the QT version of the Bareos Administration Tool console.
This is a GUI full featured program similar the bconsole program,
but it is graphical oriented and more features.
.PP
Expand Down
4 changes: 2 additions & 2 deletions manpages/bconsole.1
Expand Up @@ -24,8 +24,8 @@ Select a Director.
.BI \-l
List defined Directors.
.TP
.BI \-c\ config
Specify configuration file.
.BI \-c\ path
Specify the configuration file or directory to use.
.TP
.BI \-d\ nn
Set debug level to \fInn\fP.
Expand Down
6 changes: 3 additions & 3 deletions manpages/bcopy.8
Expand Up @@ -6,7 +6,7 @@
.\" Please adjust this date whenever revising the manpage.
.\"
.SH NAME
bcopy \- Bareos's 'Copy from tape'
bcopy \- Bareos's 'Copy from volume'
.SH SYNOPSIS
.B bcopy
.RI [ options ]
Expand All @@ -30,8 +30,8 @@ Show version and usage of program.
.BI \-b\ bootstrap
Specify a bootstrap file.
.TP
.BI \-c\ config
Specify configuration file.
.BI \-c\ path
Specify the Storage configuration file or directory to use.
.TP
.BI \-d\ nn
Set debug level to \fInn\fP.
Expand Down
6 changes: 3 additions & 3 deletions manpages/bextract.8
Expand Up @@ -6,7 +6,7 @@
.\" Please adjust this date whenever revising the manpage.
.\"
.SH NAME
bextract \- Bareos's 'Extract from tape'
bextract \- Bareos's 'Extract from volume'
.SH SYNOPSIS
.B bextract
.RI [ options ]
Expand All @@ -30,8 +30,8 @@ Show version and usage of program.
.BI \-b\ bootstrap
Specify a bootstrap file.
.TP
.BI \-c\ config
Specify configuration file.
.BI \-c\ path
Specify the Storage configuration file or directory to use.
.TP
.BI \-d\ nn
Set debug level to \fInn\fP.
Expand Down
6 changes: 3 additions & 3 deletions manpages/bls.8
Expand Up @@ -16,7 +16,7 @@
.\" .sp <n> insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
bls \- Bareos's 'Tape LS'
bls \- Bareos's 'Volume LS'
.SH SYNOPSIS
.B bls
.RI [ options ]
Expand All @@ -39,8 +39,8 @@ Show version and usage of program.
.BI \-b\ bootstrap
Specify a bootstrap file.
.TP
.BI \-c\ config
Specify configuration file.
.BI \-c\ path
Specify the Storage configuration file or directory to use.
.TP
.BI \-d\ nn
Set debug level to \fInn\fP.
Expand Down
6 changes: 3 additions & 3 deletions manpages/bscan.8
Expand Up @@ -6,7 +6,7 @@
.\" Please adjust this date whenever revising the manpage.
.\"
.SH NAME
bscan \- Bareos's 'Scan tape'
bscan \- Bareos's 'Scan volumes'
.SH SYNOPSIS
.B bscan
.RI [ options ]
Expand Down Expand Up @@ -44,8 +44,8 @@ Specify the database driver name (default NULL) <postgresql|mysql|sqlite3>.
.BI \-b\ bootstrap
Specify a bootstrap file.
.TP
.BI \-c\ configfile
Specify storage daemon configuration file.
.BI \-c\ path
Specify the Storage configuration file or directory to use.
.TP
.BI \-d\ nn
Set debug level to \fInn\fP.
Expand Down
11 changes: 4 additions & 7 deletions manpages/bsmtp.1
Expand Up @@ -72,8 +72,7 @@ ended by sending the EOF character (Ctrl-D on many systems) on the
start of a new line, much like many 'mail' commands.

The actual, automated behavior of \fBbsmtp\fR will depend on the
mail-related configuration of the Director in the \fIMessages\fR resource
of \fIbareos-dir.conf\fR.
mail-related configuration of the Director in the \fIMessages\fR resources.

Interactive use of \fBbsmtp\fR is pertinent to manually test and ensure these
configuration bits are valid. This is highly recommended.
Expand All @@ -84,18 +83,16 @@ file.

Messages {
Name = Standard
mailcommand = "/home/bareos/bin/bsmtp \-h mail.domain.com \-f \\"\\(Bareos\\) \\<%r\\>\\"
mailcommand = "/usr/bin/bsmtp \-h mail.domain.com \-f \\"\\(Bareos\\) \\<%r\\>\\"
\-s \\"Bareos: %t %e of %c %l\\" %r"
operatorcommand = "/home/bareos/bin/bsmtp \-h mail.domain.com \-f \\"\\(Bareos\\) \\<%r\\>\\"
operatorcommand = "/usr/bin/bsmtp \-h mail.domain.com \-f \\"\\(Bareos\\) \\<%r\\>\\"
\-s \\"Bareos: Intervention needed for %j\\" %r"
mail = sysadmin@site.domain.com = all, !skipped
operator = sysop@site.domain.com = mount
console = all, !skipped, !saved
}

\fIhome/bareos/bin\fR is replaced with the path to the Bareos
binary directory, and mail.domain.com is replaced with the fully
qualified name of an SMTP server, which usually listen on port 25.
mail.domain.com is replaced with the fully qualified name of an SMTP server, which usually listen on port 25.

.SH ENVIRONMENT
If the \fB-h\fR option is not specified, \fBbsmtp\fR will use environment variable \fBSMTPSERVER\fR, or 'localhost' if not set.
Expand Down
4 changes: 2 additions & 2 deletions manpages/btape.8
Expand Up @@ -29,8 +29,8 @@ Show summary of options and commands.
.BI \-b\ bootstrap
Specify a bootstrap file.
.TP
.BI \-c\ config
Specify configuration file.
.BI \-c\ path
Specify the Storage configuration file or directory to use.
.TP
.BI \-d\ nn
Set debug level to \fInn\fP.
Expand Down

0 comments on commit 7fc424d

Please sign in to comment.