Skip to content

Documentation: Added tips for Linux users #6589

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AntonPalmqvist wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Documentation: Added tips for Linux users #6589

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions doc/source/GettingStarted/InstallingGaffer/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 ##

Expand Down
6 changes: 6 additions & 0 deletions doc/source/GettingStarted/LaunchingGafferFirstTime/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 ##

Expand Down