minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2025-07-28 19:42:10 +03:00
Code Activity

additional cleanups after merge

Browse Source
This commit is contained in:
Ravind Kumar
2022-03-03 15:39:18 -05:00
parent 74e55a6ded
commit 93c9b00cb0
41 changed files with 228 additions and 192 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
source/reference/minio-mc-admin/mc-admin-bucket-remote.rst
View File

@ -144,22 +144,19 @@ Syntax
- Replace ``DESTBUCKET`` with the bucket on the
destination.
.. mc-cmd:: service
.. mc-cmd:: --service
*Required*
Specify ``"replication"``.
.. mc-cmd:: region
.. mc-cmd:: --region
The region of the :mc-cmd:`~mc admin bucket remote add DESTINATION`.
Mutually exclusive with :mc-cmd:`~mc admin bucket remote add path`
Mutually exclusive with :mc-cmd:`~mc admin bucket remote add`
.. mc-cmd:: path
.. mc-cmd:: --path
The bucket path lookup supported by the destination server. Specify
one of the following:
@ -169,10 +166,9 @@ Syntax
- ``auto`` (Default)
Mutually exclusive with
:mc-cmd:`~mc admin bucket remote add region`
:mc-cmd:`~mc admin bucket remote add`
.. mc-cmd:: sync
.. mc-cmd:: --sync
Enables synchronous replication, where MinIO attempts to replicate
the object *prior* to returning the PUT object response. Synchronous
@ -207,7 +203,7 @@ Syntax
mc admin bucket ls play/mybucket
.. mc-cmd:: service
.. mc-cmd:: --service
*Required*

4
source/reference/minio-mc-admin/mc-admin-heal.rst
View File

@ -80,12 +80,12 @@ Syntax
Inspects the :mc-cmd:`~mc admin heal TARGET` bucket or bucket prefix,
but does *not* perform any object healing.
.. mc-cmd:: force-start, f
.. mc-cmd:: --force-start, f
Force starts the healing process.
.. mc-cmd:: force-stop, s
.. mc-cmd:: --force-stop, s
Force stops the healing sequence.

20
source/reference/minio-mc-admin/mc-admin-policy.rst
View File

