diff options
| author | Daniel Baumann <mail@daniel-baumann.ch> | 2013-11-04 12:37:33 +0100 |
|---|---|---|
| committer | Daniel Baumann <mail@daniel-baumann.ch> | 2013-11-04 12:37:33 +0100 |
| commit | 35dbb107d0fb6be916a7ed2a70c2e9ea9e7b4e93 (patch) | |
| tree | 9367e6f1fd80867fca0d118dfa70de052238bf90 /manpages/en | |
| parent | e5c72654ec82a5866eb3308034aca2a65e42bdbf (diff) | |
| download | vyos-live-build-35dbb107d0fb6be916a7ed2a70c2e9ea9e7b4e93.tar.gz vyos-live-build-35dbb107d0fb6be916a7ed2a70c2e9ea9e7b4e93.zip | |
Adding program specification to lb_bootstrap_hooks manpage.
Diffstat (limited to 'manpages/en')
| -rw-r--r-- | manpages/en/lb_bootstrap_hooks.1 | 33 |
1 files changed, 27 insertions, 6 deletions
diff --git a/manpages/en/lb_bootstrap_hooks.1 b/manpages/en/lb_bootstrap_hooks.1 index a3ef2d2eb..cff97f9ed 100644 --- a/manpages/en/lb_bootstrap_hooks.1 +++ b/manpages/en/lb_bootstrap_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 bootstrap_hooks\fR command executes hooks after the bootstrap stage. +The \fBlb bootstrap_hooks\fR command executes hook files after the bootstrap stage. + +.SH SPECIFICATION +\fBlb bootstrap_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 bootstrap_hooks\fR automatically when they are executed. +.PP +Hook files must either have the suffix \fB*.hook\fR or \fB*.hook.bootstrap\fR. +.PP +Hook files with the suffix \fB*.hook\fR are executed first, hook files with the suffix \fB*.hook.bootstrap\fR are executed second. +.PP +Hook files are executed in alphanumberical order by \fBlb bootstrap_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 bootstrap_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,13 +45,21 @@ 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.bootstrap\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.bootstrap\fR:" 4 +hook files specific for the bootstrap 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_chroot_hooks\fR(1)" 4 +.IP "\fIlb_bootstrap_hooks\fR(1)" 4 .IP "\fIlb_binary_hooks\fR(1)" 4 .IP "\fIlb_source_hooks\fR(1)" 4 |