Merge lp:~derek-name/openvista-gtm-integration/bug519042 into lp:openvista-gtm-integration

[Derek_]

[Jon Tai (jontai)]

I like what you did with the man page, but I think the -h and -V lines should be separate. Also, please make the same change to all the other man pages.

The rest of the changes look good.

[lp:~derek-name/openvista-gtm-integration/bug519042]

139. By Derek_ on 2010-09-23

ovinstanceadd.8 (man page): Show that -h and -V options are each used exclusively of anything else.

140. By Derek_ on 2010-09-23

Update all man pages, formatting the synopsis section to show -h and -V options as exclusive.

[Jon Tai (jontai)]

review: Approve

=== modified file 'docs/man1/openvista.1'
--- docs/man1/openvista.1	2009-12-01 21:55:02 +0000
+++ docs/man1/openvista.1	2010-09-23 21:45:57 +0000
@@ -2,8 +2,12 @@
 .SH NAME
 openvista \- wrapper around "mumps -dir" for programmers and admins
 .SH SYNOPSIS
-.B openvista [-h] [-V]
+.B openvista
 .I instance_name
+.br
+.B ovrestore -h
+.br
+.B ovrestore -V
 .SH DESCRIPTION
 .B openvista
 is called by "full" users (programmers or administrators with a Linux account)

=== modified file 'docs/man1/ovbackup.1'
--- docs/man1/ovbackup.1	2009-12-10 22:00:27 +0000
+++ docs/man1/ovbackup.1	2010-09-23 21:45:57 +0000
@@ -2,8 +2,13 @@
 .SH NAME
 ovbackup \- back up routines and globals of an OpenVista instance
 .SH SYNOPSIS
-.B ovbackup [-h] [-V] [-q]
+.B ovbackup
+[\fB-q\fR]
 .I instance_name
+.br
+.B ovbackup -h
+.br
+.B ovbackup -V
 .SH DESCRIPTION
 Each invocation of
 .B ovbackup

=== modified file 'docs/man1/ovcc.1'
--- docs/man1/ovcc.1	2009-12-01 21:55:02 +0000
+++ docs/man1/ovcc.1	2010-09-23 21:45:57 +0000
@@ -2,8 +2,12 @@
 .SH NAME
 ovcc \- wrapper around "mumps -run ^MSCOVCI" for OpenVista Classic Component
 .SH SYNOPSIS
-.B ovcc [-h] [-V]
+.B ovcc
 .I instance_name
+.br
+.B ovcc -h
+.br
+.B ovcc -V
 .SH DESCRIPTION
 .B ovcc
 is called as an SSH forced command.  It is used by the OpenVista Classic

=== modified file 'docs/man1/ovcheckperms.1'
--- docs/man1/ovcheckperms.1	2009-12-12 01:26:41 +0000
+++ docs/man1/ovcheckperms.1	2010-09-23 21:45:57 +0000
@@ -2,8 +2,12 @@
 .SH NAME
 ovcheckperms \- verify permissions
 .SH SYNOPSIS
-.B ovcheckperms [-h] [-V]
+.B ovcheckperms
 .I instance_name
+.br
+.B ovcheckperms -h
+.br
+.B ovcheckperms -V
 .SH DESCRIPTION
 .B ovcheckperms
 verifies that all files and directories in an OpenVista instance have the

=== modified file 'docs/man1/ovcompile.1'
--- docs/man1/ovcompile.1	2010-02-09 23:34:35 +0000
+++ docs/man1/ovcompile.1	2010-09-23 21:45:57 +0000
@@ -2,8 +2,12 @@
 .SH NAME
 ovcompile \- (re)compile routines in an OpenVista instance
 .SH SYNOPSIS
-.B ovcompile [-h] [-V]
+.B ovcompile
 .I instance_name
+.br
+.B ovcompile -h
+.br
+.B ovcompile -V
 .SH DESCRIPTION
 .B ovcompile
 (re)compiles all routines in an OpenVista instance.

=== modified file 'docs/man1/ovgetvar.1'
--- docs/man1/ovgetvar.1	2009-12-12 01:26:41 +0000
+++ docs/man1/ovgetvar.1	2010-09-23 21:45:57 +0000
@@ -2,9 +2,13 @@
 .SH NAME
 ovgetvar \- get GT.M environment variable
 .SH SYNOPSIS
