
			PATCHDIAG TOOL USER'S GUIDE
			===========================

				Version:  1.0.2

				  22/Jul/98



OVERVIEW
--------

The PatchDiag Tool is a diagnostic tool that enables system administrators
to examine a profile of the patches installed on their Solaris system against
the most current profiles available from Sun Microsystems with respect to:

 - latest revisions
 - recommended patches
 - security patches
 - year 2000 patches
 - other patches relevant to the software environment

The results of PatchDiag Tool can help a system administrator quickly
determine and analyze the need for applying additional patches or newer 
revisions of existing patches.

PatchDiag Tool provides only patch profile information.  PatchDiag does not
deliver and apply any patches.  If a system administrator wants to acquire
and apply additional patches to a system, the system administrator should	
use their normal Sun authorized service channel, or can access patches	
via the web at:								 

http://sunsolve.sun.com/private-cgi/patchpage.pl  


COMPATIBILITY AND USAGE NOTES
-----------------------------

This tool is a Perl compiled script compatible with all systems running a 
Solaris 2.3 or later environment and with all patches installed in Solaris
patch packet format.  As later versions of Solaris are released, earlier 
versions of Solaris might no longer be supported by this tool.						
Patches indicated as "Recommended" patches are the most important patches.
They prevent the most critical system, user, or security-related bugs that
have been reported and fixed to date.  Patches not listed on the recommended 
should be used if needed.  Some patches listed in this report can have
certain platform-specific or application-specific dependencies and thus
might not be applicable to your system.  It is important to carefully review
the README file of each patch to fully determine the compatibility of any
patch with your system.


REQUIREMENTS AND DEPENDENCIES
-----------------------------

To run the PatchDiag Tool, you must have the following on your system
(if you have a firewall, using the links requires the ability to access
external Web pages):

patchdiag.xref:	This is the cross-reference data file of patch information
		needed by the patchdiag executable to generate its patch
		profile report.  It is updated daily to contain the latest
		data about patches.  Always use latest version of this
		to maintain the accuracy of the PatchDiag Tool results.
                You can obtain this file from the Patchdiag Tool web area at:
		
		http://sunsolve.sun.com/sunsolve/patchdiag/

pkginfo:	PatchDiag uses the pkginfo system command to obtain information
		about the packages currently installed on the system.

showrev:	PatchDiag uses the showrev system command to obtain information
		about the patches installed on the system.

uname:		PatchDiag uses the uname system command to determine the system 
                information (name and OS) when you don't use any of the source 
                file options (-p and -s).


SUPPORT AND USER COMMENTS
-------------------------

PatchDiag Tool is being made freely available for SunService customer usage.
There is no implied support for this tool.  The Perl source code is provided
in the file patchdiag.pl.  Future revisions of this tool will be provided
on a best effort basis.

Please send us your comments.

Go to the SunSolve Online patch comment page at:

	http://sunsolve.sun.com:80/pub-cgi/comment-form.pl

and follow the instructions on the page.
 

INSTALLING THE PATCHDIAG TOOL
=============================

The standard installation set of files for PatchDiag Tool consists of:

File			Contents			
----			--------			
README			Initial installation instructions
patchdiag_userguide	Complete usage information
patchdiag.1m		Man page of patchdiag
patchdiag_setup		Bourne shell script for tool setup
patchdiag.sparc		Sparc version of the Patchdiag Tool executable
patchdiag.i386		i386 version of the Patchdiag Tool executable
patchdiag.pl		The Perl source

1. Download and install the Patchdiag Tool files according to the instructions
   in the README file.							      

   You should have the following files installed on your system:
   
        - README
        - patchdiag_setup
        - patchdiag.1m
        - patchdiag_userguide
        - patchdiag.sparc
        - patchdiag.i386
        - patchdiag.pl
 
2. Obtain latest copy of the PatchDiag Tool cross-reference file from
   the Patchdiag Tool web area at:
		
		http://sunsolve.sun.com/sunsolve/patchdiag/
                ftp://sunsolve.sun.com/pub/patches/patchdiag.xref

   Place it in some appropriate directory.

