diff options
Diffstat (limited to 'docs/guide/libraries/network.md')
-rw-r--r-- | docs/guide/libraries/network.md | 94 |
1 files changed, 94 insertions, 0 deletions
diff --git a/docs/guide/libraries/network.md b/docs/guide/libraries/network.md new file mode 100644 index 0000000..afeb5d2 --- /dev/null +++ b/docs/guide/libraries/network.md @@ -0,0 +1,94 @@ +# Network + +Wrapper library over [networkmanager](https://networkmanager.dev/) to better integrate with Astal. + +## Installation + +1. install dependencies + +:::code-group + +```sh [<i class="devicon-archlinux-plain"></i> Arch] +sudo pacman -Syu meson vala libnm gobject-introspection +``` + +```sh [<i class="devicon-fedora-plain"></i> Fedora] +sudo dnf install meson gcc valac NetworkManager-libnm-devel gobject-introspection-devel +``` + +```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu] +sudo apt install meson valac libnm-dev gobject-introspection +``` + +::: + +2. clone repo + +```sh +git clone https://github.com/aylur/astal.git +cd astal/lib/network +``` + +3. install + +```sh +meson setup build +meson install -C build +``` + +:::tip +Most distros recommend manual installs in `/usr/local`, +which is what `meson` defaults to. If you want to install to `/usr` +instead which most package managers do, set the `prefix` option: + +```sh +meson setup --prefix /usr build +``` + +::: + +## Usage + +You can browse the [Network reference](https://aylur.github.io/libastal/network). + +### CLI + +There is no CLI for this library, use the one provided by networkmanager. + +```sh +nmcli --help +``` + +### Library + +:::code-group + +```js [<i class="devicon-javascript-plain"></i> JavaScript] +import Network from "gi://AstalNetwork" + +const network = Network.get_default() + +print(network.wifi.ssid) +``` + +```py [<i class="devicon-python-plain"></i> Python] +from gi.repository import AstalNetwork as Network + +network = Network.get_default() + +print(network.get_wifi().get_ssid()) +``` + +```lua [<i class="devicon-lua-plain"></i> Lua] +local Network = require("lgi").require("AstalNetwork") + +local network = Network.get_default() + +print(network.wifi.ssid) +``` + +```vala [<i class="devicon-vala-plain"></i> Vala] +// Not yet documented +``` + +::: |