Blame doc/copr.rst

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