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