glfs/general.ent

<!-- Editing  up to the line of ==== should be enough
     to generate a book for development, release, or rc-->
<!ENTITY % development "INCLUDE"> <!-- set to INCLUDE for development,
                                      set to IGNORE for release or rc -->
<!ENTITY % release     "IGNORE">  <!-- set to INCLUDE for release,
                                      set to IGNORE for development or rc -->
<!ENTITY % relyear    "2024">
<!ENTITY % relnum     "r12.1-rel-05182024">
<!ENTITY % reldate    "May 18th, 2024">
<!ENTITY % relpubdate "2024-05-18">
<!-- ================================================================== -->
<!-- Do not change anything below unless the www or book layouts change -->

<!-- Automatically generated by git-version.sh. Used for release or dev -->
<!ENTITY % conditional-entities SYSTEM "conditional.ent">
%conditional-entities;

<![ %development; [
<!-- version info automatically generated by git -->
<!ENTITY % version-entities SYSTEM "version.ent">
%version-entities;
<![ %sysv; [
<!ENTITY lfs-version   "development">
<!ENTITY blfs-version  "svn">
<!ENTITY patch-version "svn">
]]>
<![ %systemd; [
<!ENTITY lfs-version   "systemd">
<!ENTITY blfs-version  "systemd">
<!ENTITY patch-version "svn">
]]>
]]><!-- End %development -->

<![ %release; [
<![ %sysv; [
<!ENTITY lfs-version   "%relnum;">
<!ENTITY blfs-version  "%relnum;">
<!ENTITY patch-version "%relnum;">
]]>
<![ %systemd; [
<!ENTITY lfs-version   "%relnum;-systemd">
<!ENTITY blfs-version  "%relnum;-systemd">
<!ENTITY patch-version "%relnum;">
]]>

<!ENTITY year           "%relyear;">
<!ENTITY version        "%relnum;">
<!ENTITY releasedate    "%reldate;">
<!ENTITY pubdate        "%relpubdate;">
]]><!-- End %release -->

<!ENTITY copyrightdate  "&year;">
<!ENTITY copyholder     "The GLFS Development Team">
<!ENTITY lfs-domainname "linuxfromscratch.org">

<!ENTITY maintainer-fullname  "The GLFS Team">
<!ENTITY maintainer-firstname "GLFS">
<!ENTITY maintainer-address   "zeckmaisreal@gmail.com;">


<!ENTITY lfs-website          "https://www.&lfs-domainname;">
<!-- downloads_root must have an entity because it is needed for scripts
     Note:  s/_/-/ in comment to avoid grep error
     It is also needed for systemd units
     -->
<!ENTITY downloads-root       "&lfs-website;/blfs/downloads/&blfs-version;">
<!--<!ENTITY downloads-root-systemd "https://www.linuxfromscratch.org/blfs/downloads/systemd">
<!ENTITY downloads-project    "https://downloads.&lfs-domainname;">-->

<!ENTITY sources-anduin-http  "https://anduin.linuxfromscratch.org/BLFS">
<!ENTITY sources-anduin-ftp   "ftp://anduin.linuxfromscratch.org/BLFS">

<!ENTITY hints-root           "https://www.&lfs-domainname;/hints">
<!ENTITY patch-downloads      "https://www.linuxfromscratch.org/patches/downloads">
<!ENTITY patch-root           "https://www.&lfs-domainname;/patches/blfs/&patch-version;">
<!ENTITY errata               "https://www.&lfs-domainname;/blfs/errata/&blfs-version;/">
<!ENTITY blfs-ticket-root     "https://wiki.&lfs-domainname;/blfs/ticket/">

<!ENTITY lfs-root             "../../../../lfs/view/&lfs-version;">
<!ENTITY lfs-dev              "../../../../lfs/view/development">
<!ENTITY lfs-ticket-root      "https://wiki.&lfs-domainname;/lfs/ticket/">
<!ENTITY gnu-http             "https://ftp.gnu.org/gnu">
<!ENTITY gnu-ftp              "ftp://ftp.gnu.org/gnu">
<!ENTITY gnupg-http           "https://www.gnupg.org/ftp/gcrypt">
<!ENTITY gnupg-ftp            "ftp://ftp.gnupg.org/gcrypt">
<!ENTITY gstreamer-dl         "https://gstreamer.freedesktop.org/src">
<!ENTITY kernel-dl            "https://www.kernel.org/pub">
<!ENTITY mozilla-http         "https://archive.mozilla.org/pub">
<!ENTITY mozilla-hg           "https://hg.mozilla.org/releases/mozilla-release/archive/">
<!ENTITY perl_authors         "https://www.cpan.org/authors">
<!ENTITY metacpan_authors     "https://cpan.metacpan.org/authors/id">
<!ENTITY pymodules-dl         "https://files.pythonhosted.org/packages/source">
<!ENTITY sourceforge-dl       "https://downloads.sourceforge.net">

