diff options
| author | Matias Linares <matiaslina@gmail.com> | 2020-07-11 20:09:50 -0300 |
|---|---|---|
| committer | Matias Linares <matiaslina@gmail.com> | 2020-07-11 20:09:50 -0300 |
| commit | 1aa6c4d3658d859e8fa173b67f2e9e5256717021 (patch) | |
| tree | 47084b3ddc2cf7b208057930eb83e402f34e5374 | |
| parent | 8c214cf9e4146c144dfaa790fd84439e9ac19cdf (diff) | |
| download | App-RunForPid-1aa6c4d3658d859e8fa173b67f2e9e5256717021.tar.gz | |
Update readme
| -rw-r--r-- | README.md | 32 | ||||
| -rw-r--r-- | lib/App/RunForPid.pm6 | 30 |
2 files changed, 26 insertions, 36 deletions
@@ -1,24 +1,45 @@ NAME ==== -App::RunForPid - blah blah blah +App::RunForPid - Given a X Window, attach a process for debug (gdb, tail, etc) SYNOPSIS ======== -```perl6 -use App::RunForPid; +```sh +run-for-pid -h +Usage: + ./bin/run-for-pid -- Find a pid for a window + ./bin/run-for-pid <pid> -- Execute a command for a child process of $pid ``` DESCRIPTION =========== -App::RunForPid is ... +App::RunForPid is a program to attach different tools to a given +running process. + +The idea is to quickly attach or get information about that process +only from the window that's running it. There's a fallback for +background process with the `pid` parameter. + +DEPENDENCIES +============ + +* `xprop` — to get properties for a X Window +* `pstree` + +OPTIONAL DEPENDENCIES +--------------------- + +* `gdb` — Attach a gdb to a given process +* `strace` — Read stdout and stderr of a given process +* `tail` — Keep logging a file AUTHOR ====== -Matias Linares <matiaslina@gmail.com> +Matias Linares <matiaslina@deprecated.org> COPYRIGHT AND LICENSE ===================== @@ -26,4 +47,3 @@ COPYRIGHT AND LICENSE Copyright 2020 Matias Linares This library is free software; you can redistribute it and/or modify it under the Artistic License 2.0. - diff --git a/lib/App/RunForPid.pm6 b/lib/App/RunForPid.pm6 index 69c8c6a..7d45941 100644 --- a/lib/App/RunForPid.pm6 +++ b/lib/App/RunForPid.pm6 @@ -124,33 +124,3 @@ multi sub MAIN() is export { multi sub MAIN(Int $pid) is export { say "Running for $pid"; } - -=begin pod - -=head1 NAME - -App::RunForPid - blah blah blah - -=head1 SYNOPSIS - -=begin code :lang<perl6> - -use App::RunForPid; - -=end code - -=head1 DESCRIPTION - -App::RunForPid is ... - -=head1 AUTHOR - -Matias Linares <matiaslina@gmail.com> - -=head1 COPYRIGHT AND LICENSE - -Copyright 2020 Matias Linares - -This library is free software; you can redistribute it and/or modify it under the Artistic License 2.0. - -=end pod |