diff options
author | Martin Kosek <mkosek@redhat.com> | 2011-09-05 11:04:17 +0200 |
---|---|---|
committer | Martin Kosek <mkosek@redhat.com> | 2011-09-07 12:55:12 +0200 |
commit | dc3d0f387918b3de2f8e7898408e04e11cc30363 (patch) | |
tree | 99a8e54a033ffd861a343f05e4a637d3634f73d9 /install/tools/man/ipa-replica-install.1 | |
parent | 9cd76c5bf9457fc6304106741718a1e4e404a1f9 (diff) | |
download | freeipa-dc3d0f387918b3de2f8e7898408e04e11cc30363.tar.gz freeipa-dc3d0f387918b3de2f8e7898408e04e11cc30363.tar.xz freeipa-dc3d0f387918b3de2f8e7898408e04e11cc30363.zip |
Improve man pages structure
There are too many options in ipa-*-install scripts which makes it
difficult to read. This patch adds subsections to install script
online help and man pages to improve readability. No option has
been changed.
To further improve man pages:
1) All man pages were changed to have the same header and top-center
title to provide united look.
2) Few typos in man pages have been fixed
https://fedorahosted.org/freeipa/ticket/1687
Diffstat (limited to 'install/tools/man/ipa-replica-install.1')
-rw-r--r-- | install/tools/man/ipa-replica-install.1 | 48 |
1 files changed, 27 insertions, 21 deletions
diff --git a/install/tools/man/ipa-replica-install.1 b/install/tools/man/ipa-replica-install.1 index 350160ada..c82b4a6b0 100644 --- a/install/tools/man/ipa-replica-install.1 +++ b/install/tools/man/ipa-replica-install.1 @@ -16,7 +16,7 @@ .\" .\" Author: Rob Crittenden <rcritten@redhat.com> .\" -.TH "ipa-replica-install" "1" "Mar 14 2008" "freeipa" "" +.TH "ipa-replica-install" "1" "Sep 5 2011" "FreeIPA" "FreeIPA Manual Pages" .SH "NAME" ipa\-replica\-install \- Create an IPA replica .SH "SYNOPSIS" @@ -26,12 +26,11 @@ Configures a new IPA server that is a replica of the server that generated it. O The replica_file is created using the ipa\-replica\-prepare utility. .SH "OPTIONS" +.SS "BASIC OPTIONS" .TP -\fB\-N\fR, \fB\-\-no\-ntp\fR -Do not configure NTP -.TP -\fB\-d\fR, \fB\-\-debug -Enable debug logging when more verbose output is needed +\fB\-\-setup\-ca\fR +Install and configure a CA on this replica. If a CA is not configured then +certificate operations will be forwarded to a master with a CA installed. .TP \fB\-p\fR \fIDM_PASSWORD\fR, \fB\-\-password\fR=\fIDM_PASSWORD\fR Directory Manager (existing master) password @@ -39,9 +38,27 @@ Directory Manager (existing master) password \fB\-w\fR \fIADMIN_PASSWORD\fR, \fB\-\-admin\-password\fR=\fIADMIN_PASSWORD\fR Admin user Kerberos password used for connection check .TP -\fB\-\-setup\-ca\fR -Install and configure a CA on this replica. If a CA is not configured then -certificate operations will be forwarded to a master with a CA installed. +\fB\-N\fR, \fB\-\-no\-ntp\fR +Do not configure NTP +.TP +\fB\-\-no\-ui\-redirect\fR +Do not automatically redirect to the Web UI. +.TP +\fB\-\-skip\-conncheck\fR +Skip connection check to remote master +.TP +\fB\-d\fR, \fB\-\-debug +Enable debug logging when more verbose output is needed +.TP +\fB\-U\fR, \fB\-\-unattended\fR +An unattended installation that will never prompt for user input + +.SS "CERTIFICATE SYSTEM OPTIONS" +.TP +\fB\-\-no\-pkinit\fR +Disables pkinit setup steps + +.SS "DNS OPTIONS" .TP \fB\-\-setup\-dns\fR Generate a DNS zone if it does not exist already and configure the DNS server. @@ -64,18 +81,7 @@ Do not create reverse DNS zone .TP \fB\-\-no\-host\-dns\fR Do not use DNS for hostname lookup during installation -.TP -\fB\-\-no\-pkinit\fR -Disables pkinit setup steps -.TP -\fB\-\-no\-ui\-redirect\fR -Do not automatically redirect to the Web UI. -.TP -\fB\-\-skip\-conncheck\fR -Skip connection check to remote master -.TP -\fB\-U\fR, \fB\-\-unattended\fR -An unattended installation that will never prompt for user input + .SH "EXIT STATUS" 0 if the command was successful |