summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorA. Wilcox <AWilcox@Wilcox-Tech.com>2020-05-16 03:49:02 -0500
committerA. Wilcox <AWilcox@Wilcox-Tech.com>2020-05-16 03:49:02 -0500
commitf9ed712f922e6825465b66ea9b1455175ab8fa98 (patch)
treefd3f55315a2278519eff62114dda4921cc9ef52e
parent4ff7b969e61b36c77c16dc22eb46ea9b6ed8c5cd (diff)
downloadhorizon-f9ed712f922e6825465b66ea9b1455175ab8fa98.tar.gz
horizon-f9ed712f922e6825465b66ea9b1455175ab8fa98.tar.bz2
horizon-f9ed712f922e6825465b66ea9b1455175ab8fa98.tar.xz
horizon-f9ed712f922e6825465b66ea9b1455175ab8fa98.zip
owner: Add manual page
-rw-r--r--owner/CMakeLists.txt1
-rw-r--r--owner/owner.132
2 files changed, 33 insertions, 0 deletions
diff --git a/owner/CMakeLists.txt b/owner/CMakeLists.txt
index 05c2d36..c4b59de 100644
--- a/owner/CMakeLists.txt
+++ b/owner/CMakeLists.txt
@@ -4,6 +4,7 @@ set(OWNER_SRCS
add_executable(hscript-printowner ${OWNER_SRCS})
install(TARGETS hscript-printowner DESTINATION bin)
+install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/owner.1 DESTINATION share/man/man1 RENAME hscript-printowner.1)
IF(RSPEC_EXECUTABLE)
add_test(NAME "RSpecOwner"
diff --git a/owner/owner.1 b/owner/owner.1
new file mode 100644
index 0000000..79dc6e2
--- /dev/null
+++ b/owner/owner.1
@@ -0,0 +1,32 @@
+.Dd May 16, 2020
+.Dt HSCRIPT-PRINTOWNER 1
+.Os "Adélie Linux"
+.Sh NAME
+.Nm hscript-printowner
+.Nd print the owner of a file to stdout
+.Sh SYNOPSIS
+.Nm
+.Ar FILE
+.Sh DESCRIPTION
+The
+.Nm
+utility prints the owning user ID of
+.Ar FILE
+to stdout.
+.Sh EXIT STATUS
+.Ex -std
+.Sh EXAMPLES
+The following invocation will print the owner of the root directory:
+.Dl $ hscript-printowner /
+.Sh DIAGNOSTICS
+If an error occurs while trying to access the specified file, the error will
+be printed to stderr.
+.Sh SEE ALSO
+.Xr stat 1 .
+.Sh HISTORY
+The
+.Nm
+utility first appeared in Horizon 0.2.
+.Sh AUTHORS
+.An A. Wilcox
+.Aq awilfox@adelielinux.org