Module Name: src
Committed By: riastradh
Date: Thu Aug 20 22:17:17 UTC 2020
Modified Files:
src/usr.sbin/wg-userspace: wg-userspace.8
Log Message:
Fix up wg-userspace(8) man page.
To generate a diff of this commit:
cvs rdiff -u -r1.1 -r1.2 src/usr.sbin/wg-userspace/wg-userspace.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/wg-userspace/wg-userspace.8
diff -u src/usr.sbin/wg-userspace/wg-userspace.8:1.1 src/usr.sbin/wg-userspace/wg-userspace.8:1.2
--- src/usr.sbin/wg-userspace/wg-userspace.8:1.1 Thu Aug 20 21:28:02 2020
+++ src/usr.sbin/wg-userspace/wg-userspace.8 Thu Aug 20 22:17:16 2020
@@ -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.ry...@gmail.com>
.\" 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
