=head1 NAME

B<wwvnfs>

=head1 DESCRIPTION

B<wwvnfs> is a tool to help with management of the Warewulf Virtual Node File
Systems (VNFS). Warewulf uses the VNFS as a template for all node images.

=head1 OPTIONS

=over 4

=item B<--vnfs> string

This defines which VNFS you want to operate on. Any of the selected VNFS
images must be defined in the master's "vnfs dir" (default is /vnfs), as a
directory of the same name as 'string'.

If option is not given, "default" is assumed.

=item B<--build>

Turn the VNFS directory (chroot file system) into the network accessiable
image for your nodes. This will update as well as create.

=item B<--excludes> /path/to/excludes/file

Path to the excludes file that you wish to use for the VNFS build. The
excludes file specifies all of the files which should not be included in the
final node file system but are in the VNFS chroot directory (forinstance,
documentation, logs, locales, etc..).

The default is to use /etc/warewulf/vnfs/excludes which just specifies some of
the base, non risky things to include.

This command will search for the file in the following order: specified path,
/etc/warewulf/vnfs/, /etc/warewulf/vnfs/excludes-

=item B<--hybrid>

Warewulf has the capability of creating hybrid RAMDISK/NFS file systems. The
bennefits are that the commonly used libraries programs and files are
accessiably quicly from RAM, and the less commonly used files are accessiable
over NFS.

This option creates symlinks from the highest possiable points in your RAMDISK
file system to an autoconfigured VNFS mount point (automatically mounted via
NFS).

=item B<--includes>

A list of files (no globs or directories allowed) that exsist on the master's
file system (outside of the VNFS directory) that should be included in the
nodes VNFS image.

The default is to use /etc/warewulf/vnfs/includes which specifies some default
files to include for several types of systems.

This command will search for the file in the following order: specified path,
/etc/warewulf/vnfs/, /etc/warewulf/vnfs/includes-

=item B<--shell>

You would like to start a shell inside the VNFS directory as if that was the
host system (ie. chroot). 

If this command is called with the --build option, then you will get a shell 
in the temporary VNFS file system after all other actions have been done (ie. 
excludes, includes, symlinks, etc...). This is very useful for testing
changes, or seeing how things will look on the node before you boot a node on
that image.

=item B<--quiet>

Only output necessary or impoartant information.

=item B<--help>

Show the help screen.

=back

=head1 EXAMPLES

=over 4

=item B<wwvnfs --build>

Build a node image from the default VNFS image.

=item B<wwvnfs --vnfs test1 --build --excludes \
/etc/warewulf/vnfs/excludes-aggressive>

Build a node image for the VNFS "test1", but make it as small as possiable by 
using the aggressive excludes file.

=item B<wwvnfs --hybrid --build --excludes \
/etc/warewulf/vnfs/excludes-aggressive>

Build the image, make it small as possiable, but activate RAMDISK/NFS
hybridization.

=head1 AUTHORS

B<Warewulf> is written and maintained by Greg M. Kurtzer <gmk@lbl.gov>, and
hosted by Lawrence Berkeley National Labratory (http://www.lbl.gov).

http://warewulf-cluster.org/
