summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRob Crittenden <rcritten@redhat.com>2008-06-04 11:51:56 -0400
committerRob Crittenden <rcritten@redhat.com>2008-06-04 12:50:13 -0400
commit5c916a1cc8adfad6f6b24f5d46fc4b4c07e6b775 (patch)
treedc21d8f95e2a4b8096a9ecaf2c9589351a9145cc
parentd6f7998fe7a8c25f2914b262bee3e0d0562abfdb (diff)
downloadfreeipa-5c916a1cc8adfad6f6b24f5d46fc4b4c07e6b775.tar.gz
freeipa-5c916a1cc8adfad6f6b24f5d46fc4b4c07e6b775.tar.xz
freeipa-5c916a1cc8adfad6f6b24f5d46fc4b4c07e6b775.zip
Fix some minor man page issues.
438771
-rw-r--r--ipa-admintools/man/ipa-findservice.110
-rw-r--r--ipa-admintools/man/ipa-finduser.14
-rw-r--r--ipa-client/man/ipa-getkeytab.115
3 files changed, 18 insertions, 11 deletions
diff --git a/ipa-admintools/man/ipa-findservice.1 b/ipa-admintools/man/ipa-findservice.1
index f75f216f..85a24aba 100644
--- a/ipa-admintools/man/ipa-findservice.1
+++ b/ipa-admintools/man/ipa-findservice.1
@@ -25,9 +25,17 @@ ipa\-findservice \fIstring\fR
.SH "DESCRIPTION"
Searches for a service principal that contains \fIstring\fR.
-The search is a substring search in the service principal. You can search for all principals on a given host, by service or a substring.
+The search is a substring search in the service principal. You can search for all principals for a given host, by service or a substring.
All entries that match are displayed.
+.SH "EXAMPLES"
+Find all ldap service principals issued by the IPA KDC:
+
+ # ipa\-findservice ldap
+
+Find all service principals for ipa.example.com:
+
+ # ipa\-findservice ipa.example.com
.SH "EXIT STATUS"
0 if one or more entries were found
diff --git a/ipa-admintools/man/ipa-finduser.1 b/ipa-admintools/man/ipa-finduser.1
index 94989e7e..144b8637 100644
--- a/ipa-admintools/man/ipa-finduser.1
+++ b/ipa-admintools/man/ipa-finduser.1
@@ -25,7 +25,7 @@ ipa\-finduser [\fIOPTION\fR]... \fIstring\fR
.SH "DESCRIPTION"
Searches for a user that contains \fIstring\fR.
-The search is a substring search in the username, given name, family name, telephone Number, organization and title attributes.
+The search is a substring search in the username, given name, family name, telephone number, organization and title attributes.
All entries that match are displayed.
.SH "OPTIONS"
@@ -34,7 +34,7 @@ All entries that match are displayed.
Display all attributes
.PP
-By default the full name, home Directory and login shell and username fields are displayed.
+By default, the full name, home directory, login shell, and username fields are displayed.
.SH "EXIT STATUS"
0 if one or more entries were found
diff --git a/ipa-client/man/ipa-getkeytab.1 b/ipa-client/man/ipa-getkeytab.1
index 614a33cd..93db094e 100644
--- a/ipa-client/man/ipa-getkeytab.1
+++ b/ipa-client/man/ipa-getkeytab.1
@@ -21,7 +21,7 @@
.SH "NAME"
ipa\-getkeytab \- Get a keytab for a kerberos principal
.SH "SYNOPSIS"
-ipa\-getkeytab <\fI\-s ipaserver\fR> <\fI\-p principal\-name\fR> <\fI\-k keytab\-file\fR> [\fI\-e encryption\-types\fR] [\fI\-q\fR]
+ipa\-getkeytab [ \fB\-s\fR ipaserver ] [ \fB\-p\fR principal\-name ] [ \fB\-k\fR keytab\-file ] [ \fB\-e\fR encryption\-types ] [ \fB\-q\fR ]
.SH "DESCRIPTION"
Retrieves a kerberos \fIkeytab\fR.
@@ -44,20 +44,19 @@ provided, so the principal name is just the service
name and hostname (ldap/foo.example.com from the
example above).
-\fBWARNING:\fR retrieving the keytab resets the secret
-rendering all other keytabs for that principal invalid.
-
+\fBWARNING:\fR retrieving the keytab resets the secret for the Kerberos principal.
+This renders all other keytabs for that principal invalid.
.SH "OPTIONS"
.TP
\fB\-s ipaserver\fR
-The IPA Server to retrieve the keytab from (FQDN).
+The IPA server to retrieve the keytab from (FQDN).
.TP
\fB\-p principal\-name\fR
-The non realm part of the full principal name.
+The non\-realm part of the full principal name.
.TP
\fB\-k keytab\-file\fR
The keytab file where to append the new key (will be
-created if not existing).
+created if it does not exist).
.TP
\fB\-e encryption\-types\fR
The list of encryption types to use to generate keys.
@@ -73,7 +72,7 @@ des\-cbc\-md5
des\-cbc\-crc
.TP
\fB\-q\fR
-Keep quiet.
+Quiet mode. Only errors are displayed.
.TP
\fB\-\-permitted\-enctypes\fR
This options returns a description of the permitted encryption types, like this: