From 23e0e74c245604e69f2153c48028fde3aee2103a Mon Sep 17 00:00:00 2001
From: Mark Reynolds <mreynolds@redhat.com>
Date: Aug 26 2014 17:47:51 +0000
Subject: Ticket 97 - 389-console should provide man page


Bug Description:  The console is missing a man page.

Fix Description:  Add man page, and deploy it the man8 directory.

https://fedorahosted.org/389/ticket/97

Reviewed by: rmeggins & nhosoi(Thanks!!)

---

diff --git a/389-console.8 b/389-console.8
new file mode 100644
index 0000000..6230e90
--- /dev/null
+++ b/389-console.8
@@ -0,0 +1,78 @@
+.\"                                      Hey, EMACS: -*- nroff -*-
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH 389-console 8 "Aug 25, 2014"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh        disable hyphenation
+.\" .hy        enable hyphenation
+.\" .ad l      left justify
+.\" .ad b      justify to both left and right margins
+.\" .nf        disable filling
+.\" .fi        enable filling
+.\" .br        insert line break
+.\" .sp <n>    insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME 
+389-console - The 389 Directory Server UI
+.SH SYNOPSIS
+389-console [-a <URL>] [-A <local URL>] [-D <debug level>] [-f <output file>] [-h]
+[-l <Language Code>] [-s <SIE DN>] [-u <username/Bind DN>] [-w <password> | - (prompt for password)] 
+[-x <options>] [-y <password file>]         
+.SH DESCRIPTION
+A Java based remote management console used for Managing the Directory Server and Administration Server.
+.SH OPTIONS
+A summary of options is included below:
+.TP
+.B \fB\-a\fR \fIURL\fR
+Administration Server base URL.
+.TP
+.B \fB\-A\fR \fIURL\fR
+Local Administration Server URL.
+.TP
+.B \fB\-D\fR \fIDebug_Level\fR
+Debug level: 1 - 9
+.TP
+.B \fB\-f\fR \fIDebug_Output_File\fR
+Specifies the output file for the debug logging.
+.TP
+.B \fB\-h\fR
+.br
+Display usage.
+.TP
+.B \fB\-l\fR \fILanguage code\fR
+Language code.
+.TP
+.B \fB\-s\fR \fIServer DN/Identifier\fR
+server DN (cn=...) or instance ID (e.g. slapd-host)
+.TP
+.B \fB\-u\fR \fIusername/BiNd DN\fR
+The user name or bind DN to log into the console.
+.TP
+.B \fB\-w\fR \fIpassword\fR
+Password for the bind DN specified with the -u option.
+.TP
+.B \fB\-w\fR \fB\\\-\fR
+.br
+Prompt for the user password.
+.TP
+.B \fB\-x\fR \fIOption\fR
+Extra options (javalaf, nowinpos, nologo)
+.TP
+.B \fB\-y\fR \fIPassword_File\fR
+File containing user password.
+
+.SH EXAMPLE
+.TP
+389-console -a http://host.domain.com:9830 -u "cn=directory manager" -f ./passwd.txt -l en
+.TP
+389-console -D 9 -f /tmp/debug-output.txt -x nologo
+
+.SH AUTHOR
+389-console was written by the 389 Project.
+.SH "REPORTING BUGS"
+Report bugs to http://bugzilla.redhat.com.
+.SH COPYRIGHT
+Copyright \(co 2014 Red Hat, Inc.
diff --git a/389-console.spec b/389-console.spec
index 3ed2811..9f5100c 100755
--- a/389-console.spec
+++ b/389-console.spec
@@ -32,7 +32,7 @@ Administration Server and 389 Directory Server.
                                                                                 
 %build
 %{ant} \
-    -Dbuilt.dir=`pwd`/built
+    -Dbuilt.dir=`pwd`/built -Dman.dir=`pwd`/built%{_mandir}
 
 # add -Dlib.dir and -Dneed_libdir on those platforms where
 # jss is installed in a non-standard location
@@ -44,6 +44,8 @@ install -d $RPM_BUILD_ROOT%{_javadir}
 install -m644 built/*.jar $RPM_BUILD_ROOT%{_javadir}
 install -d $RPM_BUILD_ROOT%{_bindir}
 install -m755 built/%{name} $RPM_BUILD_ROOT/%{_bindir}
+install -d $RPM_BUILD_ROOT%{_mandir}/man8
+install -m built%{_mandir}/man8/* $RPM_BUILD_ROOT%{_mandir}/man8
 
 # create symlinks
 pushd $RPM_BUILD_ROOT%{_javadir}
@@ -61,6 +63,7 @@ rm -rf $RPM_BUILD_ROOT
 %{_javadir}/%{name}-%{major_version}_en.jar
 %{_javadir}/%{name}_en.jar
 %{_bindir}/%{name}
+%{_mandir}
 
 %changelog
 * Wed May 13 2009 Rich Megginson <rmeggins@redhat.com> 1.1.3-2
diff --git a/build.xml b/build.xml
index 5cb516f..2e4a4ab 100644
--- a/build.xml
+++ b/build.xml
@@ -40,6 +40,7 @@ END COPYRIGHT BLOCK
     <property name="console.local.location" value="/usr/share/java"/>
     <property name="lib.dir"                value="/usr/lib"/>
     <property name="need_libdir"            value=""/>
+    <property name="man.dir"                value="/usr/share/man"/>
 
     <!-- Verify that the required jars exist -->
     <fail message="LDAP JDK (${ldapjdk.jar.name}) does not exist in ${ldapjdk.local.location}">
@@ -85,8 +86,8 @@ END COPYRIGHT BLOCK
   </target>
 
   <!-- Build -->
-  <target name="build" depends="prepare,buildjar,buildscript"/>
-  <target name="buildnoscript" depends="prepare,buildjar"/>
+  <target name="build" depends="prepare,buildjar,buildscript,buildman"/>
+  <target name="buildnoscript" depends="prepare,buildjar,buildman"/>
 
   <target name="buildjar" depends="prepare">
     <!-- Create the theme jar file -->
@@ -116,4 +117,9 @@ END COPYRIGHT BLOCK
       <replacefilter token="@need_libdir@" value="${need_libdir}"/>
     </replace>
   </target>
+  <target name="buildman">
+    <!-- Man Page -->
+    <copy file="389-console.8" tofile="${man.dir}/man8/389-console.8"/>
+    <chmod file="${man.dir}/man8/389-console.8" perm="644"/>
+  </target>
 </project>