aboutsummaryrefslogtreecommitdiff
path: root/share/man/man3
Commit message (Collapse)AuthorAgeFilesLines
* share/man: Move many manpages to more correct packagesLexi Winter10 days1-0/+2
| | | | | | | | | | | | | | | | | | | | | | At the moment, all the manpages in share/man are in the utilities-man package. Move some of them to the package they should actually be in, using the new MANGROUPS feature. Move all of section 3 to clibs-man. Although some of these are from /usr/include/sys rather than libc, you can't practically use them without libc, and clibs-man is where the libc manpages live already. Move all of sections 4 and 9 to a new kernel-man package, except for atf-test-case.4 which goes to tests-man. atf-test-case.4 is in the wrong section, but this needs to be fixed upstream. kernel-man requires special handling in generate-ucl.lua since it's got a -man suffix but doesn't want the ' (manual pages)' automatic suffix. For now, fix this by adding a list of packages that don't get automatic suffixes. Reviewed by: ifreund_freebsdfoundation.org, manu, emaste Differential Revision: https://reviews.freebsd.org/D51504
* pthread_rwlockattr_init(3): Add more precise wording to the SYNOPSISJuraj Lutter2025-06-211-2/+2
| | | | | | | And also to ERRORS. Obtained from: OpenBSD Reviewed by: kib
* pthread_rwlockattr_destroy(3): Make SYNOPSIS more clearJuraj Lutter2025-06-211-2/+2
| | | | | | | Clarify pthread_rwlockattr_destroy is for use with an attributes object. Obtained from: OpenBSD Reviewed by: kib
* Implement CLOCK_TAINathan Whitehorn2025-06-121-1/+2
| | | | | | | | | | | | | | Provide a clock through clock_gettime() that returns the current TAI time (UTC without leap seconds) as a complement to CLOCK_REALTIME. This provides compatibility with Linux, which also provides a CLOCK_TAI since kernel 2.6.26, and this seems to be becoming the standard way to acquire TAI time. Unlike Linux, this code will return EINVAL if the TAI offset (set by ntpd, ptpd, etc.) is not known since it seems pathological for CLOCK_TAI to silently give the wrong (UTC) time if the offset is not known as it does on Linux. Reviewed by: imp Differential Revision: https://reviews.freebsd.org/D46268
* pthread_signals_block_np(3): documentKonstantin Belousov2025-05-193-0/+90
| | | | | | | Reviewed by: markj Sponsored by: The FreeBSD Foundation MFC after: 1 week Differential revision: https://reviews.freebsd.org/D50377
* pthread_switch_add_np(3): removeKonstantin Belousov2025-05-193-98/+0
| | | | | | | | | | | | The interface is not functional with libthr and returns not supported error always. There is no point in providing it to userspace or document. The symbols are kept for ABI compatibility, of course. Reviewed by: emaste, markj Sponsored by: The FreeBSD Foundation MFC after: 1 week Differential revision: https://reviews.freebsd.org/D50376
* queue(3): Install *_SPLIT_AFTER() links to the main manual pageOlivier Certner2025-05-071-0/+4
| | | | | | | | Completes commit "queue(3): New *_SPLIT_AFTER(), *_ASSERT_EMPTY(), *_ASSERT_NONEMPTY()" (c02880233949b01f). MFC after: 1 day Sponsored by: The FreeBSD Foundation
* queue.3: document STAILQ_REVERSEKonstantin Belousov2025-05-062-0/+7
| | | | | | | Reviewed by: markj, olce Sponsored by: The FreeBSD Foundation MFC after: 1 week Differential revision: https://reviews.freebsd.org/D50131
* alloca.3: move to share/man/man3Brooks Davis2025-04-292-1/+85
| | | | | | | The alloca() API is a compiler builtin and not generally part of libc. Reviewed by: imp Differential Revision: https://reviews.freebsd.org/D50055
* queue.3: Update .DdOlivier Certner2025-04-281-1/+1
| | | | | | Noted by: lwhsu MFC after: 3 days Sponsored by: The FreeBSD Foundation
* queue(3): Debug macros: Finer control knobs, userland supportOlivier Certner2025-04-281-28/+66
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Support enabling debugging macros for userland and _STANDALONE builds, in addition to the already existing kernel support. On runtime error, panic() is used for kernel and _STANDALONE builds, and a simple fprintf() + abort() combination for userland ones. These can be overriden if needed by defining the QMD_PANIC() and/or QMD_ASSERT() macros. The expansion of queue debug macros can now be controlled more finely thanks to the QUEUE_MACRO_DEBUG_ASSERTIONS and QUEUE_MACRO_NO_DEBUG_ASSERTIONS macros. The first one serves to forcibly enable debug code and the second to forcibly disable it. These are meant to be used as compile options only, and should normally not be defined in a source file. It is an error to have both of them defined. If none of the two above-mentioned macros are defined, an automatic determination is performed. When compiling kernel code, QUEUE_MACRO_DEBUG_ASSERTIONS is defined if INVARIANTS has been defined (as before). For userland and _STANDALONE builds, no debug code is ever automatically inserted even if NDEBUG is not defined, as doing so would inflate code size and users may want to have working assert() calls without this overhead by default. In the manual page, document check code control under DIAGNOSTICS. While here, rework a bit the rest of the DIAGNOSTICS section. Reviewed by: markj (older version) MFC after: 3 days Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D49973
* queue(3): New *_SPLIT_AFTER(), *_ASSERT_EMPTY(), *_ASSERT_NONEMPTY()Olivier Certner2025-04-281-0/+54
| | | | | | | | | | | | | | *_SPLIT_AFTER() allows to split an existing queue in two. It is the missing block that enables arbitrary splitting and recombinations of lists/queues together with *_CONCAT() and *_SWAP(). Add *_ASSERT_NONEMPTY(), used by *_SPLIT_AFTER(). Reviewed by: markj MFC after: 3 days Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D49608 (stailq) Differential Revision: https://reviews.freebsd.org/D49969 (rest)
* queue: Add atomic variants for *_EMPTYMark Johnston2025-02-141-1/+25
| | | | | | | | | | | | | | | | In some places, these macros are used without a lock, under the assumption that they are naturally atomic. After commit 34740937f7a4 ("queue: New debug macros for STAILQ"), this assumption is false. Provide *_EMPTY_ATOMIC for such cases. This lets us include extra debug checks for the non-atomic case, and gives us a way to explicitly annotate unlocked checks, which generally deserve extra scrutiny and might otherwise raise reports from KCSAN. Reviewed by: kib, olce (previous version) MFC after: 2 weeks Differential Revision: https://reviews.freebsd.org/D48899
* pthread_setcancelstate(3): make it async-signal-safeKonstantin Belousov2024-12-281-0/+6
| | | | | | | | | | | | | | | | by setting new cancel state and reading old cancel state from the curthread structure atomic. Note that this does not play well with async cancellation, since if cancellation is enabled from a signal handler and cancellation request is pending, the thread is cancelled immediately, calling user-defined destructors, which all must be async-signal-safe (but this is a general requirement for async cancellation anyway). Reviewed by: markj Sponsored by: The FreeBSD Foundation MFC after: 1 week Differential revision: https://reviews.freebsd.org/D48200
* timeradd.3: Add missing .Pp after .EdJohn Baldwin2024-12-131-0/+1
| | | | | | | This ensures a blank line between the end of the struct timeval definition and the following paragraph. Formatting change only. Sponsored by: Chelsio Communications
* intro(3): remove profiling libsEd Maste2024-11-271-5/+1
| | | | | | | We no longer have libc_p.a or libm_p.a. Fixes: 3750ccefb862 ("Retire MK_PROFILE infrastructure") Sponsored by: The FreeBSD Foundation
* manuals: Remove trailing spacesGraham Percival2024-11-042-2/+2
| | | | | | | | | | This does not change the rendered ascii at all. Signed-off-by: Graham Percival <gperciva@tarsnap.com> Reviewed by: mhorne, Alexander Ziaee <concussious.bugzilla@runbox.com> MFC after: 3 days Sponsored by: Tarsnap Backup Inc. Pull Request: https://github.com/freebsd/freebsd-src/pull/1473
* Canonicalize the name of the FreeBSD FoundationLi-Wen Hsu2024-10-233-3/+3
| | | | | Reviewed by: emaste Sponsored by: The FreeBSD Foundation
* they have been not true since 2012.John-Mark Gurney2024-10-191-4/+1
|
* stats.3: Fix "skipping end of block" syntax errorsGraham Percival2024-10-031-14/+14
| | | | | | | | | | | | | | | | | These were reported by `mandoc -T lint ...` as errors. The rendered output (in ascii and html) is not affected by this commit. There was a small misunderstanding about the mdoc format: a 1-line enclosure does not need a closing tag. For example, Pc is for closing an Po; if a line uses Pq (enclose the remainder of this line), there's no need for Pc. Signed-off-by: Graham Percival <gperciva@tarsnap.com> Reviewed by: mhorne MFC after: 3 days Sponsored by: Tarsnap Backup Inc. Pull Request: https://github.com/freebsd/freebsd-src/pull/1434
* tree.3: the example code fixedMaxim Konovalov2024-08-031-5/+5
| | | | | PR: 280566 Reviewed by: dougm
* Remove residual blank line at start of MakefileWarner Losh2024-07-151-1/+0
| | | | | | | This is a residual of the $FreeBSD$ removal. MFC After: 3 days (though I'll just run the command on the branches) Sponsored by: Netflix
* man filesystems: fix xrefs after move to section 4Alexander Ziaee2024-05-161-1/+1
| | | | | Reviewed by: des, imp Pull Request: https://github.com/freebsd/freebsd-src/pull/1077
* sysexits: Tidy deprecated header and manualAlexander Ziaee2024-05-101-25/+18
| | | | | | | | | | | | | <sysexits.h> was deprecated in the base system in a1432b4 for FreeBSD 8.0 and is retained only for backwards compatibility. Make that clear, since sysexits(3) suggested using it since it was in style(9) prior to this. MFC after: 1 week Co-authored-by: imp Fixes: a1432b4 Reviewed by: imp, pauamma (previous version) Pull Request https://github.com/freebsd/freebsd-src/pull/1195
* pthread_sigqueue(3): documentKonstantin Belousov2024-04-232-0/+103
| | | | | | | Reviewed by: markj Sponsored by: The FreeBSD Foundation MFC after: 1 week Differential revision: https://reviews.freebsd.org/D44867
* sys/queue.h: Add {LIST,TAILQ}_REPLACE().Dag-Erling Smørgrav2024-04-082-2/+34
| | | | | | | | MFC after: 1 week Obtained from: NetBSD Sponsored by: Klara, Inc. Reviewed by: cperciva, imp Differential Revision: https://reviews.freebsd.org/D44679
* assert.3: Update manual page based on mandoc -TlintChristopher Davidson2024-03-211-4/+0
| | | | | | | | | | | | Execute the mandoc -Tlint option on assert(3). This results in two areas of updates: Remove invalid Rs block Remove invalid Re block Reviewed by: mhorne MFC after: 3 days Pull Request: https://github.com/freebsd/freebsd-src/pull/1132
* pthread_attr_get_np(3): RevampOlivier Certner2024-01-101-35/+49
| | | | | | | | | | | | | | | | | Fix and more thoroughly describe the attributes object lifecycle. Also, correct the text about which attributes' values are reported. Add the ENOMEM error. While here, rephrase unclear passages, add references and fix the example's style. Reviewed by: kib, emaste Approved by: emaste (mentor) MFC after: 2 weeks Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D43330
* Fix typos in man pages under /share/manBenedict Reuschling2024-01-021-1/+1
| | | | Found using: devel/py-proselint
* share: Remove ancient SCCS tags.Warner Losh2023-11-278-15/+0
| | | | | | | | Remove ancient SCCS tags from the tree, automated scripting, with two minor fixup to keep things compiling. All the common forms in the tree were removed with a perl script. Sponsored by: Netflix
* bitstring: Support large bit strings.Dag-Erling Smørgrav2023-11-221-25/+25
| | | | | | | | | | | | Replace int with either size_t or ssize_t (depending on context) in order to support bit strings up to SSIZE_MAX bits in length. Since some of the arguments that need to change type are pointers, we must resort to light preprocessor trickery to avoid breaking existing code. MFC after: 3 weeks Sponsored by: Klara, Inc. Reviewed by: kevans Differential Revision: https://reviews.freebsd.org/D42698
* Document library types in the intro(3) manual pageGordon Bergling2023-11-161-3/+94
| | | | | | | | | | | Add a paragraph about library types to the intro(3) manual page. Document library types, locations and versioning. Reviewed by: emaste, jilles, mhorne, pauamma_gundo.com Obtained from: OpenBSD (partial) MFC after: 3 weeks Differential Revision: https://reviews.freebsd.org/D36594
* pthread_mutexattr(3), _condattr(3): reference libthr(3)Konstantin Belousov2023-10-262-2/+12
| | | | | | | Reviewed by: emaste Sponsored by: The FreeBSD Foundation MFC after: 3 days Differential revision: https://reviews.freebsd.org/D42344
* pthread_mutexattr_init(3): describe pthread_mutexattr_{set,get}psharedKonstantin Belousov2023-10-261-0/+20
| | | | | | | | PR: 274678 Reviewed by: emaste Sponsored by: The FreeBSD Foundation MFC after: 3 days Differential revision: https://reviews.freebsd.org/D42344
* include: Implement N2867.Dag-Erling Smørgrav2023-09-072-0/+110
| | | | | | | This adds macros for checked addition, subtraction, and multiplication with semantics similar to the builtins gcc and clang have had for years. Reviewed by: kib, emaste Differential Revision: https://reviews.freebsd.org/D41734
* Remove $FreeBSD$: one-line nroff patternWarner Losh2023-08-169-9/+0
| | | | Remove /^\.\\"\s*\$FreeBSD\$$\n/
* Remove $FreeBSD$: two-line nroff patternWarner Losh2023-08-1689-178/+0
| | | | Remove /^\.\\"\n\.\\"\s*\$FreeBSD\$$\n/
* Remove $FreeBSD$: one-line sh patternWarner Losh2023-08-162-2/+0
| | | | Remove /^\s*#[#!]?\s*\$FreeBSD\$.*$\n/
* Correct grammo. This one has spread. Should be the last.Jens Schweikhardt2023-07-081-1/+1
|
* Correct a grammo.Jens Schweikhardt2023-07-081-1/+1
|
* netlink: Fix "version introduced" documentationTom Hukins2023-03-041-1/+1
| | | | | | | | | | | | netlink(4) and associated features will exist in FreeBSD 14.0 but they will also exist in 13.2, an older version, from commits such as 02b958b1 and b309249b. This commit needs merging to stable/13 and releng/13.2. MFC after: 2days (needs to be in RC2) Reviewed by: imp,melifaro Pull Request: https://github.com/freebsd/freebsd-src/pull/651
* netlink: add u8/u64 attribute fetcher accessors to snl(3).Alexander V. Chernikov2023-03-031-0/+8
| | | | MFC after: 2 weeks
* libthr: Fix pthread_attr_[g|s]etaffinity_np manual.Dmitry Chagin2023-01-291-5/+6
| | | | | | Fix my fault in f35093f8. MFC after: 1 week
* libthr: Fix pthread_[g|s]etaffinity_np manual.Dmitry Chagin2023-01-291-7/+18
| | | | | | | | | | | | | | | | Since f35093f8 semantics of a thread affinity functions is changed to be a compatible with Linux: In case of getaffinity(), the minimum cpuset_t size that the kernel permits is the maximum CPU id, present in the system, / NBBY bytes, the maximum size is not limited. In case of setaffinity(), the kernel does not limit the size of the user-provided cpuset_t, internally using only the meaningful part of the set, where the upper bound is the maximum CPU id, present in the system, no larger than the size of the kernel cpuset_t. Reviewed by: jhb, kib Differential Revision: https://reviews.freebsd.org/D38111 MFC after: 1 week
* netlink: add snl(3) manpage to the buildAlexander V. Chernikov2023-01-161-0/+1
|
* netlink: add snl(3) - simple netlink libraryAlexander V. Chernikov2022-12-231-0/+303
| | | | | Reviewed by: bapt, pauamma Differential Revision: https://reviews.freebsd.org/D37736
* intro.3: Document 'libstdthreads' (the ISO C11 '<threads.h>' library).Gordon Bergling2022-11-071-1/+8
| | | | | | | | | | | | | It's still relatively uncommon to see C11 '<threads.h>' being used, but it's worth documenting, especially since FreeBSD requires a different library for C11 threads compared to glibc (part of '-lpthread') or musl libc (included by default). PR: 267551 Submitted by: Alois Klink <alois plus freebsd at aloisklink dot com> Reviewed by: pauamma MFC after: 3 days Differential Revision: https://reviews.freebsd.org/D37284
* CMSG_DATA.3: Fix a typo in the EXAMPLES sectionGordon Bergling2022-10-251-1/+1
| | | | | | - s/faild/failed/ MFC after: 3 days
* pthread_setschedparam(3): document EPERM returnMitchell Horne2022-10-171-1/+3
| | | | | | | | | | In kern_sched_setparam(), before setting any parameters, p_cansched() is called to check that the thread has appropriate privileges. PR: 175687 Reviewed by: markj MFC after: 1 week Differential Revision: https://reviews.freebsd.org/D37020
* rb_tree: let insert search start from next nodeDoug Moore2022-10-031-0/+18
| | | | | | | | | | | | | | | When the node to insert in the rb_tree is known to precede or follow a particular node, new methods RB_INSERT_PREV and RB_INSERT_NEXT, defined here, allow the search for where to insert the new node begin with that particular node, rather than at the root, to save a bit of time. Using those methods, instead of RB_INSERT, in managing a tree in iommu_gas.c, saves a little time. Reviewed by: kib MFC after: 3 weeks Differential Revision: https://reviews.freebsd.org/D35516