|
 |
deab74 |
From fee9bde11b42ab39af6397a0c0ce4775443b28ea Mon Sep 17 00:00:00 2001
|
|
|
deab74 |
From: Stef Walter <stefw@redhat.com>
|
|
|
deab74 |
Date: Mon, 6 Feb 2017 12:25:52 +0100
|
|
|
deab74 |
Subject: [PATCH] doc: Add short arguments like -U arguments to realm manual
|
|
|
deab74 |
page
|
|
|
deab74 |
|
|
|
deab74 |
And clean up the documentation for the various arguments.
|
|
|
deab74 |
---
|
|
|
deab74 |
doc/manual/realm.xml | 70 +++++++++++++++++++++++---------------------
|
|
|
deab74 |
1 file changed, 37 insertions(+), 33 deletions(-)
|
|
|
deab74 |
|
|
|
deab74 |
diff --git a/doc/manual/realm.xml b/doc/manual/realm.xml
|
|
|
deab74 |
index 6724d80..9d9136a 100644
|
|
|
deab74 |
--- a/doc/manual/realm.xml
|
|
|
deab74 |
+++ b/doc/manual/realm.xml
|
|
|
deab74 |
@@ -60,7 +60,7 @@
|
|
|
deab74 |
|
|
|
deab74 |
<variablelist>
|
|
|
deab74 |
<varlistentry>
|
|
|
deab74 |
- <term><option>--install=/path</option></term>
|
|
|
deab74 |
+ <term><option>-i</option>, <option>--install=/path</option></term>
|
|
|
deab74 |
<listitem><para>Run in install mode. This makes realmd
|
|
|
deab74 |
chroot into the specified directory and place files in
|
|
|
deab74 |
appropriate locations for use during an installer. No
|
|
|
deab74 |
@@ -73,7 +73,7 @@
|
|
|
deab74 |
for input.</para></listitem>
|
|
|
deab74 |
</varlistentry>
|
|
|
deab74 |
<varlistentry>
|
|
|
deab74 |
- <term><option>--verbose, -v</option></term>
|
|
|
deab74 |
+ <term><option>-v</option>, <option>--verbose</option></term>
|
|
|
deab74 |
<listitem><para>Display verbose diagnostics while doing
|
|
|
deab74 |
running commands.</para></listitem>
|
|
|
deab74 |
</varlistentry>
|
|
|
deab74 |
@@ -105,7 +105,7 @@ $ realm discover domain.example.com
|
|
|
deab74 |
|
|
|
deab74 |
<variablelist>
|
|
|
deab74 |
<varlistentry>
|
|
|
deab74 |
- <term><option>--all</option></term>
|
|
|
deab74 |
+ <term><option>-a</option>, <option>--all</option></term>
|
|
|
deab74 |
<listitem><para>Show all discovered realms (in various
|
|
|
deab74 |
configurations).</para></listitem>
|
|
|
deab74 |
</varlistentry>
|
|
|
deab74 |
@@ -116,6 +116,10 @@ $ realm discover domain.example.com
|
|
|
deab74 |
<replaceable>sssd</replaceable> or
|
|
|
deab74 |
<replaceable>winbind</replaceable>.</para></listitem>
|
|
|
deab74 |
</varlistentry>
|
|
|
deab74 |
+ <varlistentry>
|
|
|
deab74 |
+ <term><option>-n</option>, <option>--name</option></term>
|
|
|
deab74 |
+ <listitem><para>Only show the names of the discovered realms.</para></listitem>
|
|
|
deab74 |
+ </varlistentry>
|
|
|
deab74 |
<varlistentry>
|
|
|
deab74 |
<term><option>--server-software=xxx</option></term>
|
|
|
deab74 |
<listitem><para>Only discover realms which run the
|
|
|
deab74 |
@@ -187,10 +191,13 @@ $ realm join --user=admin --computer-ou=OU=Special domain.example.com
|
|
|
deab74 |
in the domain already.</para></listitem>
|
|
|
deab74 |
</varlistentry>
|
|
|
deab74 |
<varlistentry>
|
|
|
deab74 |
- <term><option>--user=xxx</option></term>
|
|
|
deab74 |
- <listitem><para>The user name to be used to authenticate
|
|
|
deab74 |
- with when joining the machine to the realm. You will
|
|
|
deab74 |
- be prompted for a password.</para></listitem>
|
|
|
deab74 |
+ <term><option>--client-software=xxx</option></term>
|
|
|
deab74 |
+ <listitem><para>Only join realms for which we can
|
|
|
deab74 |
+ use the given client software. Possible values include
|
|
|
deab74 |
+ <replaceable>sssd</replaceable> or
|
|
|
deab74 |
+ <replaceable>winbind</replaceable>. Not all values are
|
|
|
deab74 |
+ supported for all realms. By default the client software
|
|
|
deab74 |
+ is automatically selected.</para></listitem>
|
|
|
deab74 |
</varlistentry>
|
|
|
deab74 |
<varlistentry>
|
|
|
deab74 |
<term><option>--computer-ou=OU=xxx</option></term>
|
|
|
deab74 |
@@ -201,6 +208,14 @@ $ realm join --user=admin --computer-ou=OU=Special domain.example.com
|
|
|
deab74 |
DSE portion of distinguished name. This is an Active
|
|
|
deab74 |
Directory specific option.</para></listitem>
|
|
|
deab74 |
</varlistentry>
|
|
|
deab74 |
+ <varlistentry>
|
|
|
deab74 |
+ <term><option>--membership-software=xxx</option></term>
|
|
|
deab74 |
+ <listitem><para>The software to use when joining to the
|
|
|
deab74 |
+ realm. Possible values include <replaceable>samba</replaceable> or
|
|
|
deab74 |
+ <replaceable>adcli</replaceable>. Not all values are
|
|
|
deab74 |
+ supported for all realms. By default the membership software
|
|
|
deab74 |
+ is automatically selected.</para></listitem>
|
|
|
deab74 |
+ </varlistentry>
|
|
|
deab74 |
<varlistentry>
|
|
|
deab74 |
<term><option>--no-password</option></term>
|
|
|
deab74 |
<listitem><para>Perform the join automatically without
|
|
|
deab74 |
@@ -213,13 +228,16 @@ $ realm join --user=admin --computer-ou=OU=Special domain.example.com
|
|
|
deab74 |
all types of realms.</para></listitem>
|
|
|
deab74 |
</varlistentry>
|
|
|
deab74 |
<varlistentry>
|
|
|
deab74 |
- <term><option>--client-software=xxx</option></term>
|
|
|
deab74 |
- <listitem><para>Only join realms for which we can
|
|
|
deab74 |
- use the given client software. Possible values include
|
|
|
deab74 |
- <replaceable>sssd</replaceable> or
|
|
|
deab74 |
- <replaceable>winbind</replaceable>. Not all values are
|
|
|
deab74 |
- supported for all realms. By default the client software
|
|
|
deab74 |
- is automatically selected.</para></listitem>
|
|
|
deab74 |
+ <term><option>--os-name=xxx</option></term>
|
|
|
deab74 |
+ <listitem><para>The name of the operation system of the
|
|
|
deab74 |
+ client. When joining an AD domain the value is store in
|
|
|
deab74 |
+ the matching AD attribute.</para></listitem>
|
|
|
deab74 |
+ </varlistentry>
|
|
|
deab74 |
+ <varlistentry>
|
|
|
deab74 |
+ <term><option>--os-version=xxx</option></term>
|
|
|
deab74 |
+ <listitem><para>The version of the operation system of the
|
|
|
deab74 |
+ client. When joining an AD domain the value is store in
|
|
|
deab74 |
+ the matching AD attribute.</para></listitem>
|
|
|
deab74 |
</varlistentry>
|
|
|
deab74 |
<varlistentry>
|
|
|
deab74 |
<term><option>--server-software=xxx</option></term>
|
|
|
deab74 |
@@ -229,12 +247,10 @@ $ realm join --user=admin --computer-ou=OU=Special domain.example.com
|
|
|
deab74 |
<replaceable>ipa</replaceable>.</para></listitem>
|
|
|
deab74 |
</varlistentry>
|
|
|
deab74 |
<varlistentry>
|
|
|
deab74 |
- <term><option>--membership-software=xxx</option></term>
|
|
|
deab74 |
- <listitem><para>The software to use when joining to the
|
|
|
deab74 |
- realm. Possible values include <replaceable>samba</replaceable> or
|
|
|
deab74 |
- <replaceable>adcli</replaceable>. Not all values are
|
|
|
deab74 |
- supported for all realms. By default the membership software
|
|
|
deab74 |
- is automatically selected.</para></listitem>
|
|
|
deab74 |
+ <term><option>-U</option>, <option>--user=xxx</option></term>
|
|
|
deab74 |
+ <listitem><para>The user name to be used to authenticate
|
|
|
deab74 |
+ with when joining the machine to the realm. You will
|
|
|
deab74 |
+ be prompted for a password.</para></listitem>
|
|
|
deab74 |
</varlistentry>
|
|
|
deab74 |
<varlistentry>
|
|
|
deab74 |
<term><option>--user-principal=<parameter>host/name@REALM</parameter></option></term>
|
|
|
deab74 |
@@ -243,18 +259,6 @@ $ realm join --user=admin --computer-ou=OU=Special domain.example.com
|
|
|
deab74 |
the value for this option, then a principal will be set
|
|
|
deab74 |
in the form of <literal>host/shortname@REALM</literal></para></listitem>
|
|
|
deab74 |
</varlistentry>
|
|
|
deab74 |
- <varlistentry>
|
|
|
deab74 |
- <term><option>--os-name=xxx</option></term>
|
|
|
deab74 |
- <listitem><para>The name of the operation system of the
|
|
|
deab74 |
- client. When joining an AD domain the value is store in
|
|
|
deab74 |
- the matching AD attribute.</para></listitem>
|
|
|
deab74 |
- </varlistentry>
|
|
|
deab74 |
- <varlistentry>
|
|
|
deab74 |
- <term><option>--os-version=xxx</option></term>
|
|
|
deab74 |
- <listitem><para>The version of the operation system of the
|
|
|
deab74 |
- client. When joining an AD domain the value is store in
|
|
|
deab74 |
- the matching AD attribute.</para></listitem>
|
|
|
deab74 |
- </varlistentry>
|
|
|
deab74 |
</variablelist>
|
|
|
deab74 |
|
|
|
deab74 |
</refsect1>
|
|
|
deab74 |
@@ -300,7 +304,7 @@ $ realm leave domain.example.com
|
|
|
deab74 |
for a pasword.</para></listitem>
|
|
|
deab74 |
</varlistentry>
|
|
|
deab74 |
<varlistentry>
|
|
|
deab74 |
- <term><option>--user</option></term>
|
|
|
deab74 |
+ <term><option>-U</option>, <option>--user</option></term>
|
|
|
deab74 |
<listitem><para>The user name to be used to authenticate
|
|
|
deab74 |
with when leaving the realm. You will be prompted for a
|
|
|
deab74 |
password. Implies <option>--remove</option>.</para></listitem>
|
|
|
deab74 |
--
|
|
|
deab74 |
2.21.0
|
|
|
deab74 |
|