bwcreate.cfg

Package: WA2L/edrc 1.5.57
Section: Configuration Files (4)
Updated: 21 April 2007
Index Return to Main Contents

 

NAME

bwcreate.cfg - configuration file for bwcreate

 

SYNOPSIS

edrc/etc/bwcreate.cfg

 

AVAILABILITY

WA2L/edrc

 

DESCRIPTION

This is the configuration file for the bwcreate command.

 

FILEFORMAT

The format for options is OPTION=VALUE .

The format of a profile definition is:

PROFILE_name(){
OPTION1=VALUE
OPTION2=VALUE
:
OPTIONn=VALUE
}

Between the OPTION, the = and the VALUE are no spaces.

Rows starting with a # are considered as comments.

You should not comment out any OPTION. If you like to use default settings simply do not specify a VALUE.

Normally there are multiple profiles defined in one configuration file.

 

OPTIONS

 

GLOBAL OPTIONS

This options influence the general behavior of the bwcreate command.

LOG
Log output dir of bwcreate. If you specify a relative path name the path is relative to the root of the WA2L/edrc installation.

Example: LOG=/var/opt/edrc/log

Default: LOG=var/log

 

PROFILE OPTIONS

A profile has the following structure:

PROFILE_name(){

DESCRIPTION='Text'
FILESYSTEMS="filesystems"
OUTPUT_DIRECTORY=directory
OUTPUT_FILE=filename
OUTPUT_FILE_PERMISSIONS=perm
PARALLEL_EXECUTION=True|False
}

The options recognized in a profile are:

name
Name of the profile. The name defined here has to be specified in the -p option in the bwcreate command. The profile with the name default is called when the -p option is not specified when using the bwcreate command. Therefore each bwcreate.cfg file should at least define a profile with the name default.

DESCRIPTION
Profile description. The description text has to be enclosed in *single* quotes.

Example: DESCRIPTION='common Unix/Linux'

Default: DESCRIPTION=''

FILESYSTEMS
Filesystems to be listed in the BarbedWire file. It is also possible to define directories within a filesystem. If there are extra filesystems for /opt, /usr it is not sufficient to list only the root filesystem / here, due to the fact that the file search is local to a filesystem.

Example: FILESYSTEMS="/ /var /usr /opt"

Default: FILESYSTEMS="/"

OUTPUT_DIRECTORY
Existing directory where the BarbedWire file is created. This directory should have at least twice the space available as the resulting BarbedWire file size.

Example: OUTPUT_DIRECTORY=/dat/report/barbedwire

Default: OUTPUT_DIRECTORY=/var/tmp

OUTPUT_FILE
Filename of BarbedWire file in OUTPUT_DIRECTORY without suffix. A BarbedWire file has the suffix .bw.

Example: OUTPUT_FILE=$HOSTNAME_$NOW

Default: OUTPUT_FILE=barbedwire_outfile_$HOSTNAME_$TODAY

OUTPUT_FILE_PERMISSIONS
File permissions of BarbedWire file produced.

Example: OUTPUT_FILE_PERMISSIONS=400

Default: OUTPUT_FILE_PERMISSIONS=444

PARALLEL_EXECUTION
Execute the resolution of the fileproperties for all filesystems or directories listed in FILESYSTEMS in parallel.

Example: PARALLEL_EXECUTION=False

Default: PARALLEL_EXECUTION=True

 

VARIABLES

The following variables can be used in profiles. Do not use other variables in a bwcreate.cfg file seen by bwcreate due to the fact that the existence and/or contents can change without notice.

$HOSTNAME
The hostname of the system where the bwcreate command is executed.

$SERVER_ENVIRONMENT
The name of the server environment as returned by the server_environment command. See also server_environment(3) for more information about this command.

$TODAY
Date in the format YYYYMMDD (e.g. 20061206).

$NOW
Date and time in the format YYYYMMDDHHmm (e.g. 200612062307).

 

SEE ALSO

bwcreate(1), edrcintro(1), server_environment(3)

 

NOTES

-

 

BUGS

-

 

AUTHOR

bwcreate.cfg was developed by Christian Walther. Send suggestions and bug reports to wa2l@users.sourceforge.net .

 

COPYRIGHT

Copyright © 2008 Christian Walther

This is free software; see edrc/doc/COPYING for copying conditions. There is ABSOLUTELY NO WARRANTY; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.


 

Index

NAME
SYNOPSIS
AVAILABILITY
DESCRIPTION
FILEFORMAT
OPTIONS
GLOBAL OPTIONS
PROFILE OPTIONS
VARIABLES
SEE ALSO
NOTES
BUGS
AUTHOR
COPYRIGHT

This document was created by man2html using the manual pages.
Time: 00:13:56 GMT, March 08, 2025