@ -152,7 +152,7 @@ Replace the ``<USER>`` with the name of a user that exists on the deployment.
.. code-block:: shell
:class: copyable
mc admin policy set myminio listbucketsonly user=<USER>
mc admin policy set --myminio listbucketsonly user=<USER>
The following :mc-cmd:`mc admin policy set` command associates the
``listbucketsonly`` policy to a group on the ``myminio`` MinIO deployment.
@ -161,7 +161,7 @@ Replace the ``<GROUP>`` with the name of a user that exists on the deployment.
.. code-block:: shell
:class: copyable
mc admin policy set myminio listbucketsonly group=<GROUP>
mc admin policy set --myminio listbucketsonly group=<GROUP>
Syntax
------
@ -264,14 +264,14 @@ Syntax
The :mc:`alias <mc alias>` of a configured MinIO deployment on which
the command associates the :mc-cmd:`~mc admin policy set POLICYNAME`
to the :mc-cmd:`~mc admin policy set user` or
:mc-cmd:`~mc admin policy set group`.
to the :mc-cmd:`~mc admin policy set --user` or
:mc-cmd:`~mc admin policy set --group`.
.. mc-cmd:: POLICYNAME
The name of the policy which the command associates to the specified
:mc-cmd:`~mc admin policy set user` or
:mc-cmd:`~mc admin policy set group`. Specify multiple policies
:mc-cmd:`~mc admin policy set --user` or
:mc-cmd:`~mc admin policy set --group`. Specify multiple policies
as a comma-separated list.
MinIO deployments include the following :ref:`built-in policies
@ -282,20 +282,20 @@ Syntax
- :userpolicy:`diagnostics`
- :userpolicy:`writeonly`
.. mc-cmd:: user
.. mc-cmd:: --user
The name of the user to which the command associates the
:mc-cmd:`~mc admin policy set POLICYNAME`.
Mutually exclusive with :mc-cmd:`~mc admin policy set group`
Mutually exclusive with :mc-cmd:`~mc admin policy set --group`
.. mc-cmd:: group
.. mc-cmd:: --group
The name of the group to which the command associates the
:mc-cmd:`~mc admin policy set POLICYNAME`. All users with membership in
the group inherit the policies associated to the group.
Mutually exclusive with :mc-cmd:`~mc admin policy set user`
Mutually exclusive with :mc-cmd:`~mc admin policy set --user`
.. mc-cmd:: remove
:fullpath:

44
source/reference/minio-mc-admin/mc-admin-tier.rst
View File

@ -129,8 +129,8 @@ Syntax
Requires specifying the following additional options:
- :mc-cmd:`~mc admin tier add access-key`
- :mc-cmd:`~mc admin tier add secret-key`
- :mc-cmd:`~mc admin tier add --access-key`
- :mc-cmd:`~mc admin tier add --secret-key`
* - ``azure``
- Use :abbr:`Azure (Microsoft Azure)` Blob Storage as the storage
@ -138,8 +138,8 @@ Syntax
Requires specifying the following additional options:
- :mc-cmd:`~mc admin tier add account-name`
- :mc-cmd:`~mc admin tier add account-key`
- :mc-cmd:`~mc admin tier add --account-name`
- :mc-cmd:`~mc admin tier add --account-key`
* - ``gcs``
- Use :abbr:`GCP (Google Cloud Platform)` Cloud Storage as the
@ -147,7 +147,7 @@ Syntax
Requires specifying the following additional option:
- :mc-cmd:`~mc admin tier add credentials-file`
- :mc-cmd:`~mc admin tier add --credentials-file`
.. mc-cmd:: TARGET
@ -165,7 +165,7 @@ Syntax
You **must** specify the tier in all-caps, e.g. ``WARM_TIER``.
.. mc-cmd:: endpoint
.. mc-cmd:: --endpoint
*Required*
@ -174,7 +174,7 @@ Syntax
*must* resolve to the provider specified to
:mc-cmd:`~mc admin tier add TIER_TYPE`.
.. mc-cmd:: access-key
.. mc-cmd:: --access-key
*Required*
@ -186,7 +186,7 @@ Syntax
Required if :mc-cmd:`~mc admin tier add TIER_TYPE` is ``s3``.
This option has no effect for any other value of ``TIER_TYPE``.
.. mc-cmd:: secret-key
.. mc-cmd:: --secret-key
*Required*
@ -196,7 +196,7 @@ Syntax
Required if :mc-cmd:`~mc admin tier add TIER_TYPE` is ``s3``.
This option has no effect for any other value of ``TIER_TYPE``.
.. mc-cmd:: account-name
.. mc-cmd:: --account-name
*Required*
@ -213,18 +213,18 @@ Syntax
changing the account would change the storage backend and prevent access
to any objects transitioned to the original account/backend.
.. mc-cmd:: account-key
.. mc-cmd:: --account-key
*Required*
The account key for the :mc-cmd:`~mc admin tier add account-name`
The account key for the :mc-cmd:`~mc admin tier add --account-name`
associated to the remote Azure tier.
Required if :mc-cmd:`~mc admin tier add TIER_TYPE` is ``azure``.
This option has no effect for any other value of ``TIER_TYPE``.
.. mc-cmd:: credentials-file
.. mc-cmd:: --credentials-file
*Required*
@ -237,24 +237,24 @@ Syntax
Required if :mc-cmd:`~mc admin tier add TIER_TYPE` is ``gcs``.
This option has no effect for any other value of ``TIER_TYPE``.
.. mc-cmd:: bucket
.. mc-cmd:: --bucket
*Required*
The bucket on the remote tier to which MinIO transitions objects.
.. mc-cmd:: prefix
.. mc-cmd:: --prefix
*Optional*
The prefix path for the specified :mc-cmd:`~mc admin tier add bucket`
The prefix path for the specified :mc-cmd:`~mc admin tier add --bucket`
to which MinIO transitions objects.
Omit this field to transition objects into the bucket root.
.. mc-cmd:: storage-class
.. mc-cmd:: --storage-class
*Optional*
@ -270,7 +270,7 @@ Syntax
This option only applies if :mc-cmd:`~mc admin tier add TIER_TYPE` is
``s3``. This option has no effect for any other value of ``TIER_TYPE``.
.. mc-cmd:: region
.. mc-cmd:: --region
*Optional*
@ -311,7 +311,7 @@ Syntax
corresponds to the :mc-cmd:`mc admin tier add TIER_NAME` specified
when creating the remote tier.
.. mc-cmd:: access-key
.. mc-cmd:: --access-key
*Optional*
@ -324,7 +324,7 @@ Syntax
:mc-cmd:`~mc admin tier add TIER_TYPE` is ``s3``.
This option has no effect for any other ``TIER_TYPE``.
.. mc-cmd:: secret-key
.. mc-cmd:: --secret-key
*Optional*
@ -335,21 +335,21 @@ Syntax
:mc-cmd:`~mc admin tier add TIER_TYPE` is ``s3``.
This option has no effect for any other ``TIER_TYPE``.
.. mc-cmd:: account-key
.. mc-cmd:: --account-key
*Required*
The account key for a user on the remote Azure tier.
Use this option to rotate the credentials for the
:mc-cmd:`~mc admin tier add account-name`
:mc-cmd:`~mc admin tier add --account-name`
associated to the remote tier.
This option only applies to remote storage tiers with
:mc-cmd:`~mc admin tier add TIER_TYPE` is ``azure``.
This option has no effect for any other ``TIER_TYPE``.
.. mc-cmd:: credentials-file
.. mc-cmd:: --credentials-file
*Required*

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

@ -16,7 +16,7 @@
.. |command| replace:: :mc-cmd:`mc cat`
.. |rewind| replace:: :mc-cmd:`~mc cat --rewind`
.. |versionid| replace:: :mc-cmd:`~mc cat version-id`
.. |versionid| replace:: :mc-cmd:`~mc cat --version-id`
.. |alias| replace:: :mc-cmd:`~mc cat ALIAS`
Syntax
@ -97,7 +97,7 @@ Parameters
:start-after: start-rewind-desc
:end-before: end-rewind-desc
.. mc-cmd:: version-id, vid
.. mc-cmd:: --version-id, vid
.. include:: /includes/facts-versioning.rst
@ -175,7 +175,7 @@ point-in-time in the past:
View an S3 Object with Specific Version
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc cat version-id` to return a specific version of the
Use :mc-cmd:`mc cat --version-id` to return a specific version of the
object:
.. code-block:: shell
@ -188,7 +188,7 @@ object:
- Replace :mc-cmd:`PATH <mc cat ALIAS>` with the path to the object on the
S3-compatible host.
- Replace :mc-cmd:`VERSION <mc cat version-id>` with the specific version of the
- Replace :mc-cmd:`VERSION <mc cat --version-id>` with the specific version of the
object to return.
.. include:: /includes/facts-versioning.rst

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

