Editing Create a MacOS X App Bundle Using MacPorts
Jump to navigation
Jump to search
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 1: | Line 1: | ||
==Install MacPorts== | ==Install MacPorts== | ||
Line 19: | Line 9: | ||
* MacPorts has good support for Octave. A list of what MacPorts has available for Octave is [http://www.macports.org/ports.php?by=name&substr=octave here]. To install the most recent version of Octave, type {{Codeline|<nowiki>sudo port install octave-devel</nowiki>}} at the Terminal's command line. Octave has many dependencies which will be downloaded and installed prior to Octave. The entire installation process can take a few hours. | * MacPorts has good support for Octave. A list of what MacPorts has available for Octave is [http://www.macports.org/ports.php?by=name&substr=octave here]. To install the most recent version of Octave, type {{Codeline|<nowiki>sudo port install octave-devel</nowiki>}} at the Terminal's command line. Octave has many dependencies which will be downloaded and installed prior to Octave. The entire installation process can take a few hours. | ||
MacPorts has historically been rather good a maintaining their Octave portfiles. However, there are times when the | MacPorts has historically been rather good a maintaining their Octave portfiles. However, there are times when the maintainer fall behind. If the current version of the [http://www.macports.org/ports.php?by=name&substr=octave-devel octave-devel] port isn't current, it will be necessary to produce a local portfile. For the remainder of this page, it is assume a local portfile is being used and that the port name is {{Codeline|<nowiki>octave-local</nowiki>}}. | ||
===Install an Octave Port=== | ===Install an Octave Port=== | ||
MacPorts | For the purpose of creating an App bundle using MacPorts, an Octave port must be installed. A standard MacPorts port or a local port may be used. For a local portfile it is first required that a [http://guide.macports.org/chunked/development.local-repositories.html local portfile repository be created] and the local portfile placed there. | ||
A [[Prototype MacPorts PortFile|prototype portfile]] | MacPorts' Octave port includes the non-GPL [http://glaros.dtc.umn.edu/gkhome/views/metis METIS]. To avoid license violations do not bundle Metis with Octave and then distribute to others. A second motivation to use a local portfile is that the portfiles for the 3.4.x and 3.6.x series did not include all dependencies for the {{Codeline|<nowiki>print</nowiki>}} feature. The missing dependencies are [http://www.macports.org/ports.php?by=name&substr=epstool epstool], [http://www.macports.org/ports.php?by=name&substr=pstoedit pstoedit], and [http://www.macports.org/ports.php?by=name&substr=transfig transfig]. A [[Prototype MacPorts PortFile|prototype portfile]] which does not depend upon METIS and does depend upon epstool, pstoedit, and transfig has been prepared. | ||
After [http://guide.macports.org/chunked/development.local-repositories.html creating a local portfile repository] an Octave portfile may be added to the local repository using the commands below. | |||
<nowiki>mkdir -p ~/ports/math/octave-local | <nowiki>mkdir -p ~/ports/math/octave-local | ||
cp ~/Desktop/portfile ~/ports/math/octave-local</nowiki> | cp ~/Desktop/portfile ~/ports/math/octave-local</nowiki> | ||
This assumes the Octave portfile had been placed on the | This assumes the Octave portfile had been placed on the users Desktop, and that the local portfile repository is located in the users home folder and named {{Codeline|<nowiki>ports</nowiki>}}. After adding the portfile, the local repository must be indexed for MacPorts to recognize it. | ||
<nowiki>cd ~/ | <nowiki>cd ~/portfile | ||
portindex -f</nowiki> | portindex -f</nowiki> | ||
Once indexed the local Octave port may be installed. | Once indexed the local Octave port may be installed. | ||
<nowiki>sudo port install octave-local | <nowiki>sudo port install octave-local +accelerate+gcc45</nowiki> | ||
As a precaution against unexpected problems and a bloated App bundle, using consistent variants for Octave and its dependents is suggested. For example, when using | As a precaution against unexpected problems and a bloated App bundle, using consistent variants for Octave and its dependents is suggested. For example, when using {{Codeline|+accelarate}} make sure none of the dependents are using {{Codeline|+atlas}}. Also, make sure no dependents are using the {{Codeline|+universal}} variant. Using the {{Codeline|+gcc45}} variant is also recommended as all of Octave's dependents have a {{Codeline|+gcc45}} variant. At the very least, following these suggestions will reduce the size of the bundle. The name of Octave's dependent ports may be determined by the command below. | ||
<nowiki>port | <nowiki>port deps octave-local</nowiki> | ||
The installed variants for each port may be determined by the command below. Be sure to replace " | The installed variants for each port may be determined by the command below. Be sure to replace "portname" with the name of the port. | ||
<nowiki>port installed | <nowiki>port installed portname</nowiki> | ||
Once an Octave port is installed the command below may be used to determine / verify the version and variants of < | Once an Octave port is installed the command below may be used to determine / verify the version and variants of {{Codeline|<nowiki>octave-local</nowiki>}} which are installed. | ||
<nowiki>port installed octave-local</nowiki> | <nowiki>port installed octave-local</nowiki> | ||
==Create the MacOS X App Bundle== | ==Create the MacOS X App Bundle== | ||
There are effectively four tasks needed to produce the App bundle. First, Octave and all its build and run-time dependencies must be extracted from the MacPorts installation. Second a App bundle template for running a shell script is required. This may be done using the MacOS X | There are effectively four tasks needed to produce the App bundle. First, Octave and all its build and run-time dependencies must be extracted from the MacPorts installation. Second a App bundle template for running a shell script is required. This may be done using the MacOS X developer tool, Platypus. Third, the shell script which the App bundle runs is needed. This script will be used to launch the [http://en.wikipedia.org/wiki/Terminal_(OS_X) MacOS X Terminal app]. This script is referred to as the ''App's shell script''. Finally, a script for setting up the shell environment for Octave and running Octave is required. This script is referred to as the ''Octave shell script''. | ||
===Produce a DMG for Octave and its dependencies=== | ===Produce a DMG for Octave and its dependencies=== | ||
Line 67: | Line 46: | ||
MacPorts provides a feature for [http://guide.macports.org/index.html#using.binaries.binary-packages producing binary packages] with standalone binary installers that are precompiled; they do not require MacPorts on the target system. Binary files created with MacPorts may be either .pkg (Mac OS X Installer Packages), or RPM (RPM Package Manager) format. MacPorts may also process a .pkg package into a Mac OS X .dmg disk image file. The port command shown below will create a DMG type binary installer for the Octave port and all its dependencies. | MacPorts provides a feature for [http://guide.macports.org/index.html#using.binaries.binary-packages producing binary packages] with standalone binary installers that are precompiled; they do not require MacPorts on the target system. Binary files created with MacPorts may be either .pkg (Mac OS X Installer Packages), or RPM (RPM Package Manager) format. MacPorts may also process a .pkg package into a Mac OS X .dmg disk image file. The port command shown below will create a DMG type binary installer for the Octave port and all its dependencies. | ||
<nowiki>sudo port mdmg octave- | <nowiki>sudo port mdmg octave-local</nowiki> | ||
If more than one version of Octave is installed, or if more than one variant of Octave has been installed, the version and variant should be included. | |||
<nowiki>sudo port mdmg octave-local @<version>+variant1+variant2</nowiki> | |||
<nowiki> | The DMG will be placed in the port's {{Codeline|<nowiki>work</nowiki>}} directory. If a local portfile is used, a symbolic link to the {{Codeline|<nowiki>work</nowiki>}} directory will be placed in the directory containing the portfile. In this instance the DMG can be found in {{Codeline|<nowiki>~/ports/math/octave-local/work</nowiki>}}. | ||
The | The DMG produced using the [http://www.octave.org/wiki/index.php?title=Prototype_MacPorts_PortFile prototype portfile's] does not include everything needed for Octave. Both {{Codeline|macros.texi}}, {{Codeline|octave.info}}, and the {{Codeline|octave.info-#}} files are missing. Until the cause for these missing files is identified and resolved, they will have to be copied manually to the App bundle. | ||
===Use Platypus to produce a template for the App bundle=== | |||
[[File:Platypus.png|400px|thumb|right|Initial Platypus Dialog (click to enlarge)]] | |||
To creating an application bundle for MacOS X the utility, [http://sveinbjorn.org/platypus Platypus], is used. Platypus is a developer tool for the Mac OS X operating system which is intended to create native Mac OS X applications from interpreted scripts such as shell scripts or Perl, Ruby and Python programs. | |||
A shell script intended to launch a [http://en.wikipedia.org/wiki/Terminal_(OS_X) MacOS X Terminal] and run Octave will be used as the basis for the MacOS X App bundle. The itemize list below describes how to produce an App bundle template for Octave. Once this has been done, it the App bundle template must be populated with Octave and its dependencies. | |||
* Run the Platypus application. | |||
* Import Octave's [http://www.octave.org/wiki/index.php?title=File:Icon.png icon]. | |||
** The icon linked to above is a png with a transparent background. This feature is needed to produce a MacOS X application icon. | |||
* Run the | ** Using the icon linked to above the ''Icon Composer'' developers utility may be used to create a MacOS X icon. The Icon Composer is part of Xcode's developer's tools. Its home is {{Codeline|<nowiki>/Developer/Applications/Icon Composer.app</nowiki>}} | ||
* Set the "Script Type" to "Shell" | |||
* Specify the "Script Path". | |||
** Click on the "Select" button and select the [[MacOS_X_App_Launcher_Script|App shell script]] used to launch the Terminal app. | |||
* Set the "Output" to "None". | |||
* Specify App Name (Octave-3.7.0+). | |||
* Click the "Create" button. | |||
* | * Save the App bundle template to the location of your choice. | ||
===Populate the App Bundle=== | ===Populate the App Bundle=== | ||
Line 118: | Line 83: | ||
<nowiki>sudo mv /opt /opt-save</nowiki> | <nowiki>sudo mv /opt /opt-save</nowiki> | ||
* Install the MacPorts Octave DMG, which as placed on the MacOS X Desktop. Installing the DMG will create a new {{Codeline|<nowiki>/opt</nowiki>}} directory containing Octave and all its build and run-time dependencies. To avoid conflict with the original MacPorts installation. | * Install the MacPorts Octave DMG, which as placed on the MacOS X Desktop. Installing the DMG will create a new {{Codeline|<nowiki>/opt</nowiki>}} directory containing Octave and all its build and run-time dependencies. To avoid conflict with the original MacPorts installation. | ||
* Place the [[MacOS_X_App_Octave_Shell_Script| Octave shell script]] in the same directory as the App bundle template created using | * Place the [[MacOS_X_App_Octave_Shell_Script| Octave shell script]] in the same directory as the App bundle template created using Platypus. | ||
* Populate the App bundle by running the script below from the directory containing the App bundle template and the [[MacOS_X_App_Octave_Shell_Script| Octave shell script]]. | * Populate the App bundle by running the script below from the directory containing the Platypus App bundle template and the [[MacOS_X_App_Octave_Shell_Script| Octave shell script]]. | ||
<nowiki>#! /bin/sh | <nowiki>#! /bin/sh | ||
VERSION=3.7.0+ | VERSION=3.7.0+ | ||
Line 126: | Line 91: | ||
MACPORTS_PREFIX="/opt/local/" | MACPORTS_PREFIX="/opt/local/" | ||
cp -pRf ${MACPORTS_PREFIX} ${FULLAPP}/Contents/Resources/. | cp -pRf ${MACPORTS_PREFIX} ${FULLAPP}/Contents/Resources/. | ||
rm ${FULLAPP}/Contents/Resources/bin/octave | rm ${FULLAPP}/Contents/Resources/bin/octave | ||
cp octave ${FULLAPP}/Contents/Resources/bin/. | cp octave ${FULLAPP}/Contents/Resources/bin/. | ||
mkdir ${FULLAPP}/Contents/Resources/Applications | mkdir ${FULLAPP}/Contents/Resources/Applications | ||
Line 137: | Line 100: | ||
The Octave App bundle for MacOS X is now ready to run. | The Octave App bundle for MacOS X is now ready to run. | ||
==Running Octave from the Terminal's Command Line== | ==Running Octave from the Terminal's Command Line== | ||
Line 168: | Line 118: | ||
* When Octave is running, clicking on Octave's icon in the dock has no effect. This is because the App bundle runs a shell script which launches Terminal.app which runs Octave. To locate the Octave session, click on the Terminal.app. | * When Octave is running, clicking on Octave's icon in the dock has no effect. This is because the App bundle runs a shell script which launches Terminal.app which runs Octave. To locate the Octave session, click on the Terminal.app. | ||
* Only one instance of the App may be run by clicking on the app. Multiple instances may be run from the command line. | * Only one instance of the App may be run by clicking on the app. Multiple instances may be run from the command line. | ||
* | * In some instances, the Octave binary attempts to load an library whose version number is older than the one it intended to link to (at build time). This will produce an error like to one below. The developer utility, [http://macdylibbundler.sourceforge.net/ dylibbundler], is useful in pointing to and/or bundling dynamic libraries in an App bundle. This utility automates the use of [https://developer.apple.com/library/mac/#documentation/Darwin/Reference/Manpages/man1/install_name_tool.1.html {{Codeline|install_name_tool}}]. These errors may linger as the application of this tool requires some experimentation in this case. | ||
<nowiki>dyld: Library not loaded: /opt/local/libiconv.2.dylib</nowiki> | <nowiki>dyld: Library not loaded: /opt/local/libiconv.2.dylib</nowiki> | ||
===Fixing "{{Codeline|dyld: Library not loaded}}" Errors=== | ===Fixing "{{Codeline|dyld: Library not loaded}}" Errors=== | ||
If an error such as the one | If an error such as the one below is encountered; | ||
<nowiki>dyld: Library not loaded: /opt/local/libiconv.2.dylib</nowiki> | |||
It is likely due to the Bundle looking in the original install path rather than in the App bundle for the library. This can be fixed using the developer utility [https://developer.apple.com/library/mac/#documentation/Darwin/Reference/Manpages/man1/install_name_tool.1.html {{Codeline|install_name_tool}}]. | |||
To point to the correct location for the library, first determine the library's location in the App bundle. In this instance the library's path is {{Codeline|Octave-3.7.0+.app/Contents/Resources/lib/libiconv.2.dylib}}. Next open a Terminal session, {{Codeline|cd}} to the Resources directory and repair Octave's binary. | To point to the correct location for the library, first determine the library's location in the App bundle. In this instance the library's path is {{Codeline|Octave-3.7.0+.app/Contents/Resources/lib/libiconv.2.dylib}}. Next open a Terminal session, {{Codeline|cd}} to the Resources directory and repair Octave's binary. | ||
Line 179: | Line 131: | ||
To check the binary for other occurances of this problem, type the command below. | To check the binary for other occurances of this problem, type the command below. | ||
<nowiki>otool -L Octave-3.7.0+</nowiki> | <nowiki>otool -L Octave-3.7.0+</nowiki> | ||
The developer utility, [http://macdylibbundler.sourceforge.net/ dylibbundler], is intended to automate this process. If such/similar problems are encountered, please notify Octave's developers, by [http://www.gnu.org/software/octave/bugs.html filling a bug report], so that the problem can be permanently repaired. | |||
==Testing== | ==Testing== | ||
Those interested in testing an App bundle can try [https://dl.dropbox.com/u/14845154/Octave-X86_64-3.7.0% | Those interested in testing an App bundle can try [https://dl.dropbox.com/u/14845154/Octave-X86_64-3.7.0%2Bv5.dmg Octave-X86_64-3.7.0+v3.dmg (Dated: Jun 29, 2012 1:03 PM)]. The link will be periodically updated. The DMG is large (525+ MB). I kindly ask those with the patience to download it, to report results to bpabbott at mac dot com. Alternatively, if a bug is found [https://savannah.gnu.org/bugs/?group=octave file a bug report]. When reporting on your experience, please include; | ||
* The version of MacOS X you are running. | * The version of MacOS X you are running. | ||
** Note: This App bundle will ''not'' run on Mac OS 10.5 or earlier. | ** Note: This App bundle will ''not'' run on Mac OS 10.5 or earlier. | ||
* The Mac's processor (found under "About This Mac"). | * The Mac's processor (found under "About This Mac"). | ||
** Note: This App bundle will ''only'' run on 64 bit | ** Note: This App bundle will ''only'' run on Intel processors, and requires a 64 bit processor (X86_64). | ||
** If the App bundle doesn't run, it may necessary to enable 64 bit mode. See Apple's support page for instructions ⇒ [http://support.apple.com/kb/HT3773 OS X: Starting up with the 32-bit or 64-bit kernel]; | ** If the App bundle doesn't run, it may necessary to enable 64 bit mode. See Apple's support page for instructions ⇒ [http://support.apple.com/kb/HT3773 OS X: Starting up with the 32-bit or 64-bit kernel]; | ||
* Whether you have Fink, Homebrew, or MacPorts installed. | * Whether you have Fink, Homebrew, or MacPorts installed. | ||
* For intricate problems, please provide enough information so that others may duplicate it. | * For intricate problems, please provide enough information so that others may duplicate it. | ||
===Testing Results=== | ===Testing Results=== | ||
Results reported by some volunteers testing an App bundle are below. As some of the reported results are inconsistent, individuals are cautioned not interpret these results as definitive | Results reported by some volunteers testing an App bundle are below. As some of the reported results are inconsistent, individuals are cautioned to not interpret these results as definitive. | ||
* An App bundle built for arch=X86_64 on an Intel Core i7 MacBook Pro running MacOS 10.7 was found to run on the following; | :* An App bundle built for arch=X86_64 on an Intel Core i7 MacBook Pro running MacOS 10.7 was found to run on the following; | ||
: | ::* MacBook Pro (Intel Core i7) running MacOS 10.7 with MacPorts installed. | ||
:* MacBook Pro (Intel Core i7) running MacOS 10.7 with MacPorts installed. | ::* MacBook Pro (Intel Core i7) running MacOS 10.7 with no MacPorts, and no Fink, installed. | ||
:* MacBook Pro (Intel Core i7) running MacOS 10.7 with no MacPorts, and no Fink, installed. | ::* Macbook Pro (Intel Core-2 Duo 2.5 GHz) MacOS 10.6.8 with 64 bit support enabled, and with MacPorts installed. | ||
* | :::* To enable 64bit see Apple's support page ⇒ [http://support.apple.com/kb/HT3773 OS X: Starting up with the 32-bit or 64-bit kernel]. | ||
:* MacBook (Intel Core Duo) running MacOS 10.6 with no MacPorts, and no Fink, installed. The error encountered is below. | :* The App bundle did not run on; | ||
::* MacBook (Intel Core Duo) running MacOS 10.6 with no MacPorts, and no Fink, installed. The error encountered is below. | |||
<nowiki>$ cd /Applications/Octave-3.7.0+.app/Contents/Resources/bin/ | <nowiki>$ cd /Applications/Octave-3.7.0+.app/Contents/Resources/bin/ | ||
$ ./octave | $ ./octave | ||
The application cannot be opened because it has an incorrect executable format. | The application cannot be opened because it has an incorrect executable format. | ||
./octave: line 124: /Applications/Octave-3.7.0+.app/Contents/Resources/bin/octave-3.7.0+: Bad CPU type in executable</nowiki> | ./octave: line 124: /Applications/Octave-3.7.0+.app/Contents/Resources/bin/octave-3.7.0+: Bad CPU type in executable</nowiki> | ||
:* MacMini (Intel Core 2 Duo) running MacOS 10.6 with Fink installed. The error encountered is below. | ::* MacMini (Intel Core 2 Duo) running MacOS 10.6 with Fink installed. The error encountered is below. Enabling 64 bit did not effect this problem. | ||
<nowiki>terminate called after throwing an instance of '__gnu_cxx::__concurrence_lock_error' | <nowiki>terminate called after throwing an instance of '__gnu_cxx::__concurrence_lock_error' | ||
what(): __gnu_cxx::__concurrence_lock_error</nowiki> | what(): __gnu_cxx::__concurrence_lock_error</nowiki> | ||
:* MacMini (Intel Core 2 Duo) running MacOS 10.6 with no Fink or MacPorts installed. The error encountered is below. | ::* MacMini (Intel Core 2 Duo) running MacOS 10.6 with no Fink or MacPorts installed. The error encountered is below. | ||
<nowiki>terminate called after throwing an instance of '__gnu_cxx::__concurrence_lock_error' | <nowiki>terminate called after throwing an instance of '__gnu_cxx::__concurrence_lock_error' | ||
what(): __gnu_cxx::__concurrence_lock_error</nowiki> | what(): __gnu_cxx::__concurrence_lock_error</nowiki> | ||
[[Category:Mac]] | |||
[[Category: |