Blame doc/copr.rst

Packit 3a9065
..
Packit 3a9065
  Copyright (C) 2014  Red Hat, Inc.
Packit 3a9065
Packit 3a9065
  This copyrighted material is made available to anyone wishing to use,
Packit 3a9065
  modify, copy, or redistribute it subject to the terms and conditions of
Packit 3a9065
  the GNU General Public License v.2, or (at your option) any later version.
Packit 3a9065
  This program is distributed in the hope that it will be useful, but WITHOUT
Packit 3a9065
  ANY WARRANTY expressed or implied, including the implied warranties of
Packit 3a9065
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
Packit 3a9065
  Public License for more details.  You should have received a copy of the
Packit 3a9065
  GNU General Public License along with this program; if not, write to the
Packit 3a9065
  Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
Packit 3a9065
  02110-1301, USA.  Any Red Hat trademarks that are incorporated in the
Packit 3a9065
  source code or documentation are not subject to the GNU General Public
Packit 3a9065
  License and may only be used or replicated with the express permission of
Packit 3a9065
  Red Hat, Inc.
Packit 3a9065
Packit 3a9065
===============
Packit 3a9065
DNF copr Plugin
Packit 3a9065
===============
Packit 3a9065
Packit 3a9065
Work with Copr & Playground repositories on the local system.
Packit 3a9065
Packit 3a9065
* The ``copr`` command is used to add or remove Copr repositories to the local system
Packit 3a9065
* The ``playground`` is used to enable or disable the Playground repository
Packit 3a9065
Packit 3a9065
--------
Packit 3a9065
Synopsis
Packit 3a9065
--------
Packit 3a9065
Packit 3a9065
``dnf copr [enable|disable|remove|list|search] <parameters>``
Packit 3a9065
Packit 3a9065
``dnf playground [enable|disable|upgrade]``
Packit 3a9065
Packit 3a9065
----------------
Packit 3a9065
Arguments (copr)
Packit 3a9065
----------------
Packit 3a9065
Packit 3a9065
``enable name/project [chroot]``
Packit 3a9065
    Enable the ``name/project`` Copr repository with the optional ``chroot``.
Packit 3a9065
Packit 3a9065
``disable name/project``
Packit 3a9065
    Disable the ``name/project`` Copr repository.
Packit 3a9065
Packit 3a9065
``remove name/project``
Packit 3a9065
    Remove the ``name/project`` Copr repository.
Packit 3a9065
Packit 3a9065
``list --installed``
Packit 3a9065
    List installed Copr repositories (default).
Packit 3a9065
Packit 3a9065
``list --enabled``
Packit 3a9065
    List enabled Copr repositories.
Packit 3a9065
Packit 3a9065
``list --disabled``
Packit 3a9065
    List disabled Copr repositories.
Packit 3a9065
Packit 3a9065
``list --available-by-user=name``
Packit 3a9065
    List available Copr repositories for a given ``name``.
Packit 3a9065
Packit 3a9065
``search project``
Packit 3a9065
    Search for a given ``project``.
Packit 3a9065
Packit 3a9065
``enable hub/name/project``
Packit 3a9065
    Enable the ``name/project`` Copr repository from the specified Copr ``hub``,
Packit 3a9065
    Hub is be specified either by its hostname (eg. `copr.fedorainfracloud.org`)
Packit 3a9065
    or by an ID that's defined in a configuration file.
Packit 3a9065
Packit 3a9065
--------------
Packit 3a9065
Options (copr)
Packit 3a9065
--------------
Packit 3a9065
Packit 3a9065
All general DNF options are accepted, see `Options` in :manpage:`dnf(8)` for details.
Packit 3a9065
Packit 3a9065
``--hub Copr``
Packit 3a9065
    Specify a Copr hub to use. Default is the Fedora Copr: ``https://copr.fedorainfracloud.org``.
Packit 3a9065
Packit 3a9065
--------------------
Packit 3a9065
Configuration (copr)
Packit 3a9065
--------------------
Packit 3a9065
Packit 3a9065
``/etc/dnf/plugins/copr.conf``
Packit 3a9065
``/etc/dnf/plugins/copr.d/``
Packit 3a9065
Packit 3a9065
Configuration file should contain a section for each hub, each section having ``hostname``
Packit 3a9065
 (mandatory), ``protocol`` (default ``https``) and ``port`` (default ``443``) parameters.::
Packit 3a9065
Packit 3a9065
  [fedora]
Packit 3a9065
  hostname = copr.fedorainfracloud.org
Packit 3a9065
  protocol = https
Packit 3a9065
  port = 443
Packit 3a9065
Packit 3a9065
----------------------
Packit 3a9065
Arguments (playground)
Packit 3a9065
----------------------
Packit 3a9065
Packit 3a9065
``enable``
Packit 3a9065
    Enable the Playground repository.
Packit 3a9065
Packit 3a9065
``disable``
Packit 3a9065
    Disable the Playground repository.
Packit 3a9065
Packit 3a9065
``upgrade``
Packit 3a9065
    Upgrade the Playground repository settings (same as ``disable`` and then ``enable``).
Packit 3a9065
Packit 3a9065
--------------------
Packit 3a9065
Options (playground)
Packit 3a9065
--------------------
Packit 3a9065
Packit 3a9065
All general DNF options are accepted, see `Options` in :manpage:`dnf(8)` for details.
Packit 3a9065
Packit 3a9065
--------
Packit 3a9065
Examples
Packit 3a9065
--------
Packit 3a9065
Packit 3a9065
``copr enable rhscl/perl516 epel-6-x86_64``
Packit 3a9065
    Enable the ``rhscl/perl516`` Copr repository, using the ``epel-6-x86_64`` chroot.
Packit 3a9065
Packit 3a9065
``copr disable rhscl/perl516``
Packit 3a9065
    Disable the ``rhscl/perl516`` Copr repository
Packit 3a9065
Packit 3a9065
``copr list --available-by-user=rita``
Packit 3a9065
    List available Copr projects for user ``rita``.
Packit 3a9065
Packit 3a9065
``copr search tests``
Packit 3a9065
    Search for Copr projects named ``tests``.