Merge pull request #112 from forsyth2/update-help-text

Update help text

Author: forsyth2

zstash/create.py

@@ -23,7 +23,7 @@ def create():
     parser.add_argument('path', type=str, help='root directory to archive')
     required = parser.add_argument_group('required named arguments')
     required.add_argument(
-        '--hpss', type=str, help='path to HPSS storage',
+        '--hpss', type=str, help='path to storage on HPSS. Set to "none" for local archiving. Must be set to "none" if the machine does not have HPSS access.',
         required=True)
     optional = parser.add_argument_group('optional named arguments')
     optional.add_argument(
@@ -35,10 +35,10 @@ def create():
         default=256)
     optional.add_argument(
         '--keep',
-        help='keep tar files in local cache (default off)',
+        help='if --hpss is not "none", keep the tar files in the local archive (cache) after uploading to the HPSS archive. Default is to delete the tar files. If --hpss=none, this flag has no effect.',
         action="store_true")
     optional.add_argument(
-        '--cache', type=str, help='path to store files')
+        '--cache', type=str, help='the path to the zstash archive on the local file system. The default name is "zstash".')
     optional.add_argument('-v', '--verbose', action="store_true", 
                           help="increase output verbosity")
     # Now that we're inside a subcommand, ignore the first two argvs

zstash/extract.py

@@ -100,11 +100,11 @@ def extract(keep_files=True):
         usage='zstash extract [<args>] [files]',
         description='Extract files from existing archive')
     optional = parser.add_argument_group('optional named arguments')
-    optional.add_argument('--hpss', type=str, help='path to HPSS storage')
+    optional.add_argument('--hpss', type=str, help='path to storage on HPSS. Set to "none" for local archiving. Must be set to "none" if the machine does not have HPSS access.')
     optional.add_argument('--workers', type=int, default=1, help='num of multiprocess workers')
-    optional.add_argument('--keep', action='store_true', help='keep tar files in local cache (default off)')
+    optional.add_argument('--keep', action='store_true', help='if --hpss is not "none", keep the downloaded tar files in the local archive (cache) after file extraction. Default is to delete the tar files. If --hpss=none, this flag has no effect.')
     optional.add_argument(
-        '--cache', type=str, help='path to store files')
+        '--cache', type=str, help='path to the zstash archive on the local file system. The default name is "zstash".')
     optional.add_argument('-v', '--verbose', action="store_true", 
                           help="increase output verbosity")
     parser.add_argument('files', nargs='*', default=['*'])

zstash/ls.py

@@ -15,14 +15,14 @@ def ls():
     Supports the '-l' argument for more information.
     """
     parser = argparse.ArgumentParser(
-        usage='zstash ls [<args>]',
-        description='List the files from an existing archive')
+        usage='zstash ls [<args>] [files]',
+        description='List the files from an existing archive. If `files` is specified, then only the files specified will be listed. If `hpss=none`, then this will list the directories and files in the current directory excluding the cache.')
     optional = parser.add_argument_group('optional named arguments')
     optional.add_argument('--hpss', type=str, help='path to HPSS storage')
     optional.add_argument('-l', dest='long', action='store_const', const=True,
                           help='show more information for the files')
     optional.add_argument(
-        '--cache', type=str, help='path to store files')
+        '--cache', type=str, help='the path to the zstash archive on the local file system. The default name is "zstash".')
     optional.add_argument('-v', '--verbose', action="store_true", 
                           help="increase output verbosity")
 

zstash/update.py

@@ -20,7 +20,7 @@ def update():
         description='Update an existing zstash archive')
     required = parser.add_argument_group('required named arguments')
     optional = parser.add_argument_group('optional named arguments')
-    optional.add_argument('--hpss', type=str, help='path to HPSS storage')
+    optional.add_argument('--hpss', type=str, help='path to storage on HPSS. Set to "none" for local archiving. Must be set to "none" if the machine does not have HPSS access.')
     optional.add_argument(
         '--exclude', type=str,
         help='comma separated list of file patterns to exclude')
@@ -30,10 +30,10 @@ def update():
         action="store_true")
     optional.add_argument(
         '--keep',
-        help='keep tar files in local cache (default off)',
+        help='if --hpss is not "none", keep the tar files in the local archive (cache) after uploading to the HPSS archive. Default is to delete the tar files. If --hpss=none, this flag has no effect.',
         action="store_true")
     optional.add_argument(
-        '--cache', type=str, help='path to store files')
+        '--cache', type=str, help='path to the zstash archive on the local file system. The default name is "zstash".')
     optional.add_argument('-v', '--verbose', action="store_true", 
                           help="increase output verbosity")
     args = parser.parse_args(sys.argv[2:])