bionic (1) datalad-save.1.gz

Provided by: datalad_0.9.3-1_all bug

SYNOPSIS

       datalad-save  [-h] [-m MESSAGE] [-d DATASET] [-u] [-a] [--version-tag ID] [-r] [--recursion-limit LEVELS]
              [-S] [PATH [PATH ...]]

DESCRIPTION

       Save the current state of a dataset

       Saving the state of a dataset records all changes that have been  made  to  it.  This  change  record  is
       annotated  with  a  user-provided  description.  Optionally, an additional tag, such as a version, can be
       assigned to the saved state. Such tag enables straightforward retrieval of past versions at a later point
       in time.

OPTIONS

       PATH   path/name  of  the  dataset component to save. If given, only changes made to those components are
              recorded in the new state. Constraints: value must be a string [Default: None]

       -h, --help, --help-np
              show this help message. --help-np forcefully disables the use of a pager for displaying  the  help
              message

       -m MESSAGE, --message MESSAGE
              a  description  of the state or the changes made to a dataset. Constraints: value must be a string
              [Default: None]

       -d DATASET, --dataset DATASET
              "specify the dataset to save. If a dataset is given, but no FILES,  the  entire  dataset  will  be
              saved.  Constraints:  Value  must  be  a  Dataset or a valid identifier of a Dataset (e.g. a path)
              [Default: None]

       -u, --all-updated
              if no explicit paths are given, save changes of all known  components  in  a  datasets.  [Default:
              True]

       -a, --all-changes
              save  all  changes (even to not yet added files) of all components in datasets that contain any of
              the given paths [DEPRECATED!]. [Default: None]

       --version-tag ID
              an additional marker for that state. Constraints: value must be a string [Default: None]

       -r, --recursive
              if set, recurse into potential subdataset. [Default: False]

       --recursion-limit LEVELS
              limit recursion into subdataset to  the  given  number  of  levels.  Constraints:  value  must  be
              convertible to type 'int' [Default: None]

       -S, --super-datasets
              if set, save a change in a dataset also in its superdataset. [Default: False]

AUTHORS

        datalad is developed by The DataLad Team and Contributors <team@datalad.org>.