Commit Graph

536 Commits

Author SHA1 Message Date
Mike Pritchard
95522ed527 Minor mdoc cleanup - don't use .Pa for non-pathname items. 1997-03-21 20:16:33 +00:00
Mike Pritchard
dd5527c607 Use the .Fx macro for FreeBSD references for releases prior to 2.0.
Use the .Tn macro for generic FreeBSD references.  Cleanup other
formatting problems noticed while making the above changes.
1997-03-21 20:14:15 +00:00
Mike Pritchard
fb5ce63a63 Fix a number of typos and use the .Tn macro where appropriate. 1997-03-21 20:04:21 +00:00
Mike Pritchard
0728623156 Document the .An (author name) macro. Also cleanup some other problems
I noticed while editing these man pages.

Usage: .An Author_name

Example:

This manual page was written by
.An Mike Pritchard Aq mpp@FreeBSD.ORG .

Produces:

This manual page was written by Mike Pritchard <mpp@FreeBSD.ORG>.
1997-03-20 16:04:04 +00:00
Bruce Evans
eb051a2cf8 Fixed missing #includes in synopsis.
Fixed stale reference to <sys/inode.h>.
1997-03-19 21:02:11 +00:00
Mike Pritchard
8889d6ac3a Document the .Rv (return values) macro.
".Rv -std atexit" will generate the following text:

The atexit() function returns the value 0 if successful; otherwise the
value -1 is returned and the global variable errno is set to indicate the
error.
1997-03-19 21:01:45 +00:00
Bruce Evans
e0d9d675fb Fixed misuse of .Ft for enum members. (.Fa seems to be the best
available macro for enum, struct and union members.  .Ft seems to
be the best available macro for enum, struct and union tags and
types).

