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/ipa-replica-install | |
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/ipa-replica-install')
-rwxr-xr-x | install/tools/ipa-replica-install | 54 |
1 files changed, 32 insertions, 22 deletions
diff --git a/install/tools/ipa-replica-install b/install/tools/ipa-replica-install index 0d6226280..50c425624 100755 --- a/install/tools/ipa-replica-install +++ b/install/tools/ipa-replica-install @@ -23,6 +23,7 @@ import socket import os, pwd, traceback, logging, shutil import grp +from optparse import OptionGroup from ipapython import ipautil @@ -45,36 +46,45 @@ REPLICA_INFO_TOP_DIR=None def parse_options(): usage = "%prog [options] REPLICA_FILE" parser = IPAOptionParser(usage=usage, version=version.VERSION) - parser.add_option("-N", "--no-ntp", dest="conf_ntp", action="store_false", - help="do not configure ntp", default=True) - parser.add_option("-d", "--debug", dest="debug", action="store_true", - default=False, help="gather extra debugging information") - parser.add_option("-p", "--password", dest="password", sensitive=True, + + basic_group = OptionGroup(parser, "basic options") + basic_group.add_option("--setup-ca", dest="setup_ca", action="store_true", + default=False, help="configure a dogtag CA") + basic_group.add_option("-p", "--password", dest="password", sensitive=True, help="Directory Manager (existing master) password") - parser.add_option("-w", "--admin-password", dest="admin_password", sensitive=True, + basic_group.add_option("-w", "--admin-password", dest="admin_password", sensitive=True, help="Admin user Kerberos password used for connection check") - parser.add_option("--setup-dns", dest="setup_dns", action="store_true", + basic_group.add_option("-N", "--no-ntp", dest="conf_ntp", action="store_false", + help="do not configure ntp", default=True) + basic_group.add_option("--no-ui-redirect", dest="ui_redirect", action="store_false", + default=True, help="Do not automatically redirect to the Web UI") + basic_group.add_option("--skip-conncheck", dest="skip_conncheck", action="store_true", + default=False, help="skip connection check to remote master") + basic_group.add_option("-d", "--debug", dest="debug", action="store_true", + default=False, help="gather extra debugging information") + basic_group.add_option("-U", "--unattended", dest="unattended", action="store_true", + default=False, help="unattended installation never prompts the user") + parser.add_option_group(basic_group) + + cert_group = OptionGroup(parser, "certificate system options") + cert_group.add_option("--no-pkinit", dest="setup_pkinit", action="store_false", + default=True, help="disables pkinit setup steps") + parser.add_option_group(cert_group) + + dns_group = OptionGroup(parser, "DNS options") + dns_group.add_option("--setup-dns", dest="setup_dns", action="store_true", default=False, help="configure bind with our zone") - parser.add_option("--forwarder", dest="forwarders", action="append", + dns_group.add_option("--forwarder", dest="forwarders", action="append", type="ip", help="Add a DNS forwarder") - parser.add_option("--no-forwarders", dest="no_forwarders", action="store_true", + dns_group.add_option("--no-forwarders", dest="no_forwarders", action="store_true", default=False, help="Do not add any DNS forwarders, use root servers instead") - parser.add_option("--reverse-zone", dest="reverse_zone", help="The reverse DNS zone to use") - parser.add_option("--no-reverse", dest="no_reverse", action="store_true", + dns_group.add_option("--reverse-zone", dest="reverse_zone", help="The reverse DNS zone to use") + dns_group.add_option("--no-reverse", dest="no_reverse", action="store_true", default=False, help="Do not create reverse DNS zone") - parser.add_option("--no-host-dns", dest="no_host_dns", action="store_true", + dns_group.add_option("--no-host-dns", dest="no_host_dns", action="store_true", default=False, help="Do not use DNS for hostname lookup during installation") - parser.add_option("--no-pkinit", dest="setup_pkinit", action="store_false", - default=True, help="disables pkinit setup steps") - parser.add_option("--no-ui-redirect", dest="ui_redirect", action="store_false", - default=True, help="Do not automatically redirect to the Web UI") - parser.add_option("--skip-conncheck", dest="skip_conncheck", action="store_true", - default=False, help="skip connection check to remote master") - parser.add_option("--setup-ca", dest="setup_ca", action="store_true", - default=False, help="configure a dogtag CA") - parser.add_option("-U", "--unattended", dest="unattended", action="store_true", - default=False, help="unattended installation never prompts the user") + parser.add_option_group(dns_group) options, args = parser.parse_args() safe_options = parser.get_safe_opts(options) |