diff options
| author | Daniel Baumann <mail@daniel-baumann.ch> | 2013-11-04 12:26:39 +0100 |
|---|---|---|
| committer | Daniel Baumann <mail@daniel-baumann.ch> | 2013-11-04 12:26:39 +0100 |
| commit | f5b825ee3c0366c812f833f524f270e5920c7523 (patch) | |
| tree | 76b4f0e823632d2b6a89dbec4557e661240417b3 /manpages/en | |
| parent | e00df1684bcb8f3634afe07e12852cab28656b30 (diff) | |
| download | vyos-live-build-f5b825ee3c0366c812f833f524f270e5920c7523.tar.gz vyos-live-build-f5b825ee3c0366c812f833f524f270e5920c7523.zip | |
Adding program specification to lb_source_hooks manpage.
Diffstat (limited to 'manpages/en')
| -rw-r--r-- | manpages/en/lb_source_hooks.1 | 33 |
1 files changed, 28 insertions, 5 deletions
diff --git a/manpages/en/lb_source_hooks.1 b/manpages/en/lb_source_hooks.1 index 1f768893e..64bbad887 100644 --- a/manpages/en/lb_source_hooks.1 +++ b/manpages/en/lb_source_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 source_hooks\fR command executes hooks after the source stage. +The \fBlb source_hooks\fR command executes hook files after the source stage. + +.SH SPECIFICATION +\fBlb source_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 source_hooks\fR automatically when they are executed. +.PP +Hook files must either have the suffix \fB*.hook\fR or \fB*.hook.source\fR. +.PP +Hook files with the suffix \fB*.hook\fR are executed first, hook files with the suffix \fB*.hook.source\fR are executed second. +.PP +Hook files are executed in alphanumberical order by \fBlb source_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 \fBsource/live-build\fR directory by \fBlb source_hoooks\fR. They are executed from within the source directory and can read the configuration directory in \fBlive-build/config\fR within the source directory. +.PP +\fBWarning:\fR hook files are not executed within a chroot but within the context of the host system in the source directory. They have root privileges and access to the all host system ressources (devices, filesystems, network, etc.). .SH OPTIONS .IP "\-\-verbose" 4 @@ -32,10 +47,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.source\fR" 4 -.IP "\fBsource\fR" 4 +.IP "\fBconfig/build\fR:" 4 +generic configuration file. +.IP "\fBconfig/hooks/*.hook\fR:" 4 +generic hook files. +.IP "\fBconfig/hooks/*.hook.source\fR:" 4 +hook files specific for the source stage. +.IP "\fBsource\fR:" 4 +directory in which the hook files are executed. +.IP "\fBsource/live-build/config\fR:" 4 +bind mounted configuration directory within the source directory to be read by hook files. +.IP "\fBsource/live-build\fR:" 4 +directory in which hook files are copied. .SH SEE ALSO .IP "\fIlb_bootstrap_hooks\fR(1)" 4 |