diff --git a/index.html b/index.html index 70edb19..8dbe734 100644 --- a/index.html +++ b/index.html @@ -27,279 +27,38 @@

awesome-launch

-

Contents

-

Modules

-

Module launch

-

Launch clients with single instance IDs using wm-launch.

-

-

Info:

- +

API documentation for awesome-launch, a library for Awesome WM

-

Functions

- +

Modules

+
- - + + - - - - - - - - - - - - - - + +
client.by_id (id, filter)Get a launched client by its ID.awesome-launchLaunch clients with single instance IDs using wm-launch.
client.by_cmdline (cmd, filter)Get a launched client by its command line.
spawn (cmd, args)Spawn a client with wm-launch.
spawn.single_instance (cmd, args)Spawn a command if an instance is not already running.
spawn.raise_or_spawn (cmd, args)Raise a client if it exists or spawn a new one then raise it.awesome-launch.panelLaunch clients as panels.
-
-
- - -

Functions

- -
-
- - client.by_id (id, filter) -
-
- Get a launched client by its ID. - - -

Parameters:

-
    -
  • id - The ID. -
    • -
  • filter - Function to filter clients that are considered. -
    • -
- -

Returns:

-
    - - The client. -
- - - - -
-
- - client.by_cmdline (cmd, filter) -
-
- Get a launched client by its command line. - - -

Parameters:

-
    -
  • cmd - The command line. -
    • -
  • filter - Function to filter clients that are considered. -
    • -
- -

Returns:

-
    - - The client. -
- - - - -
-
- - spawn (cmd, args) -
-
- Spawn a client with wm-launch. - - -

Parameters:

-
    -
  • cmd - The command. -
    • -
  • args Table containing the single instance ID and additional arguments -
      -
    • 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). -
      • -
    • firejail - If true, run cmd with firejail. -
      • -
    -
- -

Returns:

-
    - - The client's ID. -
- - - - -
-
- - spawn.single_instance (cmd, args) -
-
- Spawn a command if an instance is not already running. - - -

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). -
      • -
    • firejail - If true, run cmd with firejail. -
      • -
    • filter - Function to filter clients that are considered. -
      • -
    -
- -

Returns:

-
    - - The client's ID. -
- - - - -
-
- - spawn.raise_or_spawn (cmd, args) -
-
- Raise a client if it exists or spawn a new one then raise it. - - -

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). -
      • -
    • firejail - If true, run cmd with firejail. -
      • -
    • filter - Function to filter clients that are considered. -
      • -
    -
- -

Returns:

-
    - - The client's ID. -
- - - - -
-
- -
generated by LDoc 1.4.6 -Last updated 2019-05-08 16:38:07 +Last updated 2019-07-02 17:25:40
diff --git a/modules/awesome-launch.html b/modules/awesome-launch.html new file mode 100644 index 0000000..27c843a --- /dev/null +++ b/modules/awesome-launch.html @@ -0,0 +1,310 @@ + + + + + awesome-launch API documentation + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module awesome-launch

+

Launch clients with single instance IDs using wm-launch.

+

+

Info:

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

Functions

+ + + + + + + + + + + + + + + + + + + + + +
client.by_id (id, filter)Get a launched client by its ID.
client.by_cmdline (cmd, filter)Get a launched client by its command line.
launch.spawn (cmd, args)Spawn a client with wm-launch.
spawn.single_instance (cmd, args)Spawn a command if an instance is not already running.
spawn.raise_or_spawn (cmd, args)Raise a client if it exists or spawn a new one then raise it.
+ +
+
+ + +

Functions

+ +
+
+ + client.by_id (id, filter) +
+
+ Get a launched client by its ID. + + +

Parameters:

+
    +
  • id + The ID. +
    • +
  • filter + Function to filter clients that are considered. +
    • +
+ +

Returns:

+
    + + The client. +
+ + + + +
+
+ + client.by_cmdline (cmd, filter) +
+
+ Get a launched client by its command line. + + +

Parameters:

+
    +
  • cmd + The command line. +
    • +
  • filter + Function to filter clients that are considered. +
    • +
+ +

Returns:

+
    + + The client. +
+ + + + +
+
+ + launch.spawn (cmd, args) +
+
+ Spawn a client with wm-launch. + + +

Parameters:

+
    +
  • cmd + The command. +
    • +
  • args Table containing the single instance ID and additional arguments +
      +
    • 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). +
      • +
    • firejail + If true, run cmd with firejail. +
      • +
    +
+ +

Returns:

+
    + + The client's ID. +
+ + + + +
+
+ + spawn.single_instance (cmd, args) +
+
+ Spawn a command if an instance is not already running. + + +

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). +
      • +
    • firejail + If true, run cmd with firejail. +
      • +
    • filter + Function to filter clients that are considered. +
      • +
    +
+ +

Returns:

+
    + + The client's ID. +
+ + + + +
+
+ + spawn.raise_or_spawn (cmd, args) +
+
+ Raise a client if it exists or spawn a new one then raise it. + + +

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). +
      • +
    • firejail + If true, run cmd with firejail. +
      • +
    • filter + Function to filter clients that are considered. +
      • +
    +
+ +

Returns:

+
    + + The client's ID. +
+ + + + +
+
+ + +
+
+
+generated by LDoc 1.4.6 +Last updated 2019-07-02 17:25:40 +
+
+ + diff --git a/modules/awesome-launch.panel.html b/modules/awesome-launch.panel.html new file mode 100644 index 0000000..5993acc --- /dev/null +++ b/modules/awesome-launch.panel.html @@ -0,0 +1,138 @@ + + + + + awesome-launch API documentation + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module awesome-launch.panel

+

Launch clients as panels.

+

+

Info:

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

Functions

+ + + + + +
toggle (cmd, args)Toggle the visibility of a panel, spawning the command if necessary.
+ +
+
+ + +

Functions

+ +
+
+ + toggle (cmd, args) +
+
+ Toggle the visibility of a panel, spawning the command if necessary. +

A panel is a floating, centered client that can be scaled to a percentage of + its size. + + + +

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). +
      • +
    • firejail + If true, run cmd with firejail. +
      • +
    • filter + Function to filter clients that are considered. +
      • +
    • scale + Percent to scale client (see awful.placement.scale). +
      • +
    +
+ + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.6 +Last updated 2019-07-02 17:25:40 +
+
+ +