Update macOS build instructions #995

dakira · 2018-09-20T05:40:22Z

Hey,

I tried the build instructions in the wiki but it seems Zeal moved to using cmake instead of qmake/make since those instructions were written.

Do you have any updated hints on building Zeal on a Mac?

trollixx · 2018-09-20T13:23:14Z

I don't use macOS, so somebody else needs to update the wiki. Generally the process should be pretty similar to building on Linux.

dakira · 2018-09-20T14:52:13Z

@trollixx thanks, I'll try to figure it out. Which version of Qt5 would you recommend?

trollixx · 2018-09-20T15:24:25Z

Always aim for the latest version, current you need at least 5.6.

dakira · 2018-09-20T19:23:55Z

Looks like the problem is the dependency on qtwebkit instead of qtwebengine because the former is not shipped anymore with all Qt versions since 5.6. So it's not that easy to get the dependencies together.

markwu · 2018-11-25T18:12:43Z

I have a homebrew formula if you want to try it.

https://github.com/markwu/homebrew-personal/blob/master/Formula/zeal.rb

Please keep cmake in version 3.12.x and qt in version 5.5 (Already removed from homebrew-core), it will build zeal successfully.

But, It will failed to build zeal in newest cmake version 3.13.x and qt 5.11.1.

markwu · 2018-11-25T18:41:40Z

it is error messages came from cmake 3.13.0 and qt 5.11.1.

Last 15 lines from /Users/markwu/Library/Logs/Homebrew/zeal/01.cmake:
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Detecting C compile features
-- Detecting C compile features - done
-- Check for working CXX compiler: /usr/local/Homebrew/Library/Homebrew/shims/mac/super/clang++
-- Check for working CXX compiler: /usr/local/Homebrew/Library/Homebrew/shims/mac/super/clang++ -- works
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Detecting CXX compile features
-- Detecting CXX compile features - done
-- Found LibArchive: /usr/local/opt/libarchive/lib/libarchive.dylib (found version "3.3.3")
-- Found SQLite: /usr/lib/libsqlite3.dylib (found version "3.24.0")
-- Configuring done
CMake Error: AutoUic (Registry): The uic executable "" does not exist

trollixx · 2018-11-25T19:11:51Z

Seems like you don't have uic installed. It should be part of the Qt installation.

markwu · 2018-11-26T03:14:08Z

The uic executable is there, I fixed that problem after downgrade cmake to 3.12.x. I guess it is the bug of cmake 3.13.0.

But new error messages comes, I still trying to figure it out:

==> Downloading https://github.com/zealdocs/zeal/archive/v0.6.1.tar.gz
Already downloaded: /Users/markwu/Library/Caches/Homebrew/downloads/317934405fce17c9a1ce09ff56d59254224b67e098b2d531d0fe801f88d34796--zeal-0.6.1.tar.gz
==> Patching
patching file src/libs/core/CMakeLists.txt
==> cmake ..
Last 15 lines from /Users/markwu/Library/Logs/Homebrew/zeal/01.cmake:
  any of the following names:

    Qt5WebKitConfig.cmake
    qt5webkit-config.cmake

  Add the installation prefix of "Qt5WebKit" to CMAKE_PREFIX_PATH or set
  "Qt5WebKit_DIR" to a directory containing one of the above files.  If
  "Qt5WebKit" provides a separate development package or SDK, be sure it has
  been installed.
Call Stack (most recent call first):
  src/libs/core/CMakeLists.txt:13 (find_package)

trollixx · 2018-11-26T03:16:10Z

It just tells you that Qt WebKit is missing. It's not part of the standard Qt distribution.

markwu · 2018-11-26T03:17:46Z

Then, I need to figure out how to add it back, I got qt 5.11.1 from homebrew bottle.

markwu · 2018-11-26T06:16:10Z

The last qtwebkit submodule for qt is verion5.9.1, there is no submodule for 5.11.x.

dakira · 2018-11-26T13:59:29Z

