rofi/INSTALL.md

316 lines
6.1 KiB
Markdown
Raw Normal View History

2014-07-27 10:46:00 +00:00
# Installation guide
2014-07-27 07:54:10 +00:00
This guide explains how to install rofi using its build system and how you can
make debug builds.
2017-03-24 08:44:08 +00:00
Rofi uses autotools (GNU Build system), for more information see
[here](https://www.gnu.org/software/automake/manual/html_node/Autotools-Introduction.html).
You can also use [Meson](https://mesonbuild.com/) as an alternative.
2017-03-24 08:44:08 +00:00
2014-07-27 07:54:10 +00:00
## DEPENDENCY
### For building
2014-07-27 07:54:10 +00:00
- C compiler that supports the c99 standard. (gcc or clang)
- make
- autoconf
- automake (1.11.3 or up)
- pkg-config
- flex 2.5.39 or higher
- bison
- check (Can be disabled using the `--disable-check` configure flag)
2021-01-17 15:43:16 +00:00
check is used for build-time tests and does not affect functionality.
- Developer packages of the external libraries
- glib-compile-resources
2014-07-27 07:54:10 +00:00
### External libraries
- libpango >= 1.50
- libpangocairo
- libcairo
- libcairo-xcb
2024-02-27 19:46:34 +00:00
- libglib2.0 >= 2.72
- gmodule-2.0
- gio-unix-2.0
- libgdk-pixbuf-2.0
- libstartup-notification-1.0
- libxkbcommon >= 0.4.1
- libxkbcommon-x11
- libxcb (sometimes split, you need libxcb, libxcb-xkb and libxcb-randr
libxcb-xinerama)
- xcb-util
- xcb-util-wm (sometimes split as libxcb-ewmh and libxcb-icccm)
- xcb-util-cursor
- xcb-imdkit (optional, 1.0.3 or up preferred)
On debian based systems, the developer packages are in the form of:
`<package>-dev` on rpm based `<package>-devel`.
2014-07-27 10:46:00 +00:00
## Install from a release
2014-07-21 14:41:31 +00:00
When downloading from the github release page, make sure to grab the archive
`rofi-{version}.tar.[g|x]z`. The auto-attached files `source code (zip|tar.gz)`
by github do not contain a valid release. It misses a setup build system and
includes irrelevant files.
### Autotools
Create a build directory and enter it:
```bash
2021-01-17 15:43:16 +00:00
mkdir build && cd build
```
2014-07-21 14:41:31 +00:00
Check dependencies and configure build system:
```bash
2021-01-17 15:43:16 +00:00
../configure
```
2014-07-21 14:41:31 +00:00
Build Rofi:
```bash
2021-01-17 15:43:16 +00:00
make
```
2014-07-21 14:41:31 +00:00
The actual install, execute as root (if needed):
```bash
2021-01-17 15:43:16 +00:00
make install
```
2014-07-21 14:41:31 +00:00
The default installation prefix is: `/usr/local/` use `./configure
--prefix={prefix}` to install into another location.
2014-07-21 14:41:31 +00:00
### Meson
Check dependencies and configure build system:
```bash
2021-01-17 15:43:16 +00:00
meson setup build
```
Build Rofi:
```bash
2021-01-17 15:43:16 +00:00
ninja -C build
```
The actual install, execute as root (if needed):
```bash
2021-01-17 15:43:16 +00:00
ninja -C build install
```
The default installation prefix is: `/usr/local/` use `meson setup build
--prefix={prefix}` to install into another location.
2014-07-27 10:46:00 +00:00
## Install a checkout from git
2014-07-21 14:41:31 +00:00
The GitHub Pages version of these directions may be out of date. Please use
[INSTALL.md from the online repo][master-install] or your local repository.
If you don't have a checkout:
2017-03-24 08:44:08 +00:00
```bash
2021-01-17 15:43:16 +00:00
git clone --recursive https://github.com/DaveDavenport/rofi
cd rofi/
```
2017-03-24 08:44:08 +00:00
If you already have a checkout:
2016-03-05 12:36:18 +00:00
```bash
2021-01-17 15:43:16 +00:00
cd rofi/
git pull
git submodule update --init
```
2016-03-05 12:36:18 +00:00
For Autotools you have an extra step, to generate build system:
2014-07-21 14:41:31 +00:00
```bash
2021-01-17 15:43:16 +00:00
autoreconf -i
```
2014-07-21 14:41:31 +00:00
From this point, use the same steps you use for a release.
2014-07-21 14:41:31 +00:00
2014-07-27 10:46:00 +00:00
## Options for configure
2014-07-21 14:41:31 +00:00
When you run the configure step there are several options you can configure.
For Autotools, you can see the full list with `./configure --help`.
For Meson, before the initial setup, you can see rofi options in
`meson_options.txt` and Meson options with `meson setup --help`. Meson's
built-in options can be set using regular command line arguments, like so:
`meson setup build --option=value`. Rofi-specific options can be set using the
`-D` argument, like so: `meson setup build -Doption=value`. After the build dir
is set up by `meson setup build`, the `meson configure build` command can be
used to configure options, by the same means.
2014-07-21 14:41:31 +00:00
The most useful one to set is the installation prefix:
2014-07-21 14:41:31 +00:00
```bash
2021-01-17 15:43:16 +00:00
# Autotools
../configure --prefix=<installation path>
2021-01-17 15:43:16 +00:00
# Meson
meson setup build --prefix <installation path>
```
2014-07-21 14:41:31 +00:00
f.e.
```bash
2021-01-17 15:43:16 +00:00
# Autotools
../configure --prefix=/usr/
2021-01-17 15:43:16 +00:00
# Meson
meson setup build --prefix /usr
```
2014-07-21 14:41:31 +00:00
2014-07-27 10:46:00 +00:00
### Install locally
2014-07-21 14:41:31 +00:00
or to install locally:
```bash
2021-01-17 15:43:16 +00:00
# Autotools
../configure --prefix=${HOME}/.local/
2014-07-21 14:41:31 +00:00
2021-01-17 15:43:16 +00:00
# Meson
meson setup build --prefix ${HOME}/.local
```
2014-07-27 10:46:00 +00:00
## Options for make
When you run make you can tweak the build process a little.
### Verbose output
Show the commands called:
```bash
2021-01-17 15:43:16 +00:00
# Autotools
make V=1
2021-01-17 15:43:16 +00:00
# Meson
ninja -C build -v
```
### Debug build
Compile with debug symbols and no optimization, this is useful for making
backtraces:
```bash
2021-01-17 15:43:16 +00:00
# Autotools
make CFLAGS="-O0 -g3" clean rofi
2021-01-17 15:43:16 +00:00
# Meson
meson configure build --debug
ninja -C build
```
2015-03-28 16:04:34 +00:00
### Get a backtrace
Getting a backtrace using GDB is not very handy. Because if rofi get stuck, it
grabs keyboard and mouse. So if it crashes in GDB you are stuck. The best way
to go is to enable core file. (ulimit -c unlimited in bash) then make rofi
crash. You can then load the core in GDB.
2015-03-28 16:04:34 +00:00
```bash
2021-01-17 15:43:16 +00:00
# Autotools
gdb rofi core
2021-01-17 15:43:16 +00:00
# Meson (because it uses a separate build directory)
gdb build/rofi core
```
2015-10-25 12:54:41 +00:00
> Where the core file is located and what its exact name is different on each
> distributions. Please consult the relevant documentation.
2017-03-24 08:44:08 +00:00
For more information see the rofi-debugging(5) manpage.
2015-10-25 12:54:41 +00:00
## Install distribution
### Debian or Ubuntu
```bash
2021-01-17 15:43:16 +00:00
apt install rofi
2024-02-10 21:14:08 +00:00
```
2015-10-25 12:54:41 +00:00
### Fedora
```bash
dnf install rofi
2024-02-10 21:14:08 +00:00
```
2015-10-25 12:54:41 +00:00
2017-03-24 08:44:08 +00:00
### ArchLinux
```bash
2021-01-17 15:43:16 +00:00
pacman -S rofi
2024-02-10 21:14:08 +00:00
```
2017-10-02 11:13:04 +00:00
### Gentoo
An ebuild is available, `x11-misc/rofi`. It's up to date, but you may need to
enable ~arch to get the latest release:
```bash
2021-01-17 15:43:16 +00:00
echo 'x11-misc/rofi ~amd64' >> /etc/portage/package.accept_keywords
2024-02-10 21:14:08 +00:00
```
2017-10-02 11:13:04 +00:00
for amd64 or:
```bash
2021-01-17 15:43:16 +00:00
echo 'x11-misc/rofi ~x86' >> /etc/portage/package.accept_keywords
2024-02-10 21:14:08 +00:00
```
2017-10-02 11:13:04 +00:00
for i386.
To install it, simply issue `emerge rofi`.
### openSUSE
On both openSUSE Leap and openSUSE Tumbleweed rofi can be installed using:
```bash
2021-01-17 15:43:16 +00:00
sudo zypper install rofi
2024-02-10 21:14:08 +00:00
```
### FreeBSD
```bash
2021-01-17 15:43:16 +00:00
sudo pkg install rofi
2024-02-10 21:14:08 +00:00
```
### macOS
On macOS rofi can be installed via [MacPorts](https://www.macports.org):
```bash
sudo port install rofi
```
[master-install]: https://github.com/DaveDavenport/rofi/blob/master/INSTALL.md#install-a-checkout-from-git