---
name: "baz"
section: "1"
platform: "linux"
package: "bazaar"
version: "1.4.2-5.3"
release: "Debian 4.0 (Etch)"
platforms: ["linux"]
url: "https://new.carta.tech/baz"
---

# baz(1)

arch command line client tool

## NAME

baz - arch command line client tool

## SYNOPSIS

**baz** *command* \[ *command\_options* \]\
 **baz** *command* \[-h\|--help\|-H\]\
 **baz** \[-h\|--help\|-H\|-V\|--version\]

## DESCRIPTION

**baz** is an implementation of **arch .**

**arch** is a version control system, which allows you to keep old versions of files and directories (usually source code), keep a log of who, when, and why changes occurred, etc., like SVN, CVS, or RCS.

**arch** has a number of advantages compared to competing systems. Among these are:

### Works on Whole Trees

**arch** keeps track of whole trees -- not just individual files. For example, if you change many files in a tree, **arch** can record all of those changes as a group rather than file-by-file; if you rename files or reorganize a tree, **arch** can record those tree arrangements along with your changes to file contents.

### Changeset Oriented

**arch** doesn´t simply "snapshot" your project trees. Instead, **arch** associates each revision with a particular changeset: a description of exactly what has changed. **arch** provides changeset oriented commands to help you review changesets, merge trees by applying changesets, examine the history of a tree by asking what changesets have been applied to it, and so forth.

### Fully Distributed

**arch** doesn´t rely on a central repository. For example, there is no need to give write access to a project´s archive to all significant contributors. Instead, each contributor can have their own archive for their work. **arch** seamlessly operates across archive boundaries.

## COMMAND OVERVIEW

### Help

- **baz help \[options\]**

  provide help with arch

### User Commands

- **baz my-id \[options\] \[id\]**

  print or change your id

- **baz my-default-archive \[options\] \[archive\]**

  print or change your default archive

- **baz register-archive \[options\] \[-d name\] location**

  change an archive location registration

- **baz whereis-archive \[options\] archive**

  print an archive location registration

- **baz archives \[options\] \[search regular expression\]**

  report registered archives and their locations

- **baz upgrade \[options\]**

  perform an upgrade of local baz settings and data.

### Project Tree Commands

- **baz annotate \[options\] \[path ...\]**

  display the changesets that last modified lines in the tree

- **baz diff \[options\] \[revision\] \[-- limit...\]**

  report about local changes in a project tree

- **baz init-tree \[options\] \[\[archive\]/version\]**

  initialize a new project tree

- **baz tree-id \[options\] \[dir\]**

  Print the tree identifier for a project tree-\>

- **baz tree-root \[options\] \[dir\]**

  find and print the root of a project tree

- **baz tree-version \[options\] \[NEW VERSION\]**

  Print the default version for a project tree

- **baz set-tree-version \[options\] \[...\]**

  This command has been removed; you can use ´baz tree-version \<version\>´ instead.

- **baz undo \[options\] \[revision\] \[-- file ...\]**

  undo and save changes in a project tree

- **baz redo \[options\] \[changeset\]**

  redo changes in project tree

- **baz file-diff \[options\] file \[revision\]**

  show local changes to a file

- **baz switch \[options\] \[package\]**

  change the working trees version to that of package

### Project Tree Inventory Commands

- **baz inventory \[options\] \[dir\]\***

  inventory a source tree

- **baz status \[options\] \[dir\]**

  scan a project tree and show the tree status.

- **baz lint \[options\] \[dir\]**

  audit a source tree

- **baz resolved \[options\] FILE \[FILE ...\]**

  Tell bazaar one or more tree problems have been resolved

- **baz id \[options\] file ...**

  report the inventory id for a file

- **baz id-tagging-method \[options\] \[method\]**

  print or change a project tree id tagging method

- **baz add-id \[options\] file ...**

  add an explicit inventory id

- **baz delete-id \[options\] file ...**

  remove an explicit inventory id

- **baz rm \[options\] file...**

  remove a file (or dir, or symlink) and its explicit inventory tag (if any)

- **baz move-id \[options\] from to**

  move an explicit inventory id

- **baz mv \[options\] from to OR from1 from2 ... dir**

  move a file (or dir, or symlink) and its explicit inventory tag (if any)

- **baz explicit-default \[options\] \[TAG-PREFIX\]**

  print or modify default ids

- **baz id-tagging-defaults \[options\]**

  print the default =tagging-method contents

- **baz inode-sig \[options\] \[dir\]**

  output the inode signature for a source tree.

### Patch Set Commands

- **baz changeset \[options\] ORIG MOD DEST \[files\]**

  compute a whole-tree changeset

- **baz apply-changeset \[options\] CHANGESET \[TARGET\]**

  apply a whole-tree changeset

- **baz show-changeset \[options\] \[dir\]**

  generate a report from a changeset

### Archive Transaction Commands

- **baz make-archive \[options\] \[name\] location**

  create a new archive directory

- **baz import \[options\] \[\[archive\]/version\]**

  archive a full-source base-0 revision

- **baz export \[options\] \[revision\] \[dir\]**

  export all or some of a tree revision

- **baz commit \[options\] \[file ...\]**

  archive a changeset-based revision

- **baz get \[options\] revision \[dir\]**

  construct a project tree for a revision

- **baz get-changeset \[options\] revision \[dir\]**

  retrieve a changeset from an archive

- **baz lock-revision \[options\] VERSION\|REVISION**

  lock (or unlock) an archive revision

- **baz archive-mirror \[options\] \[from \[to\] \[limit\]\]**

  update an archive mirror

### Archive Commands

- **baz abrowse \[options\] \[limit\]**

  print an outline describing archive contents

- **baz rbrowse \[options\] \[\[ARCHIVE\_NAME/\]LIMIT\_REGEX\]**

  print an outline describing an archive´s contents

- **baz categories \[options\] \[archive\]**

  list the categories in an archive

- **baz branches \[options\] \[\[archive/\]category\]**

  list the branches in an archive category

- **baz versions \[options\] \[branch\]**

  list the versions in an archive branch

- **baz revisions \[options\] \[\[archive/\]version\]**

  list the revisions in an archive version

- **baz ancestry \[options\] \[revision\]**

  display the ancestory of a revision

- **baz ancestry-graph \[options\] \[revision\]**

  display the ancestory of a revision

- **baz change-archive \[options\] archivename\|URL**

  Alter properties of an archive. For instance, add signatures to an unsigned archive.

- **baz cat-archive-log \[options\] revision**

  print the contents of an archived log entry

- **baz cacherev \[options\] \[ARCHIVE/\[PACKAGE\[--VERSION\[--PATCHLEVEL\]\]\]\] or \[PATCHLEVEL\]**

  cache a full source tree in an archive

- **baz cachedrevs \[options\] \[version\]**

  list cached revisions in an archive

- **baz uncacherev \[options\] revision \[dir\]**

  remove a cached full source tree from an archive

- **baz archive-meta-info \[options\] \[archive/\]item-name**

  report meta-info from an archive

- **baz archive-snapshot \[options\] dir \[\[archive/\]limit\]**

  update an archive snapshot

- **baz archive-version \[options\] \[archive\]**

  list the archive-version in an archive

- **baz archive-fixup \[options\] \[archive\]**

  fix ancillary files (e.g. .listing files) in an archive

### Patch Log Commands

- **baz make-log \[options\] \[version\]**

  initialize a new log file entry

- **baz log-versions \[options\]**

  list patch log versions in a project tree

- **baz add-log-version \[options\] \[archive\]/version**

  add a patch log version to a project tree

- **baz remove-log-version \[options\] \[archive\]/version**

  remove a version´s patch log from a project tree

- **baz log \[-f\|--full\] \[-r start\[:end\]\]**

  Show the log messages for the working directory or given

- **baz logs \[options\] \[\[archive\]/version ...\]**

  list patch logs for a version in a project tree

- **baz cat-log \[options\] revision-spec**

  print the contents of a project tree log entry

- **baz changelog \[options\] \[\[archive\]/version\]**

  generate a ChangeLog from a patch log

- **baz log-for-merge \[options\] \[\[archive\]/version\]**

  generate a log entry body for a merge

- **baz merges \[options\] INTO \[FROM\]**

  report where two branches have been merged

- **baz new-merges \[options\] \[\[archive\]/version\]**

  list tree patches new to a version

### Multi-project Configuration Commands

- **baz build-config \[options\] config**

  instantiate a multi-project config

- **baz cat-config \[options\] config**

  output information about a multi-project config

### Commands for Branching and Merging

- **baz branch \[options\] \[SOURCE\] BRANCH**

  create a branch

- **baz merge \[options\] \[FROM\]**

  merge from another branch

