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

NAME
       bk setup - create a new BitKeeper package

SYNOPSIS
       bk setup [-CfpP] [-F<key=val>] [-c<config_file>] [<directory>]

DESCRIPTION
       There is a graphical version of this command, bk setuptool.

       To  set up a BitKeeper package, you need to create and populate an ini-
       tial tree.  If the <directory> argument is supplied, the bk setup  com-
       mand will create a mostly empty package tree containing a few files and
       directories that are used by  BitKeeper.  Otherwise,  a  new  BitKeeper
       package will be created in place.

       A  system  wide  default  config template file may be created in either
       `bk dotbk`/etc/config.template, /etc/BitKeeper/etc/config.template,  or
       `bk bin`/etc/config.template.   If  any of these files is detected when
       bk setup is run, without the "-c" option, the keys in it will  be  used
       as  the  defaults  in the BitKeeper/etc/config file automatically.  The
       first file found is used.

OPTIONS
       -C              When run inside a product, setup will create  a  compo-
                       nent.  With -C, do not commit this new component to the
                       product.  Use this option when you wish to create  many
                       components and have only one commit.  The new component
                       will be left in the pending state.  The -C  option  can
                       not  be  used  with  -P.  In all other cases (outside a
                       product and with no -P), the -C option will be ignored.
       -c<config_file> Use <config_file> as the configuration  file  to  setup
                       the repository.
       --compat        Create  the  package  using a backwards compatible (and
                       slower) format.
       -f              Don't ask for confirmation.
       -F<key=val>     Override default values for the specified field.  Typi-
                       cally used in combination with a config template.
       -P              The  repository  being created is a product repository,
                       i.e., will have component repositories.
       -p              print the field names to stdout (used by setuptool).

EXAMPLES
       When creating a repository called "mypackage", you type  the  following
       command:

           $ bk setup ~/mypackage

       The following shows the directory structure of a new package.

       mypackage/

               .bk/              Directory for storing BitKeeper metadata.
               ChangeSet         Index of all changes to the repository.
               BitKeeper/        Directory   where  administrative  files  are
                                 kept.

                       etc/      Config files, in the future, policy files.
                       log/      Mail and command logs, parent pointer.
                       deleted/  Deleted files are  archived  here  (like  CVS
                                 Attic).
                       tmp/      Scratch area.
                       readers/  Transient directory for reader locks.
                       writer/   Transient directory for writer lock.
                       triggers/ Executable trigger programs stored here.

       Once  the  repository  is created, you should make a hierarchy to store
       your source files. For example, you could create the following tree:

       mypackage/

               src/              source code
               man/              manual pages
               doc/              user guides, papers, docs...

       At this point, if you are creating a new package from  scratch,  cd  to

       If you have an existing set of files that you want to add to the repos-
       itory, see bk import.

SEE ALSO
       bk Howto
       bk Howto-setup
       bk attach
       bk config-etc
       bk import
       bk setuptool

CATEGORY
       Nested
       Repository

BitKeeper Inc                         1E1                      bk setup(7.3ce)