-.B ovgetvar [-h] [-V]
+.B ovgetvar
 .I instance_name
 .I gtm_dist|gtm_path|gtmroutines|gtmgbldir
+.br
+.B ovgetvar -h
+.br
+.B ovgetvar -V
 .SH DESCRIPTION
 .B ovgetvar
 prints the effective values of 

=== modified file 'docs/man1/ovimport.1'
--- docs/man1/ovimport.1	2009-12-10 22:00:27 +0000
+++ docs/man1/ovimport.1	2010-09-23 21:45:57 +0000
@@ -2,16 +2,18 @@
 .SH NAME
 ovimport \- import routines and globals into an OpenVista instance
 .SH SYNOPSIS
-.B ovimport [-h] [-V] [-q] [-f] [-t 
-.I target
-.B ] [-c 
-.I imported|all|none
-.B ] [-r 
-.I routines
-.B ] [-g 
-.I globals
-.B ] 
+.B ovimport
+[\fB-q\fR]
+[\fB-f\fR]
+[\fB-t\fR \fItarget\fR]
+[\fB-c\fR \fIimported|all|none\fR]
+[\fB-r\fR \fIroutines\fR]
+[\fB-g\fR \fIglobals\fR]
 .I instance_name
+.br
+.B ovimport -h
+.br
+.B ovimport -V
 .SH DESCRIPTION
 .B ovimport
 imports routines and globals into an OpenVista instance.

=== modified file 'docs/man1/ovpurgejournals.1'
--- docs/man1/ovpurgejournals.1	2009-12-01 22:21:41 +0000
+++ docs/man1/ovpurgejournals.1	2010-09-23 21:45:57 +0000
@@ -2,8 +2,12 @@
 .SH NAME
 ovpurgejournals \- delete old journal files
 .SH SYNOPSIS
-.B ovpurgejournals [-h] [-V]
+.B ovpurgejournals
 .I instance_name
+.br
+.B ovpurgejournals -h
+.br
+.B ovpurgejournals -V
 .SH DESCRIPTION
 .B ovpurgejournals
 deletes old journal files beyond the configured number of journal files to

=== modified file 'docs/man1/ovswitchjournals.1'
--- docs/man1/ovswitchjournals.1	2009-12-01 21:55:02 +0000
+++ docs/man1/ovswitchjournals.1	2010-09-23 21:45:57 +0000
@@ -2,8 +2,12 @@
 .SH NAME
 ovswitchjournals \- force GT.M to switch to a new journal file
 .SH SYNOPSIS
-.B ovswitchjournals [-h] [-V]
+.B ovswitchjournals
 .I instance_name
+.br
+.B ovswitchjournals -h
+.br
+.B ovswitchjournals -V
 .SH DESCRIPTION
 .B ovswitchjournals
 forces GT.M to switch to a new journal file.  If journaling is not enabled on a

=== modified file 'docs/man1/ovtied.1'
--- docs/man1/ovtied.1	2009-12-01 21:55:02 +0000
+++ docs/man1/ovtied.1	2010-09-23 21:45:57 +0000
@@ -2,8 +2,12 @@
 .SH NAME
 ovtied \- wrapper around "mumps -run ^ZU" for end users
 .SH SYNOPSIS
-.B ovtied [-h] [-V]
+.B ovtied
 .I instance_name
+.br
+.B ovtied -h
+.br
+.B ovtied -V
 .SH DESCRIPTION
 .B ovtied
 is called as an SSH forced command for tied accounts.  It presents

=== modified file 'docs/man8/gtmsignal.8'
--- docs/man8/gtmsignal.8	2009-08-03 19:22:13 +0000
+++ docs/man8/gtmsignal.8	2010-09-23 21:45:57 +0000
@@ -2,8 +2,10 @@
 .SH NAME
 gtmsignal \- send mupip STOP or INTRPT to GT.M processes
 .SH SYNOPSIS
-.B gtmsignal [-a|--all] [-s|--stop] [-h|--help] [-q|--quiet]
-.I \fR[\fIpid\fR...]
+.B gtmsignal
+[\fB-a|--all\fR] [\fB-s|--stop\fR] [\fB-q|--quiet\fR] [\fIpid\fR...]
+.br
+.B gtmsignal -h|--help
 .SH DESCRIPTION
 .B mupip
 can be used to send signals to other GT.M processes if the user calling mupip