- **baz update \[options\] \[version/revision\]**

  update a project tree to reflect recent archived changes

- **baz replay \[options\] \[version/revision...\]**

  apply revision changesets to a project tree

- **baz apply-delta \[options\] FROM(REVISION\|DIR) TO(REVISION\|DIR)**

  compute a changeset between any two trees or revisions and apply it to a project tree

- **baz missing \[options\] \[version\]**

  print patches missing from a project tree

- **baz join-branch \[options\] version**

  add a version as an ancestor of a project tree

- **baz sync-tree \[options\] revision**

  unify a project tree´s patch-log with a given revision

- **baz delta \[options\] (REVISION\|TREE)-A (REVISION\|TREE)-B \[DESTDIR\]**

  compute a changeset (or diff) between any two trees or revisions

### Local Cache Commands

- **baz file-find \[options\] file \[revision\]**

  find given version of file

- **baz pristines \[options\] \[limit\]**

  list pristine trees in a project tree

- **baz add-pristine \[options\] revision**

  ensure that a project tree has a particular pristine revision

- **baz find-pristine \[options\] revision**

  find and print the path to a pristine revision

### Revision Library Commands

- **baz my-revision-library \[options\] \[dir\]**

  print or change your revision library path

- **baz library-config \[options\] library-dir**

  configure parameters of a revision library

- **baz library-find \[options\] revision**

  find and print the location of a revision in the revision library

- **baz library-add \[options\] revision**

  add a revision to the revision library

- **baz library-remove \[options\] revision**

  remove a revision from the revision library

- **baz library-archives \[options\]**

  list the archives in your revision library

- **baz library-categories \[options\] \[archive\]**

  list the categories in your revision library

- **baz library-branches \[options\] \[category\]**

  list the branches in a library category

- **baz library-versions \[options\] \[branch\]**

  list the versions in a library branch

- **baz library-revisions \[options\] \[version\]**

  list the revisions in a library version

- **baz library-log \[options\] revision**

  output a log message from the revision library

- **baz library-file \[options\] file revision**

  find a file in a revision library

### Cache Commands

- **baz cache-config \[options\] \[dir\]**

  Print or change your cache settings

### Published Revisions Commands

- **baz grab \[options\] location**

  grab a published revision

### Miscellaneous Scripting Support

- **baz parse-package-name \[options\] name**

  parse a package name

- **baz valid-package-name \[options\] name**

  test a package name for validity

- **baz escape \[--unescaped\] string**

  print strings in escaped or unescaped form

## HELP

### baz help

**provide help with arch**

**Usage:** baz help \[options\]

  \-h, --help     Display a help message and exit.\
   \-H             Display a verbose help message and exit.\
   \--aliases      Display command aliases\
   \-V, --version  Display a release identifier string\
                  and exit.

This command prints a list of the available commands.

To see just a list of the options to a particular command, use:

    baz $cmd -h

(where $cmd is the name of the command).   For additional explanation about a given command, use:

    baz $cmd -H

## USER COMMANDS

### baz my-id

**print or change your id**

**Usage:** baz my-id \[options\] \[id\]

  \-e, --errname  specify program name for errors\
   \-u, --uid      print only the UID portion of the ID

With no argument print your arch id.

With an argument, record ID-STRING as your id in ~/.arch-params/=id

Your id is recorded in various archives and log messages as you use arch.  It must consist entirely of printable characters and fit on one line.  By convention, it should have the form of an email address, as in this example:

        Jane Hacker \<jane.hacker@gnu.org\>

The portion of an id string between \< and \> is called your uid.  arch sometimes uses your uid as a fragment when generating unique file names.

The option -u (--uid) causes only the uid part of your id string to be printed.

### baz my-default-archive

**print or change your default archive**

