Adding program specification to lb_binary_hooks manpage.

1 files changed, 29 insertions, 6 deletions

diff --git a/manpages/en/lb_binary_hooks.1 b/manpages/en/lb_binary_hooks.1
index 441350d28..f59633579 100644
--- a/manpages/en/lb_binary_hooks.1
+++ b/manpages/en/lb_binary_hooks.1
@@ -21,7 +21,22 @@
 .SH DESCRIPTION
 live\-build contains the components to build a live system from a configuration directory.
 .PP
-The \fBlb binary_hooks\fR command executes hooks after the binary stage.
+The \fBlb binary_hooks\fR command executes hook files after the binary stage.
+
+.SH SPECIFICATION
+\fBlb binary_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 binary_hooks\fR automatically when they are executed.
+.PP
+Hook files must either have the suffix \fB*.hook\fR or \fB*.hook.binary\fR.
+.PP
+Hook files with the suffix \fB*.hook\fR are executed first, hook files with the suffix \fB*.hook.binary\fR are executed second.
+.PP
+Hook files are executed in alphanumberical order by \fBlb binary_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 \fBbinary/live-build\fR directory by \fBlb binary_hoooks\fR. They are executed from within the binary directory and can read the configuration directory in \fBlive-build/config\fR within the binary directory.
+.PP
+\fBWarning:\fR hook files are not executed within a chroot but within the context of the host system in the binary directory. They have root privileges and access to the all host system ressources (devices, filesystems, network, etc.).
 
 .SH OPTIONS
 .IP "\-\-verbose" 4
@@ -32,15 +47,23 @@ 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.binary\fR" 4
-.IP "\fBbinary\fR" 4
+.IP "\fBconfig/build\fR:" 4
+generic configuration file.
+.IP "\fBconfig/hooks/*.hook\fR:" 4
+generic hook files.
+.IP "\fBconfig/hooks/*.hook.binary\fR:" 4
+hook files specific for the binary stage.
+.IP "\fBbinary\fR:" 4
+directory in which the hook files are executed.
+.IP "\fBbinary/live-build/config\fR:" 4
+bind mounted configuration directory within the binary directory to be read by hook files.
+.IP "\fBbinary/live-build\fR:" 4
+directory in which hook files are copied.
 
 .SH SEE ALSO
 .IP "\fIlb_bootstrap_hooks\fR(1)" 4
 .IP "\fIlb_chroot_hooks\fR(1)" 4
-.IP "\fIlb_source_hooks\fR(1)"
+.IP "\fIlb_source_hooks\fR(1)" 4
 
 .SH HOMEPAGE
 More information about live\-build and the Live Systems project can be found on the homepage at <\fIhttp://live-systems.org/\fR> and in the manual at <\fIhttp://live-systems.org/manual/\fR>.