mirror of
https://github.com/minio/docs.git
synced 2025-08-06 14:42:56 +03:00
6482571bf2
- Adds landing pages for all two-word `mc` commands - Nests three+ word commands under appropriate two-word commands - Updates MinIO Client doc - Uses description from each command to populate list of subcommand descriptions - Modifies toctree for MinIO Client doc and each command/subcommand to improve left nav experienc Closes #710
62 lines
1.4 KiB
ReStructuredText
62 lines
1.4 KiB
ReStructuredText
============
|
|
``mc alias``
|
|
============
|
|
|
|
.. default-domain:: minio
|
|
|
|
.. contents:: Table of Contents
|
|
:local:
|
|
:depth: 2
|
|
|
|
.. mc:: mc alias
|
|
|
|
|
|
Description
|
|
-----------
|
|
|
|
.. start-mc-alias-desc
|
|
|
|
The :mc:`mc alias` commands provide a convenient interface for managing the list of S3-compatible hosts that :mc-cmd:`mc` can connect to and run operations against.
|
|
|
|
.. end-mc-alias-desc
|
|
|
|
.. important::
|
|
|
|
:mc-cmd:`mc` commands that operate on S3-compatible services *require* specifying an alias for that service.
|
|
|
|
Subcommands
|
|
-----------
|
|
|
|
:mc:`mc alias` includes the following subcommands:
|
|
|
|
.. list-table::
|
|
:header-rows: 1
|
|
:widths: 30 70
|
|
:width: 100%
|
|
|
|
* - Subcommand
|
|
- Description
|
|
|
|
* - :mc:`~mc alias list`
|
|
- .. include:: /reference/minio-mc/mc-alias-list.rst
|
|
:start-after: start-mc-alias-list-desc
|
|
:end-before: end-mc-alias-list-desc
|
|
|
|
* - :mc:`~mc alias remove`
|
|
- .. include:: /reference/minio-mc/mc-alias-remove.rst
|
|
:start-after: start-mc-alias-remove-desc
|
|
:end-before: end-mc-alias-remove-desc
|
|
|
|
* - :mc:`~mc alias set`
|
|
- .. include:: /reference/minio-mc/mc-alias-set.rst
|
|
:start-after: start-mc-alias-set-desc
|
|
:end-before: end-mc-alias-set-desc
|
|
|
|
.. toctree::
|
|
:titlesonly:
|
|
:hidden:
|
|
|
|
/reference/minio-mc/mc-alias-list
|
|
/reference/minio-mc/mc-alias-remove
|
|
/reference/minio-mc/mc-alias-set
|