**Usage:** baz my-default-archive \[options\] \[archive\]

  \-A, --archive  Override \`my-default-archive´\
   \-e, --errname  specify program name for errors\
   \-d, --delete   unspecify your default archive\
   \-s, --silent   suppress reassuring messages

With no argument, and without -d, print the name of your default archive.

With an argument, record ARCHIVE as your default archive in ~/.arch-params/=default-archive

With the option -d (--delete) and no argument, ensure that you do not have a default archive set in ~/.arch-params.

Your default archive is determined this way:

If the option -A (--archive) is given and not empty, that archive is the default (which makes this script useful for processing a -A argument that was passed to another script).

If -A is not given, but ~/.arch-params/=default-archive exists and is not empty, that is your default archive.

Otherwise, your default archive is the name of the local archive rooted at the argument to -R (--root) or specified in the environment variable ARCHROOT.

If no default archive can be found by any of these means, the program exits with status 1, printing an error message unless the -s (--silent) option is given.

### baz register-archive

**change an archive location registration**

**Usage:** baz register-archive \[options\] \[-d name\] location

  \-f, --force       overwrite existing location\
   \--present-ok      return 0 even if archive exists\
   \-d, --delete      delete archive registration

Record the location of ARCHIVE.

With -d, remove the registration of a previously registered archive.  When accompanied by -f, override permissions on the registration file and don´t complain if the archive is not registered. If you are deleting a location that is inaccesible, you may provide the name of the archive that the location belongs to This may not be provided when registering an archive: inaccessible archives may not be registered.

A LOCATION should be either a directory name or a distant URL.

When registering a new archive, then the archive´s name will be read automatically from the archive´s meta data.

Archive locations are stored in ~/.arch-params/archives/ARCHIVENAME.

Registering archives is optional. If you use a url to a command, the archive will be automatically registered.

### baz whereis-archive

**print an archive location registration**

**Usage:** baz whereis-archive \[options\] archive

  \--all-locations      Show all known locations for this archive name

Print the registered location of an archive.

Usually the archive must have been previously registered with "baz register-archive".

As a special exception, the the archive is not registered, but is the name of the archive rooted at the location given with the option -R (--root) or in the environment variable ARCHROOT then print that root directory.

### baz archives

**report registered archives and their locations**

**Usage:** baz archives \[options\] \[search regular expression\]

  \-n, --names           print archive names only\
   \-R, --exclude-remote  Exclude MIRROR and SOURCE archives.\
   \--all-locations       Show all known locations for archives

Print a list of registered archives and their locations

If \[search regex\] is given then only archives with names that match \[search regex\] will be shown

### baz upgrade

**perform an upgrade of local baz settings and data.**

**Usage:** baz upgrade \[options\]

  \--leave-old-config      Leave the old config in place. this may interfere with normal operation and is not recommended.\
   \--move-old-config       Move the config data to ~/.arch-params/upgraded-by-baz-1.3 after it is upgraded

By default, nothing is done. You must supply --move-old-config (recommended) or --leave-old-config

For baz 1.3 this: Scans all the archives listed in ~/.arch-params/=locations and writes consolidated configuration details to ~/.arch-params/archives. After upgrading, the previous configuration details are saved in ~/.arch-params/upgraded-by-baz-1.3/

If an archive cannot be connected to, its configuration details are left untouched

## PROJECT TREE COMMANDS

### baz annotate

**display the changesets that last modified lines in the tree**

**Usage:** baz annotate \[options\] \[path ...\]

  \-d, --dir DIR  cd to DIR first

### baz diff

**report about local changes in a project tree**

**Usage:** baz diff \[options\] \[revision\] \[-- limit...\]

  \-d, --dir DIR          Change to DIR first.\
   \-o, --output DIR       Save changeset in DIR.\
   \-v, --verbose          Verbose changeset report.\
   \-q, --quiet            Suppress progress information\
   \-s, --summary          Do not include diffs in the output.\
   \-p, --show-c-function  Show which C function each change is in.\
   \--link                 hardlink unchanged files to revision library\
   \--unescaped            show filenames in unescaped form

Generate a patch report describing the differences between the current project tree (or DIR if it is supplied) and the project trees current revision (or REVISION if supplied).

### baz init-tree

**initialize a new project tree**

**Usage:** baz init-tree \[options\] \[\[archive\]/version\]

  \-A, --archive  Override \`my-default-archive´\
   \-d, --dir DIR  cd to DIR first\
   \--nested       initialize a nested project tree.

Initialize DIR as a new project tree.

An empty patch-log for VERSION will be created, and VERSION will be made the default location for check-ins.

### baz tree-id

**Print the tree identifier for a project tree-\>**

**Usage:** baz tree-id \[options\] \[dir\]

Print the patchset identifier that represents the current tree-\> I.e. foo@example.com/demo--1.0--patch-4. Defaults to the tree the current directory is in.

### baz tree-root

**find and print the root of a project tree**

**Usage:** baz tree-root \[options\] \[dir\]

  \--accurate      error for mid-txn trees\
   \-s, --silent    exit status only

Find and print the root of the project tree that contains DIR (or the current directory). The option --accurate checks for three possibilities:

    1\) The project tree was the subject of a commit that\
        was killed before the log entry was added to the\
        tree´s patch log.  It is unknown whether or not\
        the commit took place in the archive.  The {arch}\
        directory contains the log file as "++mid-commit".

    2\) The project tree was the subject of a killed commit, but\
        it is certain the commit took place.  The log file\
        is stored as "++commit-definite".

    3\) The project tree patch log is fully up-to-date (as far as\
        arch knows).

In case 1, exit with an error and error message.

In case 2, install the log file before printing the tree root and exiting normally.

In case 3, print the tree root and exit normally.

### baz tree-version

**Print the default version for a project tree**

**Usage:** baz tree-version \[options\] \[NEW VERSION\]

  \-d, --dir DIR  cd to DIR first

Print the default version of project tree DIR (or the current directory).

(Advanced Usage) If \[NEW VERSION\] is given, then the version of the working tree is changed to the supplied one

### baz set-tree-version

**This command has been removed; you can use ´baz tree-version \<version\>´ instead.**

**Usage:** baz set-tree-version \[options\] \[...\]

### baz undo

**undo and save changes in a project tree**

**Usage:** baz undo \[options\] \[revision\] \[-- file ...\]

  \-A, --archive           Override \`my-default-archive´\
   \-d, --dir DIR           cd to DIR first\
   \-o, --output PATCH-DIR  save changeset in PATCH-DIR\
   \-n, --no-output         do not save the changeset\
   \-q, --quiet             no progress reports while computing changeset\
   \--unescaped             show filenames in unescaped form

Compute a patch set describing the changes from REVISION to the project tree containing DIR.  Save the patch in PATCH-DIR (which must not already exist) and apply the patch in reverse to the project tree containing DIR.

The effect is to remove local changes in the DIR project tree but save them in a convenient form.

If REVISION is not specified, the latest ancestor of the default version of project tree is used.

If REVISION is specified as a VERSION, the latest ancestor of the project tree in that VERSION is used.

If DIR is not specified, "." is assumed.

If PATCH-DIR is not specified, a temporary file-name of the matching ,,undo-\* is used.

If --no-output is specified, the patch set is not saved.

See also "baz redo -H" and "baz diff -H".

### baz redo

**redo changes in project tree**

**Usage:** baz redo \[options\] \[changeset\]

  \-k, --keep       do not delete the patch\
   \-q, --quiet      no progress reports while computing changeset\
   \-d, --dir DIR    Operate on project tree in DIR (default \`.´)\
   \--unescaped      show filenames in unescaped form

Apply CHANGESET to the project tree and then delete CHANGESET.

If CHANGESET is not specified, the highest numbered ,,undo-N directory in the project tree root is used.

If --keep is given, the changeset directory is not deleted.

See also "baz undo --help" and "baz apply-changeset --help".

### baz file-diff

**show local changes to a file**

**Usage:** baz file-diff \[options\] file \[revision\]

  \-A, --archive   Override \`my-default-archive´\
   \-N, --new-file  Treat missing file as empty

Print diffs between FILE and the corresponding file in a cached copy of REVISION.

The default patch level for a given version is the latest level for which the project tree has a patch.  The default archive and version is as printed by "baz tree-version".

### baz switch

**change the working trees version to that of package**

**Usage:** baz switch \[options\] \[package\]

  \-d, --dir DIR  Change to DIR first.\
   \-q, --quiet    Suppress progress information

change the working trees version to that of package, and make equivalent to revision. Preserves uncommitted changes.

Note: baz automatically switches to the \_latest\_ revision in the supplied version.

## PROJECT TREE INVENTORY COMMANDS

### baz inventory

**inventory a source tree**

**Usage:** baz inventory \[options\] \[dir\]\*

  \-s, --source        list source files\
   \-p, --precious      list precious files\
   \-b, --backups       list backup files\
   \-j, --junk          list junk files\
   \-u, --unrecognized  list unrecognized files\
   \-t, --trees         list roots of nested trees

  \-d, --directories   list only directories\
   \-f, --files         list only non-directories\
   \-B, --both          list both dirs and files\
   \--kind              indicate file kinds

  \--all               include arch control files\
   \--nested            include nested trees\
   \--no-recursion      do not list content of directory

  \--ids               list with ids (source files only)\
   \--untagged          include files that are missing ids

  \--explicit          use explicit file ids\
   \--implicit          permit implicit file ids\
   \--tagline           permit tagline file ids\
   \--names             use name-based file ids\
   \--unescaped         show filenames in unescaped form

With no arguments, print a human-readable inventory report.

With category options (--source etc) limit the report to just those files.  With no other options, the report includes all sections and files.

The options -d, -f, and -b cancel each other.

The options --nested and --no-recursion cancel each other.

If a directory is precious, junk, or unrecognized, only the directory name itself is printed -- its contents are not searched.

### baz status

**scan a project tree and show the tree status.**

**Usage:** baz status \[options\] \[dir\]

  \-V, --version             Display a release identifier string and exit\
   \-s, --broken-symlinks     Just list broken symlinks\
   \-u, --unrecognized-files  Just list files violating naming conventions\
   \-t, --untagged-files      Just list files lacking inventory ids\
   \-m, --missing-files       Just list inventory ids lacking corresponding files\
   \-d, --duplicate-ids       Just list duplicated ids\
   \-c, --conflicted          Just list conflicted files\
   \--lint                    Only lint the project tree\
   \--diffs                   deprecated. use baz diff instead\
   \--strict                  exit with non-0 status on \_any\_ oddity\
   \--unescaped               show filenames in unescaped form

Audit a source tree for various changes, the characters in the first column mean: C - conflicts R - renames A - adds D - deletes P - permissions ? - unexpected files By default, changes will report the status  for everything within a tree. Specific changes may be ignored by passing options to the changes command

Note: If conflicts have occurred, when you have resolved them, notify baz by run baz resolved --all

### baz lint

**audit a source tree**

**Usage:** baz lint \[options\] \[dir\]

  \-s, --broken-symlinks     Just list broken symlinks\
   \-u, --unrecognized-files  Just list files violating naming conventions\
   \-t, --untagged-files      Just list files lacking inventory ids\
   \-m, --missing-files       Just list inventory ids lacking corresponding files\
   \-d, --duplicate-ids       Just list duplicated ids\
   \--strict                  exit with non-0 status on \_any\_ oddity\
   \--unescaped               show filenames in unescaped form

Audit a source tree for missing files, untagged files, duplicate ids, and files not matching recognized naming conventions.

The default is to list files failing any of those tests.  Enabling any of the \`specific´ tests disables the rest, unless they´re explicitly enabled on the command line. Therefore, "lint" is equivalent to "lint -sutmd"

### baz resolved

**Tell bazaar one or more tree problems have been resolved**

**Usage:** baz resolved \[options\] FILE \[FILE ...\]

  \-d, --dir DIR  Change to DIR first.\
   \--all          Mark all problems as resolved\
   \--rejects      Mark rejects as resolved\
   \-q, --quiet    Suppress progress information

This command is used to tell bazaar that one or more tree problems has been solved. In this version of bazaar, --all is equivalent to --rejects

### baz id

**report the inventory id for a file**

**Usage:** baz id \[options\] file ...

  \--implicit       Use the implicit id tagging method.\
   \--tagline        Use the tagline id tagging method (default).\
   \--explicit       Use the explicit id tagging method.\
   \--names          Use the names id tagging method.\
   \--silent         No output -- exit status only.\
   \--unescaped      show filenames in unescaped form

Print a file´s inventory id.

### baz id-tagging-method

**print or change a project tree id tagging method**

**Usage:** baz id-tagging-method \[options\] \[method\]

  \-d, --dir DIR  cd to DIR first\
   \--strict       exit with error if method not set

Print or change the method by which source files are identified in DIR (or the current directory).

When setting, METHOD must be one of:

        names           -- use naming conventions only\
         implicit        -- use naming conventions but permit\
                            for inventory tags\
         explicit        -- require explicit designation of source\
         tagline         -- mix names, explicit and arch-tag: methods

When printing, if --strict is provided but no id tagging method is explicitly set, print an error.

### baz add-id

**add an explicit inventory id**

**Usage:** baz add-id \[options\] file ...

  \--escaped      Provided file names may be escaped.\
   \-i, --id ID    Specify ID, instead of using auto-generated id.

Create an explicit inventory id for FILE (which may be a regular file, symbolic link, or directory).

### baz delete-id

**remove an explicit inventory id**

**Usage:** baz delete-id \[options\] file ...

Remove an explicit inventory id for FILE (which may be a regular file, symbolic link, or directory).

### baz rm

**remove a file (or dir, or symlink) and its explicit inventory tag (if any)**

**Usage:** baz rm \[options\] file...

### baz move-id

**move an explicit inventory id**

**Usage:** baz move-id \[options\] from to

Move an explicit inventory id for FILE (which may be a regular file or symbolic link but which must not be a directory).

### baz mv

**move a file (or dir, or symlink) and its explicit inventory tag (if any)**

**Usage:** baz mv \[options\] from to   OR   from1 from2 ... dir

This command is suitable as a replacement for [mv(1)](/mv/1.md) within any baz tree for any move operation, regardless of id tagging method.

### baz explicit-default

**print or modify default ids**

**Usage:** baz explicit-default \[options\] \[TAG-PREFIX\]

  \-D, --dir DIR    cd to DIR first\
   \-d, --delete     remove the default\
   \-s, --strong     use the strong default (default)\
   \-w, --weak       use the weak default\
   \--dont-care      use the dont-care default

For files in this directory, use:

     ID-PREFIX\_\_BASENAME

as the default explicit id for all files in this directory that do not have an explicit explicit id.

With no arguments, print the previously set ID-PREFIX.

By default, this command sets, prints or deletes a "strong default" -- a default explicit id which overrides implicit ids.

With --weak, set (or print) a weak default id which is overridden by explicit ids.

The --dont-care option sets (or with -d, clears) a flag for that directory that causes unidged files not to be reported as such in "baz lint" reports.

### baz id-tagging-defaults

**print the default =tagging-method contents**

**Usage:** baz id-tagging-defaults \[options\]

Print the boilerplate contents that are used to initialize new =tagging-method files.

### baz inode-sig

**output the inode signature for a source tree.**

**Usage:** baz inode-sig \[options\] \[dir\]

## PATCH SET COMMANDS

### baz changeset

**compute a whole-tree changeset**

**Usage:** baz changeset \[options\] ORIG MOD DEST \[files\]

  \--file-list FILES      record only diffs of selected files\
   \--unescaped            show filenames in unescaped form

Compares the source trees ORIG and MOD, and produces a changeset tree in DEST, which must not already exist.

See also "baz apply-changeset -H".

### baz apply-changeset

**apply a whole-tree changeset**

**Usage:** baz apply-changeset \[options\] CHANGESET \[TARGET\]

  \-N, --forward    pass the --forward option to \`patch´\
   \-r, --reverse    Apply the changeset in reverse\
   \--unescaped      show filenames in unescaped form

Apply the changeset CHANGESET to the source tree TARGET (default \`.´).

See also "baz changeset -H".

### baz show-changeset

**generate a report from a changeset**

**Usage:** baz show-changeset \[options\] \[dir\]

  \--diffs          include diff output\
   \--unescaped      show filenames in unescaped form

Produce a human-readable summary of a changeset.

## ARCHIVE TRANSACTION COMMANDS

### baz make-archive

**create a new archive directory**

**Usage:** baz make-archive \[options\] \[name\] location

  \-m, --mirror MASTER              create mirror of specified archive\
   \-M, --mirror-from MASTER-SOURCE  create pull-based mirror of specified archive\
   \-l, --listing                    Keep .listing files up-to-date in this archive.\
   \-t, --tla                        Create a tla format archive.\
   \-s, --signed                     GPG sign the contents of this archive.

NAME is the global name for the archive.  It must be an email address with a fully qualified domain name, optionally followed by "--" and a string of letters, digits, periods and dashes.

With --mirror, label the new archive as a mirror of MASTER. Ordinary commits can not be made to a mirror archive, however the command "baz archive-mirror" can write to a mirror.

Two special forms of this command are available:

   baz make-archive --mirror MASTER LOCATION

is equivalent to:

   baz make-archive --mirror MASTER MASTER-MIRROR LOCATION

and thus "baz archive-mirror MASTER" will push changes from MASTER to the newly created mirror.

   baz make-archive --mirror-from MASTER-SOURCE LOCATION

is equivalent to:

   baz make-archive --mirror MASTER-SOURCE MASTER LOCATION

and thus "baz archive-mirror MASTER" will pull changes from MASTER-SOURCE to the newly created mirror.

The first of these two special forms is especially handy when creating a remote mirror in which to publish a local repository.

The second special form is handy when creating a local mirror of a remote archive, locally bound to the remote archive´s name.

The --tla option creates a tla format archive, the default is  to create a Bazaar archive.

### baz import

**archive a full-source base-0 revision**

**Usage:** baz import \[options\] \[\[archive\]/version\]

  \-d, --dir DIR           Import the directory DIR.\
   \-l, --log FILE          Commit with log file FILE.\
   \-s, --summary TEXT      log with summary TEXT plus log-for-merge output\
   \-a, --automatic         Initialise dir as a working tree, add all source-looking files in dir and import. This operation requires VERSION.\
   \-L, --log-message TEXT  log with TEXT

Archive a from-scratch base revision of the tree DIR (or the current directory).  Use this command to create the first revision of a new project.

If --log-message is specified without --summary, then TEXT is used both as the summary and the first line of the log body.

### baz export

**export all or some of a tree revision**

**Usage:** baz export \[options\] \[revision\] \[dir\]

  \-s, --silent   no output

Extract REVISION from an archive, creating a new source tree with no control information.

### baz commit

**archive a changeset-based revision**

**Usage:** baz commit \[options\] \[file ...\]

  \-d, --dir DIR           cd to DIR first\
   \-l, --log FILE          commit with log file FILE\
   \-s, --summary TEXT      log with summary TEXT plus log-for-merge output\
   \-L, --log-message TEXT  log with TEXT plus log-for-merge output\
   \--strict                strict tree-lint\
   \--seal                  create a version-0 revision\
   \--fix                   create a versionfix revision\
   \--out-of-date-ok        commit even if out of date\
   \--just-commit           only commit a simple changeset, do not add other files (such as ancestry,cached revisions.\
   \--file-list FILE        commit only changes to files listed in FILE\
   \--unescaped             show filenames in unescaped form\
   \-b, --branch            commit to a different branch

Archive a revision of the project tree containing DIR (or the current directory)

If there are any automated ChangeLog files, update them before computing the patch set.

If --log-message is specified without --summary, then TEXT is used both as the summary and the first line of the log body.

### baz get

**construct a project tree for a revision**

**Usage:** baz get \[options\] revision \[dir\]

  \-A, --archive        Override \`my-default-archive´\
   \--no-pristine        don´t save a pristine copy\
   \--link               hardlink files to revision library instead of copying\
   \--library            ensure the revision is in a revision library\
   \--sparse             add library entries sparsely (--link, --library)\
   \--non-sparse         add library entries densely (--link, --library)\
   \-s, --silent         no output\
   \--no-greedy-add      do not allow greedy libraries to add revisions\
   \--unescaped          show filenames in unescaped form

Extract REVISION from an archive, creating the new project tree DIR.   If DIR is not specified, store the working copy in a subdirectory of the current directory, giving it the name of the revision. CAUTION: when using the links option be sure to use copy-on-write on your editor or the revision library will be corrupted. Either way, the project tree must not already exist.

### baz get-changeset

**retrieve a changeset from an archive**

**Usage:** baz get-changeset \[options\] revision \[dir\]

  \-A, --archive  Override \`my-default-archive´

Retrieve the changeset for REVISION and store it in the directory DIR (or a directory named REVISION.patches).  DIR must not already exist.

### baz lock-revision

**lock (or unlock) an archive revision**

**Usage:** baz lock-revision \[options\] VERSION\|REVISION

  \-A, --archive  Override \`my-default-archive´\
   \-u, --unlock   release a lock owned by you\
   \-b, --break    break any existing lock

Acquire the lock needed to create REVISION.

Revision must be the next patch-level in sequence, however, if no patch level is specified, the revision is automatically calculated

### baz archive-mirror

**update an archive mirror**

**Usage:** baz archive-mirror \[options\] \[from \[to\] \[limit\]\]

  \--no-cached        don´t copy cached revisions\
   \-s, --summary      print the summary of each patch\
   \--cached-tags      copy only cachedrevs for tags to other archives\
   \-a, --all-mirrors  mirror to all known mirrors

If no arguments are given, update either the archive for the project tree you are in, or your \`my-default-archive´-MIRROR archive with the contents of \`my-default-archive´.

If a \[FROM\] archive is given, update the \[FROM\]-MIRROR archive with the contents of the \[FROM\] archive

If both \[FROM\] and \[TO\] archives are specified, update \[TO\] with the contents of \[FROM\]

If LIMIT is provided, it should be a category, branch, version, or revision name.   Only the indicated part of FROM will be copied to TO. If LIMIT is a revision, then cached revisions will be copied and deleted to TO.

(see "baz make-archive -H".).

## ARCHIVE COMMANDS

### baz abrowse

**print an outline describing archive contents**

**Usage:** baz abrowse \[options\] \[limit\]

  \-r, --reverse          sort revisions from newest to oldest\
   \-s, --summary          print a summary of each patch\
   \-c, --creator          print the creator of each patch\
   \-D, --date             print the date of each patch\
   \-k, --kind             show each revision kind (import, changeset or id)\
   \-C, --cacherevs        show cached revisions\
   \-f, --full             print full patch level names\
   \--desc                 implies -s -c -D -k -C\
   \--local-merges         list merges from the same archive\
   \--foreign-merges       list merges from other archives\
   \--merges               list all merges\
   \--categories           show category names only\
   \--branches             show branch names only\
   \--versions             show version names only\
   \--omit-empty           omit empty or unchanged-since items\
   \--since SNAP-FILE      show revisions after those listed in SNAP-FILE\
   \--since-limits         limit output to items in the since file\
   \--snap SNAP-FILE       record the highest revisions shown\
   \--force                overwrite an existing snap-file

Describe the contents of an archive in outline format.

With LIMIT, look only that part of the archive.

LIMIT may be a fully qualified name and may be an archive name.

### baz rbrowse

**print an outline describing an archive´s contents**

**Usage:** baz rbrowse \[options\] \[\[ARCHIVE\_NAME/\]LIMIT\_REGEX\]

  \--all                    Search all archives\
   \--since SNAP-FILE        Only show differences since SNAP-FILE\
   \--snap SNAP-FILE         Snap an archive\
   \-f, --snap-force         Force snap writing\
   \-r                       Reverse patch logs\
   \-s                       Print the summary of matching patches\
   \-c                       Print the creator of matching patches\
   \-D                       Print the date of matching patches\
   \--patch-regex REGEX      Only show revisions that contain \[REGEX\]\
                            (implies -s)\
   \--show-sealed            Do not hide sealed branches

an outline of an archive will be printed, showing the categories, branches and revisions of the specified archive if no archive is given then \`my-default-archive\` is used.

If \[LIMIT REGEX\] is specified, revisions will only be shown if the category, branch or version matches \[LIMIT REGEX\]. If --patch-regex \[REGEX\] is given, then only patchlogs matching \[REGEX\] will be given

### baz categories

**list the categories in an archive**

**Usage:** baz categories \[options\] \[archive\]

Print a list of the categories present in an archive.

### baz branches

**list the branches in an archive category**

**Usage:** baz branches \[options\] \[\[archive/\]category\]

Print a list of the branches within CATEGORY

### baz versions

**list the versions in an archive branch**

**Usage:** baz versions \[options\] \[branch\]

  \-A, --archive  Override \`my-default-archive´\
   \-r, --reverse  sort from newest to oldest

Print a list of versions within an archive branch.

The list is ordinarily sorted from oldest to newest, but the order can be changed with -r (--reverse).

### baz revisions

**list the revisions in an archive version**

**Usage:** baz revisions \[options\] \[\[archive/\]version\]

  \-r, --reverse  sort from newest to oldest\
   \-f, --full     list fully qualified names\
   \-s, --summary  print a summary of each patch\
   \-c, --creator  print the creator of each patch\
   \-D, --date     print the date of each patch

Print a list of revisions within an archive version.

The list is ordinarily sorted from oldest to newest, but the order can be changed with -r (--reverse).

With optional arguments specifying patches, list only those patches, if they exist.  If a listed patch does not exist, exit with status 1.  The -r (--reverse) flag has no effect with optional arguments.

### baz ancestry

**display the ancestory of a revision**

**Usage:** baz ancestry \[options\] \[revision\]

  \-d, --dir DIR  cd to DIR first\
   \-m, --merges   show merges into this development line\
   \-r, --reverse  list oldest to newest\
   \-s, --summary  print a summary of each patch\
   \-c, --creator  print the creator of each patch\
   \-t, --tree     generate or print the tree ancestry file\
   \-D, --date     print the date of each patch

Print the ancestry of a revision.

### baz ancestry-graph

**display the ancestory of a revision**

**Usage:** baz ancestry-graph \[options\] \[revision\]

  \-d, --dir DIR    cd to DIR first\
   \-m, --merges     show merges into this development line\
   \-r, --reverse    list oldest to newest\
   \-i, --immediate  show only the immediate ancestor\
   \-p, --previous   show the (namespace) previous revision

Print a list describing the ancestry of a revision.

### baz change-archive

**Alter properties of an archive. For instance, add signatures to an unsigned archive.**

**Usage:** baz change-archive \[options\] archivename\|URL

  \--add-signatures         turn this archve into a signed archive\
   \--remove-signatures      remove digital signatures from this archive

The following operations involve making a temporary mirror of the archive: - adding signatures - removing signatures - changing the archive format They may take some time as they involve a full mirror of the archive and all its contents The following operations will automatically propogate their changes to all writeable mirrors listed in ~/.arch-params/archives/NAME, and must have the master archive available to operate at all: - adding signatures - removing signatures

### baz cat-archive-log

**print the contents of an archived log entry**

**Usage:** baz cat-archive-log \[options\] revision

  \--headers      show only log headers

Retrieve and print the log message for the indicated revision from its archive.

### baz cacherev

**cache a full source tree in an archive**

**Usage:** baz cacherev \[options\] \[ARCHIVE/\[PACKAGE\[--VERSION\[--PATCHLEVEL\]\]\]\] or \[PATCHLEVEL\]

Cache a full-text copy of the indicated revision in the archive.   This can speed up subsequent calls to "baz get" for that and subsequent revisions.

If no nothing is specified, but the command is run from within a project tree, cache the latest revision in the default version of that tree.

### baz cachedrevs

**list cached revisions in an archive**

**Usage:** baz cachedrevs \[options\] \[version\]

Report which revisions of VERSION have been cached as whole trees in the archive.

See also "baz cacherev -H".

### baz uncacherev

**remove a cached full source tree from an archive**

**Usage:** baz uncacherev \[options\] revision \[dir\]

  \-A, --archive  Override \`my-default-archive´

Remove the cached form of REVISION from its archive.

If REVISION is not specified, but the command is run from within a project tree, uncache the latest revision in the default version of that tree.

Also see "baz cacherev -H".

### baz archive-meta-info

**report meta-info from an archive**

**Usage:** baz archive-meta-info \[options\] \[archive/\]item-name

Print the contents of a meta-info file from an archive. For example,

    % baz archive-meta-info name

prints the official name of your default archive.

### baz archive-snapshot

**update an archive snapshot**

**Usage:** baz archive-snapshot \[options\] dir \[\[archive/\]limit\]

Update the directory DIR with a "snapshot" of of an archive (or the part of the archive indicated by LIMIT

For each archive snapshotted, DIR will contain a file and subdirectory (where $ARCH is the name of the archive):

    ./$ARCH.added\
     ./$ARCH/

Similarly, for each category snapshotted, DIR will contain:

    ./$ARCH/$CAT.added\
     ./$ARCH/$CAT/

and so on, recursively, for branches and versions.

For each revision, the snapshot contains:

    ./$ARCH/$CAT/$BRANCH/$VERSION/$REVISION.added

and that file contains a copy of the patch log entry for that revision.

Snapshots can be used in combination with other tools (´make´ is suggested) to trigger one-time events in response to new additions to an archive.

### baz archive-version

**list the archive-version in an archive**

**Usage:** baz archive-version \[options\] \[archive\]

Print the archive format identifier string of an arch archive.

### baz archive-fixup

**fix ancillary files (e.g. .listing files) in an archive**

**Usage:** baz archive-fixup \[options\] \[archive\]

This is a kind of "catch-all" command to fix the non-standard, non-transactional state of an archive.  Currently its sole function is to repair .listing files in archives that use them.

## PATCH LOG COMMANDS

### baz make-log

**initialize a new log file entry**

**Usage:** baz make-log \[options\] \[version\]

  \-A, --archive  Override \`my-default-archive´\
   \-d, --dir DIR  cd to DIR first\
   \--no-file      Display filename, but do not create file.

Create (if needed) a log entry file in the root of the project tree containing DIR, for the indicated VERSION.

The name of the new log file is printed to standard output.

### baz log-versions

**list patch log versions in a project tree**

**Usage:** baz log-versions \[options\]

  \-d, --dir DIR            cd to DIR first\
   \-a, --archive ARCHIVE    list only logs for ARCHIVE\
   \-c, --category CATEGORY  list only logs for CATEGORY\
   \-b, --branch BRANCH      list only logs for BRANCH\
   \-v, --vsn VERSION        list only logs for VERSION\
   \-r, --reverse            reverse the sort order

Print the list of versions for which there are patch logs in the project tree containing DIR (or the current directory).

### baz add-log-version

**add a patch log version to a project tree**

**Usage:** baz add-log-version \[options\] \[archive\]/version

  \-A, --archive  Override \`my-default-archive´\
   \-d, --dir DIR  cd to DIR first

Add an initially empty list of patch log for VERSION to the project tree containing DIR (or the current directory).

A project tree patch log is a pre-requisite for checking the directory in on that version, or updating with patches from that version.

Note that versions recorded for a project tree are recorded by fully qualified version names: an archive name plus the name of a version within that archive.

### baz remove-log-version

**remove a version´s patch log from a project tree**

**Usage:** baz remove-log-version \[options\] \[archive\]/version

  \-A, --archive  Override \`my-default-archive´\
   \-d, --dir DIR  cd to DIR first

Remove the patch log for VERSION from the project tree containing DIR (or the current directory).

Use this command with caution -- it erases revision history from the project tree!

### baz log

**Show the log messages for the working directory or given**

**Usage:** baz log \[-f\|--full\] \[-r start\[:end\]\]

  \-r, --range    -r start\[:end\], where start+end are PATCH or PACKAGE\
   \-f, --full     show the entire log message rather than the summary

files/directories, since the beginning of time (crossing copies/renames) or since/between the revisions/dates  given. Can also be run out of a working directory to\
  interrogate an archive instead of a working tree-\>

Examples: Show me the changes made to scripts/dpkg-source.pl in the  archive:\
    %% baz log -r dpkg--devel--1.13 scripts/dpkg-source.pl

Show me the changes between a different branch´s  patch-4, my branches patch-2:\
     %% baz log -r dpkg--devel--1.13--patch-4:patch-2

Show me the changes in all revisions of the tree-version after and including patch-123.\
     %% baz log -r patch-123:

 Show me the last ten changes:\
     %% baz log -r 10

### baz logs

**list patch logs for a version in a project tree**

**Usage:** baz logs \[options\] \[\[archive\]/version ...\]

  \-A, --archive         Override \`my-default-archive´\
   \-d, --dir DIR         cd to DIR first\
   \-r, --reverse         sort from newest to oldest\
   \-s, --summary         print the summary of each patch\
   \-c, --creator         print the creator of each patch\
   \-D, --date            print the date of each patch\
   \--local-merges        list merges from the same archive\
   \--foreign-merges      list merges from other archives\
   \--merges              list all merges\
   \-f, --full            print full patch level names

Print the list of patches applied to a project tree DIR (or the current directory) from VERSION.

### baz cat-log

**print the contents of a project tree log entry**

**Usage:** baz cat-log \[options\] revision-spec

  \-A, --archive  Override \`my-default-archive´\
   \-d, --dir DIR  cd to DIR first

Retrieve and print the patch log for the indicated revision from a project tree.

### baz changelog

**generate a ChangeLog from a patch log**

**Usage:** baz changelog \[options\] \[\[archive\]/version\]

  \-A, --archive               Override \`my-default-archive´\
   \-d, --dir DIR               cd to DIR first\
   \--no-files                  exclude file lists from ChangeLog\
   \--untagged                  don´t implicitly tag the output file\
   \--new-entry PATCH,FILE      make FILE the first (top) entry\
                                 for patch level PATCH

Generate a ChangeLog for VERSION from the patch log for DIR.

### baz log-for-merge

**generate a log entry body for a merge**

**Usage:** baz log-for-merge \[options\] \[\[archive\]/version\]

  \-A, --archive  Override \`my-default-archive´\
   \-d, --dir DIR  cd to DIR first\
   \-r, --reverse  sort from newest to oldest

Generate a log entry body describing a merge into VERSION.

### baz merges

**report where two branches have been merged**

**Usage:** baz merges \[options\] INTO \[FROM\]

  \-d, --dir DIR  cd to DIR first\
   \-r, --reverse  sort from newest to oldest\
   \-f, --full     print full patch level names

Print a list of pairs of patch level names:

        %s	%s   INTO-RVN  FROM-RVN

where each pair indicates that at patch level INTO-RVN of INTO, the patch log entry FROM-RVN was added.

FROM may be a branch name, version name, or revision name. If a branch or version name, all merges from that branch or version are reported.  If a revision name, only the merge points for that specific revision are reported.

INTO may be a version name or revision name.  If a version name, all merge points within that version are printed.  If a revision name, all merge points at that revision or earlier are printed.

Output is sorted using patch-level ordering of the first column.

Included patches are listed by full name unless FROM is a revision name.  If FROM is a revision, --full causes its full name to be printed.

### baz new-merges

**list tree patches new to a version**

**Usage:** baz new-merges \[options\] \[\[archive\]/version\]

  \-A, --archive  Override \`my-default-archive´\
   \-d, --dir DIR  cd to DIR first\
   \-r, --reverse  sort from newest to oldest

List all patch log entries in the tree containing DIR that have not already been merged with VERSION.

## MULTI-PROJECT CONFIGURATION COMMANDS

### baz build-config

**instantiate a multi-project config**

**Usage:** baz build-config \[options\] config

  \-d, --dir DIR        cd to DIR first\
   \--no-pristines       don´t create pristine copies\
   \--link               hardlink files to revision library instead of copying\
   \--library            ensure revisions are in the revision library\
   \--sparse             add library entries sparsely (--link, --library)\
   \--no-greedy-add      do not allow greedy libraries to add revisions\
   \-r, --release-id     overwrite ./=RELEASE-ID for this config

Build the named configuration.  See also baz cat-config -H".

### baz cat-config

**output information about a multi-project config**

**Usage:** baz cat-config \[options\] config

  \-d, --dir DIR     cd to DIR first\
   \-o, --output CFG  write the output as config CFG\
   \-f, --force       overwrite an exiting config (with --output)\
   \-s, --snap        Show current patch levels of subtree packages.\
   \--unescaped       show filenames in unescaped form

Parse and print the indicate config file from a project tree

A config file contains blank lines, comment lines starting with "#", and config specification lines.   The config file called $NAME is stored in a project tree as ./configs/$NAME or as ./$NAME.

A config specification line contains a relative path within a project tree, and a specification of the project or revision to store in that location.

For example, the line:

   ./src/arch   lord@emf.net--2003b/arch--devo--1.0

means that, when building the configuration, the latest revision of arch--devo--1.0 should be created within the tree as ./src/arch.

The project specification can be a branch name, version name or the name of a specific revision.

The option --snap says to examine the project tree to find out which revisions of configured project are printed, and generate a new config specification that references those specific revisions.   For example, the output for the line shown above might be:

    ./src/arch  lord@emf.net--2003b/arch--devo--1.0--patch-21

The option --output causes the output from this command to be recorded as a new configuration file (or to replace an existing file if --force is provided).

## COMMANDS FOR BRANCHING AND MERGING

### baz branch

**create a branch**

**Usage:** baz branch \[options\] \[SOURCE\] BRANCH

  \-l, --log FILE     commit with log file FILE\
   \--no-cacherev      Do not cacherev tag even if different archive\
   \--seal             create a version-0 revision\
   \--fix              create a versionfix revision\
   \-d, --dir DIR      cd to DIR first

Create the continuation at the next patch level of BRANCH which is equivalent to SOURCE.

If SOURCE is not specified, the current project tree revision is used,  and the project tree is switched to BRANCH

### baz merge

**merge from another branch**

**Usage:** baz merge \[options\] \[FROM\]

  \-c, --changes OUTPUT     Generate but don´t apply the changeset.\
   \-r, --reference VERSION  Set reference version (default: project tree version)\
   \--show-merge-points      Calculate the trees to use for merging, show their ids and exit.\
   \--star-merge             Use the more restrictive star merge algorithm for choosing the common ancestor\
   \--trace                  Trace the selection of the merge points.\
   \--two-way                Perform a 2-way merge.\
   \-t, --three-way          (Deprecated - now default) Perform a 3-way merge.\
   \-d, --dir DIR            Operate on project tree in DIR (default \`.´)\
   \--unescaped              show filenames in unescaped form

Merge changes from FROM into the project tree, considering common ancestry from the project tree reference version, REFERENCE (which defaults to the tree version of the project tree). If FROM is not given, it defaults to the tree revision.

The --star-merge option is for use in situations where the pattern of merges between branches is strictly a star. If you desire standard external rejection hunks, you should use --star-merge --two-way.

By default, merge will perform a three way merge, using any of the ´best´ common ancestors available. When used in a star development model, the results will be the same as with --star-merge. However when used in a mesh model, where teams of developers are collaborating with each other, the chosen common ancestor will be the closest commont text, reducing spurious conflicts.

FROM indicates a revision (it may be specified as a version name, indicating the latest revision in that version).

TREE is the project tree into which the merge will occur.

The mesh or graph algorithm details: merge works by computing the closest common ancestor. This is defined as the common ancestor that is reachable in a minimal number of hops from Both FROM and TREE. When multiple ancestors are reachable in the same number of hops, only ancestors with no children reachable in the same number of hops are chosen. If there are multiple ancestors left to choose from, an arbitrary one is chosen. This is optimised for diff3 merges, use of --two-way is NOT RECOMMENDED without also specifying --star-merge.

The --star-merge option details: Star-merge works by computing the most recent ANCESTOR revision of REFERENCE and FROM and then applying the changeset:

         delta (ANCESTOR, FROM)

to TREE.

The "most recent ancestor" is defined as follows:

MAYBE\_ANCESTOR\_1 is defined as the highest patch level of FROM in REFERENCE for which both TREE and FROM have a patch log. In other words, it is the latest REFERENCE revision of FROM´s version already merged into TREE.

MAYBE\_ANCESTOR\_2 is defined as the highest patch level in REFERENCE for which both FROM and REFERENCE have a patch log.  In other words, it is the latest revision of REFERENCE already merged into FROM.

MAYBE\_ANCESTOR\_2, if it is not "nil", was merged into FROM at some revision of FROM´s version, which we can call LAST\_MERGE\_INTO\_FROM.

If both MAYBE\_ANCESTOR\_1 or MAYBE\_ANCESTOR\_2 are nil, star-merge can do nothing.

If just one of MAYBE\_ANCESTOR\_1 is MAYBE\_ANCESTOR\_2 is not nil, then that non-nil value is ANCESTOR.

If both MAYBE\_ANCESTOR\_1 and MAYBE\_ANCESTOR\_2 are not nil, then LAST\_MERGE\_INTO\_FROM and MAYBE\_ANCESTOR\_1 are compared (both are revisions in FROM´s version). If MAYBE\_ANCESTOR\_1 is the later revision, then MAYBE\_ANCESTOR\_1 is ANCESTOR, otherwise, MAYBE\_ANCESTOR\_2 is ANCESTOR.

### baz update

**update a project tree to reflect recent archived changes**

**Usage:** baz update \[options\] \[version/revision\]

  \-d, --dir DIR    Update project tree in DIR (default \`.´)\
   \--dest DEST      Instead of modifying the project tree in-place,\
                    make a copy of it to DEST and apply the result to that\
   \--unescaped      show filenames in unescaped form

Update a project tree by getting the latest revision of VERSION (or the default version of the project tree) and then applying a patch set of the differences between the project tree and the highest revision with which it is up-to-date.

If the merge involves conflicts, a warning message is printed, and the new project tree will contain ".rej" files.

### baz replay

**apply revision changesets to a project tree**

**Usage:** baz replay \[options\] \[version/revision...\]

  \--list FILE         read a list of patches to apply\
   \--new               replay only new patches\
   \--reverse           reverse the named patch\
   \-d, --dir DIR       Operate on project tree in DIR (default \`.´)\
   \--dest DEST         Instead of modifying the project tree in-place,\
                       make a copy of it to DEST and apply the result to that\
   \--skip-present      skip patches that contain 1 or more patch logs already in this tree\
   \--unescaped         show filenames in unescaped form

The result is formed by applying patches in the latest revision of VERSION (or the default version of the project tree), stopping after the first patch that causes conflicts.  If multiple VERSIONs are specified, they are applied in turn.

If one or more specific REVISIONs (including patch-levels) is specified instead, only those patch sets, and no others, will be applied.

With the --list option, read a list of patches to apply from FILE (- for standard input).  Complete revision names should be listed, one per line.  replay will stop at the first patch in the list that causes a merge conflict, leaving behind files with names of the form:

   ,,replay.conflicts-in --  the name of the patch that caused conflicts

   ,,replay.remaining    --  the list of patches not yet applied

### baz apply-delta

**compute a changeset between any two trees or revisions and apply it to a project tree**

**Usage:** baz apply-delta \[options\] FROM(REVISION\|DIR) TO(REVISION\|DIR)

  \-A, --archive    Override \`my-default-archive´\
   \-q, --quiet      instruct command to be quieter when applying delta\
   \-d, --dir DIR    Operate on project tree in DIR (default \`.´)\
   \-t, --three-way  Perform a 3-way (diff3-style) merge.\
   \--dest DEST      Instead of modifying the project tree in-place,\
                    make a copy of it to DEST and apply the result to that\
   \--unescaped      show filenames in unescaped form

A delta between A and B (both of which may be either a full revision or a project tree) is computed, and then applied to the project tree.

Exit Status Codes:

    0  No conflict during patch\
     1  Conflicts occurred during patch\
     3  Internal Error

### baz missing

**print patches missing from a project tree**

**Usage:** baz missing \[options\] \[version\]

  \-A, --archive       Override \`my-default-archive´\
   \-d, --dir DIR       cd to DIR first\
   \-r, --reverse       sort from newest to oldest\
   \-s, --summary       display a summary of each missing patch\
   \-c, --creator       display the creator of each missing patch\
   \-D, --date          display the date of each missing patch\
   \--unqualified       print unqualified revision names\
   \--skip-present      skip patches that contain 1 or more patch logs already in this tree

Print a list of patches missing in the project tree containing DIR (or the current directory) for VERSION (or the default version. of the project tree).

### baz join-branch

**add a version as an ancestor of a project tree**

**Usage:** baz join-branch \[options\] version

  \-A, --archive    Override \`my-default-archive´\
   \-d, --dir DIR    Operate on project tree in DIR (default \`.´)\
   \--dest DEST      Instead of modifying the project tree in-place,\
                    make a copy of it to DEST and apply the result to that\
   \--unescaped      show filenames in unescaped form

VERSION--base-0 must be a continuation (e.g. tag). The command replays  the changeset for VERSION--base-0 in the project tree, which has the  effect of adding the log for the branch (making the tag an ancestor of  the resulting tree).

### baz sync-tree

**unify a project tree´s patch-log with a given revision**

**Usage:** baz sync-tree \[options\] revision

  \-d, --dir DIR    Operate on project tree in DIR (default \`.´)\
   \--dest DEST      Instead of modifying the project tree in-place,\
                    make a copy of it to DEST and apply the result to that\
   \--unescaped      show filenames in unescaped form

The new project tree is formed by getting the REVISION and adding  all patch-log entries from REVISION.  No actual merging is performed -- only the patch-log is changed.

### baz delta

**compute a changeset (or diff) between any two trees or revisions**

**Usage:** baz delta \[options\] (REVISION\|TREE)-A (REVISION\|TREE)-B \[DESTDIR\]

  \-A, --archive          Override \`my-default-archive´\
   \-q, --quiet            quiet down progress reports while computing changeset\
   \-n, --no-changeset     do not generate a changeset\
   \--diffs                print changeset report with diffs (implies -n)\
   \-p, --show-c-function  Show which C function each change is in.\
   \--unescaped            show filenames in unescaped form

Given (REVISION\|TREE)-A and (REVISION\|TREE)-B, baz will build a changeset that comprises the changes between REVISION-A and REVISION-B

Example:\
   baz delta baz--devo--1.1--patch-6             baz--devo--1.1--patch-8 ,,changes

  Will pull patch-6 and patch-8 from baz--devo--1.1 and compute\
   a changeset, which will be saved in a newly created ,,changes\
   directory. If you would like a report instead,\
   append the --diffs option

## LOCAL CACHE COMMANDS

### baz file-find

**find given version of file**

**Usage:** baz file-find \[options\] file \[revision\]

  \-A, --archive    Override \`my-default-archive´\
   \-N, --new-file   Print missing file as \`/dev/null´\
   \-s, --silent     suppress reasuring messages\
   \--unescaped      show filenames in unescaped form

Print location of file corresponding to FILE in a cached copy of REVISION

The default patch level for a given version is the latest level for which the project tree has a patch.  The default archive and version is as printed by "baz tree-version".

### baz pristines

**list pristine trees in a project tree**

**Usage:** baz pristines \[options\] \[limit\]

  \-d, --dir DIR  cd to DIR first\
   \-r, --reverse  reverse sort order

Print the list of pristine revisions cached in project tree DIR (or the current directory).

### baz add-pristine

**ensure that a project tree has a particular pristine revision**

**Usage:** baz add-pristine \[options\] revision

  \-A, --archive  Override \`my-default-archive´\
   \-d, --dir DIR  cd to DIR first

Extract REVISION from an archive, creating a pristine copy. Store that pristine copy in the current directory´s project tree

### baz find-pristine

**find and print the path to a pristine revision**

**Usage:** baz find-pristine \[options\] revision

  \-A, --archive  Override \`my-default-archive´\
   \-d, --dir DIR  cd to DIR first\
   \-s, --silent   exit status only

Print the location of a pristine copy of the indicated revision

## REVISION LIBRARY COMMANDS

### baz my-revision-library

**print or change your revision library path**

**Usage:** baz my-revision-library \[options\] \[dir\]

  \-e, --errname      specify program name for errors\
   \-d, --delete       unspecify your revision library\
   \-s, --silent       suppress reassuring messages\
   \--search           use the full search path\
   \--add              use the full add path\
   \--search-only      use the search-only path\
   \--add-only         use the add-only path\
   \--first            prepend to the path if setting (default appends)

With no argument, and without -d, print the path to your revision library.

With an argument, record DIR as the path to your revision library in ~/.arch-params/=revision-library

With the option -d (--delete) and no argument, ensure that you do not have a revision library path set in ~/.arch-params.

If no revision library is set, the program exits with status 1, printing an error message unless the -s (--silent) option is given.

### baz library-config

**configure parameters of a revision library**

**Usage:** baz library-config \[options\] library-dir

  \--greedy          make the library greedy\
   \--non-greedy      make the library not greedy\
   \--sparse          make the library sparse\
   \--non-sparse      make the library not sparse

Set/show various parameters for a revision library.

### baz library-find

**find and print the location of a revision in the revision library**

**Usage:** baz library-find \[options\] revision

  \-A, --archive  Override \`my-default-archive´\
   \-e, --errname  specify program name for errors\
   \-s, --silent   suppress reassuring messages

Find REVISION in your revision library and print its path. If the revision is not present, print an error message (unless --silent is specified) and exit with non-0 status.

### baz library-add

**add a revision to the revision library**

**Usage:** baz library-add \[options\] revision

  \-s, --sparse          Don´t fill in gaps in the library.\
   \--non-sparse          Fill in gaps in the library.\
   \-L, --library LIB     specify which library to add to\
   \--for-links PATH      require a lib on the same device as PATH\
   \--unescaped           show filenames in unescaped form

Add REVISION to your revision library.

This command has no effect and exits with status 0 if the indicated revision is already in the library.

### baz library-remove

**remove a revision from the revision library**

**Usage:** baz library-remove \[options\] revision

  \-A, --archive  Override \`my-default-archive´

Remove REVISION from your revision library.

If the revision is not present, print an error message and exit with non-0 status.

### baz library-archives

**list the archives in your revision library**

**Usage:** baz library-archives \[options\]

List all archives with records in the revision library.

### baz library-categories

**list the categories in your revision library**

**Usage:** baz library-categories \[options\] \[archive\]

  \-A, --archive  Override \`my-default-archive´

List all categories within a given archive in the revision library.

### baz library-branches

**list the branches in a library category**

**Usage:** baz library-branches \[options\] \[category\]

  \-A, --archive  Override \`my-default-archive´

List all branches within CATEGORY in the revision library.

### baz library-versions

**list the versions in a library branch**

**Usage:** baz library-versions \[options\] \[branch\]

  \-A, --archive  Override \`my-default-archive´\
   \-r, --reverse  sort from newest to oldest

List all versions within a particular archive/branch with records in the revision library.

### baz library-revisions

**list the revisions in a library version**

**Usage:** baz library-revisions \[options\] \[version\]

  \-A, --archive  Override \`my-default-archive´\
   \-r, --reverse  sort from newest to oldest\
   \-f, --full     list fully qualified names\
   \-s, --summary  print a summary of each patch\
   \-c, --creator  print the creator of each patch\
   \-D, --date     print the date of each patch

List all revisions within a particular archive/version with records in the revision library.

### baz library-log

**output a log message from the revision library**

**Usage:** baz library-log \[options\] revision

  \-A, --archive  Override \`my-default-archive´\
   \-s, --silent   suppress reassuring messages

Print the log message for REVISION from the library.

### baz library-file

**find a file in a revision library**

**Usage:** baz library-file \[options\] file revision

  \-A, --archive  Override \`my-default-archive´\
   \--id           interpret FILE as an inventory id\
   \--this         interpret FILE as a file within a project tree

Find FILE in REVISION in your revision library and print its path. If the revision or file is not present, print an error message and exit with non-0 status.

## CACHE COMMANDS

### baz cache-config

**Print or change your cache settings**

**Usage:** baz cache-config \[options\] \[dir\]

  \-d, --disable  Disable caching, and forget the directory

With no argument, and without -d, print the path to your cache.

With an argument, record DIR as the path to your

With the option -d (--disable) and no argument, disable caching  and forget the cache directory

## PUBLISHED REVISIONS COMMANDS

### baz grab

**grab a published revision**

**Usage:** baz grab \[options\] location

  \--no-pristines      don´t create pristine copies\
   \--link              hardlink files to revision library instead of copying\
   \--library           ensure revisions are in the revision library\
   \--sparse            add library entries sparsely (--link, --library)\
   \-r, --release-id    overwrite ./=RELEASE-ID for this config

Grabs a published revision from LOCATION.

A grab file has the following syntax:

  Archive-Name:     \[the name of the archive\]\
   Archive-Location: \[the location of the archive\]\
   Target-Revision:  \[PACKAGE\|VERSION\|REVISION to get\]\
   Target-Directory: \[optional\]\[The suggested directory to get into\]\
   Target-Config:    \[optional\]\[A configuration to build upon grabbing\]

## MISCELLANEOUS SCRIPTING SUPPORT

### baz parse-package-name

**parse a package name**

**Usage:** baz parse-package-name \[options\] name

  \-A, --archive          Override \`my-default-archive´\
   \-a, --arch             print the archive name\
   \--non-arch             print the non-archive part of the name\
   \-c, --category         print the category name\
   \-b, --branch           print the branch name\
   \-p, --package          print the package name\
   \-v, --vsn              print the version id\
   \--package-version      print the category--branch--version\
   \-l, --lvl              print the patch level\
   \--patch-level          synonym for --lvl

Options -b, -B, -p, -v, and -l cancel each other.

For -b, -v, and -l, just the id string is printed without "--".

For -p, the output is "\<basename\>--\<branch\>".

### baz valid-package-name

**test a package name for validity**

**Usage:** baz valid-package-name \[options\] name

  \-e, --errname      specify program name for errors\
   \--archive          require and explicit archive\
   \--no-archive       prohibit and explicit archive\
   \-c, --category     require a category\
   \-p, --package      require category, permit branch\
   \-v, --vsn          require a version number\
   \-l, --patch-level  require a patch level\
   \--lvl              synonym for --patch-level\
   \-t, --tolerant     tolerate more specific names

Exit with status 0 if PACKAGE is a valid package name, status 1 otherwise.

By default, require a basename or basename plus branch label.

Options -v and -l cancel -b and vice versa.

Option -l implies -v.

If an error name is specified (-e or --errname), then invalid names cause an error message on stdout.  Otherwise, the exit status is the only output.

By default, validation is strict.  For example, -b checks for a valid basename and does not permit a branch label or version number.

With -t, more specific names are permitted.  For example, -b will permit a branch name, version number, and patch level.

### baz escape

**print strings in escaped or unescaped form**

**Usage:** baz escape \[--unescaped\] string

  \--unescaped      show filenames in unescaped form

Using Pika escaping rules.

## ENVIRONMENT

- *EDITOR*

  If $**EDITOR** is set, use its value as the path of the text editor **arch** is to run when asking the user for text input. If unset, log messages must be given on the command line using the \`-L´ parameter or in the file created by \`baz make-log´.

- *HOME*

  User´s home directory, where **arch** looks for *.arch-cache/* and *.arch-params/ .*

- *http\_proxy HTTP\_PROXY*

  If $**http\_proxy** or $**HTTP\_PROXY** is set, **arch** used its value as the URL of the proxy to use for WebDAV accesses. $**http\_proxy** has higher priority than $**HTTP\_PROXY**. If unset, no proxy is used.

- *TMPDIR*

  If $**TMPDIR** is set, **arch** creates temporary files in the given directory. Otherwise, it uses \`/tmp´.

## FILES

- *${HOME}/.arch-cache/*

  Directory where **arch** caches archive data

- *${HOME}/.arch-params/*

  Directory where all the user´s settings are stored.

- *${HOME}/.arch-params/hook*

  Hook script called after every execution of baz.

- *${HOME}/.arch-params/signing/*

  Directory where the commands for signing and checking signatures are stored.

## SEE ALSO

**http://bazaar.canonical.com/,** **http://wiki.gnuarch.org/,** **http://gnuarch.org/**
