summaryrefslogtreecommitdiff
path: root/devel/script/2_keys.xml
diff options
context:
space:
mode:
Diffstat (limited to 'devel/script/2_keys.xml')
-rw-r--r--devel/script/2_keys.xml31
1 files changed, 31 insertions, 0 deletions
diff --git a/devel/script/2_keys.xml b/devel/script/2_keys.xml
index bd8469c..854f0d5 100644
--- a/devel/script/2_keys.xml
+++ b/devel/script/2_keys.xml
@@ -695,6 +695,37 @@ signingkey https://packages/builder@ourcompany.net.pub
</para>
</formalpara>
</section>
+ <section id="rootshell">
+ <title><literal>rootshell</literal></title>
+ <formalpara id="rootshell.name">
+ <title>Name</title>
+ <para><literal>rootshell</literal></para>
+ </formalpara>
+ <formalpara id="rootshell.purpose">
+ <title>Purpose</title>
+ <para>The <literal>rootshell</literal> key specifies the shell to use when logging in to the target computer as the <literal>root</literal> user.</para>
+ </formalpara>
+ <formalpara id="rootshell.format">
+ <title>Format</title>
+ <para>The <literal>rootshell</literal> key is a single string value containing the full path inside the target to the executable to use as the shell.</para>
+ </formalpara>
+ <formalpara id="rootshell.default">
+ <title>Default</title>
+ <para>If no <literal>rootshell</literal> key is specified, the target computer will use <literal>/bin/sh</literal> as the shell when logging in as the <literal>root</literal> user.</para>
+ </formalpara>
+ <formalpara id="rootshell.example">
+ <title>Example</title>
+ <para>
+ <example>
+ <title>The <literal>rootshell</literal> Key</title>
+ <programlisting>
+ rootshell /bin/zsh
+ </programlisting>
+ <para>This will configure the target computer to use <literal>/bin/zsh</literal> as the shell when logging in as the <literal>root</literal> user.</para>
+ </example>
+ </para>
+ </formalpara>
+ </section>
<section id="bootloader">
<title><literal>bootloader</literal></title>
<formalpara id="bootloader.name">