Skip to content

Commit 7f117f4

Browse files
committed
Documentation update
1 parent 633381c commit 7f117f4

File tree

21 files changed

+1521
-2364
lines changed

21 files changed

+1521
-2364
lines changed

documentation/markdown/documentation/cli/commands.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -94,31 +94,32 @@ The `cp` command can copy resources between Solid pod locations, across Solid po
9494
If the source location is a container or directory, it will recursively copy the container and all sub-containers recursively copying the whole underlying resource tree, including empty containers.
9595
<!-- todo: check if empty containers are included. -->
9696
The default copying behavior ignores `.meta`, `.acl` and `.acp` resources, which can be changed using the `--all` flag.
97-
The default behavior is to overwrite files, the `--interactive-override` and `--no-override` options provide alternative behaviors.
97+
The copy command automatically copies the full recursive resource tree. At the moment this behavior cannot be altered.
98+
In terms of overriding resources, the default setting is that every time a resource is found to already exist, an interactive prompt is shown.
99+
This behavior can be altered either by the `--never-override` or the `--override` options.
98100

99101
#### arguments
100102
```
101103
Arguments:
102-
src file or directory to be copied
103-
dst destination to copy file or directory to
104+
src resource or container to be copied
105+
dst destination to copy file or directory to
104106
```
105107
The `src` argument is the location of the resource or container to be moved. If the URL starts with `http(s)://`, the resource is assumed to be a remote resource, if not the resource is assumed to be local and matched with the local file system. The `dst` argument is the destination to which the source resource is to be copied. Similarly it uses the `http(s)://` prefix to decide if the location is local or remote.
106108
The default behavior ignores context resources such as `.meta`, `.acl` and `.acp` present in the directories. The `--all` flag ignores this behavior, though note that for authorization resources, as the target URIs are not edited, copying resources with these authorization resources does not imply they will result in the same access controls as the location they were copied from!
107-
The default behavior always automatically works recursively. At the moment this behavior cannot be altered.
108109

109110
#### options
110111
```
111112
Options:
112-
-a, --all Copy .acl files in recursive directory copies
113-
-i, --interactive-override Interactive confirmation prompt when overriding existing resource
114-
-n, --no-override Do not override existing files
115-
-v, --verbose Log all read and write operations
113+
-a, --all Copy .acl files in recursive directory copies
114+
-o, --override Automatically override existing files
115+
-n, --never-override Automatically override existing files
116+
-v, --verbose Log all read and write operations
116117
```
117118
The `--all` option includes `.meta`, `.acl` and `.acp` files in the listing.
118119
<br />
119-
The `--interactive-override` option provides an interactive prompt when a copy will override an existing resource.
120+
The `--override` option automatically overrides existing resources.
120121
<br />
121-
The `--no-override` option ignores existing resources.
122+
The `--never-override` option automatically mitigates resource overrides.
122123
<br />
123124
The `--verbose` option shows warnings.
124125

@@ -156,33 +157,32 @@ If the source location is a container or directory, it will recursively move the
156157
When moving from the local file system, files will not be deleted!
157158
<!-- todo: check if empty containers are included. -->
158159
The default copying behavior ignores `.meta`, `.acl` and `.acp` resources, which can be changed using the `--all` flag.
159-
The default behavior is to overwrite files, the `--interactive-override` and `--no-override` options provide alternative behaviors.
160-
The default behavior always automatically works recursively. At the moment this behavior cannot be altered.
160+
The move command automatically moves the full recursive resource tree. At the moment this behavior cannot be altered.
161+
In terms of overriding resources, the default setting is that every time a resource is found to already exist, an interactive prompt is shown.
162+
This behavior can be altered either by the `--never-override` or the `--override` options.
161163

162164
#### arguments
163165
```
164166
Arguments:
165-
src file or directory to be moved
166-
dst destination of the move
167+
src resource or container to be moved
168+
dst destination of the move
167169
```
168170
The `src` argument is the location of the resource or container to be moved. If the URL starts with `http(s)://`, the resource is assumed to be a remote resource, if not the resource is assumed to be local and matched with the local file system. The `dst` argument is the destination to which the source resource is to be copied. Similarly it uses the `http(s)://` prefix to decide if the location is local or remote.
169171
The default behavior ignores context resources such as `.meta`, `.acl` and `.acp` present in the directories. The `--all` flag ignores this behavior, though note that for authorization resources, as the target URIs are not edited, copying resources with these authorization resources does not imply they will result in the same access controls as the location they were copied from!
170172

171-
172-
173173
#### options
174174
```
175175
Options:
176-
-a, --all Move .acl files when moving directories recursively
177-
-i, --interactive-override Interactive confirmation prompt when overriding existing files
178-
-n, --no-override Do not override existing files
179-
-v, --verbose Log all operations
176+
-a, --all Copy .acl files in recursive directory copies
177+
-o, --override Automatically override existing files
178+
-n, --never-override Automatically override existing files
179+
-v, --verbose Log all read and write operations
180180
```
181181
The `--all` option includes `.meta`, `.acl` and `.acp` files in the listing.
182182
<br />
183-
The `--interactive-override` option provides an interactive prompt when a copy will override an existing resource.
183+
The `--override` option automatically overrides existing resources.
184184
<br />
185-
The `--no-override` option ignores existing resources.
185+
The `--never-override` option automatically mitigates resource overrides.
186186
<br />
187187
The `--verbose` option shows warnings.
188188

0 commit comments

Comments
 (0)