1 .\"
2 .\" Copyright (c) 2023 Benjamin Stürz
3 .\"
4 .\" Permission to use, copy, modify, and distribute this software for any
5 .\" purpose with or without fee is hereby granted, provided that the above
6 .\" copyright notice and this permission notice appear in all copies.
7 .\"
8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15 .\"
16 .Dd $Mdocdate$
17 .Dt GOT-ARCHIVE 1
18 .Os
19 .Sh NAME
20 .Nm got-archive
21 .Nd git-archive(1) clone for got-archive(1)
22 .Sh SYNOPSIS
23 .Nm got-archive
24 .Op Fl sV
25 .Op Fl b Ar branch/tag
26 .Op Fl o Ar outdir
27 .Op Fl t Ar tmpdir
28 .Ar repo
29 .Sh DESCRIPTION
30 .Nm
31 is a small helper script for got(1) useful for creating tarballs of repositories.
32 .Pp
33 The options are as follows:
34 .Bl -tag -width -Ds
35 .Ar branch/tag .
36 .It Fl b Ar branch/tag
37 Specify a branch or tag.
38 By default, the default branch of the repository is selected (eg. master or main).
39 .It Fl o Ar outdir
40 An existing directory in which the tarball will be created.
41 By default, this will be the current working directory.
42 .It Fl s
43 Strip a preceding "v" from the
44 .Ar branch/tag .
45 .It Fl t Ar tmpdir
46 A temporary directory used for the checkout.
47 By default, this will be
48 .Ar /tmp/got-archive .
49 .It Fl V
50 Print the version of got-archive(1) and exit.
51 .Sh EXIT STATUS
52 .Ex -std got-archive
53 .Sh EXAMPLES
54 Create a tarball for
55 .Pa /var/git/example.git .
56 .Pp
57 .Dl $ got-archive /var/git/example.git
58 .Pp
59 Create a tarball for tag v1.0 of
60 .Pa /var/git/example.git
61 and put the resulting
62 .Pa example-1.0.tgz
63 into
64 .Pa /mnt .
65 .Pp
66 .Dl $ got-archive -s -b v1.0 -o /mnt /var/git/example.git
67 .Sh SEE ALSO
68 .Xr got 1 ,
69 .Xr tar 1
70 .Sh AUTHORS
71 .An Benjamin Stürz Aq Mt benni@stuerz.xyz