@markwu that's exactly the problem I had. :)

markwu · 2018-11-26T16:25:46Z

I try to build qt 5.9.2 inside mojave, no lucky. it seems xcode 10 break the compilation of old qt.

markwu · 2018-11-26T18:29:19Z

Okay, I can build zeal in MacOS mojave now, but I don't like this solution.

Use brew extract qt@5.5 YOURTAP/PATH to restore qt@5.5 formula to your tap. And move it to homebrew/core tap path, and rename it to qt@5.5.rb.
Use brew extract cmake --version=3.12.4 YOURTAP/PATH to restore cmake 3.12.4 formula to your tap. And move it to homebrew/core tap path, and rename it to replace cmake.rb.
Install qt 5.5 with brew install qt@5.5 and cmake 3.12.4 with brew install cmake. It should install qt@5.5 and cmake from bottle. If not, just add --force-bottle.
Then, you can use my formula above to build zeal.

I try this one https://github.com/OSGeo/homebrew-osgeo4mac/blob/master/Formula/qt5-webkit.rb, it can install qt5webkit with qt 5.11.1, but there are A LOT OF ERRORS.

markwu · 2018-11-29T15:17:18Z

Maybe port to qtwebengine is the way to go, seems qtwebkit does not maintain for 1 years.

markwu · 2018-11-29T15:30:28Z

cmake 3.13.1 already fixed the uic excutable bug, you can use it instead of 3.12.4 now ...

markwu · 2018-12-03T01:55:43Z

Finally, I can build zeal with Qt 5.11.1 and QtWebKit 5.212. I will write a formula for it later today.

markwu · 2018-12-03T04:17:55Z

Here comes with my personal Tap https://github.com/markwu/homebrew-personal

You can follow this instructions to install zeal with qt 5.11.x and qt-webkit 5.212

brew tap markwu/personal
brew install qt
brew install qt5-webkit
brew install zeal

If you want to install zeal with qt@5.5, you have to extract it first. Please follow the instructions to install it:

Use brew extract qt@5.5 YOURTAP/PATH to restore qt@5.5 formula to your tap. And move it to homebrew/core tap path, and rename the file to qt@5.5.rb, and remember open it and change the class name to QtAt55.

brew tap markwu/personal
brew install qt@5.5
brew install zeal-qt@5.5

markwu · 2018-12-03T04:22:11Z

But, there some different between qt 5.5 and qt 5.11.1, It looks better in qt 5.5.

qt 5.5

qt 5.11.1 (Seems some html get the wrong css style)

@trollixx Do you kown any issues about this, should I create a new one for this?

markwu · 2018-12-04T09:56:12Z

I try to build zeal master branch with --HEAD, it works.

You can build master branch with the following instructions

brew tap markwu/personal
brew install qt
brew install qt5-webkit
brew install --HEAD zeal

markwu · 2018-12-08T16:27:36Z

Qt 5.12 just relased, you have reinstall qt5-webkit again, it will compiled against Qt 5.12.x.

brew reinstall qt5-webkit

trollixx · 2018-12-14T05:55:48Z

Any volunteers to update the wiki? :)

pryorda · 2018-12-22T22:33:47Z

I'm testing this now will update in a few.

pryorda · 2018-12-23T00:17:55Z

To finish it up I had to do:

cp -Rp /usr/local/Cellar/zeal/HEAD-a64dadc/Zeal.app ~/Applications/Zeal.app

razzfox · 2018-12-23T02:08:25Z

I needed to run

brew install libjpeg libpng

before qt5-webkit would install successfully.

markwu · 2018-12-24T01:21:29Z

@razzfox I can add these two libraries to formula dependency.

sunjie21 · 2019-01-01T17:50:02Z

Any volunteers to update the wiki? :)

are there any plans to port from Qt WebKit to Qt WebEngine?

markwu · 2019-01-28T07:26:44Z

