Category : File Managers
Archive   : CLNUP100.ZIP
Filename : CLEANUP.DOC

CleanUp Version 1.00 Oct 13, 1989 Page 1



1 PURPOSE

CleanUp is a program designed to delete various backup and temporary
files from your hard disk. It uses file specifications that you enter
into a control file to search all the sub-directories on your hard
disk for files to delete. You can have CleanUp delete the files it
finds automatically or prompt you before deleting the file. Any number
of specifications can be entered and any number of sub-directories can
be searched.

CleanUp can be run in "interactive" mode or from a batch file in
"automatic" mode for use during off-hour maintenance.













































Copyright Bob Breedlove 1989 All rights reserved





CleanUp Version 1.00 Oct 13, 1989 Page 2



2 REGISTRATION

CleanUp is copyright (c) Bob Breedlove, 1989. All rights are reserved.
It is NOT free software. Should you continue to use CleanUp, please
send $5 registration along with your name, address and telephone
number to:

Bob Breedlove
3196 Swallowsnest Dr.
Sacramento, CA 95833

You can use the registration form at the end of this documentation if
you wish. Sorry, registration by phone or credit card not available.

You may use CleanUp on any number of computers that YOU, PERSONALLY
USE. If you are registering CleanUp for a company, you MUST register
CleanUp for each workstation or send a $50.00 site license fee to
allow you to use any number of copies of CleanUp at your SINGLE SITE.

CleanUp may NOT be distributed with other software or as part of any
other package. If you distribute shareware diskettes for money, you
MUST obtain written permission from the author before distributing
CleanUp.

Because of the nature of CleanUp and available time, only registered
users will qualify for support. When you register this version of
CleanUp, you will automatically receive a copy of the next version of
the program. Here are the changes that are planned:

o Run any command/program against the file(s) processed. For
example, archive all documentation files rather than deleting
them.
o Run any command when you switch to a drive, before and after
processing the files on that drive.
o Run any command when you switch to a directory, before and after
processing the files in that directory For example, delete all
backup files in a directory, then archive all remaining files.
o Run any command for SPECIFIC directories, before and after
processing the files in that directory. For example, run a batch
file which archives all files before deleting the backup files.
o Exclude directories from processing. For example, you might not
wish to delete the backup files in a sub-directory in which you
are actively programming.

When these features are incorporated, the registration price of
CleanUp will be increased to $10. By registering the current version,
you will receive this upgrade for free!










Copyright Bob Breedlove 1989 All rights reserved





CleanUp Version 1.00 Oct 13, 1989 Page 3



3 WARRANTY

CleanUp has been tested as thoroughly as possible. However, there is
no guarantee, either stated or implied that it is suitable for your
specific use or with your specific equipment. The author, Bob
Breedlove, cannot be held responsible for any damage or loss of data
resulting either directly or indirectly from the use of CleanUp.

BEFORE RUNNING CleanUp FOR THE FIRST TIME, BE SURE TO BACKUP ALL
CRITICAL FILES ON YOUR HARD DISK(S). This is especially important
when you first set up your control file.

If you are a registered CleanUp user, you will receive telephone and
mail support for the product. In addition, you will be set up with an
account on BOBsBBS for on-line support.

NON-REGISTERED USERS CANNOT RECEIVE SUPPORT FOR PROBLEMS WITH CleanUp
AND THEIR SPECIFIC EQUIPMENT.







































Copyright Bob Breedlove 1989 All rights reserved





CleanUp Version 1.00 Oct 13, 1989 Page 4



4 FILES

The following files should be on the CleanUp diskette or in the
archive file that you received:

CleanUp.EXE The CleanUp Program
CleanUp.CTL A sample control file.
CleanUp.DOC This documentation
EDITOR.CMD A "cheat sheet" of editor commands.
READ.ME Additional comments, new features

NOTE: The READ.ME file will ONLY be included when there is additional
information about the current release of CleanUp or other BOBsWARE
products which is not included in the documentation (CleanUp.DOC).

