vknet(1)/vknetd(8): improve markup, sync SYNOPSIS/usage() & update description
authorThomas Nikolajsen <thomas@dragonflybsd.org>
Mon, 29 Mar 2010 23:26:32 +0000 (01:26 +0200)
committerThomas Nikolajsen <thomas@dragonflybsd.org>
Mon, 29 Mar 2010 23:26:32 +0000 (01:26 +0200)
Default vknet socket path is /var/run/vknet;
it was updated from /dev/vknet after devfs(5) entered.

usr.bin/vknet/vknet.1
usr.bin/vknet/vknet.c
usr.sbin/vknetd/vknetd.8
usr.sbin/vknetd/vknetd.c

index 202df82..302c043 100644 (file)
 .Op Fl C
 .Op Fl b Ar local-bridge
 .Op Fl B Ar remote-bridge
-.Op Fl r Ar delay[:retries]
+.Op Fl r Ar delay Ns Op : Ns Ar retries
 .Ar local-spec
-.Ar [user@]host[:remote-spec]
+.Oo Ns Ar user Ns @ Oc Ns Ar host Ns Op : Ns Ar remote-spec
 .Nm
-.Op Fl S
+.Fl S
 .Op Fl b Ar local-bridge
-.Ar local
+.Ar local-spec
 .Sh DESCRIPTION
 The
 .Nm
 utility connects the local machine's network to the remote machine's
 network over a SSH connection.
 .Pp
-The local and remote specification
-typically supplies a path to a vknetd socket such as
-.Pa /dev/vknet ,
+The local and remote specification typically supplies a path to a
+.Nm vknetd
+socket such as
+.Pa /var/run/vknet ,
 but may also specify a
 .Xr tap 4
 interface or the
-.Ar auto
+.Cm auto
 keyword to automatically allocate a
 .Xr tap 4
 interface.
+.Ar remote-spec
+defaults to
+.Pa /var/run/vknet .
 .Pp
 If a TAP interface is used on any given side it can be bridged on that
 side.
@@ -76,7 +80,8 @@ If a unix domain socket path is specified
 .Nm
 connects to use via the SOCK_SEQPACKET socket type.
 .Xr vknetd 8