=== modified file 'docs/man8/ovinstanceadd.8'
--- docs/man8/ovinstanceadd.8	2009-12-01 21:55:02 +0000
+++ docs/man8/ovinstanceadd.8	2010-09-23 21:45:57 +0000
@@ -1,9 +1,14 @@
-.TH ovinstanceadd 8 "1 Dec 2009" Linux "User Manuals"
+.TH ovinstanceadd 8 "22 Sep 2010" Linux "User Manuals"
 .SH NAME
 ovinstanceadd \- create a new OpenVista instance
 .SH SYNOPSIS
-.B ovinstanceadd [-h] [-V]
+.B ovinstanceadd
+[\fB-p\fR \fIpath\fR]
 .I instance_name
+.br
+.B ovinstanceadd -h
+.br
+.B ovinstanceadd -V
 .SH DESCRIPTION
 .B ovinstanceadd
 creates a new OpenVista instance.  It ensures that the 
@@ -14,6 +19,8 @@
 the instance, sets up an ssh forced command to run ^ZU in the instance, and
 creates the webdav root for the instance.
 .SH OPTIONS
+.IP -p
+path; value of $gtm_dist for this instance
 .IP -h
 display help text and exit
 .IP -V

=== modified file 'docs/man8/ovinstancedel.8'
--- docs/man8/ovinstancedel.8	2009-12-01 21:55:02 +0000
+++ docs/man8/ovinstancedel.8	2010-09-23 21:45:57 +0000
@@ -2,8 +2,13 @@
 .SH NAME
 ovinstancedel \- delete an OpenVista instance
 .SH SYNOPSIS
-.B ovinstancedel [-h] [-V] [-y]
+.B ovinstancedel
+[\fB-y\fR]
 .I instance_name
+.br
+.B ovinstancedel -h
+.br
+.B ovinstancedel -V
 .SH DESCRIPTION
 .B ovinstancedel
 deletes an OpenVista instance.  All routines, database files, journals,

=== modified file 'docs/man8/ovrestore.8'
--- docs/man8/ovrestore.8	2009-12-10 22:00:27 +0000
+++ docs/man8/ovrestore.8	2010-09-23 21:45:57 +0000
@@ -2,8 +2,13 @@
 .SH NAME
 ovrestore \- restores a backup file into an OpenVista instance
 .SH SYNOPSIS
-.B ovrestore [-h] [-V] [-y] [-q] [-j] [-f]
+.B ovrestore
+[\fB-y\fR] [\fB-q\fR] [\fB-j\fR] [\fB-f\fR]
 .I backup_file instance_name
+.br
+.B ovrestore -h
+.br
+.B ovrestore -V
 .SH DESCRIPTION
 .B ovrestore
 restores a backup created by 

=== modified file 'scripts/usr/sbin/ovinstanceadd'
--- scripts/usr/sbin/ovinstanceadd	2010-05-27 17:41:20 +0000
+++ scripts/usr/sbin/ovinstanceadd	2010-09-23 21:45:57 +0000
@@ -8,21 +8,21 @@
 # instance, and creates the webdav root for the instance.
 
 
-# Copyright (C) 2009 Medsphere Systems Corporation
+# Copyright (C) 2009-2010 Medsphere Systems Corporation
 #
 # This program is free software; you can redistribute it and/or modify it solely
 # under the terms of the GNU Affero General Public License version 3 as published
 # by the Free Software Foundation.
-# 
+#
 # 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 Affero General Public License
 # for more details.
-# 
+#
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses>.
-# 
-# You can contact Medsphere Systems Corporation headquarters at 1917 Palomar 
+#
+# You can contact Medsphere Systems Corporation headquarters at 1917 Palomar
 # Oaks Way, Suite 200, Carlsbad, CA 92008 or at [e-mail].
 
 
@@ -30,14 +30,15 @@
 . /usr/lib/openvista/functions
 
 # parse arguments
-while getopts hV option; do
+while getopts hVp: option; do
     case $option in
         h)
             cat <<EOF
