From 326076c46cbdc7afc9bcc2df56aa0b95d174f927 Mon Sep 17 00:00:00 2001 From: flu0r1ne Date: Tue, 12 Sep 2023 15:58:43 -0500 Subject: Add version subcommand --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) (limited to 'README.md') 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`. -- cgit v1.2.3