From 58246397d7e5898c886337502d089a84b3b1faa8 Mon Sep 17 00:00:00 2001 From: Leah Neukirchen Date: Mon, 8 May 2023 15:34:58 +0200 Subject: add manpage and README --- README | 39 +++++++++++++++++++++++++++++++++++++++ px.1 | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 88 insertions(+) create mode 100644 README create mode 100644 px.1 diff --git a/README b/README new file mode 100644 index 0000000..da89814 --- /dev/null +++ b/README @@ -0,0 +1,39 @@ +PX(1) General Commands Manual PX(1) + +NAME + px – report details on matching processes + +SYNOPSIS + px [-f] PATTERNS ... + +DESCRIPTION + px searches the process list for processes matching any of the patterns + PATTERNS and prints details on them, namely PID, user, cpu usage, virtual + and real memory usage, start time, run time and cpu time, as well as the + full command line. + + As PATTERNS may be used: substrings of the process name or numeric PIDs. + + The options are as follows: + + -f Search the whole command line, including arguments. + +EXIT STATUS + The px utility returns 0 when a process was found, 1 if no process was + found, and 2 when other errors occured. + +SEE ALSO + ps(1), pgrep(2) + +AUTHORS + Leah Neukirchen + +LICENSE + px is in the public domain. + + To the extent possible under law, the creator of this work has waived all + copyright and related or neighboring rights to this work. + + http://creativecommons.org/publicdomain/zero/1.0/ + +Void Linux May 8, 2023 Void Linux diff --git a/px.1 b/px.1 new file mode 100644 index 0000000..d446cd0 --- /dev/null +++ b/px.1 @@ -0,0 +1,49 @@ +.Dd May 08, 2023 +.Dt PX 1 +.Os +.Sh NAME +.Nm px +.Nd report details on matching processes +.Sh SYNOPSIS +.Nm +.Op Fl f +.Ar PATTERNS ... +.Sh DESCRIPTION +.Nm +searches the process list for processes matching any of the patterns +.Ar PATTERNS +and prints details on them, +namely PID, user, cpu usage, virtual and real memory usage, +start time, run time and cpu time, as well as the full command line. +.Pp +As +.Ar PATTERNS +may be used: +substrings of the process name or numeric PIDs. +.Pp +The options are as follows: +.Bl -tag -width Ds +.It Fl f +Search the whole command line, including arguments. +.El +.Sh EXIT STATUS +The +.Nm +utility returns 0 when a process was found, +1 if no process was found, +and 2 when other errors occured. +.Sh SEE ALSO +.Xr ps 1 , +.Xr pgrep 2 +.Sh AUTHORS +.An Leah Neukirchen Aq Mt leah@vuxu.org +.Sh LICENSE +.Nm +is in the public domain. +.Pp +To the extent possible under law, +the creator of this work +has waived all copyright and related or +neighboring rights to this work. +.Pp +.Lk http://creativecommons.org/publicdomain/zero/1.0/ -- cgit 1.4.1