Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kei-g/wol

Wake-On-LAN Client
https://github.com/kei-g/wol

c docker docker-image wake-on-lan

Last synced: about 7 hours ago
JSON representation

Wake-On-LAN Client

Awesome Lists containing this project

README

        

# wol [![githuhb][github-repo-image]][github-repo-url] [![license][license-image]][license-url] [![docker][docker-image]][docker-url]

`wol` - Wake-On-LAN Client

## CI Status

| Workflow Name | Status |
|-|-|
| **Build** | [![GitHub CI (Build)][github-build-image]][github-build-url] |
| **CodeQL** | [![GitHub CI (CodeQL)][github-codeql-image]][github-codeql-url] |
| **MinGW** | [![GitHub CI (MinGW)][github-mingw-image]][github-mingw-url] |

## How to use

```shell
docker run --rm snowstep/wol 00:00:5e:00:53:00
```

## How to build

### Install packages to build

To build with clang, on linux :penguin:,

```shell
apt-get install automake clang make
```

or, to build with gcc, on linux :penguin:,

```shell
apt-get install automake gcc make
```

### Pre-configure

```shell
aclocal
autoheader
automake -a -c
autoconf
```

### with default cc

```shell
./configure --disable-dependency-tracking && make
```

### with clang

```shell
./configure --disable-dependency-tracking CC=clang LD=clang && make
```

### without symbols for debug

```shell
./configure --disable-dependency-tracking CC=clang LD=clang LDFLAGS="-Wl,-s" && make
```

### with optimizations

```shell
./configure --disable-dependency-tracking CC=clang CFLAGS="-Oz -march=native" LD=clang LDFLAGS="-Wl,-s" && make
```

## How to install

```shell
make install
```

## Usage

```shell
wol 00:00:5e:00:53:00
```

or binding specific NIC,

```shell
wol --bind=203.0.113.193 00:00:5e:00:53:00
```

## License

The source codes and documentation in this project are released under the [BSD-3-Clause License](https://github.com/kei-g/wol/blob/main/COPYING).

## Contributions

Contributions are welcome! See [Contributor's Guide](https://github.com/kei-g/wol/blob/main/CONTRIBUTING.md).

## Code of Conduct

:clap: Be nice. See [our code of conduct](https://github.com/kei-g/wol/blob/main/CODE_OF_CONDUCT.md).

[docker-image]:https://img.shields.io/docker/v/snowstep/wol?logo=docker
[docker-url]:https://hub.docker.com/r/snowstep/wol
[github-build-image]:https://github.com/kei-g/wol/actions/workflows/build.yml/badge.svg
[github-build-url]:https://github.com/kei-g/wol/actions/workflows/build.yml
[github-codeql-image]:https://github.com/kei-g/wol/actions/workflows/codeql.yml/badge.svg
[github-codeql-url]:https://github.com/kei-g/wol/actions/workflows/codeql.yml
[github-mingw-image]:https://github.com/kei-g/wol/actions/workflows/mingw.yml/badge.svg
[github-mingw-url]:https://github.com/kei-g/wol/actions/workflows/mingw.yml
[github-repo-image]:https://img.shields.io/badge/github-kei--g%2Fwol-brightgreen?logo=github
[github-repo-url]:https://github.com/kei-g/wol
[license-image]:https://img.shields.io/github/license/kei-g/wol
[license-url]:https://opensource.org/licenses/BSD-3-Clause