Launching Help

Launching Help through the main interface

launching Help Simcenter Amesim's Help is launched by pressing F1, through the contextual menus, or through the Help menu item. It is also accessible through the Help buttons of dialog boxes.

The Help opens in your default browser.

Launching the Help server manually

You can also start the server which manages the help through its executable (HelpNavigator.exe), which is located in the $AME/win64 or $AME/lnx_x64 folder. In this way you can launch Help even if Simcenter Amesim is not running.

You can use the following arguments, some of which are mandatory:

• -docPath: this argument is mandatory, it is required for the server to know where the documentation is located. A path corresponding to $AME must be given. If this argument is not given or incorrect, the server will display an error and will not start.

• -p: this argument is optional, it is used to provide a port for the server. By default it is 8080

• -noBrowser: this argument is optional, it manages the opening of the main page of the help in a browser when the server starts. By default it is set to true, so the server does not open a page in the system's default browser, and you can manually enter the address in the browser of your choice. If you want to open the main page in the system's default browser at launch you must use -noBrowser=false.

• -showUrl: this argument is optional, it can be used when the -noBrowser argument is set to false. This argument performs an index search with the value given, and opens the first result found (instead of the main page). For example to open Help displaying information on modulo plots, the argument could be -showUrl modulo. If no result is found, the main Help page opens.

Once the server has started, you can enter this address in your browser:

number>/

Note

If you call the HelpNavigator.exe manually, to stop the server you must stop the process.