awesome-launch

• Index

Contents

• Functions

Modules

• awesome-launch
• awesome-launch.panel
• awesome-launch.widget
• awesome-launch.workspace

Module awesome-launch.workspace

Create new workspaces and launch accompanying clients.

Info:

• Copyright: 2019-2020 James Reed
• Author: James Reed <jcrd@tuta.io>

Functions

client.add (cmd, args, tag)	Spawn a command and add the client to a tag.
new (name, args)	Create a new workspace and underlying (volatile) tag.
add (tag, args)	Add to or replace a given tag's clients.
selected_tag (args)	Add to or replace the selected tag's clients.

Functions

client.add (cmd, args, tag)

Spawn a command and add the client to a tag.

Parameters:

• cmd The command.
• args Table containing the single instance ID and additional arguments for spawn
  • id Single instance ID.
  • props Properties to apply to the client.
  • pwd Pathname to the working directory for new clients.
  • timeout Seconds after which to stop waiting for a client to spawn.
  • callback Function to call with client when it spawns.
  • factory The factory to use (see wm-launch's -f flag).
  • systemd If true, run cmd with systemd-run.
  • firejail If true, run cmd with firejail.
• tag The tag.

new (name, args)

Create a new workspace and underlying (volatile) tag.

Parameters:

• name The tag name.
• args Table containing tag properties and additional workspace options
  • props Properties to apply to the tag.
  • pwd Pathname to the working directory for new clients.
  • clients Table containing client commands to spawn.

    Example: args.clients = { "xterm", {"qutebrowser", {factory="qutebrowser"}} }

  • load_workspace Path to directory containing workspace file to load. Implies args.pwd.
  • callback Function to call with newly created tag.

Returns:

The new tag.

add (tag, args)

Add to or replace a given tag's clients.

Parameters:

• tag The tag to affect.
• args Table containing tag properties and additional workspace options
  • pwd Pathname to the working directory for new clients.
  • replace Kill tag's existing clients if true.
  • clients Table containing client commands to spawn.

    Example: args.clients = { "xterm", {"qutebrowser", {factory="qutebrowser"}} }

  • load_workspace Path to directory containing workspace file to load. Implies args.pwd.

Returns:

The affected tag.

selected_tag (args)

Add to or replace the selected tag's clients.

Parameters:

• args Table containing tag properties and additional workspace options
  • pwd Pathname to the working directory for new clients.
  • replace Kill tag's existing clients if true.
  • clients Table containing client commands to spawn.

    Example: args.clients = { "xterm", {"qutebrowser", {factory="qutebrowser"}} }

  • load_workspace Path to directory containing workspace file to load. Implies args.pwd.

Returns:

The affected tag.