and now copy is working

This commit is contained in:
Mario Fetka 2013-03-04 16:31:50 +01:00
parent 63bef213ca
commit 5ba5a2e54e
23 changed files with 328 additions and 3836 deletions

View File

@ -20,6 +20,7 @@ die()
BASE_DIR="`dirname $0`/.." BASE_DIR="`dirname $0`/.."
LIB_DIR="${BASE_DIR}/lib" LIB_DIR="${BASE_DIR}/lib"
OPSI_WEB_ROOT=""
# load libraries # load libraries
. ${LIB_DIR}/shflags || die 'unable to load shflags library' . ${LIB_DIR}/shflags || die 'unable to load shflags library'
@ -32,28 +33,35 @@ test -f $HOME/.opsi-administration.cfg && . $HOME/.opsi-administration.cfg
# define flags # define flags
DEFINE_string 'name' '' 'the name of the package' 'n' DEFINE_string 'name' '' 'the name of the package' 'n'
DEFINE_string 'version' 'latest' 'the version of the package' 'v' DEFINE_string 'version' '' 'the version of the package' 'v'
DEFINE_string 'type' 'public' 'type of package' 'y' DEFINE_string 'type' '' 'type of package' 'y'
DEFINE_string 'from' '' 'source level of package' 'f' DEFINE_string 'from' '' 'source level of package' 'f'
DEFINE_string 'to' '' 'output file to write to' 't' DEFINE_string 'to' '' 'output file to write to' 't'
DEFINE_string 'root' '' 'output file to write to' 'r' DEFINE_string 'root' '' 'output file to write to' 'r'
DEFINE_string 'show' 'integration' 'show a list of the' 's' DEFINE_string 'show' '' 'show a list of the' 's'
DEFINE_boolean 'delete' true 'delete old versions of the package' 'd' DEFINE_string 'delete' '' 'delete specific versions of the package' 'd'
DEFINE_boolean 'purge' false 'delete old versions of the package' 'p'
FLAGS_HELP="USAGE: ${ARGV0} [flags]" FLAGS_HELP="USAGE: ${ARGV0} [flags]"
#if [ `which 7z` ] || exit #if [ `which 7z` ] || exit
show() go_show()
{ {
local show_dir=$1 local opsi_dir=$1
local show_name=$2 local show_name=$2
local show_type=$3
local show_from=$4
local show_to=$5
local show_version=""
local show_dir="/${opsi_dir}/${show_type}/${show_from}/"
# Find all revision files and sort them # Find all revision files and sort them
local file_list=`mktemp /tmp/opsi-administration.show.XXXXXXXXXXX` local file_list=`mktemp /tmp/opsi-administration.show.XXXXXXXXXXX`
local file_list_version=`mktemp /tmp/opsi-administration.show.version.XXXXXXXXXXX` local file_list_version=`mktemp /tmp/opsi-administration.show.version.XXXXXXXXXXX`
local file_list_release=`mktemp /tmp/opsi-administration.show.release.XXXXXXXXXXX` local file_list_release=`mktemp /tmp/opsi-administration.show.release.XXXXXXXXXXX`
local file_list_final=`mktemp /tmp/opsi-administration.show.final.XXXXXXXXXXX` local file_list_final=`mktemp /tmp/opsi-administration.show.final.XXXXXXXXXXX`
local show_list=`mktemp /tmp/opsi-administration.show.list.XXXXXXXXXXX` local show_list=`mktemp /tmp/opsi-administration.show.list.XXXXXXXXXXX`
echo ""
echo "Web Root: ${show_dir} Package Name: ${show_name}" >> $show_list echo "Web Root: ${show_dir} Package Name: ${show_name}" >> $show_list
echo "" >> $show_list echo "" >> $show_list
for cfg_file in `find ${show_dir} -name "${show_name}-*.cfg" -print ` ; do for cfg_file in `find ${show_dir} -name "${show_name}-*.cfg" -print ` ; do
@ -71,8 +79,15 @@ show()
for release_file_list in `cat ${file_list_final}` ; do for release_file_list in `cat ${file_list_final}` ; do
. ${show_dir}/${show_name}-${release_file_list}.cfg . ${show_dir}/${show_name}-${release_file_list}.cfg
echo $REV_PN-$REV_VERSION-$REV_CREATOR_TAG$REV_RELEASE >> $show_list echo $REV_PN-$REV_VERSION-$REV_CREATOR_TAG$REV_RELEASE >> $show_list
show_version=$REV_VERSION-$REV_CREATOR_TAG$REV_RELEASE
done done
if [ -n "${show_version}" ];then
echo "./${ARGV0} --root ${OPSI_ROOT} --name ${show_name} --type ${show_type} --from ${show_from} --to ${show_to} --version ${show_version} " >> $show_list
else
echo "no package named ${show_name}-* in this dir ${show_dir}" >> $show_list
fi
boxes -d shell $show_list boxes -d shell $show_list
echo ""
rm -f ${show_list} rm -f ${show_list}
rm -f ${file_list} rm -f ${file_list}
@ -81,29 +96,126 @@ show()
rm -f ${file_list_release} rm -f ${file_list_release}
} }
go_copy()
{
local opsi_dir=$1
local copy_name=$2
local copy_type=$3
local copy_from=$4
local copy_to=$5
local copy_version=$6
local copy_from_dir="/${opsi_dir}/${copy_type}/${copy_from}/"
local copy_to_dir="/${opsi_dir}/${copy_type}/${copy_to}/"
local copy_list=`mktemp /tmp/opsi-administration.copy.list.XXXXXXXXXXX`
echo ""
echo "Web Root Source: ${copy_from_dir} Web Root Destination: ${copy_to_dir}" >> $copy_list
echo "Package Name: ${copy_name}" >> $copy_list
echo "" >> $copy_list
if [ ${FLAGS_purge} -eq ${FLAGS_TRUE} ]; then
rm -f ${copy_to_dir}/${copy_name}-* &>> $copy_list
fi
ln -vf ${copy_from_dir}/${copy_name}{-,_}${copy_version}{.,-}* ${copy_to_dir}/ &>> $copy_list
boxes -d shell $copy_list
echo ""
}
main() main()
{ {
if [ -n "${FLAGS_root:-}" ];then
OPSI_WEB_ROOT=${FLAGS_root:}
fi
# determine package dir
local show_dir="${OPSI_WEB_ROOT}/${FLAGS_type:+${FLAGS_type}/}${FLAGS_show:+${FLAGS_show}/}"
# checks # checks
# check if a config file is present or the --root flag has been added
if [ -n "${OPSI_WEB_ROOT}" ];then
OPSI_ROOT="${OPSI_WEB_ROOT}"
else
if [ -n "${FLAGS_root}" ];then
OPSI_ROOT=${FLAGS_root}
else
die 'root flag or config file mising'
fi
fi
# the name falg is always needed
[ -n "${FLAGS_name:-}" ] || die 'name flag missing' [ -n "${FLAGS_name:-}" ] || die 'name flag missing'
if [ -z "${FLAGS_from:-}" ]; then # check if the type is correctly set
if [ -z "${FLAGS_from:-}" ]; then if [ -n "${FLAGS_type}" ] ; then
show $show_dir ${FLAGS_name:-} case "${FLAGS_type}" in
fi
elif [ -z "${FLAGS_show:-}" ]; then public)
show $show_dir ${FLAGS_name:-} ;;
restricted)
;;
*) die "type is only public or restricted"
;;
esac
fi fi
# check if the show is correctly set
if [ -n "${FLAGS_show}" ] ; then
case "${FLAGS_show}" in
integration)
;;
testing)
;;
release)
;;
*) die "show is onyl integration testing or release"
;;
esac
fi
# check if the from is correctly set
if [ -n "${FLAGS_from}" ] ; then
case "${FLAGS_from}" in
integration)
;;
testing)
;;
release)
;;
*) die "from is onyl integration testing or release"
;;
esac
fi
# check if the to is correctly set
if [ -n "${FLAGS_to}" ] ; then
case "${FLAGS_to}" in
integration)
;;
testing)
;;
release)
;;
*) die "to is onyl integration testing or release"
;;
esac
fi
# set some local vars
local show_from=""
local show_to=""
if [ -z "${FLAGS_from}" ] && [ -z "${FLAGS_to}" ] && [ -z "${FLAGS_type}" ] ; then
go_show ${OPSI_ROOT} ${FLAGS_name:-} "public" "integration" "testing"
elif [ -n "${FLAGS_show}" ] && [ -n "${FLAGS_type}" ] ; then
case "${FLAGS_show}" in
integration)
show_from="integration"
show_to="testing"
;;
testing)
show_from="testing"
show_to="release"
;;
esac
go_show ${OPSI_ROOT} ${FLAGS_name:-} ${FLAGS_type:-} ${show_from} ${show_to}
elif [ -z "${FLAGS_show}" ] && [ -n "${FLAGS_type}" ] && [ -n "${FLAGS_from}" ] && [ -n "${FLAGS_to}" ] && [ -n "${FLAGS_version}" ]; then
go_copy ${OPSI_ROOT} ${FLAGS_name:-} ${FLAGS_type:-} ${FLAGS_from:-} ${FLAGS_to:-} ${FLAGS_version:-} ${FLAGS_purge}
fi
# if [ ${FLAGS_dry_run} -eq ${FLAGS_FALSE} -a -f "${output}" ]; then # if [ ${FLAGS_dry_run} -eq ${FLAGS_FALSE} -a -f "${output}" ]; then
# if [ ${FLAGS_force} -eq ${FLAGS_TRUE} ]; then # if [ ${FLAGS_force} -eq ${FLAGS_TRUE} ]; then

