From 00aff7d51f84380d9c02b5fb4f5bf5bdb95f5cd5 Mon Sep 17 00:00:00 2001 From: Sean Cross Date: Mon, 17 Apr 2023 17:03:56 +0800 Subject: [PATCH] Document `-gui` option (#1759) --- docs/source/reference/cli.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/source/reference/cli.md b/docs/source/reference/cli.md index d2e49d98..0eea79c0 100644 --- a/docs/source/reference/cli.md +++ b/docs/source/reference/cli.md @@ -9,6 +9,7 @@ The following are the command-line arguments that can be passed to `flow.tcl`: | `-override_env`
Optional | Allows you to override certain configuration environment variables for this run. Format: `-override_env KEY1=VALUE1,KEY2=VALUE2` | | `-expose_env` | Expose the following environment variables to `config.json` as configuration variables. Has no effect on config.tcl sourcing, which already has access to all environment variables. Format: `-expose_env KEY1,KEY2` | | `-tag `
(Optional) | Specifies a "name" for a specific run. If the tag is not specified, a timestamp is generated for identification of that run. | +| `-gui` | Run the OpenROAD GUI to view the results of the run. Must be paired with `-tag ` to specify which tag to display. | | `-run_path `
(Optional) | Specifies a `path` to save the run in. By default the run is in `design_path/`, where the design path is the one passed to `-design` | | `-src `
(Optional) | Sets the verilog source code file(s) in case of using `-init\_design\_config`.
The default is that the source code files are under `design_path/src/`, where the design path is the one passed to `-design` | | `-init_design_config`
(Optional) | Creates a configuration file for a design. The config file is by default `openlane/config.json`, but can be overriden using the value from `-config_file`. |