summaryrefslogtreecommitdiffhomepage
path: root/subr.rtl/rtl_fetch_wget.subr
diff options
context:
space:
mode:
authorLucía Andrea Illanes Albornoz <lucia@luciaillanes.de>2023-03-20 19:25:58 +0100
committerLucía Andrea Illanes Albornoz <lucia@luciaillanes.de>2023-03-20 19:26:38 +0100
commit550c1831733f61c4af8e32179dc7df39bcd7a1de (patch)
tree4c438bb98ba691c0547dd1034128b046ffcc75b5 /subr.rtl/rtl_fetch_wget.subr
parent4ad93ea7d03277735a8688943d00645dda4efc94 (diff)
downloadmidipix_build-550c1831733f61c4af8e32179dc7df39bcd7a1de.tar.bz2
midipix_build-550c1831733f61c4af8e32179dc7df39bcd7a1de.tar.xz
Document subr.rtl/*.subr functions, pt. I.
Diffstat (limited to 'subr.rtl/rtl_fetch_wget.subr')
-rw-r--r--subr.rtl/rtl_fetch_wget.subr13
1 files changed, 12 insertions, 1 deletions
diff --git a/subr.rtl/rtl_fetch_wget.subr b/subr.rtl/rtl_fetch_wget.subr
index 1b5946c9..13bc347a 100644
--- a/subr.rtl/rtl_fetch_wget.subr
+++ b/subr.rtl/rtl_fetch_wget.subr
@@ -3,7 +3,18 @@
# set +o errexit -o noglob -o nounset is assumed.
#
-# N.B. URLs ($1) may contain `?' or '&' characters.
+#
+# rtl_fetch_url_wget() - fetch archive file(s) for item
+# @_urls: list of URLs
+# @_sha256sum_src: SHA256SUM digest file to check authenticity of archive file(s) with
+# @_target_dname: target directory namne
+# @_target_fname: target filename
+# @_target_name: target subdirectory name
+# @_mirrors: optional list of mirror base URLs
+#
+# Returns: zero (0) on success, non-zero (>0) on failure
+# N.B. URLs ($1) may contain `?' or '&' characters.
+#
rtl_fetch_url_wget() {
local _rfuw_urls="${1}" _rfuw_sha256sum_src="${2}" _rfuw_target_dname="${3}" \
_rfuw_target_fname="${4}" _rfuw_target_name="${5}" _rfuw_mirrors="${6:-}" \