summaryrefslogtreecommitdiff
path: root/doc/git-annex-addurl.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'doc/git-annex-addurl.mdwn')
-rw-r--r--doc/git-annex-addurl.mdwn15
1 files changed, 12 insertions, 3 deletions
diff --git a/doc/git-annex-addurl.mdwn b/doc/git-annex-addurl.mdwn
index 99b1f8c65..888f6ac31 100644
--- a/doc/git-annex-addurl.mdwn
+++ b/doc/git-annex-addurl.mdwn
@@ -48,13 +48,22 @@ be used to get better filenames.
* `--pathdepth=N`
- This causes a shorter filename to be used. For example,
- `--pathdepth=1` will use "dir/subdir/bigfile",
- while `--pathdepth=3` will use "bigfile".
+ Rather than basing the filename on the whole url, this causes a path to
+ be constructed, starting at the specified depth within the path of the
+ url.
+
+ For example, adding the url http://www.example.com/dir/subdir/bigfile
+ with `--pathdepth=1` will use "dir/subdir/bigfile",
+ while `--pathdepth=3` will use "bigfile".
It can also be negative; `--pathdepth=-2` will use the last
two parts of the url.
+* `--prefix=foo` `--suffix=bar`
+
+ Use to adjust the filenames that are created by addurl. For example,
+ `--suffix=.mp3` can be used to add an extension to the file.
+
# SEE ALSO
[[git-annex]](1)