Clean up help text in docker-volume-backup and docker-volume-restore

This commit is contained in:
2018-03-16 17:07:07 +00:00
parent a698d1061b
commit a3c8229219
2 changed files with 14 additions and 7 deletions

View File

@@ -56,13 +56,14 @@ resolve_dest_dir () {
}
help () {
echo "usage: docker-volume-backup <vol-name> [<output-filename>]"
echo "usage: docker-volume-backup <volume> [<output-filename>]"
echo ""
echo "Backs up contents of <vol-name> to a gzipped tar archive."
echo "Backs up contents of a Docker volume to a gzipped tar archive."
echo ""
echo "If optional <output-filename> argument is given, it should"
echo "end with \".tar.gz\". If <output-filename> is not given,"
echo "resulting file with be named: <vol-name>_<datetime>.tar.gz"
echo "Arguments:"
echo " <volume> - Name of Docker volume to backup."
echo " <output-filename> - Optional argument to specify output filename."
echo " Defaults to: ./<volume>_<date>_<time>.tar.gz"
}
main () {

View File

@@ -56,8 +56,14 @@ resolve_volname () {
help () {
echo "usage: docker-volume-restore <archive> [<volume-name>]"
echo ""
echo "Input <archive> should be a *.tar.gz producded by the"
echo "docker-volume-backup command."
echo "Restores contents from a *.tar.gz archive to a Docker volume."
echo ""
echo "Arguments:"
echo " <archive> - Filename to restore data from. Must be a .tar.gz"
echo " archive with a single root directory."
echo " <volume-name> - Optional argument to specify the volume name to"
echo " restore to. If not specified, will use name of"
echo " top-level directory in the archive."
}
main () {