Skip to main content

Usage pattern

The usage pattern of raptor_sync_client and raptor_sync_server is the following:

raptor_sync_[client|server] COMMAND OPTION PARAMETER

Options can be either in short form (e.g., -c) or long-form (e.g., --config).

The documentation uses:

  • Brackets “[ ]” to describe optional elements.
  • Pipes “|” to describe mutually exclusive elements.
  • Ellipsis “…“ to describe repeating elements.

Together, these elements form valid usage patterns.

The commands are described in individual sections of this document.

Help​

The help option (--help, -h) is available for all commands.

Version​

The version option shows the version.

raptor_sync_client --version
raptor_sync_server --version