source: tags/confman-1.5.6a1/confmandoc.sh @ 123

#! /bin/bash
#
# This is a confman shell library that provides usage and help information.
# I wanted to get it out of the main script, cause it's really long. This also
# makes modularizing the code (think foreign languages if this ever goes 
# public) (Hah!) in the future.
#
# Author: Chris Cowart <ccowart@rescomp.berkeley.edu>
# Date: 14 April 2006
#
# $Id$

function print_usage {
cat <<EOF
$MYNAME provides a command-line interface to Rescomp's server
configuration management system.

Usage:
  $MYNAME [ help | -h | --help ] [ command ]
  $MYNAME setup
  $MYNAME update
  $MYNAME commit
  $MYNAME diff [ working_copy ]
  $MYNAME log [ working_copy ]
  $MYNAME create module
  $MYNAME rmmod module
  $MYNAME rename oldmodule newmodule
  $MYNAME import module livefile
  $MYNAME install workingfile [ workingfile ... ]
  $MYNAME status [ working_copy ]
  $MYNAME state
  $MYNAME ls [ workingfile | workingdirectory ]
  $MYNAME lsattr [ workingfile | workingdirectory ]
  $MYNAME chattr attribute value [ workingfile | workingdirectory ]
  $MYNAME rmattr attribute [ workingfile | workingdirectory ]
  $MYNAME rm workingfile
  $MYNAME cp src_working_copy dest_working_copy
  $MYNAME mv src_working_copy dest_working_copy
  $MYNAME mkdir workingdirectory
  $MYNAME revert workingfile
  $MYNAME chown owner [ workingfile | workingdirectory ] 
  $MYNAME chgrp group [ workingfile | workingdirectory ] 
  $MYNAME chmod mode  [ workingfile | workingdirectory ] 
  $MYNAME chcom comment-character [ workingfile | workingdirectory ] 
  $MYNAME checklook module
  $MYNAME checknew module name
  $MYNAME checkclear module name
  $MYNAME rollback module [ checkpoint | YYYYMMDD [HHMM] ]

For specific information on a particular $MYNAME subcommand, please run
  $MYNAME help subcommand

eg: $MYNAME help rollback

EOF

exit $1
}

function print_help {
  case $1 in
          se* )
cat <<EOF
$MYNAME provides a command-line interface to Rescomp's server
configuration management system.

Usage:
  $MYNAME setup

The setup command is intended to be run the first time you use $MYNAME.
It will generate your working copy. setup takes no additional arguments.

EOF
;;
          cr* )
cat <<EOF
$MYNAME provides a command-line interface to Rescomp's server
configuration management system.

Usage:
  $MYNAME create module

The create command will cause a new module, named module, to appear as a
top-level-directory in your working copy. This change will also be made to
the repositry at the same time. 

EOF
;;
          rmm* )
cat <<EOF
$MYNAME provides a command-line interface to Rescomp's server
configuration management system.

Usage:
  $MYNAME rmmod module
This command will delete the specified module from your working copy. Use with
care.
EOF
;;
          ren* )
cat <<EOF
$MYNAME provides a command-line interface to Rescomp's server
configuration management system.

Usage:
  $MYNAME rename oldmodule newmodule

Rename oldmoule to newmodule, updating all singularities, headers, and 
otherwise performing black magic.

EOF
;;
          u* )
cat <<EOF
$MYNAME provides a command-line interface to Rescomp's server
configuration management system.

Usage:
  $MYNAME update

The update command will update your working copy of all the modules
appearing in the current host's recipe file. This command does not alter
the repository.

EOF
;;
          d* )
cat <<EOF
$MYNAME provides a command-line interface to Rescomp's server
configuration management system.

Usage:
  $MYNAME diff [ working_copy ]

Look at the changes you've made to your working copy of a file or directory.
EOF
;;
          lo* )
cat <<EOF
$MYNAME provides a command-line interface to Rescomp's server
configuration management system.

Usage:
  $MYNAME log [ working_copy ]

Look at the log entries for the file or directory specified by working_copy.
EOF
;;
          status )
cat <<EOF
$MYNAME provides a command-line interface to Rescomp's server
configuration management system.

Usage:
  $MYNAME status [ working_copy ]

Look at the status entries for the file or directory specified by working_copy.
EOF
;;
          state )
cat <<EOF
$MYNAME provides a command-line interface to Rescomp's server
configuration management system.

Usage:
  $MYNAME state

This command indicates whether the system is "dirty" or "clean."

A dirty system is one that has missed an automated "sync" operation in order
to preserve changes made by installation operations occuring between the
repository's export and the system's call to "sync."

Dirty systems may have out-of-date configuration files. Subsquent sync or
commit operations can bring the sytem up-to-date.
EOF
;;
          cp )
cat <<EOF
$MYNAME provides a command-line interface to Rescomp's server
configuration management system.

Usage:
  $MYNAME cp src_working_copy dest_working_copy

Copy source to destination. Arguments must be working copies.
EOF
;;
          mv )
cat <<EOF
$MYNAME provides a command-line interface to Rescomp's server
configuration management system.

Usage:
  $MYNAME mv src_working_copy dest_working_copy

Move source to destination. Arguments must be working copies.
EOF
;;
          co* )
cat <<EOF
$MYNAME provides a command-line interface to Rescomp's server
configuration management system.

Usage:
  $MYNAME commit

The commit command causes your changes to take effect. This means that
first, your working copy of all of the modules in the current host's 
recipe will be committed to the repository. This happens after we've run
a $MYNAME update to prevent out-of-date conflicts. If there are any 
conflicts that require human intervention, the command will fail and exit 
non-zero. 

