X-Git-Url: http://git.iain.cx/?a=blobdiff_plain;f=README.md;h=095eb79fc5905aec954fc7a00ade8f7907b79670;hb=80475145e67a00ace824fc7072187d48e35eb8bc;hp=b2f03c228dbaf283b87b3f55cb013f353a1e2c92;hpb=193ae41f5473832680f1969a1e0bc19bc27909b8;p=pstop.git diff --git a/README.md b/README.md index b2f03c2..095eb79 100644 --- a/README.md +++ b/README.md @@ -17,28 +17,30 @@ most welcome. ### Installation -Install and update this go package with `go get -u github.com/sjmudd/pstop +Install and update this go package with `go get -u github.com/sjmudd/pstop` ### Configuration Access to MySQL is currently via a defaults-file which is assumed -to be ~/.my.cnf. This should probably be made more configurable. +to be `~/.my.cnf`. This should probably be made more configurable. If you see a need for this please let me know. ### Grants -Do not forget to ensure that the MySQL user you configure has access -to the performance_schema tables. +`pstop` needs `SELECT` access to `performance_schema` tables. It +will not run if access to the required tables is not available. ### Screens -pstop has 5 different screens: +pstop has 5 different screens which get updated by default every second. * Latency mode: order table activity by the time waiting to perform operations on them. * Ops (operations) mode: order table activity by the number of operations MySQL performs on them. * I/O mode: show where MySQL is spending it's time in file I/O. * Locks mode: show order based on table locks * User mode: show ordering based on how long users are running queries, or the number of connections they have to MySQL. +You can change the polling interval and switch between modes (see below). + ### Keys The following keys allow you to navigate around the different pstop displays or to change it's behaviour. @@ -55,9 +57,10 @@ The following keys allow you to navigate around the different pstop displays or ### See also -See also BUGS and NEW_FEATURES which describe things that probably -need looking at and screen_samples.txt which provides some sample -output from my own system. +See also: +* [BUGS](https://github.com/sjmudd/pstop/blob/master/BUGS) currently known issues +* [NEW_FEATURES](https://github.com/sjmudd/pstop/blob/master/NEW_FEATURES) which describe things that probably need looking at +* [screen_samples.txt](https://github.com/sjmudd/pstop/blob/master/screen_samples.txt) provides some sample output from my own system. ### Feedback