3. Run the patchdiag_setup script from the same directory as the
   patchdiag executable files.

        All the users will need to have access to the patchdiag.xref file
        in order to run patchdiag successfully.  The patchdiag_setup script
        creates the proper patchdiag executable script, which has the XREF
	variable that contains the location of the patchdiag.xref file.

4. Include patchdiag.1m in the man page directory as option.  See man system
   command.


USING THE PATCHDIAG TOOL
========================

Invoke the the PatchDiag Tool from a command line. 


USAGE
-----

Command options:

patchdiag [ -l ]
	  [ -s <sfile> <os_ver> <arch> [remotename] ] 
          [ -p <pfile> <sfile> <os_ver> <arch > [remotename]]
          [ -x xfile ]
          [ -h | -? ]

where:

<arch>  is the architecture of the system where the data was obtained. 
	Valid settings for <arch> are: 					

	- sparc
	- i386
 
	If the architecture of the system is not specified, the system
	assumes 'sparc'.

<sfile> is a file containing showrev -p output.

<pfile> is a file containing pkginfo -l output.

<os_ver> is the OS version; this must be a SunOS number, not Solaris. 
 	 Use "5.5", not "2.5" for "Solaris 2.5".

<remotename> is remote host name if data is being used from a remote 
             host machine. Default is local host name.

<xfile> is a file containing the patch cross-reference data to be used
        other than default "patchdiag.xref".

patchdiag (no options)							   
-------------------------
patchdiag with no options uses the default variables you specified during
installation.  It produces a summary status report that lists:

 - installed patches
 - uninstalled recommended patches
 - uninstalled security patches
 - uninstalled year 2000 patches  

patchdiag -l
------------
patchdiag -l produces a more extensive audit report that includes all
patches available pertinent to software installed on the system:  It lists:

 - installed patches
 - uninstalled recommended patches
 - uninstalled security patches
 - uninstalled year 2000 patches  
 - other related uninstalled patches

patchdiag -s
------------
patchdiag -s uses the specified showrev -p output file and produces a
quick summary status report.  It lists:

 - installed patches
 - uninstalled recommended patches
 - uninstalled security patches
 - uninstalled year 2000 patches  
 
patchdiag -p
------------
patchdiag -p uses the specified showrev -p and pkginfo -l output files
and produces a long (-l) format listing.  It lists:

 - installed patches
 - uninstalled recommended patches
 - uninstalled security patches
 - uninstalled year 2000 patches  
 - other related uninstalled patches


SAMPLE REPORT
=============

Here is a sample report produced by patchdiag -l.
======================================================================================
System Name: zion        SunOS Vers: 5.6         Arch: sparc
Cross Reference File Date: 24/Jul/98

PatchDiag Version: 1.0.2
======================================================================================
Report Note:

Recommended patches are considered the most important and highly
recommended patches that avoid the most critical system, user, or
security related bugs which have been reported and fixed to date.
A patch not listed on the recommended list does not imply that it
should not be used if needed.  Some patches listed in this report
may have certain platform specific or application specific dependencies
and thus may not be applicable to your system.  It is important to
carefully review the README file of each patch to fully determine
the applicability of any patch with your system.
======================================================================================
INSTALLED PATCHES
Patch  Installed Latest   Synopsis
  ID   Revision  Revision
