.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "WEBCHECKOUT 1"
.TH WEBCHECKOUT 1 2023-09-11 "perl v5.38.0" webcheckout
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
webcheckout \- check out repositories referenced on a web page
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBwebcheckout\fR [options] url [destdir]
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBwebcheckout\fR downloads an url and parses it, looking for version control
repositories referenced by the page. It checks out each repository into
a subdirectory of the current directory, using whatever VCS program is
appropriate for that repository (git, svn, etc).
.PP
The information about the repositories is embedded in the web page using
the rel=vcs\-* microformat, which is documented at
<https://joeyh.name/rfc/rel\-vcs/>.
.PP
If the optional destdir parameter is specified, VCS programs will be asked
to check out repositories into that directory. If there are multiple
repositories to check out, each will be checked out into a separate
subdirectory of the destdir.
.SH OPTIONS
.IX Header "OPTIONS"
.IP "\-a, \-\-auth" 4
.IX Item "-a, --auth"
Prefer authenticated repositories. By default, webcheckout will use
anonymous repositories when possible. If you have an account that
allows you to use authenticated repositories, you might want to use this
option.
.IP "\-\-no\-act, \-n" 4
.IX Item "--no-act, -n"
Do not actually check anything out, just print out the commands that would
be run to check out the repositories.
.IP "\-\-quiet, \-q" 4
.IX Item "--quiet, -q"
Quiet mode. Do not print out the commands being run. (The VCS commands
may still be noisy however.)
.SH PREREQUISITES
.IX Header "PREREQUISITES"
To use this program you will need lots of VCS programs installed,
obviously. It also depends on the perl LWP and HTML::Parser modules.
.PP
If the perl URI module is installed, webcheckout can heuristically guess
what you mean by partial URLs, such as "kitenet.net/~joey"'
.SH AUTHOR
.IX Header "AUTHOR"
Copyright 2009 Joey Hess <joey@kitenet.net>
.PP
Licensed under the GNU GPL version 2 or higher.
.PP
This program is included in myrepos <https://myrepos.branchable.com/>