1------------------------------ 2shFlags.sh 1.0.0 Release Notes 3------------------------------ 4 5Preface 6------- 7Copyright 2008 Kate Ward. All Rights Reserved. 8Released under the LGPL (GNU Lesser General Public License) 9 10Author: Kate Ward (kate.ward@forestent.com) 11 12This document covers any known issues and workarounds for the stated release of 13shFlags. 14 15General info 16------------ 17 18This is the first official release of shFlags. The project is modeled after the 19gflags code released by Google on http://code.google.com/p/google-gflags/. Many 20thanks for the code they have provided. 21 22As this is the first release, there are bound to be issues. Feel free 23 24Disclamer 25--------- 26 27The unit tests 28-------------- 29 30shFlags is designed to work on as many environments as possible, but not all 31environments are created equal. As such, not all of the unit tests will succeed 32on every platform. The unit tests are therefore designed to fail, indicating to 33the tester that the supported functionality is not present, but an additional 34test is present to verify that shFlags properly caught the limitation and 35presented the user with an appropriate error message. 36 37shFlags tries to support both the standard and enhanced versions of ``getopt``. 38As each responds differently, and not everything is supported on the standard 39version, some unit tests will be skipped (i.e. ASSERTS will not be thrown) when 40the standard version of ``getopt`` is detected. The reason being that there is 41no point testing for functionality that is positively known not to exist. A 42tally of skipped tests will be kept for later reference. 43 44Standard vs Enhanced getopt 45--------------------------- 46 47Here is a matrix of the supported features of the various getopt variants. 48 49+-------------------------+---+---+ 50|Feature |std|enh| 51+=========================+===+===+ 52|short option names | Y | Y | 53|long option names | N | Y | 54|spaces in string options | N | Y | 55+-------------------------+---+---+ 56 57Known Issues 58------------ 59 60The getopt version provided by default with all versions of Solaris (up to and 61including Solaris 10) is the standard version. As such, only short flags are 62supported. 63 64The getopt version provided by default with all versions of Mac OS X (up to and 65including 10.5) is the standard version. As such, only short flags are 66supported. 67 68Workarounds 69----------- 70 71The zsh shell requires the 'shwordsplit' option to be set, and the special 72FLAGS_PARENT variable must be defined. 73