@ -14,7 +14,7 @@
.. |command| replace:: :mc-cmd:`mc cp`
.. |rewind| replace:: :mc-cmd:`~mc cp --rewind`
.. |versionid| replace:: :mc-cmd:`~mc cp version-id`
.. |versionid| replace:: :mc-cmd:`~mc cp --version-id`
.. |alias| replace:: :mc-cmd:`~mc cp SOURCE`
Syntax
@ -272,7 +272,7 @@ Parameters
``KEY1=VALUE1&KEY2=VALUE2``, where each pair represents one tag to
assign to the objects.
.. mc-cmd:: version-id, vid
.. mc-cmd:: --version-id, vid
.. include:: /includes/facts-versioning.rst
@ -415,7 +415,7 @@ specific point in time. This command only applies to S3-to-S3 copy.
Copy Specific Version of Object
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc cp version-id` to copy a specific version of an object. This
Use :mc-cmd:`mc cp --version-id` to copy a specific version of an object. This
command only applies to S3-to-S3 copy.
.. code-block:: shell

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

@ -15,7 +15,7 @@
.. |command| replace:: :mc-cmd:`mc head`
.. |rewind| replace:: :mc-cmd:`~mc head --rewind`
.. |versionid| replace:: :mc-cmd:`~mc head version-id`
.. |versionid| replace:: :mc-cmd:`~mc head --version-id`
.. |alias| replace:: :mc-cmd:`~mc head ALIAS`
Syntax
@ -66,7 +66,7 @@ tool.
Parameters
~~~~~~~~~~
.. mc-cmd:: ALIAS
.. mc-cmd:: ALIAS
*Required* The object or objects to print.
@ -91,14 +91,14 @@ Parameters
mc head ~/mydata/object.txt
.. mc-cmd:: lines, n
.. mc-cmd:: --lines, n
*Optional* The number of lines to print.
Defaults to ``10``.
.. mc-cmd:: encrypt-key
.. mc-cmd:: --encrypt-key
*Optional* Encrypt or decrypt objects using server-side encryption with
@ -109,9 +109,9 @@ Parameters
object(s).
Enclose the entire list of key-value pairs passed to
:mc-cmd:`~mc head encrypt-key` in double quotes ``"``.
:mc-cmd:`~mc head --encrypt-key` in double quotes ``"``.
:mc-cmd:`~mc head encrypt-key` can use the ``MC_ENCRYPT_KEY``
:mc-cmd:`~mc head --encrypt-key` can use the ``MC_ENCRYPT_KEY``
environment variable for retrieving a list of encryption key-value pairs
as an alternative to specifying them on the command line.
@ -122,7 +122,7 @@ Parameters
:start-after: start-rewind-desc
:end-before: end-rewind-desc
.. mc-cmd:: version-id, vid
.. mc-cmd:: --version-id, vid
.. include:: /includes/facts-versioning.rst
@ -184,7 +184,7 @@ object at a specific point-in-time in the past:
View Partial Contents of an Object with Specific Version
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc head version-id` to return the first 10 lines of the
Use :mc-cmd:`mc head --version-id` to return the first 10 lines of the
object at a specific point-in-time in the past:
.. code-block:: shell
@ -198,7 +198,7 @@ object at a specific point-in-time in the past:
- Replace :mc-cmd:`PATH <mc head ALIAS>` with the path to the object on the
S3-compatible host.
- Replace :mc-cmd:`VERSION <mc head version-id>` with the version of the object.
- Replace :mc-cmd:`VERSION <mc head --version-id>` with the version of the object.
For example, specify ``30d`` to return the version of the object 30 days prior
to the current date.