-Usage: ovinstanceadd INSTANCE_NAME
+Usage: ovinstanceadd [-p PATH] INSTANCE_NAME
    or  ovinstanceadd -h
    or  ovinstanceadd -V
 
+  -p  path; value of $gtm_dist for this instance
   -h  display this help text and exit
   -V  display version information and exit
 EOF
@@ -45,14 +46,17 @@
             ;;
         V)
             cat <<EOF
-ovinstanceadd 0.8.9
-Copyright (C) 2009 Medsphere Systems Corporation
+ovinstanceadd 0.8.10
+Copyright (C) 2009-2010 Medsphere Systems Corporation
 
-ovinstanceadd is powered by Medsphere and part of a suite of open source 
-utilities licensed under the AGPL, available at http://medsphere.org.  
+ovinstanceadd is powered by Medsphere and part of a suite of open source
+utilities licensed under the AGPL, available at http://medsphere.org.
 EOF
             exit 0
             ;;
+        p)
+            gtm="$OPTARG"
+            ;;
     esac
 done
 shift `expr $OPTIND - 1`
@@ -77,7 +81,7 @@
 
 # check for for valid arguments (requires correct permissions to do; must happen after permission checks)
 case $instance in
-    */*|*" "*|*"("*|*")"*)
+    */*|*" "*|*"("*|*")"*)  #"
         echo "ovinstanceadd: $instance: Instance name cannot contain slashes, spaces, or parenthesis" >&2
         exit 3
         ;;
@@ -88,6 +92,19 @@
     exit 9
 fi
 
+# check the gtm path value, if it was specified
+if [ "$gtm" ]; then
+    [ -d "$gtm" ] \
+      || { echo "ovinstanceadd: $gtm is not a directory" >&2
+           exit 3; }
+    [ -x "$gtm/mumps" ] \
+      || { echo "ovinstanceadd: $gtm does not contain mumps" >&2
+           exit 3; }
+    [ -f "$gtm/openvista.xc" ] \
+      || { echo "ovinstanceadd: $gtm does not contain openvista.xc" >&2
+           exit 3; }
+fi
+
 # check for other requirements
 if [ ! -d "$root" ]; then
     echo "ovinstanceadd: $root does not exist" >&2
@@ -111,26 +128,33 @@
     exit 1
 fi
 
-# find the latest version of GT.M installed on this system.   to qualify as a
-# valid GT.M version, the GT.M directory must contain a mumps executable and an
-# openvista.xc file (the latter is installed by the corresponding
-# openvista-libs-* package)
-#
-# sort using only the GT.M version (not including the _ and the arch) because _
-# sorts after A, so if we were to use the entire directory name, V5.3-004A_i686
-# would come before V5.3-004_i686 (so V5.3-004_i686 would be considered the
-# "later" version), which is wrong.
-for version in `ls -1 -d /opt/lsb-gtm/V*_i686 /opt/lsb-gtm/V*_x86_64 2> /dev/null | cut -d _ -f 1 | sort -r`; do
-    # prefer 64-bit GT.M over 32-bit GT.M
-    if [ -x "${version}_x86_64/mumps" ] && [ -f "${version}_x86_64/openvista.xc" ]; then
-        gtm="${version}_x86_64"
-        break
-    fi
-    if [ -x "${version}_i686/mumps" ] && [ -f "${version}_i686/openvista.xc" ]; then
-        gtm="${version}_i686"
-        break
-    fi
-done
+if [ -z "$gtm" ]; then
+    # This is skipped if gtm was already set by the command line option.
+    #
+    # find the latest version of GT.M installed on this system. to qualify as a
+    # valid GT.M version, the GT.M directory must contain a mumps executable and
+    # an openvista.xc file (the latter is installed by the corresponding
+    # openvista-libs-* package)
+    #
+    # sort using only the GT.M version (not including the _ and the arch)
+    # because _ sorts after A, so if we were to use the entire directory name,
+    # V5.3-004A_i686 would come before V5.3-004_i686 (so V5.3-004_i686 would be
+    # considered the "later" version), which is wrong.
+    for version in $(ls -1 -d /opt/lsb-gtm/V*_i686 /opt/lsb-gtm/V*_x86_64 \
+                     2> /dev/null | cut -d _ -f 1 | sort -r); do
+        # prefer 64-bit GT.M over 32-bit GT.M
+        if [ -x "${version}_x86_64/mumps" ] \
+          && [ -f "${version}_x86_64/openvista.xc" ]; then
+            gtm="${version}_x86_64"
+            break
+        fi
+        if [ -x "${version}_i686/mumps" ] \
+          && [ -f "${version}_i686/openvista.xc" ]; then
+            gtm="${version}_i686"
+            break
+        fi
+    done
+fi
 
 if [ -z "$gtm" ]; then
     echo "ovinstanceadd: No versions of GT.M found in /opt/lsb-gtm" >&2
