From 1aa6c4d3658d859e8fa173b67f2e9e5256717021 Mon Sep 17 00:00:00 2001 From: Matias Linares Date: Sat, 11 Jul 2020 20:09:50 -0300 Subject: Update readme --- README.md | 32 ++++++++++++++++++++++++++------ 1 file changed, 26 insertions(+), 6 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index e76e338..c9e2e48 100644 --- a/README.md +++ b/README.md @@ -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 -- 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 +Matias Linares 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. - -- cgit v1.2.3-70-g09d2