If you received these files from a bulletin board system and the file
is not complete or contains other files, BE VERY CAUTIOUS! The
program may have been tampered with.

The only files necessary to run CleanUp are CleanUp.EXE and
CleanUp.CTL. These can be placed anywhere along your path.




































Copyright Bob Breedlove 1989 All rights reserved





CleanUp Version 1.00 Oct 13, 1989 Page 5



5 Starting CleanUp

5.1 Introduction

Before you can run CleanUp, you must create the control file --
CleanUp.CTL. See the section -- The Control File -- for details
on creating CleanUp.CTL.

CleanUp.EXE and CleanUp.CTL are the only files required to run
CleanUp. They can be placed anywhere on your path. If you are
unfamiliar with the DOS PATH command, please refer to your DOS
documentation.


5.2 The CleanUp Command Line

To run CleanUp, use the following command line:

CleanUp [[{path}]{ControlFileName}] [{switches}]

{ControlFileName} is the name of the control file you wish to
use. If you do NOT enter the control file name, CleanUp will
attempt to use "CleanUp.CTL". If you specify a complete path name
for the control file, CleanUp will search ONLY that directory. If
you specify ONLY a filename or do NOT specify the control file
name, CleanUp will search the current directory first. The
current directory is the one that you were in when you started
CleanUp. If it can't find the control file, CleanUp will search
the DOS PATH for the file.

If CleanUp cannot find the control file and you have NOT
specified any switches, CleanUp will abort.

The following switches can be entered on the command line:

/E Edit the specified control file (or CleanUp.CTL if none is
specified) and then exit the program without processing the
specified patterns.

/R Edit the specified control file (or CleanUp.CTL if none is
specified) and then process the specified patterns.

If either switch is specified, CleanUp will create a new control file
if it can't find the one specified.

NOTE: you can NOT enter a path name without the control filename.
CleanUp will think that the last sub-directory in your path is the
control file and attempt to find that file. For example:

C:\BIN\CleanUp.CTL

is valid, but

C:\BIN



Copyright Bob Breedlove 1989 All rights reserved





CleanUp Version 1.00 Oct 13, 1989 Page 6




is NOT. CleanUp will search for a file named "BIN" in the root
directory on the C: drive.


5.3 Examples

C> CleanUp

CleanUp will search for "CleanUp.CTL" in the current directory.
If it is not found, it will search for a control file with this
name along the DOS path. If "CleanUp.CTL" is not found, the
program will terminate with an error message.


C> CleanUp Weekly.CTL

In this example, CleanUp will search for the control file
"Weekly.CTL" in the current directory and along the path. It will
terminate with an error if the file is not found. This control
file may be one of many. Naming control files like this allows
you to have one control file for daily processing and another for
weekly or special processing.


C> CleanUp /E

This version of the command line is used to edit CleanUp.CTL and
then terminate the program. CleanUp will still search for
"CleanUp.CTL" in the current directory and along the path.
However, if it does not find an existing "CleanUp.CTL", it will
create one IN THE CURRENT DIRECTORY.

When CleanUp starts you are placed in the full-screen editor.
When you exit the editor, CleanUp terminates.


C> CleanUp /R

This example is identical to that above ("CleanUp /E") with the
exception that CleanUp will process the control file instructions
once you have exited the editor.


C> CleanUp D:\UTILITY\CleanUp.CTL

When you enter the full path name, CleanUp searches for the file
in the specified directory only. In this case, if CleanUp does
not find "CleanUp.CTL" in the directory "D:\UTILITY", it will
terminate with an error message. This feature allows you to
create control files with the same name in different directories
and process them as desired.





Copyright Bob Breedlove 1989 All rights reserved





CleanUp Version 1.00 Oct 13, 1989 Page 7



C> CleanUp C:\BIN\Daily.CTL /R

CleanUp will search the directory "C:\BIN" for a control file
called "Daily.CTL". If it does not find one, it will create one
in "C:\BIN". CleanUp will put you in the editor to edit/create
the file and then execute the resulting control file.


C> CleanUp C:\BIN\Daily.CTL /E

