From f1e65894d2ca1e22e9afcdd435d8b6d6f4d62340 Mon Sep 17 00:00:00 2001 From: Ruslan Ermilov Date: Mon, 3 Mar 2003 11:51:30 +0000 Subject: [PATCH] mdoc(7) police: Revision. --- sbin/devd/devd.8 | 20 +++++++++--- sbin/devd/devd.conf.5 | 42 +++++++++++++------------ share/man/man4/fast_ipsec.4 | 61 ++++++++++++++++++++++--------------- usr.bin/elfdump/elfdump.1 | 56 +++++++++++++++------------------- 4 files changed, 99 insertions(+), 80 deletions(-) diff --git a/sbin/devd/devd.8 b/sbin/devd/devd.8 index f65e6ab29339..bcdc0944c67f 100644 --- a/sbin/devd/devd.8 +++ b/sbin/devd/devd.8 @@ -30,7 +30,7 @@ .Os .Sh NAME .Nm devd -.Nd "Device state change daemon" +.Nd "device state change daemon" .Sh SYNOPSIS .Nm .Op Fl d @@ -47,7 +47,9 @@ Enable debugging messages and run in the foreground instead of becoming a daemon. .El .Sh IMPLEMENTATION NOTES +The .Nm +utility is a system daemon that runs in the background all the time. Whenever a device is added to or removed from the device tree, .Nm @@ -57,7 +59,7 @@ For example, .Nm might execute .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 instance when the same adapter is removed. Another example would be for @@ -66,7 +68,9 @@ to use a table to locate and load via .Xr kldload 8 the proper driver for an unrecognized device that is added to the system. .Pp +The .Nm +utility hooks into the .Xr devctl 4 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 aspect of what happens. .Pp +The .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 -.Xr devd.conf 5 +.Xr devd.conf 5 , 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. All files in each of these directories are parsed. These files are intended to be installed by third party vendors that diff --git a/sbin/devd/devd.conf.5 b/sbin/devd/devd.conf.5 index 31810650921c..1452eca524f2 100644 --- a/sbin/devd/devd.conf.5 +++ b/sbin/devd/devd.conf.5 @@ -22,7 +22,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.\" $FreeBSD$ +.\" $FreeBSD$ .\" .\" The section on comments was taken from named.conf.5, which has the .\" following copyright: @@ -40,6 +40,7 @@ .\" 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 .\" SOFTWARE. +.\" .Dd October 17, 2002 .Dt DEVD.CONF 5 .Os @@ -47,18 +48,18 @@ .Nm devd.conf .Nd configuration file for .Xr devd 8 -.Sh OVERVIEW +.Sh DESCRIPTION .Ss General Syntax A .Xr devd 8 configuration consists of two general features, statements and comments. 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. .Pp The following statements are supported: -.Bl -tag -width 0n +.Bl -tag -width ".Ic options" .It Ic options specifies various options and parameters for the operation of .Xr devd 8 . @@ -67,34 +68,36 @@ specifies various matching criteria and actions to perform when a newly attached device matches said criteria. .It Ic detach 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 specifies various matching criteria and actions to perform when no device driver currently loaded in the kernel claims a (new) device. .El .Pp -Statements may occur in any order in the config file, and may be -repated as often as required. -Further details on the syntax and meaning of each statement, and their -substatements is explained below. +Statements may occur in any order in the configuration file, and may be +repeated as often as required. +Further details on the syntax and meaning of each statement and their +substatements are explained below. .Pp Comments may appear anywhere that whitespace may appear in a -configuration file. To appeal to programmers of all kinds, they can -be written in C, C++, or shell/perl constructs. +configuration file. +To appeal to programmers of all kinds, they can +be written in C, C++, or shell/Perl constructs. .Pp C-style comments start with the two characters -.Li /* +.Ql /* (slash, star) and end with -.Li */ +.Ql */ (star, slash). Because they are completely delimited with these characters, they can be used to comment only a portion of a line or to span multiple lines. .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 -.Li */ : +.Ql */ : .Bd -literal -offset indent /* This is the start of a comment. This is still part of the comment. @@ -103,19 +106,20 @@ not valid because the entire comment ends with the first .Ed .Pp C++-style comments start with the two characters -.Li // +.Ql // (slash, slash) and continue to the end of the physical line. They cannot be continued across multiple physical lines; to have one logical comment span multiple lines, each line must use the -.Li // -pair. For example: +.Ql // +pair. +For example: .Bd -literal -offset indent // This is the start of a comment. The next line // is a new comment, even though it is logically // part of the previous comment. .Ed .Sh FILES -.Bl -tag -width /etc/devd.conf -compact +.Bl -tag -width ".Pa /etc/devd.conf" -compact .It Pa /etc/devd.conf The .Xr devd 8 diff --git a/share/man/man4/fast_ipsec.4 b/share/man/man4/fast_ipsec.4 index ae20129c89ea..38c75e9ba8ed 100644 --- a/share/man/man4/fast_ipsec.4 +++ b/share/man/man4/fast_ipsec.4 @@ -9,12 +9,6 @@ .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" 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 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE @@ -35,14 +29,18 @@ .Os .Sh NAME .Nm "Fast IPsec" -.Nd Hardware-accelerated IP Security Protocols +.Nd hardware-accelerated IP Security Protocols .Sh SYNOPSIS .Cd "options FAST_IPSEC" .Cd "device crypto" .Pp -.Cd net.inet.esp.enable -.Cd net.inet.ah.enable -.Cd net.inet.ipcomp.enable +.Bl -item -compact +.It +.Va net.inet.esp.enable +.It +.Va net.inet.ah.enable +.It +.Va net.inet.ipcomp.enable .El .Sh DESCRIPTION .Tn IPsec @@ -55,51 +53,64 @@ and .Tn IPComp (for IP Payload Compression Protocol) that provide security services for IP datagrams. -.Tn Fast IPsec +.Nm is an experimental implementation of these protocols that uses the .Xr crypto 4 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. .Pp -In general the -.Tn Fast IPsec +In general, the +.Nm implementation is intended to be compatible with the -KAME -.Tn IPsec +.Tn KAME IPsec implementation. This documentation concentrates on differences from that software. The user should refer to .Xr ipsec 4 for basic information on setting up and using these protocols. .Pp -System configuration requires the crypto subsystem. +System configuration requires the +.Xr crypto 4 +subsystem. When the -.Tn Fast IPsec -protocols are configured for use all protocols are included in the system. -To selectively enable/disable protocols use +.Nm +protocols are configured for use, all protocols are included in the system. +To selectively enable/disable protocols, use .Xr sysctl 8 . .Sh DIAGNOSTICS To be added. .Sh BUGS 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 -issues with the crypto subsystem. +issues with the +.Xr crypto 4 +subsystem. +.Pp This documentation is incomplete. .Sh SEE ALSO +.Xr crypto 4 , .Xr ipsec 4 , .Xr setkey 8 , .Xr sysctl 8 .Sh HISTORY -The protocols draw heavily on the OpenBSD implementation of the +The protocols draw heavily on the +.Ox +implementation of the .Tn IPsec 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 .Tn IPsec protocols. The -.Tn Fast IPsec +.Nm protocols first appeared in .Fx 5.0 . diff --git a/usr.bin/elfdump/elfdump.1 b/usr.bin/elfdump/elfdump.1 index 95d611eac395..f310cdb894fb 100644 --- a/usr.bin/elfdump/elfdump.1 +++ b/usr.bin/elfdump/elfdump.1 @@ -29,21 +29,24 @@ .Os .Sh NAME .Nm elfdump -.Nd "Displays information about ELF files." +.Nd "display information about" +.Tn ELF +files .Sh SYNOPSIS .Nm .Op Fl a | cdeiGhnprs -.Op Fl w Ar argument +.Op Fl w Ar file .Ar file .Sh DESCRIPTION -This is an example manual page for the +The .Nm -command. -It is intended that this example can be used as a template -when writing a new manual page. +utility +dumps various information about the specified +.Tn ELF +.Ar file . .Pp The options are as follows: -.Bl -tag -width ".Fl d Ar argument" +.Bl -tag -width ".Fl w Ar file" .It Fl a Dump all information. .It Fl c @@ -66,12 +69,10 @@ Dump the program header. Dump relocations. .It Fl s Dump the symbol table. -.It Fl w -Write output to -.Ar argument . -.It Ar file -Required argument -.Ar file . +.It Fl w Ar file +Write output to a +.Ar file +instead of the standard output. .El .Sh EXAMPLES The following is an example of a typical usage @@ -81,38 +82,31 @@ command: .Pp .Dl "elfdump -a -w output /bin/ls" .Sh DIAGNOSTICS -Exit status is 0 on success, and 1 if the command fails. -.El -.Sh COMPATIBILITY -The -.Nm -command has no known compatibility issues. +.Ex -std .Sh SEE ALSO .Xr objdump 1 , .Xr readelf 1 -.Pp .Rs -.%A AT&T Unix Systems Labs -.%T System V Application Binary Interface +.%A "AT&T Unix Systems Labs" +.%T "System V Application Binary Interface" .%O http://www.sco.com/developers/gabi/ .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 The .Nm -command first appeared in +utility first appeared in .Fx 5.0 . .Sh AUTHORS +.An -nosplit +The .Nm -was authored by +utility +was written by .An Jake Burkholder Aq jake@FreeBSD.org . This manual page was written by .An David O'Brien Aq obrien@FreeBSD.org . .Sh BUGS -Does not fully implement the ELF gABI. +Does not fully implement the +.Tn ELF +gABI.