.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "FAI-DEPS 8"
.TH FAI-DEPS 8 2024-02-11 "" ""
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
.Vb 1
\&  fai\-deps \- class dependencies for FAI
.Ve
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  fai\-deps [\-h] [\-\-man] [\-d]
.Ve
.SH ABSTRACT
.IX Header "ABSTRACT"
.Vb 1
\&  implements dependencies between fai classes.
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
fai-deps uses files \f(CW$FAI\fR/class/*.deps to sort the classes in \f(CW$LOGDIR\fR/FAI_CLASSES and define additional ones. While doing so, it retains the original order as much as possible.
.PP
*.deps files may contain class names, separated by whitespace. Comments ( after # or ; ) are ignored
.PP
e.g. you have a class WORDPRESS that depends on the classes VHOST and POSTGRES . VHOST again may depend on WEBSERVER.
So if you want to install the blogging software wordpress, you add a file
.PP
.Vb 1
\&  $FAI/class/WORDPRESS.deps
.Ve
.PP
that contains the words
  VHOST
  POSTGRES
.PP
and a file
  \f(CW$FAI\fR/class/VHOST.deps
.PP
that contains the word
  WEBSERVER
.PP
The order often is important, so this script is taking care of it. The order of the example above would be:
  WEBSERVER VHOST POSTGRES WORDPRESS
.PP
That way, in \f(CW$FAI\fR/scripts/ first the webserver would be configured, then the vhosts, ...
.PP
It removes double entries from FAI_CLASSES and handles circular dependencies[1].
.PP
I do not recommend using circular dependencies, but if you accidentally define them, they will not break your neck. But you'll get a warning ...
.SH ENVIROMENT
.IX Header "ENVIROMENT"
One non-standard perl module is required:
 Graph::Directed;
On debian install libgraph-perl
.PP
The following environment variables are used:
.PP
.Vb 2
\& $LOGDIR  : path to fai temporary files
\& $FAI     : path to fai config space
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.Vb 1
\& https://fai\-project.org
.Ve
.SH AUTHOR
.IX Header "AUTHOR"
.Vb 1
\& Copyright 2008 by Ingo Wichmann <iw@linuxhotel.de>
\&
\& This software ist free software; you can redistribute it and/or modify
\& it unter the same terms as Perl itself.
.Ve