This example is identical to the one above except that CleanUp
will NOT execute the instructions in "Daily.CTL" once you exit
the editor.












































Copyright Bob Breedlove 1989 All rights reserved





CleanUp Version 1.00 Oct 13, 1989 Page 8



6 The CONTROL FILE (CleanUp.CTL)

6.1 Introduction

CleanUp's control file(s) is a plain MS-DOS ASCII file. It can be
created using any text editor or word processor that does NOT
introduce format characters into the text. The easiest way to
create or modify CleanUp.CTL is to use CleanUp's built-in
full-screen text editor.


6.2 Format

The CleanUp control file consists of lines in one of the
following formats:

{session switch}
{filename pattern} {switches}

{session switch} is a command switch which affects the entire
CleanUp Process. {switches} which appear on the same line as a
{filename pattern} affect files matching that pattern ONLY.

NOTE: Only ONE filename pattern per command line is allowed.

Future versions of CleanUp will add features, however, they will
be downward compatible with existing command files.


6.3 Session Switches

Session switches are placed one per command line. They affect the
entire CleanUp session.


6.3.1 /B (Batch Operation)

When the /B session switch is detected, CleanUp will NOT pause
after completing execution. This is useful if you wish to run
CleanUp in unattended mode from a batch file.


6.3.2 /D (Disks to Process)


This switch tells CleanUp which disks to process. If it is not
found, CleanUp will process the current disk. You can list any
number of disks after the switch. The format of this line is:

/D {disk list}

The {disk list} is in the format of single letters. Do NOT leave
a space between the letters. For example:

/D CD



Copyright Bob Breedlove 1989 All rights reserved





CleanUp Version 1.00 Oct 13, 1989 Page 9




would process disks C: and D:

/D CDEFG

would process disks C: through G:

NOTE: CleanUp does NOT check to be sure that there are disks in
removable media disk drives. Be sure that you have set up all disks
before starting CleanUp.


6.4 Filename Patterns

CleanUp uses an extended set of file name matching symbols
(Templates). These allow greater flexibility in the selection of
files to be deleted from the hard disk than the standard DOS
wildcard characters ("?" and "*"). Only a single filename pattern
can be placed on each line.


6.4.1 Template Summary

The following is a summary of template characters that can be used in
filename patterns:

? = Any character
# = Any integer
@ = Any alphabetic character
* = any string of zero or more characters
[] = Groups characters inclusive
[~] = Groups characters exclusive
{|} = Groups of phrases

Each of these template characters is described in detail below.


6.4.2 Template Characters

? [Any Character]

Just as the DOS wildcard character, the question mark ("?")
matches any SINGLE character.

Examples:

???.EXE Matches any file with EXACTLY 3
characters and an extension of EXE. For
example: ABC.EXE, 123.EXE, A2_.EXE. It
would not match AB.EXE or ABCD.EXE.







Copyright Bob Breedlove 1989 All rights reserved





CleanUp Version 1.00 Oct 13, 1989 Page 10



TEST?.DOC Matches any file with a filename that
consists of "TEST" followed by any
SINGLE character and has an extension of
"DOC". It would match TEST1.DOC or
TESTM.DOC, but NOT TEST12.DOC.

TEST.??? Matches any file whose name is TEST with
a three character extension. Would match
TEST.EXE and TEST.DOC, but would NOT
match TEST.1.


# [Any Integer]

This template character is the same as the "?" except that it
only matches the numbers 0,1,2,3,4,5,6,7,8,9.

EXAMPLES:

A###.TXT Would match any file name starting with
"A" followed by three numbers and having
the extension "TXT". It would match
"A123.TXT" and "A989.TXT", but not
"ABCD.TXT".

#*.* Would match any file whose name started
with a number.


@ [Any Alphabetic Character]

This template character is the same as the "?" except that it
matches only the alphabetic characters A-Z. Case is ignored.

Examples:

