wrote git-annex maxsize man page

diff --git a/doc/git-annex-maxsize.mdwn b/doc/git-annex-maxsize.mdwn
new file mode 100644 (file)
index 0000000..9c09094
--- /dev/null
+++ b/doc/git-annex-maxsize.mdwn
@@ -0,0 +1,46 @@
+# NAME
+
+git-annex maxsize - configure maximum size of a repository
+
+# SYNOPSIS
+
+git annex maxsize repository size
+
+git annex maxsize here --auto
+
+git annex maxsize repository
+
+# DESCRIPTION
+
+This configures the maximum combined size of annexed files that can be
+stored in a repository. When run without a size or the --auto option,
+it displays the currently configured maxsize.
+
+The repository can be specified by git remote name or
+by uuid. For the current repository, use "here".
+
+The size can be specified using any units. For example "100 gigabytes" or
+"0.8 TB"
+
+This is advisory only, it does not prevent git-annex from trying to store
+more data than that in a repository. So use this to tell git-annex about
+hard repository size limits that are enforced in some other way.
+
+For example, if a git repository is on a 1 terabyte drive, and is the only
+thing stored on that drive, and `annex.diskreserve` is configured to 1
+gigabyte, then it would make sense to run 
+`git-annex maxsize here "999 gigabytes"`.
+
+# OPTIONS
+
+* The [[git-annex-common-options]](1) can be used.
+
+# SEE ALSO
+
+[[git-annex]](1)
+
+# AUTHOR
+
+Joey Hess <id@joeyh.name>
+
+Warning: Automatically converted into a man page by mdwn2man. Edit with care.

diff --git a/doc/git-annex-preferred-content.mdwn b/doc/git-annex-preferred-content.mdwn
index 70d2723524613a428089dc7ce139ad267cd75e81..8069cb201f9a11c35195fe7f1508abb653d8acc8 100644 (file)
--- a/doc/git-annex-preferred-content.mdwn
+++ b/doc/git-annex-preferred-content.mdwn
@@ -282,7 +282,7 @@ elsewhere to allow removing it).
   have enough free space to hold them. So once a repository is full,
   the remaining repositories will have any additional files balanced
   amoung them. In order for this to work, you must use
-  [[git-annex-size]](1) to specify the size of each repository in the
+  [[git-annex-maxsize]](1) to specify the size of each repository in the
   group.
 
   This usually avoids moving files between repositories of the group, even
@@ -350,7 +350,7 @@ for example `"exclude=* and copies=1"` will be displayed as
 
 [[git-annex-wanted]](1)
 
-[[git-annex-size]](1)
+[[git-annex-maxsize]](1)
 
 <https://git-annex.branchable.com/preferred_content/>
 

diff --git a/doc/todo/git-annex_proxies.mdwn b/doc/todo/git-annex_proxies.mdwn
index c153ae585ae68d477e33d736d32259fe41b20618..13a8f56c060f06d90195a8a059e8d6a12a7a589c 100644 (file)
--- a/doc/todo/git-annex_proxies.mdwn
+++ b/doc/todo/git-annex_proxies.mdwn
@@ -33,7 +33,7 @@ Planned schedule of work:
 * balanced= and fullybalanced= need to limit the set of repositories to
   ones with enough free space to contain a key.
 
-* Add `git-annex size` command.
+* Add `git-annex maxsize` command.
 
 * Implement [[track_free_space_in_repos_via_git-annex_branch]]