Skip to content

Commit c94508e

Browse files
committed
docs: note optional deps for JSON list generation
when building polkit rules. [skip ci]
1 parent bb29649 commit c94508e

File tree

1 file changed

+23
-4
lines changed

1 file changed

+23
-4
lines changed

README.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,16 +39,35 @@ This script requires:
3939

4040
Optional dependencies:
4141

42-
- [`python`](https://python.org) or
43-
[`sipcalc`](https://github.com/sii/sipcalc). If available, these will be
44-
used for IP address parsing and validation;[^iphandling] otherwise
45-
`update-systemd-resolved` will use native Bash routines for this.
42+
### IP Parsing and Validation
43+
44+
- [`python`](https://python.org).
45+
**or**
46+
- [`sipcalc`](https://github.com/sii/sipcalc).
47+
48+
If available, these will be used for IP address parsing and
49+
validation;[^iphandling] otherwise `update-systemd-resolved` will use native
50+
Bash routines for this.
4651

4752
[^iphandling]: Required for translating numerical labels like `1.2.3.4` to the
4853
byte arrays recognized by [the `SetLinkDNS()` function on
4954
`systemd-resolved`'s `org.freedesktop.resolve1.Manager` D-Bus
5055
interface](https://www.freedesktop.org/software/systemd/man/org.freedesktop.resolve1.html)).
5156

57+
### Polkit Rules Generation
58+
59+
- [`jq`](https://jqlang.github.io/jq/).
60+
**or**
61+
- [`perl`](https://www.perl.org/), or
62+
**or**
63+
- [`python`](https://python.org).
64+
65+
If available, these will be used for serializing the [names of the users and
66+
groups allowed to call `systemd-resolved`'s DBus methods](#polkit-rules) to
67+
JSON lists for use within the [generated polkit
68+
rules](#generating-polkit-rules). Otherwise, `update-systemd-resolved` will
69+
fall back to native Bash routines for generating these lists.
70+
5271
## Installation
5372

5473
[aur]:https://aur.archlinux.org/packages/openvpn-update-systemd-resolved/

0 commit comments

Comments
 (0)