Update docs for `spawn_callback` rename
Also includes changes to workspace.
This commit is contained in:
James Reed
parent
4e0de2c963
commit
9fefc2ecfb
|
|
@ -60,7 +60,7 @@
|
|||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/awesome-launch.workspace.html">awesome-launch.workspace</a></td>
|
||||
<td class="summary">Create new tags and launch accompanying clients.</td>
|
||||
<td class="summary">Create new workspaces and launch accompanying clients.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
|
@ -68,7 +68,7 @@
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2019-09-16 08:13:41 </i>
|
||||
<i style="float:right;">Last updated 2020-08-05 14:22:49 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -176,7 +176,7 @@
|
|||
<li><span class="parameter">timeout</span>
|
||||
Seconds after which to stop waiting for a client to spawn.
|
||||
</li>
|
||||
<li><span class="parameter">spawn_callback</span>
|
||||
<li><span class="parameter">callback</span>
|
||||
Function to call with client when it spawns.
|
||||
</li>
|
||||
<li><span class="parameter">factory</span>
|
||||
|
|
@ -225,7 +225,7 @@
|
|||
<li><span class="parameter">timeout</span>
|
||||
Seconds after which to stop waiting for a client to spawn.
|
||||
</li>
|
||||
<li><span class="parameter">spawn_callback</span>
|
||||
<li><span class="parameter">callback</span>
|
||||
Function to call with client when it spawns.
|
||||
</li>
|
||||
<li><span class="parameter">factory</span>
|
||||
|
|
@ -277,10 +277,10 @@
|
|||
<li><span class="parameter">timeout</span>
|
||||
Seconds after which to stop waiting for a client to spawn.
|
||||
</li>
|
||||
<li><span class="parameter">spawn_callback</span>
|
||||
<li><span class="parameter">callback</span>
|
||||
Function to call with client when it spawns.
|
||||
</li>
|
||||
<li><span class="parameter">callback</span>
|
||||
<li><span class="parameter">raise_callback</span>
|
||||
Function to call with client when it spawns or is raised.
|
||||
</li>
|
||||
<li><span class="parameter">factory</span>
|
||||
|
|
@ -340,7 +340,7 @@
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2019-09-16 08:13:41 </i>
|
||||
<i style="float:right;">Last updated 2020-08-05 14:22:49 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -103,7 +103,7 @@
|
|||
<li><span class="parameter">timeout</span>
|
||||
Seconds after which to stop waiting for a client to spawn.
|
||||
</li>
|
||||
<li><span class="parameter">spawn_callback</span>
|
||||
<li><span class="parameter">callback</span>
|
||||
Function to call with client when it spawns.
|
||||
</li>
|
||||
<li><span class="parameter">factory</span>
|
||||
|
|
@ -133,7 +133,7 @@
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2019-09-16 08:13:41 </i>
|
||||
<i style="float:right;">Last updated 2020-08-05 14:22:49 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -121,7 +121,7 @@
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2019-09-16 08:13:41 </i>
|
||||
<i style="float:right;">Last updated 2020-08-05 14:22:49 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -49,7 +49,7 @@
|
|||
<div id="content">
|
||||
|
||||
<h1>Module <code>awesome-launch.workspace</code></h1>
|
||||
<p>Create new tags and launch accompanying clients.</p>
|
||||
<p>Create new workspaces and launch accompanying clients.</p>
|
||||
<p></p>
|
||||
<h3>Info:</h3>
|
||||
<ul>
|
||||
|
|
@ -65,8 +65,16 @@
|
|||
<td class="summary">Spawn a command and add the client to a tag.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#add">add (name, args)</a></td>
|
||||
<td class="summary">Create a new workspace and underlying tag.</td>
|
||||
<td class="name" nowrap><a href="#new">new (name, args)</a></td>
|
||||
<td class="summary">Create a new workspace and underlying (volatile) tag.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#add">add (tag, args)</a></td>
|
||||
<td class="summary">Add to or replace a given tag's clients.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#selected_tag">selected_tag (args)</a></td>
|
||||
<td class="summary">Add to or replace the selected tag's clients.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
|
@ -104,7 +112,7 @@
|
|||
<li><span class="parameter">timeout</span>
|
||||
Seconds after which to stop waiting for a client to spawn.
|
||||
</li>
|
||||
<li><span class="parameter">spawn_callback</span>
|
||||
<li><span class="parameter">callback</span>
|
||||
Function to call with client when it spawns.
|
||||
</li>
|
||||
<li><span class="parameter">factory</span>
|
||||
|
|
@ -125,11 +133,11 @@
|
|||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "add"></a>
|
||||
<strong>add (name, args)</strong>
|
||||
<a name = "new"></a>
|
||||
<strong>new (name, args)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Create a new workspace and underlying tag.
|
||||
Create a new workspace and underlying (volatile) tag.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
|
|
@ -150,6 +158,10 @@
|
|||
<p> Example: <code>args.clients = { "xterm",
|
||||
{"qutebrowser", {factory="qutebrowser"}} }</code>
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">load_workspace</span>
|
||||
Path to directory containing workspace file to
|
||||
load. Implies args.pwd.
|
||||
</li>
|
||||
<li><span class="parameter">callback</span>
|
||||
Function to call with newly created tag.
|
||||
|
|
@ -166,6 +178,91 @@
|
|||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "add"></a>
|
||||
<strong>add (tag, args)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Add to or replace a given tag's clients.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">tag</span>
|
||||
The tag to affect.
|
||||
</li>
|
||||
<li><span class="parameter">args</span> Table containing tag properties and additional workspace options
|
||||
<ul>
|
||||
<li><span class="parameter">pwd</span>
|
||||
Pathname to the working directory for new clients.
|
||||
</li>
|
||||
<li><span class="parameter">replace</span>
|
||||
Kill tag's existing clients if true.
|
||||
</li>
|
||||
<li><span class="parameter">clients</span>
|
||||
Table containing client commands to spawn.
|
||||
<p> Example: <code>args.clients = { "xterm",
|
||||
{"qutebrowser", {factory="qutebrowser"}} }</code>
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">load_workspace</span>
|
||||
Path to directory containing workspace file to
|
||||
load. Implies args.pwd.
|
||||
</li>
|
||||
</li></ul>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
The affected tag.
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "selected_tag"></a>
|
||||
<strong>selected_tag (args)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Add to or replace the selected tag's clients.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">args</span> Table containing tag properties and additional workspace options
|
||||
<ul>
|
||||
<li><span class="parameter">pwd</span>
|
||||
Pathname to the working directory for new clients.
|
||||
</li>
|
||||
<li><span class="parameter">replace</span>
|
||||
Kill tag's existing clients if true.
|
||||
</li>
|
||||
<li><span class="parameter">clients</span>
|
||||
Table containing client commands to spawn.
|
||||
<p> Example: <code>args.clients = { "xterm",
|
||||
{"qutebrowser", {factory="qutebrowser"}} }</code>
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">load_workspace</span>
|
||||
Path to directory containing workspace file to
|
||||
load. Implies args.pwd.
|
||||
</li>
|
||||
</li></ul>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
The affected tag.
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
|
@ -174,7 +271,7 @@
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2019-09-16 08:13:41 </i>
|
||||
<i style="float:right;">Last updated 2020-08-05 14:22:49 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
Loading…
Reference in New Issue