The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

ppgrep - Look up parents' processes based on name and other attributes

VERSION

This document describes version 0.031 of ppgrep (from Perl distribution App-ProcUtils), released on 2018-04-03.

SYNOPSIS

Usage:

 % ppgrep [options] [pattern]

DESCRIPTION

This utility is similar to pgrep except that we only look at our descendants (parent, parent's parent, and so on up to PID 1).

OPTIONS

* marks required options.

Display options

--count, -c

Suppress normal output; instead print a count of matching processes.

--list-full, -a

List the full command line as well as the process ID.

--list-name, -l

List the process name as well as the process ID.

Filtering options

--euid=s, -u

Only match processes whose effective user ID is listed. Either the numerical or symbolical value may be used..

--exact, -x

Only match processes whose names (or command line if -f is specified) exactly match the pattern.

--full, -f

The pattern is normally only matched against the process name. When -f is set, the full command line is used..

--group=s, -G

Only match processes whose real group ID is listed. Either the numerical or symbolical value may be used..

--inverse, -v

Negates the matching.

--pattern=s

Only match processes whose name/cmdline match the pattern.

--pgroup=s, -g

Only match processes in the process group IDs listed.

--session=s, -s

Only match processes whose process session ID is listed.

--terminal=s, -t

Only match processes whose controlling terminal is listed. The terminal name should be specified without the "/dev/" prefix..

--uid=s, -U

Only match processes whose user ID is listed. Either the numerical or symbolical value may be used..

Output options

--format=s

Choose output format, e.g. json, text.

Default value:

 undef
--json

Set output format to json.

--naked-res

When outputing as JSON, strip result envelope.

Default value:

 0

By default, when outputing as JSON, the full enveloped result is returned, e.g.:

    [200,"OK",[1,2,3],{"func.extra"=>4}]

The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:

    [1,2,3]

Other options

--help, -h, -?

Display help message and exit.

--version, -V

Display program's version and exit.

COMPLETION

This script has shell tab completion capability with support for several shells.

bash

To activate bash completion for this script, put:

 complete -C ppgrep ppgrep

in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is recommended, however, that you install modules using cpanm-shcompgen which can activate shell completion for scripts immediately.

tcsh

To activate tcsh completion for this script, put:

 complete ppgrep 'p/*/`ppgrep`/'

in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is also recommended to install shcompgen (see above).

other shells

For fish and zsh, install shcompgen as described above.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-ProcUtils.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-ProcUtils.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-ProcUtils

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

SEE ALSO

pgrep.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2018, 2016, 2015 by perlancar@cpan.org.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.