Patch fix examples in chapter 4, adds new examples, fix out of date
information.

NOTE: Patch doesn't cover part 4.3 Logging with web UI
-- 
Martin Basti
>From 3dc1c5590617cb5315acf97cc53bc598c03d407d Mon Sep 17 00:00:00 2001
From: Martin Basti <mba...@redhat.com>
Date: Wed, 18 Sep 2013 16:57:25 +0200
Subject: [PATCH] Chapter 4 text bug fixes

FIXED:
  - ipa help command examples
  - removed * wildcard from examples
  - added example of using show command
  - added NOTE with prirorities set/add/delattrs
  - moved logging into to front
  - edited UI table showing menu entries
  - edited supported versions of web browsers
---
 src/user_guide/en-US/Usage.xml | 95 +++++++++++++++++++++++++++++++++---------
 1 file changed, 75 insertions(+), 20 deletions(-)

diff --git a/src/user_guide/en-US/Usage.xml b/src/user_guide/en-US/Usage.xml
index e63050edfe6cc8289df1d868eb9d4422ebbd10eb..8a3f3875e4f0abb4be0d844bb74cf0df33605b90 100644
--- a/src/user_guide/en-US/Usage.xml
+++ b/src/user_guide/en-US/Usage.xml
@@ -71,13 +71,32 @@
 <screen>ipa help <replaceable>topic</replaceable></screen>
 				<note><title>TIP</title>
 					<para>
-						To get a list of all available topics, run the <command>help</command> command without a topic name:
+						To get a list of all available topics, run the <command>help</command> command with <command>topics</command> param:
+					</para>
+<screen>ipa help topics</screen>
+					<para>
+						To get a list of all available commands, run the <command>help</command> command with <command>commands</command> param:
+					</para>
+<screen>ipa help commands</screen>
+					<para>
+						To get more information about <command>help</command> run command without a topic name:
 					</para>
 <screen>ipa help</screen>
 				</note>
 			<para>
 				All topic or command areas follow a consistent pattern for how entries are managed.
 			</para>
+			
+			<section id="cmd-usage-kinit"><title>Logging into the &IPA; Domain Before Running</title>
+				<para>
+					Before running any &IPA; commands (with the exception of the installation scripts, such as <command>ipa-server-install</command>), the user must first authenticate to the &IPA; domain by obtaining a Kerberos ticket. This is done using <command>kinit</command>:
+				</para>
+<screen>[user@ipaserver ~]$ kinit admin</screen>
+				<para>
+					Different login options are described in <xref linkend="logging-in" />.
+				</para>
+			</section>
+			
 			<section id="ipa-command-adding"><title>Adding, Editing, and Deleting Entries with ipa</title>
 				<para>
 					New entries are added using an <emphasis>*-add</emphasis> command. For example:
@@ -86,7 +105,7 @@
 				<para>
 					For <command>add</command> operations, commands usually prompt for any required configuration attributes, which can be passed as command-line options or using <option>--set/addattr</option> options (<xref linkend="using-setattr-addattr" />).
 				</para>
-<screen>$ ipa user-add
+<screen>[user@ipaserver ~]$ ipa user-add
 First name: John
 Last name: Smith
 User login [jsmith]: jsmith
@@ -106,9 +125,9 @@ Added user "jsmith"
 
 			<section id="ipa-command-displaying"><title>Finding and Displaying Entries with ipa</title>
 				<para>
-					Entries for an entire type are searched for using the <command>*-find</command> command and an optional search criterion. The criterion is a string which can either be an exact match or use an asterisk (*) as a wildcard.
+					Entries for an entire type are searched for using the <command>*-find</command> command and an optional search criterion. The criterion is a string.
 				</para>
-<screen>ipa user-find *smith</screen>
+<screen>$ ipa user-find jsmith</screen>
 				<para>
 					With no search criterion, every entry of that type is displayed.
 				</para>
@@ -117,7 +136,7 @@ Added user "jsmith"
 				Part of the server configuration is setting global defaults for size and time limits on searches. While these limits are always enforced in the web UI, they can be overridden with any <command>*-find</command> command with the <option>--sizelimit</option> and <option>--timelimit</option> options.
 				For example, if the default time limit is 60 seconds and a search is going to take longer, the time limit can be increased to 120 seconds:
 			</para>
-<screen>[jsmith@ipaserver ~]$ ipa user-find *sen --timelimit=120</screen>
+<screen>$ ipa user-find jsmith --timelimit=120</screen>
 				<para>
 					Not every possible attribute in an entry type can be searched for. A certain subset of attributes are predefined and indexed for searches. (This list is configurable for users and groups, but not for other types of entries.)
 				</para>
