Patch to upgrade_MailScanner_conf to provide POD documentation (man page)

[James A. Pattie]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Julian Field wrote:
| The "--keep-comments" option needs to be in the command-line spec at the
| top of the page, as well as in the description.
| A separate "Options" section for "--keep-comments" would be good too.
|
| Thanks!
|
| At 18:24 28/10/2003, you wrote:
|
|> -----BEGIN PGP SIGNED MESSAGE-----
|> Hash: SHA1
|>
|> Hi,
|>
|>        Attached is a first draft of POD documentation for
|> upgrade_MailScanner_conf
|> that will allow a man page to be generated so that the Debian maintainer
|> of the
|> mailscanner package will include the upgrade_MailScanner_conf script
|> in the
|> .deb.  :)
|>
|>        Please review and give corrections if needed or approval (Julian)
|> before I
|> submit the changes to the Debian maintainer.
|>
|>        to view the results at the command line use: pod2text
|> upgrade_MailScanner_conf
|>        and you you see the output as it will end up, but without any
|> hilighting, etc.
|> ~ You can also feed it through pod2man, pod2html, etc.
|>
|>        Thanks,
|>

how about this?

- --
James A. Pattie
james at pcxperience.com

Linux  --  SysAdmin / Programmer
Xperience, Inc.
http://www.pcxperience.com/
http://www.xperienceinc.com/

GPG Key Available at http://www.pcxperience.com/gpgkeys/james.html
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.3 (GNU/Linux)
Comment: Using GnuPG with Debian - http://enigmail.mozdev.org

iD8DBQE/oAEctUXjwPIRLVERAlOTAKDng5fDAHZVI/5dnymKZkn4PvVNyQCeKs1q
I7wFyOz3091bqsskz66o07g=
=TlAD
-----END PGP SIGNATURE-----

--
This message has been scanned for viruses and
dangerous content by MailScanner, and is
believed to be clean.
MailScanner thanks transtec Computers for their support.

-------------- next part --------------
--- upgrade_MailScanner_conf.orig       2003-10-27 15:20:52.000000000 -0600
+++ upgrade_MailScanner_conf    2003-10-29 11:57:47.000000000 -0600
@@ -42,6 +42,63 @@
 use FileHandle;
 use strict;

+=head1 NAME
+
+upgrade_MailScanner_conf - upgrades MailScanner.conf config files
+
+=head1 SYNOPSIS
+
+upgrade_MailScanner_conf [--keep-comments] MailScanner.conf MailScanner.conf.newversion > MailScanner.conf.new
+
+RPM
+===
+If you are using the RPM distributions then try this:
+
+cd /etc/MailScanner
+
+upgrade_MailScanner_conf MailScanner.conf MailScanner.conf.rpmnew > MailScanner.new
+
+mv MailScanner.conf MailScanner.old
+
+mv MailScanner.new  MailScanner.conf
+
+TAR
+===
+If you are using the tar distribution so that the old version is in
+/opt/MailScanner and the new one is in /opt/MailScanner.new then:
+
+cd /opt/MailScanner.new/etc
+
+../bin/upgrade_MailScanner_conf /opt/MailScanner/etc/MailScanner.conf /opt/MailScanner.new/etc/MailScanner.conf > MailScanner.new
+
+mv MailScanner.conf MailScanner.old
+
+mv MailScanner.new  MailScanner.conf
+
+=head1 DESCRIPTION
+
+upgrade_MailScanner_conf helps automate the conversion of older MailScanner.conf config
+files to the version of MailScanner you are installing.  This takes care of adding any
+new config items that need to be added, removing old deprecated items and updating the
+comments, unless you specify --keep-comments to signal you want your old comments left.
+
+=head1 OPTIONS
+
+--keep-comments - tells the script to not update the comments that have changed.
+
+Using --keep-comments can cause you to not realize that there are new/more options
+available to you for the item that your old comment was kept with.
+
+=head1 AUTHOR
+
+Julian Field (mailto: Jules at JulianField.net )
+
+=head1 SEE ALSO
+
+perl(1), MailScanner(3)
+
+=cut
+
 sub Usage {
   print STDERR <<EOU;
 Usage: