Editing Create a MacOS X App Bundle Using MacPorts

Jump to navigation Jump to search
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

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:
{{Warning|This page is outdated (October 2019).  For more recent information, see [[Octave for macOS]].}}
== Caveats ==
== Caveats ==


Since the initial success with producing a bundle, two things have changed on the Macports end.
{{Warning|Since the initial success with producing a bundle, two things have changed on the Macports end.
* gcc-4.7 must be used, as some dependencies are no longer supported by gcc-4.5. To look for ports using a <code>gcc45</code> variant, type <code>port rdeps gcc45</code> at the terminal's command line.
* gcc-4.7 must be used, as some dependencies are no longer supported by gcc-4.5. To look for ports using a <code>gcc45</code> variant, type <code>port rdeps gcc45</code> at the terminal's command line.
* The <code>sudo port mdmg octave-devel @3.6.4+atlas+docs+fltk+gcc47</code> command fails when bundling the <code>xorg-libx11</code> port.  Review the output of the command <code>port rdeps octave-devel @3.6.4+atlas+fltk+gcc47-x11+no_x11-metis</code> to identify the ports whose variants must be modified to avoid <code>gcc45</code> and <code>xorg-libx11</code>.  There is one dependency (<code>Transfig</code>) for which <code>x11</code> is not optional.  To resolve this, the <code>octave-devel</code> Portfile must be modified and the <code>Transfig</code> run-time dependency removed. This means that Xfig output is not available using Octave's <code>print()</code> function/command.
* The <code>sudo port mdmg octave-devel @3.6.4+atlas+docs+fltk+gcc47</code> command fails when bundling the <code>xorg-libX11</code> port.  To identify the why x11 is needed the command <code>port rdeps octave-devel @3.6.4_3+atlas+fltk+gcc47-x11+no_x11</code> may be used.  There is one dependency (<code>Transfig</code>) for which <code>x11</code> is not optional.  To resolve this, the <code>octave-devel</code> Portfile must be modified and the <code>Transfig</code> run-time dependency removed.
* While editing the Portfile for <code>octave-devel</code>, the references to <code>metis</code> should also be removed to avoid a GPL violation.
* While editing the Portfile for <code>octave-devel</code>, the references to <code>metis</code> should also be removed to avoid a GPL violation.
* Once the dependencies are resolved, the DMG may be created by <code>sudo port mdmg octave-devel @3.6.4+atlas+fltk+gcc47-x11+no_x11-metis</code>.
 
This means that Xfig output is not available using Octave's <code>print()</code> function/command.}}


==Install MacPorts==
==Install MacPorts==
Line 23: Line 22:
===Install an Octave Port===
===Install an Octave Port===


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. In order to eliminate the Metis dependency, a local portfile may be used, and edited to remove metis.  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 <code>print</code> 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 third motivation for a local portfile is to provide additional flexibility in resolving problems with creating an Octave DMG using the <code>port mdmg ...</code> command.  For macports 2.1.3, having the <code>xorg-libx11</code> as a dependency for Octave has been found to cause the <code>port mdmg octave-local ...</code> command to fail.  The <code>xorg-libx11</code> dependency may be avoided by specifying <code>-x11+no_x11-docs</code> as variants and by dropping the dependence to <code>transfig</code> (which has <code>xpm</code> as a dependency and <code>xpm</code> depends upon several <code>xorg-*</code> ports.
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.
 
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.


A [[Prototype MacPorts PortFile|prototype portfile]] has been prepared, which does not depend upon METIS and does depend upon <code>epstool</code>, and <code>pstoedit</code> (there is no <code>transfig</code> dependency since it generates an <code>xorg-libx11</code> dependency). 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.
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 user's Desktop, and that the local portfile repository is located in the users home folder and named <code>ports</code>. After adding the portfile, the local repository must be indexed for MacPorts to recognize it.
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 ~/ports
  <nowiki>cd ~/ports
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 @3.6.4+atlas+fltk+gcc47</nowiki>
  <nowiki>sudo port install octave-local +atlas+gcc47</nowiki>


The use of the <code>+atlas</code> variant is encouraged as bugs exist for Apple's accelerate framework in both MacOS 10.6 and 10.7.  Octave's developers have included a fix for MacOS 10.6, but the fix does not work for MacOS 10.7.  There is some commentary on this in various developers discussion forums.  For example, see [https://github.com/mxcl/homebrew/issues/6649 this Homebrew thread (Octave 3.4 fails on lion)], [https://stat.ethz.ch/pipermail/r-sig-mac/2011-September/008564.html this R-Sig-Mac thread (R 2.13.1-patched, vecLib problem on Lion)], and [http://list.coin-or.org/pipermail/ipopt/2011-October/002610.html the COIN-OR thread (Ipopt - problems on OS X 10.7 Lion)].  Use of Apple's accelerate framework should also be avoided for <code>arpack</code> and <code>qrupdate</code>.  To install the recommended variants, use the <code>port</code> commands below.
The use of the {{Codeline|+atlas}} variant is encouraged as bugs exist for Apple's {{Codeline|accelerate}} framework in both MacOS 10.6 and 10.7.  Octave's developers have included a fix for MacOS 10.6, but the fix does not work for MacOS 10.7.  There is some commentary on this in various developers discussion forums.  For example, see [https://github.com/mxcl/homebrew/issues/6649 this Homebrew thread (Octave 3.4 fails on lion)], [https://stat.ethz.ch/pipermail/r-sig-mac/2011-September/008564.html this R-Sig-Mac thread (R 2.13.1-patched, vecLib problem on Lion)], and [http://list.coin-or.org/pipermail/ipopt/2011-October/002610.html the COIN-OR thread (Ipopt - problems on OS X 10.7 Lion)].  Use of Apple's {{Codeline|accelerate}} framework should also be avoided for {{Codeline|arpack}} and {{Codeline|qrupdate}}.  To install the recommended variants, use the {{Codeline|port}} commands below.


  <nowiki>port install arpack +atlas+gcc47
  <nowiki>port install arpack +atlas+gcc47
port install qrupdate +atlas+gcc47</nowiki>
port install qrupdate +atlas+gcc47</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 <code>+atlas</code> make sure none of the dependents are using <code>+accelarate</code>. Also, make sure no dependents are using the <code>+universal</code> variant.  Using the <code>+gcc47</code> variant is also recommended as all of Octave's dependents have a <code>+gcc47</code> 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.
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|+atlas}} make sure none of the dependents are using {{Codeline|+accelarate}}. Also, make sure no dependents are using the {{Codeline|+universal}} variant.  Using the {{Codeline|+gcc47}} variant is also recommended as all of Octave's dependents have a {{Codeline|+gcc47}} 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 rdeps octave-local</nowiki>
  <nowiki>port deps octave-local</nowiki>


The installed variants for each port may be determined by the command below.  Be sure to replace "<portname>" with the name of the port.
The installed variants for each port may be determined by the command below.  Be sure to replace "<portname>" with the name of the port.
Line 47: Line 48:
  <nowiki>port installed <portname></nowiki>
  <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 <code>octave-local</code> which are installed.
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>
===Install Dependencies with Specific Variants===
There may be problems bundling some dependencies.  For example, bundling the <code>xorg-libx11</code> port may fail.  To alleviate this problem (or similar ones), the problematic port can be avoided as a dependency.  The command used to produce the octave-local DMG, <code>port mdmg octave-local +variant1+variant2+etc</code>, applies the listed variants to each of the dependencies.  Therefore, it is necessary to provide a proper aggregate list of dependencies.  For Octave 3.6.4, the list below were sufficient.
<pre>sudo port mdmg octave-devel @3.6.4+atlas+fltk+gcc47-x11+no_x11-metis+llvm32+ssl+qt</pre>
<span style="color: green;"> If run from a fresh macports installation (i.e. no ports have yet been installed), then this command should complete with no errors.</span>  If ports have already been installed, then errors during the execution of this command are likely and may be resolved by modifying the variant(s) of installed packages, and/or modifying the list of variants used to produce the <code>octave-local</code> DMG.  <span style="color: red;">One of Octave's dependencies, <code>transfig</code>, requires port <code>xpm</code>, which requires many xorg ports that may cause the <code>port mdmg ...</code> command to fail.  To alleviate this problem, the <code>transfig</code> port can be eliminated as a run-time dependency for Octave </span> (can the <code>transfig</code> portfile be modified to eliminate the <code>xpm</code> dependency?).


==Create the MacOS X App Bundle==
==Create the MacOS X App Bundle==
Line 67: Line 60:
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-devel @3.6.4+atlas+fltk+gcc47-x11+no_x11-metis+llvm32+ssl+qt</nowiki>
  <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>


In the event errors such as the one below are encountered, the ports implicated (<code> gtk2 </code> in this case) must be clean prior to creating the dmg.
In the event errors such as the one below are encountered, the ports implicated ({{Codeline|<nowiki>t1lib</nowiki>}} in this case) must be clean prior to creating the dmg.


  <nowiki>
  <nowiki>
Error: Requested variants "+quartz" do not match original selection "".
Error: Requested variants "+x11" do not match original selection "".
Please use the same variants again, perform 'port clean gtk2' or specify the force option (-f).
Please use the same variants again, perform 'port clean t1lib' or specify the force option (-f).
Error: org.macports.mpkg for port octave-local returned: Processing of port gtk2 failed</nowiki>
Error: org.macports.mpkg for port octave-devel returned: Processing of port t1lib failed</nowiki>


Be sure to clean each of the problematic ports prior to each attempt to create the dmg.
Be sure to clean each of the problematic ports prior to each attempt to create the dmg.


  <nowiki>sudo port clean gtk2</nowiki>
  <nowiki>sudo port clean cairo ; sudo port clean cctools ; sudo port clean pango ; sudo port clean t1lib</nowiki>
 
The ports <code>cctools</code> and <code>curl</code> consistently need to be cleaned prior to the <code>port mdmg octave-local ...</code> command.  The reason for this is not understood (yet), but one hint is seen during the compilation of the DMG.


<pre>Portfile changed since last build; discarding previous state.</pre>
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 DMG will be placed in the port's <code>work</code> directory.  If a local portfile is used, a symbolic link to the <code>work</code> directory will be placed in the directory containing the portfile.  In this instance the DMG can be found in <code>~/ports/math/octave-local/work</code>.
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.
 
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 <code>macros.texi</code>, <code>octave.info</code>, and the <code>octave.info-#</code> 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 (one possibility is that the <code>+docs</code> variant is not used.  Including the <code>+docs</code> variant would bundle <code>texlive</code> port as well as <code>xorg-libx11</code> and several other <code>xorg-*</code> ports.


===Create an Application Template for Octave===
===Create an Application Template for Octave===
Line 331: Line 324:
** This will allow for a fully automatic build of an App bundle from a shell script.
** This will allow for a fully automatic build of an App bundle from a shell script.
* Also use an AppleScript to record the creation of a MacOS X Octave icon.
* Also use an AppleScript to record the creation of a MacOS X Octave icon.
 
[[Category:Mac]]
[[Category:Outdated pages]]
Please note that all contributions to Octave may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see Octave:Copyrights for details). Do not submit copyrighted work without permission!

To edit this page, please answer the question that appears below (more info):

Cancel Editing help (opens in new window)

Templates used on this page: