SIDLOC README

This README file contains information about installing the SIDLOC utility.  
Refer to the sidloc.1 file described in section 2.0 for information about 
the SIDLOC utility. 


CONTENTS
__________

This file includes the following information:

1.0  Prerequisites
2.0  Installing SIDLOC
3.0  Customizing SIDLOC
4.0  Running SIDLOC
5.0  Trademarks


1.0  PREREQUISITES 
___________________________

To use the SIDLOC tool, you need to have OS/390 UNIX System Services (OS/390 UNIX).



2.0  INSTALLING SIDLOC
___________________________
Detach all four files (sidloc, slwork, checknl and sidloc.1) to OS/390 UNIX.
Copy sidloc, slwork, and checknl to /usr/bin (assuming /usr/bin is the default executables 
directory), and copy sidloc.1 to your default man pages directory.

Change file modes to 755.


3.0  CUSTOMIZING SIDLOC
____________________________
In the sidloc file, you can change the default root directory that identifies
the location of the source code that is used to compare the new/updated files. 
To do this, edit the following line:

   source_dir = '/u/tpf41/currentmaint'
 
to match the naming conventions of your system.

If you do not modify the root directory name, you will have to use the 
-d OrigDir option every time you use the tool.


4.0  RUNNING SIDLOC
________________________
Usage: sidloc [-d OrigDir] [-l|-s] [-t num] AparNumber [Path] [WorkDir]
                                                                                
 -d Original source directory, to compare against (default is /u/tpf41/currentmaint)

 -l Line-Of-code (LOC) count processing only
                                              
 -s SID code processing only
                                                    
 -t Interval, the number of columns between tabs (default is 1)
                 
 AparNumber, required 
                                                          
 Path, optional, directory or files that are changed (default is PWD) 
        
 Working Directory, optional, to save processed source and Apar.loc files (default is PWD)

Note: Even when running with the -l option, a SID code must be specified. For the 
      -l option, the SID code is not used, so any value can be specified.

5.0  TRADEMARKS
_________________

The following terms are trademarks of the IBM Corporation in the United 
States or other countries, or both:

IBM
OS/390

UNIX is a trademark of The Open Group in the United States and other countries.

Other company, product, and service names may be trademarks or service
marks of others.

Copyright IBM Corporation, 2002. All rights reserved.

THIS DOCUMENT IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND.
IBM DISCLAIMS ALL WARRANTIES, WHETHER EXPRESS OR IMPLIED, INCLUDING
WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR
PURPOSE AND MERCHANTABILITY WITH RESPECT TO THE INFORMATION IN THIS
DOCUMENT. BY FURNISHING THIS DOCUMENT, IBM GRANTS NO LICENSES TO ANY
PATENTS OR COPYRIGHTS.