.TH mirror 5 "2024-01-01"
.SH NAME
mirror \- file format for listing sources for git repository mirrors
.SH SYNTAX
Each file contains number of lines:
.P
.RS
.RI [ type ]
.I source
.RE
.P
Any leading whitespace is ignored. Lines that begin with
.B #
are ignored. Lines are split into
.I type
and
.I source
using regular shell word splitting mechanism. If first word is not recognized as a
.IR type ,
then it is assumed to be part of the
.I source
and gets prepended to the rest of the line with a single space character as a separator. Because of this behaviour it is
recommended to use an explicit
.I type
if
.I source
contains whitespace.
.SH SUPPORTED TYPES
.I Type
is recognized if it matches any of the following types. If it does not,
.B repo
is assumed.
.SS repo
Repository is mirrored directly from a
.IR source .
The
.I source
must be compatible with
.BR git-clone (1)
command.
.SS gitolite
First,
.I source
is queried assuming gitolite info command is available via SSH. Each repository that user has read permissions to is
then mirrored. Addresses of the repositories are generated by appending
.BI / path
to
.IR source.
The
.I source
must be compatible with both
.BR ssh (1)
and
.BR git-clone (1)
commands.
.SH SEE ALSO
.BR mirror (1),
.BR git-clone (1),
.BR ssh (1)