1
0
mirror of https://github.com/minio/docs.git synced 2025-07-30 07:03:26 +03:00

Moves limit upload and limit download flags out of global list (#820)

Uses an include in case we need them for other commands later.

Closes #787

Also update mc mv to use standard optional and required formatting for
params.

Staged:
http://192.241.195.202:9000/staging/limitflags/reference/minio-mc.html#global-options
This commit is contained in:
Daryl White
2023-04-14 15:37:31 -05:00
committed by GitHub
parent 948fce19c8
commit 48ac2437e8
5 changed files with 93 additions and 73 deletions

View File

@ -0,0 +1,49 @@
.. start-mc-limit-flags-desc
.. mc-cmd:: --limit-download
:optional:
Limit client-side download rates to no more than a specified rate in KiB/s, MiB/s, or GiB/s.
This affects only the download to the local device running the MinIO Client.
Valid units include:
- ``B`` for bytes
- ``K`` for kilobytes
- ``G`` for gigabytes
- ``T`` for terabytes
- ``Ki`` for kibibytes
- ``Gi`` for gibibytes
- ``Ti`` for tebibytes
For example, to limit download rates to no more than 1 GiB/s, use the following:
.. code-block::
--limit-download 1G
If not specified, MinIO uses an unlimited download rate.
.. mc-cmd:: --limit-upload
:optional:
Limit client-side upload rates to no more than the specified rate in KiB/s, MiB/s, or GiB/s.
This affects only the upload from the local device running the MinIO Client.
Valid units include:
- ``B`` for bytes
- ``K`` for kilobytes
- ``G`` for gigabytes
- ``T`` for terabytes
- ``Ki`` for kibibytes
- ``Gi`` for gibibytes
- ``Ti`` for tebibytes
For example, to limit upload rates to no more than 1 GiB/s, use the following:
.. code-block::
--limit-upload 1G
If not specified, MinIO uses an unlimited upload rate.
.. end-mc-limit-flags-desc