aboutsummaryrefslogtreecommitdiff
path: root/doc/git-annex-addurl.mdwn
diff options
context:
space:
mode:
authorGravatar Joey Hess <joeyh@joeyh.name>2015-03-23 15:36:10 -0400
committerGravatar Joey Hess <joeyh@joeyh.name>2015-03-23 15:36:10 -0400
commit90c35465528195367cc4ed1e15478285d7b063f3 (patch)
treefc658fb5d483ad673d82bfa5c3d00bc4a7c2d5ef /doc/git-annex-addurl.mdwn
parent052e77469015e82ca33733388ff5740fa06312e2 (diff)
splitting up the man page
Common command man pages all split out and often expanded. A few sections split out into their own pages. Still need to do all the other commands..
Diffstat (limited to 'doc/git-annex-addurl.mdwn')
-rw-r--r--doc/git-annex-addurl.mdwn66
1 files changed, 66 insertions, 0 deletions
diff --git a/doc/git-annex-addurl.mdwn b/doc/git-annex-addurl.mdwn
new file mode 100644
index 000000000..5e26035ec
--- /dev/null
+++ b/doc/git-annex-addurl.mdwn
@@ -0,0 +1,66 @@
+# NAME
+
+git-annex addurl - add urls to annex
+
+# SYNOPSIS
+
+git annex addurl `[url ...]`
+
+# DESCRIPTION
+
+Downloads each url to its own file, which is added to the annex.
+
+When `quvi` is installed, urls are automatically tested to see if they
+point to a video hosting site, and the video is downloaded instead.
+
+Urls to torrent files (including magnet links) will cause the content of
+the torrent to be downloaded, using `aria2c`.
+
+Normally the filename is based on the full url, so will look like
+"www.example.com_dir_subdir_bigfile". In some cases, addurl is able to
+come up with a better filename based on other information. Options can also
+be used to get better filenames.
+
+# OPTIONS
+
+* `--fast`
+
+ Avoid immediately downloading the url.
+
+* `--relaxed`
+
+ Avoid storing the size of the url's content, and accept whatever
+ content is there at a future point. (Implies `--fast`.)
+
+* `--raw`
+
+ Prevent special handling of urls by quvi, bittorrent, and other
+ special remotes. This will for example, make addurl
+ download the .torrent file and not the contents it points to.
+
+* `--file=name`
+
+ Use with a filename that does not yet exist to add a new file
+ with the specified name and the content downloaded from the url.
+
+ If the file already exists, addurl will record that it can be downloaded
+ from the specified url(s).
+
+* `--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".
+
+ It can also be negative; `--pathdepth=-2` will use the last
+ two parts of the url.
+
+# SEE ALSO
+
+[[git-annex]](1)
+
+# AUTHOR
+
+Joey Hess <id@joeyh.name>
+
+Warning: Automatically converted into a man page by mdwn2man. Edit with care.