git-wad

commit fceefec9b30a8df85d2dd5a8d9e83bb8cdd0ed07
parent be12d62fcb5c1f4723a71951307aa0b0a2d00886
Author: Vincent Forest <vincent.forest@meso-star.com>
Date:   Sun,  7 Apr 2024 19:00:47 +0200

Proof reading of the man page

Several small changes. Specifically, we're using URLs instead of URIs
throughout the manual, since what we're using are actually URLs and not
just URIs. We also insist on calling "git-wad init" in the working tree
before any other git-wad subcommand.

Diffstat:
M
git-wad.1
 | 
27
++++++++++++++++-----------

1 file changed, 16 insertions(+), 11 deletions(-)
diff --git a/git-wad.1 b/git-wad.1
@@ -71,7 +71,7 @@ been transferred locally
 .Pq see Cm fetch .
 .It Cm fetch
 Transfers WAD file contents locally.
-The URI of the WAD repository from which data will be transferred is
+The URL of the WAD repository from which data will be transferred is
 defined by the
 .Ev GIT_WAD_REMOTE_FETCH
 environment variable.
@@ -81,7 +81,7 @@ history.
 The options are as follows:
 .Bl  -tag -width Ds
 .It Fl 1
-Transfers only WAD file data for the HEAD not its history, i.e. it
+Transfers only WAD file data for the HEAD, not its history, i.e. it
 transfers neither their previous version nor the contents of WAD files
 that are no longer referenced.
 .It Fl a
@@ -90,6 +90,9 @@ repository history, i.e. in all commits of all branches.
 .El
 .It Cm init
 Configures the git repository for WAD file management.
+Must be called in the working tree before any other
+.Nm
+command.
 .It Cm prune
 Removes non-referenced WAD file data from local storage.
 By default, local data is retained for WAD files in the HEAD history.
@@ -117,11 +120,11 @@ and
 subcommands.
 See
 .Cm fetch
-for the URI of the WAD repository from which WAD data is transferred and
+for the URL of the WAD repository from which WAD data is transferred and
 a list of available options.
 .It Cm push
 Transfers data from WAD files to the remote WAD repository.
-The remote URI is defined by the
+The remote URL is defined by the
 .Ev GIT_WAD_REMOTE_PUSH
 environment variable.
 The default setting is to transfer WAD file data for the entire HEAD
@@ -130,12 +133,12 @@ history.
 The options are as follows:
 .Bl  -tag -width Ds
 .It Fl 1
-Transfers only WAD file data for the HEAD not its history, i.e. it
+Transfers only WAD file data for the HEAD, not its history, i.e. it
 transfers neither their previous version nor the contents of WAD files
 that are no longer referenced.
 .It Fl a
 Transfers all versions of WAD files referenced in the complete
-repository history, i.e. in all commits of all branches.
+repository history, i.e. in all commits of all branches store locally.
 .El
 .It Cm status
 Displays resolved, unrestored and orphaned WAD files for the current
@@ -160,14 +163,14 @@ subcommand and affect the reported number of WAD file data to remove.
 .Sh ENVIRONMENT
 .Bl -tag -width Ds
 .It Ev GIT_WAD_REMOTE_FETCH
-URI of the remote repository
+URL of the remote repository
 .Em from
 which WAD file data is transfered.
 By default, this is the fetch URL of the
 .Li origin
 git repository.
 .It Ev GIT_WAD_REMOTE_PUSH
-URI of the remote repository
+URL of the remote repository
 .Em to
 which WAD file data is transfered.
 By default, this is the push URL of the
@@ -188,8 +191,8 @@ section
 This is a shell script whose syntax must respect the POSIX shell.
 Here's an example of how to define an SSH remote:
 .Bd -literal -offset Ds
-GIT_WAD_REMOTE_FETCH="user@remote:repo-wad.git"
-GIT_WAD_REMOTE_PUSH="user@remote:repo-wad.git"
+GIT_WAD_REMOTE_FETCH="user@remote:repo_wad"
+GIT_WAD_REMOTE_PUSH="user@remote:repo_wad"
 .Ed
 .It Pa .gitattributes
 Regular
@@ -214,7 +217,9 @@ test.png filter=wad
 .Sh EXIT STATUS
 .Ex -std
 .Sh EXAMPLES
-Use git-wad to archive pdf files of a git repository:
+Use
+.Nm
+to archive pdf files of a git repository:
 .Bd -literal -offset Ds
 cd /path/to/git/repository
 git wad init