Back to main menu

## Mode: help

#### Syntax

`atomsk --help [<topic>]`

#### Description

This mode prints a brief summary of the program usage, and then exits the program.

One help section can be specified to display a more detailed information about the following topics: "modes", "options", "formats".

Note that if a mode or option is called incorrectly, its usage will be displayed.

No file is treated or converted in this mode (consequently options are ignored).

#### Examples

- `atomsk --help`

  This will print the general help.

- `atomsk --help options`

  This will print the help section corresponding to options.

- `atomsk --merge`

  This will print the help concerning the mode merge.

- `atomsk -shift`

  This will print the help concerning the option `-shift`.

Back to main menu