Assorted mdoc(7) fixes.

This commit is contained in:
Ruslan Ermilov 2003-06-01 19:41:49 +00:00
parent 0934f18afb
commit 9be025500d
Notes: svn2git 2020-12-20 02:59:44 +00:00
svn path=/head/; revision=115633
5 changed files with 91 additions and 74 deletions

View file

@ -29,22 +29,29 @@
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.Dd JANUARY 7, 2003
.\"
.Dd January 7, 2003
.Os
.Dt BSDE_GET_RULE 3
.Sh NAME
.Nm bsde_get_rule ,
.Nm bsde_set_rule ,
.Nm bsde_delete_rule
.Nd file system firewall rules list management
.Nd "file system firewall rules list management"
.Sh LIBRARY
.Lb libugidfw
.Sh SYNOPSIS
.In ugidfw.h
.Ft int
.Fn bsde_get_rule "int rulenum" "struct mac_bsdextended_rule *rule" "size_t errlen" "char *errstr"
.Fo bsde_get_rule
.Fa "int rulenum" "struct mac_bsdextended_rule *rule"
.Fa "size_t errlen" "char *errstr"
.Fc
.Ft int
.Fn bsde_set_rule "int rulenum" "struct mac_bsdextended_rule *rule" "size_t errlen" "char *errstr"
.Fo bsde_set_rule
.Fa "int rulenum" "struct mac_bsdextended_rule *rule"
.Fa "size_t errlen" "char *errstr"
.Fc
.Ft int
.Fn bsde_delete_rule "int rulenum" "size_t errlen" "char *errstr"
.Sh DESCRIPTION
@ -59,7 +66,8 @@ If an error occurs,
is filled in with the error string
(up to
.Fa errlen
characters, including the terminating NUL).
characters, including the terminating
.Dv NUL ) .
.Pp
The
.Fn bsde_set_rule
@ -69,7 +77,7 @@ with the specified rule
(in
.Vt "struct mac_bsdextended_rule"
form, either from
.Xr bsde_get_rule 3
.Fn bsde_get_rule
or
.Xr bsde_parse_rule 3 ) .
If an error occurs,
@ -77,7 +85,8 @@ If an error occurs,
is filled with the error string
(up to
.Fa errlen
characters, including the terminating NUL).
characters, including the terminating
.Dv NUL ) .
.Pp
The
.Fn bsde_delete_rule
@ -88,19 +97,16 @@ If an error occurs,
is filled with the error string
(up to
.Fa errlen
characters, including the terminating NUL).
characters, including the terminating
.Dv NUL ) .
.Sh RETURN VALUES
The
.Fn bsde_get_rule ,
.Fn bsde_set_rule ,
and
.Fn bsde_delete_rule
functions return
.Li 0
if successful;
otherwise the value
.Li \&-1
is returned and the value of
functions return 0 if successful;
otherwise the value \-1 is returned and the value of
.Fa *errstr
is filled in as documented in
.Sx DESCRIPTION .
@ -118,5 +124,6 @@ This software was contributed to the
.Fx
Project by Network Associates Labs,
the Security Research Division of Network Associates
Inc. under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"),
Inc. under DARPA/SPAWAR contract N66001-01-C-8035
.Pq Dq CBOSS ,
as part of the DARPA CHATS research program.

View file

@ -29,13 +29,14 @@
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.Dd JANUARY 7, 2003
.\"
.Dd January 7, 2003
.Os
.Dt BSDE_GET_RULE_COUNT 3
.Sh NAME
.Nm bsde_get_rule_count ,
.Nm bsde_get_rule_slots
.Nd file system firewall statistics
.Nd "file system firewall statistics"
.Sh LIBRARY
.Lb libugidfw
.Sh SYNOPSIS
@ -49,6 +50,7 @@ The
.Fn bsde_get_rule_count
and
.Fn bsde_get_rule_slots
functions
return the total number of enforced rules
and the total number of used rule slots, respectively.
If an error occurs,
@ -56,7 +58,8 @@ If an error occurs,
is filled in with the error string
(up to
.Fa errlen
characters, including the terminating NUL).
characters, including the terminating
.Dv NUL ) .
.Sh RETURN VALUES
The
.Fn bsde_get_rule_count
@ -65,9 +68,7 @@ and
functions return
the number of enforced rules and rule slots (respectively)
if successful;
otherwise the value
.Li \&-1
is returned and the value of
otherwise the value \-1 is returned and the value of
.Fa *errstr
is filled in as documented in
.Sx DESCRIPTION .
@ -86,5 +87,6 @@ This software was contributed to the
.Fx
Project by Network Associates Labs,
the Security Research Division of Network Associates
Inc. under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"),
Inc. under DARPA/SPAWAR contract N66001-01-C-8035
.Pq Dq CBOSS ,
as part of the DARPA CHATS research program.

View file

