]> git.sur5r.net Git - bacula/docs/blobdiff - docs/manuals/en/main/filedconf.tex
main ok but web
[bacula/docs] / docs / manuals / en / main / filedconf.tex
index ce08ae21162e9cd4bcfe2141dfc9b45af7bd9736..1642e83990e600c2e5d93a9ffdaed95f7d4966c0 100644 (file)
@@ -9,24 +9,24 @@
 The Client (or File Daemon) Configuration is one of the simpler ones to
 specify. Generally, other than changing the Client name so that error messages
 are easily identified, you will not need to modify the default Client
-configuration file. 
+configuration file.
 
 For a general discussion of configuration file and resources including the
-data types recognized by {\bf Bacula}, please see the 
+data types recognized by {\bf Bacula}, please see the
 \ilink{Configuration}{ConfigureChapter} chapter of this manual. The
-following Client Resource definitions must be defined: 
+following Client Resource definitions must be defined:
 
-\begin{itemize}
-\item 
+\begin{bsysitemize}
+\item
    \ilink{Client}{ClientResource} -- to define what Clients are  to
-   be backed up.  
-\item 
+   be backed up.
+\item
    \ilink{Director}{DirectorResource} -- to  define the Director's
-   name and its access password.  
-\item 
+   name and its access password.
+\item
    \ilink{Messages}{MessagesChapter} -- to define where error  and
-   information messages are to be sent. 
-\end{itemize}
+   information messages are to be sent.
+\end{bsysitemize}
 
 \section{The Client Resource}
 \label{ClientResource}
@@ -35,7 +35,7 @@ following Client Resource definitions must be defined:
 
 The Client Resource (or FileDaemon) resource defines the name of the Client
 (as used by the Director) as well as the port on which the Client listens for
-Director connections. 
+Director connections.
 
 \begin{description}
 
@@ -44,7 +44,7 @@ Director connections.
    \index[fd]{Directive!Client (or FileDaemon)}
    Start of the Client records.  There must be one and only one Client resource
    in the  configuration file, since it defines the properties of the  current
-   client program. 
+   client program.
 
 \item [Name = \lt{}name\gt{}]
    \index[fd]{Name}
@@ -52,7 +52,7 @@ Director connections.
    The client name that must be used  by the Director when connecting. Generally,
    it is a good idea  to use a name related to the machine so that error messages
    can be easily identified if you have multiple Clients.  This directive is
-   required.  
+   required.
 
 \item [Working Directory = \lt{}Directory\gt{}]
    \index[fd]{Working Directory}
@@ -61,7 +61,7 @@ Director connections.
    daemon  may put its status files. This directory should be used only  by {\bf
    Bacula}, but may be shared by other Bacula daemons provided the daemon
    names on the {\bf Name} definition are unique for each daemon. This directive
-   is required. 
+   is required.
 
    On Win32 systems, in some circumstances you may need to specify a drive
    letter in the specified working directory path.  Also, please be sure
@@ -73,16 +73,16 @@ Director connections.
 \item [Pid Directory = \lt{}Directory\gt{}]
    \index[fd]{Pid Directory}
    \index[fd]{Directive!Pid Directory}
-   This directive  is mandatory and specifies a directory in which the Director 
+   This directive  is mandatory and specifies a directory in which the Director
    may put its process Id file files. The process Id file is used to  shutdown
-   Bacula and to prevent multiple copies of  Bacula from running simultaneously. 
+   Bacula and to prevent multiple copies of  Bacula from running simultaneously.
    This record is required. Standard shell expansion of the {\bf Directory}  is
    done when the configuration file is read so that values such  as {\bf \$HOME}
-   will be properly expanded.  
+   will be properly expanded.
 
    Typically on Linux systems, you will set this to:  {\bf /var/run}. If you are
    not installing Bacula in the  system directories, you can use the {\bf Working
-   Directory} as  defined above. 
+   Directory} as  defined above.
 
 \item [Heartbeat Interval = \lt{}time-interval\gt{}]
    \index[fd]{Heartbeat Interval}
@@ -98,7 +98,7 @@ Director connections.
    signal to the Director and to the Storage daemon to keep the channels
    active.  The default interval is zero which disables the heartbeat.
    This feature is particularly useful if you have a router such as 3Com
-   that does not follow Internet standards and times out a valid    
+   that does not follow Internet standards and times out a valid
    connection after a short duration despite the fact that keepalive is
    set. This usually results in a broken pipe error message.
 
@@ -111,10 +111,10 @@ Director connections.
    Browse to:
    Start \gt{} Control Panel \gt{} Network Connections
 
