diff options
| author | A. Wilcox <AWilcox@Wilcox-Tech.com> | 2020-05-15 03:35:08 -0500 |
|---|---|---|
| committer | A. Wilcox <AWilcox@Wilcox-Tech.com> | 2020-05-15 03:35:08 -0500 |
| commit | 0ab18042dfdc369751d05b8e6d3c9dce42136244 (patch) | |
| tree | 5d05d9e6de7cc54a92560e9569fc62bd61efefa7 /fetch | |
| parent | 4c6116d6a631286816f4981df2a1671c57e722f2 (diff) | |
| download | horizon-0ab18042dfdc369751d05b8e6d3c9dce42136244.tar.gz horizon-0ab18042dfdc369751d05b8e6d3c9dce42136244.tar.bz2 horizon-0ab18042dfdc369751d05b8e6d3c9dce42136244.tar.xz horizon-0ab18042dfdc369751d05b8e6d3c9dce42136244.zip | |
fetch: Add manual page
Diffstat (limited to 'fetch')
| -rw-r--r-- | fetch/CMakeLists.txt | 1 | ||||
| -rw-r--r-- | fetch/fetch.1 | 67 |
2 files changed, 68 insertions, 0 deletions
diff --git a/fetch/CMakeLists.txt b/fetch/CMakeLists.txt index f9e6f1c..3cb5927 100644 --- a/fetch/CMakeLists.txt +++ b/fetch/CMakeLists.txt @@ -11,6 +11,7 @@ IF(CURL_FOUND) ENDIF(CURL_FOUND) install(TARGETS hscript-fetch DESTINATION bin) +install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/fetch.1 DESTINATION share/man/man1 RENAME hscript-fetch.1) #IF(RSPEC_EXECUTABLE) #add_test(NAME "RSpecFetch" diff --git a/fetch/fetch.1 b/fetch/fetch.1 new file mode 100644 index 0000000..9b97856 --- /dev/null +++ b/fetch/fetch.1 @@ -0,0 +1,67 @@ +.Dd May 15, 2020 +.Dt HSCRIPT-FETCH 1 +.Os "Adélie Linux" +.Sh NAME +.Nm hscript-fetch +.Nd fetch a HorizonScript for further processing +.Sh SYNOPSIS +.Nm +.Ar FILE-OR-URL +.Sh DESCRIPTION +The +.Nm +utility retrieves the HorizonScript from the location specified by +.Ar FILE-OR-URL , +and writes it to the path expected by the +.Xr hscript-executor 8 +utility; presently, +.Pa /etc/horizon/installfile . +.Pp +The single argument, +.Ar FILE-OR-URL , +should specify either an absolute path (one that begins with a /), or a URL. +.Ss Remote script retrieval +If a remote URL is specified, the +.Nm +utility will attempt to download the HorizonScript from it. Supported URL +protocols include HTTP, HTTPS, and TFTP. +.Sh FILES +.Bl -ohang -width "/etc/horizon/installfile" -offset indent -compact +.It Pa /etc/horizon/installfile +.Nm +writes the HorizonScript specified to +.Pa /etc/horizon/installfile . +.Sh EXIT STATUS +.Ex -std +.Sh EXAMPLES +hscript-fetch /media/live/desktop.installfile +.Pp +hscript-fetch https://deploy.company.int/workstation16.installfile +.Sh DIAGNOSTICS +.Bl -diag +.It "%dateT%time log %location: %status: %message[: %extra]" +A message of type +.Cm %status +was logged while processing +.Cm %location . +The log message +.Cm %message +may be followed by additional information or hints in +.Cm %extra . +.El +.Sh SEE ALSO +.Xr hscript 5 . +.Sh HISTORY +The +.Nm +command first appeared in Horizon 0.1. +.Sh AUTHORS +.An A. Wilcox +.Aq awilfox@adelielinux.org +.Sh SECURITY CONSIDERATIONS +The +.Nm +utility supports unencrypted HTTP download. Extreme caution should be +exercised when using unencrypted HTTP downloads, as your system's root +password could be manipulated by a malicious attacker. Please use HTTPS +whenever possible. |