Skip to content

Command Line

Jump to bottom
Dom Rodriguez edited this page May 28, 2020 · 4 revisions

Using Barrier from the Command Line

You might to use the command line without the GUI to run barrier, especially if you do not change settings frequently or do not want the Qt GUI running all the time. These instructions cover using Barrier via the command line interface.

The Synergy wiki was used as a reference in creating this documentation.

Document Conventions

  • Text in angle brackets <text> is input supplied by the user
  • Text in square brackets [text] represents optional inputs
  • Text in curly braces with pipes {true|false} represents options to choose from
  • Text in italics are user interface elements or items on-screen
  • Text in a monospaced font are keyboard shortcuts, prompts, commands, or command output

Topics

Windows

To use Barrier commands from the command line in Windows you can either change directories to the folder that they are located in each time or add the Barrier directory to your %PATH% variable.

To change to the directory:

cd "\Program Files\Barrier"

To add the directory to %PATH%:

  • Press (⊞ Win) + Break to view the System control panel
  • Click on Advanced system settings on the left panel
  • On the Advanced tab, click the Environment Variables... button
  • In the System variables list, double-click the Variable named Path
  • Click New and enter C:\Program Files\Barrier
  • Click OK in the Edit environment variable dialog
  • Click OK in the Environment Variables dialog
  • Click OK in the System Properties dialog

This will only effect command prompts opened after the change.

Back to top

MacOS

To use Barrier commands from the command line on MacOS you can either change directories to the folder they are located and run them using the relative path (i.e. ./barriers) each time or add the Barrier.app/Contents/MacOS directory to your $PATH.

cd /Applications/Barrier.app/Contents/MacOS/

To add the directory to $PATH:

export PATH=/Applications/Barrier.app/Contents/MacOS/:$PATH

The $PATH variable will only be set for the duration of the current shell session. To make the path persistent, add it as a new line in the /etc/paths file or set the $PATH variable in your .profile or .bashrc file.

Back to top

Linux/Unix

If Barrier has been installed using a package manager or equivalent it should already be in your $PATH.

Back to top

Server Command Line Options

To see the server command line options, use the --help argument:

barriers --help
Start the barrier server component.

Usage: barriers [--address <address>] [--config <pathname>] [--daemon|--no-daemon] [--name <screen-name>] [--restart|--no-restart] [--debug <level>]

Options:
  -a, --address <address>  listen for clients on the given address.
  -c, --config <pathname>  use the named configuration file instead.
  -d, --debug <level>      filter out log messages with priority below level.
                             level may be: FATAL, ERROR, WARNING, NOTE, INFO,
                             DEBUG, DEBUG1, DEBUG2.
  -n, --name <screen-name> use screen-name instead the hostname to identify
                             this screen in the configuration.
  -1, --no-restart         do not try to restart on failure.
      --restart            restart the server automatically if it fails. (*)
  -l  --log <file>         write log messages to file.
      --no-tray            disable the system tray icon.
      --enable-drag-drop   enable file drag & drop.
      --enable-crypto      enable the crypto (ssl) plugin.
  -f, --no-daemon          run in the foreground.

Back to top

Client Command Line Options

To see the client command line options, use the --help argument:

barrierc --help
Start the barrier client and connect to a remote server component.

Usage: barrierc [--yscroll <delta>] [--daemon|--no-daemon] [--name <screen-name>] [--restart|--no-restart] [--debug <level>] <server-address>

Options:
  -d, --debug <level>      filter out log messages with priority below level.
                             level may be: FATAL, ERROR, WARNING, NOTE, INFO,
                             DEBUG, DEBUG1, DEBUG2.
  -n, --name <screen-name> use screen-name instead the hostname to identify
                             this screen in the configuration.
  -1, --no-restart         do not try to restart on failure.
      --restart            restart the server automatically if it fails. (*)
  -l  --log <file>         write log messages to file.
      --no-tray            disable the system tray icon.
      --enable-drag-drop   enable file drag & drop.
      --enable-crypto      enable the crypto (ssl) plugin.
  -f, --no-daemon          run in the foreground.
      --daemon             run as a daemon. (*)

Back to top

Creating a systemd service (Linux)

If you would like to add the barrier client or server as a service on a systemd-based linux distribution, you can create a .service file for systemd.