-sockets cannot be bridged (but you don't want to anyway because vknetd
+sockets cannot be bridged (but you don't want to anyway because
+.Nm vknetd
 is already typically connected to a potentially bridged TAP interface).
 .Pp
 The following options are available:
@@ -87,23 +92,23 @@ Request that
 compress the connection.
 .It Fl b Ar local-bridge
 Specify that the local specification, which must be a TAP interface or
-.Ar auto ,
+.Cm auto ,
 be bridged to the specified bridge.
 .It Fl B Ar remote-bridge
 Specify that the remote specification, which must be a TAP interface or
-.Ar auto ,
+.Cm auto ,
 be bridged to the specified bridge on the remote side.
-.It Fl r Ar delay[:retries]
+.It Fl r Ar delay Ns Op : Ns Ar retries
 If the link cannot be established or is lost, delay the specified number
-of seconds and retry.  If no retry limit is specified an infinite number
-of retries will be made.
+of seconds and retry.
+If no retry limit is specified an unlimited number of retries will be made.
 .It Fl S
 This option is used by the
 .Nm
 run on the remote side of the
 .Xr ssh 1
-link to use stdin and stdout as its
-remote specification.  This option is typically not specified manually.
+link to use stdin and stdout as its remote specification.
+This option is typically not specified manually.
 .El
 .Sh REQUIREMENTS
 You may have to load the
@@ -114,23 +119,26 @@ modules, or run
 .Xr vknetd 8
 to provide an interconnect to the local and remote machine's nework.
 .Sh FILES
-.Bl -tag -width /var/log/lastlog -compact
+.Bl -tag -width ".Pa /var/run/vknet" -compact
 .It Pa /dev/tap*
 TAP interface used to route packets from userland providers back into the
-real machine.  If not otherwise specified an unused TAP interface will be
-selected.
+real machine.
+If not otherwise specified an unused TAP interface will be selected.
 .Pp
-.It Pa /dev/vknet
+.It Pa /var/run/vknet
 Socket
 .Nm
 typically connects to, established by
 .Xr vknetd 8 .
 .El
 .Sh EXAMPLES
-.Li "vknet -r 5 /dev/vknet myhomesystem:/dev/vknet"
+.Dl "vknet -r 5 /var/run/vknet myhomesystem:/var/run/vknet"
 .Pp
-.Li "vknet -r 5 -b bridge0 -B bridge0 auto myhomesystem:auto"
+.Dl "vknet -r 5 -b bridge0 -B bridge0 auto myhomesystem:auto"
 .Sh SEE ALSO
+.Xr ssh 1 ,
+.Xr bridge 4 ,
+.Xr tap 4 ,
 .Xr vke 4 ,
 .Xr vkernel 7 ,
 .Xr vknetd 8
index 5ea9670..0f4b7a5 100644 (file)
@@ -34,8 +34,9 @@
  * $DragonFly: src/usr.bin/vknet/vknet.c,v 1.1 2008/05/27 23:26:38 dillon Exp $
  */
 /*
- * vknet [-r timeout[:retries]] [-C] [-b local_bridge] [-B remote_bridge] local remote
- * vknet -S [-b local_bridge] local    (server mode)
+ * vknet [-C] [-b local-bridge] [-B remote-bridge] [-r delay[:retries]]
+ *       local-spec [user@]remote[:remote-spec]
+ * vknet -S [-b local-bridge] local-spec       (server mode)
  *
  * Connect a SOCK_SEQPACKET socket or TUN device on the local host with
  * a SOCK_SEQPACKET socket or TUN device on the remote host through a SSH
@@ -256,7 +257,7 @@ vknet_stream(void *arg)
 }
 
 /*
- * vknet_connect() - Connect to local side, optinally find or bridge the tap
+ * vknet_connect() - Connect to local side, optionally find or bridge the tap
  *                  interface.
  */
 static void
@@ -460,7 +461,7 @@ vknet_execssh(int fdin, int fdout, int compressOpt,
        if ((remotePath = strchr(remoteHost, ':')) != NULL) {
                *remotePath++ = 0;
        } else {
-               remotePath = strdup("/dev/vknet");
+               remotePath = strdup("/var/run/vknet");
        }
        ac = 0;
        av[ac++] = "ssh";
@@ -491,8 +492,9 @@ void
 usage(void)
 {
        fprintf(stderr, 
-               "vknet [-C] [-b local_bridge] [-B remote_bridge] local remote\n"
-               "vknet -S [-b local_bridge] local\n"
+               "vknet [-C] [-b local-bridge] [-B remote-bridge] [-r delay[:retries]]\n"
+               "      local-spec [user@]remote[:remote-spec]\n"
+               "vknet -S [-b local-bridge] local-spec\n"
        );
        exit(1);
 }
index 2117b63..11323ea 100644 (file)
 .Op Fl b Ar bridgeN
 .Op Fl p Ar socket_path
 .Op Fl t Ar tapN
-.Op Ar address/cidrbits
+.Op Ar address Ns / Ns Ar cidrbits
 .Sh DESCRIPTION
 The
 .Nm
 utility creates a virtualized bridged network suitable for vkernel use.
-The utility was created to simplify vkernel oprations and to allow user-run
+The utility was created to simplify
+.Nm vkernel
+operations and to allow user-run
 vkernels to have access to a network.
 General use is to specify a large 10-dot network which multiple vkernels are
 then able to connect to, and backfeed the whole mess to a TAP interface.
 .Pp
-A vkernel would make use of the virtualized network by specifying
+A
+.Nm vkernel
+would make use of the virtualized network by specifying
 .Fl I Ar /var/run/vknet
 instead of a
 .Xr tap 4
@@ -65,9 +69,10 @@ Any number of vkernels may connect to the virtual network.
 .Nm
 Implements a simple bridge for all entities connected to it.
 A cache
-of MAC addresses is built up (just like an etherswitch does) and matching
-packets will be forwarded directly to the proper 'port' (connected clients
-or TAP interface).
+of MAC addresses is built up (just like an ethernet switch does) and matching
+packets will be forwarded directly to the proper
+.Sq port
+(connected clients or TAP interface).
 Unknown MACs will be broadcast.
 .Pp
 The following options are available:
@@ -87,7 +92,7 @@ This is typically used with the
 .Fl b
 option to directly bridge
 .Nm
-into the host rather then operating it as a separate subnet.
+into the host rather than operating it as a separate subnet.
 .It Fl b Ar bridgeN
 The
 .Xr tap 4
@@ -103,49 +108,57 @@ Specify a particular
 interface to use.
 If not specified,
 .Nm
-will search for an unused tap interface.
-.It Ar address/cidrbits
+will search for an unused TAP interface.
+.It Ar address Ns / Ns Ar cidrbits
 When operating in secure mode (which is the default), a CIDR block must be
 specified.
 It is optional in unsecure mode.
-The address is the address you wish to assign to the TAP
+The
+.Ar address
+is the address you wish to assign to the TAP
 interface and will sit on both the host and virtual networks if not bridged.
 The
 .Ar cidrbits
 is the number of bits representing the virtual subnet.
 For example,
-10.1.0.1/24 places the tap interface on 10.1.0.1 and gives you an 8 bit
+10.1.0.1/24 places the TAP interface on 10.1.0.1 and gives you an 8 bit
 subnet capable of handling 254 hosts.
 An address of 0.0.0.0 is allowed as a special case in secure mode so that
-bootp
-.Xr dhclient 8 )
+bootp (
+.Xr dhclient 8 )
 can get through.
 .El
 .Sh FILES
-.Bl -tag -width /var/log/lastlog -compact
+.Bl -tag -width ".Pa /var/run/vknet" -compact
 .It Pa /dev/tap*
 TAP interface used to route packets from userland providers back into the
 real machine.
-If not otherwise specified an unused tap interface will be selected.
+If not otherwise specified an unused TAP interface will be selected.
 .It Pa /var/run/vknet
 Default socket
 .Nm
 sits on waiting for connections.
 .El
 .Sh EXAMPLES
-.Li "vknetd 10.1.0.1/16"
+.Dl "vknetd 10.1.0.1/16"
 .Sh REQUIREMENTS
 .Nm
 requires that the
-.Ar if_tap
+.Nm if_tap
 and
-.Ar if_bridge
+.Nm if_bridge
 modules be loaded.
-In addition, a 'vknet' group must exist in /etc/groups.
+In addition, a
+.Dq vknet
+group must exist in
+.Pa /etc/groups .
 .Sh SEE ALSO
 .Xr vknet 1 ,
+.Xr bridge 4 ,
+.Xr tap 4 ,
 .Xr vke 4 ,
-.Xr vkernel 7
+.Xr vkernel 7 ,
+.Xr dhclient 8
 .Sh HISTORY
 The
 .Nm
index acac9e0..078f28f 100644 (file)
@@ -34,7 +34,7 @@
  * $DragonFly: src/usr.sbin/vknetd/vknetd.c,v 1.2 2008/06/02 20:03:22 dillon Exp $
  */
 /*
- * vknet [-p path] [-t tapdev] network/mask
+ * vknet [-cdU] [-b bridgeN] [-p socket_path] [-t tapN] [address/cidrbits]
  *
  * Create a named unix-domain socket which userland vkernels can open
  * to gain access to a local network.  All connections to the socket
@@ -473,8 +473,8 @@ static
 void
 usage(void)
 {
-       fprintf(stderr, "vknet [-p path] [-t tapdev] [-U] [network/bits]\n");
-       fprintf(stderr, "network must be specified in default secure mode\n");
+       fprintf(stderr, "usage: vknet [-cdU] [-b bridgeN] [-p socket_path] [-t tapN] [address/cidrbits]\n");
+       fprintf(stderr, "address/cidrbits must be specified in default secure mode.\n");
        exit(1);
 }