'\" t
.\"     Title: aurpublish
.\"    Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 03/18/2024
.\"    Manual: \ \&
.\"    Source: \ \&
.\"  Language: English
.\"
.TH "AURPUBLISH" "1" "03/18/2024" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
aurpublish \- PKGBUILD management framework for the Arch User Repository
.SH "SYNOPSIS"
.sp
\fIaurpublish\fR [options] PACKAGE
.sp
\fIaurpublish\fR log [<options>] PACKAGE
.sp
\fIaurpublish\fR setup
.SH "DESCRIPTION"
.sp
Aurpublish is an utility which helps maintainers of aur packages to submit updates\&.
.SH "HOW IT WORKS"
.sp
Commit PKGBUILDs in named subdirectories\&. Export them to the AUR with the aurpublish command, using the subtree push stratagem\&. This preserves an independent history for third\-party hosting, pull requests\&... ;)
.SH "COMMANDS"
.PP
\fBsetup\fR
.RS 4
Initialize a new repository with git hooks\&.
.RE
.PP
\fBlog\fR <PACKAGE>
.RS 4
View the git log of a package subtree\&.
.RE
.SH "OPTIONS"
.PP
\fB\-p\fR <PACKAGE>
.RS 4
Instead of publishing, pull changes from the AUR\&. Can import packages into a new subtree\&.
.RE
.PP
\fB\-s\fR, \fB\-\-speedup\fR <PACKAGE>
.RS 4
Speedup future publishing by recording the subtree history during a push\&. This creates a merge commit and a second copy of all commits in the subtree\&. For more details, see the "\-\-rejoin" option in
\fBgit-subtree\fR(1)\&.
.RE
.PP
\fB\-u\fR, \fB\-\-url\fR <URL>
.RS 4
Specify the URL of the server that should be used for git operations\&.
.RE
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
Prints a usage page\&.
.RE
.SH "HOOKS"
.PP
\fBpre\-commit\fR
.RS 4
Warn about whitespace errors, fail if checksums don\(cqt match, and auto\-generate \&.SRCINFO for all changed PKGBUILDs\&.
.RE
.PP
\fBprepare\-commit\-msg\fR
.RS 4
Prefill the commit message with a list of added/updated/deleted packages + versions (if any)\&.
.RE
.SH "SPECIFYING AUR SERVER URL"
.sp
You can use aurpublish to interact with a git server other than the default AUR git server at aur\&.archlinux\&.org\&. This may be useful if you are running your own AUR server\&.
.sp
The upstream git server URL can be configured in two ways\&. You can set the URL with the \-u/\-\-url options when you run aurpublish\&. Or you can configure the server persistently in git by setting the aurpublish\&.remoteUrl option\&.
.PP
Set the URL with \-\-url
.RS 4
aurpublish \-\-url ssh://me@example\&.com mypackage
.RE
.PP
Set the URL for the current git directory with git config
.RS 4
git config aurpublish\&.remoteUrl ssh://me@example\&.com
.RE
.PP
Set the URL globally with git config
.RS 4
git config \-\-global aurpublish\&.remoteUrl ssh://me@example\&.com
.RE
.sp
For more details on git options see \fBgit-config\fR(1)\&.
.SH "EXAMPLES"
.PP
aurpublish setup
.RS 4
Initialize a new repository with git hooks\&. Refer to Hooks section for more info\&.
.RE
.PP
aurpublish \-p ansible\-core\-git
.RS 4
Clone existing package from aur and add its url as a git subtree to the currently existing git repository\&.
.RE
.PP
aurpublish ansible\-core\-git
.RS 4
Push an existing subtree to AUR\&.
.RE
.PP
aurpublish log
.RS 4
View the git log of a package subtree\&.
.RE
.PP
aurpublish \-\-url ssh://me@example\&.com ansible\-core\-git
.RS 4
Push the subtree to a server at ssh://example\&.com\&.
.RE
.SH "AUTHORS"
.sp
Eli Schwartz <eschwartz@archlinux\&.org>