Wrap 'wg' commands in <command>

This commit is contained in:
Graham Christensen 2019-04-23 22:42:37 -04:00
parent f57fc6c881
commit 06c83a14e1
No known key found for this signature in database
GPG key ID: ACA1C1D120C83D5C

View file

@ -26,7 +26,7 @@ let
type = with types; nullOr str;
default = null;
description = ''
Base64 private key generated by wg genkey.
Base64 private key generated by <command>wg genkey</command>.
Warning: Consider using privateKeyFile instead if you do not
want to store the key in the world-readable Nix store.
@ -37,8 +37,8 @@ let
default = false;
type = types.bool;
description = ''
Automatically generate a private key with `wg genkey`,
at the privateKeyFile location.
Automatically generate a private key with
<command>wg genkey</command>, at the privateKeyFile location.
'';
};
@ -47,7 +47,7 @@ let
type = with types; nullOr str;
default = null;
description = ''
Private key file as generated by wg genkey.
Private key file as generated by <command>wg genkey</command>.
'';
};
@ -133,8 +133,8 @@ let
example = "rVXs/Ni9tu3oDBLS4hOyAUAa1qTWVA3loR8eL20os3I=";
type = with types; nullOr str;
description = ''
Base64 preshared key generated by wg genpsk. Optional,
and may be omitted. This option adds an additional layer of
Base64 preshared key generated by <command>wg genpsk</command>.
Optional, and may be omitted. This option adds an additional layer of
symmetric-key cryptography to be mixed into the already existing
public-key cryptography, for post-quantum resistance.
@ -148,8 +148,8 @@ let
example = "/private/wireguard_psk";
type = with types; nullOr str;
description = ''
File pointing to preshared key as generated by wg pensk. Optional,
and may be omitted. This option adds an additional layer of
File pointing to preshared key as generated by <command>wg pensk</command>.
Optional, and may be omitted. This option adds an additional layer of
symmetric-key cryptography to be mixed into the already existing
public-key cryptography, for post-quantum resistance.
'';