Seeking help in building Sigil on linux

[DiapDealer]

Originally Posted by philja

If I understand correctly, I need to edit the sigil file in /usr/local/bin/. I'd appreciate a description of what I need to do to change that file.

And here I was hoping you'd be the first to try my Sigil Python AppImage. Which would mean you wouldn't need to edit any scripts (or install PyPi modules to your user directory)

The gist is that /usr/local/bin/sigil is a bash script that needs to be edited with a text editor. You'll need root permissions to edit it.

Basically you need to prevent the system Qt6 location (represented by the QTLIB_DIR variable) from being prepended to the LD_LIBRARY_PATH variable.

I myself would do that by removing :QTLIB_DIR from line 10 and line 12 of that script (note the colon at the beginning of the substring to be removed).

I'm not really happy with this solution as the script will be overwritten each time Sigil gets built then installed. But it might be the easiest solution for now.

[philja]

Sorry DiapDealer, I didn't see this reply earlier. I didn't notice that the thread had now progressed to page 5 !! My bad.

I'll gladly have a go with your Sigil Python AppImage.

[philja]

Originally Posted by DiapDealer

And here I was hoping you'd be the first to try my Sigil Python AppImage. Which would mean you wouldn't need to edit any scripts (or install PyPi modules to your user directory)

Well, it took a bit of time because domestic issues intervened.

I downloaded sigil-qt6-python3.11_x86_64.AppImage, set it to 'executable' and then used Sigil's plugin manager to set the path to the python interpreter to that file.

The wrapper script in /usr/local/bin/sigil remained in its original state with :

QTLIB_DIR="/usr/lib/x86_64-linux-gnu"

which previously prevented the testplugin from finding PySide6 etc.

With the new path to your AppImage set in the plugin manager, I ran the testplugin to a successful completion with a freshly started Sigil basic template page -

"Success - All Tests of Plugin Operations Passed"

Verifying proper Python packages are available
  Checking GUI modules
    Python Package: PySide6 (/tmp/.mount_sigil-axh8N2/opt/python3.11/lib/python3.11/site-packages/PySide6/QtWidgets.abi3.so) Found
    Python Package: PySide6 QtWebEngineWidgets (/tmp/.mount_sigil-axh8N2/opt/python3.11/lib/python3.11/site-packages/PySide6/QtWebEngineWidgets.abi3.so) Found
    Python Package: tkinter (/tmp/.mount_sigil-axh8N2/opt/python3.11/lib/python3.11/tkinter/__init__.py) Found
  Python Package: PIL (/tmp/.mount_sigil-axh8N2/opt/python3.11/lib/python3.11/site-packages/PIL/__init__.py) Found
  Python Package: cssselect (/tmp/.mount_sigil-axh8N2/opt/python3.11/lib/python3.11/site-packages/cssselect/__init__.py) Found
  Python Package: css-parser (/tmp/.mount_sigil-axh8N2/opt/python3.11/lib/python3.11/site-packages/css_parser/__init__.py) Found
  Python Package: html5lib (/tmp/.mount_sigil-axh8N2/opt/python3.11/lib/python3.11/site-packages/html5lib/__init__.py) Found
  Python Package: lxml (/tmp/.mount_sigil-axh8N2/opt/python3.11/lib/python3.11/site-packages/lxml/__init__.py) Found
  Python Package: regex (/tmp/.mount_sigil-axh8N2/opt/python3.11/lib/python3.11/site-packages/regex/__init__.py) Found
  Python Package: chardet (/tmp/.mount_sigil-axh8N2/opt/python3.11/lib/python3.11/site-packages/chardet/__init__.py) Found
  Python Package: six (/tmp/.mount_sigil-axh8N2/opt/python3.11/lib/python3.11/site-packages/six.py) Found
  Python Package: dulwich (/tmp/.mount_sigil-axh8N2/opt/python3.11/lib/python3.11/site-packages/dulwich/__init__.py) Found
  Python Package: urllib3 (/tmp/.mount_sigil-axh8N2/opt/python3.11/lib/python3.11/site-packages/urllib3/__init__.py) Found

Conclusion, no need to edit the /usr/local/bin/sigil file. Sigil 2.0.2 now runs ok with Qt6

[DiapDealer]

Thanks for trying it! Happy to see it works as expected. My plan was to avoid users needing to install a bunch of extra stuff in their system python. Thoughts? Is it easy enough to be useful?

[philja]

Originally Posted by DiapDealer

My plan was to avoid users needing to install a bunch of extra stuff in their system python. Thoughts? Is it easy enough to be useful?

It was certainly very easy to download the AppImage from the link you provided a few posts back. If that simple download means we could avoid all the rest of the hassle covered in this thread with trying to locate and install the relevant Qt6 modules needed to make Sigil work with Qt6 in Linux, then it'll prove to be a little miracle.

I did wonder where to put it but then realised that it didn't matter as far as Sigil was concerned because the path was going to be set manually in the plugin manager. So for my convenience, I placed it in the sub-directory of /Downloads/ where I keep any Sigil plugin zip files.

Setting it to executable might be a bit tricky for some Linux users.

Maybe when you decide how to issue it, you'll add a few notes and a hint to run the testplugin to check if the PySide6 stuff is located.

[DiapDealer]

This is strictly for use as the Sigil plugin interpreter and its environment. It won't replace any of the Sigil Qt6 build requirements, unfortunately. Sigil has some basic Embedded Python needs that will still use the system Python. All necessary modules are available via the normal package management system. The Python Plugin Framework needs some extra pieces that might not be available via the normal distro package management system.

[philja]

Using Sigil with your AppImage made my problem with the display of some (but not all) gif images inside the InsertImageSVG plugin's dialog go away.

