INSTALLING AND CONFIGURING DISKFREE 
===================================

File    : diskfree-documentation.txt
Author  : Bob Jonkman bjonkman@sobac.com 
Date    : 3 June 2008 

Copyright 2008 Bob Jonkman and/or SOBAC Microcomputer Services 

This program is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your
option) any later version. 

This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
Public License for more details. 

You should have received a copy of the GNU General Public License along
with this program. If not, see <http://www.gnu.org/licenses/>. 


Updates
=======

The current version of DISKFREE is available from http://sobac.com/sobac/diskfree/


Purpose
=======

DISKFREE has been developed to semi-automate the procedure of managing
disk capacity on Netware servers. 

This applies to any installation of NetWare servers where the disk
volumes need to be checked regularly for available disk space, and trend
data is needed for capacity planning. 

Disk Space Checking is currently a semi-automated process, requiring a
dedicated workstation running DISKFREE.BAT as a daily Scheduled Event. 

DISKFREE is a combination of scheduled tasks, MS-DOS Batch files and
.AWK programs, providing output as an HTML report and .CSV files. 


Installation
============

1. If GAWK is not installed on the workstation then download GAWK from
   http://gnuwin32.sourceforge.net/downlinks/gawk.php and install according
   to the instructions at http://gnuwin32.sourceforge.net/install.html 

2. UnZIP the AWK programs from DISKFREE.ZIP into the "GnuWin32\Share" folder. 

3. UnZIP the Batch programs from DISKFREE.ZIP into the C:\bin\batch\
   folder. Creat a file "volumes.cfg" is in the C:\bin folder 

4. Ensure that "C:\bin\batch\" is on the executable program path:
   - Select "Control Panel, System, Advanced, Environment Variables"
   - highlight "Path", 
   - click "Edit" 
   - add "C:\bin\batch\;" to the "Variable value" field

5. Ensure that the "AWKPATH" environment variable is set to the
   "GnuWin32\Share" folder:
   - Select "Control Panel, System, Advanced, Environment Variables"
   - click "New" in the System "variables" section
   - type "AWKPATH" in the "Variable Name" field
   - type the fully qualified path to "GnuWin32\Share" in the 
     "Variable Value" field. 

6. Add a Scheduled Task:
   - Select "Start, All Programs, Accessories, System Tools, Scheduled Tasks"
   - select "Add a scheduled task"
   - follow the Scheduled Task Wizard to run DISKFREE.BAT daily (or whenever required)
   - Use the "nodisplay" parameter to prevent the report from displaying automatically.

7. Optional: Run the DISKFREE.BAT file to create the DISKFREE.HTM report
   file, then create a shortcut on the desktop for DISKFREE.HTM 

8. Optional: Create a shortcut for DISKFREE.BAT on the desktop


End-user Instructions 
===================== 

Disk Space Checking is currently a semi-automated process, requiring a
dedicated workstation running the "DISKFREE" scripts as a daily
Scheduled Event. 

1. Log in to th workstation that has the
DISKFREE scripts installed. 

2. Double-click on desktop icon "Report-Diskfree". 

3. Scroll to bottom of the table "trend-percent-available-diskfree.csv".

4. For each volume entry, compare the value of the current day's percent
available disk space to the previous day's value.. 

5. Each table in the report can be exported as a .CSV file for further
analysis in a spreadsheet application.

6. Close the "Report-Diskfree" document. 


Sample VOLUMES.CFG
==================

# File      :   volumes.cfg
# Purpose   :   Lists volumes to be monitored with diskfree.awk
# Author    :   Bob Jonkman bjonkman@sobac.com
# Date      :   10 July 2007
# Note      :   Blank lines and lines starting with # are ignored

server01\sys
server01\vol1

server02\sys
server02\vol1
server02\vol2

# The following volume doesn't need checking
# server02\prntque

===== EOF: VOLUMES.CFG ====


(EOF: diskfree-documentation.txt)
