PicturesBackup3/usr/local/man/PicturesBackup3

.\" Manpage of PicturesBackup3
.\" Contact root@TOMCAT
.ds APP_NAME PicturesBackup3
.TH man 8 "11 Aug 2019" "0.2" "\*[APP_NAME] man page"

.SH NAME
\*[APP_NAME]  - A custom command line File Syncing Utility

.SH SYNOPSIS

.B \*[APP_NAME] 
[-h=help] [-B=Built .tar files] [-S=Sync files from selected location to ENTERPRISE] \
[-C= Cleanup] [-p=perform selected action on PiHome Directory] \
[-o=Perform selected ]

.SH DESCRIPTION

Script takes an 
.B Action 
tag and a 
.B Source 
tag.  It attempts to take the chosen action on the chosen source files. For example, -Bp would build a .tar file of the PiHome directory.  -So would sync the .tar files from TOMCAT to ENTERPISE.

.SH OPTIONS
.TP
.BR \-h
Help File

.TP
.BR \-B
Build tarbal files.  Can be used with -p (PiHome) or -o (Owncloud on TOMCAT).
Places the tarball on TOMCAT in /storage/backup/[PiHomeBackup] or [PiOwncloudBackup]

.TP
.BR \-S
Syncs Files from selected sources to ENTERPRISE.  Can be used with -p (PiHome), -o (Owncloud on TOMCAT), -i (Photos directory on Desktop), or -t (Phone Backup on TOMCAT).
PiHome and Owncloud syncs tarballs from TOMCAT/storage/backup[PiHomeBackup] or [PiOwncloudBackup]/ to ENTERPRISE/storage/TOMCAT/
Pictures syncs from Desktop Pictures folder to ENTERPRISE/Pictures.  Note these are not compressed files.
Phone Backup syncs from TOMCAT/storage/backup/phone/mike to ENTERPRISE/storage/backup/TOMCAT/phone/mike.
Note: Phone Backup on TOMCAT is a folder containing nightly auto-backups of Android phone pictures to TOMCAT.

.TP
.BR \-C
Cleanup.  When called with a Build Tar command [-B], will retail only the latest [X] archives.  Default is 10 archives.

.TP
.BR \-m
Mounts ENTERPRISE and Desktop PC shares.  Used for testing script only.

.TP
.BR \-u
Unmounts ENTERPRISE and Desktop PC shares.  Used for testing script only.

.TP
.BR \-s
Silent mode.  Supresses output.  Feature is in testing phase only.

.TP
.BR \-v
Verbose mode.  Show debuggingon screen.  Feature is in testign phase only.

.TP
.BR \-T
Testing Mode.  Simulates Builds, Syncs, and Cleanups.  No action performed.  This mode implies Verbose mode.

.TP
.BR \-V
Verbose mode.  Increases output to command line with actiosn peformed.  Useful for debugging.
.SH SEE ALSO
.SH BUGS
.SH NEEDED UPGRADES
Incorporate calls to WOL package
-See if needed server is online
  -if not, WOL and recheck

-When exiting script, shut down uneeded servers after a delay to ensure they aren't needed again.

Cleanup Routine
.SH AUTHOR
Mike Stagl