@@ -127,6 +146,20 @@ Added user "jsmith"
 				<para>
 					To display a specific entry, use the <command>*-show</command> command and the entry name. As with searches, only a subset of attributes are displayed with the entry unless the <option>--all</option> option is used.
 				</para>
+				<screen>[user@ipaserver ~]$ ipa user-show jsmith 
+  User login: jsmith
+  First name: John
+  Last name: Smith
+  Home directory: /home/jsmith
+  Login shell: /bin/sh
+  Email address: jsm...@example.com
+  UID: 1035400001
+  GID: 1035400001
+  Account disabled: False
+  Password: True
+  Member of groups: ipausers
+  Kerberos keys available: True
+</screen>	
 			</section>
 
 			<section id="ipa-command-members"><title>Adding Members to Groups and Containers with ipa</title>
@@ -190,9 +223,10 @@ Added user "jsmith"
 <screen>$ ipa user-mod jsmith --delattr=mail=john...@me.com</screen>
 				<note><title>NOTE</title>
 					<para>
-						Deleting attributes is evaluated last, after adding or editing attributes. If the same attribute is added and deleted in the same modify operation, it is a no-op.
+						Options are evaluated in order: <command>--setattr</command>, <command>--addattr</command> and <command>--delattr</command>. If the same attribute is added and deleted in the same modify operation, it is a no-op.
 					</para>
-<screen>$ ipa user-mod jsmith --addattr=mail=john...@me.com --delattr=mail=john...@me.com</screen>
+<screen>$ ipa user-mod jsmith --addattr=mail=john...@me.com --delattr=mail=john...@me.com
+ipa: ERROR: no modifications to be performed</screen>
 				</note>
 		</section>
 
@@ -205,15 +239,6 @@ Added user "jsmith"
 				</para>
 			</section>
 
-			<section id="cmd-usage-kinit"><title>Logging into the &IPA; Domain Before Running</title>
-				<para>
-					Before running any &IPA; commands (with the exception of the installation scripts, such as <command>ipa-server-install</command>), the user must first authenticate to the &IPA; domain by obtaining a Kerberos ticket. This is done using <command>kinit</command>:
-				</para>
-<screen>[jsmith@ipaserver ~]$ kinit admin</screen>
-				<para>
-					Different login options are described in <xref linkend="logging-in" />.
-				</para>
-			</section>
 		</section>
 
 		<section id="ipa-ui"><title>Looking at the &IPA; UI</title>
@@ -303,6 +328,16 @@ Added user "jsmith"
 											DNS (if configured)
 										</para>
 									</listitem>
+									<listitem>
+										<para>
+											Certificates entries
+										</para>
+									</listitem>
+									<listitem>
+										<para>
+											Realm domain entries
+										</para>
+									</listitem>
 								</itemizedlist>
 							</entry>
 						</row>
@@ -338,13 +373,23 @@ Added user "jsmith"
 											Kerberos ticket policy
 										</para>
 									</listitem>
+									<listitem>
+										<para>
+											SELinux user maps entries
+										</para>
+									</listitem>
+									<listitem>
+										<para>
+											Automember entries
+										</para>
+									</listitem>
 								</itemizedlist>
 							</entry>
 						</row>
 						
 						<row>
 							<entry>
-								&IPA; Server (access controls within &PROD;)
+								IPA Server (access controls within &PROD;)
 							</entry>
 							<entry>
 								<itemizedlist>
@@ -355,7 +400,7 @@ Added user "jsmith"
 									</listitem>
 									<listitem>
 										<para>
-											Self permissions
+											Self service permissions
 										</para>
 									</listitem>
 									<listitem>
@@ -363,6 +408,16 @@ Added user "jsmith"
 											Delegations (user access control over other users)
 										</para>
 									</listitem>
+									<listitem>
+										<para>
+											ID ranges
+										</para>
+									</listitem>
+									<listitem>
+										<para>
+											Configuration
+										</para>
+									</listitem>
 								</itemizedlist>
 							</entry>
 						</row>
@@ -378,7 +433,7 @@ Added user "jsmith"
 			<figure id="fig.ui-tabs"><title>The Main Menu</title>
 				<mediaobject>
 					<imageobject>
-						<imagedata fileref="images/ui-tabs.png" format="PNG" contentwidth="660px" />
+						<imagedata fileref="images/ui-tabs.png" format="PNG" />
 					</imageobject>
 				</mediaobject>
 			</figure>
@@ -627,7 +682,7 @@ klist: You have no tickets cached
 			<itemizedlist>
 				<listitem>
 					<para>
-						Firefox 15.x
+						Firefox 15.x and newer
 					</para>
 				</listitem>
 				<listitem>
-- 
1.8.3.1

_______________________________________________
Freeipa-devel mailing list
Freeipa-devel@redhat.com
https://www.redhat.com/mailman/listinfo/freeipa-devel

Reply via email to