summaryrefslogtreecommitdiff
path: root/manpages/en
diff options
context:
space:
mode:
Diffstat (limited to 'manpages/en')
-rw-r--r--manpages/en/lb_chroot_hooks.131
1 files changed, 26 insertions, 5 deletions
diff --git a/manpages/en/lb_chroot_hooks.1 b/manpages/en/lb_chroot_hooks.1
index 33bd3f24b..6ab570523 100644
--- a/manpages/en/lb_chroot_hooks.1
+++ b/manpages/en/lb_chroot_hooks.1
@@ -21,7 +21,20 @@
.SH DESCRIPTION
live\-build contains the components to build a live system from a configuration directory.
.PP
-The \fBlb chroot_hooks\fR command executes hooks after the chroot stage.
+The \fBlb chroot_hooks\fR command executes hook files after the chroot stage.
+
+.SH SPECIFICATION
+\fBlb chroot_hooks\fR executes any hook files found in the \fBconfig/hooks\fR directory within the configuration directory.
+.PP
+Hook files do not require to have a specific owner nor specific permissions. They are marked executable by \fBlb chroot_hooks\fR automatically when they are executed.
+.PP
+Hook files must either have the suffix \fB*.hook\fR or \fB*.hook.chroot\fR.
+.PP
+Hook files with the suffix \fB*.hook\fR are executed first, hook files with the suffix \fB*.hook.chroot\fR are executed second.
+.PP
+Hook files are executed in alphanumberical order by \fBlb chroot_hooks\fR. If one hook file depends on being run after another, best practise is to use number prefixes (nnnn, starting with 0001) to ensure the order of execution.
+.PP
+Hook files are copied into the \fBchroot/live-build\fR directory by \fBlb chroot_hoooks\fR. They are executed from within the chroot directory (chrooted) and can read the configuration directory in \fB/live-build/config\fR within the chroot directory.
.SH OPTIONS
.IP "\-\-verbose" 4
@@ -32,10 +45,18 @@ show help message and exit.
show program's version number and exit.
.SH FILES
-.IP "\fBconfig/build\fR" 4
-.IP "\fBconfig/hooks/*.hook\fR" 4
-.IP "\fBconfig/hooks/*.hook.chroot\fR" 4
-.IP "\fBchroot\fR" 4
+.IP "\fBconfig/build\fR:" 4
+generic configuration file.
+.IP "\fBconfig/hooks/*.hook\fR:" 4
+generic hook files.
+.IP "\fBconfig/hooks/*.hook.chroot\fR:" 4
+hook files specific for the chroot stage.
+.IP "\fBchroot\fR:" 4
+directory in which the hook files are executed.
+.IP "\fBchroot/live-build/config\fR:" 4
+bind mounted configuration directory within the chroot directory to be read by hook files.
+.IP "\fBchroot/live-build\fR:" 4
+directory in which hook files are copied.
.SH SEE ALSO
.IP "\fIlb_bootstrap_hooks\fR(1)" 4