diff --git a/golden-files/help b/golden-files/help index b93dec2..f7ebce7 100644 --- a/golden-files/help +++ b/golden-files/help @@ -1,40 +1,40 @@ ┌──────────────── Help ────────────────┐ -│Produces a set of reports for every f │ -│The reports are produced by many exis │ -│  │ -│The state of each report is also summ │ -│The possible states are listed below. │ -│  │ -│A report is viewed by selecting its s │ -│  │ -│Reports are recalculated whenever fil │ -│are kept up to date. (optional)  │ -│  │ -│The reports are cached in a directory │ -│directory.  │ -│  │ -│Usage: vigil  │ -│  │ -│e.g. # vigil my_project  │ -│  │ -│Keys:  │ -│ h - Show the help screen. (toggle)  │ -│ d, c, j, k - Move the cursor up, do │ -│ D, C, J, K - Scroll the result pane │ -│ t - Turn the result pane to portrai │ -│ l - Show the activity log. (toggle) │ -│ n - Move to the next issue.  │ -│ N - Move to the next issue of the c │ -│ o - Order files by type, or by dire │ -│ p - Pause work. (toggle)  │ -│ w - Watch the filesystem for change │ -│ s - Change the appearance of result │ -│ q - Quit.  │ -│  │ -│Statuses:  │ -│  Normal  │ +│Vigil maintains a set of reports for e│ +│Different types of reports are produce│ +│ │ +│The state of each report is summarised│ +│viewed by selecting this status indica│ +│are listed below. │ +│ │ +│Reports are recalculated whenever file│ +│to date. │ +│ │ +│The reports are cached in a directory │ +│ │ +│ │ +│Usage: vigil │ +│ │ +│e.g. # vigil my_project │ +│ │ +│Keys: │ +│ h - Show the help screen. (toggle) │ +│ d, c, j, k or arrow keys or the mous│ +│ D, C, J, K or page up, page down, ho│ +│ t - Turn the result pane to portrait│ +│ l - Show the activity log. (toggle) │ +│ n - Move to the next issue. │ +│ N - Move to the next issue of the cu│ +│ o - Order files by type, or by direc│ +│ p - Pause work. (toggle) │ +│ s - Change the appearance of result │ +│ q - Quit. │ +│ │ +│Statuses: │ +│  Normal │ │   Ok │ │   Problem │ │   Not applicable │ +│   Running │ +│ . Pending │ │  │ └──────────────────────────────────────┘ \ No newline at end of file diff --git a/vigil b/vigil index b16cade..c7edea3 100755 --- a/vigil +++ b/vigil @@ -5,19 +5,17 @@ # Licensed under the Artistic License 2.0. """\ -Produces a set of reports for every file in a directory tree. -The reports are produced by many existing command-line tools. +Vigil maintains a set of reports for each file in a directory tree. +Different types of reports are produced for different types of file. -The state of each report is also summarised by a status indicator. -The possible states are listed below. +The state of each report is summarised by a status indicator, and a report is +viewed by selecting this status indicator with the cursor. The types of status +are listed below. -A report is viewed by selecting its status indicator with the cursor. +Reports are recalculated whenever files are changed, so that they are always up +to date. -Reports are recalculated whenever files are changed, added, or deleted, and so -are kept up to date. (optional) - -The reports are cached in a directory named ".vigil" under the target -directory. +The reports are cached in a directory ".vigil" under the target directory. Usage: vigil