------ --------- -------- ------------------------------------------------------------
105214    01     CURRENT  SunOS 5.6: /kernel/fs/sockfs patch
105216    01        03    SunOS 5.6: /usr/sbin/rpcbind patch
105222    01        03    SunOS 5.6: sbus driver patch
105223    01        04    SunOS 5.6: pln/soc drivers & ssafirmware patch
105284    03        12    Motif 1.2.7: sparc Runtime library patch
105356    01        06    SunOS 5.6: /kernel/drv/ssd patch
105357    01        02    SunOS 5.6: /kernel/drv/ses patch
105375    03        09    SunOS 5.6: sf & socal driver patch
105379    01        04    SunOS 5.6: /kernel/misc/nfssrv patch
105393    01            
105397    02     CURRENT  SunOS 5.6: /usr/sbin/passmgmt patch
105405    01        02    SunOS 5.6: libcurses.a & libcurses.so.1 patch
105407    01     CURRENT  SunOS 5.6: /usr/bin/volrmmount patch
105416    01     CURRENT  SunOS 5.6: /usr/lib/acct/acctdisk patch
105472    01        02    SunOS 5.6: /usr/lib/autofs/automountd patch
105492    01        02    SunOS 5.6: cgsix driver patch
105497    01     CURRENT  OpenWindows 3.6: printtool patch
105516    01     CURRENT  SunOS 5.6: /usr/lib/fs/ufs/fsck patch
105518    01     CURRENT  SunOS 5.6: /usr/bin/vacation patch
105528    01     CURRENT  SunOS 5.6: /kernel/drv/be patch
105529    01        04    SunOS 5.6: /kernel/drv/tcp patch
105558    01     CURRENT  CDE 1.2: dtpad patch
105615    02        03    SunOS 5.6: /usr/lib/nfs/mountd patch
105621    01            
105665    01            
105669    02     CURRENT  CDE 1.2: libDtSvc Patch
105786    01        05    SunOS 5.6: /kernel/drv/ip patch
======================================================================================

UNINSTALLED RECOMMENDED PATCHES

Patch  Ins Lat Age  Require    Incomp  Synopsis
  ID   Rev Rev        ID         ID
------ --- --- --- --------- --------- -----------------------------------------
105181 N/A  06  77                     SunOS 5.6: kernel update patch
105210 N/A  11  63                     SunOS 5.6: libc & watchmalloc patch
105395 N/A  02  73                     SunOS 5.6: /usr/lib/sendmail patch
105401 N/A  14  53                     SunOS 5.6: libnsl and NIS+ commands patch
105490 N/A  04 115                     SunOS 5.6: linker patch
105552 N/A  02 217                     SunOS 5.6: /usr/sbin/rpc.nisd_resolv patch
105562 N/A  03  58                     SunOS 5.6: chkey and keylogin patch
105580 N/A  07  38                     SunOS 5.6: /kernel/drv/glm patch
105600 N/A  05  92 105181-05           SunOS 5.6: /kernel/drv/isp patch
105642 N/A  05  65                     SunOS 5.6: prtdiag patch
105667 N/A  01 211                     SunOS 5.6: /usr/bin/rdist patch
105720 N/A  03 156                     SunOS 5.6: /kernel/fs/nfs patch
105736 N/A  01 170                     SunOS 5.6: /usr/lib/mail.local patch
105755 N/A  06  77                     SunOS 5.6: libresolv, in.named, named-xfer, nslookup, nstest patch
105797 N/A  03 112                     SunOS 5.6: /kernel/drv/sd patch
105926 N/A  01 217                     SunOS 5.6: /usr/sbin/static/tar patch
106049 N/A  01  91                     SunOS 5.6: /usr/sbin/in.telnetd patch
106125 N/A  05  59                     SunOS 5.6: Patch for patchadd and patchrm
106226 N/A  01  87                     SunOS 5.6: /usr/sbin/format patch
106235 N/A  01  50                     SunOS 5.6: lp patch
106301 N/A  01 115                     SunOS 5.6: /usr/sbin/in.ftpd patch
106448 N/A  01  45                     SunOS 5.6: /usr/sbin/ping patch
105837 N/A  02 156                     CDE 1.2: dtappgather Patch
106242 N/A  01  74                     CDE 1.2: libDtHelp.so.1 fixes
105464 N/A  01 311                     SunOS 5.6: multiple xterm fixes
106222 N/A  01 122                     OpenWindows 3.6: filemgr (ff.core) fixes
======================================================================================

UNINSTALLED SECURITY PATCHES

NOTE: This list includes the Security patches that are also Recommended

Patch  Ins Lat Age  Require    Incomp  Synopsis
  ID   Rev Rev        ID         ID