I couldn't believe it so I reversed and went back to using the /usr/bin/python3 path to the interpreter with the edit to /usr/local/bin/sigil wrapper script to remove the QTLIB_DIR statement. This made the problem with gif display come back.

I found that I could go back and forth between these two configurations and make the display issue disappear or reappear in a systematic fashion.

see : https://www.mobileread.com/forums/sh...21#post4373721

So there's something in your AppImage that was missing or defective in the other setup configuration. How about that?

[philja]

Having succeeded in building 2.0.2 with Qt6 on Ubuntu 22.04 Jammy, thanks to the help provided in this thread, I thought I'd have a go with the latest version. I'm still on Jammy and wouldn't normally upgrade to 24-04 until it reaches the .1 level in August.

First, I thoroughly reviewed all this thread and consulted my notes from the earlier build. Next, I went through the latest version at : https://github.com/Sigil-Ebook/Sigil...ng_on_Linux.md checking that I had all the components and packages listed.

By the way, I think there is a typo in the section of that document 'Getting Qt6' for Debian systems : the 7th bullet point says

qt6-5compat-dev (use libqt6corecompat6-dev instead on Ubuntu 22.04 and earlier)

I think it should have a '5' in the package name - libqt6core5compat6-dev - which would correspond with the package I already had installed.

I downloaded the 2.1.0 zip file and followed the instructions but the cmake command failed. The indications are :

 Could NOT find XKB (missing: XKB_LIBRARY XKB_INCLUDE_DIR) (Required is at least version "0.5.0")
-- Found WrapVulkanHeaders: /usr/include  
-- Could NOT find Qt6Svg (missing: Qt6Svg_DIR)

XKB seems to be X keyboard related and I don't recall having had any problem with that when building Sigil-2.0.2. I seem to have 5 packages with xkb in their names installed. I don't know whether that is a show-stopper.

It does seem to me that the failure to find Qt6Svg is more likely to be the important one. The terminal output goes on to say:

CMake Error at src/qt6sigil.cmake:31 (find_package):
  Found package configuration file:

    /usr/lib/x86_64-linux-gnu/cmake/Qt6/Qt6Config.cmake

  but it set Qt6_FOUND to FALSE so package "Qt6" is considered to be NOT
  FOUND.  Reason given by package:

  Failed to find Qt component "Svg".

  Expected Config file at
  "/usr/lib/x86_64-linux-gnu/cmake/Qt6Svg/Qt6SvgConfig.cmake" does NOT exist

During the build of 2.0.2, the Qt6 SVG problems disappeared with the installation of the package libqt6svg6

Something seems to have changed with Qt6 between the building of 2.0.2 and 2.1.0.

[KevinH]

Yes, most distributions keep updating their Qt versions and unfortunately how they split up Qt for packaging in their specific distribution.

Once you added the libqt6svg package, did your build complete and were you able to launch it?

Or is the missing xkb lib still an issue?

[DiapDealer]

With 2.0.2, I believe QtSvg was merely a runtime requirement. We changed something along the road to 2.1.0 that made it a build requirement. So I'm guessing that means that a -dev package for QtSvg will also be required (on distros that split packages into separate lib and dev components).

Let me see if I can figure out what Ubuntu is calling that package today.

EDIT: Try installing libqt6svg6-dev on Jammy.

[DiapDealer]

Thanks for pointing out the typo in libqt6core5compat6-dev. I fixed it in the documentation. I also updated it to libqt6svg6-dev to reflect the new build-time requirement for the QtSvg headers and includes.

[philja]

Originally Posted by KevinH

Yes, most distributions keep updating their Qt versions and unfortunately how they split up Qt for packaging in their specific distribution.

Once you added the libqt6svg package, did your build complete and were you able to launch it?

Or is the missing xkb lib still an issue?

My distro is the same today as when I did the 2.0.2 build back in last November (2023) apart from updates but the Qt6 packages I installed for building 2.0.2 remain unchanged in my machine.
The libqt6svg package is still there but evidently not sufficient this time round. Last time there was no mention of problems with xkb as far as I recall - nothing in my notes nor mention in this thread.

Originally Posted by DiapDealer

With 2.0.2, I believe QtSvg was merely a runtime requirement. We changed something along the road to 2.1.0 that made it a build requirement. So I'm guessing that means that a -dev package for QtSvg will also be required (on distros that split packages into separate lib and dev components).

Let me see if I can figure out what Ubuntu is calling that package today.

EDIT: Try installing libqt6svg6-dev on Jammy.

Thanks for that idea - I'll give it a try and come back.

[philja]

Originally Posted by DiapDealer

EDIT: Try installing libqt6svg6-dev on Jammy.

I installed libqt6svg6-dev and the installation brought in another dependency, libqt6svgwidgets6.

CMAKE went through ok - still mentioned the missing XKB but it still mentions the missing windows.h which was said to be irrelevant earlier in this thread when building 2.0.2 so maybe XKB is another irrelevancy.

MAKE and MAKE INSTALL also went ok. Sigil started and the testplugin ran to completion with no faults listed.

So now I have what appears to be a functioning Sigil-2.1.0.

Thanks for the help.

[DiapDealer]

Good deal. Thanks for reporting back!

[DiapDealer]

Originally Posted by philja

CMAKE went through ok - still mentioned the missing XKB but it still mentions the missing windows.h which was said to be irrelevant earlier in this thread when building 2.0.2 so maybe XKB is another irrelevancy.

Just tracked this down. I don't know if this makes any real difference at all, but making sure the following two packages are installed silenced CMake's missing XKB message for me:

libxkbcommon-dev (very likely already installed, but check)
libxkbfile-dev (not installed by default on my Jammy virtual machine)