home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / lvmtlk12.zip / readme.1st < prev   
Text File  |  2002-06-02  |  7KB  |  155 lines
  1. ******************************************************************************
  2. * THE IBM LOGICAL VOLUME MANAGER PROGRAMMER'S TOOLKIT                        *
  3. ******************************************************************************
  4.  
  5. This package contains the programmer's toolkit and API documentation for
  6. the IBM OS/2 Logical Volume Manager.  The Logical Volume Manager (LVM) is a
  7. disk partition/volume management program which replaces the old 'FDISK'
  8. utility.
  9.  
  10. This version of LVM is included in the following operating systems:
  11.   * OS/2 Warp Server for e-business
  12.   * Convenience Package (1 and 2) for OS/2 Warp Version 4
  13.   * Convenience Package (1 and 2)for OS/2 Warp Server for e-business
  14.   * eComStation
  15.  
  16. LVM has a great many features which set it above FDISK, including:
  17.   * 'Sticky' drive letters which may be arbitrarily assigned (i.e., not
  18.     dependent on disk geometry)
  19.   * Enables enhanced file system support (such as JFS)
  20.   * Allows repartitioning without rebooting
  21.   * Volume 'spanning' (combining several partitions into a single
  22.     logical volume, even across multiple hard disks)
  23.   * Dynamic volume expansion (when using the JFS file system)
  24.   * Support for long volume names (e.g. on the Boot Manager menu)
  25.  
  26. All of LVM's functionality (the 'LVM Engine') is contained in a system DLL
  27. (LVM.DLL) which may be called directly by application programmers.  This
  28. toolkit and documentation provide programmers with the necessary information
  29. for doing so.
  30.  
  31.  
  32. ARCHIVE CONTENTS
  33. ----------------
  34.  
  35.   README.1ST : This file.
  36.   LICENSE    : A copy of the GNU General Public License.
  37.   JMA_TK.TXT : The original readme file written by John Martin Alfreddson,
  38.                who first compiled LVM.LIB.
  39.  
  40.   'doc' directory:
  41.  
  42.       This directory contains the API documentation, in IBM INF format.
  43.  
  44.       LVMAPI1.INF : Documentation for 'lvm_intr.h' (LVM Interface).
  45.       LVMAPI2.INF : Documentation for 'lvm_cons.h' (LVM Constants).
  46.       LVMAPI3.INF : Documentation for 'lvm_gbls.h' (LVM Global Definitions).
  47.       LVMAPI4.INF : Documentation for 'lvm_type.h' (LVM Internal Types).
  48.  
  49.       (Each of these books contains increasingly more esoteric information.  Most
  50.       people will never even need to look at the contents of the fourth book.)
  51.  
  52.   'include' directory:
  53.  
  54.       This directory contains the header files required for using the toolkit.
  55.  
  56.       lvm_intr.h : Main LVM header file (must be included in applications).
  57.       lvm_cons.h : Additional header file (included by lvm_intr.h).
  58.       lvm_type.h : Additional header file (included by lvm_intr.h).
  59.       lvm_list.h : Additional header file (included by lvm_intr.h).
  60.       lvm_gbls.h : Additional header file (included by lvm_intr.h).
  61.  
  62.   'lib' directory:
  63.  
  64.       This directory contains the import library required for using the toolkit.
  65.  
  66.       LVM.LIB : Import library for linking with compiled programs.
  67.  
  68.   'samples' directory:
  69.  
  70.       This directory contains two sample programs, with source code.
  71.  
  72.       lvmtest.cmd  : Batch file for compiling lvmtest.cpp.
  73.       lvmtest.cpp  : Source code for LVMTEST, a simple sample program.
  74.       Makefile     : 'Make' file for querylvm.cpp.
  75.       querylvm.cpp : Source code for QUERYLVM, a more extensive sample program.
  76.       readme.txt   : Notes on the sample programs.
  77.  
  78.   'src' directory:
  79.  
  80.       This directory contains the source code for the compiled toolkit and
  81.       documentation files (a GPL requirement).
  82.  
  83.       ipfsrc.zip : IPF source code for the INF documents under 'doc'.
  84.       lvmtk.def  : Definition-file source code for LVM.LIB (under 'lib').
  85.  
  86.  
  87. INSTALLATION
  88. ------------
  89.  
  90. Copy the contents of 'lib' to a directory on your compiler's library path
  91. (the %LIB% path for the IBM C/C++ Compilers).
  92.  
  93. Copy the contents of 'include' to a directory on your compiler's include
  94. path (the %INCLUDE% path for the IBM C/C++ Compilers).
  95.  
  96. Copy the contents of 'doc' to a directory on your BOOKSHELF path.
  97.  
  98. Create a program object for the LVM API Documentation which calls VIEW.EXE
  99. (or your favourite alternate help-file viewer) with the parameter:
  100.  
  101.     LVMAPI1.INF+LVMAPI2.INF+LVMAPI3.INF+LVMAPI4.INF
  102.  
  103. Place the samples and the other files in this package wherever you please.
  104.  
  105.  
  106.  
  107. ACKNOWLEDGEMENTS
  108. ----------------
  109.  
  110. The toolkit and documentation are derived from the 'Reference OS/2 Code' located
  111. in the CVS repository of the IBM Enterprise Volume Management System (EVMS) open
  112. source project.  They are licensed under the GNU GPL.
  113.  
  114. Whether or not programs written using this toolkit must also be licensed under
  115. GPL is uncertain.  Several people have told me that header files are considered
  116. information and not code, thus programs written using them need not be GPL'd.
  117. However, if you want to be legally safe, you might want to double-check with the
  118. Free Software Foundation (http://www.gnu.org) before writing non-Free programs
  119. using this toolkit.
  120.  
  121. LVM.LIB and the LVMTEST sample program were originally created and distributed
  122. by John Martin Alfreddson.
  123.  
  124. The API documentation and the QUERYLVM sample program were created by Alex
  125. Taylor.
  126.  
  127. The toolkit header files were written by IBM.  They have been modifed slightly
  128. (a few commas and one C++ comment marker were removed from lvm_list.h and
  129. lvm_type.h) by Alex Taylor in order to fix some errors with certain compilers.
  130.  
  131.  
  132. ******************************************************************************
  133. * NOTE                                                                       *
  134. *                                                                            *
  135. * There is a distinction made between LVM Version 1 and LVM Version 2.  As   *
  136. * far as I can tell, all existing versions of LVM for OS/2 (including WSeB   *
  137. * and eComStation) are Version 1.                                            *
  138. *                                                                            *
  139. * However, the reference code published on the EVMS repository (from which   *
  140. * all this documentation is derived) seems to be for LVM Version 2.          *
  141. *                                                                            *
  142. * Some of the features described in the API documentation are specific to    *
  143. * Version 2, and are therefore unusable on OS/2 systems (at least until such *
  144. * a day as LVM Version 2 is released).                                       *
  145. *                                                                            *
  146. * For more information, see LVMAPI1.INF.                                     *
  147. *                                                                            *
  148. ******************************************************************************
  149.  
  150. --
  151. Alex Taylor
  152. http://www.cs-club.org/~alex
  153. June 2 2002
  154.  
  155.