Skip to content

Latest commit

 

History

History
108 lines (66 loc) · 3.02 KB

INSTALL.md

File metadata and controls

108 lines (66 loc) · 3.02 KB
Raw

Installation help

This document provides platform specific installation guidelines and help.

  1. All-Plaftorms
  2. Linux
  3. MacOS
  4. Known Issues

All Platforms

Requirements

SelSearch requires Python>=3.8 to be installed.

PIP Install

In a terminal / anaconda prompt, latest version of SelSearch can be obtained via pip:

pip install selsearch

Verify your installation with selsearch -v.

Optionally, you can generate a config file with:

selsearch init

Enabling XSel

Using XSel had two major benefits over the default way:

  1. it can grab selected text from a non-focused window;
  2. and it does not alter the clipboard (i.e., without XSel, SelSearch uses the clipboard to copy the selected text).

By default, Selsearch will use XSel if installed. You can opt-out of this by editing the config file:

xsel = false  # We don't want to use XSel

Linux

As most Linux distrubutions use X, it is recommended to install XSel.

MacOS

As MacOS distrubutions (can) use X, it is recommended to install XSel.

Known Issues

Linux Issues

No installation issue known until now.

MacOS Issues

Many thanks to mmakdis for providing help and screenshots for the MacOS version.

This process is not trusted! [...]

You need to allow your terminal to use your keyboard.

First, open System Preferences, and search for Security & Privacy.

drawing

Then, in Accessibility, allow the Terminal application to control your computer.

drawing

Repeat the same process for Input Monitoring.

drawing

xsel: Can't open display: (null): Inappropriate ioctl for device

In a terminal, or in your .bashrc (or equivalent), write export DISPLAY=:1. Verify that it works by testing the command xsel.

If this does fix the problem, disable XSel in the config file and open an issue.

My shortcut using <alt> doest not work

It seems that the <alt> key is mapped to <option> on MacOS keyboards.

Windows Issues

'selsearch' is not recognized as an internal or external command [...]

Most probably, when you installed SelSearch, a warning told you that Path\To\Python\Scripts\ was not in PATH. This means that the selsearch command is not directly exposed to you in the terminal.

To solve this, you must add the path to Python's scripts folder in the environment variable PATH. See this tutorial for more details.