TweetFollow Us on Twitter

May 01 Mac OS X

Volume Number: 17 (2001)
Issue Number: 05
Column Tag: Mac OS X

Just Ship It!

by Andrew Stone

Building Electronic and CD Software distributions for Mac OS X

Now that you have written, debugged, beta tested and finished your online documentation for your whizzy new Mac OS X application, it's time to make it available to the world! Back in the old days of Mac OS 9 and earlier, developers had a selection of package making tools, including the almost de facto StuffIt™. For Mac OS X however, there is no need to rely on third party vendors to create your installation packages: Apple has provided some powerful disk image creation utilities that come with the base release of Mac OS X. This article will teach you how to use those tools by hand, give you an example of a totally automated packaging shell script, and go into the finer points, such as including a background image in your distribution folder. These same tools can create your master for CD replication as well.

The Macintosh Way

A quick review of some of the online developer discussion groups will reveal the huge amount of emotion developers have over the right way to distribute software packages. Open source and free ware folks swear by gnutar, but that is a problematic solution because Apple no longer includes gnutar in the base distribution. And, because of legal issues surrounding the GNU project's ‘Copyleft', Apple did not build in an unpacking mechanism for the industry standard gnutar ball. So, for now, forget simply packing up your distribution with gnutar czf, although you get the highest level of compression and smallest resulting downloads.

Apple has come up with a great packaging solution, although the resulting downloads are somewhat bulkier — disk images are optimized for decompression speed, not minimum compression size. The emphasis has become on how easy a distribution is to unpack and how to reduce the number of steps a user has to take to get the software installed. If you have visited the iTools site, and peeked into the Mac OS X software download folder, you'll see a bunch of APPNAME.dmg files — "disk image" files. The same technology that Apple pioneered for distributing firmware upgrades, the self-mounting disk image, .smi, has evolved to be a great way for developers to distribute their wares.

The user simply double-clicks the downloaded .dmg file, and the Copy Disk utility launches, and automatically mounts the download as a the disk image. During the mounting, Copy Disk verifies the integrity of the image by matching the checksum with the encoded checksum. The user then sees your distribution folder with your application in it. They can try out your app from the disk image if they want, or they can just copy it to their applications folder. And that is the entire installation process.

Because the OS X bundle architecture encourages developers to place all the related files of an application inside the application wrapper, your application can be anywhere on the user's computer and still function correctly. This is an ideal situation because we should never force users to do anything a certain way, especially not for some arcane technical reason. If your installation requires frameworks that must be installed in a certain location, you should consider either including them inside the appwrapper, or perhaps using scripts that install the software for the user in the correct location. Rule 1 is to make your installation so idiot proof that even adults can use it.

The Tools

You use the command line tools, hdiutil and hdid, to create, mount, eject and compress your disk image. A complete guide to the usage of these programs is included in the online manual pages. Type "man hdiutil" to see all the options. Let's walk over this process. I'll use APPNAME as a standin for whatever your application is called in the following set of instructions.

1. Launch Terminal.app from /Applications/Utilities
2. Become "root", aka super user

   sudo -s

then provide an adminstrator password, probably your own login password if you are set up to administer your machine.

You need to be root because you will be creating and mounting disk partitions which requires root access. A user cannot sudo to root if they are not a member of the admin group. To allow a user to become an administrator, choose the "Users" module from System Preference's "Show All" pane. Select the user, and click "Edit User". Make sure that the "Allow user to administer this machine" switch is checked, and click OK.

By default, Mac OS X ships without a root account for security reasons. The traditional way of becoming substitute user, su, will fail. To add a root user, launch NetInfoManager from /Applications/Utilities. Choose Domain->Security->Authenticate..., and provide the admin password for your computer. Choose Domain->Security->Enable Root User. You will be asked to provide a non-trivial password, don't forget it!

3. Change directory to where you want to build your disk image — preferabbly a disk with a lot of free space!

   cd /Volumes/BIG/distribution

4. Create the scratch, uncompressed disk image to which you will copy your application. You should be liberal with the size you allocate with the -megabytes flag. Having too much extra free space will not affect the final compressed size, but having too little will annoy you when you cannot quite copy all of your application onto the image. Doubling the size that your application requires seems to always work. The -layout flag can be NONE for net-distributed application, but you must use the SPUD (Single Partition UDIF) option for a CD-R master. If you are planning on using the same image for Net distribution as CD distribution, then use SPUD here. The -zeroImage tells hdiutil to write zeros to all sectors in the image file, which seems like a good idea to me.

   hdiutil create ‘APPNAME-scratch.dmg' -megabytes 10 -layout NONE -zeroImage

5. Alert the operating system of the existence of this new disk using hdid — but don't mount the disk in Finder.

   hdid APPNAME-scratch.dmg -nomount

After entering this command, the system will reply with the allocated device now connected to the disk image:

   /dev/disk1

You'll now use this information in the next step when you initialize the disk image. It's always of the fom /dev/disk, starting with 1.

6. Create an HFS file system with the name you want Finder to display, using the standard 4K blocksize, -b 4096. If you used -layout NONE above:

   newfs_hfs -v APPNAME -w -b 4096 /dev/disk1

If you used -layout SPUD above, you need to initialize the second partition which contains the actual Apple_HFS disk, since the first one has the partition map on it:

   newfs_hfs -v APPNAME -w -b 4096 /dev/disk1s2

7. Eject the image, again replacing disk1 with whatever was returned in step 5. above.

   hdiutil eject disk1

8. Now, do a complete mount of the disk so that it appears in Finder:

   hdid APPNAME-scratch.dmg
     ->/dev/disk1

At this point, the disk image appears as the icon of a removable drive entitled the name you gave to the -v option in step 6. Now, copy your application and readme files to the new disk. Set the permissions as needed — later in this article, you'll learn how to change the folder's background image and set custom folder icons.

9. Eject the disk

hdiutil eject disk1

NOTE: If disk won't eject because "its busy", you may have to logout and login or even reboot.

10. Make the compressed, net distributable, disk image:

hdiutil convert ‘APPNAME-scratch.dmg' -format UDCO -o ‘APPNAME-2001-04-06'

The -format option is UDCO (UDIF compressed image) for net distributions, and UDTO (DVD/CD-R master image) for your CD master image. The correct file extension will be added by hdiutil. I think it is wise to include a date in the name of your distribution, so that users can quickly and correctly tell whether they need to download a newer version or not.

Automating The Process

Ken Case, cofounder of OmniGroup, www.OmniGroup.com, created PackageApplication. This handy script not only creates the diskimage, but preprocesses your application to remove extraneous files and symbols, makes a copy of the release, installs frameworks inside of the application, copies the app to the image, compresses the image, and creates an equivalent tarball for a more traditional (and somewhat smaller) UNIX distribution. This is a zsh script, so save it to PackageApplication and make the appropriate changes to PUBLIC path, and then make the file executable:

chmod 755 PackageApplication

Now, you can package an application with, e.g.:

sudo -u root PackageApplication APPNAME

Sudo allows you to execute commands as another user — you are prompted for a password — provide your own. See man sudo for more information on this handy utility.

Here's the script:

#!/bin/zsh -f
#
# Copyright 2000-2001 Omni Development, Inc. All rights reserved.
#
# $Header: /Network/Source/CVS/OmniGroup/Scripts/PackageApplication,v 1.27 2001/03/14 20:19:28 kc Exp $

PUBLIC=/Users/Shared

APPNAME=$1
if [ "$APPNAME" = "" ]; then
   echo "Usage: $0 app-name"
   exit 1
fi
if [ "$SUDO_USER" = "" ]; then
   SUDO_USER = "$USER"
fi
INSTALLEDPRODUCTS=$PUBLIC/$SUDO_USER/InstalledProducts
PACKAGEDIR=$PUBLIC/$SUDO_USER/Release/$APPNAME

cd /tmp

echo "Copying files from $INSTALLEDPRODUCTS to $PACKAGEDIR
"
echo "   (Note: this assumes that all of $INSTALLEDPRODUCTS
   is needed for $APPNAME. If not, remove and rebuild.)
