🌍 🌏 🌎
Agism
Flag of Russia

INSTALL

This document describes building and installing Agism from sources.

Unpacking

Unpack the source tarball first:

$ tar xzf agism-3-0.vdb.1.tar.gz
$ cd agism-3-0.vdb.1

In-source build is prohibited, so you have to create a build directory and change to it before running configure:

$ mkdir _build
$ cd _build

All the intermediate and output files (including HTML pages and RPM packages) will be located in the build directory.

Installing the tools

Agism provides setup.sh script to install the tools and libraries needed to create Agism components for end users: extension, man page, extension pack, and RPM package (in case of RPM-based distro). The script works for Arch, Debian, Fedora, Mageia, OpenMandriva, openSUSE, and Ubuntu. Run the script with superuser privileges, e. g.:

$ sudo ../bin/setup.sh

Underlying package manager may ask for confirmations. Use -y option to install all the packages non-interactively:

$ sudo ../bin/setup.sh -y

If sudo is not available in your distro, use su command instead, for example:

$ su -c '../bin/setup.sh -y'

See the annotated list of packages to install in the setup-distro.sh file (where distro is a short name of your distro, e. g. debian or opensuse). Feel free to review it and comment out optional packages you do not want to install. Lack of optional build tools may disable Agism components: e. g. if pandoc is missed, the man page will not be built. Lack of optional test tools will cause some tests to skip. If you are not going to develop Agism, most of the test tools can be safely omitted. (Stuff is a bit more complicated, though: for example, building the RPM package require some test tools.)

Note: The simple gnome-extensions tool is packed in the gnome-shell package, which has a lot of dependencies. Actually, it will pull in the entire GNOME. It is not a problem for a desktop that already runs GNOME, but a headless server will have to download a lot of packages.

Configuring

Run configure in the build directory:

$ ../configure

Run configure with the --help option to see the list of all available options.

Options to disable Agism components

--disable-pack

Do not build the extension pack.

--disable-man

Do not build the man page. Useful if pandoc program is not available in your distro.

--disable-rpm

Do not build the RPM packages. Useful in non-RPM distros (e. g. Arch, Debian, Ubuntu, etc).

--disable-html

Do not build HTML pages.

Building

To build Agism, just run make:

$ make

By default, pack, RPM packages and HTML pages are not built. To build them, specify targets in the command line (all or some):

$ make pack rpm html

All GNU Automake standard targets (check, dist, etc) are supported. There are some non-standard convenience targets, run make help to see them.

Installing

I recommend building and installing the package appropriate for your GNU/Linux distro, if it is possible. In such case the Agism is installed as a system extension, which is available for all users of the system.

Alternatively, you can build and install the extension pack. In such case installation does not require superuser privileges, but Agism is installed as user extension, available only to the user who installed it.

The last option is installing the extension by make install. It is ok to do it in a controlled environment (e. g. in an RPM spec file), but it is not recommended on a live system. Anyway, if you do this, Agism will be installed as system extension.

Note: Regardless of the installation type (system or user) a newly installed extension is not available until the GNOME Shell is restarted. If your GNOME run on top of the X Window System session, press Alt+F2 to open Run Dialog, then type ‘r’ and press Enter. In case of Wayland you have to log out and log in.

Installing the RPM package

Fedora

$ DIST=$(rpmbuild --eval %{?dist})
$ sudo dnf install ./gnome-shell-extension-agism-3-0.vdb.1$DIST.noarch.rpm

Mageia

$ DIST=$(rpmbuild --eval %{?dist})
$ su -c "dnf install ./gnome-shell-extension-agism-3-0.vdb.1$DIST.noarch.rpm"

OpenMandriva

$ DIST=$(rpmbuild --eval %{?disttag:-%{disttag}})
$ sudo dnf install ./gnome-shell-extension-agism-3-0.vdb.1$DIST.noarch.rpm

openSUSE

$ sudo zypper install ./gnome-shell-extension-agism-3-0.vdb.1.noarch.rpm

Installing the extension pack

If installing the RPM package is not feasible, run

$ gnome-extensions install ./agism@agism.sourceforge.io.shell-extension.zip

Use --force option in case of upgrading (or downgrading) the already installed extension:

$ gnome-extensions install --force ./agism@agism.sourceforge.io.shell-extension.zip

Alternatively, run

$ make pack-install

Installing the raw extension

$ sudo make install

It is not recommended in a live system, build and install either RPM package or extension pack instead. However, it is ok to use make install in an RPM spec file or similar conditions.

Enabling

Installed Agism is available for the users (or the user, depending on installation type), but not active. To make Agism up and running, enable it:

$ gnome-extensions enable agism@agism.sourceforge.io

or

$ make enable

Old versions of gnome-extensions are known to fail silently, so make sure the extension is really enabled by running

$ gnome-extensions show agism@agism.sourceforge.io

or

$ make show

The output looks like:

Name: Agism
Description: ...
Path: ...
URL: ...
Version: ...
State: ...

Pay special attention to:

3-0.vdb.1
Source Forge
2023-04-28