1
0
mirror of https://git.FreeBSD.org/src.git synced 2024-12-20 11:11:24 +00:00
Commit Graph

491 Commits

Author SHA1 Message Date
Chris Costello
bb33e42207 Replace .Va, .Ar and .Nm with .Fa or .Va where necessary, examples:
``.Ar errno'' -> ``.Va errno''
  ``.Nm ops'' -> ``.Fa ops''
  ``.Va fd'' -> ``.Fa fd''
2000-06-23 05:05:44 +00:00
Chris Costello
a907d4fd1f Replace an erroneous .Va error' with .Va errno'. 2000-06-23 04:25:10 +00:00
Chris Costello
48b5eb7c85 Replace `FreeBSD 4.0'' with `.Fx 4.0'' and remove a useless empty line
at the end of the file.
2000-06-23 03:50:32 +00:00
Chris Costello
dca3f6825f Replace .Va references to function arguments to .Fa references. 2000-06-23 03:43:34 +00:00
Josef Karthauser
0a266c86a2 Make a note of fflagstostr and strtofflags in the 'see also' section. 2000-06-17 14:03:34 +00:00
Alexander Langer
cb477b672b Fix typo: turn of -> turn off.
PR:		18805
Submitted by:	Yoshihiro Ota <ota@mail.drexel.edu>
Kind of Reviewed by:	asmodai ("sure")
2000-06-13 12:50:47 +00:00
John-Mark Gurney
e585cdf0ce add a BUGS section on how we can only watch VNODE's on a UFS file system
right now...

I talked w/ phk last night and "fixing" this in a generic way is going
to require a lot of complex thought on stacking let alone the NFS problems..

add missing sys/time.h for struct timespec def...
2000-06-07 22:09:16 +00:00
Chris Costello
f9a2346166 Replace a `manual(section)' reference with a proper .Xr statement. 2000-05-31 21:12:08 +00:00
John-Mark Gurney
af7b56f450 fix up the kqueue documentation... comment some things that were left
out that really needed to be here...

Reviewed-by: jlemon
2000-05-24 04:29:57 +00:00
Brian Feldman
a274d19ba2 Back out NOTE_EXIT status reporting pending discussion. 2000-05-21 16:27:41 +00:00
Chris Costello
12b03e57e5 Remove a superfluous `.Pp' occuring directly after
`.Sh IMPLEMENTATION NOTES'.
2000-05-19 02:55:43 +00:00
Chris Costello
ef626a01c1 Add a note under IMPLEMENTATION NOTES about the behavior of sendfile()
in the threaded library.
2000-05-19 02:53:55 +00:00
Peter Wemm
76e61b9c71 List ECONNRESET as a return value. EINVAL was not documented either. 2000-05-19 01:00:57 +00:00
Brian Feldman
a24b514d72 Put the wait(2) exit status in "data" for NOTE_EXIT kevents. 2000-05-17 01:16:11 +00:00
Bruce Evans
200f7053ee Fixed missing include in synopsis.
Use a long line instead splitting a line with backslash-newline in synopsis.
My synopsis checker doesn't understand backslash-newline.
2000-05-11 16:01:17 +00:00
Tim Vanderhoek
49ca482a68 When "any" acts as a subject, the verb must agree with whatever any is of. 2000-05-11 05:29:10 +00:00
Tim Vanderhoek
d4b81c98d8 Content-free commit: only remove trailing whitespace 2000-05-11 05:06:00 +00:00
Tim Vanderhoek
18bd6f9514 The accept() function is a call, not an argument. Also, add: serial
comma, missing-hyphen, and a word-erase character.
2000-05-11 05:04:30 +00:00
Jonathan Lemon
4451bb5da5 Some mdoc cleanups for the manual page.
Submitted by:  phantom
2000-05-06 13:06:03 +00:00
Jonathan Lemon
ad35a4c94a Add a kqueue(2) manual page. 2000-05-04 20:11:38 +00:00
Alexey Zelkin
4f79a4117a Use `Er' variable to define first column width in ERRORS section. It was
initially suggested by mdoc(7) style, but was broken over the years
2000-05-04 13:09:25 +00:00
Alexey Zelkin
2a53c5ec96 mdoc(7) cleanup:
. use real function names as `.Nm' macro argument in NAME section. It allows
them to appear in apropos(1) or whatis(1) output.

. replace empty lines with `.Pp' macro.

. replace hardcoded standard names with their `.St' macro equivalents.

. sort cross references in SEE ALSO section
2000-05-04 08:05:45 +00:00
Jason Evans
4c089f4dff Add missing man pages. Fix various compliance bugs, mostly having to do with
error return values.  Implement pthread_mutexattr_gettype().

PR:		docs/16537, docs/17538
2000-05-02 06:51:40 +00:00
Joseph Koshy
0588fce1ba Fix typo. Use `.Fa' to denote a function argument.
PR:		docs/18214
Submitted by:	Ben Smithurst <ben@scientia.demon.co.uk>
2000-04-26 05:09:22 +00:00
Garrett Wollman
d166947eda Spell MAP_NOSYNC correctly.
Submitted by:	allenc@verinet.com
2000-04-23 15:15:15 +00:00
Garrett Wollman
c1c8bf8375 .Lb-ify 2000-04-23 02:02:33 +00:00
Garrett Wollman
5c317306cb Add shm_open(3) and shm_unlink(3). The documentation could use a good
bit of work (and is stylistically probably the worst manual page
I've ever written).
2000-04-22 15:24:29 +00:00
Alexey Zelkin
25bb73e063 Introduce ".Lb" macro to libc manpages.
More libraries manpages updates following.
2000-04-21 09:42:15 +00:00
Archie Cobbs
2d6fdfda46 Document EWOULDBLOCK as a possible errno return value. 2000-04-09 19:10:57 +00:00
Bruce Evans
e92393ba2b Fixed wrong arg type in synopsis. 2000-03-23 15:28:30 +00:00
Jason Evans
070dac0827 Add a man page for aio_waitcomplete(). Update the aio_cancel() man page to
reflect the fact that aio_cancel() works now.

Submitted by:	Christopher Sedore <cmsedore@maxwell.syr.edu>
2000-03-21 10:25:22 +00:00
Sheldon Hearn
4e86fcacf6 Remove more single-space hard sentence breaks. 2000-03-02 14:54:02 +00:00
Sheldon Hearn
c6ff3a1bf7 Remove single-space hard sentence breaks. These degrade the quality
of the typeset output, tend to make diffs harder to read and provide
bad examples for new-comers to mdoc.
2000-03-02 09:14:21 +00:00
Paul Saab
9730a5daab Add MAP_NOCORE to mmap(2), and MADV_NOCORE and MADV_CORE to madvise(2).
This
This feature allows you to specify if mmap'd data is included in
an application's corefile.

Change the type of eflags in struct vm_map_entry from u_char to
vm_eflags_t (an unsigned int).

Reviewed by:	dillon,jdp,alfred
Approved by:	jkh
2000-02-28 04:10:35 +00:00
Matthew Dillon
1f6889a1eb Fix null-pointer dereference crash when the system is intentionally
run out of KVM through a mmap()/fork() bomb that allocates hundreds
    of thousands of vm_map_entry structures.

    Add panic to make null-pointer dereference crash a little more verbose.

    Add a new sysctl, vm.max_proc_mmap, which specifies the maximum number
    of mmap()'d spaces (discrete vm_map_entry's in the process).  The value
    defaults to around 9000 for a 128MB machine.  The test is scaled for the
    number of processes sharing a vmspace (aka linux threads).  Setting
    the value to 0 disables the feature.

PR: kern/16573
Approved by: jkh
2000-02-16 21:11:33 +00:00
Chris Costello
efeff014b4 Replace .Os BSD' which caused a troff error with .Bx' which also
happens to be the correct macro to use in this situation.
2000-02-14 01:34:15 +00:00
David E. O'Brien
ed0010ed09 Document the support in the kernel for hardware debug registers on the
ix86 platform which allows for hardware watchpoints, etc...

Submitted by:	Brian Dean <brdean@unx.sas.com>
2000-02-12 18:33:54 +00:00
Guido van Rooij
68d1433483 We _do_ support MS_ASYNC
Reviewed by:	Matthew Dillon <dillon@apollo.backplane.com>
2000-01-24 18:35:16 +00:00
Alfred Perlstein
621d130fd8 Clarify that we don't offer hard realtime.
Split timeval options into 3 paragraphs, it's easier on my eyes.
2000-01-24 02:13:21 +00:00
Sheldon Hearn
58d6ca9155 Add HISTORY.
Submitted by:	obrien
2000-01-18 12:50:13 +00:00
Bruce Evans
ee17748d12 Fixed missing backslash in previous commit. Adding setresuid.2 has taken
4 commits and 2 world breakages so far.
2000-01-18 05:38:05 +00:00
Sheldon Hearn
6af37844c7 Fix line too long style bug in the previous commit (which, by the
way, unbroke world).
2000-01-18 05:15:26 +00:00
Andrey A. Chernov
2b85852d78 add setresuid.2 2000-01-18 04:37:21 +00:00
Sheldon Hearn
b905f5bd46 Add manual pages for the newly added setres[ug]id system calls. 2000-01-17 15:01:42 +00:00
Kris Kennaway
bd2d54f0cb Sync contents of struct nfsd_svrargs 2000-01-09 01:54:35 +00:00
Bruce Evans
2f64ff4437 Fixed wrong #include in synopsis. 1999-12-23 16:48:57 +00:00
Bruce Evans
7452ae6ecc Fixed missing `const' in synopsis. 1999-12-23 16:46:34 +00:00
Bruce Evans
3050159ad5 Fixed missing installation of a link to getlogin_r.3. This is the first
example of section 2 and section 3 interfaces sharing a man page.  It's
probably a bad example.
1999-12-23 16:12:24 +00:00
Jeroen Ruigrok van der Werven
7bf92e055d Fix a typo which I cannot believe I missed after rereading this text
about 6-7 times prior to commit.

Reported by: sheldonh
1999-12-21 11:55:44 +00:00
Jeroen Ruigrok van der Werven
7ec9b49533 Properly manify this manpage.
Fix some spelling mistakes and typo's inspired by Nicholas' initial
PR submission.

PR:		docs/15597
Submitted by:	Nicholas Esborn <nick@flatlan.net>
1999-12-21 11:19:32 +00:00
Martin Cracauer
48e364bf96 Document SA_SIGINFO
Reviewed by:	Sheldon Hearn <sheldonh@uunet.co.za>
1999-12-15 16:51:35 +00:00
Matthew Dillon
4f79d873c1 Add MAP_NOSYNC feature to mmap(), and MADV_NOSYNC and MADV_AUTOSYNC to
madvise().

    This feature prevents the update daemon from gratuitously flushing
    dirty pages associated with a mapped file-backed region of memory.  The
    system pager will still page the memory as necessary and the VM system
    will still be fully coherent with the filesystem.  Modifications made
    by other means to the same area of memory, for example by write(), are
    unaffected.  The feature works on a page-granularity basis.

    MAP_NOSYNC allows one to use mmap() to share memory between processes
    without incuring any significant filesystem overhead, putting it in
    the same performance category as SysV Shared memory and anonymous memory.

Reviewed by: julian, alc, dg
1999-12-12 03:19:33 +00:00
Archie Cobbs
93521056fa Add reference to netgraph(4) in the 'see also' section. 1999-12-06 23:35:40 +00:00
Brian Feldman
1c982a6d2f Add RLIMIT_SBSIZE here, too. 1999-12-03 23:25:14 +00:00
Wes Peters
4d3be89f2a Document the getlogin_r function. 1999-11-28 22:41:50 +00:00
Poul-Henning Kamp
9b962c56a4 General clean-up of socket.h and associated sources to synchronise up
with NetBSD and the Single Unix Specification v2.

This updates some structures with other, almost equivalent types and
effort is under way to get the whole more consistent.

Also removes a double definition of INET6 and some other clean-ups.

Reviewed by: green, bde, phk
Some part obtained from: NetBSD, SUSv2 specification
1999-11-24 20:49:04 +00:00
Chris Costello
328984c261 Properly document what ENOENT really means for kldfind(2). 1999-11-14 18:15:33 +00:00
Nik Clayton
de1efdfc1a Document that bind(2) can fail with EAGAIN.
PR:             docs/14173 docs/14181
Submitted by:   Charles Randall <crandall@matchlogic.com>
Submitted by:   Kelly Yancey <kbyanc@posi.net>
1999-11-01 19:43:07 +00:00
Wes Peters
9466cad206 Correct the description of the timeout argument. I've examined
the code, which seems to implement the POSIX requirements, and
have described the behavior here.  Basically, it behaves the same
as select(2).

Noticed by: John Polstra
1999-10-09 01:35:58 +00:00
Wes Peters
58ae401b79 Fixed a typo (well, format-o) in yesterday's edits.
Spotted by:	John Polstra <jdp@polstra.com> (again)
1999-09-21 17:30:43 +00:00
Wes Peters
236cb8163d Fixed the description of when and why aio_suspend returns.
Also spelled out the return values and conditions a little
better.

Noticed by:	John Polstra <jdp@polstra.com>
1999-09-20 18:30:55 +00:00
Poul-Henning Kamp
978f8d9300 Add a version number field to the jail(2) argument so that future changes
can be handled intelligently.
1999-09-19 08:36:03 +00:00
Alfred Perlstein
07181581f9 Add FreeBSD history in 'HISTORY'
Pointed out by: obrien
1999-09-11 21:07:14 +00:00
Bruce Evans
665e2b8d01 Fixed disordering in previous commit. 1999-09-11 14:20:18 +00:00
Alfred Perlstein
6e5eff6270 Document fhopen, fhstat, and fhstatfs syscalls.
Obtained from:	NetBSD
1999-09-11 00:49:10 +00:00
Alfred Perlstein
6430719389 sync with src/sys/sys/mount.h 1999-09-10 09:12:24 +00:00
Bill Fumerola
3113e9d141 Add aio_{cancel,error,return,suspend,write} into the mix.
Submitted by:	Dan Nelson <dnelson@emsphone.com>
Forgotten by:	mpp
1999-09-09 19:06:57 +00:00
Alexey Zelkin
0ae8283b3d Some style and "look" fixes
Reviewed by:	mpp
1999-09-05 07:02:22 +00:00
Alexey Zelkin
b288071d9d Name Description (.Nd macro) added.
Style and punctuation errors fixes.
ERRORS section included to RETURN VALUES because it's
describing return values instead of errors and their handling.

Reviewed by:	mpp
1999-09-05 06:59:34 +00:00
Alexey Zelkin
1fcbf95515 mdoc(7) style fix.
Correct RB_* values list bounds.

Reviewed by:	mpp
1999-09-05 06:50:49 +00:00
Alexey Zelkin
b6c461d787 mdoc(7) style fix: FreeBSD -> .Fx
Reviewed by:	mpp
1999-09-05 06:47:01 +00:00
Alexey Zelkin
417f221ddc Remove useless .Fn macro suffix
Reviewed by:	mpp
1999-09-05 06:41:49 +00:00
Alexey Zelkin
c60ceb83c2 mdoc style fix.
Reviewed by:	mpp
1999-09-05 06:39:22 +00:00
Alexey Zelkin
3cd9a8622a mdoc(7) style fixes
Reviewed by:	mpp
1999-09-05 06:37:01 +00:00
Peter Wemm
7f3dea244c $Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00
Mike Pritchard
8a951d305e Remove some 4.3BSDish anacronisims that stated that it was an
error for a pathname to contain a character with the high-order
bit set.

Inspired by:  joerg's previous commit
1999-08-27 20:21:18 +00:00
Joerg Wunsch
b6e3808f9b Remove a 4.3BSDish anachronism that claimed EPERM for an attempt to
mknod() a pathname containg a ``character with the high-order bit
set''.
1999-08-27 14:25:00 +00:00
Chris Costello
1d71a557cc Document ENOSYS error.
PR:		docs/13290
1999-08-23 11:07:29 +00:00
Mike Pritchard
74804d58a0 Various man page cleanup:
- Sort xrefs
- FreeBSD.ORG -> FreeBSD.org
- Be consistent with section names as outlines in mdoc(7)
- Other misc mdoc cleanup.

PR:		doc/13144
Submitted by:	Alexy M. Zelkin <phantom@cris.net>
1999-08-15 09:51:25 +00:00
Chris Costello
e5721f2fd3 Change reference to mount(1) to mount(8) 1999-08-14 06:17:24 +00:00
Chris Costello
2d3a25e901 Change reference from kldload(3) to kldload(2) 1999-08-13 21:02:39 +00:00
Bruce Evans
176ef327fa Fixed $Id$.
Removed POSIX.1/NetBSD markup (braces) for NAME_MAX, etc.  We don't
define this.  Most FreeBSD man pages hard-code the limits; in fact,
utimes.2 recently became the only file in libc/sys/*.2 that mentions
NAME_MAX.  There probably should be mandoc macros for this.
1999-07-31 22:29:17 +00:00
Bruce Evans
fbcc97c9d2 Removed a duplicate reference to System V.4. 1999-07-31 22:14:46 +00:00
Bruce Evans
1c8deedd38 Fixed syntax error in previous commit. 1999-07-31 22:10:17 +00:00
Bruce Evans
d3ac30dd5e FIxed disordering in previous commit. Fixed some old disorder. 1999-07-31 22:00:09 +00:00
Nik Clayton
83f7951bfc Document that writev(2) can fail with ENOBUFS.
Text is a compromise based on messages from Wes Peters, Ville-Pertti
Keinonen, and Matt Dillon.

PR:             docs/10512
Submitted by:   Howard Goldstein <hgoldst@mpcs.com>
1999-07-30 21:20:09 +00:00
Mike Pritchard
6a8edfca23 Use the .At macro when referencing versions of AT&T UNIX.
Note: you need to install the current groff tmac macros for these
man pages to format correctly.  Specifically, rev 1.21 of
contrib_groff/tmac/doc-syms in -current, or rev 1.17.24 for 3.2-stable
1999-07-30 12:45:20 +00:00
Mike Pritchard
afb7dc43a9 Document the getdents(2) system call. The documentation was
added to the getdirentries(2) man page because 95%+ of that
man page comprised the text of the getdents(2) man page
I obtained from NetBSD.
1999-07-30 11:32:08 +00:00
Mike Pritchard
07677e5025 Document the lchmod(2) system call.
Pointed-out-by: bde
1999-07-30 10:08:21 +00:00
Mike Pritchard
38cf40702d Add a manual page for getdents(2). This was taken from NetBSD, but
still needs some cleanup which is why it hasn't been added to the
Makefile yet.

Obtained from:	NetBSD
Pointed-out-by: bde
1999-07-30 09:26:50 +00:00
Mike Pritchard
db58ff7d87 Document the lutimes() and futimes() system calls.
PR:		kern/11213
Obtained from:	NetBSD w/some minor changes by me
1999-07-30 09:01:45 +00:00
Mike Pritchard
4f8d723376 Mdoc cleanup. 1999-07-30 07:45:40 +00:00
Sheldon Hearn
4a9e5bd0db Correct HISTORY section, according to CVS logs.
PR:	12810
Submitted by:	Alex Perel <veers@disturbed.net>
1999-07-26 09:37:47 +00:00
Nick Hibma
ebec760f9a Update the manpage for the number of symlinks in ELOOP
PR:		12634 (partial)
Submitted by:	Julian H. Stacey jhs@FreeBSD.ORG
1999-07-24 16:45:57 +00:00
Hidetoshi Shimokawa
f2fd63aff2 Make profil() 64bit-safe for alpha.
uintfptr_t may be better for offset, but we must wait until
the definition of uintfptr_t moves from machine/profile.h.

Reviewed by: bde
1999-07-16 06:28:55 +00:00
Jonathan Lemon
9a670a9a6c Reference correct sysctl: kern.maxsockbuf --> kern.ipc.maxsockbuf 1999-07-15 17:15:24 +00:00
Nik Clayton
fbc400a67a 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 20:50:10 +00:00
Poul-Henning Kamp
38edd9beb9 Clarify an explanation a little bit. 1999-07-09 21:35:37 +00:00
Mike Pritchard
4343edfe20 Nuke the BUGS sections of these man pages because they are not appropriate. 1999-07-01 21:13:06 +00:00
Mike Pritchard
ec8dae7070 Fix typos/spelling errors. 1999-07-01 21:09:57 +00:00