manuals, sum-down, radix

1 files changed, 44 insertions, 0 deletions

diff --git a/man/man1/clone.1 b/man/man1/clone.1
new file mode 100644
index 0000000..5801940
--- /dev/null
+++ b/man/man1/clone.1
@@ -0,0 +1,44 @@
+.TH clone 1 2022-06-03 utils
+
+.SH NAME
+clone \- clone a git repository
+
+.SH SYNOPSIS
+.B clone
+.RI [ url | arg\ ... ]
+
+.SH DESCRIPTION
+.B clone
+is a wrapper around
+.BR git\-clone (1)
+that, instead of cloning to the current directory,
+creates the cloned repositories into the
+.IR $HOME / src
+directory,
+prefixing the host name and directory of each origin.
+
+This is similar to the way the go language handles remote dependencies.
+
+It makes it easy to keep sources organised and consistent,
+as long as you don't need to keep track of merge request across different remote repositories, which may well be the case.
+But as
+.BR git (1)
+only deems one remote to be the origin,
+that would be reflected in the src directory tree.
+(Until you change the origin or move the work tree.)
+
+For convenience, the options
+.I \-\-verbose
+and
+.I \-\-progress
+are passed by default.
+Any parameter that does not start with
+"http" or "git@" is passed to
+.BR git\-clone (1)
+as a further parameter.
+
+.SH EXAMPLES
+.B clone https://git.tree-board.net/utils
+
+.SH SEE ALSO
+.BR git (1),\  git-clone (1)