help¶

vb help [OPTIONS] [TOPIC] [SUBCOMMAND]

Description¶

Display information on how to use TOPIC, which may be a command, webpage, or setting. Webpage names begin with /. If TOPIC is omitted, a list of topics is returned. If there is an extra argument after TOPIC, it is the name of a subcommand, in which case only the help text for that one subcommand is shown.

Options¶

-a, --all¶: List both common and auxiliary commands

-e, --everything¶: List all help on all topics

-f, --full¶: List full set of commands (including auxiliary and unsupported test commands), options, settings, and web pages

-o, --options¶: List command-line options common to all commands

-s, --setting¶: List setting names

-t, --test¶: List unsupported test commands

-v, --verbose¶: List both names and help text

-x, --aux¶: List only auxiliary commands

-w, --www¶: List all web pages

-c, --commands¶: Restrict TOPIC search to commands, only TOPIC is present

-h, --html¶: Format output as HTML rather than plain text, only TOPIC is present

-o, --options¶: Show command-line options for TOPIC, only TOPIC is present

--raw¶: Output raw, unformatted help text, only TOPIC is present

-u, --usage¶: Show a succinct usage summary, not full help text, only TOPIC is present

Examples¶

List all commands

$ vb help -a
3-way-merge*    clone           hook*           push            sync          
add             close*          http*           rebuild         system        
addremove       commit          import*         reconstruct*    tag           
alerts*         configuration*  info            redo*           tarball*      
all             dbstat          init            remote          ticket*       
amend           deconstruct*    interwiki*      rename*         timeline      
annotate        delete          kv              repack          tls-config*   
artifact*       descendants*    leaves*         reparent*       touch*        
attachment*     describe        license         revert          tree          
backoffice*     detach*         login-group*    rm              ui            
backup*         diff            ls              rss*            undo          
bisect          extras          md5sum*         scrub*          unpublished*  
blame           fdiff           merge           search*         unset*        
branch          finfo           merge-base      server*         unversioned   
build           forget*         merge-info      settings        update        
bundle*         fts-config*     minizip         sha1sum*        user*         
cache*          fusefs*         mv              sha3sum*        version       
cat             gdiff           open            shell*          whatis*       
cgi*            git*            patch           sql             which*        
changes         gn              pikchr*         sqlar*          wiki*         
chat            grep            praise*         sqlite3*        xdiff         
checkout*       hash-policy*    publish*        ssl-config      zip*          
cherrypick      hashsum*        pull            stash         
clean           help            purge*          status

Show usage summary for a specific command

$ vb help commit
Usage: vb commit|ci [OPTIONS] [FILE ...]

Create a new check-in containing all of the changes in the current
check-out.  All changes are committed unless some subset of files
is specified on the command line, in which case only the named files
become part of the new check-in.

You will be prompted to enter a check-in comment unless the comment
has been specified on the command-line using "-m" or "-M".  The
text editor used is determined by the "editor""editor" setting, or by the
"VISUAL" or "EDITOR" environment variables.  Commit message text is
interpreted as vb-wiki format.  Potentially misformatted check-in
comment text is detected and reported unless the --no-verify-comment
option is used.

The --branch option followed by a branch name causes the new
check-in to be placed in a newly-created branch with name specified.

A check-in is not permitted to fork unless the --allow-fork option
appears.  An empty check-in (i.e. with nothing changed) is not
allowed unless the --allow-empty option appears.  A check-in may not
be older than its ancestor unless the --allow-older option appears.
If any files in the check-in appear to contain unresolved merge
conflicts, the check-in will not be allowed unless the
--allow-conflict option is present.  In addition, the entire
check-in process may be aborted if a file contains content that
appears to be binary, Unicode text, or text with CR/LF line endings
unless the interactive user chooses to proceed.  If there is no
interactive user or these warnings should be skipped for some other
reason, the --no-warnings option may be used.  A check-in is not
allowed against a closed leaf.

The --private option creates a private check-in that is never synced.
Children of private check-ins are automatically private.

The --tag option applies the symbolic tag name to the check-in.
The --tag option can be repeated to assign multiple tags to a check-in.
For example: "... --tag release --tag version-1.2.3 ..."

Options:
  --allow-conflict           Allow unresolved merge conflicts
  --allow-empty              Allow a commit with no changes
  --allow-fork               Allow the commit to fork
  --allow-older              Allow a commit older than its ancestor
  --baseline                 Use a baseline manifest in the commit process
  --bgcolor COLOR            Apply COLOR to this one check-in only
  --branch NEW-BRANCH-NAME   Check in to this new branch
  --branchcolor COLOR        Apply given COLOR to the branch
  --close                    Close the branch being committed
  --date-override DATETIME   Make DATETIME the time of the check-in.
                             Useful when importing historical check-ins
                             from another version control system.
  --delta                    Use a delta manifest in the commit process
  --editor NAME              Text editor to use for check-in comment.
  --hash                     Verify file status using hashing rather
                             than relying on filesystem mtimes
  --if-changes               Make this command a silent no-op if there
                             are no changes
  -a|--addremove             Run addremove before committing
  --ignore-clock-skew        If a clock skew is detected, ignore it and
                             behave as if the user had entered 'yes' to
                             the question of whether to proceed despite
                             the skew.
  --ignore-oversize          Do not warn the user about oversized files
  --integrate                Close all merged-in branches
  -m|--comment COMMENT-TEXT  Use COMMENT-TEXT as the check-in comment
  -M|--message-file FILE     Read the check-in comment from FILE
  -n|--dry-run               Do not actually create a new check-in. Just
                             show what would have happened. For debugging.
  -v|--verbose               Show a diff in the commit message prompt
  --no-prompt                This option disables prompting the user for
                             input and assumes an answer of 'No' for every
                             question.
  --no-warnings              Omit all warnings about file contents
  --no-verify                Do not run before-commit hooks
  --no-verify-comment        Do not validate the check-in comment
  --nosign                   Do not attempt to sign this commit with gpg
  --nosync                   Do not auto-sync prior to committing
  --override-lock            Allow a check-in even though parent is locked
  --private                  Never sync the resulting check-in and make
                             all descendants private too.
  --proxy PROXY              Use PROXY as http proxy during sync operation
  --tag TAG-NAME             Add TAG-NAME to the check-in. May be repeated.
  --trace                    Debug tracing
  --user-override USER       Record USER as the login that created the
                             new check-in, rather that the current user.
  -L|--license LICENSENAME   Add the check-in of this submission to the specified license
                             
See also: branch, changes, update, extras, sync