From: smckown <smckown@986fd584-583e-0410-b54d-b9fe63dff8e5>
Date: Wed, 2 Dec 2009 02:43:01 +0000 (+0000)
Subject: Add man pages for git-local and git-publish-branch.
X-Git-Url: https://oss.titaniummirror.com/gitweb?p=git-utils.git;a=commitdiff_plain;h=4b01965a29349eb340282f32bc37097050ec25b9

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

These can be copied to /usr/local/man/man1 and then used through git, such as:
git publish-branch --help
---

diff --git a/git-local.1 b/git-local.1
new file mode 100644
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)
diff --git a/git-publish-branch.1 b/git-publish-branch.1
new file mode 100644
index 0000000..c16e5d9
--- /dev/null
+++ b/git-publish-branch.1
@@ -0,0 +1,41 @@
+.\"
+.TH "git-publish-branch"
+.SH NAME
+git-publish-branch \- publish a local branch to a remote repository
+
+.SH SYNOPSIS
+\fBgit-publish-branch\fR [-d|-h] [\fIBRANCH\fR] [\fIREPOSITORY\fR]
+
+.SH "DESCRIPTION"
+
+.PP
+\fBgit-publish-branch\fR publishes a local branch to a remote repository.  The
+selected branch is pushed to the remote repository and the local branch is
+reset as a tracking branch for the new remote branch.
+
+If the -d option is specified, the branch is removed from the remote repository
+and the local branch is unset as its tracking branch.
+
+.SH "OPTIONS"
+
+.TP
+-d
+Include this switch to delete (unpublish) a branch.
+
+.TP
+-h
+Display help message.
+
+.TP
+\fIBRANCH\fR
+The branch to publish or unpublish.  If not provided, meaning the repository
+is also not provided, the branch defaults to the one currently checked out.
+
+.TP
+\fIREPOSITORY\fR
+The name of the remote repository.  If not provided, the repository remote
+defaults to origin.
+
+This manual page was written by David Eriksson <twogood@users.sourceforge.net>.
+.SH "SEE ALSO"
+git-branch(1) git-checkout(1) git-remote(1)