Add man pages for git-local and git-publish-branch.

[git-utils.git] / git-local.1

diff --git a/git-local.1 b/git-local.1
new file mode 100644 (file)
index 0000000..3192efb
--- /dev/null
+++ b/git-local.1
@@ -0,0 +1,54 @@
+.\"
+.TH "git-local"
+.SH NAME
+git-local \- Back up and restore local branches to a remote repository
+
+.SH SYNOPSIS
+\fBgit-local\fR [--upload|--download|--remove|--list] [\fIREMOTE\fR] [\fIPREFIX\fR]
+
+.SH "DESCRIPTION"
+
+.PP
+\fBgit-local\fR provides some useful facilities for backing up and restoring
+local branches to a remote repository.  Very useful for allowing users to
+store local branches they normally wouldn't want to publish in a remote repo
+for later retrieval.
+
+.SH "OPTIONS"
+
+.TP
+--upload [\fIREMOTE\fR] [\fIPREFIX\fR]
+Upload all local branches to \fIREMOTE\fR repository with a namespace prefix of
+\fIPREFIX\fR/.
+
+.TP
+--download [\fIREMOTE\fR] [\fIPREFIX\fR]
+Download local branches on \fIREMOTE\fR repository with a namespace prefix of
+\fIPREFIX\fR/.
+
+.TP
+--remove [\fIREMOTE\fR] [\fIPREFIX\fR]
+Removes all branches on \fIREMOTE\fR repository with a namespace prefix of
+\fIPREFIX\fR/.  BE CAREFUL WITH THIS COMMAND!
+
+.TP
+--list [\fIREMOTE\fR] [\fIPREFIX\fR]
+Lists all branches on \fIREMOTE\fR repository with a namespace prefix of
+\fIPREFIX\fR/.
+
+.TP
+\fIREMOTE\fR
+The name of the remote referencing a remote repository.  If not provided,
+meaning that also the \fIPREFIX\fR is also left unprovided, is 'origin'.
+
+.TP
+\fIPREFIX\fR
+The name of the prefix used to reference branches on the remote repository.
+If not provided it defaults to the user's login.  On the remote repository,
+the \fIPREFIX\fR is relative to refs/.  So a prefix of 'bozo' actually
+references
+refs/bozo/.  In this manner, the branches stored by git-local don't show up
+in the common branch name list commands that by default reference refs/heads.
+
+.SH "SEE ALSO"
+git-branch(1) git-checkout(1) git-remote(1)