minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2025-07-31 18:04:52 +03:00
Code Activity

DOCS-380: Additional cleanups

Browse Source
This commit is contained in:
ravindk89
2022-01-05 15:02:04 -05:00
parent 8e4d7b6971
commit 2175f83970
11 changed files with 67 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
source/reference/minio-mc/mc-cat.rst
View File

@ -54,7 +54,7 @@ display the contents of the specified file or object to ``STDOUT``.
[--rewind] \
[--version-id] \
[--encrypt-key] \
PATH
ALIAS [ALIAS ...]
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-syntax
@ -69,12 +69,26 @@ Parameters
.. mc-cmd:: ALIAS
*Required* The :ref:`alias <alias>` of a MinIO or other S3-compatible
service.
*Required* The :ref:`alias <alias>` of a MinIO deployment and the full
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
:option:

14
source/reference/minio-mc/mc-cp.rst
View File

@ -66,7 +66,8 @@ similar results to the ``cp`` commandline tool.
[--storage-class "string"] \
[--tags "string"] \
[--version-id "string"] \
SOURCE TARGET
SOURCE [SOURCE ...] \
TARGET
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-syntax
@ -79,7 +80,7 @@ Parameters
*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
object (e.g. bucket and path to object). For example:
@ -87,6 +88,13 @@ Parameters
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
path to that object. For example:
@ -105,7 +113,7 @@ Parameters
*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
(e.g. bucket and path to object). For example:

4
source/reference/minio-mc/mc-diff.rst
View File

@ -57,7 +57,7 @@ Parameters
*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
object (e.g. bucket and path to object). For example:
@ -77,7 +77,7 @@ Parameters
*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
object (e.g. bucket and path to object). For example:

16
source/reference/minio-mc/mc-head.rst
View File

@ -57,7 +57,7 @@ tool.
[--rewind "string"] \
[--version-id "string"] \
[--encrypt-key "string"] \
ALIAS
ALIAS [ALIAS ...]
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-syntax
@ -70,16 +70,20 @@ Parameters
*Required* The object or objects to print.
For an object on MinIO or another S3-compatible service, specify the
:ref:`alias <alias>` and the full path to that object (e.g. bucket and path
to object). For example:
For example:
For an object on MinIO, specify the :ref:`alias <alias>` and the full path to
that object (e.g. bucket and path to object). For example:
.. code-block:: none
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 example:

4
source/reference/minio-mc/mc-ls.rst
View File

@ -55,7 +55,7 @@ results as the ``ls`` command.
[--rewind] \
[--versions] \
[--summarize] \
ALIAS
ALIAS [ALIAS ...]
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-syntax
@ -69,7 +69,7 @@ Parameters
*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
object (e.g. bucket and path to object). For example:

2
source/reference/minio-mc/mc-mb.rst
View File

@ -62,7 +62,7 @@ Parameters
*Required* The MinIO or other S3-compatible service on which to create the
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:
.. code-block:: none

19
source/reference/minio-mc/mc-mv.rst
View File

@ -53,7 +53,7 @@ similar results to the ``mv`` commandline tool.
[--preserve] \
[--recursive] \
[--storage-class "string"] \
SOURCE \
SOURCE [SOURCE...] \
TARGET
.. include:: /includes/common-minio-mc.rst
@ -67,9 +67,9 @@ Parameters
*Required* The object or objects to move.
For moving an object from MinIO or another S3-compatible service,
specify the :ref:`alias <alias>` and hte full path to the object(s)
(e.g. bucket and path to objects). For example:
For moving an object from a MinIO bucket, specify the :ref:`alias <alias>`
and the full path to the object(s) (e.g. bucket and path to objects). For
example:
.. code-block:: shell
@ -82,8 +82,13 @@ Parameters
mc mv ~/mydata/object.txt play/mybucket/object.txt
You can specify both local paths
and S3 paths using a configured S3 service :mc:`alias <mc alias>`.
Specify multiple ``SOURCE`` paths to move multiple objects to the
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
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
: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)
(e.g. bucket and path to objects). For example:

1
source/reference/minio-mc/mc-policy-set.rst
View File

@ -77,7 +77,6 @@ Parameters
- ``upload`` - Enable upload-only access to the ``ALIAS``.
- ``public`` - Enable download and upload access to the ``ALIAS``.
.. mc-cmd:: ALIAS
*Required* The full path to the bucket or bucket prefix to which the

9
source/reference/minio-mc/mc-rb.rst
View File

@ -55,7 +55,7 @@ similar results to the ``rm --rf`` commandline tool.
mc [GLOBALFLAGS] rb \
--force \
[--dangerous] \
ALIAS
ALIAS [ALIAS...]
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-syntax
@ -91,6 +91,13 @@ Parameters
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
:option:

1
source/reference/minio-mc/mc-rm.rst
View File

@ -68,6 +68,7 @@ results to the ``rm`` commandline tool.
[--stdin] \
[--version-id "string"]* \
[--versions] \
ALIAS [ALIAS ...]
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-syntax

2
source/reference/minio-mc/mc-stat.rst
View File

@ -54,7 +54,7 @@ results to the ``stat`` commandline tool.
[--rewind "string"] \
[--versions] \
[--version-id "string"]* \
ALIAS
ALIAS [ALIAS ...]
.. include:: /includes/common-minio-mc.rst