mirror of
https://github.com/minio/docs.git
synced 2025-08-06 14:42:56 +03:00
DOCS-380: Additional cleanups
This commit is contained in:
@@ -54,7 +54,7 @@ display the contents of the specified file or object to ``STDOUT``.
|
|||||||
[--rewind] \
|
[--rewind] \
|
||||||
[--version-id] \
|
[--version-id] \
|
||||||
[--encrypt-key] \
|
[--encrypt-key] \
|
||||||
PATH
|
ALIAS [ALIAS ...]
|
||||||
|
|
||||||
.. include:: /includes/common-minio-mc.rst
|
.. include:: /includes/common-minio-mc.rst
|
||||||
:start-after: start-minio-syntax
|
:start-after: start-minio-syntax
|
||||||
@@ -69,12 +69,26 @@ Parameters
|
|||||||
|
|
||||||
.. mc-cmd:: ALIAS
|
.. mc-cmd:: ALIAS
|
||||||
|
|
||||||
*Required* The :ref:`alias <alias>` of a MinIO or other S3-compatible
|
*Required* The :ref:`alias <alias>` of a MinIO deployment and the full
|
||||||
service.
|
path to the object. For example:
|
||||||
|
|
||||||
.. mc-cmd:: PATH
|
.. code-block:: shell
|
||||||
|
|
||||||
*Required* The full path to an object on the specified alias.
|
mc cat myminio/mybucket/myobject.txt
|
||||||
|
|
||||||
|
You can specify multiple objects on the same or different MinIO
|
||||||
|
deployment. For example:
|
||||||
|
|
||||||
|
.. code-block:: shell
|
||||||
|
|
||||||
|
mc cat myminio/mybucket/object.txt myminio/myotherbucket/object.txt
|
||||||
|
|
||||||
|
For an object on a local filesystem, specify the full path to that
|
||||||
|
object. For example:
|
||||||
|
|
||||||
|
.. code-block:: shell
|
||||||
|
|
||||||
|
mc cat ~/data/object.txt
|
||||||
|
|
||||||
.. mc-cmd:: rewind
|
.. mc-cmd:: rewind
|
||||||
:option:
|
:option:
|
||||||
|
@@ -66,7 +66,8 @@ similar results to the ``cp`` commandline tool.
|
|||||||
[--storage-class "string"] \
|
[--storage-class "string"] \
|
||||||
[--tags "string"] \
|
[--tags "string"] \
|
||||||
[--version-id "string"] \
|
[--version-id "string"] \
|
||||||
SOURCE TARGET
|
SOURCE [SOURCE ...] \
|
||||||
|
TARGET
|
||||||
|
|
||||||
.. include:: /includes/common-minio-mc.rst
|
.. include:: /includes/common-minio-mc.rst
|
||||||
:start-after: start-minio-syntax
|
:start-after: start-minio-syntax
|
||||||
@@ -79,7 +80,7 @@ Parameters
|
|||||||
|
|
||||||
*Required* The object or objects to copy.
|
*Required* The object or objects to copy.
|
||||||
|
|
||||||
For copying an object from MinIO or another S3-compatible service,
|
For copying an object from MinIO,
|
||||||
specify the :ref:`alias <alias>` and the full path to that
|
specify the :ref:`alias <alias>` and the full path to that
|
||||||
object (e.g. bucket and path to object). For example:
|
object (e.g. bucket and path to object). For example:
|
||||||
|
|
||||||
@@ -87,6 +88,13 @@ Parameters
|
|||||||
|
|
||||||
mc cp play/mybucket/object.txt ~/mydata/object.txt
|
mc cp play/mybucket/object.txt ~/mydata/object.txt
|
||||||
|
|
||||||
|
Specify multiple ``SOURCE`` paths to copy multiple objects to the
|
||||||
|
specified :mc-cmd:`~mc cp TARGET`. :mc-cmd:`mc cp` treats the
|
||||||
|
*last* specified alias or filesystem path as the ``TARGET``. For example:
|
||||||
|
|
||||||
|
.. code-block:: none
|
||||||
|
|
||||||
|
mc cp ~/data/object.txt myminio/mydata/object.txt play/mydata/object.txt
|
||||||
|
|
||||||
For copying an object from a local filesystem, specify the full
|
For copying an object from a local filesystem, specify the full
|
||||||
path to that object. For example:
|
path to that object. For example:
|
||||||
@@ -105,7 +113,7 @@ Parameters
|
|||||||
|
|
||||||
*Required* The full path to which :mc:`mc cp` copies the object.
|
*Required* The full path to which :mc:`mc cp` copies the object.
|
||||||
|
|
||||||
For copying an object to MinIO or another S3-compatible service,
|
For copying an object to MinIO,
|
||||||
specify the :mc:`alias <mc alias>` and the full path to that object
|
specify the :mc:`alias <mc alias>` and the full path to that object
|
||||||
(e.g. bucket and path to object). For example:
|
(e.g. bucket and path to object). For example:
|
||||||
|
|
||||||
|
@@ -57,7 +57,7 @@ Parameters
|
|||||||
|
|
||||||
*Required* The object to compare to the ``TARGET``.
|
*Required* The object to compare to the ``TARGET``.
|
||||||
|
|
||||||
For an object from MinIO or another S3-compatible service,
|
For an object from MinIO,
|
||||||
specify the :mc:`alias <mc alias>` and the full path to that
|
specify the :mc:`alias <mc alias>` and the full path to that
|
||||||
object (e.g. bucket and path to object). For example:
|
object (e.g. bucket and path to object). For example:
|
||||||
|
|
||||||
@@ -77,7 +77,7 @@ Parameters
|
|||||||
|
|
||||||
*Required* The object to compare to the ``SOURCE``.
|
*Required* The object to compare to the ``SOURCE``.
|
||||||
|
|
||||||
For an object from MinIO or another S3-compatible service,
|
For an object from MinIO,
|
||||||
specify the :mc:`alias <mc alias>` and the full path to that
|
specify the :mc:`alias <mc alias>` and the full path to that
|
||||||
object (e.g. bucket and path to object). For example:
|
object (e.g. bucket and path to object). For example:
|
||||||
|
|
||||||
|
@@ -57,7 +57,7 @@ tool.
|
|||||||
[--rewind "string"] \
|
[--rewind "string"] \
|
||||||
[--version-id "string"] \
|
[--version-id "string"] \
|
||||||
[--encrypt-key "string"] \
|
[--encrypt-key "string"] \
|
||||||
ALIAS
|
ALIAS [ALIAS ...]
|
||||||
|
|
||||||
.. include:: /includes/common-minio-mc.rst
|
.. include:: /includes/common-minio-mc.rst
|
||||||
:start-after: start-minio-syntax
|
:start-after: start-minio-syntax
|
||||||
@@ -70,16 +70,20 @@ Parameters
|
|||||||
|
|
||||||
*Required* The object or objects to print.
|
*Required* The object or objects to print.
|
||||||
|
|
||||||
For an object on MinIO or another S3-compatible service, specify the
|
For an object on MinIO, specify the :ref:`alias <alias>` and the full path to
|
||||||
:ref:`alias <alias>` and the full path to that object (e.g. bucket and path
|
that object (e.g. bucket and path to object). For example:
|
||||||
to object). For example:
|
|
||||||
|
|
||||||
For example:
|
|
||||||
|
|
||||||
.. code-block:: none
|
.. code-block:: none
|
||||||
|
|
||||||
mc head play/mybucket/object.txt
|
mc head play/mybucket/object.txt
|
||||||
|
|
||||||
|
You can specify multiple objects on the same or different MinIO
|
||||||
|
deployments. For example:
|
||||||
|
|
||||||
|
.. code-block:: none
|
||||||
|
|
||||||
|
mc head ~/mydata/object.txt myminio/mydata/object.txt
|
||||||
|
|
||||||
For an object on a local filesystem, specify the full path to that object.
|
For an object on a local filesystem, specify the full path to that object.
|
||||||
For example:
|
For example:
|
||||||
|
|
||||||
|
@@ -55,7 +55,7 @@ results as the ``ls`` command.
|
|||||||
[--rewind] \
|
[--rewind] \
|
||||||
[--versions] \
|
[--versions] \
|
||||||
[--summarize] \
|
[--summarize] \
|
||||||
ALIAS
|
ALIAS [ALIAS ...]
|
||||||
|
|
||||||
.. include:: /includes/common-minio-mc.rst
|
.. include:: /includes/common-minio-mc.rst
|
||||||
:start-after: start-minio-syntax
|
:start-after: start-minio-syntax
|
||||||
@@ -69,7 +69,7 @@ Parameters
|
|||||||
|
|
||||||
*Required* The object or objects to copy.
|
*Required* The object or objects to copy.
|
||||||
|
|
||||||
For listing objects on MinIO or another S3-compatible service,
|
For listing objects on MinIO,
|
||||||
specify the :ref:`alias <alias>` and the full path to that
|
specify the :ref:`alias <alias>` and the full path to that
|
||||||
object (e.g. bucket and path to object). For example:
|
object (e.g. bucket and path to object). For example:
|
||||||
|
|
||||||
|
@@ -62,7 +62,7 @@ Parameters
|
|||||||
*Required* The MinIO or other S3-compatible service on which to create the
|
*Required* The MinIO or other S3-compatible service on which to create the
|
||||||
new bucket.
|
new bucket.
|
||||||
|
|
||||||
For creating a bucket on MinIO or another S3-compatible service, specify the
|
For creating a bucket on MinIO, specify the
|
||||||
:ref:`alias <alias>` and the name of the bucket. For example:
|
:ref:`alias <alias>` and the name of the bucket. For example:
|
||||||
|
|
||||||
.. code-block:: none
|
.. code-block:: none
|
||||||
|
@@ -53,7 +53,7 @@ similar results to the ``mv`` commandline tool.
|
|||||||
[--preserve] \
|
[--preserve] \
|
||||||
[--recursive] \
|
[--recursive] \
|
||||||
[--storage-class "string"] \
|
[--storage-class "string"] \
|
||||||
SOURCE \
|
SOURCE [SOURCE...] \
|
||||||
TARGET
|
TARGET
|
||||||
|
|
||||||
.. include:: /includes/common-minio-mc.rst
|
.. include:: /includes/common-minio-mc.rst
|
||||||
@@ -67,9 +67,9 @@ Parameters
|
|||||||
|
|
||||||
*Required* The object or objects to move.
|
*Required* The object or objects to move.
|
||||||
|
|
||||||
For moving an object from MinIO or another S3-compatible service,
|
For moving an object from a MinIO bucket, specify the :ref:`alias <alias>`
|
||||||
specify the :ref:`alias <alias>` and hte full path to the object(s)
|
and the full path to the object(s) (e.g. bucket and path to objects). For
|
||||||
(e.g. bucket and path to objects). For example:
|
example:
|
||||||
|
|
||||||
.. code-block:: shell
|
.. code-block:: shell
|
||||||
|
|
||||||
@@ -82,8 +82,13 @@ Parameters
|
|||||||
|
|
||||||
mc mv ~/mydata/object.txt play/mybucket/object.txt
|
mc mv ~/mydata/object.txt play/mybucket/object.txt
|
||||||
|
|
||||||
You can specify both local paths
|
Specify multiple ``SOURCE`` paths to move multiple objects to the
|
||||||
and S3 paths using a configured S3 service :mc:`alias <mc alias>`.
|
specified :mc-cmd:`~mc mv TARGET`. :mc-cmd:`mc rm` treats the
|
||||||
|
*last* specified alias or filesystem path as the ``TARGET``. For example:
|
||||||
|
|
||||||
|
.. code-block:: shell
|
||||||
|
|
||||||
|
mc mv ~/mydata/object.txt play/mydata/otherobject.txt myminio/mydata
|
||||||
|
|
||||||
If you specify a directory or bucket to :mc-cmd:`~mc mv SOURCE`, you must
|
If you specify a directory or bucket to :mc-cmd:`~mc mv SOURCE`, you must
|
||||||
also specify :mc-cmd-option:`~mc mv recursive` to recursively move the
|
also specify :mc-cmd-option:`~mc mv recursive` to recursively move the
|
||||||
@@ -98,7 +103,7 @@ Parameters
|
|||||||
:ref:`alias <alias>` of a configured S3 service as the prefix to the
|
:ref:`alias <alias>` of a configured S3 service as the prefix to the
|
||||||
:mc-cmd:`~mc mv TARGET` path.
|
:mc-cmd:`~mc mv TARGET` path.
|
||||||
|
|
||||||
For moving an object from MinIO or another S3-compatible service,
|
For moving an object from MinIO,
|
||||||
specify the :ref:`alias <alias>` and hte full path to the object(s)
|
specify the :ref:`alias <alias>` and hte full path to the object(s)
|
||||||
(e.g. bucket and path to objects). For example:
|
(e.g. bucket and path to objects). For example:
|
||||||
|
|
||||||
|
@@ -77,7 +77,6 @@ Parameters
|
|||||||
- ``upload`` - Enable upload-only access to the ``ALIAS``.
|
- ``upload`` - Enable upload-only access to the ``ALIAS``.
|
||||||
- ``public`` - Enable download and upload access to the ``ALIAS``.
|
- ``public`` - Enable download and upload access to the ``ALIAS``.
|
||||||
|
|
||||||
|
|
||||||
.. mc-cmd:: ALIAS
|
.. mc-cmd:: ALIAS
|
||||||
|
|
||||||
*Required* The full path to the bucket or bucket prefix to which the
|
*Required* The full path to the bucket or bucket prefix to which the
|
||||||
|
@@ -55,7 +55,7 @@ similar results to the ``rm --rf`` commandline tool.
|
|||||||
mc [GLOBALFLAGS] rb \
|
mc [GLOBALFLAGS] rb \
|
||||||
--force \
|
--force \
|
||||||
[--dangerous] \
|
[--dangerous] \
|
||||||
ALIAS
|
ALIAS [ALIAS...]
|
||||||
|
|
||||||
.. include:: /includes/common-minio-mc.rst
|
.. include:: /includes/common-minio-mc.rst
|
||||||
:start-after: start-minio-syntax
|
:start-after: start-minio-syntax
|
||||||
@@ -91,6 +91,13 @@ Parameters
|
|||||||
|
|
||||||
mc rb ~/data/myolddata
|
mc rb ~/data/myolddata
|
||||||
|
|
||||||
|
You can specify multiple ``ALIAS`` targets consisting of either
|
||||||
|
MinIO or local filesystem directories. The command attempts to remove
|
||||||
|
*all* specified targets. For example:
|
||||||
|
|
||||||
|
.. code-block:: none
|
||||||
|
|
||||||
|
mc rb --force myminio/mydata ~/data/myolddata
|
||||||
|
|
||||||
.. mc-cmd:: force
|
.. mc-cmd:: force
|
||||||
:option:
|
:option:
|
||||||
|
@@ -68,6 +68,7 @@ results to the ``rm`` commandline tool.
|
|||||||
[--stdin] \
|
[--stdin] \
|
||||||
[--version-id "string"]* \
|
[--version-id "string"]* \
|
||||||
[--versions] \
|
[--versions] \
|
||||||
|
ALIAS [ALIAS ...]
|
||||||
|
|
||||||
.. include:: /includes/common-minio-mc.rst
|
.. include:: /includes/common-minio-mc.rst
|
||||||
:start-after: start-minio-syntax
|
:start-after: start-minio-syntax
|
||||||
|
@@ -54,7 +54,7 @@ results to the ``stat`` commandline tool.
|
|||||||
[--rewind "string"] \
|
[--rewind "string"] \
|
||||||
[--versions] \
|
[--versions] \
|
||||||
[--version-id "string"]* \
|
[--version-id "string"]* \
|
||||||
ALIAS
|
ALIAS [ALIAS ...]
|
||||||
|
|
||||||
|
|
||||||
.. include:: /includes/common-minio-mc.rst
|
.. include:: /includes/common-minio-mc.rst
|
||||||
|
Reference in New Issue
Block a user