Command Line Options

The command-line interface is given below:

ford.py [-h] [-d PROJECT_DIR] [-p PAGE_DIR] [-o OUTPUT_DIR] [-s CSS]
        [--exclude EXCLUDE] [--exclude_dir EXCLUDE_DIR] [-e EXTENSIONS]
        [-m MACRO] [-w] [--no-warn] [-q] [-v] [-V]
        project_file

####PROJECT_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. (default: f90, f95, f03, f08, F90, F95, F03, F08) ####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. ####--no-warn Do not print warnings for every undocumented item encountered. This is the default behaviour. ###-q/--quiet Do not print any description of progress. ###-v/--verbose Print description of progress (default). ####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.