Fixed missing void arg types.
1997-03-19 20:42:18 +00:00
Mike Pritchard
5b945c8686 Update the table of contents such as it is to reflect my previous change. 1997-03-19 20:31:42 +00:00
Mike Pritchard
c41c97fab9 Document the previously undocumented .Bf (begin font mode) macro.
Moved the descriptions of the .Em, .Li and .Sy macros into
the new "Font Modes" sub-section along with .Bf, since they are
all related.
1997-03-19 20:16:50 +00:00
Bruce Evans
7b46e774ec Fixed missing #include of <sys/types.h> in synopsis. 1997-03-19 19:48:24 +00:00
Bruce Evans
ddbd069887 Fixed missing #include(s) (mostly of <sys/types.h> in synopsis).
Reviewed by:	wollman
1997-03-19 19:47:43 +00:00
Bruce Evans
c85c53625d Fixed synopsis (after the cleanup of <sys/snoop.h>, there are no other
prerequisites; previously <sys/ioctl.h> was bogus and some prerequisites
weren't documented).
1997-03-19 04:58:33 +00:00
Bruce Evans
401caa1438 Fixed wrong #include in synopsis. <sys/dir.h> has been deprecated for
years.

Not fixed: stale, misformatted copy of <dirent.h>.  I will be cleaning
up the dirent.h and dir.h headers soon (ufs stuff needs to be separated
better), so don't change the man page yet.
1997-03-19 03:48:12 +00:00
Bruce Evans
612a931654 Fixed missing #includes in synopsis. 1997-03-19 03:23:54 +00:00
Bruce Evans
21f8e39341 Fixed synopsis (wrong #includes and superfluous parentheses in typedef).
Nuked the confusing timeout_func_t typedef.  It will go away in <systm.h>
later.
1997-03-19 03:18:01 +00:00
Bruce Evans
02a98699c2 Fixed wrong number of args in STAILQ_REMOVE_HEAD() in synopsis. 1997-03-19 02:57:50 +00:00
Mike Pritchard
aef772c06b The "usage" line for the .Ic macro incorrectly says that it is
the .Li macro.
1997-03-18 20:00:36 +00:00
Mike Pritchard
5f1376d7ec Backout part of my previous change that changed MIN/TIME to VMIN/VTIME
throughout the man page.  Only some of these were corrected.

Pointed out by: bde
1997-03-18 07:17:22 +00:00
Mike Pritchard
ed7922d368 The VMIN and VTIME c_cc values were incorrectly defined as MIN and TIME.
Obtained from: NetBSD PR# 3243
1997-03-14 05:01:14 +00:00
Mike Pritchard
623899a3c3 Add some text regarding security issues when using a shell
script as the login shell.  Closes PR# 2978.
1997-03-14 02:37:27 +00:00
Mike Pritchard
0b65a99863 Oops. I misread some commit mail - remove the blurb about comments
in passwd/group not being enabled by default.
1997-03-12 14:05:36 +00:00
Mike Pritchard
c5cb834a27 Typo police (this one wasn't yours, Joerg :-) 1997-03-12 13:51:57 +00:00
Mike Pritchard
902c520a16 Typo police. 1997-03-12 13:51:17 +00:00
Mike Pritchard
f57cc79d87 Improve the wording of the section on comments in the group and passwd
files.  Also mention that this feature is not enabled by default
and that they must be enabled by compile-time options.

Fixed another typo or two I noticed while I was at it.
1997-03-12 13:46:16 +00:00
Joerg Wunsch
e48ff1868b Document the various link-level flag for these drivers.
2.2 candidate (after typo police :)
1997-03-12 13:37:56 +00:00
Wolfram Schneider
2641f58969 Sync with /etc/mtree/BSD.*.dist 1997-03-09 22:39:56 +00:00
John-Mark Gurney
c3df09bb7a replace non-existant ioctl [GP]IO_STRMAP with what really does exist,
[GS]ETFKEY...

Definately a 2.2 Candidate

a clean up of this page is to follow....  but I'm not sure I'll have it
before 2.2 is to be released...
1997-03-09 20:53:20 +00:00
Wolfram Schneider
22bf981261 Document comments. 1997-03-09 12:20:48 +00:00
Mike Pritchard
6aea1c7c74 The CIRCLEQ_ENTRY example was wrong. Part of PR# 2917. 1997-03-09 00:49:00 +00:00
Wolfram Schneider
f71e91691c Sync with /etc/mtree/BSD.root.dist. 1997-03-08 15:54:56 +00:00
Wolfram Schneider
c7fa2a6521 Add variable MAIL. 1997-03-08 14:41:44 +00:00
Mike Pritchard
eaa8b244f1 Some minor mdoc cleanup. 1997-03-07 03:32:31 +00:00
John-Mark Gurney
ac5afce161 add missing cvs Id lines. 1997-03-07 03:28:23 +00:00
Mike Pritchard
50e7a72d28 Update this man page to reflect how setattr manipulates time
values after the Lite2 merge.
1997-03-07 03:16:52 +00:00
John-Mark Gurney
7fbd615061 add missing cvs Id lines 1997-03-07 02:53:37 +00:00
John-Mark Gurney
892cb98e6b add missing cvs Id lines. 1997-03-07 02:50:01 +00:00
Doug Rabson
ffdbee2566 Formatting tweaks. 1997-03-04 10:02:44 +00:00
Mike Pritchard
3a9c9c6e42 Typo police. 1997-03-04 06:20:48 +00:00
Bruce Evans
0b7607eaaf Improved description of the device names. 1997-03-03 18:47:38 +00:00
Bruce Evans
3fbafe0fb2 Updated descriptions of minor numbers and files.
Refer to pstat.

Don't attempt to list all the model numbers.
1997-03-03 18:38:37 +00:00
Doug Rabson
fab63cc413 This is the current draft of my filesystem manpages. Some files are
incomplete and some are just placeholders but I wanted to try to get
something at least into 2.2 on the grounds that what I have is a lot
better than nothing.  I also wanted to commit something which documents
the interfaces in 2.2 before I start updating the documentation for 3.0.

This is a definite 2.2 candidate and is also relavent to 2.1 if people
still care about that branch.
1997-03-03 18:01:01 +00:00
Mike Pritchard
d0b67be00e The .Fx macro doesn't know about any of the 1.* FreeBSD releases. 1997-02-28 02:20:42 +00:00
Mike Pritchard
09edd56ac0 Correct section number in the .DT line.
Pointed out by: bde
1997-02-23 18:00:03 +00:00
Mike Pritchard
1dcb0e4fb1 Add i386 to the .Dt line. 1997-02-22 23:35:22 +00:00
John-Mark Gurney
2c8478e177 this manpage will actually make it's first appearance in 2.2.
2.2 Candidate
1997-02-22 23:20:54 +00:00
Mike Pritchard
3c3fafffa5 Remove an unneeded #include line.
Pointed-out-by: bde
1997-02-22 21:21:13 +00:00
Mike Pritchard
e4343c4e5a sysmouse.4 should be in man4.i386. 1997-02-22 21:19:55 +00:00
Peter Wemm
7e546392b5 Revert $FreeBSD$ to $Id$ 1997-02-22 15:12:41 +00:00
Peter Wemm
e25aeca937 Revert $FreeBSD$ back to $Id$ 1997-02-22 13:26:29 +00:00
John-Mark Gurney
f79219c3ea added man page for /dev/sysmouse. (and activate it)
plus add appropriate xrefs now that we have {cd,sd,st}.9
1997-02-20 15:14:59 +00:00
Justin T. Gibbs
2e3507efc7 Update to match reality. Give more indepth description of SCB paging
and tagged queueing.  Mention the AHC_ALLOW_MEMIO option.
1997-02-18 20:27:26 +00:00
Mike Pritchard
0f63118af8 These man pages will first appear in FreeBSD 2.2, not 3.0. 1997-02-17 15:22:20 +00:00
John-Mark Gurney
055ef91403 Bring intro(3) a bit closer to reality:
1)	comment out xref to non-existant libc(3)
2)	comment out reference to Fortran specific section (3f)
3)	add libkvm with reference to kvm(3)
4)	comment out xref to non-existant pc(1)
5)	comment out libplot and libplotf77
6)	fix problem with -ltermcap not being parenthesized
7)	sort files listing

