*******
Cockpit
*******
Command Line Interface
----------------------

   Commandline interface for verification and shell binding.

   .. raw:: html
   
      <div class="indextab">
      <div class="nonbreakheadtab">
      <div class="autocoltab">
   
   
   
   +-------------------------------------------------+-------------------------------+
   | Command Line Interface                          | Call Options                  |
   +=================================================+===============================+
   | :ref:`rtplatformids - call <RTPLATFORMIDS_CLI>` | :ref:`platformidsCLISYNOPSIS` |
   +-------------------------------------------------+-------------------------------+
   |                                                 | :ref:`platformidsCLIOPTIONS`  |
   +-------------------------------------------------+-------------------------------+
   |                                                 | :ref:`platformidsEXAMPLES`    |
   +-------------------------------------------------+-------------------------------+
   
   .. raw:: html
   
      </div>
      </div>
      </div>



API
---

   .. raw:: html
   
      <div class="indextab">
      <div class="nonbreakheadtab">
      <div class="autocoltab">
   
   +---------+---------------------------------------------------+------------------------------------+
   |         | Shortcuts                                         | API                                |
   +=========+===================================================+====================================+
   | core    | :ref:`platformids <PLATFORMSMODULE>`              | `platformids <platformids.html#>`_ |
   +---------+---------------------------------------------------+------------------------------------+
   | class   | :ref:`platformids.platforms <PLATFORMSMODULE>`    | `platforms`_                       |
   +---------+---------------------------------------------------+------------------------------------+
   | plugins | :ref:`platformids.dist <OSTYPEANDDISTCATEGORIES>` | <platform-modules>                 |
   +---------+---------------------------------------------------+------------------------------------+

   .. raw:: html
   
      </div>
      </div>
      </div>


   .. raw:: html
   
      <div class="indextab">
      <div class="nonbreakheadtab">
      <div class="autocoltab">
   
   +--------------------+-----------------------------------------------+------------------------------+----------------------------------------------+---------------------------------+-----------------------------------------------+----------------------------------+
   | Platform Modules   |                                               |                              |                                              |                                 |                                               |                                  |
   +====================+===============================================+==============================+==============================================+=================================+===============================================+==================================+
   | Linux              | :ref:`alpinelinux <DIST_MODULE_ALPINE>`       | [:ref:`doc <enumALPINELIN>`] | :ref:`archlinux <DIST_MODULE_ARCHLIN>`       | [:ref:`doc <enumARCHLIN>`]      | :ref:`centos <DIST_MODULE_CENTOS>`            | [:ref:`doc <enumCENTOS>`]        |
   +--------------------+-----------------------------------------------+------------------------------+----------------------------------------------+---------------------------------+-----------------------------------------------+----------------------------------+
   |                    | :ref:`debian <DIST_MODULE_DEBIAN>`            | [:ref:`doc <enumDEBIAN>`]    | :ref:`fedora <DIST_MODULE_FEDORA>`           | [:ref:`doc <enumFEDORA>`]       | :ref:`gentoo <DIST_MODULE_GENTOO>`            | [:ref:`doc <enumGENTOO>`]        |
   +--------------------+-----------------------------------------------+------------------------------+----------------------------------------------+---------------------------------+-----------------------------------------------+----------------------------------+
   |                    | :ref:`opensuse <DIST_MODULE_OPENSUSE>`        | [:ref:`doc <enumOPENSUSE>`]  | :ref:`oraclelinux <DIST_MODULE_ORACLELIN>`   | [:ref:`doc <enumOEL>`]          | :ref:`rhel <DIST_MODULE_RHEL>`                | [:ref:`doc <enumRHEL>`]          |
   +--------------------+-----------------------------------------------+------------------------------+----------------------------------------------+---------------------------------+-----------------------------------------------+----------------------------------+
   |                    | :ref:`sles <DIST_MODULE_SLES>`                | [:ref:`doc <enumSLES>`]      | :ref:`ubuntu <DIST_MODULE_UBUNTU>`           | [:ref:`doc <enumUBUNTU>`]       |                                               |                                  |
   +--------------------+-----------------------------------------------+------------------------------+----------------------------------------------+---------------------------------+-----------------------------------------------+----------------------------------+
   | BSD                | :ref:`freebsd <DIST_MODULE_FREEBSD>`          | [:ref:`doc <enumFREEBSD>`]   | :ref:`netbsd <DIST_MODULE_NETBSD>`           | [:ref:`doc <enumNETBSD>`]       | :ref:`openbsd <DIST_MODULE_OPENBSD>`          | [:ref:`doc <enumOPENBSD>`]       |
   +--------------------+-----------------------------------------------+------------------------------+----------------------------------------------+---------------------------------+-----------------------------------------------+----------------------------------+
   | Windows-NT         | :ref:`windows <DIST_MODULE_WINDOWS>`          | [:ref:`doc <enumWINNT>`]     | :ref:`cygwin <DIST_MODULE_CYGWIN>`           | [:ref:`doc <enumCYGWIN>`]       |                                               |                                  |
   +--------------------+-----------------------------------------------+------------------------------+----------------------------------------------+---------------------------------+-----------------------------------------------+----------------------------------+
   | OS-X / macOS       | :ref:`darwin <DIST_MODULE_DARWIN>`            | [:ref:`doc <enumOSX>`]       |                                              |                                 |                                               |                                  |
   +--------------------+-----------------------------------------------+------------------------------+----------------------------------------------+---------------------------------+-----------------------------------------------+----------------------------------+
   | UNIX               | :ref:`solaris <DIST_MODULE_SOLARIS>`          | [:ref:`doc <enumSOLARIS>`]   |                                              |                                 |                                               |                                  |
   +--------------------+-----------------------------------------------+------------------------------+----------------------------------------------+---------------------------------+-----------------------------------------------+----------------------------------+
   | Network + Security | :ref:`openwrt <NET_MODULE_OPENWRT>`           | [:ref:`doc <secnetOPENWRT>`] | :ref:`kali <NET_MODULE_KALI>`                | [:ref:`doc <secnetKALILINUX>`]  | :ref:`pfsense <NET_MODULE_PFSENSE>`           | [:ref:`doc <secnetPFSENSE>`]     |
   +--------------------+-----------------------------------------------+------------------------------+----------------------------------------------+---------------------------------+-----------------------------------------------+----------------------------------+
   | Embedded           | :ref:`armbian <EMBED_MODULE_ARMBIAN>` \(1)    | [:ref:`doc <enumARMBIAN>`]   | :ref:`raspbian <EMBED_MODULE_RASPBIAN>` \(1) | [:ref:`doc <embeddedRASPBIAN>`] |                                               |                                  |
   +--------------------+-----------------------------------------------+------------------------------+----------------------------------------------+---------------------------------+-----------------------------------------------+----------------------------------+
   |                    | :ref:`windows10iot <DIST_MODULE_WINDOWS>`     | [:ref:`doc <WINIOTRASPI>`]   | :ref:`MicroPython <EMBED_MODULE_MICROPY>`    | [:ref:`doc <embeddedMICROPY>`]  | :ref:`CircuitPython <EMBED_MODULE_CIRCUITPY>` | [:ref:`doc <embeddedCIRCUITPY>`] |
   +--------------------+-----------------------------------------------+------------------------------+----------------------------------------------+---------------------------------+-----------------------------------------------+----------------------------------+

   .. raw:: html
   
      </div>
      </div>
      </div>

   **(1)**: "*Shrinked-PC*" with low-level-hardware interfaces and special compiled kernels. Thus logical still of *category* *POSIX*, but localized coallocated with *EMBEDDED* systems. 


   Examples for optional loaded custom platforms:

   .. raw:: html
   
      <div class="indextab">
      <div class="nonbreakheadtab">
      <div class="autocoltab">
   
   +-------------+----------------+------------------------------------------------------+---------------------------------+-------------------------------------------------+------------------------------+-------------------------------------------------+-----------------------------+
   | Custom Type | Custom Modules |                                                      |                                 |                                                 |                              |                                                 |                             |
   +=============+================+======================================================+=================================+=================================================+==============================+=================================================+=============================+
   | ostype      |                | :ref:`custom.minix <CUSTOM_MODULE_MINIX>`            | [:ref:`doc <enumMINIX>`]        | :ref:`custom.reactos <CUSTOM_MODULE_REACTOS>`   | [:ref:`doc <enumREACTOS>`]   |                                                 |                             |
   +-------------+----------------+------------------------------------------------------+---------------------------------+-------------------------------------------------+------------------------------+-------------------------------------------------+-----------------------------+
   | dist        | BSD            | :ref:`custom.dragonflybsd <CUSTOM_MODULE_DRAGON>`    | [:ref:`doc <enumDRAGONFLYBSD>`] | :ref:`custom.ghostbsd <CUSTOM_MODULE_GHOSTBSD>` | [:ref:`doc <enumGHOSTBSD>`]  | :ref:`custom.nomadbsd <CUSTOM_MODULE_NOMADBSD>` | [:ref:`doc <enumNOMADBSD>`] |
   +-------------+----------------+------------------------------------------------------+---------------------------------+-------------------------------------------------+------------------------------+-------------------------------------------------+-----------------------------+
   |             |                | :ref:`custom.trueos <CUSTOM_MODULE_TRUEOS>`          | [:ref:`doc <enumTRUEOS>`]       |                                                 |                              |                                                 |                             |
   +-------------+----------------+------------------------------------------------------+---------------------------------+-------------------------------------------------+------------------------------+-------------------------------------------------+-----------------------------+
   |             | LINUX          | :ref:`custom.linuxmint <CUSTOM_MODULE_LINUXMINT>`    | [:ref:`doc <enumLINUXMINT>`]    | :ref:`custom.slackware <CUSTOM_MODULE_SLACK>`   | [:ref:`doc <enumSLACKWARE>`] |                                                 |                             |
   +-------------+----------------+------------------------------------------------------+---------------------------------+-------------------------------------------------+------------------------------+-------------------------------------------------+-----------------------------+
   |             | MINIX          | :ref:`custom.minix2 <CUSTOM_MODULE_MINIX2>`          | [:ref:`doc <enumMINIX2>`]       |                                                 |                              |                                                 |                             |
   +-------------+----------------+------------------------------------------------------+---------------------------------+-------------------------------------------------+------------------------------+-------------------------------------------------+-----------------------------+
   |             | SECURITY       | :ref:`custom.blackarch <CUSTOM_MODULE_BLACKARCH>`    | [:ref:`doc <enumBLACKARCH>`]    | :ref:`custom.parrotos <CUSTOM_MODULE_PARROT>`   | [:ref:`doc <enumPARROTOS>`]  | :ref:`custom.pentoo <CUSTOM_MODULE_PENTOO>`     | [:ref:`doc <enumPENTOO>`]   |
   +-------------+----------------+------------------------------------------------------+---------------------------------+-------------------------------------------------+------------------------------+-------------------------------------------------+-----------------------------+
   |             | UNIX           | :ref:`custom.aix <CUSTOM_MODULE_AIX>` (x86 / VMs)    | [:ref:`doc <enumAIX>`]          |                                                 |                              |                                                 |                             |
   +-------------+----------------+------------------------------------------------------+---------------------------------+-------------------------------------------------+------------------------------+-------------------------------------------------+-----------------------------+

   .. raw:: html
   
      </div>
      </div>
      </div>

   .. raw:: html
   
      </div>
      </div>
      </div>

.. _platformids: platformids.html#
.. _platformids.__init__: _modules/platformids/__init__.html#

.. _platforms: platforms.html#
.. _platformids.platforms: _modules/platformids/platforms.html#

.. _POSIX, CIFS, URI...: package_doc.html#resources

.. _HowTo Custom Data:  howto_custom.html

.. _platformids.config: config.html

.. _config data: config_data.html

.. _dist.custom.circuitpython: dist/custom/circuitpython.html#
.. _dist.custom.micropython: dist/custom/micropython.html#