Bring the help text up-to-date.

This commit is contained in:
Andrew Hamilton 2017-04-20 23:52:59 +02:00
parent 82f06edff5
commit 023bdd17cb
2 changed files with 6 additions and 9 deletions

View file

@ -1,10 +1,7 @@
(B┌────────────────────────────────────────────── Help ──────────────────────────────────────────────┐ (B┌────────────────────────────────────────────── Help ──────────────────────────────────────────────┐
│Vigil Code Monitor │ │Vigil Code Monitor │
│ │ │ │
│Vigil shows a list of status reports for a given codebase, and keeps them │ │Vigil maintains an up-to-date set of reports for every file in a codebase. │
│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 │ │A status indicator summarises the state of each report, and a report is viewed │
│by selecting this status indicator with the cursor. │ │by selecting this status indicator with the cursor. │
@ -57,4 +54,7 @@
│ │ │ │
│ │ │ │
│ │ │ │
│ │
│ │
│ │
└──────────────────────────────────────────────────────────────────────────────────────────────────┘(B └──────────────────────────────────────────────────────────────────────────────────────────────────┘(B

7
vigil
View file

@ -6,10 +6,7 @@
"""Vigil Code Monitor """Vigil Code Monitor
Vigil shows a list of status reports for a given codebase, and keeps them Vigil maintains an up-to-date set of reports for every file in a codebase.
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 A status indicator summarises the state of each report, and a report is viewed
by selecting this status indicator with the cursor. by selecting this status indicator with the cursor.
@ -57,7 +54,7 @@ Options:
-s on|off, --sandbox=on|off Use a sandbox to prevent changes to the -s on|off, --sandbox=on|off Use a sandbox to prevent changes to the
filesystem. The sandbox is on by default. filesystem. The sandbox is on by default.
-w COUNT, --workers=COUNT The number of processes working in parallel. -w COUNT, --workers=COUNT The number of processes working in parallel.
By default it is twice the number of cpus. By default it is the number of cpus minus 1.
-e "COMMAND", --editor="COMMAND" The command used to start the editor, in -e "COMMAND", --editor="COMMAND" The command used to start the editor, in
the *edit command. It may contain options. the *edit command. It may contain options.
-t THEME, --theme=THEME The pygment theme used for syntax -t THEME, --theme=THEME The pygment theme used for syntax