-   Right click the connection for the nvidia adapter and select properties. 
-   Under the General tab, click "Configure...". Under the Advanced tab set 
-   "Checksum Offload" to disabled and click OK to save the change.  
-   
+   Right click the connection for the nvidia adapter and select properties.
+   Under the General tab, click "Configure...". Under the Advanced tab set
+   "Checksum Offload" to disabled and click OK to save the change.
+
    Lack of communications, or communications that get interrupted can
    also be caused by Linux firewalls where you have a rule that throttles
    connections or traffic.
@@ -138,8 +138,8 @@ Director connections.
    an example:
 
 \footnotesize
-\begin{verbatim}
- FDAddresses  = { 
+\begin{lstlisting}
+ FDAddresses  = {
     ip = { addr = 1.2.3.4; port = 1205; }
     ipv4 = {
         addr = 1.2.3.4; port = http; }
@@ -159,7 +159,7 @@ Director connections.
         addr = bluedot.thun.net
     }
  }
-\end{verbatim}
+\end{lstlisting}
 \normalsize
 
 where ip, ip4, ip6, addr, and port are all keywords. Note, that  the address
@@ -168,23 +168,23 @@ a symbolic name (only in the ip specification).  Also, port can be specified
 as a number or as the mnemonic value from  the /etc/services file.  If a port
 is not specified, the default will be used. If an ip  section is specified,
 the resolution can be made either by IPv4 or  IPv6. If ip4 is specified, then
-only IPv4 resolutions will be permitted,  and likewise with ip6.  
+only IPv4 resolutions will be permitted,  and likewise with ip6.
 
 \item [FDPort = \lt{}port-number\gt{}]
    \index[fd]{FDPort}
    \index[fd]{Directive!FDPort}
    This specifies the port number  on which the Client listens for Director
    connections. It must agree  with the FDPort specified in the Client resource
-   of the Director's  configuration file. The default is 9102. 
+   of the Director's  configuration file. The default is 9102.
 
 \item [FDAddress = \lt{}IP-Address\gt{}]
    \index[fd]{FDAddress}
    \index[fd]{Directive!FDAddress}
    This record is optional,  and if it is specified, it will cause the File
    daemon server (for  Director connections) to bind to the specified {\bf
-   IP-Address},  which is either a domain name or an IP address specified as a 
+   IP-Address},  which is either a domain name or an IP address specified as a
    dotted quadruple. If this record is not specified, the File daemon  will bind
-   to any available address (the default). 
+   to any available address (the default).
 
 \item [FDSourceAddress = \lt{}IP-Address\gt{}]
    \index[fd]{FDSourceAddress}
@@ -192,24 +192,24 @@ only IPv4 resolutions will be permitted,  and likewise with ip6.
    This record is optional,  and if it is specified, it will cause the File
    daemon server (for  Storage connections) to bind to the specified {\bf
    IP-Address},  which is either a domain name or an IP address specified as a
-   dotted quadruple. If this record is not specified, the kernel will choose 
+   dotted quadruple. If this record is not specified, the kernel will choose
    the best address according to the routing table (the default).
 
 \item [SDConnectTimeout = \lt{}time-interval\gt{}]
    \index[fd]{SDConnectTimeout}
    \index[fd]{Directive!SDConnectTimeout}
    This  record defines an interval of time that  the File daemon will try to
-   connect to the  Storage daemon. The default is 30 minutes. If no connection 
-   is made in the specified time interval, the File daemon  cancels the Job. 
+   connect to the  Storage daemon. The default is 30 minutes. If no connection
+   is made in the specified time interval, the File daemon  cancels the Job.
 
-\item [Maximum Network Buffer Size = \lt{}bytes\gt{}]  
+\item [Maximum Network Buffer Size = \lt{}bytes\gt{}]
    \index[fd]{Maximum Network Buffer Size}
    \index[fd]{Directive!Maximum Network Buffer Size}
    where \lt{}bytes\gt{} specifies the initial network buffer  size to use with
    the File daemon. This size will be adjusted down  if it is too large until it
    is accepted by the OS. Please use  care in setting this value since if it is
    too large, it will  be trimmed by 512 bytes until the OS is happy, which may
-   require  a large number of system calls. The default value is 65,536 bytes. 
+   require  a large number of system calls. The default value is 65,536 bytes.
 
    Note, on certain Windows machines, there are reports that the
    transfer rates are very slow and this seems to be related to
@@ -236,29 +236,29 @@ use. The speed parameter should be specified in k/s, kb/s, m/s or mb/s.
 
 
 \item [PKI Encryption]
-  See the \ilink{Data Encryption}{DataEncryption} chapter of this manual. 
+  See the \ilink{Data Encryption}{DataEncryption} chapter of this manual.
 
 \item [PKI Signatures]
-  See the \ilink{Data Encryption}{DataEncryption} chapter of this manual. 
+  See the \ilink{Data Encryption}{DataEncryption} chapter of this manual.
 
 \item [PKI Keypair]
