[Midnightbsd-cvs] src [7819] trunk/share/man/man4/ng_netflow.4: cleanup man page
laffer1 at midnightbsd.org
laffer1 at midnightbsd.org
Tue Sep 6 19:30:11 EDT 2016
Revision: 7819
http://svnweb.midnightbsd.org/src/?rev=7819
Author: laffer1
Date: 2016-09-06 19:30:10 -0400 (Tue, 06 Sep 2016)
Log Message:
-----------
cleanup man page
Modified Paths:
--------------
trunk/share/man/man4/ng_netflow.4
Modified: trunk/share/man/man4/ng_netflow.4
===================================================================
--- trunk/share/man/man4/ng_netflow.4 2016-09-06 23:29:20 UTC (rev 7818)
+++ trunk/share/man/man4/ng_netflow.4 2016-09-06 23:30:10 UTC (rev 7819)
@@ -24,7 +24,7 @@
.\"
.\" $MidnightBSD$
.\"
-.Dd March 2, 2011
+.Dd Nov 2, 2012
.Dt NG_NETFLOW 4
.Os
.Sh NAME
@@ -101,15 +101,15 @@
.Sh CONTROL MESSAGES
This node type supports the generic control messages, plus the following:
.Bl -tag -width indent
-.It Dv NGM_NETFLOW_INFO
+.It Dv NGM_NETFLOW_INFO Pq Ic info
Returns some node statistics and the current timeout values in a
.Vt "struct ng_netflow_info" .
-.It Dv NGM_NETFLOW_IFINFO
+.It Dv NGM_NETFLOW_IFINFO Pq Ic ifinfo
Returns information about the
.Va iface Ns Ar N
hook.
The hook number is passed as an argument.
-.It Dv NGM_NETFLOW_SETDLT
+.It Dv NGM_NETFLOW_SETDLT Pq Ic setdlt
Sets data link type on the
.Va iface Ns Ar N
hook.
@@ -119,7 +119,7 @@
as an argument:
.Bd -literal -offset 4n
struct ng_netflow_setdlt {
- uint16_t iface; /* which iface to operate on */
+ uint16_t iface; /* which iface dlt change */
uint8_t dlt; /* DLT_XXX from bpf.h */
};
.Ed
@@ -128,7 +128,7 @@
.Va iface Ns Ar N
hook must already be connected, otherwise message send operation will
return an error.
-.It Dv NGM_NETFLOW_SETIFINDEX
+.It Dv NGM_NETFLOW_SETIFINDEX Pq Ic setifindex
In some cases,
.Nm
may be unable to determine the input interface index of a packet.
@@ -148,8 +148,8 @@
as an argument:
.Bd -literal -offset 4n
struct ng_netflow_setifindex {
- u_int16_t iface; /* which iface to operate on */
- u_int16_t index; /* new index */
+ uint16_t iface; /* which iface index change */
+ uint16_t index; /* new index */
};
.Ed
.Pp
@@ -157,7 +157,7 @@
.Va iface Ns Ar N
hook must already be connected, otherwise the message
send operation will return an error.
-.It Dv NGM_NETFLOW_SETTIMEOUTS
+.It Dv NGM_NETFLOW_SETTIMEOUTS Pq Ic settimeouts
Sets values in seconds for NetFlow active/inactive timeouts.
This message requires
.Vt "struct ng_netflow_settimeouts"
@@ -164,11 +164,11 @@
as an argument:
.Bd -literal -offset 4n
struct ng_netflow_settimeouts {
- uint32_t inactive_timeout;
- uint32_t active_timeout;
+ uint32_t inactive_timeout; /* flow inactive timeout */
+ uint32_t active_timeout; /* flow active timeout */
};
.Ed
-.It Dv NGM_NETFLOW_SETCONFIG
+.It Dv NGM_NETFLOW_SETCONFIG Pq Ic setconfig
Sets configuration for the specified interface.
This message requires
.Vt "struct ng_netflow_setconfig"
@@ -175,8 +175,8 @@
as an argument:
.Bd -literal -offset 4n
struct ng_netflow_setconfig {
- u_int16_t iface;
- u_int32_t conf;
+ uint16_t iface; /* which iface config change */
+ uint32_t conf; /* new config */
#define NG_NETFLOW_CONF_INGRESS 1
#define NG_NETFLOW_CONF_EGRESS 2
#define NG_NETFLOW_CONF_ONCE 4
@@ -193,7 +193,7 @@
if it several times passes via exactly this netflow node. Last two options are
important to avoid duplicate accounting when both ingress and egress NetFlow
are enabled.
-.It Dv NGM_NETFLOW_SETTEMPLATE
+.It Dv NGM_NETFLOW_SETTEMPLATE Pq Ic settemplate
Sets various timeouts to announce data flow templates
(NetFlow v9-specific). This message requires
.Vt "struct ng_netflow_settemplate"
@@ -200,8 +200,8 @@
as an argument:
.Bd -literal -offset 4n
struct ng_netflow_settemplate {
- uint16_t time;
- uint16_t packets;
+ uint16_t time; /* max time between announce */
+ uint16_t packets; /* max packets between announce */
};
.Ed
.Pp
@@ -208,14 +208,14 @@
Value of time field represents time in seconds to re-announce data templates.
Value of packets field represents maximum packets count between
re-announcing data templates.
-.It Dv NGM_NETFLOW_SETMTU
+.It Dv NGM_NETFLOW_SETMTU Pq Ic setmtu
Sets export interface MTU to build packets of specified size (NetFlow v9-specific).
This message requires
.Vt "struct ng_netflow_setmtu"
as an argument:
.Bd -literal -offset 4n
-struct ng_netflow_settemtu {
- uint16_t mtu;
+struct ng_netflow_setemtu {
+ uint16_t mtu; /* MTU for packet */
};
.Ed
.Pp
@@ -229,38 +229,16 @@
See also
.Sx BUGS
section.
-.It Dv NGM_NETFLOW_V9INFO
+.It Dv NGM_NETFLOW_V9INFO Pq Ic v9info
Returns some NetFlow v9 related values in a
-.Vt "struct ng_netflow_v9info" .
+.Bd -literal -offset 4n
+struct ng_netflow_v9info {
+ uint16_t templ_packets; /* v9 template packets */
+ uint16_t templ_time; /* v9 template time */
+ uint16_t mtu; /* v9 MTU */
+};
+.Ed
.El
-.Sh ASCII CONTROL MESSAGES
-Most binary control messages have an
-.Tn ASCII
-equivalent.
-The supported
-.Tn ASCII
-commands are:
-.Pp
-.Bl -tag -width ".Dv NGM_NETFLOW_SETTIMEOUTS" -compact
-.It Dv NGM_NETFLOW_INFO
-.Qq Li info
-.It Dv NGM_NETFLOW_IFINFO
-.Qq Li "ifinfo %u"
-.It Dv NGM_NETFLOW_SETDLT
-.Qq Li "setdlt { iface = %u dlt = %u }"
-.It Dv NGM_NETFLOW_SETIFINDEX
-.Qq Li "setifindex { iface = %u index = %u }"
-.It Dv NGM_NETFLOW_SETTIMEOUTS
-.Qq Li "settimeouts { inactive = %u active = %u }"
-.It Dv NGM_NETFLOW_SETCONFIG
-.Qq Li "setconfig { iface = %u conf = %u }"
-.It Dv NGM_NETFLOW_SETTEMPLATE
-.Qq Li "settemplate { time = %u packets = %u }"
-.It Dv NGM_NETFLOW_SETMTU
-.Qq Li "setmtu { mtu = %u }"
-.It Dv NGM_NETFLOW_V9INFO
-.Qq Li v9info
-.El
.Sh SHUTDOWN
This node shuts down upon receipt of a
.Dv NGM_SHUTDOWN
More information about the Midnightbsd-cvs
mailing list