Date: Mon, 2 Dec 1996 11:20:03 -0800 (PST) From: S Sigala <ssigala@globalnet.it> To: freebsd-bugs Subject: Re: docs/2134: Some fixes to man pages (typos, mdoc style, etc.) Message-ID: <199612021920.LAA06979@freefall.freebsd.org>
next in thread | raw e-mail | index | archive | help
The following reply was made to PR docs/2134; it has been noted by GNATS. From: S Sigala <ssigala@globalnet.it> To: FreeBSD-gnats-submit@freebsd.org Cc: Subject: Re: docs/2134: Some fixes to man pages (typos, mdoc style, etc.) Date: Mon, 2 Dec 1996 21:12:12 +0100 (MET) On Mon, 2 Dec 1996, Garrett Wollman wrote: > > +.br > > It is an error to use .[a-z][a-z] requests in a -mdoc page. Only > .[A-Z][a-z] requests are permitted. > > > +.Va MANPATH > > Should be .Ev. > Argh... sorry, i have broken instead of fixing :-( anyway.. i have some other (.Xr) fixes... please take a look, thanks for your patience :-) Index: share/man/man3/sysexits.3 =================================================================== RCS file: /usr/local/FreeBSD-CVS/src/share/man/man3/sysexits.3,v retrieving revision 1.2 diff -u -r1.2 sysexits.3 --- sysexits.3 1996/04/08 04:18:00 1.2 +++ sysexits.3 1996/12/02 18:57:14 @@ -117,7 +117,7 @@ parenthesis for easy reference. .Sh SEE ALSO .Xr exit 3 , -.Xr style 9 . +.Xr style 9 .Sh HISTORY The .Nm sysexits Index: share/man/man4/ccd.4 =================================================================== RCS file: /usr/local/FreeBSD-CVS/src/share/man/man4/ccd.4,v retrieving revision 1.4 diff -u -r1.4 ccd.4 --- ccd.4 1996/11/07 04:10:55 1.4 +++ ccd.4 1996/12/02 18:59:17 @@ -112,4 +112,4 @@ .Xr disklabel 8 , .Xr fsck 8 , .Xr mount 8 , -.Xr newfs 8 . +.Xr newfs 8 Index: share/man/man4/ch.4 =================================================================== RCS file: /usr/local/FreeBSD-CVS/src/share/man/man4/ch.4,v retrieving revision 1.5 diff -u -r1.5 ch.4 --- ch.4 1996/10/18 20:22:03 1.5 +++ ch.4 1996/12/02 19:28:18 @@ -107,5 +107,4 @@ .Sh HISTORY The .Nm -driver appeared in 386BSD 0.1 - +driver appeared in 386BSD 0.1. Index: share/man/man4/divert.4 =================================================================== RCS file: /usr/local/FreeBSD-CVS/src/share/man/man4/divert.4,v retrieving revision 1.2 diff -u -r1.2 divert.4 --- divert.4 1996/07/11 02:08:30 1.2 +++ divert.4 1996/12/02 19:01:50 @@ -127,8 +127,8 @@ .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 Index: share/man/man4/ifmib.4 =================================================================== RCS file: /usr/local/FreeBSD-CVS/src/share/man/man4/ifmib.4,v retrieving revision 1.1 diff -u -r1.1 ifmib.4 --- ifmib.4 1996/11/15 19:49:41 1.1 +++ ifmib.4 1996/12/02 19:28:44 @@ -179,4 +179,3 @@ .Nm interface first appeared in .Fx 2.2 . - Index: share/man/man4/intro.4 =================================================================== RCS file: /usr/local/FreeBSD-CVS/src/share/man/man4/intro.4,v retrieving revision 1.3 diff -u -r1.3 intro.4 --- intro.4 1996/08/21 22:01:14 1.3 +++ intro.4 1996/12/02 19:28:48 @@ -162,8 +162,8 @@ .Xr socket 2 , .Xr hier 7 , .Xr config 8 , -.Xr MAKEDEV 8 , -.Xr devfs 5 Pq not yet existent . +.Xr MAKEDEV 8 +.\" Xr devfs 5 Pq not yet existent . .Sh AUTHORS This man page has been written by .if t J\(:org Wunsch @@ -173,4 +173,3 @@ .Nm intro appeared in .Fx 2.1 . - Index: share/man/man4/scsi.4 =================================================================== RCS file: /usr/local/FreeBSD-CVS/src/share/man/man4/scsi.4,v retrieving revision 1.6 diff -u -r1.6 scsi.4 --- scsi.4 1996/10/18 20:22:13 1.6 +++ scsi.4 1996/12/02 19:29:21 @@ -182,4 +182,3 @@ This .Nm system appeared in MACH 2.5 at TRW. - Index: share/man/man4/su.4 =================================================================== RCS file: /usr/local/FreeBSD-CVS/src/share/man/man4/su.4,v retrieving revision 1.5 diff -u -r1.5 su.4 --- su.4 1996/10/18 20:22:25 1.5 +++ su.4 1996/12/02 19:29:34 @@ -79,5 +79,4 @@ .Sh HISTORY The .Nm -driver appeared in 386BSD 0.1 - +driver appeared in 386BSD 0.1. Index: share/man/man4/tp.4 =================================================================== RCS file: /usr/local/FreeBSD-CVS/src/share/man/man4/tp.4,v retrieving revision 1.3 diff -u -r1.3 tp.4 --- tp.4 1996/10/05 18:37:23 1.3 +++ tp.4 1996/12/02 19:00:13 @@ -680,7 +680,7 @@ .Xr iso 4 , .Xr clnp 4 , .Xr cltp 4 , -.Xr ifconfig 8 . +.Xr ifconfig 8 .Sh BUGS The protocol definition of expedited data is slightly problematic, in a way that renders expedited data almost useless, Index: share/man/man4/uk.4 =================================================================== RCS file: /usr/local/FreeBSD-CVS/src/share/man/man4/uk.4,v retrieving revision 1.6 diff -u -r1.6 uk.4 --- uk.4 1996/10/18 20:22:31 1.6 +++ uk.4 1996/12/02 19:29:52 @@ -91,5 +91,4 @@ .Sh HISTORY The .Nm -driver appeared in 386BSD 0.1 - +driver appeared in 386BSD 0.1. Index: share/man/man4/worm.4 =================================================================== RCS file: /usr/local/FreeBSD-CVS/src/share/man/man4/worm.4,v retrieving revision 1.6 diff -u -r1.6 worm.4 --- worm.4 1996/08/21 22:01:17 1.6 +++ worm.4 1996/12/02 19:06:02 @@ -240,7 +240,7 @@ .Xr open 2 , .Xr ioctl 2 , .Xr write 2 , -.Xr close 2 . +.Xr close 2 .Sh AUTHORS The first skeleton for a .Nm Index: share/man/man4/man4.i386/cy.4 =================================================================== RCS file: /usr/local/FreeBSD-CVS/src/share/man/man4/man4.i386/cy.4,v retrieving revision 1.1 diff -u -r1.1 cy.4 --- cy.4 1995/10/10 09:34:21 1.1 +++ cy.4 1996/12/02 19:11:56 @@ -199,7 +199,7 @@ .Xr tty 4 , .Xr termios 4 , .Xr comcontrol 8 , -.Xr stty 1 . +.Xr stty 1 .Sh HISTORY The .Nm Index: share/man/man4/man4.i386/dgb.4 =================================================================== RCS file: /usr/local/FreeBSD-CVS/src/share/man/man4/man4.i386/dgb.4,v retrieving revision 1.1 diff -u -r1.1 dgb.4 --- dgb.4 1995/10/17 17:38:42 1.1 +++ dgb.4 1996/12/02 19:07:39 @@ -339,7 +339,7 @@ .Xr comcontrol 8 , .\" XXX add next line to many other drivers. .Xr MAKEDEV 8 , -.Xr stty 1 . +.Xr stty 1 .Sh HISTORY The .Nm Index: share/man/man4/man4.i386/lp.4 =================================================================== RCS file: /usr/local/FreeBSD-CVS/src/share/man/man4/man4.i386/lp.4,v retrieving revision 1.1 diff -u -r1.1 lp.4 --- lp.4 1996/03/05 16:49:57 1.1 +++ lp.4 1996/12/02 19:31:42 @@ -230,4 +230,3 @@ 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. - Index: share/man/man4/man4.i386/pcvt.4 =================================================================== RCS file: /usr/local/FreeBSD-CVS/src/share/man/man4/man4.i386/pcvt.4,v retrieving revision 1.3 diff -u -r1.3 pcvt.4 --- pcvt.4 1996/07/04 00:42:09 1.3 +++ pcvt.4 1996/12/02 19:12:37 @@ -859,7 +859,7 @@ .Xr pc 4 , .Xr config 8 , .Xr intro 2 , -.Xr ioctl 2 . +.Xr ioctl 2 .Sh BUGS Certainly existent. See the file .Pa BugList Index: share/man/man4/man4.i386/si.4 =================================================================== RCS file: /usr/local/FreeBSD-CVS/src/share/man/man4/man4.i386/si.4,v retrieving revision 1.4 diff -u -r1.4 si.4 --- si.4 1996/02/12 01:20:36 1.4 +++ si.4 1996/12/02 19:09:44 @@ -131,7 +131,7 @@ .Xr tty 4 , .Xr sio 4 , .Xr sicontrol 8 , -.Xr comcontrol 8 . +.Xr comcontrol 8 .\" .Sh STANDARDS .Sh HISTORY This driver is loosely based on driver code originating at Specialix, which Index: share/man/man4/man4.i386/sio.4 =================================================================== RCS file: /usr/local/FreeBSD-CVS/src/share/man/man4/man4.i386/sio.4,v retrieving revision 1.18 diff -u -r1.18 sio.4 --- sio.4 1995/12/29 12:51:32 1.18 +++ sio.4 1996/12/02 19:10:12 @@ -285,7 +285,7 @@ .Xr tty 4 , .Xr termios 4 , .Xr comcontrol 8 , -.Xr stty 1 . +.Xr stty 1 .Sh HISTORY The .Nm Index: share/man/man5/fstab.5 =================================================================== RCS file: /usr/local/FreeBSD-CVS/src/share/man/man5/fstab.5,v retrieving revision 1.5 diff -u -r1.5 fstab.5 --- fstab.5 1996/11/10 02:23:33 1.5 +++ fstab.5 1996/12/02 19:13:37 @@ -245,7 +245,7 @@ .Xr quotacheck 8 , .Xr quotaon 8 , .Xr swapon 8 , -.Xr umount 8 . +.Xr umount 8 .Sh HISTORY The .Nm Index: share/man/man5/hosts.equiv.5 =================================================================== RCS file: /usr/local/FreeBSD-CVS/src/share/man/man5/hosts.equiv.5,v retrieving revision 1.2 diff -u -r1.2 hosts.equiv.5 --- hosts.equiv.5 1996/10/05 18:37:26 1.2 +++ hosts.equiv.5 1996/12/02 19:42:12 @@ -119,8 +119,7 @@ .Xr inet 3 , .Xr ifconfig 8 , .Xr named 8 , -.Xr yp 4 . +.Xr yp 4 .Sh BUGS This man page is incomplete. For more information read the source in lib/libc/net/rcmd.c or the sunos man page. - Index: share/man/man5/hosts.lpd.5 =================================================================== RCS file: /usr/local/FreeBSD-CVS/src/share/man/man5/hosts.lpd.5,v retrieving revision 1.2 diff -u -r1.2 hosts.lpd.5 --- hosts.lpd.5 1996/07/11 02:47:00 1.2 +++ hosts.lpd.5 1996/12/02 19:13:51 @@ -50,4 +50,4 @@ .Pa /etc . .Sh SEE ALSO .Xr printcap 5 , -.Xr lpd 8 . +.Xr lpd 8 Index: share/man/man5/link.5 =================================================================== RCS file: /usr/local/FreeBSD-CVS/src/share/man/man5/link.5,v retrieving revision 1.7 diff -u -r1.7 link.5 --- link.5 1996/10/05 18:37:27 1.7 +++ link.5 1996/12/02 19:42:18 @@ -571,8 +571,6 @@ .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. - Index: share/man/man5/passwd.5 =================================================================== RCS file: /usr/local/FreeBSD-CVS/src/share/man/man5/passwd.5,v retrieving revision 1.6 diff -u -r1.6 passwd.5 --- passwd.5 1996/08/22 23:51:58 1.6 +++ passwd.5 1996/12/02 19:42:29 @@ -583,4 +583,3 @@ The override capability was updated to properly support netgroups in .Fx 2.0.5 . - Index: share/man/man5/procfs.5 =================================================================== RCS file: /usr/local/FreeBSD-CVS/src/share/man/man5/procfs.5,v retrieving revision 1.2 diff -u -r1.2 procfs.5 --- procfs.5 1994/08/10 20:03:54 1.2 +++ procfs.5 1996/12/02 19:16:22 @@ -14,7 +14,7 @@ .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 , Index: share/man/man5/sysconfig.5 =================================================================== RCS file: /usr/local/FreeBSD-CVS/src/share/man/man5/sysconfig.5,v retrieving revision 1.5 diff -u -r1.5 sysconfig.5 --- sysconfig.5 1996/10/05 18:37:28 1.5 +++ sysconfig.5 1996/12/02 19:43:14 @@ -361,4 +361,3 @@ .Fx 2.0.5 . .Sh AUTHOR Jordan K. Hubbard. - Index: share/man/man7/hostname.7 =================================================================== RCS file: /usr/local/FreeBSD-CVS/src/share/man/man7/hostname.7,v retrieving revision 1.1.1.1 diff -u -r1.1.1.1 hostname.7 --- hostname.7 1994/05/30 19:08:56 1.1.1.1 +++ hostname.7 1996/12/02 19:44:02 @@ -89,4 +89,5 @@ .Xr named 8 .Sh HISTORY .Nm Hostname -appeared in 4.2 BSD. +appeared in +.Bx 4.2 . Index: share/man/man7/intro.7 =================================================================== RCS file: /usr/local/FreeBSD-CVS/src/share/man/man7/intro.7,v retrieving revision 1.1.1.1 diff -u -r1.1.1.1 intro.7 --- intro.7 1994/05/30 19:08:56 1.1.1.1 +++ intro.7 1996/12/02 19:19:35 @@ -56,5 +56,7 @@ .Cw .De .Sh HISTORY +The .Nm intro -appeared in 4.2 BSD. +section manual page appeared in +.Bx 4.2 . Index: share/man/man8/man8.i386/MAKEDEV.8 =================================================================== RCS file: /usr/local/FreeBSD-CVS/src/share/man/man8/man8.i386/MAKEDEV.8,v retrieving revision 1.5 diff -u -r1.5 MAKEDEV.8 --- MAKEDEV.8 1996/08/24 16:44:23 1.5 +++ MAKEDEV.8 1996/12/02 19:44:55 @@ -86,6 +86,6 @@ .It Pa /dev The special file directory. .Sh SEE ALSO -.Xr intro 4 +.Xr intro 4 , .Xr config 8 , .Xr mknod 8 Index: share/man/man9/copy.9 =================================================================== RCS file: /usr/local/FreeBSD-CVS/src/share/man/man9/copy.9,v retrieving revision 1.1 diff -u -r1.1 copy.9 --- copy.9 1996/04/15 21:37:06 1.1 +++ copy.9 1996/12/02 19:22:54 @@ -127,4 +127,4 @@ bytes. .Sh SEE ALSO .Xr fetch 9 , -.Xr store 9 . +.Xr store 9 Index: share/man/man9/fetch.9 =================================================================== RCS file: /usr/local/FreeBSD-CVS/src/share/man/man9/fetch.9,v retrieving revision 1.1 diff -u -r1.1 fetch.9 --- fetch.9 1996/04/15 21:37:06 1.1 +++ fetch.9 1996/12/02 19:23:32 @@ -82,4 +82,4 @@ functions return the data fetched or -1 on failure. .Sh SEE ALSO .Xr copy 9 , -.Xr store 9 . +.Xr store 9 Index: share/man/man9/intro.9 =================================================================== RCS file: /usr/local/FreeBSD-CVS/src/share/man/man9/intro.9,v retrieving revision 1.4 diff -u -r1.4 intro.9 --- intro.9 1996/08/21 21:43:28 1.4 +++ intro.9 1996/12/02 19:22:10 @@ -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 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 @@ .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 Index: share/man/man9/store.9 =================================================================== RCS file: /usr/local/FreeBSD-CVS/src/share/man/man9/store.9,v retrieving revision 1.1 diff -u -r1.1 store.9 --- store.9 1996/04/15 21:37:07 1.1 +++ store.9 1996/12/02 19:24:14 @@ -82,4 +82,4 @@ functions return 0 on success or -1 on failure. .Sh SEE ALSO .Xr copy 9 , -.Xr fetch 9 . +.Xr fetch 9 Index: share/man/man9/style.9 =================================================================== RCS file: /usr/local/FreeBSD-CVS/src/share/man/man9/style.9,v retrieving revision 1.11 diff -u -r1.11 style.9 --- style.9 1996/08/24 10:49:09 1.11 +++ style.9 1996/12/02 19:45:31 @@ -437,5 +437,3 @@ 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. - - Index: share/man/man9/suser.9 =================================================================== RCS file: /usr/local/FreeBSD-CVS/src/share/man/man9/suser.9,v retrieving revision 1.1 diff -u -r1.1 suser.9 --- suser.9 1996/10/16 21:14:32 1.1 +++ suser.9 1996/12/02 19:24:52 @@ -55,8 +55,6 @@ 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 @@ of some other implimentations of .Nm in which a TRUE response indicates Super powers. -
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?199612021920.LAA06979>