.TH "datalad save" "1" "2019\-02\-08" ""datalad save 0.11.2""
.SH NAME
\fBdatalad save\fR \- save the current state of a dataset
.SH SYNOPSIS
.nh
.HP
\fBdatalad save\fR [-h] [-m\~MESSAGE] [-d\~DATASET] [-u] [--version-tag\~ID] [-r] [--recursion-limit\~LEVELS] [-S] [-F\~MESSAGE_FILE] [PATH [PATH ...]]


.hy
.SH DESCRIPTION

Saving the state of a dataset records 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.
.PP
Examples:
.PP
Save any content underneath the current directory, without altering
any potential subdataset (use \-\-recursive for that)::
.PP
  % datalad save .
.PP
Save any modification of known dataset content, but leave untracked
files (e.g. temporary files) untouched::
.PP
  % dataset save \-d <path_to_dataset>
.PP
Tag the most recent saved state of a dataset::
.PP
  % dataset save \-d <path_to_dataset> \-\-version\-tag bestyet
.SH OPTIONS
.TP
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]

.TP
\fB-h\fR, \fB--help\fR, \fB--help-np\fR
show this help message. --help-np forcefully disables the use of a pager for displaying the help message
.TP
\fB-m\fR MESSAGE, \fB--message\fR MESSAGE
a description of the state or the changes made to a dataset. Constraints: value must be a string [Default: None]
.TP
\fB-d\fR \fI\s-1DATASET\s0\fR, \fB--dataset\fR \fI\s-1DATASET\s0\fR
"specify the dataset to save. Constraints: Value must be a Dataset or a valid identifier of a Dataset (e.g. a path) [Default: None]
.TP
\fB-u\fR, \fB--all-updated\fR
if no explicit paths are given, save changes of all known components in a datasets. [Default: True]
.TP
\fB--version-tag\fR ID
an additional marker for that state. Constraints: value must be a string [Default: None]
.TP
\fB-r\fR, \fB--recursive\fR
if set, recurse into potential subdataset. [Default: False]
.TP
\fB--recursion-limit\fR LEVELS
limit recursion into subdataset to the given number of levels. Constraints: value must be convertible to type 'int' [Default: None]
.TP
\fB-S\fR, \fB--super-datasets\fR
if set, save a change in a dataset also in its superdataset. [Default: False]
.TP
\fB-F\fR \fI\s-1MESSAGE_FILE\s0\fR, \fB--message-file\fR \fI\s-1MESSAGE_FILE\s0\fR
take the commit message from this file. This flag is mutually exclusive with -m. Constraints: value must be a string [Default: None]
.SH AUTHORS
 datalad is developed by The DataLad Team and Contributors <team@datalad.org>.