.\"Man page for Breezy (brz) .\" .\" Large parts of this file are autogenerated from the output of .\" "brz help commands" .\" "brz help " .\" .ie \n(.g .ds Aq \(aq .el .ds Aq ' .TH brz 1 "2022\-10\-10" "3.3.1.dev" "Breezy" .SH "NAME" brz \- Breezy next\-generation distributed version control .SH "SYNOPSIS" .B "brz" .I "command" [ .I "command_options" ] .br .B "brz" .B "help" .br .B "brz" .B "help" .I "command" .SH "DESCRIPTION" Breezy (or brz) is a distributed version control system that is powerful, friendly, and scalable. Breezy is a fork of the Bazaar version control system. Breezy keeps track of changes to software source code (or similar information); lets you explore who changed it, when, and why; merges concurrent changes; and helps people work together in a team. .SH "COMMAND OVERVIEW" .TP .B "brz add [FILE...]" Add specified files or directories. .TP .B "brz alias [NAME]" Set/unset and display aliases. .TP .B "brz annotate FILENAME" Show the origin of each line in a file. .TP .B "brz bind [LOCATION]" Convert the current branch into a checkout of the supplied branch. .TP .B "brz bisect SUBCOMMAND [ARGS...]" Find an interesting commit using a binary search. .TP .B "brz branch FROM_LOCATION [TO_LOCATION]" Create a new branch that is a copy of an existing branch. .TP .B "brz branches [LOCATION]" List the branches available at the current location. .TP .B "brz break\-lock [LOCATION]" Break a dead lock. .TP .B "brz cat FILENAME" Write the contents of a file as of a given revision to standard output. .TP .B "brz check [PATH]" Validate working tree structure, branch consistency and repository history. .TP .B "brz checkout [BRANCH_LOCATION] [TO_LOCATION]" Create a new checkout of an existing branch. .TP .B "brz clean\-tree" Remove unwanted files from working tree. .TP .B "brz clone FROM_LOCATION [TO_LOCATION]" Clone a control directory. .TP .B "brz commit [SELECTED...]" Commit changes into a new revision. .TP .B "brz config [NAME]" Display, set or remove a configuration option. .TP .B "brz conflicts" List files with conflicts. .TP .B "brz cp [NAMES...]" Copy a file. .TP .B "brz deleted" List files deleted in the working tree. .TP .B "brz diff [FILE...]" Show differences in the working tree, between revisions or branches. .TP .B "brz export DEST [BRANCH_OR_SUBDIR]" Export current or past revision to a destination directory or archive. .TP .B "brz grep PATTERN [PATH...]" Print lines matching PATTERN for specified files and revisions. .TP .B "brz help [TOPIC]" Show help on a command or other topic. .TP .B "brz ignore [NAME_PATTERN...]" Ignore specified files or patterns. .TP .B "brz ignored" List ignored files and the patterns that matched them. .TP .B "brz import SOURCE [TREE]" Import sources from a directory, tarball or zip file .TP .B "brz info [LOCATION]" Show information about a working tree, branch or repository. .TP .B "brz init [LOCATION]" Make a directory into a versioned branch. .TP .B "brz init\-shared\-repository LOCATION" Create a shared repository for branches to share storage space. .TP .B "brz join TREE" Combine a tree into its containing tree. .TP .B "brz launchpad\-login [NAME]" Show or set the Launchpad user ID. .TP .B "brz launchpad\-logout" Unset the Launchpad user ID. .TP .B "brz launchpad\-open [LOCATION]" Open a Launchpad branch page in your web browser. .TP .B "brz link\-tree LOCATION" Hardlink matching files to another tree. .TP .B "brz log [FILE...]" Show historical log for a branch or subset of a branch. .TP .B "brz lp\-find\-proposal" Find the proposal to merge this revision. .TP .B "brz ls [PATH]" List files in a tree. .TP .B "brz merge [LOCATION]" Perform a three\-way merge. .TP .B "brz missing [OTHER_BRANCH]" Show unmerged/unpulled revisions between two branches. .TP .B "brz mkdir DIR..." Create a new versioned directory. .TP .B "brz mv [NAMES...]" Move or rename a file. .TP .B "brz nick [NICKNAME]" Print or set the branch nickname. .TP .B "brz pack [BRANCH_OR_REPO]" Compress the data within a repository. .TP .B "brz patch [FILENAME]" Apply a named patch to the current tree. .TP .B "brz ping LOCATION" Pings a Bazaar smart server. .TP .B "brz plugins" List the installed plugins. .TP .B "brz pull [LOCATION]" Turn this branch into a mirror of another branch. .TP .B "brz push [LOCATION]" Update a mirror of this branch. .TP .B "brz reconcile [BRANCH]" Reconcile brz metadata in a branch. .TP .B "brz reconfigure [LOCATION]" Reconfigure the type of a brz directory. .TP .B "brz remerge [FILE...]" Redo a merge. .TP .B "brz remove [FILE...]" Remove files or directories. .TP .B "brz remove\-branch [LOCATION]" Remove a branch. .TP .B "brz remove\-tree [LOCATION...]" Remove the working tree from a given branch/checkout. .TP .B "brz renames [DIR]" Show list of renamed files. .TP .B "brz resolve [FILE...]" Mark a conflict as resolved. .TP .B "brz revert [FILE...]" Set files in the working tree back to the contents of a previous revision. .TP .B "brz revno [LOCATION]" Show current revision number. .TP .B "brz root [FILENAME]" Show the tree root directory. .TP .B "brz send [SUBMIT_BRANCH] [PUBLIC_BRANCH]" Mail or create a merge\-directive for submitting changes. .TP .B "brz serve" Run the brz server. .TP .B "brz shelve [FILE...]" Temporarily set aside some changes from the current tree. .TP .B "brz sign\-my\-commits [LOCATION] [COMMITTER]" Sign all commits by a given committer. .TP .B "brz split TREE" Split a subdirectory of a tree into a separate tree. .TP .B "brz status [FILE...]" Display status summary. .TP .B "brz switch [TO_LOCATION]" Set the branch of a checkout and update. .TP .B "brz tag [TAG_NAME]" Create, remove or modify a tag naming a revision. .TP .B "brz tags" List tags. .TP .B "brz testament [BRANCH]" Show testament (signing\-form) of a revision. .TP .B "brz unbind" Convert the current checkout into a regular branch. .TP .B "brz uncommit [LOCATION]" Remove the last committed revision. .TP .B "brz unshelve [SHELF_ID]" Restore shelved changes. .TP .B "brz update [DIR]" Update a working tree to a new revision. .TP .B "brz upgrade [URL]" Upgrade a repository, branch or working tree to a newer format. .TP .B "brz verify\-signatures [LOCATION]" Verify all commit signatures. .TP .B "brz version" Show version of brz. .TP .B "brz version\-info [LOCATION]" Show version information about this tree. .TP .B "brz view [FILE...]" Manage filtered views. .TP .B "brz whoami [NAME]" Show or set brz user id. .SH "COMMAND REFERENCE" .SS "brz \-\-help" Alias for "help", see "brz help". .SS "brz \-?" Alias for "help", see "brz help". .SS "brz \-h" Alias for "help", see "brz help". .SS "brz ?" Alias for "help", see "brz help". .SS "brz add [FILE...]" Options: \-\-dry\-run Show what would be done, but don\*(Aqt actually do anything. \-\-file\-ids\-from ARG Lookup file ids from this tree. \-\-help, \-h Show help message. \-\-no\-recurse, \-N Don\*(Aqt recursively add the contents of directories. \-\-quiet, \-q Only display errors and warnings. \-\-usage Show usage message and options. \-\-verbose, \-v Display more information. See also: ignore, remove Add specified files or directories. In non\-recursive mode, all the named items are added, regardless of whether they were previously ignored. A warning is given if any of the named files are already versioned. In recursive mode (the default), files are treated the same way but the behaviour for directories is different. Directories that are already versioned do not give a warning. All directories, whether already versioned or not, are searched for files or subdirectories that are neither versioned or ignored, and these are added. This search proceeds recursively into versioned directories. If no names are given \*(Aq.\*(Aq is assumed. A warning will be printed when nested trees are encountered, unless they are explicitly ignored. Therefore simply saying \*(Aqbrz add\*(Aq will version all files that are currently unknown. Adding a file whose parent directory is not versioned will implicitly add the parent, and so on up to the root. This means you should never need to explicitly add a directory, they\*(Aqll just get added when you add a file in the directory. \-\-dry\-run will show which files would be added, but not actually add them. \-\-file\-ids\-from will try to use the file ids from the supplied path. It looks up ids trying to find a matching parent directory with the same filename, and then by pure path. This option is rarely needed but can be useful when adding the same logical file into two branches that will be merged later (without showing the two different adds as a conflict). It is also useful when merging another project into a subdirectory of this one. Any files matching patterns in the ignore list will not be added unless they are explicitly mentioned. In recursive mode, files larger than the configuration option add.maximum_file_size will be skipped. Named items are never skipped due to file size. .SS "brz alias [NAME]" Options: \-\-help, \-h Show help message. \-\-quiet, \-q Only display errors and warnings. \-\-remove Remove the alias. \-\-usage Show usage message and options. \-\-verbose, \-v Display more information. Set/unset and display aliases. Examples: Show the current aliases: brz alias Show the alias specified for \*(Aqll\*(Aq: brz alias ll Set an alias for \*(Aqll\*(Aq: brz alias ll="log \-\-line \-r\-10..\-1" To remove an alias for \*(Aqll\*(Aq: brz alias \-\-remove ll .SS "brz ann" Alias for "annotate", see "brz annotate". .SS "brz annotate FILENAME" Options: \-\-all Show annotations on all lines. \-\-directory ARG, \-d Branch to operate on, instead of working directory. \-\-help, \-h Show help message. \-\-long Show commit date in annotations. \-\-quiet, \-q Only display errors and warnings. \-\-revision ARG, \-r See "help revisionspec" for details. \-\-show\-ids Show internal object ids. \-\-usage Show usage message and options. \-\-verbose, \-v Display more information. Aliases: ann, blame, praise Show the origin of each line in a file. This prints out the given file with an annotation on the left side indicating which revision, author and date introduced the change. If the origin is the same for a run of consecutive lines, it is shown only at the top, unless the \-\-all option is given. .SS "brz bind [LOCATION]" Options: \-\-directory ARG, \-d Branch to operate on, instead of working directory. \-\-help, \-h Show help message. \-\-quiet, \-q Only display errors and warnings. \-\-usage Show usage message and options. \-\-verbose, \-v Display more information. See also: checkouts, unbind Convert the current branch into a checkout of the supplied branch. If no branch is supplied, rebind to the last bound location. Once converted into a checkout, commits must succeed on the master branch before they will be applied to the local branch. Bound branches use the nickname of its master branch unless it is set locally, in which case binding will update the local nickname to be that of the master. .SS "brz bisect SUBCOMMAND [ARGS...]" Options: \-\-directory ARG, \-d Branch to operate on, instead of working directory. \-\-help, \-h Show help message. \-\-output ARG, \-o Write log to this file. \-\-quiet, \-q Only display errors and warnings. \-\-revision ARG, \-r See "help revisionspec" for details. \-\-usage Show usage message and options. \-\-verbose, \-v Display more information. Find an interesting commit using a binary search. Bisecting, in a nutshell, is a way to find the commit at which some testable change was made, such as the introduction of a bug or feature. By identifying a version which did not have the interesting change and a later version which did, a developer can test for the presence of the change at various points in the history, eventually ending up at the precise commit when the change was first introduced. This command uses subcommands to implement the search, each of which changes the state of the bisection. The subcommands are: brz bisect start Start a bisect, possibly clearing out a previous bisect. brz bisect yes [\-r rev] The specified revision (or the current revision, if not given) has the characteristic we\*(Aqre looking for, brz bisect no [\-r rev] The specified revision (or the current revision, if not given) does not have the characteristic we\*(Aqre looking for, brz bisect move \-r rev Switch to a different revision manually. Use if the bisect algorithm chooses a revision that is not suitable. Try to move as little as possible. brz bisect reset Clear out a bisection in progress. brz bisect log [\-o file] Output a log of the current bisection to standard output, or to the specified file. brz bisect replay Replay a previously\-saved bisect log, forgetting any bisection that might be in progress. brz bisect run