------ --- --- --- --------- --------- -----------------------------------------
105181 N/A  06  77                     SunOS 5.6: kernel update patch
105210 N/A  11  63                     SunOS 5.6: libc & watchmalloc patch
105395 N/A  02  73                     SunOS 5.6: /usr/lib/sendmail patch
105401 N/A  14  53                     SunOS 5.6: libnsl and NIS+ commands patch
105562 N/A  03  58                     SunOS 5.6: chkey and keylogin patch
105667 N/A  01 211                     SunOS 5.6: /usr/bin/rdist patch
105736 N/A  01 170                     SunOS 5.6: /usr/lib/mail.local patch
105755 N/A  06  77                     SunOS 5.6: libresolv, in.named, named-xfer, nslookup, nstest patch
105800 N/A  02  59 106125-05           SunOS 5.6: /usr/bin/admintool patch y2000 patch
106049 N/A  01  91                     SunOS 5.6: /usr/sbin/in.telnetd patch
106235 N/A  01  50                     SunOS 5.6: lp patch
106301 N/A  01 115                     SunOS 5.6: /usr/sbin/in.ftpd patch
106448 N/A  01  45                     SunOS 5.6: /usr/sbin/ping patch
105837 N/A  02 156                     CDE 1.2: dtappgather Patch
106222 N/A  01 122                     OpenWindows 3.6: filemgr (ff.core) fixes
======================================================================================

UNINSTALLED Y2K PATCHES

NOTE: This list includes the Y2K patches that are also Recommended

Patch  Ins Lat Age  Require    Incomp  Synopsis
  ID   Rev Rev        ID         ID
------ --- --- --- --------- --------- -----------------------------------------
105800 N/A  02  59 106125-05           SunOS 5.6: /usr/bin/admintool patch y2000 patch
105464 N/A  01 311                     SunOS 5.6: multiple xterm fixes
======================================================================================

OTHER RELATED UNINSTALLED PATCHES

NOTE: This is determined by the packages that have been
      installed on the system.

      When one patch refers to multiple packages, we list the
      additional packages in the next lines.

      The various 'S','R','*' marks denote unbundled packages
      that is designated as an 'Security' or 'Recommended'.

         S = Security
         R = Recommened Unbundled
         * = Both Security and Recommended Unbundled

Patch    Package   Lat Age Synopsis
  ID     Name      Rev
------ - --------- --- --- ------------------------------------------------------------
105160   SUNWdtbas  05  67 CDE 1.2: dtterm libDtTerm.so.1 patch
105338   SUNWdtdst  11  66 CDE 1.2: dtmail patch
         SUNWdthev
         SUNWdtma
105361   SUNWxilvl  05  84 VIS/XIL 2.6: Graphics Patch
105364   SUNWsxow   01 157 Solaris 2.6: SX Graphics Patch
         SUNWsxxgl
105377   SUNWbcp    03 175 SunOS 5.6: BCP patch
105390   SUNWman    02 179 SunOS 5.6: SGML Manual Pages Patch
105400   SUNWplow1  02 203 SunOS 5.6: Greek keyboard layout incorrect on Sparc
         SUNWxwplt
105403   SUNWnisu   01 204 SunOS 5.6: /usr/lib/netsvc/yp/ypbind patch
105421   SUNWapppr  01 175 SunOS 5.6: /etc/init.d/asppp patch
105426   SUNWtnfc   01 260 SunOS 5.6: /usr/lib/libtnfprobe.so.1 patch
105486   SUNWcsr    04  38 SunOS 5.6: /kernel/fs/hsfs patch
105564   SUNWcsr    02 203 SunOS 5.6: /kernel/misc/rpcsec patch
105566   SUNWdtdmn  03  94 CDE 1.2: calendar manager patch
         SUNWdtdst
105568   SUNWcsu    08  94 SunOS 5.6: /usr/lib/libthread.so.1 patch
105570   SUNWrtvc   02  84 SunVideo 1.3: Patch
         SUNWrtvcl
105572   SUNWcsr    04  99 SunOS 5.6: /kernel/fs/ufs patch
105591   SUNWlibC   02  81 SunOS 5.6: Shared library patch for C++
105604   SUNWcar    05  92 SunOS 5.6: ebus/pci/rootnex driver patch
         SUNWcsr
         SUNWhea