View File

@ -1 +0,0 @@
12

View File

@ -1 +0,0 @@
12

View File

@ -1,78 +0,0 @@
------------------------------
shFlags.sh 1.0.1 Release Notes
------------------------------
Preface
-------
Copyright 2008 Kate Ward. All Rights Reserved.
Released under the LGPL (GNU Lesser General Public License)
Author: Kate Ward (kate.ward@forestent.com)
This document covers any known issues and workarounds for the stated release of
shFlags.
General info
------------
This is both a minor bug fix release, and a minor new feature release of
shFlags. It adds several warning messages, fixes three issues, and now displays
the default value behind the help string when help is requested. Additionally,
the coding standards have been modified slightly and officially documented.
They were taken from the standards used by shUnit2 (the unit testing framework
used for the unit testing).
Please see the CHANGES-1.0.txt file for a complete list of changes.
The unit tests
--------------
shFlags is designed to work on as many environments as possible, but not all
environments are created equal. As such, not all of the unit tests will succeed
on every platform. The unit tests are therefore designed to fail, indicating to
the tester that the supported functionality is not present, but an additional
test is present to verify that shFlags properly caught the limitation and
presented the user with an appropriate error message.
shFlags tries to support both the standard and enhanced versions of **getopt**.
As each responds differently, and not everything is supported on the standard
version, some unit tests will be skipped (i.e. ASSERTS will not be thrown) when
the standard version of **getopt** is detected. The reason being that there is
no point testing for functionality that is positively known not to exist. A
tally of skipped tests will be kept for later reference.
To see the test results for the various OSes tested, please visit
http://forestent.com/projects/shflags/testresults/.
Standard vs Enhanced getopt
---------------------------
Here is a matrix of the supported features of the various **getopt** variants.
+-------------------------+---+---+
|Feature |std|enh|
+=========================+===+===+
|short option names | Y | Y |
|long option names | N | Y |
|spaces in string options | N | Y |
+-------------------------+---+---+
Known Issues
------------
The **getopt** version provided by default with all versions of Mac OS X (up to
and including 10.5.5) is the standard version. As such, only short flags are
supported.
The **getopt** version provided by default with all versions of Solaris (up to
and including Solaris 10 and OpenSolaris) is the standard version. As such,
only short flags are supported.
Workarounds
-----------
The Zsh shell requires the ``shwordsplit`` option to be set, and the special
``FLAGS_PARENT`` variable must be defined.
.. vim:fileencoding=latin1:ft=rst:spell:tw=80

View File

@ -1,10 +0,0 @@
improve zsh, automatically ... (pulled from configure)
if test -n "${ZSH_VERSION+set}" && (emulate sh) >/dev/null 2>&1; then
emulate sh
NULLCMD=:
# Zsh 3.x and 4.x performs word splitting on ${1+"$@"}, which
# is contrary to our usage. Disable this feature.
alias -g '${1+"$@"}'='"$@"'
setopt NO_GLOB_SUBST
else

View File

