Commit Graph

620 Commits

Author SHA1 Message Date
Bruce Evans
f644d0654b Fixed missing #includes in synopsis. 1999-12-23 17:24:40 +00:00
Bruce Evans
5770fb1361 Fixed bitrot in synopsis. Important interface changes hadn't reached here. 1999-12-23 17:22:58 +00:00
Bruce Evans
bd00dbfafc "Fixed" assorted bitrot. remove_dev() was renamed to destroy_dev().
VOP_ABORTOP() went away.  at_shutdown() was replaced by undocumented
event handling.  Rename remove_dev() here too, and remove the dead
and dead wrong man pages.
1999-12-23 17:16:32 +00:00
Eivind Eklund
4dc39f110c Correct the documentation of LOCKPARENT - it does not reliably result in the
parent being locked, but rather plays some hide and seek (does not lock if
dvp == vp).

Also add a BUGS section noting that this is undesired behaviour.
1999-12-18 20:50:48 +00:00
Eivind Eklund
9a8fa3c19f Document NDFREE w/flags, and fix up the description of NOFOLLOW. 1999-12-16 23:20:11 +00:00
David E. O'Brien
b7c42f7dde * State in words that "#define^IMACRO" is proper, as it is hard to tell
from the example.
* Embelish the usage() example to show how uppercase options are sorted.

Taken from previous bdelinting.
1999-12-16 10:02:20 +00:00
Alfred Perlstein
1e12157c61 explain that ioflags can be used to give read-ahead hints to the underlying
filesystem.
1999-12-13 02:28:53 +00:00
Kenneth D. Merry
86b2c8466d Revamp the devstat priority system. All disks now have the same priority.
The same goes for CD drivers and tape drivers.  In systems with mixed IDE
and SCSI, devices in the same priority class will be sorted in attach
order.

Also, the 'CCD' priority is now the 'ARRAY' priority, and a number of
drivers have been modified to use that priority.

This includes the necessary changes to all drivers, except the ATA drivers.
Soren will modify those separately.

This does not include and does not require any change in the devstat
version number, since no known userland applications use the priority
enumerations.

Reviewed by:	msmith, sos, phk, jlemon, mjacob, bde
1999-12-08 04:45:23 +00:00
Matthew N. Dodd
238ebf9958 Remove mention of 'ivars'. 1999-12-03 11:22:28 +00:00
Nick Hibma
fa930a7361 Add the device_get_children(9) man page. 1999-12-02 16:34:09 +00:00
Nick Hibma
2d876113a8 It's device_add_child*, not bus_add_child*. 1999-12-02 16:31:12 +00:00
John Polstra
907b750c0c The rt_refcnt member is a long now. 1999-11-22 04:26:00 +00:00
Poul-Henning Kamp
93efcae809 The at_exit and at_fork functions currently use a 'roll your own'
linked list to store the callbak routines.  The patch converts the
lists to queue(3) TAILQs, making the code slightly clearer and ensuring
that callbacks are executed in FIFO order.

Man page also updated as necesary.

(discontinued use of M_TEMP malloc type while here anyway /phk)

Submitted by:   Jake Burkholder jake@checker.org
PR:             14912
1999-11-19 21:29:03 +00:00
Eivind Eklund
b04b572b08 Document changed calling conventions (lost WILLRELE) for VOP_MKNOD and
VOP_SYMLINK.
1999-11-13 21:00:26 +00:00
Joerg Wunsch
93c6e868e8 Move the description of the traditional sleep() form out into the history
section, we no longer have it.

Fix mdoc style violations caused by a previous committer.
1999-11-03 10:39:54 +00:00
Alexey Zelkin
e1e5fdf6d4 mdoc(7)'fy 1999-10-30 15:12:25 +00:00
Alexey Zelkin
a169de1e31 mdoc(7)'fy, fix broken FreeBSD release number (3.0.1 -> 3.1) 1999-10-30 14:15:49 +00:00
Poul-Henning Kamp
02c58685a4 Change useracc() and kernacc() to use VM_PROT_{READ|WRITE|EXECUTE} for the
"rw" argument, rather than hijacking B_{READ|WRITE}.

Fix two bugs (physio & cam) resulting by the confusion caused by this.

