support file urls

[zpackage] / doc / zpm-fetchurl.8

diff --git a/doc/zpm-fetchurl.8 b/doc/zpm-fetchurl.8
new file mode 100644 (file)
index 0000000..c6f748c
--- /dev/null
+++ b/doc/zpm-fetchurl.8
@@ -0,0 +1,73 @@
+.TH zpm-fetchurl 8 2018-12-09 "ZPM 0.4"
+.SH NAME
+zpm-fetchurl \- download files
+.SH SYNOPSIS
+.B zpm fetchurl
+[
+.B -ISkKr
+]
+[
+.BI -o file
+]
+.I [ url ]
+.SH DESCRIPTION
+\fBzpm-fetchurl\fR downloads files
+.PP
+\fBzpm-fetchurl\fR understands http, https, and file type urls.
+For https, it uses a trust on first use model for ssl certificates, but a more
+common model verifying via root certificates, or no verfication can also be
+used.
+.PP
+While this program can be used directly, it is intended for use by zpm scripts
+for downloading repositories and packages without requiring an external
+dependency.
+.SH OPTIONS
+.TP
+.B \-I
+output the response header only, implies -r
+.TP
+.B \-r
+output the entire response header, including the header
+.TP
+.B \-S
+output the response status code only
+.TP
+.B \-k
+Don't verify any certificates.
+.TP
+.B \-K
+Verify certificates via root certificates.  This is normally the default for
+TLS, but zpm-fetchurl uses a trust on first use policy instead.  Root
+certificates are found by default in /etc/zpm/roots.pem, but the ZPM_ROOTFILE
+environment variable can be used to override this.
+.TP
+.BI \-R " limit"
+set the limit on following redirects, defaults to 50
+.TP
+.BI \-z " path"
+Only download if remote is newer than the file given by path
+.TP
+.BI \-o " path"
+Write the output to the file given by \fIpath\fR.  Output is
+written to stdout by default.
+.TP
+.B \-f
+Fail silently on errors.
+.TP
+.B \-#
+Output a progress bar.
+.SH EXAMPLES
+.TP
+zpm fetchurl -o zpm-0.1.2.zpm https://zoranix.net/repo/packages/zpm-0.1.2.zpm
+.SH EXIT STATUS
+0 on success non zero on failure
+.SH FILES
+/var/lib/zpm/known_hosts
+~/.zpm/known_hosts
+.SH ENVIRONMENT
+ZPM_KNOWNHOSTS
+ZPM_ROOTFILE
+.SH AUTHOR
+Nathan Wagner
+.SH SEE ALSO
+zpm(8)