Date: Tue, 13 Nov 2012 20:41:36 +0000 (UTC) From: Joel Dahl <joel@FreeBSD.org> To: src-committers@freebsd.org, svn-src-all@freebsd.org, svn-src-head@freebsd.org Subject: svn commit: r242997 - head/share/man/man4 Message-ID: <201211132041.qADKfa5Q017107@svn.freebsd.org>
next in thread | raw e-mail | index | archive | help
Author: joel (doc committer) Date: Tue Nov 13 20:41:36 2012 New Revision: 242997 URL: http://svnweb.freebsd.org/changeset/base/242997 Log: Updates for netgraph node manual pages. Discussed with: glebius Submitted by: Mamontov Roman <mr.xanto@gmail.com> Modified: head/share/man/man4/ng_UI.4 head/share/man/man4/ng_async.4 head/share/man/man4/ng_atmllc.4 head/share/man/man4/ng_bluetooth.4 head/share/man/man4/ng_bpf.4 head/share/man/man4/ng_bridge.4 head/share/man/man4/ng_bt3c.4 head/share/man/man4/ng_btsocket.4 head/share/man/man4/ng_car.4 head/share/man/man4/ng_ccatm.4 head/share/man/man4/ng_cisco.4 head/share/man/man4/ng_deflate.4 head/share/man/man4/ng_eiface.4 head/share/man/man4/ng_etf.4 head/share/man/man4/ng_ether.4 head/share/man/man4/ng_fec.4 head/share/man/man4/ng_frame_relay.4 head/share/man/man4/ng_gif.4 head/share/man/man4/ng_gif_demux.4 head/share/man/man4/ng_h4.4 head/share/man/man4/ng_hci.4 head/share/man/man4/ng_hole.4 head/share/man/man4/ng_hub.4 head/share/man/man4/ng_iface.4 head/share/man/man4/ng_ksocket.4 head/share/man/man4/ng_l2cap.4 head/share/man/man4/ng_l2tp.4 head/share/man/man4/ng_lmi.4 head/share/man/man4/ng_mppc.4 head/share/man/man4/ng_nat.4 head/share/man/man4/ng_netflow.4 head/share/man/man4/ng_one2many.4 head/share/man/man4/ng_patch.4 head/share/man/man4/ng_ppp.4 head/share/man/man4/ng_pppoe.4 head/share/man/man4/ng_pptpgre.4 head/share/man/man4/ng_pred1.4 head/share/man/man4/ng_rfc1490.4 head/share/man/man4/ng_source.4 head/share/man/man4/ng_split.4 head/share/man/man4/ng_sppp.4 head/share/man/man4/ng_sscfu.4 head/share/man/man4/ng_sscop.4 head/share/man/man4/ng_tag.4 head/share/man/man4/ng_tcpmss.4 head/share/man/man4/ng_tee.4 head/share/man/man4/ng_tty.4 head/share/man/man4/ng_ubt.4 head/share/man/man4/ng_uni.4 head/share/man/man4/ng_vjc.4 head/share/man/man4/ng_vlan.4 Modified: head/share/man/man4/ng_UI.4 ============================================================================== --- head/share/man/man4/ng_UI.4 Tue Nov 13 20:38:55 2012 (r242996) +++ head/share/man/man4/ng_UI.4 Tue Nov 13 20:41:36 2012 (r242997) @@ -65,12 +65,12 @@ will have a 0x03 byte prepended to them 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. Modified: head/share/man/man4/ng_async.4 ============================================================================== --- head/share/man/man4/ng_async.4 Tue Nov 13 20:38:55 2012 (r242996) +++ head/share/man/man4/ng_async.4 Tue Nov 13 20:41:36 2012 (r242997) @@ -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 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 Modified: head/share/man/man4/ng_atmllc.4 ============================================================================== --- head/share/man/man4/ng_atmllc.4 Tue Nov 13 20:38:55 2012 (r242996) +++ head/share/man/man4/ng_atmllc.4 Tue Nov 13 20:41:36 2012 (r242997) @@ -60,7 +60,7 @@ encapsulated into a PDU and transmitted 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 Modified: head/share/man/man4/ng_bluetooth.4 ============================================================================== --- head/share/man/man4/ng_bluetooth.4 Tue Nov 13 20:38:55 2012 (r242996) +++ head/share/man/man4/ng_bluetooth.4 Tue Nov 13 20:41:36 2012 (r242997) @@ -43,7 +43,7 @@ All Bluetooth variables can be examined .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. Modified: head/share/man/man4/ng_bpf.4 ============================================================================== --- head/share/man/man4/ng_bpf.4 Tue Nov 13 20:38:55 2012 (r242996) +++ head/share/man/man4/ng_bpf.4 Tue Nov 13 20:41:36 2012 (r242997) @@ -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 ho .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. Modified: head/share/man/man4/ng_bridge.4 ============================================================================== --- head/share/man/man4/ng_bridge.4 Tue Nov 13 20:38:55 2012 (r242996) +++ head/share/man/man4/ng_bridge.4 Tue Nov 13 20:41:36 2012 (r242997) @@ -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 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 Modified: head/share/man/man4/ng_bt3c.4 ============================================================================== --- head/share/man/man4/ng_bt3c.4 Tue Nov 13 20:38:55 2012 (r242996) +++ head/share/man/man4/ng_bt3c.4 Tue Nov 13 20:41:36 2012 (r242997) @@ -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. Modified: head/share/man/man4/ng_btsocket.4 ============================================================================== --- head/share/man/man4/ng_btsocket.4 Tue Nov 13 20:38:55 2012 (r242996) +++ head/share/man/man4/ng_btsocket.4 Tue Nov 13 20:41:36 2012 (r242997) @@ -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 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 test 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. Modified: head/share/man/man4/ng_car.4 ============================================================================== --- head/share/man/man4/ng_car.4 Tue Nov 13 20:38:55 2012 (r242996) +++ head/share/man/man4/ng_car.4 Tue Nov 13 20:41:36 2012 (r242997) @@ -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 .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 Modified: head/share/man/man4/ng_ccatm.4 ============================================================================== --- head/share/man/man4/ng_ccatm.4 Tue Nov 13 20:38:55 2012 (r242996) +++ head/share/man/man4/ng_ccatm.4 Tue Nov 13 20:41:36 2012 (r242997) @@ -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 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 ad 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 ta 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 a 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. Modified: head/share/man/man4/ng_cisco.4 ============================================================================== --- head/share/man/man4/ng_cisco.4 Tue Nov 13 20:38:55 2012 (r242996) +++ head/share/man/man4/ng_cisco.4 Tue Nov 13 20:41:36 2012 (r242997) @@ -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 Modified: head/share/man/man4/ng_deflate.4 ============================================================================== --- head/share/man/man4/ng_deflate.4 Tue Nov 13 20:38:55 2012 (r242996) +++ head/share/man/man4/ng_deflate.4 Tue Nov 13 20:41:36 2012 (r242997) @@ -61,7 +61,7 @@ mode to permit sending uncompressed fram .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 thi 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 Modified: head/share/man/man4/ng_eiface.4 ============================================================================== --- head/share/man/man4/ng_eiface.4 Tue Nov 13 20:38:55 2012 (r242996) +++ head/share/man/man4/ng_eiface.4 Tue Nov 13 20:41:36 2012 (r242997) @@ -63,8 +63,8 @@ Similarly, packets received on the hook 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 Modified: head/share/man/man4/ng_etf.4 ============================================================================== --- head/share/man/man4/ng_etf.4 Tue Nov 13 20:38:55 2012 (r242996) +++ head/share/man/man4/ng_etf.4 Tue Nov 13 20:41:36 2012 (r242997) @@ -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 mes 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 Modified: head/share/man/man4/ng_ether.4 ============================================================================== --- head/share/man/man4/ng_ether.4 Tue Nov 13 20:38:55 2012 (r242996) +++ head/share/man/man4/ng_ether.4 Tue Nov 13 20:41:36 2012 (r242997) @@ -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 devic 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 Modified: head/share/man/man4/ng_fec.4 ============================================================================== --- head/share/man/man4/ng_fec.4 Tue Nov 13 20:38:55 2012 (r242996) +++ head/share/man/man4/ng_fec.4 Tue Nov 13 20:41:36 2012 (r242997) @@ -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 Modified: head/share/man/man4/ng_frame_relay.4 ============================================================================== --- head/share/man/man4/ng_frame_relay.4 Tue Nov 13 20:38:55 2012 (r242996) +++ head/share/man/man4/ng_frame_relay.4 Tue Nov 13 20:41:36 2012 (r242997) @@ -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. Modified: head/share/man/man4/ng_gif.4 ============================================================================== --- head/share/man/man4/ng_gif.4 Tue Nov 13 20:38:55 2012 (r242996) +++ head/share/man/man4/ng_gif.4 Tue Nov 13 20:41:36 2012 (r242997) @@ -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. Modified: head/share/man/man4/ng_gif_demux.4 ============================================================================== --- head/share/man/man4/ng_gif_demux.4 Tue Nov 13 20:38:55 2012 (r242996) +++ head/share/man/man4/ng_gif_demux.4 Tue Nov 13 20:41:36 2012 (r242997) @@ -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 Modified: head/share/man/man4/ng_h4.4 ============================================================================== --- head/share/man/man4/ng_h4.4 Tue Nov 13 20:38:55 2012 (r242996) +++ head/share/man/man4/ng_h4.4 Tue Nov 13 20:41:36 2012 (r242997) @@ -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 Modified: head/share/man/man4/ng_hci.4 ============================================================================== --- head/share/man/man4/ng_hci.4 Tue Nov 13 20:38:55 2012 (r242996) +++ head/share/man/man4/ng_hci.4 Tue Nov 13 20:41:36 2012 (r242997) @@ -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 Modified: head/share/man/man4/ng_hole.4 ============================================================================== --- head/share/man/man4/ng_hole.4 Tue Nov 13 20:38:55 2012 (r242996) +++ head/share/man/man4/ng_hole.4 Tue Nov 13 20:41:36 2012 (r242997) @@ -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. Modified: head/share/man/man4/ng_hub.4 ============================================================================== --- head/share/man/man4/ng_hub.4 Tue Nov 13 20:38:55 2012 (r242996) +++ head/share/man/man4/ng_hub.4 Tue Nov 13 20:41:36 2012 (r242997) @@ -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 *** DIFF OUTPUT TRUNCATED AT 1000 LINES ***
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201211132041.qADKfa5Q017107>