2 #---------------------------------*- sh -*-------------------------------------
4 # \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
6 # \\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd.
8 #------------------------------------------------------------------------------
10 # This file is part of OpenFOAM.
12 # OpenFOAM is free software: you can redistribute it and/or modify it
13 # under the terms of the GNU General Public License as published by
14 # the Free Software Foundation, either version 3 of the License, or
15 # (at your option) any later version.
17 # OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
18 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
19 # FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22 # You should have received a copy of the GNU General Public License
23 # along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 # foamPackDoxygen [-prefix DIR] [-o outputDir]
29 # Packs and compresses the OpenFOAM doxygen html for release
31 #------------------------------------------------------------------------------
32 packDir
=$WM_PROJECT-$WM_PROJECT_VERSION
36 while [ $# -gt 0 ]; do echo "$1" 1>&2; shift; done
38 Usage: ${0##*/} [-prefix DIR] [-o outputDir]
40 Packs and compresses the OpenFOAM doxygen html for release
46 unset prefix outputDir
63 usage
"unknown option: '$*'"
68 # if packing from within the directory, use -prefix form
69 if [ "${PWD##*/}" = "$packDir" ]
74 # pack the directories directly and add prefix afterwards
78 elif [ ! -d $packDir ]
80 echo "Error: directory $packDir does not exist" 1>&2
85 # add optional output directory
87 if [ -d "$outputDir" ]
89 packFile
="$outputDir/$packDir$packTag"
91 packFile
="$packDir$packTag"
97 echo "Error: $packFile already exists"
101 # Pack and compress the packFile using GNU tar
102 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
104 echo "Packing doxygen html into $packFile"
109 tar czpf
$packFile --transform="s@^@$prefix/@" doc
/Doxygen
/html
111 tar czpf
$packFile $packDir/doc
/Doxygen
/html
116 echo "Finished packing doxygen html into file $packFile"
118 echo "Error: failure packing doxygen html file $packFile"
121 #------------------------------------------------------------------------------