summaryrefslogtreecommitdiffhomepage
path: root/subr.rtl/rtl_install.subr
diff options
context:
space:
mode:
authorLucía Andrea Illanes Albornoz <lucia@luciaillanes.de>2023-03-20 19:45:45 +0100
committerLucía Andrea Illanes Albornoz <lucia@luciaillanes.de>2023-03-20 19:45:45 +0100
commit131fe2372940b4ef107454e0f1454be7aa08e901 (patch)
tree4a15bee12c7c6e7608cdc3ddbabd161ebca4fdd3 /subr.rtl/rtl_install.subr
parent550c1831733f61c4af8e32179dc7df39bcd7a1de (diff)
downloadmidipix_build-131fe2372940b4ef107454e0f1454be7aa08e901.tar.bz2
midipix_build-131fe2372940b4ef107454e0f1454be7aa08e901.tar.xz
Document subr.rtl/*.subr functions, pt. II.
Diffstat (limited to 'subr.rtl/rtl_install.subr')
-rw-r--r--subr.rtl/rtl_install.subr8
1 files changed, 8 insertions, 0 deletions
diff --git a/subr.rtl/rtl_install.subr b/subr.rtl/rtl_install.subr
index 5273a5ca..a0a9b8d0 100644
--- a/subr.rtl/rtl_install.subr
+++ b/subr.rtl/rtl_install.subr
@@ -3,6 +3,14 @@
# set +o errexit -o noglob -o nounset is assumed.
#
+#
+# rtl_install() - install files
+# @[-v]: increase verbosity
+# @_prefix: installation prefix pathname
+# @...: install operation (one of: -* (remove,) !*=* (move/rename,) /=* (create directory/ies,) @*=* (create/update symbolic link,) m[0-7][0-7][0-7][0-7]=* (set mode bits,) o*=* (set user/group owner,) *=* (copy))
+#
+# Returns: zero (0) on success, non-zero (>0) on failure
+#
rtl_install() {
local _ri_verbose="" _ri_prefix="" \
_ri_chmod_mode="" _ri_dname="" _ri_file_fname_dst="" _ri_file_fname_src="" \