TweetFollow Us on Twitter

Ship It! Distributing Your Software

Volume Number: 20 (2004)
Issue Number: 1
Column Tag: Programming

Mac OS X Programming Secrets

by Scott Knaster

Ship It! Distributing Your Software

Here's a twist: let's assume your world-changing Mac OS X application is finished, documented, freshly painted, and ready to go out into the world. What are you going to do now? Why, you need to distribute your software, of course. We're going to take a couple of columns to look at how you get your software out into the world and installed on happy Macs everywhere.

There are two ways you can distribute your software: as a disk image, or wrapped in an installer. Mac OS X comes with Apple-supplied tools you can use to create both kinds of distributions, whether your software is going to get to users on a CD or via the Internet. In this month's column, we're going to cover the first kind of distribution: disk images.

In Your Image

If your software has just an application bundle to install, maybe along with some documentation or a couple of other ancillary files, you should consider providing drag-and-drop installation with a disk image. A disk image is simply a file that contains an encoded representation of a disk volume. Mac OS X can turn a disk image into something that looks exactly like a mounted volume. When you distribute a disk image online with your application on it, your users can download the disk image, have OS X mount it like a disk, then just drag your application from the volume and drop it on their own disks. You can also use a disk image to create CDs to distribute. When users get the CDs, they can drag and drop to install in the same way.

Writing and testing your software is hard - making a disk image that includes your software is very easy. When you're ready to start messing around with disk images, launch Disk Utility, which you'll find in the /Applications/Utilities/ folder. (If you're using Mac OS 10.2, use Disk Copy instead - the disk image creation features are in there. They're very similar to those in Disk Utility, but not identical. As a MacTech reader, we trust you can adapt.)

Note that even though Apple replaced the features of Disk Copy with Disk Utility in 10.3, not all of Disk Copy's features made it in. In particular, Disk Copy provided more options for your disk image format, and Disk Copy let you create an image from a folder by dragging the folder in (Disk Utility lets you do this via a menu item). Maybe these features will be revived in future versions of Disk Utility.

To make your new disk image, click New Image in the toolbar. You'll see a sheet like the one in Figure 1. Give your disk image a pleasant name. For the Size popup, choose a size that's big enough to hold the software you're going to put on it. It's OK if the virtual disk is way too big - if you're going to distribute it via the Internet, you can compress it later, so unused space won't be wasted. Leave the Encryption and Format settings as they are, and click Create. Disk Utility will show you a little progress dance, and then voila! You've created your first disk image (see Figure 2). After the image is created, OS X mounts it as a volume.


Figure 1. Disk Utility offers various settings when you create your disk image. Usually, you'll just have to worry about the size, making sure it's big enough for your files.


Figure 2. After you create your disk image, it appears in the left pane of Disk Utility and its image is mounted.

Build Your Case

Once you've created the disk image, switch to the Finder. You'll discover the Finder already knows about the volume supplied by your fresh new disk image. If you're running 10.3 and you have the Sidebar set to show removable media, your volume appears in the list. Now you need to add your files to it. Grab the files you want to distribute and drag them to the new disk.

After you've dragged and dropped the files, you can channel your inner designer and make the Finder window look just the way you want. Move the icons around to form a lovely pattern. Choose View --> Show View Options and add a background image or color, pick a different size for the icons, and make the labels look perfect.


Figure 3. In the Finder, drag the files you want to the disk image, then go wild dressing up the contents however you like.

Here are a couple of tips about prettying up the way your Finder window looks. The General panel of Finder preferences has a setting called Open new windows in column view. If the user has this checked, your disk image's window will indeed open in column view, which conceals all your painstaking icon placement and other visual tweaks. Sigh. Second, if you want to use a background picture (JPG, PNG, and so on) for your Finder window, make sure you copy the picture's file to your disk first, then use the Select button in the View Options window to point at the new copy. If you don't copy it to your disk first, it won't be there for users to see when they download your disk image or open your CD.

Once you have the files and the view settings you want, eject the disk image in the Finder and go back to Disk Utility. If you're going to distribute your software by CD, you can go ahead and order the pizza, because you're almost done. All that's left now is to burn the CD. You can do that from Disk Utility. Just select the disk image in the left pane and click Burn on the toolbar. Disk Utility will ask you to insert a blank CD, then give you the dialog you see in Figure 4. Just click Burn and wait for your CD to be made.


Figure 4. "Ready to burn," indeed! You'll get this

dialog when you have selected a disk image (.dmg) 

and inserted a blank CD.

