Command-line switches

This topic gives a detailed description of command-line switches and examples of their usage.

Command-line usage

To view command-line switches for /document, run the following command:

dbforgesql.com /document /?

Note

To run dbForge Studio CLI commands, open Command Prompt and navigate to the folder that contains dbforgesql.com. The default path to this executable depends on where dbForge Studio for SQL Server is installed. If you installed dbForge Studio:

  • As a standalone tool
C:\Program Files\Devart\dbForge Studio for SQL Server
  • As part of the dbForge Edge bundle
C:\Program Files\Devart\dbForge Edge\dbForge Studio for SQL Server

Available command-line switches

All switches available for this option are listed below, along with usage examples.

Name Description
/author Specifies the author for the generated documentation. This value overrides the author in the project file (.ddoc).
Usage: /author:<author_name>
/breadcrumbs Specifies whether to include breadcrumbs in the generated documentation.
To enable the option, specify: Yes, Y, On, True, T.
To disable the option, specify: No, N, Off, False, F.
The default value for the parameter is Y.
Usage: /breadcrumbs:<value>
/connection Specifies a connection string.
Usage: /connection:<connection_string>
/copyright Specifies the copyright information for the generated documentation. This value overrides the copyright information in the project file (.ddoc).
Usage: /copyright:<copyright_text>
/created Specifies the creation date for the generated documentation. This value overrides the creation date in the project file (.ddoc).
Usage: /created:<date>
/database Specifies databases to document. You can provide a single database name or multiple database names separated by commas. To include all the databases on the server, use the ALLDATABASES value.
Usage: /database:<database_name>
/docdescription Specifies the document description for the generated documentation. This value overrides the document description in the project file (.ddoc).
Usage: /docdescription:<description>
/doclogo Specifies the path to the logo image for the generated documentation. This value overrides the logo path in the project file (.ddoc).
Usage: /doclogo:<path>
/doctitle Specifies the document title for the generated documentation. This value overrides the document title in the project file (.ddoc)
Usage: /doctitle:<title>
/format Specifies the output format of the generated documentation.
Available options:
  • PDF – A PDF file.
  • HTML – An HTML file.
  • MARKDOWN – A plain-text document that uses a lightweight markup language (Markdown).
If not specified, the default format is HTML.
Usage: /format:<HTML|PDF|MARKDOWN>
/errormode Specifies the application’s behavior when an error occurs:
  • ignore – Ignores the error.
  • abort – Cancels execution.

Usage: /errormode:<ignore|abort>
/exitcodes Displays the list of exit codes that can be returned by the command-line process.
Usage: /exitcodes
/output Specify an output file name for PDF documentation or a folder name for HTML or Markdown documentation.
Usage: /output:<file_or_folder_name>
/password Specifies the server password. This value overrides the password in the connection string.
Usage: /password:<pw>
/path Specifies an output file name for PDF documentation or folder name for HTML or Markdown documentation.
Usage: /path:<folder_path>
/permissions Specifies whether to include database object permissions in the generated documentation.
To turn on the option, specify: Yes, Y, On, True, T.
To turn off the option, specify: No, N, Off, False, F.
Usage: /permissions:<value>
/projfile Specifies the full path and file name of the project file (.ddoc).
Note: You can use the Generate Documentation wizard to create the project file. For more information, see Generate a database document.
Usage: /projfile:<path>
/treatwarningaserror Specifies how to treat warnings:
  • Yes – Warnings are treated as errors; further behavior is determined by the /errormode argument.
  • No – Warnings aren’t treated as errors; execution continues with warning messages.

Usage: /treatWarningAsError:[Yes|No]