105618   SUNWxwplt  01 284 OpenWindows 3.6: Xcms patch
105623   SUNWfns    01 225 SunOS 5.6: /usr/bin/fncreate_printer patch
105630   SUNWdtbas  01 275 CDE 1.2: libDtWidget patch
105633   SUNWxwcft  08  85 OpenWindows 3.6: Xsun patch
         SUNWxwfnt
         SUNWxwplt
         SUNWxwslb
105637   SUNWpmu    01 282 SunOS 5.6: /usr/lib/power/powerd patch
105651   SUNWcar    08  58 SunOS 5.6: ac/environ/fhc/sysctrl driver patch
         SUNWcsr
         SUNWhea
105654   SUNWcsr    03 210 SunOS 5.6: driver_aliases/driver_classes/name_to_major patch
105693   SUNWcsr    04  46 SunOS 5.6: /kernel/fs/cachefs patch
         SUNWcsu
105705   SUNWcsu    02 150 SunOS 5.6: /usr/kernel/drv/audiocs patch
         SUNWhea
105718   SUNWcsu    02 199 SunOS 5.6: /usr/bin/su patch
105722   SUNWcsu    01 248 SunOS 5.6: /usr/lib/fs/ufs/ufsdump patch
105724   SUNWcsu    01 248 SunOS 5.6: /usr/lib/fs/ufs/ufsrestore patch
105742   SUNWcsr    03 108 SunOS 5.6: /kernel/drv/le patch
105743   SUNWfns    01 227 SunOS 5.6: /usr/lib/libxfn.so.2 patch
105746   SUNWcsu    01 260 SunOS 5.6: /usr/bin/cpio patch
105757   SUNWcsu    01 253 SunOS 5.6: /usr/bin/echo patch
105778   SUNWcsr    01 203 SunOS 5.6: /kernel/fs/specfs patch
105780   SUNWcsr    01 203 SunOS 5.6: /kernel/fs/fifofs patch
105792   SUNWcsu    02 163 SunOS 5.6: /usr/sbin/tar patch
105795   SUNWhmd    03 126 SunOS 5.6: /kernel/drv/hme patch
         SUNWhmdu
105798   SUNWcpr    03 128 SunOS 5.6: sun4m, sun4u & sun4u1 cprboot patch
105802   SUNWtltk   03 126 OpenWindows 3.6: tooltalk patch
105836   SUNWcsr    02  92 SunOS 5.6: /kernel/drv/qe patch
105847   SUNWcsr    01 207 SunOS 5.6: /kernel/drv/st.conf patch
105867   SUNWcsu    01 199 SunOS 5.6: /usr/sbin/tapes patch
105874   SUNWadmc   01  92 SunOS 5.6: libspmisoft.so.1 patch for upgrade
105924   SUNWcsr    03  91 SunOS 5.6: devlink.tab/iu.ap/minor_perm & se driver patch
105953   SUNWcsu    01 205 SunOS 5.6: /usr/bin/xargs patch
105959   SUNWpppk   01 205 SunOS 5.6: /usr/kernel/strmod/ppp patch
105988   SUNWcsu    01 192 SunOS 5.6: /usr/sbin/rwall patch
105990   SUNWcsu    01 186 SunOS 5.6: vi/ex/edit/view/vedit patch
         SUNWxcu4
106017   SUNWcsr    01 198 SunOS 5.6: POINT PATCH: 4074114 - bugfix for /kernel/strmod/ms
106025   SUNWdtdst  01 186 CDE 1.2 sdtfprop: patch for group permissions
106027   SUNWdtwm   01 196 CDE 1.2 dtsession: patch for screenlock
106029   SUNWsprot  01 162 SunOS 5.6: /usr/ccs/bin/make patch
         SUNWxcu4t
106031   SUNWcar    02 182 SunOS 5.6: adb & kadb patch
         SUNWcsu
106035   SUNWcsu    01  91 SunOS 5.6: /usr/bin/getopt patch
106044   SUNWcsu    01 190 SunOS 5.6: /usr/lib/nss_nisplus.so.1 patch
106084   SUNWxildh  03 107 XIL 1.3: Graphics Patch
         SUNWxilrl
