Scroll to navigation

datalad-create-sibling(1) General Commands Manual datalad-create-sibling(1)

SYNOPSIS

datalad-create-sibling [--version] [-h] [-l LEVEL] [-p {condor}] [--target-dir PATH] [--target-url URL] [--target-pushurl URL] [--dataset DATASET] [-r] [--existing MODE] [--shared false|true|umask|group|all|world|everybody|0xxx] [--ui false|true|html_filename] [--as-common-datasrc NAME] SSHURL [TARGETNAME]

DESCRIPTION

Create dataset(s)'s sibling (e.g., on a web server).

Those (empty) datasets can then serve as a target for the PUBLISH command.

OPTIONS

SSHURL Login information for the target server. This can be given as a URL (ssh://host/path) or SSH-style (user@host:path). Unless overridden, this also serves the future dataset's access URL and path on the server. Constraints: value must be a string TARGETNAME sibling name to create for this publication target. If RECURSIVE is set, the same name will be used to label all the subdatasets' siblings. Note, this is just a convenience option, siblings can also be added at a later point in time. When creation target datasets fails, no siblings are added. Constraints: value must be a string [Default: None]

--version show the program's version and license information -h, --help, --help-np show this help message. --help-np forcefully disables the use of a pager for displaying the help message -l LEVEL, --log-level LEVEL set logging verbosity level. Choose among critical, error, warning, info, debug. Also you can specify an integer <10 to provide even more debugging information -p {condor}, --pbs-runner {condor} execute command by scheduling it via available PBS. For settings, config file will be consulted --target-dir PATH path to the directory *on the server* where the dataset shall be created. By default the SSH access URL is used to identify this directory. If a relative path is provided here, it is interpreted as being relative to the user's home directory on the server. Additional features are relevant for recursive processing of datasets with subdatasets. By default, the local dataset structure is replicated on the server. However, it is possible to provide a template for generating different target directory names for all (sub)datasets. Templates can contain certain placeholder that are substituted for each (sub)dataset. For example: "/mydirectory/dataset-%NAME". Supported placeholders: %NAME - the name of the datasets, with any slashes replaced by dashes . Constraints: value must be a string [Default: None] --target-url URL "public" access URL of the to-be-created target dataset(s) (default: SSHURL). Accessibility of this URL determines the access permissions of potential consumers of the dataset. As with TARGET_DIR, templates (same set of placeholders) are supported. Also, if specified, it is provided as the annex description . Constraints: value must be a string [Default: None] --target-pushurl URL In case the TARGET_URL cannot be used to publish to the dataset, this option specifies an alternative URL for this purpose. As with TARGET_URL, templates (same set of placeholders) are supported. . Constraints: value must be a string [Default: None] --dataset DATASET, -d DATASET specify the dataset to create the publication target for. If no dataset is given, an attempt is made to identify the dataset based on the current working directory. Constraints: Value must be a Dataset or a valid identifier of a Dataset (e.g. a path) [Default: None] -r, --recursive if set, recurse into potential subdataset. [Default: False] --existing MODE action to perform, if target directory exists already. Dataset is skipped if 'skip'. 'replace' forces to (re-)init the dataset, and to (re-)configure the dataset sibling, i.e. its URL(s), in case it already exists. 'reconfigure' updates metadata of the dataset sibling. 'error' causes an exception to be raised. Constraints: value must be one of ('skip', 'replace', 'error', 'reconfigure') [Default: 'error'] --shared false|true|umask|group|all|world|everybody|0xxx if given, configures the access permissions on the server for multi-users (this could include access by a webserver!). Possible values for this option are identical to those of `git init --shared` and are described in its documentation. Constraints: value must be a string, or value must be convertible to type bool [Default: False] --ui false|true|html_filename publish a web interface for the dataset with an optional user-specified name for the html at publication target. defaults to INDEX.HTML at dataset root. Constraints: value must be convertible to type bool, or value must be a string [Default: False] --as-common-datasrc NAME configure the created sibling as a common data source of the dataset that can be automatically used by all consumers of the dataset (technical: git-annex auto- enabled special remote). [Default: None]

AUTHORS

datalad is developed by The DataLad Team and Contributors <team@datalad.org>.
2016-11-10 datalad-create-sibling 0.4.1