Download Lowdown

If you want to get your disk image ready for online distribution instead of via CD, the first thing to do is get that extra space out of the disk image. To do this, while still in Disk Utility, select the disk image in the left pane (if it's not there, you can drag it in from the Finder, or choose Images --> Open), and then choose Images --> Convert. Pick Compressed as the image format, and let 'er rip. Soon you'll have your compressed image. (For fun, you can go into the Finder and Get Info on both the original and compressed images. You'll see that the original is 40 Mb, or whatever other value you specified when you created it, and the compressed version not only gets rid of the unused space, it compresses the files, so the image uses less space than the original files.)

You might notice that Disk Utility keeps track of all the disk images it has ever seen on its little shelf over in the left pane. The way to get rid of those isn't obvious: just drag them off and drop them anywhere but the pane, and they'll go poof.

Once you have the compressed image, you're done. You can post it online for downloading. Let's take a look at the experience users have when downloading a disk image with a web browser. If you download a disk image with a non-Apple browser, such as Internet Explorer or Camino, here's the typical experience:

    1. User clicks a link to download the disk image file. The file goes into the Downloads folder.

    2. In the Finder, in the Downloads folder, the user double-clicks the disk image. The Finder decompresses the disk image and mounts it. Usually, the disk automatically opens.

    3. The user drags the downloaded application to the hard disk, usually to the Applications folder.

    4. The user ejects the mounted disk image.

    5. The confused, exhausted user drags the disk image file to the trash.

When Safari appeared in January 2003, Apple made it smarter than the average bear for downloading disk images. Safari knows how to decompress and mount disk images all by itself, without having to ask the Finder for help. So when you download a disk image with Safari, there's one less step: you don't have to switch to the Finder and double-click the disk image file. That's progress.

Becoming an Enabler

When Mac OS 10.2.3 arrived, Apple made the download experience even better, as long as you were using Safari. Mac OS 10.2.3 introduced the groovy concept of Internet-enabled disk images, which make the download experience even better. When users download an Internet-enabled disk image, Safari decompresses the file and mounts the virtual disk, as usual. But then, it continues by copying the disk's contents to the Downloads folder, ejecting the mounted disk image, and moving the disk image file to the trash. That's pretty cool for users. All they have to do at that point is visit the files in the Downloads folder and copy them to their final destination. And Internet-enabled disk images are compatible with all browsers and Mac OS X versions. Users who are not running Safari with Mac OS X 10.2.3 or later will still get the old, standard behavior.

How do you make an Internet-enabled disk image? I was hoping you would ask that question. It's free and oh-so-easy. You merely have to issue a single instruction using hdiutil, a command line utility that comes with Mac OS X. To Internet-enable your favorite disk image, just go to the Terminal and type

   hdiutil internet-enable -yes SuperWare.dmg

Of course, make sure you have the right path to your disk image file. As always, you can drag the file into the Terminal window from the Finder if you want to be sure. If you do it right, hdiutil will confirm back to you thusly:

   hdiutil: internet-enable: enable succeeded

That's all there is to it. Sure, it would be nice if Disk Utility had a command for Internet-enabling, and it surely will in the future, but for now, this is how we do it. If you find distasteful even this extremely brief journey into Unix, you can use the donationware program IDIot, which makes it super-simple to Internet-enable a disk image. IDIot is available at http://www.ifthensoft.com/idiot.hqx . And if you want to read all about Internet-enabled disk images from the folks who invented them, see http://developer.apple.com/ue/files/iedi.html.

Master and Commander

As we have seen, Disk Utility makes it pretty darn easy to create disk images, and with just a little tweak under the hdiutil hood, we can improve the user experience by making disk images Internet-enabled. If you're the command-line type, or you need to write shell scripts to manipulate your disk images, you should consider hdiutil for more than just the bit part described above.

You can perform the same basic functions with hdiutil as you can with Disk Utility, plus lots more geeky stuff. For example, earlier we used Disk Utility to create a disk image, copy files to the image, then compress it for optimum online distribution. Let's do the same steps with hdiutil. First, we create the disk image itself and ask the operating system to mount it:

[neb:~] scott% hdiutil create -size 40m -fs HFS+ -volname "SuperWare" SuperWare.dmg

Initializing...
Creating...
...............................................................................
Formatting...
Finishing...
created: /Users/scott/SuperWare.dmg

[neb:~] scott% hdiutil mount SuperWare.dmg
Initializing...
Attaching...
Finishing...
Finishing...
/dev/disk2              Apple_partition_scheme         
/dev/disk2s1            Apple_partition_map            
/dev/disk2s2            Apple_HFS                       /Volumes/SuperWare

