[src/trunk]: src/usr.sbin/wg-userspace Fix up wg-userspace(8) man page.

[riastradh <riastradh%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/3ef0e26f5774
branches:  trunk
changeset: 975060:3ef0e26f5774
user:      riastradh <riastradh%NetBSD.org@localhost>
date:      Thu Aug 20 22:17:16 2020 +0000

description:
Fix up wg-userspace(8) man page.

diffstat:

 usr.sbin/wg-userspace/wg-userspace.8 |  49 +++++++++++++++++++++++++++++++++--
 1 files changed, 45 insertions(+), 4 deletions(-)

diffs (82 lines):

diff -r d6c4c8b9ff56 -r 3ef0e26f5774 usr.sbin/wg-userspace/wg-userspace.8
--- a/usr.sbin/wg-userspace/wg-userspace.8      Thu Aug 20 21:59:54 2020 +0000
+++ b/usr.sbin/wg-userspace/wg-userspace.8      Thu Aug 20 22:17:16 2020 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: wg-userspace.8,v 1.1 2020/08/20 21:28:02 riastradh Exp $
+.\"    $NetBSD: wg-userspace.8,v 1.2 2020/08/20 22:17:16 riastradh Exp $
 .\"
 .\" Copyright (C) Ryota Ozaki <ozaki.ryota%gmail.com@localhost>
 .\" All rights reserved.
@@ -27,28 +27,69 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd February 27, 2019
+.Dd August 20, 2020
 .Dt WG-USERSPACE 8
 .Os
+.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
 .Sh NAME
 .Nm wg-userspace
 .Nd manipulate WireGuard userspace instances
+.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
 .Sh SYNOPSIS
-.Nm
 .Ar id
+.Ar command
 .Op Ar arguments
+.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
 .Sh DESCRIPTION
 .Nm
 is used to create, destroy and configure WireGuard userspace instances.
+.Pp
+The following commands are supported:
+.Bl -tag -width "destroy"
+.It Cm create
+Create a WireGuard interface.
+The interface will appear as
+.Li tun Ns Ar id
+to the rest of the system, and will be served by a rump server in whose
+context the interface appears as
+.Li wg Ns Ar id .
+.It Cm destroy
+Destroy a WireGuard interface and stop the rump server behind it.
+.It Cm ifconfig Ar wgN Ar args...
+Run
+.Xr ifconfig 8
+in the context of the WireGuard interface's rump server.
+For example,
+.Bd -literal -compact
+       # wg-userspace 0 ifconfig wg0 10.0.1.0/24
+.Ed
+will set the WireGuard interface's IP address.
+.It Cm wgconfig Ar wgN Ar args...
+Run
+.Xr wgconfig 8
+in the context of the WireGuard interface's rump server.
+For example,
+.Bd -literal -compact
+       # wg-userspace 0 wgconfig wg0 set listen-port 1234
+.Ed
+will set the WireGuard interface's listening port.
+.It Cm debug Ar command Op Ar args...
+Run an arbitrary command in the context of the WireGuard interface's
+rump server, using
+.Xr rumphijack 3 .
+.El
+.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
 .Sh SEE ALSO
 .Xr wg 4 ,
 .Xr wg-keygen 8 ,
 .Xr wgconfig 8
+.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
 .Sh HISTORY
 The
 .Nm
 command first appeared in
-.Nx 9.0 .
+.Nx 10.0 .
+.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
 .Sh AUTHORS
 The
 .Nm