@???.@@@ Would match any file whose name was
exactly 4 characters long and started
with any alphabetic character and whose
extension was composed of exactly three
alphanumeric character. It would match
"A123.ABC" or "ZA2C.TXT", but not
"0ABC.TXT" or "A123.A2C".

T@#*.* Would match any file whose name started
with a "T" followed by any alphabetic
character and any numeric character.


* [Any string of zero or more Characters]

The asterisk ("*") matches any string of zero or more characters.
NOTE: Unlike the DOS "*" this template character can be used
anywhere in the file name or extension.



Copyright Bob Breedlove 1989 All rights reserved





CleanUp Version 1.00 Oct 13, 1989 Page 11




*.EXE Matches any file with the extension
"EXE".

TEST*.DOC Matches any file which starts with
"TEST" and has zero or more characters
in the remainder of the filename and has
the extension "DOC". This template would
match TEST.DOC, TEST1.DOC, TESTABC.DOC.

*TEST.* This template would match any file with
TEST as the last four characters of the
filename and any extension. It would
match TEST.DOC, ATEST.EXE, THISTEST.TXT.
It would not match TEST1.DOC.

T*0*.T* This pattern matches any file that
starts with "T", has a "0" somewhere in
the filename and has an extension that
starts with "T". It matches T10.TXT,
T011.T, TXXXXXX0.T00. It would not match
T111.TXT, 1T0.T, T00.XXX.


[] [Groups characters, inclusive]
[~] [Groups characters, exclusive]

The "[]" pattern allows you to specify characters which are to be
considered in an "or" function. The [~] pattern indicates that
the character must NOT be one of the characters. The "-" is used
to indicate a range of characters. The "," indicates separate
characters.

Examples:

[a-e]*.* Will match any filename starting with
the characters "a","b","c","d", or "e".

[a,d,1,@]*.* Will match any filename starting with
the characters "a","d","1" or "@".
Notice that the "@" does NOT have its
usual meaning.

S[a-d,g,1-3]*.123 Will match any filename starting with
the letter "S" and followed by one of
the characters
"a","b","c","d","g","1","2","3" and
having the extension "123".

[~a-z]*.* Will match any filename NOT starting
with an alphabetic character.






Copyright Bob Breedlove 1989 All rights reserved





CleanUp Version 1.00 Oct 13, 1989 Page 12



[~a,1,@]*.* Will match any filename NOT starting
with an "a","1", or "@".


{|} [Groups phrases]

Just as the "[]" pattern matches single characters, the "{|}"
pattern matches sets of one or more phrases. The vertical bar
"|" is used to separate the phrases. The phrases to not have to
be the same length.

Examples:

{TO|THE|T2A}*.* Will match filenames starting with "TO",
"THE", or "T2A".

*{XA|XB|TC}.* Will match filenames ending with "XA",
"XB", or "TC".

*.{TMP|TST} Will match filenames with the extensions
"TMP" or "TST".

*{T1|T2|A1|A2}*.* Will match filenames with the phrases
"T1", "T2", "A1" or "A2" somewhere in
their filenames.


6.5 Pattern Switches

Pattern switches apply only to the pattern on the line in which
they are entered. The following switches are recognized:


6.5.1 /V - Verify before processing

The (V)erify switch causes CleanUp to pause and prompt you before
processing a file which matches this pattern. A message is
displayed in the {message area} and the program pauses for input
from the user. If you answer "Y", the file will be processed.
If you answer "N", it will not be processed.


6.5.2 /L - Log file switch

The (L)og switch causes CleanUp to record the individual filename
in the log file. This gives you a permanent record of which
files were processed.










Copyright Bob Breedlove 1989 All rights reserved





CleanUp Version 1.00 Oct 13, 1989 Page 13



6.5.3 /C - Count only switch

The (C)ount switch causes CleanUp to tally the file, but NOT
delete it. This can be useful if you wish only to know how many
of a particular file are on your hard disk. It is also useful
for testing complex patterns to make sure that they delete ONLY
the files that you intend.


















































Copyright Bob Breedlove 1989 All rights reserved





CleanUp Version 1.00 Oct 13, 1989 Page 14



