mdoc(7) police: Revision.

This commit is contained in:
Ruslan Ermilov 2003-03-03 11:51:30 +00:00
parent 3cb179a848
commit f1e65894d2
Notes: svn2git 2020-12-20 02:59:44 +00:00
svn path=/head/; revision=111813
4 changed files with 99 additions and 80 deletions

View File

@ -30,7 +30,7 @@
.Os .Os
.Sh NAME .Sh NAME
.Nm devd .Nm devd
.Nd "Device state change daemon" .Nd "device state change daemon"
.Sh SYNOPSIS .Sh SYNOPSIS
.Nm .Nm
.Op Fl d .Op Fl d
@ -47,7 +47,9 @@ Enable debugging messages and run in the foreground instead of
becoming a daemon. becoming a daemon.
.El .El
.Sh IMPLEMENTATION NOTES .Sh IMPLEMENTATION NOTES
The
.Nm .Nm
utility
is a system daemon that runs in the background all the time. is a system daemon that runs in the background all the time.
Whenever a device is added to or removed from the device tree, Whenever a device is added to or removed from the device tree,
.Nm .Nm
@ -57,7 +59,7 @@ For example,
.Nm .Nm
might execute might execute
.Xr dhclient 8 .Xr dhclient 8
when an ethernet adapter is added to the system and kill the when an Ethernet adapter is added to the system, and kill the
.Xr dhclient 8 .Xr dhclient 8
instance when the same adapter is removed. instance when the same adapter is removed.
Another example would be for Another example would be for
@ -66,7 +68,9 @@ to use a table to locate and load via
.Xr kldload 8 .Xr kldload 8
the proper driver for an unrecognized device that is added to the system. the proper driver for an unrecognized device that is added to the system.
.Pp .Pp
The
.Nm .Nm
utility
hooks into the hooks into the
.Xr devctl 4 .Xr devctl 4
device driver. device driver.
@ -82,12 +86,18 @@ For most mundane uses, the default handlers are adequate.
However, for more advanced users, the power is present to tweak every However, for more advanced users, the power is present to tweak every
aspect of what happens. aspect of what happens.
.Pp .Pp
The
.Nm .Nm
reads /etc/devd.conf and uses that file to drive the rest of the process. utility
reads
.Pa /etc/devd.conf
and uses that file to drive the rest of the process.
While the format of this file is described in While the format of this file is described in
.Xr devd.conf 5 .Xr devd.conf 5 ,
some basics are covered here. some basics are covered here.
In the options section, one can define multiple directories to search In the
.Ic options
section, one can define multiple directories to search
for config files. for config files.
All files in each of these directories are parsed. All files in each of these directories are parsed.
These files are intended to be installed by third party vendors that These files are intended to be installed by third party vendors that

View File