@@ -183,7 +207,7 @@
 } || exit_with_error "ovinstanceadd" "Unable to create instance directories"
 
 # now that the directory structure exists, we can safely call set_gtm_env
-set_gtm_env "$instance" || 
+set_gtm_env "$instance" ||
 exit_with_error "ovinstanceadd" "Unable to set GT.M environment"
 
 {
@@ -212,7 +236,7 @@
 
 # mumps doesn't exit non-zero even if something goes wrong in ^GDE, so look for
 # the mumps.gld to determine success
-[ -f "$root/$instance/globals/mumps.gld" ] || 
+[ -f "$root/$instance/globals/mumps.gld" ] ||
 exit_with_error "ovinstanceadd" "Unable to create global directory file"
 
 {
@@ -227,14 +251,14 @@
   | grep -v '^$' \
   | logger -p user.info -t "ovinstanceadd[$$]"
 retval=${PIPESTATUS[0]}
-[ $retval -eq 0 ] || 
+[ $retval -eq 0 ] ||
 exit_with_error "ovinstanceadd" "Unable to enable journaling"
 
 (
     umask 027
     ssh-keygen -q -t rsa -f "$root/$instance/etc/$instance-tied_rsa_key" -C "$instance" -N "" &&
     ssh-keygen -q -t rsa -f "$root/$instance/etc/$instance-ovcc_rsa_key" -C "$instance" -N ""
-) || 
+) ||
 exit_with_error "ovinstanceadd" "Unable to generate SSH keys"
 
 # convert SSH key to PuTTY format for easy installation on Windows clients
@@ -258,10 +282,10 @@
 command=$command" && cat '$root/$instance/etc/$instance-tied_rsa_key.pub' >> '$home/.ssh/authorized_keys'"
 command=$command" && printf 'no-port-forwarding,no-X11-forwarding,no-agent-forwarding,command=\"/usr/bin/ovcc -- %s\" ' '$instance' >> '$home/.ssh/authorized_keys'"
 command=$command" && cat '$root/$instance/etc/$instance-ovcc_rsa_key.pub' >> '$home/.ssh/authorized_keys'"
-su -c "$command" "$user" || 
+su -c "$command" "$user" ||
 exit_with_error "ovinstanceadd" "Unable to update $home/.ssh/authorized_keys"
 
-install -o "$apache_user" -g "$apache_user" -m 755 -d "$docroot/webdav/$instance" || 
+install -o "$apache_user" -g "$apache_user" -m 755 -d "$docroot/webdav/$instance" ||
 exit_with_error "ovinstanceadd" "Unable to create webdav root"
 
 ln -s "$docroot/webdav/$instance" "$root/$instance/images"
@@ -270,10 +294,10 @@
     umask 077
     tr -dc '_A-Z-a-z-0-9' < /dev/urandom | head -c16 > "$root/$instance/etc/$instance-webdav_password"
 )
-[ -f "$root/$instance/etc/$instance-webdav_password" ] || 
+[ -f "$root/$instance/etc/$instance-webdav_password" ] ||
 exit_with_error "ovinstanceadd" "Unable to generate WebDAV password"
 
-htpasswd -b -m "$apache_conf/webdav.htpasswd" "$instance" "`cat \"$root/$instance/etc/$instance-webdav_password\"`" > /dev/null 2>&1 || 
+htpasswd -b -m "$apache_conf/webdav.htpasswd" "$instance" "`cat \"$root/$instance/etc/$instance-webdav_password\"`" > /dev/null 2>&1 ||
 exit_with_error "ovinstanceadd" "Unable to update $apache_conf/webdav.htpasswd"
 
 for plugin in openvista_databases openvista_locks openvista_processes; do