NAME

       foamHelp - part of OpenFOAM (The Open Source CFD Toolbox).

SYNOPSIS

       foamHelp [OPTIONS] tool

DESCRIPTION

       Valid <tool> options include:
           boundary
           functionObject
           solver

       NOTE the <tool> must actually appear *before* any options

ARGUMENTS

       tool

OPTIONS

       -case dir
              Specify case directory to use (instead of the cwd)

       -decomposeParDict file
              Use specified file for decomposePar dictionary

       -noFunctionObjects
              Do not execute function objects

       -parallel
              Run in parallel [Parallel option]

       -region name
              Specify alternative mesh region

       -doc   Display documentation in browser

       -help  Display short help and exit

       -help-full
              Display full help and exit

   ADVANCED OPTIONS
       -fileHandler handler
              Override the file handler type

       -hostRoots ((host1 dir1) .. (hostN dirN))
              Per-host  slave  root  directories for distributed running. The host specification can be a regex.
              [Parallel option]

       -roots (dir1 .. dirN)
              Slave root directories for distributed running [Parallel option]

       -doc-source
              Display source code in browser

       -help-man
              Display full help (manpage format) and exit

       -help-notes
              Display help notes (description) and exit

SEE ALSO

       Online documentation https://www.openfoam.com/documentation/

COPYRIGHT

       Copyright © 2018-2019 OpenCFD Ltd.

www.openfoam.com                                    OpenFOAM-                                        FOAMHELP(1)