@ -22,7 +22,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE. .\" SUCH DAMAGE.
.\" .\"
.\" $FreeBSD$ .\" $FreeBSD$
.\" .\"
.\" The section on comments was taken from named.conf.5, which has the .\" The section on comments was taken from named.conf.5, which has the
.\" following copyright: .\" following copyright:
@ -40,6 +40,7 @@
.\" PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS .\" PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
.\" ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS .\" ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
.\" SOFTWARE. .\" SOFTWARE.
.\"
.Dd October 17, 2002 .Dd October 17, 2002
.Dt DEVD.CONF 5 .Dt DEVD.CONF 5
.Os .Os
@ -47,18 +48,18 @@
.Nm devd.conf .Nm devd.conf
.Nd configuration file for .Nd configuration file for
.Xr devd 8 .Xr devd 8
.Sh OVERVIEW .Sh DESCRIPTION
.Ss General Syntax .Ss General Syntax
A A
.Xr devd 8 .Xr devd 8
configuration consists of two general features, statements configuration consists of two general features, statements
and comments. and comments.
All statements end with a semicolon. All statements end with a semicolon.
Many statements can contain substatements, which are each also Many statements can contain substatements, which are also
terminated with a semicolon. terminated with a semicolon.
.Pp .Pp
The following statements are supported: The following statements are supported:
.Bl -tag -width 0n .Bl -tag -width ".Ic options"
.It Ic options .It Ic options
specifies various options and parameters for the operation of specifies various options and parameters for the operation of
.Xr devd 8 . .Xr devd 8 .
@ -67,34 +68,36 @@ specifies various matching criteria and actions to perform when
a newly attached device matches said criteria. a newly attached device matches said criteria.
.It Ic detach .It Ic detach
specifies various matching criteria and actions to perform when specifies various matching criteria and actions to perform when
a newly attached device matches said criteria. a newly detached device matches said criteria.
.It Ic nomatch .It Ic nomatch
specifies various matching criteria and actions to perform when specifies various matching criteria and actions to perform when
no device driver currently loaded in the kernel claims a (new) no device driver currently loaded in the kernel claims a (new)
device. device.
.El .El
.Pp .Pp
Statements may occur in any order in the config file, and may be Statements may occur in any order in the configuration file, and may be
repated as often as required. repeated as often as required.
Further details on the syntax and meaning of each statement, and their Further details on the syntax and meaning of each statement and their
substatements is explained below. substatements are explained below.
.Pp .Pp
Comments may appear anywhere that whitespace may appear in a Comments may appear anywhere that whitespace may appear in a
configuration file. To appeal to programmers of all kinds, they can configuration file.
be written in C, C++, or shell/perl constructs. To appeal to programmers of all kinds, they can
be written in C, C++, or shell/Perl constructs.
.Pp .Pp
C-style comments start with the two characters C-style comments start with the two characters
.Li /* .Ql /*
(slash, star) and end with (slash, star) and end with
.Li */ .Ql */
(star, slash). (star, slash).
Because they are completely delimited with these characters, Because they are completely delimited with these characters,
they can be used to comment only a portion of a line or to span they can be used to comment only a portion of a line or to span
multiple lines. multiple lines.
.Pp .Pp
C-style comments cannot be nested. For example, the following is C-style comments cannot be nested.
For example, the following is
not valid because the entire comment ends with the first not valid because the entire comment ends with the first
.Li */ : .Ql */ :
.Bd -literal -offset indent .Bd -literal -offset indent
/* This is the start of a comment. /* This is the start of a comment.
This is still part of the comment. This is still part of the comment.
@ -103,19 +106,20 @@ not valid because the entire comment ends with the first
.Ed .Ed
.Pp .Pp
C++-style comments start with the two characters C++-style comments start with the two characters
.Li // .Ql //
(slash, slash) and continue to the end of the physical line. (slash, slash) and continue to the end of the physical line.
They cannot be continued across multiple physical lines; to have They cannot be continued across multiple physical lines; to have
one logical comment span multiple lines, each line must use the one logical comment span multiple lines, each line must use the
.Li // .Ql //
pair. For example: pair.
For example:
.Bd -literal -offset indent .Bd -literal -offset indent
// This is the start of a comment. The next line // This is the start of a comment. The next line
// is a new comment, even though it is logically // is a new comment, even though it is logically
// part of the previous comment. // part of the previous comment.
.Ed .Ed
.Sh FILES .Sh FILES
.Bl -tag -width /etc/devd.conf -compact .Bl -tag -width ".Pa /etc/devd.conf" -compact
.It Pa /etc/devd.conf .It Pa /etc/devd.conf
The The
.Xr devd 8 .Xr devd 8

View File

@ -9,12 +9,6 @@
.\" 2. Redistributions in binary form must reproduce the above copyright .\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the .\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution. .\" documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\" must display the following acknowledgement:
.\" This product includes software developed by Bill Paul.
.\" 4. Neither the name of the author nor the names of any co-contributors
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\" .\"
.\" THIS SOFTWARE IS PROVIDED BY Sam Leffler AND CONTRIBUTORS ``AS IS'' AND .\" THIS SOFTWARE IS PROVIDED BY Sam Leffler AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
@ -35,14 +29,18 @@
.Os .Os
.Sh NAME .Sh NAME
.Nm "Fast IPsec" .Nm "Fast IPsec"
.Nd Hardware-accelerated IP Security Protocols .Nd hardware-accelerated IP Security Protocols
.Sh SYNOPSIS .Sh SYNOPSIS
.Cd "options FAST_IPSEC" .Cd "options FAST_IPSEC"
.Cd "device crypto" .Cd "device crypto"
.Pp .Pp
.Cd net.inet.esp.enable .Bl -item -compact
.Cd net.inet.ah.enable .It
.Cd net.inet.ipcomp.enable .Va net.inet.esp.enable
.It
.Va net.inet.ah.enable
.It
.Va net.inet.ipcomp.enable
.El .El
.Sh DESCRIPTION .Sh DESCRIPTION
.Tn IPsec .Tn IPsec
@ -55,51 +53,64 @@ and
.Tn IPComp .Tn IPComp
(for IP Payload Compression Protocol) (for IP Payload Compression Protocol)
that provide security services for IP datagrams. that provide security services for IP datagrams.
.Tn Fast IPsec .Nm
is an experimental implementation of these protocols that uses the is an experimental implementation of these protocols that uses the
.Xr crypto 4 .Xr crypto 4
subsystem to carry out cryptographic operations. subsystem to carry out cryptographic operations.
This means, in particular, that cryptograph hardware devices are This means, in particular, that cryptographic hardware devices are
employed whenever possible to optimize the performance of these protocols. employed whenever possible to optimize the performance of these protocols.
.Pp .Pp
In general the In general, the
.Tn Fast IPsec .Nm
implementation is intended to be compatible with the implementation is intended to be compatible with the
KAME .Tn KAME IPsec
.Tn IPsec
implementation. implementation.
This documentation concentrates on differences from that software. This documentation concentrates on differences from that software.
The user should refer to The user should refer to
.Xr ipsec 4 .Xr ipsec 4
for basic information on setting up and using these protocols. for basic information on setting up and using these protocols.
.Pp .Pp
System configuration requires the crypto subsystem. System configuration requires the
.Xr crypto 4
subsystem.
When the When the
.Tn Fast IPsec .Nm
protocols are configured for use all protocols are included in the system. protocols are configured for use, all protocols are included in the system.
To selectively enable/disable protocols use To selectively enable/disable protocols, use
.Xr sysctl 8 . .Xr sysctl 8 .
.Sh DIAGNOSTICS .Sh DIAGNOSTICS
To be added. To be added.
.Sh BUGS .Sh BUGS
There is presently no support for IPv6. There is presently no support for IPv6.
The IPcomp protocol support does not work. .Pp
The
.Tn IPcomp
protocol support does not work.
.Pp
Certain legacy authentication algorithms are not supported because of Certain legacy authentication algorithms are not supported because of
issues with the crypto subsystem. issues with the
.Xr crypto 4
subsystem.
.Pp
This documentation is incomplete. This documentation is incomplete.
.Sh SEE ALSO .Sh SEE ALSO
.Xr crypto 4 ,
.Xr ipsec 4 , .Xr ipsec 4 ,
.Xr setkey 8 , .Xr setkey 8 ,
.Xr sysctl 8 .Xr sysctl 8
.Sh HISTORY .Sh HISTORY
The protocols draw heavily on the OpenBSD implementation of the The protocols draw heavily on the
.Ox
implementation of the
.Tn IPsec .Tn IPsec
protocols. protocols.
The policy management code is derived from the KAME implementation found The policy management code is derived from the
.Tn KAME
implementation found
in their in their
.Tn IPsec .Tn IPsec
protocols. protocols.
The The
.Tn Fast IPsec .Nm
protocols first appeared in protocols first appeared in
.Fx 5.0 . .Fx 5.0 .

View File

@ -29,21 +29,24 @@
.Os .Os
.Sh NAME .Sh NAME
.Nm elfdump .Nm elfdump
.Nd "Displays information about ELF files." .Nd "display information about"
.Tn ELF
files
.Sh SYNOPSIS .Sh SYNOPSIS
.Nm .Nm
.Op Fl a | cdeiGhnprs .Op Fl a | cdeiGhnprs
.Op Fl w Ar argument .Op Fl w Ar file
.Ar file .Ar file
.Sh DESCRIPTION .Sh DESCRIPTION
This is an example manual page for the The
.Nm .Nm
command. utility
It is intended that this example can be used as a template dumps various information about the specified
when writing a new manual page. .Tn ELF
.Ar file .
.Pp .Pp
The options are as follows: The options are as follows:
.Bl -tag -width ".Fl d Ar argument" .Bl -tag -width ".Fl w Ar file"
.It Fl a .It Fl a
Dump all information. Dump all information.
.It Fl c .It Fl c
@ -66,12 +69,10 @@ Dump the program header.
Dump relocations. Dump relocations.
.It Fl s .It Fl s
Dump the symbol table. Dump the symbol table.
.It Fl w .It Fl w Ar file
Write output to Write output to a
.Ar argument . .Ar file
.It Ar file instead of the standard output.
Required argument
.Ar file .
.El .El
.Sh EXAMPLES .Sh EXAMPLES
The following is an example of a typical usage The following is an example of a typical usage
@ -81,38 +82,31 @@ command:
.Pp .Pp
.Dl "elfdump -a -w output /bin/ls" .Dl "elfdump -a -w output /bin/ls"
.Sh DIAGNOSTICS .Sh DIAGNOSTICS
Exit status is 0 on success, and 1 if the command fails. .Ex -std
.El
.Sh COMPATIBILITY
The
.Nm
command has no known compatibility issues.
.Sh SEE ALSO .Sh SEE ALSO
.Xr objdump 1 , .Xr objdump 1 ,
.Xr readelf 1 .Xr readelf 1
.Pp
.Rs .Rs
.%A AT&T Unix Systems Labs .%A "AT&T Unix Systems Labs"
.%T System V Application Binary Interface .%T "System V Application Binary Interface"
.%O http://www.sco.com/developers/gabi/ .%O http://www.sco.com/developers/gabi/
.Re .Re
.\".Sh STANDARDS
.\"If the command conforms to some standard, such as
.\".St -p1003.2
.\"or
.\".St -isoC ,
.\"it should be noted here.
.Sh HISTORY .Sh HISTORY
The The
.Nm .Nm
command first appeared in utility first appeared in
.Fx 5.0 . .Fx 5.0 .
.Sh AUTHORS .Sh AUTHORS
.An -nosplit
The
.Nm .Nm
was authored by utility
was written by
.An Jake Burkholder Aq jake@FreeBSD.org . .An Jake Burkholder Aq jake@FreeBSD.org .
This This
manual page was written by manual page was written by
.An David O'Brien Aq obrien@FreeBSD.org . .An David O'Brien Aq obrien@FreeBSD.org .
.Sh BUGS .Sh BUGS
Does not fully implement the ELF gABI. Does not fully implement the
.Tn ELF
gABI.