xref: /freebsd/bin/nproc/nproc.1 (revision 1e078fb6021ebb5ccfb092fe9e5befcf4054ac0b)
148bfd359SMateusz Guzik.\"-
248bfd359SMateusz Guzik.\" * Copyright (c) 2023 Piotr Paweł Stefaniak
348bfd359SMateusz Guzik.\"
448bfd359SMateusz Guzik.\" * SPDX-License-Identifier: BSD-2-Clause
548bfd359SMateusz Guzik.\"
6*1e078fb6SMateusz Piotrowski.Dd June 2, 2023
748bfd359SMateusz Guzik.Dt NPROC 1
848bfd359SMateusz Guzik.Os
948bfd359SMateusz Guzik.Sh NAME
1048bfd359SMateusz Guzik.Nm nproc
1148bfd359SMateusz Guzik.Nd print the number of processors
1248bfd359SMateusz Guzik.Sh SYNOPSIS
1348bfd359SMateusz Guzik.Nm
1448bfd359SMateusz Guzik.Op Fl -all
1548bfd359SMateusz Guzik.Op Fl -ignore Ns = Ns Ar count
1648bfd359SMateusz Guzik.Nm Fl -help
1748bfd359SMateusz Guzik.Nm Fl -version
1848bfd359SMateusz Guzik.Sh DESCRIPTION
1948bfd359SMateusz GuzikThe
2048bfd359SMateusz Guzik.Nm
2148bfd359SMateusz Guzikutility is used to print the number of processors limited to the
2248bfd359SMateusz Guzik.Xr cpuset 2
2348bfd359SMateusz Guzikof the current process, unless the
2448bfd359SMateusz Guzik.Fl -all
2548bfd359SMateusz Guzikflag is specified.
2648bfd359SMateusz Guzik.Pp
2748bfd359SMateusz GuzikThe available flags are:
2848bfd359SMateusz Guzik.Bl -tag -width Ds
2948bfd359SMateusz Guzik.It Fl -all
3048bfd359SMateusz GuzikCount all processors currently online.
3148bfd359SMateusz Guzik.It Fl -ignore Ns = Ns Ar count
3248bfd359SMateusz GuzikThe result is decreased by
3348bfd359SMateusz Guzik.Ar count ,
3448bfd359SMateusz Guzikbut never below 1.
3548bfd359SMateusz Guzik.It Fl -version
366957cd86SKonstantin BelousovPrint the current program version and exit.
376957cd86SKonstantin BelousovDo not use this option.
3848bfd359SMateusz Guzik.It Fl -help
3948bfd359SMateusz GuzikPrint usage information and exit.
4048bfd359SMateusz Guzik.El
4148bfd359SMateusz Guzik.Sh COMPATIBILITY
4248bfd359SMateusz GuzikThis program is intended to be compatible with nproc as found in GNU coreutils.
43059320b8SMateusz Guzik.Sh BUGS
44059320b8SMateusz GuzikIf HyperThreading is enabled in BIOS and disabled in the kernel, the
45059320b8SMateusz Guzik.Fl -all
46059320b8SMateusz Guzikoption on Linux will still report all possible CPU threads.
47059320b8SMateusz GuzikOn FreeBSD only active threads will be reported.
4848bfd359SMateusz Guzik.Sh SEE ALSO
4948bfd359SMateusz Guzik.Xr cpuset 1
5048bfd359SMateusz Guzik.Sh HISTORY
5148bfd359SMateusz GuzikThe
5248bfd359SMateusz Guzik.Nm
5348bfd359SMateusz Guzikutility first appeared in
54*1e078fb6SMateusz Piotrowski.Fx 13.2 .
5548bfd359SMateusz Guzik.Sh AUTHORS
5648bfd359SMateusz Guzik.An -nosplit
5748bfd359SMateusz Guzik.An Mateusz Guzik Aq Mt mjg@FreeBSD.org
5848bfd359SMateusz Guzikwrote the program and
5948bfd359SMateusz Guzik.An Piotr Paweł Stefaniak Aq Mt pstef@FreeBSD.org
6048bfd359SMateusz Guzikwrote this page.
61