Submitted by:   Tor.Egge@fast.no
Reviewed by:    alc, ken (partly)
1999-10-30 06:32:05 +00:00
Chris Piazza
20d8fa6f36 Revert previous change, I misread it as an if( when it really
wasn't.
1999-10-10 09:28:14 +00:00
Chris Piazza
133dba33b6 Add the missing ')' in
(p = f()) == NULL
1999-10-09 23:12:57 +00:00
Matthew Dillon
cc4a02e299 Bring kernel malloc documentation up to date, including the example.
PR:	docs/10059
1999-09-29 16:49:18 +00:00
Chris Costello
94b1839d20 Document the make_dev(9) and remove_dev(9) facilities.
remove_dev(9) is created as a link to the existing make_dev(9) page.

Reviewed by:	phk
1999-09-25 20:12:01 +00:00
Matthew Dillon
87b0140cdf mdoc style cleanup
Submitted by:	  Mike Pritchard <mpp@FreeBSD.ORG>
1999-09-25 17:21:21 +00:00
Chris Costello
2baad6b54c Remove a useless new line. 1999-09-25 16:11:09 +00:00
Chris Costello
2da64d5dd7 Document the devtoname(9) kernel interface. 1999-09-25 15:58:33 +00:00
Matthew Dillon
37af288330 More locking clarifications. Add skeleton manual page for VOP_LEASE 1999-09-24 17:11:02 +00:00
Matthew Dillon
fb3fd47611 More synchronization of the VOP documentation to the real world. 1999-09-24 13:58:55 +00:00
Matthew Dillon
bebac989cc More clarification of locking requirements. 1999-09-24 10:42:45 +00:00
Matthew Dillon
065aee8253 Bring more VOP manual pages up to date in regards to locking
requirements.
1999-09-24 10:19:43 +00:00
Matthew Dillon
fe11eb74af Update errors in documentation for various VOP_ calls. Specifically,
describe the correct locking state expected on entry and return.
1999-09-24 07:07:02 +00:00
Alexey Zelkin
0dc03e0114 Add to .Nm devstat_end_transaction_buf().
Do some ordering.

Noticed by: ken
1999-09-23 13:31:15 +00:00
Poul-Henning Kamp
04a2253821 Document the new free/erase transaction type.
Reminded about by:	ken
1999-09-22 20:27:21 +00:00
Alexey Zelkin
fe27e01fac Synchronization NAME section with SYNOPSIS. 1999-09-21 19:18:09 +00:00
Poul-Henning Kamp
bd9e52dcc4 document devstat_end_transaction_buf() 1999-09-18 21:31:19 +00:00
Ruslan Ermilov
c931dae17f Adjust descriptions for if_up() and if_down().
Reviewed by:	wollman
1999-09-14 01:05:40 +00:00
Doug Rabson
57129f42d5 Add new manpage device_set_flags.9 and add links for
device_set_desc_copy.9 and device_get_flags.9.
1999-09-12 16:01:11 +00:00
Alfred Perlstein
2f42dfd0a2 vnode -> mountpoint
reference vfs_check_export
change license to my own, (ok'd by dfr) and remove advert clause.
remove extra Id tags and emacs cruft, this should be a fresh file.
1999-09-11 21:00:03 +00:00
Chris Costello
7ad5ee3757 Add a link for uiomove.9 to uio.9 1999-09-11 15:39:31 +00:00
Alfred Perlstein
fb6d83aa60 Document VFS changes:
VFS_CHECKEXP.9, now used to check export credentials
VFS_FHTOVP.9, only used for filehandle to vnode, no access checks are done.
VFS.9, inform people of the vfs_std* functions available to avoid
       ugly casts to eopnotsup and making of dummy functions to return 0.
1999-09-11 00:57:20 +00:00
Doug Rabson
b99b8460af Add device_set_desc_copy(9). 1999-09-06 15:13:09 +00:00
Alexey Zelkin
0d28dd1dc5 Replace stale references to device_add_child_after(9) with
device_child_add_ordered(9)

PR:		13210
Submitted by:	Alexey Zelkin <phantom@cris.net>
Reviewed by:	mpp
Forgotten by:	dfr
1999-09-04 12:37:21 +00:00
Peter Wemm
7f3dea244c $Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00
Chris Costello
340b8cda25 Bad ref time(2) changed to time(3) 1999-08-16 22:11:19 +00:00
Mike Pritchard
ac23fd2044 Remove a self-referencing xref in the SEE ALSO section. 1999-08-15 13:47:08 +00:00
Mike Pritchard
def37e7c68 Various man page cleanup:
- Sort xrefs
- FreeBSD.ORG -> FreeBSD.org
- Be consistent with section names as outlined in mdoc(7).
- Other misc mdoc cleanup.

PR:		doc/13144
Submitted by:	Alexey M. Zelkin <phantom@cris.net>
1999-08-15 10:48:36 +00:00
Tim Vanderhoek
0983f2b022 English fixes: consistent spacing after periods, "userland", not "user land",
other typos, ~four grammar gnits, an ironic case of incorrect
               parallelization, bad capitalization, an incorrect use of the
               infamous slash ('/'), and an unclear sentence.
1999-08-02 04:00:33 +00:00
Tim Vanderhoek
4ac29fd62e Bruce noted that the use of err(), fixed to errx() in the last commit,
did not specify an exit code.  This implies the use of either a hand-
rolled err() (Bruce's suggestion) or a random error code (my suggestion),
both of which are against the style guidelines.  This commit specifies
the correct error code (implicitly).  This also changes the error message
to be a little more helpful.
1999-08-02 03:18:17 +00:00
Tim Vanderhoek
b787fc933a Use errx() instead of err() in example code calling err() after strtol(). 1999-07-31 15:04:37 +00:00
Matthew N. Dodd
15317dd875 Alter the behavior of sys/kern/subr_bus.c:device_print_child()
- device_print_child() either lets the BUS_PRINT_CHILD
	  method produce the entire device announcement message or
	  it prints "foo0: not found\n"

Alter sys/kern/subr_bus.c:bus_generic_print_child() to take on
the previous behavior of device_print_child() (printing the
"foo0: <FooDevice 1.1>" bit of the announce message.)

Provide bus_print_child_header() and bus_print_child_footer()
to actually print the output for bus_generic_print_child().
These functions should be used whenever possible (unless you can
just use bus_generic_print_child())

The BUS_PRINT_CHILD method now returns int instead of void.

Modify everything else that defines or uses a BUS_PRINT_CHILD
method to comply with the above changes.

	- Devices are 'on' a bus, not 'at' it.
	- If a custom BUS_PRINT_CHILD method does the same thing
	  as bus_generic_print_child(), use bus_generic_print_child()
	- Use device_get_nameunit() instead of both
	  device_get_name() and device_get_unit()
	- All BUS_PRINT_CHILD methods return the number of
	  characters output.

Reviewed by: dfr, peter
1999-07-29 01:03:04 +00:00
Nik Clayton
5bf6ab8369 Add $Id$, to make it simpler for members of the translation teams to
track.

The $Id$ line is normally at the bottom of the main comment block in the
man page, separated from the rest of the manpage by an empty comment,
like so;

     .\"    $Id$
     .\"

If the immediately preceding comment is a @(#) format ID marker than the
the $Id$ will line up underneath it with no intervening blank lines.
Otherwise, an additional blank line is inserted.

Approved by:            bde
1999-07-12 21:02:10 +00:00
Kris Kennaway
d30b1794da Flesh out VOP_ADVLOCK.9 with a description of the available flags
Sync vnode.9 with the definitions in <sys/vnode.h>

Reviewed by:	Doug Rabson
1999-06-30 12:02:52 +00:00
Mike Pritchard
5d70612b3f Fix some typos and do some minor mdoc cleanup. 1999-06-27 02:38:46 +00:00
Nick Hibma
6dcd4819f1 Add man page for device_quiet and friends 1999-06-22 18:09:54 +00:00
Tim Vanderhoek
3c218dea5c typo: Adviseroty -> Advisory 1999-06-22 02:34:47 +00:00
Nick Hibma
6979450036 Update the comments on values than can be returned by DEVICE_PROBE.
DEVICE_PROBE can return priorities.

Reviewed by:	Doug Rabson <dfr@nlsystems.com>
1999-06-17 19:22:12 +00:00
Bruce Evans
20891aba11 Fixed bitrot in synopsis (a missing include). 1999-06-02 16:33:22 +00:00
Nik Clayton
0bf3e334e5 Description of LOCKLEAF said "inode" when it should have said "vnode".
PR:             docs/11596
Submitted by:   Robert Watson <robert@fledge.watson.org>
1999-05-29 13:00:40 +00:00
Doug Rabson
86238261ee Document device_add_child_ordered(). 1999-05-28 09:38:25 +00:00
Michael Haro
476702b3c4 s/file it possible/file if possible/ 1999-05-11 01:19:34 +00:00
Poul-Henning Kamp
75c1354190 This Implements the mumbled about "Jail" feature.
This is a seriously beefed up chroot kind of thing.  The process
is jailed along the same lines as a chroot does it, but with
additional tough restrictions imposed on what the superuser can do.

For all I know, it is safe to hand over the root bit inside a
prison to the customer living in that prison, this is what
it was developed for in fact:  "real virtual servers".

Each prison has an ip number associated with it, which all IP
communications will be coerced to use and each prison has its own
hostname.

Needless to say, you need more RAM this way, but the advantage is
that each customer can run their own particular version of apache
and not stomp on the toes of their neighbors.

It generally does what one would expect, but setting up a jail
still takes a little knowledge.

A few notes:

   I have no scripts for setting up a jail, don't ask me for them.

   The IP number should be an alias on one of the interfaces.

   mount a /proc in each jail, it will make ps more useable.

   /proc/<pid>/status tells the hostname of the prison for
   jailed processes.

   Quotas are only sensible if you have a mountpoint per prison.

   There are no privisions for stopping resource-hogging.

   Some "#ifdef INET" and similar may be missing (send patches!)

If somebody wants to take it from here and develop it into
more of a "virtual machine" they should be most welcome!

Tools, comments, patches & documentation most welcome.

Have fun...

Sponsored by:   http://www.rndassociates.com/
Run for almost a year by:       http://www.servetheweb.com/
1999-04-28 11:38:52 +00:00
Bruce Evans
7784aabe43 Fixed bitrot in synopsis. 1999-03-26 02:11:59 +00:00
Guy Helmer
2112898830 Document the flags and p parameters to VOP_LOCK and VOP_UNLOCK. Also,
at Doug Rabson's suggestion, add vn_lock(9) as an alternative name for
this manpage and note its calling convention.

PR:		docs/9338
1999-03-17 20:17:32 +00:00
Bruce Evans
ec1b10869b Removed old scsi section 9 man pages. Only cd.9 has been converted to
cam.  scsiconf.9, sd.9, and st.9 can now be found in the Attic.

Reviewed by:	ken
1999-03-06 19:03:31 +00:00
Bruce Evans
2f02d39302 Fixed bitrot in synopsis (devfs_link was renamed to devfs_makelink).
Didn't fix bitrot in this page's name; just install a link.
1999-03-06 17:37:20 +00:00
Bruce Evans
5ad5ff52b2 Fixed wrong function prototype(s) in synopsis. 1999-03-06 17:25:50 +00:00
Bruce Evans
522e56cf6d Fixed bitrot in synopsis (u_long changed to uintptr_t for portability). 1999-03-06 17:21:14 +00:00
Bruce Evans
3b00e9bd92 Fixed C syntax error in synopsis. 1999-03-06 17:14:24 +00:00
Bruce Evans
399eae0d05 Fixed bitrot in synopsis (const poisoning hadn't reached here). 1999-03-06 17:10:15 +00:00
Bruce Evans
6232b00ed1 Fixed missing headers in synopsis. 1999-03-06 17:07:29 +00:00
Bruce Evans
95fd910edc Fixed bitrot in synopsis (fuword() and suword() changed to support alpha). 1999-03-06 17:04:18 +00:00
Matthew Dillon
c20b4df657 Clarify more of what VOP_LINK expects. 1999-02-13 07:56:49 +00:00
Matthew Dillon
3ac84fed2e Update man page - directory vnode should not be unlocked or released
by the VOP routine.  The caller does it.
1999-02-13 07:44:14 +00:00
Alexander Langer
43d1df332e Removed occurrences of consecutive repeated words (such as "the the"). 1999-02-12 02:12:08 +00:00
Kenneth D. Merry
2a888f938e Add a prioritization field to the devstat_add_entry() call so that
peripheral drivers can determine where in the devstat(9) list they are
inserted.

This requires recompilation of libdevstat, systat, vmstat, rpc.rstatd, and
any ports that depend on the devstat code, since the size of the devstat
structure has changed.  The devstat version number has been incremented as
well to reflect the change.

This sorts devices in the devstat list in "more interesting" to "less
interesting" order.  So, for instance, da devices are now more important
than floppy drives, and so will appear before floppy drives in the default
output from systat, iostat, vmstat, etc.

The order of devices is, for now, kept in a central table in devicestat.h.
If individual drivers were able to make a meaningful decision on what
priority they should be at attach time, we could consider splitting the
priority information out into the various drivers.  For now, though, they
have no way of knowing that, so it's easier to put them in an easy to find
table.

Also, move the checkversion() call in vmstat(8) to a more logical place.

Thanks to Bruce and David O'Brien for suggestions, for reviewing this, and
for putting up with the long time it has taken me to commit it.  Bruce did
object somewhat to the central priority table (he would rather the
priorities be distributed in each driver), so his objection is duly noted
here.

Reviewed by:	bde, obrien
1999-02-10 00:04:13 +00:00
Mike Pritchard
a04dd7481b Fix some spelling errors. 1999-02-01 22:55:54 +00:00
Nicolas Souchu
88ec80ed82 ppbconf.9 removed 1999-01-30 15:33:20 +00:00
Nicolas Souchu
06fc25611a Improve ppbus(4) microsequencer description. Remove ppbconf.9 which is
to rapidly depreciated.
1999-01-30 15:32:41 +00:00
Julian Elischer
2755f9f602 Slightly relax the requirements fro removing extra braces and parenthesis.
Objected to by: bde
1999-01-30 04:17:14 +00:00
David E. O'Brien
bc6b8d1239 Add MLINKS for devstat kernel interfaces. 1999-01-09 05:09:21 +00:00
Matthew Dillon
557d5a1caa M_AWAIT changed to M_ASLEEP 1998-12-23 01:06:57 +00:00
Matthew Dillon
367f1374e1 Documentation update for new M_AWAIT flag to kernel malloc, plus revamp
the descriptions of the flags and return value.
1998-12-23 01:05:06 +00:00
Matthew Dillon
1ddb20703d update asleep/await sections 1998-12-23 00:24:59 +00:00
Matthew Dillon
88b85f7467 Add manual page describing kernel buffer management system (i.e.
kern/vfs_bio.c).
1998-12-22 19:47:48 +00:00
Matthew Dillon
4f32889f72 update HISTORY section 1998-12-21 10:34:53 +00:00
Matthew Dillon
f44bc94d97 Add manual page for experimental kernel asleep() and await() routines 1998-12-21 10:29:28 +00:00
Nicolas Souchu
fa7bfeb7f9 microseq.9: general purpose parallel microcode for ppbus(4)
ppbconf.9: general info about ppbus(4) structures
1998-10-28 00:55:42 +00:00
Bruce Evans
17d1bf4260 Removed all `vector xxxintr' specifications. Interrupt handlers are now
configured in drivers.
1998-10-22 15:53:06 +00:00
Kenneth D. Merry
de336449f3 Change the worm(4) man page to note that there is no longer a worm(4)
driver, and point users in the right direction for similar functionality.
The functionality that used to be provided there is now provided by the
cd(4) driver and cdrecord.

Fix cross-references in a few other man pages.  (i.e. delete references to
things I haven't written yet)
1998-10-16 00:26:28 +00:00
Kenneth D. Merry
e6c744a084 Update the cd(9) man page for the CAM cd driver. This really just an
update of the quirk entry descriptions to reflect the current state of
things.

Once I find out where such things belong, I'll document things like
the changer scheduling mechanism, actions taken at probe, etc.
1998-10-12 04:09:49 +00:00
Eivind Eklund
74c6d86921 Add a section on vnode types. Mostly based on information supplied by
Terry Lambert <terry@lambert.org>
1998-09-28 23:36:35 +00:00
Eivind Eklund
c78f3f0d75 Add a manpage for namei().
Markup changes and review by:	dfr
1998-09-27 13:35:49 +00:00
Justin T. Gibbs
fb43a2ea5d Add devstat.9. 1998-09-15 10:26:57 +00:00
Justin T. Gibbs
a8abf21632 Add a new at_shutdown queue, SHUTDOWN_FINAL. This queue is run at
splhigh() after any system dumps have completed.  SHUTDOWN_POST_SYNC
isn't quite late enough for disk controllers.
1998-09-15 08:48:57 +00:00
Justin T. Gibbs
c61d88e026 Man page describing the in kernel device statistics routines.
Submitted by:	"Kenneth D. Merry" <ken@plutotech.com>
1998-09-15 06:49:18 +00:00
Doug Rabson
cefd51ec44 Add manpages for the new device framework. 1998-09-03 21:52:05 +00:00
Wolfram Schneider
acd8019083 Sort cross references. 1998-08-31 16:41:09 +00:00
Bruce Evans
cec5d8b382 FIxed missing include in synopsis. 1998-08-03 17:29:44 +00:00
Bruce Evans
99b4f8244c FIxed bitrot in prototype in synopsis. 1998-08-03 17:27:41 +00:00
Poul-Henning Kamp
0b014ec5ac Fix argument reversal in example.
PR:		7138
Reviewed by:	phk
Submitted by:	Robert Watson <robert+freebsd@cyrus.watson.org>
1998-07-02 05:37:33 +00:00
Dmitrij Tejblum
0d8778c56e Insert a missing newline. 1998-06-24 13:30:25 +00:00
Poul-Henning Kamp
782932bb44 devfs_add_devswf(9) and devfs_link(9) don't tell you how to
remove the device once it's added or linked.

PR:		6524
Reviewed by:	phk
Submitted by:	Brian Cully <shmit@kublai.com>
1998-05-06 09:13:53 +00:00
Peter Dufault
8a6472b723 Finish _POSIX_PRIORITY_SCHEDULING. Needs P1003_1B and
_KPOSIX_PRIORITY_SCHEDULING options to work.  Changes:

Change all "posix4" to "p1003_1b".  Misnamed files are left
as "posix4" until I'm told if I can simply delete them and add
new ones;

Add _POSIX_PRIORITY_SCHEDULING system calls for FreeBSD and Linux;

Add man pages for _POSIX_PRIORITY_SCHEDULING system calls;

Add options to LINT;

Minor fixes to P1003_1B code during testing.
1998-03-28 11:51:01 +00:00
Philippe Charnier
aaf1f16e39 .Sh AUTHOR -> .Sh AUTHORS according to mdoc specs.
Use .An/.Aq.
1998-03-12 07:31:21 +00:00
Peter Dufault
aac4ad2c99 Reviewed by: bde
Changes to support building with _POSIX_SOURCE set to 199309L:

1. Add sys/_posix.h to handle those preprocessor defs that POSIX
says have effects when defined before including any header files;

2. Change POSIX4_VISIBLE back to _POSIX4_VISIBLE

3. Add _POSIX4_VISIBLE_HISTORICALLY for pre-existing BSD features now
defined in POSIX.  These show up when:

_POSIX_SOURCE and _POSIX_C_SOURCE are not set or
_POSIX_C_SOURCE is set >= 199309L

and vanish when:

_POSIX_SOURCE is set or _POSIX_C_SOURCE is < 199309L.

4. Explain these in man 9 posix4;

5. Include _posix.h and conditionalize on new feature test.
1998-03-08 17:25:38 +00:00
Peter Dufault
917e476dad Reviewed by: msmith, bde long ago
POSIX.4 headers and sysctl variables.  Nothing should change
unless POSIX4 is defined or _POSIX_VERSION is set to 199309.
1998-03-04 10:27:00 +00:00
James Raynard
73d8529af3 Fix a few typos. 1998-02-28 15:37:25 +00:00
James Raynard
95297e22ca Strings are terminated by NUL, not NULL. 1998-02-28 15:35:22 +00:00
Bruce Evans
7bbe74ab58 Don't refer to the nonexistent function VOP_VALLOC. 1998-01-20 11:08:06 +00:00
Bruce Evans
a17bbc0dda Removed obsolete man pages. 1998-01-16 18:56:34 +00:00
Bruce Evans
9d44ece512 Removed references to the man pages for the obsolete interfaces
VOP_BLKATOFF, VOP_SEEK, VOP_SELECT, VOP_TRUNCATE, VOP_UPDATE,
VOP_VALLOC and VOP_VFREE.
1998-01-16 18:49:42 +00:00
Bruce Evans
06dcc5a953 Fixed synopsis again. Too much was blown away by splatting a NetBSD-
based version over the top of the FreeBSD version in rev.1.6.
1998-01-16 18:45:52 +00:00
Bruce Evans
f867ffd315 Fixed bitrot. The type of the "level" is intrmask_t, not int. 1998-01-16 18:14:34 +00:00
Bruce Evans
e6a658d84f Fixed prototype for tsleep() (const poisoning). 1998-01-16 18:12:57 +00:00
Bruce Evans
b1d3fc49a9 Fixed a missing #include in the synopsis. 1998-01-16 18:06:23 +00:00
Steve Price
857f817c5c Comment out xref to buf(9) manpage.
PR:		5421
1998-01-03 22:26:00 +00:00
Alexander Langer
e69bcfc3bc Expanded cross references. 1998-01-02 19:22:52 +00:00
Bruce Evans
fc372b5422 Sorted lists. Use the same style as most Makefiles for `MLINKS+=' lines. 1998-01-01 10:12:14 +00:00
Bruce Evans
3cfd401c74 Install devfs_remove_dev.9 and suser.9. 1998-01-01 09:40:21 +00:00
Wolfram Schneider
de635b0683 The terminating character in strings is NUL', not NULL'. 1997-12-28 12:06:29 +00:00
Tim Vanderhoek
dfb9495b2a Use consistent spelling,
writeable -> writable (recall prior debate over this? :-)
	initialise -> initialize
	recognise -> recognize

Merry Christmas! :)
1997-12-25 09:36:42 +00:00
Julian Elischer
8cf58ae5e9 Add a man page for REMOVING devices from devfs. 1997-12-25 05:54:24 +00:00
Garrett Wollman
a873f07c1c oops, remove a dangling predicate left over after a sentence was rewritten. 1997-12-07 20:25:45 +00:00
Garrett Wollman
25a5737a0f Add some more macro advice and correct spelling of ``parentheses''. 1997-12-07 20:19:20 +00:00
Garrett Wollman
c9c42d0aa7 Added some advice to avoid typedef'ing structures, as this breaks
information-hiding.  Also recommended against naming typedefs to end
in _t unless POSIX or ANSI requires it, and in favor of using queue(3)
macros to generate lists rather than rolling one's own.
1997-12-07 19:53:44 +00:00
Bruce Evans
22301c4b46 Fixed spelling of EACCES. 1997-11-23 17:58:55 +00:00
David E. O'Brien
d927c2c392 state that "kernel includes" ==> sys/*.h 1997-11-12 06:29:10 +00:00
Poul-Henning Kamp
2a94e401b5 Update malloc.9 to reflect new reality. 1997-10-11 08:11:31 +00:00
Poul-Henning Kamp
c9405c2f11 Be a little closer to current reality. 1997-10-11 07:39:45 +00:00
Wolfram Schneider
bceb8aed9e Sort cross refereces in section SEE ALSO. 1997-09-29 10:11:02 +00:00
Justin T. Gibbs
c242996390 Updated timeout.9 man page describing the new callout interface. This
man page was based on the NetBSD version.
1997-09-21 22:12:19 +00:00
Eivind Eklund
16e1a942f7 Activate the bios.9 manpage.
PR:	4215
1997-08-12 18:24:44 +00:00
Mike Smith
6b8d502d48 Oops, fix manpage title. 1997-08-01 15:17:54 +00:00
Mike Smith
a1dadd1000 Manpage for new BIOS functionality.
(Skeletal, could do with some extra references.)
1997-08-01 06:04:08 +00:00
Peter Wemm
122c2021d3 An overhaul of style.9 to clear up some of the ambiguities. A number of
things are explicitly stated now rather than being implied by example.

Obtained from: Quite a few people over the last few weeks
Reviewed by: core
1997-05-27 10:00:08 +00:00
Alexander Langer
2ac0c19008 Typo fix: sq --> qs 1997-05-12 01:56:31 +00:00
Bruce Evans
2e14815b84 Fixed #include and/or prototype bugs in synopsis. 1997-04-13 14:49:13 +00:00
Bruce Evans
b18e517615 Updated synopsis for Lite2.
Fixed missing #include in synopsis.
1997-04-13 14:39:59 +00:00
Bruce Evans
336ff946fc Fixed #include(s) in the synopsis to actually declare the function(s) in the
synopsis.
1997-04-11 17:58:16 +00:00
Bruce Evans
d134e17633 Cleaned up synopsis:
- don't quote function names, since quoting them is unnecessary and
  unusual and confuses my synopsis checker.
- include <sys/types.h> instead of <sys/param.h>.  It is normal to
  (have to) include <sys/param.h> instead of <sys/types.h>, but it
  is more useful for man pages to document minimal prerequisites.
1997-04-11 17:55:19 +00:00
Bruce Evans
29ea3efb24 Fixed synopsis:
- don't declare nonexistent function sleep().
- don't include <sys/errno.h> explicitly.

sleep() should be nuked some more, e.g., this man page should not be
named after a nonexistent function.
1997-04-11 17:49:56 +00:00
Mike Pritchard
405eecfbb1 Check for -1 instead of EOF in the getopt() example.
Submitted by:	Kent Vander Velden
1997-04-09 19:03:14 +00:00
Mike Pritchard
db0ed86298 Document wakeup_one(). 1997-04-09 05:39:32 +00:00
John-Mark Gurney
df3cc9399c uncomment CD_Q_BCD_TRACKS flag, add xref to scsi(4) 1997-04-02 09:41:16 +00:00
Mike Pritchard
88cf6634a5 Add malloc(9) to document the kernel malloc() and free() routines.
Obtained from: NetBSD w/changes to reflect current FreeBSD headers
and diagnostic messages.
1997-03-22 23:50:21 +00:00
Mike Pritchard
5ea8e149f2 Minor mdoc fixes. 1997-03-22 22:47:34 +00:00
Mike Pritchard
c8ff0947c0 Add vslock(9) to document the vslock() and vsunlock() kernel functions.
Obtained from: NetBSD
1997-03-22 22:21:37 +00:00
Mike Pritchard
1e133bd480 One minor mdoc fix. 1997-03-22 22:19:26 +00:00
Mike Pritchard
dad0f56607 Add kernacc(9) that documents the kernacc() and useracc() kernel
functions.

Obtained from: NetBSD (renamed from access.9)
1997-03-22 22:06:07 +00:00
Mike Pritchard
4b2502a3e8 Add physio(9).
Obtained from: NetBSD w/minor FreeBSD changes
1997-03-22 21:31:29 +00:00
Mike Pritchard
b6c4b1903b Add mi_switch.9. It documents the kernel mi_switch() and cpu_switch()
context switching functions.

Obtained from: NetBSD (renamed from ctxsw.9)
1997-03-22 20:59:18 +00:00
Mike Pritchard
ec505e0408 Add resettodr(9).
Obtained from: NetBSD
1997-03-22 20:07:04 +00:00
Mike Pritchard
4035c9100d Add inittodr(9) to document how the system clock is initialized.
Obtained from NetBSD and then modified to reflect how things work
in FreeBSD, along with some minor changes to make a few points
clearer.
1997-03-22 19:46:44 +00:00
Mike Pritchard
de1543a46d Add time(9) to document the kernel time variables. Obtained from
NetBSD and then modified by me to reflect some FreeBSD specific
things and to clarify some other pointed based on some old mail
from Bruce Evans about this man page.
1997-03-22 19:09:31 +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
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
Mike Pritchard
eaa8b244f1 Some minor mdoc cleanup. 1997-03-07 03:32:31 +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
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
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
09edd56ac0 Correct section number in the .DT line.
Pointed out by: bde
1997-02-23 18:00:03 +00:00
Peter Wemm
e25aeca937 Revert $FreeBSD$ back to $Id$ 1997-02-22 13:26:29 +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
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
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
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
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
Poul-Henning Kamp
8964f83c4a add more arguments to these things.
2.2 candidate.
1997-01-15 19:39:45 +00:00
Garrett Wollman
de707befce Document Monday's changes in the interface structure. 1997-01-15 19:28:39 +00:00
Jordan K. Hubbard
1130b656e5 Make the long-awaited change from $Id$ to $FreeBSD$
This will make a number of things easier in the future, as well as (finally!)
avoiding the Id-smashing problem which has plagued developers for so long.

Boy, I'm glad we're not using sup anymore.  This update would have been
insane otherwise.
1997-01-14 07:20:47 +00:00
Mike Pritchard
188097739b Spelling police. 1996-12-26 22:50:43 +00:00
Wolfram Schneider
0b992c1d66 Sort cross references. 1996-12-26 16:16:37 +00:00
Mike Pritchard
4a6a66d28c Typo police. 1996-12-18 22:06:47 +00:00
Garrett Wollman
3cb60f1a48 Create a new manual page describing how network interfaces and
addresses are glued together with the generic networking code.
1996-12-17 20:21:01 +00:00
Mike Pritchard
aab5e1b6d0 Minor formatting/style fixes.
Submitted by:	Sandro Sigala <sandro@cat.local.net> as part of PR # 2134
1996-12-09 07:45:59 +00:00
Mike Pritchard
fc43dc94cb Correct some spelling errors. 1996-12-01 00:25:06 +00:00
Mike Pritchard
70843691f8 Fix an incorrect man page cross reference. 1996-11-30 23:24:20 +00:00
Julian Elischer
1d4b74d4fd add a man page for suser() because its usage is not as obvious
as you would first think.
1996-10-16 21:14:32 +00:00
Garrett Wollman
6cbc213f79 Fix a macro error in HISTORY section. 1996-10-08 20:38:28 +00:00
Garrett Wollman
50853e53cc Add an rtentry(9) page to describe the structure of a routing-table
entry and the metrics and flags which pertain thereto.
1996-10-08 20:25:39 +00:00
Garrett Wollman
ad31211dc6 Document what I believe to be the interface of rtalloc*. 1996-10-08 18:45:06 +00:00
Joerg Wunsch
59df6275ad Add a man page describing the interrupt priority `levels'.
Comments by: bde

Lousy MCI network link :(, my commit message for the Makefile has been
botched.
1996-10-04 21:22:49 +00:00
Joerg Wunsch
f89810cd97 Reviewed by:
Submitted by:
Obtained from:
1996-10-04 21:20:07 +00:00
Bruce Evans
59c49dd346 Fixed SYNOPSIS (#includes, return types, arg names and formatting) and
a couple of other things.
1996-08-28 16:58:34 +00:00
Wolfram Schneider
f31078c2f7 bring back ``case '?':'' in switch statement 1996-08-24 10:49:09 +00:00
Wolfram Schneider
7416827fb1 add copyright, $Id$
remove case '?', if '?' is not in getopt(), it should
not be in the switch statement
1996-08-22 16:55:15 +00:00
Julian Elischer
e0d898b48e Some cleanups to the callout lists recently added.
note that at_shutdown has a new parameter to indicate When
during a shutdown the callout should be made. also
add a RB_POWEROFF flag to reboot "howto" parameter..
tells the reboot code in our at_shutdown module to turn off the UPS
and kill the power. bound to be useful eventually on laptops
1996-08-22 03:50:33 +00:00
Mike Pritchard
fe6869c2d0 Use the .Fx macro to reference FreeBSD versions in several newer man
pages.

For those of you that don't know, here is an example of how the .Fx
macro is used:

The xyzzy command first appeared in
.Fx 2.2 .

Will expand to:

The xyzzy command first appeared in FreeBSD 2.2.
1996-08-21 21:43:28 +00:00
Julian Elischer
3fcaebbf79 Add man-pages for at_exit, at_fork and at_shutdown()
so that people can look and comment.
I'll add the at_fork and at_exit immediatly, but I'll
add teh at_shutdown later as it's more extensive
and I desire people's comments..

julian
1996-08-19 02:22:15 +00:00
Bruce Evans
0ba27adc20 Restored most of suggestion about using NULL, even though wollman
disagrees with it personally :-), and fixed the misleading parts.
1996-07-17 12:32:18 +00:00
Garrett Wollman
117e1bd9ef Delete incorrect and misleading suggestion about NULL. I left in
the part about testing pointers against NULL, even though I disagree
with it personally.
1996-06-13 19:52:42 +00:00
Mike Pritchard
5406291a1d Add man pages for the copy*, fetch*, and store* families of
kernel functions.

Also added timeout(9) to the makefile.

Reviewed by:	joerg
Obtained from:	NetBSD
1996-04-15 21:37:07 +00:00
Joerg Wunsch
4928e97cae Describe timeout() and untimeout(). 1996-04-13 16:59:07 +00:00
Mike Pritchard
89e33e9285 Fix some typos. 1996-04-07 08:37:54 +00:00
Mike Pritchard
906c1e27fc Correct some man page cross references and file location references. 1996-04-07 00:06:21 +00:00
Joerg Wunsch
a29b7c975a Fix a typo. 1996-04-06 13:33:23 +00:00
Joerg Wunsch
9c2c5c6d6e .Ql --> .Dv
Submitted by:	wollman
1996-04-05 23:23:25 +00:00
Mike Pritchard
ac6a55a386 List tsleep & wakeup in the summary line so that they can
be found with "man -k".
1996-04-05 21:08:40 +00:00
Joerg Wunsch
7b0d14f596 Populate this. :)
Add a man page for tsleep()/wakeup().
1996-04-03 07:41:27 +00:00
Marc G. Fournier
7d12015159 Makefile: added devfs_add_devswf.9, removed devfs_add_devsw.9
devfs_link.9: modified man page to reflect source code

devfs_add_devsw.9: replaced by devfs_add_devswf.9

devfs_add_devswf.9: proper function for adding devices to DEVFS
1996-04-02 04:10:45 +00:00
Joerg Wunsch
81f2fe8dca Convert this to a real man page. Using one blurb of a .Bd -literal
looks rather ugly.

Also slightly adopt the contents to the results of a discussion that
took place in -core some months ago.  We couldn't agree on everything,
but some of the previous sentiments were rather outdated.
1996-03-31 22:36:14 +00:00
Mike Pritchard
bcff8e2ae4 Another round of man page cleanups.
Down to only about 100 items left to cleanup! :-)
1996-02-12 04:57:03 +00:00
Mike Pritchard
6fad16fd59 Add some missing MLINKS, correct some cross references, correct some
file locations and some minor formatting/style problems.
1996-02-09 16:20:10 +00:00
Mike Pritchard
4a8d02835c Fix a bunch of spelling errors in a bunch of man pages. 1996-01-30 13:52:50 +00:00
Bruce Evans
151eb452b6 Added new devfs manpages here too. 1996-01-01 16:58:10 +00:00
Joerg Wunsch
96b2792e12 Add man pages for devfs functions after Julian's descripton.
Someone must be the first. :)
1995-12-31 00:08:18 +00:00
Poul-Henning Kamp
56accb4fa4 Recreate style with original indent. 1995-12-21 18:35:19 +00:00
Bruce Evans
091e867f75 Don't use the normal `.Sh' indentation of 5 for the style guide. It
screws up the indentation and the style guide is half about indentation.
1995-12-14 18:26:31 +00:00
Bruce Evans
e710b9f789 Fixed manual section number. 1995-12-14 18:19:40 +00:00
Poul-Henning Kamp
b030a30523 Add a slightly edited version of the style document. 1995-12-14 10:50:27 +00:00
Poul-Henning Kamp
0786f79c1f Add a section 9 about the kernel to out man pages.
Please help fill this out !
1995-12-14 10:08:31 +00:00