about summary refs log tree commit diff
diff options
context:
space:
mode:
authorLeah Neukirchen <leah@vuxu.org>2023-05-08 15:34:58 +0200
committerLeah Neukirchen <leah@vuxu.org>2023-05-08 15:34:58 +0200
commit58246397d7e5898c886337502d089a84b3b1faa8 (patch)
treed2f6df8b435f11dc0e766bf3b5e10aca527be70c
parent8926a832f09d30c7428474edd553e89ad83a58a0 (diff)
downloadpx-58246397d7e5898c886337502d089a84b3b1faa8.tar.gz
px-58246397d7e5898c886337502d089a84b3b1faa8.tar.xz
px-58246397d7e5898c886337502d089a84b3b1faa8.zip
add manpage and README
-rw-r--r--README39
-rw-r--r--px.149
2 files changed, 88 insertions, 0 deletions
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 <leah@vuxu.org>
+
+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/