The cl-wol.cli Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-wol.cli Reference Manual

This is the cl-wol.cli Reference Manual, version 0.1.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Sun May 15 04:19:18 2022 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

* cl-wol

=cl-wol= is a Common Lisp system and CLI application, which can power
on remote systems using [[https://en.wikipedia.org/wiki/Wake-on-LAN][Wake on LAN (WoL)]].

* Requirements

- [[https://www.quicklisp.org/beta/][Quicklisp]]

* Installation

=cl-wol= is not yet in Quicklisp, so in order to install it you will need to
clone the repo and add it to your [[https://www.quicklisp.org/beta/faq.html][Quicklisp local-projects]].

#+begin_src shell
  cd ~/quicklisp/local-projects
  git clone https://github.com/dnaeon/cl-wol.git
#+end_src

If you are installing the CLI application, you will also need a recent
version of [[https://github.com/dnaeon/clingon][clingon]], as the one found in Quicklisp is not yet updated
to the latest release.

* Systems

=cl-wol= provides the following systems.

The =cl-wol.core= system provides the core functionallity for powering
on remote systems using [[https://en.wikipedia.org/wiki/Wake-on-LAN][Wake on LAN (WoL)]] by broadcasting a magic
packet to a destination port and address.

The =cl-wol.test= system provides the test suite of =cl-wol.core=.

The =cl-wol.cli= system provides a command-line interface application,
built on top of =cl-wol.core=, which comes with support for looking up
hosts and their MAC addresses from a local SQLite database.

* Usage

The following formats of MAC addresses are supported by =cl-wol=.

- As a string in =AA:BB:CC:DD:EE:FF= format
- As a string in =AA-BB-CC-DD-EE-FF= format
- As a =(simple-array (unsigned-byte 8) (6))= vector

** API

The following section describes how to use the =cl-wol.core= system.

First, start your Lisp REPL and load the system.

#+begin_src lisp
  CL-USER> (ql:quickload :cl-wol.core)
  To load "cl-wol.core":
    Load 1 ASDF system:
      cl-wol.core
  ; Loading "cl-wol.core"

  (:CL-WOL.CORE)
#+end_src

In order to wake a remote system identified by a given MAC address we
first need to create a new instance of =CL-WOL.CORE:MAGIC-PACKET=.

#+begin_src lisp
  CL-USER> (defparameter *magic-packet*
             (cl-wol.core:make-magic-packet "aa:bb:cc:dd:ee:ff"))
  *MAGIC-PACKET*
#+end_src

The =CL-WOL.CORE:MAKE-MAGIC-PACKET= function accepts an optional
second argument, which represents a =SecureOn= password. The format of
the =SecureOn= password is the same as the one for MAC addresses. For
example, if you need to create a magic packet with =SecureOn= password
appended to the payload you can evaluate the following expression.

#+begin_src lisp
  CL-USER> (defparameter *magic-packet*
             (cl-wol.core:make-magic-packet "aa:bb:cc:dd:ee:ff" "00-00-00-00-00-00"))
  *MAGIC-PACKET*
#+end_src

Another way to create a magic packet is by providing a =(simple-array
(unsigned-byte 8) (6)= vector to =CL-WOL.CORE:MAKE-MAGIC-PACKET=. You
can also use the =CL-WOL.CORE:MAKE-OCTET-VECTOR= function to create a
new octet vector. For example.

#+begin_src lisp
  CL-USER> (defparameter *magic-packet*
             (cl-wol.core:make-magic-packet (cl-wol.core:make-octet-vector #(1 2 3 4 5 6))))
  *MAGIC-PACKET*
#+end_src

Now that we have a magic packet we can broadcast it to a given port
and address. In order to do that we will use the =CL-WOL.CORE:WAKE=
generic function. The following example broadcasts the magic packet
to =255.255.255.255= on port =7=.

#+begin_src lisp
  CL-USER> (cl-wol.core:wake *magic-packet* "255.255.255.255" 7)
  T
#+end_src

** CLI

[[./images/wol-demo.gif]]

You can build the CLI application of =cl-wol= by executing the
following command.

#+begin_src shell
  make cli
#+end_src

The default Lisp implementation is SBCL, so if you are using a
different implementation simply pass the =LISP= environment variable
before invoking the =cli= target. This command builds the CLI
application using Clozure Common Lisp for example.

#+begin_src shell
  LISP=ccl make cli
#+end_src

Once the app is built you can find the executable in the =bin=
directory of the =cl-wol.cli= system, which you can later install
somewhere in your =PATH=, e.g.

#+begin_src shell
  sudo install ./bin/wol /usr/local/bin
#+end_src

You can also generate Zsh completions for the CLI application by
executing the =wol zsh-completions= sub-command, e.g.

#+begin_src shell
  wol zsh-completions > ~/.zsh-completions/_wol
#+end_src

You can wake up remote systems by using the =wol wake=
sub-command. Multiple MAC addresses can be specified on the
command-line as separate arguments, e.g.

#+begin_src shell
  $ wol wake 00:01:02:03:04:05 aa:bb:cc:dd:ee:ff
  Waking up 00:01:02:03:04:05 ...
  Waking up aa:bb:cc:dd:ee:ff ...
#+end_src

Instead of remembering MAC addresses by heart the =cl-wol= CLI
application supports storing MAC addresses in a local SQLite database,
which can be looked up by the various sub-commands.

First, we need to initialize a new database file using the =wol
init-db= sub-command.

#+begin_src shell
  $ wol init-db --database wol.db
    [14:25:36] cl-migratum.core core.lisp (apply-pending) -
    Found 1 pending migration(s) to be applied
    [14:25:36] cl-migratum.core core.lisp (apply-and-register) -
    Applying migration 20211222183337 - add_hosts_table
#+end_src

Once the database is initialized you can add hosts to it. For example:

#+begin_src shell
  wol add-host --database wol.db --address aa:bb:cc:dd:ee:ff --name box-01
  wol add-host --database wol.db --address 01:02:03:04:05:06 --name box-02
#+end_src

Listing the hosts from the database is done via the =wol list-hosts=
sub-command.

#+begin_src shell
  $ wol list-hosts --database wol.db
  +----+--------+-------------------+---------------------+
  | ID | NAME   | ADDR              | CREATED AT          |
  +----+--------+-------------------+---------------------+
  |  1 | box-01 | aa:bb:cc:dd:ee:ff | 2021-12-26 14:27:19 |
  |  2 | box-02 | 01:02:03:04:05:06 | 2021-12-26 14:27:30 |
  +----+--------+-------------------+---------------------+
#+end_src

You can now wake up hosts by referring to their names. In order to do
that use the =--database= and =--name= options of the =wol wake=
sub-command. The =--name= option can be repeated multiple times in
order to refer to different hosts, e.g.

#+begin_src shell
  $ wol wake --database wol.db --name box-01 --name box-02
  Waking up 01:02:03:04:05:06 ...
  Waking up aa:bb:cc:dd:ee:ff ...
#+end_src

Deleting hosts from the database is done via the =wol delete-host=
sub-command, e.g.

#+begin_src shell
  wol delete-host --database wol.db box-01 box-02
#+end_src

* Tests

Tests are provided as part of the =:cl-wol.test= system.

In order to run the tests you can evaluate the following expressions
from your Lisp REPL.

#+begin_src lisp
  CL-USER> (ql:quickload :cl-wol.test)
  CL-USER> (asdf:test-system :cl-wol.test)
#+end_src

Or you can run the tests using the =test= target instead, e.g.

#+begin_src shell
  make test
#+end_src

Here's how to run the tests against SBCL, CCL and ECL for example.

#+begin_src shell
  for lisp in sbcl ccl ecl; do
      echo "Running tests using ${lisp} ..."
      LISP=${lisp} make test > ${lisp}-tests.out
  done
#+end_src

* Docker Images

You can build and run a Docker image of the CLI application by
executing the following commands.

#+begin_src shell
  docker build -t cl-wol.cli:latest -f Dockerfile .
#+end_src

A separate image can be built for running the test suite of =cl-wol=.

#+begin_src shell
  docker build -t cl-wol.test:latest -f Dockerfile.tests .
  docker run --rm cl-wol.test:latest
#+end_src

* Contributing

=cl-wol= is hosted on [[https://github.com/dnaeon/cl-wol][Github]]. Please contribute by reporting issues,
suggesting features or by sending patches using pull requests.

* License

This project is Open Source and licensed under the [[http://opensource.org/licenses/BSD-2-Clause][BSD License]].

* Authors

- Marin Atanasov Nikolov 


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.


Next: , Previous: , Up: Systems   [Contents][Index]

2.1 cl-wol.cli

Long Name

cl-wol.cli

Maintainer

Marin Atanasov Nikolov <dnaeon@gmail.com>

Author

Marin Atanasov Nikolov <dnaeon@gmail.com>

Home Page

https://github.com/dnaeon/cl-wol

Source Control

https://github.com/dnaeon/cl-wol

Bug Tracker

https://github.com/dnaeon/cl-wol

License

BSD 2-Clause

Description

CLI built on top of the cl-wol.core system

Long Description

* cl-wol

=cl-wol= is a Common Lisp system and CLI application, which can power
on remote systems using [[https://en.wikipedia.org/wiki/Wake-on-LAN][Wake on LAN (WoL)]].

* Requirements

- [[https://www.quicklisp.org/beta/][Quicklisp]]

* Installation

=cl-wol= is not yet in Quicklisp, so in order to install it you will need to
clone the repo and add it to your [[https://www.quicklisp.org/beta/faq.html][Quicklisp local-projects]].

#+begin_src shell
cd ~/quicklisp/local-projects
git clone https://github.com/dnaeon/cl-wol.git
#+end_src

If you are installing the CLI application, you will also need a recent
version of [[https://github.com/dnaeon/clingon][clingon]], as the one found in Quicklisp is not yet updated to the latest release.

* Systems

=cl-wol= provides the following systems.

The =cl-wol.core= system provides the core functionallity for powering
on remote systems using [[https://en.wikipedia.org/wiki/Wake-on-LAN][Wake on LAN (WoL)]] by broadcasting a magic packet to a destination port and address.

The =cl-wol.test= system provides the test suite of =cl-wol.core=.

The =cl-wol.cli= system provides a command-line interface application,
built on top of =cl-wol.core=, which comes with support for looking up
hosts and their MAC addresses from a local SQLite database.

* Usage

The following formats of MAC addresses are supported by =cl-wol=.

- As a string in =AA:BB:CC:DD:EE:FF= format
- As a string in =AA-BB-CC-DD-EE-FF= format
- As a =(simple-array (unsigned-byte 8) (6))= vector

** API

The following section describes how to use the =cl-wol.core= system.

First, start your Lisp REPL and load the system.

#+begin_src lisp
CL-USER> (ql:quickload :cl-wol.core)
To load "cl-wol.core":
Load 1 ASDF system:
cl-wol.core
; Loading "cl-wol.core"

(:CL-WOL.CORE)
#+end_src

In order to wake a remote system identified by a given MAC address we
first need to create a new instance of =CL-WOL.CORE:MAGIC-PACKET=.

#+begin_src lisp
CL-USER> (defparameter *magic-packet*
(cl-wol.core:make-magic-packet "aa:bb:cc:dd:ee:ff"))
*MAGIC-PACKET*
#+end_src

The =CL-WOL.CORE:MAKE-MAGIC-PACKET= function accepts an optional
second argument, which represents a =SecureOn= password. The format of
the =SecureOn= password is the same as the one for MAC addresses. For
example, if you need to create a magic packet with =SecureOn= password
appended to the payload you can evaluate the following expression.

#+begin_src lisp
CL-USER> (defparameter *magic-packet*
(cl-wol.core:make-magic-packet "aa:bb:cc:dd:ee:ff" "00-00-00-00-00-00"))
*MAGIC-PACKET*
#+end_src

Another way to create a magic packet is by providing a =(simple-array
(unsigned-byte 8) (6)= vector to =CL-WOL.CORE:MAKE-MAGIC-PACKET=. You
can also use the =CL-WOL.CORE:MAKE-OCTET-VECTOR= function to create a
new octet vector. For example.

#+begin_src lisp
CL-USER> (defparameter *magic-packet*
(cl-wol.core:make-magic-packet (cl-wol.core:make-octet-vector #(1 2 3 4 5 6)))) *MAGIC-PACKET*
#+end_src

Now that we have a magic packet we can broadcast it to a given port
and address. In order to do that we will use the =CL-WOL.CORE:WAKE=
generic function. The following example broadcasts the magic packet
to =255.255.255.255= on port =7=.

#+begin_src lisp
CL-USER> (cl-wol.core:wake *magic-packet* "255.255.255.255" 7)
T
#+end_src

** CLI

[[./images/wol-demo.gif]]

You can build the CLI application of =cl-wol= by executing the
following command.

#+begin_src shell
make cli
#+end_src

The default Lisp implementation is SBCL, so if you are using a
different implementation simply pass the =LISP= environment variable
before invoking the =cli= target. This command builds the CLI
application using Clozure Common Lisp for example.

#+begin_src shell
LISP=ccl make cli
#+end_src

Once the app is built you can find the executable in the =bin=
directory of the =cl-wol.cli= system, which you can later install
somewhere in your =PATH=, e.g.

#+begin_src shell
sudo install ./bin/wol /usr/local/bin
#+end_src

You can also generate Zsh completions for the CLI application by
executing the =wol zsh-completions= sub-command, e.g.

#+begin_src shell
wol zsh-completions > ~/.zsh-completions/_wol
#+end_src

You can wake up remote systems by using the =wol wake=
sub-command. Multiple MAC addresses can be specified on the
command-line as separate arguments, e.g.

#+begin_src shell
$ wol wake 00:01:02:03:04:05 aa:bb:cc:dd:ee:ff
Waking up 00:01:02:03:04:05 ...
Waking up aa:bb:cc:dd:ee:ff ...
#+end_src

Instead of remembering MAC addresses by heart the =cl-wol= CLI
application supports storing MAC addresses in a local SQLite database,
which can be looked up by the various sub-commands.

First, we need to initialize a new database file using the =wol
init-db= sub-command.

#+begin_src shell
$ wol init-db –database wol.db
<INFO> [14:25:36] cl-migratum.core core.lisp (apply-pending) -
Found 1 pending migration(s) to be applied
<INFO> [14:25:36] cl-migratum.core core.lisp (apply-and-register) -
Applying migration 20211222183337 - add_hosts_table
#+end_src

Once the database is initialized you can add hosts to it. For example:

#+begin_src shell
wol add-host –database wol.db –address aa:bb:cc:dd:ee:ff –name box-01
wol add-host –database wol.db –address 01:02:03:04:05:06 –name box-02
#+end_src

Listing the hosts from the database is done via the =wol list-hosts=
sub-command.

#+begin_src shell
$ wol list-hosts –database wol.db
+—-+——–+——————-+———————+
| ID | NAME | ADDR | CREATED AT | +—-+——–+——————-+———————+
| 1 | box-01 | aa:bb:cc:dd:ee:ff | 2021-12-26 14:27:19 |
| 2 | box-02 | 01:02:03:04:05:06 | 2021-12-26 14:27:30 | +—-+——–+——————-+———————+
#+end_src

You can now wake up hosts by referring to their names. In order to do
that use the =–database= and =–name= options of the =wol wake=
sub-command. The =–name= option can be repeated multiple times in
order to refer to different hosts, e.g.

#+begin_src shell
$ wol wake –database wol.db –name box-01 –name box-02
Waking up 01:02:03:04:05:06 ...
Waking up aa:bb:cc:dd:ee:ff ...
#+end_src

Deleting hosts from the database is done via the =wol delete-host=
sub-command, e.g.

#+begin_src shell
wol delete-host –database wol.db box-01 box-02
#+end_src

* Tests

Tests are provided as part of the =:cl-wol.test= system.

In order to run the tests you can evaluate the following expressions
from your Lisp REPL.

#+begin_src lisp
CL-USER> (ql:quickload :cl-wol.test)
CL-USER> (asdf:test-system :cl-wol.test)
#+end_src

Or you can run the tests using the =test= target instead, e.g.

#+begin_src shell
make test
#+end_src

Here’s how to run the tests against SBCL, CCL and ECL for example.

#+begin_src shell
for lisp in sbcl ccl ecl; do
echo "Running tests using ${lisp} ..."
LISP=${lisp} make test > ${lisp}-tests.out
done
#+end_src

* Docker Images

You can build and run a Docker image of the CLI application by
executing the following commands.

#+begin_src shell
docker build -t cl-wol.cli:latest -f Dockerfile .
#+end_src

A separate image can be built for running the test suite of =cl-wol=.

#+begin_src shell
docker build -t cl-wol.test:latest -f Dockerfile.tests .
docker run –rm cl-wol.test:latest
#+end_src

* Contributing

=cl-wol= is hosted on [[https://github.com/dnaeon/cl-wol][Github]]. Please contribute by reporting issues, suggesting features or by sending patches using pull requests.

* License

This project is Open Source and licensed under the [[http://opensource.org/licenses/BSD-2-Clause][BSD License]].

* Authors

- Marin Atanasov Nikolov <dnaeon@gmail.com>

Version

0.1.0

Dependencies
Source

cl-wol.cli.asd (file)

Components

Previous: , Up: Systems   [Contents][Index]

2.2 cl-wol.core

Long Name

cl-wol.core

Maintainer

Marin Atanasov Nikolov <dnaeon@gmail.com>

Author

Marin Atanasov Nikolov <dnaeon@gmail.com>

Home Page

https://github.com/dnaeon/cl-wol

Source Control

https://github.com/dnaeon/cl-wol

Bug Tracker

https://github.com/dnaeon/cl-wol

License

BSD 2-Clause

Description

Core Wake On Lan (WoL) Common Lisp System

Long Description

* cl-wol

=cl-wol= is a Common Lisp system and CLI application, which can power
on remote systems using [[https://en.wikipedia.org/wiki/Wake-on-LAN][Wake on LAN (WoL)]].

* Requirements

- [[https://www.quicklisp.org/beta/][Quicklisp]]

* Installation

=cl-wol= is not yet in Quicklisp, so in order to install it you will need to
clone the repo and add it to your [[https://www.quicklisp.org/beta/faq.html][Quicklisp local-projects]].

#+begin_src shell
cd ~/quicklisp/local-projects
git clone https://github.com/dnaeon/cl-wol.git
#+end_src

If you are installing the CLI application, you will also need a recent
version of [[https://github.com/dnaeon/clingon][clingon]], as the one found in Quicklisp is not yet updated to the latest release.

* Systems

=cl-wol= provides the following systems.

The =cl-wol.core= system provides the core functionallity for powering
on remote systems using [[https://en.wikipedia.org/wiki/Wake-on-LAN][Wake on LAN (WoL)]] by broadcasting a magic packet to a destination port and address.

The =cl-wol.test= system provides the test suite of =cl-wol.core=.

The =cl-wol.cli= system provides a command-line interface application,
built on top of =cl-wol.core=, which comes with support for looking up
hosts and their MAC addresses from a local SQLite database.

* Usage

The following formats of MAC addresses are supported by =cl-wol=.

- As a string in =AA:BB:CC:DD:EE:FF= format
- As a string in =AA-BB-CC-DD-EE-FF= format
- As a =(simple-array (unsigned-byte 8) (6))= vector

** API

The following section describes how to use the =cl-wol.core= system.

First, start your Lisp REPL and load the system.

#+begin_src lisp
CL-USER> (ql:quickload :cl-wol.core)
To load "cl-wol.core":
Load 1 ASDF system:
cl-wol.core
; Loading "cl-wol.core"

(:CL-WOL.CORE)
#+end_src

In order to wake a remote system identified by a given MAC address we
first need to create a new instance of =CL-WOL.CORE:MAGIC-PACKET=.

#+begin_src lisp
CL-USER> (defparameter *magic-packet*
(cl-wol.core:make-magic-packet "aa:bb:cc:dd:ee:ff"))
*MAGIC-PACKET*
#+end_src

The =CL-WOL.CORE:MAKE-MAGIC-PACKET= function accepts an optional
second argument, which represents a =SecureOn= password. The format of
the =SecureOn= password is the same as the one for MAC addresses. For
example, if you need to create a magic packet with =SecureOn= password
appended to the payload you can evaluate the following expression.

#+begin_src lisp
CL-USER> (defparameter *magic-packet*
(cl-wol.core:make-magic-packet "aa:bb:cc:dd:ee:ff" "00-00-00-00-00-00"))
*MAGIC-PACKET*
#+end_src

Another way to create a magic packet is by providing a =(simple-array
(unsigned-byte 8) (6)= vector to =CL-WOL.CORE:MAKE-MAGIC-PACKET=. You
can also use the =CL-WOL.CORE:MAKE-OCTET-VECTOR= function to create a
new octet vector. For example.

#+begin_src lisp
CL-USER> (defparameter *magic-packet*
(cl-wol.core:make-magic-packet (cl-wol.core:make-octet-vector #(1 2 3 4 5 6)))) *MAGIC-PACKET*
#+end_src

Now that we have a magic packet we can broadcast it to a given port
and address. In order to do that we will use the =CL-WOL.CORE:WAKE=
generic function. The following example broadcasts the magic packet
to =255.255.255.255= on port =7=.

#+begin_src lisp
CL-USER> (cl-wol.core:wake *magic-packet* "255.255.255.255" 7)
T
#+end_src

** CLI

[[./images/wol-demo.gif]]

You can build the CLI application of =cl-wol= by executing the
following command.

#+begin_src shell
make cli
#+end_src

The default Lisp implementation is SBCL, so if you are using a
different implementation simply pass the =LISP= environment variable
before invoking the =cli= target. This command builds the CLI
application using Clozure Common Lisp for example.

#+begin_src shell
LISP=ccl make cli
#+end_src

Once the app is built you can find the executable in the =bin=
directory of the =cl-wol.cli= system, which you can later install
somewhere in your =PATH=, e.g.

#+begin_src shell
sudo install ./bin/wol /usr/local/bin
#+end_src

You can also generate Zsh completions for the CLI application by
executing the =wol zsh-completions= sub-command, e.g.

#+begin_src shell
wol zsh-completions > ~/.zsh-completions/_wol
#+end_src

You can wake up remote systems by using the =wol wake=
sub-command. Multiple MAC addresses can be specified on the
command-line as separate arguments, e.g.

#+begin_src shell
$ wol wake 00:01:02:03:04:05 aa:bb:cc:dd:ee:ff
Waking up 00:01:02:03:04:05 ...
Waking up aa:bb:cc:dd:ee:ff ...
#+end_src

Instead of remembering MAC addresses by heart the =cl-wol= CLI
application supports storing MAC addresses in a local SQLite database,
which can be looked up by the various sub-commands.

First, we need to initialize a new database file using the =wol
init-db= sub-command.

#+begin_src shell
$ wol init-db –database wol.db
<INFO> [14:25:36] cl-migratum.core core.lisp (apply-pending) -
Found 1 pending migration(s) to be applied
<INFO> [14:25:36] cl-migratum.core core.lisp (apply-and-register) -
Applying migration 20211222183337 - add_hosts_table
#+end_src

Once the database is initialized you can add hosts to it. For example:

#+begin_src shell
wol add-host –database wol.db –address aa:bb:cc:dd:ee:ff –name box-01
wol add-host –database wol.db –address 01:02:03:04:05:06 –name box-02
#+end_src

Listing the hosts from the database is done via the =wol list-hosts=
sub-command.

#+begin_src shell
$ wol list-hosts –database wol.db
+—-+——–+——————-+———————+
| ID | NAME | ADDR | CREATED AT | +—-+——–+——————-+———————+
| 1 | box-01 | aa:bb:cc:dd:ee:ff | 2021-12-26 14:27:19 |
| 2 | box-02 | 01:02:03:04:05:06 | 2021-12-26 14:27:30 | +—-+——–+——————-+———————+
#+end_src

You can now wake up hosts by referring to their names. In order to do
that use the =–database= and =–name= options of the =wol wake=
sub-command. The =–name= option can be repeated multiple times in
order to refer to different hosts, e.g.

#+begin_src shell
$ wol wake –database wol.db –name box-01 –name box-02
Waking up 01:02:03:04:05:06 ...
Waking up aa:bb:cc:dd:ee:ff ...
#+end_src

Deleting hosts from the database is done via the =wol delete-host=
sub-command, e.g.

#+begin_src shell
wol delete-host –database wol.db box-01 box-02
#+end_src

* Tests

Tests are provided as part of the =:cl-wol.test= system.

In order to run the tests you can evaluate the following expressions
from your Lisp REPL.

#+begin_src lisp
CL-USER> (ql:quickload :cl-wol.test)
CL-USER> (asdf:test-system :cl-wol.test)
#+end_src

Or you can run the tests using the =test= target instead, e.g.

#+begin_src shell
make test
#+end_src

Here’s how to run the tests against SBCL, CCL and ECL for example.

#+begin_src shell
for lisp in sbcl ccl ecl; do
echo "Running tests using ${lisp} ..."
LISP=${lisp} make test > ${lisp}-tests.out
done
#+end_src

* Docker Images

You can build and run a Docker image of the CLI application by
executing the following commands.

#+begin_src shell
docker build -t cl-wol.cli:latest -f Dockerfile .
#+end_src

A separate image can be built for running the test suite of =cl-wol=.

#+begin_src shell
docker build -t cl-wol.test:latest -f Dockerfile.tests .
docker run –rm cl-wol.test:latest
#+end_src

* Contributing

=cl-wol= is hosted on [[https://github.com/dnaeon/cl-wol][Github]]. Please contribute by reporting issues, suggesting features or by sending patches using pull requests.

* License

This project is Open Source and licensed under the [[http://opensource.org/licenses/BSD-2-Clause][BSD License]].

* Authors

- Marin Atanasov Nikolov <dnaeon@gmail.com>

Version

0.1.0

Dependencies
Source

cl-wol.core.asd (file)

Component

core (module)


Next: , Previous: , Up: Top   [Contents][Index]

3 Modules

Modules are listed depth-first from the system components tree.


Next: , Previous: , Up: Modules   [Contents][Index]

3.1 cl-wol.cli/migrations

Parent

cl-wol.cli (system)

Location

src/cli/migrations/

Components

Next: , Previous: , Up: Modules   [Contents][Index]

3.2 cl-wol.cli/cli

Dependency

migrations (module)

Parent

cl-wol.cli (system)

Location

src/cli/

Components

Previous: , Up: Modules   [Contents][Index]

3.3 cl-wol.core/core

Parent

cl-wol.core (system)

Location

src/core/

Component

core.lisp (file)


Next: , Previous: , Up: Top   [Contents][Index]

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Next: , Previous: , Up: Files   [Contents][Index]

4.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.1 cl-wol.cli.asd

Location

cl-wol.cli.asd

Systems

cl-wol.cli (system)

Packages

cl-wol-cli-system


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.2 cl-wol.core.asd

Location

cl-wol.core.asd

Systems

cl-wol.core (system)

Packages

cl-wol-core-system


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.3 cl-wol.cli/cli/package.lisp

Parent

cli (module)

Location

src/cli/package.lisp

Packages

cl-wol.cli


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.4 cl-wol.cli/cli/db-utils.lisp

Dependency

package.lisp (file)

Parent

cli (module)

Location

src/cli/db-utils.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.5 cl-wol.cli/cli/wake.lisp

Dependency

db-utils.lisp (file)

Parent

cli (module)

Location

src/cli/wake.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.6 cl-wol.cli/cli/zsh-completions.lisp

Dependency

wake.lisp (file)

Parent

cli (module)

Location

src/cli/zsh-completions.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.7 cl-wol.cli/cli/print-doc.lisp

Dependency

zsh-completions.lisp (file)

Parent

cli (module)

Location

src/cli/print-doc.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.8 cl-wol.cli/cli/init-db.lisp

Dependency

print-doc.lisp (file)

Parent

cli (module)

Location

src/cli/init-db.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.9 cl-wol.cli/cli/add-host.lisp

Dependency

init-db.lisp (file)

Parent

cli (module)

Location

src/cli/add-host.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.10 cl-wol.cli/cli/delete-host.lisp

Dependency

add-host.lisp (file)

Parent

cli (module)

Location

src/cli/delete-host.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.11 cl-wol.cli/cli/list-hosts.lisp

Dependency

delete-host.lisp (file)

Parent

cli (module)

Location

src/cli/list-hosts.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.12 cl-wol.cli/cli/main.lisp

Dependency

list-hosts.lisp (file)

Parent

cli (module)

Location

src/cli/main.lisp

Exported Definitions

main (function)

Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

4.1.13 cl-wol.core/core/core.lisp

Parent

core (module)

Location

src/core/core.lisp

Packages

cl-wol.core

Exported Definitions
Internal Definitions

simple-octet-vector (type)


Previous: , Up: Files   [Contents][Index]

4.2 Static


Next: , Previous: , Up: Static files   [Contents][Index]

4.2.1 cl-wol.cli/migrations/20211222183337-add_hosts_table.down.sql

Parent

migrations (module)

Location

src/cli/migrations/20211222183337-add_hosts_table.down.sql


Previous: , Up: Static files   [Contents][Index]

4.2.2 cl-wol.cli/migrations/20211222183337-add_hosts_table.up.sql

Parent

migrations (module)

Location

src/cli/migrations/20211222183337-add_hosts_table.up.sql


Next: , Previous: , Up: Top   [Contents][Index]

5 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

5.1 cl-wol-cli-system

Source

cl-wol.cli.asd

Use List

Next: , Previous: , Up: Packages   [Contents][Index]

5.2 cl-wol.cli

Source

package.lisp (file)

Nickname

wol.cli

Use List

common-lisp

Exported Definitions

main (function)

Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

5.3 cl-wol-core-system

Source

cl-wol.core.asd

Use List

Previous: , Up: Packages   [Contents][Index]

5.4 cl-wol.core

Source

core.lisp (file)

Nickname

wol.core

Use List

common-lisp

Exported Definitions
Internal Definitions

simple-octet-vector (type)


Next: , Previous: , Up: Top   [Contents][Index]

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

6.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.1 Special variables

Special Variable: *mac-regex*

Regex used to parse MAC addresses

Package

cl-wol.core

Source

core.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.2 Functions

Function: main ()

Main CLI entrypoint

Package

cl-wol.cli

Source

main.lisp (file)

Function: make-octet-vector CONTENTS

Make an octet vector from the given contents

Package

cl-wol.core

Source

core.lisp (file)

Function: parse-hex-bytes STR

Parses a string representation of a MAC address or SecureOn password into a list of bytes

Package

cl-wol.core

Source

core.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.3 Generic functions

Generic Function: encode-payload OBJECT

Encodes the OBJECT and returns a vector of bytes representing the payload for waking up a remote system

Package

cl-wol.core

Source

core.lisp (file)

Methods
Method: encode-payload (OBJECT magic-packet)
Generic Function: mac-address OBJECT

Returns the string representation of the MAC address associated with the OBJECT

Package

cl-wol.core

Source

core.lisp (file)

Methods
Method: mac-address (OBJECT magic-packet)
Method: mac-address (CONDITION invalid-mac-address)
Generic Function: mac-octets OBJECT

Returns a vector of bytes representing the MAC address associated with the OBJECT

Package

cl-wol.core

Source

core.lisp (file)

Methods
Method: mac-octets (MAGIC-PACKET magic-packet)

Destination MAC address

Generic Function: make-magic-packet ADDRESS &optional PASSWORD

Creates a new magic packet destined to the given ADDRESS. If PASSWORD is specified it represents a SecureOn password

Package

cl-wol.core

Source

core.lisp (file)

Methods
Method: make-magic-packet ADDRESS &optional PASSWORD
Method: make-magic-packet (ADDRESS string) &optional PASSWORD
Generic Function: payload CONDITION
Package

cl-wol.core

Methods
Method: payload (CONDITION invalid-payload)
Source

core.lisp (file)

Generic Function: secureon-password OBJECT

Returns the SecureOn password associated with the OBJECT as a vector of octets

Package

cl-wol.core

Source

core.lisp (file)

Methods
Method: secureon-password (MAGIC-PACKET magic-packet)

Optional SecureOn password

Method: secureon-password (CONDITION invalid-password)
Generic Function: wake OBJECT ADDRESS PORT

Wakes up a remote system by encoding the OBJECT and sending a broadcast packet to the given ADDRESS and PORT

Package

cl-wol.core

Source

core.lisp (file)

Methods
Method: wake (OBJECT magic-packet) ADDRESS PORT

Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.4 Conditions

Condition: invalid-mac-address ()

A condition which is signalled upon an invalid MAC address

Package

cl-wol.core

Source

core.lisp (file)

Direct superclasses

simple-error (condition)

Direct methods

mac-address (method)

Direct slots
Slot: address
Initargs

:address

Initform

(quote (error "must specify mac address"))

Readers

mac-address (generic function)

Condition: invalid-password ()

A condition which is signalled upon invalid SecureOn password

Package

cl-wol.core

Source

core.lisp (file)

Direct superclasses

simple-error (condition)

Direct methods

secureon-password (method)

Direct slots
Slot: password
Initargs

:password

Initform

(quote (error "must specify password"))

Readers

secureon-password (generic function)

Condition: invalid-payload ()

A condition which is signalled when invalid payload is generated

Package

cl-wol.core

Source

core.lisp (file)

Direct superclasses

simple-error (condition)

Direct methods

payload (method)

Direct slots
Slot: payload
Initargs

:payload

Initform

(quote (error "must specify payload"))

Readers

payload (generic function)


Previous: , Up: Exported definitions   [Contents][Index]

6.1.5 Classes

Class: magic-packet ()

A class which represents the Magic Packet used to wake remote systems

Package

cl-wol.core

Source

core.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: address

Destination MAC address

Initargs

:address

Initform

(error "must specify mac address")

Readers

mac-octets (generic function)

Slot: password

Optional SecureOn password

Initargs

:password

Readers

secureon-password (generic function)


Previous: , Up: Definitions   [Contents][Index]

6.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.1 Functions

Function: add-host/command ()

Returns the command for adding hosts to the database file

Package

cl-wol.cli

Source

add-host.lisp (file)

Function: add-host/handler CMD

Handler for the ‘add-host’ command

Package

cl-wol.cli

Source

add-host.lisp (file)

Function: add-host/options ()

Returns the options of the ‘add-host’ command

Package

cl-wol.cli

Source

add-host.lisp (file)

Function: db-execute DB-CONN STMT &rest PARAMS

Execute a given statement against the database

Package

cl-wol.cli

Source

db-utils.lisp (file)

Function: db-migrations-path ()

Returns the path to the migration files

Package

cl-wol.cli

Source

db-utils.lisp (file)

Function: delete-host/command ()

Returns the command for deleting hosts from the database file

Package

cl-wol.cli

Source

delete-host.lisp (file)

Function: delete-host/handler CMD

Handler for the ‘delete-host’ command

Package

cl-wol.cli

Source

delete-host.lisp (file)

Function: delete-host/options ()

Returns the options of the ‘delete-host’ command

Package

cl-wol.cli

Source

delete-host.lisp (file)

Function: disconnect-db-conn DB-CONN

Disconnects from the database

Package

cl-wol.cli

Source

db-utils.lisp (file)

Function: get-host-from-db DB-CONN NAME

Fetches the host with the given NAME from the database

Package

cl-wol.cli

Source

db-utils.lisp (file)

Function: get-hosts-to-wake CMD

Returns the list of MAC addresses to wake up based on the provided options and arguments from the command-line

Package

cl-wol.cli

Source

wake.lisp (file)

Function: init-db/command ()

Returns the command for initializing the database

Package

cl-wol.cli

Source

init-db.lisp (file)

Function: init-db/handler CMD

Handler for the ‘init-db’ command

Package

cl-wol.cli

Source

init-db.lisp (file)

Function: init-db/options ()

Returns the options of the ‘init-db’ command

Package

cl-wol.cli

Source

init-db.lisp (file)

Function: list-hosts/command ()

Returns the command for listing hosts from the database file

Package

cl-wol.cli

Source

list-hosts.lisp (file)

Function: list-hosts/handler CMD

Handler for the ‘list-hosts’ command

Package

cl-wol.cli

Source

list-hosts.lisp (file)

Function: list-hosts/options ()

Returns the options of the ‘list-hosts’ command

Package

cl-wol.cli

Source

list-hosts.lisp (file)

Function: make-db-conn DB-PATH

Creates a new database connection to the given DB-PATH

Package

cl-wol.cli

Source

db-utils.lisp (file)

Function: migrate-db DB-CONN

Migrates the database to the latest version

Package

cl-wol.cli

Source

db-utils.lisp (file)

Function: print-doc/command ()

Returns a command which will print the app’s documentation

Package

cl-wol.cli

Source

print-doc.lisp (file)

Function: print-doc/handler CMD
Package

cl-wol.cli

Source

print-doc.lisp (file)

Function: table-columns DB-CONN TABLE

Get the list of columns for a given table

Package

cl-wol.cli

Source

db-utils.lisp (file)

Function: table-info DB-CONN TABLE

Get details about a given table

Package

cl-wol.cli

Source

db-utils.lisp (file)

Function: top-level/command ()

Returns the top-level command

Package

cl-wol.cli

Source

main.lisp (file)

Function: top-level/handler CMD

The top-level handler

Package

cl-wol.cli

Source

main.lisp (file)

Function: top-level/sub-commands ()

Returns the list of top-level sub-commands

Package

cl-wol.cli

Source

main.lisp (file)

Function: wake/command ()

Returns the command for waking up remote systems

Package

cl-wol.cli

Source

wake.lisp (file)

Function: wake/handler CMD

The handler for the ‘wake’ command

Package

cl-wol.cli

Source

wake.lisp (file)

Function: wake/options ()

Returns the options for the ‘wake’ command

Package

cl-wol.cli

Source

wake.lisp (file)

Function: zsh-completions/command ()

Returns a command for generating Zsh completions script

Package

cl-wol.cli

Source

zsh-completions.lisp (file)

Function: zsh-completions/handler CMD
Package

cl-wol.cli

Source

zsh-completions.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

6.2.2 Types

Type: simple-octet-vector &optional LENGTH
Package

cl-wol.core

Source

core.lisp (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L   M   S  
Index Entry  Section

C
cl-wol.cli.asd: The cl-wol․cli․asd file
cl-wol.cli/cli: The cl-wol․cli/cli module
cl-wol.cli/cli/add-host.lisp: The cl-wol․cli/cli/add-host․lisp file
cl-wol.cli/cli/db-utils.lisp: The cl-wol․cli/cli/db-utils․lisp file
cl-wol.cli/cli/delete-host.lisp: The cl-wol․cli/cli/delete-host․lisp file
cl-wol.cli/cli/init-db.lisp: The cl-wol․cli/cli/init-db․lisp file
cl-wol.cli/cli/list-hosts.lisp: The cl-wol․cli/cli/list-hosts․lisp file
cl-wol.cli/cli/main.lisp: The cl-wol․cli/cli/main․lisp file
cl-wol.cli/cli/package.lisp: The cl-wol․cli/cli/package․lisp file
cl-wol.cli/cli/print-doc.lisp: The cl-wol․cli/cli/print-doc․lisp file
cl-wol.cli/cli/wake.lisp: The cl-wol․cli/cli/wake․lisp file
cl-wol.cli/cli/zsh-completions.lisp: The cl-wol․cli/cli/zsh-completions․lisp file
cl-wol.cli/migrations: The cl-wol․cli/migrations module
cl-wol.cli/migrations/20211222183337-add_hosts_table.down.sql: The cl-wol․cli/migrations/20211222183337-add_hosts_table․down․sql file
cl-wol.cli/migrations/20211222183337-add_hosts_table.up.sql: The cl-wol․cli/migrations/20211222183337-add_hosts_table․up․sql file
cl-wol.core.asd: The cl-wol․core․asd file
cl-wol.core/core: The cl-wol․core/core module
cl-wol.core/core/core.lisp: The cl-wol․core/core/core․lisp file

F
File, Lisp, cl-wol.cli.asd: The cl-wol․cli․asd file
File, Lisp, cl-wol.cli/cli/add-host.lisp: The cl-wol․cli/cli/add-host․lisp file
File, Lisp, cl-wol.cli/cli/db-utils.lisp: The cl-wol․cli/cli/db-utils․lisp file
File, Lisp, cl-wol.cli/cli/delete-host.lisp: The cl-wol․cli/cli/delete-host․lisp file
File, Lisp, cl-wol.cli/cli/init-db.lisp: The cl-wol․cli/cli/init-db․lisp file
File, Lisp, cl-wol.cli/cli/list-hosts.lisp: The cl-wol․cli/cli/list-hosts․lisp file
File, Lisp, cl-wol.cli/cli/main.lisp: The cl-wol․cli/cli/main․lisp file
File, Lisp, cl-wol.cli/cli/package.lisp: The cl-wol․cli/cli/package․lisp file
File, Lisp, cl-wol.cli/cli/print-doc.lisp: The cl-wol․cli/cli/print-doc․lisp file
File, Lisp, cl-wol.cli/cli/wake.lisp: The cl-wol․cli/cli/wake․lisp file
File, Lisp, cl-wol.cli/cli/zsh-completions.lisp: The cl-wol․cli/cli/zsh-completions․lisp file
File, Lisp, cl-wol.core.asd: The cl-wol․core․asd file
File, Lisp, cl-wol.core/core/core.lisp: The cl-wol․core/core/core․lisp file
File, static, cl-wol.cli/migrations/20211222183337-add_hosts_table.down.sql: The cl-wol․cli/migrations/20211222183337-add_hosts_table․down․sql file
File, static, cl-wol.cli/migrations/20211222183337-add_hosts_table.up.sql: The cl-wol․cli/migrations/20211222183337-add_hosts_table․up․sql file

L
Lisp File, cl-wol.cli.asd: The cl-wol․cli․asd file
Lisp File, cl-wol.cli/cli/add-host.lisp: The cl-wol․cli/cli/add-host․lisp file
Lisp File, cl-wol.cli/cli/db-utils.lisp: The cl-wol․cli/cli/db-utils․lisp file
Lisp File, cl-wol.cli/cli/delete-host.lisp: The cl-wol․cli/cli/delete-host․lisp file
Lisp File, cl-wol.cli/cli/init-db.lisp: The cl-wol․cli/cli/init-db․lisp file
Lisp File, cl-wol.cli/cli/list-hosts.lisp: The cl-wol․cli/cli/list-hosts․lisp file
Lisp File, cl-wol.cli/cli/main.lisp: The cl-wol․cli/cli/main․lisp file
Lisp File, cl-wol.cli/cli/package.lisp: The cl-wol․cli/cli/package․lisp file
Lisp File, cl-wol.cli/cli/print-doc.lisp: The cl-wol․cli/cli/print-doc․lisp file
Lisp File, cl-wol.cli/cli/wake.lisp: The cl-wol․cli/cli/wake․lisp file
Lisp File, cl-wol.cli/cli/zsh-completions.lisp: The cl-wol․cli/cli/zsh-completions․lisp file
Lisp File, cl-wol.core.asd: The cl-wol․core․asd file
Lisp File, cl-wol.core/core/core.lisp: The cl-wol․core/core/core․lisp file

M
Module, cl-wol.cli/cli: The cl-wol․cli/cli module
Module, cl-wol.cli/migrations: The cl-wol․cli/migrations module
Module, cl-wol.core/core: The cl-wol․core/core module

S
Static File, cl-wol.cli/migrations/20211222183337-add_hosts_table.down.sql: The cl-wol․cli/migrations/20211222183337-add_hosts_table․down․sql file
Static File, cl-wol.cli/migrations/20211222183337-add_hosts_table.up.sql: The cl-wol․cli/migrations/20211222183337-add_hosts_table․up․sql file

Jump to:   C   F   L   M   S  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   A   D   E   F   G   I   L   M   P   S   T   W   Z  
Index Entry  Section

A
add-host/command: Internal functions
add-host/handler: Internal functions
add-host/options: Internal functions

D
db-execute: Internal functions
db-migrations-path: Internal functions
delete-host/command: Internal functions
delete-host/handler: Internal functions
delete-host/options: Internal functions
disconnect-db-conn: Internal functions

E
encode-payload: Exported generic functions
encode-payload: Exported generic functions

F
Function, add-host/command: Internal functions
Function, add-host/handler: Internal functions
Function, add-host/options: Internal functions
Function, db-execute: Internal functions
Function, db-migrations-path: Internal functions
Function, delete-host/command: Internal functions
Function, delete-host/handler: Internal functions
Function, delete-host/options: Internal functions
Function, disconnect-db-conn: Internal functions
Function, get-host-from-db: Internal functions
Function, get-hosts-to-wake: Internal functions
Function, init-db/command: Internal functions
Function, init-db/handler: Internal functions
Function, init-db/options: Internal functions
Function, list-hosts/command: Internal functions
Function, list-hosts/handler: Internal functions
Function, list-hosts/options: Internal functions
Function, main: Exported functions
Function, make-db-conn: Internal functions
Function, make-octet-vector: Exported functions
Function, migrate-db: Internal functions
Function, parse-hex-bytes: Exported functions
Function, print-doc/command: Internal functions
Function, print-doc/handler: Internal functions
Function, table-columns: Internal functions
Function, table-info: Internal functions
Function, top-level/command: Internal functions
Function, top-level/handler: Internal functions
Function, top-level/sub-commands: Internal functions
Function, wake/command: Internal functions
Function, wake/handler: Internal functions
Function, wake/options: Internal functions
Function, zsh-completions/command: Internal functions
Function, zsh-completions/handler: Internal functions

G
Generic Function, encode-payload: Exported generic functions
Generic Function, mac-address: Exported generic functions
Generic Function, mac-octets: Exported generic functions
Generic Function, make-magic-packet: Exported generic functions
Generic Function, payload: Exported generic functions
Generic Function, secureon-password: Exported generic functions
Generic Function, wake: Exported generic functions
get-host-from-db: Internal functions
get-hosts-to-wake: Internal functions

I
init-db/command: Internal functions
init-db/handler: Internal functions
init-db/options: Internal functions

L
list-hosts/command: Internal functions
list-hosts/handler: Internal functions
list-hosts/options: Internal functions

M
mac-address: Exported generic functions
mac-address: Exported generic functions
mac-address: Exported generic functions
mac-octets: Exported generic functions
mac-octets: Exported generic functions
main: Exported functions
make-db-conn: Internal functions
make-magic-packet: Exported generic functions
make-magic-packet: Exported generic functions
make-magic-packet: Exported generic functions
make-octet-vector: Exported functions
Method, encode-payload: Exported generic functions
Method, mac-address: Exported generic functions
Method, mac-address: Exported generic functions
Method, mac-octets: Exported generic functions
Method, make-magic-packet: Exported generic functions
Method, make-magic-packet: Exported generic functions
Method, payload: Exported generic functions
Method, secureon-password: Exported generic functions
Method, secureon-password: Exported generic functions
Method, wake: Exported generic functions
migrate-db: Internal functions

P
parse-hex-bytes: Exported functions
payload: Exported generic functions
payload: Exported generic functions
print-doc/command: Internal functions
print-doc/handler: Internal functions

S
secureon-password: Exported generic functions
secureon-password: Exported generic functions
secureon-password: Exported generic functions

T
table-columns: Internal functions
table-info: Internal functions
top-level/command: Internal functions
top-level/handler: Internal functions
top-level/sub-commands: Internal functions

W
wake: Exported generic functions
wake: Exported generic functions
wake/command: Internal functions
wake/handler: Internal functions
wake/options: Internal functions

Z
zsh-completions/command: Internal functions
zsh-completions/handler: Internal functions

Jump to:   A   D   E   F   G   I   L   M   P   S   T   W   Z  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
A   P   S  
Index Entry  Section

*
*mac-regex*: Exported special variables

A
address: Exported conditions
address: Exported classes

P
password: Exported conditions
password: Exported classes
payload: Exported conditions

S
Slot, address: Exported conditions
Slot, address: Exported classes
Slot, password: Exported conditions
Slot, password: Exported classes
Slot, payload: Exported conditions
Special Variable, *mac-regex*: Exported special variables

Jump to:   *  
A   P   S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   I   M   P   S   T  
Index Entry  Section

C
cl-wol-cli-system: The cl-wol-cli-system package
cl-wol-core-system: The cl-wol-core-system package
cl-wol.cli: The cl-wol․cli system
cl-wol.cli: The cl-wol․cli package
cl-wol.core: The cl-wol․core system
cl-wol.core: The cl-wol․core package
Class, magic-packet: Exported classes
Condition, invalid-mac-address: Exported conditions
Condition, invalid-password: Exported conditions
Condition, invalid-payload: Exported conditions

I
invalid-mac-address: Exported conditions
invalid-password: Exported conditions
invalid-payload: Exported conditions

M
magic-packet: Exported classes

P
Package, cl-wol-cli-system: The cl-wol-cli-system package
Package, cl-wol-core-system: The cl-wol-core-system package
Package, cl-wol.cli: The cl-wol․cli package
Package, cl-wol.core: The cl-wol․core package

S
simple-octet-vector: Internal types
System, cl-wol.cli: The cl-wol․cli system
System, cl-wol.core: The cl-wol․core system

T
Type, simple-octet-vector: Internal types

Jump to:   C   I   M   P   S   T