summaryrefslogtreecommitdiff
path: root/executor
diff options
context:
space:
mode:
authorA. Wilcox <AWilcox@Wilcox-Tech.com>2020-05-15 03:13:38 -0500
committerA. Wilcox <AWilcox@Wilcox-Tech.com>2020-05-15 03:13:38 -0500
commit4c6116d6a631286816f4981df2a1671c57e722f2 (patch)
tree299ec10bd6910be6014acf63163ab99cf45be249 /executor
parent250e9965add22337c200b4b80dfba4b6ac21bce0 (diff)
downloadhorizon-4c6116d6a631286816f4981df2a1671c57e722f2.tar.gz
horizon-4c6116d6a631286816f4981df2a1671c57e722f2.tar.bz2
horizon-4c6116d6a631286816f4981df2a1671c57e722f2.tar.xz
horizon-4c6116d6a631286816f4981df2a1671c57e722f2.zip
executor: Add manual page
Diffstat (limited to 'executor')
-rw-r--r--executor/CMakeLists.txt1
-rw-r--r--executor/executor.841
2 files changed, 42 insertions, 0 deletions
diff --git a/executor/CMakeLists.txt b/executor/CMakeLists.txt
index dbdcd3b..36ea245 100644
--- a/executor/CMakeLists.txt
+++ b/executor/CMakeLists.txt
@@ -4,3 +4,4 @@ set(EXEC_SRCS
add_executable(hscript-executor ${EXEC_SRCS})
target_link_libraries(hscript-executor hscript)
install(TARGETS hscript-executor DESTINATION bin)
+install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/executor.8 DESTINATION share/man/man8 RENAME hscript-executor.8)
diff --git a/executor/executor.8 b/executor/executor.8
new file mode 100644
index 0000000..3542263
--- /dev/null
+++ b/executor/executor.8
@@ -0,0 +1,41 @@
+.Dd May 15, 2020
+.Dt HSCRIPT-EXECUTOR 8
+.Os "Adélie Linux"
+.Sh NAME
+.Nm hscript-executor
+.Nd install a Linux system based on a HorizonScript
+.Sh SYNOPSIS
+.Nm
+.Sh DESCRIPTION
+The
+.Nm
+utility installs a Linux system to /target on the current system, configured
+as described in a given HorizonScript.
+.Pp
+It is assumed that
+.Xr hscript-fetch 8
+has been run before
+.Nm ,
+as this utility places the desired HorizonScript in the location where
+.Nm
+expects it to be.
+.Sh FILES
+.Bl -ohang -width "/etc/horizon/installfile" -offset indent -compact
+.It Pa /etc/horizon/installfile
+.Nm
+reads
+.Pa /etc/horizon/installfile
+as the HorizonScript to use for configuring the target system.
+.El
+.Sh SEE ALSO
+.Xr hscript 5 ,
+.Xr hscript-fetch 8 ,
+.Xr hscript-simulate 1 ,
+.Xr hscript-validate 1 .
+.Sh HISTORY
+The
+.Nm
+command first appeared in Horizon 0.1.
+.Sh AUTHORS
+.An A. Wilcox
+.Aq awilfox@adelielinux.org