diff options
| author | Joel Dahl <joel@FreeBSD.org> | 2012-11-13 20:41:36 +0000 |
|---|---|---|
| committer | Joel Dahl <joel@FreeBSD.org> | 2012-11-13 20:41:36 +0000 |
| commit | c60bda17f2a9ed4a8c1ef6483ee7b8f207de7129 (patch) | |
| tree | c5b2cb36e2caf23c2f1c4a8c6cda36449a7c51f5 /share/man | |
| parent | 8f19da81d1d2e3c3514f05b615314915b9c4a16c (diff) | |
Updates for netgraph node manual pages.
Discussed with: glebius
Submitted by: Mamontov Roman <mr.xanto@gmail.com>
Notes
Notes:
svn path=/head/; revision=242997
Diffstat (limited to 'share/man')
51 files changed, 398 insertions, 401 deletions
diff --git a/share/man/man4/ng_UI.4 b/share/man/man4/ng_UI.4 index 2054d19ee1ad..30f7c4898ef1 100644 --- a/share/man/man4/ng_UI.4 +++ b/share/man/man4/ng_UI.4 @@ -65,12 +65,12 @@ will have a 0x03 byte prepended to them before being forwarded out on the hook. .Sh HOOKS This node type supports the following hooks: -.Bl -tag -width foobar -.It Dv downstream +.Bl -tag -width ".Va downstream" +.It Va downstream Downstream connection. Packets on this side of the node have a 0x03 as their first byte. -.It Dv upstream +.It Va upstream Upstream connection. Packets on this side of the node have the initial 0x03 byte stripped off. diff --git a/share/man/man4/ng_async.4 b/share/man/man4/ng_async.4 index 2349cb3c6fac..ffd9a385d461 100644 --- a/share/man/man4/ng_async.4 +++ b/share/man/man4/ng_async.4 @@ -35,7 +35,7 @@ .\" $FreeBSD$ .\" $Whistle: ng_async.8,v 1.6 1999/01/25 23:46:25 archie Exp $ .\" -.Dd January 19, 1999 +.Dd November 13, 2012 .Dt NG_ASYNC 4 .Os .Sh NAME @@ -88,13 +88,13 @@ Flag sharing between frames is disabled after one second of transmit idle time. .Sh HOOKS This node type supports the following hooks: -.Bl -tag -width foobar -.It Dv async +.Bl -tag -width ".Va async" +.It Va async Asynchronous connection. Typically this hook would be connected to a .Xr ng_tty 4 node, which handles transmission of serial data over a tty device. -.It Dv sync +.It Va sync Synchronous connection. This hook sends and receives synchronous frames. For PPP, these frames should contain address, control, and protocol fields, @@ -106,24 +106,17 @@ type node. .Sh CONTROL MESSAGES This node type supports the generic control messages, plus the following: .Bl -tag -width foo -.It Dv NGM_ASYNC_CMD_GET_STATS -This command returns a -.Dv "struct ng_async_stat" -containing node statistics for packet, octet, and error counts. -.It Dv NGM_ASYNC_CMD_CLR_STATS -Clears the node statistics. -.It Dv NGM_ASYNC_CMD_SET_CONFIG +.It Dv NGM_ASYNC_CMD_SET_CONFIG Pq Ic setconfig Sets the node configuration, which is described by a .Dv "struct ng_async_cfg" : .Bd -literal -offset 4n struct ng_async_cfg { - u_char enabled; /* Turn encoding on/off */ - uint16_t amru; /* Max receive async frame len */ - uint16_t smru; /* Max receive sync frame len */ - uint32_t accm; /* ACCM encoding */ + u_char enabled; /* Turn encoding on/off */ + uint16_t amru; /* Max receive async frame length */ + uint16_t smru; /* Max receive sync frame length */ + uint32_t accm; /* ACCM encoding */ }; .Ed -.Pp The .Dv enabled field enables or disables all encoding/decoding functions (default disabled). @@ -142,8 +135,15 @@ The .Dv accm field is the asynchronous character control map, which controls the escaping of characters 0x00 thorough 0x1f (default 0xffffffff). -.It Dv NGM_ASYNC_CMD_GET_CONFIG +.It Dv NGM_ASYNC_CMD_GET_CONFIG Pq Ic getconfig This command returns the current configuration structure. +.It Dv NGM_ASYNC_CMD_GET_STATS Pq Ic getstats +This command returns a +.Dv "struct ng_async_stat" +containing node statistics for packet, octet, and error counts. +.It Dv NGM_ASYNC_CMD_CLR_STATS Pq Ic clrstats +Clears the node statistics. +.Pp .El .Sh SHUTDOWN This node shuts down upon receipt of a diff --git a/share/man/man4/ng_atmllc.4 b/share/man/man4/ng_atmllc.4 index 81768b54da7c..50131a2c41d3 100644 --- a/share/man/man4/ng_atmllc.4 +++ b/share/man/man4/ng_atmllc.4 @@ -60,7 +60,7 @@ encapsulated into a PDU and transmitted via the hook. .Sh HOOKS This node type supports the following hooks: -.Bl -tag -width indent +.Bl -tag -width ".Va ether" .It Va atm ATM connection. Typically, this hook would be connected to a diff --git a/share/man/man4/ng_bluetooth.4 b/share/man/man4/ng_bluetooth.4 index 2214172b1ada..c956dd06a3e8 100644 --- a/share/man/man4/ng_bluetooth.4 +++ b/share/man/man4/ng_bluetooth.4 @@ -43,7 +43,7 @@ All Bluetooth variables can be examined and changed via .Ss Bluetooth Variables Below is the description of default variables. Each Bluetooth module might add its own variables to the tree. -.Bl -tag -width indent +.Bl -tag -width foo .It Va net.bluetooth.version A read-only integer variable that shows the current version of the Bluetooth stack. diff --git a/share/man/man4/ng_bpf.4 b/share/man/man4/ng_bpf.4 index 4f89729785c6..44a51e37f404 100644 --- a/share/man/man4/ng_bpf.4 +++ b/share/man/man4/ng_bpf.4 @@ -35,7 +35,7 @@ .\" $FreeBSD$ .\" $Whistle: ng_bpf.8,v 1.2 1999/12/03 01:57:12 archie Exp $ .\" -.Dd May 30, 2007 +.Dd November 13, 2012 .Dt NG_BPF 4 .Os .Sh NAME @@ -81,7 +81,7 @@ This node type supports any number of hooks having arbitrary names. .Sh CONTROL MESSAGES This node type supports the generic control messages, plus the following: .Bl -tag -width foo -.It Dv NGM_BPF_SET_PROGRAM +.It Dv NGM_BPF_SET_PROGRAM Pq Ic setprogram This command sets the filter program that will be applied to incoming data on a hook. The following structure must be supplied as an argument: @@ -90,7 +90,7 @@ struct ng_bpf_hookprog { char thisHook[NG_HOOKSIZ]; /* name of hook */ char ifMatch[NG_HOOKSIZ]; /* match dest hook */ char ifNotMatch[NG_HOOKSIZ]; /* !match dest hook */ - int32_t bpf_prog_len; /* #isns in program */ + int32_t bpf_prog_len; /* #insns in program */ struct bpf_insn bpf_prog[]; /* bpf program */ }; .Ed @@ -112,25 +112,25 @@ The program must be a valid program or else .Er EINVAL is returned. -.It Dv NGM_BPF_GET_PROGRAM +.It Dv NGM_BPF_GET_PROGRAM Pq Ic getprogram This command takes an .Tn ASCII string argument, the hook name, and returns the corresponding .Dv "struct ng_bpf_hookprog" as shown above. -.It Dv NGM_BPF_GET_STATS +.It Dv NGM_BPF_GET_STATS Pq Ic getstats This command takes an .Tn ASCII string argument, the hook name, and returns the statistics associated with the hook as a .Dv "struct ng_bpf_hookstat" . -.It Dv NGM_BPF_CLR_STATS +.It Dv NGM_BPF_CLR_STATS Pq Ic clrstats This command takes an .Tn ASCII string argument, the hook name, and clears the statistics associated with the hook. -.It Dv NGM_BPF_GETCLR_STATS +.It Dv NGM_BPF_GETCLR_STATS Pq Ic getclrstats This command is identical to .Dv NGM_BPF_GET_STATS , except that the statistics are also atomically cleared. diff --git a/share/man/man4/ng_bridge.4 b/share/man/man4/ng_bridge.4 index b00dc6088b8b..4899937a6342 100644 --- a/share/man/man4/ng_bridge.4 +++ b/share/man/man4/ng_bridge.4 @@ -98,7 +98,7 @@ node to the bridge node. This node type supports the generic control messages, plus the following: .Bl -tag -width foo -.It Dv NGM_BRIDGE_SET_CONFIG +.It Dv NGM_BRIDGE_SET_CONFIG Pq Ic setconfig Set the node configuration. This command takes a .Dv "struct ng_bridge_config" @@ -140,13 +140,13 @@ determines how quickly a host must jump from one link to another before we declare a loopback condition. The default is one second. .Pp -.It Dv NGM_BRIDGE_GET_CONFIG +.It Dv NGM_BRIDGE_GET_CONFIG Pq Ic getconfig Returns the current configuration as a .Dv "struct ng_bridge_config" . -.It Dv NGM_BRIDGE_RESET +.It Dv NGM_BRIDGE_RESET Pq Ic reset Causes the node to forget all hosts and unmute all links. The node configuration is not changed. -.It Dv NGM_BRIDGE_GET_STATS +.It Dv NGM_BRIDGE_GET_STATS Pq Ic getstats This command takes a four byte link number as an argument and returns a .Dv "struct ng_bridge_link_stats" @@ -171,17 +171,17 @@ struct ng_bridge_link_stats { uint64_t memoryFailures; /* times couldn't get mem or mbuf */ }; .Ed -.It Dv NGM_BRIDGE_CLR_STATS +.It Dv NGM_BRIDGE_CLR_STATS Pq Ic clrstats This command takes a four byte link number as an argument and clears the statistics for that link. -.It Dv NGM_BRIDGE_GETCLR_STATS +.It Dv NGM_BRIDGE_GETCLR_STATS Pq Ic getclrstats Same as .Dv NGM_BRIDGE_GET_STATS , but also atomically clears the statistics as well. -.It Dv NGM_BRIDGE_GET_TABLE +.It Dv NGM_BRIDGE_GET_TABLE Pq Ic gettable Returns the current host mapping table used to direct packets, in a .Dv "struct ng_bridge_host_ary" . -.It Dv NGM_BRIDGE_SET_PERSISTENT +.It Dv NGM_BRIDGE_SET_PERSISTENT Pq Ic setpersistent This command sets the persistent flag on the node, and takes no arguments. .El .Sh SHUTDOWN diff --git a/share/man/man4/ng_bt3c.4 b/share/man/man4/ng_bt3c.4 index 157a3788dbfc..b6c3ba7243a8 100644 --- a/share/man/man4/ng_bt3c.4 +++ b/share/man/man4/ng_bt3c.4 @@ -74,34 +74,34 @@ The driver provides support for the 3Com/HP 3CRWB6096-A PCCARD bluetooth adapter. .Sh HOOKS This node type supports the following hooks: -.Bl -tag -width indent -.It Dv hook +.Bl -tag -width ".Va hook" +.It Va hook single HCI frame contained in single .Vt mbuf structure. .El .Sh CONTROL MESSAGES This node type supports the generic control messages, plus the following: -.Bl -tag -width indent -.It Dv NGM_BT3C_NODE_GET_STATE +.Bl -tag -width foo +.It Dv NGM_BT3C_NODE_GET_STATE Pq Ic get_state Returns the current receiving state for the node. -.It Dv NGM_BT3C_NODE_GET_DEBUG -Returns an integer containing the current debug level for the node. -.It Dv NGM_BT3C_NODE_SET_DEBUG +.It Dv NGM_BT3C_NODE_SET_DEBUG Pq Ic set_debug This command takes an integer argument and sets the current debug level for the node. -.It Dv NGM_BT3C_NODE_GET_QLEN +.It Dv NGM_BT3C_NODE_GET_DEBUG Pq Ic get_debug +Returns an integer containing the current debug level for the node. +.It Dv NGM_BT3C_NODE_GET_QLEN Pq Ic get_qlen This command takes a parameter that specifies queue number and returns the current length of the queue for the node. -.It Dv NGM_BT3C_NODE_SET_QLEN +.It Dv NGM_BT3C_NODE_SET_QLEN Pq Ic set_qlen This command takes two parameters that specify the queue number and the maximum length of the queue and sets the maximum length of the queue for the node. -.It Dv NGM_BT3C_NODE_GET_STAT +.It Dv NGM_BT3C_NODE_GET_STAT Pq Ic get_stat Returns various statistic information for the node, such as: number of bytes (frames) sent, number of bytes (frames) received and number of input (output) errors. -.It Dv NGM_BT3C_NODE_RESET_STAT +.It Dv NGM_BT3C_NODE_RESET_STAT Pq Ic reset_stat Reset all statistic counters to zero. .It Dv NGM_BT3C_NODE_DOWNLOAD_FIRMWARE Download card firmware. diff --git a/share/man/man4/ng_btsocket.4 b/share/man/man4/ng_btsocket.4 index 22763f98626e..12f28448ef6e 100644 --- a/share/man/man4/ng_btsocket.4 +++ b/share/man/man4/ng_btsocket.4 @@ -25,7 +25,7 @@ .\" $Id: ng_btsocket.4,v 1.7 2003/05/21 19:37:35 max Exp $ .\" $FreeBSD$ .\" -.Dd July 8, 2002 +.Dd November 13, 2012 .Dt NG_BTSOCKET 4 .Os .Sh NAME @@ -65,14 +65,14 @@ The Bluetooth raw HCI socket address is defined as follows: struct sockaddr_hci { u_char hci_len; /* total length */ u_char hci_family; /* address family */ - char hci_node[16]; /* HCI node name */ + char hci_node[32]; /* address (size == NG_NODESIZ ) */ }; .Ed .Pp Raw HCI sockets support a number of .Xr ioctl 2 requests such as: -.Bl -tag -width indent +.Bl -tag -width foo .It Dv SIOC_HCI_RAW_NODE_GET_STATE Returns current state for the HCI node. .It Dv SIOC_HCI_RAW_NODE_INIT @@ -174,7 +174,7 @@ request. Raw L2CAP sockets support number of .Xr ioctl 2 requests such as: -.Bl -tag -width indent +.Bl -tag -width foo .It Dv SIOC_L2CAP_NODE_GET_FLAGS Returns current state for the L2CAP node. .It Dv SIOC_L2CAP_NODE_GET_DEBUG @@ -243,7 +243,7 @@ level which can be set with .Xr setsockopt 2 and tested with .Xr getsockopt 2 : -.Bl -tag -width indent +.Bl -tag -width foo .It Dv SO_L2CAP_IMTU Get (set) maximum payload size the local socket is capable of accepting. .It Dv SO_L2CAP_OMTU @@ -312,7 +312,7 @@ The following options, which can be tested with call, are defined at .Dv SOL_RFCOMM level for RFCOMM sockets: -.Bl -tag -width indent +.Bl -tag -width foo .It Dv SO_RFCOMM_MTU Returns the maximum transfer unit size (in bytes) for the underlying RFCOMM channel. diff --git a/share/man/man4/ng_car.4 b/share/man/man4/ng_car.4 index 79967e72dd5e..348b03d64d64 100644 --- a/share/man/man4/ng_car.4 +++ b/share/man/man4/ng_car.4 @@ -25,7 +25,7 @@ .\" .\" $FreeBSD$ .\" -.Dd March 11, 2007 +.Dd November 13, 2012 .Dt NG_CAR 4 .Os .Sh NAME @@ -50,7 +50,7 @@ Traffic shaping with RED. .El .Sh HOOKS This node type supports the following hooks: -.Bl -tag -width indent +.Bl -tag -width ".Va upper" .It Va upper Hook leading to upper layer protocols. .It Va lower @@ -73,7 +73,7 @@ is considered traffic. .Sh MODES OF OPERATION Each hook can operate in one of the following modes: -.Bl -tag -width indent +.Bl -tag -width foo .It Dv NG_CAR_SINGLE_RATE Single rate three color marker as described in RFC 2697. Committed burst packets are counted as green, extended burst packets are @@ -114,24 +114,24 @@ rates are measured in packets per second and bursts are in packets. .Sh CONTROL MESSAGES This node type supports the generic control messages and the following specific messages. -.Bl -tag -width indent -.It Dv NGM_CAR_SET_CONF Pq Li setconf +.Bl -tag -width foo +.It Dv NGM_CAR_SET_CONF Pq Ic setconf Set node configuration to the specified at .Vt "struct ng_car_bulkconf" -.It Dv NGM_CAR_GET_CONF Pq Li getconf +.It Dv NGM_CAR_GET_CONF Pq Ic getconf Return current node configuration as .Vt "struct ng_car_bulkconf" .Bd -literal struct ng_car_hookconf { - uint64_t cbs; /* Committed burst size */ - uint64_t ebs; /* Exceeded/Peak burst size */ - uint64_t cir; /* Committed information rate */ - uint64_t pir; /* Peak information rate */ + uint64_t cbs; /* Commited burst size (bytes) */ + uint64_t ebs; /* Exceeded/Peak burst size (bytes) */ + uint64_t cir; /* Commited information rate (bits/s) */ + uint64_t pir; /* Peak information rate (bits/s) */ uint8_t green_action; /* Action for green packets */ uint8_t yellow_action; /* Action for yellow packets */ uint8_t red_action; /* Action for red packets */ - uint8_t mode; /* operation mode */ - uint8_t opt; /* mode options */ + uint8_t mode; /* single/double rate, ... */ + uint8_t opt; /* color-aware or color-blind */ }; /* possible actions (..._action) */ @@ -156,17 +156,17 @@ struct ng_car_bulkconf { struct ng_car_hookconf downstream; }; .Ed -.It Dv NGM_CAR_GET_STATS Pq Li getstats +.It Dv NGM_CAR_GET_STATS Pq Ic getstats Return node statistics as .Vt "struct ng_car_bulkstats" .Bd -literal struct ng_car_hookstats { - uint64_t passed_pkts; - uint64_t droped_pkts; - uint64_t green_pkts; - uint64_t yellow_pkts; - uint64_t red_pkts; - uint64_t errors; + uint64_t passed_pkts; /* Counter for passed packets */ + uint64_t droped_pkts; /* Counter for droped packets */ + uint64_t green_pkts; /* Counter for green packets */ + uint64_t yellow_pkts; /* Counter for yellow packets */ + uint64_t red_pkts; /* Counter for red packets */ + uint64_t errors; /* Counter for operation errors */ }; struct ng_car_bulkstats { @@ -174,9 +174,9 @@ struct ng_car_bulkstats { struct ng_car_hookstats downstream; }; .Ed -.It Dv NGM_CAR_CLR_STATS Pq Li clrstats +.It Dv NGM_CAR_CLR_STATS Pq Ic clrstats Clear node statistics. -.It Dv NGM_CAR_GETCLR_STATS Pq Li getclrstats +.It Dv NGM_CAR_GETCLR_STATS Pq Ic getclrstats Atomically return and clear node statistics. .El .Sh SHUTDOWN diff --git a/share/man/man4/ng_ccatm.4 b/share/man/man4/ng_ccatm.4 index 1010c0fba5f3..f643d726d55e 100644 --- a/share/man/man4/ng_ccatm.4 +++ b/share/man/man4/ng_ccatm.4 @@ -146,7 +146,7 @@ enum atmop { .Pp These codes correspond directly to the operations specified in the ATM Forum document with the following exceptions: -.Bl -tag -width indent +.Bl -tag -width foo .It Dv ATMOP_RESP As discussed in .Xr ng_uni 4 , @@ -191,12 +191,12 @@ listening hooks or rejected. .Sh CONTROL MESSAGES Besides the generic messages the node understands the following special messages: -.Bl -tag -width indent -.It Dv NGM_CCATM_DUMP +.Bl -tag -width foo +.It Dv NGM_CCATM_DUMP Pq Ic dump This causes the internal state of the node to be dumped in ASCII to the .Va dump hook. -.It Dv NGM_CCATM_STOP +.It Dv NGM_CCATM_STOP Pq Ic stop This message causes all connections on that port to be aborted (not released!\&) and all ATM endpoints which are bound to that port to be closed. It stops processing of all messages from the UNI stack on that port UNI stack. @@ -207,17 +207,17 @@ struct ngm_ccatm_port { }; .Ed .Pp -.It Dv NGM_CCATM_START +.It Dv NGM_CCATM_START Pq Ic start Start processing on the port. The argument is a .Vt ngm_ccatm_port structure. -.It Dv NGM_CCATM_CLEAR +.It Dv NGM_CCATM_CLEAR Pq Ic clear This message takes a .Vt ngm_ccatm_port structure and clears all prefixes and addresses on that port. If the port number is zero, all ports are cleared. -.It Dv NGM_CCATM_GET_ADDRESSES +.It Dv NGM_CCATM_GET_ADDRESSES Pq Ic get_addresses Get the list of all registered addresses on the given port. The argument is a .Vt ngm_ccatm_port @@ -243,7 +243,7 @@ If it is not zero, only the addresses on that port are reported. The number of addresses is returned in the .Va count field. -.It Dv NGM_CCATM_ADDRESS_REGISTERED +.It Dv NGM_CCATM_ADDRESS_REGISTERED Pq Ic address_reg This message is used by ILMI to inform the .Nm node that a previous address registration request was successful. @@ -251,7 +251,7 @@ This causes the node to activate that address. The argument to the message is a .Vt ngm_ccatm_address_req structure. -.It Dv NGM_CCATM_ADDRESS_UNREGISTERED +.It Dv NGM_CCATM_ADDRESS_UNREGISTERED Pq Ic address_unreg This message is used by ILMI to inform the .Nm node that an address has been unregistered. @@ -259,7 +259,7 @@ The node clears that address from its tables. The argument is a .Vt ngm_ccatm_address_req structure. -.It Dv NGM_CCATM_SET_PORT_PARAM +.It Dv NGM_CCATM_SET_PORT_PARAM Pq Ic set_port_param This request sets the parameters on the given port. The argument is a .Bd -literal @@ -281,13 +281,13 @@ address and prefix tables of that port are empty. The .Va num_addr field is ignored. -.It Dv NGM_CCATM_GET_PORT_PARAM +.It Dv NGM_CCATM_GET_PORT_PARAM Pq Ic get_port_param Retrieve the parameters of the given port. The argument is a .Vt ngm_ccatm_port and the result a .Vt ngm_ccatm_atm_port . -.It Dv NGM_CCATM_GET_PORTLIST +.It Dv NGM_CCATM_GET_PORTLIST Pq Ic get_portlist Get a list of all available ports on that node. This is returned as a .Bd -literal @@ -296,20 +296,20 @@ struct ngm_ccatm_portlist { uint32_t ports[]; }; .Ed -.It Dv NGM_CCATM_GETSTATE +.It Dv NGM_CCATM_GETSTATE Pq Ic getstate Return the state of a port. The argument is a .Vt "struct ngm_ccatm_port" and the return values as a .Vt uint32_t . -.It Dv NGM_CCATM_SETLOG +.It Dv NGM_CCATM_SETLOG Pq Ic setlog This requests sets a new logging level and returns the previous one. The argument is either a .Vt uint32_t in which case it specifies the new logging level, or may be empty in which case just the old level is returned as a .Vt uint32_t . -.It Dv NGM_CCATM_RESET +.It Dv NGM_CCATM_RESET Pq Ic reset Reset the node. This is allowed only if the number of user hooks and connected UNI stacks is zero. diff --git a/share/man/man4/ng_cisco.4 b/share/man/man4/ng_cisco.4 index e4300a040b9c..143ecdb521bd 100644 --- a/share/man/man4/ng_cisco.4 +++ b/share/man/man4/ng_cisco.4 @@ -114,28 +114,28 @@ understands the message. .Sh HOOKS This node type supports the following hooks: -.Bl -tag -width foobarbazio -.It Dv downstream +.Bl -tag -width ".Va downstream" +.It Va downstream The connection to the synchronous line. -.It Dv inet +.It Va inet IP hook. -.It Dv inet6 +.It Va inet6 IPv6 hook. -.It Dv atalk +.It Va atalk AppleTalk hook. -.It Dv ipx -IPX hook +.It Va ipx +IPX hook. .El .Sh CONTROL MESSAGES This node type supports the generic control messages, plus the following: .Bl -tag -width foo -.It Dv NGM_CISCO_SET_IPADDR +.It Dv NGM_CISCO_SET_IPADDR Pq Ic setipaddr This command takes an array of two .Dv "struct in_addr" arguments. The first is the IP address of the corresponding interface and the second is the netmask. -.It Dv NGM_CISCO_GET_IPADDR +.It Dv NGM_CISCO_GET_IPADDR Pq Ic getipaddr This command returns the IP configuration in the same format used by .Dv NGM_CISCO_SET_IPADDR . This command is also @@ -143,13 +143,13 @@ This command is also by this node type to the .Dv inet peer whenever an IP address inquiry packet is received. -.It Dv NGM_CISCO_GET_STATUS +.It Dv NGM_CISCO_GET_STATUS Pq Ic getstats Returns a .Dv "struct ngciscostat" : .Bd -literal -offset 4n struct ngciscostat { - uint32_t seq_retries; /* # unack'd retries */ - uint32_t keepalive_period; /* in seconds */ + uint32_t seqRetries; /* # unack'd retries */ + uint32_t keepAlivePeriod; /* in seconds */ }; .Ed .El diff --git a/share/man/man4/ng_deflate.4 b/share/man/man4/ng_deflate.4 index 11dc132074c6..dbf3c562f18a 100644 --- a/share/man/man4/ng_deflate.4 +++ b/share/man/man4/ng_deflate.4 @@ -61,7 +61,7 @@ mode to permit sending uncompressed frames. .Sh HOOKS This node type supports the following hooks: .Pp -.Bl -tag -compact -width decomp +.Bl -tag -compact -width ".Va decomp" .It Va comp Connection to .Xr ng_ppp 4 @@ -82,7 +82,7 @@ operation mode. .Sh CONTROL MESSAGES This node type supports the generic control messages, plus the following: .Bl -tag -width foo -.It Dv NGM_DEFLATE_CONFIG Pq Li config +.It Dv NGM_DEFLATE_CONFIG Pq Ic config This command resets and configures the node for a session (i.e., for compression or decompression). This command takes a @@ -101,7 +101,7 @@ The .Fa windowBits specify compression windows size as negotiated by the Compression Control Protocol (CCP) in PPP. -.It Dv NGM_DEFLATE_RESETREQ Pq Li resetreq +.It Dv NGM_DEFLATE_RESETREQ Pq Ic resetreq This message contains no arguments, and is bi-directional. If an error is detected during decompression, this message is sent by the node to the originator of the @@ -113,7 +113,7 @@ This message may also be received by this node type when a CCP Reset-Request or Reset-Ack is received by the local PPP entity. The node will respond by flushing its compression state so the sides can resynchronize. -.It Dv NGM_DEFLATE_GET_STATS Pq Li getstats +.It Dv NGM_DEFLATE_GET_STATS Pq Ic getstats This control message obtains statistics for a given hook. The statistics are returned in .Vt "struct ng_deflate_stats" : @@ -127,9 +127,9 @@ struct ng_deflate_stats { uint64_t Errors; }; .Ed -.It Dv NGM_DEFLATE_CLR_STATS Pq Li clrstats +.It Dv NGM_DEFLATE_CLR_STATS Pq Ic clrstats This control message clears statistics for a given hook. -.It Dv NGM_DEFLATE_GETCLR_STATS Pq Li getclrstats +.It Dv NGM_DEFLATE_GETCLR_STATS Pq Ic getclrstats This control message obtains and clears statistics for a given hook. .El .Sh SHUTDOWN diff --git a/share/man/man4/ng_eiface.4 b/share/man/man4/ng_eiface.4 index 66991533c352..d0d6f96ea0e8 100644 --- a/share/man/man4/ng_eiface.4 +++ b/share/man/man4/ng_eiface.4 @@ -63,8 +63,8 @@ Similarly, packets received on the hook go to the protocol stack as packets received by any real Ethernet interface. .Sh CONTROL MESSAGES This node type supports the generic control messages, plus the following: -.Bl -tag -width indent -.It Dv NGM_EIFACE_SET Pq Li set +.Bl -tag -width foo +.It Dv NGM_EIFACE_SET Pq Ic set Set link-level address of the interface. Requires .Vt "struct ether_addr" @@ -76,7 +76,7 @@ version, called which requires as an argument an .Tn ASCII string consisting of 6 colon-separated hex digits. -.It Dv NGM_EIFACE_GET_IFNAME Pq Li getifname +.It Dv NGM_EIFACE_GET_IFNAME Pq Ic getifname Return the name of the associated interface as a .Dv NUL Ns -terminated .Tn ASCII diff --git a/share/man/man4/ng_etf.4 b/share/man/man4/ng_etf.4 index adc3fba54a57..a35f4fa565ba 100644 --- a/share/man/man4/ng_etf.4 +++ b/share/man/man4/ng_etf.4 @@ -26,7 +26,7 @@ .\" .\" $FreeBSD$ .\" -.Dd May 16, 2006 +.Dd November 13, 2012 .Dt NG_ETF 4 .Os .Sh NAME @@ -66,7 +66,7 @@ than those configured by the control messages must have arrived via the hook. .Sh HOOKS This node type supports the following hooks: -.Bl -tag -width ".Em downstream" +.Bl -tag -width ".Aq Em any legal name" .It Em downstream Typically this hook would be connected to a .Xr ng_ether 4 @@ -89,11 +89,11 @@ with a particular set of ethertypes. .Sh CONTROL MESSAGES This node type supports the generic control messages, plus the following: .Bl -tag -width 4n -.It Dv NGM_ETF_GET_STATUS +.It Dv NGM_ETF_GET_STATUS Pq Ic getstatus This command returns a .Vt "struct ng_etfstat" containing node statistics for packet counts. -.It Dv NGM_ETF_SET_FILTER +.It Dv NGM_ETF_SET_FILTER Pq Ic setfilter Sets the a new ethertype filter into the node and specifies the hook to and from which packets of that type should use. The hook and ethertype @@ -101,8 +101,8 @@ are specified in a structure of type .Vt "struct ng_etffilter" : .Bd -literal -offset 4n struct ng_etffilter { - char matchhook[NG_HOOKSIZ]; /* hook name */ - uint16_t ethertype; /* catch these */ + char matchhook[NG_HOOKSIZ]; /* hook name */ + uint16_t ethertype; /* this ethertype to this hook */ }; .Ed .El diff --git a/share/man/man4/ng_ether.4 b/share/man/man4/ng_ether.4 index 6ca5c11bbbf6..610a8af8ae2e 100644 --- a/share/man/man4/ng_ether.4 +++ b/share/man/man4/ng_ether.4 @@ -124,36 +124,36 @@ but only receives unrecognized packets. .El .Sh CONTROL MESSAGES This node type supports the generic control messages, plus the following: -.Bl -tag -width indent -.It Dv NGM_ETHER_GET_IFNAME Pq Li getifname +.Bl -tag -width foo +.It Dv NGM_ETHER_GET_IFNAME Pq Ic getifname Returns the name of the associated interface as a .Dv NUL Ns -terminated .Tn ASCII string. Normally this is the same as the name of the node. -.It Dv NGM_ETHER_GET_IFINDEX Pq Li getifindex +.It Dv NGM_ETHER_GET_IFINDEX Pq Ic getifindex Returns the global index of the associated interface as a 32 bit integer. -.It Dv NGM_ETHER_GET_ENADDR Pq Li getenaddr +.It Dv NGM_ETHER_GET_ENADDR Pq Ic getenaddr Returns the device's unique six byte Ethernet address. -.It Dv NGM_ETHER_SET_ENADDR Pq Li setenaddr +.It Dv NGM_ETHER_SET_ENADDR Pq Ic setenaddr Sets the device's unique six byte Ethernet address. This control message is equivalent to using the .Dv SIOCSIFLLADDR .Xr ioctl 2 system call. -.It Dv NGM_ETHER_SET_PROMISC Pq Li setpromisc +.It Dv NGM_ETHER_SET_PROMISC Pq Ic setpromisc Enable or disable promiscuous mode. This message includes a single 32 bit integer flag that enables or disables promiscuous mode on the interface. Any non-zero value enables promiscuous mode. -.It Dv NGM_ETHER_GET_PROMISC Pq Li getpromisc +.It Dv NGM_ETHER_GET_PROMISC Pq Ic getpromisc Get the current value of the node's promiscuous flag. The returned value is always either one or zero. Note that this flag reflects the node's own promiscuous setting and does not necessarily reflect the promiscuous state of the actual interface, which can be affected by other means (e.g., .Xr bpf 4 ) . -.It Dv NGM_ETHER_SET_AUTOSRC Pq Li setautosrc +.It Dv NGM_ETHER_SET_AUTOSRC Pq Ic setautosrc Sets the automatic source address override flag. This message includes a single 32 bit integer flag that causes all outgoing packets to have their source Ethernet @@ -161,22 +161,22 @@ address field overwritten with the device's unique Ethernet address. If this flag is set to zero, the source address in outgoing packets is not modified. The default setting for this flag is disabled. -.It Dv NGM_ETHER_GET_AUTOSRC Pq Li getautosrc +.It Dv NGM_ETHER_GET_AUTOSRC Pq Ic getautosrc Get the current value of the node's source address override flag. The returned value is always either one or zero. -.It Dv NGM_ETHER_ADD_MULTI Pq Li addmulti +.It Dv NGM_ETHER_ADD_MULTI Pq Ic addmulti Join Ethernet multicast group. This control message is equivalent to using the .Dv SIOCADDMULTI .Xr ioctl 2 system call. -.It Dv NGM_ETHER_DEL_MULTI Pq Li delmulti +.It Dv NGM_ETHER_DEL_MULTI Pq Ic delmulti Leave Ethernet multicast group. This control message is equivalent to using the .Dv SIOCDELMULTI .Xr ioctl 2 system call. -.It Dv NGM_ETHER_DETACH Pq Li detach +.It Dv NGM_ETHER_DETACH Pq Ic detach Detach from underlying Ethernet interface and shut down node. .El .Sh SHUTDOWN diff --git a/share/man/man4/ng_fec.4 b/share/man/man4/ng_fec.4 index 26004eee4dd0..f9759cbc020f 100644 --- a/share/man/man4/ng_fec.4 +++ b/share/man/man4/ng_fec.4 @@ -57,20 +57,20 @@ node should not have any hooks. .Sh CONTROL MESSAGES Interface membership in the FEC group is configured with the following control messages: -.Bl -tag -width indent -.It Dv NGM_FEC_ADD_IFACE Pq Dq Li add_iface +.Bl -tag -width foo +.It Dv NGM_FEC_ADD_IFACE Pq Ic add_iface Attach interface to the FEC group. The target interface name is passed as a string argument. -.It Dv NGM_FEC_DEL_IFACE Pq Dq Li del_iface +.It Dv NGM_FEC_DEL_IFACE Pq Ic del_iface Remove interface from the trunk. The target interface name is passed as a string argument. .El .Pp The following control messages define the forwarding method for a node: -.Bl -tag -width indent -.It Dv NGM_FEC_SET_MODE_MAC Pq Dq Li set_mode_mac +.Bl -tag -width foo +.It Dv NGM_FEC_SET_MODE_MAC Pq Ic set_mode_mac Forwarding decisions will be based on the link-layer MAC address of the destination. -.It Dv NGM_FEC_SET_MODE_INET Pq Dq Li set_mode_inet +.It Dv NGM_FEC_SET_MODE_INET Pq Ic set_mode_inet Forwarding decisions will be based on the IP address of the destination. .El .Sh SHUTDOWN diff --git a/share/man/man4/ng_frame_relay.4 b/share/man/man4/ng_frame_relay.4 index edc8a8ca3e14..576fdfe3e8e8 100644 --- a/share/man/man4/ng_frame_relay.4 +++ b/share/man/man4/ng_frame_relay.4 @@ -63,10 +63,10 @@ through are available to connect to each of the DLCI channels. .Sh HOOKS This node type supports the following hooks: -.Bl -tag -width foobar -.It Dv downstream +.Bl -tag -width ".Va downstream" +.It Va downstream The connection to the synchronous line. -.It Dv dlciX +.It Va dlciX Here X is a decimal number from 0 to 1023. This hook corresponds to the DLCI X frame relay virtual channel. diff --git a/share/man/man4/ng_gif.4 b/share/man/man4/ng_gif.4 index 6c4dad257d11..2f360c0fb46d 100644 --- a/share/man/man4/ng_gif.4 +++ b/share/man/man4/ng_gif.4 @@ -99,10 +99,10 @@ packet attached to the front. When no hooks are connected, packets flow normally upwards and downwards. .Sh HOOKS This node type supports the following hooks: -.Bl -tag -width ".Dv orphans" -.It Dv lower +.Bl -tag -width ".Va orphans" +.It Va lower Connection to the lower device link layer. -.It Dv orphans +.It Va orphans Like .Dv lower , but only receives unrecognized packets. diff --git a/share/man/man4/ng_gif_demux.4 b/share/man/man4/ng_gif_demux.4 index e549728c4cd5..b245e09fa29d 100644 --- a/share/man/man4/ng_gif_demux.4 +++ b/share/man/man4/ng_gif_demux.4 @@ -70,7 +70,7 @@ hook. .Sh HOOKS This node type supports the following hooks: .Bl -tag -width ".Dv inet6" -.It Dv gif +.It Va gif Connection to the .Dv lower or @@ -78,19 +78,19 @@ or hook of an .Xr ng_gif 4 node. -.It Dv inet +.It Va inet Hook for input and output of IP frames. -.It Dv inet6 +.It Va inet6 Hook for input and output of IPv6 frames. -.It Dv atalk +.It Va atalk Hook for input and output of AppleTalk frames. -.It Dv ipx +.It Va ipx Hook for input and output of IPX frames. -.It Dv atm +.It Va atm Hook for input and output of ATM frames. -.It Dv natm +.It Va natm Hook for input and output of NATM frames. -.It Dv ns +.It Va ns Hook for input and output of NS frames. .El .Sh CONTROL MESSAGES diff --git a/share/man/man4/ng_h4.4 b/share/man/man4/ng_h4.4 index cda15e409069..a3b99ed9ace7 100644 --- a/share/man/man4/ng_h4.4 +++ b/share/man/man4/ng_h4.4 @@ -71,15 +71,15 @@ similar to the control message. .Sh HOOKS This node type supports the following hooks: -.Bl -tag -width indent -.It Dv hook +.Bl -tag -width ".Va hook" +.It Va hook single HCI frame contained in single .Vt mbuf structure. .El .Sh CONTROL MESSAGES This node type supports the generic control messages, plus the following: -.Bl -tag -width indent +.Bl -tag -width foo .It Dv NGM_H4_NODE_RESET Reset the node. .It Dv NGM_H4_NODE_GET_STATE diff --git a/share/man/man4/ng_hci.4 b/share/man/man4/ng_hci.4 index 0234d4105a6f..7ef7fcba061d 100644 --- a/share/man/man4/ng_hci.4 +++ b/share/man/man4/ng_hci.4 @@ -191,7 +191,7 @@ Host Controller. .Sh HCI INITIALIZATION On initialization, HCI control application must issue the following HCI commands (in any order). -.Bl -tag -width indent +.Bl -tag -width foo .It Dv Read_BD_ADDR To obtain BD_ADDR of the Bluetooth unit. .It Dv Read_Local_Supported_Features @@ -250,23 +250,23 @@ typedef struct { .Ed .Sh HOOKS This node type supports the following hooks: -.Bl -tag -width indent -.It Dv drv +.Bl -tag -width ".Va drv" +.It Va drv Bluetooth Host Controller Transport Layer hook. Single HCI packet contained in single .Vt mbuf structure. -.It Dv acl +.It Va acl Upper layer protocol/node is connected to the hook. Single HCI ACL data packet contained in single .Vt mbuf structure. -.It Dv sco +.It Va sco Upper layer protocol/node is connected to the hook. Single HCI SCO data packet contained in single .Vt mbuf structure. -.It Dv raw +.It Va raw Raw hook. Every HCI frame (including HCI command frame) that goes in or out will be delivered to the hook. @@ -276,7 +276,7 @@ Single HCI frame contained in single structure. .El .Sh BLUETOOTH UPPER LAYER PROTOCOLS INTERFACE (LP CONTROL MESSAGES) -.Bl -tag -width indent +.Bl -tag -width foo .It Dv NGM_HCI_LP_CON_REQ Requests the lower protocol to create a connection. If a physical link @@ -311,7 +311,7 @@ agreement. .El .Sh NETGRAPH CONTROL MESSAGES This node type supports the generic control messages, plus the following: -.Bl -tag -width indent +.Bl -tag -width foo .It Dv NGM_HCI_NODE_GET_STATE Returns current state for the node. .It Dv NGM_HCI_NODE_INIT diff --git a/share/man/man4/ng_hole.4 b/share/man/man4/ng_hole.4 index 0199d74b9795..4d0c0773f2be 100644 --- a/share/man/man4/ng_hole.4 +++ b/share/man/man4/ng_hole.4 @@ -57,19 +57,19 @@ as long as the name is unique. .Sh CONTROL MESSAGES This node type supports the generic control messages, plus the following: -.Bl -tag -width indent -.It Dv NGM_HOLE_GET_STATS +.Bl -tag -width foo +.It Dv NGM_HOLE_GET_STATS Pq Ic getstats This command takes an .Tn ASCII string argument, the hook name, and returns the statistics associated with the hook as a .Vt "struct ng_hole_hookstat" . -.It Dv NGM_HOLE_CLR_STATS +.It Dv NGM_HOLE_CLR_STATS Pq Ic clrstats This command takes an .Tn ASCII string argument, the hook name, and clears the statistics associated with the hook. -.It Dv NGM_HOLE_GETCLR_STATS +.It Dv NGM_HOLE_GETCLR_STATS Pq Ic getclrstats This command is identical to .Dv NGM_HOLE_GET_STATS , except that the statistics are also atomically cleared. diff --git a/share/man/man4/ng_hub.4 b/share/man/man4/ng_hub.4 index c52aba048477..da687239e7f2 100644 --- a/share/man/man4/ng_hub.4 +++ b/share/man/man4/ng_hub.4 @@ -48,7 +48,7 @@ as long as the name is unique. This node type supports the generic control messages, plus the following: .Bl -tag -width foo -.It Dv NGM_HUB_SET_PERSISTENT +.It Dv NGM_HUB_SET_PERSISTENT Pq Ic setpersistent This command sets the persistent flag on the node, and takes no arguments. .El .Sh SHUTDOWN diff --git a/share/man/man4/ng_iface.4 b/share/man/man4/ng_iface.4 index 76ec47fc5b7d..1756f9d18a6f 100644 --- a/share/man/man4/ng_iface.4 +++ b/share/man/man4/ng_iface.4 @@ -83,40 +83,40 @@ The default mode is point-to-point. nodes support the Berkeley Packet Filter (BPF). .Sh HOOKS This node type supports the following hooks: -.Bl -tag -width foobar -.It Dv inet +.Bl -tag -width ".Va inet6" +.It Va inet Transmission and reception of IP packets. -.It Dv inet6 +.It Va inet6 Transmission and reception of IPv6 packets. -.It Dv atalk +.It Va atalk Transmission and reception of AppleTalk packets. -.It Dv ipx +.It Va ipx Transmission and reception of IPX packets. -.It Dv atm +.It Va atm Transmission and reception of ATM packets. -.It Dv natm +.It Va natm Transmission and reception of NATM packets. -.It Dv ns +.It Va ns Transmission and reception of NS packets. .El .Sh CONTROL MESSAGES This node type supports the generic control messages, plus the following: .Bl -tag -width foo -.It Dv NGM_IFACE_GET_IFNAME +.It Dv NGM_IFACE_GET_IFNAME Pq Ic getifname Returns the name of the associated interface as a .Dv NUL Ns -terminated .Tn ASCII string. Normally this is the same as the name of the node. -.It Dv NGM_IFACE_GET_IFINDEX +.It Dv NGM_IFACE_GET_IFINDEX Pq Ic getifindex Returns the global index of the associated interface as a 32 bit integer. -.It Dv NGM_IFACE_POINT2POINT +.It Dv NGM_IFACE_POINT2POINT Pq Ic point2point Set the interface to point-to-point mode. The interface must not currently be up. -.It Dv NGM_IFACE_BROADCAST +.It Dv NGM_IFACE_BROADCAST Pq Ic broadcast Set the interface to broadcast mode. The interface must not currently be up. -.It Dv NGM_CISCO_GET_IPADDR +.It Dv NGM_CISCO_GET_IPADDR Pq Ic getipaddr This message is defined by the .Xr ng_cisco 4 node type; see diff --git a/share/man/man4/ng_ksocket.4 b/share/man/man4/ng_ksocket.4 index 3a9fcd0aad8e..ff67028beffe 100644 --- a/share/man/man4/ng_ksocket.4 +++ b/share/man/man4/ng_ksocket.4 @@ -111,28 +111,28 @@ to sender. .Sh CONTROL MESSAGES This node type supports the generic control messages, plus the following: .Bl -tag -width foo -.It Dv NGM_KSOCKET_BIND +.It Dv NGM_KSOCKET_BIND Pq Ic bind This functions exactly like the .Xr bind 2 system call. The .Vt "struct sockaddr" socket address parameter should be supplied as an argument. -.It Dv NGM_KSOCKET_LISTEN +.It Dv NGM_KSOCKET_LISTEN Pq Ic listen This functions exactly like the .Xr listen 2 system call. The backlog parameter (a single 32 bit .Dv int ) should be supplied as an argument. -.It Dv NGM_KSOCKET_CONNECT +.It Dv NGM_KSOCKET_CONNECT Pq Ic connect This functions exactly like the .Xr connect 2 system call. The .Vt "struct sockaddr" destination address parameter should be supplied as an argument. -.It Dv NGM_KSOCKET_ACCEPT +.It Dv NGM_KSOCKET_ACCEPT Pq Ic accept Equivalent to the .Xr accept 2 system call on a non-blocking socket. @@ -148,26 +148,26 @@ when a connection is established. A cloned node supports a single hook with an arbitrary name. If not connected, a node disappears when its parent node is destroyed. Once connected, it becomes an independent node. -.It Dv NGM_KSOCKET_GETNAME +.It Dv NGM_KSOCKET_GETNAME Pq Ic getname Equivalent to the .Xr getsockname 2 system call. The name is returned as a .Vt "struct sockaddr" in the arguments field of the reply. -.It Dv NGM_KSOCKET_GETPEERNAME +.It Dv NGM_KSOCKET_GETPEERNAME Pq Ic getpeername Equivalent to the .Xr getpeername 2 system call. The name is returned as a .Vt "struct sockaddr" in the arguments field of the reply. -.It Dv NGM_KSOCKET_SETOPT +.It Dv NGM_KSOCKET_SETOPT Pq Ic setopt Equivalent to the .Xr setsockopt 2 system call, except that the option name, level, and value are passed in a .Vt "struct ng_ksocket_sockopt" . -.It Dv NGM_KSOCKET_GETOPT +.It Dv NGM_KSOCKET_GETOPT Pq Ic getopt Equivalent to the .Xr getsockopt 2 system call, except that the option is passed in a diff --git a/share/man/man4/ng_l2cap.4 b/share/man/man4/ng_l2cap.4 index 949b0390cabf..ba5df7d9c032 100644 --- a/share/man/man4/ng_l2cap.4 +++ b/share/man/man4/ng_l2cap.4 @@ -104,7 +104,7 @@ assigned to (remote) channel endpoints by several remote devices connected to a single local device, the local device can still uniquely associate each remote CID with a different device. .Ss Channel Operational States -.Bl -tag -width indent +.Bl -tag -width foo .It Dv NG_L2CAP_CLOSED In this state, there is no channel associated with this CID. This is the only @@ -209,13 +209,13 @@ L2CAP does not support the concept of a global group name. .El .Sh HOOKS This node type supports the following hooks: -.Bl -tag -width indent -.It Dv hci +.Bl -tag -width ".Va hci" +.It Va hci Bluetooth Host Controller Interface downstream hook. -.It Dv l2c +.It Va l2c Upper layer protocol upstream hook. Usually the Bluetooth L2CAP socket layer is connected to the hook. -.It Dv ctl +.It Va ctl Control hook. Usually the Bluetooth raw L2CAP sockets layer is connected to the hook. .El @@ -242,7 +242,7 @@ and will not set flag. There is no reason for this, because they are just notifications and do not require acknowledgment. -.Bl -tag -width indent +.Bl -tag -width foo .It Dv NGM_L2CAP_L2CA_CON Requests the creation of a channel representing a logical connection to a physical address. @@ -380,7 +380,7 @@ parameter is the PSM value indicating service that should be blocked .El .Sh NETGRAPH CONTROL MESSAGES This node type supports the generic control messages, plus the following: -.Bl -tag -width indent +.Bl -tag -width foo .It Dv NGM_L2CAP_NODE_GET_FLAGS Returns current state for the node. .It Dv NGM_L2CAP_NODE_GET_DEBUG diff --git a/share/man/man4/ng_l2tp.4 b/share/man/man4/ng_l2tp.4 index c556a49b828e..fc5ed07167d8 100644 --- a/share/man/man4/ng_l2tp.4 +++ b/share/man/man4/ng_l2tp.4 @@ -37,7 +37,7 @@ .\" .\" $FreeBSD$ .\" -.Dd August 2, 2004 +.Dd November 13, 2012 .Dt NG_L2TP 4 .Os .Sh NAME @@ -59,13 +59,12 @@ control session packet acknowledgment and retransmission. The .Nm l2tp node type supports the following hooks: -.Pp -.Bl -tag -compact -offset indent -width ".Dv session_hhhh" -.It Dv lower +.Bl -tag -width ".Va session_hhhh" +.It Va lower L2TP frames. -.It Dv ctrl +.It Va ctrl Control packets. -.It Dv session_hhhh +.It Va session_hhhh Session 0xhhhh data packets. .El .Pp @@ -104,8 +103,8 @@ the hook is named .Dv session_abcd . .Sh CONTROL MESSAGES This node type supports the generic control messages, plus the following: -.Bl -tag -width indent -.It Dv NGM_L2TP_SET_CONFIG +.Bl -tag -width foo +.It Dv NGM_L2TP_SET_CONFIG Pq Ic setconfig This command updates the configuration of the node. It takes a .Vt "struct ng_l2tp_config" @@ -182,14 +181,14 @@ Once a failure condition is declared, each additional retransmission will cause the .Nm l2tp node to send a -.Dv NGM_L2TP_ACK_FAILURE +.Dv NGM_L2TP_ACK_FAILURE Pq Ic ackfailure control message back to the node that sent the last .Dv NGM_L2TP_SET_CONFIG . Appropriate action should then be taken to shutdown the control connection. -.It Dv NGM_L2TP_GET_CONFIG +.It Dv NGM_L2TP_GET_CONFIG Pq Ic getconfig Returns the current configuration as a .Vt "struct ng_l2tp_config" . -.It Dv NGM_L2TP_SET_SESS_CONFIG +.It Dv NGM_L2TP_SET_SESS_CONFIG Pq Ic setsessconfig This control message configures a single data session. The corresponding hook must already be connected before sending this command. The argument is a @@ -199,9 +198,9 @@ The argument is a struct ng_l2tp_sess_config { uint16_t session_id; /* local session id */ uint16_t peer_id; /* peer's session id */ - u_char control_dseq; /* we control data sequencing? */ - u_char enable_dseq; /* enable data sequencing? */ - u_char include_length; /* include length field? */ + u_char control_dseq; /* whether we control data sequencing */ + u_char enable_dseq; /* whether to enable data sequencing */ + u_char include_length; /* whether to include length field */ }; .Ed .Pp @@ -256,35 +255,35 @@ The field determines whether the L2TP header length field is included in outgoing L2TP data packets. For incoming packets, the L2TP length field is always checked when present. -.It Dv NGM_L2TP_GET_SESS_CONFIG +.It Dv NGM_L2TP_GET_SESS_CONFIG Pq Ic getsessconfig This command takes a two byte session ID as an argument and returns the current configuration for the corresponding data session as a .Vt "struct ng_l2tp_sess_config" . The corresponding session hook must be connected. -.It Dv NGM_L2TP_GET_STATS +.It Dv NGM_L2TP_GET_STATS Pq Ic getstats This command returns a .Vt "struct ng_l2tp_stats" containing statistics of the L2TP tunnel. -.It Dv NGM_L2TP_CLR_STATS +.It Dv NGM_L2TP_CLR_STATS Pq Ic clrstats This command clears the statistics for the L2TP tunnel. -.It Dv NGM_L2TP_GETCLR_STATS +.It Dv NGM_L2TP_GETCLR_STATS Pq Ic getclrstats Same as .Dv NGM_L2TP_GET_STATS , but also atomically clears the statistics as well. -.It Dv NGM_L2TP_GET_SESSION_STATS +.It Dv NGM_L2TP_GET_SESSION_STATS Pq Ic getsessstats This command takes a two byte session ID as an argument and returns a .Vt "struct ng_l2tp_session_stats" containing statistics for the corresponding data session. The corresponding session hook must be connected. -.It Dv NGM_L2TP_CLR_SESSION_STATS +.It Dv NGM_L2TP_CLR_SESSION_STATS Pq Ic clrsessstats This command takes a two byte session ID as an argument and clears the statistics for that data session. The corresponding session hook must be connected. -.It Dv NGM_L2TP_GETCLR_SESSION_STATS +.It Dv NGM_L2TP_GETCLR_SESSION_STATS Pq Ic getclrsessstats Same as .Dv NGM_L2TP_GET_SESSION_STATS , but also atomically clears the statistics as well. -.It Dv NGM_L2TP_SET_SEQ +.It Dv NGM_L2TP_SET_SEQ Pq Ic setsequence This command sets the sequence numbers of a not yet enabled node. It takes a .Vt "struct ng_l2tp_seq_config" diff --git a/share/man/man4/ng_lmi.4 b/share/man/man4/ng_lmi.4 index a8fed52dbc0d..537871768253 100644 --- a/share/man/man4/ng_lmi.4 +++ b/share/man/man4/ng_lmi.4 @@ -35,7 +35,7 @@ .\" $FreeBSD$ .\" $Whistle: ng_lmi.8,v 1.4 1999/01/25 23:46:27 archie Exp $ .\" -.Dd January 19, 1999 +.Dd November 13, 2012 .Dt NG_LMI 4 .Os .Sh NAME @@ -82,16 +82,16 @@ This node also supports the control message. .Sh HOOKS This node type supports the following hooks: -.Bl -tag -width foobarbaz -.It Dv annexA +.Bl -tag -width ".Va auto1023" +.It Va annexA ITU Annex A LMI hook. -.It Dv annexD +.It Va annexD ANSI Annex D LMI hook. -.It Dv group4 +.It Va group4 Group-of-four LMI hook. -.It Dv auto0 +.It Va auto0 Auto-detection hook for DLCI 0. -.It Dv auto1023 +.It Va auto1023 Auto-detection hook for DLCI 1023. .El .Sh CONTROL MESSAGES @@ -108,8 +108,8 @@ struct nglmistat { u_char hook[12]; /* Active hook */ u_char fixed; /* If set to fixed LMI mode */ u_char autod; /* If currently auto-detecting */ - u_char seen[NGM_LMI_STAT_ARYSIZE]; /* bitmap DLCIs seen */ - u_char up[NGM_LMI_STAT_ARYSIZE]; /* bitmap DLCIs up */ + u_char seen[NGM_LMI_STAT_ARYSIZE]; /* DLCIs ever seen */ + u_char up[NGM_LMI_STAT_ARYSIZE]; /* DLCIs currently up */ }; .Ed .It Dv NGM_TEXT_STATUS diff --git a/share/man/man4/ng_mppc.4 b/share/man/man4/ng_mppc.4 index df3b3a76bea0..e7eeedfb4789 100644 --- a/share/man/man4/ng_mppc.4 +++ b/share/man/man4/ng_mppc.4 @@ -64,16 +64,15 @@ node type hook of the same name. Each direction of traffic flow is independent of the other. .Sh HOOKS This node type supports the following hooks: -.Pp -.Bl -tag -compact -width vjc_vjuncomp -.It Dv comp +.Bl -tag -width ".Va decomp" +.It Va comp Connection to .Xr ng_ppp 4 .Dv "comp" hook. Incoming frames are compressed and/or encrypted, and sent back out the same hook. -.It Dv decomp +.It Va decomp Connection to .Xr ng_ppp 4 .Dv "decomp" diff --git a/share/man/man4/ng_nat.4 b/share/man/man4/ng_nat.4 index b2cff1f30057..2c7da77003ab 100644 --- a/share/man/man4/ng_nat.4 +++ b/share/man/man4/ng_nat.4 @@ -44,7 +44,7 @@ node uses engine for packet aliasing. .Sh HOOKS This node type has two hooks: -.Bl -tag -width indent +.Bl -tag -width ".Va out" .It Va out Packets received on this hook are considered outgoing and will be masqueraded to a configured address. @@ -54,12 +54,12 @@ dealiased. .El .Sh CONTROL MESSAGES This node type supports the generic control messages, plus the following: -.Bl -tag -width indent -.It Dv NGM_NAT_SET_IPADDR Pq Li setaliasaddr +.Bl -tag -width foo +.It Dv NGM_NAT_SET_IPADDR Pq Ic setaliasaddr Configure aliasing address for a node. After both hooks have been connected and aliasing address was configured, a node is ready for aliasing operation. -.It Dv NGM_NAT_SET_MODE Pq Li setmode +.It Dv NGM_NAT_SET_MODE Pq Ic setmode Set node's operation mode using supplied .Vt "struct ng_nat_mode" . .Bd -literal @@ -76,11 +76,11 @@ struct ng_nat_mode { #define NG_NAT_PROXY_ONLY 0x40 #define NG_NAT_REVERSE 0x80 .Ed -.It Dv NGM_NAT_SET_TARGET Pq Li settarget +.It Dv NGM_NAT_SET_TARGET Pq Ic settarget Configure target address for a node. When an incoming packet not associated with any pre-existing aliasing link arrives at the host machine, it will be sent to the specified address. -.It Dv NGM_NAT_REDIRECT_PORT Pq Li redirectport +.It Dv NGM_NAT_REDIRECT_PORT Pq Ic redirectport Redirect incoming connections arriving to given port(s) to another host and port(s). The following @@ -106,7 +106,7 @@ information about redirection added to list of static redirects which later can be retrieved by .Dv NGM_NAT_LIST_REDIRECTS message. -.It Dv NGM_NAT_REDIRECT_ADDR Pq Li redirectaddr +.It Dv NGM_NAT_REDIRECT_ADDR Pq Ic redirectaddr Redirect traffic for public IP address to a machine on the local network. This function is known as @@ -123,7 +123,7 @@ struct ng_nat_redirect_addr { .Ed .Pp Unique ID for this redirection is returned as response to this message. -.It Dv NGM_NAT_REDIRECT_PROTO Pq Li redirectproto +.It Dv NGM_NAT_REDIRECT_PROTO Pq Ic redirectproto Redirect incoming IP packets of protocol .Va proto (see @@ -143,7 +143,7 @@ struct ng_nat_redirect_proto { .Ed .Pp Unique ID for this redirection is returned as response to this message. -.It Dv NGM_NAT_REDIRECT_DYNAMIC Pq Li redirectdynamic +.It Dv NGM_NAT_REDIRECT_DYNAMIC Pq Ic redirectdynamic Mark redirection with specified ID as dynamic, i.e., it will serve for exactly one next connection and then will be automatically deleted from internal links table. @@ -152,10 +152,10 @@ The redirection with this ID is also immediately deleted from user-visible list of static redirects (available through .Dv NGM_NAT_LIST_REDIRECTS message). -.It Dv NGM_NAT_REDIRECT_DELETE Pq Li redirectdelete +.It Dv NGM_NAT_REDIRECT_DELETE Pq Ic redirectdelete Delete redirection with specified ID (currently active connections are not affected). -.It Dv NGM_NAT_ADD_SERVER Pq Li addserver +.It Dv NGM_NAT_ADD_SERVER Pq Ic addserver Add another server to a pool. This is used to transparently offload network load on a single server and distribute the load across a pool of servers, also known as @@ -191,7 +191,7 @@ and are also ignored after .Dv NGM_NAT_ADD_SERVER was used (they are effectively replaced by server pool). -.It Dv NGM_NAT_LIST_REDIRECTS Pq Li listredirects +.It Dv NGM_NAT_LIST_REDIRECTS Pq Ic listredirects Return list of configured static redirects as .Vt "struct ng_nat_list_redirects" . .Bd -literal @@ -233,7 +233,7 @@ servers counter is greater than zero, then and .Va local_port are also meaningless. -.It Dv NGM_NAT_PROXY_RULE Pq Li proxyrule +.It Dv NGM_NAT_PROXY_RULE Pq Ic proxyrule Specify a transparent proxying rule (string must be supplied as argument). See diff --git a/share/man/man4/ng_netflow.4 b/share/man/man4/ng_netflow.4 index 36551d514b75..b88c01743daf 100644 --- a/share/man/man4/ng_netflow.4 +++ b/share/man/man4/ng_netflow.4 @@ -99,7 +99,7 @@ hook of the node. .Sh CONTROL MESSAGES This node type supports the generic control messages, plus the following: -.Bl -tag -width indent +.Bl -tag -width foo .It Dv NGM_NETFLOW_INFO Pq Ic info Returns some node statistics and the current timeout values in a .Vt "struct ng_netflow_info" . diff --git a/share/man/man4/ng_one2many.4 b/share/man/man4/ng_one2many.4 index 948b763f911c..288ea1868785 100644 --- a/share/man/man4/ng_one2many.4 +++ b/share/man/man4/ng_one2many.4 @@ -34,7 +34,7 @@ .\" .\" $FreeBSD$ .\" -.Dd March 1, 2011 +.Dd November 13, 2012 .Dt NG_ONE2MANY 4 .Os .Sh NAME @@ -107,7 +107,7 @@ In the future other algorithms may be added as well. The node distinguishes between active and failed links. Data is sent only to active links. The following link failure detection algorithms are available: -.Bl -tag -width indent +.Bl -tag -width foo .It Dv NG_ONE2MANY_FAIL_MANUAL The node is explicitly told which of the links are up via the .Dv NGM_ONE2MANY_SET_CONFIG @@ -149,7 +149,7 @@ plus a single hook named This node type supports the generic control messages, plus the following: .Bl -tag -width foo -.It Dv NGM_ONE2MANY_SET_CONFIG +.It Dv NGM_ONE2MANY_SET_CONFIG Pq Ic setconfig Sets the node configuration using a .Dv "struct ng_one2many_link_config" as the control message argument: @@ -174,10 +174,10 @@ are .Dv NG_ONE2MANY_FAIL_MANUAL (default) or .Dv NG_ONE2MANY_FAIL_NOTIFY . -.It Dv NGM_ONE2MANY_GET_CONFIG +.It Dv NGM_ONE2MANY_GET_CONFIG Pq Ic getconfig Returns the current node configuration in a .Dv "struct ng_one2many_link_config" . -.It Dv NGM_ONE2MANY_GET_STATS +.It Dv NGM_ONE2MANY_GET_STATS Pq Ic getstats This command takes a 32 bit link number as an argument and returns a .Dv "struct ng_one2many_link_stats" @@ -191,6 +191,7 @@ struct ng_one2many_link_stats { uint64_t recvPackets; /* total pkts rec'd on link */ uint64_t xmitOctets; /* total octets xmit'd on link */ uint64_t xmitPackets; /* total pkts xmit'd on link */ + uint64_t memoryFailures; /* times couldn't get mem or mbuf */ }; .Ed .Pp @@ -198,10 +199,10 @@ To access statistics for the .Dv one link, use the link number .Dv -1 . -.It Dv NGM_ONE2MANY_CLR_STATS +.It Dv NGM_ONE2MANY_CLR_STATS Pq Ic clrstats This command takes a 32 bit link number as an argument and clears the statistics for that link. -.It Dv NGM_ONE2MANY_GETCLR_STATS +.It Dv NGM_ONE2MANY_GETCLR_STATS Pq Ic getclrstats Same as .Dv NGM_ONE2MANY_GET_STATS , but also atomically clears the statistics for the link as well. diff --git a/share/man/man4/ng_patch.4 b/share/man/man4/ng_patch.4 index b1ddf4aebd7c..db7ede54025f 100644 --- a/share/man/man4/ng_patch.4 +++ b/share/man/man4/ng_patch.4 @@ -57,7 +57,7 @@ bytes beginning from are taken as a single integer in network byte order. .Sh HOOKS This node type has two hooks: -.Bl -tag -width indent +.Bl -tag -width ".Va out" .It Va in Packets received on this hook are modified according to rules specified in config and then forwarded to @@ -73,8 +73,8 @@ hook without any changes. .El .Sh CONTROL MESSAGES This node type supports the generic control messages, plus the following: -.Bl -tag -width indent -.It Dv NGM_PATCH_SETCONFIG Pq Li setconfig +.Bl -tag -width foo +.It Dv NGM_PATCH_SETCONFIG Pq Ic setconfig This command sets the sequence of modify operations that will be applied to incoming data on a hook. The following @@ -115,16 +115,16 @@ corresponding checksum before transmitting packet on output interface. The .Nm node does not do any checksum correction by itself. -.It Dv NGM_PATCH_GETCONFIG Pq Li getconfig +.It Dv NGM_PATCH_GETCONFIG Pq Ic getconfig This control message obtains current set of modify operations, returned as .Vt "struct ng_patch_config" . -.It Dv NGM_PATCH_GET_STATS Pq Li getstats +.It Dv NGM_PATCH_GET_STATS Pq Ic getstats Returns node statistics as a .Vt "struct ng_patch_stats" . -.It Dv NGM_PATCH_CLR_STATS Pq Li clrstats +.It Dv NGM_PATCH_CLR_STATS Pq Ic clrstats Clear node statistics. -.It Dv NGM_PATCH_GETCLR_STATS Pq Li getclrstats +.It Dv NGM_PATCH_GETCLR_STATS Pq Ic getclrstats This command is identical to .Dv NGM_PATCH_GET_STATS , except that the statistics are also atomically cleared. diff --git a/share/man/man4/ng_ppp.4 b/share/man/man4/ng_ppp.4 index 88cf6e2e69a9..d69a59f3f8f4 100644 --- a/share/man/man4/ng_ppp.4 +++ b/share/man/man4/ng_ppp.4 @@ -35,7 +35,7 @@ .\" $FreeBSD$ .\" $Whistle: ng_ppp.8,v 1.3 1999/01/25 23:46:27 archie Exp $ .\" -.Dd September 24, 2012 +.Dd November 13, 2012 .Dt NG_PPP 4 .Os .Sh NAME @@ -290,55 +290,54 @@ and the PPP node simply fragments frames into equal sized portions across all of the links. .Sh HOOKS This node type supports the following hooks: -.Pp -.Bl -tag -compact -width vjc_vjuncomp -.It Dv link<N> +.Bl -tag -width ".Va vjc_vjuncomp" +.It Va link<N> Individual PPP link number .Dv <N> -.It Dv compress +.It Va compress Connection to compression engine -.It Dv decompress +.It Va decompress Connection to decompression engine -.It Dv encrypt +.It Va encrypt Connection to encryption engine -.It Dv decrypt +.It Va decrypt Connection to decryption engine -.It Dv vjc_ip +.It Va vjc_ip Connection to .Xr ng_vjc 4 .Dv ip hook -.It Dv vjc_vjcomp +.It Va vjc_vjcomp Connection to .Xr ng_vjc 4 .Dv vjcomp hook -.It Dv vjc_vjuncomp +.It Va vjc_vjuncomp Connection to .Xr ng_vjc 4 .Dv vjuncomp hook -.It Dv vjc_vjip +.It Va vjc_vjip Connection to .Xr ng_vjc 4 .Dv vjip hook -.It Dv inet +.It Va inet IP packet data -.It Dv ipv6 +.It Va ipv6 IPv6 packet data -.It Dv atalk +.It Va atalk AppleTalk packet data -.It Dv ipx +.It Va ipx IPX packet data -.It Dv bypass +.It Va bypass Bypass hook; frames have a four byte header consisting of a link number and a PPP protocol number. .El .Sh CONTROL MESSAGES This node type supports the generic control messages, plus the following: .Bl -tag -width foo -.It Dv NGM_PPP_SET_CONFIG +.It Dv NGM_PPP_SET_CONFIG Pq Ic setconfig This command configures all aspects of the node. This includes enabling multi-link PPP, encryption, compression, Van Jacobson compression, and IP, @@ -359,7 +358,7 @@ struct ng_ppp_link_conf { u_char enableACFComp; /* enable addr/ctrl field compression */ uint16_t mru; /* peer MRU */ uint32_t latency; /* link latency (in milliseconds) */ - uint32_t bandwidth; /* link bandwidth (in bytes/second) */ + uint32_t bandwidth; /* link bandwidth (in bytes/sec/10) */ }; /* Bundle config structure */ @@ -387,28 +386,28 @@ struct ng_ppp_node_conf { }; .Ed .Pp -.It Dv NGM_PPP_GET_CONFIG +.It Dv NGM_PPP_GET_CONFIG Pq Ic getconfig Returns the current configuration as a .Dv "struct ng_ppp_node_conf" . -.It Dv NGM_PPP_GET_LINK_STATS +.It Dv NGM_PPP_GET_LINK_STATS Pq Ic getstats This command takes a two byte link number as an argument and returns a .Dv "struct ng_ppp_link_stat" containing statistics for the corresponding link. Here .Dv NG_PPP_BUNDLE_LINKNUM is a valid link number corresponding to the multi-link bundle. -.It Dv NGM_PPP_GET_LINK_STATS64 +.It Dv NGM_PPP_GET_LINK_STATS64 Pq Ic getstats64 Same as NGM_PPP_GET_LINK_STATS but returns .Dv "struct ng_ppp_link_stat64" containing 64bit counters. -.It Dv NGM_PPP_CLR_LINK_STATS +.It Dv NGM_PPP_CLR_LINK_STATS Pq Ic clrstats This command takes a two byte link number as an argument and clears the statistics for that link. -.It Dv NGM_PPP_GETCLR_LINK_STATS +.It Dv NGM_PPP_GETCLR_LINK_STATS Pq Ic getclrstats Same as .Dv NGM_PPP_GET_LINK_STATS , but also atomically clears the statistics as well. -.It Dv NGM_PPP_GETCLR_LINK_STATS64 +.It Dv NGM_PPP_GETCLR_LINK_STATS64 Pq Ic getclrstats64 Same as NGM_PPP_GETCLR_LINK_STATS but returns .Dv "struct ng_ppp_link_stat64" containing 64bit counters. diff --git a/share/man/man4/ng_pppoe.4 b/share/man/man4/ng_pppoe.4 index e7a9939b29f5..a124d6770b7c 100644 --- a/share/man/man4/ng_pppoe.4 +++ b/share/man/man4/ng_pppoe.4 @@ -35,7 +35,7 @@ .\" $FreeBSD$ .\" $Whistle: ng_pppoe.8,v 1.1 1999/01/25 23:46:27 archie Exp $ .\" -.Dd December 27, 2007 +.Dd November 13, 2012 .Dt NG_PPPOE 4 .Os .Sh NAME @@ -67,8 +67,8 @@ the control message. .Sh HOOKS This node type supports the following hooks: -.Bl -tag -width [unspecified] -.It Dv ethernet +.Bl -tag -width ".Va [unspecified]" +.It Va ethernet The hook that should normally be connected to an .Xr ng_ether 4 node. @@ -77,9 +77,9 @@ Once connected, will send a message down this hook to determine Ethernet address of the underlying node. Obtained address will be stored and then used for outgoing datagrams. -.It Dv debug +.It Va debug Presently no use. -.It Dv [unspecified] +.It Va [unspecified] Any other name is assumed to be a session hook that will be connected to a PPP client agent, or a PPP server agent. .El @@ -98,7 +98,7 @@ struct ngpppoestat { .It Dv NGM_TEXT_STATUS This generic message returns a human-readable version of the node status. (not yet) -.It Dv NGM_PPPOE_CONNECT +.It Dv NGM_PPPOE_CONNECT Pq Ic pppoe_connect Tell a nominated newly created hook that its session should enter the state machine as a client. It must be newly created and a service name can be given as an argument. @@ -110,7 +110,7 @@ A session request packet will be broadcasted on the Ethernet. This command uses the .Dv ngpppoe_init_data structure shown below. -.It Dv NGM_PPPOE_LISTEN +.It Dv NGM_PPPOE_LISTEN Pq Ic pppoe_listen Tell a nominated newly created hook that its session should enter the state machine as a server listener. The argument @@ -124,7 +124,7 @@ the session that is started to answer the request. This command uses the .Dv ngpppoe_init_data structure shown below. -.It Dv NGM_PPPOE_OFFER +.It Dv NGM_PPPOE_OFFER Pq Ic pppoe_offer Tell a nominated newly created hook that its session should enter the state machine as a server. The argument given is the name of the service to offer. @@ -148,18 +148,18 @@ The three commands above use a common data structure: .Bd -literal -offset 4n struct ngpppoe_init_data { char hook[NG_HOOKSIZ]; /* hook to monitor on */ - uint16_t data_len; /* service name length */ + uint16_t data_len; /* length of the service name */ char data[0]; /* init data goes here */ }; .Ed .Bl -tag -width 3n -.It Dv NGM_PPPOE_SUCCESS +.It Dv NGM_PPPOE_SUCCESS Pq Ic pppoe_success This command is sent to the node that started this session with one of the above messages, and reports a state change. This message reports successful Session negotiation. It uses the structure shown below, and reports back the hook name corresponding to the successful session. -.It Dv NGM_PPPOE_FAIL +.It Dv NGM_PPPOE_FAIL Pq Ic pppoe_fail This command is sent to the node that started this session with one of the above messages, and reports a state change. This message reports failed Session negotiation. @@ -167,7 +167,7 @@ It uses the structure shown below, and reports back the hook name corresponding to the failed session. The hook will probably have been removed immediately after sending this message. -.It Dv NGM_PPPOE_CLOSE +.It Dv NGM_PPPOE_CLOSE Pq Ic pppoe_close This command is sent to the node that started this session with one of the above messages, and reports a state change. This message reports a request to close a session. @@ -191,7 +191,7 @@ struct ngpppoe_sts { }; .Ed .Bl -tag -width 3n -.It Dv NGM_PPPOE_GETMODE +.It Dv NGM_PPPOE_GETMODE Pq Ic pppoe_getmode This command returns the current compatibility mode of the node as a string. .Tn ASCII @@ -221,7 +221,7 @@ This option is necessary for compatibility with D-Link DI-614+ and DI-624+ SOHO routers as clients, when serving only specific Service-Name. This compatibility option does not affect client mode. .El -.It Dv NGM_PPPOE_SETMODE +.It Dv NGM_PPPOE_SETMODE Pq Ic pppoe_setmode Configure node to the specified mode. The string argument is required. This command understands the same keywords that are returned by the @@ -235,7 +235,7 @@ the next session in the proprietary 3Com mode: .Bd -literal -offset indent ngctl msg fxp0:orphans pppoe_setmode '"3Com"' .Ed -.It Dv NGM_PPPOE_SETENADDR +.It Dv NGM_PPPOE_SETENADDR Pq Ic setenaddr Set the node Ethernet address for outgoing datagrams. This message is important when a node has failed to obtain an Ethernet address from its peer on the diff --git a/share/man/man4/ng_pptpgre.4 b/share/man/man4/ng_pptpgre.4 index e0d41f1c0cfd..3e26f9cc024b 100644 --- a/share/man/man4/ng_pptpgre.4 +++ b/share/man/man4/ng_pptpgre.4 @@ -35,7 +35,7 @@ .\" $FreeBSD$ .\" $Whistle: ng_pptpgre.8,v 1.2 1999/12/08 00:20:53 archie Exp $ .\" -.Dd March 29, 2008 +.Dd November 13, 2012 .Dt NG_PPTPGRE 4 .Os .Sh NAME @@ -72,19 +72,18 @@ hook of a node. .Sh HOOKS This node type supports the following hooks: -.Pp -.Bl -tag -compact -width ".Li session_hhhh" -.It Li session_hhhh +.Bl -tag -width ".Va session_hhhh" +.It Va session_hhhh Session 0xhhhh data packets to the upper protocol layers -.It Li upper +.It Va upper Same as session_hhhh, but for single session with configurable cid (legacy) -.It Li lower +.It Va lower Connection to the lower protocol layers .El .Sh CONTROL MESSAGES This node type supports the generic control messages, plus the following: -.Bl -tag -width indent -.It Dv NGM_PPTPGRE_SET_CONFIG +.Bl -tag -width foo +.It Dv NGM_PPTPGRE_SET_CONFIG Pq Ic setconfig This command resets and configures hook for a session. If corresponding session_hhhh hook is not connected, upper hook will be configured. This command takes a @@ -95,7 +94,7 @@ as an argument: struct ng_pptpgre_conf { u_char enabled; /* enables traffic flow */ u_char enableDelayedAck; /* enables delayed acks */ - u_char enableAlwaysAck; /* always send ack with data */ + u_char enableAlwaysAck; /* always include ack with data */ u_char enableWindowing; /* enable windowing algorithm */ uint16_t cid; /* my call id */ uint16_t peerCid; /* peer call id */ @@ -124,16 +123,16 @@ The windowing mechanism is a design error in the PPTP protocol; L2TP, the successor to PPTP, removes it. .Pp The remaining fields are as supplied by the PPTP virtual call setup process. -.It Dv NGM_PPTPGRE_GET_CONFIG +.It Dv NGM_PPTPGRE_GET_CONFIG Pq Ic getconfig Takes two byte argument as cid and returns the current configuration as a .Vt "struct ng_pptpgre_conf" . -.It Dv NGM_PPTPGRE_GET_STATS +.It Dv NGM_PPTPGRE_GET_STATS Pq Ic getstats This command returns a .Vt "struct ng_pptpgre_stats" containing various node statistics. -.It Dv NGM_PPTPGRE_CLR_STATS +.It Dv NGM_PPTPGRE_CLR_STATS Pq Ic clrstats This command resets the node statistics. -.It Dv NGM_PPTPGRE_GETCLR_STATS +.It Dv NGM_PPTPGRE_GETCLR_STATS Pq Ic getclrstats This command atomically gets and resets the node statistics, returning a .Vt "struct ng_pptpgre_stats" . .El diff --git a/share/man/man4/ng_pred1.4 b/share/man/man4/ng_pred1.4 index a8c8c5e06d17..fed3fdca8d04 100644 --- a/share/man/man4/ng_pred1.4 +++ b/share/man/man4/ng_pred1.4 @@ -54,7 +54,7 @@ node type hook of the same name. .Sh HOOKS This node type supports the following hooks: .Pp -.Bl -tag -compact -width decomp +.Bl -tag -compact -width ".Va decomp" .It Va comp Connection to .Xr ng_ppp 4 @@ -74,7 +74,7 @@ specifying node's operation mode. .Sh CONTROL MESSAGES This node type supports the generic control messages, plus the following: .Bl -tag -width foo -.It Dv NGM_PRED1_CONFIG Pq Li config +.It Dv NGM_PRED1_CONFIG Pq Ic config This command resets and configures the node for a session (i.e., for compression or decompression). This command takes a @@ -88,7 +88,7 @@ struct ng_pred1_config { The .Ft enable field enables traffic flow through the node. -.It Dv NGM_PRED1_RESETREQ Pq Li resetreq +.It Dv NGM_PRED1_RESETREQ Pq Ic resetreq This message contains no arguments, and is bi-directional. If an error is detected during decompression, this message is sent by the node to the originator of the @@ -100,7 +100,7 @@ This message may also be received by this node type when a CCP Reset-Request or Reset-Ack is received by the local PPP entity. The node will respond by flushing its compression state so the sides can resynchronize. -.It Dv NGM_PRED1_GET_STATS Pq Li getstats +.It Dv NGM_PRED1_GET_STATS Pq Ic getstats This control message obtains statistics for a given hook. The statistics are returned in .Vt "struct ng_pred1_stats" : @@ -114,9 +114,9 @@ struct ng_pred1_stats { uint64_t Errors; }; .Ed -.It Dv NGM_PRED1_CLR_STATS Pq Li clrstats +.It Dv NGM_PRED1_CLR_STATS Pq Ic clrstats This control message clears statistics for a given hook. -.It Dv NGM_PRED1_GETCLR_STATS Pq Li getclrstats +.It Dv NGM_PRED1_GETCLR_STATS Pq Ic getclrstats This control message obtains and clears statistics for a given hook. .El .Sh SHUTDOWN diff --git a/share/man/man4/ng_rfc1490.4 b/share/man/man4/ng_rfc1490.4 index 472b30871c47..de45fb7dab1e 100644 --- a/share/man/man4/ng_rfc1490.4 +++ b/share/man/man4/ng_rfc1490.4 @@ -78,20 +78,20 @@ hook of an node. .Sh HOOKS This node type supports the following hooks: -.Bl -tag -width foobarbazum -.It Dv downstream +.Bl -tag -width ".Va downstream" +.It Va downstream Connects to the RFC 1490 peer entity. -.It Dv ethernet +.It Va ethernet Transmits and receives bridged raw Ethernet frames, without a checksum. -.It Dv inet +.It Va inet Transmits and receives raw IP frames. -.It Dv ppp +.It Va ppp Transmits and receives PPP frames. .El .Sh CONTROL MESSAGES This node type supports the generic control messages, plus the following: -.Bl -tag -width indent -.It Dv NGM_RFC1490_SETENCAP +.Bl -tag -width foo +.It Dv NGM_RFC1490_SET_ENCAP Pq Ic setencap This command sets encapsulation method for the node. The desired method must be passed as a string message argument, and must be one of the following supported encapsulation modes: @@ -105,7 +105,7 @@ Also conforms to RFC1490/2427. IP packets are sent and received using proprietary Cisco encapsulation method. .El -.It Dv NGM_RFC1490_GETENCAP +.It Dv NGM_RFC1490_GET_ENCAP Pq Ic getencap This command returns current encapsulation method on the node. .El .Sh SHUTDOWN diff --git a/share/man/man4/ng_source.4 b/share/man/man4/ng_source.4 index 7c55751cb93a..5205bc41e15d 100644 --- a/share/man/man4/ng_source.4 +++ b/share/man/man4/ng_source.4 @@ -111,10 +111,10 @@ This node type supports the generic control messages as well as the following, which must be sent with the .Dv NGM_SOURCE_COOKIE attached. -.Bl -tag -width indent +.Bl -tag -width foo .It Dv NGM_SOURCE_GET_STATS Pq Ic getstats Returns a structure containing the following fields: -.Bl -tag -width indent +.Bl -tag -width ".Va elapsedTime" .It Va outOctets The number of octets/bytes sent out the .Va output @@ -185,7 +185,7 @@ This message specifies that a timestamp (in the format of a .Vt "struct timeval" ) should be inserted in the transmitted packets. This message requires a structure containing the following fields: -.Bl -tag -width indent +.Bl -tag -width ".Va offset" .It Va offset The offset from the beginning of the packet at which the timestamp is to be inserted. @@ -200,7 +200,7 @@ This message specifies that a counter should be embedded in transmitted packets. Up to four counters may be independently configured. This message requires a structure containing the following fields: -.Bl -tag -width indent +.Bl -tag -width ".Va increment" .It Va offset The offset from the beginning of the packet at which the counter is to be inserted. diff --git a/share/man/man4/ng_split.4 b/share/man/man4/ng_split.4 index 9b74863a6641..4062ca25fbf2 100644 --- a/share/man/man4/ng_split.4 +++ b/share/man/man4/ng_split.4 @@ -49,17 +49,17 @@ node type is used to split a bidirectional stream of packets into two separate unidirectional streams of packets. .Sh HOOKS This node type supports the following three hooks: -.Bl -tag -width foobar -.It Dv in +.Bl -tag -width ".Va mixed" +.It Va in Packets received on .Em in are forwarded to .Em mixed . -.It Dv out +.It Va out Packets received on .Em out will be discarded as illegal. -.It Dv mixed +.It Va mixed Packets received on .Em mixed are forwarded to diff --git a/share/man/man4/ng_sppp.4 b/share/man/man4/ng_sppp.4 index 49f8a4c27ae9..d23268f7f14d 100644 --- a/share/man/man4/ng_sppp.4 +++ b/share/man/man4/ng_sppp.4 @@ -99,8 +99,8 @@ The connection to the synchronous line. .El .Sh CONTROL MESSAGES This node type supports the generic control messages, plus the following: -.Bl -tag -width indent -.It Dv NGM_IFACE_GET_IFNAME +.Bl -tag -width foo +.It Dv NGM_SPPP_GET_IFNAME Pq Ic getifname Returns the name of the associated interface as a .Dv NUL Ns -terminated .Tn ASCII diff --git a/share/man/man4/ng_sscfu.4 b/share/man/man4/ng_sscfu.4 index 0679d5805621..c44c1f430958 100644 --- a/share/man/man4/ng_sscfu.4 +++ b/share/man/man4/ng_sscfu.4 @@ -123,8 +123,8 @@ reset. The .Nm sscfu node understands the generic messages plus the following: -.Bl -tag -width indent -.It Dv NGM_SSCFU_GETDEFPARAM +.Bl -tag -width foo +.It Dv NGM_SSCFU_GETDEFPARAM Pq Ic getdefparam This message returns a .Vt sscop_param structure, which contains the default parameters for the SSCOP at the @@ -132,22 +132,22 @@ UNI. This structure should be used for a .Dv NGM_SSCOP_SETPARAM message to the SSCOP node below the SSCF. -.It Dv NGM_SSCFU_ENABLE +.It Dv NGM_SSCFU_ENABLE Pq Ic enable This message creates the actual SSCF instance and initializes it. Until this is done, parameters may neither be retrieved nor set, and all messages received on any hook are discarded. -.It Dv NGM_SSCFU_DISABLE +.It Dv NGM_SSCFU_DISABLE Pq Ic disable Destroy the SSCF instance. After this, all messages on any hooks are discarded. -.It Dv NGM_SSCFU_GETDEBUG +.It Dv NGM_SSCFU_GETDEBUG Pq Ic getdebug Retrieve the debugging flags in a .Vt uint32_t . -.It Dv NGM_SSCFU_SETDEBUG +.It Dv NGM_SSCFU_SETDEBUG Pq Ic setdebug Set debugging flags. The argument must be a .Vt uint32_t . -.It Dv NGM_SSCFU_GETSTATE +.It Dv NGM_SSCFU_GETSTATE Pq Ic getstate Retrieve the current state of the SSCFU instance in a .Vt uint32_t . If the node has not been enabled, 0 is returned. diff --git a/share/man/man4/ng_sscop.4 b/share/man/man4/ng_sscop.4 index 0c6f0d4564b9..5496a379b946 100644 --- a/share/man/man4/ng_sscop.4 +++ b/share/man/man4/ng_sscop.4 @@ -204,8 +204,8 @@ struct sscop_merr { The .Nm sscop node understands the generic control messages, plus the following: -.Bl -tag -width indent -.It Dv NGM_SSCOP_SETPARAM +.Bl -tag -width foo +.It Dv NGM_SSCOP_SETPARAM Pq Ic setparam Sets operational parameters of the SSCOP instance and takes the following structure: .Bd -literal @@ -312,28 +312,28 @@ but that could not be set and is an .Xr errno 2 code describing why the parameter could not be set. -.It Dv NGM_SSCOP_GETPARAM +.It Dv NGM_SSCOP_GETPARAM Pq Ic getparam This message returns the current operational parameters of the SSCOP instance in a .Vt sscop_param structure. -.It Dv NGM_SSCOP_ENABLE +.It Dv NGM_SSCOP_ENABLE Pq Ic enable This message creates the actual SSCOP instance and initializes it. Until this is done, parameters may neither be retrieved nor set, and all messages received on any hook are discarded. -.It Dv NGM_SSCOP_DISABLE +.It Dv NGM_SSCOP_DISABLE Pq Ic disable Destroy the SSCOP instance. After this, all messages on any hooks are discarded. -.It Dv NGM_SSCOP_SETDEBUG +.It Dv NGM_SSCOP_SETDEBUG Pq Ic setdebug Set debugging flags. The argument is a .Vt uint32_t . -.It Dv NGM_SSCOP_GETDEBUG +.It Dv NGM_SSCOP_GETDEBUG Pq Ic getdebug Retrieve the actual debugging flags. Needs no arguments and responds with a .Vt uint32_t . -.It Dv NGM_SSCOP_GETSTATE +.It Dv NGM_SSCOP_GETSTATE Pq Ic getstate Responds with the current state of the SSCOP instance in a .Vt uint32_t . If the node is not enabled, the retrieved state is 0. @@ -352,7 +352,7 @@ state of the protocol. At the upper layer interface, the .Nm sscop node handles three types of flow control messages: -.Bl -tag -width indent +.Bl -tag -width foo .It Dv NGM_HIGH_WATER_PASSED If this message is received, the SSCOP stops moving the receive window. Each time a data message is handed over to the upper layer, the receive diff --git a/share/man/man4/ng_tag.4 b/share/man/man4/ng_tag.4 index 98cfa24fae6f..e025a2669575 100644 --- a/share/man/man4/ng_tag.4 +++ b/share/man/man4/ng_tag.4 @@ -112,8 +112,8 @@ configure a hook with a structure pointing to hooks which do not exist yet. The safe way is to create all hooks first, then begin to configure them. .Sh CONTROL MESSAGES This node type supports the generic control messages, plus the following: -.Bl -tag -width indent -.It Dv NGM_TAG_SET_HOOKIN +.Bl -tag -width foo +.It Dv NGM_TAG_SET_HOOKIN Pq Ic sethookin This command sets tag values which will be searched in the tag list of incoming packets on a hook. The following structure must be supplied as an argument: @@ -149,14 +149,14 @@ respectively. If .Va strip flag is non-zero, then found tag is deleted from list of packet tags. -.It Dv NGM_TAG_GET_HOOKIN +.It Dv NGM_TAG_GET_HOOKIN Pq Ic gethookin This command takes an .Tn ASCII string argument, the hook name, and returns the corresponding .Vt "struct ng_tag_hookin" as shown above. -.It Dv NGM_TAG_SET_HOOKOUT +.It Dv NGM_TAG_SET_HOOKOUT Pq Ic sethookout This command sets tags values which will be applied to outgoing packets. The following structure must be supplied as an argument: @@ -175,25 +175,25 @@ The hook to be updated is specified in Other variables mean basically the same as in .Vt "struct ng_tag_hookin" shown above, except used for setting values in a new tag. -.It Dv NGM_TAG_GET_HOOKOUT +.It Dv NGM_TAG_GET_HOOKOUT Pq Ic gethookout This command takes an .Tn ASCII string argument, the hook name, and returns the corresponding .Vt "struct ng_tag_hookout" as shown above. -.It Dv NGM_TAG_GET_STATS +.It Dv NGM_TAG_GET_STATS Pq Ic getstats This command takes an .Tn ASCII string argument, the hook name, and returns the statistics associated with the hook as a .Vt "struct ng_tag_hookstat" . -.It Dv NGM_TAG_CLR_STATS +.It Dv NGM_TAG_CLR_STATS Pq Ic clrstats This command takes an .Tn ASCII string argument, the hook name, and clears the statistics associated with the hook. -.It Dv NGM_TAG_GETCLR_STATS +.It Dv NGM_TAG_GETCLR_STATS Pq Ic getclrstats This command is identical to .Dv NGM_TAG_GET_STATS , except that the statistics are also atomically cleared. diff --git a/share/man/man4/ng_tcpmss.4 b/share/man/man4/ng_tcpmss.4 index fc610b6d6695..240d97579c19 100644 --- a/share/man/man4/ng_tcpmss.4 +++ b/share/man/man4/ng_tcpmss.4 @@ -45,8 +45,8 @@ The control message is used to configure a hook. .Sh CONTROL MESSAGES This node type supports the generic control messages, plus the following. -.Bl -tag -width indent -.It Dv NGM_TCPMSS_CONFIG Pq Li config +.Bl -tag -width foo +.It Dv NGM_TCPMSS_CONFIG Pq Ic config This control message configures node to do given MSS adjusting on a particular hook. It requires the @@ -69,7 +69,7 @@ if it exceeds .Va maxMSS . After that, packets would be sent to hook .Va outHook . -.It Dv NGM_TCPMSS_GET_STATS Pq Li getstats +.It Dv NGM_TCPMSS_GET_STATS Pq Ic getstats This control message obtains statistics for a given hook. The statistics are returned in .Vt "struct ng_tcpmss_hookstat" : @@ -82,9 +82,9 @@ struct ng_tcpmss_hookstat { uint64_t FixedPkts; /* changed packets */ }; .Ed -.It Dv NGM_TCPMSS_CLR_STATS Pq Li clrstats +.It Dv NGM_TCPMSS_CLR_STATS Pq Ic clrstats This control message clears statistics for a given hook. -.It Dv NGM_TCPMSS_GETCLR_STATS Pq Li getclrstats +.It Dv NGM_TCPMSS_GETCLR_STATS Pq Ic getclrstats This control message obtains and clears statistics for a given hook. .El .Sh EXAMPLES diff --git a/share/man/man4/ng_tee.4 b/share/man/man4/ng_tee.4 index 84801b7ad38d..e86209df8429 100644 --- a/share/man/man4/ng_tee.4 +++ b/share/man/man4/ng_tee.4 @@ -88,23 +88,23 @@ and respectively. .Sh HOOKS This node type supports the following hooks: -.Bl -tag -width foobarbarfoo -.It Dv right +.Bl -tag -width ".Va left2right" +.It Va right The connection to the node on the right. -.It Dv left +.It Va left The connection to the node on the left. -.It Dv right2left +.It Va right2left Tap for right to left traffic. -.It Dv left2right +.It Va left2right Tap for left to right traffic. .El .Sh CONTROL MESSAGES This node type supports the generic control messages, plus the following. .Bl -tag -width foo -.It Dv NGM_TEE_GET_STATS +.It Dv NGM_TEE_GET_STATS Pq Ic getstats Get statistics, returned as a .Dv "struct ng_tee_stats" . -.It Dv NGM_TEE_CLR_STATS +.It Dv NGM_TEE_CLR_STATS Pq Ic clrstats Clear statistics. .El .Sh SHUTDOWN diff --git a/share/man/man4/ng_tty.4 b/share/man/man4/ng_tty.4 index dc73e58a2471..3add57cdc2cb 100644 --- a/share/man/man4/ng_tty.4 +++ b/share/man/man4/ng_tty.4 @@ -80,8 +80,8 @@ type node. The hot character has no effect on the transmission of data. .Sh HOOKS This node type supports the following hooks: -.Bl -tag -width foobar -.It Dv hook +.Bl -tag -width ".Va hook" +.It Va hook .Xr tty 4 serial data contained in .Dv mbuf diff --git a/share/man/man4/ng_ubt.4 b/share/man/man4/ng_ubt.4 index ebb454d92a37..6a39ddd9424e 100644 --- a/share/man/man4/ng_ubt.4 +++ b/share/man/man4/ng_ubt.4 @@ -76,8 +76,8 @@ TDK Bluetooth USB adapter .El .Sh HOOKS This node type supports the following hooks: -.Bl -tag -width indent -.It Dv hook +.Bl -tag -width ".Va hook" +.It Va hook single HCI frame contained in a single .Vt mbuf structure. @@ -85,22 +85,22 @@ structure. .Sh CONTROL MESSAGES This node type supports the generic control messages, plus the following: .Bl -tag -width indent -.It Dv NGM_UBT_NODE_GET_DEBUG +.It Dv NGM_UBT_NODE_GET_DEBUG Pq Ic get_debug Returns an integer containing the current debug level for the node. -.It Dv NGM_UBT_NODE_SET_DEBUG +.It Dv NGM_UBT_NODE_SET_DEBUG Pq Ic set_debug This command takes an integer argument and sets the current debug level for the node. -.It Dv NGM_UBT_NODE_GET_QLEN +.It Dv NGM_UBT_NODE_GET_QLEN Pq Ic get_qlen This command takes a parameter that specifies the queue number and returns the current maximal length of the queue for the node. -.It Dv NGM_UBT_NODE_SET_QLEN +.It Dv NGM_UBT_NODE_SET_QLEN Pq Ic set_qlen This command takes two parameters that specify the queue number and the maximum length of the queue and sets the maximal length of the queue for the node. -.It Dv NGM_UBT_NODE_GET_STAT +.It Dv NGM_UBT_NODE_GET_STAT Pq Ic get_stat Returns various statistic information for the node, such as: number of bytes (frames) sent, number of bytes (frames) received and number of input (output) errors. -.It Dv NGM_UBT_NODE_RESET_STAT +.It Dv NGM_UBT_NODE_RESET_STAT Pq Ic reset_stat Reset all statistic counters to zero. .El .Sh SHUTDOWN diff --git a/share/man/man4/ng_uni.4 b/share/man/man4/ng_uni.4 index f6eb05fdbe50..a2e3c4582205 100644 --- a/share/man/man4/ng_uni.4 +++ b/share/man/man4/ng_uni.4 @@ -212,7 +212,7 @@ enum uni_sig { .Pp The meaning of most of the signals can be deduced from the ITU-T SDLs. A number of signals, however, is unique to this implementation: -.Bl -tag -width indent +.Bl -tag -width foo .It Dv UNIAPI_ERROR This is the error response, mentioned earlier. It carries an error code or @@ -245,8 +245,8 @@ Each of the signals is followed by a fixed size structure defined in The .Nm uni node understands the standard control messages, plus the following: -.Bl -tag -width indent -.It Dv NGM_UNI_SETDEBUG +.Bl -tag -width foo +.It Dv NGM_UNI_SETDEBUG Pq Ic setdebug Set debugging facility levels. The UNI stack defines a number of debugging facilities, each one associated with a debugging level. @@ -258,12 +258,12 @@ struct ngm_uni_debug { uint32_t level[UNI_MAXFACILITY]; }; .Ed -.It Dv NGM_UNI_SETDEBUG +.It Dv NGM_UNI_GETDEBUG Pq Ic getdebug Get debugging facility levels. This returns an .Vt ngm_uni_debug structure. -.It Dv NGM_UNI_GET_CONFIG +.It Dv NGM_UNI_GET_CONFIG Pq Ic get_config Retrieve the current configuration of the UNI instance. This message returns a .Vt uni_config @@ -326,7 +326,7 @@ All timer values are given in milliseconds. Note, however, that the actual resolution of the timers depend on system configuration (see .Xr timeout 9 ) . -.It Dv NGM_UNI_SET_CONFIG +.It Dv NGM_UNI_SET_CONFIG Pq Ic set_config Change the UNI configuration. This takes a .Bd -literal @@ -386,10 +386,10 @@ the definitions from and .Vt "enum uni_option" should be used. -.It Dv NGM_UNI_ENABLE +.It Dv NGM_UNI_ENABLE Pq Ic enable Create the UNI instance and enable processing. Before the UNI is enabled parameters cannot be retrieved or set. -.It Dv NGM_UNI_DISABLE +.It Dv NGM_UNI_DISABLE Pq Ic disable Destroy the UNI instance and free all resources. Note, that connections are not released. .El diff --git a/share/man/man4/ng_vjc.4 b/share/man/man4/ng_vjc.4 index 714aa7e27323..83f026947670 100644 --- a/share/man/man4/ng_vjc.4 +++ b/share/man/man4/ng_vjc.4 @@ -103,20 +103,20 @@ and hooks, respectively. .Sh HOOKS This node type supports the following hooks: -.Bl -tag -width foobarbazi -.It Dv ip +.Bl -tag -width ".Va vjuncomp" +.It Va ip Upstream (uncompressed) IP packets. -.It Dv vjcomp +.It Va vjcomp Downstream compressed TCP packets. -.It Dv vjuncomp +.It Va vjuncomp Downstream uncompressed TCP packets. -.It Dv vjip +.It Va vjip Downstream uncompressed IP packets. .El .Sh CONTROL MESSAGES This node type supports the generic control messages, plus the following: .Bl -tag -width foo -.It Dv NGM_VJC_SET_CONFIG +.It Dv NGM_VJC_SET_CONFIG Pq Ic setconfig This command resets the compression state and configures it according to the supplied .Dv "struct ngm_vjc_config" @@ -169,12 +169,12 @@ either (a) it is not possible for an outgoing frame to be lost, or reported to the peer's decompression engine (see .Dv NGM_VJC_RECV_ERROR below). -.It Dv NGM_VJC_GET_STATE +.It Dv NGM_VJC_GET_STATE Pq Ic getstate This command returns the node's current state described by the .Dv "struct slcompress" structure, which is defined in .In net/slcompress.h . -.It Dv NGM_VJC_CLR_STATS +.It Dv NGM_VJC_CLR_STATS Pq Ic clrstats Clears the node statistics counters. Statistics are also cleared whenever the .Dv enableComp @@ -183,7 +183,7 @@ or fields are changed from zero to one by a .Dv NGM_VJC_SET_CONFIG control message. -.It Dv NGM_VJC_RECV_ERROR +.It Dv NGM_VJC_RECV_ERROR Pq Ic recverror When the peer has CID header field compression enabled, this message must be sent to the local .Nm vjc diff --git a/share/man/man4/ng_vlan.4 b/share/man/man4/ng_vlan.4 index bf673cf3bd7f..1efacccc8088 100644 --- a/share/man/man4/ng_vlan.4 +++ b/share/man/man4/ng_vlan.4 @@ -78,7 +78,7 @@ hooks is tagged accordingly and sent out the hook. .Sh HOOKS This node type supports the following hooks: -.Bl -tag -width ".Va downstream" +.Bl -tag -width "Aq Em any valid name" .It Va downstream Typically this hook would be connected to a .Xr ng_ether 4 @@ -102,12 +102,12 @@ hook. .El .Sh CONTROL MESSAGES This node type supports the generic control messages, plus the following: -.Bl -tag -width indent -.It Dv NGM_VLAN_ADD_FILTER Pq Li addfilter +.Bl -tag -width foo +.It Dv NGM_VLAN_ADD_FILTER Pq Ic addfilter Associates a hook with the tag. -.It Dv NGM_VLAN_DEL_FILTER Pq Li delfilter +.It Dv NGM_VLAN_DEL_FILTER Pq Ic delfilter Disassociates a hook from the tag. -.It Dv NGM_VLAN_GET_TABLE Pq Li gettable +.It Dv NGM_VLAN_GET_TABLE Pq Ic gettable Returns a table of all hook/tag associations. .El .Sh EXAMPLES |