1datalad export-archive(1)   General Commands Manual  datalad export-archive(1)
2
3
4

NAME

6       datalad  export-archive  - export the content of a dataset as a TAR/ZIP
7       archive.
8

SYNOPSIS

10       datalad export-archive [-h] [-d DATASET] [-t {tar|zip}] [-c  {gz|bz2|}]
11              [--missing-content {error|continue|ignore}] [--version] [PATH]
12
13
14

OPTIONS

16       PATH   File name of the generated TAR archive. If no file name is given
17              the archive will be generated in the current directory and  will
18              be  named:  datalad_<dataset_uuid>.(tar.*|zip). To generate that
19              file in a different directory, provide an existing directory  as
20              the file name. Constraints: value must be a string or value must
21              be NONE
22
23
24       -h, --help, --help-np
25              show this help message. --help-np forcefully disables the use of
26              a pager for displaying the help message
27
28       -d DATASET, --dataset DATASET
29              "specify  the  dataset to export. If no dataset is given, an at‐
30              tempt is made to identify the dataset based on the current work‐
31              ing  directory.  Constraints: Value must be a Dataset or a valid
32              identifier of a Dataset (e.g. a path) or value must be NONE
33
34       -t {tar|zip}, --archivetype {tar|zip}
35              Type of archive to generate. Constraints: value must be  one  of
36              ('tar', 'zip') [Default: 'tar']
37
38       -c {gz|bz2|}, --compression {gz|bz2|}
39              Compression  method  to  use. 'bz2' is not supported for ZIP ar‐
40              chives. No compression is used when an empty  string  is  given.
41              Constraints:  value  must  be one of ('gz', 'bz2', '') [Default:
42              'gz']
43
44       --missing-content {error|continue|ignore}
45              By default, any discovered file with missing content will result
46              in  an error and the export is aborted. Setting this to 'contin‐
47              ue' will issue warnings instead of failing on error.  The  value
48              'ignore'  will only inform about problem at the 'debug' log lev‐
49              el. The latter two can be helpful when generating a TAR  archive
50              from a dataset where some file content is not available locally.
51              Constraints: value must be one  of  ('error',  'continue',  'ig‐
52              nore') [Default: 'error']
53
54       --version
55              show the module and its version which provides the command
56

AUTHORS

58        datalad is developed by The DataLad Team and Contributors <team@datal‐
59       ad.org>.
60
61
62
63datalad export-archive 0.19.3     2023-08-11         datalad export-archive(1)
Impressum