diff options
author | Wolfgang Müller | 2021-05-22 12:54:18 +0200 |
---|---|---|
committer | Wolfgang Müller | 2021-05-22 12:54:18 +0200 |
commit | 8643238ec04da8d0bda46cb06ecd29dc88f9d243 (patch) | |
tree | e43ab9adb83bde8ac2f51a80eabbf91d421f72e8 /git-package.1 | |
parent | b4bcd4e667ae767b3736494b188523a5590b7f26 (diff) | |
download | git-helpers-8643238ec04da8d0bda46cb06ecd29dc88f9d243.tar.gz |
Add git-package(1)
Diffstat (limited to 'git-package.1')
-rw-r--r-- | git-package.1 | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/git-package.1 b/git-package.1 new file mode 100644 index 0000000..ac3e5cf --- /dev/null +++ b/git-package.1 @@ -0,0 +1,53 @@ +.Dd May 22, 2021 +.Dt GIT-PACKAGE 1 +.Os +.Sh NAME +.Nm git-package +.Nd create an archive of a named tree suitable for distribution +.Sh SYNOPSIS +.Nm git package +.Op Fl f Ar format +.Ar tree-ish +.Op Ar path... +.Sh DESCRIPTION +.Nm +creates an archive of a named tree (or specific paths within that tree, if +specified) that is suitable for distribution on the world wide web. +It saves the archive to +.Pa <name>-<tree-ish>.<format> , +where +.Em name +is the title of the repository. +For supported archive formats, see +.Xr git-archive 1 . +A default archive format can be set via +.Xr git-config 1 , +using the +.Em package.format +option. +.Pp +The options are as follows: +.Bl -tag -width Ds +.It Fl f Ar format +The format to archive +.Ar tree-ish +as. +Defaults to +.Em package.format , +or tar.gz if unset. +.El +.Sh SEE ALSO +.Xr git 1 , +.Xr git-archive 1 , +.Xr git-config 1 +.Sh HISTORY +.Nm +was written due to the lack of a convenient tool to create release +archives for distribution. +.Xr git-archive 1 +was considered, but was found to be too burdensome to be deployed regularly. +.Sh AUTHORS +.An -nosplit +.Nm +was written by +.An Wolfgang Müller Aq Mt wolf@oriole.systems . |