Once $MYNAME is satisfied that all of your changes have been propogated to
the repository, we will roll-out your working copy to the live filesystem.
Every module appearing in the host's recipe file will be rolled out IN THE
ORDER OF APPEARANCE.

EOF
;;
          im* )
cat <<EOF
$MYNAME provides a command-line interface to Rescomp's server
configuration management system.

Usage:
  $MYNAME import module livefile

The import subcommand adds the specified file to your working copy of the
repository. 

EOF
;;
          in* )
cat <<EOF
$MYNAME provides a command-line interface to Rescomp's server
configuration management system.

Usage:
  $MYNAME install workingfile [ workingfile ... ]

The install subcommand allows you to roll out a single file from your working
copy.

EOF
;;
          rev* )
cat <<EOF
$MYNAME provides a command-line interface to Rescomp's server
configuration management system.

Usage:
  $MYNAME revert workingfile [ workingfile ... ]

The revert subcommand gives you the opportunity to revert to the file before
you started making changes to it.

EOF
;;
          rm )
cat <<EOF
$MYNAME provides a command-line interface to Rescomp's server configuration
management system.

Usage:
  $MYNAME rm file

The remove subcommand removes a file from version control It will NOT remove 
the file from the live filesystem. 

EOF
;;
          mk* )
cat <<EOF
$MYNAME provides a command-line interface to Rescomp's server configuration
management system.

Usage:
  $MYNAME mkdir directory 

This command will create a new version-controlled directory in your working
copy.  Parent directories do not have to exist; they will be created 
automagically. This command only affects your working copy. It does not commit 
the change.

EOF
;;
          ls )
cat<<EOF
$MYNAME provides a command-line interface to Rescomp's server configuration
management system.

Usage:
  $MYNAME ls [ file | directory ]

The ls subcommand lists out the contents, in modified long form, of the
current working directory. If a file or directory is specified, it will list
that instead.

EOF
;;
          lsattr )
cat<<EOF
$MYNAME provides a command-line interface to Rescomp's server configuration
management system.

Usage:
  $MYNAME lsattr [ file | directory ]

The lsattr subcommand lists out the confman attributes of files in the
repository. These attributes can be used to store information such as
file permissions, ownership, comment characters, syntax checkers, and
even commands to execute when changing the file.

EOF
;;
          chattr )
cat<<EOF
$MYNAME provides a command-line interface to Rescomp's server configuration
management system.

Usage:
  $MYNAME chattr attribute value [ file | directory ]

The chattr subcommand alters the confman attributes of files in the
repository. These attributes can be used to store information such as
file permissions, ownership, comment characters, syntax checkers, and
even commands to execute when changing the file.

EOF
;;
          rmattr )
cat<<EOF
$MYNAME provides a command-line interface to Rescomp's server configuration
management system.

Usage:
  $MYNAME rmattr attribute [ file | directory ]

The rmattr subcommand removes the confman attributes of files in the
repository. These attributes can be used to store information such as
file permissions, ownership, comment characters, syntax checkers, and
even commands to execute when changing the file.

EOF
;;
          cho* )
cat <<EOF
$MYNAME provides a command-line interface to Rescomp's server configuration
management system.

Usage:
  $MYNAME chown [ -R ] owner [ file | directory ] 

The chown command works like it's unix equivalent. It does not support
user:group notation. The only option it will take is -R for recursive.

EOF
;;
          chg* )
cat <<EOF
$MYNAME provides a command-line interface to Rescomp's server configuration
management system.

Usage:
  $MYNAME chgrp group [ file | directory ] 

The chgrp command works like it's unix equivalent. The only option it will take
is -R for recursive.

EOF
;;
          chm* )
cat <<EOF
$MYNAME provides a command-line interface to Rescomp's server configuration
management system.

Usage:
  $MYNAME chmod mode [ file | directory ] 

The chmod command works like it's unix equivalent. Note that it will only
accept octets as permissions -- it will not interpret symbolic permissions
correctly. The only option it will take is -R for recursive.

EOF
;;
          chc* )
cat <<EOF
$MYNAME provides a command-line interface to Rescomp's server configuration
management system.

Usage:
  $MYNAME chcom comment-character [ file | directory ] 

The chcom subcommand takes a file or directory as an argument and changes the
comment string associated with it. This will typically only be useful when
confman has guessed the comment character of your file incorrectly.

EOF
;;
          checkl* )
cat <<EOF
$MYNAME provides a command-line interface to Rescomp's server
configuration management system.

Usage:
  $MYNAME checklook module

The checklook command peeks into the checkpoints for the specified module
and gives you a listing of current checkpoints with some other cool info.
This command does not alter the repository.

EOF
;;
          checkn* )
cat <<EOF
$MYNAME provides a command-line interface to Rescomp's server
configuration management system.

Usage:
  $MYNAME checknew module name

The newcheck command creates a named checkpoint for the specified module.
This change is committed to the repository immediately.

EOF
;;
          checkc* )
cat <<EOF
$MYNAME provides a command-line interface to Rescomp's server
configuration management system.

Usage:
  $MYNAME checkclear module name

The rmcheck command clears a named checkpoint from the specified module. 
This change is committed to the repository immediately.

EOF
;;
          ro* )
cat <<EOF
$MYNAME provides a command-line interface to Rescomp's server
configuration management system.

Usage:
  $MYNAME rollback module [ checkpoint | YYYYMMDD [HHMM] ]

The rollback command first rolls your working copy of module back to the
named checkpoint. You can optionally roll-back to a specific point in time
using a date (and optionally time) as specified in the usage statement. 
This change is immediately committed to the repository.

After the rollback is complete, we perform the equivalent of a:
  $MYNAME commit

EOF
;;
          * )
print_usage 1
;;
esac
exit $2
}