PicturesBackup2 2.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. .\" Manpage of PicturesBackup2
  2. .\" Contact root@TOMCAT
  3. .ds APP_NAME PicturesBackup2
  4. .TH man 8 "02 Oct 2018" "1.0" "\*[APP_NAME] man page"
  5. .SH NAME
  6. \*[APP_NAME] - A custom command line File Syncing Utility
  7. .SH SYNOPSIS
  8. .B \*[APP_NAME]
  9. [-h=help] [-B=Built .tar files] [-S=Sync files from selected location to ENTERPRISE] [-C= future use] [-p=perform selected action on PiHome Directory
  10. .SH DESCRIPTION
  11. Script takes an
  12. .B Action
  13. tag and a
  14. .B Source
  15. 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.
  16. .SH OPTIONS
  17. .TP
  18. .BR \-h
  19. Help File
  20. .TP
  21. .BR \-B
  22. Build tarbal files. Can be used with -p (PiHome) or -o (Owncloud on TOMCAT).
  23. Places the tarball on TOMCAT in /storage/backup/[PiHomeBackup] or [PiOwncloudBackup]
  24. .TP
  25. .BR \-S
  26. 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).
  27. PiHome and Owncloud syncs tarballs from TOMCAT/storage/backup[PiHomeBackup] or [PiOwncloudBackup]/ to ENTERPRISE/storage/TOMCAT/
  28. Pictures syncs from Desktop Pictures folder to ENTERPRISE/Pictures. Note these are not compressed files.
  29. Phone Backup syncs from TOMCAT/storage/backup/phone/mike to ENTERPRISE/storage/backup/TOMCAT/phone/mike.
  30. Note: Phone Backup on TOMCAT is a folder containing nightly auto-backups of Android phone pictures to TOMCAT.
  31. .TP
  32. .BR \-C
  33. Cleanup. Future use only. Will clean up archives after a sync to limit space used on TOMCAT and ENTERPRISE servers.
  34. .TP
  35. .BR \-m
  36. Mounts ENTERPRISE and Desktop PC shares. Used for testing script only.
  37. .TP
  38. .BR \-u
  39. Unmounts ENTERPRISE and Desktop PC shares. Used for testing script only.
  40. .TP
  41. .BR \-s
  42. Silent mode. Supresses output. Feature is in testing phase only.
  43. .TP
  44. .BR \-v
  45. Verbose mode. Show debuggingon screen. Feature is in testign phase only.
  46. .SH SEE ALSO
  47. .SH BUGS
  48. .SH NEEDED UPGRADES
  49. Incorporate calls to WOL package
  50. -See if needed server is online
  51. -if not, WOL and recheck
  52. -When exiting script, shut down uneeded servers after a delay to ensure they aren't needed again.
  53. Cleanup Routine
  54. .SH AUTHOR
  55. Mike Stagl root@TOMCAT