• abort
• backups
• bk
• bkd
• changes
• check
• citool
• clone
• cmdlog
• collapse
• commit
• conflicts
• cset
• csets
• csettool
• difftool
• files
• fixtool
• glob
• history
• id
• import
• level
• lock
• makepatch
• merge
• merge-binaries
• parent
• pending
• pull
• push
• relink
• repocheck
• resolve
• resolving
• revtool
• rm
• rmgone
• service
• setup
• setuptool
• sfio
• status
• superset
• tag
• tags
• takepatch
• templates
• triggers
• undo
• unlock
• unpull
• untag
• url

bk(7.3ce)                   BitKeeper User's Manual                  bk(7.3ce)

NAME
       bk - BitKeeper configuration management system front end

SYNOPSIS
       bk [-A|U|e|r] [-s<alias>] [options] <command> [<options>]

DESCRIPTION
       bk is the front end to all BitKeeper commands.

       If  you are looking for instructions on how to get started, try running
       the test drive at http://www.bitkeeper.com/Test.html.

OPTIONS
       Only the global options are documented here.  To see  command  specific
       options  consult the documentation for the command in question (bk help
       <command>).

       -@[<url>]     Run the command in the specified repository  rather  than
                     locally.   If  <url>  is not specified, then use the par-
                     ent[s] of the current repository.  If there are  multiple
                     parents,  incoming and/or outgoing, use all of those par-
                     ents.  You can use the construct -@@<file> to  specify  a
                     file  containing a list of repository URLs, one per line;
                     the command is run in each of the remote repositories.

                     The -r[<dir>] option works as expected, running the  com-
                     mand recursively over all of the implied files.  If spec-
                     ified, <dir> must be relative to the root of  the  remote
                     repository.

                     If  "-"  is the last argument, then the standard input is
                     read and buffered.  Each remote command receives the same
                     input.

       -A
       --all-files   Starting  at the current working directory, run <command>
                     on all files in the entire repository or  nested  collec-
                     tion.   In a standalone repository this option is similar
                     to -r.  For example, to search all files in a nested col-
                     lection:

                         $ bk -A grep 'the string I want to find'

                     See -s below for ways to limit the set of files processed
                     in a nested collection.

       --config=<key:val>
                     Override one value in the configuration for this  command
                     only.

       --cd=<dir>    Change to <dir> before running the command.

       -e
       --each-repo   This  is a nested collection iterator that runs <command>
                     in each of the populated components and then the product.
                     For  example,  to  see  the full path to the root of each
                     repository in a nested collection:

                         $ bk -e pwd

                     See -s below for ways to limit the  set  of  repositories
                     processed in a nested collection.

       --headers     For  remote commands (-@) or for nested collection itera-
                     tors, this option causes the output from running the com-
                     mand in each repository to prefixed with a header:

                         #### <repo-url or location> ####

       -P            Change  directories to the root of the product repository
                     before running <command>.  Same as  -R  in  a  non-nested
                     collection.

       -R            Change  directories  to the root of the repository before
                     running <command>.

       -r[<dir>]     Starting at <dir>, or the repository root  if  <dir>  was
                     not  specified,  apply <command> recursively to <dir> and
                     all subdirectories.  This works by generating a  list  of
                     files  and  passing  them  to  <command>  on the standard
                     input.  This option differs from -A in that it is limited
                     to the current repository only, so if you are in a compo-
                     nent it will list only files belonging to that component.

       -s<alias>
       --subset=<a>  This option restricts the files (-A/-U)  or  repositories
                     (-e)  processed  to  those  belonging  to  the  specified
                     alias[es].  The option may be repeated to specify  multi-
                     ple  aliases, the alias may be a component, and the alias
                     may be negated.  To search everywhere except the product:

                         $ bk -U -s^PRODUCT grep some_string

                     This option must be combined  with  one  of:  -A,  --all-
                     files, -e, --each-repo, -U, --user-files.

                     In a standalone repository this option has no effect.

       -U
       --user-files  Starting  at the current working directory, run <command>
                     on all user files in the entire repository or nested col-
                     lection.   User files means everything except deleted and
                     BitKeeper metadata files.   In  a  standalone  repository
                     this option is similar to -Ur.  For example, to check out
                     your collection:

                         $ bk -U get

                     To see all unchecked in changes:

                         $ bk -cU diff

                     See -s above for ways to limit the set of files processed
                     in a nested collection.

       -1acGpx -^G   One  or  more of these options may be used in combination
                     with "-A", "-r", or "-U" to limit the set of files passed
                     to <command>.

                     -1   Only  examine  the current (or named) directory.  Do
                          not go into subdirectories.
                     -G   List files only if they are checked out ("gotten").
                     -^G  List files only if they are not  checked  out  ("not
                          gotten").
                     -a   Examine   all   files,   even   if  listed  in  Bit-
                          Keeper/etc/ignore.
                     -c   List changed files (locked and modified).  See EXAM-
                          PLES below for a typical usage.
                     -p   List files with pending deltas.
                     -x   List  files  which  have  no revision control files.
                          See EXAMPLES below for a typical usage.
                     --gfiles-opts=<opts>
                          This long option may  be  used  to  pass  any  valid
                          option to sfiles.  The format must include the lead-
                          ing - or -- for each option and each option must  be
                          separated by a space like so:

                              --gfiles-opts='-c --cold'

EXIT STATUS
       Unless  otherwise documented, all BitKeeper commands return exit status
       0 on success and greater than 0 on failure.

EXAMPLES
       The following commands are equivalent:

             bk -A get
             bk -R gfiles | bk -R get -
             cd `bk root`; bk gfiles | bk get -

       An example usage for generating a  patch  of  all  new  and/or  changed
       files:

           $ bk -cxU diff -Nu

SEE ALSO
       bk gfiles

CATEGORY
       Repository

BitKeeper Inc                         1E1                            bk(7.3ce)