60 lines
No EOL
8.6 KiB
Text
60 lines
No EOL
8.6 KiB
Text
[0m[38;2;255;255;255m[48;2;0;0;0m┌────────────────────────────────────────────── 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. │
|
||
│ -e "COMMAND" --editor="COMMAND" The command used to start the editor, in │
|
||
│ the [0m[38;2;0;255;0m[48;2;0;0;0me[0m[38;2;255;255;255m[48;2;0;0;0mdit command. It may contain options. │
|
||
│ │
|
||
│Keys: │
|
||
│ [0m[38;2;0;255;0m[48;2;0;0;0mh[0m[38;2;255;255;255m[48;2;0;0;0m - Show the help screen. (toggle) │
|
||
│ [0m[38;2;0;255;0m[48;2;0;0;0mq[0m[38;2;255;255;255m[48;2;0;0;0m - Quit. │
|
||
│ [0m[38;2;0;255;0m[48;2;0;0;0md[0m[38;2;255;255;255m[48;2;0;0;0m, [0m[38;2;0;255;0m[48;2;0;0;0mc[0m[38;2;255;255;255m[48;2;0;0;0m, [0m[38;2;0;255;0m[48;2;0;0;0mj[0m[38;2;255;255;255m[48;2;0;0;0m, [0m[38;2;0;255;0m[48;2;0;0;0mk[0m[38;2;255;255;255m[48;2;0;0;0m, [0m[38;2;0;255;0m[48;2;0;0;0mf[0m[38;2;255;255;255m[48;2;0;0;0m, [0m[38;2;0;255;0m[48;2;0;0;0mv[0m[38;2;255;255;255m[48;2;0;0;0m or arrow keys or mouse click - Move the cursor. │
|
||
│ [0m[38;2;0;255;0m[48;2;0;0;0mD[0m[38;2;255;255;255m[48;2;0;0;0m, [0m[38;2;0;255;0m[48;2;0;0;0mC[0m[38;2;255;255;255m[48;2;0;0;0m, [0m[38;2;0;255;0m[48;2;0;0;0mJ[0m[38;2;255;255;255m[48;2;0;0;0m, [0m[38;2;0;255;0m[48;2;0;0;0mK[0m[38;2;255;255;255m[48;2;0;0;0m, [0m[38;2;0;255;0m[48;2;0;0;0mF[0m[38;2;255;255;255m[48;2;0;0;0m, [0m[38;2;0;255;0m[48;2;0;0;0mV[0m[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. │
|
||
│ [0m[38;2;0;255;0m[48;2;0;0;0mt[0m[38;2;255;255;255m[48;2;0;0;0m - Turn the result pane to portrait or landscape orientation. (toggle) │
|
||
│ [0m[38;2;0;255;0m[48;2;0;0;0ml[0m[38;2;255;255;255m[48;2;0;0;0m - Show the activity log. (toggle) │
|
||
│ [0m[38;2;0;255;0m[48;2;0;0;0me[0m[38;2;255;255;255m[48;2;0;0;0m - Edit the current file with an editor defined by -e, $EDITOR or $VISUAL. │
|
||
│ [0m[38;2;0;255;0m[48;2;0;0;0mn[0m[38;2;255;255;255m[48;2;0;0;0m - Move to the next issue. │
|
||
│ [0m[38;2;0;255;0m[48;2;0;0;0mN[0m[38;2;255;255;255m[48;2;0;0;0m - Move to the next issue of the current tool. │
|
||
│ [0m[38;2;0;255;0m[48;2;0;0;0mp[0m[38;2;255;255;255m[48;2;0;0;0m - Pause workers. (toggle) │
|
||
│ [0m[38;2;0;255;0m[48;2;0;0;0mo[0m[38;2;255;255;255m[48;2;0;0;0m - Order files by type, or by directory location. (toggle) │
|
||
│ [0m[38;2;0;255;0m[48;2;0;0;0mr[0m[38;2;255;255;255m[48;2;0;0;0m - Refresh the currently selected report. │
|
||
│ [0m[38;2;0;255;0m[48;2;0;0;0ms[0m[38;2;255;255;255m[48;2;0;0;0m - Change the appearance of result statuses. (toggle) │
|
||
│ │
|
||
│Statuses: │
|
||
│ Normal │
|
||
│ [0m[38;2;0;255;0m[48;2;0;0;0m [0m[38;2;255;255;255m[48;2;0;0;0m Ok │
|
||
│ [0m[38;2;255;0;0m[48;2;0;0;0m [0m[38;2;255;255;255m[48;2;0;0;0m Problem │
|
||
│ [0m[38;2;100;100;100m[48;2;0;0;0m [0m[38;2;255;255;255m[48;2;0;0;0m Not applicable │
|
||
│ [0m[38;2;90;90;255m[48;2;0;0;0m [0m[38;2;255;255;255m[48;2;0;0;0m Running │
|
||
│ [0m[38;2;255;255;0m[48;2;0;0;0m [0m[38;2;255;255;255m[48;2;0;0;0m Paused │
|
||
│ [0m[38;2;200;0;200m[48;2;0;0;0m [0m[38;2;255;255;255m[48;2;0;0;0m Timed out │
|
||
│ . Pending │
|
||
│ [0m[38;2;255;0;0m[48;2;0;0;0mE [0m[38;2;255;255;255m[48;2;0;0;0m Error │
|
||
│ │
|
||
│ │
|
||
│ │
|
||
│ │
|
||
└──────────────────────────────────────────────────────────────────────────────────────────────────┘[0m |