Commit Graph

225 Commits

Author SHA1 Message Date
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