mirror of
https://github.com/minio/docs.git
synced 2025-07-30 07:03:26 +03:00
81 lines
1.1 KiB
ReStructuredText
81 lines
1.1 KiB
ReStructuredText
:orphan:
|
|
|
|
..
|
|
|
|
Use this file as a template for adding new MinIO `mc` commands and
|
|
subcommands.
|
|
|
|
.. _minio-mc-COMMAND:
|
|
|
|
============================
|
|
``mc COMMAND``
|
|
============================
|
|
|
|
.. default-domain:: minio
|
|
|
|
.. contents:: Table of Contents
|
|
:local:
|
|
:depth: 2
|
|
|
|
.. mc:: mc COMMAND
|
|
|
|
Syntax
|
|
------
|
|
|
|
.. start-mc-COMMAND-desc
|
|
|
|
The :mc:`mc COMMAND` command DESCRIPTION
|
|
|
|
.. end-mc-COMMAND-desc
|
|
|
|
.. code-block:: shell
|
|
|
|
mc [GLOBALFLAGS] COMMAND FLAGS [FLAGS] ARGUMENTS [ARGUMENTS]
|
|
|
|
Parameters
|
|
~~~~~~~~~~
|
|
|
|
..
|
|
|
|
Document all arguments here:
|
|
|
|
.. mc-cmd:: ARGUMENT
|
|
|
|
*Required|Optional* Describe the argument here
|
|
|
|
|
|
..
|
|
|
|
Document all flags here
|
|
|
|
.. mc-cmd:: FLAG
|
|
|
|
*Required|Optional* Describe the flag here
|
|
|
|
Global Flags
|
|
~~~~~~~~~~~~
|
|
|
|
.. include:: /includes/common-minio-mc.rst
|
|
:start-after: start-minio-mc-globals
|
|
:end-before: end-minio-mc-globals
|
|
|
|
Examples
|
|
--------
|
|
|
|
..
|
|
|
|
Document all examples here
|
|
|
|
Use action-based titles:
|
|
|
|
Enable | Configure | Modify | Deploy | Set
|
|
|
|
Behavior
|
|
--------
|
|
|
|
..
|
|
|
|
Document all behaviors here
|
|
|
|
Be descriptive to improve searchability / SEO
|