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