From: Sascha Wildner Date: Sun, 28 Mar 2010 11:30:07 +0000 (+0200) Subject: Sort sections in various manual pages. X-Git-Tag: v2.6.0~4 X-Git-Url: http://gitweb.dragonflybsd.org/dragonfly.git/commitdiff_plain/a68e0df02e05f0ae707cf2b7d2d0905567e1afe9 Sort sections in various manual pages. --- diff --git a/lib/libc/sys/pselect.2 b/lib/libc/sys/pselect.2 index a205cd8..a701c4b 100644 --- a/lib/libc/sys/pselect.2 +++ b/lib/libc/sys/pselect.2 @@ -110,6 +110,18 @@ The .Fn pselect function conforms to .St -p1003.1-2001 . +.Sh HISTORY +The +.Fn pselect +function first appeared in +.Dx 1.11 . +.Sh AUTHORS +This manual page was originally written by +.An Garrett Wollman Aq wollman@FreeBSD.org +for +.Fx +and later modified for +.Dx . .Sh BUGS The .Fn pselect @@ -124,15 +136,3 @@ The .Fn pselect implementations in libthread_xu (kernel multi-threading) and libc (single-threading) operate atomically and are therefore race-free. -.Sh HISTORY -The -.Fn pselect -function first appeared in -.Dx 1.11 . -.Sh AUTHORS -This manual page was originally written by -.An Garrett Wollman Aq wollman@FreeBSD.org -for -.Fx -and later modified for -.Dx . diff --git a/lib/libc/uuid/uuid.3 b/lib/libc/uuid/uuid.3 index 8ee22ff..6d95757 100644 --- a/lib/libc/uuid/uuid.3 +++ b/lib/libc/uuid/uuid.3 @@ -161,13 +161,6 @@ functions decode a UUID from an octet stream in little-endian and big-endian byte-order, respectively. These routines are not part of the DCE RPC API. They are provided for convenience. -.Sh FILES -.Bl -tag -width ".Pa /etc/defaults/uuids" -.It Pa /etc/defaults/uuids -A list of UUIDs and their symbolic names provided by the OS vendor. -.It Pa /etc/uuids -A list of UUIDs and their symbolic names provided by the system administrator. -.El .Sh RETURN VALUES The successful or unsuccessful completion of the function is returned in the .Fa status @@ -185,6 +178,13 @@ The meaning of the code escaped the writers mind. .It Dv uuid_s_not_found A UUID lookup failed. .El +.Sh FILES +.Bl -tag -width ".Pa /etc/defaults/uuids" +.It Pa /etc/defaults/uuids +A list of UUIDs and their symbolic names provided by the OS vendor. +.It Pa /etc/uuids +A list of UUIDs and their symbolic names provided by the system administrator. +.El .Sh SEE ALSO .Xr uuidgen 1 , .Xr uuidgen 2 , diff --git a/lib/libsdp/sdp.3 b/lib/libsdp/sdp.3 index 9c1b2b2..9ba7c98 100644 --- a/lib/libsdp/sdp.3 +++ b/lib/libsdp/sdp.3 @@ -411,11 +411,6 @@ to find out more about error. .Xr strerror 3 , .Xr bluetooth 4 , .Xr sdpd 8 -.Sh AUTHORS -.An Maksim Yevmenkin Aq m_evmenkin@yahoo.com -.Sh BUGS -Most likely. -Please report bugs if found. .Sh HISTORY .Nm libsdp first appeared in @@ -425,3 +420,8 @@ was ported to by .An Iain Hibbert and imported into .Dx 1.11 . +.Sh AUTHORS +.An Maksim Yevmenkin Aq m_evmenkin@yahoo.com +.Sh BUGS +Most likely. +Please report bugs if found. diff --git a/sbin/hammer/hammer.8 b/sbin/hammer/hammer.8 index 6cc78fa..4913253 100644 --- a/sbin/hammer/hammer.8 +++ b/sbin/hammer/hammer.8 @@ -1395,8 +1395,6 @@ fsync is ignored. Calls to fsync() will be ignored. This mode is primarily designed for testing and should not be used on a production system. .El -.Sh EXIT STATUS -.Ex -std .Sh FILES .Bl -tag -width ".It Pa /var/slaves/" -compact .It Pa /snapshots @@ -1423,6 +1421,8 @@ recommended slave PFS snapshots directory .Nm ( HAMMER VERSION 2-) .El +.Sh EXIT STATUS +.Ex -std .Sh SEE ALSO .Xr ssh 1 , .Xr undo 1 , diff --git a/share/man/man4/ae.4 b/share/man/man4/ae.4 index 9c3ef74..ba9ee2a 100644 --- a/share/man/man4/ae.4 +++ b/share/man/man4/ae.4 @@ -124,6 +124,14 @@ instead. .Xr ng_ether 4 , .Xr vlan 4 , .Xr ifconfig 8 +.Sh HISTORY +The +.Nm +driver and this manual page was written by +.An Stanislav Sedov +.Aq stas@FreeBSD.org . +It first appeared in +.Fx 7.1 . .Sh BUGS The Attansic L2 FastEthernet contoller supports DMA but do not use a descriptor based transfer mechanism via scatter-gather DMA. @@ -133,11 +141,3 @@ Furthermore, a lot of data alignment restrictions apply. This may introduce a high CPU load on systems with heavy network activity. Luckily enough this should not be a problem on modern hardware as L2 does not support speeds faster than 100Mbps. -.Sh HISTORY -The -.Nm -driver and this manual page was written by -.An Stanislav Sedov -.Aq stas@FreeBSD.org . -It first appeared in -.Fx 7.1 . diff --git a/share/man/man4/cmx.4 b/share/man/man4/cmx.4 index cfc8377..8d821ac 100644 --- a/share/man/man4/cmx.4 +++ b/share/man/man4/cmx.4 @@ -68,11 +68,6 @@ and are supported and work as expected. An open file descriptor will always be ready for writing, but only ready for reading if the device indicates that it has data available. -.Sh COMPATIBILITY -Userland smartcard code written for the vendor's Linux drivers -should work with the -.Nm -driver without modification. .Sh FILES .Bl -tag -width /dev/cmxn -compact .It Pa /dev/cmx\fBn\fP @@ -92,6 +87,11 @@ Character device special file. .\".Nm .\"devices. .El +.Sh COMPATIBILITY +Userland smartcard code written for the vendor's Linux drivers +should work with the +.Nm +driver without modification. .Sh SEE ALSO .Xr pccard 4 .Sh HISTORY diff --git a/share/man/man5/uuids.5 b/share/man/man5/uuids.5 index 90f3995..0926c5e 100644 --- a/share/man/man5/uuids.5 +++ b/share/man/man5/uuids.5 @@ -59,13 +59,6 @@ i.e. 16 hexadecimal digits, with dash after digit no. 8, 12, 16 and 20. A name is a text string enclosed in double quotes .Pq Sq \&" . -.Sh EXAMPLES -A UUID with name -.Dq test UUID : -.Bd -literal -offset indent -# test uuids(5) file -061ceb5d-5beb-11dd-924c-010e0cd0bad1 "test UUID" -.Ed .Sh FILES .Bl -tag -width ".Pa /etc/defaults/uuids" -compact .It Pa /etc/defaults/uuids @@ -74,6 +67,13 @@ A list of UUIDs and their symbolic names provided by the OS vendor. A list of UUIDs and their symbolic names provided by the system administrator. .El +.Sh EXAMPLES +A UUID with name +.Dq test UUID : +.Bd -literal -offset indent +# test uuids(5) file +061ceb5d-5beb-11dd-924c-010e0cd0bad1 "test UUID" +.Ed .Sh SEE ALSO .Xr uuid 3 .Sh AUTHORS diff --git a/share/man/man7/vkernel.7 b/share/man/man7/vkernel.7 index 524496b..66ab5d4 100644 --- a/share/man/man7/vkernel.7 +++ b/share/man/man7/vkernel.7 @@ -280,6 +280,21 @@ default configuration file, for .Xr config 8 . .El +.Sh CONFIGURATION FILES +Your virtual kernel is a complete +.Dx +system, but you might not want to run all the services a normal kernel runs. +Here is what a typical virtual kernel's +.Pa /etc/rc.conf +file looks like, with some additional possibilities commented out. +.Bd -literal +hostname="vkernel" +network_interfaces="lo0 vke0" +ifconfig_vke0="DHCP" +sendmail_enable="NO" +#syslog_enable="NO" +blanktime="NO" +.Ed .Sh EXAMPLES A couple of steps are necessary in order to prepare the system to build and run a virtual kernel. @@ -401,21 +416,6 @@ building the world under a virtual kernel, like this: vkernel# make MACHINE_PLATFORM=pc32 buildworld vkernel# make MACHINE_PLATFORM=pc32 installworld .Ed -.Sh CONFIGURATION FILES -Your virtual kernel is a complete -.Dx -system, but you might not want to run all the services a normal kernel runs. -Here is what a typical virtual kernel's -.Pa /etc/rc.conf -file looks like, with some additional possibilities commented out. -.Bd -literal -hostname="vkernel" -network_interfaces="lo0 vke0" -ifconfig_vke0="DHCP" -sendmail_enable="NO" -#syslog_enable="NO" -blanktime="NO" -.Ed .Sh SEE ALSO .Xr vknet 1 , .Xr bridge 4 , diff --git a/share/man/man9/ioctl.9 b/share/man/man9/ioctl.9 index 7f5d84a..3313f25 100644 --- a/share/man/man9/ioctl.9 +++ b/share/man/man9/ioctl.9 @@ -179,6 +179,26 @@ In order for the new ioctl to be visible to the system, it is installed in either .In sys/ioctl.h or one of the files that are reached from .In sys/ioctl.h . +.Sh RETURN VALUES +A distinction must be made at this point. +All +.Fn *_ioctl +routines from +.Em within kernel +should return either 0 for success +or a defined error code, as described in +.In sys/errno.h . +At the libc level though a conversion takes place, so that eventually +.Xr ioctl 2 +returns either 0 for success or -1 for failure, in which case the +.Va errno +variable is set accordingly. +.Pp +The use of magic numbers such as -1, to indicate that a given ioctl +code was not handled, is strongly discouraged. +The value -1 is bound to the +.Er ERESTART +pseudo-error, which is returned inside kernel to modify return to process. .Sh EXAMPLES Let's suppose that we want to pass an integer value to the kernel. From the user point of view, this is like writing to the kernel. @@ -223,25 +243,5 @@ if (ioctl(fd, MYDEVIOCTL, \*[Am]a) == -1) { /* Handle failure */ } .Ed -.Sh RETURN VALUES -A distinction must be made at this point. -All -.Fn *_ioctl -routines from -.Em within kernel -should return either 0 for success -or a defined error code, as described in -.In sys/errno.h . -At the libc level though a conversion takes place, so that eventually -.Xr ioctl 2 -returns either 0 for success or -1 for failure, in which case the -.Va errno -variable is set accordingly. -.Pp -The use of magic numbers such as -1, to indicate that a given ioctl -code was not handled, is strongly discouraged. -The value -1 is bound to the -.Er ERESTART -pseudo-error, which is returned inside kernel to modify return to process. .Sh SEE ALSO .Xr ioctl 2 diff --git a/usr.bin/btpin/btpin.1 b/usr.bin/btpin/btpin.1 index 11bd9eb..f88d102 100644 --- a/usr.bin/btpin/btpin.1 +++ b/usr.bin/btpin/btpin.1 @@ -78,12 +78,12 @@ Specify path to the control socket. The default path is .Pa /var/run/bthcid . .El -.Sh EXIT STATUS -.Ex -std .Sh FILES .Bl -tag -compact .It Pa /var/run/bthcid .El +.Sh EXIT STATUS +.Ex -std .Sh SEE ALSO .Xr btconfig 8 , .Xr bthcid 8 diff --git a/usr.bin/pkg_radd/pkg_radd.1 b/usr.bin/pkg_radd/pkg_radd.1 index 3fa8388..e1fa829 100644 --- a/usr.bin/pkg_radd/pkg_radd.1 +++ b/usr.bin/pkg_radd/pkg_radd.1 @@ -96,12 +96,12 @@ to fetch packages from the European mirror: .Xr pkg_info 1 , .Xr pkg_search 1 , .Xr pkgsrc 7 -.Sh AUTHORS -.Nm -was written by -.An Simon 'corecode' Schubert Aq corecode@fs.ei.tum.de . .Sh HISTORY The .Nm utility first appeared in .Dx 1.11 . +.Sh AUTHORS +.Nm +was written by +.An Simon 'corecode' Schubert Aq corecode@fs.ei.tum.de . diff --git a/usr.bin/pkg_search/pkg_search.1 b/usr.bin/pkg_search/pkg_search.1 index ac0b44d..13d391a 100644 --- a/usr.bin/pkg_search/pkg_search.1 +++ b/usr.bin/pkg_search/pkg_search.1 @@ -90,12 +90,12 @@ command: .Xr pkg_info 1 , .Xr pkg_summary 5 , .Xr pkgsrc 7 -.Sh AUTHORS -.Nm -was written by -.An Matthias Schmidt Aq matthias@dragonflybsd.org . .Sh HISTORY The .Nm utility first appeared in .Dx 1.11 . +.Sh AUTHORS +.Nm +was written by +.An Matthias Schmidt Aq matthias@dragonflybsd.org . diff --git a/usr.bin/rfcomm_sppd/rfcomm_sppd.1 b/usr.bin/rfcomm_sppd/rfcomm_sppd.1 index 3f7a7ec..2f91b36 100644 --- a/usr.bin/rfcomm_sppd/rfcomm_sppd.1 +++ b/usr.bin/rfcomm_sppd/rfcomm_sppd.1 @@ -160,8 +160,6 @@ made, and operate over the named pair. Otherwise, stdin/stdout will be used. .El -.Sh EXIT STATUS -.Ex -std .Sh FILES .Bl -tag -width ".Pa /dev/tty[p-sP-S][0-9a-v]" -compact .It Pa /dev/pty[p-sP-S][0-9a-v] @@ -169,6 +167,8 @@ master pseudo terminals .It Pa /dev/tty[p-sP-S][0-9a-v] slave pseudo terminals .El +.Sh EXIT STATUS +.Ex -std .Sh EXAMPLES .Dl rfcomm_sppd -a 00:01:02:03:04:05 -s 1 -t /dev/ttyp1 .Pp diff --git a/usr.bin/vknet/vknet.1 b/usr.bin/vknet/vknet.1 index 24cb6de..202df82 100644 --- a/usr.bin/vknet/vknet.1 +++ b/usr.bin/vknet/vknet.1 @@ -105,10 +105,6 @@ run on the remote side of the link to use stdin and stdout as its remote specification. This option is typically not specified manually. .El -.Sh EXAMPLES -.Li "vknet -r 5 /dev/vknet myhomesystem:/dev/vknet" -.Pp -.Li "vknet -r 5 -b bridge0 -B bridge0 auto myhomesystem:auto" .Sh REQUIREMENTS You may have to load the .Ar if_tap @@ -130,8 +126,10 @@ Socket typically connects to, established by .Xr vknetd 8 . .El -.Sh BUGS -There are currently no known bugs. +.Sh EXAMPLES +.Li "vknet -r 5 /dev/vknet myhomesystem:/dev/vknet" +.Pp +.Li "vknet -r 5 -b bridge0 -B bridge0 auto myhomesystem:auto" .Sh SEE ALSO .Xr vke 4 , .Xr vkernel 7 , @@ -142,3 +140,5 @@ The command was written by Matthew Dillon and first appeared in .Dx 1.13 in May 2008. +.Sh BUGS +There are currently no known bugs. diff --git a/usr.sbin/adduser/adduser.conf.5 b/usr.sbin/adduser/adduser.conf.5 index ec63433..9eea06d 100644 --- a/usr.sbin/adduser/adduser.conf.5 +++ b/usr.sbin/adduser/adduser.conf.5 @@ -209,6 +209,9 @@ The .Nm manual page first appeared in .Fx 5.3 . +.Sh AUTHORS +This manual page was written by +.An Tom Rhodes Aq trhodes@FreeBSD.org . .Sh BUGS The internal variables documented here may change without notice. Do not rely on them. @@ -217,6 +220,3 @@ To modify this file invoke with the .Fl C option instead. -.Sh AUTHORS -This manual page was written by -.An Tom Rhodes Aq trhodes@FreeBSD.org . diff --git a/usr.sbin/mailwrapper/mailwrapper.8 b/usr.sbin/mailwrapper/mailwrapper.8 index 87cd075..f6caea1 100644 --- a/usr.sbin/mailwrapper/mailwrapper.8 +++ b/usr.sbin/mailwrapper/mailwrapper.8 @@ -123,9 +123,6 @@ option with .Va daily_status_include_submit_mailq should be turned off in .Pa /etc/periodic.conf . -.Sh EXIT STATUS -.Nm -exits 0 on success, and \*[Gt]0 if an error occurs. .Sh FILES Configuration for .Nm @@ -135,6 +132,9 @@ is kept in is typically set up as a symbolic link to .Nm which is not usually invoked on its own. +.Sh EXIT STATUS +.Nm +exits 0 on success, and \*[Gt]0 if an error occurs. .Sh DIAGNOSTICS The .Nm diff --git a/usr.sbin/sdpd/sdpd.8 b/usr.sbin/sdpd/sdpd.8 index 23921e8..2db345e 100644 --- a/usr.sbin/sdpd/sdpd.8 +++ b/usr.sbin/sdpd/sdpd.8 @@ -144,8 +144,6 @@ as RFCOMM channels etc., before registering the service. .Sh SEE ALSO .Xr sdpquery 1 , .Xr sdp 3 -.Sh AUTHORS -.An Maksim Yevmenkin Aq m_evmenkin@yahoo.com .Sh HISTORY The .Nm @@ -159,6 +157,8 @@ under the sponsorship of .An Itronix, Inc. It was imported into .Dx 1.11 . +.Sh AUTHORS +.An Maksim Yevmenkin Aq m_evmenkin@yahoo.com .Sh BUGS Most likely. Please report if found. diff --git a/usr.sbin/vknetd/vknetd.8 b/usr.sbin/vknetd/vknetd.8 index d6100a9..2117b63 100644 --- a/usr.sbin/vknetd/vknetd.8 +++ b/usr.sbin/vknetd/vknetd.8 @@ -121,16 +121,6 @@ bootp .Xr ( dhclient 8 ) can get through. .El -.Sh EXAMPLES -.Li "vknetd 10.1.0.1/16" -.Sh REQUIREMENTS -.Nm -requires that the -.Ar if_tap -and -.Ar if_bridge -modules be loaded. -In addition, a 'vknet' group must exist in /etc/groups. .Sh FILES .Bl -tag -width /var/log/lastlog -compact .It Pa /dev/tap* @@ -142,14 +132,16 @@ Default socket .Nm sits on waiting for connections. .El -.Sh BUGS -.Nm -defaults to secure mode and will prevent IP spoofing, but the security -does not yet handle ARP issues so ARP spoofing can be used to create a -denial of service attack on the host network. -.Pp +.Sh EXAMPLES +.Li "vknetd 10.1.0.1/16" +.Sh REQUIREMENTS .Nm -does not currently implement a timeout for its MAC cache. +requires that the +.Ar if_tap +and +.Ar if_bridge +modules be loaded. +In addition, a 'vknet' group must exist in /etc/groups. .Sh SEE ALSO .Xr vknet 1 , .Xr vke 4 , @@ -160,3 +152,11 @@ The command was written by Matthew Dillon and first appeared in .Dx 1.13 in May 2008. +.Sh BUGS +.Nm +defaults to secure mode and will prevent IP spoofing, but the security +does not yet handle ARP issues so ARP spoofing can be used to create a +denial of service attack on the host network. +.Pp +.Nm +does not currently implement a timeout for its MAC cache.