Differential D26310 Diff 77017 usr.bin/procstat/procstat.1

Changeset View

Standalone View

usr.bin/procstat/procstat.1

	Show All 19 Lines
	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)			.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT			.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY			.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF			.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	.\" SUCH DAMAGE.			.\" SUCH DAMAGE.
	.\"			.\"
	.\" $FreeBSD$			.\" $FreeBSD$
	.\"			.\"
	.Dd March 4, 2019			.Dd September 14, 2020
	.Dt PROCSTAT 1			.Dt PROCSTAT 1
	.Os			.Os
	.Sh NAME			.Sh NAME
	.Nm procstat			.Nm procstat
	.Nd get detailed process information			.Nd get detailed process information
	.Sh SYNOPSIS			.Sh SYNOPSIS
	.Nm			.Nm
	.Op Fl -libxo			.Op Fl -libxo
	▲ Show 20 Lines • Show All 60 Lines • ▼ Show 20 Lines
	.Nm			.Nm
	.Op Fl -libxo			.Op Fl -libxo
	.Fl L			.Fl L
	.Op Fl h			.Op Fl h
	.Op Fl M Ar core			.Op Fl M Ar core
	.Op Fl N Ar system			.Op Fl N Ar system
	.Op Fl w Ar interval			.Op Fl w Ar interval
	.Ar core ...			.Ar core ...
				.Nm pargs \| penv \| pwdx
				.Op Fl -libxo
				.Ar pid ...
	.Sh DESCRIPTION			.Sh DESCRIPTION
	.Nm			.Nm
	utility displays detailed information about the processes identified by the			utility displays detailed information about the processes identified by the
	.Ar pid			.Ar pid
	arguments, or if the			arguments, or if the
	.Fl a			.Fl a
	flag is used, all processes.			flag is used, all processes.
	It can also display information extracted from a process core file, if			It can also display information extracted from a process core file, if
	the core file is specified as the argument.			the core file is specified as the argument.
	.Pp			.Pp
				The
				gbeUnsubmitted Done Inline Actions I would start that paragraph with a 'The'. gbe: I would start that paragraph with a 'The'.
				.Nm pargs ,
				.Nm penv
				and
				.Nm pwdx
				utilities mimics the Solaris utilities of the same names.
				They display the arguments, environment and current working directory,
				respectively of the process specified by
				.Ar pid
				argument.
				kibUnsubmitted Done Inline Actions I suggest to reorder description to de-empase Solaris part. First describe each of the command, then as the last sentence mention that the intent is to 'mimic the Solaris ...', as a hint to reader. kib: I suggest to reorder description to de-empase Solaris part. First describe each of the command…
				.Pp
	If the			If the
	.Fl -libxo			.Fl -libxo
	flag is specified the output is generated via			flag is specified the output is generated via
	.Xr libxo 3			.Xr libxo 3
	in a selection of different human and machine readable formats.			in a selection of different human and machine readable formats.
	See			See
	.Xr xo_parse_args 3			.Xr xo_parse_args 3
	for details on command line arguments.			for details on command line arguments.
	.Pp			.Pp
	The following commands are available:			The following commands are available for
				.Nm :
	.Bl -tag -width indent			.Bl -tag -width indent
	.It Ar basic			.It Ar basic
	Print basic process statistics (this is the default).			Print basic process statistics (this is the default).
	.It Ar binary \| Fl b			.It Ar binary \| Fl b
	Display binary information for the process.			Display binary information for the process.
	.Pp			.Pp
	Substring commands are accepted.			Substring commands are accepted.
	.It Ar argument(s) \| Fl c			.It Ar argument(s) \| Fl c
	▲ Show 20 Lines • Show All 292 Lines • ▼ Show 20 Lines
	signal name			signal name
	.It FLAGS			.It FLAGS
	process signal disposition details, three symbols			process signal disposition details, three symbols
	.Bl -tag -width X -compact			.Bl -tag -width X -compact
	.It P			.It P
	if signal is pending in the global process queue; - otherwise.			if signal is pending in the global process queue; - otherwise.
	.It I			.It I
	if signal delivery disposition is			if signal delivery disposition is
	.Dv SIG_IGN;			.Dv SIG_IGN ;
	- otherwise.			- otherwise.
	.It C			.It C
	if the signal will be caught; - otherwise.			if the signal will be caught; - otherwise.
	.El			.El
	.El			.El
	.Pp			.Pp
	If			If
	.Fl n			.Fl n
	▲ Show 20 Lines • Show All 264 Lines • ▼ Show 20 Lines
	.Sh AUTHORS			.Sh AUTHORS
	.An Robert N M Watson Aq Mt rwatson@FreeBSD.org .			.An Robert N M Watson Aq Mt rwatson@FreeBSD.org .
	.br			.br
	.Xr libxo 3			.Xr libxo 3
	support was added by			support was added by
	.An -nosplit			.An -nosplit
	Allan Jude			Allan Jude
	.Aq Mt allanjude@FreeBSD.org .			.Aq Mt allanjude@FreeBSD.org .
				.br
				.An Juraj Lutter
				.Aq Mt juraj@lutter.sk
				added the pargs, penv and pwdx functionality.
				gbeUnsubmitted Done Inline Actions 'options' would maybe a more suitable description. gbe: 'options' would maybe a more suitable description.
	.Sh BUGS			.Sh BUGS
	The display of open file or memory mapping pathnames is implemented using the			The display of open file or memory mapping pathnames is implemented using the
	kernel's name cache.			kernel's name cache.
	If a file system does not use the name cache, or the path to a file is not in			If a file system does not use the name cache, or the path to a file is not in
	the cache, a path will not be displayed.			the cache, a path will not be displayed.
	.Pp			.Pp
	.Nm			.Nm
	currently supports extracting data only from a live kernel, and not from			currently supports extracting data only from a live kernel, and not from
	kernel crash dumps.			kernel crash dumps.