From a6b3b0f6cbaeb90995f5aa14eca7e27d9ff218e2 Mon Sep 17 00:00:00 2001 From: "A. Wilcox" Date: Sat, 16 May 2020 04:59:53 -0500 Subject: Qt UI: Add manual pages --- ui/qt5/CMakeLists.txt | 3 +++ ui/qt5/horizon-ppc64-detect.1 | 27 +++++++++++++++++++++++++++ ui/qt5/horizon-qt5.1 | 24 ++++++++++++++++++++++++ ui/qt5/horizon-run-qt5.8 | 42 ++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 96 insertions(+) create mode 100644 ui/qt5/horizon-ppc64-detect.1 create mode 100644 ui/qt5/horizon-qt5.1 create mode 100644 ui/qt5/horizon-run-qt5.8 (limited to 'ui') diff --git a/ui/qt5/CMakeLists.txt b/ui/qt5/CMakeLists.txt index 908f8d6..8dbf4a8 100644 --- a/ui/qt5/CMakeLists.txt +++ b/ui/qt5/CMakeLists.txt @@ -69,6 +69,7 @@ IF("cxx_std_17" IN_LIST CMAKE_CXX_COMPILE_FEATURES) ENDIF() install(TARGETS horizon-qt5 DESTINATION bin) +install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/horizon-qt5.1 DESTINATION share/man/man1) IF(INSTALL) pkg_check_modules(XKBFile REQUIRED xkbfile) @@ -82,5 +83,7 @@ IF(INSTALL) set_property(TARGET horizon-run-qt5 PROPERTY CXX_STANDARD 17) ENDIF() install(TARGETS horizon-run-qt5 DESTINATION bin) + install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/horizon-run-qt5.8 DESTINATION share/man/man8) install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/horizon-ppc64-detect DESTINATION bin) + install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/horizon-ppc64-detect.1 DESTINATION share/man/man1) ENDIF(INSTALL) diff --git a/ui/qt5/horizon-ppc64-detect.1 b/ui/qt5/horizon-ppc64-detect.1 new file mode 100644 index 0000000..24cf437 --- /dev/null +++ b/ui/qt5/horizon-ppc64-detect.1 @@ -0,0 +1,27 @@ +.Dd May 16, 2020 +.Dt HORIZON-PPC64-DETECT 1 +.Os "Adélie Linux" +.Sh NAME +.Nm horizon-ppc64-detect +.Nd detect platform characteristics +.Sh SYNOPSIS +.Nm +.Sh DESCRIPTION +The +.Nm +utility determines the platform characteristics of a 64-bit PowerPC computer +for the Horizon installation system. +.Sh FILES +.Bl -tag -width Ds +.It Pa /tmp/horizon-platform +The +.Nm +utility writes the type of platform to +.Pa /tmp/horizon-platform . +.Sh HISTORY +The +.Nm +command first appeared in Horizon 0.9. +.Sh AUTHORS +.An A. Wilcox +.Aq awilfox@adelielinux.org diff --git a/ui/qt5/horizon-qt5.1 b/ui/qt5/horizon-qt5.1 new file mode 100644 index 0000000..ab5dfde --- /dev/null +++ b/ui/qt5/horizon-qt5.1 @@ -0,0 +1,24 @@ +.Dd May 16, 2020 +.Dt HORIZON-QT5 1 +.Os "Adélie Linux" +.Sh NAME +.Nm horizon-qt5 +.Nd create a HorizonScript using a simple user interface +.Sh SYNOPSIS +.Nm +.Sh DESCRIPTION +The +.Nm +utility allows you to create a HorizonScript using a graphical user interface. +.Sh SEE ALSO +.Xr hscript-validate 1 , +.Xr hscript 5 , +.Xr hscript-executor 8 , +.Xr horizon-run-qt5 8 . +.Sh HISTORY +The +.Nm +utility first appeared in Horizon 0.9. +.Sh AUTHORS +.An A. Wilcox +.Aq awilfox@adelielinux.org diff --git a/ui/qt5/horizon-run-qt5.8 b/ui/qt5/horizon-run-qt5.8 new file mode 100644 index 0000000..da9a7c6 --- /dev/null +++ b/ui/qt5/horizon-run-qt5.8 @@ -0,0 +1,42 @@ +.Dd May 16, 2020 +.Dt HORIZON-RUN-QT5 8 +.Os "Adélie Linux" +.Sh NAME +.Nm horizon-run-qt5 +.Nd execute a HorizonScript with visual progress indication +.Sh SYNOPSIS +.Nm +.Op Fl hv +.Op Fl -automatic +.Sh DESCRIPTION +The +.Nm +utility executes the HorizonScript located at +.Pa /etc/horizon/installfile , +and displays a graphical indication of execution progress. This tool is +used internally by the Horizon Qt 5 UI system. It is additionally used +for unattended installations when graphical progress is requested by the +system administrator. +.Pp +If the +.Fl -automatic +flag is passed to the +.Nm +utility, the system will be automatically rebooted after installation +completes. +.Sh FILES +.Bl -tag -width Ds +.It Pa /etc/horizon/installfile +The +.Nm +utility executes the HorizonScript at +.Pa /etc/horizon/installfile . +.Sh SEE ALSO +.Xr hscript-executor 8 . +.Sh HISTORY +The +.Nm +utility first appeared in Horizon 0.9. +.Sh AUTHORS +.An A. Wilcox +.Aq awilfox@adelielinux.org -- cgit v1.2.3-60-g2f50