@ -1,111 +0,0 @@
Coding Standards
================
shFlags is more than just a simple 20 line shell script. It is a pretty
significant library of shell code that at first glance is not that easy to
understand. To improve code readability and usability, some guidelines have
been set down to make the code more understandable for anyone who wants to read
or modify it.
Function Documentation
----------------------
Each function should be preceded by a header that provides the following:
#. A one-sentence summary of what the function does
#. (optional) A longer description of what the function does, and perhaps some
special information that helps convey its usage better.
#. Args: a one-line summary of each argument of the form:
``name: type: description``
#. Output: a one-line summary of the output provided. Only output to STDOUT
must be documented, unless the output to STDERR is of significance (i.e. not
just an error message). The output should be of the form:
``type: description``
#. Returns: a one-line summary of the value returned. Returns in shell are
always integers, but if the output is a true/false for success (i.e. a
boolean), it should be noted. The output should be of the form:
``type: description``
Here is a sample header: ::
# Return valid getopt options using currently defined list of long options.
#
# This function builds a proper getopt option string for short (and long)
# options, using the current list of long options for reference.
#
# Args:
# _flags_optStr: integer: option string type (__FLAGS_OPTSTR_*)
# Output:
# string: generated option string for getopt
# Returns:
# boolean: success of operation (always returns True)
Variable and Function Names
---------------------------
All shFlags specific constants, variables, and functions will be prefixed
appropriately with 'flags'. This is to distinguish usage in the shFlags code
from users own scripts so that the shell name space remains predictable to
users. The exceptions here are the standard ``assertEquals``, etc. functions.
All non built-in constants and variables will be surrouned with squiggle
brackets, e.g. '${flags_someVariable}' to improve code readability.
Due to some shells not supporting local variables in functions, care in the
naming and use of variables, both public and private, is very important.
Accidental overriding of the variables can occur easily if care is not taken as
all variables are technically global variables in some shells.
================================ ========================
**type** **sample**
global public constant ``FLAGS_TRUE``
global private constant ``__FLAGS_SHELL_FLAGS``
global public variable not used
global private variable ``__flags_someVariable``
global macro ``_FLAGS_SOME_MACRO_``
public function ``assertEquals``
public function, local variable ``flags_someVariable_``
private function ``_flags_someFunction``
private function, local variable ``_flags_someVariable_``
================================ ========================
Where it makes sense, variables can have the first letter of the second and
later words capitalized. For example, the local variable name for the total
number of test cases seen might be ``flags_totalTestsSeen_``.
Local Variable Cleanup
----------------------
As many shells do not support local variables, no support for cleanup of
variables is present either. As such, all variables local to a function must be
cleared up with the ``unset`` command at the end of each function.
Indentation
-----------
Code block indentation is two (2) spaces, and tabs may not be used. ::
if [ -z 'some string' ]; then
someFunction
fi
Lines of code should be no longer than 80 characters unless absolutely
necessary. When lines are wrapped using the backslash character '\', subsequent
lines should be indented with four (4) spaces so as to differentiate from the
standard spacing of two characters, and tabs may not be used. ::
for x in some set of very long set of arguments that make for a very long \
that extends much too long for one line
do
echo ${x}
done
When a conditional expression is written using the builtin [ command, and that
line must be wrapped, place the control || or && operators on the same line as
the expression where possible, with the list to be executed on its own line. ::
[ -n 'some really long expression' -a -n 'some other long expr' ] && \
echo 'that was actually true!'
.. vim:spell
.. $Id$

View File

@ -1,132 +0,0 @@
Changes in shFlags 1.0.x
========================
Changes with 1.0.4
------------------
Fixed issue #10. Usage of ``expr`` under FreeBSD 7.2 (FreeNAS 0.7.1) and FreeBSD
8.0 that was causing many unit tests to fail.
Fixed issue where booleans were sometimes mis-configured to require additional
values like other flags.
Changed _flags_fatal() to exit with FLAGS_ERROR immediately.
Fixed issue #11. When help is requested, the help flag is no longer prefixed
with [no].
Upgraded shUnit2 to 2.1.6.
Fixed issue #12. Requesting help shouldn't be considered an error.
Added the ability to override the use of the OS default 'getopt' command by
defining the FLAGS_GETOPT_CMD variable.
Updated gen_test_results.sh and versions from shUnit2 source.
Fixed issues# 13, 14. Added support for dashes ('-') in long flag names. The
defined flag will still be declared with underscores ('_') due to shell
limitations, so only one of a dashed flag name or an underscored flag name are
allowed, not both.
Changes with 1.0.3
------------------
MAJOR CHANGE! ``FLAGS_ARGC`` is now obsolete, and is replaced by
``FLAGS_ARGV``. See below for more info.
Fixed issue# 7 where long flags defined with '=' (e.g. --abc=123) made it
impossible for the user to know how many non-flag command-line arguments were
available because the value returned by ``FLAGS_ARGC`` was wrong. The
``FLAGS_ARGC`` value is now obsolete, but will be maintained for backwards
compatibility. The new method of getting the non-flag arguments is by executing
``eval set -- "${FLAGS_ARGV}"`` after the **FLAGS** call. The arguments will
then be available using the standard shell $#, $@, $*, $1, etc. variables.
Due to above fix for issue# 7, there is now proper support for mixing flags
with non-flag arguments on the command-line. Previously, all non-flag arguments
had to be at the end of the command-line.
Renamed ``_flags_standardGetopt()`` and ``_flags_enhancedGetopt()`` functions to
``_flags_getoptStandard()`` and ``_flags_getoptEnhanced()``.
Took out the setting and restoration of the '-u' shell flag to treat unset
variables as an error. No point in having it in this library as it is verified
in the unit tests, and provides basically no benefit.
Fixed bug under Solaris where the generated help was adding extra 'x'
characters.
Added checks for reserved flag variables (e.g. FLAGS_TRUE).
Fixed some unset variable bugs.
Now report the actual getopt error if there is one.
All tests now properly enable skipping based on whether a standard or enhanced
getopt is found.
Added the OS version to OS release for Solaris.
Fixed flags_reset() so it unsets the default value environment vars.
Changes with 1.0.2
------------------
FLAGS_PARENT no longer transforms into a constant so that it can be defined at
run time in scripts.
Added warning about short flags being unsupported when there are problems
parsing the options with **getopt**.
Add default values to end of description strings.
Fixed bug that returned an error instead of success when recalling the default
values for empty strings.
Added warning when a duplicate flag definition is attempted.
Improved ``assert[Warn|Error]Msg()`` test helper grepping.
Replaced shell_versions.sh with a new versions library and created
**gen_test_results.sh** to make releases easier.
Copied the coding standards from shUnit2, but haven't fully implemented them
in shFlags yet.
Issue# 1: When a user defines their own --help flag, no more warning is thrown
when FLAGS() is called stating that the help flag already defined.
Issue# 2: Passing the --nohelp option no longer gives help output.
Issue# 3: Added support for screen width detection.
Changes with 1.0.1
------------------
Fixed bug where the help output added [no] to all flag names
Added additional example files that are referenced by the documentation.
Improved zsh version and option checking.
Upgraded shUnit2 to 2.1.4
Added unit testing for the help output.
When including a library (e.g. shflags) in a script, zsh 3.0.8 doesn't actually
execute the code in-line, but later. As such, variables that are defined in the
library cannot be used until functions are called from the main code. This
required the 'help' flag definition to be moved inside the FLAGS command.
Changes with 1.0.0
------------------
This is the first official release, so everything is new.
.. vim:fileencoding=latin1:ft=rst:spell:tw=80
.. $Id$

View File

@ -1,72 +0,0 @@
------------------------------
shFlags.sh 1.0.1 Release Notes
------------------------------
Preface
-------
Copyright 2008 Kate Ward. All Rights Reserved.
Released under the LGPL (GNU Lesser General Public License)
Author: Kate Ward (kate.ward@forestent.com)
This document covers any known issues and workarounds for the stated release of
shFlags.
General info
------------
This is a minor bugfix release of shFlags. It mainly fixes poor output of the
automated help system, but it also includes a couple more examples that are
referenced by the documentation.
Please see the CHANGES-1.0.txt file for a complete list of changes.
Disclamer
---------
The unit tests
--------------
shFlags is designed to work on as many environments as possible, but not all
environments are created equal. As such, not all of the unit tests will succeed
on every platform. The unit tests are therefore designed to fail, indicating to
the tester that the supported functionality is not present, but an additional
test is present to verify that shFlags properly caught the limitation and
presented the user with an appropriate error message.
shFlags tries to support both the standard and enhanced versions of ``getopt``.
As each responds differently, and not everything is supported on the standard
version, some unit tests will be skipped (i.e. ASSERTS will not be thrown) when
the standard version of ``getopt`` is detected. The reason being that there is
no point testing for functionality that is positively known not to exist. A
tally of skipped tests will be kept for later reference.
Standard vs Enhanced getopt
---------------------------
Here is a matrix of the supported features of the various getopt variants.
+-------------------------+---+---+
|Feature |std|enh|
+=========================+===+===+
|short option names | Y | Y |
|long option names | N | Y |
|spaces in string options | N | Y |
+-------------------------+---+---+
Known Issues
------------
The getopt version provided by default with all versions of Mac OS X (up to and
including 10.5) is the standard version. As such, only short flags are
supported.
The getopt version provided by default with all versions of Solaris (up to and
including Solaris 10) is the standard version. As such, only short flags are
supported.
Workarounds
-----------
The zsh shell requires the 'shwordsplit' option to be set, and the special
FLAGS_PARENT variable must be defined.

View File

@ -1,81 +0,0 @@
------------------------------
shFlags.sh 1.0.4 Release Notes
------------------------------
Preface
=======
Copyright 2008-2009 Kate Ward. All Rights Reserved.
Released under the LGPL (GNU Lesser General Public License)
Author: kate.ward@forestent.com (Kate Ward)
This document covers any known issues and workarounds for the stated release of
shFlags.
Release info
============
This is a minor bug fix release.
Please see the CHANGES-1.0.txt file for a complete list of changes.
Major changes
-------------
Obsolete items
--------------
Bug fixes
---------
Issue #10 - Changed the internal usage of the ``expn`` command to fix issues
under FreeBSD.
General info
============
The unit tests
--------------
shFlags is designed to work on as many environments as possible, but not all
environments are created equal. As such, not all of the unit tests will succeed
on every platform. The unit tests are therefore designed to fail, indicating to
the tester that the supported functionality is not present, but an additional
test is present to verify that shFlags properly caught the limitation and
presented the user with an appropriate error message.
shFlags tries to support both the standard and enhanced versions of ``getopt``.
As each responds differently, and not everything is supported on the standard
version, some unit tests will be skipped (i.e. ASSERTS will not be thrown) when
the standard version of ``getopt`` is detected. The reason being that there is
no point testing for functionality that is positively known not to exist. A
tally of skipped tests will be kept for later reference.
Standard vs Enhanced getopt
---------------------------
Here is a matrix of the supported features of the various **getopt** variants.
+=========================================+=====+=====+
| Feature | std | enh |
+-----------------------------------------+-----+-----+
| short option names | Y | Y |
| long option names | N | Y |
| spaces in string options | N | Y |
| intermixing of flag and non-flag values | N | Y |
+=========================================+=====+=====+
Known Issues
------------
The **getopt** version provided by default with all versions of Mac OS X (up to
and including 10.5.6) and Solaris (up to and including Solaris 10 and
OpenSolaris) is the standard version.
Workarounds
-----------
The Zsh shell requires the ``shwordsplit`` option to be set and the special
``FLAGS_PARENT`` variable must be defined. See ``src/shflags_test_helpers`` to
see how the unit tests do this.
.. vim:fileencoding=latin1:ft=rst:spell:tw=80

View File

@ -1,292 +0,0 @@
/*
:Author: David Goodger
:Contact: goodger@users.sourceforge.net
:Date: $Date: 2007-04-11 11:48:16 +0100 (Wed, 11 Apr 2007) $
:Revision: $Revision: 2791 $
:Copyright: This stylesheet has been placed in the public domain.
:Modified by: Kate Ward <kate.ward@forestent.com>
Default cascading style sheet for the HTML output of Docutils.
See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/
/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
border: 0 }
table.borderless td, table.borderless th {
/* Override padding for "table.docutils td" with "! important".
The right padding separates the table cells. */
padding: 0 0.5em 0 0 ! important }
.first {
/* Override more specific margin styles with "! important". */
margin-top: 0 ! important }
.last, .with-subtitle {
margin-bottom: 0 ! important }
.hidden {
display: none }
a.toc-backref {
text-decoration: none ;
color: black }
blockquote.epigraph {
margin: 2em 5em ; }
dl.docutils dd {
margin-bottom: 0.5em }
/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
font-weight: bold }
*/
div.abstract {
margin: 2em 5em }
div.abstract p.topic-title {
font-weight: bold ;
text-align: center }
div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
margin: 2em ;
border: medium outset ;
padding: 1em }
div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
font-weight: bold ;
font-family: sans-serif }
div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title {
color: red ;
font-weight: bold ;
font-family: sans-serif }
/* Uncomment (and remove this text!) to get reduced vertical space in
compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
margin-bottom: 0.5em }
div.compound .compound-last, div.compound .compound-middle {
margin-top: 0.5em }
*/
div.dedication {
margin: 2em 5em ;
text-align: center ;
font-style: italic }
div.dedication p.topic-title {
font-weight: bold ;
font-style: normal }
div.figure {
margin-left: 2em ;
margin-right: 2em }
div.footer, div.header {
clear: both;
font-size: smaller }
div.line-block {
display: block ;
margin-top: 1em ;
margin-bottom: 1em }
div.line-block div.line-block {
margin-top: 0 ;
margin-bottom: 0 ;
margin-left: 1.5em }
div.sidebar {
margin-left: 1em ;
border: medium outset ;
padding: 1em ;
background-color: #ffffee ;
width: 40% ;
float: right ;
clear: right }
div.sidebar p.rubric {
font-family: sans-serif ;
font-size: medium }
div.system-messages {
margin: 5em }
div.system-messages h1 {
color: red }
div.system-message {
border: medium outset ;
padding: 1em }
div.system-message p.system-message-title {
color: red ;
font-weight: bold }
div.topic {
margin: 2em }
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
margin-top: 0.4em }
h1.title {
text-align: center }
h2.subtitle {
text-align: center }
hr.docutils {
width: 75% }
img.align-left {
clear: left }
img.align-right {
clear: right }
ol.simple, ul.simple {
margin-bottom: 1em }
ol.arabic {
list-style: decimal }
ol.loweralpha {
list-style: lower-alpha }
ol.upperalpha {
list-style: upper-alpha }
ol.lowerroman {
list-style: lower-roman }
ol.upperroman {
list-style: upper-roman }
p.attribution {
text-align: right ;
margin-left: 50% }
p.caption {
font-style: italic }
p.credits {
font-style: italic ;
font-size: smaller }
p.label {
white-space: nowrap }
p.rubric {
font-weight: bold ;
font-size: larger ;
color: maroon ;
text-align: center }
p.sidebar-title {
font-family: sans-serif ;
font-weight: bold ;
font-size: larger }
p.sidebar-subtitle {
font-family: sans-serif ;
font-weight: bold }
p.topic-title {
font-weight: bold }
pre.address {
margin-bottom: 0 ;
margin-top: 0 ;
font-family: serif ;
font-size: 100% }
pre.literal-block, pre.doctest-block {
margin-left: 2em ;
margin-right: 2em ;
background-color: #eeeeee }
span.classifier {
font-family: sans-serif ;
font-style: oblique }
span.classifier-delimiter {
font-family: sans-serif ;
font-weight: bold }
span.interpreted {
font-family: sans-serif }
span.option {
white-space: nowrap }
span.pre {
white-space: pre }
span.problematic {
color: red }
span.section-subtitle {
/* font-size relative to parent (h1..h6 element) */
font-size: 80% }
table.citation {
border-left: solid 1px gray;
margin-left: 1px }
table.docinfo {
margin: 2em 4em }
/*
table.docutils {
margin-top: 0.5em ;
margin-bottom: 0.5em }
*/
table.footnote {
border-left: solid 1px black;
margin-left: 1px ;
font-size: 80% }
}
table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
padding-left: 0.5em ;
padding-right: 0.5em ;
vertical-align: top }
table.docutils th.field-name, table.docinfo th.docinfo-name {
font-weight: bold ;
text-align: left ;
white-space: nowrap ;
padding-left: 0 }
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
font-size: 100% }
/*
tt.docutils {
background-color: #eeeeee }
*/
ul.auto-toc {
list-style-type: none }
/* customizations by kward */
h1 { font-size: 133%; border-top:1px solid #CCCCFF; }
h1.title { font-size: 150%; border-top:0px; padding-top: 1em; }
/* div.document { font-size: 90% } */

View File

@ -1,72 +0,0 @@
------------------------------
shFlags.sh 1.0.0 Release Notes
------------------------------
Preface
-------
Copyright 2008 Kate Ward. All Rights Reserved.
Released under the LGPL (GNU Lesser General Public License)
Author: Kate Ward (kate.ward@forestent.com)
This document covers any known issues and workarounds for the stated release of
shFlags.
General info
------------
This is the first official release of shFlags. The project is modeled after the
gflags code released by Google on http://code.google.com/p/google-gflags/. Many
thanks for the code they have provided.
As this is the first release, there are bound to be issues. Feel free
Disclamer
---------
The unit tests
--------------
shFlags is designed to work on as many environments as possible, but not all
environments are created equal. As such, not all of the unit tests will succeed
on every platform. The unit tests are therefore designed to fail, indicating to
the tester that the supported functionality is not present, but an additional
test is present to verify that shFlags properly caught the limitation and
presented the user with an appropriate error message.
shFlags tries to support both the standard and enhanced versions of ``getopt``.
As each responds differently, and not everything is supported on the standard
version, some unit tests will be skipped (i.e. ASSERTS will not be thrown) when
the standard version of ``getopt`` is detected. The reason being that there is
no point testing for functionality that is positively known not to exist. A
tally of skipped tests will be kept for later reference.
Standard vs Enhanced getopt
---------------------------
Here is a matrix of the supported features of the various getopt variants.
+-------------------------+---+---+
|Feature |std|enh|
+=========================+===+===+
|short option names | Y | Y |
|long option names | N | Y |
|spaces in string options | N | Y |
+-------------------------+---+---+
Known Issues
------------
The getopt version provided by default with all versions of Solaris (up to and
including Solaris 10) is the standard version. As such, only short flags are
supported.
The getopt version provided by default with all versions of Mac OS X (up to and
including 10.5) is the standard version. As such, only short flags are
supported.
Workarounds
-----------
The zsh shell requires the 'shwordsplit' option to be set, and the special
FLAGS_PARENT variable must be defined.

View File

@ -1,4 +0,0 @@
I'd like to thank these people for their contributisons to shFlags.
Maciej Bliziński <blizinski@google.com> -- _many_ code reviews
Bjarni Einarsson <bre@google.com> -- bug reports

View File

@ -1,94 +0,0 @@
------------------------------
shFlags.sh 1.0.3 Release Notes
------------------------------
Preface
=======
Copyright 2008-2009 Kate Ward. All Rights Reserved.
Released under the LGPL (GNU Lesser General Public License)
Author: kate.ward@forestent.com (Kate Ward)
This document covers any known issues and workarounds for the stated release of
shFlags.
Release info
============
This is a major bug fix release. The biggest fix is in how non-flag arguments are
made available to the script.
Major changes
-------------
The use of the ``FLAGS_ARGC`` variable is now obsolete. It will be maintained
for backwards compatibility with old scripts, but its value is known to be
wrong when flag and non-flag arguments are mixed together on the command-line.
To gain access to the non-flag arguments, replace the following snippet of code
in your scripts with the updated version.
old ::
shift ${FLAGS_ARGC}
new ::
eval set -- "${FLAGS_ARGV}"
Please see the CHANGES-1.0.txt file for a complete list of changes.
Obsolete items
--------------
Bug fixes
---------
Issue# 7 Flags set with '=' result in off-by-one shifting error
General info
============
The unit tests
--------------
shFlags is designed to work on as many environments as possible, but not all
environments are created equal. As such, not all of the unit tests will succeed
on every platform. The unit tests are therefore designed to fail, indicating to
the tester that the supported functionality is not present, but an additional
test is present to verify that shFlags properly caught the limitation and
presented the user with an appropriate error message.
shFlags tries to support both the standard and enhanced versions of ``getopt``.
As each responds differently, and not everything is supported on the standard
version, some unit tests will be skipped (i.e. ASSERTS will not be thrown) when
the standard version of ``getopt`` is detected. The reason being that there is
no point testing for functionality that is positively known not to exist. A
tally of skipped tests will be kept for later reference.
Standard vs Enhanced getopt
---------------------------
Here is a matrix of the supported features of the various **getopt** variants.
+=========================================+=====+=====+
| Feature | std | enh |
+-----------------------------------------+-----+-----+
| short option names | Y | Y |
| long option names | N | Y |
| spaces in string options | N | Y |
| intermixing of flag and non-flag values | N | Y |
+=========================================+=====+=====+
Known Issues
------------
The **getopt** version provided by default with all versions of Mac OS X (up to
and including 10.5.6) and Solaris (up to and including Solaris 10 and
OpenSolaris) is the standard version.
Workarounds
-----------
The Zsh shell requires the ``shwordsplit`` option to be set and the special
``FLAGS_PARENT`` variable must be defined. See ``src/shflags_test_helpers`` to
see how the unit tests do this.
.. vim:fileencoding=latin1:ft=rst:spell:tw=80

View File

@ -1,504 +0,0 @@
GNU LESSER GENERAL PUBLIC LICENSE
Version 2.1, February 1999
Copyright (C) 1991, 1999 Free Software Foundation, Inc.
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
[This is the first released version of the Lesser GPL. It also counts
as the successor of the GNU Library Public License, version 2, hence
the version number 2.1.]
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
Licenses are intended to guarantee your freedom to share and change
free software--to make sure the software is free for all its users.
This license, the Lesser General Public License, applies to some
specially designated software packages--typically libraries--of the
Free Software Foundation and other authors who decide to use it. You
can use it too, but we suggest you first think carefully about whether
this license or the ordinary General Public License is the better
strategy to use in any particular case, based on the explanations below.
When we speak of free software, we are referring to freedom of use,
not price. Our General Public Licenses are designed to make sure that
you have the freedom to distribute copies of free software (and charge
for this service if you wish); that you receive source code or can get
it if you want it; that you can change the software and use pieces of
it in new free programs; and that you are informed that you can do
these things.
To protect your rights, we need to make restrictions that forbid
distributors to deny you these rights or to ask you to surrender these
rights. These restrictions translate to certain responsibilities for
you if you distribute copies of the library or if you modify it.
For example, if you distribute copies of the library, whether gratis
or for a fee, you must give the recipients all the rights that we gave
you. You must make sure that they, too, receive or can get the source
code. If you link other code with the library, you must provide
complete object files to the recipients, so that they can relink them
with the library after making changes to the library and recompiling
it. And you must show them these terms so they know their rights.
We protect your rights with a two-step method: (1) we copyright the
library, and (2) we offer you this license, which gives you legal
permission to copy, distribute and/or modify the library.
To protect each distributor, we want to make it very clear that
there is no warranty for the free library. Also, if the library is
modified by someone else and passed on, the recipients should know
that what they have is not the original version, so that the original
author's reputation will not be affected by problems that might be
introduced by others.
Finally, software patents pose a constant threat to the existence of
any free program. We wish to make sure that a company cannot
effectively restrict the users of a free program by obtaining a
restrictive license from a patent holder. Therefore, we insist that
any patent license obtained for a version of the library must be
consistent with the full freedom of use specified in this license.
Most GNU software, including some libraries, is covered by the
ordinary GNU General Public License. This license, the GNU Lesser
General Public License, applies to certain designated libraries, and
is quite different from the ordinary General Public License. We use
this license for certain libraries in order to permit linking those
libraries into non-free programs.
When a program is linked with a library, whether statically or using
a shared library, the combination of the two is legally speaking a
combined work, a derivative of the original library. The ordinary
General Public License therefore permits such linking only if the
entire combination fits its criteria of freedom. The Lesser General
Public License permits more lax criteria for linking other code with
the library.
We call this license the "Lesser" General Public License because it
does Less to protect the user's freedom than the ordinary General
Public License. It also provides other free software developers Less
of an advantage over competing non-free programs. These disadvantages
are the reason we use the ordinary General Public License for many
libraries. However, the Lesser license provides advantages in certain
special circumstances.
For example, on rare occasions, there may be a special need to
encourage the widest possible use of a certain library, so that it becomes
a de-facto standard. To achieve this, non-free programs must be
allowed to use the library. A more frequent case is that a free
library does the same job as widely used non-free libraries. In this
case, there is little to gain by limiting the free library to free
software only, so we use the Lesser General Public License.
In other cases, permission to use a particular library in non-free
programs enables a greater number of people to use a large body of
free software. For example, permission to use the GNU C Library in
non-free programs enables many more people to use the whole GNU
operating system, as well as its variant, the GNU/Linux operating
system.
Although the Lesser General Public License is Less protective of the
users' freedom, it does ensure that the user of a program that is
linked with the Library has the freedom and the wherewithal to run
that program using a modified version of the Library.
The precise terms and conditions for copying, distribution and
modification follow. Pay close attention to the difference between a
"work based on the library" and a "work that uses the library". The
former contains code derived from the library, whereas the latter must
be combined with the library in order to run.
GNU LESSER GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License Agreement applies to any software library or other
program which contains a notice placed by the copyright holder or
other authorized party saying it may be distributed under the terms of
this Lesser General Public License (also called "this License").
Each licensee is addressed as "you".
A "library" means a collection of software functions and/or data
prepared so as to be conveniently linked with application programs
(which use some of those functions and data) to form executables.
The "Library", below, refers to any such software library or work
which has been distributed under these terms. A "work based on the
Library" means either the Library or any derivative work under
copyright law: that is to say, a work containing the Library or a
portion of it, either verbatim or with modifications and/or translated
straightforwardly into another language. (Hereinafter, translation is
included without limitation in the term "modification".)
"Source code" for a work means the preferred form of the work for
making modifications to it. For a library, complete source code means
all the source code for all modules it contains, plus any associated
interface definition files, plus the scripts used to control compilation
and installation of the library.
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running a program using the Library is not restricted, and output from
such a program is covered only if its contents constitute a work based
on the Library (independent of the use of the Library in a tool for
writing it). Whether that is true depends on what the Library does
and what the program that uses the Library does.
1. You may copy and distribute verbatim copies of the Library's
complete source code as you receive it, in any medium, provided that
you conspicuously and appropriately publish on each copy an
appropriate copyright notice and disclaimer of warranty; keep intact
all the notices that refer to this License and to the absence of any
warranty; and distribute a copy of this License along with the
Library.
You may charge a fee for the physical act of transferring a copy,
and you may at your option offer warranty protection in exchange for a
fee.
2. You may modify your copy or copies of the Library or any portion
of it, thus forming a work based on the Library, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) The modified work must itself be a software library.
b) You must cause the files modified to carry prominent notices
stating that you changed the files and the date of any change.
c) You must cause the whole of the work to be licensed at no
charge to all third parties under the terms of this License.
d) If a facility in the modified Library refers to a function or a
table of data to be supplied by an application program that uses
the facility, other than as an argument passed when the facility
is invoked, then you must make a good faith effort to ensure that,
in the event an application does not supply such function or
table, the facility still operates, and performs whatever part of
its purpose remains meaningful.
(For example, a function in a library to compute square roots has
a purpose that is entirely well-defined independent of the
application. Therefore, Subsection 2d requires that any
application-supplied function or table used by this function must
be optional: if the application does not supply it, the square
root function must still compute square roots.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Library,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Library, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote
it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Library.
In addition, mere aggregation of another work not based on the Library
with the Library (or with a work based on the Library) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may opt to apply the terms of the ordinary GNU General Public
License instead of this License to a given copy of the Library. To do
this, you must alter all the notices that refer to this License, so
that they refer to the ordinary GNU General Public License, version 2,
instead of to this License. (If a newer version than version 2 of the
ordinary GNU General Public License has appeared, then you can specify
that version instead if you wish.) Do not make any other change in
these notices.
Once this change is made in a given copy, it is irreversible for
that copy, so the ordinary GNU General Public License applies to all
subsequent copies and derivative works made from that copy.
This option is useful when you wish to copy part of the code of
the Library into a program that is not a library.
4. You may copy and distribute the Library (or a portion or
derivative of it, under Section 2) in object code or executable form
under the terms of Sections 1 and 2 above provided that you accompany
it with the complete corresponding machine-readable source code, which
must be distributed under the terms of Sections 1 and 2 above on a
medium customarily used for software interchange.
If distribution of object code is made by offering access to copy
from a designated place, then offering equivalent access to copy the
source code from the same place satisfies the requirement to
distribute the source code, even though third parties are not
compelled to copy the source along with the object code.
5. A program that contains no derivative of any portion of the
Library, but is designed to work with the Library by being compiled or
linked with it, is called a "work that uses the Library". Such a
work, in isolation, is not a derivative work of the Library, and
therefore falls outside the scope of this License.
However, linking a "work that uses the Library" with the Library
creates an executable that is a derivative of the Library (because it
contains portions of the Library), rather than a "work that uses the
library". The executable is therefore covered by this License.
Section 6 states terms for distribution of such executables.
When a "work that uses the Library" uses material from a header file
that is part of the Library, the object code for the work may be a
derivative work of the Library even though the source code is not.
Whether this is true is especially significant if the work can be
linked without the Library, or if the work is itself a library. The
threshold for this to be true is not precisely defined by law.
If such an object file uses only numerical parameters, data
structure layouts and accessors, and small macros and small inline
functions (ten lines or less in length), then the use of the object
file is unrestricted, regardless of whether it is legally a derivative
work. (Executables containing this object code plus portions of the
Library will still fall under Section 6.)
Otherwise, if the work is a derivative of the Library, you may
distribute the object code for the work under the terms of Section 6.
Any executables containing that work also fall under Section 6,
whether or not they are linked directly with the Library itself.
6. As an exception to the Sections above, you may also combine or
link a "work that uses the Library" with the Library to produce a
work containing portions of the Library, and distribute that work
under terms of your choice, provided that the terms permit
modification of the work for the customer's own use and reverse
engineering for debugging such modifications.
You must give prominent notice with each copy of the work that the
Library is used in it and that the Library and its use are covered by
this License. You must supply a copy of this License. If the work
during execution displays copyright notices, you must include the
copyright notice for the Library among them, as well as a reference
directing the user to the copy of this License. Also, you must do one
of these things:
a) Accompany the work with the complete corresponding
machine-readable source code for the Library including whatever
changes were used in the work (which must be distributed under
Sections 1 and 2 above); and, if the work is an executable linked
with the Library, with the complete machine-readable "work that
uses the Library", as object code and/or source code, so that the
user can modify the Library and then relink to produce a modified
executable containing the modified Library. (It is understood
that the user who changes the contents of definitions files in the
Library will not necessarily be able to recompile the application
to use the modified definitions.)
b) Use a suitable shared library mechanism for linking with the
Library. A suitable mechanism is one that (1) uses at run time a
copy of the library already present on the user's computer system,
rather than copying library functions into the executable, and (2)
will operate properly with a modified version of the library, if
the user installs one, as long as the modified version is
interface-compatible with the version that the work was made with.
c) Accompany the work with a written offer, valid for at
least three years, to give the same user the materials
specified in Subsection 6a, above, for a charge no more
than the cost of performing this distribution.
d) If distribution of the work is made by offering access to copy
from a designated place, offer equivalent access to copy the above
specified materials from the same place.
e) Verify that the user has already received a copy of these
materials or that you have already sent this user a copy.
For an executable, the required form of the "work that uses the
Library" must include any data and utility programs needed for
reproducing the executable from it. However, as a special exception,
the materials to be distributed need not include anything that is
normally distributed (in either source or binary form) with the major
components (compiler, kernel, and so on) of the operating system on
which the executable runs, unless that component itself accompanies
the executable.
It may happen that this requirement contradicts the license
restrictions of other proprietary libraries that do not normally
accompany the operating system. Such a contradiction means you cannot
use both them and the Library together in an executable that you
distribute.
7. You may place library facilities that are a work based on the
Library side-by-side in a single library together with other library
facilities not covered by this License, and distribute such a combined
library, provided that the separate distribution of the work based on
the Library and of the other library facilities is otherwise
permitted, and provided that you do these two things:
a) Accompany the combined library with a copy of the same work
based on the Library, uncombined with any other library
facilities. This must be distributed under the terms of the
Sections above.
b) Give prominent notice with the combined library of the fact
that part of it is a work based on the Library, and explaining
where to find the accompanying uncombined form of the same work.
8. You may not copy, modify, sublicense, link with, or distribute
the Library except as expressly provided under this License. Any
attempt otherwise to copy, modify, sublicense, link with, or
distribute the Library is void, and will automatically terminate your
rights under this License. However, parties who have received copies,
or rights, from you under this License will not have their licenses
terminated so long as such parties remain in full compliance.
9. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Library or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Library (or any work based on the
Library), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Library or works based on it.
10. Each time you redistribute the Library (or any work based on the
Library), the recipient automatically receives a license from the
original licensor to copy, distribute, link with or modify the Library
subject to these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties with
this License.
11. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Library at all. For example, if a patent
license would not permit royalty-free redistribution of the Library by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Library.
If any portion of this section is held invalid or unenforceable under any
particular circumstance, the balance of the section is intended to apply,
and the section as a whole is intended to apply in other circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
12. If the distribution and/or use of the Library is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Library under this License may add
an explicit geographical distribution limitation excluding those countries,
so that distribution is permitted only in or among countries not thus
excluded. In such case, this License incorporates the limitation as if
written in the body of this License.
13. The Free Software Foundation may publish revised and/or new
versions of the Lesser General Public License from time to time.
Such new versions will be similar in spirit to the present version,
but may differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the Library
specifies a version number of this License which applies to it and
"any later version", you have the option of following the terms and
conditions either of that version or of any later version published by
the Free Software Foundation. If the Library does not specify a
license version number, you may choose any version ever published by
the Free Software Foundation.
14. If you wish to incorporate parts of the Library into other free
programs whose distribution conditions are incompatible with these,
write to the author to ask for permission. For software which is
copyrighted by the Free Software Foundation, write to the Free
Software Foundation; we sometimes make exceptions for this. Our
decision will be guided by the two goals of preserving the free status
of all derivatives of our free software and of promoting the sharing
and reuse of software generally.
NO WARRANTY
15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Libraries
If you develop a new library, and you want it to be of the greatest
possible use to the public, we recommend making it free software that
everyone can redistribute and change. You can do so by permitting
redistribution under these terms (or, alternatively, under the terms of the
ordinary General Public License).
To apply these terms, attach the following notices to the library. It is
safest to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least the
"copyright" line and a pointer to where the full notice is found.
<one line to give the library's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Also add information on how to contact you by electronic and paper mail.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the library, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the
library `Frob' (a library for tweaking knobs) written by James Random Hacker.
<signature of Ty Coon>, 1 April 1990
Ty Coon, President of Vice
That's all there is to it!

Binary file not shown.

160
doc/beautify_bash.py Normal file
View File

@ -0,0 +1,160 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-
#**************************************************************************
# Copyright (C) 2011, Paul Lutus *
# *
# This program is free software; you can redistribute it and/or modify *
# it under the terms of the GNU General Public License as published by *
# the Free Software Foundation; either version 2 of the License, or *
# (at your option) any later version. *
# *
# This program is distributed in the hope that it will be useful, *
# but WITHOUT ANY WARRANTY; without even the implied warranty of *
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
# GNU General Public License for more details. *
# *
# You should have received a copy of the GNU General Public License *
# along with this program; if not, write to the *
# Free Software Foundation, Inc., *
# 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
#**************************************************************************
import re, sys
PVERSION = '1.0'
class BeautifyBash:
def __init__(self):
self.tab_str = ' '
self.tab_size = 2
def read_file(self,fp):
with open(fp) as f:
return f.read()
def write_file(self,fp,data):
with open(fp,'w') as f:
f.write(data)
def beautify_string(self,data,path = ''):
tab = 0
case_stack = []
in_here_doc = False
defer_ext_quote = False
in_ext_quote = False
ext_quote_string = ''
here_string = ''
output = []
line = 1
for record in re.split('\n',data):
record = record.rstrip()
stripped_record = record.strip()
# collapse multiple quotes between ' ... '
test_record = re.sub(r'\'.*?\'','',stripped_record)
# collapse multiple quotes between " ... "
test_record = re.sub(r'".*?"','',test_record)
# collapse multiple quotes between ` ... `
test_record = re.sub(r'`.*?`','',test_record)
# collapse multiple quotes between \` ... ' (weird case)
test_record = re.sub(r'\\`.*?\'','',test_record)
# strip out any escaped single characters
test_record = re.sub(r'\\.','',test_record)
# remove '#' comments
test_record = re.sub(r'(\A|\s)(#.*)','',test_record,1)
if(not in_here_doc):
if(re.search('<<-?',test_record)):
here_string = re.sub('.*<<-?\s*[\'|"]?([_|\w]+)[\'|"]?.*','\\1',stripped_record,1)
in_here_doc = (len(here_string) > 0)
if(in_here_doc): # pass on with no changes
output.append(record)
# now test for here-doc termination string
if(re.search(here_string,test_record) and not re.search('<<',test_record)):
in_here_doc = False
else: # not in here doc
if(in_ext_quote):
if(re.search(ext_quote_string,test_record)):
# provide line after quotes
test_record = re.sub('.*%s(.*)' % ext_quote_string,'\\1',test_record,1)
in_ext_quote = False
else: # not in ext quote
if(re.search(r'(\A|\s)(\'|")',test_record)):
# apply only after this line has been processed
defer_ext_quote = True
ext_quote_string = re.sub('.*([\'"]).*','\\1',test_record,1)
# provide line before quote
test_record = re.sub('(.*)%s.*' % ext_quote_string,'\\1',test_record,1)
if(in_ext_quote):
# pass on unchanged
output.append(record)
else: # not in ext quote
inc = len(re.findall('(\s|\A|;)(case|then|do)(;|\Z|\s)',test_record))
inc += len(re.findall('(\{|\(|\[)',test_record))
outc = len(re.findall('(\s|\A|;)(esac|fi|done|elif)(;|\)|\||\Z|\s)',test_record))
outc += len(re.findall('(\}|\)|\])',test_record))
if(re.search(r'\besac\b',test_record)):
if(len(case_stack) == 0):
sys.stderr.write(
'File %s: error: "esac" before "case" in line %d.\n' % (path,line)
)
else:
outc += case_stack.pop()
# sepcial handling for bad syntax within case ... esac
if(len(case_stack) > 0):
if(re.search('\A[^(]*\)',test_record)):
# avoid overcount
outc -= 2
case_stack[-1] += 1
if(re.search(';;',test_record)):
outc += 1
case_stack[-1] -= 1
# an ad-hoc solution for the "else" keyword
else_case = (0,-1)[re.search('^(else)',test_record) != None]
net = inc - outc
tab += min(net,0)
extab = tab + else_case
extab = max(0,extab)
output.append((self.tab_str * self.tab_size * extab) + stripped_record)
tab += max(net,0)
if(defer_ext_quote):
in_ext_quote = True
defer_ext_quote = False
if(re.search(r'\bcase\b',test_record)):
case_stack.append(0)
line += 1
error = (tab != 0)
if(error):
sys.stderr.write('File %s: error: indent/outdent mismatch: %d.\n' % (path,tab))
return '\n'.join(output), error
def beautify_file(self,path):
error = False
if(path == '-'):
data = sys.stdin.read()
result,error = self.beautify_string(data,'(stdin)')
sys.stdout.write(result)
else: # named file
data = self.read_file(path)
result,error = self.beautify_string(data,path)
if(data != result):
# make a backup copy
self.write_file(path + '~',data)
self.write_file(path,result)
return error
def main(self):
error = False
sys.argv.pop(0)
if(len(sys.argv) < 1):
sys.stderr.write('usage: shell script filenames or \"-\" for stdin.\n')
else:
for path in sys.argv:
error |= self.beautify_file(path)
sys.exit((0,1)[error])
# if not called as a module
if(__name__ == '__main__'):
BeautifyBash().main()