Running Barrier as a systemd service as the root user will allow Barrier to access any X11 screen. If you need to use Barrier before logging (i.e. in a Display Manager like GDM) in this is possibly the only option despite the possible security concern of running Barrier as root. If you do not need to use Barrier at the login screen it is likely better to run Barrier under your user account.

Here is an example .service template for a service on a computer used by one person where Barrier does not need access to the Display Manager. This can be put in the /etc/systemd/system/ directory and started or stopped with the systemctl command. This assumes that the X11 display is on :0.

[Unit]
Description=Barrier Client daemon
After=network.target

[Service]
User=<username>
Group=<groupname>
ExecStart=barrierc --enable-crypto --display :0 --debug INFO -f <server hostname or IP>
Restart=always

[Install]
WantedBy=multi-user.target

If you want to use a systemd Barrier service on a multi-user system, consider using a user service or starting the GUI application at logon instead.

The barrier client can also be started from the command line remotely using ssh as long as $DISPLAY is set or specified with --display.

Back to top

Launchd daemon (MacOS)

If you want to create a daemon for MacOS instead of using the GUI, you can create a daemon/agent using a .plist file in ~/Library/LaunchAgents. Information about creating daemons/agents for MacOS can be found at launchd.info.

The recommended method of starting automatically on MacOS is with the GUI by dragging Barrier.app to the Login Items pane in System Preferences > Users & Groups. This method does start Barrier after logging in.

Back to top

Windows Service

The Windows version uses a service that can be started/stopped in the Windows Services snap-in. The Services snap-in can be accessed by pressing (⊞ Win) + R and typing services.msc in the Run dialog. The service is named Barrier.

Back to top

Text File Configuration

If you use Barrier from the command line you may need to create a configuration file. Configuration files can be copied from their default GUI locations as a baseline.

The client will use the configuration specified by the server.

When a text file configuration is used it needs to be specified with the --config option on the command line or it will use the default locations.

barriers --config ~/barrier/config/path/file.conf ...

Back to top

Server Configuration File

The text file configuration uses four different sections; screens, aliases, links and options. The structure of a server configuration file looks something like this:

section: screens
    hostname1:
        setting = value
    hostname2:
        setting = value
end
section: aliases
    hostname1:
        hostname1.alias
    hostname2:
        hostname2.alias
end
section: links
    hostname1:
        direction = hostname2
    hostname2:
        direction = hostname1
end
section: options
    option = value
end

Examples can be found in the doc directory of the Barrier repository.

Back to top

Screen Options

By default screens use the hostname of the server or client. Each screen may have any of the following settings:

halfDuplexCapsLock = {true|false}
halfDuplexNumLock = {true|false}
halfDuplexScrollLock = {true|false}
switchCorners = {none, top-left, top-right, bottom-left, bottom-right, left, right, top, bottom, all}
switchCornerSize = N
xtestIsXineramaUnaware = {true|false}
preserveFocus = {true|false}
shift = {shift|ctrl|alt|meta|super|none}
ctrl = {shift|ctrl|alt|meta|super|none}
alt = {shift|ctrl|alt|meta|super|none}
altgr = {shift|ctrl|alt|meta|super|none}
meta = {shift|ctrl|alt|meta|super|none}
super = {shift|ctrl|alt|meta|super|none}
  • halfDuplexCapsLock, halfDuplexNumLock, and halfDuplexScrollLock are for clients that use a press to enable and a release to disable instead of toggling with a press and release
  • switchCorners prevents switching when reaching the edge of any of the listed corners
  • switchCornerSize is the size in pixels to ignore on a screen edge when using switchCorners
  • xtestIsXineramaUnaware works around a bug when using certain versions of the XTest extension in combination with Xinerama on X11 clients (Linux)
  • preserveFocus prevents dropping focus of the current window when switching screens
  • shift, ctrl, alt, altgr, meta, and super allow these keys to be mapped to a different key for that screen

Back to top

Aliases

By default a screen name is the hostname of the client or server. However, the screen name can be specified on the command line for both the server and client with the --screen option and if there is a matching Alias it will be recognized. Aliases must be unique.

Back to top

Links

The links section describes the screens relationships to each other. Links allow you to specify how screens are layed in relation to each other. Links use the following format:

{left|right|up|down}(<range>) = name(<range>)

Each link defines a screen edge and the screen name it connects to. The range is an optional percentage (between 0 and 100) of the edge that will connect to the other screen. For example, if there are two hosts on the right of host1 and they are split 50-50 on the right edge, the configuration might look something like this:

section: links
    host1:
        right(0,50) = host2(50,100)
        right(50,100) = host3(0,50)
...

Overlaps on the screen ranges are not supported.

A simpler configuration with two hosts might look like this:

section: links
    host1:
        right = host2
    host2:
        left = host1

The GUI can be used to set up the layout and the configuration can be copied into the configuration file being used for the command line.

Back to top

Options

The key/value pairs in the options section are global options that apply to all screens.

heartbeat = N
switchCorners = {none, top-left, top-right, bottom-left, bottom-right, left, right, top, bottom, all}
switchCornerSize = N
switchDelay = N
switchDoubleTap = N
screenSaverSync = {true|false}
relativeMouseMoves = {true|false}
clipboardSharing = {true|false}
clipboardSharingSize = N
win32KeepForeground = {true|false}
keystroke(key) = actions
mousebutton(button) = actions
  • heartbeat disconnects clients if they do not send a message within N milliseconds
  • switchCorners prevents switching screens when reaching the edge on any of the listed corners
  • switchCornerSize is the size in pixels to ignore on a screen edge when using switchCorners
  • switchDelay prevents switching unless the mouse rests on the edge for N milliseconds
  • switchDoubleTap prevents switching unless the edge is double-tapped within N milliseconds
  • screenSaverSync will sync the screensavers if set to true. If set to false the clients will use their own screensaver settings and the server screensaver won't start as long as there is input to any screen
  • relativeMouseMoves causes clients to move the mouse using relative coordinates rather than absolute when the cursor is locked to a screen. This is may assist with certain games
  • clipboardSharing enables sharing clipboard contents between server and clients if set to true
  • clipboardSharingSize sets a limit of N Kb of data when clipboard sharing is enabled
  • win32KeepForeground grabs the focus of on a Windows server on switching to a client if set to true. If set to false it will leave the current window in the foreground. Leaving this setting on true avoids issues with other apps interfering with reading hardware inputs
  • keystroke can be used to bind actions to keys
  • mousebutton can be used to bind a modifier and a mouse button (left is 1, middle is 2, and right is 3) to an action.

Back to top

Actions

Back to top

Keys

Keys can be in either unicode hexadecimal format (i.e. \uXXXX) or a valid key name. The following named keys are valid in a configuration:

Standard Keys Standard Keys Keypad Keys Media Keys Web Keys
F1 to F35 Left KP_0 to KP_9 AppMail WWWBack
Ampersand LeftTab KP_F1 to KP_F4 AppMedia WWWFavorites
Apostrophe Less KP_Add AppUser1 WWWForward
Asterisk Linefeed KP_Begin AppUser2 WWWHome
At Menu KP_Decimal AudioDown WWWRefresh
BackSpace Minus KP_Delete AudioMute WWWSearch
Backslash NumLock KP_Divide AudioNext WWWStop
Bar Number KP_Down AudioPlay
Begin PageDown KP_End AudioPrev
BraceL PageUp KP_Enter AudioStop
BraceR ParenthesisL KP_Equal AudioUp
BracketL ParenthesisR KP_Home Eject
BracketR Pause KP_Insert
Break Percent KP_Left
Cancel Period KP_Multiply
CapsLock Plus KP_PageDown
Circumflex Print KP_PageUp
Clear Question KP_Right
Colon Redo KP_Separator
Comma Return KP_Space
Delete Right KP_Subtract
Dollar ScrollLock KP_Tab
DoubleQuote Select KP_Up
Down Semicolon
End Slash
Equal Sleep
Escape Space
Exclaim Space
Execute SysReq
Find Tab
Grave Tilde
Greater Underscore
Help Undo
Home Up
Insert

Back to top

Client Configuration File

Client options are set either by the command line arguments or by the server the client has connected to. There is no --config argument for the barrierc client command.

The client saves a configuration file that can be read for informational or troubleshooting purposes, and is structured like an .ini file. It has two sections, [General] and [internalConfig].

Back to top

Clone this wiki locally