106112   SUNWdtdst  01 182 CDE 1.2: dtfile patch
106123   SUNWdoc    02 126 SunOS 5.6: sgml patch
106138   SUNWoldst  01  91 OpenWindows 3.6: mp fails to set correct A4 paper size information
106141   SUNWcsu    01 108 SunOS 5.6: /usr/bin/mkdir patch
106150   SUNWdhcsu  02  85 SunOS 5.6: in.dhcpd and pntadm patch
106168   SUNWcar    02  92 SunOS 5.6: dma driver patch
         SUNWcsr
106169   SUNWcar    02  92 SunOS 5.6: sbusmem driver patch
         SUNWcsr
106170   SUNWcsr    02 108 SunOS 5.6: /kernel/drv/esp patch
         SUNWhea
106171   SUNWcsr    01  92 SunOS 5.6: /kernel/drv/lebuffer patch
106172   SUNWhmd    02 108 SunOS 5.6: /kernel/drv/fas patch
106173   SUNWcsr    02 108 SunOS 5.6: /kernel/misc/scsi patch
106183   SUNWarc    03  92 SunOS 5.6: cfgadm utility & libraries
         SUNWcsu
         SUNWhea
         SUNWkvm
106193   SUNWadmap  01 154 SunOS 5.6: NIS locale ordering fails to be read by sysidnet
106216   SUNWcar    02  91 SunOS 5.6: /platform/sun4u/kernel/drv/envctrl patch
106219   SUNWman    02 107 SunOS 5.6: luxadm.1m Manual Page Patch
106267   SUNWdtim   02 101 CDE 1.2: sdtimage fixes
106285   SUNWcsr    01  85 SunOS 5.6: /kernel/sys/msgsys patch
106292   SUNWcsu    01 135 SunOS 5.6: pkgmk & pkginstall patch
106303   SUNWypu    01 108 SunOS 5.6: /usr/lib/netsvc/yp/rpc.yppasswdd patch
106317   SUNWadmc   01  91 SunOS 5.6: upgrade_script terminated abnormally during upgrade
106323   SUNWcsr    01  91 SunOS 5.6: /etc/inet/services patch
106331   SUNWolinc  03  93 OpenWindows 3.6: Xview Patch
         SUNWolrte
         SUNWolslb
106361   SUNWcsr    02  88 SunOS 5.6: csh/jsh/ksh/rksh/rsh/sh patch
         SUNWcsu
106388   SUNWcsu    01  78 SunOS 5.6: /usr/bin/localedef patch
106390   SUNWdial   01  88 BD graphics 2.6: Buttons/Dials Patch
         SUNWdialh
106394   SUNWxgldg  03  81 XGL 3.3: XGL Patch (unstripped version)
         SUNWxglrt
106395   SUNWxgldg  03  81 XGL 3.3: XGL Patch (stripped version)
         SUNWxglrt
106404   SUNWxwplt  01  87 OpenWindows 3.6: libXext patch
         SUNWxwslb
106415   SUNWxwopt  01  88 OpenWindows 3.6: w returns wrong login user number in xdm
106429   SUNWcsr    01  65 SunOS 5.6: /kernel/drv/mm patch
106435   SUNWpmu    01  50 SunOS 5.6: /usr/kernel/drv/pm patch
106437   SUNWdtdst  01  87 CDE 1.2: Print Manager Patch
106439   SUNWcsu    01  80 SunOS 5.6: /usr/sbin/syslogd patch
106466   SUNWcsu    01  58 SunOS 5.6: /usr/sbin/df & /usr/xpg4/bin/df patch
         SUNWxcu4
106471   SUNWatfsr  01  58 SunOS 5.6: /kernel/fs/autofs patch
         SUNWatfsu
         SUNWhea
106480   SUNWtltk   01  46 OpenWindows 3.6: ToolTalk patch
         SUNWtltkd
106495   SUNWesu    01  66 SunOS 5.6: truss & truss support library patch
         SUNWtoo
106497   SUNWman    01  53 SunOS 5.6: Manual Pages Patch for ldap
======================================================================================

