Markup, grammar, punctuation.

This commit is contained in:
ru 2004-07-01 18:20:57 +00:00
parent a0dce18ba8
commit 615a6a246a
9 changed files with 73 additions and 59 deletions

View File

@ -27,7 +27,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd February 8, 2003
.Dd March 7, 2004
.Dt LIBGEOM 3
.Os
.Sh NAME
@ -151,12 +151,13 @@ if there are no more items in the snapshot.
.Ss "Control Functions"
The
.Fn gctl_*
functions are used to send requests to GEOM classes. In order for a GEOM
functions are used to send requests to GEOM classes.
In order for a GEOM
class to actually be able to receive these requests, it must have defined a
"ctlreq" method.
.Pp
A
.Ar struct gctl_req * ,
.Vt "struct gctl_req *" ,
obtained with
.Fn gctl_get_handle ,
can hold any number of parameters, which must be added to it with
@ -170,56 +171,69 @@ Both
and
.Fn gctl_rw_param
take a string
.Ar name ,
.Fa name ,
which is used to identify the parameter, and a
.Ar value ,
which contains - in the read-only case - the data to be passed to the
GEOM class, or - in the read/write case - a pointer to preallocated memory
that the GEOM class should fill with the desired data. If
.Ar len
.Fa value ,
which contains, in the read-only case, the data to be passed to the
GEOM class, or, in the read/write case, a pointer to preallocated memory
that the GEOM class should fill with the desired data.
If
.Fa len
is negative, it is assumed that
.Ar value
is an ASCII string and the actual length is taken from the string length of
.Ar value ;
.Fa value
is an
.Tn ASCII
string and the actual length is taken from the string length of
.Fa value ;
otherwise it must hold the size of
.Ar value .
.Fa value .
.Pp
A parameter with a
.Ar name
containing the string "class" is mandatory for each request, and the
.Fa name
containing the string
.Qq Li class
is mandatory for each request, and the
corresponding
.Ar value
.Fa value
must hold the name of the GEOM class where the request should be sent to.
.Pp
Also mandatory for each request is a parameter with a
.Ar name
called "verb", and the corresponding
.Ar value
.Fa name
called
.Qq Li verb ,
and the corresponding
.Fa value
needs to hold the command string that the GEOM class should react upon.
.Pp
Once all desired parameters are filled in, the request must be sent to
the GEOM subsystem with
.Fn gctl_issue ,
which returns NULL on success, or a string containing the error message
which returns
.Dv NULL
on success, or a string containing the error message
on failure.
.Pp
After the request is finished, the allocated memory should be released with
.Fn gctl_free .
.Pp
The
.Fn gctl_dump
function
can be used to format the contents of
.Ar req
.Fa req
to the open file handle pointed to by
.Ar f
.Fa f ,
for debugging purposes.
.Pp
Error handling for the control functions is postponed until the call
to
.Fn gctl_issue
which returns NULL on success or an error message corresponding to the
to
.Fn gctl_issue ,
which returns
.Dv NULL
on success, or an error message corresponding to the
first error which happened.
.Sh EXAMPLES
Create a request that is to be sent to the CCD class and tell
Create a request that is to be sent to the CCD class, and tell
it to destroy a specific geom:
.Bd -literal -offset indent
H = gctl_get_handle();
@ -229,13 +243,11 @@ sprintf(buf, "ccd%d", ccd);
gctl_ro_param(H, "geom", -1, buf);
errstr = gctl_issue(H);
if (errstr != NULL)
err(1, "Could not destroy ccd: %s", errstr);
err(1, "could not destroy ccd: %s", errstr);
gctl_free(H);
.Ed
.Sh SEE ALSO
.Rs
http://ezine.daemonnews.org/200308/blueprints.html
.Re
.Pa http://ezine.daemonnews.org/200308/blueprints.html
.Sh HISTORY
The
.Nm geom

View File

