Arguments and options for the dita command
The dita command takes mandatory arguments to process DITA content, manage plug-ins, or print information about the command. Options can be used to modify the command behavior or specify additional configuration parameters.
Usage
Arguments
- -i, -input file
- Specifies the master file for your documentation project. Typically this is a DITA map, however it also can be a DITA topic if you want to transform a single DITA file. The path can be absolute, relative to args.input.dir, or relative to the current directory if args.input.dir is not defined.
- -f, -format name
- Specifies the output format (transformation type).
- -install filename
- -install URL
- Install a single plug-in from a local ZIP file or from a URL.
- -install
- If no filename or URL argument is provided, the installation process reloads plug-ins from the plugins directory. This approach can be used to install multiple plug-ins at once, or install any individual plug-ins you have already copied to the plugins directory.
- -uninstall id
- Uninstall a plug-in with the specified ID.
- -h, -help
- Print command usage help.
- -version
- Print version information and exit.
Options
- -o, -output dir
- Specifies the path of the output directory; the path can be absolute or relative to the current directory. By default, the output is written to the out subdirectory of the current directory.
- -filter file
- Specifies a filter file to be used to include, exclude, or flag content.
- -t, -temp dir
- Specifies the location of the temporary directory.
- -v, -verbose
- Verbose logging.
- -d, -debug
- Debug logging.
- -l, -logfile file
- Write logging messages to a file.
- -Dparameter=value
- Specify a value for a DITA-OT or Ant build parameter.
Parameters not implemented by the specified transformation type or referenced in a .properties file are ignored.
Tip: If you are building in different environments where the location of the input files is not consistent, set args.input.dir with the dita command and reference its value with${args.input.dir}
in your .properties file. - -propertyfile file
- Use build parameters defined in the referenced .properties file.
Build parameters specified on the command line override those set in the .properties file.