git-annex/doc/git-annex-maxsize.mdwn
2024-08-18 12:08:13 -04:00

56 lines
1.4 KiB
Markdown

# NAME
git-annex maxsize - configure maximum size of a repository
# SYNOPSIS
git annex maxsize repository size
git annex maxsize repository
git annex maxsize
# DESCRIPTION
This configures the maximum combined size of annexed files that can be
stored in a repository. When run with a repository but without a size,
it displays the currently configured maxsize. When run without a
repository, it displays an overview of the size and maxsize of all
repositories.
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
* `--bytes`
Displays the maximum size in bytes, disabling the default nicer units.
* `--json`
Enable JSON output.
* The [[git-annex-common-options]](1) can also 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.