60 lines
No EOL
8.7 KiB
Text
60 lines
No EOL
8.7 KiB
Text
(B[m[38;2;255;255;255m[48;2;0;0;0m┌────────────────────────────────────────────── Help ──────────────────────────────────────────────┐
|
||
│Vigil Code Monitor │
|
||
│ │
|
||
│Vigil shows a list of status reports for a given codebase, and keeps them │
|
||
│up to date as the codebase changes. │
|
||
│ │
|
||
│A set of reports is produced for every file, which depend on the file's type. │
|
||
│ │
|
||
│A status indicator summarises the state of each report, and a report is viewed │
|
||
│by selecting this status indicator with the cursor. The types of status are │
|
||
│listed below. │
|
||
│ │
|
||
│The reports are cached in the codebase's root directory in a ".vigil" │
|
||
│directory. │
|
||
│ │
|
||
│Keys: │
|
||
│ (B[m[38;2;0;255;0m[48;2;0;0;0mh(B[m[38;2;255;255;255m[48;2;0;0;0m - Show the help screen. (toggle) │
|
||
│ (B[m[38;2;0;255;0m[48;2;0;0;0mq(B[m[38;2;255;255;255m[48;2;0;0;0m - Quit. │
|
||
│ (B[m[38;2;0;255;0m[48;2;0;0;0md(B[m[38;2;255;255;255m[48;2;0;0;0m, (B[m[38;2;0;255;0m[48;2;0;0;0mc(B[m[38;2;255;255;255m[48;2;0;0;0m, (B[m[38;2;0;255;0m[48;2;0;0;0mj(B[m[38;2;255;255;255m[48;2;0;0;0m, (B[m[38;2;0;255;0m[48;2;0;0;0mk(B[m[38;2;255;255;255m[48;2;0;0;0m, (B[m[38;2;0;255;0m[48;2;0;0;0mf(B[m[38;2;255;255;255m[48;2;0;0;0m, (B[m[38;2;0;255;0m[48;2;0;0;0mv(B[m[38;2;255;255;255m[48;2;0;0;0m or arrow keys or mouse click - Move the cursor. │
|
||
│ (B[m[38;2;0;255;0m[48;2;0;0;0mD(B[m[38;2;255;255;255m[48;2;0;0;0m, (B[m[38;2;0;255;0m[48;2;0;0;0mC(B[m[38;2;255;255;255m[48;2;0;0;0m, (B[m[38;2;0;255;0m[48;2;0;0;0mJ(B[m[38;2;255;255;255m[48;2;0;0;0m, (B[m[38;2;0;255;0m[48;2;0;0;0mK(B[m[38;2;255;255;255m[48;2;0;0;0m, (B[m[38;2;0;255;0m[48;2;0;0;0mF(B[m[38;2;255;255;255m[48;2;0;0;0m, (B[m[38;2;0;255;0m[48;2;0;0;0mV(B[m[38;2;255;255;255m[48;2;0;0;0m or page up, page down, home, end or the mouse wheel - │
|
||
│ Scroll the result pane. │
|
||
│ (B[m[38;2;0;255;0m[48;2;0;0;0mt(B[m[38;2;255;255;255m[48;2;0;0;0m - Turn the result pane to portrait or landscape orientation. (toggle) │
|
||
│ (B[m[38;2;0;255;0m[48;2;0;0;0ml(B[m[38;2;255;255;255m[48;2;0;0;0m - Show the activity log. (toggle) │
|
||
│ (B[m[38;2;0;255;0m[48;2;0;0;0me(B[m[38;2;255;255;255m[48;2;0;0;0m - Edit the current file with an editor defined by -e, $EDITOR or $VISUAL. │
|
||
│ (B[m[38;2;0;255;0m[48;2;0;0;0mn(B[m[38;2;255;255;255m[48;2;0;0;0m - Move to the next issue. │
|
||
│ (B[m[38;2;0;255;0m[48;2;0;0;0mN(B[m[38;2;255;255;255m[48;2;0;0;0m - Move to the next issue of the current tool. │
|
||
│ (B[m[38;2;0;255;0m[48;2;0;0;0mp(B[m[38;2;255;255;255m[48;2;0;0;0m - Pause workers. (toggle) │
|
||
│ (B[m[38;2;0;255;0m[48;2;0;0;0mo(B[m[38;2;255;255;255m[48;2;0;0;0m - Order files by type, or by directory location. (toggle) │
|
||
│ (B[m[38;2;0;255;0m[48;2;0;0;0mr(B[m[38;2;255;255;255m[48;2;0;0;0m - Refresh the currently selected report. │
|
||
│ │
|
||
│Statuses: │
|
||
│ (B[m[38;2;255;255;255m[48;2;255;255;255m (B[m[38;2;255;255;255m[48;2;0;0;0m Normal │
|
||
│ (B[m[38;2;255;255;255m[48;2;0;255;0m (B[m[38;2;255;255;255m[48;2;0;0;0m Ok │
|
||
│ (B[m[38;2;255;255;255m[48;2;255;0;0m (B[m[38;2;255;255;255m[48;2;0;0;0m Problem │
|
||
│ (B[m[38;2;255;255;255m[48;2;100;100;100m (B[m[38;2;255;255;255m[48;2;0;0;0m Not applicable │
|
||
│ (B[m[38;2;255;255;255m[48;2;90;90;255m (B[m[38;2;255;255;255m[48;2;0;0;0m Running │
|
||
│ (B[m[38;2;255;255;255m[48;2;255;255;0m (B[m[38;2;255;255;255m[48;2;0;0;0m Paused │
|
||
│ (B[m[38;2;255;255;255m[48;2;200;0;200m (B[m[38;2;255;255;255m[48;2;0;0;0m Timed out │
|
||
│ . Pending │
|
||
│ (B[m[38;2;255;255;255m[48;2;255;0;0mE(B[m[38;2;255;255;255m[48;2;0;0;0m Error │
|
||
│ │
|
||
│ │
|
||
│ │
|
||
│ │
|
||
│ │
|
||
│ │
|
||
│ │
|
||
│ │
|
||
│ │
|
||
│ │
|
||
│ │
|
||
│ │
|
||
│ │
|
||
│ │
|
||
│ │
|
||
│ │
|
||
│ │
|
||
│ │
|
||
│ │
|
||
└──────────────────────────────────────────────────────────────────────────────────────────────────┘(B[m |