Skip to content

Commit

Permalink
Update manpage for rolectl deploy --settings-stdin
Browse files Browse the repository at this point in the history
  • Loading branch information
sgallagher committed Aug 10, 2015
1 parent 76e46b5 commit 84a955c
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions doc/xml/rolectl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@
</varlistentry>

<varlistentry>
<term><command>deploy <replaceable>ROLE</replaceable> <optional>--name <replaceable>NAME</replaceable></optional> <optional>--settings-file <replaceable>FILE</replaceable></optional></command></term>
<term><command>deploy <replaceable>ROLE</replaceable> <optional>--name <replaceable>NAME</replaceable></optional> <optional>--settings-file <replaceable>FILE</replaceable> | --settings-stdin</optional> </command></term>
<listitem>
<para>
Deploys the role <replaceable>ROLE</replaceable> with the optional name <replaceable>NAME</replaceable> and the optional settings file <replaceable>FILE</replaceable> to an instance.
Expand All @@ -173,7 +173,7 @@
If no name is specified for the instance, rolekit will use the next lowest unused instance number starting by 1 as the name. The first not named instance will be <replaceable>1</replaceable>, the second <replaceable>2</replaceable> and so on. The number of instances per role are currently limited to one.
</para>
<para>
The settings file can be used to apply values to settings. The settings file needs to be a vaild json file. If no settings file is used, the default settings of the role are used for the instance.
The settings file or stdin can be used to apply values to settings. The settings need to be valid JSON. If no settings are specified, the default settings of the role are used for the instance.
</para>
<para>
Not all settings can be set in the settings file. The role defines which settings are read only and can therefore not be set within the settings file. The readonly default settings are: <replaceable>lasterror</replaceable>, <replaceable>version</replaceable>, <replaceable>services</replaceable>, <replaceable>packages</replaceable> and <replaceable>firewall</replaceable>.
Expand Down

0 comments on commit 84a955c

Please sign in to comment.