Module Name: src
Committed By: uwe
Date: Fri Aug 21 03:13:30 UTC 2020
Modified Files:
src/usr.sbin/wgconfig: wgconfig.8
Log Message:
Markup fixes.
To generate a diff of this commit:
cvs rdiff -u -r1.7 -r1.8 src/usr.sbin/wgconfig/wgconfig.8
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/usr.sbin/wgconfig/wgconfig.8
diff -u src/usr.sbin/wgconfig/wgconfig.8:1.7 src/usr.sbin/wgconfig/wgconfig.8:1.8
--- src/usr.sbin/wgconfig/wgconfig.8:1.7 Fri Aug 21 02:45:33 2020
+++ src/usr.sbin/wgconfig/wgconfig.8 Fri Aug 21 03:13:30 2020
@@ -1,4 +1,4 @@
-.\" $NetBSD: wgconfig.8,v 1.7 2020/08/21 02:45:33 uwe Exp $
+.\" $NetBSD: wgconfig.8,v 1.8 2020/08/21 03:13:30 uwe Exp $
.\"
.\" Copyright (C) Ryota Ozaki <[email protected]>
.\" All rights reserved.
@@ -37,30 +37,39 @@
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.Sh SYNOPSIS
.Nm
-.Ar wgN
+.Li wg Ns Ar N\|
.Op Cm "show all"
.\"
.Nm
-.Ar wgN Cm "show peer" Ar name
+.Li wg Ns Ar N\|
+.Cm "show peer" Ar name
.Op Fl Fl show-preshared-key
.\"
.Nm
-.Ar wgN Cm "show private-key"
+.Li wg Ns Ar N\|
+.Cm "show private-key"
.\"
.Nm
-.Ar wgN Cm "set private-key" Ar "filename"
+.Li wg Ns Ar N\|
+.Cm "set private-key" Ar "filename"
.\"
.Nm
-.Ar wgN Cm "set listen-port" Ar port
+.Li wg Ns Ar N\|
+.Cm "set listen-port" Ar port
.\"
.Nm
-.Ar wgN Cm "add peer" Ar name Ar pubkey
+.Li wg Ns Ar N\|
+.Cm "add peer" Ar name Ar pubkey
.Op Fl Fl preshared-key Ns = Ns Ar filename
-.Op Fl Fl endpoint Ns = Ns Ar ip : Ns Ar port
-.Op Fl Fl allowed-ips Ns = Ns Ar ip1 Ns / Ns Ar cidr1 Ns Op , Ns Ar ip2 Ns / Ns Ar cidr2 Ns ,...
+.Op Fl Fl endpoint Ns = Ns Ar ip Ns Li \&: Ns Ar port
+.Oo
+.Fl Fl allowed-ips Ns Li \&= Ns Ar ip1 Ns Li \&/ Ns Ar cidr1 Ns
+.Op Li \&, Ns Ar ip2 Ns Li \&/ Ns Ar cidr2 Ns Li \&, Ns Ar ...
+.Oc
.\"
.Nm
-.Ar wgN Cm "delete peer" Ar name
+.Li wg Ns Ar N\|
+.Cm "delete peer" Ar name
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.Sh DESCRIPTION
The
@@ -94,39 +103,45 @@ also display the secret preshared key th
have with the
.Fl Fl preshared-key
option to
-.Nm Ar wgN Cm "add peer" .
+.Nm
+.Li wg Ns Ar N Cm "add peer" .
.It Cm "show private-key"
Show the private key that was set with
-.Nm Ar wgN Cm "set private-key" .
+.Nm
+.Li wg Ns Ar N Cm "set private-key" .
.It Cm "set private-key" Ar filename
Set the private key of
-.Ar wgN
+.Li wg Ns Ar N\|
to the base64-encoded private key in the file at
.Ar filename .
.It Cm "set listen-port" Ar port
Set the UDP port number that
-.Ar wgN
+.Li wg Ns Ar N\|
listens for incoming WireGuard sessions on.
This allows a peer to start a new session without having a specific
endpoint IP address configured.
-.It Cm "add peer" Ar name Ar pubkey Op Ar options...
+.It Cm "add peer" Ar name Ar pubkey Op Ar options ...
Add a peer.
The argument
.Ar name
may be passed to
-.Nm Ar wgN Cm "show peer"
+.Nm
+.Li wg Ns Ar N Cm "show peer"
and
-.Nm Ar wgN Cm "delete peer" .
+.Nm
+.Li wg Ns Ar N Cm "delete peer" .
The argument
.Ar pubkey
is the peer's base64-encoded public key, as printed by
-.Nm wg-keygen Fl Fl pub .
+.Nm wg-keygen
+.Fl Fl pub .
.Pp
The following options may be specified:
.Bl -tag -width abcd
.It Fl Fl preshared-key-file Ns = Ns Ar filename
Set a secret preshared key generated by
-.Nm wg-keygen Fl Fl psk .
+.Nm wg-keygen
+.Fl Fl psk .
.Pp
If the preshared key can be arranged in advance on a medium not subject
to eavesdropping, then it defends against possible future quantum
@@ -135,11 +150,12 @@ WireGuard still uses X25519 key agreemen
session keys so that past session transcripts remain secret should one
of the endpoints be compromised in the future; the preshared key is an
additional measure on top.
-.It Fl Fl endpoint Ns = Ns Ar ip : Ns Ar port
+.It Fl Fl endpoint Ns Li \&= Ns Ar ip Ns Li \&: Ns Ar port
Set the peer's endpoint address outside the tunnel.
This is optional for a VPN server if the WireGuard interface is
configured to listen on a port number.
-.It Fl Fl allowed-ips Ns = Ns Ar ip1 Ns / Ns Ar cidr1 Ns Op , Ns Ar ip2 Ns / Ns Ar cidr2 Ns ,...
+.It Fl Fl allowed-ips Ns Li \&= Ns Ar ip1 Ns Li \&/ Ns Ar cidr1 Ns \
+ Op Li \&, Ns Ar ip2 Ns Li \&/ Ns Ar cidr2 Ns Li \&, Ns Ar ...
Set the IP address ranges that the peer is allowed to select inside the
tunnel.
.El
@@ -147,7 +163,8 @@ tunnel.
Delete the peer
.Ar name
previously added with
-.Nm Ar wgN Cm "add peer" Ar name .
+.Nm
+.Li wg Ns Ar N Cm "add peer" Ar name .
.El
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.Sh EXAMPLES
