mirror of
https://salsa.debian.org/freeipa-team/freeipa.git
synced 2025-02-25 18:55:28 -06:00
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
This commit is contained in:
Martin Kosek
@@ -42,7 +42,7 @@ try:
|
||||
from ipapython.config import IPAOptionParser
|
||||
import SSSDConfig
|
||||
from ConfigParser import RawConfigParser
|
||||
from optparse import SUPPRESS_HELP
|
||||
from optparse import SUPPRESS_HELP, OptionGroup
|
||||
except ImportError:
|
||||
print >> sys.stderr, """\
|
||||
There was a problem importing one of the required Python modules. The
|
||||
@@ -61,46 +61,61 @@ client_nss_nickname_format = 'IPA Machine Certificate - %s'
|
||||
|
||||
def parse_options():
|
||||
parser = IPAOptionParser(version=version.VERSION)
|
||||
parser.add_option("--domain", dest="domain", help="domain name")
|
||||
parser.add_option("--server", dest="server", help="IPA server")
|
||||
parser.add_option("--realm", dest="realm_name", help="realm name")
|
||||
parser.add_option("-f", "--force", dest="force", action="store_true",
|
||||
default=False, help="force setting of LDAP/Kerberos conf")
|
||||
parser.add_option("-d", "--debug", dest="debug", action="store_true",
|
||||
default=False, help="print debugging information")
|
||||
parser.add_option("-U", "--unattended", dest="unattended",
|
||||
action="store_true",
|
||||
help="unattended installation never prompts the user")
|
||||
parser.add_option("--ntp-server", dest="ntp_server", help="ntp server to use")
|
||||
parser.add_option("-S", "--no-sssd", action="store_false",
|
||||
help="Do not configure the client to use SSSD for authentication", default=True, dest="sssd")
|
||||
parser.add_option("-N", "--no-ntp", action="store_false",
|
||||
help="do not configure ntp", default=True, dest="conf_ntp")
|
||||
parser.add_option("-w", "--password", dest="password", sensitive=True,
|
||||
|
||||
basic_group = OptionGroup(parser, "basic options")
|
||||
basic_group.add_option("--domain", dest="domain", help="domain name")
|
||||
basic_group.add_option("--server", dest="server", help="IPA server")
|
||||
basic_group.add_option("--realm", dest="realm_name", help="realm name")
|
||||
basic_group.add_option("-p", "--principal", dest="principal",
|
||||
help="principal to use to join the IPA realm"),
|
||||
basic_group.add_option("-w", "--password", dest="password", sensitive=True,
|
||||
help="password to join the IPA realm (assumes bulk password unless principal is also set)"),
|
||||
parser.add_option("-W", dest="prompt_password", action="store_true",
|
||||
basic_group.add_option("-W", dest="prompt_password", action="store_true",
|
||||
default=False,
|
||||
help="Prompt for a password to join the IPA realm"),
|
||||
parser.add_option("-p", "--principal", dest="principal",
|
||||
help="principal to use to join the IPA realm"),
|
||||
# --on-master is used in ipa-server-install and ipa-replica-install
|
||||
# only, it isn't meant to be used on clients.
|
||||
parser.add_option("--on-master", dest="on_master", action="store_true",
|
||||
help=SUPPRESS_HELP, default=False)
|
||||
parser.add_option("--permit", dest="permit", action="store_true",
|
||||
help="disable access rules by default, permit all access.", default=False)
|
||||
parser.add_option("--mkhomedir", dest="mkhomedir", action="store_true",
|
||||
help="create home directories for users on their first login", default=False)
|
||||
parser.add_option("", "--uninstall", dest="uninstall", action="store_true",
|
||||
default=False, help="uninstall an existing installation")
|
||||
parser.add_option("", "--hostname", dest="hostname",
|
||||
basic_group.add_option("--mkhomedir", dest="mkhomedir",
|
||||
action="store_true", default=False,
|
||||
help="create home directories for users on their first login")
|
||||
basic_group.add_option("", "--hostname", dest="hostname",
|
||||
help="The hostname of this server (FQDN). If specified, the hostname will be set and "
|
||||
"the system configuration will be updated to persist over reboot. "
|
||||
"By default a nodename result from uname(2) is used.")
|
||||
parser.add_option("", "--enable-dns-updates", dest="dns_updates", action="store_true", default=False,
|
||||
basic_group.add_option("--ntp-server", dest="ntp_server", help="ntp server to use")
|
||||
basic_group.add_option("-N", "--no-ntp", action="store_false",
|
||||
help="do not configure ntp", default=True, dest="conf_ntp")
|
||||
basic_group.add_option("-f", "--force", dest="force", action="store_true",
|
||||
default=False, help="force setting of LDAP/Kerberos conf")
|
||||
basic_group.add_option("-d", "--debug", dest="debug", action="store_true",
|
||||
default=False, help="print debugging information")
|
||||
basic_group.add_option("-U", "--unattended", dest="unattended",
|
||||
action="store_true",
|
||||
help="unattended (un)installation never prompts the user")
|
||||
# --on-master is used in ipa-server-install and ipa-replica-install
|
||||
# only, it isn't meant to be used on clients.
|
||||
basic_group.add_option("--on-master", dest="on_master", action="store_true",
|
||||
help=SUPPRESS_HELP, default=False)
|
||||
parser.add_option_group(basic_group)
|
||||
|
||||
sssd_group = OptionGroup(parser, "SSSD options")
|
||||
sssd_group.add_option("--permit", dest="permit",
|
||||
action="store_true", default=False,
|
||||
help="disable access rules by default, permit all access.")
|
||||
sssd_group.add_option("", "--enable-dns-updates", dest="dns_updates",
|
||||
action="store_true", default=False,
|
||||
help="Configures the machine to attempt dns updates when the ip address changes.")
|
||||
parser.add_option("--no-krb5-offline-passwords", dest="krb5_offline_passwords", action="store_false",
|
||||
help="Configure SSSD not to store user password when the server is offline", default=True)
|
||||
sssd_group.add_option("--no-krb5-offline-passwords", dest="krb5_offline_passwords",
|
||||
action="store_false", default=True,
|
||||
help="Configure SSSD not to store user password when the server is offline")
|
||||
sssd_group.add_option("-S", "--no-sssd", dest="sssd",
|
||||
action="store_false", default=True,
|
||||
help="Do not configure the client to use SSSD for authentication")
|
||||
parser.add_option_group(sssd_group)
|
||||
|
||||
uninstall_group = OptionGroup(parser, "uninstall options")
|
||||
uninstall_group.add_option("", "--uninstall", dest="uninstall", action="store_true",
|
||||
default=False, help="uninstall an existing installation. The uninstall can " \
|
||||
"be run with --unattended option")
|
||||
parser.add_option_group(uninstall_group)
|
||||
|
||||
options, args = parser.parse_args()
|
||||
safe_opts = parser.get_safe_opts(options)
|
||||
|
||||
@@ -16,7 +16,7 @@
|
||||
.\"
|
||||
.\" Author: Rob Crittenden <rcritten@@redhat.com>
|
||||
.\"
|
||||
.TH "default.conf" "5" "02/21/2011" "freeipa" ""
|
||||
.TH "default.conf" "5" "Feb 21 2011" "FreeIPA" "FreeIPA Manual Pages"
|
||||
.SH "NAME"
|
||||
default.conf \- IPA configuration file
|
||||
.SH "SYNOPSIS"
|
||||
|
||||
@@ -16,7 +16,7 @@
|
||||
.\"
|
||||
.\" Author: Rob Crittenden <rcritten@redhat.com>
|
||||
.\"
|
||||
.TH "ipa-client-install" "1" "Mar 14 2008" "freeipa" ""
|
||||
.TH "ipa-client-install" "1" "Sep 5 2011" "FreeIPA" "FreeIPA Manual Pages"
|
||||
.SH "NAME"
|
||||
ipa\-client\-install \- Configure an IPA client
|
||||
.SH "SYNOPSIS"
|
||||
@@ -29,7 +29,9 @@ By default this configures SSSD to connect to an IPA server for authentication a
|
||||
An authorized user is required to join a client machine to IPA. This can take the form of a kerberos principal or a one\-time password associated with the machine.
|
||||
|
||||
This same tool is used to unconfigure IPA and attemps to return the machine to its previous state. Part of this process is to unenroll the host from the IPA server. Unenrollment consists of disabling the prinicipal key on the IPA server so that it may be re\-enrolled. The machine principal in /etc/krb5.keytab (host/<fqdn>@REALM) is used to authenticate to the IPA server to unenroll itself. If this principal does not exist then unenrollment will fail and an administrator will need to disable the host principal (ipa host\-disable <fqdn>).
|
||||
|
||||
.SH "OPTIONS"
|
||||
.SS "BASIC OPTIONS"
|
||||
.TP
|
||||
\fB\-\-domain\fR=\fIDOMAIN\fR
|
||||
Set the domain name to DOMAIN
|
||||
@@ -40,6 +42,27 @@ Set the IPA server to connect to
|
||||
\fB\-\-realm\fR=\fIREALM_NAME\fR
|
||||
Set the IPA realm name to REALM_NAME
|
||||
.TP
|
||||
\fB\-p\fR, \fB\-\-principal\fR
|
||||
Authorized kerberos principal to use to join the IPA realm.
|
||||
.TP
|
||||
\fB\-w\fR \fIPASSWORD\fR, \fB\-\-password\fR=\fIPASSWORD\fR
|
||||
Password for joining a machine to the IPA realm. Assumes bulk password unless principal is also set.
|
||||
.TP
|
||||
\fB\-W\fR
|
||||
Prompt for the password for joining a machine to the IPA realm.
|
||||
.TP
|
||||
\fB\-\-mkhomedir\fR
|
||||
Configure PAM to create a users home directory if it does not exist.
|
||||
.TP
|
||||
\fB\-\-hostname\fR
|
||||
The hostname of this server (FQDN). If specified, the hostname will be set and the system configuration will be updated to persist over reboot. By default a nodename result from uname(2) is used.
|
||||
.TP
|
||||
\fB\-\-ntp\-server\fR=\fINTP_SERVER\fR
|
||||
Configure ntpd to use this NTP server.
|
||||
.TP
|
||||
\fB\-N\fR, \fB\-\-no\-ntp\fR
|
||||
Do not configure or enable NTP.
|
||||
.TP
|
||||
\fB\-f\fR, \fB\-\-force\fR
|
||||
Force the settings even if errors occur
|
||||
.TP
|
||||
@@ -48,42 +71,28 @@ Print debugging information to stdout
|
||||
.TP
|
||||
\fB\-U\fR, \fB\-\-unattended\fR
|
||||
Unattended installation. The user will not be prompted.
|
||||
.TP
|
||||
\fB\-\-ntp\-server\fR=\fINTP_SERVER\fR
|
||||
Configure ntpd to use this NTP server.
|
||||
.TP
|
||||
\fB\-S\fR, \fB\-\-no\-sssd\fR
|
||||
Do not configure the client to use SSSD for authentication, use nss_ldap instead.
|
||||
.TP
|
||||
\fB\-N\fR, \fB\-\-no\-ntp\fR
|
||||
Do not configure or enable NTP.
|
||||
.TP
|
||||
\fB\-w\fR \fIPASSWORD\fR, \fB\-\-password\fR=\fIPASSWORD\fR
|
||||
Password for joining a machine to the IPA realm. Assumes bulk password unless principal is also set.
|
||||
.TP
|
||||
\fB\-W\fR
|
||||
Prompt for the password for joining a machine to the IPA realm.
|
||||
.TP
|
||||
\fB\-p\fR, \fB\-\-principal\fR
|
||||
Authorized kerberos principal to use to join the IPA realm.
|
||||
|
||||
.SS "SSSD OPTIONS"
|
||||
.TP
|
||||
\fB\-\-permit\fR
|
||||
Configure SSSD to permit all access. Otherwise the machine will be controlled by the Host\-based Access Controls (HBAC) on the IPA server.
|
||||
.TP
|
||||
\fB\-\-mkhomedir\fR
|
||||
Configure PAM to create a users home directory if it does not exist.
|
||||
.TP
|
||||
\fB\-\-uninstall\fR
|
||||
Remove the IPA client software and restore the configuration to the pre\-IPA state.
|
||||
.TP
|
||||
\fB\-\-hostname\fR
|
||||
The hostname of this server (FQDN). If specified, the hostname will be set and the system configuration will be updated to persist over reboot. By default a nodename result from uname(2) is used.
|
||||
.TP
|
||||
\fB\-\-enable\-dns\-updates\fR
|
||||
This option tells SSSD to automatically update DNS with the IP address of this client.
|
||||
.TP
|
||||
\fB\-\-no\-krb5\-offline\-passwords\fR
|
||||
Configure SSSD not to store user password when the server is offline.
|
||||
.TP
|
||||
\fB\-S\fR, \fB\-\-no\-sssd\fR
|
||||
Do not configure the client to use SSSD for authentication, use nss_ldap instead.
|
||||
|
||||
.SS "UNINSTALL OPTIONS"
|
||||
.TP
|
||||
\fB\-\-uninstall\fR
|
||||
Remove the IPA client software and restore the configuration to the pre\-IPA state.
|
||||
\fB\-U\fR, \fB\-\-unattended\fR
|
||||
Unattended uninstallation. The user will not be prompted.
|
||||
|
||||
.SH "EXIT STATUS"
|
||||
0 if the installation was successful
|
||||
|
||||
|
||||
@@ -17,7 +17,7 @@
|
||||
.\" Author: Karl MacMillan <kmacmill@redhat.com>
|
||||
.\" Author: Simo Sorce <ssorce@redhat.com>
|
||||
.\"
|
||||
.TH "ipa-getkeytab" "1" "Oct 10 2007" "freeipa" ""
|
||||
.TH "ipa-getkeytab" "1" "Oct 10 2007" "FreeIPA" "FreeIPA Manual Pages"
|
||||
.SH "NAME"
|
||||
ipa\-getkeytab \- Get a keytab for a Kerberos principal
|
||||
.SH "SYNOPSIS"
|
||||
|
||||
@@ -16,7 +16,7 @@
|
||||
.\"
|
||||
.\" Author: Rob Crittenden <rcritten@redhat.com>
|
||||
.\"
|
||||
.TH "ipa-join" "1" "Oct 8 2009" "freeipa" ""
|
||||
.TH "ipa-join" "1" "Oct 8 2009" "FreeIPA" "FreeIPA Manual Pages"
|
||||
.SH "NAME"
|
||||
ipa\-join \- Join a machine to an IPA realm and get a keytab for the host service principal
|
||||
.SH "SYNOPSIS"
|
||||
|
||||
@@ -17,7 +17,7 @@
|
||||
.\" Author: Rob Crittenden <rcritten@redhat.com>
|
||||
.\"
|
||||
.\"
|
||||
.TH "ipa-rmkeytab" "1" "Oct 30 2009" "freeipa" ""
|
||||
.TH "ipa-rmkeytab" "1" "Oct 30 2009" "FreeIPA" "FreeIPA Manual Pages"
|
||||
.SH "NAME"
|
||||
ipa\-rmkeytab \- Remove a kerberos principal from a keytab
|
||||
.SH "SYNOPSIS"
|
||||
|
||||
Reference in New Issue
Block a user