Note the aid and coddling that Disk Utility gave us when we used it previously. Disk Utility thoughtfully assumed we needed an HFS+ disk, wanted the volume name to be the same as the filename of the image, and would like to mount the new volume. When we use hdiutil, we have to explicitly choose the file system and volume name we want, and we need a second command to mount the volume. Of course, this little bit of extra work also indicates that hdiutil provides us with extra flexibility. For example, you can choose a different file system, or a volume name that's not the same as the file name when you use hdiutil. As an extreme example of the flexibility of hdiutil, it lets you specify the size of the disk image in various units, including megabytes, gigabytes, terabytes, petabytes, and exobytes. An exobyte is a gigabyte of gigabytes. That's thinking ahead!

At this point, we're ready to copy the desired files to the disk image. Of course, we can use the command line or the Finder for this, or both. You'll probably want to use the Finder for delicate icon positioning and tweaking Finder view settings. Once the disk image has everything you want, unmount it:

[neb:~] scott% hdiutil unmount /Volumes/SuperWare 
hdiutil: unmount: LetIOKitSettleDown: (timed out)
"disk2s2" unmounted successfully.

After unmounting, we can use hdiutil to burn a CD, like so:

[neb:~] scott% hdiutil burn SuperWare.dmg

Preparing data for burn
Opening session
Opening track
Writing track
.............................................................
Closing track
Closing session
Finishing burn
Verifying burn...
Verifying
.............................................................
Burn completed successfully
.............................................................

hdiutil: burn: completed

Burning a CD with hdiutil is like a game: you see how many dots you can get before more text appears. No fancy-pants Aqua progress bars here! If you're not going to burn a CD, but you instead want to prepare the disk image for downloading, you need to compress it, as we did with Disk Utility. With hdiutil, that works as follows:

[neb:~] scott% hdiutil convert -format UDCO -o SuperWare_online.dmg SuperWare.dmg

Preparing imaging engine...
Reading DDM...
   (CRC32 $767AD93D: DDM)
Reading Apple_partition_map (0)...
   (CRC32 $DD66DE0F: Apple_partition_map (0))
Reading Apple_HFS (1)...
.............................................................
   (CRC32 $9F4C65C5: Apple_HFS (1))
Reading Apple_Free (2)...
.............................................................
   (CRC32 $00000000: Apple_Free (2))
Terminating imaging engine...
Adding resources...
.............................................................
Elapsed Time:  1.074s
 (1 task, weight 100)
File size: 31489 bytes, Checksum: CRC32 $A3B0383C
Sectors processed: 81920, 1345 compressed
Speed: 626.0Kbytes/sec
Savings: 97.6%
created: SuperWare_online.dmg

In amongst all that geeky progress reporting, we've created our compressed image in the file SuperWare_online.dmg. The -format UDCO option is the way you create a compressed image. And by the way, if you would rather not see Terminal spew all that stuff at you, most hdiutil commands include a -quiet option to suppress output. To find out about all the features of hdiutil - and there are an enormous number of them - check out man hdiutil. Most hdiutil commands have their own individual help commands, which you can get by typing hdiutil, the command name, and the -help option, like this:

[neb:~] scott% hdiutil unmount -help
hdiutil unmount: unmount a mounted partition
Usage:  hdiutil unmount <mountpoint>
        Options:
            -force              force unmount

        Common options:
            -verbose
            -debug
            -quiet

Another powerful option for creating disk images is DropDMG, a $10 utility written by Michael Tsai. This program provides a nice Aqua UI with more disk image creation features than Disk Utility, has a thorough AppleScript dictionary, and is also available from the command line. You can get DropDMG at http://www.c-command.com/dropdmg/index.shtml.

You might also be interested in BootCD, a free utility for making disk images that create bootable CDs. BootCD is available at http://www.charlessoft.com/.

Coming Soon

As we mentioned at the start, disk images are only one way of passing out software. Disk images are great for distributions that are simple enough to allow drag-and-drop installation. However, drag installing leaves behind older copies of the application, which can confuse the Finder. And if you have more complex requirements, such as needing to put files in various places on the disk, run code while you're installing, or install on OS 9 as well as OS X, you'll need an installer.