View File

@ -1 +0,0 @@
12

View File

@ -1 +0,0 @@
12

View File

@ -1,227 +0,0 @@
#! /bin/sh
# $Id$
# vim:et:ft=sh:sts=2:sw=2
#
# Copyright 2008 Kate Ward. All Rights Reserved.
# Released under the LGPL (GNU Lesser General Public License)
#
# Author: kate.ward@forestent.com (Kate Ward)
#
# This library provides reusable functions that determine actual names and
# versions of installed shells and the OS. The library can also be run as a
# script if set execuatable.
ARGV0=`basename "$0"`
LSB_RELEASE='/etc/lsb-release'
VERSIONS_SHELLS="/bin/bash /bin/dash /bin/ksh /bin/pdksh /bin/sh /bin/zsh"
TRUE=0
FALSE=1
ERROR=2
__versions_haveStrings=${ERROR}
#------------------------------------------------------------------------------
# functions
#
versions_osName()
{
os_name_='unrecognized'
os_system_=`uname -s`
case ${os_system_} in
CYGWIN_NT-*) os_name_='Cygwin' ;;
Darwin) os_name_='Mac OS X' ;;
FreeBSD) os_name_='FreeBSD' ;;
Linux) os_name_='Linux' ;;
SunOS)
if grep 'OpenSolaris' /etc/release >/dev/null; then
os_name_='OpenSolaris'
else
os_name_='Solaris'
fi
;;
esac
echo ${os_name_}
unset os_name_ os_system_
}
versions_osVersion()
{
os_version_='unrecognized'
os_system_=`uname -s`
os_release_=`uname -r`
case ${os_system_} in
CYGWIN_NT-*)
os_version_=`expr "${os_release_}" : '\([0-9]*\.[0-9]\.[0-9]*\).*'`
;;
Darwin)
major_='10'
sub_=`echo ${os_release_} |sed 's/^[0-9]*\.\([0-9]*\)\.[0-9]*$/\1/'`
case ${os_release_} in
8.*) minor_='4' ;;
9.*) minor_='5' ;;
10.*) minor_='6' ;;
*) minor_='X'; sub_='X' ;;
esac
os_version_="${major_}.${minor_}.${sub_}"
;;
FreeBSD)
os_version_=`expr "${os_release_}" : '\([0-9]*\.[0-9]*\)-.*'`
;;
Linux)
if [ -r "${LSB_RELEASE}" ]; then
if grep -q 'DISTRIB_ID=Ubuntu' "${LSB_RELEASE}"; then
os_version_=`cat "${LSB_RELEASE}" \
|awk -F= '$1~/DISTRIB_DESCRIPTION/{print $2}' \
|sed 's/"//g;s/ /-/g'`
fi
elif [ -r '/etc/redhat-release' ]; then
os_version_=`cat /etc/redhat-release`
fi
;;
SunOS)
if grep 'OpenSolaris' /etc/release >/dev/null; then
os_version_=`grep 'OpenSolaris' /etc/release |awk '{print $2"("$3")"}'`
else
major_=`echo ${os_release_} |sed 's/[0-9]*\.\([0-9]*\)/\1/'`
minor_=`grep Solaris /etc/release |sed 's/[^u]*\(u[0-9]*\).*/\1/'`
os_version_="${major_}${minor_}"
fi
;;
esac
echo ${os_version_}
unset os_name_ os_release_ os_version_ major_ minor_ sub_
}
versions_shellVersion()
{
shell_=$1
if [ ! -x "${shell_}" ]; then
echo 'not installed'
return
fi
version_=''
case ${shell_} in
*/sh)
# TODO(kward): fix this
## this could be one of any number of shells. try until one fits.
#version_=`versions_shell_bash ${shell_}`
## dash cannot be self determined yet
#[ -z "${version_}" ] && version_=`versions_shell_ksh ${shell_}`
## pdksh is covered in versions_shell_ksh()
#[ -z "${version_}" ] && version_=`versions_shell_zsh ${shell_}`
;;
*/bash) version_=`versions_shell_bash ${shell_}` ;;
*/dash)
# simply assuming Ubuntu Linux until somebody comes up with a better
# test. the following test will return an empty string if dash is not
# installed.
version_=`versions_shell_dash`
;;
*/ksh) version_=`versions_shell_ksh ${shell_}` ;;
*/pdksh) version_=`versions_shell_pdksh ${shell_}` ;;
*/zsh) version_=`versions_shell_zsh ${shell_}` ;;
*) version_='invalid'
esac
echo ${version_:-unknown}
unset shell_ version_
}
versions_shell_bash()
{
$1 --version 2>&1 |grep 'GNU bash' |sed 's/.*version \([^ ]*\).*/\1/'
}
versions_shell_dash()
{
eval dpkg >/dev/null 2>&1
[ $? -eq 127 ] && return # return if dpkg not found
dpkg -l |grep ' dash ' |awk '{print $3}'
}
versions_shell_ksh()
{
versions_shell_=$1
# see if --version gives a result
versions_version_=`${versions_shell_} --version 2>&1 \
|sed 's/.*\([0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9]\).*/\1/'`
# --version didn't work... look into the binary
if [ $? -ne ${TRUE} ]; then
_versions_have_strings
versions_version_=`strings ${versions_shell_} 2>&1 \
|grep Version \
|sed 's/^.*Version \(.*\)$/\1/;s/ s+ \$$//;s/ /-/g'`
[ -z "${versions_version_}" ] \
&& versions_version_=`versions_shell_pdksh ${versions_shell_}`
fi
echo ${versions_version_}
unset versions_shell_ versions_version_
}
versions_shell_pdksh()
{
_versions_have_strings
strings $1 2>&1 \
|grep 'PD KSH' \
|sed -e 's/.*PD KSH \(.*\)/\1/;s/ /-/g'
}
versions_shell_zsh()
{
versions_shell_=$1
versions_version_=`${versions_shell_} --version 2>&1 |awk '{print $2}'`
if [ $? -ne ${TRUE} ]; then
versions_version_=`echo 'echo ${ZSH_VERSION}' |${versions_shell_}`
fi
echo ${versions_version_}
unset versions_shell_ versions_version_
}
# Determine if the 'strings' binary installed.
_versions_have_strings()
{
[ ${__versions_haveStrings} -ne ${ERROR} ] && return
eval strings /dev/null >/dev/null 2>&1
if [ $? -eq 0 ]; then
__versions_haveStrings=${TRUE}
else
echo 'WARN: strings not installed. try installing binutils?' >&2
__versions_haveStrings=${FALSE}
fi
}
#------------------------------------------------------------------------------
# main
#
versions_main()
{
# treat unset variables as an error
set -u
os_name=`versions_osName`
os_version=`versions_osVersion`
echo "os: ${os_name} version: ${os_version}"
for shell in ${VERSIONS_SHELLS}; do
shell_version=`versions_shellVersion ${shell}`
echo "shell: ${shell} version: ${shell_version}"
done
}
if [ "${ARGV0}" = 'versions' ]; then
versions_main "$@"
fi

