1 karl  1.2 //%2006////////////////////////////////////////////////////////////////////////
  2           //
  3           // Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development
  4           // Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems.
  5           // Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L.P.;
  6           // IBM Corp.; EMC Corporation, The Open Group.
  7           // Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.;
  8           // IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.
  9           // Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.;
 10           // EMC Corporation; VERITAS Software Corporation; The Open Group.
 11           // Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.;
 12           // EMC Corporation; Symantec Corporation; The Open Group.
 13           //
 14           // Permission is hereby granted, free of charge, to any person obtaining a copy
 15           // of this software and associated documentation files (the "Software"), to
 16           // deal in the Software without restriction, including without limitation the
 17           // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 18           // sell copies of the Software, and to permit persons to whom the Software is
 19           // furnished to do so, subject to the following conditions:
 20           // 
 21           // THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN
 22 karl  1.2 // ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED
 23           // "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
 24           // LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
 25           // PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 26           // HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 27           // ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 28           // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 29           //
 30           //==============================================================================

 31 jim.wunderlich 1.1     Binary Repository readme
 32                        ========================
 33                    
 34                        Filename:  readme.binary_repository
 35                        Authors:   Karl Schopmeyer, Jim Wunderlich, 
 36                        Date:      20 April 2005	
 37                    
 38                          PEP 164 added the capability to write and read a repository in
 39                          binary mode as opposed to XML. The binary repository is approximately
 40                          42% smaller than a regular xml text based repository. This allows
 41                          significant disk space savings and also results in shorter file 
 42                          load times. 
 43                    
 44                          The binary repository functionality supports both XML and binary 
 45                          objects concurrently within the same repository. That is it supports
 46                          mixed mode repositorys since the encoding and decoding is done on
 47                          a per object basis.
 48                    
 49                    
 50                        Building binary objects within the repository using Makefile (cimmofl)
 51                        ======================================================================
 52 jim.wunderlich 1.1 
 53                          The  REPOSITORY_MODE environement variable controls whether
 54                          new repository objects are written in XML or Binary mode by
 55                          the makefiles using cimmofl. It can be set to XML or BIN and 
 56                          defaults to XML.
 57                    
 58                    
 59                    	1. Set REPOSITORY_MODE to BIN
 60                    
 61                                     export PEGASUS_REPOSITORY_MODE=BIN	(Unix)
 62                    		 set PEGASUS_REPOSITORY_MODE=BIN        (Windows)
 63                     
 64                    
 65                    	2. Build the repository 
 66                    
 67                                    make repository
 68                    
 69                    
 70                    
 71                        Building binary objects within the repository using Maekfile (cimmof)
 72                        =====================================================================
 73 jim.wunderlich 1.1 
 74                          The enableBinaryRepository configuration variable controls
 75                          whether new repository objects are written in XML or Binary
 76                          mode when the server is running (cimmof).
 77                    
 78                    	1. Use the cimconfig utility to set the enableBinaryRepository
 79                               flag to true in the planed configuration file as follows.
 80                    
 81                                     cimconfig -ps enableBinaryRepository=true 
 82                    
 83                    	2. Start the cimserver
 84                    
 85                    		cimserver start
 86                    
 87                    	3. Build the repository 
 88                    
 89                                    make repositoryServer
 90                    
 91                    
 92                        Building binary objects within the repository using cimmofl
 93                        ===========================================================
 94 jim.wunderlich 1.1       The cimmofl command accepts a command line argument, 
 95                          REPOSITORY_MODE (-M), that controls whether new repository 
 96                          objects are written in XML (XML) or Binary (BIN) mode.
 97                    
 98                    	1. cimmofl -M BIN .......
 99                    
100                    
101                    
102                    ======================================================================
103                    
104                    For additional information refer to PEP16 and to the help information 
105                    available from the following commands.
106                    
107                    
108                    	cimmofl -h
109                    	cimconfig -h

110 karl           1.2