diff --git a/README b/README index e400034b..55d74452 100644 --- a/README +++ b/README @@ -1,197 +1,205 @@ This is gpg4win - the GUI Installer Builder for W32. See also the file doc/README.en.txt. For MSI Package instructions see src/README-msi.txt. Instructions: ============= 1. Download the source and binary packages that are required to build the installer: $ cd packages $ sh download.sh [...] $ cd .. -1.5 (Only necessary when building from Git) +2. Generate config files $ ./autogen.sh -2. Configure the source tree for cross compilation: +3. Configure the source tree for cross compilation: $ ./autogen.sh --build-w32 -3. Build the installer: +4. Build the installer: $ make The installer will be made available under src/installers: src/installers/gpg4win-X.Y.Z.exe Instructions for AppImage: ========================== -1. (Only necessary when building from Git) +1. Download the source and binary packages that are required to build + the installer: + + $ cd packages + $ sh download.sh + [...] + $ cd .. + +2. Generate config files $ ./autogen.sh -2. Build the Docker image that will be used for creating the AppImage: +3. Build the Docker image that will be used for creating the AppImage: $ docker/build-appimage-docker-image.sh -3. Build the AppImage using the Docker image: +4. Build the AppImage using the Docker image: $ docker/run-appimage-build.sh Basic requirements ================== A decent POSIX system is required for building this software as well as GNU make. We are using Debian GNU/Linux 10 (buster), any other POSIX system should work as well but you may run into problems due to different toolchain versions. For MSI Packages you will additionally need the dependencies mentioned in src/README-msi.txt To satisfy all needs of configure at least the following packages need to be installed: build-essential autoconf automake mingw-w64 mingw-w64-i686-dev \ mingw-w64-x86-64-dev nsis stow unzip icoutils texlive \ libglib2.0-dev gettext docbook-utils ghostscript \ texinfo libgdk-pixbuf2.0-dev texlive-latex-extra libqt4-dev-bin \ wget mingw-w64 texlive-lang-german cmake libgtk2.0-bin libxml2-utils \ gperf libgettextpo-dev automake-1.15 libkf5config-dev libkf5config-dev-bin \ libkf5coreaddons-dev gpgrt-tools imagemagick Building the Webpages ===================== The website is in the dedicated branch "website" in the git reposity. Checkout that branch and read the instructions: git checkout website Development Branches ==================== The old version of gpg4win (version < 1.2) is since 1.1.3 tracked by the GIT branch: gpg4win-1-branch. Only important fixes will go into this version. The current version in the GIT master starts as version 1.9. Adding new packages to the installer: ===================================== This requires editing a couple of files; we might eventually automate some of these tasks. Here is a short run up: 1. Add constants for the package FOO into src/config.nsi.in . 2. Create 2 new installer scripts, named src/inst-foo.nsi and uninst-foo.nsi and add them to EXTRA_DIST in src/Makefile.am. 3. Add foo to one the variables gpg4win_bpgks (if foo should not be build be the gpg4win) or gpg4win_spkgs (if foo should be build by gpg4win) in src/Makefile.am . Also add any required configure flags etc. 4. Add FOO to src/inst-sections.nsi. 5. Add detection of packages to configure.ac. Check out the available macros in m4/gpg4win.m4. Depending on the way an upstream package is packaged, you might need to write a new macro. 6. Add download information to packages/download.sh. 7. If the package ships pkg-config (*.pc) support files, you need add post install instructions to Makefile.am. Note that *.pc files may be in the "runtime" directory ${pkgidir} if the package is built within gpg4win (or peculiarly shipped), or in the development package ${pkgidir_dev}. 8. Add the installed files to the mkportable headers. Then run the usual "./autogen.sh" to create the actual configure file and run configure as described above. Kleopatra Locatization ====================== The kde-l10n package is generated with the script src/kde-l10n.sh execute it after a build to generate an updated l10n package which you can then upload and add to packages.common. The tarballs and the nsis scripts are located in the temp directory kde-l10n prints as output. Installer Slideshow =================== During installation we are showing a slide show. If you want to change the contents shown add / modify files in the src/slideshow subfolder. Install them in inst-gpg4win.nsi (Add them to the list of files before g4wihelp::slide_show) and modify src/slideshow/slides.dat accordingly. Version numbers =============== We use a specific order of version numbers. This is best shown by an example: 2.1.1 - The final 2.1.1 release. 2.1.1-beta88 - A snapshot before the 2.1.1 release. (The 88 in this example is the number of commits since the last release). The important point is that we bump up the version number before we do an release and append a suffix to mark it as a development version. This allows other software to use a configure check for the next to be released version of gpg4win. Copyright ========= The entire Gpg4win package is Copyright (C) 2005, 2006, 2007, 2008, 2009, 2012, 2013 g10 Code GmbH GPG4Win is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. GPG4Win is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA This file ========= Copyright 2005, 2006, 2008 g10 Code GmbH This file is free software; as a special exception the author gives unlimited permission to copy and/or distribute it, with or without modifications, as long as this notice is preserved. This file is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY, to the extent permitted by law; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. diff --git a/docker/appimage/build-appimage.sh b/docker/appimage/build-appimage.sh index d453c39e..8c0ee31e 100644 --- a/docker/appimage/build-appimage.sh +++ b/docker/appimage/build-appimage.sh @@ -1,116 +1,113 @@ #!/bin/sh # Build an AppImage of Kleopatra # Copyright (C) 2021 g10 Code GmbH # # Software engineering by Ingo Klöcker # # This file is part of GnuPG. # # GnuPG is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3 of the License, or # (at your option) any later version. # # GnuPG is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program; if not, see . # # SPDX-License-Identifier: GPL-3.0+ set -e . /opt/rh/devtoolset-7/enable -cd /src/packages -./download.sh - cd /src ./configure --enable-appimage --enable-maintainer-mode --disable-manuals cd /src make if [ -f /src/src/gnupg-vsd/custom.mk ]; then GNUPG_BUILD_VSD=yes else GNUPG_BUILD_VSD=no fi export GNUPG_BUILD_VSD echo 'rootdir = $APPDIR/usr' >/build/AppDir/usr/bin/gpgconf.ctl if [ $GNUPG_BUILD_VSD = yes ]; then echo 'sysconfdir = /etc/gnupg-vsd' >>/build/AppDir/usr/bin/gpgconf.ctl else echo 'sysconfdir = /etc/gnupg' >>/build/AppDir/usr/bin/gpgconf.ctl fi # Copy the start-shell helper for use AppRun cp /src/src/appimage/start-shell /build/AppDir/ chmod +x /build/AppDir/start-shell # Copy standard global configuration if [ $GNUPG_BUILD_VSD = yes ]; then mkdir -p /build/AppDir/usr/share/gnupg/conf/gnupg-vsd rsync -av --delete --omit-dir-times \ /src/src/gnupg-vsd/Standard/etc/gnupg/ \ /build/AppDir/usr/share/gnupg/conf/gnupg-vsd/ fi export PATH=/opt/linuxdeploy/usr/bin:$PATH export LD_LIBRARY_PATH=/build/install/lib # tell the linuxdeploy qt-plugin where to find qmake export QMAKE=/build/install/bin/qmake # create plugin directories expected by linuxdeploy qt-plugin # workaround for # [qt/stdout] Deploy[qt/stderr] terminate called after throwing an instance of 'boost::filesystem::filesystem_error' # [qt/stderr] what(): boost::filesystem::directory_iterator::construct: No such file or directory: "/build/AppDir/usr/plugins/sqldrivers" # ERROR: Failed to run plugin: qt (exit code: 6) mkdir -p /build/install/plugins/sqldrivers # copy KDE plugins for d in iconengines kf5 pim; do mkdir -p /build/AppDir/usr/plugins/${d}/ rsync -av --delete --omit-dir-times /build/install/lib64/plugins/${d}/ /build/AppDir/usr/plugins/${d}/ done cd /build # Remove existing AppRun and wrapped AppRun, that may be left over # from a previous run of linuxdeploy, to ensure that our custom AppRun # is deployed rm -f /build/AppDir/AppRun /build/AppDir/AppRun.wrapped 2>/dev/null # Remove existing translations that may be left over from a previous # run of linuxdeploy rm -rf /build/AppDir/usr/translations # Remove the version files to make sure that only one will be created. rm -f /build/AppDir/GnuPG-VS-Desktop-VERSION 2>/dev/null rm -f /build/AppDir/GnuPG-Desktop-VERSION 2>/dev/null # Extract gnupg version or (for VSD builds) gpg4win version for use # as filename of the AppImage if [ $GNUPG_BUILD_VSD = yes ]; then myversion=$(grep PACKAGE_VERSION /src/config.h|sed -n 's/.*"\(.*\)"$/\1/p') OUTPUT=gnupg-vs-desktop-${myversion}-x86_64.AppImage echo "Packaging GnuPG VS-Desktop Appimage: $myversion" echo $myversion >/build/AppDir/GnuPG-VS-Desktop-VERSION else myversion=$(ls /src/packages/gnupg-2.*tar.* \ | sed -n 's,.*/gnupg-\(2.*\).tar.*,\1,p') OUTPUT=gnupg-desktop-${myversion}-x86_64.AppImage echo "Packaging Gpg4win Appimage: $myversion" echo $myversion >/build/AppDir/GnuPG-Desktop-VERSION fi export OUTPUT linuxdeploy --appdir /build/AppDir \ --desktop-file /build/AppDir/usr/share/applications/org.kde.kleopatra.desktop \ --icon-file /build/AppDir/usr/share/icons/hicolor/256x256/apps/kleopatra.png \ --custom-apprun /src/src/appimage/AppRun \ --plugin qt \ --output appimage \ 2>&1 | tee /build/logs/linuxdeploy-gnupg-desktop.log