7 The CleanUp Screen

+---------------------------------------------------------------+
| Directory: {directory} |
+-----------------------------+---------------------------------+
|{processed files} | Disks Processed : {count} |
| | Directories Processed : {count} |
| | Files Read : {count} |
| | Files Matched : {count} |
| | Files Deleted : {count} |
| +---------------------------------+
| |{control file name} |
| +---------------------------------+
| |{control file patterns} |
| |{final statistics} |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
+-----------------------------+ |
|{messages and prompts} | |
| | |
+-----------------------------+---------------------------------+
Cleanup version {version} (c) Bob Breedlove 1989


While cleanup is processing, it displays the CleanUp control
screen. This screen displays information about the session. It
is also used to prompt for information from the user, if
required.
























Copyright Bob Breedlove 1989 All rights reserved





CleanUp Version 1.00 Oct 13, 1989 Page 15



8 The log file (CleanUp.LOG)

CleanUp maintains a log file. By default, this file is called
CleanUp.LOG. It is stored in the same sub-directory where
CleanUp found the control file. The file is a plain ASCII text
file and can be listed, edited or printed. The log file name
will be the same as the name of the control file used with an
extension of "LOG". For example: if your control file is
"DAILY.CTL" then the log file will be "DAILY.LOG".

NOTE: CleanUp will write over any existing log files. If you
wish to keep track of previous CleanUp sessions, you will have to
rename the log file to a different name or copy the log file to a
different directory before running CleanUp.


8.1 Sample Log File

CleanUp version 1.00a started : 10/05/89 at 12:51:23

Control File:

Disks : C
*.BAK /L
*.TMP /V
*.[&,~]*
*.??$
*.O

TEST.BAK deleted
DOCUMENT.BAK deleted
RESTORE.BAK deleted


Num Bytes Num Bytes
Pattern Matched Matched Deleted Deleted
*.BAK 3 16835 3 16835
*.TMP 0 0 0 0
*.[&,~]* 0 0 0 0
*.??$ 0 0 0 0
*.O 0 0 0 0

Disks Processed : 1
Dirs Processed : 43
Files Read : 888
Bytes Read : 17911920
Files Matched : 3
Bytes Matched : 16835
Files Deleted : 3
Bytes Deleted : 16835







Copyright Bob Breedlove 1989 All rights reserved





CleanUp Version 1.00 Oct 13, 1989 Page 16



8.2 Log File Contents

8.2.1 Log File Header

The control file header contains the version number. This number
is important when reporting problems with your registered version
of CleanUp.

The header also shows the date and time that CleanUp was run.
These are taken from the computer's clock and will only be as
accurate as the clock is.


8.2.2 CleanUp Control File Patterns

CleanUp then displays the control file name and its contents.
This section in the log file contains the patterns and control
switches found in the control file.


8.2.3 File Processing Log

If you have told CleanUp to log files that it finds and processes
(/L switch), this section contains a list of these filenames.


8.2.4 Pattern Counts

CleanUp next displays the counts and total bytes matched and
processed (deleted) for each of the file patterns.


8.2.5 Total Counts

The log ends with the total processing count display. This is
the same display which is shown in the lower right-hand window on
the CleanUp screen.




















Copyright Bob Breedlove 1989 All rights reserved





CleanUp Version 1.00 Oct 13, 1989 Page 17



9 The Full Screen Editor

CleanUp has a full-screen editor which can be used to edit the
control file. It can handle files up to 64K in size. The editor
uses commands very similar to WordStar (tm). The file EDITOR.CMD
contains the commands. To print this "cheat sheet", you can use
the command:

COPY EDITOR.CMD PRN

Be sure that your printer is on before you issue this command.


9.1 Editing the Control File

To edit the control file, start CleanUp with the "/E" or "/R"
switches. See the discussion above for more information on these
command line switches.







































Copyright Bob Breedlove 1989 All rights reserved





CleanUp Version 1.00 Oct 13, 1989 Page 18



10 Tips and Cautions

10.1 The DOS Path

