From 64ce362410ffe912dafdc30dba3b7a6e04e2e98e Mon Sep 17 00:00:00 2001 From: Anton Palmqvist <13031779+AntonPalmqvist@users.noreply.github.com> Date: Tue, 9 Sep 2025 20:12:12 -0700 Subject: [PATCH] Documentation: Added tips for Linux users - Added info about missing package when on a fresh Ubuntu install - Added info on how to create an alias for easier launch --- doc/source/GettingStarted/InstallingGaffer/index.md | 2 ++ doc/source/GettingStarted/LaunchingGafferFirstTime/index.md | 6 ++++++ 2 files changed, 8 insertions(+) diff --git a/doc/source/GettingStarted/InstallingGaffer/index.md b/doc/source/GettingStarted/InstallingGaffer/index.md index 5be1335e63f..33a78c28248 100644 --- a/doc/source/GettingStarted/InstallingGaffer/index.md +++ b/doc/source/GettingStarted/InstallingGaffer/index.md @@ -25,6 +25,8 @@ To install Gaffer in Linux: Gaffer is now installed to `/opt/gaffer-!GAFFER_VERSION!-linux`. +> Note : +> On Ubuntu you might also need to install the `libxcb-cursor0` package by running the following command: `sudo apt install libxcb-cursor0` ## Installing in Windows ## diff --git a/doc/source/GettingStarted/LaunchingGafferFirstTime/index.md b/doc/source/GettingStarted/LaunchingGafferFirstTime/index.md index 53948ac6f55..fd29f197509 100644 --- a/doc/source/GettingStarted/LaunchingGafferFirstTime/index.md +++ b/doc/source/GettingStarted/LaunchingGafferFirstTime/index.md @@ -25,6 +25,12 @@ To launch Gaffer for the first time in Linux: Gaffer will launch in a new window. +> Tip : +> Create an alias to make it easier to launch by adding the following line to your `~/.bash_aliases` file: +> `alias gaffer='/opt/gaffer-!GAFFER_VERSION!-linux/bin/gaffer'` +> and if you have a HiDPI display you can also add QT_SCALE_FACTOR=2 to make the interface scale better to your display: +> `alias gaffer='QT_SCALE_FACTOR=2 /opt/gaffer-!GAFFER_VERSION!-linux/bin/gaffer'` +> Refresh by running `source ~/.bash_aliases` and you can now launch by simply typing `gaffer` in the terminal, no matter what folder you're in. ## Launching in Windows ##