The documentation is OS-independent. Linux* OS and Windows* OS may have different styles in passing parameters. This User and Reference Guide follows the nomenclature used on the Linux* OS. Here is a list of the most important differences and how they are mapped from the Linux* OS style to the Windows* OS one:
Linux* OS | Microsoft* Windows* OS |
---|---|
-L<path> |
-LIBPATH:<path> |
-l<library> |
<library>.lib |
<directory>/<file> |
<directory>\<file> |
The following conventions are used in this document:
Convention | Explanation | Example |
---|---|---|
This type style | Document or product names | The term process in this documentation implicitly includes thread. |
This type style | GUI elements | Click OK |
<this type style> |
Placeholders for actual values | <new-name> |
This type style |
Commands, arguments, options | $ mpirun -trace -n 4 myApp |
THIS_TYPE_STYLE |
Environment variables | Set the VT_CONFIG environment variable to the directory that contains the configuration file. |
[ items ] |
Optional items | [config options] |
[ item | item ] |
Selectable items separated by vertical bar(s) | [on|off] |
$ |
Introduces UNIX* commands | $ ls |
> |
Introduces Windows* commands | > cd |