-  See the \ilink{Data Encryption}{DataEncryption} chapter of this manual. 
+  See the \ilink{Data Encryption}{DataEncryption} chapter of this manual.
 
 \item [PKI Master Key]
-  See the \ilink{Data Encryption}{DataEncryption} chapter of this manual. 
+  See the \ilink{Data Encryption}{DataEncryption} chapter of this manual.
 
 \end{description}
 
-The following is an example of a valid Client resource definition: 
+The following is an example of a valid Client resource definition:
 
 \footnotesize
-\begin{verbatim}
+\begin{lstlisting}
 Client {                              # this is me
   Name = rufus-fd
   WorkingDirectory = $HOME/bacula/bin/working
   Pid Directory = $HOME/bacula/bin/working
 }
-\end{verbatim}
+\end{lstlisting}
 \normalsize
 
 \section{The Director Resource}
@@ -267,7 +267,7 @@ Client {                              # this is me
 \index[general]{Resource!Director }
 
 The Director resource defines the name and password of the Directors that are
-permitted to contact this Client. 
+permitted to contact this Client.
 
 \begin{description}
 
@@ -276,23 +276,23 @@ permitted to contact this Client.
    \index[fd]{Directive!Director}
    Start of the Director records. There may be any  number of Director resources
    in the Client configuration file. Each  one specifies a Director that is
-   allowed to connect to this  Client. 
+   allowed to connect to this  Client.
 
 \item [Name = \lt{}name\gt{}]
    \index[fd]{Name}
    \index[fd]{Directive!Name}
-   The name of the Director  that may contact this Client. This name must be the 
+   The name of the Director  that may contact this Client. This name must be the
    same as the name specified on the Director resource  in the Director's
    configuration file. Note, the case (upper/lower) of the characters in
    the name are significant (i.e. S is not the same as s). This directive
-   is required. 
+   is required.
 
 \item [Password = \lt{}password\gt{}]
    \index[fd]{Password}
    \index[fd]{Directive!Password}
    Specifies the password that must be  supplied for a Director to be authorized.
 This password  must be the same as the password specified in the  Client
-resource in the Director's configuration file.  This directive is required. 
+resource in the Director's configuration file.  This directive is required.
 
 \item [Maximum Bandwidth Per Job = \lt{}speed\gt{}]
 \index[fd]{Maximum Bandwidth Per Job}
@@ -300,7 +300,7 @@ resource in the Director's configuration file.  This directive is required.
 
 The speed parameter specifies the maximum allowed bandwidth that a job may use
 when started from this Director. The speed parameter should be specified in
-k/s, KB/s, m/s or MB/s.
+k/s, Kb/s, m/s or Mb/s.
 
 \item [Monitor = \lt{}yes\vb{}no\gt{}]
    \index[fd]{Monitor}
@@ -309,19 +309,19 @@ k/s, KB/s, m/s or MB/s.
    to this Client. If Monitor is set to  {\bf yes}, this director will only be
    able to fetch the current status  of this Client.
 
-   Please note that if this director is being used by a Monitor, we highly 
-   recommend to set this directive to {\bf yes} to avoid serious security 
-   problems. 
+   Please note that if this director is being used by a Monitor, we highly
+   recommend to set this directive to {\bf yes} to avoid serious security
+   problems.
 \end{description}
 
 Thus multiple Directors may be authorized to use this Client's services. Each
 Director will have a different name, and normally a different password as
-well. 
+well.
 
-The following is an example of a valid Director resource definition: 
+The following is an example of a valid Director resource definition:
 
 \footnotesize
-\begin{verbatim}
+\begin{lstlisting}
 #
 # List Directors who are permitted to contact the File daemon
 #
@@ -334,7 +334,7 @@ Director {
   Password = not_as_good
   Monitor = Yes
 }
-\end{verbatim}
+\end{lstlisting}
 \normalsize
 
 \section{The Message Resource}
@@ -342,21 +342,21 @@ Director {
 \index[general]{Message Resource}
 \index[general]{Resource!Message }
 
-Please see the 
+Please see the
 \ilink{Messages Resource}{MessagesChapter} Chapter of this
-manual for the details of the Messages Resource. 
+manual for the details of the Messages Resource.
 
-There must be at least one Message resource in the Client configuration file. 
+There must be at least one Message resource in the Client configuration file.
 
 \section{Example Client Configuration File}
 \label{SampleClientConfiguration}
 \index[general]{Example Client Configuration File }
 \index[general]{File!Example Client Configuration }
 
-An example File Daemon configuration file might be the following: 
+An example File Daemon configuration file might be the following:
 
 \footnotesize
-\begin{verbatim}
+\begin{lstlisting}
 #
 # Default  Bacula File Daemon Configuration file
 #
@@ -395,5 +395,5 @@ Messages {
   Name = Standard
   director = rufus-dir = all, !skipped
 }
-\end{verbatim}
+\end{lstlisting}
 \normalsize