I just update my formula for recent code change. It can compile zeal stable version 0.6.1 and HEAD with Qt 5.11.2. For Qt5.5, It only support zeal stable version 0.6.1

dakira · 2020-01-17T14:50:38Z

I finally updated the build instructions in the wiki. :)

frankli0324 · 2020-03-27T04:38:46Z

090f527

On MacOS, you need to enable loopback aliases other than 127.0.0.1 manually:

sudo ifconfig lo0 alias 127.0.0.22 up

markwu · 2020-03-27T10:24:27Z

090f527

On MacOS, you need to enable loopback aliases other than 127.0.0.1 manually:

sudo ifconfig lo0 alias 127.0.0.22 up

What will happened if I don't enable loopback aliases?

markwu · 2020-03-27T10:41:17Z

Okay, now I know what's going on.

markwu · 2020-03-27T10:47:49Z

Maybe I should create a daemon for this https://medium.com/@david.limkys/permanently-create-an-ifconfig-loopback-alias-macos-b7c93a8b0db ?

frankli0324 · 2020-03-27T13:48:47Z

sure yes

markwu · 2020-03-28T05:44:33Z

I just add a zeal-loopbackalias daemon support, maybe you want to try it.

After install zeal with head version, you can enable the daemon with

sudo brew services start markwu/personal/zeal

Than, the lookpback should be installed without problem. You can verify it with:

$ ifconfig lo0 | grep 127.0.0.22, the result will be

	inet 127.0.0.22 netmask 0xff000000

trollixx · 2020-03-28T18:23:24Z

I don't use macOS much, it doesn't route all 127.*.*.* addresses by default? I picked 127.0.0.22 to reduce possibility of conflicts.

markwu · 2020-03-29T04:54:24Z

I don't use macOS much, it doesn't route all 127.*.*.* addresses by default? I picked 127.0.0.22 to reduce possibility of conflicts.

Mac doesn't route all 127.*.*.* by default I guess, therefore I need to add alias for it.

Does linux and windows route all 127.*.*.* by default?

frankli0324 · 2020-03-29T07:40:02Z

Does linux and windows route all 127.*.*.* by default?

yes

Related to #995.

trollixx · 2020-03-31T04:50:40Z

I have just pushed a change that replaces 127.0.0.22 with 127.0.0.1. Hopefully that will make it work out of the box.

markwu · 2020-03-31T09:34:30Z

@trollixx

Do you use different port when change it to use 127.0.0.1?

For many developers, they installed local http server, it use 127.0.0.1 and localhost.

There might have some problems if you use the default 80 port.

markwu · 2020-04-01T13:37:51Z

@trollixx I saw you use port other than 80. Thanks!

I also removed the loopback alias daemon from this formula.

trollixx · 2020-04-02T02:30:15Z

@trollixx I saw you use port other than 80.

Yes, a random non-priviliged port is selected on every run.

markwu · 2020-05-09T04:49:05Z

I already update the wiki documents about building zeal on macOS. Since there is no need for qt5-webkit, I already removed it and related patches from my formula.

It is so good that zeal adapt WebEngine, the life become easier.

sikmir · 2020-06-17T08:30:57Z

Zeal can be installed from macports: macports/macports-ports#7444.

RakibFiha · 2020-08-27T10:13:06Z

I try to build zeal master branch with --HEAD, it works.

You can build master branch with the following instructions
brew tap markwu/personal
brew install qt
brew install qt5-webkit
brew install --HEAD zeal

Is working as of 27th of August 2020

markwu · 2020-08-28T02:23:52Z

@RakibFiha Just following the wiki, it should be work.

https://github.com/zealdocs/zeal/wiki/Build-Instructions-for-macOS

dakira changed the title ~~Update Mac build instructions~~ Updated Mac build instructions Sep 20, 2018

trollixx added type/enhancement scope/documentation labels Sep 20, 2018

trollixx added type/task and removed type/enhancement labels Oct 17, 2018

