From 6a2f098e72e71437154ec00506e8e736aa8e1026 Mon Sep 17 00:00:00 2001 From: Soccera1 <129828376+Soccera1@users.noreply.github.com> Date: Tue, 28 Jul 2026 15:54:54 +1000 Subject: Add docs --- man/nproc.1 | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 man/nproc.1 (limited to 'man/nproc.1') diff --git a/man/nproc.1 b/man/nproc.1 new file mode 100644 index 0000000..aa4343f --- /dev/null +++ b/man/nproc.1 @@ -0,0 +1,51 @@ +.\" Adapted for BNU from the GNU Coreutils 9.11 manual page; see doc/README.md. +.TH NPROC "1" "2026-07-28" "BNU 9.11" "BNU Commands" +.SH NAME +nproc \- print the number of processing units available +.SH SYNOPSIS +.B nproc +[\fI\,OPTION\/\fR]... +.SH DESCRIPTION +.\" This page is derived from GNU Coreutils documentation. +This page documents BNU, an independent Bun implementation compatible with +GNU Coreutils 9.11. +.PP +Print the number of processing units available to the current process, +which may be less than the number of online processors. +If the 'OMP_NUM_THREADS' or 'OMP_THREAD_LIMIT' environment variables are set, +then they will determine the minimum and maximum returned value respectively. +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#nproc--all'\fB\-\-all\fP\X'tty: link' +print the number of installed processors, +disregarding any OpenMP environment variables, or CPU quotas. +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#nproc--ignore'\fB\-\-ignore=N\fP\X'tty: link' +if possible, exclude N processing units. +The result is guaranteed to be at least 1. +.TP +\X'tty: link https://www.gnu.org/software/coreutils/nproc#nproc--help'\fB\-\-help\fP\X'tty: link' +display this help and exit +.TP +\X'tty: link https://www.gnu.org/software/coreutils/nproc#nproc--version'\fB\-\-version\fP\X'tty: link' +output version information and exit +.SH AUTHORS +Upstream GNU Coreutils documentation authors: +Written by Giuseppe Scrivano. +.br +Adapted for BNU; the BNU implementation is independent. +.SH "REPORTING BUGS" +Report BNU bugs at . +.br +For upstream GNU Coreutils, see . +.SH COPYRIGHT +Copyright \(co 2026 Free Software Foundation, Inc. +.br +This manual page was adapted for BNU in 2026. +License GPLv3+: GNU GPL version 3 or later . +.br +This is free software: you are free to change and redistribute it. +There is NO WARRANTY, to the extent permitted by law. +.SH "SEE ALSO" +Upstream documentation +.br +BNU documentation is available locally via: info \(aq(bnu) nproc invocation\(aq -- cgit v1.3