http.download: move download words to their own vocabulary

[factor.git] / basis / http / download / download-docs.factor

diff --git a/basis/http/download/download-docs.factor b/basis/http/download/download-docs.factor
new file mode 100644 (file)
index 0000000..72dc7b2
--- /dev/null
+++ b/basis/http/download/download-docs.factor
@@ -0,0 +1,28 @@
+! Copyright (C) 2024 Doug Coleman.
+! See https://factorcode.org/license.txt for BSD license.
+USING: calendar help.markup help.syntax io.pathnames kernel math
+strings urls ;
+IN: http.download
+
+HELP: download
+{ $values { "url" { $or url string } } { "path" "a pathname string" } }
+{ $description "Downloads the contents of the URL to a file in the " { $link current-directory } " having the same file name and returns the pathname." }
+{ $errors "Throws an error if the HTTP request fails." } ;
+
+HELP: download-to
+{ $values { "url" { $or url string } } { "file" "a pathname string" } { "path" "a pathname string" } }
+{ $description "Downloads the contents of the URL to a file with the given pathname and returns the pathname." }
+{ $errors "Throws an error if the HTTP request fails." } ;
+
+
+ARTICLE: "http.download" "HTTP Download Utilities"
+"The " { $vocab-link "http.download" } " vocabulary provides utilities for downloading files from the web."
+
+"Utilities to retrieve a " { $link url } " and save the contents to a file:"
+{ $subsections
+    download
+    download-to
+}
+;
+
+ABOUT: "http.download"