trollixx changed the title ~~Updated Mac build instructions~~ Update macOS build instructions Oct 17, 2018

trollixx added the Help Wanted label Nov 7, 2018

trollixx added the platform/macos label Dec 14, 2018

william8th mentioned this issue Jan 19, 2019

Failed to build qt5-webkit on Mojave markwu/homebrew-personal#1

Closed

dakira closed this as completed Jan 17, 2020

trollixx added a commit that referenced this issue Mar 31, 2020

fix(core): bind local HTTP server to 127.0.0.1

753ce5b

Related to #995.

TheKnarf mentioned this issue Oct 2, 2022

Docset search theknarf-experiments/alfred-alternative#12

Open

github-actions bot locked and limited conversation to collaborators Aug 6, 2023

trollixx removed the Help Wanted label Aug 4, 2024

Update macOS build instructions #995

Update macOS build instructions #995

Comments

dakira commented Sep 20, 2018 • edited Loading

trollixx commented Sep 20, 2018

dakira commented Sep 20, 2018

trollixx commented Sep 20, 2018

dakira commented Sep 20, 2018

markwu commented Nov 25, 2018 • edited Loading

markwu commented Nov 25, 2018

trollixx commented Nov 25, 2018

markwu commented Nov 26, 2018 • edited Loading

trollixx commented Nov 26, 2018

markwu commented Nov 26, 2018

markwu commented Nov 26, 2018 • edited Loading

dakira commented Nov 26, 2018

markwu commented Nov 26, 2018

markwu commented Nov 26, 2018 • edited Loading

markwu commented Nov 29, 2018

markwu commented Nov 29, 2018

markwu commented Dec 3, 2018 • edited Loading

markwu commented Dec 3, 2018

markwu commented Dec 3, 2018 • edited Loading

qt 5.5

qt 5.11.1 (Seems some html get the wrong css style)

markwu commented Dec 4, 2018 • edited Loading

markwu commented Dec 8, 2018 • edited Loading

trollixx commented Dec 14, 2018

pryorda commented Dec 22, 2018

pryorda commented Dec 23, 2018 • edited Loading

razzfox commented Dec 23, 2018 • edited Loading

markwu commented Dec 24, 2018

sunjie21 commented Jan 1, 2019

markwu commented Jan 28, 2019 • edited Loading

dakira commented Jan 17, 2020

frankli0324 commented Mar 27, 2020

markwu commented Mar 27, 2020 • edited Loading

markwu commented Mar 27, 2020

markwu commented Mar 27, 2020

frankli0324 commented Mar 27, 2020

markwu commented Mar 28, 2020

trollixx commented Mar 28, 2020

markwu commented Mar 29, 2020

frankli0324 commented Mar 29, 2020

trollixx commented Mar 31, 2020 • edited Loading

markwu commented Mar 31, 2020 • edited Loading

markwu commented Apr 1, 2020

trollixx commented Apr 2, 2020

markwu commented May 9, 2020

sikmir commented Jun 17, 2020

RakibFiha commented Aug 27, 2020

markwu commented Aug 28, 2020

dakira commented Sep 20, 2018 •

edited

Loading

markwu commented Nov 25, 2018 •

edited

Loading

markwu commented Nov 26, 2018 •

edited

Loading

markwu commented Nov 26, 2018 •

edited

Loading

markwu commented Nov 26, 2018 •

edited

Loading

markwu commented Dec 3, 2018 •

edited

Loading

markwu commented Dec 3, 2018 •

edited

Loading

markwu commented Dec 4, 2018 •

edited

Loading

markwu commented Dec 8, 2018 •

edited

Loading

pryorda commented Dec 23, 2018 •

edited

Loading

razzfox commented Dec 23, 2018 •

edited

Loading

markwu commented Jan 28, 2019 •

edited

Loading

markwu commented Mar 27, 2020 •

edited

Loading

trollixx commented Mar 31, 2020 •

edited

Loading

markwu commented Mar 31, 2020 •

edited

Loading