18
source/reference/minio-mc/mc-ilm-add.rst
View File

@ -103,7 +103,7 @@ Parameters
For versioned buckets, the expiry rule applies only to the *current*
object version. Use the
:mc-cmd:`~mc ilm add noncurrentversion-expiration-days` option
:mc-cmd:`~mc ilm add --noncurrentversion-expiration-days` option
to apply expiration behavior to noncurrent object versions.
MinIO uses a scanner process to check objects against all configured
@ -113,12 +113,12 @@ Parameters
Mutually exclusive with the following options:
- :mc-cmd:`~mc ilm add expired-object-delete-marker`
- :mc-cmd:`~mc ilm add --expired-object-delete-marker`
For more complete documentation on object expiration, see
:ref:`minio-lifecycle-management-expiration`.
.. mc-cmd:: expired-object-delete-marker
.. mc-cmd:: --expired-object-delete-marker
*Required* Specify this option to direct MinIO to remove delete markers for
@ -149,7 +149,7 @@ Parameters
For versioned buckets, the transition rule applies only to the *current*
object version. Use the
:mc-cmd:`~mc ilm add noncurrentversion-transition-days` option
:mc-cmd:`~mc ilm add --noncurrentversion-transition-days` option
to apply transition behavior to noncurrent object versions.
Requires specifying :mc-cmd:`~mc ilm add --storage-class`.
@ -180,9 +180,9 @@ Parameters
This option is mutually exclusive with the following option:
- :mc-cmd:`~mc ilm add expired-object-delete-marker`
- :mc-cmd:`~mc ilm add --expired-object-delete-marker`
.. mc-cmd:: noncurrentversion-expiration-days
.. mc-cmd:: --noncurrentversion-expiration-days
*Optional* The number of days to retain an object version after becoming
@ -198,7 +198,7 @@ Parameters
limited system resources may delay application of lifecycle management
rules. See :ref:`minio-lifecycle-management-scanner` for more information.
.. mc-cmd:: noncurrentversion-transition-days
.. mc-cmd:: --noncurrentversion-transition-days
*Optional* The number of days an object has been non-current (i.e. replaced
@ -209,7 +209,7 @@ Parameters
passes that calendar date.
This option has no effect on non-versioned buckets. Requires specifying
:mc-cmd:`~mc ilm add noncurrentversion-transition-storage-class`.
:mc-cmd:`~mc ilm add --noncurrentversion-transition-storage-class`.
This option has the same behavior as the
S3 ``NoncurrentVersionTransition`` action.
@ -219,7 +219,7 @@ Parameters
limited system resources may delay application of lifecycle management
rules. See :ref:`minio-lifecycle-management-scanner` for more information.
.. mc-cmd:: noncurrentversion-transition-storage-class
.. mc-cmd:: --noncurrentversion-transition-storage-class
*Optional* The remote storage tier to which MinIO

18
source/reference/minio-mc/mc-ilm-edit.rst
View File

@ -101,7 +101,7 @@ Parameters
For versioned buckets, the expiry rule applies only to the *current*
object version. Use the
:mc-cmd:`~mc ilm edit noncurrentversion-expiration-days` option
:mc-cmd:`~mc ilm edit --noncurrentversion-expiration-days` option
to apply expiration behavior to noncurrent object versions.
MinIO uses a scanner process to check objects against all configured
@ -111,9 +111,9 @@ Parameters
Mutually exclusive with the following options:
- :mc-cmd:`~mc ilm edit expired-object-delete-marker`
- :mc-cmd:`~mc ilm edit --expired-object-delete-marker`
.. mc-cmd:: expired-object-delete-marker
.. mc-cmd:: --expired-object-delete-marker
*Optional* Specify this option to direct MinIO to remove delete markers for
@ -130,7 +130,7 @@ Parameters
limited system resources may delay application of lifecycle management
rules. See :ref:`minio-lifecycle-management-scanner` for more information.
.. mc-cmd:: noncurrentversion-expiration-days
.. mc-cmd:: --noncurrentversion-expiration-days
*Optional* The number of days to retain an object version after becoming
@ -146,7 +146,7 @@ Parameters
limited system resources may delay application of lifecycle management
rules. See :ref:`minio-lifecycle-management-scanner` for more information.
.. mc-cmd:: noncurrentversion-transition-days
.. mc-cmd:: --noncurrentversion-transition-days
*Optional* The number of days an object has been non-current (i.e. replaced
@ -157,7 +157,7 @@ Parameters
passes that calendar date.
This option has no effect on non-versioned buckets. Requires specifying
:mc-cmd:`~mc ilm edit noncurrentversion-transition-storage-class`.
:mc-cmd:`~mc ilm edit --noncurrentversion-transition-storage-class`.
This option has the same behavior as the
S3 ``NoncurrentVersionTransition`` action.
@ -167,7 +167,7 @@ Parameters
limited system resources may delay application of lifecycle management
rules. See :ref:`minio-lifecycle-management-scanner` for more information.
.. mc-cmd:: noncurrentversion-transition-storage-class
.. mc-cmd:: --noncurrentversion-transition-storage-class
*Optional* The remote storage tier to which MinIO
@ -187,7 +187,7 @@ Parameters
This option is mutually exclusive with the following option:
- :mc-cmd:`~mc ilm edit expired-object-delete-marker`
- :mc-cmd:`~mc ilm edit --expired-object-delete-marker`
.. mc-cmd:: --transition-days
@ -199,7 +199,7 @@ Parameters
For versioned buckets, the transition rule applies only to the *current*
object version. Use the
:mc-cmd:`~mc ilm edit noncurrentversion-transition-days` option
:mc-cmd:`~mc ilm edit --noncurrentversion-transition-days` option
to apply transition behavior to noncurrent object versions.
Requires specifying :mc-cmd:`~mc ilm edit --storage-class`.

8
source/reference/minio-mc/mc-ilm-restore.rst
View File

@ -70,26 +70,26 @@ Parameters
mc ilm restore myminio/mybucket/object.txt
.. mc-cmd:: days value
.. mc-cmd:: --days
*Optional* The number of days after which MinIO expires the restored copy
of the archived object.
.. mc-cmd:: recursive, r
.. mc-cmd:: --recursive, r
*Optional* Restores all objects under the specified prefix.
.. mc-cmd:: versions
.. mc-cmd:: --versions
*Optional* Restores all versions of the object on the remote tier.
.. mc-cmd:: version-id, vid
.. mc-cmd:: --version-id, vid
*Optional* Restores the specified version of the object on the remote tier.

4
source/reference/minio-mc/mc-legalhold-clear.rst
View File

@ -14,7 +14,7 @@
.. |command| replace:: :mc-cmd:`mc legalhold clear`
.. |rewind| replace:: :mc-cmd:`~mc legalhold clear --rewind`
.. |versionid| replace:: :mc-cmd:`~mc legalhold clear version-id`
.. |versionid| replace:: :mc-cmd:`~mc legalhold clear --version-id`
.. |alias| replace:: :mc-cmd:`~mc legalhold clear ALIAS`
Syntax
@ -87,7 +87,7 @@ Parameters
:start-after: start-rewind-desc
:end-before: end-rewind-desc
.. mc-cmd:: version-id, vid
.. mc-cmd:: --version-id, vid
.. include:: /includes/facts-versioning.rst

4
source/reference/minio-mc/mc-legalhold-info.rst
View File

@ -14,7 +14,7 @@
.. |command| replace:: :mc-cmd:`mc legalhold info`
.. |rewind| replace:: :mc-cmd:`~mc legalhold info --rewind`
.. |versionid| replace:: :mc-cmd:`~mc legalhold info version-id`
.. |versionid| replace:: :mc-cmd:`~mc legalhold info --version-id`
.. |alias| replace:: :mc-cmd:`~mc legalhold info ALIAS`
Syntax
@ -86,7 +86,7 @@ Parameters
:start-after: start-rewind-desc
:end-before: end-rewind-desc
.. mc-cmd:: version-id, vid
.. mc-cmd:: --version-id, vid
.. include:: /includes/facts-versioning.rst

4
source/reference/minio-mc/mc-legalhold-set.rst
View File

@ -15,7 +15,7 @@
.. |command| replace:: :mc-cmd:`mc legalhold set`
.. |rewind| replace:: :mc-cmd:`~mc legalhold set --rewind`
.. |versionid| replace:: :mc-cmd:`~mc legalhold set version-id`
.. |versionid| replace:: :mc-cmd:`~mc legalhold set --version-id`
.. |alias| replace:: :mc-cmd:`~mc legalhold set ALIAS`
Syntax
@ -88,7 +88,7 @@ Parameters
:start-after: start-rewind-desc
:end-before: end-rewind-desc
.. mc-cmd:: version-id, vid
.. mc-cmd:: --version-id, vid
.. include:: /includes/facts-versioning.rst

10
source/reference/minio-mc/mc-retention-clear.rst
View File

@ -12,7 +12,7 @@
.. |command| replace:: :mc-cmd:`mc retention clear`
.. |rewind| replace:: :mc-cmd:`~mc retention clear --rewind`
.. |versionid| replace:: :mc-cmd:`~mc retention clear version-id`
.. |versionid| replace:: :mc-cmd:`~mc retention clear --version-id`
.. |versions| replace:: :mc-cmd:`~mc retention clear --versions`
.. |alias| replace:: :mc-cmd:`~mc retention clear ALIAS`
@ -63,7 +63,7 @@ To change the retention status of an object under
:start-after: start-minio-syntax
:end-before: end-minio-syntax
:mc-cmd:`mc retention clear version-id` is mutually exclusive with
:mc-cmd:`mc retention clear --version-id` is mutually exclusive with
multiple other parameters. See the reference documentation for more
information.
@ -87,7 +87,7 @@ Parameters
- If the ``ALIAS`` bucket has versioning enabled,
:mc-cmd:`mc retention clear` by default applies to only the latest
object version. Use :mc-cmd:`~mc retention clear version-id` or
object version. Use :mc-cmd:`~mc retention clear --version-id` or
:mc-cmd:`~mc retention clear --versions` to clear the object lock
settings for a specific version or for all versions of the object.
@ -106,7 +106,7 @@ Parameters
*Optional* Recursively clears the object lock settings for all objects in the
specified :mc-cmd:`~mc retention clear ALIAS` path.
Mutually exclusive with :mc-cmd:`~mc retention clear version-id`.
Mutually exclusive with :mc-cmd:`~mc retention clear --version-id`.
.. mc-cmd:: --rewind
@ -115,7 +115,7 @@ Parameters
:start-after: start-rewind-desc
:end-before: end-rewind-desc
.. mc-cmd:: version-id, vid
.. mc-cmd:: --version-id, vid
.. include:: /includes/facts-versioning.rst

10
source/reference/minio-mc/mc-retention-info.rst
View File

@ -12,7 +12,7 @@
.. |command| replace:: :mc-cmd:`mc retention info`
.. |rewind| replace:: :mc-cmd:`~mc retention info --rewind`
.. |versionid| replace:: :mc-cmd:`~mc retention info version-id`
.. |versionid| replace:: :mc-cmd:`~mc retention info --version-id`
.. |alias| replace:: :mc-cmd:`~mc retention info ALIAS`
.. |versions| replace:: :mc-cmd:`~mc retention info --versions`
@ -67,7 +67,7 @@ object locking enabled.
:start-after: start-minio-syntax
:end-before: end-minio-syntax
:mc-cmd:`mc retention info version-id` is mutually exclusive with
:mc-cmd:`mc retention info --version-id` is mutually exclusive with
multiple other parameters. See the reference documentation for more
information.
@ -93,7 +93,7 @@ Parameters
- If the ``ALIAS`` bucket has versioning enabled,
:mc-cmd:`mc retention info` by default applies to only the latest object
version. Use :mc-cmd:`~mc retention info version-id` or
version. Use :mc-cmd:`~mc retention info --version-id` or
:mc-cmd:`~mc retention info --versions` to return the object lock
settings for a specific version or for all versions of the object.
@ -113,7 +113,7 @@ Parameters
*Optional* Recursively returns the object lock settings for all objects in the
specified :mc-cmd:`~mc retention info ALIAS` path.
Mutually exclusive with :mc-cmd:`~mc retention info version-id`.
Mutually exclusive with :mc-cmd:`~mc retention info --version-id`.
.. mc-cmd:: --rewind
@ -122,7 +122,7 @@ Parameters
:start-after: start-rewind-desc
:end-before: end-rewind-desc
.. mc-cmd:: version-id, vid
.. mc-cmd:: --version-id, vid
.. include:: /includes/facts-versioning.rst

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

@ -13,7 +13,7 @@
.. |command| replace:: :mc-cmd:`mc rm`
.. |rewind| replace:: :mc-cmd:`~mc rm --rewind`
.. |versions| replace:: :mc-cmd:`~mc rm --versions`
.. |versionid| replace:: :mc-cmd:`~mc rm version-id`
.. |versionid| replace:: :mc-cmd:`~mc rm --version-id`
.. |alias| replace:: :mc-cmd:`~mc rm ALIAS`
Syntax
@ -75,7 +75,7 @@ results to the ``rm`` commandline tool.
:end-before: end-minio-syntax
:mc-cmd:`mc rm --force` is required by multiple parameters.
:mc-cmd:`mc rm version-id` is mutually exclusive with multiple
:mc-cmd:`mc rm --version-id` is mutually exclusive with multiple
parameters. See the reference documentation for more information.
Parameters
@ -232,7 +232,7 @@ Parameters
:mc-cmd:`~mc rm --fake` flag to validate the scope of the
recursive delete operation.
Mutually exclusive with :mc-cmd:`mc rm version-id`
Mutually exclusive with :mc-cmd:`mc rm --version-id`
.. mc-cmd:: --rewind
@ -257,7 +257,7 @@ Parameters
:mc-cmd:`~mc rm --rewind` together to remove all object
versions which existed at a specific point in time.
.. mc-cmd:: version-id, vid
.. mc-cmd:: --version-id, vid
.. include:: /includes/facts-versioning.rst
@ -395,7 +395,7 @@ that marks an object as deleted while retaining all previous versions of that
object.
- To remove a specific object version from a bucket, use
:mc-cmd:`mc rm version-id`
:mc-cmd:`mc rm --version-id`
- To remove all versions of an object from a bucket, use
:mc-cmd:`mc rm --versions`

4
source/reference/minio-mc/mc-share-download.rst
View File

@ -11,7 +11,7 @@
.. mc:: mc share download
.. |command| replace:: :mc-cmd:`mc share download`
.. |versionid| replace:: :mc-cmd:`~mc share download version-id`
.. |versionid| replace:: :mc-cmd:`~mc share download --version-id`
.. |alias| replace:: :mc-cmd:`~mc share download ALIAS`
Syntax
@ -110,7 +110,7 @@ Parameters
Required if any ``ALIAS`` specifies a path to a bucket or bucket prefix.
.. mc-cmd:: version-id, vid
.. mc-cmd:: --version-id, vid
.. include:: /includes/facts-versioning.rst

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

@ -115,7 +115,7 @@ Parameters
See the S3 API :s3-api:`CSVOutput <API_CSVOutput.html>` for more
information.
.. mc-cmd:: csv-output-header
.. mc-cmd:: --csv-output-header
*Optional* The header row of the ``.csv`` output file. Specify a string of

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

@ -13,7 +13,7 @@
.. |command| replace:: :mc-cmd:`mc stat`
.. |rewind| replace:: :mc-cmd:`~mc stat --rewind`
.. |versions| replace:: :mc-cmd:`~mc stat --versions`
.. |versionid| replace:: :mc-cmd:`~mc stat version-id`
.. |versionid| replace:: :mc-cmd:`~mc stat --version-id`
.. |alias| replace:: :mc-cmd:`~mc stat ALIAS`
Syntax
@ -61,7 +61,7 @@ results to the ``stat`` commandline tool.
:start-after: start-minio-syntax
:end-before: end-minio-syntax
:mc-cmd:`mc stat version-id` is mutually exclusive with multiple
:mc-cmd:`mc stat --version-id` is mutually exclusive with multiple
parameters. See the reference documentation for more information.
Parameters
@ -137,7 +137,7 @@ Parameters
:mc-cmd:`~mc stat --rewind` together to remove all object
versions which existed at a specific point in time.
.. mc-cmd:: version-id, vid
.. mc-cmd:: --version-id, vid
.. include:: /includes/facts-versioning.rst

6
source/reference/minio-mc/mc-tag-list.rst
View File

@ -15,7 +15,7 @@
.. |command| replace:: :mc-cmd:`mc tag list`
.. |rewind| replace:: :mc-cmd:`~mc tag list --rewind`
.. |versions| replace:: :mc-cmd:`~mc tag list --versions`
.. |versionid| replace:: :mc-cmd:`~mc tag list version-id`
.. |versionid| replace:: :mc-cmd:`~mc tag list --version-id`
.. |alias| replace:: :mc-cmd:`~mc tag list ALIAS`
Syntax
@ -56,7 +56,7 @@ The :mc:`mc tag list` command lists all tags from a bucket or object.
:start-after: start-minio-syntax
:end-before: end-minio-syntax
:mc-cmd:`mc tag list version-id` is mutually exclusive with
:mc-cmd:`mc tag list --version-id` is mutually exclusive with
multiple parameters. See the reference documentation for more information.
Parameters
@ -90,7 +90,7 @@ Parameters
:mc-cmd:`~mc tag list --rewind` together to list tags from all
object versions which existed at a specific point in time.
.. mc-cmd:: version-id, vid
.. mc-cmd:: --version-id, vid
.. include:: /includes/facts-versioning.rst

6
source/reference/minio-mc/mc-tag-remove.rst
View File

@ -15,7 +15,7 @@
.. |command| replace:: :mc-cmd:`mc tag remove`
.. |rewind| replace:: :mc-cmd:`~mc tag remove --rewind`
.. |versions| replace:: :mc-cmd:`~mc tag remove --versions`
.. |versionid| replace:: :mc-cmd:`~mc tag remove version-id`
.. |versionid| replace:: :mc-cmd:`~mc tag remove --version-id`
.. |alias| replace:: :mc-cmd:`~mc tag remove ALIAS`
Syntax
@ -55,7 +55,7 @@ The :mc:`mc tag remove` command removes all tags from a bucket or object.
:start-after: start-minio-syntax
:end-before: end-minio-syntax
:mc-cmd:`mc tag remove version-id` is mutually exclusive with
:mc-cmd:`mc tag remove --version-id` is mutually exclusive with
multiple parameters. See the reference documentation for more information.
Parameters
@ -89,7 +89,7 @@ Parameters
:mc-cmd:`~mc tag remove --rewind` together to remove tags from all
object versions which existed at a specific point in time.
.. mc-cmd:: version-id, vid
.. mc-cmd:: --version-id, vid
.. include:: /includes/facts-versioning.rst

2
source/reference/minio-server/minio-server.rst
View File

@ -156,7 +156,7 @@ The command accepts the following arguments:
Omit to direct MinIO to generate a dynamic port at server startup. The
MinIO server outputs the port to the system log.
.. mc-cmd:: certs-dir, -S
.. mc-cmd:: --certs-dir, -S
*Optional* Specifies the path to the folder containing certificates the