@ -73,31 +73,31 @@ returned. The value of
describes the filtering predicate as follows:
.Pp
.Bl -tag -width 20n -offset indent -compact
.It Sy KERN_PROC_ALL
.It Dv KERN_PROC_ALL
all processes and kernel visible threads
.It Sy KERN_PROC_PROC
.It Dv KERN_PROC_PROC
all processes, without threads
.It Sy KERN_PROC_PID
processes with process id
.It Dv KERN_PROC_PID
processes with process ID
.Fa arg
.It Sy KERN_PROC_PGRP
.It Dv KERN_PROC_PGRP
processes with process group
.Fa arg
.It Sy KERN_PROC_SESSION
.It Dv KERN_PROC_SESSION
processes with session
.Fa arg
.It Sy KERN_PROC_TTY
processes with tty
.It Dv KERN_PROC_TTY
processes with TTY
.Fa arg
.It Sy KERN_PROC_UID
processes with effective user id
.It Dv KERN_PROC_UID
processes with effective user ID
.Fa arg
.It Sy KERN_PROC_RUID
processes with real user id
.It Dv KERN_PROC_RUID
processes with real user ID
.Fa arg
.It Sy KERN_PROC_INC_THREAD
.It Dv KERN_PROC_INC_THREAD
modifier to return all kernel visible threads when filtering
by process id, process group, tty, user id, and real user id
by process ID, process group, TTY, user ID, and real user ID
.El
.Pp
The number of processes found is returned in the reference parameter

View File

@ -81,9 +81,9 @@ prompts for a password.
specifies a non-standard location for the RADIUS client configuration file
(normally located in
.Pa /etc/radius.conf ) .
.It Cm nas_id Ns No = Ns Ar identifier
.It Cm nas_id Ns = Ns Ar identifier
specifies a NAS identifier to send instead of the hostname.
.It Cm template_user Ns No = Ns Ar username
.It Cm template_user Ns = Ns Ar username
specifies a user whose
.Xr passwd 5
entry will be used as a template to create the session environment

View File

@ -61,7 +61,7 @@ The Self authentication component
.Pq Fn pam_sm_authenticate ,
returns success if and only if the target user's user ID is identical
with the current real user ID.
If the current real user ID is zero authentication will fail,
If the current real user ID is zero, authentication will fail,
unless the
.Cm allow_root
option was specified.

View File

@ -79,7 +79,9 @@ characters, including the terminating
.Dv NUL ) .
If successful and
.Fa rulenum
is non-NULL, the rule number used will be returned in
is
.No non- Ns Dv NULL ,
the rule number used will be returned in
.Fa *rulenum .
.Pp
The

View File

@ -30,7 +30,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd January 5, 2003
.Dd February 25, 2004
.Os
.Dt LIBUGIDFW 3
.Sh NAME

View File

@ -54,18 +54,16 @@
.Sh DESCRIPTION
The
.Fn fabs ,
the
.Fn fabsf
and the
and
.Fn fabsl
functions compute the absolute value of a floating-point number
.Fa x .
.Sh RETURN VALUES
The
.Fn fabs ,
the
.Fn fabsf
and the
and
.Fn fabsl
functions return the absolute value of
.Fa x .
@ -83,7 +81,7 @@ function conforms to
.St -isoC .
The
.Fn fabsf
and the
and
.Fn fabsl
functions conform to
.St -isoC-99 .

View File

@ -69,13 +69,13 @@ The
and
.Fn cabsf
functions compute the complex absolute value of
.Ar z .
.Fa z .
.Pp
.Fn hypot "\*(If" "v"
=
.Fn hypot "v" "\*(If"
= +\*(If for all
.Ar v ,
.Fa v ,
including \*(Na.
.Sh ERROR (due to Roundoff, etc.)
Below 0.97
@ -98,7 +98,7 @@ and
.Fn hypot "\*(Na" "v"
are \*(Na for all
.Em finite
.Ar v ;
.Fa v ;
with "reserved operand" in place of "\*(Na", the
same is true on a
.Tn VAX .
@ -113,12 +113,12 @@ This is intentional; it happens because
= +\*(If
for
.Em all
.Ar v ,
.Fa v ,
finite or infinite.
Hence
.Fn hypot "\*(If" "v"
is independent of
.Ar v .
.Fa v .
Unlike the reserved operand fault on a
.Tn VAX ,
the

View File

@ -90,10 +90,12 @@
These functions are required or recommended by
.St -ieee754 .
.Pp
The
.Fn copysign ,
.Fn copysignf
and
.Fn copysignl
functions
return
.Fa x
with its sign changed to