still missing most of the libraries that exist in /usr/lib.

Closes PR#1151
1997-02-17 08:30:16 +00:00
Mike Pritchard
8b3a341046 Typo police. 1997-02-16 16:36:31 +00:00
Mike Pritchard
51ac664f83 Typo and style fixes. 1997-02-16 16:36:17 +00:00
Wolfram Schneider
e0d769c5c8 Install new intro.5 man page. 1997-02-16 12:13:32 +00:00
Wolfram Schneider
92f2618c58 Add cross references to apropos(1), intro(5), intro(6). 1997-02-16 12:12:00 +00:00
Wolfram Schneider
92eea88bbc Add directory man6 to SUBDIR 1997-02-16 11:35:05 +00:00
Wolfram Schneider
97750a7d6b Add an intro for games. 1997-02-16 11:30:03 +00:00
Mike Pritchard
6e768644e1 Style fixes. 1997-02-14 07:47:37 +00:00
Mike Pritchard
e334931601 Xref boot(9). 1997-02-14 07:08:17 +00:00
Mike Pritchard
4c14d8be74 Style fix. 1997-02-14 07:07:13 +00:00
Mike Pritchard
2f581b2bfa Add boot(9) Obtained from NetBSD w/modifications by me. 1997-02-14 07:06:26 +00:00
Mike Pritchard
88fc18877d Add MD5(9).
Obtained from: OpenBSD
1997-02-14 06:42:21 +00:00
Mike Pritchard
a195100836 Oops. I accidently removed fpa.4 from the install list (it is
a pending change...grr)

Submitted by:	bde
1997-02-14 05:18:02 +00:00
Mike Pritchard
3586b410dc Add sl(4) and ppp(4).
Obtained from: NetBSD
1997-02-13 18:48:25 +00:00
Mike Pritchard
9a16c56614 Add vn(4) to document vn pseudo-devices.
Obtained from: NetBSD
1997-02-13 18:29:30 +00:00
Mike Pritchard
8c21e889fd Add motd(5).
Obtained from:  NetBSD
1997-02-13 18:03:23 +00:00
Mike Pritchard
15623f37d0 Typo fix.
Obtained from: NetBSD
1997-02-13 17:38:31 +00:00
Mike Pritchard
d654cd00d6 Add psignal(9).
Obtained from: NetBSD
1997-02-13 17:19:50 +00:00
Mike Pritchard
d46ebd5820 Add panic(9).
Obtained from: NetBSD
1997-02-13 17:02:28 +00:00
David Nugent
408bc30d8c Update manpage; corrections, clarifications and login class (with xref). 1997-02-10 16:03:21 +00:00
Mike Pritchard
7b9099712a Update to reflect new Lite2 fs.h. 1997-02-10 07:10:08 +00:00
Mike Pritchard
076dc43ccb Typo police. 1997-02-09 21:08:52 +00:00
Joerg Wunsch
3cf493c646 Various man pages describing the internals of the SCSI subsystem.
Submitted by:	John-Mark Gurney <gurney_j@resnet.uoregon.edu>
1997-02-09 20:29:15 +00:00
Joerg Wunsch
92cc1cf79e Update to match the new reality. 1997-02-06 22:23:59 +00:00
Brian Somers
04f36f75da Incoming packets no longer have their ip_sum zero'd 1997-02-06 11:16:21 +00:00
Mike Pritchard
6a6c4c22d2 Fix a bunch of man pages to stop abusing the .Nm macro, along
with some other minor fixes for some problems I noticed
while making these changes.