<!ENTITY fedora-http-repo     "http://pkgs.fedoraproject.org/repo/pkgs">
<!ENTITY jaist-ftp-repo       "ftp://ftp.jaist.ac.jp/pub//sourceforge">
<!ENTITY lxqt-http-repo       "http://downloads.lxqt.org/lxqt">
<!ENTITY publisher            "Unknown">
<!ENTITY xorg-download-http   "https://www.x.org/pub/individual">
<!ENTITY xorg-download-ftp    "ftp://ftp.x.org/pub/individual">
<!ENTITY pypi                 "https://pypi.python.org/pypi">
<!ENTITY appstream-glib-url   "http://people.freedesktop.org/~hughsient/appstream-glib/releases">
<!ENTITY elinks-url           "http://elinks.or.cz">
<!ENTITY w3m-url              "http://w3m.sourceforge.net/">
<!ENTITY sysprof-url          "https://wiki.gnome.org/Apps/Sysprof">
<!ENTITY man                  "https://man.archlinux.org/man/">

<!-- Convenience entities -->
<!ENTITY root                 "<systemitem class='username'>root</systemitem>">
<!ENTITY gi-docgen-url        "https://gnome.pages.gitlab.gnome.org/gi-docgen/">

<!-- These entities are used to identify versions of LFS
     packages referenced throughout the BLFS book. -->

<!ENTITY lfs-perl-version             "5.38"> <!-- used in git -->

<!-- End LFS versions -->

<!ENTITY blfs-bootscripts-version     "20240209">
<!ENTITY systemd-units-version        "20240205">

<!ENTITY blfs-wiki                    "https://wiki.&lfs-domainname;/blfs/wiki">
<!ENTITY blfs-svn		      "https://&lfs-domainname;/blfs/view/svn">

<!-- These entities are used to annotate the current status of a package as it
     relates to the version of LFS it will build/work against -->

<!ENTITY lfs121_checked  "<note><para>Development versions of GLFS may not build or run
                          some packages properly if LFS or dependencies have been updated
                          since the most recent stable versions of the books.</para></note>">

<!--<!ENTITY lfs121_checked  "<para>This package is known to build and work properly
                          using an LFS 12.1 platform.</para>">-->


<!-- End special entities about LFS compatibility -->

<!ENTITY as_root "<note><para>When installing multiple packages in a script,
  the installation needs to be done as the root user. There are three general
  options that can be used to do this:</para>

  <orderedlist>

  <listitem><para>Run the entire script as the root user (not
  recommended).</para></listitem>

  <listitem><para>Use the <command>sudo</command> command from the
  sudo package.</para></listitem>

  <listitem><para>Use <command>su -c &quot;command arguments&quot;</command>
  (quotes required) which will ask for the root  password for every iteration
  of the loop.</para></listitem>

  </orderedlist>

  <para>One way to handle this situation is to create a short
  <command>bash</command> function that automatically selects the appropriate
  method.  Once the command is set in the environment, it does not need to be
  set again.</para>

  <screen><userinput>as_root()
{
  if   [ $EUID = 0 ];        then $*
  elif [ -x /usr/bin/sudo ]; then sudo $*
  else                            su -c \\&quot;$*\\&quot;
  fi
}

export -f as_root</userinput></screen>
</note>">

<!ENTITY not-katamari         "<para>This package is provided for testing the
                               completed Xorg installation.</para>">

<!ENTITY % package-entities SYSTEM      "packages.ent">
%package-entities;

<!ENTITY parallel_issues "<note><para>This package may occasionally fail when
                          building with multiple processors.  See <xref
                          linkend='parallel-builds'/> for more information.</para></note>">

<!ENTITY shell-env "<note><para>If installing in the chroot environment, be
                    sure to export the <envar>SHELL</envar> environment
                    variable or configuration of the package will
                    fail.</para></note>">

<!ENTITY gi-doc-disable
         "Allow building this package without <xref linkend='gi-docgen'/>
          installed.  If you have <xref linkend='gi-docgen'/> installed and
          you wish to rebuild and install the API documentation, a
          <command>meson configure</command> command will reset this
          option.">

<!ENTITY build-use-internet
         "<note><para>An Internet connection is needed for building this
          package.</para></note>">

<!ENTITY test-use-internet
         "<note><para>An Internet connection is needed for some tests of
          this package.</para></note>">

<!ENTITY logind
         "<phrase revision='sysv'><xref linkend='elogind'/></phrase>
          <phrase revision='systemd'><xref linkend='systemd'/></phrase>">

<!ENTITY qt5-deps
         "(<xref linkend='qt5'/> or <xref role='nodep' linkend='qt5-alternate'/>)">

<!ENTITY build-wheel-cmd "pip3 wheel -w dist --no-build-isolation --no-deps --no-cache-dir">
<!ENTITY build-wheel "<screen><userinput>&build-wheel-cmd; $PWD</userinput></screen>">

<!ENTITY install-wheel "pip3 install --no-index --find-links=dist --no-cache-dir --no-user">

<!ENTITY berkeley-db "<ulink url='https://anduin.linuxfromscratch.org/BLFS/bdb/db-5.3.28.tar.gz'>Berkeley DB</ulink> (deprecated)">

<!ENTITY gobject-introspection "<xref linkend='glib2'/> (with GObject Introspection)">