commit 93f7b916ace0efd549b6ba338a54211e6ec08bc5
parent cc8fd7631c319ab83092124be1486b60262c27f7
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Sun, 18 Feb 2024 18:46:11 +0100
Start writing the manual page
Currently, only the beginning is written, i.e. the name, the synposis
and the description.
Diffstat:
| M | Makefile | | | 1 | + |
| A | git-wad.1 | | | 55 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
2 files changed, 56 insertions(+), 0 deletions(-)
diff --git a/Makefile b/Makefile
@@ -31,3 +31,4 @@ uninstall:
lint:
shellcheck -o all git-wad
+ mandoc -Wbase -Tlint git-wad.1
diff --git a/git-wad.1 b/git-wad.1
@@ -0,0 +1,55 @@
+.\" Copyright (C) 2023, 2024 |Méso|Star> (contact@meso-star.com)
+.\"
+.\" This program is free software: you can redistribute it and/or modify
+.\" it under the terms of the GNU General Public License as published by
+.\" the Free Software Foundation, either version 3 of the License, or
+.\" (at your option) any later version.
+.\"
+.\" This program is distributed in the hope that it will be useful,
+.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+.\" GNU General Public License for more details.
+.\"
+.\" You should have received a copy of the GNU General Public License
+.\" along with this program. If not, see <http://www.gnu.org/licenses/>.
+.Dd February 18, 2024
+.Dt GIT-WAD 1
+.Os
+.Sh NAME
+.Nm git-wad
+.Nd manage files with git, but not their content
+.Sh SYNOPSIS
+.Nm
+.Cm checkout
+.Nm
+.Cm fetch Op Fl -all
+.Nm
+.Cm init
+.Nm
+.Cm prune Op Fl -all
+.Nm
+.Cm pull Op Fl -all
+.Nm
+.Cm push Op Fl -all
+.Nm
+.Cm status Op Fl -all
+.Sh DESCRIPTION
+.Nm
+allows files to be managed via git(1) without git managing their
+content.
+git then only archives the fingerprints of these files, here called WAD
+files.
+These fingerprints are used both to differentiate between different
+versions of a WAD file and as pointers to its data.
+The latter can be archived elsewhere than on the git repository that
+manages their fingerprint, and are accessible via a potentially distinct
+protocol.
+.Pp
+Even without tracking their content, being able to follow and
+historicize files in git makes it possible to manage the consistency of
+a source tree with the third-party files needed for the project, all at
+once.
+Third-party files whose full management by git would raise problems of
+memory occupation, disk space or checking times.
+.Sh SEE ALSO
+.Xr git 1