View File

@ -1,40 +0,0 @@
# $Id: shlib 14 2007-02-18 19:43:41Z sfsetse $
# vim:et:ft=sh:sts=2:sw=2
#
# Copyright 2011 Kate Ward. All Rights Reserved.
# Released under the LGPL (GNU Lesser General Public License).
#
# Author: kate.ward@forestent.com (Kate Ward)
#
# Library of shell functions.
# Convert a relative path into it's absolute equivalent.
#
# This function will automatically prepend the current working directory if the
# path is not already absolute. It then removes all parent references (../) to
# reconstruct the proper absolute path.
#
# Args:
# shlib_path_: string: relative path
# Outputs:
# string: absolute path
shlib_relToAbsPath()
{
shlib_path_=$1
# prepend current directory to relative paths
echo "${shlib_path_}" |grep '^/' >/dev/null 2>&1 \
|| shlib_path_="`pwd`/${shlib_path_}"
# clean up the path. if all seds supported true regular expressions, then
# this is what it would be:
shlib_old_=${shlib_path_}
while true; do
shlib_new_=`echo "${shlib_old_}" |sed 's/[^/]*\/\.\.\/*//g;s/\/\.\//\//'`
[ "${shlib_old_}" = "${shlib_new_}" ] && break
shlib_old_=${shlib_new_}
done
echo "${shlib_new_}"
unset shlib_path_ shlib_old_ shlib_new_
}

Binary file not shown.