aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorflu0r1ne <flu0r1ne@flu0r1ne.net>2023-09-12 15:58:43 -0500
committerflu0r1ne <flu0r1ne@flu0r1ne.net>2023-09-12 15:58:43 -0500
commit326076c46cbdc7afc9bcc2df56aa0b95d174f927 (patch)
tree42966f0624675aa5abf8f29096787a3cc171ba60 /README.md
parentea718c0997cd2e61c2a7fb491d1e7479296e710f (diff)
downloadwg2nd-0.1.0.tar.xz
wg2nd-0.1.0.zip
Add version subcommandv0.1.0
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 6 insertions, 4 deletions
diff --git a/README.md b/README.md
index 6153e1d..f41a5d8 100644
--- a/README.md
+++ b/README.md
@@ -97,10 +97,12 @@ specific components of the configurations and outputs them to `stdout`. The `ins
installs the configuration with the appropriate permissions.
```plaintext
-Usage: ./wg2nd { install, generate } [ OPTIONS ] { -h, CONFIG_FILE }
+Usage: wg2nd { install, generate } [ OPTIONS ] { -h, CONFIG_FILE }
+Usage: wg2nd version
- CONFIG_FILE is the complete path to a WireGuard configuration file used by
- `wg-quick`. `wg2nd` converts the WireGuard configuration to networkd files.
+ CONFIG_FILE is the complete path to a WireGuard configuration file, used by
+ `wg-quick`. `wg2nd` will convert the WireGuard configuration to networkd
+ files.
The generated configurations are functionally equivalent to `wg-quick(8)`
with the following exceptions:
@@ -127,7 +129,7 @@ Usage: ./wg2nd { install, generate } [ OPTIONS ] { -h, CONFIG_FILE }
```
```plaintext
-Usage: ./wg2nd install [ -h ] [ -f FILE_NAME ] [ -o OUTPUT_PATH ] CONFIG_FILE
+Usage: wg2nd install [ -h ] [ -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`.