@ -29,26 +29,33 @@
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.Dd JANUARY 7, 2003
.\"
.Dd January 7, 2003
.Os
.Dt BSDE_PARSE_RULE 3
.Sh NAME
.Nm bsde_parse_rule ,
.Nm bsde_parse_rule_string
.Nd parse file system firewall rules
.Nd "parse file system firewall rules"
.Sh LIBRARY
.Lb libugidfw
.Sh SYNOPSIS
.In ugidfw.h
.Ft int
.Fn bsde_parse_rule "int argc" "char *argv[]" "struct mac_bsdextended_rule *rule" "size_t buflen" "char *errstr"
.Fo bsde_parse_rule
.Fa "int argc" "char *argv[]" "struct mac_bsdextended_rule *rule"
.Fa "size_t buflen" "char *errstr"
.Fc
.Ft int
.Fn bsde_parse_rule_string "const char *string" "struct mac_bsdextended_rule *rule" "size_t buflen" "char *errstr"
.Fo bsde_parse_rule_string
.Fa "const char *string" "struct mac_bsdextended_rule *rule"
.Fa "size_t buflen" "char *errstr"
.Fc
.Sh DESCRIPTION
The
.Fn bsde_parse_rule
function parses an argument vector
(e.g.
(e.g.\&
.Fa argv
as passed to
.Fn main )
@ -59,24 +66,21 @@ If an error occurs,
is filled in with the error string
(up to
.Fa errlen
characters, including the terminating NUL).
characters, including the terminating
.Dv NUL ) .
.Pp
The
.Fn bsde_parse_rule_string
function is identical to
.Fn bsde_parse_rule ,
except that it parse a single string, rather than an array of arguments.
except that it parses a single string rather than an array of arguments.
.Sh RETURN VALUES
The
.Fn bsde_parse_rule_string
and
.Fn bsde_parse_rule
functions return
.Li 0
if successful;
otherwise the value
.Li \&-1
is returned and the value of
functions return 0 if successful;
otherwise the value \-1 is returned and the value of
.Fa *errstr
is filled in as documented in
.Sx DESCRIPTION .
@ -95,5 +99,6 @@ This software was contributed to the
.Fx
Project by Network Associates Labs,
the Security Research Division of Network Associates
Inc. under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"),
Inc. under DARPA/SPAWAR contract N66001-01-C-8035
.Pq Dq CBOSS ,
as part of the DARPA CHATS research program.

View file

@ -29,37 +29,37 @@
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.Dd JANUARY 7, 2003
.\"
.Dd January 7, 2003
.Os
.Dt BSDE_RULE_TO_STRING 3
.Sh NAME
.Nm bsde_rule_to_string
.Nd converts a ugidfw rule into its text representation
.Nd "convert a ugidfw rule into its text representation"
.Sh LIBRARY
.Lb libugidfw
.Sh SYNOPSIS
.In ugidfw.h
.Ft int
.Fn bsde_rule_to_string "struct mac_bsdextended_rule *rule" "char *buf" "size_t buflen"
.Fo bsde_rule_to_string
.Fa "struct mac_bsdextended_rule *rule" "char *buf" "size_t buflen"
.Fc
.Sh DESCRIPTION
The
.Fn bsde_rule_to_string
function converts a rule in its internal representation
.Vt ( "struct mac_bsdextended_rule" )
into its text representation and writes up to
.Pq Vt "struct mac_bsdextended_rule"
into its text representation, and writes up to
.Fa buflen
bytes of it to
.Fa buf
(including the terminating NUL).
(including the terminating
.Dv NUL ) .
.Sh RETURN VALUES
The
.Fn bsde_rule_to_string
function returns
.Li \&-1
if the conversion was truncated;
otherwise the value
.Li 0
is returned.
function returns \-1 if the conversion was truncated;
otherwise the value 0 is returned.
.Sh SEE ALSO
.Xr bsde_delete_rule 3 ,
.Xr bsde_get_rule 3 ,
@ -76,5 +76,6 @@ This software was contributed to the
.Fx
Project by Network Associates Labs,
the Security Research Division of Network Associates
Inc. under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"),
Inc. under DARPA/SPAWAR contract N66001-01-C-8035
.Pq Dq CBOSS ,
as part of the DARPA CHATS research program.

View file

@ -29,12 +29,13 @@
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.Dd JANUARY 5, 2003
.\"
.Dd January 5, 2003
.Os
.Dt LIBUGIDFW 3
.Sh NAME
.Nm libugidfw
.Nd library interface to the file system firewall MAC policy
.Nd "library interface to the file system firewall MAC policy"
.Sh LIBRARY
.Lb libugidfw
.Sh SYNOPSIS
@ -49,10 +50,10 @@ file system firewall MAC policy.
The
.Nm
library defines the following functions:
.Bl -tag -width "bsde_parse_rule_strong"
.Bl -tag -width ".Fn bsde_parse_rule_string"
.It Fn bsde_rule_to_string
Converts the internal representation of a rule
.Vt ( "struct mac_bsdextended_rule" )
.Pq Vt "struct mac_bsdextended_rule"
into its text representation;
see
.Xr bsde_rule_to_string 3 .
@ -112,5 +113,6 @@ This software was contributed to the
.Fx
Project by Network Associates Labs,
the Security Research Division of Network Associates
Inc. under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"),
Inc. under DARPA/SPAWAR contract N66001-01-C-8035
.Pq Dq CBOSS ,
as part of the DARPA CHATS research program.