Skip to content

Commit

Permalink
Update dds-submit docs
Browse files Browse the repository at this point in the history
  • Loading branch information
AnarManafov committed Sep 26, 2023
1 parent 8decc2c commit a70dbae
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 2 deletions.
34 changes: 34 additions & 0 deletions dds-submit/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# dds-submimt

Submits and activates DDS agents UNIX/Linux/OSX

## Synopsis

```shell
dds-submit [[-h, --help] | [-v, --version]] [-l, --list] [-r, --rms arg] [-s, --session arg] {[-c, --config arg] | [-n, --number arg] | [-s, --slots arg]}
```

## Description

The command is used to submit DDS agents to allocate resources for user tasks. Once enough agents are online use the [dds-topology](../dds-topology/README.md) command to activate the agents - i.e. distribute user tasks across agents and start them.

## Options

* **-h, --help**
Shows usage options.
* **-v, --version**
Shows version information.
* **--l, --list** *arg*
List all available RMS plug-ins.
* **--r, --rms** *arg*
Defines a destination resource management system plug-in. Use `--list` to find out names of available RMS plug-ins.
* **--s, --session** *arg*
DDS Session ID.
* **--path** *arg*
Defines a path to the root plug-ins directory. If not specified than default root plug-ins directory is used.
* **-c, --config** *arg*
A plug-in's configuration file. It can be used to provide additional RMS options.
* **-n, --number** *arg*
Defines a number of agents to spawn. This option can not be mixed with `--config`.
* **-s, --slots** *arg*
Defines a number of task slots per agent. This option can not be mixed with `--config`.
4 changes: 2 additions & 2 deletions dds-user-defaults/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,11 @@ Generates a default DDS configuration file.
If the destination file exists, removes it and creates a new file, without prompting for confirmation.
Can only be used with the `-d, --default` options.

* **-c, --config *arg***
* **-c, --config** *arg*
This options can be used together with other options to specify non-default location of the DDS configuration file.
By default the command uses `~/.DDS/DDS.cfg`.

* **-s, --session *arg***
* **-s, --session** *arg*
Use the specified DDS Session ID instead of a default one.

* **--ignore-default-sid**
Expand Down

0 comments on commit a70dbae

Please sign in to comment.