eris/golden-files/help

[0m[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.                  │
│                                                                                                  │
│                                                                                                  │
│Usage:                                                                                            │
│  vigil [options] <directory>                                                                     │
│  vigil -h | --help                                                                               │
│                                                                                                  │
│Example:                                                                                          │
│  # vigil my_project                                                                              │
│                                                                                                  │
│Options:                                                                                          │
│  -h, --help                       Show this screen and exit.                                     │
│  -s on|off, --sandbox=on|off      Use a sandbox to prevent changes to the                        │
│                                   filesystem. The sandbox is on by default.                      │
│  -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.                                                      │
│                                                                                                  │
│Statuses:                                                                                         │
│  [0m[38;2;255;255;255m[48;2;255;255;255m [0m[38;2;255;255;255m[48;2;0;0;0m Normal                                                                                        │
│  [0m[38;2;255;255;255m[48;2;0;255;0m [0m[38;2;255;255;255m[48;2;0;0;0m Ok                                                                                            │
│  [0m[38;2;255;255;255m[48;2;255;0;0m [0m[38;2;255;255;255m[48;2;0;0;0m Problem                                                                                       │
│  [0m[38;2;255;255;255m[48;2;100;100;100m [0m[38;2;255;255;255m[48;2;0;0;0m Not applicable                                                                                │
│  [0m[38;2;255;255;255m[48;2;90;90;255m [0m[38;2;255;255;255m[48;2;0;0;0m Running                                                                                       │
│  [0m[38;2;255;255;255m[48;2;255;255;0m [0m[38;2;255;255;255m[48;2;0;0;0m Paused                                                                                        │
│  [0m[38;2;255;255;255m[48;2;200;0;200m [0m[38;2;255;255;255m[48;2;0;0;0m Timed out                                                                                     │
│  . Pending                                                                                       │
│  [0m[38;2;255;255;255m[48;2;255;0;0mE[0m[38;2;255;255;255m[48;2;0;0;0m Error                                                                                         │
│                                                                                                  │
│                                                                                                  │
│                                                                                                  │
└──────────────────────────────────────────────────────────────────────────────────────────────────┘[0m
-												Make the window in help's golden file bigger, now that theres more help.

											
										
										
											2016-01-29 21:29:44 +00:00
+								[0m[38;2;255;255;255m[48;2;0;0;0m┌────────────────────────────────────────────── Help ──────────────────────────────────────────────┐
-												Improved the project description.

											
										
										
											2016-09-30 15:37:29 +02:00
+								│Vigil Code Monitor                                                                                │
-												Make the window in help's golden file bigger, now that theres more help.

											
										
										
											2016-01-29 21:29:44 +00:00
+								│                                                                                                  │
-												Improved the project description.

											
										
										
											2016-09-30 15:37:29 +02:00
+								│Vigil shows a list of status reports for a given codebase, and keeps them                         │
 								│up to date as the codebase changes.                                                               │
-												Make the window in help's golden file bigger, now that theres more help.

											
										
										
											2016-01-29 21:29:44 +00:00
+								│                                                                                                  │
-												Improved the project description.

											
										
										
											2016-09-30 15:37:29 +02:00
+								│A set of reports is produced for every file, which depend on the file's type.                     │
-												Make the window in help's golden file bigger, now that theres more help.

											
										
										
											2016-01-29 21:29:44 +00:00
+								│                                                                                                  │
-												Improved the project description.

											
										
										
											2016-09-30 15:37:29 +02:00
+								│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.                  │
-												Make the window in help's golden file bigger, now that theres more help.

											
										
										
											2016-01-29 21:29:44 +00:00
+								│                                                                                                  │
 								│                                                                                                  │
 								│Usage:                                                                                            │
-												"Directory" is more straight forward than "root_path".

											
										
										
											2016-01-30 13:00:21 +00:00
+								│  vigil [options] <directory>                                                                     │
-												Make the window in help's golden file bigger, now that theres more help.

											
										
										
											2016-01-29 21:29:44 +00:00
+								│  vigil -h | --help                                                                               │
 								│                                                                                                  │
 								│Example:                                                                                          │
 								│  # vigil my_project                                                                              │
 								│                                                                                                  │
 								│Options:                                                                                          │
-												The help text was too wide.

											
										
										
											2016-02-19 19:01:28 +00:00
+								│  -h, --help                       Show this screen and exit.                                     │
-												Make the sandbox option positive: --no-sandbox -> --sandbox.

											
										
										
											2016-02-20 23:36:23 +00:00
+								│  -s on|off, --sandbox=on|off      Use a sandbox to prevent changes to the                        │
 								│                                   filesystem. The sandbox is on by default.                      │
-												The help text was too wide.

											
										
										
											2016-02-19 19:01:28 +00:00
+								│  -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.                      │
-												Make the window in help's golden file bigger, now that theres more help.

											
										
										
											2016-01-29 21:29:44 +00:00
+								│                                                                                                  │
 								│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)                                                              │
-												Add missing 'edit' action to help, and reorder actions to match the status bar.

											
										
										
											2016-02-02 10:38:37 +00:00
+								│  [0m[38;2;0;255;0m[48;2;0;0;0mq[0m[38;2;255;255;255m[48;2;0;0;0m - Quit.                                                                                       │
-												Make the window in help's golden file bigger, now that theres more help.

											
										
										
											2016-01-29 21:29:44 +00:00
+								│  [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)                                                             │
-												Improved the help text slightly.

											
										
										
											2016-02-07 20:35:49 +00:00
+								│  [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.                     │
-												Make the window in help's golden file bigger, now that theres more help.

											
										
										
											2016-01-29 21:29:44 +00:00
+								│  [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.                                                 │
-												Added a command-line option to control the number of workers.

											
										
										
											2016-01-31 23:19:28 +00:00
+								│  [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)                                                                     │
-												Add missing 'edit' action to help, and reorder actions to match the status bar.

											
										
										
											2016-02-02 10:38:37 +00:00
+								│  [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)                                     │
-												Added a "refresh" action that recalculates the result of the current selection.

Ideally this isn't necessary, but sometimes it is. For example a timed out report might
succeed when tried again.

											
										
										
											2016-02-01 23:07:19 +00:00
+								│  [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.                                                      │
-												Make the window in help's golden file bigger, now that theres more help.

											
										
										
											2016-01-29 21:29:44 +00:00
+								│                                                                                                  │
 								│Statuses:                                                                                         │
-												Only have the simple style of statuses.

The double width character wasn't common and often didn't work depending
on terminal or font.

											
										
										
											2016-09-30 12:57:43 +02:00
+								│  [0m[38;2;255;255;255m[48;2;255;255;255m [0m[38;2;255;255;255m[48;2;0;0;0m Normal                                                                                        │
 								│  [0m[38;2;255;255;255m[48;2;0;255;0m [0m[38;2;255;255;255m[48;2;0;0;0m Ok                                                                                            │
 								│  [0m[38;2;255;255;255m[48;2;255;0;0m [0m[38;2;255;255;255m[48;2;0;0;0m Problem                                                                                       │
 								│  [0m[38;2;255;255;255m[48;2;100;100;100m [0m[38;2;255;255;255m[48;2;0;0;0m Not applicable                                                                                │
 								│  [0m[38;2;255;255;255m[48;2;90;90;255m [0m[38;2;255;255;255m[48;2;0;0;0m Running                                                                                       │
 								│  [0m[38;2;255;255;255m[48;2;255;255;0m [0m[38;2;255;255;255m[48;2;0;0;0m Paused                                                                                        │
 								│  [0m[38;2;255;255;255m[48;2;200;0;200m [0m[38;2;255;255;255m[48;2;0;0;0m Timed out                                                                                     │
 								│  . Pending                                                                                       │
 								│  [0m[38;2;255;255;255m[48;2;255;0;0mE[0m[38;2;255;255;255m[48;2;0;0;0m Error                                                                                         │
 								│                                                                                                  │
-												Make the window in help's golden file bigger, now that theres more help.

											
										
										
											2016-01-29 21:29:44 +00:00
+								│                                                                                                  │
 								│                                                                                                  │
 								└──────────────────────────────────────────────────────────────────────────────────────────────────┘[0m