eris/golden-files/help

60 lines
8.4 KiB
Text
Raw Normal View History

┌────────────────────────────────────────────── Help ──────────────────────────────────────────────┐
│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 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. │
│ │
│Reports are recalculated whenever files are changed, so that they are always up │
│to date. │
│ │
│The reports are cached in a directory ".vigil" under the target directory. │
│ │
│ │
│Usage: │
│ vigil [options] <directory> │
│ vigil -h | --help │
│ │
│Example: │
│ # vigil my_project │
│ │
│Options: │
│ -h --help Show this screen and exit. │
│ -n --no-sandbox Don't prevent changes to the filesystem. │
│ -w COUNT --workers=COUNT The number of processes working in parallel. │
│ By default it is twice the number of cpus. │
│ │
│Keys: │
h - Show the help screen. (toggle) │
d, c, j, k, f, v or arrow keys or mouse click - Move the cursor. │
D, C, J, K, F, V or page up, page down, home, end or the mouse wheel - │
│ Scroll the result pane. │
t - Turn the result pane to portrait or landscape orientation. (toggle) │
l - Show the activity log. (toggle) │
n - Move to the next issue. │
N - Move to the next issue of the current tool. │
o - Order files by type, or by directory location. (toggle) │
p - Pause workers. (toggle) │
s - Change the appearance of result statuses. (toggle) │
q - Quit. │
│ │
│Statuses: │
│  Normal │
  Ok │
  Problem │
  Not applicable │
  Running │
  Paused │
│ . Pending │
E  Error │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
└──────────────────────────────────────────────────────────────────────────────────────────────────┘