Because CleanUp searches first in the current directory and then
along the DOS PATH for the control file, you can have multiple
control files in different sub-directories for various
situations. In fact, you can have different control files with
the SAME NAME in different sub-directories. If you do, however,
it is important that you realize where you have started CleanUp
and what your DOS path is! UNLESS YOU SPECIFY THE FULL PATH NAME,
CleanUp WILL EXECUTE THE FIRST CONTROL FILE IT FINDS THAT MATCHES
YOUR COMMAND LINE!

For example, given the following sub-directory structure:

C:\
+----C:\BIN
| CleanUp.CTL
+----C:\WORK
| CleanUp.CTL
+----C:\TEST
| CleanUp.CTL
+----C:\MYDIR

and the following DOS path

C:\BIN;C:\WORK

starting CleanUp from the following directories will use the
indicated CleanUp.CTL file:

Start Directory Control File
C:\ C:\BIN\CleanUp.CTL
C:\BIN C:\BIN\CleanUp.CTL
C:\TEST C:\TEST\CleanUp.CTL
C:\WORK C:\WORK\CleanUp.CTL
C:\MYDIR C:\BIN\CleanUp.CTL

Note that even though "C:\WORK\CleanUp.CTL" is along the DOS Path, it
will not be used unless specified explicitly or CleanUp is started
from that sub-directory. This is because the path is searched on the
order entered and CleanUp will always find "CleanUp.CTL" in the
"C:\BIN" directory first and use it.


10.2 Filename Patterns

CleanUp will process faster and use less memory if you combine
patterns. For example, if you wish to delete all files with
extensions of "BAK" and "TMP", you could enter either:

*.BAK
*.TMP



Copyright Bob Breedlove 1989 All rights reserved





CleanUp Version 1.00 Oct 13, 1989 Page 19




or

*.{BAK|TMP}

in the control file. Both will do the job, but the second will
use somewhat less memory and will process somewhat faster. The
first command lines will count the file separately while the
second will give you a total count for both types of files.

You might also want to delete all files starting with the letters
"A", "B", or "D". You could enter:

A*.*
B*.*
D*.*

This would count each type of file separately. However, you could
also enter:

[a,b,d]*.*

and get somewhat faster processing.


10.3 Using the /C pattern switch

When you first test a control file, you might want to use the /C
switch to count the files matching the pattern without deleting
them. This will allow you to verify that only the files that you
want to delete are actually deleted by CleanUp. Once you've seen
that the control file works correctly, remove the switch and
process the disk.
























Copyright Bob Breedlove 1989 All rights reserved





CleanUp Version 1.00 Oct 13, 1989 Page 20



11 Capacities

CleanUp does not limit the number of patterns or sub-directories
that you can process. However, CleanUp does use memory to store
"lists" used to process files. If you have a large number of
sub-directories or patterns, and a small amount of memory,
CleanUp may not function. To make more memory available:

o Remove any memory-resident programs
o Remove any menuing programs that are in memory

It is highly unlikely that you will run out of memory if you have done
these two things.












































Copyright Bob Breedlove 1989 All rights reserved





CleanUp Version 1.00 Oct 13, 1989 Page 21



12 Registration Form

To register CleanUp, send $5.00 and this completed registration
form to:

Bob Breedlove
3196 Swallowsnest Dr.
Sacramento, CA 95833

You will receive confirmation of your registration and support
instructions by return mail. When the new version of CleanUp is
released, you will receive if FREE OF CHARGE! Thanks for
registering CleanUp.

Name: __________________________________________________
Address: __________________________________________________
__________________________________________________
City: ___________________________ State: ___ Zip: ______
Phone: (______) _____-_______ extension _________________

The following information is optional, however, it will help me
provide you with assistance should you need support to use
CleanUp.

Computer: __________________________________________________
Type: 808X____ 80286____ 80386____ Other_____________
Memory: ___________________
Graphics: CGA__ VGA__ EGA__ B/W__ Hercules__





























Copyright Bob Breedlove 1989 All rights reserved