You can use the PackageMaker and Installer tools provided by Apple, or get a more powerful third-party tool, such as Installer VISE, VISE X, or FileStorm from MindVision, or StuffIt InstallerMaker from Aladdin. Many commercial developers prefer those third-party programs for complex installations, but Apple's built-in tools are easy to use, improving, and free - if you have OS X, you already own them. In next month's column, we'll take a look at how to use these tools to create your own installers. Until then, get your software coded, tested, debugged, and documented, so you'll be all ready to distribute it.


Scott Knaster has been writing about Macs for as long as there have been Macs. Scott wrote developer books for General Magic, worked on SDK stuff for Danger, and contributed to the first user manual for the Philips Velo. Scott's hobby is gaining and losing weight.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

ExpanDrive 6.1.8 - Access cloud storage...
ExpanDrive builds cloud storage in every application, acts just like a USB drive plugged into your Mac. With ExpanDrive, you can securely access any remote file server directly from the Finder or... Read more
DiskCatalogMaker 7.2.7 - Catalog your di...
DiskCatalogMaker is a simple disk management tool which catalogs disks. Simple, light-weight, and fast Finder-like intuitive look and feel Super-fast search algorithm Can compress catalog data for... Read more
DiskCatalogMaker 7.2.7 - Catalog your di...
DiskCatalogMaker is a simple disk management tool which catalogs disks. Simple, light-weight, and fast Finder-like intuitive look and feel Super-fast search algorithm Can compress catalog data for... Read more
Iridient Developer 3.2.1 - Powerful imag...
Iridient Developer (was RAW Developer) is a powerful image-conversion application designed specifically for OS X. Iridient Developer gives advanced photographers total control over every aspect of... Read more
BusyContacts 1.2.7 - Fast, efficient con...
BusyContacts is a contact manager for OS X that makes creating, finding, and managing contacts faster and more efficient. It brings to contact management the same power, flexibility, and sharing... Read more
MegaSeg 6.0.5 - Professional DJ and radi...
MegaSeg is a complete solution for pro audio/video DJ mixing, radio automation, and music scheduling with rock-solid performance and an easy-to-use design. Mix with visual waveforms and Magic... Read more
BusyContacts 1.2.7 - Fast, efficient con...
BusyContacts is a contact manager for OS X that makes creating, finding, and managing contacts faster and more efficient. It brings to contact management the same power, flexibility, and sharing... Read more
MegaSeg 6.0.5 - Professional DJ and radi...
MegaSeg is a complete solution for pro audio/video DJ mixing, radio automation, and music scheduling with rock-solid performance and an easy-to-use design. Mix with visual waveforms and Magic... Read more
Iridient Developer 3.2.1 - Powerful imag...
Iridient Developer (was RAW Developer) is a powerful image-conversion application designed specifically for OS X. Iridient Developer gives advanced photographers total control over every aspect of... Read more
iFFmpeg 6.6.1 - Convert multimedia files...
iFFmpeg is a comprehensive media tool to convert movie, audio and media files between formats. The FFmpeg command line instructions can be very hard to master/understand, so iFFmpeg does all the hard... Read more

Latest Forum Discussions

See All

The best deals on the App Store this wee...
A new week means new discounts on the App Store. This week's deals run the gamut of action-adventure titles, puzzle games, and one of the best narrative adventure series out there. If you're looking to fill out your mobile gaming library on a... | Read more »
What you need to know about Animal Cross...
We hope you've been hard at work on collecting all of those holiday items in Animal Crossing: Pocket Camp, because you're about to get a whole new list of fun things to do as the game receives its first big update sometime soon. There are a lot of... | Read more »
Reigns: Her Majesty guide - how to use e...
Ruling a kingdom isn't easy--doubly so for a queen whose every decision is questioned by the other factions seeking a slice of power. Reigns: Her Majesty builds on the original game's swipey tactics, adding items that you can use to move the story... | Read more »
The best new games we played this week -...
Friday has crept up on us once again, so it's time to honor the best new games we've played over the past few days. This past week was a pretty exciting one, with the debut of lots of beautiful new indies and some familiar faces returning to the... | Read more »
Portal Knights guide- beginner tips and...
Portal Knights is finally making the jump to iOS and Android, and it's already climbing the ranks to become the next big MMO experience on mobile. This sprawling sandbox game will let you pursue any adventure you wish, whether you want to sling... | Read more »
Reigns: Her Majesty guide - how to swipe...
Reigns: Her Majesty is storming the App Store this week, bringing more tinder-esque kingdom building to eager players everywhere. If you've played the original Reigns, you'll know that leading a kingdom is never easy. It's a careful balancing act... | Read more »
Getting Over It (Games)
Getting Over It 1.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: A game I madeFor a certain kind of person To hurt them. • Climb up an enormous mountain with nothing but a hammer and a pot.•... | Read more »
Reigns: Her Majesty (Games)
Reigns: Her Majesty 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: | Read more »
Pocket Legends Adventures guide - how to...
Pocket Legends Adventures is a fun action adventure RPG that takes control when you want it to, but also opens itself for player input, too, if you're looking to tkae a more active role in combat. Regardless of play style, the game can be quite... | Read more »
Portal Knights (Games)
Portal Knights 1.2.4 Device: iOS Universal Category: Games Price: $4.99, Version: 1.2.4 (iTunes) Description: Craft your adventure. Forge your hero. Become the ultimate Portal Knight! | Read more »

