summaryrefslogtreecommitdiffstats
path: root/share/man
diff options
context:
space:
mode:
authormpp <mpp@FreeBSD.org>1996-12-09 07:45:59 +0000
committermpp <mpp@FreeBSD.org>1996-12-09 07:45:59 +0000
commitd6dadb5ec6ac6513241ce76b28eadc974e1ddc92 (patch)
treed7eca7690fa47b3e5b84d52a8a5b8cf39a97ffe6 /share/man
parent5c59f6cd6ec2e8e77abc45ff48cc70de7135dfb3 (diff)
downloadFreeBSD-src-d6dadb5ec6ac6513241ce76b28eadc974e1ddc92.zip
FreeBSD-src-d6dadb5ec6ac6513241ce76b28eadc974e1ddc92.tar.gz
Minor formatting/style fixes.
Submitted by: Sandro Sigala <sandro@cat.local.net> as part of PR # 2134
Diffstat (limited to 'share/man')
-rw-r--r--share/man/man4/ch.45
-rw-r--r--share/man/man4/divert.44
-rw-r--r--share/man/man4/ifmib.43
-rw-r--r--share/man/man4/intro.43
-rw-r--r--share/man/man4/man4.i386/lp.41
-rw-r--r--share/man/man4/scsi.43
-rw-r--r--share/man/man4/su.45
-rw-r--r--share/man/man4/uk.45
-rw-r--r--share/man/man5/link.54
-rw-r--r--share/man/man5/passwd.51
-rw-r--r--share/man/man5/procfs.54
-rw-r--r--share/man/man5/sysconfig.53
-rw-r--r--share/man/man7/hostname.73
-rw-r--r--share/man/man7/intro.74
-rw-r--r--share/man/man7/mailaddr.73
-rw-r--r--share/man/man9/intro.922
-rw-r--r--share/man/man9/style.96
-rw-r--r--share/man/man9/suser.93
18 files changed, 32 insertions, 50 deletions
diff --git a/share/man/man4/ch.4 b/share/man/man4/ch.4
index 9bba368..0931f64 100644
--- a/share/man/man4/ch.4
+++ b/share/man/man4/ch.4
@@ -1,4 +1,4 @@
-.\" $Id: ch.4,v 1.4 1996/09/23 22:23:30 wosch Exp $
+.\" $Id: ch.4,v 1.5 1996/10/18 20:22:03 julian Exp $
.\" Copyright (c) 1996
.\" Julian Elischer <julian@freebsd.org>. All rights reserved.
.\"
@@ -107,5 +107,4 @@ None.
.Sh HISTORY
The
.Nm
-driver appeared in 386BSD 0.1
-
+driver appeared in 386BSD 0.1.
diff --git a/share/man/man4/divert.4 b/share/man/man4/divert.4
index 6f52ae1..81ab14e 100644
--- a/share/man/man4/divert.4
+++ b/share/man/man4/divert.4
@@ -127,8 +127,8 @@ that was not associated with any interface.
.Xr ipfw 8 ,
.Xr socket 2 ,
.Xr bind 2 ,
-.Xr sendto 2 .
-.Xr recvfrom 2 ,
+.Xr sendto 2 ,
+.Xr recvfrom 2 .
.Sh BUGS
This is an attempt to provide a clean way for user mode processes
to implement various IP tricks like address translation, but it
diff --git a/share/man/man4/ifmib.4 b/share/man/man4/ifmib.4
index 7553296..99416e5 100644
--- a/share/man/man4/ifmib.4
+++ b/share/man/man4/ifmib.4
@@ -25,7 +25,7 @@
.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $Id$
+.\" $Id: ifmib.4,v 1.1 1996/11/15 19:49:41 wollman Exp $
.\"
.Dd November 15, 1996
.Dt IFMIB 4
@@ -179,4 +179,3 @@ The
.Nm
interface first appeared in
.Fx 2.2 .
-
diff --git a/share/man/man4/intro.4 b/share/man/man4/intro.4
index 37fb8c7..e2d42e2 100644
--- a/share/man/man4/intro.4
+++ b/share/man/man4/intro.4
@@ -23,7 +23,7 @@
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
-.\" $Id: intro.4,v 1.2 1996/02/11 22:37:26 mpp Exp $
+.\" $Id: intro.4,v 1.3 1996/08/21 22:01:14 mpp Exp $
.\"
.Dd January 20, 1996
.Dt INTRO 4
@@ -173,4 +173,3 @@ with initial input by David E. O'Brien.
.Nm intro
appeared in
.Fx 2.1 .
-
diff --git a/share/man/man4/man4.i386/lp.4 b/share/man/man4/man4.i386/lp.4
index b2de78b..cac44ac 100644
--- a/share/man/man4/man4.i386/lp.4
+++ b/share/man/man4/man4.i386/lp.4
@@ -230,4 +230,3 @@ in the case of LPIP mode.
Polling timeouts are controlled by counting loop iterations rather than
timers, and so are dependent on CPU speed. This is somewhat stabilised
by the need to perform (slow) ISA bus cycles to actually read the port.
-
diff --git a/share/man/man4/scsi.4 b/share/man/man4/scsi.4
index 887f5b9..7447633 100644
--- a/share/man/man4/scsi.4
+++ b/share/man/man4/scsi.4
@@ -1,4 +1,4 @@
-.\" $Id: scsi.4,v 1.5 1996/09/23 22:23:33 wosch Exp $
+.\" $Id: scsi.4,v 1.6 1996/10/18 20:22:13 julian Exp $
.\" Copyright (c) 1996
.\" Julian Elischer <julian@freebsd.org>. All rights reserved.
.\"
@@ -182,4 +182,3 @@ Bit 3 shows more detailed information including DMA scatter-gather logs.
This
.Nm
system appeared in MACH 2.5 at TRW.
-
diff --git a/share/man/man4/su.4 b/share/man/man4/su.4
index 0d360bd..37609ce 100644
--- a/share/man/man4/su.4
+++ b/share/man/man4/su.4
@@ -1,4 +1,4 @@
-.\" $Id: su.4,v 1.4 1996/09/23 22:23:37 wosch Exp $
+.\" $Id: su.4,v 1.5 1996/10/18 20:22:25 julian Exp $
.\" Copyright (c) 1996
.\" Julian Elischer <julian@freebsd.org>. All rights reserved.
.\"
@@ -79,5 +79,4 @@ devices.
.Sh HISTORY
The
.Nm
-driver appeared in 386BSD 0.1
-
+driver appeared in 386BSD 0.1.
diff --git a/share/man/man4/uk.4 b/share/man/man4/uk.4
index a28c451..42ad9b9 100644
--- a/share/man/man4/uk.4
+++ b/share/man/man4/uk.4
@@ -1,4 +1,4 @@
-.\" $Id: uk.4,v 1.5 1996/09/23 22:23:40 wosch Exp $
+.\" $Id: uk.4,v 1.6 1996/10/18 20:22:31 julian Exp $
.\" Copyright (c) 1996
.\" Julian Elischer <julian@freebsd.org>. All rights reserved.
.\"
@@ -91,5 +91,4 @@ devices.
.Sh HISTORY
The
.Nm
-driver appeared in 386BSD 0.1
-
+driver appeared in 386BSD 0.1.
diff --git a/share/man/man5/link.5 b/share/man/man5/link.5
index b42e0d2..db5e769 100644
--- a/share/man/man5/link.5
+++ b/share/man/man5/link.5
@@ -26,7 +26,7 @@
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
-.\" $Id: link.5,v 1.6 1996/05/01 01:45:22 bde Exp $
+.\" $Id: link.5,v 1.7 1996/10/05 18:37:27 wosch Exp $
.\"
.Dd October 23, 1993
.Dt LINK 5
@@ -571,8 +571,6 @@ The number of valid entries in
.It Fa hi_next
Next bucket in case of hashing collisions.
.El
-
.Sh CAVEATS
Only the (GNU) C compiler currently supports the creation of shared libraries.
Other programming languages can not be used.
-
diff --git a/share/man/man5/passwd.5 b/share/man/man5/passwd.5
index ff31599..4335391 100644
--- a/share/man/man5/passwd.5
+++ b/share/man/man5/passwd.5
@@ -583,4 +583,3 @@ and first appeared in
The override capability was updated to properly support netgroups
in
.Fx 2.0.5 .
-
diff --git a/share/man/man5/procfs.5 b/share/man/man5/procfs.5
index 71d38d9..ab4666d 100644
--- a/share/man/man5/procfs.5
+++ b/share/man/man5/procfs.5
@@ -1,4 +1,4 @@
-.\" $Id: procfs.5,v 1.1 1994/08/10 20:03:06 wollman Exp $
+.\" $Id: procfs.5,v 1.2 1994/08/10 20:03:54 wollman Exp $
.\" Written by Garrett Wollman
.\" This file is in the public domain.
.\"
@@ -14,7 +14,7 @@ proc /proc procfs rw 0 0
.Ed
.Sh DESCRIPTION
The process file system, or
-.Nm ,
+.Nm procfs ,
implements a view of the system process table inside the file system.
It is normally mounted on
.Pa /proc ,
diff --git a/share/man/man5/sysconfig.5 b/share/man/man5/sysconfig.5
index 09b6a19..633931b 100644
--- a/share/man/man5/sysconfig.5
+++ b/share/man/man5/sysconfig.5
@@ -22,7 +22,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $Id: sysconfig.5,v 1.4 1996/08/21 22:01:46 mpp Exp $
+.\" $Id: sysconfig.5,v 1.5 1996/10/05 18:37:28 wosch Exp $
.\"
.Dd December 18, 1995
.Dt SYSCONFIG 5
@@ -361,4 +361,3 @@ file appeared in
.Fx 2.0.5 .
.Sh AUTHOR
Jordan K. Hubbard.
-
diff --git a/share/man/man7/hostname.7 b/share/man/man7/hostname.7
index 719ae0f..3335e16 100644
--- a/share/man/man7/hostname.7
+++ b/share/man/man7/hostname.7
@@ -89,4 +89,5 @@ by a system-wide configuration file (see
.Xr named 8
.Sh HISTORY
.Nm Hostname
-appeared in 4.2 BSD.
+appeared in
+.Bx 4.2 .
diff --git a/share/man/man7/intro.7 b/share/man/man7/intro.7
index 07ef6a8..6d7ce58 100644
--- a/share/man/man7/intro.7
+++ b/share/man/man7/intro.7
@@ -56,5 +56,7 @@ in the area of text processing macro packages for
.Cw
.De
.Sh HISTORY
+The
.Nm intro
-appeared in 4.2 BSD.
+section manual page appeared in
+.Bx 4.2 .
diff --git a/share/man/man7/mailaddr.7 b/share/man/man7/mailaddr.7
index 96a98f9..bb22a8a 100644
--- a/share/man/man7/mailaddr.7
+++ b/share/man/man7/mailaddr.7
@@ -144,7 +144,8 @@ Crocker, D. H.,
RFC822.
.Sh HISTORY
.Nm Mailaddr
-appeared in 4.2 BSD.
+appeared in
+.Bx 4.2 .
.Sh BUGS
The RFC822 group syntax (``group:user1,user2,user3;'') is not supported
except in the special case of ``group:;'' because of a conflict with old
diff --git a/share/man/man9/intro.9 b/share/man/man9/intro.9
index a209499..dfed313 100644
--- a/share/man/man9/intro.9
+++ b/share/man/man9/intro.9
@@ -37,12 +37,11 @@
.Sh DESCRIPTION
This section contains information about the interfaces and
subroutines in the kernel.
-
.Sh PROTOTYPES ANSI-C AND ALL THAT
Yes please.
-
+.Pp
We would like all code to be fully prototyped.
-
+.Pp
If your code compiles cleanly with
.Nm cc
.Ar -Wall
@@ -52,21 +51,19 @@ It is important to understand that this isn't a question of just shutting up
it is a question about avoiding the things it complains about.
To put it bluntly, don't hide the problem by casting and other
obfuscating practices, solve the problem.
-
.Sh INDENTATION AND STYLE
Belive it or not, there actually exists a guide for indentation and style.
It isn't generally applied though.
-
+.Pp
We would appreciate if people would pay attention to it, and at least not
violate it blatantly.
-
+.Pp
We don't mind it too badly if you have your own style, but please make
sure we can read it too.
-
+.Pp
Please take time to read
.Xr style 9
for more information.
-
.Sh NAMING THINGS
Some general rules exist:
.Bl -enum
@@ -83,26 +80,23 @@ And the name of the procedure should start with the prefix
.Li DDB_
to clearly identify the procedure as a debugger routine.
.El
-
-
.Sh SCOPE OF SYMBOLS
It is important to carefully consider the scope of symbols in the kernel.
The default is to make everything static, unless some reason requires
the opposite.
-
+.Pp
There are several reasons for this policy,
the main one is that the kernel is one monolithic name-space,
and pollution is not a good idea here either.
-
+.Pp
For device drivers and other modules that don't add new internal interfaces
to the kernel, the entire source should be in one file it possible.
That way all symbols can be made static.
-
+.Pp
If for some reason a module is split over multiple source files, then try
to split the module along some major fault-line and consider using the
number of global symbols as your guide.
The fewer the better.
-
.Sh HISTORY
The
.Nm intro
diff --git a/share/man/man9/style.9 b/share/man/man9/style.9
index 91abc01..cd852e0 100644
--- a/share/man/man9/style.9
+++ b/share/man/man9/style.9
@@ -22,7 +22,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $Id: style.9,v 1.10 1996/08/22 16:55:15 wosch Exp $
+.\" $Id: style.9,v 1.11 1996/08/24 10:49:09 wosch Exp $
.\"
.Dd December 14, 1995
.Dt STYLE 9
@@ -39,7 +39,7 @@ files in the FreeBSD source tree.
*
* @(#)style 1.14 (Berkeley) 4/28/95
*
- * $Id: style.9,v 1.10 1996/08/22 16:55:15 wosch Exp $
+ * $Id: style.9,v 1.11 1996/08/24 10:49:09 wosch Exp $
*
*/
@@ -437,5 +437,3 @@ there.
This man page is largely based on the src/admin/style/style file from
the BSD 4.4-Lite2 release, with a few updates to reflect the current
practice and desire of the FreeBSD project.
-
-
diff --git a/share/man/man9/suser.9 b/share/man/man9/suser.9
index 30acaa8..7a81d48 100644
--- a/share/man/man9/suser.9
+++ b/share/man/man9/suser.9
@@ -55,8 +55,6 @@ then the usage is not noted. Because part of it's function is to notice
whether super powers have been used,
.Nm
should be called after other permission possibilities have been exhausted.
-
-
.Sh RETURN VALUES
The
.Nm
@@ -66,4 +64,3 @@ This is the
of some other implementations of
.Nm
in which a TRUE response indicates Super powers.
-
OpenPOWER on IntegriCloud