Proc-ProcessTable-ncps/README.md

# About
New Colorized(optional) PS, a enhanced version of PS with advanced searching capabilities.

![ncps](ncps.png)

The search criteria can be any of the following.

* command
* EUID set
* EGID set
* JID
* is a kernel process
* percent of memory usage
* percent of CPU usage
* RSS
* VSZ
* is swapped out
* process state
* CPU time in seconds
* UID or username
* wait channel
* is a zombie process

# Command Line Options
```
-c <regex>    Search procs using the matching regex.
--ci          Invert the command search.

--cf          Show children minor faults.

--cF          Show children major faults.

--eg          Search for proccs with a EGID set.
--egi         Invert the EGID set search.

--eu          Search for proccs with a EUID set.
--eui         Invert the EUID set search.

-f            Show minor faults.

-F            Show major faults.

-J            Show jail IDs.
-j <jids>     A comma seperated list of JIDs to search for.
--ji          Invert the JIDs earch.

--idle        Show the idle kernel process.

--kern        Searches for kernel processes.
--kerni       Invert the kernel process search.

-m <pctmem>   Memory usage percent to search for.
--mi          Invert the memory usage search.

-n            Show number of threads.

--nc          disable color.

-p <pctcpu>   CPU usage percent to search for.
--pi          Invert the CPU usage search.

--pid <pids>  PIDs to search for.
--pidi        Invert the PID search.

-r <RSSs>     A comma seperated list of RSS values to search for.
--ri          Invert the RSS search.

-s            Show swapped out procs.
--si          Invert the swapped out search.

--self        Show the the ncps process as well.

--st <states> A comma seperated list of states to search for.
--sti         Invert the state search.

--stats       Print some general states about CPU usage and memory usage.

-t <times>    A comma seperated value of time, in seconds, to search for.
--ti          Invert the time search.

--tty         Show TTYs.

-u <UIDs>     A comma seperated list of UIDs or usernames.
--ui          Invert the UID/username search.

-vs <VSZs>    A comma seperated list of VSZs to search for.
--vsi         Invert the VSZ search.

-w <wchans>   A string search for wait channels.
--wi          Invert the wait channel search.

-z            Show zombies procs.


For the various switches above that can take numeric values,
the equalities below can be used, by directly prepending them to
the number.
<
<=
>
>=
!
```

# Enviromental Variables

The enviromental variables below may be set to set the default for the
flag in question.

Unless set to defined ands set to 1, these will default to 0.


| Variable |  Description  |
| -------- | ---------------- |
|  NCPS_jid | Sets the default for the -J flag.    |
|   NCPS_numthr | Sets the default for the -n flag.|
|   NCPS_cmajflt | Sets the default for the --cF flag. |
|   NCPS_majflt | Sets the default for the -F flag. |
|  NCPS_cminflt | Sets the default for the --cf flag. |
|  NCPS_minflt | Sets the default for the -f flag. |
|  NCPS_tty | Sets the default for the --tty flag. |
|  NCPS_self | Sets the default for the --self flag. |
|  NCPS_idle | Sets the default for the --idle flag. |
|  NO_COLOR | Don't colorize the output. |


# EXAMPLES
    ncps -J -j 0 --ji

Display all processes with a jail ID other than zero.

    ncps -c firefox --stats

Show all firefox processes and the stats for them.

    ncps -F -f -cF -cf

Show all minor/major values for processes.

    ncps -p '>1'

Show all processes using more than 1% of the CPU time.


# Installing

## FreeBSD

    pkg install perl5 p5-App-cpanminus
    cpanm Proc::ProcessTable::ncps
    
## Linux

### CentOS

    yum install cpanm
    cpanm Proc::ProcessTable::ncps

### Debian

This has been tested as working on Debian 9 minimal.

    apt install perl perl-base perl-modules make cpanminus gcc 
    cpanm Proc::ProcessTable::ncps