"
(cd $INSTALLEDPRODUCTS; chmod -R u+w .; tar cf — .) | (rm -rf $PACKAGEDIR; mkdir -p $PACKAGEDIR ; cd 
$PACKAGEDIR; tar xpf — |& egrep -v ‘tar: Unable to set file uid/gid of .* (No such file or directory)')

cd $PACKAGEDIR
echo "Cleaning up release"
chmod -R u+w,go-w,a+rX .
chown -R root.admin . 2>/dev/null
# Get rid of those CVS leftovers...
find . -name CVS -type d -exec rm -rf {} \; -prune
find . -name ‘.#*' -type f -exec rm {} \; -prune
# Users don't need framework documentation and headers, and developers can get those by downloading 
them separately

find . -name ‘*.minx' -exec rm {} \; -prune
find . -name ‘Documentation' -exec rm -rf {} \; -prune
find . -name ‘Headers' -exec rm -rf {} \; -prune
find . -name ‘PrivateHeaders' -exec rm -rf {} \; -prune
echo "Stripping debugger symbol table entries from Mach-O files"
find . -type f -print | xargs file | grep Mach-O | awk -F: ‘{print $1}' | while read file
do
   echo "  $file"
   strip -S $file
   chmod a+x $file
done
if [ "$APPNAME" = "OmniWeb" ]; then
   echo "Moving plugins into $APPNAME plugins"
   mv *.plugin $APPNAME.app/Contents/PlugIns
fi
echo "Moving frameworks into $APPNAME frameworks"
mkdir $APPNAME.app/Contents/Frameworks
mv *.framework $APPNAME.app/Contents/Frameworks
if [ -d OmniGroupCrashCatcher.app ]; then
   echo "Moving OmniGroupCrashCatcher into $APPNAME resources"
   mv OmniGroupCrashCatcher.app $APPNAME.app/Contents/Resources
fi
echo "Setting up launcher"
mv $APPNAME.app/Contents/MacOS/{,.}$APPNAME
mv Launcher $APPNAME.app/Contents/MacOS/$APPNAME
echo "Total size of $PWD"
du -s *

echo "Building tar file"
PACKAGEDATE=`date "+%Y-%m-%d"`
TARBALL_NAME="$APPNAME-$PACKAGEDATE.tar.gz"
TARBALL="$PUBLIC/$TARBALL_NAME"
tar czf $TARBALL $APPNAME.app
echo "Building Disk Copy image"
LABELNAME="$APPNAME-$PACKAGEDATE"
SCRATCHIMAGE="$PUBLIC/${LABELNAME} Temp-$$.dmg"
DISKCOPYIMAGE="$TARBALL:r:r.dmg"
# Create the image
echo "  Creating scratch image..."
rm -f $SCRATCHIMAGE
hdiutil create $SCRATCHIMAGE -megabytes 10 -layout NONE -zeroImage
# Create a /dev/disk device from the image
drive=`hdid -nomount $SCRATCHIMAGE`
# Create a new filesystem on the disk device
newfs_hfs -v "${APPNAME}" -b 4096 /dev/r${drive:t}
# Remount the disk
echo "  Image formatted, ejecting ${drive}..."
hdiutil eject ${drive}
echo "  Mounting $SCRATCHIMAGE..."
drive=`hdid $SCRATCHIMAGE`
echo "  Searching for ${drive}..."
while [ "$MOUNTPOINT" = "" ]
do
   MOUNTPOINT=`df -l | grep $drive | awk ‘{print $6}'`
done
echo "  Found $drive at $MOUNTPOINT"
# Unpack the tarball into the mounted filesystem
echo "  Copying application..."
(cd $MOUNTPOINT && gnutar xzpf $TARBALL)
# Eject the disk
echo "  Ejecting..."
hdiutil eject ${drive}
# Convert the image to a UDIF compressed image 
echo "  Compressing..."
hdiutil convert -format UDCO $SCRATCHIMAGE -o ${DISKCOPYIMAGE:r}
gzip -9 < $DISKCOPYIMAGE > $DISKCOPYIMAGE.gz
# Remove the temporary image
echo "  Removing scratch image"
rm -f $SCRATCHIMAGE
#
# All done! List the resulting packages to the user.
#
ls -lg $TARBALL $DISKCOPYIMAGE $DISKCOPYIMAGE.gz

Getting Fancy

The automated process is great if you are happy with a standard folder with your application in it. You can use the utility ditto to copy files that have resource forks with them — or you can just drag and drop them onto the disk image. Since Finder lets you associate images with folders, let's take advantage! I have not yet figured out how to automate the process of adding a background folder image — because the image MUST point to within the new file hierarchy on your disk image — and this has to be done with Finder. If you preset it on a folder which you then copy to your disk, the copied folder will point back to the original image, which will not be on the end user's disk!

The Finder stores information about a folder in a file named .DS_Store — normally you cannot see files that begin with a ‘.'. Use the -a option to ls to see this file:

ls -la 
-rw-rw-rw-  1 andrew admin    22604 Mar 26 17:28 .DS_Store

To set the background image of a folder:

1. In Finder, select the folder, and set the view to Icon mode

2. Choose View -> Show View Options... to bring up the View Options window.

3. Select the "Window" pane. You must have the Finder window in "Icon" mode to access this feature.

4. Uncheck the "Use Global View Preferences" switch

5. Select the "Picture" option, and click "Select..."

6. Navigate to an image included within your new disk image's file hierarchy and click "Choose"


Figure 1. For a professional touch, include an instructive image in the top level folder.

You can also set a custom icon for any folder — these do copy fine via Finder or ditto, since they are stored in the folder. Our artist created them in Mac OS 9 with IconFactory, a plugin for PhotoShop http://www.iconfactory.com. In Mac OS X, you can copy/paste folder icons like this:

1. In Finder, select the folder which has the icon you like

2. Choose File -> Show Info

3. Click on the icon in the upper left hand corner, a box will show that it is selected

4. Choose Edit -> Copy

5. Navigate to the destination folder on which you want the icon to appear.

6. Click on the Info window's icon

7. Choose Edit -> Paste


Figure 2. Folders can have their own special icon.

You're Toast

Making a CD master image is very similar to making a net distribution, with a few changes in the creation of the disk partition, in the initializing of the new file system, and in the compression phase (steps 4., 6. and 10. from The Tools above). When we create the disk image, we'll use the SPUD layout and make it large enough to hold all those quicktime movies and demo files!

hdiutil create ‘APPNAME-scratch.dmg' -megabytes 160 -layout SPUD -zeroImage

The process continues the same until we initialize the new disk — we want to intialize the second partition:

newfs_hfs -v APPNAME -w -b 4096 /dev/disk1s2

The process continues the same until we get to the very end when we make a raw disk image for use by Toast or other cd recording software:

hdiutil convert ‘APPNAME-scratch.dmg' -format UDTO -o ‘APPNAME_CD_2000-04-06'

You are ready to burn your golden master and you'll be shipping CDs within days.

Conclusion

The disk image format is a simple and surefire way to distribute your software electronically, and the same tools let you create CD master images.

Thanks to Jim Kateley and Eric Peyton of Apple Computer, Inc., who assisted me in understanding these tools, Byron Han, principle engineer on the DiskImages project, and Ken Case for PackageApplication.


Andrew Stone, CEO of Stone Design, www.stone.com, has been coding in Cocoa as an independent software developer for over 13 years.

 
AAPL
$97.19
Apple Inc.
+2.47
MSFT
$44.87
Microsoft Corpora
+0.04
GOOG
$595.98
Google Inc.
+1.24

MacTech Search:
Community Search:

Software Updates via MacUpdate

Firefox 31.0 - Fast, safe Web browser. (...
Firefox for Mac offers a fast, safe Web browsing experience. Browse quickly, securely, and effortlessly. With its industry-leading features, Firefox is the choice of Web development professionals... Read more
Little Snitch 3.3.3 - Alerts you to outg...
Little Snitch gives you control over your private outgoing data. Track background activityAs soon as your computer connects to the Internet, applications often have permission to send any... Read more
Thunderbird 31.0 - Email client from Moz...
As of July 2012, Thunderbird has transitioned to a new governance model, with new features being developed by the broader free software and open source community, and security fixes and improvements... Read more
Together 3.2 - Store and organize all of...
Together helps you organize your Mac, giving you the ability to store, edit and preview your files in a single clean, uncluttered interface. Smart storage. With simple drag-and-drop functionality,... Read more
Cyberduck 4.5 - FTP and SFTP browser. (F...
Cyberduck is a robust FTP/FTP-TLS/SFTP browser for the Mac whose lack of visual clutter and cleverly intuitive features make it easy to use. Support for external editors and system technologies such... Read more
iExplorer 3.4 - View and transfer all th...
iExplorer is an iPhone browser for Mac lets you view the files on your iOS device. By using a drag and drop interface, you can quickly copy files and folders between your Mac and your iPhone or... Read more
Airmail 1.4 - Powerful, minimal email cl...
Airmail is a powerful, minimal mail client.It was designed to retain the same experience with a single or multiple accounts and provide a quick, modern and easy-to-use user experience. Airmail... Read more
Macs Fan Control 1.1.12 - Monitor and co...
Macs Fan Control allows you to monitor and control almost any aspect of your computer's fans, with support for controlling fan speed, temperature sensors pane, menu-bar icon, and autostart with... Read more
A Better Finder Rename 9.37 - File, phot...
A Better Finder Rename is the most complete renaming solution available on the market today. That's why, since 1996, tens of thousands of hobbyists, professionals and businesses depend on A Better... Read more
MacBook Air EFI Firmware Update 2.9 - Fo...
MacBook Air EFI Firmware Update is recommended for MacBook Air (Mid 2011) models. This update addresses an issue where systems may take longer to wake from sleep than expected and fixes a rare issue... Read more

Latest Forum Discussions

See All

Traps n' Gemstones (Games)
Traps n' Gemstones 1.00 Device: iOS Universal Category: Games Price: $2.99, Version: 1.00 (iTunes) Description: LAUNCH SALE! 40% off, JULY ONLY! TRAPS N' GEMSTONES is an adventurous platform game, among gamers typically known as the... | Read more »
Soccer Physics (Games)
Soccer Physics 1.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0 (iTunes) Description: One-button soccer game! So dumb it's fun. "Soccer Physics is probably the funniest football game you'll play on iOS" —... | Read more »
Ex-Angry Birds Developers Release Monsu...
Ex-Angry Birds Developers Release Monsu Teaser Trailer Posted by Jennifer Allen on July 23rd, 2014 [ permalink ] Finnish developer Boomlagoon has released a teaser trailer of their forthcoming side-scrolling action platformer, | Read more »
Lots of New Modes Have Been Added to Can...
Lots of New Modes Have Been Added to Canabalt Posted by Jennifer Allen on July 23rd, 2014 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Stronghold 3: The Campaigns Review
Stronghold 3: The Campaigns Review By Jennifer Allen on July 23rd, 2014 Our Rating: :: DULL STRATEGIZINGiPad Only App - Designed for the iPad A cumbersome strategy game, Stronghold 3: The Campaigns has a few too many issues to... | Read more »
Table Tennis Touch on Sale for a Limited...
Table Tennis Touch on Sale for a Limited Time Posted by Jessica Fisher on July 23rd, 2014 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Secret Files Tunguska Review
Secret Files Tunguska Review By Jennifer Allen on July 23rd, 2014 Our Rating: :: CONSPIRACY-LITTERED ADVENTURINGUniversal App - Designed for iPhone and iPad Offering traditional adventuring with no fear of in-app purchases, Secret... | Read more »
Celebrate Summer With a Cat in the Hat L...
Celebrate Summer With a Cat in the Hat Learning Library Sale Posted by Ellis Spice on July 22nd, 2014 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Dragon Raiders Review
Dragon Raiders Review By Nadia Oxford on July 22nd, 2014 Our Rating: :: RUN, DRAGON, RUNUniversal App - Designed for iPhone and iPad Dragon Raiders is rough and scaly in some parts, but overall it’s an enjoyable level-based running... | Read more »
MyTaskList Review
MyTaskList Review By Jennifer Allen on July 22nd, 2014 Our Rating: :: EFFECTIVE IF PLAINUniversal App - Designed for iPhone and iPad It’s not the most stylish of task management apps, but MyTaskList has all the features you could... | Read more »

Price Scanner via MacPrices.net

With The Apple/IBM Alliance, Is The iPad Now...
Almost since the iPad was rolled out in 2010, and especially after Apple made a 128 GB storage configuration available in 2012, there’s been debate over whether the iPad is a serious tool for... Read more
MacBook Airs on sale starting at $799, free s...
B&H Photo has the new 2014 MacBook Airs on sale for up to $100 off MSRP for a limited time. Shipping is free, and B&H charges NY sales tax only. They also include free copies of Parallels... Read more
Apple 27″ Thunderbolt Display (refurbished) a...
The Apple Store has Apple Certified Refurbished 27″ Thunderbolt Displays available for $799 including free shipping. That’s $200 off the cost of new models. Read more
WaterField Designs Unveils Cycling Ride Pouch...
High end computer case and bag maker WaterField Designs of San Francisco now enters the cycling market with the introduction of the Cycling Ride Pouch – an upscale toolkit with a scratch-free iPhone... Read more
Kingston Digital Ships Large Capacity Near 1T...
Kingston Digital, Inc., the Flash memory affiliate of Kingston Technology Company, Inc.,has announced its latest addition to the SSDNow V300 series, the V310. The Kingston SSDNow V310 solid-state... Read more
Apple’s Fiscal Third Quarter Results; Record...
Apple has announced financial results for its fiscal 2014 third quarter ended June 28, 2014, racking up quarterly revenue of $37.4 billion and quarterly net profit of $7.7 billion, or $1.28 per... Read more
15-inch 2.0GHz MacBook Pro Retina on sale for...
B&H Photo has the 15″ 2.0GHz Retina MacBook Pro on sale for $1829 including free shipping plus NY sales tax only. Their price is $170 off MSRP. B&H will also include free copies of Parallels... Read more
Apple restocks refurbished Mac minis for up t...
The Apple Store has restocked Apple Certified Refurbished Mac minis for up to $150 off the cost of new models. Apple’s one-year warranty is included with each mini, and shipping is free: - 2.5GHz Mac... Read more
Twelve South HiRise For MacBook – Height-Adju...
If you use your MacBook as a workhorse desktop substitute, as many of us do, a laptop stand combined with an external keyboard and pointing device are pretty much obligatory if you want to avoid... Read more
Why The Mac Was Not Included In The Apple/IBM...
TUAW’s Yoni Heisler cites Fredrick Paul of Network World whoi blogged last week that the Mac’s conspicuous absence from Apple and IBM’s landmark partnership agreement represents a huge squandered... Read more

Jobs Board

Senior Interaction Designer, *Apple* Online...
**Job Summary** Apple is looking for a hands on Senior…will be a key player in designing for the Apple Online Store. The ideal designer will have a Read more
*Apple* Sales Chat Rep - Apple (United State...
…is looking for motivated, outgoing, and tech savvy individuals who want to offer Apple Customers an unparalleled customer experience over chat. At Apple , we believe Read more
Mac Expert - *Apple* Online Store Mexico -...
…MUST be fluent in English and Spanish to be considered for this position At Apple , we believe that hard work, a fun environment, creativity and innovation fuel the Read more
*Apple* Industrial Design CAD Sculptor - App...
**Job Summary** The Apple Industrial Design team is looking for a CAD sculptor/Digital 3D modeler to create high quality CAD models used in the industrial design process Read more
*Apple* Developer Support Advisor - Portugue...
**Job Summary** Imagine what you could do here. At Apple , great ideas have a way of becoming great products, services, and customer experiences very quickly. Bring Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.