autostart

Documentation

Overview

Package autostart puts Factor into the user's login sequence: a systemd user service where a user manager is running, an XDG autostart entry on other Linux desktops, a launchd agent on macOS, and a Run registry value on Windows. The wizard installs these itself — a missing autostart is a setup step, not homework for the user.

Index

• func Uninstall(ctx context.Context, env desktop.Env) error
• type Entry
  • func Install(ctx context.Context, env desktop.Env, exe, configPath string) (Entry, error)
  • func Installed(env desktop.Env) (Entry, bool)

Functions

func Uninstall

func Uninstall(ctx context.Context, env desktop.Env) error

Uninstall removes whatever Install put in place. A platform may hold more than one flavour (a box that gained systemd after an XDG install), so every flavour it knows is cleaned, and an absent entry is not an error.

Types

type Entry

type Entry struct {
	Mechanism string
	Path      string
}

Entry names an installed login entry: the mechanism in words the summary can print, and the file (or registry value) that carries it.

func Install

func Install(ctx context.Context, env desktop.Env, exe, configPath string) (Entry, error)

Install writes the login entry for this platform and enables it. exe is the binary to start; configPath, when not blank, is carried into the entry so a gateway born at login reads the same config the wizard wrote.

func Installed

func Installed(env desktop.Env) (Entry, bool)

Installed reports the login entry currently in place, if any.