From 50df8f91a90d8c91676b81cc9668b58914f85b08 Mon Sep 17 00:00:00 2001
From: flu0r1ne <flu0r1ne@flu0r1ne.net>
Date: Mon, 20 Nov 2023 17:45:24 -0600
Subject: Allow configurable activation policy, allow -h before dropping caps

---
 README.md | 32 ++++++++++++++++++++------------
 1 file changed, 20 insertions(+), 12 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 9664eb4..36ad5e4 100644
--- a/README.md
+++ b/README.md
@@ -80,7 +80,8 @@ wg2nd generate -t nft /etc/wireguard/wg0.conf >> /etc/nftables.conf
 networkctl up wg0
 ```
 
-To enable automatic starting, ensure that the `ActivationPolicy` is removed from the generated `network` configuration.
+To enable automatic starting, use `wg2nd install -a up /etc/wireguard/wg0.conf`. This sets the
+default [activation policy](https://www.freedesktop.org/software/systemd/man/latest/systemd.network.html#ActivationPolicy=) to `up`.
 
 ### Batch Conversion
 
@@ -136,7 +137,7 @@ Usage: wg2nd version
 ```
 
 ```plaintext
-Usage: wg2nd install [ -h ] [ -f FILE_NAME ] [ -o OUTPUT_PATH ] CONFIG_FILE
+Usage: ./wg2nd install [ -h ] [ -a ACTIVATION_POLICY ] [ -f FILE_NAME ] [ -o OUTPUT_PATH ] CONFIG_FILE
 
   `wg2nd install` translates `wg-quick(8)` configuration into corresponding
   `networkd` configuration and installs the resulting files in `OUTPUT_PATH`.
@@ -152,6 +153,10 @@ Usage: wg2nd install [ -h ] [ -f FILE_NAME ] [ -o OUTPUT_PATH ] CONFIG_FILE
   `wg2nd generate -t nft CONFIG_FILE`.
 
 Options:
+  -a ACTIVATION_POLICY
+     manual Require manual activation (default)
+     up     Automatically set the link "up"
+
   -o OUTPUT_PATH  The installation path (default is /etc/systemd/network)
 
   -f FILE_NAME    The base name for the installed configuration files. The
@@ -166,18 +171,21 @@ Options:
 ```
 
 ```plaintext
-Usage: wg2nd generate [ -h ] [ -t { network, netdev, keyfile, nft } ] CONFIG_FILE
-
-`wg2nd generate` translates `wg-quick(8)` configuration into the equivalent
-`systemd-networkd` configuration. The results are printed to `stdout`. Users
-are responsible for installing these files correctly and restricting access privileges.
+Usage: ./wg2nd generate [ -h ] [ -a ACTIVATION_POLICY ] [ -k KEYPATH ] [ -t { network, netdev, keyfile, nft } ] CONFIG_FILE
 
 Options:
+  -a ACTIVATION_POLICY
+     manual Require manual activation (default)
+     up     Automatically set the link "up"
+
   -t FILE_TYPE
-     network    Generate a Network Configuration File (see systemd.network(8))
-     netdev     Generate a Virtual Device File (see systemd.netdev(8))
-     keyfile    Print the interface's private key
-     nft        Print the netfilter table `nft(8)` installed by `wg-quick(8)`
+     network  Generate a Network Configuration File (see systemd.network(8))
+     netdev   Generate a Virtual Device File (see systemd.netdev(8))
+     keyfile  Print the interface's private key
+     nft      Print the netfilter table `nft(8)` installed by `wg-quick(8)`
+
+  -k KEYPATH  Full path to the keyfile (a path relative to /etc/systemd/network is generated
+              if unspecified)
 
-  -h            Display this help
+  -h        Print this help
 ```
-- 
cgit v1.2.3