summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRob Crittenden <rcritten@redhat.com>2010-09-09 17:59:04 -0400
committerRob Crittenden <rcritten@redhat.com>2010-09-20 15:57:21 -0400
commit923f88c485f1ac0f87f130d515a021efbb80debc (patch)
tree70eb52a663689bee9136de06bb8e20906d967fd1
parentb47d6c09440799f41ca4aa91014a7829ada06114 (diff)
downloadfreeipa-923f88c485f1ac0f87f130d515a021efbb80debc.tar.gz
freeipa-923f88c485f1ac0f87f130d515a021efbb80debc.tar.xz
freeipa-923f88c485f1ac0f87f130d515a021efbb80debc.zip
Add missing man pageas for ipa-dns-install and ipa-upgradeconfig.
tickets 130 and 131
-rw-r--r--install/tools/man/ipa-dns-install.148
-rw-r--r--install/tools/man/ipa-upgradeconfig.833
2 files changed, 81 insertions, 0 deletions
diff --git a/install/tools/man/ipa-dns-install.1 b/install/tools/man/ipa-dns-install.1
new file mode 100644
index 000000000..4159625d0
--- /dev/null
+++ b/install/tools/man/ipa-dns-install.1
@@ -0,0 +1,48 @@
+.\" A man page for ipa-dns-install
+.\" Copyright (C) 2010 Red Hat, Inc.
+.\"
+.\" This is free software; you can redistribute it and/or modify it under
+.\" the terms of the GNU Library General Public License as published by
+.\" the Free Software Foundation; version 2 only
+.\"
+.\" This program is distributed in the hope that it will be useful, but
+.\" WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+.\" General Public License for more details.
+.\"
+.\" You should have received a copy of the GNU Library General Public
+.\" License along with this program; if not, write to the Free Software
+.\" Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+.\"
+.\" Author: Rob Crittenden <rcritten@redhat.com>
+.\"
+.TH "ipa-dns-install" "1" "Sep 9, 2010" "freeipa" ""
+.SH "NAME"
+ipa\-dns\-install \- Add DNS as a service to an IPA server
+.SH "SYNOPSIS"
+ipa\-dns\-install [\fIOPTION\fR]...
+.SH "DESCRIPTION"
+Adds DNS as an IPA\-managed service. This requires that the IPA server is already installed and configured.
+.SH "OPTIONS"
+.TP
+\fB\-p\fR <fl>DM_PASSWORD\fR, \fB\-\-ds\-password\fR=\fIDM_PASSWORD\fR
+The password to be used by the Directory Server for the Directory Manager user
+.TP
+\fB\-\-ip\-address\fR=\fIIP_ADDRESS\fR
+The IP address of the IPA server. If not provided then this is determined based on the hostname of the server.
+.TP
+\fB\-\-forwarders\fR=\fIFORWARDERS\fR
+A forwarder is a DNS server where queries for a specific non\-resolvable address can be directed. To define multiple forwarders use mutliple instances of \fB\-\-forwarders\fR
+.TP
+\fB\-\-noforwarders\fR
+Do not add any DNS forwarders, send non\-resolvable addresses to the DNS root servers.
+.TP
+\fB\-d\fR, \fB\-\-debug\fR
+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
+.SH "EXIT STATUS"
+0 if the installation was successful
+
+1 if an error occurred
diff --git a/install/tools/man/ipa-upgradeconfig.8 b/install/tools/man/ipa-upgradeconfig.8
new file mode 100644
index 000000000..ac9b2e9ac
--- /dev/null
+++ b/install/tools/man/ipa-upgradeconfig.8
@@ -0,0 +1,33 @@
+.\" A man page for ipa-upgradeconfig
+.\" Copyright (C) 2010 Red Hat, Inc.
+.\"
+.\" This is free software; you can redistribute it and/or modify it under
+.\" the terms of the GNU Library General Public License as published by
+.\" the Free Software Foundation; version 2 only
+.\"
+.\" This program is distributed in the hope that it will be useful, but
+.\" WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+.\" General Public License for more details.
+.\"
+.\" You should have received a copy of the GNU Library General Public
+.\" License along with this program; if not, write to the Free Software
+.\" Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+.\"
+.\" Author: Rob Crittenden <rcritten@redhat.com>
+.\"
+.TH "ipa-upgradeconfig" "8" "Sep 9 2010" "freeipa" ""
+.SH "NAME"
+ipa\-upgradeconfig \- Upgrade the IPA Apache configuration
+.SH "SYNOPSIS"
+ipa\-upgradeconfig
+.SH "DESCRIPTION"
+A tool to update the IPA Apache configuration during an upgrade.
+
+It examines the VERSION value in the head of \fI/etc/httpd/conf.d/ipa.conf\fR and \fI/etc/httpd/conf.d/ipa\-rewrite.conf\fR and compares this with the templates. If an update is needed then new files are written.
+
+This is not intended to be run by an end\-user. It is executed when the IPA rpms are upgraded.
+.SH "EXIT STATUS"
+0 if the update was successful or there was nothing to do
+
+1 if an error occurred