Command Line Options

The command-line interface is given below:

usage: ford [-h] [-d SRC_DIR] [-p PAGE_DIR] [-o OUTPUT_DIR] [-s CSS]
            [--exclude EXCLUDE] [--exclude_dir EXCLUDE_DIR] [-e EXTENSIONS]
            [-m MACRO] [-w] [--no-search] [-q] [-V] [--debug] [-I INCLUDE]
            project_file

####SRC_DIR The directory where the source-files are to be found for this project. This must not be a subdirectory of the OUTPUT_DIR (see below). This option may be repeated to specify multiple project directories. (default: ./src) ####PAGE_DIR A directory containing markdown files to be processed into individuals pages within the documentation. See Writing Pages for details. ####OUTPUT_DIR The directory where the project output will be placed. Any content already present there will be deleted. (default: ./doc) ####CSS The path to a custom style-sheet which can be used to modify the appearance of the output. ####EXCLUDE A source file which should not be docuemnted. Provide only the file-name, not the full path. This option may be repeated to specify multiple files to be excluded. ####EXCLUDE_DIR A directory whose contents should not be documented. Provide only the directory-name, not the full path. This option may be repeated to specify multiple files to be excluded. ####EXTENSIONS File extensions which will be read by FORD for documentation. This option may be repeated to specify multiple extensions. These extensions are only for free-form code. Extensions for fixed-form code may be specified in the project file. (default: f90, f95, f03, f08, f15, F90, F95, F03, F08, F15) ####INCLUDE Directory in which to search for include files, used either by the preprocessor or Fortran's intrinsic include function. This option may be repeated to specify multiple include directories. ####MACRO Macros of the form mac-name or mac-name=mac-value to be used when preprocessing files. This option may be repeated to specify multiple macros. ####-w/--warn Print warnings for every undocumented item encountered. ####-q/--quiet Do not print any description of progress. ####--no-search Do not create the search feature in the documentation. As creating this is time-consuming, it may be useful to turn it off if your project is large. ####--debug Allows FORD to crash and display a Python backtrace if an error is encountered when parsing a file. ####project_file The file containing a description of your project and various settings for FORD.

---

Settings specified at the command-line will override those specified in the project file.