Price Scanner via MacPrices.net

Green Monday deal: 15″ 2.8GHz MacBook Pro on...
B&H Photo has the 15″ 2.8GHz Space Gray MacBook Pro on sale for $250 off MSRP for today only as part of their Green Monday/Holiday sale. Shipping is free, and B&H charges sales tax for NY... Read more
Green Monday sale: B&H offers 12″ Apple i...
B&H Photo has 12″ iPad Pros on sale for up to $150 off MSRP as part of their Green Monday/Holiday sale. Shipping is free, and B&H charges sales tax in NY & NJ only: – 12″ 64GB WiFi iPad... Read more
Holiday deal: 21″ and 27″ Apple iMacs on sale...
MacMall has 2017 21″ and 27″ Apple iMacs on sale for up to $200 off MSRP. Shipping is free: – 21″ 2.3GHz iMac: $999 $100 off MSRP – 21″ 3.0GHz iMac: $1199 $100 off MSRP – 21″ 3.4GHz iMac: $1379 $120... Read more
Holiday deal: Apple Mac minis for up to $150...
MacMall has Mac minis on sale for up to $100 off MSRP, each including free shipping: – 1.4GHz Mac mini: $399 $100 off MSRP – 2.6GHz Mac mini: $599 $100 off MSRP – 2.8GHz Mac mini: $949 $50 off MSRP... Read more
Beats by Dr. Dre – BeatsX Earphones on sale f...
Best Buy has BeatsX Earphones on sale for $109, $40 off, on their online store. Sale price for online orders only. Choose free store pickup, if available, or choose free shipping. Read more
10″ 64GB WiFi Apple iPad Pros on sale for $59...
MacMall has 10.5″ 64GB Apple iPad Pros on sale for $599 including free shipping. That’s $50 off MSRP and among the lowest prices available for these iPads from any Apple reseller. Read more
15″ 2.2GHz MacBook Pros on sale for $200-$300...
B&H Photo has the 15″ 2.2GHz MacBook Pro available for $200 off MSRP including free shipping plus NY & NJ sales tax only: – 15″ 2.2GHz MacBook Pro (MJLQ2LL/A): $1799 $200 off MSRP Apple has... Read more
Holiday sale: 15″ MacBook Pros for $200-$420...
MacMall has 15″ MacBook Pros on sale for $220-$300 off MSRP, each including free shipping: – 15″ 2.8GHz MacBook Pro Space Gray (MPTR2LL/A): $2179, $220 off MSRP – 15″ 2.8GHz MacBook Pro Silver (... Read more
Holiday sale: 13″ MacBook Airs for up to $150...
B&H Photo has 13″ MacBook Airs on sale for $100 off MSRP as part of their Holiday sale. Shipping is free, and B&H charges sales tax for NY & NJ residents only: – 13″ 1.8GHz/128GB MacBook... Read more
The best Holiday sale prices on 13″ MacBook P...
B&H Photo has 13″ MacBook Pros on sale this weekend, with models available for $100-$150 off MSRP. Shipping is free, and B&H charges sales tax for NY & NJ residents only: – 13-inch 2.3GHz... Read more

Jobs Board

*Apple* Retail - Multiple Positions - Apple,...
Job Description:SalesSpecialist - Retail Customer Service and SalesTransform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
*Apple* Retail - Multiple Positions - Apple,...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
*Apple* Retail - Multiple Positions - Apple,...
Job Description:SalesSpecialist - Retail Customer Service and SalesTransform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
*Apple* Information Security - Security Data...
# Apple Information Security - Security Data Analyst Job Number: 113119545 Austin, Texas, United States Posted: 10-Nov-2017 Weekly Hours: 40.00 **Job Summary** This Read more
*Apple* Retail - Multiple Positions - Apple,...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.