Pointed out by:	bde
1997-02-05 15:07:37 +00:00
Mike Pritchard
b74774a0ad Fix a typo and one small style point. 1997-02-02 21:38:10 +00:00
Joerg Wunsch
c5ec806f68 Add a man page for the uio handling, after all the recent ramblings in
the hackers list.

Please correct me where i'm wrong.
1997-02-02 11:41:07 +00:00
Joerg Wunsch
f552063e6c Correct the synopsis of some EISA or PCI drivers. They don't take
ISA-like arguments (anymore).
1997-02-01 19:54:23 +00:00
Mike Pritchard
b3c6242fda Don't use hardcoded *roff escape sequences. Use mdoc macros instead. 1997-01-31 01:14:16 +00:00
Mike Pritchard
8f20a914b6 Minor mdoc cleanup. 1997-01-31 00:38:18 +00:00
Mike Pritchard
bba323e822 Update to reflect current include files. 1997-01-31 00:05:08 +00:00
Mike Pritchard
c18460f90e Update to reflect current include files. 1997-01-30 23:57:31 +00:00
Mike Pritchard
cb7ecbe37a Actually remove the old netns/netiso man pages. They haven't
been installed for the last 9 months or so anyways.
1997-01-30 23:51:48 +00:00
Mike Pritchard
0c3a17466f Update to reflect current include files. 1997-01-30 23:49:46 +00:00
Joshua Peck Macdonald
04bbb62b7a I just found a bug in my program, I was calling va_arg (..., char),
when parsing a printf-like arg list.  Looking for someone to blame,
I noticed that the man page has a bad example.  It clearly says at
the top that types following the last known argument are passed after
their default type conversions, and then later the example uses

	va_arg (..., char);

so I fixed it.
1997-01-30 10:22:00 +00:00
Mike Pritchard
e0604514d8 Update to reflect the current types.h. 1997-01-29 05:24:35 +00:00
Mike Pritchard
2c18ef217f Update to reflect current fs.h. 1997-01-28 07:25:18 +00:00
Mike Pritchard
5f9a0f6762 Update to match current include files. 1997-01-28 07:03:33 +00:00
Mike Pritchard
9136a887b6 Update to reflect current acct.h. 1997-01-28 06:53:19 +00:00
Mike Pritchard
ad2c737e4f Update the man page to reflect the current state of
fstab.h.
1997-01-28 06:12:54 +00:00
Andrey A. Chernov
d80ace690d Add save/restore cursor position escapes 1997-01-26 23:27:15 +00:00
Mike Pritchard
cc2c561f5e Man page police. 1997-01-25 20:42:09 +00:00
Satoshi Asami
bee9cbfd38 Explain more about the interleave factor. Mention mirroring, and add
a reminder that you can't mount half of a mirrored two-disk ccd.
1997-01-25 02:10:43 +00:00
Jordan K. Hubbard
6fb16f982c Add missing entries for de.4, fxp.4, ix.4, le.4, lnc.4, ze.4, and zp.4.
Now things build again.

Forgotten Again By:     David E. O'Brien	:-)
1997-01-21 12:25:06 +00:00
Wolfram Schneider
75141cc987 Sort cross references. 1997-01-20 23:23:22 +00:00
David E. O'Brien
5747fc5871 Share my poetry with the world.
(de.4, fxp.4, ix.4, le.4, lnc.4, ze.4, and zp.4)

Not forgetten this time by:	obrien  :-)
1997-01-20 09:22:23 +00:00
David E. O'Brien
44fd653298 New manpages for various Ethernet drivers, that I didn't see manpages for.
Manpage police???  Looking kinda bored there aren't you?  Need something
to do?  :-)  I'm sure there's work here to be done.

Inspired by:	Joerg

2.2-R candidate after Mike gets thru with them.
1997-01-20 09:18:54 +00:00