]> git.sur5r.net Git - bacula/docs/blobdiff - docs/manual/filedconf.tex
This commit was manufactured by cvs2svn to create tag
[bacula/docs] / docs / manual / filedconf.tex
index 3ecacbaa299bf4c75fa380c8c2efc1d21b69f2d0..2c5e757f0af5c987a64014b791e1777a2bbf1288 100644 (file)
@@ -46,20 +46,23 @@ Director connections.
 \begin{description}
 
 \item [Client (or FileDaemon)]
-   \index[fd]{Client (or FileDaemon) }
+   \index[fd]{Client (or FileDaemon)}
+   \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. 
 
 \item [Name = \lt{}name\gt{}]
-   \index[fd]{Name  }
+   \index[fd]{Name}
+   \index[fd]{Directive!Name}
    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.  
 
 \item [Working Directory = \lt{}Directory\gt{}]
-   \index[fd]{Working Directory  }
+   \index[fd]{Working Directory}
+   \index[fd]{Directive!Working Directory}
    This directive  is mandatory and specifies a directory in which the File
    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
@@ -74,20 +77,22 @@ client program.
    to the Storage daemon).
 
 \item [Pid Directory = \lt{}Directory\gt{}]
-   \index[fd]{Pid Directory  }
+   \index[fd]{Pid Directory}
+   \index[fd]{Directive!Pid Directory}
    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. 
-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.  
+   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. 
+   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.  
 
-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. 
+   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. 
 
 \item [Heartbeat Interval = \lt{}time-interval\gt{}]
-   \index[fd]{Heartbeat Interval  }
+   \index[fd]{Heartbeat Interval}
+   \index[fd]{Directive!Heartbeat Interval}
    \index[general]{Heartbeat Interval}
    \index[general]{Broken pipe}
    This record defines an interval of time.  For each heartbeat that the
@@ -120,7 +125,8 @@ Directory} as  defined above.
 
 
 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
-   \index[fd]{Maximum Concurrent Jobs  }
+   \index[fd]{Maximum Concurrent Jobs}
+   \index[fd]{Directive!Maximum Concurrent Jobs}
    where \lt{}number\gt{} is the maximum number of Jobs that should run
    concurrently.  The default is set to 2, but you may set it to a larger
    number.  Each contact from the Director (e.g.  status request, job start
@@ -129,7 +135,8 @@ Directory} as  defined above.
    will need to set this value greater than 1.
 
 \item [FDAddresses = \lt{}IP-address-specification\gt{}]
-   \index[console]{FDAddresses  }
+   \index[fd]{FDAddresses}
+   \index[fd]{Directive!FDAddresses}
    Specify the ports and addresses on which the Director daemon will listen
    for Bacula Console connections.  Probably the simplest way to explain is
    to show an example:
@@ -170,13 +177,15 @@ 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.  
 
 \item [FDPort = \lt{}port-number\gt{}]
-   \index[console]{FDPort  }
+   \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. 
 
 \item [FDAddress = \lt{}IP-Address\gt{}]
-   \index[console]{FDAddress  }
+   \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 
@@ -184,13 +193,15 @@ dotted quadruple. If this record is not specified, the File daemon  will bind
 to any available address (the default). 
 
 \item [SDConnectTimeout = \lt{}time-interval\gt{}]
-   \index[console]{SDConnectTimeout  }
+   \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. 
 
 \item [Maximum Network Buffer Size = \lt{}bytes\gt{}]  
-   \index[console]{Maximum Network Buffer Size  }
+   \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
@@ -222,25 +233,29 @@ permitted to contact this Client.
 \begin{description}
 
 \item [Director]
-   \index[fd]{Director }
+   \index[fd]{Director}
+   \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. 
 
 \item [Name = \lt{}name\gt{}]
-   \index[fd]{Name  }
+   \index[fd]{Name}
+   \index[fd]{Directive!Name}
    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. This record is required. 
 
 \item [Password = \lt{}password\gt{}]
-   \index[fd]{Password  }
+   \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 record is required. 
 
 \item [Monitor = \lt{}yes|no\gt{}]
-   \index[fd]{Monitor  }
+   \index[fd]{Monitor}
+   \index[fd]{Directive!Monitor}
    If Monitor is set to {\bf no} (default),  this director will have full access
 to this Client. If Monitor is set to  {\bf yes}, this director will only be
 able to fetch the current status  of this Client.